hb-common.h 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505
  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. #ifndef HB_H_IN
  29. #error "Include <hb.h> instead."
  30. #endif
  31. #ifndef HB_COMMON_H
  32. #define HB_COMMON_H
  33. #ifndef HB_EXTERN
  34. #define HB_EXTERN extern
  35. #endif
  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. #if defined (_SVR4) || defined (SVR4) || defined (__OpenBSD__) || \
  46. defined (_sgi) || defined (__sun) || defined (sun) || \
  47. defined (__digital__) || defined (__HP_cc)
  48. # include <inttypes.h>
  49. #elif defined (_AIX)
  50. # include <sys/inttypes.h>
  51. #elif defined (_MSC_VER) && _MSC_VER < 1600
  52. /* VS 2010 (_MSC_VER 1600) has stdint.h */
  53. typedef __int8 int8_t;
  54. typedef unsigned __int8 uint8_t;
  55. typedef __int16 int16_t;
  56. typedef unsigned __int16 uint16_t;
  57. typedef __int32 int32_t;
  58. typedef unsigned __int32 uint32_t;
  59. typedef __int64 int64_t;
  60. typedef unsigned __int64 uint64_t;
  61. #elif defined (__KERNEL__)
  62. # include <linux/types.h>
  63. #else
  64. # include <stdint.h>
  65. #endif
  66. #if defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
  67. #define HB_DEPRECATED __attribute__((__deprecated__))
  68. #elif defined(_MSC_VER) && (_MSC_VER >= 1300)
  69. #define HB_DEPRECATED __declspec(deprecated)
  70. #else
  71. #define HB_DEPRECATED
  72. #endif
  73. #if defined(__GNUC__) && ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
  74. #define HB_DEPRECATED_FOR(f) __attribute__((__deprecated__("Use '" #f "' instead")))
  75. #elif defined(_MSC_FULL_VER) && (_MSC_FULL_VER > 140050320)
  76. #define HB_DEPRECATED_FOR(f) __declspec(deprecated("is deprecated. Use '" #f "' instead"))
  77. #else
  78. #define HB_DEPRECATED_FOR(f) HB_DEPRECATED
  79. #endif
  80. HB_BEGIN_DECLS
  81. typedef int hb_bool_t;
  82. typedef uint32_t hb_codepoint_t;
  83. typedef int32_t hb_position_t;
  84. typedef uint32_t hb_mask_t;
  85. typedef union _hb_var_int_t {
  86. uint32_t u32;
  87. int32_t i32;
  88. uint16_t u16[2];
  89. int16_t i16[2];
  90. uint8_t u8[4];
  91. int8_t i8[4];
  92. } hb_var_int_t;
  93. /* hb_tag_t */
  94. typedef uint32_t hb_tag_t;
  95. #define HB_TAG(c1,c2,c3,c4) ((hb_tag_t)((((uint32_t)(c1)&0xFF)<<24)|(((uint32_t)(c2)&0xFF)<<16)|(((uint32_t)(c3)&0xFF)<<8)|((uint32_t)(c4)&0xFF)))
  96. #define HB_UNTAG(tag) (uint8_t)(((tag)>>24)&0xFF), (uint8_t)(((tag)>>16)&0xFF), (uint8_t)(((tag)>>8)&0xFF), (uint8_t)((tag)&0xFF)
  97. #define HB_TAG_NONE HB_TAG(0,0,0,0)
  98. #define HB_TAG_MAX HB_TAG(0xff,0xff,0xff,0xff)
  99. #define HB_TAG_MAX_SIGNED HB_TAG(0x7f,0xff,0xff,0xff)
  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. /* buf should have 4 bytes. */
  104. HB_EXTERN void
  105. hb_tag_to_string (hb_tag_t tag, char *buf);
  106. /**
  107. * hb_direction_t:
  108. * @HB_DIRECTION_INVALID: Initial, unset direction.
  109. * @HB_DIRECTION_LTR: Text is set horizontally from left to right.
  110. * @HB_DIRECTION_RTL: Text is set horizontally from right to left.
  111. * @HB_DIRECTION_TTB: Text is set vertically from top to bottom.
  112. * @HB_DIRECTION_BTT: Text is set vertically from bottom to top.
  113. */
  114. typedef enum {
  115. HB_DIRECTION_INVALID = 0,
  116. HB_DIRECTION_LTR = 4,
  117. HB_DIRECTION_RTL,
  118. HB_DIRECTION_TTB,
  119. HB_DIRECTION_BTT
  120. } hb_direction_t;
  121. /* len=-1 means str is NUL-terminated */
  122. HB_EXTERN hb_direction_t
  123. hb_direction_from_string (const char *str, int len);
  124. HB_EXTERN const char *
  125. hb_direction_to_string (hb_direction_t direction);
  126. #define HB_DIRECTION_IS_VALID(dir) ((((unsigned int) (dir)) & ~3U) == 4)
  127. /* Direction must be valid for the following */
  128. #define HB_DIRECTION_IS_HORIZONTAL(dir) ((((unsigned int) (dir)) & ~1U) == 4)
  129. #define HB_DIRECTION_IS_VERTICAL(dir) ((((unsigned int) (dir)) & ~1U) == 6)
  130. #define HB_DIRECTION_IS_FORWARD(dir) ((((unsigned int) (dir)) & ~2U) == 4)
  131. #define HB_DIRECTION_IS_BACKWARD(dir) ((((unsigned int) (dir)) & ~2U) == 5)
  132. #define HB_DIRECTION_REVERSE(dir) ((hb_direction_t) (((unsigned int) (dir)) ^ 1))
  133. /* hb_language_t */
  134. typedef const struct hb_language_impl_t *hb_language_t;
  135. HB_EXTERN hb_language_t
  136. hb_language_from_string (const char *str, int len);
  137. HB_EXTERN const char *
  138. hb_language_to_string (hb_language_t language);
  139. #define HB_LANGUAGE_INVALID ((hb_language_t) 0)
  140. HB_EXTERN hb_language_t
  141. hb_language_get_default (void);
  142. /* hb_script_t */
  143. /* https://unicode.org/iso15924/ */
  144. /* https://docs.google.com/spreadsheets/d/1Y90M0Ie3MUJ6UVCRDOypOtijlMDLNNyyLk36T6iMu0o */
  145. /* Unicode Character Database property: Script (sc) */
  146. typedef enum
  147. {
  148. /*1.1*/ HB_SCRIPT_COMMON = HB_TAG ('Z','y','y','y'),
  149. /*1.1*/ HB_SCRIPT_INHERITED = HB_TAG ('Z','i','n','h'),
  150. /*5.0*/ HB_SCRIPT_UNKNOWN = HB_TAG ('Z','z','z','z'),
  151. /*1.1*/ HB_SCRIPT_ARABIC = HB_TAG ('A','r','a','b'),
  152. /*1.1*/ HB_SCRIPT_ARMENIAN = HB_TAG ('A','r','m','n'),
  153. /*1.1*/ HB_SCRIPT_BENGALI = HB_TAG ('B','e','n','g'),
  154. /*1.1*/ HB_SCRIPT_CYRILLIC = HB_TAG ('C','y','r','l'),
  155. /*1.1*/ HB_SCRIPT_DEVANAGARI = HB_TAG ('D','e','v','a'),
  156. /*1.1*/ HB_SCRIPT_GEORGIAN = HB_TAG ('G','e','o','r'),
  157. /*1.1*/ HB_SCRIPT_GREEK = HB_TAG ('G','r','e','k'),
  158. /*1.1*/ HB_SCRIPT_GUJARATI = HB_TAG ('G','u','j','r'),
  159. /*1.1*/ HB_SCRIPT_GURMUKHI = HB_TAG ('G','u','r','u'),
  160. /*1.1*/ HB_SCRIPT_HANGUL = HB_TAG ('H','a','n','g'),
  161. /*1.1*/ HB_SCRIPT_HAN = HB_TAG ('H','a','n','i'),
  162. /*1.1*/ HB_SCRIPT_HEBREW = HB_TAG ('H','e','b','r'),
  163. /*1.1*/ HB_SCRIPT_HIRAGANA = HB_TAG ('H','i','r','a'),
  164. /*1.1*/ HB_SCRIPT_KANNADA = HB_TAG ('K','n','d','a'),
  165. /*1.1*/ HB_SCRIPT_KATAKANA = HB_TAG ('K','a','n','a'),
  166. /*1.1*/ HB_SCRIPT_LAO = HB_TAG ('L','a','o','o'),
  167. /*1.1*/ HB_SCRIPT_LATIN = HB_TAG ('L','a','t','n'),
  168. /*1.1*/ HB_SCRIPT_MALAYALAM = HB_TAG ('M','l','y','m'),
  169. /*1.1*/ HB_SCRIPT_ORIYA = HB_TAG ('O','r','y','a'),
  170. /*1.1*/ HB_SCRIPT_TAMIL = HB_TAG ('T','a','m','l'),
  171. /*1.1*/ HB_SCRIPT_TELUGU = HB_TAG ('T','e','l','u'),
  172. /*1.1*/ HB_SCRIPT_THAI = HB_TAG ('T','h','a','i'),
  173. /*2.0*/ HB_SCRIPT_TIBETAN = HB_TAG ('T','i','b','t'),
  174. /*3.0*/ HB_SCRIPT_BOPOMOFO = HB_TAG ('B','o','p','o'),
  175. /*3.0*/ HB_SCRIPT_BRAILLE = HB_TAG ('B','r','a','i'),
  176. /*3.0*/ HB_SCRIPT_CANADIAN_SYLLABICS = HB_TAG ('C','a','n','s'),
  177. /*3.0*/ HB_SCRIPT_CHEROKEE = HB_TAG ('C','h','e','r'),
  178. /*3.0*/ HB_SCRIPT_ETHIOPIC = HB_TAG ('E','t','h','i'),
  179. /*3.0*/ HB_SCRIPT_KHMER = HB_TAG ('K','h','m','r'),
  180. /*3.0*/ HB_SCRIPT_MONGOLIAN = HB_TAG ('M','o','n','g'),
  181. /*3.0*/ HB_SCRIPT_MYANMAR = HB_TAG ('M','y','m','r'),
  182. /*3.0*/ HB_SCRIPT_OGHAM = HB_TAG ('O','g','a','m'),
  183. /*3.0*/ HB_SCRIPT_RUNIC = HB_TAG ('R','u','n','r'),
  184. /*3.0*/ HB_SCRIPT_SINHALA = HB_TAG ('S','i','n','h'),
  185. /*3.0*/ HB_SCRIPT_SYRIAC = HB_TAG ('S','y','r','c'),
  186. /*3.0*/ HB_SCRIPT_THAANA = HB_TAG ('T','h','a','a'),
  187. /*3.0*/ HB_SCRIPT_YI = HB_TAG ('Y','i','i','i'),
  188. /*3.1*/ HB_SCRIPT_DESERET = HB_TAG ('D','s','r','t'),
  189. /*3.1*/ HB_SCRIPT_GOTHIC = HB_TAG ('G','o','t','h'),
  190. /*3.1*/ HB_SCRIPT_OLD_ITALIC = HB_TAG ('I','t','a','l'),
  191. /*3.2*/ HB_SCRIPT_BUHID = HB_TAG ('B','u','h','d'),
  192. /*3.2*/ HB_SCRIPT_HANUNOO = HB_TAG ('H','a','n','o'),
  193. /*3.2*/ HB_SCRIPT_TAGALOG = HB_TAG ('T','g','l','g'),
  194. /*3.2*/ HB_SCRIPT_TAGBANWA = HB_TAG ('T','a','g','b'),
  195. /*4.0*/ HB_SCRIPT_CYPRIOT = HB_TAG ('C','p','r','t'),
  196. /*4.0*/ HB_SCRIPT_LIMBU = HB_TAG ('L','i','m','b'),
  197. /*4.0*/ HB_SCRIPT_LINEAR_B = HB_TAG ('L','i','n','b'),
  198. /*4.0*/ HB_SCRIPT_OSMANYA = HB_TAG ('O','s','m','a'),
  199. /*4.0*/ HB_SCRIPT_SHAVIAN = HB_TAG ('S','h','a','w'),
  200. /*4.0*/ HB_SCRIPT_TAI_LE = HB_TAG ('T','a','l','e'),
  201. /*4.0*/ HB_SCRIPT_UGARITIC = HB_TAG ('U','g','a','r'),
  202. /*4.1*/ HB_SCRIPT_BUGINESE = HB_TAG ('B','u','g','i'),
  203. /*4.1*/ HB_SCRIPT_COPTIC = HB_TAG ('C','o','p','t'),
  204. /*4.1*/ HB_SCRIPT_GLAGOLITIC = HB_TAG ('G','l','a','g'),
  205. /*4.1*/ HB_SCRIPT_KHAROSHTHI = HB_TAG ('K','h','a','r'),
  206. /*4.1*/ HB_SCRIPT_NEW_TAI_LUE = HB_TAG ('T','a','l','u'),
  207. /*4.1*/ HB_SCRIPT_OLD_PERSIAN = HB_TAG ('X','p','e','o'),
  208. /*4.1*/ HB_SCRIPT_SYLOTI_NAGRI = HB_TAG ('S','y','l','o'),
  209. /*4.1*/ HB_SCRIPT_TIFINAGH = HB_TAG ('T','f','n','g'),
  210. /*5.0*/ HB_SCRIPT_BALINESE = HB_TAG ('B','a','l','i'),
  211. /*5.0*/ HB_SCRIPT_CUNEIFORM = HB_TAG ('X','s','u','x'),
  212. /*5.0*/ HB_SCRIPT_NKO = HB_TAG ('N','k','o','o'),
  213. /*5.0*/ HB_SCRIPT_PHAGS_PA = HB_TAG ('P','h','a','g'),
  214. /*5.0*/ HB_SCRIPT_PHOENICIAN = HB_TAG ('P','h','n','x'),
  215. /*5.1*/ HB_SCRIPT_CARIAN = HB_TAG ('C','a','r','i'),
  216. /*5.1*/ HB_SCRIPT_CHAM = HB_TAG ('C','h','a','m'),
  217. /*5.1*/ HB_SCRIPT_KAYAH_LI = HB_TAG ('K','a','l','i'),
  218. /*5.1*/ HB_SCRIPT_LEPCHA = HB_TAG ('L','e','p','c'),
  219. /*5.1*/ HB_SCRIPT_LYCIAN = HB_TAG ('L','y','c','i'),
  220. /*5.1*/ HB_SCRIPT_LYDIAN = HB_TAG ('L','y','d','i'),
  221. /*5.1*/ HB_SCRIPT_OL_CHIKI = HB_TAG ('O','l','c','k'),
  222. /*5.1*/ HB_SCRIPT_REJANG = HB_TAG ('R','j','n','g'),
  223. /*5.1*/ HB_SCRIPT_SAURASHTRA = HB_TAG ('S','a','u','r'),
  224. /*5.1*/ HB_SCRIPT_SUNDANESE = HB_TAG ('S','u','n','d'),
  225. /*5.1*/ HB_SCRIPT_VAI = HB_TAG ('V','a','i','i'),
  226. /*5.2*/ HB_SCRIPT_AVESTAN = HB_TAG ('A','v','s','t'),
  227. /*5.2*/ HB_SCRIPT_BAMUM = HB_TAG ('B','a','m','u'),
  228. /*5.2*/ HB_SCRIPT_EGYPTIAN_HIEROGLYPHS = HB_TAG ('E','g','y','p'),
  229. /*5.2*/ HB_SCRIPT_IMPERIAL_ARAMAIC = HB_TAG ('A','r','m','i'),
  230. /*5.2*/ HB_SCRIPT_INSCRIPTIONAL_PAHLAVI = HB_TAG ('P','h','l','i'),
  231. /*5.2*/ HB_SCRIPT_INSCRIPTIONAL_PARTHIAN = HB_TAG ('P','r','t','i'),
  232. /*5.2*/ HB_SCRIPT_JAVANESE = HB_TAG ('J','a','v','a'),
  233. /*5.2*/ HB_SCRIPT_KAITHI = HB_TAG ('K','t','h','i'),
  234. /*5.2*/ HB_SCRIPT_LISU = HB_TAG ('L','i','s','u'),
  235. /*5.2*/ HB_SCRIPT_MEETEI_MAYEK = HB_TAG ('M','t','e','i'),
  236. /*5.2*/ HB_SCRIPT_OLD_SOUTH_ARABIAN = HB_TAG ('S','a','r','b'),
  237. /*5.2*/ HB_SCRIPT_OLD_TURKIC = HB_TAG ('O','r','k','h'),
  238. /*5.2*/ HB_SCRIPT_SAMARITAN = HB_TAG ('S','a','m','r'),
  239. /*5.2*/ HB_SCRIPT_TAI_THAM = HB_TAG ('L','a','n','a'),
  240. /*5.2*/ HB_SCRIPT_TAI_VIET = HB_TAG ('T','a','v','t'),
  241. /*6.0*/ HB_SCRIPT_BATAK = HB_TAG ('B','a','t','k'),
  242. /*6.0*/ HB_SCRIPT_BRAHMI = HB_TAG ('B','r','a','h'),
  243. /*6.0*/ HB_SCRIPT_MANDAIC = HB_TAG ('M','a','n','d'),
  244. /*6.1*/ HB_SCRIPT_CHAKMA = HB_TAG ('C','a','k','m'),
  245. /*6.1*/ HB_SCRIPT_MEROITIC_CURSIVE = HB_TAG ('M','e','r','c'),
  246. /*6.1*/ HB_SCRIPT_MEROITIC_HIEROGLYPHS = HB_TAG ('M','e','r','o'),
  247. /*6.1*/ HB_SCRIPT_MIAO = HB_TAG ('P','l','r','d'),
  248. /*6.1*/ HB_SCRIPT_SHARADA = HB_TAG ('S','h','r','d'),
  249. /*6.1*/ HB_SCRIPT_SORA_SOMPENG = HB_TAG ('S','o','r','a'),
  250. /*6.1*/ HB_SCRIPT_TAKRI = HB_TAG ('T','a','k','r'),
  251. /*
  252. * Since: 0.9.30
  253. */
  254. /*7.0*/ HB_SCRIPT_BASSA_VAH = HB_TAG ('B','a','s','s'),
  255. /*7.0*/ HB_SCRIPT_CAUCASIAN_ALBANIAN = HB_TAG ('A','g','h','b'),
  256. /*7.0*/ HB_SCRIPT_DUPLOYAN = HB_TAG ('D','u','p','l'),
  257. /*7.0*/ HB_SCRIPT_ELBASAN = HB_TAG ('E','l','b','a'),
  258. /*7.0*/ HB_SCRIPT_GRANTHA = HB_TAG ('G','r','a','n'),
  259. /*7.0*/ HB_SCRIPT_KHOJKI = HB_TAG ('K','h','o','j'),
  260. /*7.0*/ HB_SCRIPT_KHUDAWADI = HB_TAG ('S','i','n','d'),
  261. /*7.0*/ HB_SCRIPT_LINEAR_A = HB_TAG ('L','i','n','a'),
  262. /*7.0*/ HB_SCRIPT_MAHAJANI = HB_TAG ('M','a','h','j'),
  263. /*7.0*/ HB_SCRIPT_MANICHAEAN = HB_TAG ('M','a','n','i'),
  264. /*7.0*/ HB_SCRIPT_MENDE_KIKAKUI = HB_TAG ('M','e','n','d'),
  265. /*7.0*/ HB_SCRIPT_MODI = HB_TAG ('M','o','d','i'),
  266. /*7.0*/ HB_SCRIPT_MRO = HB_TAG ('M','r','o','o'),
  267. /*7.0*/ HB_SCRIPT_NABATAEAN = HB_TAG ('N','b','a','t'),
  268. /*7.0*/ HB_SCRIPT_OLD_NORTH_ARABIAN = HB_TAG ('N','a','r','b'),
  269. /*7.0*/ HB_SCRIPT_OLD_PERMIC = HB_TAG ('P','e','r','m'),
  270. /*7.0*/ HB_SCRIPT_PAHAWH_HMONG = HB_TAG ('H','m','n','g'),
  271. /*7.0*/ HB_SCRIPT_PALMYRENE = HB_TAG ('P','a','l','m'),
  272. /*7.0*/ HB_SCRIPT_PAU_CIN_HAU = HB_TAG ('P','a','u','c'),
  273. /*7.0*/ HB_SCRIPT_PSALTER_PAHLAVI = HB_TAG ('P','h','l','p'),
  274. /*7.0*/ HB_SCRIPT_SIDDHAM = HB_TAG ('S','i','d','d'),
  275. /*7.0*/ HB_SCRIPT_TIRHUTA = HB_TAG ('T','i','r','h'),
  276. /*7.0*/ HB_SCRIPT_WARANG_CITI = HB_TAG ('W','a','r','a'),
  277. /*8.0*/ HB_SCRIPT_AHOM = HB_TAG ('A','h','o','m'),
  278. /*8.0*/ HB_SCRIPT_ANATOLIAN_HIEROGLYPHS = HB_TAG ('H','l','u','w'),
  279. /*8.0*/ HB_SCRIPT_HATRAN = HB_TAG ('H','a','t','r'),
  280. /*8.0*/ HB_SCRIPT_MULTANI = HB_TAG ('M','u','l','t'),
  281. /*8.0*/ HB_SCRIPT_OLD_HUNGARIAN = HB_TAG ('H','u','n','g'),
  282. /*8.0*/ HB_SCRIPT_SIGNWRITING = HB_TAG ('S','g','n','w'),
  283. /*
  284. * Since 1.3.0
  285. */
  286. /*9.0*/ HB_SCRIPT_ADLAM = HB_TAG ('A','d','l','m'),
  287. /*9.0*/ HB_SCRIPT_BHAIKSUKI = HB_TAG ('B','h','k','s'),
  288. /*9.0*/ HB_SCRIPT_MARCHEN = HB_TAG ('M','a','r','c'),
  289. /*9.0*/ HB_SCRIPT_OSAGE = HB_TAG ('O','s','g','e'),
  290. /*9.0*/ HB_SCRIPT_TANGUT = HB_TAG ('T','a','n','g'),
  291. /*9.0*/ HB_SCRIPT_NEWA = HB_TAG ('N','e','w','a'),
  292. /*
  293. * Since 1.6.0
  294. */
  295. /*10.0*/HB_SCRIPT_MASARAM_GONDI = HB_TAG ('G','o','n','m'),
  296. /*10.0*/HB_SCRIPT_NUSHU = HB_TAG ('N','s','h','u'),
  297. /*10.0*/HB_SCRIPT_SOYOMBO = HB_TAG ('S','o','y','o'),
  298. /*10.0*/HB_SCRIPT_ZANABAZAR_SQUARE = HB_TAG ('Z','a','n','b'),
  299. /*
  300. * Since 1.8.0
  301. */
  302. /*11.0*/HB_SCRIPT_DOGRA = HB_TAG ('D','o','g','r'),
  303. /*11.0*/HB_SCRIPT_GUNJALA_GONDI = HB_TAG ('G','o','n','g'),
  304. /*11.0*/HB_SCRIPT_HANIFI_ROHINGYA = HB_TAG ('R','o','h','g'),
  305. /*11.0*/HB_SCRIPT_MAKASAR = HB_TAG ('M','a','k','a'),
  306. /*11.0*/HB_SCRIPT_MEDEFAIDRIN = HB_TAG ('M','e','d','f'),
  307. /*11.0*/HB_SCRIPT_OLD_SOGDIAN = HB_TAG ('S','o','g','o'),
  308. /*11.0*/HB_SCRIPT_SOGDIAN = HB_TAG ('S','o','g','d'),
  309. /*
  310. * Since 2.4.0
  311. */
  312. /*12.0*/HB_SCRIPT_ELYMAIC = HB_TAG ('E','l','y','m'),
  313. /*12.0*/HB_SCRIPT_NANDINAGARI = HB_TAG ('N','a','n','d'),
  314. /*12.0*/HB_SCRIPT_NYIAKENG_PUACHUE_HMONG = HB_TAG ('H','m','n','p'),
  315. /*12.0*/HB_SCRIPT_WANCHO = HB_TAG ('W','c','h','o'),
  316. /* No script set. */
  317. HB_SCRIPT_INVALID = HB_TAG_NONE,
  318. /* Dummy values to ensure any hb_tag_t value can be passed/stored as hb_script_t
  319. * without risking undefined behavior. We have two, for historical reasons.
  320. * HB_TAG_MAX used to be unsigned, but that was invalid Ansi C, so was changed
  321. * to _HB_SCRIPT_MAX_VALUE to be equal to HB_TAG_MAX_SIGNED as well.
  322. *
  323. * See this thread for technicalities:
  324. *
  325. * https://lists.freedesktop.org/archives/harfbuzz/2014-March/004150.html
  326. */
  327. _HB_SCRIPT_MAX_VALUE = HB_TAG_MAX_SIGNED, /*< skip >*/
  328. _HB_SCRIPT_MAX_VALUE_SIGNED = HB_TAG_MAX_SIGNED /*< skip >*/
  329. } hb_script_t;
  330. /* Script functions */
  331. HB_EXTERN hb_script_t
  332. hb_script_from_iso15924_tag (hb_tag_t tag);
  333. HB_EXTERN hb_script_t
  334. hb_script_from_string (const char *str, int len);
  335. HB_EXTERN hb_tag_t
  336. hb_script_to_iso15924_tag (hb_script_t script);
  337. HB_EXTERN hb_direction_t
  338. hb_script_get_horizontal_direction (hb_script_t script);
  339. /* User data */
  340. typedef struct hb_user_data_key_t {
  341. /*< private >*/
  342. char unused;
  343. } hb_user_data_key_t;
  344. typedef void (*hb_destroy_func_t) (void *user_data);
  345. /* Font features and variations. */
  346. /**
  347. * HB_FEATURE_GLOBAL_START
  348. *
  349. * Since: 2.0.0
  350. */
  351. #define HB_FEATURE_GLOBAL_START 0
  352. /**
  353. * HB_FEATURE_GLOBAL_END
  354. *
  355. * Since: 2.0.0
  356. */
  357. #define HB_FEATURE_GLOBAL_END ((unsigned int) -1)
  358. /**
  359. * hb_feature_t:
  360. * @tag: a feature tag
  361. * @value: 0 disables the feature, non-zero (usually 1) enables the feature.
  362. * For features implemented as lookup type 3 (like 'salt') the @value is a one
  363. * based index into the alternates.
  364. * @start: the cluster to start applying this feature setting (inclusive).
  365. * @end: the cluster to end applying this feature setting (exclusive).
  366. *
  367. * The #hb_feature_t is the structure that holds information about requested
  368. * feature application. The feature will be applied with the given value to all
  369. * glyphs which are in clusters between @start (inclusive) and @end (exclusive).
  370. * Setting start to @HB_FEATURE_GLOBAL_START and end to @HB_FEATURE_GLOBAL_END
  371. * specifies that the feature always applies to the entire buffer.
  372. */
  373. typedef struct hb_feature_t {
  374. hb_tag_t tag;
  375. uint32_t value;
  376. unsigned int start;
  377. unsigned int end;
  378. } hb_feature_t;
  379. HB_EXTERN hb_bool_t
  380. hb_feature_from_string (const char *str, int len,
  381. hb_feature_t *feature);
  382. HB_EXTERN void
  383. hb_feature_to_string (hb_feature_t *feature,
  384. char *buf, unsigned int size);
  385. /**
  386. * hb_variation_t:
  387. *
  388. * Since: 1.4.2
  389. */
  390. typedef struct hb_variation_t {
  391. hb_tag_t tag;
  392. float value;
  393. } hb_variation_t;
  394. HB_EXTERN hb_bool_t
  395. hb_variation_from_string (const char *str, int len,
  396. hb_variation_t *variation);
  397. HB_EXTERN void
  398. hb_variation_to_string (hb_variation_t *variation,
  399. char *buf, unsigned int size);
  400. /**
  401. * hb_color_t:
  402. *
  403. * Data type for holding color values.
  404. *
  405. * Since: 2.1.0
  406. */
  407. typedef uint32_t hb_color_t;
  408. #define HB_COLOR(b,g,r,a) ((hb_color_t) HB_TAG ((b),(g),(r),(a)))
  409. HB_EXTERN uint8_t
  410. hb_color_get_alpha (hb_color_t color);
  411. #define hb_color_get_alpha(color) ((color) & 0xFF)
  412. HB_EXTERN uint8_t
  413. hb_color_get_red (hb_color_t color);
  414. #define hb_color_get_red(color) (((color) >> 8) & 0xFF)
  415. HB_EXTERN uint8_t
  416. hb_color_get_green (hb_color_t color);
  417. #define hb_color_get_green(color) (((color) >> 16) & 0xFF)
  418. HB_EXTERN uint8_t
  419. hb_color_get_blue (hb_color_t color);
  420. #define hb_color_get_blue(color) (((color) >> 24) & 0xFF)
  421. HB_END_DECLS
  422. #endif /* HB_COMMON_H */