Home | History | Annotate | Download | only in src
      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 #ifndef HB_H_IN
     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 #else
     67 #  include <stdint.h>
     68 #endif
     69 
     70 #if    __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
     71 #define HB_DEPRECATED __attribute__((__deprecated__))
     72 #elif defined(_MSC_VER) && (_MSC_VER >= 1300)
     73 #define HB_DEPRECATED __declspec(deprecated)
     74 #else
     75 #define HB_DEPRECATED
     76 #endif
     77 
     78 #if    __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
     79 #define HB_DEPRECATED_FOR(f) __attribute__((__deprecated__("Use '" #f "' instead")))
     80 #elif defined(_MSC_FULL_VER) && (_MSC_FULL_VER > 140050320)
     81 #define HB_DEPRECATED_FOR(f) __declspec(deprecated("is deprecated. Use '" #f "' instead"))
     82 #else
     83 #define HB_DEPRECATED_FOR(f) HB_DEPRECATED
     84 #endif
     85 
     86 
     87 HB_BEGIN_DECLS
     88 
     89 
     90 typedef int hb_bool_t;
     91 
     92 typedef uint32_t hb_codepoint_t;
     93 typedef int32_t hb_position_t;
     94 typedef uint32_t hb_mask_t;
     95 
     96 typedef union _hb_var_int_t {
     97   uint32_t u32;
     98   int32_t i32;
     99   uint16_t u16[2];
    100   int16_t i16[2];
    101   uint8_t u8[4];
    102   int8_t i8[4];
    103 } hb_var_int_t;
    104 
    105 
    106 /* hb_tag_t */
    107 
    108 typedef uint32_t hb_tag_t;
    109 
    110 #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)))
    111 #define HB_UNTAG(tag)   (((tag)>>24)&0xFF), (((tag)>>16)&0xFF), (((tag)>>8)&0xFF), ((tag)&0xFF)
    112 
    113 #define HB_TAG_NONE HB_TAG(0,0,0,0)
    114 #define HB_TAG_MAX HB_TAG(0xff,0xff,0xff,0xff)
    115 #define HB_TAG_MAX_SIGNED HB_TAG(0x7f,0xff,0xff,0xff)
    116 
    117 /* len=-1 means str is NUL-terminated. */
    118 HB_EXTERN hb_tag_t
    119 hb_tag_from_string (const char *str, int len);
    120 
    121 /* buf should have 4 bytes. */
    122 HB_EXTERN void
    123 hb_tag_to_string (hb_tag_t tag, char *buf);
    124 
    125 
    126 /**
    127  * hb_direction_t:
    128  * @HB_DIRECTION_INVALID: Initial, unset direction.
    129  * @HB_DIRECTION_LTR: Text is set horizontally from left to right.
    130  * @HB_DIRECTION_RTL: Text is set horizontally from right to left.
    131  * @HB_DIRECTION_TTB: Text is set vertically from top to bottom.
    132  * @HB_DIRECTION_BTT: Text is set vertically from bottom to top.
    133  */
    134 typedef enum {
    135   HB_DIRECTION_INVALID = 0,
    136   HB_DIRECTION_LTR = 4,
    137   HB_DIRECTION_RTL,
    138   HB_DIRECTION_TTB,
    139   HB_DIRECTION_BTT
    140 } hb_direction_t;
    141 
    142 /* len=-1 means str is NUL-terminated */
    143 HB_EXTERN hb_direction_t
    144 hb_direction_from_string (const char *str, int len);
    145 
    146 HB_EXTERN const char *
    147 hb_direction_to_string (hb_direction_t direction);
    148 
    149 #define HB_DIRECTION_IS_VALID(dir)	((((unsigned int) (dir)) & ~3U) == 4)
    150 /* Direction must be valid for the following */
    151 #define HB_DIRECTION_IS_HORIZONTAL(dir)	((((unsigned int) (dir)) & ~1U) == 4)
    152 #define HB_DIRECTION_IS_VERTICAL(dir)	((((unsigned int) (dir)) & ~1U) == 6)
    153 #define HB_DIRECTION_IS_FORWARD(dir)	((((unsigned int) (dir)) & ~2U) == 4)
    154 #define HB_DIRECTION_IS_BACKWARD(dir)	((((unsigned int) (dir)) & ~2U) == 5)
    155 #define HB_DIRECTION_REVERSE(dir)	((hb_direction_t) (((unsigned int) (dir)) ^ 1))
    156 
    157 
    158 /* hb_language_t */
    159 
    160 typedef const struct hb_language_impl_t *hb_language_t;
    161 
    162 HB_EXTERN hb_language_t
    163 hb_language_from_string (const char *str, int len);
    164 
    165 HB_EXTERN const char *
    166 hb_language_to_string (hb_language_t language);
    167 
    168 #define HB_LANGUAGE_INVALID ((hb_language_t) 0)
    169 
    170 HB_EXTERN hb_language_t
    171 hb_language_get_default (void);
    172 
    173 
    174 /* hb_script_t */
    175 
    176 /* https://unicode.org/iso15924/ */
    177 /* https://docs.google.com/spreadsheets/d/1Y90M0Ie3MUJ6UVCRDOypOtijlMDLNNyyLk36T6iMu0o */
    178 /* Unicode Character Database property: Script (sc) */
    179 typedef enum
    180 {
    181   /*1.1*/ HB_SCRIPT_COMMON			= HB_TAG ('Z','y','y','y'),
    182   /*1.1*/ HB_SCRIPT_INHERITED			= HB_TAG ('Z','i','n','h'),
    183   /*5.0*/ HB_SCRIPT_UNKNOWN			= HB_TAG ('Z','z','z','z'),
    184 
    185   /*1.1*/ HB_SCRIPT_ARABIC			= HB_TAG ('A','r','a','b'),
    186   /*1.1*/ HB_SCRIPT_ARMENIAN			= HB_TAG ('A','r','m','n'),
    187   /*1.1*/ HB_SCRIPT_BENGALI			= HB_TAG ('B','e','n','g'),
    188   /*1.1*/ HB_SCRIPT_CYRILLIC			= HB_TAG ('C','y','r','l'),
    189   /*1.1*/ HB_SCRIPT_DEVANAGARI			= HB_TAG ('D','e','v','a'),
    190   /*1.1*/ HB_SCRIPT_GEORGIAN			= HB_TAG ('G','e','o','r'),
    191   /*1.1*/ HB_SCRIPT_GREEK			= HB_TAG ('G','r','e','k'),
    192   /*1.1*/ HB_SCRIPT_GUJARATI			= HB_TAG ('G','u','j','r'),
    193   /*1.1*/ HB_SCRIPT_GURMUKHI			= HB_TAG ('G','u','r','u'),
    194   /*1.1*/ HB_SCRIPT_HANGUL			= HB_TAG ('H','a','n','g'),
    195   /*1.1*/ HB_SCRIPT_HAN				= HB_TAG ('H','a','n','i'),
    196   /*1.1*/ HB_SCRIPT_HEBREW			= HB_TAG ('H','e','b','r'),
    197   /*1.1*/ HB_SCRIPT_HIRAGANA			= HB_TAG ('H','i','r','a'),
    198   /*1.1*/ HB_SCRIPT_KANNADA			= HB_TAG ('K','n','d','a'),
    199   /*1.1*/ HB_SCRIPT_KATAKANA			= HB_TAG ('K','a','n','a'),
    200   /*1.1*/ HB_SCRIPT_LAO				= HB_TAG ('L','a','o','o'),
    201   /*1.1*/ HB_SCRIPT_LATIN			= HB_TAG ('L','a','t','n'),
    202   /*1.1*/ HB_SCRIPT_MALAYALAM			= HB_TAG ('M','l','y','m'),
    203   /*1.1*/ HB_SCRIPT_ORIYA			= HB_TAG ('O','r','y','a'),
    204   /*1.1*/ HB_SCRIPT_TAMIL			= HB_TAG ('T','a','m','l'),
    205   /*1.1*/ HB_SCRIPT_TELUGU			= HB_TAG ('T','e','l','u'),
    206   /*1.1*/ HB_SCRIPT_THAI			= HB_TAG ('T','h','a','i'),
    207 
    208   /*2.0*/ HB_SCRIPT_TIBETAN			= HB_TAG ('T','i','b','t'),
    209 
    210   /*3.0*/ HB_SCRIPT_BOPOMOFO			= HB_TAG ('B','o','p','o'),
    211   /*3.0*/ HB_SCRIPT_BRAILLE			= HB_TAG ('B','r','a','i'),
    212   /*3.0*/ HB_SCRIPT_CANADIAN_SYLLABICS		= HB_TAG ('C','a','n','s'),
    213   /*3.0*/ HB_SCRIPT_CHEROKEE			= HB_TAG ('C','h','e','r'),
    214   /*3.0*/ HB_SCRIPT_ETHIOPIC			= HB_TAG ('E','t','h','i'),
    215   /*3.0*/ HB_SCRIPT_KHMER			= HB_TAG ('K','h','m','r'),
    216   /*3.0*/ HB_SCRIPT_MONGOLIAN			= HB_TAG ('M','o','n','g'),
    217   /*3.0*/ HB_SCRIPT_MYANMAR			= HB_TAG ('M','y','m','r'),
    218   /*3.0*/ HB_SCRIPT_OGHAM			= HB_TAG ('O','g','a','m'),
    219   /*3.0*/ HB_SCRIPT_RUNIC			= HB_TAG ('R','u','n','r'),
    220   /*3.0*/ HB_SCRIPT_SINHALA			= HB_TAG ('S','i','n','h'),
    221   /*3.0*/ HB_SCRIPT_SYRIAC			= HB_TAG ('S','y','r','c'),
    222   /*3.0*/ HB_SCRIPT_THAANA			= HB_TAG ('T','h','a','a'),
    223   /*3.0*/ HB_SCRIPT_YI				= HB_TAG ('Y','i','i','i'),
    224 
    225   /*3.1*/ HB_SCRIPT_DESERET			= HB_TAG ('D','s','r','t'),
    226   /*3.1*/ HB_SCRIPT_GOTHIC			= HB_TAG ('G','o','t','h'),
    227   /*3.1*/ HB_SCRIPT_OLD_ITALIC			= HB_TAG ('I','t','a','l'),
    228 
    229   /*3.2*/ HB_SCRIPT_BUHID			= HB_TAG ('B','u','h','d'),
    230   /*3.2*/ HB_SCRIPT_HANUNOO			= HB_TAG ('H','a','n','o'),
    231   /*3.2*/ HB_SCRIPT_TAGALOG			= HB_TAG ('T','g','l','g'),
    232   /*3.2*/ HB_SCRIPT_TAGBANWA			= HB_TAG ('T','a','g','b'),
    233 
    234   /*4.0*/ HB_SCRIPT_CYPRIOT			= HB_TAG ('C','p','r','t'),
    235   /*4.0*/ HB_SCRIPT_LIMBU			= HB_TAG ('L','i','m','b'),
    236   /*4.0*/ HB_SCRIPT_LINEAR_B			= HB_TAG ('L','i','n','b'),
    237   /*4.0*/ HB_SCRIPT_OSMANYA			= HB_TAG ('O','s','m','a'),
    238   /*4.0*/ HB_SCRIPT_SHAVIAN			= HB_TAG ('S','h','a','w'),
    239   /*4.0*/ HB_SCRIPT_TAI_LE			= HB_TAG ('T','a','l','e'),
    240   /*4.0*/ HB_SCRIPT_UGARITIC			= HB_TAG ('U','g','a','r'),
    241 
    242   /*4.1*/ HB_SCRIPT_BUGINESE			= HB_TAG ('B','u','g','i'),
    243   /*4.1*/ HB_SCRIPT_COPTIC			= HB_TAG ('C','o','p','t'),
    244   /*4.1*/ HB_SCRIPT_GLAGOLITIC			= HB_TAG ('G','l','a','g'),
    245   /*4.1*/ HB_SCRIPT_KHAROSHTHI			= HB_TAG ('K','h','a','r'),
    246   /*4.1*/ HB_SCRIPT_NEW_TAI_LUE			= HB_TAG ('T','a','l','u'),
    247   /*4.1*/ HB_SCRIPT_OLD_PERSIAN			= HB_TAG ('X','p','e','o'),
    248   /*4.1*/ HB_SCRIPT_SYLOTI_NAGRI		= HB_TAG ('S','y','l','o'),
    249   /*4.1*/ HB_SCRIPT_TIFINAGH			= HB_TAG ('T','f','n','g'),
    250 
    251   /*5.0*/ HB_SCRIPT_BALINESE			= HB_TAG ('B','a','l','i'),
    252   /*5.0*/ HB_SCRIPT_CUNEIFORM			= HB_TAG ('X','s','u','x'),
    253   /*5.0*/ HB_SCRIPT_NKO				= HB_TAG ('N','k','o','o'),
    254   /*5.0*/ HB_SCRIPT_PHAGS_PA			= HB_TAG ('P','h','a','g'),
    255   /*5.0*/ HB_SCRIPT_PHOENICIAN			= HB_TAG ('P','h','n','x'),
    256 
    257   /*5.1*/ HB_SCRIPT_CARIAN			= HB_TAG ('C','a','r','i'),
    258   /*5.1*/ HB_SCRIPT_CHAM			= HB_TAG ('C','h','a','m'),
    259   /*5.1*/ HB_SCRIPT_KAYAH_LI			= HB_TAG ('K','a','l','i'),
    260   /*5.1*/ HB_SCRIPT_LEPCHA			= HB_TAG ('L','e','p','c'),
    261   /*5.1*/ HB_SCRIPT_LYCIAN			= HB_TAG ('L','y','c','i'),
    262   /*5.1*/ HB_SCRIPT_LYDIAN			= HB_TAG ('L','y','d','i'),
    263   /*5.1*/ HB_SCRIPT_OL_CHIKI			= HB_TAG ('O','l','c','k'),
    264   /*5.1*/ HB_SCRIPT_REJANG			= HB_TAG ('R','j','n','g'),
    265   /*5.1*/ HB_SCRIPT_SAURASHTRA			= HB_TAG ('S','a','u','r'),
    266   /*5.1*/ HB_SCRIPT_SUNDANESE			= HB_TAG ('S','u','n','d'),
    267   /*5.1*/ HB_SCRIPT_VAI				= HB_TAG ('V','a','i','i'),
    268 
    269   /*5.2*/ HB_SCRIPT_AVESTAN			= HB_TAG ('A','v','s','t'),
    270   /*5.2*/ HB_SCRIPT_BAMUM			= HB_TAG ('B','a','m','u'),
    271   /*5.2*/ HB_SCRIPT_EGYPTIAN_HIEROGLYPHS	= HB_TAG ('E','g','y','p'),
    272   /*5.2*/ HB_SCRIPT_IMPERIAL_ARAMAIC		= HB_TAG ('A','r','m','i'),
    273   /*5.2*/ HB_SCRIPT_INSCRIPTIONAL_PAHLAVI	= HB_TAG ('P','h','l','i'),
    274   /*5.2*/ HB_SCRIPT_INSCRIPTIONAL_PARTHIAN	= HB_TAG ('P','r','t','i'),
    275   /*5.2*/ HB_SCRIPT_JAVANESE			= HB_TAG ('J','a','v','a'),
    276   /*5.2*/ HB_SCRIPT_KAITHI			= HB_TAG ('K','t','h','i'),
    277   /*5.2*/ HB_SCRIPT_LISU			= HB_TAG ('L','i','s','u'),
    278   /*5.2*/ HB_SCRIPT_MEETEI_MAYEK		= HB_TAG ('M','t','e','i'),
    279   /*5.2*/ HB_SCRIPT_OLD_SOUTH_ARABIAN		= HB_TAG ('S','a','r','b'),
    280   /*5.2*/ HB_SCRIPT_OLD_TURKIC			= HB_TAG ('O','r','k','h'),
    281   /*5.2*/ HB_SCRIPT_SAMARITAN			= HB_TAG ('S','a','m','r'),
    282   /*5.2*/ HB_SCRIPT_TAI_THAM			= HB_TAG ('L','a','n','a'),
    283   /*5.2*/ HB_SCRIPT_TAI_VIET			= HB_TAG ('T','a','v','t'),
    284 
    285   /*6.0*/ HB_SCRIPT_BATAK			= HB_TAG ('B','a','t','k'),
    286   /*6.0*/ HB_SCRIPT_BRAHMI			= HB_TAG ('B','r','a','h'),
    287   /*6.0*/ HB_SCRIPT_MANDAIC			= HB_TAG ('M','a','n','d'),
    288 
    289   /*6.1*/ HB_SCRIPT_CHAKMA			= HB_TAG ('C','a','k','m'),
    290   /*6.1*/ HB_SCRIPT_MEROITIC_CURSIVE		= HB_TAG ('M','e','r','c'),
    291   /*6.1*/ HB_SCRIPT_MEROITIC_HIEROGLYPHS	= HB_TAG ('M','e','r','o'),
    292   /*6.1*/ HB_SCRIPT_MIAO			= HB_TAG ('P','l','r','d'),
    293   /*6.1*/ HB_SCRIPT_SHARADA			= HB_TAG ('S','h','r','d'),
    294   /*6.1*/ HB_SCRIPT_SORA_SOMPENG		= HB_TAG ('S','o','r','a'),
    295   /*6.1*/ HB_SCRIPT_TAKRI			= HB_TAG ('T','a','k','r'),
    296 
    297   /*
    298    * Since: 0.9.30
    299    */
    300   /*7.0*/ HB_SCRIPT_BASSA_VAH			= HB_TAG ('B','a','s','s'),
    301   /*7.0*/ HB_SCRIPT_CAUCASIAN_ALBANIAN		= HB_TAG ('A','g','h','b'),
    302   /*7.0*/ HB_SCRIPT_DUPLOYAN			= HB_TAG ('D','u','p','l'),
    303   /*7.0*/ HB_SCRIPT_ELBASAN			= HB_TAG ('E','l','b','a'),
    304   /*7.0*/ HB_SCRIPT_GRANTHA			= HB_TAG ('G','r','a','n'),
    305   /*7.0*/ HB_SCRIPT_KHOJKI			= HB_TAG ('K','h','o','j'),
    306   /*7.0*/ HB_SCRIPT_KHUDAWADI			= HB_TAG ('S','i','n','d'),
    307   /*7.0*/ HB_SCRIPT_LINEAR_A			= HB_TAG ('L','i','n','a'),
    308   /*7.0*/ HB_SCRIPT_MAHAJANI			= HB_TAG ('M','a','h','j'),
    309   /*7.0*/ HB_SCRIPT_MANICHAEAN			= HB_TAG ('M','a','n','i'),
    310   /*7.0*/ HB_SCRIPT_MENDE_KIKAKUI		= HB_TAG ('M','e','n','d'),
    311   /*7.0*/ HB_SCRIPT_MODI			= HB_TAG ('M','o','d','i'),
    312   /*7.0*/ HB_SCRIPT_MRO				= HB_TAG ('M','r','o','o'),
    313   /*7.0*/ HB_SCRIPT_NABATAEAN			= HB_TAG ('N','b','a','t'),
    314   /*7.0*/ HB_SCRIPT_OLD_NORTH_ARABIAN		= HB_TAG ('N','a','r','b'),
    315   /*7.0*/ HB_SCRIPT_OLD_PERMIC			= HB_TAG ('P','e','r','m'),
    316   /*7.0*/ HB_SCRIPT_PAHAWH_HMONG		= HB_TAG ('H','m','n','g'),
    317   /*7.0*/ HB_SCRIPT_PALMYRENE			= HB_TAG ('P','a','l','m'),
    318   /*7.0*/ HB_SCRIPT_PAU_CIN_HAU			= HB_TAG ('P','a','u','c'),
    319   /*7.0*/ HB_SCRIPT_PSALTER_PAHLAVI		= HB_TAG ('P','h','l','p'),
    320   /*7.0*/ HB_SCRIPT_SIDDHAM			= HB_TAG ('S','i','d','d'),
    321   /*7.0*/ HB_SCRIPT_TIRHUTA			= HB_TAG ('T','i','r','h'),
    322   /*7.0*/ HB_SCRIPT_WARANG_CITI			= HB_TAG ('W','a','r','a'),
    323 
    324   /*8.0*/ HB_SCRIPT_AHOM			= HB_TAG ('A','h','o','m'),
    325   /*8.0*/ HB_SCRIPT_ANATOLIAN_HIEROGLYPHS	= HB_TAG ('H','l','u','w'),
    326   /*8.0*/ HB_SCRIPT_HATRAN			= HB_TAG ('H','a','t','r'),
    327   /*8.0*/ HB_SCRIPT_MULTANI			= HB_TAG ('M','u','l','t'),
    328   /*8.0*/ HB_SCRIPT_OLD_HUNGARIAN		= HB_TAG ('H','u','n','g'),
    329   /*8.0*/ HB_SCRIPT_SIGNWRITING			= HB_TAG ('S','g','n','w'),
    330 
    331   /*
    332    * Since 1.3.0
    333    */
    334   /*9.0*/ HB_SCRIPT_ADLAM			= HB_TAG ('A','d','l','m'),
    335   /*9.0*/ HB_SCRIPT_BHAIKSUKI			= HB_TAG ('B','h','k','s'),
    336   /*9.0*/ HB_SCRIPT_MARCHEN			= HB_TAG ('M','a','r','c'),
    337   /*9.0*/ HB_SCRIPT_OSAGE			= HB_TAG ('O','s','g','e'),
    338   /*9.0*/ HB_SCRIPT_TANGUT			= HB_TAG ('T','a','n','g'),
    339   /*9.0*/ HB_SCRIPT_NEWA			= HB_TAG ('N','e','w','a'),
    340 
    341   /*
    342    * Since 1.6.0
    343    */
    344   /*10.0*/HB_SCRIPT_MASARAM_GONDI		= HB_TAG ('G','o','n','m'),
    345   /*10.0*/HB_SCRIPT_NUSHU			= HB_TAG ('N','s','h','u'),
    346   /*10.0*/HB_SCRIPT_SOYOMBO			= HB_TAG ('S','o','y','o'),
    347   /*10.0*/HB_SCRIPT_ZANABAZAR_SQUARE		= HB_TAG ('Z','a','n','b'),
    348 
    349   /*
    350    * Since 1.8.0
    351    */
    352   /*11.0*/HB_SCRIPT_DOGRA			= HB_TAG ('D','o','g','r'),
    353   /*11.0*/HB_SCRIPT_GUNJALA_GONDI		= HB_TAG ('G','o','n','g'),
    354   /*11.0*/HB_SCRIPT_HANIFI_ROHINGYA		= HB_TAG ('R','o','h','g'),
    355   /*11.0*/HB_SCRIPT_MAKASAR			= HB_TAG ('M','a','k','a'),
    356   /*11.0*/HB_SCRIPT_MEDEFAIDRIN			= HB_TAG ('M','e','d','f'),
    357   /*11.0*/HB_SCRIPT_OLD_SOGDIAN			= HB_TAG ('S','o','g','o'),
    358   /*11.0*/HB_SCRIPT_SOGDIAN			= HB_TAG ('S','o','g','d'),
    359 
    360   /* No script set. */
    361   HB_SCRIPT_INVALID				= HB_TAG_NONE,
    362 
    363   /* Dummy values to ensure any hb_tag_t value can be passed/stored as hb_script_t
    364    * without risking undefined behavior.  We have two, for historical reasons.
    365    * HB_TAG_MAX used to be unsigned, but that was invalid Ansi C, so was changed
    366    * to _HB_SCRIPT_MAX_VALUE to be equal to HB_TAG_MAX_SIGNED as well.
    367    *
    368    * See this thread for technicalities:
    369    *
    370    *   https://lists.freedesktop.org/archives/harfbuzz/2014-March/004150.html
    371    */
    372   _HB_SCRIPT_MAX_VALUE				= HB_TAG_MAX_SIGNED, /*< skip >*/
    373   _HB_SCRIPT_MAX_VALUE_SIGNED			= HB_TAG_MAX_SIGNED /*< skip >*/
    374 
    375 } hb_script_t;
    376 
    377 
    378 /* Script functions */
    379 
    380 HB_EXTERN hb_script_t
    381 hb_script_from_iso15924_tag (hb_tag_t tag);
    382 
    383 HB_EXTERN hb_script_t
    384 hb_script_from_string (const char *str, int len);
    385 
    386 HB_EXTERN hb_tag_t
    387 hb_script_to_iso15924_tag (hb_script_t script);
    388 
    389 HB_EXTERN hb_direction_t
    390 hb_script_get_horizontal_direction (hb_script_t script);
    391 
    392 
    393 /* User data */
    394 
    395 typedef struct hb_user_data_key_t {
    396   /*< private >*/
    397   char unused;
    398 } hb_user_data_key_t;
    399 
    400 typedef void (*hb_destroy_func_t) (void *user_data);
    401 
    402 
    403 /* Font features and variations. */
    404 
    405 /**
    406  * HB_FEATURE_GLOBAL_START
    407  *
    408  * Since: 2.0.0
    409  */
    410 #define HB_FEATURE_GLOBAL_START	0
    411 /**
    412  * HB_FEATURE_GLOBAL_END
    413  *
    414  * Since: 2.0.0
    415  */
    416 #define HB_FEATURE_GLOBAL_END	((unsigned int) -1)
    417 
    418 typedef struct hb_feature_t {
    419   hb_tag_t      tag;
    420   uint32_t      value;
    421   unsigned int  start;
    422   unsigned int  end;
    423 } hb_feature_t;
    424 
    425 HB_EXTERN hb_bool_t
    426 hb_feature_from_string (const char *str, int len,
    427 			hb_feature_t *feature);
    428 
    429 HB_EXTERN void
    430 hb_feature_to_string (hb_feature_t *feature,
    431 		      char *buf, unsigned int size);
    432 
    433 /**
    434  * hb_variation_t:
    435  *
    436  * Since: 1.4.2
    437  */
    438 typedef struct hb_variation_t {
    439   hb_tag_t tag;
    440   float    value;
    441 } hb_variation_t;
    442 
    443 HB_EXTERN hb_bool_t
    444 hb_variation_from_string (const char *str, int len,
    445 			  hb_variation_t *variation);
    446 
    447 HB_EXTERN void
    448 hb_variation_to_string (hb_variation_t *variation,
    449 			char *buf, unsigned int size);
    450 
    451 /**
    452  * hb_color_t:
    453  *
    454  * Data type for holding color values.
    455  *
    456  * Since: 2.1.0
    457  */
    458 typedef uint32_t hb_color_t;
    459 
    460 #define HB_COLOR(b,g,r,a) ((hb_color_t) HB_TAG ((b),(g),(r),(a)))
    461 
    462 /**
    463  * hb_color_get_alpha:
    464  *
    465  *
    466  *
    467  * Since: 2.1.0
    468  */
    469 #define hb_color_get_alpha(color)	((color) & 0xFF)
    470 /**
    471  * hb_color_get_red:
    472  *
    473  *
    474  *
    475  * Since: 2.1.0
    476  */
    477 #define hb_color_get_red(color)		(((color) >> 8) & 0xFF)
    478 /**
    479  * hb_color_get_green:
    480  *
    481  *
    482  *
    483  * Since: 2.1.0
    484  */
    485 #define hb_color_get_green(color)	(((color) >> 16) & 0xFF)
    486 /**
    487  * hb_color_get_blue:
    488  *
    489  *
    490  *
    491  * Since: 2.1.0
    492  */
    493 #define hb_color_get_blue(color)	(((color) >> 24) & 0xFF)
    494 
    495 
    496 HB_END_DECLS
    497 
    498 #endif /* HB_COMMON_H */
    499