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