src/hb-common.h

   1 /*
   2  * Copyright © 2007,2008,2009  Red Hat, Inc.
   3  * Copyright © 2011,2012  Google, Inc.
   4  *
   5  *  This is part of HarfBuzz, a text shaping library.
   6  *
   7  * Permission is hereby granted, without written agreement and without
   8  * license or royalty fees, to use, copy, modify, and distribute this
   9  * software and its documentation for any purpose, provided that the
  10  * above copyright notice and the following two paragraphs appear in
  11  * all copies of this software.
  12  *
  13  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  15  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  16  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  17  * DAMAGE.
  18  *
  19  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  20  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  21  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  22  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  23  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  24  *
  25  * Red Hat Author(s): Behdad Esfahbod
  26  * Google Author(s): Behdad Esfahbod
  27  */
  28
  29 #if !defined(HB_H_IN) && !defined(HB_NO_SINGLE_HEADER_ERROR)
  30 #error "Include <hb.h> instead."
  31 #endif
  32
  33 #ifndef HB_COMMON_H
  34 #define HB_COMMON_H
  35
  36 #ifndef HB_EXTERN
  37 #define HB_EXTERN extern
  38 #endif
  39
  40 #ifndef HB_BEGIN_DECLS
  41 # ifdef __cplusplus
  42 #  define HB_BEGIN_DECLS        extern "C" {
  43 #  define HB_END_DECLS          }
  44 # else /* !__cplusplus */
  45 #  define HB_BEGIN_DECLS
  46 #  define HB_END_DECLS
  47 # endif /* !__cplusplus */
  48 #endif
  49
  50 #if defined (_SVR4) || defined (SVR4) || defined (__OpenBSD__) || \
  51     defined (_sgi) || defined (__sun) || defined (sun) || \
  52     defined (__digital__) || defined (__HP_cc)
  53 #  include <inttypes.h>
  54 #elif defined (_AIX)
  55 #  include <sys/inttypes.h>
  56 #elif defined (_MSC_VER) && _MSC_VER < 1600
  57 /* VS 2010 (_MSC_VER 1600) has stdint.h */
  58 typedef __int8 int8_t;
  59 typedef unsigned __int8 uint8_t;
  60 typedef __int16 int16_t;
  61 typedef unsigned __int16 uint16_t;
  62 typedef __int32 int32_t;
  63 typedef unsigned __int32 uint32_t;
  64 typedef __int64 int64_t;
  65 typedef unsigned __int64 uint64_t;
  66 #elif defined (__KERNEL__)
  67 #  include <linux/types.h>
  68 #else
  69 #  include <stdint.h>
  70 #endif
  71
  72 #if defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
  73 #define HB_DEPRECATED __attribute__((__deprecated__))
  74 #elif defined(_MSC_VER) && (_MSC_VER >= 1300)
  75 #define HB_DEPRECATED __declspec(deprecated)
  76 #else
  77 #define HB_DEPRECATED
  78 #endif
  79
  80 #if defined(__GNUC__) && ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
  81 #define HB_DEPRECATED_FOR(f) __attribute__((__deprecated__("Use '" #f "' instead")))
  82 #elif defined(_MSC_FULL_VER) && (_MSC_FULL_VER > 140050320)
  83 #define HB_DEPRECATED_FOR(f) __declspec(deprecated("is deprecated. Use '" #f "' instead"))
  84 #else
  85 #define HB_DEPRECATED_FOR(f) HB_DEPRECATED
  86 #endif
  87
  88
  89 HB_BEGIN_DECLS
  90
  91 /**
  92  * hb_bool_t:
  93  *
  94  * Data type for booleans.
  95  *
  96  **/
  97 typedef int hb_bool_t;
  98
  99 /**
 100  * hb_codepoint_t:
 101  *
 102  * Data type for holding Unicode codepoints. Also
 103  * used to hold glyph IDs.
 104  *
 105  **/
 106 typedef uint32_t hb_codepoint_t;
 107 /**
 108  * hb_position_t:
 109  *
 110  * Data type for holding a single coordinate value.
 111  * Contour points and other multi-dimensional data are
 112  * stored as tuples of #hb_position_t's.
 113  *
 114  **/
 115 typedef int32_t hb_position_t;
 116 /**
 117  * hb_mask_t:
 118  *
 119  * Data type for bitmasks.
 120  *
 121  **/
 122 typedef uint32_t hb_mask_t;
 123
 124 typedef union _hb_var_int_t {
 125   uint32_t u32;
 126   int32_t i32;
 127   uint16_t u16[2];
 128   int16_t i16[2];
 129   uint8_t u8[4];
 130   int8_t i8[4];
 131 } hb_var_int_t;
 132
 133
 134 /* hb_tag_t */
 135
 136 /**
 137  * hb_tag_t:
 138  *
 139  * Data type for tag identifiers. Tags are four
 140  * byte integers, each byte representing a character.
 141  *
 142  * Tags are used to identify tables, design-variation axes,
 143  * scripts, languages, font features, and baselines with
 144  * human-readable names.
 145  *
 146  **/
 147 typedef uint32_t hb_tag_t;
 148
 149 /**
 150  * HB_TAG:
 151  * @c1: 1st character of the tag
 152  * @c2: 2nd character of the tag
 153  * @c3: 3rd character of the tag
 154  * @c4: 4th character of the tag
 155  *
 156  * Constructs an #hb_tag_t from four character literals.
 157  *
 158  **/
 159 #define HB_TAG(c1,c2,c3,c4) ((hb_tag_t)((((uint32_t)(c1)&0xFF)<<24)|(((uint32_t)(c2)&0xFF)<<16)|(((uint32_t)(c3)&0xFF)<<8)|((uint32_t)(c4)&0xFF)))
 160
 161 /**
 162  * HB_UNTAG:
 163  * @tag: an #hb_tag_t
 164  *
 165  * Extracts four character literals from an #hb_tag_t.
 166  *
 167  * Since: 0.6.0
 168  *
 169  **/
 170 #define HB_UNTAG(tag)   (uint8_t)(((tag)>>24)&0xFF), (uint8_t)(((tag)>>16)&0xFF), (uint8_t)(((tag)>>8)&0xFF), (uint8_t)((tag)&0xFF)
 171
 172 /**
 173  * HB_TAG_NONE:
 174  *
 175  * Unset #hb_tag_t.
 176  */
 177 #define HB_TAG_NONE HB_TAG(0,0,0,0)
 178 /**
 179  * HB_TAG_MAX:
 180  *
 181  * Maximum possible unsigned #hb_tag_t.
 182  *
 183  * Since: 0.9.26
 184  */
 185 #define HB_TAG_MAX HB_TAG(0xff,0xff,0xff,0xff)
 186 /**
 187  * HB_TAG_MAX_SIGNED:
 188  *
 189  * Maximum possible signed #hb_tag_t.
 190  *
 191  * Since: 0.9.33
 192  */
 193 #define HB_TAG_MAX_SIGNED HB_TAG(0x7f,0xff,0xff,0xff)
 194
 195 /* len=-1 means str is NUL-terminated. */
 196 HB_EXTERN hb_tag_t
 197 hb_tag_from_string (const char *str, int len);
 198
 199 /* buf should have 4 bytes. */
 200 HB_EXTERN void
 201 hb_tag_to_string (hb_tag_t tag, char *buf);
 202
 203
 204 /**
 205  * hb_direction_t:
 206  * @HB_DIRECTION_INVALID: Initial, unset direction.
 207  * @HB_DIRECTION_LTR: Text is set horizontally from left to right.
 208  * @HB_DIRECTION_RTL: Text is set horizontally from right to left.
 209  * @HB_DIRECTION_TTB: Text is set vertically from top to bottom.
 210  * @HB_DIRECTION_BTT: Text is set vertically from bottom to top.
 211  *
 212  * The direction of a text segment or buffer.
 213  *
 214  * A segment can also be tested for horizontal or vertical
 215  * orientation (irrespective of specific direction) with
 216  * HB_DIRECTION_IS_HORIZONTAL() or HB_DIRECTION_IS_VERTICAL().
 217  *
 218  */
 219 typedef enum {
 220   HB_DIRECTION_INVALID = 0,
 221   HB_DIRECTION_LTR = 4,
 222   HB_DIRECTION_RTL,
 223   HB_DIRECTION_TTB,
 224   HB_DIRECTION_BTT
 225 } hb_direction_t;
 226
 227 /* len=-1 means str is NUL-terminated */
 228 HB_EXTERN hb_direction_t
 229 hb_direction_from_string (const char *str, int len);
 230
 231 HB_EXTERN const char *
 232 hb_direction_to_string (hb_direction_t direction);
 233
 234 /**
 235  * HB_DIRECTION_IS_VALID:
 236  * @dir: #hb_direction_t to test
 237  *
 238  * Tests whether a text direction is valid.
 239  *
 240  **/
 241 #define HB_DIRECTION_IS_VALID(dir)      ((((unsigned int) (dir)) & ~3U) == 4)
 242 /* Direction must be valid for the following */
 243 /**
 244  * HB_DIRECTION_IS_HORIZONTAL:
 245  * @dir: #hb_direction_t to test
 246  *
 247  * Tests whether a text direction is horizontal. Requires
 248  * that the direction be valid.
 249  *
 250  **/
 251 #define HB_DIRECTION_IS_HORIZONTAL(dir) ((((unsigned int) (dir)) & ~1U) == 4)
 252 /**
 253  * HB_DIRECTION_IS_VERTICAL:
 254  * @dir: #hb_direction_t to test
 255  *
 256  * Tests whether a text direction is vertical. Requires
 257  * that the direction be valid.
 258  *
 259  **/
 260 #define HB_DIRECTION_IS_VERTICAL(dir)   ((((unsigned int) (dir)) & ~1U) == 6)
 261 /**
 262  * HB_DIRECTION_IS_FORWARD:
 263  * @dir: #hb_direction_t to test
 264  *
 265  * Tests whether a text direction moves forward (from left to right, or from
 266  * top to bottom). Requires that the direction be valid.
 267  *
 268  **/
 269 #define HB_DIRECTION_IS_FORWARD(dir)    ((((unsigned int) (dir)) & ~2U) == 4)
 270 /**
 271  * HB_DIRECTION_IS_BACKWARD:
 272  * @dir: #hb_direction_t to test
 273  *
 274  * Tests whether a text direction moves backward (from right to left, or from
 275  * bottom to top). Requires that the direction be valid.
 276  *
 277  **/
 278 #define HB_DIRECTION_IS_BACKWARD(dir)   ((((unsigned int) (dir)) & ~2U) == 5)
 279 /**
 280  * HB_DIRECTION_REVERSE:
 281  * @dir: #hb_direction_t to reverse
 282  *
 283  * Reverses a text direction. Requires that the direction
 284  * be valid.
 285  *
 286  **/
 287 #define HB_DIRECTION_REVERSE(dir)       ((hb_direction_t) (((unsigned int) (dir)) ^ 1))
 288
 289
 290 /* hb_language_t */
 291
 292 /**
 293  * hb_language_t:
 294  *
 295  * Data type for languages. Each #hb_language_t corresponds to a BCP 47
 296  * language tag.
 297  *
 298  */
 299 typedef const struct hb_language_impl_t *hb_language_t;
 300
 301 HB_EXTERN hb_language_t
 302 hb_language_from_string (const char *str, int len);
 303
 304 HB_EXTERN const char *
 305 hb_language_to_string (hb_language_t language);
 306
 307 /**
 308  * HB_LANGUAGE_INVALID:
 309  *
 310  * An unset #hb_language_t.
 311  *
 312  * Since: 0.6.0
 313  */
 314 #define HB_LANGUAGE_INVALID ((hb_language_t) 0)
 315
 316 HB_EXTERN hb_language_t
 317 hb_language_get_default (void);
 318
 319
 320 /**
 321  * hb_script_t:
 322  * @HB_SCRIPT_COMMON: `Zyyy`
 323  * @HB_SCRIPT_INHERITED: `Zinh`
 324  * @HB_SCRIPT_UNKNOWN: `Zzzz`
 325  * @HB_SCRIPT_ARABIC: `Arab`
 326  * @HB_SCRIPT_ARMENIAN: `Armn`
 327  * @HB_SCRIPT_BENGALI: `Beng`
 328  * @HB_SCRIPT_CYRILLIC: `Cyrl`
 329  * @HB_SCRIPT_DEVANAGARI: `Deva`
 330  * @HB_SCRIPT_GEORGIAN: `Geor`
 331  * @HB_SCRIPT_GREEK: `Grek`
 332  * @HB_SCRIPT_GUJARATI: `Gujr`
 333  * @HB_SCRIPT_GURMUKHI: `Guru`
 334  * @HB_SCRIPT_HANGUL: `Hang`
 335  * @HB_SCRIPT_HAN: `Hani`
 336  * @HB_SCRIPT_HEBREW: `Hebr`
 337  * @HB_SCRIPT_HIRAGANA: `Hira`
 338  * @HB_SCRIPT_KANNADA: `Knda`
 339  * @HB_SCRIPT_KATAKANA: `Kana`
 340  * @HB_SCRIPT_LAO: `Laoo`
 341  * @HB_SCRIPT_LATIN: `Latn`
 342  * @HB_SCRIPT_MALAYALAM: `Mlym`
 343  * @HB_SCRIPT_ORIYA: `Orya`
 344  * @HB_SCRIPT_TAMIL: `Taml`
 345  * @HB_SCRIPT_TELUGU: `Telu`
 346  * @HB_SCRIPT_THAI: `Thai`
 347  * @HB_SCRIPT_TIBETAN: `Tibt`
 348  * @HB_SCRIPT_BOPOMOFO: `Bopo`
 349  * @HB_SCRIPT_BRAILLE: `Brai`
 350  * @HB_SCRIPT_CANADIAN_SYLLABICS: `Cans`
 351  * @HB_SCRIPT_CHEROKEE: `Cher`
 352  * @HB_SCRIPT_ETHIOPIC: `Ethi`
 353  * @HB_SCRIPT_KHMER: `Khmr`
 354  * @HB_SCRIPT_MONGOLIAN: `Mong`
 355  * @HB_SCRIPT_MYANMAR: `Mymr`
 356  * @HB_SCRIPT_OGHAM: `Ogam`
 357  * @HB_SCRIPT_RUNIC: `Runr`
 358  * @HB_SCRIPT_SINHALA: `Sinh`
 359  * @HB_SCRIPT_SYRIAC: `Syrc`
 360  * @HB_SCRIPT_THAANA: `Thaa`
 361  * @HB_SCRIPT_YI: `Yiii`
 362  * @HB_SCRIPT_DESERET: `Dsrt`
 363  * @HB_SCRIPT_GOTHIC: `Goth`
 364  * @HB_SCRIPT_OLD_ITALIC: `Ital`
 365  * @HB_SCRIPT_BUHID: `Buhd`
 366  * @HB_SCRIPT_HANUNOO: `Hano`
 367  * @HB_SCRIPT_TAGALOG: `Tglg`
 368  * @HB_SCRIPT_TAGBANWA: `Tagb`
 369  * @HB_SCRIPT_CYPRIOT: `Cprt`
 370  * @HB_SCRIPT_LIMBU: `Limb`
 371  * @HB_SCRIPT_LINEAR_B: `Linb`
 372  * @HB_SCRIPT_OSMANYA: `Osma`
 373  * @HB_SCRIPT_SHAVIAN: `Shaw`
 374  * @HB_SCRIPT_TAI_LE: `Tale`
 375  * @HB_SCRIPT_UGARITIC: `Ugar`
 376  * @HB_SCRIPT_BUGINESE: `Bugi`
 377  * @HB_SCRIPT_COPTIC: `Copt`
 378  * @HB_SCRIPT_GLAGOLITIC: `Glag`
 379  * @HB_SCRIPT_KHAROSHTHI: `Khar`
 380  * @HB_SCRIPT_NEW_TAI_LUE: `Talu`
 381  * @HB_SCRIPT_OLD_PERSIAN: `Xpeo`
 382  * @HB_SCRIPT_SYLOTI_NAGRI: `Sylo`
 383  * @HB_SCRIPT_TIFINAGH: `Tfng`
 384  * @HB_SCRIPT_BALINESE: `Bali`
 385  * @HB_SCRIPT_CUNEIFORM: `Xsux`
 386  * @HB_SCRIPT_NKO: `Nkoo`
 387  * @HB_SCRIPT_PHAGS_PA: `Phag`
 388  * @HB_SCRIPT_PHOENICIAN: `Phnx`
 389  * @HB_SCRIPT_CARIAN: `Cari`
 390  * @HB_SCRIPT_CHAM: `Cham`
 391  * @HB_SCRIPT_KAYAH_LI: `Kali`
 392  * @HB_SCRIPT_LEPCHA: `Lepc`
 393  * @HB_SCRIPT_LYCIAN: `Lyci`
 394  * @HB_SCRIPT_LYDIAN: `Lydi`
 395  * @HB_SCRIPT_OL_CHIKI: `Olck`
 396  * @HB_SCRIPT_REJANG: `Rjng`
 397  * @HB_SCRIPT_SAURASHTRA: `Saur`
 398  * @HB_SCRIPT_SUNDANESE: `Sund`
 399  * @HB_SCRIPT_VAI: `Vaii`
 400  * @HB_SCRIPT_AVESTAN: `Avst`
 401  * @HB_SCRIPT_BAMUM: `Bamu`
 402  * @HB_SCRIPT_EGYPTIAN_HIEROGLYPHS: `Egyp`
 403  * @HB_SCRIPT_IMPERIAL_ARAMAIC: `Armi`
 404  * @HB_SCRIPT_INSCRIPTIONAL_PAHLAVI: `Phli`
 405  * @HB_SCRIPT_INSCRIPTIONAL_PARTHIAN: `Prti`
 406  * @HB_SCRIPT_JAVANESE: `Java`
 407  * @HB_SCRIPT_KAITHI: `Kthi`
 408  * @HB_SCRIPT_LISU: `Lisu`
 409  * @HB_SCRIPT_MEETEI_MAYEK: `Mtei`
 410  * @HB_SCRIPT_OLD_SOUTH_ARABIAN: `Sarb`
 411  * @HB_SCRIPT_OLD_TURKIC: `Orkh`
 412  * @HB_SCRIPT_SAMARITAN: `Samr`
 413  * @HB_SCRIPT_TAI_THAM: `Lana`
 414  * @HB_SCRIPT_TAI_VIET: `Tavt`
 415  * @HB_SCRIPT_BATAK: `Batk`
 416  * @HB_SCRIPT_BRAHMI: `Brah`
 417  * @HB_SCRIPT_MANDAIC: `Mand`
 418  * @HB_SCRIPT_CHAKMA: `Cakm`
 419  * @HB_SCRIPT_MEROITIC_CURSIVE: `Merc`
 420  * @HB_SCRIPT_MEROITIC_HIEROGLYPHS: `Mero`
 421  * @HB_SCRIPT_MIAO: `Plrd`
 422  * @HB_SCRIPT_SHARADA: `Shrd`
 423  * @HB_SCRIPT_SORA_SOMPENG: `Sora`
 424  * @HB_SCRIPT_TAKRI: `Takr`
 425  * @HB_SCRIPT_BASSA_VAH: `Bass`, Since: 0.9.30
 426  * @HB_SCRIPT_CAUCASIAN_ALBANIAN: `Aghb`, Since: 0.9.30
 427  * @HB_SCRIPT_DUPLOYAN: `Dupl`, Since: 0.9.30
 428  * @HB_SCRIPT_ELBASAN: `Elba`, Since: 0.9.30
 429  * @HB_SCRIPT_GRANTHA: `Gran`, Since: 0.9.30
 430  * @HB_SCRIPT_KHOJKI: `Khoj`, Since: 0.9.30
 431  * @HB_SCRIPT_KHUDAWADI: `Sind`, Since: 0.9.30
 432  * @HB_SCRIPT_LINEAR_A: `Lina`, Since: 0.9.30
 433  * @HB_SCRIPT_MAHAJANI: `Mahj`, Since: 0.9.30
 434  * @HB_SCRIPT_MANICHAEAN: `Mani`, Since: 0.9.30
 435  * @HB_SCRIPT_MENDE_KIKAKUI: `Mend`, Since: 0.9.30
 436  * @HB_SCRIPT_MODI: `Modi`, Since: 0.9.30
 437  * @HB_SCRIPT_MRO: `Mroo`, Since: 0.9.30
 438  * @HB_SCRIPT_NABATAEAN: `Nbat`, Since: 0.9.30
 439  * @HB_SCRIPT_OLD_NORTH_ARABIAN: `Narb`, Since: 0.9.30
 440  * @HB_SCRIPT_OLD_PERMIC: `Perm`, Since: 0.9.30
 441  * @HB_SCRIPT_PAHAWH_HMONG: `Hmng`, Since: 0.9.30
 442  * @HB_SCRIPT_PALMYRENE: `Palm`, Since: 0.9.30
 443  * @HB_SCRIPT_PAU_CIN_HAU: `Pauc`, Since: 0.9.30
 444  * @HB_SCRIPT_PSALTER_PAHLAVI: `Phlp`, Since: 0.9.30
 445  * @HB_SCRIPT_SIDDHAM: `Sidd`, Since: 0.9.30
 446  * @HB_SCRIPT_TIRHUTA: `Tirh`, Since: 0.9.30
 447  * @HB_SCRIPT_WARANG_CITI: `Wara`, Since: 0.9.30
 448  * @HB_SCRIPT_AHOM: `Ahom`, Since: 0.9.30
 449  * @HB_SCRIPT_ANATOLIAN_HIEROGLYPHS: `Hluw`, Since: 0.9.30
 450  * @HB_SCRIPT_HATRAN: `Hatr`, Since: 0.9.30
 451  * @HB_SCRIPT_MULTANI: `Mult`, Since: 0.9.30
 452  * @HB_SCRIPT_OLD_HUNGARIAN: `Hung`, Since: 0.9.30
 453  * @HB_SCRIPT_SIGNWRITING: `Sgnw`, Since: 0.9.30
 454  * @HB_SCRIPT_ADLAM: `Adlm`, Since: 1.3.0
 455  * @HB_SCRIPT_BHAIKSUKI: `Bhks`, Since: 1.3.0
 456  * @HB_SCRIPT_MARCHEN: `Marc`, Since: 1.3.0
 457  * @HB_SCRIPT_OSAGE: `Osge`, Since: 1.3.0
 458  * @HB_SCRIPT_TANGUT: `Tang`, Since: 1.3.0
 459  * @HB_SCRIPT_NEWA: `Newa`, Since: 1.3.0
 460  * @HB_SCRIPT_MASARAM_GONDI: `Gonm`, Since: 1.6.0
 461  * @HB_SCRIPT_NUSHU: `Nshu`, Since: 1.6.0
 462  * @HB_SCRIPT_SOYOMBO: `Soyo`, Since: 1.6.0
 463  * @HB_SCRIPT_ZANABAZAR_SQUARE: `Zanb`, Since: 1.6.0
 464  * @HB_SCRIPT_DOGRA: `Dogr`, Since: 1.8.0
 465  * @HB_SCRIPT_GUNJALA_GONDI: `Gong`, Since: 1.8.0
 466  * @HB_SCRIPT_HANIFI_ROHINGYA: `Rohg`, Since: 1.8.0
 467  * @HB_SCRIPT_MAKASAR: `Maka`, Since: 1.8.0
 468  * @HB_SCRIPT_MEDEFAIDRIN: `Medf`, Since: 1.8.0
 469  * @HB_SCRIPT_OLD_SOGDIAN: `Sogo`, Since: 1.8.0
 470  * @HB_SCRIPT_SOGDIAN: `Sogd`, Since: 1.8.0
 471  * @HB_SCRIPT_ELYMAIC: `Elym`, Since: 2.4.0
 472  * @HB_SCRIPT_NANDINAGARI: `Nand`, Since: 2.4.0
 473  * @HB_SCRIPT_NYIAKENG_PUACHUE_HMONG: `Hmnp`, Since: 2.4.0
 474  * @HB_SCRIPT_WANCHO: `Wcho`, Since: 2.4.0
 475  * @HB_SCRIPT_CHORASMIAN: `Chrs`, Since: 2.6.7
 476  * @HB_SCRIPT_DIVES_AKURU: `Diak`, Since: 2.6.7
 477  * @HB_SCRIPT_KHITAN_SMALL_SCRIPT: `Kits`, Since: 2.6.7
 478  * @HB_SCRIPT_YEZIDI: `Yezi`, Since: 2.6.7
 479  * @HB_SCRIPT_CYPRO_MINOAN: `Cpmn`, Since: 3.0.0
 480  * @HB_SCRIPT_OLD_UYGHUR: `Ougr`, Since: 3.0.0
 481  * @HB_SCRIPT_TANGSA: `Tnsa`, Since: 3.0.0
 482  * @HB_SCRIPT_TOTO: `Toto`, Since: 3.0.0
 483  * @HB_SCRIPT_VITHKUQI: `Vith`, Since: 3.0.0
 484  * @HB_SCRIPT_MATH: `Zmth`, Since: 3.4.0
 485  * @HB_SCRIPT_INVALID: No script set
 486  *
 487  * Data type for scripts. Each #hb_script_t's value is an #hb_tag_t corresponding
 488  * to the four-letter values defined by [ISO 15924](https://unicode.org/iso15924/).
 489  *
 490  * See also the Script (sc) property of the Unicode Character Database.
 491  *
 492  **/
 493
 494 /* https://docs.google.com/spreadsheets/d/1Y90M0Ie3MUJ6UVCRDOypOtijlMDLNNyyLk36T6iMu0o */
 495 typedef enum
 496 {
 497   HB_SCRIPT_COMMON                      = HB_TAG ('Z','y','y','y'), /*1.1*/
 498   HB_SCRIPT_INHERITED                   = HB_TAG ('Z','i','n','h'), /*1.1*/
 499   HB_SCRIPT_UNKNOWN                     = HB_TAG ('Z','z','z','z'), /*5.0*/
 500
 501   HB_SCRIPT_ARABIC                      = HB_TAG ('A','r','a','b'), /*1.1*/
 502   HB_SCRIPT_ARMENIAN                    = HB_TAG ('A','r','m','n'), /*1.1*/
 503   HB_SCRIPT_BENGALI                     = HB_TAG ('B','e','n','g'), /*1.1*/
 504   HB_SCRIPT_CYRILLIC                    = HB_TAG ('C','y','r','l'), /*1.1*/
 505   HB_SCRIPT_DEVANAGARI                  = HB_TAG ('D','e','v','a'), /*1.1*/
 506   HB_SCRIPT_GEORGIAN                    = HB_TAG ('G','e','o','r'), /*1.1*/
 507   HB_SCRIPT_GREEK                       = HB_TAG ('G','r','e','k'), /*1.1*/
 508   HB_SCRIPT_GUJARATI                    = HB_TAG ('G','u','j','r'), /*1.1*/
 509   HB_SCRIPT_GURMUKHI                    = HB_TAG ('G','u','r','u'), /*1.1*/
 510   HB_SCRIPT_HANGUL                      = HB_TAG ('H','a','n','g'), /*1.1*/
 511   HB_SCRIPT_HAN                         = HB_TAG ('H','a','n','i'), /*1.1*/
 512   HB_SCRIPT_HEBREW                      = HB_TAG ('H','e','b','r'), /*1.1*/
 513   HB_SCRIPT_HIRAGANA                    = HB_TAG ('H','i','r','a'), /*1.1*/
 514   HB_SCRIPT_KANNADA                     = HB_TAG ('K','n','d','a'), /*1.1*/
 515   HB_SCRIPT_KATAKANA                    = HB_TAG ('K','a','n','a'), /*1.1*/
 516   HB_SCRIPT_LAO                         = HB_TAG ('L','a','o','o'), /*1.1*/
 517   HB_SCRIPT_LATIN                       = HB_TAG ('L','a','t','n'), /*1.1*/
 518   HB_SCRIPT_MALAYALAM                   = HB_TAG ('M','l','y','m'), /*1.1*/
 519   HB_SCRIPT_ORIYA                       = HB_TAG ('O','r','y','a'), /*1.1*/
 520   HB_SCRIPT_TAMIL                       = HB_TAG ('T','a','m','l'), /*1.1*/
 521   HB_SCRIPT_TELUGU                      = HB_TAG ('T','e','l','u'), /*1.1*/
 522   HB_SCRIPT_THAI                        = HB_TAG ('T','h','a','i'), /*1.1*/
 523
 524   HB_SCRIPT_TIBETAN                     = HB_TAG ('T','i','b','t'), /*2.0*/
 525
 526   HB_SCRIPT_BOPOMOFO                    = HB_TAG ('B','o','p','o'), /*3.0*/
 527   HB_SCRIPT_BRAILLE                     = HB_TAG ('B','r','a','i'), /*3.0*/
 528   HB_SCRIPT_CANADIAN_SYLLABICS          = HB_TAG ('C','a','n','s'), /*3.0*/
 529   HB_SCRIPT_CHEROKEE                    = HB_TAG ('C','h','e','r'), /*3.0*/
 530   HB_SCRIPT_ETHIOPIC                    = HB_TAG ('E','t','h','i'), /*3.0*/
 531   HB_SCRIPT_KHMER                       = HB_TAG ('K','h','m','r'), /*3.0*/
 532   HB_SCRIPT_MONGOLIAN                   = HB_TAG ('M','o','n','g'), /*3.0*/
 533   HB_SCRIPT_MYANMAR                     = HB_TAG ('M','y','m','r'), /*3.0*/
 534   HB_SCRIPT_OGHAM                       = HB_TAG ('O','g','a','m'), /*3.0*/
 535   HB_SCRIPT_RUNIC                       = HB_TAG ('R','u','n','r'), /*3.0*/
 536   HB_SCRIPT_SINHALA                     = HB_TAG ('S','i','n','h'), /*3.0*/
 537   HB_SCRIPT_SYRIAC                      = HB_TAG ('S','y','r','c'), /*3.0*/
 538   HB_SCRIPT_THAANA                      = HB_TAG ('T','h','a','a'), /*3.0*/
 539   HB_SCRIPT_YI                          = HB_TAG ('Y','i','i','i'), /*3.0*/
 540
 541   HB_SCRIPT_DESERET                     = HB_TAG ('D','s','r','t'), /*3.1*/
 542   HB_SCRIPT_GOTHIC                      = HB_TAG ('G','o','t','h'), /*3.1*/
 543   HB_SCRIPT_OLD_ITALIC                  = HB_TAG ('I','t','a','l'), /*3.1*/
 544
 545   HB_SCRIPT_BUHID                       = HB_TAG ('B','u','h','d'), /*3.2*/
 546   HB_SCRIPT_HANUNOO                     = HB_TAG ('H','a','n','o'), /*3.2*/
 547   HB_SCRIPT_TAGALOG                     = HB_TAG ('T','g','l','g'), /*3.2*/
 548   HB_SCRIPT_TAGBANWA                    = HB_TAG ('T','a','g','b'), /*3.2*/
 549
 550   HB_SCRIPT_CYPRIOT                     = HB_TAG ('C','p','r','t'), /*4.0*/
 551   HB_SCRIPT_LIMBU                       = HB_TAG ('L','i','m','b'), /*4.0*/
 552   HB_SCRIPT_LINEAR_B                    = HB_TAG ('L','i','n','b'), /*4.0*/
 553   HB_SCRIPT_OSMANYA                     = HB_TAG ('O','s','m','a'), /*4.0*/
 554   HB_SCRIPT_SHAVIAN                     = HB_TAG ('S','h','a','w'), /*4.0*/
 555   HB_SCRIPT_TAI_LE                      = HB_TAG ('T','a','l','e'), /*4.0*/
 556   HB_SCRIPT_UGARITIC                    = HB_TAG ('U','g','a','r'), /*4.0*/
 557
 558   HB_SCRIPT_BUGINESE                    = HB_TAG ('B','u','g','i'), /*4.1*/
 559   HB_SCRIPT_COPTIC                      = HB_TAG ('C','o','p','t'), /*4.1*/
 560   HB_SCRIPT_GLAGOLITIC                  = HB_TAG ('G','l','a','g'), /*4.1*/
 561   HB_SCRIPT_KHAROSHTHI                  = HB_TAG ('K','h','a','r'), /*4.1*/
 562   HB_SCRIPT_NEW_TAI_LUE                 = HB_TAG ('T','a','l','u'), /*4.1*/
 563   HB_SCRIPT_OLD_PERSIAN                 = HB_TAG ('X','p','e','o'), /*4.1*/
 564   HB_SCRIPT_SYLOTI_NAGRI                = HB_TAG ('S','y','l','o'), /*4.1*/
 565   HB_SCRIPT_TIFINAGH                    = HB_TAG ('T','f','n','g'), /*4.1*/
 566
 567   HB_SCRIPT_BALINESE                    = HB_TAG ('B','a','l','i'), /*5.0*/
 568   HB_SCRIPT_CUNEIFORM                   = HB_TAG ('X','s','u','x'), /*5.0*/
 569   HB_SCRIPT_NKO                         = HB_TAG ('N','k','o','o'), /*5.0*/
 570   HB_SCRIPT_PHAGS_PA                    = HB_TAG ('P','h','a','g'), /*5.0*/
 571   HB_SCRIPT_PHOENICIAN                  = HB_TAG ('P','h','n','x'), /*5.0*/
 572
 573   HB_SCRIPT_CARIAN                      = HB_TAG ('C','a','r','i'), /*5.1*/
 574   HB_SCRIPT_CHAM                        = HB_TAG ('C','h','a','m'), /*5.1*/
 575   HB_SCRIPT_KAYAH_LI                    = HB_TAG ('K','a','l','i'), /*5.1*/
 576   HB_SCRIPT_LEPCHA                      = HB_TAG ('L','e','p','c'), /*5.1*/
 577   HB_SCRIPT_LYCIAN                      = HB_TAG ('L','y','c','i'), /*5.1*/
 578   HB_SCRIPT_LYDIAN                      = HB_TAG ('L','y','d','i'), /*5.1*/
 579   HB_SCRIPT_OL_CHIKI                    = HB_TAG ('O','l','c','k'), /*5.1*/
 580   HB_SCRIPT_REJANG                      = HB_TAG ('R','j','n','g'), /*5.1*/
 581   HB_SCRIPT_SAURASHTRA                  = HB_TAG ('S','a','u','r'), /*5.1*/
 582   HB_SCRIPT_SUNDANESE                   = HB_TAG ('S','u','n','d'), /*5.1*/
 583   HB_SCRIPT_VAI                         = HB_TAG ('V','a','i','i'), /*5.1*/
 584
 585   HB_SCRIPT_AVESTAN                     = HB_TAG ('A','v','s','t'), /*5.2*/
 586   HB_SCRIPT_BAMUM                       = HB_TAG ('B','a','m','u'), /*5.2*/
 587   HB_SCRIPT_EGYPTIAN_HIEROGLYPHS        = HB_TAG ('E','g','y','p'), /*5.2*/
 588   HB_SCRIPT_IMPERIAL_ARAMAIC            = HB_TAG ('A','r','m','i'), /*5.2*/
 589   HB_SCRIPT_INSCRIPTIONAL_PAHLAVI       = HB_TAG ('P','h','l','i'), /*5.2*/
 590   HB_SCRIPT_INSCRIPTIONAL_PARTHIAN      = HB_TAG ('P','r','t','i'), /*5.2*/
 591   HB_SCRIPT_JAVANESE                    = HB_TAG ('J','a','v','a'), /*5.2*/
 592   HB_SCRIPT_KAITHI                      = HB_TAG ('K','t','h','i'), /*5.2*/
 593   HB_SCRIPT_LISU                        = HB_TAG ('L','i','s','u'), /*5.2*/
 594   HB_SCRIPT_MEETEI_MAYEK                = HB_TAG ('M','t','e','i'), /*5.2*/
 595   HB_SCRIPT_OLD_SOUTH_ARABIAN           = HB_TAG ('S','a','r','b'), /*5.2*/
 596   HB_SCRIPT_OLD_TURKIC                  = HB_TAG ('O','r','k','h'), /*5.2*/
 597   HB_SCRIPT_SAMARITAN                   = HB_TAG ('S','a','m','r'), /*5.2*/
 598   HB_SCRIPT_TAI_THAM                    = HB_TAG ('L','a','n','a'), /*5.2*/
 599   HB_SCRIPT_TAI_VIET                    = HB_TAG ('T','a','v','t'), /*5.2*/
 600
 601   HB_SCRIPT_BATAK                       = HB_TAG ('B','a','t','k'), /*6.0*/
 602   HB_SCRIPT_BRAHMI                      = HB_TAG ('B','r','a','h'), /*6.0*/
 603   HB_SCRIPT_MANDAIC                     = HB_TAG ('M','a','n','d'), /*6.0*/
 604
 605   HB_SCRIPT_CHAKMA                      = HB_TAG ('C','a','k','m'), /*6.1*/
 606   HB_SCRIPT_MEROITIC_CURSIVE            = HB_TAG ('M','e','r','c'), /*6.1*/
 607   HB_SCRIPT_MEROITIC_HIEROGLYPHS        = HB_TAG ('M','e','r','o'), /*6.1*/
 608   HB_SCRIPT_MIAO                        = HB_TAG ('P','l','r','d'), /*6.1*/
 609   HB_SCRIPT_SHARADA                     = HB_TAG ('S','h','r','d'), /*6.1*/
 610   HB_SCRIPT_SORA_SOMPENG                = HB_TAG ('S','o','r','a'), /*6.1*/
 611   HB_SCRIPT_TAKRI                       = HB_TAG ('T','a','k','r'), /*6.1*/
 612
 613   /*
 614    * Since: 0.9.30
 615    */
 616   HB_SCRIPT_BASSA_VAH                   = HB_TAG ('B','a','s','s'), /*7.0*/
 617   HB_SCRIPT_CAUCASIAN_ALBANIAN          = HB_TAG ('A','g','h','b'), /*7.0*/
 618   HB_SCRIPT_DUPLOYAN                    = HB_TAG ('D','u','p','l'), /*7.0*/
 619   HB_SCRIPT_ELBASAN                     = HB_TAG ('E','l','b','a'), /*7.0*/
 620   HB_SCRIPT_GRANTHA                     = HB_TAG ('G','r','a','n'), /*7.0*/
 621   HB_SCRIPT_KHOJKI                      = HB_TAG ('K','h','o','j'), /*7.0*/
 622   HB_SCRIPT_KHUDAWADI                   = HB_TAG ('S','i','n','d'), /*7.0*/
 623   HB_SCRIPT_LINEAR_A                    = HB_TAG ('L','i','n','a'), /*7.0*/
 624   HB_SCRIPT_MAHAJANI                    = HB_TAG ('M','a','h','j'), /*7.0*/
 625   HB_SCRIPT_MANICHAEAN                  = HB_TAG ('M','a','n','i'), /*7.0*/
 626   HB_SCRIPT_MENDE_KIKAKUI               = HB_TAG ('M','e','n','d'), /*7.0*/
 627   HB_SCRIPT_MODI                        = HB_TAG ('M','o','d','i'), /*7.0*/
 628   HB_SCRIPT_MRO                         = HB_TAG ('M','r','o','o'), /*7.0*/
 629   HB_SCRIPT_NABATAEAN                   = HB_TAG ('N','b','a','t'), /*7.0*/
 630   HB_SCRIPT_OLD_NORTH_ARABIAN           = HB_TAG ('N','a','r','b'), /*7.0*/
 631   HB_SCRIPT_OLD_PERMIC                  = HB_TAG ('P','e','r','m'), /*7.0*/
 632   HB_SCRIPT_PAHAWH_HMONG                = HB_TAG ('H','m','n','g'), /*7.0*/
 633   HB_SCRIPT_PALMYRENE                   = HB_TAG ('P','a','l','m'), /*7.0*/
 634   HB_SCRIPT_PAU_CIN_HAU                 = HB_TAG ('P','a','u','c'), /*7.0*/
 635   HB_SCRIPT_PSALTER_PAHLAVI             = HB_TAG ('P','h','l','p'), /*7.0*/
 636   HB_SCRIPT_SIDDHAM                     = HB_TAG ('S','i','d','d'), /*7.0*/
 637   HB_SCRIPT_TIRHUTA                     = HB_TAG ('T','i','r','h'), /*7.0*/
 638   HB_SCRIPT_WARANG_CITI                 = HB_TAG ('W','a','r','a'), /*7.0*/
 639
 640   HB_SCRIPT_AHOM                        = HB_TAG ('A','h','o','m'), /*8.0*/
 641   HB_SCRIPT_ANATOLIAN_HIEROGLYPHS       = HB_TAG ('H','l','u','w'), /*8.0*/
 642   HB_SCRIPT_HATRAN                      = HB_TAG ('H','a','t','r'), /*8.0*/
 643   HB_SCRIPT_MULTANI                     = HB_TAG ('M','u','l','t'), /*8.0*/
 644   HB_SCRIPT_OLD_HUNGARIAN               = HB_TAG ('H','u','n','g'), /*8.0*/
 645   HB_SCRIPT_SIGNWRITING                 = HB_TAG ('S','g','n','w'), /*8.0*/
 646
 647   /*
 648    * Since 1.3.0
 649    */
 650   HB_SCRIPT_ADLAM                       = HB_TAG ('A','d','l','m'), /*9.0*/
 651   HB_SCRIPT_BHAIKSUKI                   = HB_TAG ('B','h','k','s'), /*9.0*/
 652   HB_SCRIPT_MARCHEN                     = HB_TAG ('M','a','r','c'), /*9.0*/
 653   HB_SCRIPT_OSAGE                       = HB_TAG ('O','s','g','e'), /*9.0*/
 654   HB_SCRIPT_TANGUT                      = HB_TAG ('T','a','n','g'), /*9.0*/
 655   HB_SCRIPT_NEWA                        = HB_TAG ('N','e','w','a'), /*9.0*/
 656
 657   /*
 658    * Since 1.6.0
 659    */
 660   HB_SCRIPT_MASARAM_GONDI               = HB_TAG ('G','o','n','m'), /*10.0*/
 661   HB_SCRIPT_NUSHU                       = HB_TAG ('N','s','h','u'), /*10.0*/
 662   HB_SCRIPT_SOYOMBO                     = HB_TAG ('S','o','y','o'), /*10.0*/
 663   HB_SCRIPT_ZANABAZAR_SQUARE            = HB_TAG ('Z','a','n','b'), /*10.0*/
 664
 665   /*
 666    * Since 1.8.0
 667    */
 668   HB_SCRIPT_DOGRA                       = HB_TAG ('D','o','g','r'), /*11.0*/
 669   HB_SCRIPT_GUNJALA_GONDI               = HB_TAG ('G','o','n','g'), /*11.0*/
 670   HB_SCRIPT_HANIFI_ROHINGYA             = HB_TAG ('R','o','h','g'), /*11.0*/
 671   HB_SCRIPT_MAKASAR                     = HB_TAG ('M','a','k','a'), /*11.0*/
 672   HB_SCRIPT_MEDEFAIDRIN                 = HB_TAG ('M','e','d','f'), /*11.0*/
 673   HB_SCRIPT_OLD_SOGDIAN                 = HB_TAG ('S','o','g','o'), /*11.0*/
 674   HB_SCRIPT_SOGDIAN                     = HB_TAG ('S','o','g','d'), /*11.0*/
 675
 676   /*
 677    * Since 2.4.0
 678    */
 679   HB_SCRIPT_ELYMAIC                     = HB_TAG ('E','l','y','m'), /*12.0*/
 680   HB_SCRIPT_NANDINAGARI                 = HB_TAG ('N','a','n','d'), /*12.0*/
 681   HB_SCRIPT_NYIAKENG_PUACHUE_HMONG      = HB_TAG ('H','m','n','p'), /*12.0*/
 682   HB_SCRIPT_WANCHO                      = HB_TAG ('W','c','h','o'), /*12.0*/
 683
 684   /*
 685    * Since 2.6.7
 686    */
 687   HB_SCRIPT_CHORASMIAN                  = HB_TAG ('C','h','r','s'), /*13.0*/
 688   HB_SCRIPT_DIVES_AKURU                 = HB_TAG ('D','i','a','k'), /*13.0*/
 689   HB_SCRIPT_KHITAN_SMALL_SCRIPT         = HB_TAG ('K','i','t','s'), /*13.0*/
 690   HB_SCRIPT_YEZIDI                      = HB_TAG ('Y','e','z','i'), /*13.0*/
 691
 692   /*
 693    * Since 3.0.0
 694    */
 695   HB_SCRIPT_CYPRO_MINOAN                = HB_TAG ('C','p','m','n'), /*14.0*/
 696   HB_SCRIPT_OLD_UYGHUR                  = HB_TAG ('O','u','g','r'), /*14.0*/
 697   HB_SCRIPT_TANGSA                      = HB_TAG ('T','n','s','a'), /*14.0*/
 698   HB_SCRIPT_TOTO                        = HB_TAG ('T','o','t','o'), /*14.0*/
 699   HB_SCRIPT_VITHKUQI                    = HB_TAG ('V','i','t','h'), /*14.0*/
 700
 701   /*
 702    * Since 3.4.0
 703    */
 704   HB_SCRIPT_MATH                        = HB_TAG ('Z','m','t','h'),
 705
 706   /* No script set. */
 707   HB_SCRIPT_INVALID                     = HB_TAG_NONE,
 708
 709   /*< private >*/
 710
 711   /* Dummy values to ensure any hb_tag_t value can be passed/stored as hb_script_t
 712    * without risking undefined behavior.  We have two, for historical reasons.
 713    * HB_TAG_MAX used to be unsigned, but that was invalid Ansi C, so was changed
 714    * to _HB_SCRIPT_MAX_VALUE to be equal to HB_TAG_MAX_SIGNED as well.
 715    *
 716    * See this thread for technicalities:
 717    *
 718    *   https://lists.freedesktop.org/archives/harfbuzz/2014-March/004150.html
 719    */
 720   _HB_SCRIPT_MAX_VALUE                          = HB_TAG_MAX_SIGNED, /*< skip >*/
 721   _HB_SCRIPT_MAX_VALUE_SIGNED                   = HB_TAG_MAX_SIGNED /*< skip >*/
 722
 723 } hb_script_t;
 724
 725
 726 /* Script functions */
 727
 728 HB_EXTERN hb_script_t
 729 hb_script_from_iso15924_tag (hb_tag_t tag);
 730
 731 HB_EXTERN hb_script_t
 732 hb_script_from_string (const char *str, int len);
 733
 734 HB_EXTERN hb_tag_t
 735 hb_script_to_iso15924_tag (hb_script_t script);
 736
 737 HB_EXTERN hb_direction_t
 738 hb_script_get_horizontal_direction (hb_script_t script);
 739
 740
 741 /* User data */
 742
 743 /**
 744  * hb_user_data_key_t:
 745  *
 746  * Data structure for holding user-data keys.
 747  *
 748  **/
 749 typedef struct hb_user_data_key_t {
 750   /*< private >*/
 751   char unused;
 752 } hb_user_data_key_t;
 753
 754 /**
 755  * hb_destroy_func_t:
 756  * @user_data: the data to be destroyed
 757  *
 758  * A virtual method for destroy user-data callbacks.
 759  *
 760  */
 761 typedef void (*hb_destroy_func_t) (void *user_data);
 762
 763
 764 /* Font features and variations. */
 765
 766 /**
 767  * HB_FEATURE_GLOBAL_START:
 768  *
 769  * Special setting for #hb_feature_t.start to apply the feature from the start
 770  * of the buffer.
 771  *
 772  * Since: 2.0.0
 773  */
 774 #define HB_FEATURE_GLOBAL_START 0
 775
 776 /**
 777  * HB_FEATURE_GLOBAL_END:
 778  *
 779  * Special setting for #hb_feature_t.end to apply the feature from to the end
 780  * of the buffer.
 781  *
 782  * Since: 2.0.0
 783  */
 784 #define HB_FEATURE_GLOBAL_END   ((unsigned int) -1)
 785
 786 /**
 787  * hb_feature_t:
 788  * @tag: The #hb_tag_t tag of the feature
 789  * @value: The value of the feature. 0 disables the feature, non-zero (usually
 790  * 1) enables the feature.  For features implemented as lookup type 3 (like
 791  * 'salt') the @value is a one based index into the alternates.
 792  * @start: the cluster to start applying this feature setting (inclusive).
 793  * @end: the cluster to end applying this feature setting (exclusive).
 794  *
 795  * The #hb_feature_t is the structure that holds information about requested
 796  * feature application. The feature will be applied with the given value to all
 797  * glyphs which are in clusters between @start (inclusive) and @end (exclusive).
 798  * Setting start to #HB_FEATURE_GLOBAL_START and end to #HB_FEATURE_GLOBAL_END
 799  * specifies that the feature always applies to the entire buffer.
 800  */
 801 typedef struct hb_feature_t {
 802   hb_tag_t      tag;
 803   uint32_t      value;
 804   unsigned int  start;
 805   unsigned int  end;
 806 } hb_feature_t;
 807
 808 HB_EXTERN hb_bool_t
 809 hb_feature_from_string (const char *str, int len,
 810                         hb_feature_t *feature);
 811
 812 HB_EXTERN void
 813 hb_feature_to_string (hb_feature_t *feature,
 814                       char *buf, unsigned int size);
 815
 816 /**
 817  * hb_variation_t:
 818  * @tag: The #hb_tag_t tag of the variation-axis name
 819  * @value: The value of the variation axis
 820  *
 821  * Data type for holding variation data. Registered OpenType
 822  * variation-axis tags are listed in
 823  * [OpenType Axis Tag Registry](https://docs.microsoft.com/en-us/typography/opentype/spec/dvaraxisreg).
 824  *
 825  * Since: 1.4.2
 826  */
 827 typedef struct hb_variation_t {
 828   hb_tag_t tag;
 829   float    value;
 830 } hb_variation_t;
 831
 832 HB_EXTERN hb_bool_t
 833 hb_variation_from_string (const char *str, int len,
 834                           hb_variation_t *variation);
 835
 836 HB_EXTERN void
 837 hb_variation_to_string (hb_variation_t *variation,
 838                         char *buf, unsigned int size);
 839
 840 /**
 841  * hb_color_t:
 842  *
 843  * Data type for holding color values. Colors are eight bits per
 844  * channel RGB plus alpha transparency.
 845  *
 846  * Since: 2.1.0
 847  */
 848 typedef uint32_t hb_color_t;
 849
 850 /**
 851  * HB_COLOR:
 852  * @b: blue channel value
 853  * @g: green channel value
 854  * @r: red channel value
 855  * @a: alpha channel value
 856  *
 857  * Constructs an #hb_color_t from four integers.
 858  *
 859  * Since: 2.1.0
 860  */
 861 #define HB_COLOR(b,g,r,a) ((hb_color_t) HB_TAG ((b),(g),(r),(a)))
 862
 863 HB_EXTERN uint8_t
 864 hb_color_get_alpha (hb_color_t color);
 865 #define hb_color_get_alpha(color)       ((color) & 0xFF)
 866
 867 HB_EXTERN uint8_t
 868 hb_color_get_red (hb_color_t color);
 869 #define hb_color_get_red(color)         (((color) >> 8) & 0xFF)
 870
 871 HB_EXTERN uint8_t
 872 hb_color_get_green (hb_color_t color);
 873 #define hb_color_get_green(color)       (((color) >> 16) & 0xFF)
 874
 875 HB_EXTERN uint8_t
 876 hb_color_get_blue (hb_color_t color);
 877 #define hb_color_get_blue(color)        (((color) >> 24) & 0xFF)
 878
 879 HB_END_DECLS
 880
 881 #endif /* HB_COMMON_H */