1 /* 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3 * 4 * This code is free software; you can redistribute it and/or modify it 5 * under the terms of the GNU General Public License version 2 only, as 6 * published by the Free Software Foundation. Oracle designates this 7 * particular file as subject to the "Classpath" exception as provided 8 * by Oracle in the LICENSE file that accompanied this code. 9 * 10 * This code is distributed in the hope that it will be useful, but WITHOUT 11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 13 * version 2 for more details (a copy is included in the LICENSE file that 14 * accompanied this code). 15 * 16 * You should have received a copy of the GNU General Public License version 17 * 2 along with this work; if not, write to the Free Software Foundation, 18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 19 * 20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 21 * or visit www.oracle.com if you need additional information or have any 22 * questions. 23 */ 24 25 // This file is available under and governed by the GNU General Public 26 // License version 2 only, as published by the Free Software Foundation. 27 // However, the following notice accompanied the original version of this 28 // file: 29 // 30 /* 31 * Copyright © 2007,2008,2009 Red Hat, Inc. 32 * Copyright © 2011,2012 Google, Inc. 33 * 34 * This is part of HarfBuzz, a text shaping library. 35 * 36 * Permission is hereby granted, without written agreement and without 37 * license or royalty fees, to use, copy, modify, and distribute this 38 * software and its documentation for any purpose, provided that the 39 * above copyright notice and the following two paragraphs appear in 40 * all copies of this software. 41 * 42 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR 43 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES 44 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN 45 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 46 * DAMAGE. 47 * 48 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, 49 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 50 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS 51 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO 52 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. 53 * 54 * Red Hat Author(s): Behdad Esfahbod 55 * Google Author(s): Behdad Esfahbod 56 */ 57 58 #ifndef HB_H_IN 59 #error "Include <hb.h> instead." 60 #endif 61 62 #ifndef HB_COMMON_H 63 #define HB_COMMON_H 64 65 #ifndef HB_BEGIN_DECLS 66 # ifdef __cplusplus 67 # define HB_BEGIN_DECLS extern "C" { 68 # define HB_END_DECLS } 69 # else /* !__cplusplus */ 70 # define HB_BEGIN_DECLS 71 # define HB_END_DECLS 72 # endif /* !__cplusplus */ 73 #endif 74 75 #if !defined (HB_DONT_DEFINE_STDINT) 76 77 #if defined (_SVR4) || defined (SVR4) || defined (__OpenBSD__) || \ 78 defined (_sgi) || defined (__sun) || defined (sun) || \ 79 defined (__digital__) || defined (__HP_cc) 80 # include <inttypes.h> 81 #elif defined (_AIX) 82 # include <sys/inttypes.h> 83 /* VS 2010 (_MSC_VER 1600) has stdint.h */ 84 #elif defined (_MSC_VER) && _MSC_VER < 1600 85 typedef __int8 int8_t; 86 typedef unsigned __int8 uint8_t; 87 typedef __int16 int16_t; 88 typedef unsigned __int16 uint16_t; 89 typedef __int32 int32_t; 90 typedef unsigned __int32 uint32_t; 91 typedef __int64 int64_t; 92 typedef unsigned __int64 uint64_t; 93 #else 94 # include <stdint.h> 95 #endif 96 97 #endif 98 99 HB_BEGIN_DECLS 100 101 102 typedef int hb_bool_t; 103 104 typedef uint32_t hb_codepoint_t; 105 typedef int32_t hb_position_t; 106 typedef uint32_t hb_mask_t; 107 108 typedef union _hb_var_int_t { 109 uint32_t u32; 110 int32_t i32; 111 uint16_t u16[2]; 112 int16_t i16[2]; 113 uint8_t u8[4]; 114 int8_t i8[4]; 115 } hb_var_int_t; 116 117 118 /* hb_tag_t */ 119 120 typedef uint32_t hb_tag_t; 121 122 #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)))) 123 #define HB_UNTAG(tag) ((uint8_t)((tag)>>24)), ((uint8_t)((tag)>>16)), ((uint8_t)((tag)>>8)), ((uint8_t)(tag)) 124 125 #define HB_TAG_NONE HB_TAG(0,0,0,0) 126 #define HB_TAG_MAX HB_TAG(0xff,0xff,0xff,0xff) 127 #define HB_TAG_MAX_SIGNED HB_TAG(0x7f,0xff,0xff,0xff) 128 129 /* len=-1 means str is NUL-terminated. */ 130 hb_tag_t 131 hb_tag_from_string (const char *str, int len); 132 133 /* buf should have 4 bytes. */ 134 void 135 hb_tag_to_string (hb_tag_t tag, char *buf); 136 137 138 /* hb_direction_t */ 139 140 typedef enum { 141 HB_DIRECTION_INVALID = 0, 142 HB_DIRECTION_LTR = 4, 143 HB_DIRECTION_RTL, 144 HB_DIRECTION_TTB, 145 HB_DIRECTION_BTT 146 } hb_direction_t; 147 148 /* len=-1 means str is NUL-terminated */ 149 hb_direction_t 150 hb_direction_from_string (const char *str, int len); 151 152 const char * 153 hb_direction_to_string (hb_direction_t direction); 154 155 #define HB_DIRECTION_IS_VALID(dir) ((((unsigned int) (dir)) & ~3U) == 4) 156 /* Direction must be valid for the following */ 157 #define HB_DIRECTION_IS_HORIZONTAL(dir) ((((unsigned int) (dir)) & ~1U) == 4) 158 #define HB_DIRECTION_IS_VERTICAL(dir) ((((unsigned int) (dir)) & ~1U) == 6) 159 #define HB_DIRECTION_IS_FORWARD(dir) ((((unsigned int) (dir)) & ~2U) == 4) 160 #define HB_DIRECTION_IS_BACKWARD(dir) ((((unsigned int) (dir)) & ~2U) == 5) 161 #define HB_DIRECTION_REVERSE(dir) ((hb_direction_t) (((unsigned int) (dir)) ^ 1)) 162 163 164 /* hb_language_t */ 165 166 typedef const struct hb_language_impl_t *hb_language_t; 167 168 /* len=-1 means str is NUL-terminated */ 169 hb_language_t 170 hb_language_from_string (const char *str, int len); 171 172 const char * 173 hb_language_to_string (hb_language_t language); 174 175 #define HB_LANGUAGE_INVALID ((hb_language_t) NULL) 176 177 hb_language_t 178 hb_language_get_default (void); 179 180 181 /* hb_script_t */ 182 183 /* http://unicode.org/iso15924/ */ 184 /* http://goo.gl/x9ilM */ 185 /* Unicode Character Database property: Script (sc) */ 186 typedef enum 187 { 188 /*1.1*/ HB_SCRIPT_COMMON = HB_TAG ('Z','y','y','y'), 189 /*1.1*/ HB_SCRIPT_INHERITED = HB_TAG ('Z','i','n','h'), 190 /*5.0*/ HB_SCRIPT_UNKNOWN = HB_TAG ('Z','z','z','z'), 191 192 /*1.1*/ HB_SCRIPT_ARABIC = HB_TAG ('A','r','a','b'), 193 /*1.1*/ HB_SCRIPT_ARMENIAN = HB_TAG ('A','r','m','n'), 194 /*1.1*/ HB_SCRIPT_BENGALI = HB_TAG ('B','e','n','g'), 195 /*1.1*/ HB_SCRIPT_CYRILLIC = HB_TAG ('C','y','r','l'), 196 /*1.1*/ HB_SCRIPT_DEVANAGARI = HB_TAG ('D','e','v','a'), 197 /*1.1*/ HB_SCRIPT_GEORGIAN = HB_TAG ('G','e','o','r'), 198 /*1.1*/ HB_SCRIPT_GREEK = HB_TAG ('G','r','e','k'), 199 /*1.1*/ HB_SCRIPT_GUJARATI = HB_TAG ('G','u','j','r'), 200 /*1.1*/ HB_SCRIPT_GURMUKHI = HB_TAG ('G','u','r','u'), 201 /*1.1*/ HB_SCRIPT_HANGUL = HB_TAG ('H','a','n','g'), 202 /*1.1*/ HB_SCRIPT_HAN = HB_TAG ('H','a','n','i'), 203 /*1.1*/ HB_SCRIPT_HEBREW = HB_TAG ('H','e','b','r'), 204 /*1.1*/ HB_SCRIPT_HIRAGANA = HB_TAG ('H','i','r','a'), 205 /*1.1*/ HB_SCRIPT_KANNADA = HB_TAG ('K','n','d','a'), 206 /*1.1*/ HB_SCRIPT_KATAKANA = HB_TAG ('K','a','n','a'), 207 /*1.1*/ HB_SCRIPT_LAO = HB_TAG ('L','a','o','o'), 208 /*1.1*/ HB_SCRIPT_LATIN = HB_TAG ('L','a','t','n'), 209 /*1.1*/ HB_SCRIPT_MALAYALAM = HB_TAG ('M','l','y','m'), 210 /*1.1*/ HB_SCRIPT_ORIYA = HB_TAG ('O','r','y','a'), 211 /*1.1*/ HB_SCRIPT_TAMIL = HB_TAG ('T','a','m','l'), 212 /*1.1*/ HB_SCRIPT_TELUGU = HB_TAG ('T','e','l','u'), 213 /*1.1*/ HB_SCRIPT_THAI = HB_TAG ('T','h','a','i'), 214 215 /*2.0*/ HB_SCRIPT_TIBETAN = HB_TAG ('T','i','b','t'), 216 217 /*3.0*/ HB_SCRIPT_BOPOMOFO = HB_TAG ('B','o','p','o'), 218 /*3.0*/ HB_SCRIPT_BRAILLE = HB_TAG ('B','r','a','i'), 219 /*3.0*/ HB_SCRIPT_CANADIAN_SYLLABICS = HB_TAG ('C','a','n','s'), 220 /*3.0*/ HB_SCRIPT_CHEROKEE = HB_TAG ('C','h','e','r'), 221 /*3.0*/ HB_SCRIPT_ETHIOPIC = HB_TAG ('E','t','h','i'), 222 /*3.0*/ HB_SCRIPT_KHMER = HB_TAG ('K','h','m','r'), 223 /*3.0*/ HB_SCRIPT_MONGOLIAN = HB_TAG ('M','o','n','g'), 224 /*3.0*/ HB_SCRIPT_MYANMAR = HB_TAG ('M','y','m','r'), 225 /*3.0*/ HB_SCRIPT_OGHAM = HB_TAG ('O','g','a','m'), 226 /*3.0*/ HB_SCRIPT_RUNIC = HB_TAG ('R','u','n','r'), 227 /*3.0*/ HB_SCRIPT_SINHALA = HB_TAG ('S','i','n','h'), 228 /*3.0*/ HB_SCRIPT_SYRIAC = HB_TAG ('S','y','r','c'), 229 /*3.0*/ HB_SCRIPT_THAANA = HB_TAG ('T','h','a','a'), 230 /*3.0*/ HB_SCRIPT_YI = HB_TAG ('Y','i','i','i'), 231 232 /*3.1*/ HB_SCRIPT_DESERET = HB_TAG ('D','s','r','t'), 233 /*3.1*/ HB_SCRIPT_GOTHIC = HB_TAG ('G','o','t','h'), 234 /*3.1*/ HB_SCRIPT_OLD_ITALIC = HB_TAG ('I','t','a','l'), 235 236 /*3.2*/ HB_SCRIPT_BUHID = HB_TAG ('B','u','h','d'), 237 /*3.2*/ HB_SCRIPT_HANUNOO = HB_TAG ('H','a','n','o'), 238 /*3.2*/ HB_SCRIPT_TAGALOG = HB_TAG ('T','g','l','g'), 239 /*3.2*/ HB_SCRIPT_TAGBANWA = HB_TAG ('T','a','g','b'), 240 241 /*4.0*/ HB_SCRIPT_CYPRIOT = HB_TAG ('C','p','r','t'), 242 /*4.0*/ HB_SCRIPT_LIMBU = HB_TAG ('L','i','m','b'), 243 /*4.0*/ HB_SCRIPT_LINEAR_B = HB_TAG ('L','i','n','b'), 244 /*4.0*/ HB_SCRIPT_OSMANYA = HB_TAG ('O','s','m','a'), 245 /*4.0*/ HB_SCRIPT_SHAVIAN = HB_TAG ('S','h','a','w'), 246 /*4.0*/ HB_SCRIPT_TAI_LE = HB_TAG ('T','a','l','e'), 247 /*4.0*/ HB_SCRIPT_UGARITIC = HB_TAG ('U','g','a','r'), 248 249 /*4.1*/ HB_SCRIPT_BUGINESE = HB_TAG ('B','u','g','i'), 250 /*4.1*/ HB_SCRIPT_COPTIC = HB_TAG ('C','o','p','t'), 251 /*4.1*/ HB_SCRIPT_GLAGOLITIC = HB_TAG ('G','l','a','g'), 252 /*4.1*/ HB_SCRIPT_KHAROSHTHI = HB_TAG ('K','h','a','r'), 253 /*4.1*/ HB_SCRIPT_NEW_TAI_LUE = HB_TAG ('T','a','l','u'), 254 /*4.1*/ HB_SCRIPT_OLD_PERSIAN = HB_TAG ('X','p','e','o'), 255 /*4.1*/ HB_SCRIPT_SYLOTI_NAGRI = HB_TAG ('S','y','l','o'), 256 /*4.1*/ HB_SCRIPT_TIFINAGH = HB_TAG ('T','f','n','g'), 257 258 /*5.0*/ HB_SCRIPT_BALINESE = HB_TAG ('B','a','l','i'), 259 /*5.0*/ HB_SCRIPT_CUNEIFORM = HB_TAG ('X','s','u','x'), 260 /*5.0*/ HB_SCRIPT_NKO = HB_TAG ('N','k','o','o'), 261 /*5.0*/ HB_SCRIPT_PHAGS_PA = HB_TAG ('P','h','a','g'), 262 /*5.0*/ HB_SCRIPT_PHOENICIAN = HB_TAG ('P','h','n','x'), 263 264 /*5.1*/ HB_SCRIPT_CARIAN = HB_TAG ('C','a','r','i'), 265 /*5.1*/ HB_SCRIPT_CHAM = HB_TAG ('C','h','a','m'), 266 /*5.1*/ HB_SCRIPT_KAYAH_LI = HB_TAG ('K','a','l','i'), 267 /*5.1*/ HB_SCRIPT_LEPCHA = HB_TAG ('L','e','p','c'), 268 /*5.1*/ HB_SCRIPT_LYCIAN = HB_TAG ('L','y','c','i'), 269 /*5.1*/ HB_SCRIPT_LYDIAN = HB_TAG ('L','y','d','i'), 270 /*5.1*/ HB_SCRIPT_OL_CHIKI = HB_TAG ('O','l','c','k'), 271 /*5.1*/ HB_SCRIPT_REJANG = HB_TAG ('R','j','n','g'), 272 /*5.1*/ HB_SCRIPT_SAURASHTRA = HB_TAG ('S','a','u','r'), 273 /*5.1*/ HB_SCRIPT_SUNDANESE = HB_TAG ('S','u','n','d'), 274 /*5.1*/ HB_SCRIPT_VAI = HB_TAG ('V','a','i','i'), 275 276 /*5.2*/ HB_SCRIPT_AVESTAN = HB_TAG ('A','v','s','t'), 277 /*5.2*/ HB_SCRIPT_BAMUM = HB_TAG ('B','a','m','u'), 278 /*5.2*/ HB_SCRIPT_EGYPTIAN_HIEROGLYPHS = HB_TAG ('E','g','y','p'), 279 /*5.2*/ HB_SCRIPT_IMPERIAL_ARAMAIC = HB_TAG ('A','r','m','i'), 280 /*5.2*/ HB_SCRIPT_INSCRIPTIONAL_PAHLAVI = HB_TAG ('P','h','l','i'), 281 /*5.2*/ HB_SCRIPT_INSCRIPTIONAL_PARTHIAN = HB_TAG ('P','r','t','i'), 282 /*5.2*/ HB_SCRIPT_JAVANESE = HB_TAG ('J','a','v','a'), 283 /*5.2*/ HB_SCRIPT_KAITHI = HB_TAG ('K','t','h','i'), 284 /*5.2*/ HB_SCRIPT_LISU = HB_TAG ('L','i','s','u'), 285 /*5.2*/ HB_SCRIPT_MEETEI_MAYEK = HB_TAG ('M','t','e','i'), 286 /*5.2*/ HB_SCRIPT_OLD_SOUTH_ARABIAN = HB_TAG ('S','a','r','b'), 287 /*5.2*/ HB_SCRIPT_OLD_TURKIC = HB_TAG ('O','r','k','h'), 288 /*5.2*/ HB_SCRIPT_SAMARITAN = HB_TAG ('S','a','m','r'), 289 /*5.2*/ HB_SCRIPT_TAI_THAM = HB_TAG ('L','a','n','a'), 290 /*5.2*/ HB_SCRIPT_TAI_VIET = HB_TAG ('T','a','v','t'), 291 292 /*6.0*/ HB_SCRIPT_BATAK = HB_TAG ('B','a','t','k'), 293 /*6.0*/ HB_SCRIPT_BRAHMI = HB_TAG ('B','r','a','h'), 294 /*6.0*/ HB_SCRIPT_MANDAIC = HB_TAG ('M','a','n','d'), 295 296 /*6.1*/ HB_SCRIPT_CHAKMA = HB_TAG ('C','a','k','m'), 297 /*6.1*/ HB_SCRIPT_MEROITIC_CURSIVE = HB_TAG ('M','e','r','c'), 298 /*6.1*/ HB_SCRIPT_MEROITIC_HIEROGLYPHS = HB_TAG ('M','e','r','o'), 299 /*6.1*/ HB_SCRIPT_MIAO = HB_TAG ('P','l','r','d'), 300 /*6.1*/ HB_SCRIPT_SHARADA = HB_TAG ('S','h','r','d'), 301 /*6.1*/ HB_SCRIPT_SORA_SOMPENG = HB_TAG ('S','o','r','a'), 302 /*6.1*/ HB_SCRIPT_TAKRI = HB_TAG ('T','a','k','r'), 303 304 /* 305 * Since: 0.9.30 306 */ 307 /*7.0*/ HB_SCRIPT_BASSA_VAH = HB_TAG ('B','a','s','s'), 308 /*7.0*/ HB_SCRIPT_CAUCASIAN_ALBANIAN = HB_TAG ('A','g','h','b'), 309 /*7.0*/ HB_SCRIPT_DUPLOYAN = HB_TAG ('D','u','p','l'), 310 /*7.0*/ HB_SCRIPT_ELBASAN = HB_TAG ('E','l','b','a'), 311 /*7.0*/ HB_SCRIPT_GRANTHA = HB_TAG ('G','r','a','n'), 312 /*7.0*/ HB_SCRIPT_KHOJKI = HB_TAG ('K','h','o','j'), 313 /*7.0*/ HB_SCRIPT_KHUDAWADI = HB_TAG ('S','i','n','d'), 314 /*7.0*/ HB_SCRIPT_LINEAR_A = HB_TAG ('L','i','n','a'), 315 /*7.0*/ HB_SCRIPT_MAHAJANI = HB_TAG ('M','a','h','j'), 316 /*7.0*/ HB_SCRIPT_MANICHAEAN = HB_TAG ('M','a','n','i'), 317 /*7.0*/ HB_SCRIPT_MENDE_KIKAKUI = HB_TAG ('M','e','n','d'), 318 /*7.0*/ HB_SCRIPT_MODI = HB_TAG ('M','o','d','i'), 319 /*7.0*/ HB_SCRIPT_MRO = HB_TAG ('M','r','o','o'), 320 /*7.0*/ HB_SCRIPT_NABATAEAN = HB_TAG ('N','b','a','t'), 321 /*7.0*/ HB_SCRIPT_OLD_NORTH_ARABIAN = HB_TAG ('N','a','r','b'), 322 /*7.0*/ HB_SCRIPT_OLD_PERMIC = HB_TAG ('P','e','r','m'), 323 /*7.0*/ HB_SCRIPT_PAHAWH_HMONG = HB_TAG ('H','m','n','g'), 324 /*7.0*/ HB_SCRIPT_PALMYRENE = HB_TAG ('P','a','l','m'), 325 /*7.0*/ HB_SCRIPT_PAU_CIN_HAU = HB_TAG ('P','a','u','c'), 326 /*7.0*/ HB_SCRIPT_PSALTER_PAHLAVI = HB_TAG ('P','h','l','p'), 327 /*7.0*/ HB_SCRIPT_SIDDHAM = HB_TAG ('S','i','d','d'), 328 /*7.0*/ HB_SCRIPT_TIRHUTA = HB_TAG ('T','i','r','h'), 329 /*7.0*/ HB_SCRIPT_WARANG_CITI = HB_TAG ('W','a','r','a'), 330 331 /*8.0*/ HB_SCRIPT_AHOM = HB_TAG ('A','h','o','m'), 332 /*8.0*/ HB_SCRIPT_ANATOLIAN_HIEROGLYPHS = HB_TAG ('H','l','u','w'), 333 /*8.0*/ HB_SCRIPT_HATRAN = HB_TAG ('H','a','t','r'), 334 /*8.0*/ HB_SCRIPT_MULTANI = HB_TAG ('M','u','l','t'), 335 /*8.0*/ HB_SCRIPT_OLD_HUNGARIAN = HB_TAG ('H','u','n','g'), 336 /*8.0*/ HB_SCRIPT_SIGNWRITING = HB_TAG ('S','g','n','w'), 337 338 /* No script set. */ 339 HB_SCRIPT_INVALID = HB_TAG_NONE, 340 341 /* Dummy values to ensure any hb_tag_t value can be passed/stored as hb_script_t 342 * without risking undefined behavior. Include both a signed and unsigned max, 343 * since technically enums are int, and indeed, hb_script_t ends up being signed. 344 * See this thread for technicalities: 345 * 346 * http://lists.freedesktop.org/archives/harfbuzz/2014-March/004150.html 347 */ 348 _HB_SCRIPT_MAX_VALUE = HB_TAG_MAX, /*< skip >*/ 349 _HB_SCRIPT_MAX_VALUE_SIGNED = HB_TAG_MAX_SIGNED /*< skip >*/ 350 351 } hb_script_t; 352 353 354 /* Script functions */ 355 356 hb_script_t 357 hb_script_from_iso15924_tag (hb_tag_t tag); 358 359 /* sugar for tag_from_string() then script_from_iso15924_tag */ 360 /* len=-1 means s is NUL-terminated */ 361 hb_script_t 362 hb_script_from_string (const char *s, int len); 363 364 hb_tag_t 365 hb_script_to_iso15924_tag (hb_script_t script); 366 367 hb_direction_t 368 hb_script_get_horizontal_direction (hb_script_t script); 369 370 371 /* User data */ 372 373 typedef struct hb_user_data_key_t { 374 /*< private >*/ 375 char unused; 376 } hb_user_data_key_t; 377 378 typedef void (*hb_destroy_func_t) (void *user_data); 379 380 381 HB_END_DECLS 382 383 #endif /* HB_COMMON_H */