1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 **********************************************************************
5 *   Copyright (C) 1996-2016, International Business Machines
6 *   Corporation and others.  All Rights Reserved.
7 **********************************************************************
8 *
9 *  FILE NAME : UTYPES.H (formerly ptypes.h)
10 *
11 *   Date        Name        Description
12 *   12/11/96    helena      Creation.
13 *   02/27/97    aliu        Added typedefs for UClassID, int8, int16, int32,
14 *                           uint8, uint16, and uint32.
15 *   04/01/97    aliu        Added XP_CPLUSPLUS and modified to work under C as
16 *                            well as C++.
17 *                           Modified to use memcpy() for uprv_arrayCopy() fns.
18 *   04/14/97    aliu        Added TPlatformUtilities.
19 *   05/07/97    aliu        Added import/export specifiers (replacing the old
20 *                           broken EXT_CLASS).  Added version number for our
21 *                           code.  Cleaned up header.
22 *    6/20/97    helena      Java class name change.
23 *   08/11/98    stephen     UErrorCode changed from typedef to enum
24 *   08/12/98    erm         Changed T_ANALYTIC_PACKAGE_VERSION to 3
25 *   08/14/98    stephen     Added uprv_arrayCopy() for int8_t, int16_t, int32_t
26 *   12/09/98    jfitz       Added BUFFER_OVERFLOW_ERROR (bug 1100066)
27 *   04/20/99    stephen     Cleaned up & reworked for autoconf.
28 *                           Renamed to utypes.h.
29 *   05/05/99    stephen     Changed to use <inttypes.h>
30 *   12/07/99    helena      Moved copyright notice string from ucnv_bld.h here.
31 *******************************************************************************
32 */
33 
34 #ifndef UTYPES_H
35 #define UTYPES_H
36 
37 
38 #include "unicode/umachine.h"
39 #include "unicode/uversion.h"
40 #include "unicode/uconfig.h"
41 #include <float.h>
42 
43 #if !U_NO_DEFAULT_INCLUDE_UTF_HEADERS
44 #   include "unicode/utf.h"
45 #endif
46 
47 /*!
48  * \file
49  * \brief Basic definitions for ICU, for both C and C++ APIs
50  *
51  * This file defines basic types, constants, and enumerations directly or
52  * indirectly by including other header files, especially utf.h for the
53  * basic character and string definitions and umachine.h for consistent
54  * integer and other types.
55  */
56 
57 
58 /**
59  * \def U_SHOW_CPLUSPLUS_API
60  * @internal
61  */
62 #ifdef __cplusplus
63 #   ifndef U_SHOW_CPLUSPLUS_API
64 #       define U_SHOW_CPLUSPLUS_API 1
65 #   endif
66 #else
67 #   undef U_SHOW_CPLUSPLUS_API
68 #   define U_SHOW_CPLUSPLUS_API 0
69 #endif
70 
71 /** @{ API visibility control */
72 
73 /**
74  * \def U_HIDE_DRAFT_API
75  * Define this to 1 to request that draft API be "hidden"
76  * @internal
77  */
78 /**
79  * \def U_HIDE_INTERNAL_API
80  * Define this to 1 to request that internal API be "hidden"
81  * @internal
82  */
83 #if !U_DEFAULT_SHOW_DRAFT && !defined(U_SHOW_DRAFT_API)
84 #define U_HIDE_DRAFT_API 1
85 #endif
86 #if !U_DEFAULT_SHOW_DRAFT && !defined(U_SHOW_INTERNAL_API)
87 #define U_HIDE_INTERNAL_API 1
88 #endif
89 
90 /** @} */
91 
92 /*===========================================================================*/
93 /* ICUDATA naming scheme                                                     */
94 /*===========================================================================*/
95 
96 /**
97  * \def U_ICUDATA_TYPE_LETTER
98  *
99  * This is a platform-dependent string containing one letter:
100  * - b for big-endian, ASCII-family platforms
101  * - l for little-endian, ASCII-family platforms
102  * - e for big-endian, EBCDIC-family platforms
103  * This letter is part of the common data file name.
104  * @stable ICU 2.0
105  */
106 
107 /**
108  * \def U_ICUDATA_TYPE_LITLETTER
109  * The non-string form of U_ICUDATA_TYPE_LETTER
110  * @stable ICU 2.0
111  */
112 #if U_CHARSET_FAMILY
113 #   if U_IS_BIG_ENDIAN
114    /* EBCDIC - should always be BE */
115 #     define U_ICUDATA_TYPE_LETTER "e"
116 #     define U_ICUDATA_TYPE_LITLETTER e
117 #   else
118 #     error "Don't know what to do with little endian EBCDIC!"
119 #     define U_ICUDATA_TYPE_LETTER "x"
120 #     define U_ICUDATA_TYPE_LITLETTER x
121 #   endif
122 #else
123 #   if U_IS_BIG_ENDIAN
124       /* Big-endian ASCII */
125 #     define U_ICUDATA_TYPE_LETTER "b"
126 #     define U_ICUDATA_TYPE_LITLETTER b
127 #   else
128       /* Little-endian ASCII */
129 #     define U_ICUDATA_TYPE_LETTER "l"
130 #     define U_ICUDATA_TYPE_LITLETTER l
131 #   endif
132 #endif
133 
134 /**
135  * A single string literal containing the icudata stub name. i.e. 'icudt18e' for
136  * ICU 1.8.x on EBCDIC, etc..
137  * @stable ICU 2.0
138  */
139 #define U_ICUDATA_NAME    "icudt" U_ICU_VERSION_SHORT U_ICUDATA_TYPE_LETTER
140 #ifndef U_HIDE_INTERNAL_API
141 #define U_USRDATA_NAME    "usrdt" U_ICU_VERSION_SHORT U_ICUDATA_TYPE_LETTER  /**< @internal */
142 #define U_USE_USRDATA     0  /**< @internal */
143 #endif  /* U_HIDE_INTERNAL_API */
144 
145 /**
146  *  U_ICU_ENTRY_POINT is the name of the DLL entry point to the ICU data library.
147  *    Defined as a literal, not a string.
148  *    Tricky Preprocessor use - ## operator replaces macro parameters with the literal string
149  *                              from the corresponding macro invocation, _before_ other macro substitutions.
150  *                              Need a nested \#defines to get the actual version numbers rather than
151  *                              the literal text U_ICU_VERSION_MAJOR_NUM into the name.
152  *                              The net result will be something of the form
153  *                                  \#define U_ICU_ENTRY_POINT icudt19_dat
154  * @stable ICU 2.4
155  */
156 #define U_ICUDATA_ENTRY_POINT  U_DEF2_ICUDATA_ENTRY_POINT(U_ICU_VERSION_MAJOR_NUM,U_LIB_SUFFIX_C_NAME)
157 
158 #ifndef U_HIDE_INTERNAL_API
159 /**
160  * Do not use. Note that it's OK for the 2nd argument to be undefined (literal).
161  * @internal
162  */
163 #define U_DEF2_ICUDATA_ENTRY_POINT(major,suff) U_DEF_ICUDATA_ENTRY_POINT(major,suff)
164 
165 /**
166  * Do not use.
167  * @internal
168  */
169 #ifndef U_DEF_ICUDATA_ENTRY_POINT
170 /* affected by symbol renaming. See platform.h */
171 #ifndef U_LIB_SUFFIX_C_NAME
172 #define U_DEF_ICUDATA_ENTRY_POINT(major, suff) icudt##major##_dat
173 #else
174 #define U_DEF_ICUDATA_ENTRY_POINT(major, suff) icudt##suff ## major##_dat
175 #endif
176 #endif
177 #endif  /* U_HIDE_INTERNAL_API */
178 
179 /**
180  * \def NULL
181  * Define NULL if necessary, to nullptr for C++ and to ((void *)0) for C.
182  * @stable ICU 2.0
183  */
184 #ifndef NULL
185 #ifdef __cplusplus
186 #define NULL    nullptr
187 #else
188 #define NULL    ((void *)0)
189 #endif
190 #endif
191 
192 /*===========================================================================*/
193 /* Calendar/TimeZone data types                                              */
194 /*===========================================================================*/
195 
196 /**
197  * Date and Time data type.
198  * This is a primitive data type that holds the date and time
199  * as the number of milliseconds since 1970-jan-01, 00:00 UTC.
200  * UTC leap seconds are ignored.
201  * @stable ICU 2.0
202  */
203 typedef double UDate;
204 
205 /** The number of milliseconds per second @stable ICU 2.0 */
206 #define U_MILLIS_PER_SECOND        (1000)
207 /** The number of milliseconds per minute @stable ICU 2.0 */
208 #define U_MILLIS_PER_MINUTE       (60000)
209 /** The number of milliseconds per hour @stable ICU 2.0 */
210 #define U_MILLIS_PER_HOUR       (3600000)
211 /** The number of milliseconds per day @stable ICU 2.0 */
212 #define U_MILLIS_PER_DAY       (86400000)
213 
214 /**
215  * Maximum UDate value
216  * @stable ICU 4.8
217  */
218 #define U_DATE_MAX DBL_MAX
219 
220 /**
221  * Minimum UDate value
222  * @stable ICU 4.8
223  */
224 #define U_DATE_MIN -U_DATE_MAX
225 
226 /*===========================================================================*/
227 /* Shared library/DLL import-export API control                              */
228 /*===========================================================================*/
229 
230 /*
231  * Control of symbol import/export.
232  * ICU is separated into three libraries.
233  */
234 
235 /**
236  * \def U_COMBINED_IMPLEMENTATION
237  * Set to export library symbols from inside the ICU library
238  * when all of ICU is in a single library.
239  * This can be set as a compiler option while building ICU, and it
240  * needs to be the first one tested to override U_COMMON_API, U_I18N_API, etc.
241  * @stable ICU 2.0
242  */
243 
244 /**
245  * \def U_DATA_API
246  * Set to export library symbols from inside the stubdata library,
247  * and to import them from outside.
248  * @stable ICU 3.0
249  */
250 
251 /**
252  * \def U_COMMON_API
253  * Set to export library symbols from inside the common library,
254  * and to import them from outside.
255  * @stable ICU 2.0
256  */
257 
258 /**
259  * \def U_I18N_API
260  * Set to export library symbols from inside the i18n library,
261  * and to import them from outside.
262  * @stable ICU 2.0
263  */
264 
265 /**
266  * \def U_LAYOUT_API
267  * Set to export library symbols from inside the layout engine library,
268  * and to import them from outside.
269  * @stable ICU 2.0
270  */
271 
272 /**
273  * \def U_LAYOUTEX_API
274  * Set to export library symbols from inside the layout extensions library,
275  * and to import them from outside.
276  * @stable ICU 2.6
277  */
278 
279 /**
280  * \def U_IO_API
281  * Set to export library symbols from inside the ustdio library,
282  * and to import them from outside.
283  * @stable ICU 2.0
284  */
285 
286 /**
287  * \def U_TOOLUTIL_API
288  * Set to export library symbols from inside the toolutil library,
289  * and to import them from outside.
290  * @stable ICU 3.4
291  */
292 
293 #ifdef U_IN_DOXYGEN
294 // This definition is required when generating the API docs.
295 #define U_COMBINED_IMPLEMENTATION 1
296 #endif
297 
298 #if defined(U_COMBINED_IMPLEMENTATION)
299 #define U_DATA_API     U_EXPORT
300 #define U_COMMON_API   U_EXPORT
301 #define U_I18N_API     U_EXPORT
302 #define U_LAYOUT_API   U_EXPORT
303 #define U_LAYOUTEX_API U_EXPORT
304 #define U_IO_API       U_EXPORT
305 #define U_TOOLUTIL_API U_EXPORT
306 #elif defined(U_STATIC_IMPLEMENTATION)
307 #define U_DATA_API
308 #define U_COMMON_API
309 #define U_I18N_API
310 #define U_LAYOUT_API
311 #define U_LAYOUTEX_API
312 #define U_IO_API
313 #define U_TOOLUTIL_API
314 #elif defined(U_COMMON_IMPLEMENTATION)
315 #define U_DATA_API     U_IMPORT
316 #define U_COMMON_API   U_EXPORT
317 #define U_I18N_API     U_IMPORT
318 #define U_LAYOUT_API   U_IMPORT
319 #define U_LAYOUTEX_API U_IMPORT
320 #define U_IO_API       U_IMPORT
321 #define U_TOOLUTIL_API U_IMPORT
322 #elif defined(U_I18N_IMPLEMENTATION)
323 #define U_DATA_API     U_IMPORT
324 #define U_COMMON_API   U_IMPORT
325 #define U_I18N_API     U_EXPORT
326 #define U_LAYOUT_API   U_IMPORT
327 #define U_LAYOUTEX_API U_IMPORT
328 #define U_IO_API       U_IMPORT
329 #define U_TOOLUTIL_API U_IMPORT
330 #elif defined(U_LAYOUT_IMPLEMENTATION)
331 #define U_DATA_API     U_IMPORT
332 #define U_COMMON_API   U_IMPORT
333 #define U_I18N_API     U_IMPORT
334 #define U_LAYOUT_API   U_EXPORT
335 #define U_LAYOUTEX_API U_IMPORT
336 #define U_IO_API       U_IMPORT
337 #define U_TOOLUTIL_API U_IMPORT
338 #elif defined(U_LAYOUTEX_IMPLEMENTATION)
339 #define U_DATA_API     U_IMPORT
340 #define U_COMMON_API   U_IMPORT
341 #define U_I18N_API     U_IMPORT
342 #define U_LAYOUT_API   U_IMPORT
343 #define U_LAYOUTEX_API U_EXPORT
344 #define U_IO_API       U_IMPORT
345 #define U_TOOLUTIL_API U_IMPORT
346 #elif defined(U_IO_IMPLEMENTATION)
347 #define U_DATA_API     U_IMPORT
348 #define U_COMMON_API   U_IMPORT
349 #define U_I18N_API     U_IMPORT
350 #define U_LAYOUT_API   U_IMPORT
351 #define U_LAYOUTEX_API U_IMPORT
352 #define U_IO_API       U_EXPORT
353 #define U_TOOLUTIL_API U_IMPORT
354 #elif defined(U_TOOLUTIL_IMPLEMENTATION)
355 #define U_DATA_API     U_IMPORT
356 #define U_COMMON_API   U_IMPORT
357 #define U_I18N_API     U_IMPORT
358 #define U_LAYOUT_API   U_IMPORT
359 #define U_LAYOUTEX_API U_IMPORT
360 #define U_IO_API       U_IMPORT
361 #define U_TOOLUTIL_API U_EXPORT
362 #else
363 #define U_DATA_API     U_IMPORT
364 #define U_COMMON_API   U_IMPORT
365 #define U_I18N_API     U_IMPORT
366 #define U_LAYOUT_API   U_IMPORT
367 #define U_LAYOUTEX_API U_IMPORT
368 #define U_IO_API       U_IMPORT
369 #define U_TOOLUTIL_API U_IMPORT
370 #endif
371 
372 /**
373  * \def U_STANDARD_CPP_NAMESPACE
374  * Control of C++ Namespace
375  * @stable ICU 2.0
376  */
377 #ifdef __cplusplus
378 #define U_STANDARD_CPP_NAMESPACE        ::
379 #else
380 #define U_STANDARD_CPP_NAMESPACE
381 #endif
382 
383 /*===========================================================================*/
384 /* UErrorCode */
385 /*===========================================================================*/
386 
387 /**
388  * Standard ICU4C error code type, a substitute for exceptions.
389  *
390  * Initialize the UErrorCode with U_ZERO_ERROR, and check for success or
391  * failure using U_SUCCESS() or U_FAILURE():
392  *
393  *     UErrorCode errorCode = U_ZERO_ERROR;
394  *     // call ICU API that needs an error code parameter.
395  *     if (U_FAILURE(errorCode)) {
396  *         // An error occurred. Handle it here.
397  *     }
398  *
399  * C++ code should use icu::ErrorCode, available in unicode/errorcode.h, or a
400  * suitable subclass.
401  *
402  * For more information, see:
403  * http://icu-project.org/userguide/conventions
404  *
405  * Note: By convention, ICU functions that take a reference (C++) or a pointer
406  * (C) to a UErrorCode first test:
407  *
408  *     if (U_FAILURE(errorCode)) { return immediately; }
409  *
410  * so that in a chain of such functions the first one that sets an error code
411  * causes the following ones to not perform any operations.
412  *
413  * @stable ICU 2.0
414  */
415 typedef enum UErrorCode {
416     /* The ordering of U_ERROR_INFO_START Vs U_USING_FALLBACK_WARNING looks weird
417      * and is that way because VC++ debugger displays first encountered constant,
418      * which is not the what the code is used for
419      */
420 
421     U_USING_FALLBACK_WARNING  = -128,   /**< A resource bundle lookup returned a fallback result (not an error) */
422 
423     U_ERROR_WARNING_START     = -128,   /**< Start of information results (semantically successful) */
424 
425     U_USING_DEFAULT_WARNING   = -127,   /**< A resource bundle lookup returned a result from the root locale (not an error) */
426 
427     U_SAFECLONE_ALLOCATED_WARNING = -126, /**< A SafeClone operation required allocating memory (informational only) */
428 
429     U_STATE_OLD_WARNING       = -125,   /**< ICU has to use compatibility layer to construct the service. Expect performance/memory usage degradation. Consider upgrading */
430 
431     U_STRING_NOT_TERMINATED_WARNING = -124,/**< An output string could not be NUL-terminated because output length==destCapacity. */
432 
433     U_SORT_KEY_TOO_SHORT_WARNING = -123, /**< Number of levels requested in getBound is higher than the number of levels in the sort key */
434 
435     U_AMBIGUOUS_ALIAS_WARNING = -122,   /**< This converter alias can go to different converter implementations */
436 
437     U_DIFFERENT_UCA_VERSION = -121,     /**< ucol_open encountered a mismatch between UCA version and collator image version, so the collator was constructed from rules. No impact to further function */
438 
439     U_PLUGIN_CHANGED_LEVEL_WARNING = -120, /**< A plugin caused a level change. May not be an error, but later plugins may not load. */
440 
441 #ifndef U_HIDE_DEPRECATED_API
442     /**
443      * One more than the highest normal UErrorCode warning value.
444      * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
445      */
446     U_ERROR_WARNING_LIMIT,
447 #endif  // U_HIDE_DEPRECATED_API
448 
449     U_ZERO_ERROR              =  0,     /**< No error, no warning. */
450 
451     U_ILLEGAL_ARGUMENT_ERROR  =  1,     /**< Start of codes indicating failure */
452     U_MISSING_RESOURCE_ERROR  =  2,     /**< The requested resource cannot be found */
453     U_INVALID_FORMAT_ERROR    =  3,     /**< Data format is not what is expected */
454     U_FILE_ACCESS_ERROR       =  4,     /**< The requested file cannot be found */
455     U_INTERNAL_PROGRAM_ERROR  =  5,     /**< Indicates a bug in the library code */
456     U_MESSAGE_PARSE_ERROR     =  6,     /**< Unable to parse a message (message format) */
457     U_MEMORY_ALLOCATION_ERROR =  7,     /**< Memory allocation error */
458     U_INDEX_OUTOFBOUNDS_ERROR =  8,     /**< Trying to access the index that is out of bounds */
459     U_PARSE_ERROR             =  9,     /**< Equivalent to Java ParseException */
460     U_INVALID_CHAR_FOUND      = 10,     /**< Character conversion: Unmappable input sequence. In other APIs: Invalid character. */
461     U_TRUNCATED_CHAR_FOUND    = 11,     /**< Character conversion: Incomplete input sequence. */
462     U_ILLEGAL_CHAR_FOUND      = 12,     /**< Character conversion: Illegal input sequence/combination of input units. */
463     U_INVALID_TABLE_FORMAT    = 13,     /**< Conversion table file found, but corrupted */
464     U_INVALID_TABLE_FILE      = 14,     /**< Conversion table file not found */
465     U_BUFFER_OVERFLOW_ERROR   = 15,     /**< A result would not fit in the supplied buffer */
466     U_UNSUPPORTED_ERROR       = 16,     /**< Requested operation not supported in current context */
467     U_RESOURCE_TYPE_MISMATCH  = 17,     /**< an operation is requested over a resource that does not support it */
468     U_ILLEGAL_ESCAPE_SEQUENCE = 18,     /**< ISO-2022 illegal escape sequence */
469     U_UNSUPPORTED_ESCAPE_SEQUENCE = 19, /**< ISO-2022 unsupported escape sequence */
470     U_NO_SPACE_AVAILABLE      = 20,     /**< No space available for in-buffer expansion for Arabic shaping */
471     U_CE_NOT_FOUND_ERROR      = 21,     /**< Currently used only while setting variable top, but can be used generally */
472     U_PRIMARY_TOO_LONG_ERROR  = 22,     /**< User tried to set variable top to a primary that is longer than two bytes */
473     U_STATE_TOO_OLD_ERROR     = 23,     /**< ICU cannot construct a service from this state, as it is no longer supported */
474     U_TOO_MANY_ALIASES_ERROR  = 24,     /**< There are too many aliases in the path to the requested resource.
475                                              It is very possible that a circular alias definition has occurred */
476     U_ENUM_OUT_OF_SYNC_ERROR  = 25,     /**< UEnumeration out of sync with underlying collection */
477     U_INVARIANT_CONVERSION_ERROR = 26,  /**< Unable to convert a UChar* string to char* with the invariant converter. */
478     U_INVALID_STATE_ERROR     = 27,     /**< Requested operation can not be completed with ICU in its current state */
479     U_COLLATOR_VERSION_MISMATCH = 28,   /**< Collator version is not compatible with the base version */
480     U_USELESS_COLLATOR_ERROR  = 29,     /**< Collator is options only and no base is specified */
481     U_NO_WRITE_PERMISSION     = 30,     /**< Attempt to modify read-only or constant data. */
482 #ifndef U_HIDE_DRAFT_API
483     /**
484      * The input is impractically long for an operation.
485      * It is rejected because it may lead to problems such as excessive
486      * processing time, stack depth, or heap memory requirements.
487      *
488      * @draft ICU 68
489      */
490     U_INPUT_TOO_LONG_ERROR = 31,
491 #endif  // U_HIDE_DRAFT_API
492 
493 #ifndef U_HIDE_DEPRECATED_API
494     /**
495      * One more than the highest standard error code.
496      * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
497      */
498     U_STANDARD_ERROR_LIMIT = 32,
499 #endif  // U_HIDE_DEPRECATED_API
500 
501     /*
502      * Error codes in the range 0x10000 0x10100 are reserved for Transliterator.
503      */
504     U_BAD_VARIABLE_DEFINITION=0x10000,/**< Missing '$' or duplicate variable name */
505     U_PARSE_ERROR_START = 0x10000,    /**< Start of Transliterator errors */
506     U_MALFORMED_RULE,                 /**< Elements of a rule are misplaced */
507     U_MALFORMED_SET,                  /**< A UnicodeSet pattern is invalid*/
508     U_MALFORMED_SYMBOL_REFERENCE,     /**< UNUSED as of ICU 2.4 */
509     U_MALFORMED_UNICODE_ESCAPE,       /**< A Unicode escape pattern is invalid*/
510     U_MALFORMED_VARIABLE_DEFINITION,  /**< A variable definition is invalid */
511     U_MALFORMED_VARIABLE_REFERENCE,   /**< A variable reference is invalid */
512     U_MISMATCHED_SEGMENT_DELIMITERS,  /**< UNUSED as of ICU 2.4 */
513     U_MISPLACED_ANCHOR_START,         /**< A start anchor appears at an illegal position */
514     U_MISPLACED_CURSOR_OFFSET,        /**< A cursor offset occurs at an illegal position */
515     U_MISPLACED_QUANTIFIER,           /**< A quantifier appears after a segment close delimiter */
516     U_MISSING_OPERATOR,               /**< A rule contains no operator */
517     U_MISSING_SEGMENT_CLOSE,          /**< UNUSED as of ICU 2.4 */
518     U_MULTIPLE_ANTE_CONTEXTS,         /**< More than one ante context */
519     U_MULTIPLE_CURSORS,               /**< More than one cursor */
520     U_MULTIPLE_POST_CONTEXTS,         /**< More than one post context */
521     U_TRAILING_BACKSLASH,             /**< A dangling backslash */
522     U_UNDEFINED_SEGMENT_REFERENCE,    /**< A segment reference does not correspond to a defined segment */
523     U_UNDEFINED_VARIABLE,             /**< A variable reference does not correspond to a defined variable */
524     U_UNQUOTED_SPECIAL,               /**< A special character was not quoted or escaped */
525     U_UNTERMINATED_QUOTE,             /**< A closing single quote is missing */
526     U_RULE_MASK_ERROR,                /**< A rule is hidden by an earlier more general rule */
527     U_MISPLACED_COMPOUND_FILTER,      /**< A compound filter is in an invalid location */
528     U_MULTIPLE_COMPOUND_FILTERS,      /**< More than one compound filter */
529     U_INVALID_RBT_SYNTAX,             /**< A "::id" rule was passed to the RuleBasedTransliterator parser */
530     U_INVALID_PROPERTY_PATTERN,       /**< UNUSED as of ICU 2.4 */
531     U_MALFORMED_PRAGMA,               /**< A 'use' pragma is invalid */
532     U_UNCLOSED_SEGMENT,               /**< A closing ')' is missing */
533     U_ILLEGAL_CHAR_IN_SEGMENT,        /**< UNUSED as of ICU 2.4 */
534     U_VARIABLE_RANGE_EXHAUSTED,       /**< Too many stand-ins generated for the given variable range */
535     U_VARIABLE_RANGE_OVERLAP,         /**< The variable range overlaps characters used in rules */
536     U_ILLEGAL_CHARACTER,              /**< A special character is outside its allowed context */
537     U_INTERNAL_TRANSLITERATOR_ERROR,  /**< Internal transliterator system error */
538     U_INVALID_ID,                     /**< A "::id" rule specifies an unknown transliterator */
539     U_INVALID_FUNCTION,               /**< A "&fn()" rule specifies an unknown transliterator */
540 #ifndef U_HIDE_DEPRECATED_API
541     /**
542      * One more than the highest normal Transliterator error code.
543      * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
544      */
545     U_PARSE_ERROR_LIMIT,
546 #endif  // U_HIDE_DEPRECATED_API
547 
548     /*
549      * Error codes in the range 0x10100 0x10200 are reserved for the formatting API.
550      */
551     U_UNEXPECTED_TOKEN=0x10100,       /**< Syntax error in format pattern */
552     U_FMT_PARSE_ERROR_START=0x10100,  /**< Start of format library errors */
553     U_MULTIPLE_DECIMAL_SEPARATORS,    /**< More than one decimal separator in number pattern */
554     U_MULTIPLE_DECIMAL_SEPERATORS = U_MULTIPLE_DECIMAL_SEPARATORS, /**< Typo: kept for backward compatibility. Use U_MULTIPLE_DECIMAL_SEPARATORS */
555     U_MULTIPLE_EXPONENTIAL_SYMBOLS,   /**< More than one exponent symbol in number pattern */
556     U_MALFORMED_EXPONENTIAL_PATTERN,  /**< Grouping symbol in exponent pattern */
557     U_MULTIPLE_PERCENT_SYMBOLS,       /**< More than one percent symbol in number pattern */
558     U_MULTIPLE_PERMILL_SYMBOLS,       /**< More than one permill symbol in number pattern */
559     U_MULTIPLE_PAD_SPECIFIERS,        /**< More than one pad symbol in number pattern */
560     U_PATTERN_SYNTAX_ERROR,           /**< Syntax error in format pattern */
561     U_ILLEGAL_PAD_POSITION,           /**< Pad symbol misplaced in number pattern */
562     U_UNMATCHED_BRACES,               /**< Braces do not match in message pattern */
563     U_UNSUPPORTED_PROPERTY,           /**< UNUSED as of ICU 2.4 */
564     U_UNSUPPORTED_ATTRIBUTE,          /**< UNUSED as of ICU 2.4 */
565     U_ARGUMENT_TYPE_MISMATCH,         /**< Argument name and argument index mismatch in MessageFormat functions */
566     U_DUPLICATE_KEYWORD,              /**< Duplicate keyword in PluralFormat */
567     U_UNDEFINED_KEYWORD,              /**< Undefined Plural keyword */
568     U_DEFAULT_KEYWORD_MISSING,        /**< Missing DEFAULT rule in plural rules */
569     U_DECIMAL_NUMBER_SYNTAX_ERROR,    /**< Decimal number syntax error */
570     U_FORMAT_INEXACT_ERROR,           /**< Cannot format a number exactly and rounding mode is ROUND_UNNECESSARY @stable ICU 4.8 */
571     U_NUMBER_ARG_OUTOFBOUNDS_ERROR,   /**< The argument to a NumberFormatter helper method was out of bounds; the bounds are usually 0 to 999. @stable ICU 61 */
572     U_NUMBER_SKELETON_SYNTAX_ERROR,   /**< The number skeleton passed to C++ NumberFormatter or C UNumberFormatter was invalid or contained a syntax error. @stable ICU 62 */
573 #ifndef U_HIDE_DEPRECATED_API
574     /**
575      * One more than the highest normal formatting API error code.
576      * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
577      */
578     U_FMT_PARSE_ERROR_LIMIT = 0x10114,
579 #endif  // U_HIDE_DEPRECATED_API
580 
581     /*
582      * Error codes in the range 0x10200 0x102ff are reserved for BreakIterator.
583      */
584     U_BRK_INTERNAL_ERROR=0x10200,          /**< An internal error (bug) was detected.             */
585     U_BRK_ERROR_START=0x10200,             /**< Start of codes indicating Break Iterator failures */
586     U_BRK_HEX_DIGITS_EXPECTED,             /**< Hex digits expected as part of a escaped char in a rule. */
587     U_BRK_SEMICOLON_EXPECTED,              /**< Missing ';' at the end of a RBBI rule.            */
588     U_BRK_RULE_SYNTAX,                     /**< Syntax error in RBBI rule.                        */
589     U_BRK_UNCLOSED_SET,                    /**< UnicodeSet writing an RBBI rule missing a closing ']'. */
590     U_BRK_ASSIGN_ERROR,                    /**< Syntax error in RBBI rule assignment statement.   */
591     U_BRK_VARIABLE_REDFINITION,            /**< RBBI rule $Variable redefined.                    */
592     U_BRK_MISMATCHED_PAREN,                /**< Mis-matched parentheses in an RBBI rule.          */
593     U_BRK_NEW_LINE_IN_QUOTED_STRING,       /**< Missing closing quote in an RBBI rule.            */
594     U_BRK_UNDEFINED_VARIABLE,              /**< Use of an undefined $Variable in an RBBI rule.    */
595     U_BRK_INIT_ERROR,                      /**< Initialization failure.  Probable missing ICU Data. */
596     U_BRK_RULE_EMPTY_SET,                  /**< Rule contains an empty Unicode Set.               */
597     U_BRK_UNRECOGNIZED_OPTION,             /**< !!option in RBBI rules not recognized.            */
598     U_BRK_MALFORMED_RULE_TAG,              /**< The {nnn} tag on a rule is malformed              */
599 #ifndef U_HIDE_DEPRECATED_API
600     /**
601      * One more than the highest normal BreakIterator error code.
602      * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
603      */
604     U_BRK_ERROR_LIMIT,
605 #endif  // U_HIDE_DEPRECATED_API
606 
607     /*
608      * Error codes in the range 0x10300-0x103ff are reserved for regular expression related errors.
609      */
610     U_REGEX_INTERNAL_ERROR=0x10300,       /**< An internal error (bug) was detected.              */
611     U_REGEX_ERROR_START=0x10300,          /**< Start of codes indicating Regexp failures          */
612     U_REGEX_RULE_SYNTAX,                  /**< Syntax error in regexp pattern.                    */
613     U_REGEX_INVALID_STATE,                /**< RegexMatcher in invalid state for requested operation */
614     U_REGEX_BAD_ESCAPE_SEQUENCE,          /**< Unrecognized backslash escape sequence in pattern  */
615     U_REGEX_PROPERTY_SYNTAX,              /**< Incorrect Unicode property                         */
616     U_REGEX_UNIMPLEMENTED,                /**< Use of regexp feature that is not yet implemented. */
617     U_REGEX_MISMATCHED_PAREN,             /**< Incorrectly nested parentheses in regexp pattern.  */
618     U_REGEX_NUMBER_TOO_BIG,               /**< Decimal number is too large.                       */
619     U_REGEX_BAD_INTERVAL,                 /**< Error in {min,max} interval                        */
620     U_REGEX_MAX_LT_MIN,                   /**< In {min,max}, max is less than min.                */
621     U_REGEX_INVALID_BACK_REF,             /**< Back-reference to a non-existent capture group.    */
622     U_REGEX_INVALID_FLAG,                 /**< Invalid value for match mode flags.                */
623     U_REGEX_LOOK_BEHIND_LIMIT,            /**< Look-Behind pattern matches must have a bounded maximum length.    */
624     U_REGEX_SET_CONTAINS_STRING,          /**< Regexps cannot have UnicodeSets containing strings.*/
625 #ifndef U_HIDE_DEPRECATED_API
626     U_REGEX_OCTAL_TOO_BIG,                /**< Octal character constants must be <= 0377. @deprecated ICU 54. This error cannot occur. */
627 #endif  /* U_HIDE_DEPRECATED_API */
628     U_REGEX_MISSING_CLOSE_BRACKET=U_REGEX_SET_CONTAINS_STRING+2, /**< Missing closing bracket on a bracket expression. */
629     U_REGEX_INVALID_RANGE,                /**< In a character range [x-y], x is greater than y.   */
630     U_REGEX_STACK_OVERFLOW,               /**< Regular expression backtrack stack overflow.       */
631     U_REGEX_TIME_OUT,                     /**< Maximum allowed match time exceeded                */
632     U_REGEX_STOPPED_BY_CALLER,            /**< Matching operation aborted by user callback fn.    */
633     U_REGEX_PATTERN_TOO_BIG,              /**< Pattern exceeds limits on size or complexity. @stable ICU 55 */
634     U_REGEX_INVALID_CAPTURE_GROUP_NAME,   /**< Invalid capture group name. @stable ICU 55 */
635 #ifndef U_HIDE_DEPRECATED_API
636     /**
637      * One more than the highest normal regular expression error code.
638      * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
639      */
640     U_REGEX_ERROR_LIMIT=U_REGEX_STOPPED_BY_CALLER+3,
641 #endif  // U_HIDE_DEPRECATED_API
642 
643     /*
644      * Error codes in the range 0x10400-0x104ff are reserved for IDNA related error codes.
645      */
646     U_IDNA_PROHIBITED_ERROR=0x10400,
647     U_IDNA_ERROR_START=0x10400,
648     U_IDNA_UNASSIGNED_ERROR,
649     U_IDNA_CHECK_BIDI_ERROR,
650     U_IDNA_STD3_ASCII_RULES_ERROR,
651     U_IDNA_ACE_PREFIX_ERROR,
652     U_IDNA_VERIFICATION_ERROR,
653     U_IDNA_LABEL_TOO_LONG_ERROR,
654     U_IDNA_ZERO_LENGTH_LABEL_ERROR,
655     U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR,
656 #ifndef U_HIDE_DEPRECATED_API
657     /**
658      * One more than the highest normal IDNA error code.
659      * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
660      */
661     U_IDNA_ERROR_LIMIT,
662 #endif  // U_HIDE_DEPRECATED_API
663     /*
664      * Aliases for StringPrep
665      */
666     U_STRINGPREP_PROHIBITED_ERROR = U_IDNA_PROHIBITED_ERROR,
667     U_STRINGPREP_UNASSIGNED_ERROR = U_IDNA_UNASSIGNED_ERROR,
668     U_STRINGPREP_CHECK_BIDI_ERROR = U_IDNA_CHECK_BIDI_ERROR,
669 
670     /*
671      * Error codes in the range 0x10500-0x105ff are reserved for Plugin related error codes.
672      */
673     U_PLUGIN_ERROR_START=0x10500,         /**< Start of codes indicating plugin failures */
674     U_PLUGIN_TOO_HIGH=0x10500,            /**< The plugin's level is too high to be loaded right now. */
675     U_PLUGIN_DIDNT_SET_LEVEL,             /**< The plugin didn't call uplug_setPlugLevel in response to a QUERY */
676 #ifndef U_HIDE_DEPRECATED_API
677     /**
678      * One more than the highest normal plug-in error code.
679      * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
680      */
681     U_PLUGIN_ERROR_LIMIT,
682 #endif  // U_HIDE_DEPRECATED_API
683 
684 #ifndef U_HIDE_DEPRECATED_API
685     /**
686      * One more than the highest normal error code.
687      * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
688      */
689     U_ERROR_LIMIT=U_PLUGIN_ERROR_LIMIT
690 #endif  // U_HIDE_DEPRECATED_API
691 } UErrorCode;
692 
693 /* Use the following to determine if an UErrorCode represents */
694 /* operational success or failure. */
695 
696 #ifdef __cplusplus
697     /**
698      * Does the error code indicate success?
699      * @stable ICU 2.0
700      */
701     static
U_SUCCESS(UErrorCode code)702     inline UBool U_SUCCESS(UErrorCode code) { return (UBool)(code<=U_ZERO_ERROR); }
703     /**
704      * Does the error code indicate a failure?
705      * @stable ICU 2.0
706      */
707     static
U_FAILURE(UErrorCode code)708     inline UBool U_FAILURE(UErrorCode code) { return (UBool)(code>U_ZERO_ERROR); }
709 #else
710     /**
711      * Does the error code indicate success?
712      * @stable ICU 2.0
713      */
714 #   define U_SUCCESS(x) ((x)<=U_ZERO_ERROR)
715     /**
716      * Does the error code indicate a failure?
717      * @stable ICU 2.0
718      */
719 #   define U_FAILURE(x) ((x)>U_ZERO_ERROR)
720 #endif
721 
722 /**
723  * Return a string for a UErrorCode value.
724  * The string will be the same as the name of the error code constant
725  * in the UErrorCode enum above.
726  * @stable ICU 2.0
727  */
728 U_CAPI const char * U_EXPORT2
729 u_errorName(UErrorCode code);
730 
731 
732 #endif /* _UTYPES */
733