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