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