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