1 // Copyright (C) 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
4 **********************************************************************
5 * Copyright (C) 1996-2016, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 **********************************************************************
9 * FILE NAME : UTYPES.H (formerly ptypes.h)
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
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 *******************************************************************************
38 #include "unicode/umachine.h"
39 #include "unicode/uversion.h"
40 #include "unicode/uconfig.h"
43 #if !U_NO_DEFAULT_INCLUDE_UTF_HEADERS
44 # include "unicode/utf.h"
49 * \brief Basic definitions for ICU, for both C and C++ APIs
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.
59 * \def U_SHOW_CPLUSPLUS_API
63 # ifndef U_SHOW_CPLUSPLUS_API
64 # define U_SHOW_CPLUSPLUS_API 1
67 # undef U_SHOW_CPLUSPLUS_API
68 # define U_SHOW_CPLUSPLUS_API 0
71 /** @{ API visibility control */
74 * \def U_HIDE_DRAFT_API
75 * Define this to 1 to request that draft API be "hidden"
79 * \def U_HIDE_INTERNAL_API
80 * Define this to 1 to request that internal API be "hidden"
83 #if !U_DEFAULT_SHOW_DRAFT && !defined(U_SHOW_DRAFT_API)
84 #define U_HIDE_DRAFT_API 1
86 #if !U_DEFAULT_SHOW_DRAFT && !defined(U_SHOW_INTERNAL_API)
87 #define U_HIDE_INTERNAL_API 1
92 /*===========================================================================*/
93 /* ICUDATA naming scheme */
94 /*===========================================================================*/
97 * \def U_ICUDATA_TYPE_LETTER
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.
108 * \def U_ICUDATA_TYPE_LITLETTER
109 * The non-string form of U_ICUDATA_TYPE_LETTER
114 /* EBCDIC - should always be BE */
115 # define U_ICUDATA_TYPE_LETTER "e"
116 # define U_ICUDATA_TYPE_LITLETTER e
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
124 /* Big-endian ASCII */
125 # define U_ICUDATA_TYPE_LETTER "b"
126 # define U_ICUDATA_TYPE_LITLETTER b
128 /* Little-endian ASCII */
129 # define U_ICUDATA_TYPE_LETTER "l"
130 # define U_ICUDATA_TYPE_LITLETTER l
135 * A single string literal containing the icudata stub name. i.e. 'icudt18e' for
136 * ICU 1.8.x on EBCDIC, etc..
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 */
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 paramters 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
156 #define U_ICUDATA_ENTRY_POINT U_DEF2_ICUDATA_ENTRY_POINT(U_ICU_VERSION_MAJOR_NUM,U_LIB_SUFFIX_C_NAME)
158 #ifndef U_HIDE_INTERNAL_API
160 * Do not use. Note that it's OK for the 2nd argument to be undefined (literal).
163 #define U_DEF2_ICUDATA_ENTRY_POINT(major,suff) U_DEF_ICUDATA_ENTRY_POINT(major,suff)
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
174 #define U_DEF_ICUDATA_ENTRY_POINT(major, suff) icudt##suff ## major##_dat
177 #endif /* U_HIDE_INTERNAL_API */
181 * Define NULL if necessary, to 0 for C++ and to ((void *)0) for C.
188 #define NULL ((void *)0)
192 /*===========================================================================*/
193 /* Calendar/TimeZone data types */
194 /*===========================================================================*/
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.
203 typedef double UDate;
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)
215 * Maximum UDate value
218 #define U_DATE_MAX DBL_MAX
221 * Minimum UDate value
224 #define U_DATE_MIN -U_DATE_MAX
226 /*===========================================================================*/
227 /* Shared library/DLL import-export API control */
228 /*===========================================================================*/
231 * Control of symbol import/export.
232 * ICU is separated into three libraries.
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.
246 * Set to export library symbols from inside the stubdata library,
247 * and to import them from outside.
253 * Set to export library symbols from inside the common library,
254 * and to import them from outside.
260 * Set to export library symbols from inside the i18n library,
261 * and to import them from outside.
267 * Set to export library symbols from inside the layout engine library,
268 * and to import them from outside.
273 * \def U_LAYOUTEX_API
274 * Set to export library symbols from inside the layout extensions library,
275 * and to import them from outside.
281 * Set to export library symbols from inside the ustdio library,
282 * and to import them from outside.
287 * \def U_TOOLUTIL_API
288 * Set to export library symbols from inside the toolutil library,
289 * and to import them from outside.
293 #if defined(U_COMBINED_IMPLEMENTATION)
294 #define U_DATA_API U_EXPORT
295 #define U_COMMON_API U_EXPORT
296 #define U_I18N_API U_EXPORT
297 #define U_LAYOUT_API U_EXPORT
298 #define U_LAYOUTEX_API U_EXPORT
299 #define U_IO_API U_EXPORT
300 #define U_TOOLUTIL_API U_EXPORT
301 #elif defined(U_STATIC_IMPLEMENTATION)
306 #define U_LAYOUTEX_API
308 #define U_TOOLUTIL_API
309 #elif defined(U_COMMON_IMPLEMENTATION)
310 #define U_DATA_API U_IMPORT
311 #define U_COMMON_API U_EXPORT
312 #define U_I18N_API U_IMPORT
313 #define U_LAYOUT_API U_IMPORT
314 #define U_LAYOUTEX_API U_IMPORT
315 #define U_IO_API U_IMPORT
316 #define U_TOOLUTIL_API U_IMPORT
317 #elif defined(U_I18N_IMPLEMENTATION)
318 #define U_DATA_API U_IMPORT
319 #define U_COMMON_API U_IMPORT
320 #define U_I18N_API U_EXPORT
321 #define U_LAYOUT_API U_IMPORT
322 #define U_LAYOUTEX_API U_IMPORT
323 #define U_IO_API U_IMPORT
324 #define U_TOOLUTIL_API U_IMPORT
325 #elif defined(U_LAYOUT_IMPLEMENTATION)
326 #define U_DATA_API U_IMPORT
327 #define U_COMMON_API U_IMPORT
328 #define U_I18N_API U_IMPORT
329 #define U_LAYOUT_API U_EXPORT
330 #define U_LAYOUTEX_API U_IMPORT
331 #define U_IO_API U_IMPORT
332 #define U_TOOLUTIL_API U_IMPORT
333 #elif defined(U_LAYOUTEX_IMPLEMENTATION)
334 #define U_DATA_API U_IMPORT
335 #define U_COMMON_API U_IMPORT
336 #define U_I18N_API U_IMPORT
337 #define U_LAYOUT_API U_IMPORT
338 #define U_LAYOUTEX_API U_EXPORT
339 #define U_IO_API U_IMPORT
340 #define U_TOOLUTIL_API U_IMPORT
341 #elif defined(U_IO_IMPLEMENTATION)
342 #define U_DATA_API U_IMPORT
343 #define U_COMMON_API U_IMPORT
344 #define U_I18N_API U_IMPORT
345 #define U_LAYOUT_API U_IMPORT
346 #define U_LAYOUTEX_API U_IMPORT
347 #define U_IO_API U_EXPORT
348 #define U_TOOLUTIL_API U_IMPORT
349 #elif defined(U_TOOLUTIL_IMPLEMENTATION)
350 #define U_DATA_API U_IMPORT
351 #define U_COMMON_API U_IMPORT
352 #define U_I18N_API U_IMPORT
353 #define U_LAYOUT_API U_IMPORT
354 #define U_LAYOUTEX_API U_IMPORT
355 #define U_IO_API U_IMPORT
356 #define U_TOOLUTIL_API U_EXPORT
358 #define U_DATA_API U_IMPORT
359 #define U_COMMON_API U_IMPORT
360 #define U_I18N_API U_IMPORT
361 #define U_LAYOUT_API U_IMPORT
362 #define U_LAYOUTEX_API U_IMPORT
363 #define U_IO_API U_IMPORT
364 #define U_TOOLUTIL_API U_IMPORT
368 * \def U_STANDARD_CPP_NAMESPACE
369 * Control of C++ Namespace
373 #define U_STANDARD_CPP_NAMESPACE ::
375 #define U_STANDARD_CPP_NAMESPACE
378 /*===========================================================================*/
380 /*===========================================================================*/
383 * Error code to replace exception handling, so that the code is compatible with all C++ compilers,
384 * and to use the same mechanism for C and C++.
387 * ICU functions that take a reference (C++) or a pointer (C) to a UErrorCode
388 * first test if(U_FAILURE(errorCode)) { return immediately; }
389 * so that in a chain of such functions the first one that sets an error code
390 * causes the following ones to not perform any operations.
393 * Error codes should be tested using U_FAILURE() and U_SUCCESS().
396 typedef enum UErrorCode {
397 /* The ordering of U_ERROR_INFO_START Vs U_USING_FALLBACK_WARNING looks weird
398 * and is that way because VC++ debugger displays first encountered constant,
399 * which is not the what the code is used for
402 U_USING_FALLBACK_WARNING = -128, /**< A resource bundle lookup returned a fallback result (not an error) */
404 U_ERROR_WARNING_START = -128, /**< Start of information results (semantically successful) */
406 U_USING_DEFAULT_WARNING = -127, /**< A resource bundle lookup returned a result from the root locale (not an error) */
408 U_SAFECLONE_ALLOCATED_WARNING = -126, /**< A SafeClone operation required allocating memory (informational only) */
410 U_STATE_OLD_WARNING = -125, /**< ICU has to use compatibility layer to construct the service. Expect performance/memory usage degradation. Consider upgrading */
412 U_STRING_NOT_TERMINATED_WARNING = -124,/**< An output string could not be NUL-terminated because output length==destCapacity. */
414 U_SORT_KEY_TOO_SHORT_WARNING = -123, /**< Number of levels requested in getBound is higher than the number of levels in the sort key */
416 U_AMBIGUOUS_ALIAS_WARNING = -122, /**< This converter alias can go to different converter implementations */
418 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 */
420 U_PLUGIN_CHANGED_LEVEL_WARNING = -120, /**< A plugin caused a level change. May not be an error, but later plugins may not load. */
422 #ifndef U_HIDE_DEPRECATED_API
424 * One more than the highest normal UErrorCode warning value.
425 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
427 U_ERROR_WARNING_LIMIT,
428 #endif // U_HIDE_DEPRECATED_API
430 U_ZERO_ERROR = 0, /**< No error, no warning. */
432 U_ILLEGAL_ARGUMENT_ERROR = 1, /**< Start of codes indicating failure */
433 U_MISSING_RESOURCE_ERROR = 2, /**< The requested resource cannot be found */
434 U_INVALID_FORMAT_ERROR = 3, /**< Data format is not what is expected */
435 U_FILE_ACCESS_ERROR = 4, /**< The requested file cannot be found */
436 U_INTERNAL_PROGRAM_ERROR = 5, /**< Indicates a bug in the library code */
437 U_MESSAGE_PARSE_ERROR = 6, /**< Unable to parse a message (message format) */
438 U_MEMORY_ALLOCATION_ERROR = 7, /**< Memory allocation error */
439 U_INDEX_OUTOFBOUNDS_ERROR = 8, /**< Trying to access the index that is out of bounds */
440 U_PARSE_ERROR = 9, /**< Equivalent to Java ParseException */
441 U_INVALID_CHAR_FOUND = 10, /**< Character conversion: Unmappable input sequence. In other APIs: Invalid character. */
442 U_TRUNCATED_CHAR_FOUND = 11, /**< Character conversion: Incomplete input sequence. */
443 U_ILLEGAL_CHAR_FOUND = 12, /**< Character conversion: Illegal input sequence/combination of input units. */
444 U_INVALID_TABLE_FORMAT = 13, /**< Conversion table file found, but corrupted */
445 U_INVALID_TABLE_FILE = 14, /**< Conversion table file not found */
446 U_BUFFER_OVERFLOW_ERROR = 15, /**< A result would not fit in the supplied buffer */
447 U_UNSUPPORTED_ERROR = 16, /**< Requested operation not supported in current context */
448 U_RESOURCE_TYPE_MISMATCH = 17, /**< an operation is requested over a resource that does not support it */
449 U_ILLEGAL_ESCAPE_SEQUENCE = 18, /**< ISO-2022 illlegal escape sequence */
450 U_UNSUPPORTED_ESCAPE_SEQUENCE = 19, /**< ISO-2022 unsupported escape sequence */
451 U_NO_SPACE_AVAILABLE = 20, /**< No space available for in-buffer expansion for Arabic shaping */
452 U_CE_NOT_FOUND_ERROR = 21, /**< Currently used only while setting variable top, but can be used generally */
453 U_PRIMARY_TOO_LONG_ERROR = 22, /**< User tried to set variable top to a primary that is longer than two bytes */
454 U_STATE_TOO_OLD_ERROR = 23, /**< ICU cannot construct a service from this state, as it is no longer supported */
455 U_TOO_MANY_ALIASES_ERROR = 24, /**< There are too many aliases in the path to the requested resource.
456 It is very possible that a circular alias definition has occured */
457 U_ENUM_OUT_OF_SYNC_ERROR = 25, /**< UEnumeration out of sync with underlying collection */
458 U_INVARIANT_CONVERSION_ERROR = 26, /**< Unable to convert a UChar* string to char* with the invariant converter. */
459 U_INVALID_STATE_ERROR = 27, /**< Requested operation can not be completed with ICU in its current state */
460 U_COLLATOR_VERSION_MISMATCH = 28, /**< Collator version is not compatible with the base version */
461 U_USELESS_COLLATOR_ERROR = 29, /**< Collator is options only and no base is specified */
462 U_NO_WRITE_PERMISSION = 30, /**< Attempt to modify read-only or constant data. */
464 #ifndef U_HIDE_DEPRECATED_API
466 * One more than the highest standard error code.
467 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
469 U_STANDARD_ERROR_LIMIT,
470 #endif // U_HIDE_DEPRECATED_API
473 * Error codes in the range 0x10000 0x10100 are reserved for Transliterator.
475 U_BAD_VARIABLE_DEFINITION=0x10000,/**< Missing '$' or duplicate variable name */
476 U_PARSE_ERROR_START = 0x10000, /**< Start of Transliterator errors */
477 U_MALFORMED_RULE, /**< Elements of a rule are misplaced */
478 U_MALFORMED_SET, /**< A UnicodeSet pattern is invalid*/
479 U_MALFORMED_SYMBOL_REFERENCE, /**< UNUSED as of ICU 2.4 */
480 U_MALFORMED_UNICODE_ESCAPE, /**< A Unicode escape pattern is invalid*/
481 U_MALFORMED_VARIABLE_DEFINITION, /**< A variable definition is invalid */
482 U_MALFORMED_VARIABLE_REFERENCE, /**< A variable reference is invalid */
483 U_MISMATCHED_SEGMENT_DELIMITERS, /**< UNUSED as of ICU 2.4 */
484 U_MISPLACED_ANCHOR_START, /**< A start anchor appears at an illegal position */
485 U_MISPLACED_CURSOR_OFFSET, /**< A cursor offset occurs at an illegal position */
486 U_MISPLACED_QUANTIFIER, /**< A quantifier appears after a segment close delimiter */
487 U_MISSING_OPERATOR, /**< A rule contains no operator */
488 U_MISSING_SEGMENT_CLOSE, /**< UNUSED as of ICU 2.4 */
489 U_MULTIPLE_ANTE_CONTEXTS, /**< More than one ante context */
490 U_MULTIPLE_CURSORS, /**< More than one cursor */
491 U_MULTIPLE_POST_CONTEXTS, /**< More than one post context */
492 U_TRAILING_BACKSLASH, /**< A dangling backslash */
493 U_UNDEFINED_SEGMENT_REFERENCE, /**< A segment reference does not correspond to a defined segment */
494 U_UNDEFINED_VARIABLE, /**< A variable reference does not correspond to a defined variable */
495 U_UNQUOTED_SPECIAL, /**< A special character was not quoted or escaped */
496 U_UNTERMINATED_QUOTE, /**< A closing single quote is missing */
497 U_RULE_MASK_ERROR, /**< A rule is hidden by an earlier more general rule */
498 U_MISPLACED_COMPOUND_FILTER, /**< A compound filter is in an invalid location */
499 U_MULTIPLE_COMPOUND_FILTERS, /**< More than one compound filter */
500 U_INVALID_RBT_SYNTAX, /**< A "::id" rule was passed to the RuleBasedTransliterator parser */
501 U_INVALID_PROPERTY_PATTERN, /**< UNUSED as of ICU 2.4 */
502 U_MALFORMED_PRAGMA, /**< A 'use' pragma is invlalid */
503 U_UNCLOSED_SEGMENT, /**< A closing ')' is missing */
504 U_ILLEGAL_CHAR_IN_SEGMENT, /**< UNUSED as of ICU 2.4 */
505 U_VARIABLE_RANGE_EXHAUSTED, /**< Too many stand-ins generated for the given variable range */
506 U_VARIABLE_RANGE_OVERLAP, /**< The variable range overlaps characters used in rules */
507 U_ILLEGAL_CHARACTER, /**< A special character is outside its allowed context */
508 U_INTERNAL_TRANSLITERATOR_ERROR, /**< Internal transliterator system error */
509 U_INVALID_ID, /**< A "::id" rule specifies an unknown transliterator */
510 U_INVALID_FUNCTION, /**< A "&fn()" rule specifies an unknown transliterator */
511 #ifndef U_HIDE_DEPRECATED_API
513 * One more than the highest normal Transliterator error code.
514 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
517 #endif // U_HIDE_DEPRECATED_API
520 * Error codes in the range 0x10100 0x10200 are reserved for the formatting API.
522 U_UNEXPECTED_TOKEN=0x10100, /**< Syntax error in format pattern */
523 U_FMT_PARSE_ERROR_START=0x10100, /**< Start of format library errors */
524 U_MULTIPLE_DECIMAL_SEPARATORS, /**< More than one decimal separator in number pattern */
525 U_MULTIPLE_DECIMAL_SEPERATORS = U_MULTIPLE_DECIMAL_SEPARATORS, /**< Typo: kept for backward compatibility. Use U_MULTIPLE_DECIMAL_SEPARATORS */
526 U_MULTIPLE_EXPONENTIAL_SYMBOLS, /**< More than one exponent symbol in number pattern */
527 U_MALFORMED_EXPONENTIAL_PATTERN, /**< Grouping symbol in exponent pattern */
528 U_MULTIPLE_PERCENT_SYMBOLS, /**< More than one percent symbol in number pattern */
529 U_MULTIPLE_PERMILL_SYMBOLS, /**< More than one permill symbol in number pattern */
530 U_MULTIPLE_PAD_SPECIFIERS, /**< More than one pad symbol in number pattern */
531 U_PATTERN_SYNTAX_ERROR, /**< Syntax error in format pattern */
532 U_ILLEGAL_PAD_POSITION, /**< Pad symbol misplaced in number pattern */
533 U_UNMATCHED_BRACES, /**< Braces do not match in message pattern */
534 U_UNSUPPORTED_PROPERTY, /**< UNUSED as of ICU 2.4 */
535 U_UNSUPPORTED_ATTRIBUTE, /**< UNUSED as of ICU 2.4 */
536 U_ARGUMENT_TYPE_MISMATCH, /**< Argument name and argument index mismatch in MessageFormat functions */
537 U_DUPLICATE_KEYWORD, /**< Duplicate keyword in PluralFormat */
538 U_UNDEFINED_KEYWORD, /**< Undefined Plural keyword */
539 U_DEFAULT_KEYWORD_MISSING, /**< Missing DEFAULT rule in plural rules */
540 U_DECIMAL_NUMBER_SYNTAX_ERROR, /**< Decimal number syntax error */
541 U_FORMAT_INEXACT_ERROR, /**< Cannot format a number exactly and rounding mode is ROUND_UNNECESSARY @stable ICU 4.8 */
542 #ifndef U_HIDE_DEPRECATED_API
544 * One more than the highest normal formatting API error code.
545 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
547 U_FMT_PARSE_ERROR_LIMIT,
548 #endif // U_HIDE_DEPRECATED_API
551 * Error codes in the range 0x10200 0x102ff are reserved for BreakIterator.
553 U_BRK_INTERNAL_ERROR=0x10200, /**< An internal error (bug) was detected. */
554 U_BRK_ERROR_START=0x10200, /**< Start of codes indicating Break Iterator failures */
555 U_BRK_HEX_DIGITS_EXPECTED, /**< Hex digits expected as part of a escaped char in a rule. */
556 U_BRK_SEMICOLON_EXPECTED, /**< Missing ';' at the end of a RBBI rule. */
557 U_BRK_RULE_SYNTAX, /**< Syntax error in RBBI rule. */
558 U_BRK_UNCLOSED_SET, /**< UnicodeSet witing an RBBI rule missing a closing ']'. */
559 U_BRK_ASSIGN_ERROR, /**< Syntax error in RBBI rule assignment statement. */
560 U_BRK_VARIABLE_REDFINITION, /**< RBBI rule $Variable redefined. */
561 U_BRK_MISMATCHED_PAREN, /**< Mis-matched parentheses in an RBBI rule. */
562 U_BRK_NEW_LINE_IN_QUOTED_STRING, /**< Missing closing quote in an RBBI rule. */
563 U_BRK_UNDEFINED_VARIABLE, /**< Use of an undefined $Variable in an RBBI rule. */
564 U_BRK_INIT_ERROR, /**< Initialization failure. Probable missing ICU Data. */
565 U_BRK_RULE_EMPTY_SET, /**< Rule contains an empty Unicode Set. */
566 U_BRK_UNRECOGNIZED_OPTION, /**< !!option in RBBI rules not recognized. */
567 U_BRK_MALFORMED_RULE_TAG, /**< The {nnn} tag on a rule is mal formed */
568 #ifndef U_HIDE_DEPRECATED_API
570 * One more than the highest normal BreakIterator error code.
571 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
574 #endif // U_HIDE_DEPRECATED_API
577 * Error codes in the range 0x10300-0x103ff are reserved for regular expression related errors.
579 U_REGEX_INTERNAL_ERROR=0x10300, /**< An internal error (bug) was detected. */
580 U_REGEX_ERROR_START=0x10300, /**< Start of codes indicating Regexp failures */
581 U_REGEX_RULE_SYNTAX, /**< Syntax error in regexp pattern. */
582 U_REGEX_INVALID_STATE, /**< RegexMatcher in invalid state for requested operation */
583 U_REGEX_BAD_ESCAPE_SEQUENCE, /**< Unrecognized backslash escape sequence in pattern */
584 U_REGEX_PROPERTY_SYNTAX, /**< Incorrect Unicode property */
585 U_REGEX_UNIMPLEMENTED, /**< Use of regexp feature that is not yet implemented. */
586 U_REGEX_MISMATCHED_PAREN, /**< Incorrectly nested parentheses in regexp pattern. */
587 U_REGEX_NUMBER_TOO_BIG, /**< Decimal number is too large. */
588 U_REGEX_BAD_INTERVAL, /**< Error in {min,max} interval */
589 U_REGEX_MAX_LT_MIN, /**< In {min,max}, max is less than min. */
590 U_REGEX_INVALID_BACK_REF, /**< Back-reference to a non-existent capture group. */
591 U_REGEX_INVALID_FLAG, /**< Invalid value for match mode flags. */
592 U_REGEX_LOOK_BEHIND_LIMIT, /**< Look-Behind pattern matches must have a bounded maximum length. */
593 U_REGEX_SET_CONTAINS_STRING, /**< Regexps cannot have UnicodeSets containing strings.*/
594 #ifndef U_HIDE_DEPRECATED_API
595 U_REGEX_OCTAL_TOO_BIG, /**< Octal character constants must be <= 0377. @deprecated ICU 54. This error cannot occur. */
596 #endif /* U_HIDE_DEPRECATED_API */
597 U_REGEX_MISSING_CLOSE_BRACKET=U_REGEX_SET_CONTAINS_STRING+2, /**< Missing closing bracket on a bracket expression. */
598 U_REGEX_INVALID_RANGE, /**< In a character range [x-y], x is greater than y. */
599 U_REGEX_STACK_OVERFLOW, /**< Regular expression backtrack stack overflow. */
600 U_REGEX_TIME_OUT, /**< Maximum allowed match time exceeded */
601 U_REGEX_STOPPED_BY_CALLER, /**< Matching operation aborted by user callback fn. */
602 U_REGEX_PATTERN_TOO_BIG, /**< Pattern exceeds limits on size or complexity. @stable ICU 55 */
603 U_REGEX_INVALID_CAPTURE_GROUP_NAME, /**< Invalid capture group name. @stable ICU 55 */
604 #ifndef U_HIDE_DEPRECATED_API
606 * One more than the highest normal regular expression error code.
607 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
609 U_REGEX_ERROR_LIMIT=U_REGEX_STOPPED_BY_CALLER+3,
610 #endif // U_HIDE_DEPRECATED_API
613 * Error codes in the range 0x10400-0x104ff are reserved for IDNA related error codes.
615 U_IDNA_PROHIBITED_ERROR=0x10400,
616 U_IDNA_ERROR_START=0x10400,
617 U_IDNA_UNASSIGNED_ERROR,
618 U_IDNA_CHECK_BIDI_ERROR,
619 U_IDNA_STD3_ASCII_RULES_ERROR,
620 U_IDNA_ACE_PREFIX_ERROR,
621 U_IDNA_VERIFICATION_ERROR,
622 U_IDNA_LABEL_TOO_LONG_ERROR,
623 U_IDNA_ZERO_LENGTH_LABEL_ERROR,
624 U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR,
625 #ifndef U_HIDE_DEPRECATED_API
627 * One more than the highest normal IDNA error code.
628 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
631 #endif // U_HIDE_DEPRECATED_API
633 * Aliases for StringPrep
635 U_STRINGPREP_PROHIBITED_ERROR = U_IDNA_PROHIBITED_ERROR,
636 U_STRINGPREP_UNASSIGNED_ERROR = U_IDNA_UNASSIGNED_ERROR,
637 U_STRINGPREP_CHECK_BIDI_ERROR = U_IDNA_CHECK_BIDI_ERROR,
640 * Error codes in the range 0x10500-0x105ff are reserved for Plugin related error codes.
642 U_PLUGIN_ERROR_START=0x10500, /**< Start of codes indicating plugin failures */
643 U_PLUGIN_TOO_HIGH=0x10500, /**< The plugin's level is too high to be loaded right now. */
644 U_PLUGIN_DIDNT_SET_LEVEL, /**< The plugin didn't call uplug_setPlugLevel in response to a QUERY */
645 #ifndef U_HIDE_DEPRECATED_API
647 * One more than the highest normal plug-in error code.
648 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
650 U_PLUGIN_ERROR_LIMIT,
651 #endif // U_HIDE_DEPRECATED_API
653 #ifndef U_HIDE_DEPRECATED_API
655 * One more than the highest normal error code.
656 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
658 U_ERROR_LIMIT=U_PLUGIN_ERROR_LIMIT
659 #endif // U_HIDE_DEPRECATED_API
662 /* Use the following to determine if an UErrorCode represents */
663 /* operational success or failure. */
667 * Does the error code indicate success?
671 inline UBool U_SUCCESS(UErrorCode code) { return (UBool)(code<=U_ZERO_ERROR); }
673 * Does the error code indicate a failure?
677 inline UBool U_FAILURE(UErrorCode code) { return (UBool)(code>U_ZERO_ERROR); }
680 * Does the error code indicate success?
683 # define U_SUCCESS(x) ((x)<=U_ZERO_ERROR)
685 * Does the error code indicate a failure?
688 # define U_FAILURE(x) ((x)>U_ZERO_ERROR)
692 * Return a string for a UErrorCode value.
693 * The string will be the same as the name of the error code constant
694 * in the UErrorCode enum above.
697 U_STABLE const char * U_EXPORT2
698 u_errorName(UErrorCode code);