include/harfbuzz/hb-common.h

0001 /*
0002  * Copyright © 2007,2008,2009  Red Hat, Inc.
0003  * Copyright © 2011,2012  Google, Inc.
0004  *
0005  *  This is part of HarfBuzz, a text shaping library.
0006  *
0007  * Permission is hereby granted, without written agreement and without
0008  * license or royalty fees, to use, copy, modify, and distribute this
0009  * software and its documentation for any purpose, provided that the
0010  * above copyright notice and the following two paragraphs appear in
0011  * all copies of this software.
0012  *
0013  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
0014  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
0015  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
0016  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
0017  * DAMAGE.
0018  *
0019  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
0020  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
0021  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
0022  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
0023  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
0024  *
0025  * Red Hat Author(s): Behdad Esfahbod
0026  * Google Author(s): Behdad Esfahbod
0027  */
0028
0029 #if !defined(HB_H_IN) && !defined(HB_NO_SINGLE_HEADER_ERROR)
0030 #error "Include <hb.h> instead."
0031 #endif
0032
0033 #ifndef HB_COMMON_H
0034 #define HB_COMMON_H
0035
0036 #ifndef HB_EXTERN
0037 #define HB_EXTERN extern
0038 #endif
0039
0040 #ifndef HB_BEGIN_DECLS
0041 # ifdef __cplusplus
0042 #  define HB_BEGIN_DECLS    extern "C" {
0043 #  define HB_END_DECLS      }
0044 # else /* !__cplusplus */
0045 #  define HB_BEGIN_DECLS
0046 #  define HB_END_DECLS
0047 # endif /* !__cplusplus */
0048 #endif
0049
0050 #if defined (_AIX)
0051 #  include <sys/inttypes.h>
0052 #elif defined (_MSC_VER) && _MSC_VER < 1600
0053 /* VS 2010 (_MSC_VER 1600) has stdint.h   */
0054 typedef __int8 int8_t;
0055 typedef unsigned __int8 uint8_t;
0056 typedef __int16 int16_t;
0057 typedef unsigned __int16 uint16_t;
0058 typedef __int32 int32_t;
0059 typedef unsigned __int32 uint32_t;
0060 typedef __int64 int64_t;
0061 typedef unsigned __int64 uint64_t;
0062 #elif defined (_MSC_VER) && _MSC_VER < 1800
0063 /* VS 2013 (_MSC_VER 1800) has inttypes.h */
0064 #  include <stdint.h>
0065 #else
0066 #  include <inttypes.h>
0067 #endif
0068
0069 #if defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
0070 #define HB_DEPRECATED __attribute__((__deprecated__))
0071 #elif defined(_MSC_VER) && (_MSC_VER >= 1300)
0072 #define HB_DEPRECATED __declspec(deprecated)
0073 #else
0074 #define HB_DEPRECATED
0075 #endif
0076
0077 #if defined(__GNUC__) && ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
0078 #define HB_DEPRECATED_FOR(f) __attribute__((__deprecated__("Use '" #f "' instead")))
0079 #elif defined(_MSC_FULL_VER) && (_MSC_FULL_VER > 140050320)
0080 #define HB_DEPRECATED_FOR(f) __declspec(deprecated("is deprecated. Use '" #f "' instead"))
0081 #else
0082 #define HB_DEPRECATED_FOR(f) HB_DEPRECATED
0083 #endif
0084
0085
0086 HB_BEGIN_DECLS
0087
0088 /**
0089  * hb_bool_t:
0090  *
0091  * Data type for booleans.
0092  *
0093  **/
0094 typedef int hb_bool_t;
0095
0096 /**
0097  * hb_codepoint_t:
0098  *
0099  * Data type for holding Unicode codepoints. Also
0100  * used to hold glyph IDs.
0101  *
0102  **/
0103 typedef uint32_t hb_codepoint_t;
0104
0105 /**
0106  * HB_CODEPOINT_INVALID:
0107  *
0108  * Unused #hb_codepoint_t value.
0109  *
0110  * Since: 8.0.0
0111  */
0112 #define HB_CODEPOINT_INVALID ((hb_codepoint_t) -1)
0113
0114 /**
0115  * hb_position_t:
0116  *
0117  * Data type for holding a single coordinate value.
0118  * Contour points and other multi-dimensional data are
0119  * stored as tuples of #hb_position_t's.
0120  *
0121  **/
0122 typedef int32_t hb_position_t;
0123 /**
0124  * hb_mask_t:
0125  *
0126  * Data type for bitmasks.
0127  *
0128  **/
0129 typedef uint32_t hb_mask_t;
0130
0131 typedef union _hb_var_int_t {
0132   uint32_t u32;
0133   int32_t i32;
0134   uint16_t u16[2];
0135   int16_t i16[2];
0136   uint8_t u8[4];
0137   int8_t i8[4];
0138 } hb_var_int_t;
0139
0140 typedef union _hb_var_num_t {
0141   float f;
0142   uint32_t u32;
0143   int32_t i32;
0144   uint16_t u16[2];
0145   int16_t i16[2];
0146   uint8_t u8[4];
0147   int8_t i8[4];
0148 } hb_var_num_t;
0149
0150
0151 /* hb_tag_t */
0152
0153 /**
0154  * hb_tag_t:
0155  *
0156  * Data type for tag identifiers. Tags are four
0157  * byte integers, each byte representing a character.
0158  *
0159  * Tags are used to identify tables, design-variation axes,
0160  * scripts, languages, font features, and baselines with
0161  * human-readable names.
0162  *
0163  **/
0164 typedef uint32_t hb_tag_t;
0165
0166 /**
0167  * HB_TAG:
0168  * @c1: 1st character of the tag
0169  * @c2: 2nd character of the tag
0170  * @c3: 3rd character of the tag
0171  * @c4: 4th character of the tag
0172  *
0173  * Constructs an #hb_tag_t from four character literals.
0174  *
0175  **/
0176 #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)))
0177
0178 /**
0179  * HB_UNTAG:
0180  * @tag: an #hb_tag_t
0181  *
0182  * Extracts four character literals from an #hb_tag_t.
0183  *
0184  * Since: 0.6.0
0185  *
0186  **/
0187 #define HB_UNTAG(tag)   (uint8_t)(((tag)>>24)&0xFF), (uint8_t)(((tag)>>16)&0xFF), (uint8_t)(((tag)>>8)&0xFF), (uint8_t)((tag)&0xFF)
0188
0189 /**
0190  * HB_TAG_NONE:
0191  *
0192  * Unset #hb_tag_t.
0193  */
0194 #define HB_TAG_NONE HB_TAG(0,0,0,0)
0195 /**
0196  * HB_TAG_MAX:
0197  *
0198  * Maximum possible unsigned #hb_tag_t.
0199  *
0200  * Since: 0.9.26
0201  */
0202 #define HB_TAG_MAX HB_TAG(0xff,0xff,0xff,0xff)
0203 /**
0204  * HB_TAG_MAX_SIGNED:
0205  *
0206  * Maximum possible signed #hb_tag_t.
0207  *
0208  * Since: 0.9.33
0209  */
0210 #define HB_TAG_MAX_SIGNED HB_TAG(0x7f,0xff,0xff,0xff)
0211
0212 /* len=-1 means str is NUL-terminated. */
0213 HB_EXTERN hb_tag_t
0214 hb_tag_from_string (const char *str, int len);
0215
0216 /* buf should have 4 bytes. */
0217 HB_EXTERN void
0218 hb_tag_to_string (hb_tag_t tag, char *buf);
0219
0220
0221 /**
0222  * hb_direction_t:
0223  * @HB_DIRECTION_INVALID: Initial, unset direction.
0224  * @HB_DIRECTION_LTR: Text is set horizontally from left to right.
0225  * @HB_DIRECTION_RTL: Text is set horizontally from right to left.
0226  * @HB_DIRECTION_TTB: Text is set vertically from top to bottom.
0227  * @HB_DIRECTION_BTT: Text is set vertically from bottom to top.
0228  *
0229  * The direction of a text segment or buffer.
0230  *
0231  * A segment can also be tested for horizontal or vertical
0232  * orientation (irrespective of specific direction) with
0233  * HB_DIRECTION_IS_HORIZONTAL() or HB_DIRECTION_IS_VERTICAL().
0234  *
0235  */
0236 typedef enum {
0237   HB_DIRECTION_INVALID = 0,
0238   HB_DIRECTION_LTR = 4,
0239   HB_DIRECTION_RTL,
0240   HB_DIRECTION_TTB,
0241   HB_DIRECTION_BTT
0242 } hb_direction_t;
0243
0244 /* len=-1 means str is NUL-terminated */
0245 HB_EXTERN hb_direction_t
0246 hb_direction_from_string (const char *str, int len);
0247
0248 HB_EXTERN const char *
0249 hb_direction_to_string (hb_direction_t direction);
0250
0251 /**
0252  * HB_DIRECTION_IS_VALID:
0253  * @dir: #hb_direction_t to test
0254  *
0255  * Tests whether a text direction is valid.
0256  *
0257  **/
0258 #define HB_DIRECTION_IS_VALID(dir)  ((((unsigned int) (dir)) & ~3U) == 4)
0259 /* Direction must be valid for the following */
0260 /**
0261  * HB_DIRECTION_IS_HORIZONTAL:
0262  * @dir: #hb_direction_t to test
0263  *
0264  * Tests whether a text direction is horizontal. Requires
0265  * that the direction be valid.
0266  *
0267  **/
0268 #define HB_DIRECTION_IS_HORIZONTAL(dir) ((((unsigned int) (dir)) & ~1U) == 4)
0269 /**
0270  * HB_DIRECTION_IS_VERTICAL:
0271  * @dir: #hb_direction_t to test
0272  *
0273  * Tests whether a text direction is vertical. Requires
0274  * that the direction be valid.
0275  *
0276  **/
0277 #define HB_DIRECTION_IS_VERTICAL(dir)   ((((unsigned int) (dir)) & ~1U) == 6)
0278 /**
0279  * HB_DIRECTION_IS_FORWARD:
0280  * @dir: #hb_direction_t to test
0281  *
0282  * Tests whether a text direction moves forward (from left to right, or from
0283  * top to bottom). Requires that the direction be valid.
0284  *
0285  **/
0286 #define HB_DIRECTION_IS_FORWARD(dir)    ((((unsigned int) (dir)) & ~2U) == 4)
0287 /**
0288  * HB_DIRECTION_IS_BACKWARD:
0289  * @dir: #hb_direction_t to test
0290  *
0291  * Tests whether a text direction moves backward (from right to left, or from
0292  * bottom to top). Requires that the direction be valid.
0293  *
0294  **/
0295 #define HB_DIRECTION_IS_BACKWARD(dir)   ((((unsigned int) (dir)) & ~2U) == 5)
0296 /**
0297  * HB_DIRECTION_REVERSE:
0298  * @dir: #hb_direction_t to reverse
0299  *
0300  * Reverses a text direction. Requires that the direction
0301  * be valid.
0302  *
0303  **/
0304 #define HB_DIRECTION_REVERSE(dir)   ((hb_direction_t) (((unsigned int) (dir)) ^ 1))
0305
0306
0307 /* hb_language_t */
0308
0309 /**
0310  * hb_language_t:
0311  *
0312  * Data type for languages. Each #hb_language_t corresponds to a BCP 47
0313  * language tag.
0314  *
0315  */
0316 typedef const struct hb_language_impl_t *hb_language_t;
0317
0318 HB_EXTERN hb_language_t
0319 hb_language_from_string (const char *str, int len);
0320
0321 HB_EXTERN const char *
0322 hb_language_to_string (hb_language_t language);
0323
0324 /**
0325  * HB_LANGUAGE_INVALID:
0326  *
0327  * An unset #hb_language_t.
0328  *
0329  * Since: 0.6.0
0330  */
0331 #define HB_LANGUAGE_INVALID ((hb_language_t) 0)
0332
0333 HB_EXTERN hb_language_t
0334 hb_language_get_default (void);
0335
0336 HB_EXTERN hb_bool_t
0337 hb_language_matches (hb_language_t language,
0338              hb_language_t specific);
0339
0340 /**
0341  * hb_script_t:
0342  * @HB_SCRIPT_COMMON: `Zyyy`
0343  * @HB_SCRIPT_INHERITED: `Zinh`
0344  * @HB_SCRIPT_UNKNOWN: `Zzzz`
0345  * @HB_SCRIPT_ARABIC: `Arab`
0346  * @HB_SCRIPT_ARMENIAN: `Armn`
0347  * @HB_SCRIPT_BENGALI: `Beng`
0348  * @HB_SCRIPT_CYRILLIC: `Cyrl`
0349  * @HB_SCRIPT_DEVANAGARI: `Deva`
0350  * @HB_SCRIPT_GEORGIAN: `Geor`
0351  * @HB_SCRIPT_GREEK: `Grek`
0352  * @HB_SCRIPT_GUJARATI: `Gujr`
0353  * @HB_SCRIPT_GURMUKHI: `Guru`
0354  * @HB_SCRIPT_HANGUL: `Hang`
0355  * @HB_SCRIPT_HAN: `Hani`
0356  * @HB_SCRIPT_HEBREW: `Hebr`
0357  * @HB_SCRIPT_HIRAGANA: `Hira`
0358  * @HB_SCRIPT_KANNADA: `Knda`
0359  * @HB_SCRIPT_KATAKANA: `Kana`
0360  * @HB_SCRIPT_LAO: `Laoo`
0361  * @HB_SCRIPT_LATIN: `Latn`
0362  * @HB_SCRIPT_MALAYALAM: `Mlym`
0363  * @HB_SCRIPT_ORIYA: `Orya`
0364  * @HB_SCRIPT_TAMIL: `Taml`
0365  * @HB_SCRIPT_TELUGU: `Telu`
0366  * @HB_SCRIPT_THAI: `Thai`
0367  * @HB_SCRIPT_TIBETAN: `Tibt`
0368  * @HB_SCRIPT_BOPOMOFO: `Bopo`
0369  * @HB_SCRIPT_BRAILLE: `Brai`
0370  * @HB_SCRIPT_CANADIAN_SYLLABICS: `Cans`
0371  * @HB_SCRIPT_CHEROKEE: `Cher`
0372  * @HB_SCRIPT_ETHIOPIC: `Ethi`
0373  * @HB_SCRIPT_KHMER: `Khmr`
0374  * @HB_SCRIPT_MONGOLIAN: `Mong`
0375  * @HB_SCRIPT_MYANMAR: `Mymr`
0376  * @HB_SCRIPT_OGHAM: `Ogam`
0377  * @HB_SCRIPT_RUNIC: `Runr`
0378  * @HB_SCRIPT_SINHALA: `Sinh`
0379  * @HB_SCRIPT_SYRIAC: `Syrc`
0380  * @HB_SCRIPT_THAANA: `Thaa`
0381  * @HB_SCRIPT_YI: `Yiii`
0382  * @HB_SCRIPT_DESERET: `Dsrt`
0383  * @HB_SCRIPT_GOTHIC: `Goth`
0384  * @HB_SCRIPT_OLD_ITALIC: `Ital`
0385  * @HB_SCRIPT_BUHID: `Buhd`
0386  * @HB_SCRIPT_HANUNOO: `Hano`
0387  * @HB_SCRIPT_TAGALOG: `Tglg`
0388  * @HB_SCRIPT_TAGBANWA: `Tagb`
0389  * @HB_SCRIPT_CYPRIOT: `Cprt`
0390  * @HB_SCRIPT_LIMBU: `Limb`
0391  * @HB_SCRIPT_LINEAR_B: `Linb`
0392  * @HB_SCRIPT_OSMANYA: `Osma`
0393  * @HB_SCRIPT_SHAVIAN: `Shaw`
0394  * @HB_SCRIPT_TAI_LE: `Tale`
0395  * @HB_SCRIPT_UGARITIC: `Ugar`
0396  * @HB_SCRIPT_BUGINESE: `Bugi`
0397  * @HB_SCRIPT_COPTIC: `Copt`
0398  * @HB_SCRIPT_GLAGOLITIC: `Glag`
0399  * @HB_SCRIPT_KHAROSHTHI: `Khar`
0400  * @HB_SCRIPT_NEW_TAI_LUE: `Talu`
0401  * @HB_SCRIPT_OLD_PERSIAN: `Xpeo`
0402  * @HB_SCRIPT_SYLOTI_NAGRI: `Sylo`
0403  * @HB_SCRIPT_TIFINAGH: `Tfng`
0404  * @HB_SCRIPT_BALINESE: `Bali`
0405  * @HB_SCRIPT_CUNEIFORM: `Xsux`
0406  * @HB_SCRIPT_NKO: `Nkoo`
0407  * @HB_SCRIPT_PHAGS_PA: `Phag`
0408  * @HB_SCRIPT_PHOENICIAN: `Phnx`
0409  * @HB_SCRIPT_CARIAN: `Cari`
0410  * @HB_SCRIPT_CHAM: `Cham`
0411  * @HB_SCRIPT_KAYAH_LI: `Kali`
0412  * @HB_SCRIPT_LEPCHA: `Lepc`
0413  * @HB_SCRIPT_LYCIAN: `Lyci`
0414  * @HB_SCRIPT_LYDIAN: `Lydi`
0415  * @HB_SCRIPT_OL_CHIKI: `Olck`
0416  * @HB_SCRIPT_REJANG: `Rjng`
0417  * @HB_SCRIPT_SAURASHTRA: `Saur`
0418  * @HB_SCRIPT_SUNDANESE: `Sund`
0419  * @HB_SCRIPT_VAI: `Vaii`
0420  * @HB_SCRIPT_AVESTAN: `Avst`
0421  * @HB_SCRIPT_BAMUM: `Bamu`
0422  * @HB_SCRIPT_EGYPTIAN_HIEROGLYPHS: `Egyp`
0423  * @HB_SCRIPT_IMPERIAL_ARAMAIC: `Armi`
0424  * @HB_SCRIPT_INSCRIPTIONAL_PAHLAVI: `Phli`
0425  * @HB_SCRIPT_INSCRIPTIONAL_PARTHIAN: `Prti`
0426  * @HB_SCRIPT_JAVANESE: `Java`
0427  * @HB_SCRIPT_KAITHI: `Kthi`
0428  * @HB_SCRIPT_LISU: `Lisu`
0429  * @HB_SCRIPT_MEETEI_MAYEK: `Mtei`
0430  * @HB_SCRIPT_OLD_SOUTH_ARABIAN: `Sarb`
0431  * @HB_SCRIPT_OLD_TURKIC: `Orkh`
0432  * @HB_SCRIPT_SAMARITAN: `Samr`
0433  * @HB_SCRIPT_TAI_THAM: `Lana`
0434  * @HB_SCRIPT_TAI_VIET: `Tavt`
0435  * @HB_SCRIPT_BATAK: `Batk`
0436  * @HB_SCRIPT_BRAHMI: `Brah`
0437  * @HB_SCRIPT_MANDAIC: `Mand`
0438  * @HB_SCRIPT_CHAKMA: `Cakm`
0439  * @HB_SCRIPT_MEROITIC_CURSIVE: `Merc`
0440  * @HB_SCRIPT_MEROITIC_HIEROGLYPHS: `Mero`
0441  * @HB_SCRIPT_MIAO: `Plrd`
0442  * @HB_SCRIPT_SHARADA: `Shrd`
0443  * @HB_SCRIPT_SORA_SOMPENG: `Sora`
0444  * @HB_SCRIPT_TAKRI: `Takr`
0445  * @HB_SCRIPT_BASSA_VAH: `Bass`, Since: 0.9.30
0446  * @HB_SCRIPT_CAUCASIAN_ALBANIAN: `Aghb`, Since: 0.9.30
0447  * @HB_SCRIPT_DUPLOYAN: `Dupl`, Since: 0.9.30
0448  * @HB_SCRIPT_ELBASAN: `Elba`, Since: 0.9.30
0449  * @HB_SCRIPT_GRANTHA: `Gran`, Since: 0.9.30
0450  * @HB_SCRIPT_KHOJKI: `Khoj`, Since: 0.9.30
0451  * @HB_SCRIPT_KHUDAWADI: `Sind`, Since: 0.9.30
0452  * @HB_SCRIPT_LINEAR_A: `Lina`, Since: 0.9.30
0453  * @HB_SCRIPT_MAHAJANI: `Mahj`, Since: 0.9.30
0454  * @HB_SCRIPT_MANICHAEAN: `Mani`, Since: 0.9.30
0455  * @HB_SCRIPT_MENDE_KIKAKUI: `Mend`, Since: 0.9.30
0456  * @HB_SCRIPT_MODI: `Modi`, Since: 0.9.30
0457  * @HB_SCRIPT_MRO: `Mroo`, Since: 0.9.30
0458  * @HB_SCRIPT_NABATAEAN: `Nbat`, Since: 0.9.30
0459  * @HB_SCRIPT_OLD_NORTH_ARABIAN: `Narb`, Since: 0.9.30
0460  * @HB_SCRIPT_OLD_PERMIC: `Perm`, Since: 0.9.30
0461  * @HB_SCRIPT_PAHAWH_HMONG: `Hmng`, Since: 0.9.30
0462  * @HB_SCRIPT_PALMYRENE: `Palm`, Since: 0.9.30
0463  * @HB_SCRIPT_PAU_CIN_HAU: `Pauc`, Since: 0.9.30
0464  * @HB_SCRIPT_PSALTER_PAHLAVI: `Phlp`, Since: 0.9.30
0465  * @HB_SCRIPT_SIDDHAM: `Sidd`, Since: 0.9.30
0466  * @HB_SCRIPT_TIRHUTA: `Tirh`, Since: 0.9.30
0467  * @HB_SCRIPT_WARANG_CITI: `Wara`, Since: 0.9.30
0468  * @HB_SCRIPT_AHOM: `Ahom`, Since: 0.9.30
0469  * @HB_SCRIPT_ANATOLIAN_HIEROGLYPHS: `Hluw`, Since: 0.9.30
0470  * @HB_SCRIPT_HATRAN: `Hatr`, Since: 0.9.30
0471  * @HB_SCRIPT_MULTANI: `Mult`, Since: 0.9.30
0472  * @HB_SCRIPT_OLD_HUNGARIAN: `Hung`, Since: 0.9.30
0473  * @HB_SCRIPT_SIGNWRITING: `Sgnw`, Since: 0.9.30
0474  * @HB_SCRIPT_ADLAM: `Adlm`, Since: 1.3.0
0475  * @HB_SCRIPT_BHAIKSUKI: `Bhks`, Since: 1.3.0
0476  * @HB_SCRIPT_MARCHEN: `Marc`, Since: 1.3.0
0477  * @HB_SCRIPT_OSAGE: `Osge`, Since: 1.3.0
0478  * @HB_SCRIPT_TANGUT: `Tang`, Since: 1.3.0
0479  * @HB_SCRIPT_NEWA: `Newa`, Since: 1.3.0
0480  * @HB_SCRIPT_MASARAM_GONDI: `Gonm`, Since: 1.6.0
0481  * @HB_SCRIPT_NUSHU: `Nshu`, Since: 1.6.0
0482  * @HB_SCRIPT_SOYOMBO: `Soyo`, Since: 1.6.0
0483  * @HB_SCRIPT_ZANABAZAR_SQUARE: `Zanb`, Since: 1.6.0
0484  * @HB_SCRIPT_DOGRA: `Dogr`, Since: 1.8.0
0485  * @HB_SCRIPT_GUNJALA_GONDI: `Gong`, Since: 1.8.0
0486  * @HB_SCRIPT_HANIFI_ROHINGYA: `Rohg`, Since: 1.8.0
0487  * @HB_SCRIPT_MAKASAR: `Maka`, Since: 1.8.0
0488  * @HB_SCRIPT_MEDEFAIDRIN: `Medf`, Since: 1.8.0
0489  * @HB_SCRIPT_OLD_SOGDIAN: `Sogo`, Since: 1.8.0
0490  * @HB_SCRIPT_SOGDIAN: `Sogd`, Since: 1.8.0
0491  * @HB_SCRIPT_ELYMAIC: `Elym`, Since: 2.4.0
0492  * @HB_SCRIPT_NANDINAGARI: `Nand`, Since: 2.4.0
0493  * @HB_SCRIPT_NYIAKENG_PUACHUE_HMONG: `Hmnp`, Since: 2.4.0
0494  * @HB_SCRIPT_WANCHO: `Wcho`, Since: 2.4.0
0495  * @HB_SCRIPT_CHORASMIAN: `Chrs`, Since: 2.6.7
0496  * @HB_SCRIPT_DIVES_AKURU: `Diak`, Since: 2.6.7
0497  * @HB_SCRIPT_KHITAN_SMALL_SCRIPT: `Kits`, Since: 2.6.7
0498  * @HB_SCRIPT_YEZIDI: `Yezi`, Since: 2.6.7
0499  * @HB_SCRIPT_CYPRO_MINOAN: `Cpmn`, Since: 3.0.0
0500  * @HB_SCRIPT_OLD_UYGHUR: `Ougr`, Since: 3.0.0
0501  * @HB_SCRIPT_TANGSA: `Tnsa`, Since: 3.0.0
0502  * @HB_SCRIPT_TOTO: `Toto`, Since: 3.0.0
0503  * @HB_SCRIPT_VITHKUQI: `Vith`, Since: 3.0.0
0504  * @HB_SCRIPT_MATH: `Zmth`, Since: 3.4.0
0505  * @HB_SCRIPT_KAWI: `Kawi`, Since: 5.2.0
0506  * @HB_SCRIPT_NAG_MUNDARI: `Nagm`, Since: 5.2.0
0507  * @HB_SCRIPT_GARAY: `Gara`, Since: 10.0.0
0508  * @HB_SCRIPT_GURUNG_KHEMA: `Gukh`, Since: 10.0.0
0509  * @HB_SCRIPT_KIRAT_RAI: `Krai`, Since: 10.0.0
0510  * @HB_SCRIPT_OL_ONAL: `Onao`, Since: 10.0.0
0511  * @HB_SCRIPT_SUNUWAR: `Sunu`, Since: 10.0.0
0512  * @HB_SCRIPT_TODHRI: `Todr`, Since: 10.0.0
0513  * @HB_SCRIPT_TULU_TIGALARI: `Tutg`, Since: 10.0.0
0514  * @HB_SCRIPT_INVALID: No script set
0515  *
0516  * Data type for scripts. Each #hb_script_t's value is an #hb_tag_t corresponding
0517  * to the four-letter values defined by [ISO 15924](https://unicode.org/iso15924/).
0518  *
0519  * See also the Script (sc) property of the Unicode Character Database.
0520  *
0521  **/
0522
0523 /* https://docs.google.com/spreadsheets/d/1Y90M0Ie3MUJ6UVCRDOypOtijlMDLNNyyLk36T6iMu0o */
0524 typedef enum
0525 {
0526   HB_SCRIPT_COMMON          = HB_TAG ('Z','y','y','y'), /*1.1*/
0527   HB_SCRIPT_INHERITED           = HB_TAG ('Z','i','n','h'), /*1.1*/
0528   HB_SCRIPT_UNKNOWN         = HB_TAG ('Z','z','z','z'), /*5.0*/
0529
0530   HB_SCRIPT_ARABIC          = HB_TAG ('A','r','a','b'), /*1.1*/
0531   HB_SCRIPT_ARMENIAN            = HB_TAG ('A','r','m','n'), /*1.1*/
0532   HB_SCRIPT_BENGALI         = HB_TAG ('B','e','n','g'), /*1.1*/
0533   HB_SCRIPT_CYRILLIC            = HB_TAG ('C','y','r','l'), /*1.1*/
0534   HB_SCRIPT_DEVANAGARI          = HB_TAG ('D','e','v','a'), /*1.1*/
0535   HB_SCRIPT_GEORGIAN            = HB_TAG ('G','e','o','r'), /*1.1*/
0536   HB_SCRIPT_GREEK           = HB_TAG ('G','r','e','k'), /*1.1*/
0537   HB_SCRIPT_GUJARATI            = HB_TAG ('G','u','j','r'), /*1.1*/
0538   HB_SCRIPT_GURMUKHI            = HB_TAG ('G','u','r','u'), /*1.1*/
0539   HB_SCRIPT_HANGUL          = HB_TAG ('H','a','n','g'), /*1.1*/
0540   HB_SCRIPT_HAN             = HB_TAG ('H','a','n','i'), /*1.1*/
0541   HB_SCRIPT_HEBREW          = HB_TAG ('H','e','b','r'), /*1.1*/
0542   HB_SCRIPT_HIRAGANA            = HB_TAG ('H','i','r','a'), /*1.1*/
0543   HB_SCRIPT_KANNADA         = HB_TAG ('K','n','d','a'), /*1.1*/
0544   HB_SCRIPT_KATAKANA            = HB_TAG ('K','a','n','a'), /*1.1*/
0545   HB_SCRIPT_LAO             = HB_TAG ('L','a','o','o'), /*1.1*/
0546   HB_SCRIPT_LATIN           = HB_TAG ('L','a','t','n'), /*1.1*/
0547   HB_SCRIPT_MALAYALAM           = HB_TAG ('M','l','y','m'), /*1.1*/
0548   HB_SCRIPT_ORIYA           = HB_TAG ('O','r','y','a'), /*1.1*/
0549   HB_SCRIPT_TAMIL           = HB_TAG ('T','a','m','l'), /*1.1*/
0550   HB_SCRIPT_TELUGU          = HB_TAG ('T','e','l','u'), /*1.1*/
0551   HB_SCRIPT_THAI            = HB_TAG ('T','h','a','i'), /*1.1*/
0552
0553   HB_SCRIPT_TIBETAN         = HB_TAG ('T','i','b','t'), /*2.0*/
0554
0555   HB_SCRIPT_BOPOMOFO            = HB_TAG ('B','o','p','o'), /*3.0*/
0556   HB_SCRIPT_BRAILLE         = HB_TAG ('B','r','a','i'), /*3.0*/
0557   HB_SCRIPT_CANADIAN_SYLLABICS      = HB_TAG ('C','a','n','s'), /*3.0*/
0558   HB_SCRIPT_CHEROKEE            = HB_TAG ('C','h','e','r'), /*3.0*/
0559   HB_SCRIPT_ETHIOPIC            = HB_TAG ('E','t','h','i'), /*3.0*/
0560   HB_SCRIPT_KHMER           = HB_TAG ('K','h','m','r'), /*3.0*/
0561   HB_SCRIPT_MONGOLIAN           = HB_TAG ('M','o','n','g'), /*3.0*/
0562   HB_SCRIPT_MYANMAR         = HB_TAG ('M','y','m','r'), /*3.0*/
0563   HB_SCRIPT_OGHAM           = HB_TAG ('O','g','a','m'), /*3.0*/
0564   HB_SCRIPT_RUNIC           = HB_TAG ('R','u','n','r'), /*3.0*/
0565   HB_SCRIPT_SINHALA         = HB_TAG ('S','i','n','h'), /*3.0*/
0566   HB_SCRIPT_SYRIAC          = HB_TAG ('S','y','r','c'), /*3.0*/
0567   HB_SCRIPT_THAANA          = HB_TAG ('T','h','a','a'), /*3.0*/
0568   HB_SCRIPT_YI              = HB_TAG ('Y','i','i','i'), /*3.0*/
0569
0570   HB_SCRIPT_DESERET         = HB_TAG ('D','s','r','t'), /*3.1*/
0571   HB_SCRIPT_GOTHIC          = HB_TAG ('G','o','t','h'), /*3.1*/
0572   HB_SCRIPT_OLD_ITALIC          = HB_TAG ('I','t','a','l'), /*3.1*/
0573
0574   HB_SCRIPT_BUHID           = HB_TAG ('B','u','h','d'), /*3.2*/
0575   HB_SCRIPT_HANUNOO         = HB_TAG ('H','a','n','o'), /*3.2*/
0576   HB_SCRIPT_TAGALOG         = HB_TAG ('T','g','l','g'), /*3.2*/
0577   HB_SCRIPT_TAGBANWA            = HB_TAG ('T','a','g','b'), /*3.2*/
0578
0579   HB_SCRIPT_CYPRIOT         = HB_TAG ('C','p','r','t'), /*4.0*/
0580   HB_SCRIPT_LIMBU           = HB_TAG ('L','i','m','b'), /*4.0*/
0581   HB_SCRIPT_LINEAR_B            = HB_TAG ('L','i','n','b'), /*4.0*/
0582   HB_SCRIPT_OSMANYA         = HB_TAG ('O','s','m','a'), /*4.0*/
0583   HB_SCRIPT_SHAVIAN         = HB_TAG ('S','h','a','w'), /*4.0*/
0584   HB_SCRIPT_TAI_LE          = HB_TAG ('T','a','l','e'), /*4.0*/
0585   HB_SCRIPT_UGARITIC            = HB_TAG ('U','g','a','r'), /*4.0*/
0586
0587   HB_SCRIPT_BUGINESE            = HB_TAG ('B','u','g','i'), /*4.1*/
0588   HB_SCRIPT_COPTIC          = HB_TAG ('C','o','p','t'), /*4.1*/
0589   HB_SCRIPT_GLAGOLITIC          = HB_TAG ('G','l','a','g'), /*4.1*/
0590   HB_SCRIPT_KHAROSHTHI          = HB_TAG ('K','h','a','r'), /*4.1*/
0591   HB_SCRIPT_NEW_TAI_LUE         = HB_TAG ('T','a','l','u'), /*4.1*/
0592   HB_SCRIPT_OLD_PERSIAN         = HB_TAG ('X','p','e','o'), /*4.1*/
0593   HB_SCRIPT_SYLOTI_NAGRI        = HB_TAG ('S','y','l','o'), /*4.1*/
0594   HB_SCRIPT_TIFINAGH            = HB_TAG ('T','f','n','g'), /*4.1*/
0595
0596   HB_SCRIPT_BALINESE            = HB_TAG ('B','a','l','i'), /*5.0*/
0597   HB_SCRIPT_CUNEIFORM           = HB_TAG ('X','s','u','x'), /*5.0*/
0598   HB_SCRIPT_NKO             = HB_TAG ('N','k','o','o'), /*5.0*/
0599   HB_SCRIPT_PHAGS_PA            = HB_TAG ('P','h','a','g'), /*5.0*/
0600   HB_SCRIPT_PHOENICIAN          = HB_TAG ('P','h','n','x'), /*5.0*/
0601
0602   HB_SCRIPT_CARIAN          = HB_TAG ('C','a','r','i'), /*5.1*/
0603   HB_SCRIPT_CHAM            = HB_TAG ('C','h','a','m'), /*5.1*/
0604   HB_SCRIPT_KAYAH_LI            = HB_TAG ('K','a','l','i'), /*5.1*/
0605   HB_SCRIPT_LEPCHA          = HB_TAG ('L','e','p','c'), /*5.1*/
0606   HB_SCRIPT_LYCIAN          = HB_TAG ('L','y','c','i'), /*5.1*/
0607   HB_SCRIPT_LYDIAN          = HB_TAG ('L','y','d','i'), /*5.1*/
0608   HB_SCRIPT_OL_CHIKI            = HB_TAG ('O','l','c','k'), /*5.1*/
0609   HB_SCRIPT_REJANG          = HB_TAG ('R','j','n','g'), /*5.1*/
0610   HB_SCRIPT_SAURASHTRA          = HB_TAG ('S','a','u','r'), /*5.1*/
0611   HB_SCRIPT_SUNDANESE           = HB_TAG ('S','u','n','d'), /*5.1*/
0612   HB_SCRIPT_VAI             = HB_TAG ('V','a','i','i'), /*5.1*/
0613
0614   HB_SCRIPT_AVESTAN         = HB_TAG ('A','v','s','t'), /*5.2*/
0615   HB_SCRIPT_BAMUM           = HB_TAG ('B','a','m','u'), /*5.2*/
0616   HB_SCRIPT_EGYPTIAN_HIEROGLYPHS    = HB_TAG ('E','g','y','p'), /*5.2*/
0617   HB_SCRIPT_IMPERIAL_ARAMAIC        = HB_TAG ('A','r','m','i'), /*5.2*/
0618   HB_SCRIPT_INSCRIPTIONAL_PAHLAVI   = HB_TAG ('P','h','l','i'), /*5.2*/
0619   HB_SCRIPT_INSCRIPTIONAL_PARTHIAN  = HB_TAG ('P','r','t','i'), /*5.2*/
0620   HB_SCRIPT_JAVANESE            = HB_TAG ('J','a','v','a'), /*5.2*/
0621   HB_SCRIPT_KAITHI          = HB_TAG ('K','t','h','i'), /*5.2*/
0622   HB_SCRIPT_LISU            = HB_TAG ('L','i','s','u'), /*5.2*/
0623   HB_SCRIPT_MEETEI_MAYEK        = HB_TAG ('M','t','e','i'), /*5.2*/
0624   HB_SCRIPT_OLD_SOUTH_ARABIAN       = HB_TAG ('S','a','r','b'), /*5.2*/
0625   HB_SCRIPT_OLD_TURKIC          = HB_TAG ('O','r','k','h'), /*5.2*/
0626   HB_SCRIPT_SAMARITAN           = HB_TAG ('S','a','m','r'), /*5.2*/
0627   HB_SCRIPT_TAI_THAM            = HB_TAG ('L','a','n','a'), /*5.2*/
0628   HB_SCRIPT_TAI_VIET            = HB_TAG ('T','a','v','t'), /*5.2*/
0629
0630   HB_SCRIPT_BATAK           = HB_TAG ('B','a','t','k'), /*6.0*/
0631   HB_SCRIPT_BRAHMI          = HB_TAG ('B','r','a','h'), /*6.0*/
0632   HB_SCRIPT_MANDAIC         = HB_TAG ('M','a','n','d'), /*6.0*/
0633
0634   HB_SCRIPT_CHAKMA          = HB_TAG ('C','a','k','m'), /*6.1*/
0635   HB_SCRIPT_MEROITIC_CURSIVE        = HB_TAG ('M','e','r','c'), /*6.1*/
0636   HB_SCRIPT_MEROITIC_HIEROGLYPHS    = HB_TAG ('M','e','r','o'), /*6.1*/
0637   HB_SCRIPT_MIAO            = HB_TAG ('P','l','r','d'), /*6.1*/
0638   HB_SCRIPT_SHARADA         = HB_TAG ('S','h','r','d'), /*6.1*/
0639   HB_SCRIPT_SORA_SOMPENG        = HB_TAG ('S','o','r','a'), /*6.1*/
0640   HB_SCRIPT_TAKRI           = HB_TAG ('T','a','k','r'), /*6.1*/
0641
0642   /*
0643    * Since: 0.9.30
0644    */
0645   HB_SCRIPT_BASSA_VAH           = HB_TAG ('B','a','s','s'), /*7.0*/
0646   HB_SCRIPT_CAUCASIAN_ALBANIAN      = HB_TAG ('A','g','h','b'), /*7.0*/
0647   HB_SCRIPT_DUPLOYAN            = HB_TAG ('D','u','p','l'), /*7.0*/
0648   HB_SCRIPT_ELBASAN         = HB_TAG ('E','l','b','a'), /*7.0*/
0649   HB_SCRIPT_GRANTHA         = HB_TAG ('G','r','a','n'), /*7.0*/
0650   HB_SCRIPT_KHOJKI          = HB_TAG ('K','h','o','j'), /*7.0*/
0651   HB_SCRIPT_KHUDAWADI           = HB_TAG ('S','i','n','d'), /*7.0*/
0652   HB_SCRIPT_LINEAR_A            = HB_TAG ('L','i','n','a'), /*7.0*/
0653   HB_SCRIPT_MAHAJANI            = HB_TAG ('M','a','h','j'), /*7.0*/
0654   HB_SCRIPT_MANICHAEAN          = HB_TAG ('M','a','n','i'), /*7.0*/
0655   HB_SCRIPT_MENDE_KIKAKUI       = HB_TAG ('M','e','n','d'), /*7.0*/
0656   HB_SCRIPT_MODI            = HB_TAG ('M','o','d','i'), /*7.0*/
0657   HB_SCRIPT_MRO             = HB_TAG ('M','r','o','o'), /*7.0*/
0658   HB_SCRIPT_NABATAEAN           = HB_TAG ('N','b','a','t'), /*7.0*/
0659   HB_SCRIPT_OLD_NORTH_ARABIAN       = HB_TAG ('N','a','r','b'), /*7.0*/
0660   HB_SCRIPT_OLD_PERMIC          = HB_TAG ('P','e','r','m'), /*7.0*/
0661   HB_SCRIPT_PAHAWH_HMONG        = HB_TAG ('H','m','n','g'), /*7.0*/
0662   HB_SCRIPT_PALMYRENE           = HB_TAG ('P','a','l','m'), /*7.0*/
0663   HB_SCRIPT_PAU_CIN_HAU         = HB_TAG ('P','a','u','c'), /*7.0*/
0664   HB_SCRIPT_PSALTER_PAHLAVI     = HB_TAG ('P','h','l','p'), /*7.0*/
0665   HB_SCRIPT_SIDDHAM         = HB_TAG ('S','i','d','d'), /*7.0*/
0666   HB_SCRIPT_TIRHUTA         = HB_TAG ('T','i','r','h'), /*7.0*/
0667   HB_SCRIPT_WARANG_CITI         = HB_TAG ('W','a','r','a'), /*7.0*/
0668
0669   HB_SCRIPT_AHOM            = HB_TAG ('A','h','o','m'), /*8.0*/
0670   HB_SCRIPT_ANATOLIAN_HIEROGLYPHS   = HB_TAG ('H','l','u','w'), /*8.0*/
0671   HB_SCRIPT_HATRAN          = HB_TAG ('H','a','t','r'), /*8.0*/
0672   HB_SCRIPT_MULTANI         = HB_TAG ('M','u','l','t'), /*8.0*/
0673   HB_SCRIPT_OLD_HUNGARIAN       = HB_TAG ('H','u','n','g'), /*8.0*/
0674   HB_SCRIPT_SIGNWRITING         = HB_TAG ('S','g','n','w'), /*8.0*/
0675
0676   /*
0677    * Since 1.3.0
0678    */
0679   HB_SCRIPT_ADLAM           = HB_TAG ('A','d','l','m'), /*9.0*/
0680   HB_SCRIPT_BHAIKSUKI           = HB_TAG ('B','h','k','s'), /*9.0*/
0681   HB_SCRIPT_MARCHEN         = HB_TAG ('M','a','r','c'), /*9.0*/
0682   HB_SCRIPT_OSAGE           = HB_TAG ('O','s','g','e'), /*9.0*/
0683   HB_SCRIPT_TANGUT          = HB_TAG ('T','a','n','g'), /*9.0*/
0684   HB_SCRIPT_NEWA            = HB_TAG ('N','e','w','a'), /*9.0*/
0685
0686   /*
0687    * Since 1.6.0
0688    */
0689   HB_SCRIPT_MASARAM_GONDI       = HB_TAG ('G','o','n','m'), /*10.0*/
0690   HB_SCRIPT_NUSHU           = HB_TAG ('N','s','h','u'), /*10.0*/
0691   HB_SCRIPT_SOYOMBO         = HB_TAG ('S','o','y','o'), /*10.0*/
0692   HB_SCRIPT_ZANABAZAR_SQUARE        = HB_TAG ('Z','a','n','b'), /*10.0*/
0693
0694   /*
0695    * Since 1.8.0
0696    */
0697   HB_SCRIPT_DOGRA           = HB_TAG ('D','o','g','r'), /*11.0*/
0698   HB_SCRIPT_GUNJALA_GONDI       = HB_TAG ('G','o','n','g'), /*11.0*/
0699   HB_SCRIPT_HANIFI_ROHINGYA     = HB_TAG ('R','o','h','g'), /*11.0*/
0700   HB_SCRIPT_MAKASAR         = HB_TAG ('M','a','k','a'), /*11.0*/
0701   HB_SCRIPT_MEDEFAIDRIN         = HB_TAG ('M','e','d','f'), /*11.0*/
0702   HB_SCRIPT_OLD_SOGDIAN         = HB_TAG ('S','o','g','o'), /*11.0*/
0703   HB_SCRIPT_SOGDIAN         = HB_TAG ('S','o','g','d'), /*11.0*/
0704
0705   /*
0706    * Since 2.4.0
0707    */
0708   HB_SCRIPT_ELYMAIC         = HB_TAG ('E','l','y','m'), /*12.0*/
0709   HB_SCRIPT_NANDINAGARI         = HB_TAG ('N','a','n','d'), /*12.0*/
0710   HB_SCRIPT_NYIAKENG_PUACHUE_HMONG  = HB_TAG ('H','m','n','p'), /*12.0*/
0711   HB_SCRIPT_WANCHO          = HB_TAG ('W','c','h','o'), /*12.0*/
0712
0713   /*
0714    * Since 2.6.7
0715    */
0716   HB_SCRIPT_CHORASMIAN          = HB_TAG ('C','h','r','s'), /*13.0*/
0717   HB_SCRIPT_DIVES_AKURU         = HB_TAG ('D','i','a','k'), /*13.0*/
0718   HB_SCRIPT_KHITAN_SMALL_SCRIPT     = HB_TAG ('K','i','t','s'), /*13.0*/
0719   HB_SCRIPT_YEZIDI          = HB_TAG ('Y','e','z','i'), /*13.0*/
0720
0721   /*
0722    * Since 3.0.0
0723    */
0724   HB_SCRIPT_CYPRO_MINOAN        = HB_TAG ('C','p','m','n'), /*14.0*/
0725   HB_SCRIPT_OLD_UYGHUR          = HB_TAG ('O','u','g','r'), /*14.0*/
0726   HB_SCRIPT_TANGSA          = HB_TAG ('T','n','s','a'), /*14.0*/
0727   HB_SCRIPT_TOTO            = HB_TAG ('T','o','t','o'), /*14.0*/
0728   HB_SCRIPT_VITHKUQI            = HB_TAG ('V','i','t','h'), /*14.0*/
0729
0730   /*
0731    * Since 3.4.0
0732    */
0733   HB_SCRIPT_MATH            = HB_TAG ('Z','m','t','h'),
0734
0735   /*
0736    * Since 5.2.0
0737    */
0738   HB_SCRIPT_KAWI            = HB_TAG ('K','a','w','i'), /*15.0*/
0739   HB_SCRIPT_NAG_MUNDARI         = HB_TAG ('N','a','g','m'), /*15.0*/
0740
0741   /*
0742    * Since 10.0.0
0743    */
0744   HB_SCRIPT_GARAY           = HB_TAG ('G','a','r','a'), /*16.0*/
0745   HB_SCRIPT_GURUNG_KHEMA        = HB_TAG ('G','u','k','h'), /*16.0*/
0746   HB_SCRIPT_KIRAT_RAI           = HB_TAG ('K','r','a','i'), /*16.0*/
0747   HB_SCRIPT_OL_ONAL         = HB_TAG ('O','n','a','o'), /*16.0*/
0748   HB_SCRIPT_SUNUWAR         = HB_TAG ('S','u','n','u'), /*16.0*/
0749   HB_SCRIPT_TODHRI          = HB_TAG ('T','o','d','r'), /*16.0*/
0750   HB_SCRIPT_TULU_TIGALARI       = HB_TAG ('T','u','t','g'), /*16.0*/
0751
0752   /* No script set. */
0753   HB_SCRIPT_INVALID         = HB_TAG_NONE,
0754
0755   /*< private >*/
0756
0757   /* Dummy values to ensure any hb_tag_t value can be passed/stored as hb_script_t
0758    * without risking undefined behavior.  We have two, for historical reasons.
0759    * HB_TAG_MAX used to be unsigned, but that was invalid Ansi C, so was changed
0760    * to _HB_SCRIPT_MAX_VALUE to be equal to HB_TAG_MAX_SIGNED as well.
0761    *
0762    * See this thread for technicalities:
0763    *
0764    *   https://lists.freedesktop.org/archives/harfbuzz/2014-March/004150.html
0765    */
0766   _HB_SCRIPT_MAX_VALUE              = HB_TAG_MAX_SIGNED, /*< skip >*/
0767   _HB_SCRIPT_MAX_VALUE_SIGNED           = HB_TAG_MAX_SIGNED /*< skip >*/
0768
0769 } hb_script_t;
0770
0771
0772 /* Script functions */
0773
0774 HB_EXTERN hb_script_t
0775 hb_script_from_iso15924_tag (hb_tag_t tag);
0776
0777 HB_EXTERN hb_script_t
0778 hb_script_from_string (const char *str, int len);
0779
0780 HB_EXTERN hb_tag_t
0781 hb_script_to_iso15924_tag (hb_script_t script);
0782
0783 HB_EXTERN hb_direction_t
0784 hb_script_get_horizontal_direction (hb_script_t script);
0785
0786
0787 /* User data */
0788
0789 /**
0790  * hb_user_data_key_t:
0791  *
0792  * Data structure for holding user-data keys.
0793  *
0794  **/
0795 typedef struct hb_user_data_key_t {
0796   /*< private >*/
0797   char unused;
0798 } hb_user_data_key_t;
0799
0800 /**
0801  * hb_destroy_func_t:
0802  * @user_data: the data to be destroyed
0803  *
0804  * A virtual method for destroy user-data callbacks.
0805  *
0806  */
0807 typedef void (*hb_destroy_func_t) (void *user_data);
0808
0809
0810 /* Font features and variations. */
0811
0812 /**
0813  * HB_FEATURE_GLOBAL_START:
0814  *
0815  * Special setting for #hb_feature_t.start to apply the feature from the start
0816  * of the buffer.
0817  *
0818  * Since: 2.0.0
0819  */
0820 #define HB_FEATURE_GLOBAL_START 0
0821
0822 /**
0823  * HB_FEATURE_GLOBAL_END:
0824  *
0825  * Special setting for #hb_feature_t.end to apply the feature from to the end
0826  * of the buffer.
0827  *
0828  * Since: 2.0.0
0829  */
0830 #define HB_FEATURE_GLOBAL_END   ((unsigned int) -1)
0831
0832 /**
0833  * hb_feature_t:
0834  * @tag: The #hb_tag_t tag of the feature
0835  * @value: The value of the feature. 0 disables the feature, non-zero (usually
0836  * 1) enables the feature.  For features implemented as lookup type 3 (like
0837  * 'salt') the @value is a one based index into the alternates.
0838  * @start: the cluster to start applying this feature setting (inclusive).
0839  * @end: the cluster to end applying this feature setting (exclusive).
0840  *
0841  * The #hb_feature_t is the structure that holds information about requested
0842  * feature application. The feature will be applied with the given value to all
0843  * glyphs which are in clusters between @start (inclusive) and @end (exclusive).
0844  * Setting start to #HB_FEATURE_GLOBAL_START and end to #HB_FEATURE_GLOBAL_END
0845  * specifies that the feature always applies to the entire buffer.
0846  */
0847 typedef struct hb_feature_t {
0848   hb_tag_t      tag;
0849   uint32_t      value;
0850   unsigned int  start;
0851   unsigned int  end;
0852 } hb_feature_t;
0853
0854 HB_EXTERN hb_bool_t
0855 hb_feature_from_string (const char *str, int len,
0856             hb_feature_t *feature);
0857
0858 HB_EXTERN void
0859 hb_feature_to_string (hb_feature_t *feature,
0860               char *buf, unsigned int size);
0861
0862 /**
0863  * hb_variation_t:
0864  * @tag: The #hb_tag_t tag of the variation-axis name
0865  * @value: The value of the variation axis
0866  *
0867  * Data type for holding variation data. Registered OpenType
0868  * variation-axis tags are listed in
0869  * [OpenType Axis Tag Registry](https://docs.microsoft.com/en-us/typography/opentype/spec/dvaraxisreg).
0870  *
0871  * Since: 1.4.2
0872  */
0873 typedef struct hb_variation_t {
0874   hb_tag_t tag;
0875   float    value;
0876 } hb_variation_t;
0877
0878 HB_EXTERN hb_bool_t
0879 hb_variation_from_string (const char *str, int len,
0880               hb_variation_t *variation);
0881
0882 HB_EXTERN void
0883 hb_variation_to_string (hb_variation_t *variation,
0884             char *buf, unsigned int size);
0885
0886 /**
0887  * hb_color_t:
0888  *
0889  * Data type for holding color values. Colors are eight bits per
0890  * channel RGB plus alpha transparency.
0891  *
0892  * Since: 2.1.0
0893  */
0894 typedef uint32_t hb_color_t;
0895
0896 /**
0897  * HB_COLOR:
0898  * @b: blue channel value
0899  * @g: green channel value
0900  * @r: red channel value
0901  * @a: alpha channel value
0902  *
0903  * Constructs an #hb_color_t from four integers.
0904  *
0905  * Since: 2.1.0
0906  */
0907 #define HB_COLOR(b,g,r,a) ((hb_color_t) HB_TAG ((b),(g),(r),(a)))
0908
0909 HB_EXTERN uint8_t
0910 hb_color_get_alpha (hb_color_t color);
0911 #define hb_color_get_alpha(color)   ((color) & 0xFF)
0912
0913 HB_EXTERN uint8_t
0914 hb_color_get_red (hb_color_t color);
0915 #define hb_color_get_red(color)     (((color) >> 8) & 0xFF)
0916
0917 HB_EXTERN uint8_t
0918 hb_color_get_green (hb_color_t color);
0919 #define hb_color_get_green(color)   (((color) >> 16) & 0xFF)
0920
0921 HB_EXTERN uint8_t
0922 hb_color_get_blue (hb_color_t color);
0923 #define hb_color_get_blue(color)    (((color) >> 24) & 0xFF)
0924
0925 /**
0926  * hb_glyph_extents_t:
0927  * @x_bearing: Distance from the x-origin to the left extremum of the glyph.
0928  * @y_bearing: Distance from the top extremum of the glyph to the y-origin.
0929  * @width: Distance from the left extremum of the glyph to the right extremum.
0930  * @height: Distance from the top extremum of the glyph to the bottom extremum.
0931  *
0932  * Glyph extent values, measured in font units.
0933  *
0934  * Note that @height is negative, in coordinate systems that grow up.
0935  **/
0936 typedef struct hb_glyph_extents_t {
0937   hb_position_t x_bearing;
0938   hb_position_t y_bearing;
0939   hb_position_t width;
0940   hb_position_t height;
0941 } hb_glyph_extents_t;
0942
0943 /**
0944  * hb_font_t:
0945  *
0946  * Data type for holding fonts.
0947  *
0948  */
0949 typedef struct hb_font_t hb_font_t;
0950
0951 HB_END_DECLS
0952
0953 #endif /* HB_COMMON_H */