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