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_BEGIN_DECLS 37 # ifdef __cplusplus 38 # define HB_BEGIN_DECLS extern "C" { 39 # define HB_END_DECLS } 40 # else /* !__cplusplus */ 41 # define HB_BEGIN_DECLS 42 # define HB_END_DECLS 43 # endif /* !__cplusplus */ 44 #endif 45 46 #if !defined (HB_DONT_DEFINE_STDINT) 47 48 #if defined (_SVR4) || defined (SVR4) || defined (__OpenBSD__) || \ 49 defined (_sgi) || defined (__sun) || defined (sun) || \ 50 defined (__digital__) || defined (__HP_cc) 51 # include <inttypes.h> 52 #elif defined (_AIX) 53 # include <sys/inttypes.h> 54 /* VS 2010 (_MSC_VER 1600) has stdint.h */ 55 #elif defined (_MSC_VER) && _MSC_VER < 1600 56 typedef __int8 int8_t; 57 typedef unsigned __int8 uint8_t; 58 typedef __int16 int16_t; 59 typedef unsigned __int16 uint16_t; 60 typedef __int32 int32_t; 61 typedef unsigned __int32 uint32_t; 62 typedef __int64 int64_t; 63 typedef unsigned __int64 uint64_t; 64 #else 65 # include <stdint.h> 66 #endif 67 68 #endif 69 70 HB_BEGIN_DECLS 71 72 73 typedef int hb_bool_t; 74 75 typedef uint32_t hb_codepoint_t; 76 typedef int32_t hb_position_t; 77 typedef uint32_t hb_mask_t; 78 79 typedef union _hb_var_int_t { 80 uint32_t u32; 81 int32_t i32; 82 uint16_t u16[2]; 83 int16_t i16[2]; 84 uint8_t u8[4]; 85 int8_t i8[4]; 86 } hb_var_int_t; 87 88 89 /* hb_tag_t */ 90 91 typedef uint32_t hb_tag_t; 92 93 #define HB_TAG(c1,c2,c3,c4) ((hb_tag_t)((((uint8_t)(c1))<<24)|(((uint8_t)(c2))<<16)|(((uint8_t)(c3))<<8)|((uint8_t)(c4)))) 94 #define HB_UNTAG(tag) ((uint8_t)((tag)>>24)), ((uint8_t)((tag)>>16)), ((uint8_t)((tag)>>8)), ((uint8_t)(tag)) 95 96 #define HB_TAG_NONE HB_TAG(0,0,0,0) 97 #define HB_TAG_MAX HB_TAG(0xff,0xff,0xff,0xff) 98 #define HB_TAG_MAX_SIGNED HB_TAG(0x7f,0xff,0xff,0xff) 99 100 /* len=-1 means str is NUL-terminated. */ 101 HB_EXTERN hb_tag_t 102 hb_tag_from_string (const char *str, int len); 103 104 /* buf should have 4 bytes. */ 105 HB_EXTERN void 106 hb_tag_to_string (hb_tag_t tag, char *buf); 107 108 109 /** 110 * hb_direction_t: 111 * @HB_DIRECTION_INVALID: Initial, unset direction. 112 * @HB_DIRECTION_LTR: Text is set horizontally from left to right. 113 * @HB_DIRECTION_RTL: Text is set horizontally from right to left. 114 * @HB_DIRECTION_TTB: Text is set vertically from top to bottom. 115 * @HB_DIRECTION_BTT: Text is set vertically from bottom to top. 116 */ 117 typedef enum { 118 HB_DIRECTION_INVALID = 0, 119 HB_DIRECTION_LTR = 4, 120 HB_DIRECTION_RTL, 121 HB_DIRECTION_TTB, 122 HB_DIRECTION_BTT 123 } hb_direction_t; 124 125 /* len=-1 means str is NUL-terminated */ 126 HB_EXTERN hb_direction_t 127 hb_direction_from_string (const char *str, int len); 128 129 HB_EXTERN const char * 130 hb_direction_to_string (hb_direction_t direction); 131 132 #define HB_DIRECTION_IS_VALID(dir) ((((unsigned int) (dir)) & ~3U) == 4) 133 /* Direction must be valid for the following */ 134 #define HB_DIRECTION_IS_HORIZONTAL(dir) ((((unsigned int) (dir)) & ~1U) == 4) 135 #define HB_DIRECTION_IS_VERTICAL(dir) ((((unsigned int) (dir)) & ~1U) == 6) 136 #define HB_DIRECTION_IS_FORWARD(dir) ((((unsigned int) (dir)) & ~2U) == 4) 137 #define HB_DIRECTION_IS_BACKWARD(dir) ((((unsigned int) (dir)) & ~2U) == 5) 138 #define HB_DIRECTION_REVERSE(dir) ((hb_direction_t) (((unsigned int) (dir)) ^ 1)) 139 140 141 /* hb_language_t */ 142 143 typedef const struct hb_language_impl_t *hb_language_t; 144 145 HB_EXTERN hb_language_t 146 hb_language_from_string (const char *str, int len); 147 148 HB_EXTERN const char * 149 hb_language_to_string (hb_language_t language); 150 151 #define HB_LANGUAGE_INVALID ((hb_language_t) NULL) 152 153 HB_EXTERN hb_language_t 154 hb_language_get_default (void); 155 156 157 /* hb_script_t */ 158 159 /* http://unicode.org/iso15924/ */ 160 /* http://goo.gl/x9ilM */ 161 /* Unicode Character Database property: Script (sc) */ 162 typedef enum 163 { 164 /*1.1*/ HB_SCRIPT_COMMON = HB_TAG ('Z','y','y','y'), 165 /*1.1*/ HB_SCRIPT_INHERITED = HB_TAG ('Z','i','n','h'), 166 /*5.0*/ HB_SCRIPT_UNKNOWN = HB_TAG ('Z','z','z','z'), 167 168 /*1.1*/ HB_SCRIPT_ARABIC = HB_TAG ('A','r','a','b'), 169 /*1.1*/ HB_SCRIPT_ARMENIAN = HB_TAG ('A','r','m','n'), 170 /*1.1*/ HB_SCRIPT_BENGALI = HB_TAG ('B','e','n','g'), 171 /*1.1*/ HB_SCRIPT_CYRILLIC = HB_TAG ('C','y','r','l'), 172 /*1.1*/ HB_SCRIPT_DEVANAGARI = HB_TAG ('D','e','v','a'), 173 /*1.1*/ HB_SCRIPT_GEORGIAN = HB_TAG ('G','e','o','r'), 174 /*1.1*/ HB_SCRIPT_GREEK = HB_TAG ('G','r','e','k'), 175 /*1.1*/ HB_SCRIPT_GUJARATI = HB_TAG ('G','u','j','r'), 176 /*1.1*/ HB_SCRIPT_GURMUKHI = HB_TAG ('G','u','r','u'), 177 /*1.1*/ HB_SCRIPT_HANGUL = HB_TAG ('H','a','n','g'), 178 /*1.1*/ HB_SCRIPT_HAN = HB_TAG ('H','a','n','i'), 179 /*1.1*/ HB_SCRIPT_HEBREW = HB_TAG ('H','e','b','r'), 180 /*1.1*/ HB_SCRIPT_HIRAGANA = HB_TAG ('H','i','r','a'), 181 /*1.1*/ HB_SCRIPT_KANNADA = HB_TAG ('K','n','d','a'), 182 /*1.1*/ HB_SCRIPT_KATAKANA = HB_TAG ('K','a','n','a'), 183 /*1.1*/ HB_SCRIPT_LAO = HB_TAG ('L','a','o','o'), 184 /*1.1*/ HB_SCRIPT_LATIN = HB_TAG ('L','a','t','n'), 185 /*1.1*/ HB_SCRIPT_MALAYALAM = HB_TAG ('M','l','y','m'), 186 /*1.1*/ HB_SCRIPT_ORIYA = HB_TAG ('O','r','y','a'), 187 /*1.1*/ HB_SCRIPT_TAMIL = HB_TAG ('T','a','m','l'), 188 /*1.1*/ HB_SCRIPT_TELUGU = HB_TAG ('T','e','l','u'), 189 /*1.1*/ HB_SCRIPT_THAI = HB_TAG ('T','h','a','i'), 190 191 /*2.0*/ HB_SCRIPT_TIBETAN = HB_TAG ('T','i','b','t'), 192 193 /*3.0*/ HB_SCRIPT_BOPOMOFO = HB_TAG ('B','o','p','o'), 194 /*3.0*/ HB_SCRIPT_BRAILLE = HB_TAG ('B','r','a','i'), 195 /*3.0*/ HB_SCRIPT_CANADIAN_SYLLABICS = HB_TAG ('C','a','n','s'), 196 /*3.0*/ HB_SCRIPT_CHEROKEE = HB_TAG ('C','h','e','r'), 197 /*3.0*/ HB_SCRIPT_ETHIOPIC = HB_TAG ('E','t','h','i'), 198 /*3.0*/ HB_SCRIPT_KHMER = HB_TAG ('K','h','m','r'), 199 /*3.0*/ HB_SCRIPT_MONGOLIAN = HB_TAG ('M','o','n','g'), 200 /*3.0*/ HB_SCRIPT_MYANMAR = HB_TAG ('M','y','m','r'), 201 /*3.0*/ HB_SCRIPT_OGHAM = HB_TAG ('O','g','a','m'), 202 /*3.0*/ HB_SCRIPT_RUNIC = HB_TAG ('R','u','n','r'), 203 /*3.0*/ HB_SCRIPT_SINHALA = HB_TAG ('S','i','n','h'), 204 /*3.0*/ HB_SCRIPT_SYRIAC = HB_TAG ('S','y','r','c'), 205 /*3.0*/ HB_SCRIPT_THAANA = HB_TAG ('T','h','a','a'), 206 /*3.0*/ HB_SCRIPT_YI = HB_TAG ('Y','i','i','i'), 207 208 /*3.1*/ HB_SCRIPT_DESERET = HB_TAG ('D','s','r','t'), 209 /*3.1*/ HB_SCRIPT_GOTHIC = HB_TAG ('G','o','t','h'), 210 /*3.1*/ HB_SCRIPT_OLD_ITALIC = HB_TAG ('I','t','a','l'), 211 212 /*3.2*/ HB_SCRIPT_BUHID = HB_TAG ('B','u','h','d'), 213 /*3.2*/ HB_SCRIPT_HANUNOO = HB_TAG ('H','a','n','o'), 214 /*3.2*/ HB_SCRIPT_TAGALOG = HB_TAG ('T','g','l','g'), 215 /*3.2*/ HB_SCRIPT_TAGBANWA = HB_TAG ('T','a','g','b'), 216 217 /*4.0*/ HB_SCRIPT_CYPRIOT = HB_TAG ('C','p','r','t'), 218 /*4.0*/ HB_SCRIPT_LIMBU = HB_TAG ('L','i','m','b'), 219 /*4.0*/ HB_SCRIPT_LINEAR_B = HB_TAG ('L','i','n','b'), 220 /*4.0*/ HB_SCRIPT_OSMANYA = HB_TAG ('O','s','m','a'), 221 /*4.0*/ HB_SCRIPT_SHAVIAN = HB_TAG ('S','h','a','w'), 222 /*4.0*/ HB_SCRIPT_TAI_LE = HB_TAG ('T','a','l','e'), 223 /*4.0*/ HB_SCRIPT_UGARITIC = HB_TAG ('U','g','a','r'), 224 225 /*4.1*/ HB_SCRIPT_BUGINESE = HB_TAG ('B','u','g','i'), 226 /*4.1*/ HB_SCRIPT_COPTIC = HB_TAG ('C','o','p','t'), 227 /*4.1*/ HB_SCRIPT_GLAGOLITIC = HB_TAG ('G','l','a','g'), 228 /*4.1*/ HB_SCRIPT_KHAROSHTHI = HB_TAG ('K','h','a','r'), 229 /*4.1*/ HB_SCRIPT_NEW_TAI_LUE = HB_TAG ('T','a','l','u'), 230 /*4.1*/ HB_SCRIPT_OLD_PERSIAN = HB_TAG ('X','p','e','o'), 231 /*4.1*/ HB_SCRIPT_SYLOTI_NAGRI = HB_TAG ('S','y','l','o'), 232 /*4.1*/ HB_SCRIPT_TIFINAGH = HB_TAG ('T','f','n','g'), 233 234 /*5.0*/ HB_SCRIPT_BALINESE = HB_TAG ('B','a','l','i'), 235 /*5.0*/ HB_SCRIPT_CUNEIFORM = HB_TAG ('X','s','u','x'), 236 /*5.0*/ HB_SCRIPT_NKO = HB_TAG ('N','k','o','o'), 237 /*5.0*/ HB_SCRIPT_PHAGS_PA = HB_TAG ('P','h','a','g'), 238 /*5.0*/ HB_SCRIPT_PHOENICIAN = HB_TAG ('P','h','n','x'), 239 240 /*5.1*/ HB_SCRIPT_CARIAN = HB_TAG ('C','a','r','i'), 241 /*5.1*/ HB_SCRIPT_CHAM = HB_TAG ('C','h','a','m'), 242 /*5.1*/ HB_SCRIPT_KAYAH_LI = HB_TAG ('K','a','l','i'), 243 /*5.1*/ HB_SCRIPT_LEPCHA = HB_TAG ('L','e','p','c'), 244 /*5.1*/ HB_SCRIPT_LYCIAN = HB_TAG ('L','y','c','i'), 245 /*5.1*/ HB_SCRIPT_LYDIAN = HB_TAG ('L','y','d','i'), 246 /*5.1*/ HB_SCRIPT_OL_CHIKI = HB_TAG ('O','l','c','k'), 247 /*5.1*/ HB_SCRIPT_REJANG = HB_TAG ('R','j','n','g'), 248 /*5.1*/ HB_SCRIPT_SAURASHTRA = HB_TAG ('S','a','u','r'), 249 /*5.1*/ HB_SCRIPT_SUNDANESE = HB_TAG ('S','u','n','d'), 250 /*5.1*/ HB_SCRIPT_VAI = HB_TAG ('V','a','i','i'), 251 252 /*5.2*/ HB_SCRIPT_AVESTAN = HB_TAG ('A','v','s','t'), 253 /*5.2*/ HB_SCRIPT_BAMUM = HB_TAG ('B','a','m','u'), 254 /*5.2*/ HB_SCRIPT_EGYPTIAN_HIEROGLYPHS = HB_TAG ('E','g','y','p'), 255 /*5.2*/ HB_SCRIPT_IMPERIAL_ARAMAIC = HB_TAG ('A','r','m','i'), 256 /*5.2*/ HB_SCRIPT_INSCRIPTIONAL_PAHLAVI = HB_TAG ('P','h','l','i'), 257 /*5.2*/ HB_SCRIPT_INSCRIPTIONAL_PARTHIAN = HB_TAG ('P','r','t','i'), 258 /*5.2*/ HB_SCRIPT_JAVANESE = HB_TAG ('J','a','v','a'), 259 /*5.2*/ HB_SCRIPT_KAITHI = HB_TAG ('K','t','h','i'), 260 /*5.2*/ HB_SCRIPT_LISU = HB_TAG ('L','i','s','u'), 261 /*5.2*/ HB_SCRIPT_MEETEI_MAYEK = HB_TAG ('M','t','e','i'), 262 /*5.2*/ HB_SCRIPT_OLD_SOUTH_ARABIAN = HB_TAG ('S','a','r','b'), 263 /*5.2*/ HB_SCRIPT_OLD_TURKIC = HB_TAG ('O','r','k','h'), 264 /*5.2*/ HB_SCRIPT_SAMARITAN = HB_TAG ('S','a','m','r'), 265 /*5.2*/ HB_SCRIPT_TAI_THAM = HB_TAG ('L','a','n','a'), 266 /*5.2*/ HB_SCRIPT_TAI_VIET = HB_TAG ('T','a','v','t'), 267 268 /*6.0*/ HB_SCRIPT_BATAK = HB_TAG ('B','a','t','k'), 269 /*6.0*/ HB_SCRIPT_BRAHMI = HB_TAG ('B','r','a','h'), 270 /*6.0*/ HB_SCRIPT_MANDAIC = HB_TAG ('M','a','n','d'), 271 272 /*6.1*/ HB_SCRIPT_CHAKMA = HB_TAG ('C','a','k','m'), 273 /*6.1*/ HB_SCRIPT_MEROITIC_CURSIVE = HB_TAG ('M','e','r','c'), 274 /*6.1*/ HB_SCRIPT_MEROITIC_HIEROGLYPHS = HB_TAG ('M','e','r','o'), 275 /*6.1*/ HB_SCRIPT_MIAO = HB_TAG ('P','l','r','d'), 276 /*6.1*/ HB_SCRIPT_SHARADA = HB_TAG ('S','h','r','d'), 277 /*6.1*/ HB_SCRIPT_SORA_SOMPENG = HB_TAG ('S','o','r','a'), 278 /*6.1*/ HB_SCRIPT_TAKRI = HB_TAG ('T','a','k','r'), 279 280 /* 281 * Since: 0.9.30 282 */ 283 /*7.0*/ HB_SCRIPT_BASSA_VAH = HB_TAG ('B','a','s','s'), 284 /*7.0*/ HB_SCRIPT_CAUCASIAN_ALBANIAN = HB_TAG ('A','g','h','b'), 285 /*7.0*/ HB_SCRIPT_DUPLOYAN = HB_TAG ('D','u','p','l'), 286 /*7.0*/ HB_SCRIPT_ELBASAN = HB_TAG ('E','l','b','a'), 287 /*7.0*/ HB_SCRIPT_GRANTHA = HB_TAG ('G','r','a','n'), 288 /*7.0*/ HB_SCRIPT_KHOJKI = HB_TAG ('K','h','o','j'), 289 /*7.0*/ HB_SCRIPT_KHUDAWADI = HB_TAG ('S','i','n','d'), 290 /*7.0*/ HB_SCRIPT_LINEAR_A = HB_TAG ('L','i','n','a'), 291 /*7.0*/ HB_SCRIPT_MAHAJANI = HB_TAG ('M','a','h','j'), 292 /*7.0*/ HB_SCRIPT_MANICHAEAN = HB_TAG ('M','a','n','i'), 293 /*7.0*/ HB_SCRIPT_MENDE_KIKAKUI = HB_TAG ('M','e','n','d'), 294 /*7.0*/ HB_SCRIPT_MODI = HB_TAG ('M','o','d','i'), 295 /*7.0*/ HB_SCRIPT_MRO = HB_TAG ('M','r','o','o'), 296 /*7.0*/ HB_SCRIPT_NABATAEAN = HB_TAG ('N','b','a','t'), 297 /*7.0*/ HB_SCRIPT_OLD_NORTH_ARABIAN = HB_TAG ('N','a','r','b'), 298 /*7.0*/ HB_SCRIPT_OLD_PERMIC = HB_TAG ('P','e','r','m'), 299 /*7.0*/ HB_SCRIPT_PAHAWH_HMONG = HB_TAG ('H','m','n','g'), 300 /*7.0*/ HB_SCRIPT_PALMYRENE = HB_TAG ('P','a','l','m'), 301 /*7.0*/ HB_SCRIPT_PAU_CIN_HAU = HB_TAG ('P','a','u','c'), 302 /*7.0*/ HB_SCRIPT_PSALTER_PAHLAVI = HB_TAG ('P','h','l','p'), 303 /*7.0*/ HB_SCRIPT_SIDDHAM = HB_TAG ('S','i','d','d'), 304 /*7.0*/ HB_SCRIPT_TIRHUTA = HB_TAG ('T','i','r','h'), 305 /*7.0*/ HB_SCRIPT_WARANG_CITI = HB_TAG ('W','a','r','a'), 306 307 /*8.0*/ HB_SCRIPT_AHOM = HB_TAG ('A','h','o','m'), 308 /*8.0*/ HB_SCRIPT_ANATOLIAN_HIEROGLYPHS = HB_TAG ('H','l','u','w'), 309 /*8.0*/ HB_SCRIPT_HATRAN = HB_TAG ('H','a','t','r'), 310 /*8.0*/ HB_SCRIPT_MULTANI = HB_TAG ('M','u','l','t'), 311 /*8.0*/ HB_SCRIPT_OLD_HUNGARIAN = HB_TAG ('H','u','n','g'), 312 /*8.0*/ HB_SCRIPT_SIGNWRITING = HB_TAG ('S','g','n','w'), 313 314 /* No script set. */ 315 HB_SCRIPT_INVALID = HB_TAG_NONE, 316 317 /* Dummy values to ensure any hb_tag_t value can be passed/stored as hb_script_t 318 * without risking undefined behavior. Include both a signed and unsigned max, 319 * since technically enums are int, and indeed, hb_script_t ends up being signed. 320 * See this thread for technicalities: 321 * 322 * http://lists.freedesktop.org/archives/harfbuzz/2014-March/004150.html 323 */ 324 _HB_SCRIPT_MAX_VALUE = HB_TAG_MAX, /*< skip >*/ 325 _HB_SCRIPT_MAX_VALUE_SIGNED = HB_TAG_MAX_SIGNED /*< skip >*/ 326 327 } hb_script_t; 328 329 330 /* Script functions */ 331 332 HB_EXTERN hb_script_t 333 hb_script_from_iso15924_tag (hb_tag_t tag); 334 335 HB_EXTERN hb_script_t 336 hb_script_from_string (const char *str, int len); 337 338 HB_EXTERN hb_tag_t 339 hb_script_to_iso15924_tag (hb_script_t script); 340 341 HB_EXTERN hb_direction_t 342 hb_script_get_horizontal_direction (hb_script_t script); 343 344 345 /* User data */ 346 347 typedef struct hb_user_data_key_t { 348 /*< private >*/ 349 char unused; 350 } hb_user_data_key_t; 351 352 typedef void (*hb_destroy_func_t) (void *user_data); 353 354 355 HB_END_DECLS 356 357 #endif /* HB_COMMON_H */ 358