hb-common.h 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953
  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. #if !defined(HB_H_IN) && !defined(HB_NO_SINGLE_HEADER_ERROR)
  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 (_AIX)
  46. # include <sys/inttypes.h>
  47. #elif defined (_MSC_VER) && _MSC_VER < 1600
  48. /* VS 2010 (_MSC_VER 1600) has stdint.h */
  49. typedef __int8 int8_t;
  50. typedef unsigned __int8 uint8_t;
  51. typedef __int16 int16_t;
  52. typedef unsigned __int16 uint16_t;
  53. typedef __int32 int32_t;
  54. typedef unsigned __int32 uint32_t;
  55. typedef __int64 int64_t;
  56. typedef unsigned __int64 uint64_t;
  57. #elif defined (_MSC_VER) && _MSC_VER < 1800
  58. /* VS 2013 (_MSC_VER 1800) has inttypes.h */
  59. # include <stdint.h>
  60. #else
  61. # include <inttypes.h>
  62. #endif
  63. #if defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
  64. #define HB_DEPRECATED __attribute__((__deprecated__))
  65. #elif defined(_MSC_VER) && (_MSC_VER >= 1300)
  66. #define HB_DEPRECATED __declspec(deprecated)
  67. #else
  68. #define HB_DEPRECATED
  69. #endif
  70. #if defined(__GNUC__) && ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
  71. #define HB_DEPRECATED_FOR(f) __attribute__((__deprecated__("Use '" #f "' instead")))
  72. #elif defined(_MSC_FULL_VER) && (_MSC_FULL_VER > 140050320)
  73. #define HB_DEPRECATED_FOR(f) __declspec(deprecated("is deprecated. Use '" #f "' instead"))
  74. #else
  75. #define HB_DEPRECATED_FOR(f) HB_DEPRECATED
  76. #endif
  77. HB_BEGIN_DECLS
  78. /**
  79. * hb_bool_t:
  80. *
  81. * Data type for booleans.
  82. *
  83. **/
  84. typedef int hb_bool_t;
  85. /**
  86. * hb_codepoint_t:
  87. *
  88. * Data type for holding Unicode codepoints. Also
  89. * used to hold glyph IDs.
  90. *
  91. **/
  92. typedef uint32_t hb_codepoint_t;
  93. /**
  94. * HB_CODEPOINT_INVALID:
  95. *
  96. * Unused #hb_codepoint_t value.
  97. *
  98. * Since: 8.0.0
  99. */
  100. #define HB_CODEPOINT_INVALID ((hb_codepoint_t) -1)
  101. /**
  102. * hb_position_t:
  103. *
  104. * Data type for holding a single coordinate value.
  105. * Contour points and other multi-dimensional data are
  106. * stored as tuples of #hb_position_t's.
  107. *
  108. **/
  109. typedef int32_t hb_position_t;
  110. /**
  111. * hb_mask_t:
  112. *
  113. * Data type for bitmasks.
  114. *
  115. **/
  116. typedef uint32_t hb_mask_t;
  117. typedef union _hb_var_int_t {
  118. uint32_t u32;
  119. int32_t i32;
  120. uint16_t u16[2];
  121. int16_t i16[2];
  122. uint8_t u8[4];
  123. int8_t i8[4];
  124. } hb_var_int_t;
  125. typedef union _hb_var_num_t {
  126. float f;
  127. uint32_t u32;
  128. int32_t i32;
  129. uint16_t u16[2];
  130. int16_t i16[2];
  131. uint8_t u8[4];
  132. int8_t i8[4];
  133. } hb_var_num_t;
  134. /* hb_tag_t */
  135. /**
  136. * hb_tag_t:
  137. *
  138. * Data type for tag identifiers. Tags are four
  139. * byte integers, each byte representing a character.
  140. *
  141. * Tags are used to identify tables, design-variation axes,
  142. * scripts, languages, font features, and baselines with
  143. * human-readable names.
  144. *
  145. **/
  146. typedef uint32_t hb_tag_t;
  147. /**
  148. * HB_TAG:
  149. * @c1: 1st character of the tag
  150. * @c2: 2nd character of the tag
  151. * @c3: 3rd character of the tag
  152. * @c4: 4th character of the tag
  153. *
  154. * Constructs an #hb_tag_t from four character literals.
  155. *
  156. **/
  157. #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)))
  158. /**
  159. * HB_UNTAG:
  160. * @tag: an #hb_tag_t
  161. *
  162. * Extracts four character literals from an #hb_tag_t.
  163. *
  164. * Since: 0.6.0
  165. *
  166. **/
  167. #define HB_UNTAG(tag) (uint8_t)(((tag)>>24)&0xFF), (uint8_t)(((tag)>>16)&0xFF), (uint8_t)(((tag)>>8)&0xFF), (uint8_t)((tag)&0xFF)
  168. /**
  169. * HB_TAG_NONE:
  170. *
  171. * Unset #hb_tag_t.
  172. */
  173. #define HB_TAG_NONE HB_TAG(0,0,0,0)
  174. /**
  175. * HB_TAG_MAX:
  176. *
  177. * Maximum possible unsigned #hb_tag_t.
  178. *
  179. * Since: 0.9.26
  180. */
  181. #define HB_TAG_MAX HB_TAG(0xff,0xff,0xff,0xff)
  182. /**
  183. * HB_TAG_MAX_SIGNED:
  184. *
  185. * Maximum possible signed #hb_tag_t.
  186. *
  187. * Since: 0.9.33
  188. */
  189. #define HB_TAG_MAX_SIGNED HB_TAG(0x7f,0xff,0xff,0xff)
  190. /* len=-1 means str is NUL-terminated. */
  191. HB_EXTERN hb_tag_t
  192. hb_tag_from_string (const char *str, int len);
  193. /* buf should have 4 bytes. */
  194. HB_EXTERN void
  195. hb_tag_to_string (hb_tag_t tag, char *buf);
  196. /**
  197. * hb_direction_t:
  198. * @HB_DIRECTION_INVALID: Initial, unset direction.
  199. * @HB_DIRECTION_LTR: Text is set horizontally from left to right.
  200. * @HB_DIRECTION_RTL: Text is set horizontally from right to left.
  201. * @HB_DIRECTION_TTB: Text is set vertically from top to bottom.
  202. * @HB_DIRECTION_BTT: Text is set vertically from bottom to top.
  203. *
  204. * The direction of a text segment or buffer.
  205. *
  206. * A segment can also be tested for horizontal or vertical
  207. * orientation (irrespective of specific direction) with
  208. * HB_DIRECTION_IS_HORIZONTAL() or HB_DIRECTION_IS_VERTICAL().
  209. *
  210. */
  211. typedef enum {
  212. HB_DIRECTION_INVALID = 0,
  213. HB_DIRECTION_LTR = 4,
  214. HB_DIRECTION_RTL,
  215. HB_DIRECTION_TTB,
  216. HB_DIRECTION_BTT
  217. } hb_direction_t;
  218. /* len=-1 means str is NUL-terminated */
  219. HB_EXTERN hb_direction_t
  220. hb_direction_from_string (const char *str, int len);
  221. HB_EXTERN const char *
  222. hb_direction_to_string (hb_direction_t direction);
  223. /**
  224. * HB_DIRECTION_IS_VALID:
  225. * @dir: #hb_direction_t to test
  226. *
  227. * Tests whether a text direction is valid.
  228. *
  229. **/
  230. #define HB_DIRECTION_IS_VALID(dir) ((((unsigned int) (dir)) & ~3U) == 4)
  231. /* Direction must be valid for the following */
  232. /**
  233. * HB_DIRECTION_IS_HORIZONTAL:
  234. * @dir: #hb_direction_t to test
  235. *
  236. * Tests whether a text direction is horizontal. Requires
  237. * that the direction be valid.
  238. *
  239. **/
  240. #define HB_DIRECTION_IS_HORIZONTAL(dir) ((((unsigned int) (dir)) & ~1U) == 4)
  241. /**
  242. * HB_DIRECTION_IS_VERTICAL:
  243. * @dir: #hb_direction_t to test
  244. *
  245. * Tests whether a text direction is vertical. Requires
  246. * that the direction be valid.
  247. *
  248. **/
  249. #define HB_DIRECTION_IS_VERTICAL(dir) ((((unsigned int) (dir)) & ~1U) == 6)
  250. /**
  251. * HB_DIRECTION_IS_FORWARD:
  252. * @dir: #hb_direction_t to test
  253. *
  254. * Tests whether a text direction moves forward (from left to right, or from
  255. * top to bottom). Requires that the direction be valid.
  256. *
  257. **/
  258. #define HB_DIRECTION_IS_FORWARD(dir) ((((unsigned int) (dir)) & ~2U) == 4)
  259. /**
  260. * HB_DIRECTION_IS_BACKWARD:
  261. * @dir: #hb_direction_t to test
  262. *
  263. * Tests whether a text direction moves backward (from right to left, or from
  264. * bottom to top). Requires that the direction be valid.
  265. *
  266. **/
  267. #define HB_DIRECTION_IS_BACKWARD(dir) ((((unsigned int) (dir)) & ~2U) == 5)
  268. /**
  269. * HB_DIRECTION_REVERSE:
  270. * @dir: #hb_direction_t to reverse
  271. *
  272. * Reverses a text direction. Requires that the direction
  273. * be valid.
  274. *
  275. **/
  276. #define HB_DIRECTION_REVERSE(dir) ((hb_direction_t) (((unsigned int) (dir)) ^ 1))
  277. /* hb_language_t */
  278. /**
  279. * hb_language_t:
  280. *
  281. * Data type for languages. Each #hb_language_t corresponds to a BCP 47
  282. * language tag.
  283. *
  284. */
  285. typedef const struct hb_language_impl_t *hb_language_t;
  286. HB_EXTERN hb_language_t
  287. hb_language_from_string (const char *str, int len);
  288. HB_EXTERN const char *
  289. hb_language_to_string (hb_language_t language);
  290. /**
  291. * HB_LANGUAGE_INVALID:
  292. *
  293. * An unset #hb_language_t.
  294. *
  295. * Since: 0.6.0
  296. */
  297. #define HB_LANGUAGE_INVALID ((hb_language_t) 0)
  298. HB_EXTERN hb_language_t
  299. hb_language_get_default (void);
  300. HB_EXTERN hb_bool_t
  301. hb_language_matches (hb_language_t language,
  302. hb_language_t specific);
  303. /**
  304. * hb_script_t:
  305. * @HB_SCRIPT_COMMON: `Zyyy`
  306. * @HB_SCRIPT_INHERITED: `Zinh`
  307. * @HB_SCRIPT_UNKNOWN: `Zzzz`
  308. * @HB_SCRIPT_ARABIC: `Arab`
  309. * @HB_SCRIPT_ARMENIAN: `Armn`
  310. * @HB_SCRIPT_BENGALI: `Beng`
  311. * @HB_SCRIPT_CYRILLIC: `Cyrl`
  312. * @HB_SCRIPT_DEVANAGARI: `Deva`
  313. * @HB_SCRIPT_GEORGIAN: `Geor`
  314. * @HB_SCRIPT_GREEK: `Grek`
  315. * @HB_SCRIPT_GUJARATI: `Gujr`
  316. * @HB_SCRIPT_GURMUKHI: `Guru`
  317. * @HB_SCRIPT_HANGUL: `Hang`
  318. * @HB_SCRIPT_HAN: `Hani`
  319. * @HB_SCRIPT_HEBREW: `Hebr`
  320. * @HB_SCRIPT_HIRAGANA: `Hira`
  321. * @HB_SCRIPT_KANNADA: `Knda`
  322. * @HB_SCRIPT_KATAKANA: `Kana`
  323. * @HB_SCRIPT_LAO: `Laoo`
  324. * @HB_SCRIPT_LATIN: `Latn`
  325. * @HB_SCRIPT_MALAYALAM: `Mlym`
  326. * @HB_SCRIPT_ORIYA: `Orya`
  327. * @HB_SCRIPT_TAMIL: `Taml`
  328. * @HB_SCRIPT_TELUGU: `Telu`
  329. * @HB_SCRIPT_THAI: `Thai`
  330. * @HB_SCRIPT_TIBETAN: `Tibt`
  331. * @HB_SCRIPT_BOPOMOFO: `Bopo`
  332. * @HB_SCRIPT_BRAILLE: `Brai`
  333. * @HB_SCRIPT_CANADIAN_SYLLABICS: `Cans`
  334. * @HB_SCRIPT_CHEROKEE: `Cher`
  335. * @HB_SCRIPT_ETHIOPIC: `Ethi`
  336. * @HB_SCRIPT_KHMER: `Khmr`
  337. * @HB_SCRIPT_MONGOLIAN: `Mong`
  338. * @HB_SCRIPT_MYANMAR: `Mymr`
  339. * @HB_SCRIPT_OGHAM: `Ogam`
  340. * @HB_SCRIPT_RUNIC: `Runr`
  341. * @HB_SCRIPT_SINHALA: `Sinh`
  342. * @HB_SCRIPT_SYRIAC: `Syrc`
  343. * @HB_SCRIPT_THAANA: `Thaa`
  344. * @HB_SCRIPT_YI: `Yiii`
  345. * @HB_SCRIPT_DESERET: `Dsrt`
  346. * @HB_SCRIPT_GOTHIC: `Goth`
  347. * @HB_SCRIPT_OLD_ITALIC: `Ital`
  348. * @HB_SCRIPT_BUHID: `Buhd`
  349. * @HB_SCRIPT_HANUNOO: `Hano`
  350. * @HB_SCRIPT_TAGALOG: `Tglg`
  351. * @HB_SCRIPT_TAGBANWA: `Tagb`
  352. * @HB_SCRIPT_CYPRIOT: `Cprt`
  353. * @HB_SCRIPT_LIMBU: `Limb`
  354. * @HB_SCRIPT_LINEAR_B: `Linb`
  355. * @HB_SCRIPT_OSMANYA: `Osma`
  356. * @HB_SCRIPT_SHAVIAN: `Shaw`
  357. * @HB_SCRIPT_TAI_LE: `Tale`
  358. * @HB_SCRIPT_UGARITIC: `Ugar`
  359. * @HB_SCRIPT_BUGINESE: `Bugi`
  360. * @HB_SCRIPT_COPTIC: `Copt`
  361. * @HB_SCRIPT_GLAGOLITIC: `Glag`
  362. * @HB_SCRIPT_KHAROSHTHI: `Khar`
  363. * @HB_SCRIPT_NEW_TAI_LUE: `Talu`
  364. * @HB_SCRIPT_OLD_PERSIAN: `Xpeo`
  365. * @HB_SCRIPT_SYLOTI_NAGRI: `Sylo`
  366. * @HB_SCRIPT_TIFINAGH: `Tfng`
  367. * @HB_SCRIPT_BALINESE: `Bali`
  368. * @HB_SCRIPT_CUNEIFORM: `Xsux`
  369. * @HB_SCRIPT_NKO: `Nkoo`
  370. * @HB_SCRIPT_PHAGS_PA: `Phag`
  371. * @HB_SCRIPT_PHOENICIAN: `Phnx`
  372. * @HB_SCRIPT_CARIAN: `Cari`
  373. * @HB_SCRIPT_CHAM: `Cham`
  374. * @HB_SCRIPT_KAYAH_LI: `Kali`
  375. * @HB_SCRIPT_LEPCHA: `Lepc`
  376. * @HB_SCRIPT_LYCIAN: `Lyci`
  377. * @HB_SCRIPT_LYDIAN: `Lydi`
  378. * @HB_SCRIPT_OL_CHIKI: `Olck`
  379. * @HB_SCRIPT_REJANG: `Rjng`
  380. * @HB_SCRIPT_SAURASHTRA: `Saur`
  381. * @HB_SCRIPT_SUNDANESE: `Sund`
  382. * @HB_SCRIPT_VAI: `Vaii`
  383. * @HB_SCRIPT_AVESTAN: `Avst`
  384. * @HB_SCRIPT_BAMUM: `Bamu`
  385. * @HB_SCRIPT_EGYPTIAN_HIEROGLYPHS: `Egyp`
  386. * @HB_SCRIPT_IMPERIAL_ARAMAIC: `Armi`
  387. * @HB_SCRIPT_INSCRIPTIONAL_PAHLAVI: `Phli`
  388. * @HB_SCRIPT_INSCRIPTIONAL_PARTHIAN: `Prti`
  389. * @HB_SCRIPT_JAVANESE: `Java`
  390. * @HB_SCRIPT_KAITHI: `Kthi`
  391. * @HB_SCRIPT_LISU: `Lisu`
  392. * @HB_SCRIPT_MEETEI_MAYEK: `Mtei`
  393. * @HB_SCRIPT_OLD_SOUTH_ARABIAN: `Sarb`
  394. * @HB_SCRIPT_OLD_TURKIC: `Orkh`
  395. * @HB_SCRIPT_SAMARITAN: `Samr`
  396. * @HB_SCRIPT_TAI_THAM: `Lana`
  397. * @HB_SCRIPT_TAI_VIET: `Tavt`
  398. * @HB_SCRIPT_BATAK: `Batk`
  399. * @HB_SCRIPT_BRAHMI: `Brah`
  400. * @HB_SCRIPT_MANDAIC: `Mand`
  401. * @HB_SCRIPT_CHAKMA: `Cakm`
  402. * @HB_SCRIPT_MEROITIC_CURSIVE: `Merc`
  403. * @HB_SCRIPT_MEROITIC_HIEROGLYPHS: `Mero`
  404. * @HB_SCRIPT_MIAO: `Plrd`
  405. * @HB_SCRIPT_SHARADA: `Shrd`
  406. * @HB_SCRIPT_SORA_SOMPENG: `Sora`
  407. * @HB_SCRIPT_TAKRI: `Takr`
  408. * @HB_SCRIPT_BASSA_VAH: `Bass`, Since: 0.9.30
  409. * @HB_SCRIPT_CAUCASIAN_ALBANIAN: `Aghb`, Since: 0.9.30
  410. * @HB_SCRIPT_DUPLOYAN: `Dupl`, Since: 0.9.30
  411. * @HB_SCRIPT_ELBASAN: `Elba`, Since: 0.9.30
  412. * @HB_SCRIPT_GRANTHA: `Gran`, Since: 0.9.30
  413. * @HB_SCRIPT_KHOJKI: `Khoj`, Since: 0.9.30
  414. * @HB_SCRIPT_KHUDAWADI: `Sind`, Since: 0.9.30
  415. * @HB_SCRIPT_LINEAR_A: `Lina`, Since: 0.9.30
  416. * @HB_SCRIPT_MAHAJANI: `Mahj`, Since: 0.9.30
  417. * @HB_SCRIPT_MANICHAEAN: `Mani`, Since: 0.9.30
  418. * @HB_SCRIPT_MENDE_KIKAKUI: `Mend`, Since: 0.9.30
  419. * @HB_SCRIPT_MODI: `Modi`, Since: 0.9.30
  420. * @HB_SCRIPT_MRO: `Mroo`, Since: 0.9.30
  421. * @HB_SCRIPT_NABATAEAN: `Nbat`, Since: 0.9.30
  422. * @HB_SCRIPT_OLD_NORTH_ARABIAN: `Narb`, Since: 0.9.30
  423. * @HB_SCRIPT_OLD_PERMIC: `Perm`, Since: 0.9.30
  424. * @HB_SCRIPT_PAHAWH_HMONG: `Hmng`, Since: 0.9.30
  425. * @HB_SCRIPT_PALMYRENE: `Palm`, Since: 0.9.30
  426. * @HB_SCRIPT_PAU_CIN_HAU: `Pauc`, Since: 0.9.30
  427. * @HB_SCRIPT_PSALTER_PAHLAVI: `Phlp`, Since: 0.9.30
  428. * @HB_SCRIPT_SIDDHAM: `Sidd`, Since: 0.9.30
  429. * @HB_SCRIPT_TIRHUTA: `Tirh`, Since: 0.9.30
  430. * @HB_SCRIPT_WARANG_CITI: `Wara`, Since: 0.9.30
  431. * @HB_SCRIPT_AHOM: `Ahom`, Since: 0.9.30
  432. * @HB_SCRIPT_ANATOLIAN_HIEROGLYPHS: `Hluw`, Since: 0.9.30
  433. * @HB_SCRIPT_HATRAN: `Hatr`, Since: 0.9.30
  434. * @HB_SCRIPT_MULTANI: `Mult`, Since: 0.9.30
  435. * @HB_SCRIPT_OLD_HUNGARIAN: `Hung`, Since: 0.9.30
  436. * @HB_SCRIPT_SIGNWRITING: `Sgnw`, Since: 0.9.30
  437. * @HB_SCRIPT_ADLAM: `Adlm`, Since: 1.3.0
  438. * @HB_SCRIPT_BHAIKSUKI: `Bhks`, Since: 1.3.0
  439. * @HB_SCRIPT_MARCHEN: `Marc`, Since: 1.3.0
  440. * @HB_SCRIPT_OSAGE: `Osge`, Since: 1.3.0
  441. * @HB_SCRIPT_TANGUT: `Tang`, Since: 1.3.0
  442. * @HB_SCRIPT_NEWA: `Newa`, Since: 1.3.0
  443. * @HB_SCRIPT_MASARAM_GONDI: `Gonm`, Since: 1.6.0
  444. * @HB_SCRIPT_NUSHU: `Nshu`, Since: 1.6.0
  445. * @HB_SCRIPT_SOYOMBO: `Soyo`, Since: 1.6.0
  446. * @HB_SCRIPT_ZANABAZAR_SQUARE: `Zanb`, Since: 1.6.0
  447. * @HB_SCRIPT_DOGRA: `Dogr`, Since: 1.8.0
  448. * @HB_SCRIPT_GUNJALA_GONDI: `Gong`, Since: 1.8.0
  449. * @HB_SCRIPT_HANIFI_ROHINGYA: `Rohg`, Since: 1.8.0
  450. * @HB_SCRIPT_MAKASAR: `Maka`, Since: 1.8.0
  451. * @HB_SCRIPT_MEDEFAIDRIN: `Medf`, Since: 1.8.0
  452. * @HB_SCRIPT_OLD_SOGDIAN: `Sogo`, Since: 1.8.0
  453. * @HB_SCRIPT_SOGDIAN: `Sogd`, Since: 1.8.0
  454. * @HB_SCRIPT_ELYMAIC: `Elym`, Since: 2.4.0
  455. * @HB_SCRIPT_NANDINAGARI: `Nand`, Since: 2.4.0
  456. * @HB_SCRIPT_NYIAKENG_PUACHUE_HMONG: `Hmnp`, Since: 2.4.0
  457. * @HB_SCRIPT_WANCHO: `Wcho`, Since: 2.4.0
  458. * @HB_SCRIPT_CHORASMIAN: `Chrs`, Since: 2.6.7
  459. * @HB_SCRIPT_DIVES_AKURU: `Diak`, Since: 2.6.7
  460. * @HB_SCRIPT_KHITAN_SMALL_SCRIPT: `Kits`, Since: 2.6.7
  461. * @HB_SCRIPT_YEZIDI: `Yezi`, Since: 2.6.7
  462. * @HB_SCRIPT_CYPRO_MINOAN: `Cpmn`, Since: 3.0.0
  463. * @HB_SCRIPT_OLD_UYGHUR: `Ougr`, Since: 3.0.0
  464. * @HB_SCRIPT_TANGSA: `Tnsa`, Since: 3.0.0
  465. * @HB_SCRIPT_TOTO: `Toto`, Since: 3.0.0
  466. * @HB_SCRIPT_VITHKUQI: `Vith`, Since: 3.0.0
  467. * @HB_SCRIPT_MATH: `Zmth`, Since: 3.4.0
  468. * @HB_SCRIPT_KAWI: `Kawi`, Since: 5.2.0
  469. * @HB_SCRIPT_NAG_MUNDARI: `Nagm`, Since: 5.2.0
  470. * @HB_SCRIPT_GARAY: `Gara`, Since: 10.0.0
  471. * @HB_SCRIPT_GURUNG_KHEMA: `Gukh`, Since: 10.0.0
  472. * @HB_SCRIPT_KIRAT_RAI: `Krai`, Since: 10.0.0
  473. * @HB_SCRIPT_OL_ONAL: `Onao`, Since: 10.0.0
  474. * @HB_SCRIPT_SUNUWAR: `Sunu`, Since: 10.0.0
  475. * @HB_SCRIPT_TODHRI: `Todr`, Since: 10.0.0
  476. * @HB_SCRIPT_TULU_TIGALARI: `Tutg`, Since: 10.0.0
  477. * @HB_SCRIPT_INVALID: No script set
  478. *
  479. * Data type for scripts. Each #hb_script_t's value is an #hb_tag_t corresponding
  480. * to the four-letter values defined by [ISO 15924](https://unicode.org/iso15924/).
  481. *
  482. * See also the Script (sc) property of the Unicode Character Database.
  483. *
  484. **/
  485. /* https://docs.google.com/spreadsheets/d/1Y90M0Ie3MUJ6UVCRDOypOtijlMDLNNyyLk36T6iMu0o */
  486. typedef enum
  487. {
  488. HB_SCRIPT_COMMON = HB_TAG ('Z','y','y','y'), /*1.1*/
  489. HB_SCRIPT_INHERITED = HB_TAG ('Z','i','n','h'), /*1.1*/
  490. HB_SCRIPT_UNKNOWN = HB_TAG ('Z','z','z','z'), /*5.0*/
  491. HB_SCRIPT_ARABIC = HB_TAG ('A','r','a','b'), /*1.1*/
  492. HB_SCRIPT_ARMENIAN = HB_TAG ('A','r','m','n'), /*1.1*/
  493. HB_SCRIPT_BENGALI = HB_TAG ('B','e','n','g'), /*1.1*/
  494. HB_SCRIPT_CYRILLIC = HB_TAG ('C','y','r','l'), /*1.1*/
  495. HB_SCRIPT_DEVANAGARI = HB_TAG ('D','e','v','a'), /*1.1*/
  496. HB_SCRIPT_GEORGIAN = HB_TAG ('G','e','o','r'), /*1.1*/
  497. HB_SCRIPT_GREEK = HB_TAG ('G','r','e','k'), /*1.1*/
  498. HB_SCRIPT_GUJARATI = HB_TAG ('G','u','j','r'), /*1.1*/
  499. HB_SCRIPT_GURMUKHI = HB_TAG ('G','u','r','u'), /*1.1*/
  500. HB_SCRIPT_HANGUL = HB_TAG ('H','a','n','g'), /*1.1*/
  501. HB_SCRIPT_HAN = HB_TAG ('H','a','n','i'), /*1.1*/
  502. HB_SCRIPT_HEBREW = HB_TAG ('H','e','b','r'), /*1.1*/
  503. HB_SCRIPT_HIRAGANA = HB_TAG ('H','i','r','a'), /*1.1*/
  504. HB_SCRIPT_KANNADA = HB_TAG ('K','n','d','a'), /*1.1*/
  505. HB_SCRIPT_KATAKANA = HB_TAG ('K','a','n','a'), /*1.1*/
  506. HB_SCRIPT_LAO = HB_TAG ('L','a','o','o'), /*1.1*/
  507. HB_SCRIPT_LATIN = HB_TAG ('L','a','t','n'), /*1.1*/
  508. HB_SCRIPT_MALAYALAM = HB_TAG ('M','l','y','m'), /*1.1*/
  509. HB_SCRIPT_ORIYA = HB_TAG ('O','r','y','a'), /*1.1*/
  510. HB_SCRIPT_TAMIL = HB_TAG ('T','a','m','l'), /*1.1*/
  511. HB_SCRIPT_TELUGU = HB_TAG ('T','e','l','u'), /*1.1*/
  512. HB_SCRIPT_THAI = HB_TAG ('T','h','a','i'), /*1.1*/
  513. HB_SCRIPT_TIBETAN = HB_TAG ('T','i','b','t'), /*2.0*/
  514. HB_SCRIPT_BOPOMOFO = HB_TAG ('B','o','p','o'), /*3.0*/
  515. HB_SCRIPT_BRAILLE = HB_TAG ('B','r','a','i'), /*3.0*/
  516. HB_SCRIPT_CANADIAN_SYLLABICS = HB_TAG ('C','a','n','s'), /*3.0*/
  517. HB_SCRIPT_CHEROKEE = HB_TAG ('C','h','e','r'), /*3.0*/
  518. HB_SCRIPT_ETHIOPIC = HB_TAG ('E','t','h','i'), /*3.0*/
  519. HB_SCRIPT_KHMER = HB_TAG ('K','h','m','r'), /*3.0*/
  520. HB_SCRIPT_MONGOLIAN = HB_TAG ('M','o','n','g'), /*3.0*/
  521. HB_SCRIPT_MYANMAR = HB_TAG ('M','y','m','r'), /*3.0*/
  522. HB_SCRIPT_OGHAM = HB_TAG ('O','g','a','m'), /*3.0*/
  523. HB_SCRIPT_RUNIC = HB_TAG ('R','u','n','r'), /*3.0*/
  524. HB_SCRIPT_SINHALA = HB_TAG ('S','i','n','h'), /*3.0*/
  525. HB_SCRIPT_SYRIAC = HB_TAG ('S','y','r','c'), /*3.0*/
  526. HB_SCRIPT_THAANA = HB_TAG ('T','h','a','a'), /*3.0*/
  527. HB_SCRIPT_YI = HB_TAG ('Y','i','i','i'), /*3.0*/
  528. HB_SCRIPT_DESERET = HB_TAG ('D','s','r','t'), /*3.1*/
  529. HB_SCRIPT_GOTHIC = HB_TAG ('G','o','t','h'), /*3.1*/
  530. HB_SCRIPT_OLD_ITALIC = HB_TAG ('I','t','a','l'), /*3.1*/
  531. HB_SCRIPT_BUHID = HB_TAG ('B','u','h','d'), /*3.2*/
  532. HB_SCRIPT_HANUNOO = HB_TAG ('H','a','n','o'), /*3.2*/
  533. HB_SCRIPT_TAGALOG = HB_TAG ('T','g','l','g'), /*3.2*/
  534. HB_SCRIPT_TAGBANWA = HB_TAG ('T','a','g','b'), /*3.2*/
  535. HB_SCRIPT_CYPRIOT = HB_TAG ('C','p','r','t'), /*4.0*/
  536. HB_SCRIPT_LIMBU = HB_TAG ('L','i','m','b'), /*4.0*/
  537. HB_SCRIPT_LINEAR_B = HB_TAG ('L','i','n','b'), /*4.0*/
  538. HB_SCRIPT_OSMANYA = HB_TAG ('O','s','m','a'), /*4.0*/
  539. HB_SCRIPT_SHAVIAN = HB_TAG ('S','h','a','w'), /*4.0*/
  540. HB_SCRIPT_TAI_LE = HB_TAG ('T','a','l','e'), /*4.0*/
  541. HB_SCRIPT_UGARITIC = HB_TAG ('U','g','a','r'), /*4.0*/
  542. HB_SCRIPT_BUGINESE = HB_TAG ('B','u','g','i'), /*4.1*/
  543. HB_SCRIPT_COPTIC = HB_TAG ('C','o','p','t'), /*4.1*/
  544. HB_SCRIPT_GLAGOLITIC = HB_TAG ('G','l','a','g'), /*4.1*/
  545. HB_SCRIPT_KHAROSHTHI = HB_TAG ('K','h','a','r'), /*4.1*/
  546. HB_SCRIPT_NEW_TAI_LUE = HB_TAG ('T','a','l','u'), /*4.1*/
  547. HB_SCRIPT_OLD_PERSIAN = HB_TAG ('X','p','e','o'), /*4.1*/
  548. HB_SCRIPT_SYLOTI_NAGRI = HB_TAG ('S','y','l','o'), /*4.1*/
  549. HB_SCRIPT_TIFINAGH = HB_TAG ('T','f','n','g'), /*4.1*/
  550. HB_SCRIPT_BALINESE = HB_TAG ('B','a','l','i'), /*5.0*/
  551. HB_SCRIPT_CUNEIFORM = HB_TAG ('X','s','u','x'), /*5.0*/
  552. HB_SCRIPT_NKO = HB_TAG ('N','k','o','o'), /*5.0*/
  553. HB_SCRIPT_PHAGS_PA = HB_TAG ('P','h','a','g'), /*5.0*/
  554. HB_SCRIPT_PHOENICIAN = HB_TAG ('P','h','n','x'), /*5.0*/
  555. HB_SCRIPT_CARIAN = HB_TAG ('C','a','r','i'), /*5.1*/
  556. HB_SCRIPT_CHAM = HB_TAG ('C','h','a','m'), /*5.1*/
  557. HB_SCRIPT_KAYAH_LI = HB_TAG ('K','a','l','i'), /*5.1*/
  558. HB_SCRIPT_LEPCHA = HB_TAG ('L','e','p','c'), /*5.1*/
  559. HB_SCRIPT_LYCIAN = HB_TAG ('L','y','c','i'), /*5.1*/
  560. HB_SCRIPT_LYDIAN = HB_TAG ('L','y','d','i'), /*5.1*/
  561. HB_SCRIPT_OL_CHIKI = HB_TAG ('O','l','c','k'), /*5.1*/
  562. HB_SCRIPT_REJANG = HB_TAG ('R','j','n','g'), /*5.1*/
  563. HB_SCRIPT_SAURASHTRA = HB_TAG ('S','a','u','r'), /*5.1*/
  564. HB_SCRIPT_SUNDANESE = HB_TAG ('S','u','n','d'), /*5.1*/
  565. HB_SCRIPT_VAI = HB_TAG ('V','a','i','i'), /*5.1*/
  566. HB_SCRIPT_AVESTAN = HB_TAG ('A','v','s','t'), /*5.2*/
  567. HB_SCRIPT_BAMUM = HB_TAG ('B','a','m','u'), /*5.2*/
  568. HB_SCRIPT_EGYPTIAN_HIEROGLYPHS = HB_TAG ('E','g','y','p'), /*5.2*/
  569. HB_SCRIPT_IMPERIAL_ARAMAIC = HB_TAG ('A','r','m','i'), /*5.2*/
  570. HB_SCRIPT_INSCRIPTIONAL_PAHLAVI = HB_TAG ('P','h','l','i'), /*5.2*/
  571. HB_SCRIPT_INSCRIPTIONAL_PARTHIAN = HB_TAG ('P','r','t','i'), /*5.2*/
  572. HB_SCRIPT_JAVANESE = HB_TAG ('J','a','v','a'), /*5.2*/
  573. HB_SCRIPT_KAITHI = HB_TAG ('K','t','h','i'), /*5.2*/
  574. HB_SCRIPT_LISU = HB_TAG ('L','i','s','u'), /*5.2*/
  575. HB_SCRIPT_MEETEI_MAYEK = HB_TAG ('M','t','e','i'), /*5.2*/
  576. HB_SCRIPT_OLD_SOUTH_ARABIAN = HB_TAG ('S','a','r','b'), /*5.2*/
  577. HB_SCRIPT_OLD_TURKIC = HB_TAG ('O','r','k','h'), /*5.2*/
  578. HB_SCRIPT_SAMARITAN = HB_TAG ('S','a','m','r'), /*5.2*/
  579. HB_SCRIPT_TAI_THAM = HB_TAG ('L','a','n','a'), /*5.2*/
  580. HB_SCRIPT_TAI_VIET = HB_TAG ('T','a','v','t'), /*5.2*/
  581. HB_SCRIPT_BATAK = HB_TAG ('B','a','t','k'), /*6.0*/
  582. HB_SCRIPT_BRAHMI = HB_TAG ('B','r','a','h'), /*6.0*/
  583. HB_SCRIPT_MANDAIC = HB_TAG ('M','a','n','d'), /*6.0*/
  584. HB_SCRIPT_CHAKMA = HB_TAG ('C','a','k','m'), /*6.1*/
  585. HB_SCRIPT_MEROITIC_CURSIVE = HB_TAG ('M','e','r','c'), /*6.1*/
  586. HB_SCRIPT_MEROITIC_HIEROGLYPHS = HB_TAG ('M','e','r','o'), /*6.1*/
  587. HB_SCRIPT_MIAO = HB_TAG ('P','l','r','d'), /*6.1*/
  588. HB_SCRIPT_SHARADA = HB_TAG ('S','h','r','d'), /*6.1*/
  589. HB_SCRIPT_SORA_SOMPENG = HB_TAG ('S','o','r','a'), /*6.1*/
  590. HB_SCRIPT_TAKRI = HB_TAG ('T','a','k','r'), /*6.1*/
  591. /*
  592. * Since: 0.9.30
  593. */
  594. HB_SCRIPT_BASSA_VAH = HB_TAG ('B','a','s','s'), /*7.0*/
  595. HB_SCRIPT_CAUCASIAN_ALBANIAN = HB_TAG ('A','g','h','b'), /*7.0*/
  596. HB_SCRIPT_DUPLOYAN = HB_TAG ('D','u','p','l'), /*7.0*/
  597. HB_SCRIPT_ELBASAN = HB_TAG ('E','l','b','a'), /*7.0*/
  598. HB_SCRIPT_GRANTHA = HB_TAG ('G','r','a','n'), /*7.0*/
  599. HB_SCRIPT_KHOJKI = HB_TAG ('K','h','o','j'), /*7.0*/
  600. HB_SCRIPT_KHUDAWADI = HB_TAG ('S','i','n','d'), /*7.0*/
  601. HB_SCRIPT_LINEAR_A = HB_TAG ('L','i','n','a'), /*7.0*/
  602. HB_SCRIPT_MAHAJANI = HB_TAG ('M','a','h','j'), /*7.0*/
  603. HB_SCRIPT_MANICHAEAN = HB_TAG ('M','a','n','i'), /*7.0*/
  604. HB_SCRIPT_MENDE_KIKAKUI = HB_TAG ('M','e','n','d'), /*7.0*/
  605. HB_SCRIPT_MODI = HB_TAG ('M','o','d','i'), /*7.0*/
  606. HB_SCRIPT_MRO = HB_TAG ('M','r','o','o'), /*7.0*/
  607. HB_SCRIPT_NABATAEAN = HB_TAG ('N','b','a','t'), /*7.0*/
  608. HB_SCRIPT_OLD_NORTH_ARABIAN = HB_TAG ('N','a','r','b'), /*7.0*/
  609. HB_SCRIPT_OLD_PERMIC = HB_TAG ('P','e','r','m'), /*7.0*/
  610. HB_SCRIPT_PAHAWH_HMONG = HB_TAG ('H','m','n','g'), /*7.0*/
  611. HB_SCRIPT_PALMYRENE = HB_TAG ('P','a','l','m'), /*7.0*/
  612. HB_SCRIPT_PAU_CIN_HAU = HB_TAG ('P','a','u','c'), /*7.0*/
  613. HB_SCRIPT_PSALTER_PAHLAVI = HB_TAG ('P','h','l','p'), /*7.0*/
  614. HB_SCRIPT_SIDDHAM = HB_TAG ('S','i','d','d'), /*7.0*/
  615. HB_SCRIPT_TIRHUTA = HB_TAG ('T','i','r','h'), /*7.0*/
  616. HB_SCRIPT_WARANG_CITI = HB_TAG ('W','a','r','a'), /*7.0*/
  617. HB_SCRIPT_AHOM = HB_TAG ('A','h','o','m'), /*8.0*/
  618. HB_SCRIPT_ANATOLIAN_HIEROGLYPHS = HB_TAG ('H','l','u','w'), /*8.0*/
  619. HB_SCRIPT_HATRAN = HB_TAG ('H','a','t','r'), /*8.0*/
  620. HB_SCRIPT_MULTANI = HB_TAG ('M','u','l','t'), /*8.0*/
  621. HB_SCRIPT_OLD_HUNGARIAN = HB_TAG ('H','u','n','g'), /*8.0*/
  622. HB_SCRIPT_SIGNWRITING = HB_TAG ('S','g','n','w'), /*8.0*/
  623. /*
  624. * Since 1.3.0
  625. */
  626. HB_SCRIPT_ADLAM = HB_TAG ('A','d','l','m'), /*9.0*/
  627. HB_SCRIPT_BHAIKSUKI = HB_TAG ('B','h','k','s'), /*9.0*/
  628. HB_SCRIPT_MARCHEN = HB_TAG ('M','a','r','c'), /*9.0*/
  629. HB_SCRIPT_OSAGE = HB_TAG ('O','s','g','e'), /*9.0*/
  630. HB_SCRIPT_TANGUT = HB_TAG ('T','a','n','g'), /*9.0*/
  631. HB_SCRIPT_NEWA = HB_TAG ('N','e','w','a'), /*9.0*/
  632. /*
  633. * Since 1.6.0
  634. */
  635. HB_SCRIPT_MASARAM_GONDI = HB_TAG ('G','o','n','m'), /*10.0*/
  636. HB_SCRIPT_NUSHU = HB_TAG ('N','s','h','u'), /*10.0*/
  637. HB_SCRIPT_SOYOMBO = HB_TAG ('S','o','y','o'), /*10.0*/
  638. HB_SCRIPT_ZANABAZAR_SQUARE = HB_TAG ('Z','a','n','b'), /*10.0*/
  639. /*
  640. * Since 1.8.0
  641. */
  642. HB_SCRIPT_DOGRA = HB_TAG ('D','o','g','r'), /*11.0*/
  643. HB_SCRIPT_GUNJALA_GONDI = HB_TAG ('G','o','n','g'), /*11.0*/
  644. HB_SCRIPT_HANIFI_ROHINGYA = HB_TAG ('R','o','h','g'), /*11.0*/
  645. HB_SCRIPT_MAKASAR = HB_TAG ('M','a','k','a'), /*11.0*/
  646. HB_SCRIPT_MEDEFAIDRIN = HB_TAG ('M','e','d','f'), /*11.0*/
  647. HB_SCRIPT_OLD_SOGDIAN = HB_TAG ('S','o','g','o'), /*11.0*/
  648. HB_SCRIPT_SOGDIAN = HB_TAG ('S','o','g','d'), /*11.0*/
  649. /*
  650. * Since 2.4.0
  651. */
  652. HB_SCRIPT_ELYMAIC = HB_TAG ('E','l','y','m'), /*12.0*/
  653. HB_SCRIPT_NANDINAGARI = HB_TAG ('N','a','n','d'), /*12.0*/
  654. HB_SCRIPT_NYIAKENG_PUACHUE_HMONG = HB_TAG ('H','m','n','p'), /*12.0*/
  655. HB_SCRIPT_WANCHO = HB_TAG ('W','c','h','o'), /*12.0*/
  656. /*
  657. * Since 2.6.7
  658. */
  659. HB_SCRIPT_CHORASMIAN = HB_TAG ('C','h','r','s'), /*13.0*/
  660. HB_SCRIPT_DIVES_AKURU = HB_TAG ('D','i','a','k'), /*13.0*/
  661. HB_SCRIPT_KHITAN_SMALL_SCRIPT = HB_TAG ('K','i','t','s'), /*13.0*/
  662. HB_SCRIPT_YEZIDI = HB_TAG ('Y','e','z','i'), /*13.0*/
  663. /*
  664. * Since 3.0.0
  665. */
  666. HB_SCRIPT_CYPRO_MINOAN = HB_TAG ('C','p','m','n'), /*14.0*/
  667. HB_SCRIPT_OLD_UYGHUR = HB_TAG ('O','u','g','r'), /*14.0*/
  668. HB_SCRIPT_TANGSA = HB_TAG ('T','n','s','a'), /*14.0*/
  669. HB_SCRIPT_TOTO = HB_TAG ('T','o','t','o'), /*14.0*/
  670. HB_SCRIPT_VITHKUQI = HB_TAG ('V','i','t','h'), /*14.0*/
  671. /*
  672. * Since 3.4.0
  673. */
  674. HB_SCRIPT_MATH = HB_TAG ('Z','m','t','h'),
  675. /*
  676. * Since 5.2.0
  677. */
  678. HB_SCRIPT_KAWI = HB_TAG ('K','a','w','i'), /*15.0*/
  679. HB_SCRIPT_NAG_MUNDARI = HB_TAG ('N','a','g','m'), /*15.0*/
  680. /*
  681. * Since 10.0.0
  682. */
  683. HB_SCRIPT_GARAY = HB_TAG ('G','a','r','a'), /*16.0*/
  684. HB_SCRIPT_GURUNG_KHEMA = HB_TAG ('G','u','k','h'), /*16.0*/
  685. HB_SCRIPT_KIRAT_RAI = HB_TAG ('K','r','a','i'), /*16.0*/
  686. HB_SCRIPT_OL_ONAL = HB_TAG ('O','n','a','o'), /*16.0*/
  687. HB_SCRIPT_SUNUWAR = HB_TAG ('S','u','n','u'), /*16.0*/
  688. HB_SCRIPT_TODHRI = HB_TAG ('T','o','d','r'), /*16.0*/
  689. HB_SCRIPT_TULU_TIGALARI = HB_TAG ('T','u','t','g'), /*16.0*/
  690. /* No script set. */
  691. HB_SCRIPT_INVALID = HB_TAG_NONE,
  692. /*< private >*/
  693. /* Dummy values to ensure any hb_tag_t value can be passed/stored as hb_script_t
  694. * without risking undefined behavior. We have two, for historical reasons.
  695. * HB_TAG_MAX used to be unsigned, but that was invalid Ansi C, so was changed
  696. * to _HB_SCRIPT_MAX_VALUE to be equal to HB_TAG_MAX_SIGNED as well.
  697. *
  698. * See this thread for technicalities:
  699. *
  700. * https://lists.freedesktop.org/archives/harfbuzz/2014-March/004150.html
  701. */
  702. _HB_SCRIPT_MAX_VALUE = HB_TAG_MAX_SIGNED, /*< skip >*/
  703. _HB_SCRIPT_MAX_VALUE_SIGNED = HB_TAG_MAX_SIGNED /*< skip >*/
  704. } hb_script_t;
  705. /* Script functions */
  706. HB_EXTERN hb_script_t
  707. hb_script_from_iso15924_tag (hb_tag_t tag);
  708. HB_EXTERN hb_script_t
  709. hb_script_from_string (const char *str, int len);
  710. HB_EXTERN hb_tag_t
  711. hb_script_to_iso15924_tag (hb_script_t script);
  712. HB_EXTERN hb_direction_t
  713. hb_script_get_horizontal_direction (hb_script_t script);
  714. /* User data */
  715. /**
  716. * hb_user_data_key_t:
  717. *
  718. * Data structure for holding user-data keys.
  719. *
  720. **/
  721. typedef struct hb_user_data_key_t {
  722. /*< private >*/
  723. char unused;
  724. } hb_user_data_key_t;
  725. /**
  726. * hb_destroy_func_t:
  727. * @user_data: the data to be destroyed
  728. *
  729. * A virtual method for destroy user-data callbacks.
  730. *
  731. */
  732. typedef void (*hb_destroy_func_t) (void *user_data);
  733. /* Font features and variations. */
  734. /**
  735. * HB_FEATURE_GLOBAL_START:
  736. *
  737. * Special setting for #hb_feature_t.start to apply the feature from the start
  738. * of the buffer.
  739. *
  740. * Since: 2.0.0
  741. */
  742. #define HB_FEATURE_GLOBAL_START 0
  743. /**
  744. * HB_FEATURE_GLOBAL_END:
  745. *
  746. * Special setting for #hb_feature_t.end to apply the feature from to the end
  747. * of the buffer.
  748. *
  749. * Since: 2.0.0
  750. */
  751. #define HB_FEATURE_GLOBAL_END ((unsigned int) -1)
  752. /**
  753. * hb_feature_t:
  754. * @tag: The #hb_tag_t tag of the feature
  755. * @value: The value of the feature. 0 disables the feature, non-zero (usually
  756. * 1) enables the feature. For features implemented as lookup type 3 (like
  757. * 'salt') the @value is a one based index into the alternates.
  758. * @start: the cluster to start applying this feature setting (inclusive).
  759. * @end: the cluster to end applying this feature setting (exclusive).
  760. *
  761. * The #hb_feature_t is the structure that holds information about requested
  762. * feature application. The feature will be applied with the given value to all
  763. * glyphs which are in clusters between @start (inclusive) and @end (exclusive).
  764. * Setting start to #HB_FEATURE_GLOBAL_START and end to #HB_FEATURE_GLOBAL_END
  765. * specifies that the feature always applies to the entire buffer.
  766. */
  767. typedef struct hb_feature_t {
  768. hb_tag_t tag;
  769. uint32_t value;
  770. unsigned int start;
  771. unsigned int end;
  772. } hb_feature_t;
  773. HB_EXTERN hb_bool_t
  774. hb_feature_from_string (const char *str, int len,
  775. hb_feature_t *feature);
  776. HB_EXTERN void
  777. hb_feature_to_string (hb_feature_t *feature,
  778. char *buf, unsigned int size);
  779. /**
  780. * hb_variation_t:
  781. * @tag: The #hb_tag_t tag of the variation-axis name
  782. * @value: The value of the variation axis
  783. *
  784. * Data type for holding variation data. Registered OpenType
  785. * variation-axis tags are listed in
  786. * [OpenType Axis Tag Registry](https://docs.microsoft.com/en-us/typography/opentype/spec/dvaraxisreg).
  787. *
  788. * Since: 1.4.2
  789. */
  790. typedef struct hb_variation_t {
  791. hb_tag_t tag;
  792. float value;
  793. } hb_variation_t;
  794. HB_EXTERN hb_bool_t
  795. hb_variation_from_string (const char *str, int len,
  796. hb_variation_t *variation);
  797. HB_EXTERN void
  798. hb_variation_to_string (hb_variation_t *variation,
  799. char *buf, unsigned int size);
  800. /**
  801. * hb_color_t:
  802. *
  803. * Data type for holding color values. Colors are eight bits per
  804. * channel RGB plus alpha transparency.
  805. *
  806. * Since: 2.1.0
  807. */
  808. typedef uint32_t hb_color_t;
  809. /**
  810. * HB_COLOR:
  811. * @b: blue channel value
  812. * @g: green channel value
  813. * @r: red channel value
  814. * @a: alpha channel value
  815. *
  816. * Constructs an #hb_color_t from four integers.
  817. *
  818. * Since: 2.1.0
  819. */
  820. #define HB_COLOR(b,g,r,a) ((hb_color_t) HB_TAG ((b),(g),(r),(a)))
  821. HB_EXTERN uint8_t
  822. hb_color_get_alpha (hb_color_t color);
  823. #define hb_color_get_alpha(color) ((color) & 0xFF)
  824. HB_EXTERN uint8_t
  825. hb_color_get_red (hb_color_t color);
  826. #define hb_color_get_red(color) (((color) >> 8) & 0xFF)
  827. HB_EXTERN uint8_t
  828. hb_color_get_green (hb_color_t color);
  829. #define hb_color_get_green(color) (((color) >> 16) & 0xFF)
  830. HB_EXTERN uint8_t
  831. hb_color_get_blue (hb_color_t color);
  832. #define hb_color_get_blue(color) (((color) >> 24) & 0xFF)
  833. /**
  834. * hb_glyph_extents_t:
  835. * @x_bearing: Distance from the x-origin to the left extremum of the glyph.
  836. * @y_bearing: Distance from the top extremum of the glyph to the y-origin.
  837. * @width: Distance from the left extremum of the glyph to the right extremum.
  838. * @height: Distance from the top extremum of the glyph to the bottom extremum.
  839. *
  840. * Glyph extent values, measured in font units.
  841. *
  842. * Note that @height is negative, in coordinate systems that grow up.
  843. **/
  844. typedef struct hb_glyph_extents_t {
  845. hb_position_t x_bearing;
  846. hb_position_t y_bearing;
  847. hb_position_t width;
  848. hb_position_t height;
  849. } hb_glyph_extents_t;
  850. /**
  851. * hb_font_t:
  852. *
  853. * Data type for holding fonts.
  854. *
  855. */
  856. typedef struct hb_font_t hb_font_t;
  857. HB_END_DECLS
  858. #endif /* HB_COMMON_H */