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(a,b,c,d) ((hb_tag_t)((((uint8_t)(a))<<24)|(((uint8_t)(b))<<16)|(((uint8_t)(c))<<8)|((uint8_t)(d)))) 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 98 /* len=-1 means str is NUL-terminated. */ 99 hb_tag_t 100 hb_tag_from_string (const char *str, int len); 101 102 /* buf should have 4 bytes. */ 103 void 104 hb_tag_to_string (hb_tag_t tag, char *buf); 105 106 107 /* hb_direction_t */ 108 109 typedef enum { 110 HB_DIRECTION_INVALID = 0, 111 HB_DIRECTION_LTR = 4, 112 HB_DIRECTION_RTL, 113 HB_DIRECTION_TTB, 114 HB_DIRECTION_BTT 115 } hb_direction_t; 116 117 /* len=-1 means str is NUL-terminated */ 118 hb_direction_t 119 hb_direction_from_string (const char *str, int len); 120 121 const char * 122 hb_direction_to_string (hb_direction_t direction); 123 124 #define HB_DIRECTION_IS_HORIZONTAL(dir) ((((unsigned int) (dir)) & ~1U) == 4) 125 #define HB_DIRECTION_IS_VERTICAL(dir) ((((unsigned int) (dir)) & ~1U) == 6) 126 #define HB_DIRECTION_IS_FORWARD(dir) ((((unsigned int) (dir)) & ~2U) == 4) 127 #define HB_DIRECTION_IS_BACKWARD(dir) ((((unsigned int) (dir)) & ~2U) == 5) 128 #define HB_DIRECTION_IS_VALID(dir) ((((unsigned int) (dir)) & ~3U) == 4) 129 #define HB_DIRECTION_REVERSE(dir) ((hb_direction_t) (((unsigned int) (dir)) ^ 1)) /* Direction must be valid */ 130 131 132 /* hb_language_t */ 133 134 typedef struct hb_language_impl_t *hb_language_t; 135 136 /* len=-1 means str is NUL-terminated */ 137 hb_language_t 138 hb_language_from_string (const char *str, int len); 139 140 const char * 141 hb_language_to_string (hb_language_t language); 142 143 #define HB_LANGUAGE_INVALID ((hb_language_t) NULL) 144 145 hb_language_t 146 hb_language_get_default (void); 147 148 149 /* hb_script_t */ 150 151 /* http://unicode.org/iso15924/ */ 152 /* http://goo.gl/x9ilM */ 153 /* Unicode Character Database property: Script (sc) */ 154 typedef enum 155 { 156 /* Unicode-1.1 additions */ 157 HB_SCRIPT_COMMON = HB_TAG ('Z','y','y','y'), 158 HB_SCRIPT_ARABIC = HB_TAG ('A','r','a','b'), 159 HB_SCRIPT_ARMENIAN = HB_TAG ('A','r','m','n'), 160 HB_SCRIPT_BENGALI = HB_TAG ('B','e','n','g'), 161 HB_SCRIPT_BOPOMOFO = HB_TAG ('B','o','p','o'), 162 HB_SCRIPT_CANADIAN_ABORIGINAL = HB_TAG ('C','a','n','s'), 163 HB_SCRIPT_CHEROKEE = HB_TAG ('C','h','e','r'), 164 HB_SCRIPT_COPTIC = HB_TAG ('C','o','p','t'), 165 HB_SCRIPT_CYRILLIC = HB_TAG ('C','y','r','l'), 166 HB_SCRIPT_DEVANAGARI = HB_TAG ('D','e','v','a'), 167 HB_SCRIPT_GEORGIAN = HB_TAG ('G','e','o','r'), 168 HB_SCRIPT_GREEK = HB_TAG ('G','r','e','k'), 169 HB_SCRIPT_GUJARATI = HB_TAG ('G','u','j','r'), 170 HB_SCRIPT_GURMUKHI = HB_TAG ('G','u','r','u'), 171 HB_SCRIPT_HANGUL = HB_TAG ('H','a','n','g'), 172 HB_SCRIPT_HAN = HB_TAG ('H','a','n','i'), 173 HB_SCRIPT_HEBREW = HB_TAG ('H','e','b','r'), 174 HB_SCRIPT_HIRAGANA = HB_TAG ('H','i','r','a'), 175 HB_SCRIPT_INHERITED = HB_TAG ('Z','i','n','h'), 176 HB_SCRIPT_KANNADA = HB_TAG ('K','n','d','a'), 177 HB_SCRIPT_KATAKANA = HB_TAG ('K','a','n','a'), 178 HB_SCRIPT_LAO = HB_TAG ('L','a','o','o'), 179 HB_SCRIPT_LATIN = HB_TAG ('L','a','t','n'), 180 HB_SCRIPT_MALAYALAM = HB_TAG ('M','l','y','m'), 181 HB_SCRIPT_MONGOLIAN = HB_TAG ('M','o','n','g'), 182 HB_SCRIPT_OGHAM = HB_TAG ('O','g','a','m'), 183 HB_SCRIPT_ORIYA = HB_TAG ('O','r','y','a'), 184 HB_SCRIPT_RUNIC = HB_TAG ('R','u','n','r'), 185 HB_SCRIPT_SYRIAC = HB_TAG ('S','y','r','c'), 186 HB_SCRIPT_TAMIL = HB_TAG ('T','a','m','l'), 187 HB_SCRIPT_TELUGU = HB_TAG ('T','e','l','u'), 188 HB_SCRIPT_THAI = HB_TAG ('T','h','a','i'), 189 HB_SCRIPT_YI = HB_TAG ('Y','i','i','i'), 190 191 /* Unicode-2.0 additions */ 192 HB_SCRIPT_TIBETAN = HB_TAG ('T','i','b','t'), 193 194 /* Unicode-3.0 additions */ 195 HB_SCRIPT_ETHIOPIC = HB_TAG ('E','t','h','i'), 196 HB_SCRIPT_KHMER = HB_TAG ('K','h','m','r'), 197 HB_SCRIPT_MYANMAR = HB_TAG ('M','y','m','r'), 198 HB_SCRIPT_SINHALA = HB_TAG ('S','i','n','h'), 199 HB_SCRIPT_THAANA = HB_TAG ('T','h','a','a'), 200 201 /* Unicode-3.1 additions */ 202 HB_SCRIPT_DESERET = HB_TAG ('D','s','r','t'), 203 HB_SCRIPT_GOTHIC = HB_TAG ('G','o','t','h'), 204 HB_SCRIPT_OLD_ITALIC = HB_TAG ('I','t','a','l'), 205 206 /* Unicode-3.2 additions */ 207 HB_SCRIPT_BUHID = HB_TAG ('B','u','h','d'), 208 HB_SCRIPT_HANUNOO = HB_TAG ('H','a','n','o'), 209 HB_SCRIPT_TAGALOG = HB_TAG ('T','g','l','g'), 210 HB_SCRIPT_TAGBANWA = HB_TAG ('T','a','g','b'), 211 212 /* Unicode-4.0 additions */ 213 HB_SCRIPT_BRAILLE = HB_TAG ('B','r','a','i'), 214 HB_SCRIPT_CYPRIOT = HB_TAG ('C','p','r','t'), 215 HB_SCRIPT_LIMBU = HB_TAG ('L','i','m','b'), 216 HB_SCRIPT_LINEAR_B = HB_TAG ('L','i','n','b'), 217 HB_SCRIPT_OSMANYA = HB_TAG ('O','s','m','a'), 218 HB_SCRIPT_SHAVIAN = HB_TAG ('S','h','a','w'), 219 HB_SCRIPT_TAI_LE = HB_TAG ('T','a','l','e'), 220 HB_SCRIPT_UGARITIC = HB_TAG ('U','g','a','r'), 221 222 /* Unicode-4.1 additions */ 223 HB_SCRIPT_BUGINESE = HB_TAG ('B','u','g','i'), 224 HB_SCRIPT_GLAGOLITIC = HB_TAG ('G','l','a','g'), 225 HB_SCRIPT_KHAROSHTHI = HB_TAG ('K','h','a','r'), 226 HB_SCRIPT_NEW_TAI_LUE = HB_TAG ('T','a','l','u'), 227 HB_SCRIPT_OLD_PERSIAN = HB_TAG ('X','p','e','o'), 228 HB_SCRIPT_SYLOTI_NAGRI = HB_TAG ('S','y','l','o'), 229 HB_SCRIPT_TIFINAGH = HB_TAG ('T','f','n','g'), 230 231 /* Unicode-5.0 additions */ 232 HB_SCRIPT_BALINESE = HB_TAG ('B','a','l','i'), 233 HB_SCRIPT_CUNEIFORM = HB_TAG ('X','s','u','x'), 234 HB_SCRIPT_NKO = HB_TAG ('N','k','o','o'), 235 HB_SCRIPT_PHAGS_PA = HB_TAG ('P','h','a','g'), 236 HB_SCRIPT_PHOENICIAN = HB_TAG ('P','h','n','x'), 237 HB_SCRIPT_UNKNOWN = HB_TAG ('Z','z','z','z'), 238 239 /* Unicode-5.1 additions */ 240 HB_SCRIPT_CARIAN = HB_TAG ('C','a','r','i'), 241 HB_SCRIPT_CHAM = HB_TAG ('C','h','a','m'), 242 HB_SCRIPT_KAYAH_LI = HB_TAG ('K','a','l','i'), 243 HB_SCRIPT_LEPCHA = HB_TAG ('L','e','p','c'), 244 HB_SCRIPT_LYCIAN = HB_TAG ('L','y','c','i'), 245 HB_SCRIPT_LYDIAN = HB_TAG ('L','y','d','i'), 246 HB_SCRIPT_OL_CHIKI = HB_TAG ('O','l','c','k'), 247 HB_SCRIPT_REJANG = HB_TAG ('R','j','n','g'), 248 HB_SCRIPT_SAURASHTRA = HB_TAG ('S','a','u','r'), 249 HB_SCRIPT_SUNDANESE = HB_TAG ('S','u','n','d'), 250 HB_SCRIPT_VAI = HB_TAG ('V','a','i','i'), 251 252 /* Unicode-5.2 additions */ 253 HB_SCRIPT_AVESTAN = HB_TAG ('A','v','s','t'), 254 HB_SCRIPT_BAMUM = HB_TAG ('B','a','m','u'), 255 HB_SCRIPT_EGYPTIAN_HIEROGLYPHS = HB_TAG ('E','g','y','p'), 256 HB_SCRIPT_IMPERIAL_ARAMAIC = HB_TAG ('A','r','m','i'), 257 HB_SCRIPT_INSCRIPTIONAL_PAHLAVI = HB_TAG ('P','h','l','i'), 258 HB_SCRIPT_INSCRIPTIONAL_PARTHIAN = HB_TAG ('P','r','t','i'), 259 HB_SCRIPT_JAVANESE = HB_TAG ('J','a','v','a'), 260 HB_SCRIPT_KAITHI = HB_TAG ('K','t','h','i'), 261 HB_SCRIPT_LISU = HB_TAG ('L','i','s','u'), 262 HB_SCRIPT_MEETEI_MAYEK = HB_TAG ('M','t','e','i'), 263 HB_SCRIPT_OLD_SOUTH_ARABIAN = HB_TAG ('S','a','r','b'), 264 HB_SCRIPT_OLD_TURKIC = HB_TAG ('O','r','k','h'), 265 HB_SCRIPT_SAMARITAN = HB_TAG ('S','a','m','r'), 266 HB_SCRIPT_TAI_THAM = HB_TAG ('L','a','n','a'), 267 HB_SCRIPT_TAI_VIET = HB_TAG ('T','a','v','t'), 268 269 /* Unicode-6.0 additions */ 270 HB_SCRIPT_BATAK = HB_TAG ('B','a','t','k'), 271 HB_SCRIPT_BRAHMI = HB_TAG ('B','r','a','h'), 272 HB_SCRIPT_MANDAIC = HB_TAG ('M','a','n','d'), 273 274 /* Unicode-6.1 additions */ 275 HB_SCRIPT_CHAKMA = HB_TAG ('C','a','k','m'), 276 HB_SCRIPT_MEROITIC_CURSIVE = HB_TAG ('M','e','r','c'), 277 HB_SCRIPT_MEROITIC_HIEROGLYPHS = HB_TAG ('M','e','r','o'), 278 HB_SCRIPT_MIAO = HB_TAG ('P','l','r','d'), 279 HB_SCRIPT_SHARADA = HB_TAG ('S','h','r','d'), 280 HB_SCRIPT_SORA_SOMPENG = HB_TAG ('S','o','r','a'), 281 HB_SCRIPT_TAKRI = HB_TAG ('T','a','k','r'), 282 283 /* No script set */ 284 HB_SCRIPT_INVALID = HB_TAG_NONE 285 } hb_script_t; 286 287 288 /* Script functions */ 289 290 hb_script_t 291 hb_script_from_iso15924_tag (hb_tag_t tag); 292 293 /* suger for tag_from_string() then script_from_iso15924_tag */ 294 /* len=-1 means s is NUL-terminated */ 295 hb_script_t 296 hb_script_from_string (const char *s, int len); 297 298 hb_tag_t 299 hb_script_to_iso15924_tag (hb_script_t script); 300 301 hb_direction_t 302 hb_script_get_horizontal_direction (hb_script_t script); 303 304 305 /* User data */ 306 307 typedef struct hb_user_data_key_t { 308 /*< private >*/ 309 char unused; 310 } hb_user_data_key_t; 311 312 typedef void (*hb_destroy_func_t) (void *user_data); 313 314 315 HB_END_DECLS 316 317 #endif /* HB_COMMON_H */ 318
