1/*
2 *
3 * (C) Copyright IBM Corp. and others 1998-2014 - All Rights Reserved
4 *
5 */
6
7#ifndef __LETYPES_H
8#define __LETYPES_H
9
10#if !defined(LE_USE_CMEMORY) && (defined(U_LAYOUT_IMPLEMENTATION) || defined(U_LAYOUTEX_IMPLEMENTATION) || defined(U_STATIC_IMPLEMENTATION) || defined(U_COMBINED_IMPLEMENTATION))
11#define LE_USE_CMEMORY
12#endif
13
14#include "unicode/utypes.h"
15
16#ifdef __cplusplus
17#include "unicode/uobject.h"
18#endif
19
20#ifdef LE_USE_CMEMORY
21#include "cmemory.h"
22#endif
23
24/*!
25 * \file
26 * \brief C API: Basic definitions for the ICU LayoutEngine
27 */
28
29/**
30 * A type used for signed, 32-bit integers.
31 *
32 * @deprecated ICU 54. See {@link icu::LayoutEngine}
33 */
34typedef int32_t le_int32;
35
36/**
37 * A type used for unsigned, 32-bit integers.
38 *
39 * @deprecated ICU 54. See {@link icu::LayoutEngine}
40 */
41typedef uint32_t le_uint32;
42
43/**
44 * A type used for signed, 16-bit integers.
45 *
46 * @deprecated ICU 54. See {@link icu::LayoutEngine}
47 */
48typedef int16_t le_int16;
49
50/**
51 * A type used for unsigned, 16-bit integers.
52 *
53 * @deprecated ICU 54. See {@link icu::LayoutEngine}
54 */
55typedef uint16_t le_uint16;
56
57/**
58 * A type used for signed, 8-bit integers.
59 *
60 * @deprecated ICU 54. See {@link icu::LayoutEngine}
61 */
62typedef int8_t le_int8;
63
64/**
65 * A type used for unsigned, 8-bit integers.
66 *
67 * @deprecated ICU 54. See {@link icu::LayoutEngine}
68 */
69typedef uint8_t le_uint8;
70
71
72/**
73 * A type used for boolean values.
74 *
75 * @deprecated ICU 54. See {@link icu::LayoutEngine}
76 */
77typedef UBool le_bool;
78
79#ifndef NULL
80/**
81 * Used to represent empty pointers.
82 *
83 * @deprecated ICU 54. See {@link icu::LayoutEngine}
84 */
85#define NULL 0
86#endif
87
88/**
89 * Used for four character tags.
90 *
91 * @deprecated ICU 54. See {@link icu::LayoutEngine}
92 */
93typedef le_uint32 LETag;
94
95/**
96 * Used for 16-bit glyph indices as they're represented
97 * in TrueType font tables.
98 *
99 * @deprecated ICU 54. See {@link icu::LayoutEngine}
100 */
101typedef le_uint16 TTGlyphID;
102
103/**
104 * Used for glyph indices. The low-order 16 bits are
105 * the glyph ID within the font. The next 8 bits are
106 * the sub-font ID within a compound font. The high-
107 * order 8 bits are client defined. The LayoutEngine
108 * will never change or look at the client defined bits.
109 *
110 * @deprecated ICU 54. See {@link icu::LayoutEngine}
111 */
112typedef le_uint32 LEGlyphID;
113
114/**
115 * Used to mask off the glyph ID part of an LEGlyphID.
116 *
117 * @see LEGlyphID
118 * @deprecated ICU 54. See {@link icu::LayoutEngine}
119 */
120#define LE_GLYPH_MASK     0x0000FFFF
121
122/**
123 * Used to shift the glyph ID part of an LEGlyphID
124 * into the low-order bits.
125 *
126 * @see LEGlyphID
127 * @deprecated ICU 54. See {@link icu::LayoutEngine}
128 */
129#define LE_GLYPH_SHIFT    0
130
131
132/**
133 * Used to mask off the sub-font ID part of an LEGlyphID.
134 *
135 * @see LEGlyphID
136 * @deprecated ICU 54. See {@link icu::LayoutEngine}
137 */
138#define LE_SUB_FONT_MASK  0x00FF0000
139
140/**
141 * Used to shift the sub-font ID part of an LEGlyphID
142 * into the low-order bits.
143 *
144 * @see LEGlyphID
145 * @deprecated ICU 54. See {@link icu::LayoutEngine}
146 */
147#define LE_SUB_FONT_SHIFT 16
148
149
150/**
151 * Used to mask off the client-defined part of an LEGlyphID.
152 *
153 * @see LEGlyphID
154 * @deprecated ICU 54. See {@link icu::LayoutEngine}
155 */
156#define LE_CLIENT_MASK    0xFF000000
157
158/**
159 * Used to shift the sub-font ID part of an LEGlyphID
160 * into the low-order bits.
161 *
162 * @see LEGlyphID
163 * @deprecated ICU 54. See {@link icu::LayoutEngine}
164 */
165#define LE_CLIENT_SHIFT   24
166
167
168/**
169 * A convenience macro to get the Glyph ID part of an LEGlyphID.
170 *
171 * @see LEGlyphID
172 * @deprecated ICU 54. See {@link icu::LayoutEngine}
173 */
174#define LE_GET_GLYPH(gid) ((gid & LE_GLYPH_MASK) >> LE_GLYPH_SHIFT)
175
176/**
177 * A convenience macro to get the sub-font ID part of an LEGlyphID.
178 *
179 * @see LEGlyphID
180 * @deprecated ICU 54. See {@link icu::LayoutEngine}
181 */
182#define LE_GET_SUB_FONT(gid) ((gid & LE_SUB_FONT_MASK) >> LE_SUB_FONT_SHIFT)
183
184/**
185 * A convenience macro to get the client-defined part of an LEGlyphID.
186 *
187 * @see LEGlyphID
188 * @deprecated ICU 54. See {@link icu::LayoutEngine}
189 */
190#define LE_GET_CLIENT(gid) ((gid & LE_CLIENT_MASK) >> LE_CLIENT_SHIFT)
191
192
193/**
194 * A convenience macro to set the Glyph ID part of an LEGlyphID.
195 *
196 * @see LEGlyphID
197 * @deprecated ICU 54. See {@link icu::LayoutEngine}
198 */
199#define LE_SET_GLYPH(gid, glyph) ((gid & ~LE_GLYPH_MASK) | ((glyph << LE_GLYPH_SHIFT) & LE_GLYPH_MASK))
200
201/**
202 * A convenience macro to set the sub-font ID part of an LEGlyphID.
203 *
204 * @see LEGlyphID
205 * @deprecated ICU 54. See {@link icu::LayoutEngine}
206 */
207#define LE_SET_SUB_FONT(gid, font) ((gid & ~LE_SUB_FONT_MASK) | ((font << LE_SUB_FONT_SHIFT) & LE_SUB_FONT_MASK))
208
209/**
210 * A convenience macro to set the client-defined part of an LEGlyphID.
211 *
212 * @see LEGlyphID
213 * @deprecated ICU 54. See {@link icu::LayoutEngine}
214 */
215#define LE_SET_CLIENT(gid, client) ((gid & ~LE_CLIENT_MASK) | ((client << LE_CLIENT_SHIFT) & LE_CLIENT_MASK))
216
217
218/**
219 * Used to represent 16-bit Unicode code points.
220 *
221 * @deprecated ICU 54. See {@link icu::LayoutEngine}
222 */
223typedef UChar LEUnicode16;
224
225/**
226 * Used to represent 32-bit Unicode code points.
227 *
228 * @deprecated ICU 54. See {@link icu::LayoutEngine}
229 */
230typedef UChar32 LEUnicode32;
231
232#ifndef U_HIDE_DEPRECATED_API
233/**
234 * Used to represent 16-bit Unicode code points.
235 *
236 * @deprecated ICU 54. See {@link icu::LayoutEngine}
237 */
238typedef UChar LEUnicode;
239#endif  /* U_HIDE_DEPRECATED_API */
240
241/**
242 * Used to hold a pair of (x, y) values which represent a point.
243 *
244 * @deprecated ICU 54. See {@link icu::LayoutEngine}
245 */
246struct LEPoint
247{
248    /**
249     * The x coordinate of the point.
250     *
251     * @deprecated ICU 54. See {@link icu::LayoutEngine}
252     */
253    float fX;
254
255    /**
256     * The y coordinate of the point.
257     *
258     * @deprecated ICU 54. See {@link icu::LayoutEngine}
259     */
260    float fY;
261};
262
263#ifndef __cplusplus
264/**
265 * Used to hold a pair of (x, y) values which represent a point.
266 *
267 * @deprecated ICU 54. See {@link icu::LayoutEngine}
268 */
269typedef struct LEPoint LEPoint;
270#endif
271
272
273#ifndef U_HIDE_INTERNAL_API
274
275/**
276 * \def
277 * @internal
278 */
279#ifndef LE_ASSERT_BAD_FONT
280#define LE_ASSERT_BAD_FONT 0
281#endif
282
283/**
284 * \def LE_DEBUG_BAD_FONT
285 * @internal
286 */
287#if LE_ASSERT_BAD_FONT
288#include <stdio.h>
289#define LE_DEBUG_BAD_FONT(x) fprintf(stderr,"%s:%d: BAD FONT: %s\n", __FILE__, __LINE__, (x));
290#else
291#define LE_DEBUG_BAD_FONT(x)
292#endif
293
294/**
295 * \def LE_UINTPTR_MAX
296 * Max value representable by a uintptr
297 */
298
299#ifndef UINT32_MAX
300#define LE_UINT32_MAX 0xFFFFFFFFU
301#else
302#define LE_UINT32_MAX UINT32_MAX
303#endif
304
305#ifndef UINTPTR_MAX
306#define LE_UINTPTR_MAX LE_UINT32_MAX
307#else
308#define LE_UINTPTR_MAX UINTPTR_MAX
309#endif
310
311/**
312 * Range check for overflow
313 */
314#define LE_RANGE_CHECK(type, count, ptrfn) (( (LE_UINTPTR_MAX / sizeof(type)) < (size_t)count ) ? NULL : (ptrfn))
315/**
316 * A convenience macro to get the length of an array.
317 *
318 * @internal
319 */
320#define LE_ARRAY_SIZE(array) (sizeof array / sizeof array[0])
321
322#ifdef LE_USE_CMEMORY
323/**
324 * A convenience macro for copying an array.
325 *
326 * @internal
327 */
328#define LE_ARRAY_COPY(dst, src, count) uprv_memcpy((void *) (dst), (void *) (src), (count) * sizeof (src)[0])
329
330/**
331 * Allocate an array of basic types. This is used to isolate the rest of
332 * the LayoutEngine code from cmemory.h.
333 *
334 * @internal
335 */
336#define LE_NEW_ARRAY(type, count) (type *)  LE_RANGE_CHECK(type,count,uprv_malloc((count) * sizeof(type)))
337
338/**
339 * Re-allocate an array of basic types. This is used to isolate the rest of
340 * the LayoutEngine code from cmemory.h.
341 *
342 * @internal
343 */
344#define LE_GROW_ARRAY(array, newSize) uprv_realloc((void *) (array), (newSize) * sizeof (array)[0])
345
346 /**
347 * Free an array of basic types. This is used to isolate the rest of
348 * the LayoutEngine code from cmemory.h.
349 *
350 * @internal
351 */
352#define LE_DELETE_ARRAY(array) uprv_free((void *) (array))
353#else
354
355/* Not using ICU memory - use C std lib versions */
356
357#include <stdlib.h>
358#include <string.h>
359
360/**
361 * A convenience macro to get the length of an array.
362 *
363 * @internal
364 */
365#define LE_ARRAY_SIZE(array) (sizeof array / sizeof array[0])
366
367/**
368 * A convenience macro for copying an array.
369 *
370 * @internal
371 */
372#define LE_ARRAY_COPY(dst, src, count) memcpy((void *) (dst), (void *) (src), (count) * sizeof (src)[0])
373
374/**
375 * Allocate an array of basic types. This is used to isolate the rest of
376 * the LayoutEngine code from cmemory.h.
377 *
378 * @internal
379 */
380#define LE_NEW_ARRAY(type, count) LE_RANGE_CHECK(type,count,(type *) malloc((count) * sizeof(type)))
381
382/**
383 * Re-allocate an array of basic types. This is used to isolate the rest of
384 * the LayoutEngine code from cmemory.h.
385 *
386 * @internal
387 */
388#define LE_GROW_ARRAY(array, newSize) realloc((void *) (array), (newSize) * sizeof (array)[0])
389
390 /**
391 * Free an array of basic types. This is used to isolate the rest of
392 * the LayoutEngine code from cmemory.h.
393 *
394 * @internal
395 */
396#define LE_DELETE_ARRAY(array) free((void *) (array))
397
398#endif
399#endif  /* U_HIDE_INTERNAL_API */
400
401/**
402 * A macro to construct the four-letter tags used to
403 * label TrueType tables, and for script, language and
404 * feature tags in OpenType tables.
405 *
406 * WARNING: THIS MACRO WILL ONLY WORK CORRECTLY IF
407 * THE ARGUMENT CHARACTERS ARE ASCII.
408 *
409 * @deprecated ICU 54. See {@link icu::LayoutEngine}
410 */
411#define LE_MAKE_TAG(a, b, c, d) \
412    (((le_uint32)(a) << 24) |   \
413     ((le_uint32)(b) << 16) |   \
414     ((le_uint32)(c) << 8)  |   \
415      (le_uint32)(d))
416
417/**
418 * This enumeration defines constants for the standard
419 * TrueType, OpenType and AAT table tags.
420 *
421 * @deprecated ICU 54. See {@link icu::LayoutEngine}
422 */
423enum LETableTags {
424    LE_ACNT_TABLE_TAG = 0x61636E74UL, /**< 'acnt' */
425    LE_AVAR_TABLE_TAG = 0x61766172UL, /**< 'avar' */
426    LE_BASE_TABLE_TAG = 0x42415345UL, /**< 'BASE' */
427    LE_BDAT_TABLE_TAG = 0x62646174UL, /**< 'bdat' */
428    LE_BHED_TABLE_TAG = 0x62686564UL, /**< 'bhed' */
429    LE_BLOC_TABLE_TAG = 0x626C6F63UL, /**< 'bloc' */
430    LE_BSLN_TABLE_TAG = 0x62736C6EUL, /**< 'bsln' */
431    LE_CFF__TABLE_TAG = 0x43464620UL, /**< 'CFF ' */
432    LE_CMAP_TABLE_TAG = 0x636D6170UL, /**< 'cmap' */
433    LE_CVAR_TABLE_TAG = 0x63766172UL, /**< 'cvar' */
434    LE_CVT__TABLE_TAG = 0x63767420UL, /**< 'cvt ' */
435    LE_DSIG_TABLE_TAG = 0x44534947UL, /**< 'DSIG' */
436    LE_EBDT_TABLE_TAG = 0x45424454UL, /**< 'EBDT' */
437    LE_EBLC_TABLE_TAG = 0x45424C43UL, /**< 'EBLC' */
438    LE_EBSC_TABLE_TAG = 0x45425343UL, /**< 'EBSC' */
439    LE_FDSC_TABLE_TAG = 0x66647363UL, /**< 'fdsc' */
440    LE_FEAT_TABLE_TAG = 0x66656174UL, /**< 'feat' */
441    LE_FMTX_TABLE_TAG = 0x666D7478UL, /**< 'fmtx' */
442    LE_FPGM_TABLE_TAG = 0x6670676DUL, /**< 'fpgm' */
443    LE_FVAR_TABLE_TAG = 0x66766172UL, /**< 'fvar' */
444    LE_GASP_TABLE_TAG = 0x67617370UL, /**< 'gasp' */
445    LE_GDEF_TABLE_TAG = 0x47444546UL, /**< 'GDEF' */
446    LE_GLYF_TABLE_TAG = 0x676C7966UL, /**< 'glyf' */
447    LE_GPOS_TABLE_TAG = 0x47504F53UL, /**< 'GPOS' */
448    LE_GSUB_TABLE_TAG = 0x47535542UL, /**< 'GSUB' */
449    LE_GVAR_TABLE_TAG = 0x67766172UL, /**< 'gvar' */
450    LE_HDMX_TABLE_TAG = 0x68646D78UL, /**< 'hdmx' */
451    LE_HEAD_TABLE_TAG = 0x68656164UL, /**< 'head' */
452    LE_HHEA_TABLE_TAG = 0x68686561UL, /**< 'hhea' */
453    LE_HMTX_TABLE_TAG = 0x686D7478UL, /**< 'hmtx' */
454    LE_HSTY_TABLE_TAG = 0x68737479UL, /**< 'hsty' */
455    LE_JUST_TABLE_TAG = 0x6A757374UL, /**< 'just' */
456    LE_JSTF_TABLE_TAG = 0x4A535446UL, /**< 'JSTF' */
457    LE_KERN_TABLE_TAG = 0x6B65726EUL, /**< 'kern' */
458    LE_LCAR_TABLE_TAG = 0x6C636172UL, /**< 'lcar' */
459    LE_LOCA_TABLE_TAG = 0x6C6F6361UL, /**< 'loca' */
460    LE_LTSH_TABLE_TAG = 0x4C545348UL, /**< 'LTSH' */
461    LE_MAXP_TABLE_TAG = 0x6D617870UL, /**< 'maxp' */
462    LE_MORT_TABLE_TAG = 0x6D6F7274UL, /**< 'mort' */
463    LE_MORX_TABLE_TAG = 0x6D6F7278UL, /**< 'morx' */
464    LE_NAME_TABLE_TAG = 0x6E616D65UL, /**< 'name' */
465    LE_OPBD_TABLE_TAG = 0x6F706264UL, /**< 'opbd' */
466    LE_OS_2_TABLE_TAG = 0x4F532F32UL, /**< 'OS/2' */
467    LE_PCLT_TABLE_TAG = 0x50434C54UL, /**< 'PCLT' */
468    LE_POST_TABLE_TAG = 0x706F7374UL, /**< 'post' */
469    LE_PREP_TABLE_TAG = 0x70726570UL, /**< 'prep' */
470    LE_PROP_TABLE_TAG = 0x70726F70UL, /**< 'prop' */
471    LE_TRAK_TABLE_TAG = 0x7472616BUL, /**< 'trak' */
472    LE_VDMX_TABLE_TAG = 0x56444D58UL, /**< 'VDMX' */
473    LE_VHEA_TABLE_TAG = 0x76686561UL, /**< 'vhea' */
474    LE_VMTX_TABLE_TAG = 0x766D7478UL, /**< 'vmtx' */
475    LE_VORG_TABLE_TAG = 0x564F5247UL, /**< 'VORG' */
476    LE_ZAPF_TABLE_TAG = 0x5A617066UL  /**< 'Zapf' */
477};
478
479/**
480 * This enumeration defines constants for all
481 * the common OpenType feature tags.
482 *
483 * @deprecated ICU 54. See {@link icu::LayoutEngine}
484 */
485enum LEFeatureTags {
486    LE_AALT_FEATURE_TAG = 0x61616C74UL, /**< 'aalt' */
487    LE_ABVF_FEATURE_TAG = 0x61627666UL, /**< 'abvf' */
488    LE_ABVM_FEATURE_TAG = 0x6162766DUL, /**< 'abvm' */
489    LE_ABVS_FEATURE_TAG = 0x61627673UL, /**< 'abvs' */
490    LE_AFRC_FEATURE_TAG = 0x61667263UL, /**< 'afrc' */
491    LE_AKHN_FEATURE_TAG = 0x616B686EUL, /**< 'akhn' */
492    LE_BLWF_FEATURE_TAG = 0x626C7766UL, /**< 'blwf' */
493    LE_BLWM_FEATURE_TAG = 0x626C776DUL, /**< 'blwm' */
494    LE_BLWS_FEATURE_TAG = 0x626C7773UL, /**< 'blws' */
495    LE_CALT_FEATURE_TAG = 0x63616C74UL, /**< 'calt' */
496    LE_CASE_FEATURE_TAG = 0x63617365UL, /**< 'case' */
497    LE_CCMP_FEATURE_TAG = 0x63636D70UL, /**< 'ccmp' */
498    LE_CJCT_FEATURE_TAG = 0x636A6374UL, /**< 'cjct' */
499    LE_CLIG_FEATURE_TAG = 0x636C6967UL, /**< 'clig' */
500    LE_CPSP_FEATURE_TAG = 0x63707370UL, /**< 'cpsp' */
501    LE_CSWH_FEATURE_TAG = 0x63737768UL, /**< 'cswh' */
502    LE_CURS_FEATURE_TAG = 0x63757273UL, /**< 'curs' */
503    LE_C2SC_FEATURE_TAG = 0x63327363UL, /**< 'c2sc' */
504    LE_C2PC_FEATURE_TAG = 0x63327063UL, /**< 'c2pc' */
505    LE_DIST_FEATURE_TAG = 0x64697374UL, /**< 'dist' */
506    LE_DLIG_FEATURE_TAG = 0x646C6967UL, /**< 'dlig' */
507    LE_DNOM_FEATURE_TAG = 0x646E6F6DUL, /**< 'dnom' */
508    LE_EXPT_FEATURE_TAG = 0x65787074UL, /**< 'expt' */
509    LE_FALT_FEATURE_TAG = 0x66616C74UL, /**< 'falt' */
510    LE_FIN2_FEATURE_TAG = 0x66696E32UL, /**< 'fin2' */
511    LE_FIN3_FEATURE_TAG = 0x66696E33UL, /**< 'fin3' */
512    LE_FINA_FEATURE_TAG = 0x66696E61UL, /**< 'fina' */
513    LE_FRAC_FEATURE_TAG = 0x66726163UL, /**< 'frac' */
514    LE_FWID_FEATURE_TAG = 0x66776964UL, /**< 'fwid' */
515    LE_HALF_FEATURE_TAG = 0x68616C66UL, /**< 'half' */
516    LE_HALN_FEATURE_TAG = 0x68616C6EUL, /**< 'haln' */
517    LE_HALT_FEATURE_TAG = 0x68616C74UL, /**< 'halt' */
518    LE_HIST_FEATURE_TAG = 0x68697374UL, /**< 'hist' */
519    LE_HKNA_FEATURE_TAG = 0x686B6E61UL, /**< 'hkna' */
520    LE_HLIG_FEATURE_TAG = 0x686C6967UL, /**< 'hlig' */
521    LE_HNGL_FEATURE_TAG = 0x686E676CUL, /**< 'hngl' */
522    LE_HWID_FEATURE_TAG = 0x68776964UL, /**< 'hwid' */
523    LE_INIT_FEATURE_TAG = 0x696E6974UL, /**< 'init' */
524    LE_ISOL_FEATURE_TAG = 0x69736F6CUL, /**< 'isol' */
525    LE_ITAL_FEATURE_TAG = 0x6974616CUL, /**< 'ital' */
526    LE_JALT_FEATURE_TAG = 0x6A616C74UL, /**< 'jalt' */
527    LE_JP78_FEATURE_TAG = 0x6A703738UL, /**< 'jp78' */
528    LE_JP83_FEATURE_TAG = 0x6A703833UL, /**< 'jp83' */
529    LE_JP90_FEATURE_TAG = 0x6A703930UL, /**< 'jp90' */
530    LE_KERN_FEATURE_TAG = 0x6B65726EUL, /**< 'kern' */
531    LE_LFBD_FEATURE_TAG = 0x6C666264UL, /**< 'lfbd' */
532    LE_LIGA_FEATURE_TAG = 0x6C696761UL, /**< 'liga' */
533    LE_LJMO_FEATURE_TAG = 0x6C6A6D6FUL, /**< 'ljmo' */
534    LE_LNUM_FEATURE_TAG = 0x6C6E756DUL, /**< 'lnum' */
535    LE_LOCL_FEATURE_TAG = 0x6C6F636CUL, /**< 'locl' */
536    LE_MARK_FEATURE_TAG = 0x6D61726BUL, /**< 'mark' */
537    LE_MED2_FEATURE_TAG = 0x6D656432UL, /**< 'med2' */
538    LE_MEDI_FEATURE_TAG = 0x6D656469UL, /**< 'medi' */
539    LE_MGRK_FEATURE_TAG = 0x6D67726BUL, /**< 'mgrk' */
540    LE_MKMK_FEATURE_TAG = 0x6D6B6D6BUL, /**< 'mkmk' */
541    LE_MSET_FEATURE_TAG = 0x6D736574UL, /**< 'mset' */
542    LE_NALT_FEATURE_TAG = 0x6E616C74UL, /**< 'nalt' */
543    LE_NLCK_FEATURE_TAG = 0x6E6C636BUL, /**< 'nlck' */
544    LE_NUKT_FEATURE_TAG = 0x6E756B74UL, /**< 'nukt' */
545    LE_NUMR_FEATURE_TAG = 0x6E756D72UL, /**< 'numr' */
546    LE_ONUM_FEATURE_TAG = 0x6F6E756DUL, /**< 'onum' */
547    LE_OPBD_FEATURE_TAG = 0x6F706264UL, /**< 'opbd' */
548    LE_ORDN_FEATURE_TAG = 0x6F72646EUL, /**< 'ordn' */
549    LE_ORNM_FEATURE_TAG = 0x6F726E6DUL, /**< 'ornm' */
550    LE_PALT_FEATURE_TAG = 0x70616C74UL, /**< 'palt' */
551    LE_PCAP_FEATURE_TAG = 0x70636170UL, /**< 'pcap' */
552    LE_PNUM_FEATURE_TAG = 0x706E756DUL, /**< 'pnum' */
553    LE_PREF_FEATURE_TAG = 0x70726566UL, /**< 'pref' */
554    LE_PRES_FEATURE_TAG = 0x70726573UL, /**< 'pres' */
555    LE_PSTF_FEATURE_TAG = 0x70737466UL, /**< 'pstf' */
556    LE_PSTS_FEATURE_TAG = 0x70737473UL, /**< 'psts' */
557    LE_PWID_FEATURE_TAG = 0x70776964UL, /**< 'pwid' */
558    LE_QWID_FEATURE_TAG = 0x71776964UL, /**< 'qwid' */
559    LE_RAND_FEATURE_TAG = 0x72616E64UL, /**< 'rand' */
560    LE_RLIG_FEATURE_TAG = 0x726C6967UL, /**< 'rlig' */
561    LE_RPHF_FEATURE_TAG = 0x72706866UL, /**< 'rphf' */
562    LE_RKRF_FEATURE_TAG = 0x726B7266UL, /**< 'rkrf' */
563    LE_RTBD_FEATURE_TAG = 0x72746264UL, /**< 'rtbd' */
564    LE_RTLA_FEATURE_TAG = 0x72746C61UL, /**< 'rtla' */
565    LE_RUBY_FEATURE_TAG = 0x72756279UL, /**< 'ruby' */
566    LE_SALT_FEATURE_TAG = 0x73616C74UL, /**< 'salt' */
567    LE_SINF_FEATURE_TAG = 0x73696E66UL, /**< 'sinf' */
568    LE_SIZE_FEATURE_TAG = 0x73697A65UL, /**< 'size' */
569    LE_SMCP_FEATURE_TAG = 0x736D6370UL, /**< 'smcp' */
570    LE_SMPL_FEATURE_TAG = 0x736D706CUL, /**< 'smpl' */
571    LE_SS01_FEATURE_TAG = 0x73733031UL, /**< 'ss01' */
572    LE_SS02_FEATURE_TAG = 0x73733032UL, /**< 'ss02' */
573    LE_SS03_FEATURE_TAG = 0x73733033UL, /**< 'ss03' */
574    LE_SS04_FEATURE_TAG = 0x73733034UL, /**< 'ss04' */
575    LE_SS05_FEATURE_TAG = 0x73733035UL, /**< 'ss05' */
576    LE_SS06_FEATURE_TAG = 0x73733036UL, /**< 'ss06' */
577    LE_SS07_FEATURE_TAG = 0x73733037UL, /**< 'ss07' */
578    LE_SS08_FEATURE_TAG = 0x73733038UL, /**< 'ss08' */
579    LE_SS09_FEATURE_TAG = 0x73733039UL, /**< 'ss09' */
580    LE_SS10_FEATURE_TAG = 0x73733130UL, /**< 'ss10' */
581    LE_SS11_FEATURE_TAG = 0x73733131UL, /**< 'ss11' */
582    LE_SS12_FEATURE_TAG = 0x73733132UL, /**< 'ss12' */
583    LE_SS13_FEATURE_TAG = 0x73733133UL, /**< 'ss13' */
584    LE_SS14_FEATURE_TAG = 0x73733134UL, /**< 'ss14' */
585    LE_SS15_FEATURE_TAG = 0x73733135UL, /**< 'ss15' */
586    LE_SS16_FEATURE_TAG = 0x73733136UL, /**< 'ss16' */
587    LE_SS17_FEATURE_TAG = 0x73733137UL, /**< 'ss17' */
588    LE_SS18_FEATURE_TAG = 0x73733138UL, /**< 'ss18' */
589    LE_SS19_FEATURE_TAG = 0x73733139UL, /**< 'ss19' */
590    LE_SS20_FEATURE_TAG = 0x73733230UL, /**< 'ss20' */
591    LE_SUBS_FEATURE_TAG = 0x73756273UL, /**< 'subs' */
592    LE_SUPS_FEATURE_TAG = 0x73757073UL, /**< 'sups' */
593    LE_SWSH_FEATURE_TAG = 0x73777368UL, /**< 'swsh' */
594    LE_TITL_FEATURE_TAG = 0x7469746CUL, /**< 'titl' */
595    LE_TJMO_FEATURE_TAG = 0x746A6D6FUL, /**< 'tjmo' */
596    LE_TNAM_FEATURE_TAG = 0x746E616DUL, /**< 'tnam' */
597    LE_TNUM_FEATURE_TAG = 0x746E756DUL, /**< 'tnum' */
598    LE_TRAD_FEATURE_TAG = 0x74726164UL, /**< 'trad' */
599    LE_TWID_FEATURE_TAG = 0x74776964UL, /**< 'twid' */
600    LE_UNIC_FEATURE_TAG = 0x756E6963UL, /**< 'unic' */
601    LE_VALT_FEATURE_TAG = 0x76616C74UL, /**< 'valt' */
602    LE_VATU_FEATURE_TAG = 0x76617475UL, /**< 'vatu' */
603    LE_VERT_FEATURE_TAG = 0x76657274UL, /**< 'vert' */
604    LE_VHAL_FEATURE_TAG = 0x7668616CUL, /**< 'vhal' */
605    LE_VJMO_FEATURE_TAG = 0x766A6D6FUL, /**< 'vjmo' */
606    LE_VKNA_FEATURE_TAG = 0x766B6E61UL, /**< 'vkna' */
607    LE_VKRN_FEATURE_TAG = 0x766B726EUL, /**< 'vkrn' */
608    LE_VPAL_FEATURE_TAG = 0x7670616CUL, /**< 'vpal' */
609    LE_VRT2_FEATURE_TAG = 0x76727432UL, /**< 'vrt2' */
610    LE_ZERO_FEATURE_TAG = 0x7A65726FUL  /**< 'zero' */
611};
612
613/**
614 * @internal
615 */
616enum LEFeatureENUMs {
617  LE_Kerning_FEATURE_ENUM = 0,   /**< Requests Kerning. Formerly LayoutEngine::kTypoFlagKern */
618  LE_Ligatures_FEATURE_ENUM = 1, /**< Requests Ligatures. Formerly LayoutEngine::kTypoFlagLiga */
619  LE_CLIG_FEATURE_ENUM,  /**< Feature specific enum */
620  LE_DLIG_FEATURE_ENUM,  /**< Feature specific enum */
621  LE_HLIG_FEATURE_ENUM,  /**< Feature specific enum */
622  LE_LIGA_FEATURE_ENUM,  /**< Feature specific enum */
623  LE_RLIG_FEATURE_ENUM,  /**< Feature specific enum */
624  LE_SMCP_FEATURE_ENUM,  /**< Feature specific enum */
625  LE_FRAC_FEATURE_ENUM,  /**< Feature specific enum */
626  LE_AFRC_FEATURE_ENUM,  /**< Feature specific enum */
627  LE_ZERO_FEATURE_ENUM,  /**< Feature specific enum */
628  LE_SWSH_FEATURE_ENUM,  /**< Feature specific enum */
629  LE_CSWH_FEATURE_ENUM,  /**< Feature specific enum */
630  LE_SALT_FEATURE_ENUM,  /**< Feature specific enum */
631  LE_NALT_FEATURE_ENUM,  /**< Feature specific enum */
632  LE_RUBY_FEATURE_ENUM,  /**< Feature specific enum */
633  LE_SS01_FEATURE_ENUM,  /**< Feature specific enum */
634  LE_SS02_FEATURE_ENUM,  /**< Feature specific enum */
635  LE_SS03_FEATURE_ENUM,  /**< Feature specific enum */
636  LE_SS04_FEATURE_ENUM,  /**< Feature specific enum */
637  LE_SS05_FEATURE_ENUM,  /**< Feature specific enum */
638  LE_SS06_FEATURE_ENUM,  /**< Feature specific enum */
639  LE_SS07_FEATURE_ENUM,   /**< Feature specific enum */
640
641  LE_CHAR_FILTER_FEATURE_ENUM = 31, /**< Apply CharSubstitutionFilter */
642  LE_FEATURE_ENUM_MAX = LE_CHAR_FILTER_FEATURE_ENUM
643};
644
645
646/**
647 * Flags for typographic features.
648 * @internal
649 * @{
650 */
651#define LE_Kerning_FEATURE_FLAG   (1 << LE_Kerning_FEATURE_ENUM)
652#define LE_Ligatures_FEATURE_FLAG (1 << LE_Ligatures_FEATURE_ENUM)
653#define LE_CLIG_FEATURE_FLAG (1 << LE_CLIG_FEATURE_ENUM)
654#define LE_DLIG_FEATURE_FLAG (1 << LE_DLIG_FEATURE_ENUM)
655#define LE_HLIG_FEATURE_FLAG (1 << LE_HLIG_FEATURE_ENUM)
656#define LE_LIGA_FEATURE_FLAG (1 << LE_LIGA_FEATURE_ENUM)
657#define LE_RLIG_FEATURE_FLAG (1 << LE_RLIG_FEATURE_ENUM)
658#define LE_SMCP_FEATURE_FLAG (1 << LE_SMCP_FEATURE_ENUM)
659#define LE_FRAC_FEATURE_FLAG (1 << LE_FRAC_FEATURE_ENUM)
660#define LE_AFRC_FEATURE_FLAG (1 << LE_AFRC_FEATURE_ENUM)
661#define LE_ZERO_FEATURE_FLAG (1 << LE_ZERO_FEATURE_ENUM)
662#define LE_SWSH_FEATURE_FLAG (1 << LE_SWSH_FEATURE_ENUM)
663#define LE_CSWH_FEATURE_FLAG (1 << LE_CSWH_FEATURE_ENUM)
664#define LE_SALT_FEATURE_FLAG (1 << LE_SALT_FEATURE_ENUM)
665#define LE_NALT_FEATURE_FLAG (1 << LE_NALT_FEATURE_ENUM)
666#define LE_RUBY_FEATURE_FLAG (1 << LE_RUBY_FEATURE_ENUM)
667#define LE_SS01_FEATURE_FLAG (1 << LE_SS01_FEATURE_ENUM)
668#define LE_SS02_FEATURE_FLAG (1 << LE_SS02_FEATURE_ENUM)
669#define LE_SS03_FEATURE_FLAG (1 << LE_SS03_FEATURE_ENUM)
670#define LE_SS04_FEATURE_FLAG (1 << LE_SS04_FEATURE_ENUM)
671#define LE_SS05_FEATURE_FLAG (1 << LE_SS05_FEATURE_ENUM)
672#define LE_SS06_FEATURE_FLAG (1 << LE_SS06_FEATURE_ENUM)
673#define LE_SS07_FEATURE_FLAG (1 << LE_SS07_FEATURE_ENUM)
674
675#define LE_CHAR_FILTER_FEATURE_FLAG (1 << LE_CHAR_FILTER_FEATURE_ENUM)
676/**
677 * @}
678 */
679
680#define LE_DEFAULT_FEATURE_FLAG (LE_Kerning_FEATURE_FLAG | LE_Ligatures_FEATURE_FLAG) /**< default features */
681
682/**
683 * Error codes returned by the LayoutEngine.
684 *
685 * @deprecated ICU 54. See {@link icu::LayoutEngine}
686 */
687enum LEErrorCode {
688    /* informational */
689    LE_NO_SUBFONT_WARNING          = U_USING_DEFAULT_WARNING, /**< The font does not contain subfonts. */
690
691    /* success */
692    LE_NO_ERROR                     = U_ZERO_ERROR, /**< No error, no warning. */
693
694    /* failures */
695    LE_ILLEGAL_ARGUMENT_ERROR       = U_ILLEGAL_ARGUMENT_ERROR,  /**< An illegal argument was detected. */
696    LE_MEMORY_ALLOCATION_ERROR      = U_MEMORY_ALLOCATION_ERROR, /**< Memory allocation error. */
697    LE_INDEX_OUT_OF_BOUNDS_ERROR    = U_INDEX_OUTOFBOUNDS_ERROR, /**< Trying to access an index that is out of bounds. */
698    LE_NO_LAYOUT_ERROR              = U_UNSUPPORTED_ERROR,       /**< You must call layoutChars() first. */
699    LE_INTERNAL_ERROR               = U_INTERNAL_PROGRAM_ERROR,  /**< An internal error was encountered. */
700    LE_FONT_FILE_NOT_FOUND_ERROR    = U_FILE_ACCESS_ERROR,       /**< The requested font file cannot be opened. */
701    LE_MISSING_FONT_TABLE_ERROR     = U_MISSING_RESOURCE_ERROR   /**< The requested font table does not exist. */
702};
703
704#ifndef __cplusplus
705/**
706 * Error codes returned by the LayoutEngine.
707 *
708 * @deprecated ICU 54. See {@link icu::LayoutEngine}
709 */
710typedef enum LEErrorCode LEErrorCode;
711#endif
712
713/**
714 * A convenience macro to test for the success of a LayoutEngine call.
715 *
716 * @deprecated ICU 54. See {@link icu::LayoutEngine}
717 */
718#define LE_SUCCESS(code) (U_SUCCESS((UErrorCode)code))
719
720/**
721 * A convenience macro to test for the failure of a LayoutEngine call.
722 *
723 * @deprecated ICU 54. See {@link icu::LayoutEngine}
724 */
725#define LE_FAILURE(code) (U_FAILURE((UErrorCode)code))
726
727
728#endif
729