hb-common.h revision c6035cf802c60f0526f421f39a55886061df94ee
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# ifdef __cplusplus 37# define HB_BEGIN_DECLS extern "C" { 38# define HB_END_DECLS } 39# else /* !__cplusplus */ 40# define HB_BEGIN_DECLS 41# define HB_END_DECLS 42# endif /* !__cplusplus */ 43 44HB_BEGIN_DECLS 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 70 71typedef int hb_bool_t; 72 73typedef uint32_t hb_codepoint_t; 74typedef int32_t hb_position_t; 75typedef uint32_t hb_mask_t; 76 77typedef union _hb_var_int_t { 78 uint32_t u32; 79 int32_t i32; 80 uint16_t u16[2]; 81 int16_t i16[2]; 82 uint8_t u8[4]; 83 int8_t i8[4]; 84} hb_var_int_t; 85 86 87/* hb_tag_t */ 88 89typedef uint32_t hb_tag_t; 90 91#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)))) 92#define HB_UNTAG(tag) ((uint8_t)((tag)>>24)), ((uint8_t)((tag)>>16)), ((uint8_t)((tag)>>8)), ((uint8_t)(tag)) 93 94#define HB_TAG_NONE HB_TAG(0,0,0,0) 95 96/* len=-1 means s is NUL-terminated */ 97hb_tag_t hb_tag_from_string (const char *s, int len); 98 99 100/* hb_direction_t */ 101 102typedef enum _hb_direction_t { 103 HB_DIRECTION_INVALID = -1, 104 HB_DIRECTION_LTR = 0, 105 HB_DIRECTION_RTL, 106 HB_DIRECTION_TTB, 107 HB_DIRECTION_BTT 108} hb_direction_t; 109 110/* len=-1 means s is NUL-terminated */ 111hb_direction_t 112hb_direction_from_string (const char *str, int len); 113 114const char * 115hb_direction_to_string (hb_direction_t direction); 116 117#define HB_DIRECTION_IS_HORIZONTAL(dir) ((((unsigned int) (dir)) & ~1U) == 0) 118#define HB_DIRECTION_IS_VERTICAL(dir) ((((unsigned int) (dir)) & ~1U) == 2) 119#define HB_DIRECTION_IS_FORWARD(dir) ((((unsigned int) (dir)) & ~2U) == 0) 120#define HB_DIRECTION_IS_BACKWARD(dir) ((((unsigned int) (dir)) & ~2U) == 1) 121#define HB_DIRECTION_REVERSE(dir) ((hb_direction_t) (((unsigned int) (dir)) ^ 1)) 122 123 124/* hb_language_t */ 125 126typedef struct _hb_language_t *hb_language_t; 127 128/* len=-1 means s is NUL-terminated */ 129hb_language_t 130hb_language_from_string (const char *str, int len); 131 132const char * 133hb_language_to_string (hb_language_t language); 134 135#define HB_LANGUAGE_INVALID ((hb_language_t) NULL) 136 137hb_language_t 138hb_language_get_default (void); 139 140 141/* hb_unicode_general_category_t */ 142 143typedef enum _hb_unicode_general_category_t 144{ 145 HB_UNICODE_GENERAL_CATEGORY_CONTROL, /* Cc */ 146 HB_UNICODE_GENERAL_CATEGORY_FORMAT, /* Cf */ 147 HB_UNICODE_GENERAL_CATEGORY_UNASSIGNED, /* Cn */ 148 HB_UNICODE_GENERAL_CATEGORY_PRIVATE_USE, /* Co */ 149 HB_UNICODE_GENERAL_CATEGORY_SURROGATE, /* Cs */ 150 HB_UNICODE_GENERAL_CATEGORY_LOWERCASE_LETTER, /* Ll */ 151 HB_UNICODE_GENERAL_CATEGORY_MODIFIER_LETTER, /* Lm */ 152 HB_UNICODE_GENERAL_CATEGORY_OTHER_LETTER, /* Lo */ 153 HB_UNICODE_GENERAL_CATEGORY_TITLECASE_LETTER, /* Lt */ 154 HB_UNICODE_GENERAL_CATEGORY_UPPERCASE_LETTER, /* Lu */ 155 HB_UNICODE_GENERAL_CATEGORY_SPACING_MARK, /* Mc */ 156 HB_UNICODE_GENERAL_CATEGORY_ENCLOSING_MARK, /* Me */ 157 HB_UNICODE_GENERAL_CATEGORY_NON_SPACING_MARK, /* Mn */ 158 HB_UNICODE_GENERAL_CATEGORY_DECIMAL_NUMBER, /* Nd */ 159 HB_UNICODE_GENERAL_CATEGORY_LETTER_NUMBER, /* Nl */ 160 HB_UNICODE_GENERAL_CATEGORY_OTHER_NUMBER, /* No */ 161 HB_UNICODE_GENERAL_CATEGORY_CONNECT_PUNCTUATION, /* Pc */ 162 HB_UNICODE_GENERAL_CATEGORY_DASH_PUNCTUATION, /* Pd */ 163 HB_UNICODE_GENERAL_CATEGORY_CLOSE_PUNCTUATION, /* Pe */ 164 HB_UNICODE_GENERAL_CATEGORY_FINAL_PUNCTUATION, /* Pf */ 165 HB_UNICODE_GENERAL_CATEGORY_INITIAL_PUNCTUATION, /* Pi */ 166 HB_UNICODE_GENERAL_CATEGORY_OTHER_PUNCTUATION, /* Po */ 167 HB_UNICODE_GENERAL_CATEGORY_OPEN_PUNCTUATION, /* Ps */ 168 HB_UNICODE_GENERAL_CATEGORY_CURRENCY_SYMBOL, /* Sc */ 169 HB_UNICODE_GENERAL_CATEGORY_MODIFIER_SYMBOL, /* Sk */ 170 HB_UNICODE_GENERAL_CATEGORY_MATH_SYMBOL, /* Sm */ 171 HB_UNICODE_GENERAL_CATEGORY_OTHER_SYMBOL, /* So */ 172 HB_UNICODE_GENERAL_CATEGORY_LINE_SEPARATOR, /* Zl */ 173 HB_UNICODE_GENERAL_CATEGORY_PARAGRAPH_SEPARATOR, /* Zp */ 174 HB_UNICODE_GENERAL_CATEGORY_SPACE_SEPARATOR /* Zs */ 175} hb_unicode_general_category_t; 176 177 178/* hb_script_t */ 179 180/* http://unicode.org/iso15924/ */ 181/* http://goo.gl/x9ilM */ 182typedef enum _hb_script_t 183{ 184 /* Unicode-1.1 additions */ 185 HB_SCRIPT_COMMON = HB_TAG ('Z','y','y','y'), 186 HB_SCRIPT_ARABIC = HB_TAG ('A','r','a','b'), 187 HB_SCRIPT_ARMENIAN = HB_TAG ('A','r','m','n'), 188 HB_SCRIPT_BENGALI = HB_TAG ('B','e','n','g'), 189 HB_SCRIPT_BOPOMOFO = HB_TAG ('B','o','p','o'), 190 HB_SCRIPT_CANADIAN_ABORIGINAL = HB_TAG ('C','a','n','s'), 191 HB_SCRIPT_CHEROKEE = HB_TAG ('C','h','e','r'), 192 HB_SCRIPT_COPTIC = HB_TAG ('C','o','p','t'), 193 HB_SCRIPT_CYRILLIC = HB_TAG ('C','y','r','l'), 194 HB_SCRIPT_DEVANAGARI = HB_TAG ('D','e','v','a'), 195 HB_SCRIPT_GEORGIAN = HB_TAG ('G','e','o','r'), 196 HB_SCRIPT_GREEK = HB_TAG ('G','r','e','k'), 197 HB_SCRIPT_GUJARATI = HB_TAG ('G','u','j','r'), 198 HB_SCRIPT_GURMUKHI = HB_TAG ('G','u','r','u'), 199 HB_SCRIPT_HANGUL = HB_TAG ('H','a','n','g'), 200 HB_SCRIPT_HAN = HB_TAG ('H','a','n','i'), 201 HB_SCRIPT_HEBREW = HB_TAG ('H','e','b','r'), 202 HB_SCRIPT_HIRAGANA = HB_TAG ('H','i','r','a'), 203 HB_SCRIPT_INHERITED = HB_TAG ('Z','i','n','h'), 204 HB_SCRIPT_KANNADA = HB_TAG ('K','n','d','a'), 205 HB_SCRIPT_KATAKANA = HB_TAG ('K','a','n','a'), 206 HB_SCRIPT_LAO = HB_TAG ('L','a','o','o'), 207 HB_SCRIPT_LATIN = HB_TAG ('L','a','t','n'), 208 HB_SCRIPT_MALAYALAM = HB_TAG ('M','l','y','m'), 209 HB_SCRIPT_MONGOLIAN = HB_TAG ('M','o','n','g'), 210 HB_SCRIPT_OGHAM = HB_TAG ('O','g','a','m'), 211 HB_SCRIPT_ORIYA = HB_TAG ('O','r','y','a'), 212 HB_SCRIPT_RUNIC = HB_TAG ('R','u','n','r'), 213 HB_SCRIPT_SYRIAC = HB_TAG ('S','y','r','c'), 214 HB_SCRIPT_TAMIL = HB_TAG ('T','a','m','l'), 215 HB_SCRIPT_TELUGU = HB_TAG ('T','e','l','u'), 216 HB_SCRIPT_THAI = HB_TAG ('T','h','a','i'), 217 HB_SCRIPT_YI = HB_TAG ('Y','i','i','i'), 218 219 /* Unicode-2.0 additions */ 220 HB_SCRIPT_TIBETAN = HB_TAG ('T','i','b','t'), 221 222 /* Unicode-3.0 additions */ 223 HB_SCRIPT_ETHIOPIC = HB_TAG ('E','t','h','i'), 224 HB_SCRIPT_KHMER = HB_TAG ('K','h','m','r'), 225 HB_SCRIPT_MYANMAR = HB_TAG ('M','y','m','r'), 226 HB_SCRIPT_SINHALA = HB_TAG ('S','i','n','h'), 227 HB_SCRIPT_THAANA = HB_TAG ('T','h','a','a'), 228 229 /* Unicode-3.1 additions */ 230 HB_SCRIPT_DESERET = HB_TAG ('D','s','r','t'), 231 HB_SCRIPT_GOTHIC = HB_TAG ('G','o','t','h'), 232 HB_SCRIPT_OLD_ITALIC = HB_TAG ('I','t','a','l'), 233 234 /* Unicode-3.2 additions */ 235 HB_SCRIPT_BUHID = HB_TAG ('B','u','h','d'), 236 HB_SCRIPT_HANUNOO = HB_TAG ('H','a','n','o'), 237 HB_SCRIPT_TAGALOG = HB_TAG ('T','g','l','g'), 238 HB_SCRIPT_TAGBANWA = HB_TAG ('T','a','g','b'), 239 240 /* Unicode-4.0 additions */ 241 HB_SCRIPT_BRAILLE = HB_TAG ('B','r','a','i'), 242 HB_SCRIPT_CYPRIOT = HB_TAG ('C','p','r','t'), 243 HB_SCRIPT_LIMBU = HB_TAG ('L','i','m','b'), 244 HB_SCRIPT_LINEAR_B = HB_TAG ('L','i','n','b'), 245 HB_SCRIPT_OSMANYA = HB_TAG ('O','s','m','a'), 246 HB_SCRIPT_SHAVIAN = HB_TAG ('S','h','a','w'), 247 HB_SCRIPT_TAI_LE = HB_TAG ('T','a','l','e'), 248 HB_SCRIPT_UGARITIC = HB_TAG ('U','g','a','r'), 249 250 /* Unicode-4.1 additions */ 251 HB_SCRIPT_BUGINESE = HB_TAG ('B','u','g','i'), 252 HB_SCRIPT_GLAGOLITIC = HB_TAG ('G','l','a','g'), 253 HB_SCRIPT_KHAROSHTHI = HB_TAG ('K','h','a','r'), 254 HB_SCRIPT_NEW_TAI_LUE = HB_TAG ('T','a','l','u'), 255 HB_SCRIPT_OLD_PERSIAN = HB_TAG ('X','p','e','o'), 256 HB_SCRIPT_SYLOTI_NAGRI = HB_TAG ('S','y','l','o'), 257 HB_SCRIPT_TIFINAGH = HB_TAG ('T','f','n','g'), 258 259 /* Unicode-5.0 additions */ 260 HB_SCRIPT_BALINESE = HB_TAG ('B','a','l','i'), 261 HB_SCRIPT_CUNEIFORM = HB_TAG ('X','s','u','x'), 262 HB_SCRIPT_NKO = HB_TAG ('N','k','o','o'), 263 HB_SCRIPT_PHAGS_PA = HB_TAG ('P','h','a','g'), 264 HB_SCRIPT_PHOENICIAN = HB_TAG ('P','h','n','x'), 265 HB_SCRIPT_UNKNOWN = HB_TAG ('Z','z','z','z'), 266 267 /* Unicode-5.1 additions */ 268 HB_SCRIPT_CARIAN = HB_TAG ('C','a','r','i'), 269 HB_SCRIPT_CHAM = HB_TAG ('C','h','a','m'), 270 HB_SCRIPT_KAYAH_LI = HB_TAG ('K','a','l','i'), 271 HB_SCRIPT_LEPCHA = HB_TAG ('L','e','p','c'), 272 HB_SCRIPT_LYCIAN = HB_TAG ('L','y','c','i'), 273 HB_SCRIPT_LYDIAN = HB_TAG ('L','y','d','i'), 274 HB_SCRIPT_OL_CHIKI = HB_TAG ('O','l','c','k'), 275 HB_SCRIPT_REJANG = HB_TAG ('R','j','n','g'), 276 HB_SCRIPT_SAURASHTRA = HB_TAG ('S','a','u','r'), 277 HB_SCRIPT_SUNDANESE = HB_TAG ('S','u','n','d'), 278 HB_SCRIPT_VAI = HB_TAG ('V','a','i','i'), 279 280 /* Unicode-5.2 additions */ 281 HB_SCRIPT_AVESTAN = HB_TAG ('A','v','s','t'), 282 HB_SCRIPT_BAMUM = HB_TAG ('B','a','m','u'), 283 HB_SCRIPT_EGYPTIAN_HIEROGLYPHS = HB_TAG ('E','g','y','p'), 284 HB_SCRIPT_IMPERIAL_ARAMAIC = HB_TAG ('A','r','m','i'), 285 HB_SCRIPT_INSCRIPTIONAL_PAHLAVI = HB_TAG ('P','h','l','i'), 286 HB_SCRIPT_INSCRIPTIONAL_PARTHIAN = HB_TAG ('P','r','t','i'), 287 HB_SCRIPT_JAVANESE = HB_TAG ('J','a','v','a'), 288 HB_SCRIPT_KAITHI = HB_TAG ('K','t','h','i'), 289 HB_SCRIPT_LISU = HB_TAG ('L','i','s','u'), 290 HB_SCRIPT_MEETEI_MAYEK = HB_TAG ('M','t','e','i'), 291 HB_SCRIPT_OLD_SOUTH_ARABIAN = HB_TAG ('S','a','r','b'), 292 HB_SCRIPT_OLD_TURKIC = HB_TAG ('O','r','k','h'), 293 HB_SCRIPT_SAMARITAN = HB_TAG ('S','a','m','r'), 294 HB_SCRIPT_TAI_THAM = HB_TAG ('L','a','n','a'), 295 HB_SCRIPT_TAI_VIET = HB_TAG ('T','a','v','t'), 296 297 /* Unicode-6.0 additions */ 298 HB_SCRIPT_BATAK = HB_TAG ('B','a','t','k'), 299 HB_SCRIPT_BRAHMI = HB_TAG ('B','r','a','h'), 300 HB_SCRIPT_MANDAIC = HB_TAG ('M','a','n','d'), 301 302 /* Unicode-6.1 additions */ 303 HB_SCRIPT_CHAKMA = HB_TAG ('C','a','k','m'), 304 HB_SCRIPT_MEROITIC_CURSIVE = HB_TAG ('M','e','r','c'), 305 HB_SCRIPT_MEROITIC_HIEROGLYPHS = HB_TAG ('M','e','r','o'), 306 HB_SCRIPT_MIAO = HB_TAG ('P','l','r','d'), 307 HB_SCRIPT_SHARADA = HB_TAG ('S','h','r','d'), 308 HB_SCRIPT_SORA_SOMPENG = HB_TAG ('S','o','r','a'), 309 HB_SCRIPT_TAKRI = HB_TAG ('T','a','k','r'), 310 311 /* No script set */ 312 HB_SCRIPT_INVALID = HB_TAG_NONE 313} hb_script_t; 314 315 316/* Script functions */ 317 318hb_script_t 319hb_script_from_iso15924_tag (hb_tag_t tag); 320 321/* suger for tag_from_string() then script_from_iso15924_tag */ 322/* len=-1 means s is NUL-terminated */ 323hb_script_t 324hb_script_from_string (const char *s, int len); 325 326hb_tag_t 327hb_script_to_iso15924_tag (hb_script_t script); 328 329hb_direction_t 330hb_script_get_horizontal_direction (hb_script_t script); 331 332 333/* User data */ 334 335typedef struct _hb_user_data_key_t { 336 /*< private >*/ 337 char unused; 338} hb_user_data_key_t; 339 340typedef void (*hb_destroy_func_t) (void *user_data); 341 342 343HB_END_DECLS 344 345#endif /* HB_COMMON_H */ 346