comparison mupdf-source/thirdparty/harfbuzz/src/hb-common.h @ 2:b50eed0cc0ef upstream

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