1/* 2********************************************************************** 3* Copyright (C) 1996-2012, International Business Machines 4* Corporation and others. All Rights Reserved. 5********************************************************************** 6* 7* FILE NAME : UTYPES.H (formerly ptypes.h) 8* 9* Date Name Description 10* 12/11/96 helena Creation. 11* 02/27/97 aliu Added typedefs for UClassID, int8, int16, int32, 12* uint8, uint16, and uint32. 13* 04/01/97 aliu Added XP_CPLUSPLUS and modified to work under C as 14* well as C++. 15* Modified to use memcpy() for uprv_arrayCopy() fns. 16* 04/14/97 aliu Added TPlatformUtilities. 17* 05/07/97 aliu Added import/export specifiers (replacing the old 18* broken EXT_CLASS). Added version number for our 19* code. Cleaned up header. 20* 6/20/97 helena Java class name change. 21* 08/11/98 stephen UErrorCode changed from typedef to enum 22* 08/12/98 erm Changed T_ANALYTIC_PACKAGE_VERSION to 3 23* 08/14/98 stephen Added uprv_arrayCopy() for int8_t, int16_t, int32_t 24* 12/09/98 jfitz Added BUFFER_OVERFLOW_ERROR (bug 1100066) 25* 04/20/99 stephen Cleaned up & reworked for autoconf. 26* Renamed to utypes.h. 27* 05/05/99 stephen Changed to use <inttypes.h> 28* 12/07/99 helena Moved copyright notice string from ucnv_bld.h here. 29******************************************************************************* 30*/ 31 32#ifndef UTYPES_H 33#define UTYPES_H 34 35 36#include "unicode/umachine.h" 37#include "unicode/uversion.h" 38#include "unicode/uconfig.h" 39#if U_PLATFORM!=U_PF_IPHONE 40#include <float.h> 41#endif 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 1 /**< @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 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 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 0 for C++ and to ((void *)0) for C. 182 * @stable ICU 2.0 183 */ 184#ifndef NULL 185#ifdef __cplusplus 186#define NULL 0 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 */ 203typedef 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#if U_PLATFORM!=U_PF_IPHONE 219#define U_DATE_MAX DBL_MAX 220#else 221#define U_DATE_MAX (1.7976931348623157e+308) 222#endif 223 224/** 225 * Minimum UDate value 226 * @stable ICU 4.8 227 */ 228#define U_DATE_MIN (-U_DATE_MAX) 229 230/*===========================================================================*/ 231/* Shared library/DLL import-export API control */ 232/*===========================================================================*/ 233 234/* 235 * Control of symbol import/export. 236 * ICU is separated into three libraries. 237 */ 238 239/** 240 * \def U_COMBINED_IMPLEMENTATION 241 * Set to export library symbols from inside the ICU library 242 * when all of ICU is in a single library. 243 * This can be set as a compiler option while building ICU, and it 244 * needs to be the first one tested to override U_COMMON_API, U_I18N_API, etc. 245 * @stable ICU 2.0 246 */ 247 248/** 249 * \def U_DATA_API 250 * Set to export library symbols from inside the stubdata library, 251 * and to import them from outside. 252 * @stable ICU 3.0 253 */ 254 255/** 256 * \def U_COMMON_API 257 * Set to export library symbols from inside the common library, 258 * and to import them from outside. 259 * @stable ICU 2.0 260 */ 261 262/** 263 * \def U_I18N_API 264 * Set to export library symbols from inside the i18n library, 265 * and to import them from outside. 266 * @stable ICU 2.0 267 */ 268 269/** 270 * \def U_LAYOUT_API 271 * Set to export library symbols from inside the layout engine library, 272 * and to import them from outside. 273 * @stable ICU 2.0 274 */ 275 276/** 277 * \def U_LAYOUTEX_API 278 * Set to export library symbols from inside the layout extensions library, 279 * and to import them from outside. 280 * @stable ICU 2.6 281 */ 282 283/** 284 * \def U_IO_API 285 * Set to export library symbols from inside the ustdio library, 286 * and to import them from outside. 287 * @stable ICU 2.0 288 */ 289 290/** 291 * \def U_TOOLUTIL_API 292 * Set to export library symbols from inside the toolutil library, 293 * and to import them from outside. 294 * @stable ICU 3.4 295 */ 296 297#if defined(U_COMBINED_IMPLEMENTATION) 298#define U_DATA_API U_EXPORT 299#define U_COMMON_API U_EXPORT 300#define U_I18N_API U_EXPORT 301#define U_LAYOUT_API U_EXPORT 302#define U_LAYOUTEX_API U_EXPORT 303#define U_IO_API U_EXPORT 304#define U_TOOLUTIL_API U_EXPORT 305#elif defined(U_STATIC_IMPLEMENTATION) 306#define U_DATA_API 307#define U_COMMON_API 308#define U_I18N_API 309#define U_LAYOUT_API 310#define U_LAYOUTEX_API 311#define U_IO_API 312#define U_TOOLUTIL_API 313#elif defined(U_COMMON_IMPLEMENTATION) 314#define U_DATA_API U_IMPORT 315#define U_COMMON_API U_EXPORT 316#define U_I18N_API U_IMPORT 317#define U_LAYOUT_API U_IMPORT 318#define U_LAYOUTEX_API U_IMPORT 319#define U_IO_API U_IMPORT 320#define U_TOOLUTIL_API U_IMPORT 321#elif defined(U_I18N_IMPLEMENTATION) 322#define U_DATA_API U_IMPORT 323#define U_COMMON_API U_IMPORT 324#define U_I18N_API U_EXPORT 325#define U_LAYOUT_API U_IMPORT 326#define U_LAYOUTEX_API U_IMPORT 327#define U_IO_API U_IMPORT 328#define U_TOOLUTIL_API U_IMPORT 329#elif defined(U_LAYOUT_IMPLEMENTATION) 330#define U_DATA_API U_IMPORT 331#define U_COMMON_API U_IMPORT 332#define U_I18N_API U_IMPORT 333#define U_LAYOUT_API U_EXPORT 334#define U_LAYOUTEX_API U_IMPORT 335#define U_IO_API U_IMPORT 336#define U_TOOLUTIL_API U_IMPORT 337#elif defined(U_LAYOUTEX_IMPLEMENTATION) 338#define U_DATA_API U_IMPORT 339#define U_COMMON_API U_IMPORT 340#define U_I18N_API U_IMPORT 341#define U_LAYOUT_API U_IMPORT 342#define U_LAYOUTEX_API U_EXPORT 343#define U_IO_API U_IMPORT 344#define U_TOOLUTIL_API U_IMPORT 345#elif defined(U_IO_IMPLEMENTATION) 346#define U_DATA_API U_IMPORT 347#define U_COMMON_API U_IMPORT 348#define U_I18N_API U_IMPORT 349#define U_LAYOUT_API U_IMPORT 350#define U_LAYOUTEX_API U_IMPORT 351#define U_IO_API U_EXPORT 352#define U_TOOLUTIL_API U_IMPORT 353#elif defined(U_TOOLUTIL_IMPLEMENTATION) 354#define U_DATA_API U_IMPORT 355#define U_COMMON_API U_IMPORT 356#define U_I18N_API U_IMPORT 357#define U_LAYOUT_API U_IMPORT 358#define U_LAYOUTEX_API U_IMPORT 359#define U_IO_API U_IMPORT 360#define U_TOOLUTIL_API U_EXPORT 361#else 362#define U_DATA_API U_IMPORT 363#define U_COMMON_API U_IMPORT 364#define U_I18N_API U_IMPORT 365#define U_LAYOUT_API U_IMPORT 366#define U_LAYOUTEX_API U_IMPORT 367#define U_IO_API U_IMPORT 368#define U_TOOLUTIL_API U_IMPORT 369#endif 370 371/** 372 * \def U_STANDARD_CPP_NAMESPACE 373 * Control of C++ Namespace 374 * @stable ICU 2.0 375 */ 376#ifdef __cplusplus 377#define U_STANDARD_CPP_NAMESPACE :: 378#else 379#define U_STANDARD_CPP_NAMESPACE 380#endif 381 382 383/*===========================================================================*/ 384/* Global delete operator */ 385/*===========================================================================*/ 386 387/* 388 * The ICU4C library must not use the global new and delete operators. 389 * These operators here are defined to enable testing for this. 390 * See Jitterbug 2581 for details of why this is necessary. 391 * 392 * Verification that ICU4C's memory usage is correct, i.e., 393 * that global new/delete are not used: 394 * 395 * a) Check for imports of global new/delete (see uobject.cpp for details) 396 * b) Verify that new is never imported. 397 * c) Verify that delete is only imported from object code for interface/mixin classes. 398 * d) Add global delete and delete[] only for the ICU4C library itself 399 * and define them in a way that crashes or otherwise easily shows a problem. 400 * 401 * The following implements d). 402 * The operator implementations crash; this is intentional and used for library debugging. 403 * 404 * Note: This is currently only done on Windows because 405 * some Linux/Unix compilers have problems with defining global new/delete. 406 * On Windows, it is _MSC_VER>=1200 for MSVC 6.0 and higher. 407 */ 408#if defined(__cplusplus) && U_DEBUG && U_OVERRIDE_CXX_ALLOCATION && (_MSC_VER>=1200) && !defined(U_STATIC_IMPLEMENTATION) && (defined(U_COMMON_IMPLEMENTATION) || defined(U_I18N_IMPLEMENTATION) || defined(U_IO_IMPLEMENTATION) || defined(U_LAYOUT_IMPLEMENTATION) || defined(U_LAYOUTEX_IMPLEMENTATION)) 409 410#ifndef U_HIDE_INTERNAL_API 411/** 412 * Global operator new, defined only inside ICU4C, must not be used. 413 * Crashes intentionally. 414 * @internal 415 */ 416inline void * 417operator new(size_t /*size*/) { 418 char *q=NULL; 419 *q=5; /* break it */ 420 return q; 421} 422 423#ifdef _Ret_bytecap_ 424/* This is only needed to suppress a Visual C++ 2008 warning for operator new[]. */ 425_Ret_bytecap_(_Size) 426#endif 427/** 428 * Global operator new[], defined only inside ICU4C, must not be used. 429 * Crashes intentionally. 430 * @internal 431 */ 432inline void * 433operator new[](size_t /*size*/) { 434 char *q=NULL; 435 *q=5; /* break it */ 436 return q; 437} 438 439/** 440 * Global operator delete, defined only inside ICU4C, must not be used. 441 * Crashes intentionally. 442 * @internal 443 */ 444inline void 445operator delete(void * /*p*/) { 446 char *q=NULL; 447 *q=5; /* break it */ 448} 449 450/** 451 * Global operator delete[], defined only inside ICU4C, must not be used. 452 * Crashes intentionally. 453 * @internal 454 */ 455inline void 456operator delete[](void * /*p*/) { 457 char *q=NULL; 458 *q=5; /* break it */ 459} 460 461#endif /* U_HIDE_INTERNAL_API */ 462#endif 463 464/*===========================================================================*/ 465/* UErrorCode */ 466/*===========================================================================*/ 467 468/** 469 * Error code to replace exception handling, so that the code is compatible with all C++ compilers, 470 * and to use the same mechanism for C and C++. 471 * 472 * \par 473 * ICU functions that take a reference (C++) or a pointer (C) to a UErrorCode 474 * first test if(U_FAILURE(errorCode)) { return immediately; } 475 * so that in a chain of such functions the first one that sets an error code 476 * causes the following ones to not perform any operations. 477 * 478 * \par 479 * Error codes should be tested using U_FAILURE() and U_SUCCESS(). 480 * @stable ICU 2.0 481 */ 482typedef enum UErrorCode { 483 /* The ordering of U_ERROR_INFO_START Vs U_USING_FALLBACK_WARNING looks weird 484 * and is that way because VC++ debugger displays first encountered constant, 485 * which is not the what the code is used for 486 */ 487 488 U_USING_FALLBACK_WARNING = -128, /**< A resource bundle lookup returned a fallback result (not an error) */ 489 490 U_ERROR_WARNING_START = -128, /**< Start of information results (semantically successful) */ 491 492 U_USING_DEFAULT_WARNING = -127, /**< A resource bundle lookup returned a result from the root locale (not an error) */ 493 494 U_SAFECLONE_ALLOCATED_WARNING = -126, /**< A SafeClone operation required allocating memory (informational only) */ 495 496 U_STATE_OLD_WARNING = -125, /**< ICU has to use compatibility layer to construct the service. Expect performance/memory usage degradation. Consider upgrading */ 497 498 U_STRING_NOT_TERMINATED_WARNING = -124,/**< An output string could not be NUL-terminated because output length==destCapacity. */ 499 500 U_SORT_KEY_TOO_SHORT_WARNING = -123, /**< Number of levels requested in getBound is higher than the number of levels in the sort key */ 501 502 U_AMBIGUOUS_ALIAS_WARNING = -122, /**< This converter alias can go to different converter implementations */ 503 504 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 */ 505 506 U_PLUGIN_CHANGED_LEVEL_WARNING = -120, /**< A plugin caused a level change. May not be an error, but later plugins may not load. */ 507 508 U_ERROR_WARNING_LIMIT, /**< This must always be the last warning value to indicate the limit for UErrorCode warnings (last warning code +1) */ 509 510 511 U_ZERO_ERROR = 0, /**< No error, no warning. */ 512 513 U_ILLEGAL_ARGUMENT_ERROR = 1, /**< Start of codes indicating failure */ 514 U_MISSING_RESOURCE_ERROR = 2, /**< The requested resource cannot be found */ 515 U_INVALID_FORMAT_ERROR = 3, /**< Data format is not what is expected */ 516 U_FILE_ACCESS_ERROR = 4, /**< The requested file cannot be found */ 517 U_INTERNAL_PROGRAM_ERROR = 5, /**< Indicates a bug in the library code */ 518 U_MESSAGE_PARSE_ERROR = 6, /**< Unable to parse a message (message format) */ 519 U_MEMORY_ALLOCATION_ERROR = 7, /**< Memory allocation error */ 520 U_INDEX_OUTOFBOUNDS_ERROR = 8, /**< Trying to access the index that is out of bounds */ 521 U_PARSE_ERROR = 9, /**< Equivalent to Java ParseException */ 522 U_INVALID_CHAR_FOUND = 10, /**< Character conversion: Unmappable input sequence. In other APIs: Invalid character. */ 523 U_TRUNCATED_CHAR_FOUND = 11, /**< Character conversion: Incomplete input sequence. */ 524 U_ILLEGAL_CHAR_FOUND = 12, /**< Character conversion: Illegal input sequence/combination of input units. */ 525 U_INVALID_TABLE_FORMAT = 13, /**< Conversion table file found, but corrupted */ 526 U_INVALID_TABLE_FILE = 14, /**< Conversion table file not found */ 527 U_BUFFER_OVERFLOW_ERROR = 15, /**< A result would not fit in the supplied buffer */ 528 U_UNSUPPORTED_ERROR = 16, /**< Requested operation not supported in current context */ 529 U_RESOURCE_TYPE_MISMATCH = 17, /**< an operation is requested over a resource that does not support it */ 530 U_ILLEGAL_ESCAPE_SEQUENCE = 18, /**< ISO-2022 illlegal escape sequence */ 531 U_UNSUPPORTED_ESCAPE_SEQUENCE = 19, /**< ISO-2022 unsupported escape sequence */ 532 U_NO_SPACE_AVAILABLE = 20, /**< No space available for in-buffer expansion for Arabic shaping */ 533 U_CE_NOT_FOUND_ERROR = 21, /**< Currently used only while setting variable top, but can be used generally */ 534 U_PRIMARY_TOO_LONG_ERROR = 22, /**< User tried to set variable top to a primary that is longer than two bytes */ 535 U_STATE_TOO_OLD_ERROR = 23, /**< ICU cannot construct a service from this state, as it is no longer supported */ 536 U_TOO_MANY_ALIASES_ERROR = 24, /**< There are too many aliases in the path to the requested resource. 537 It is very possible that a circular alias definition has occured */ 538 U_ENUM_OUT_OF_SYNC_ERROR = 25, /**< UEnumeration out of sync with underlying collection */ 539 U_INVARIANT_CONVERSION_ERROR = 26, /**< Unable to convert a UChar* string to char* with the invariant converter. */ 540 U_INVALID_STATE_ERROR = 27, /**< Requested operation can not be completed with ICU in its current state */ 541 U_COLLATOR_VERSION_MISMATCH = 28, /**< Collator version is not compatible with the base version */ 542 U_USELESS_COLLATOR_ERROR = 29, /**< Collator is options only and no base is specified */ 543 U_NO_WRITE_PERMISSION = 30, /**< Attempt to modify read-only or constant data. */ 544 545 U_STANDARD_ERROR_LIMIT, /**< This must always be the last value to indicate the limit for standard errors */ 546 /* 547 * the error code range 0x10000 0x10100 are reserved for Transliterator 548 */ 549 U_BAD_VARIABLE_DEFINITION=0x10000,/**< Missing '$' or duplicate variable name */ 550 U_PARSE_ERROR_START = 0x10000, /**< Start of Transliterator errors */ 551 U_MALFORMED_RULE, /**< Elements of a rule are misplaced */ 552 U_MALFORMED_SET, /**< A UnicodeSet pattern is invalid*/ 553 U_MALFORMED_SYMBOL_REFERENCE, /**< UNUSED as of ICU 2.4 */ 554 U_MALFORMED_UNICODE_ESCAPE, /**< A Unicode escape pattern is invalid*/ 555 U_MALFORMED_VARIABLE_DEFINITION, /**< A variable definition is invalid */ 556 U_MALFORMED_VARIABLE_REFERENCE, /**< A variable reference is invalid */ 557 U_MISMATCHED_SEGMENT_DELIMITERS, /**< UNUSED as of ICU 2.4 */ 558 U_MISPLACED_ANCHOR_START, /**< A start anchor appears at an illegal position */ 559 U_MISPLACED_CURSOR_OFFSET, /**< A cursor offset occurs at an illegal position */ 560 U_MISPLACED_QUANTIFIER, /**< A quantifier appears after a segment close delimiter */ 561 U_MISSING_OPERATOR, /**< A rule contains no operator */ 562 U_MISSING_SEGMENT_CLOSE, /**< UNUSED as of ICU 2.4 */ 563 U_MULTIPLE_ANTE_CONTEXTS, /**< More than one ante context */ 564 U_MULTIPLE_CURSORS, /**< More than one cursor */ 565 U_MULTIPLE_POST_CONTEXTS, /**< More than one post context */ 566 U_TRAILING_BACKSLASH, /**< A dangling backslash */ 567 U_UNDEFINED_SEGMENT_REFERENCE, /**< A segment reference does not correspond to a defined segment */ 568 U_UNDEFINED_VARIABLE, /**< A variable reference does not correspond to a defined variable */ 569 U_UNQUOTED_SPECIAL, /**< A special character was not quoted or escaped */ 570 U_UNTERMINATED_QUOTE, /**< A closing single quote is missing */ 571 U_RULE_MASK_ERROR, /**< A rule is hidden by an earlier more general rule */ 572 U_MISPLACED_COMPOUND_FILTER, /**< A compound filter is in an invalid location */ 573 U_MULTIPLE_COMPOUND_FILTERS, /**< More than one compound filter */ 574 U_INVALID_RBT_SYNTAX, /**< A "::id" rule was passed to the RuleBasedTransliterator parser */ 575 U_INVALID_PROPERTY_PATTERN, /**< UNUSED as of ICU 2.4 */ 576 U_MALFORMED_PRAGMA, /**< A 'use' pragma is invlalid */ 577 U_UNCLOSED_SEGMENT, /**< A closing ')' is missing */ 578 U_ILLEGAL_CHAR_IN_SEGMENT, /**< UNUSED as of ICU 2.4 */ 579 U_VARIABLE_RANGE_EXHAUSTED, /**< Too many stand-ins generated for the given variable range */ 580 U_VARIABLE_RANGE_OVERLAP, /**< The variable range overlaps characters used in rules */ 581 U_ILLEGAL_CHARACTER, /**< A special character is outside its allowed context */ 582 U_INTERNAL_TRANSLITERATOR_ERROR, /**< Internal transliterator system error */ 583 U_INVALID_ID, /**< A "::id" rule specifies an unknown transliterator */ 584 U_INVALID_FUNCTION, /**< A "&fn()" rule specifies an unknown transliterator */ 585 U_PARSE_ERROR_LIMIT, /**< The limit for Transliterator errors */ 586 587 /* 588 * the error code range 0x10100 0x10200 are reserved for formatting API parsing error 589 */ 590 U_UNEXPECTED_TOKEN=0x10100, /**< Syntax error in format pattern */ 591 U_FMT_PARSE_ERROR_START=0x10100, /**< Start of format library errors */ 592 U_MULTIPLE_DECIMAL_SEPARATORS, /**< More than one decimal separator in number pattern */ 593 U_MULTIPLE_DECIMAL_SEPERATORS = U_MULTIPLE_DECIMAL_SEPARATORS, /**< Typo: kept for backward compatibility. Use U_MULTIPLE_DECIMAL_SEPARATORS */ 594 U_MULTIPLE_EXPONENTIAL_SYMBOLS, /**< More than one exponent symbol in number pattern */ 595 U_MALFORMED_EXPONENTIAL_PATTERN, /**< Grouping symbol in exponent pattern */ 596 U_MULTIPLE_PERCENT_SYMBOLS, /**< More than one percent symbol in number pattern */ 597 U_MULTIPLE_PERMILL_SYMBOLS, /**< More than one permill symbol in number pattern */ 598 U_MULTIPLE_PAD_SPECIFIERS, /**< More than one pad symbol in number pattern */ 599 U_PATTERN_SYNTAX_ERROR, /**< Syntax error in format pattern */ 600 U_ILLEGAL_PAD_POSITION, /**< Pad symbol misplaced in number pattern */ 601 U_UNMATCHED_BRACES, /**< Braces do not match in message pattern */ 602 U_UNSUPPORTED_PROPERTY, /**< UNUSED as of ICU 2.4 */ 603 U_UNSUPPORTED_ATTRIBUTE, /**< UNUSED as of ICU 2.4 */ 604 U_ARGUMENT_TYPE_MISMATCH, /**< Argument name and argument index mismatch in MessageFormat functions */ 605 U_DUPLICATE_KEYWORD, /**< Duplicate keyword in PluralFormat */ 606 U_UNDEFINED_KEYWORD, /**< Undefined Plural keyword */ 607 U_DEFAULT_KEYWORD_MISSING, /**< Missing DEFAULT rule in plural rules */ 608 U_DECIMAL_NUMBER_SYNTAX_ERROR, /**< Decimal number syntax error */ 609 U_FORMAT_INEXACT_ERROR, /**< Cannot format a number exactly and rounding mode is ROUND_UNNECESSARY @stable ICU 4.8 */ 610 U_FMT_PARSE_ERROR_LIMIT, /**< The limit for format library errors */ 611 612 /* 613 * the error code range 0x10200 0x102ff are reserved for Break Iterator related error 614 */ 615 U_BRK_INTERNAL_ERROR=0x10200, /**< An internal error (bug) was detected. */ 616 U_BRK_ERROR_START=0x10200, /**< Start of codes indicating Break Iterator failures */ 617 U_BRK_HEX_DIGITS_EXPECTED, /**< Hex digits expected as part of a escaped char in a rule. */ 618 U_BRK_SEMICOLON_EXPECTED, /**< Missing ';' at the end of a RBBI rule. */ 619 U_BRK_RULE_SYNTAX, /**< Syntax error in RBBI rule. */ 620 U_BRK_UNCLOSED_SET, /**< UnicodeSet witing an RBBI rule missing a closing ']'. */ 621 U_BRK_ASSIGN_ERROR, /**< Syntax error in RBBI rule assignment statement. */ 622 U_BRK_VARIABLE_REDFINITION, /**< RBBI rule $Variable redefined. */ 623 U_BRK_MISMATCHED_PAREN, /**< Mis-matched parentheses in an RBBI rule. */ 624 U_BRK_NEW_LINE_IN_QUOTED_STRING, /**< Missing closing quote in an RBBI rule. */ 625 U_BRK_UNDEFINED_VARIABLE, /**< Use of an undefined $Variable in an RBBI rule. */ 626 U_BRK_INIT_ERROR, /**< Initialization failure. Probable missing ICU Data. */ 627 U_BRK_RULE_EMPTY_SET, /**< Rule contains an empty Unicode Set. */ 628 U_BRK_UNRECOGNIZED_OPTION, /**< !!option in RBBI rules not recognized. */ 629 U_BRK_MALFORMED_RULE_TAG, /**< The {nnn} tag on a rule is mal formed */ 630 U_BRK_ERROR_LIMIT, /**< This must always be the last value to indicate the limit for Break Iterator failures */ 631 632 /* 633 * The error codes in the range 0x10300-0x103ff are reserved for regular expression related errrs 634 */ 635 U_REGEX_INTERNAL_ERROR=0x10300, /**< An internal error (bug) was detected. */ 636 U_REGEX_ERROR_START=0x10300, /**< Start of codes indicating Regexp failures */ 637 U_REGEX_RULE_SYNTAX, /**< Syntax error in regexp pattern. */ 638 U_REGEX_INVALID_STATE, /**< RegexMatcher in invalid state for requested operation */ 639 U_REGEX_BAD_ESCAPE_SEQUENCE, /**< Unrecognized backslash escape sequence in pattern */ 640 U_REGEX_PROPERTY_SYNTAX, /**< Incorrect Unicode property */ 641 U_REGEX_UNIMPLEMENTED, /**< Use of regexp feature that is not yet implemented. */ 642 U_REGEX_MISMATCHED_PAREN, /**< Incorrectly nested parentheses in regexp pattern. */ 643 U_REGEX_NUMBER_TOO_BIG, /**< Decimal number is too large. */ 644 U_REGEX_BAD_INTERVAL, /**< Error in {min,max} interval */ 645 U_REGEX_MAX_LT_MIN, /**< In {min,max}, max is less than min. */ 646 U_REGEX_INVALID_BACK_REF, /**< Back-reference to a non-existent capture group. */ 647 U_REGEX_INVALID_FLAG, /**< Invalid value for match mode flags. */ 648 U_REGEX_LOOK_BEHIND_LIMIT, /**< Look-Behind pattern matches must have a bounded maximum length. */ 649 U_REGEX_SET_CONTAINS_STRING, /**< Regexps cannot have UnicodeSets containing strings.*/ 650 U_REGEX_OCTAL_TOO_BIG, /**< Octal character constants must be <= 0377. */ 651 U_REGEX_MISSING_CLOSE_BRACKET, /**< Missing closing bracket on a bracket expression. */ 652 U_REGEX_INVALID_RANGE, /**< In a character range [x-y], x is greater than y. */ 653 U_REGEX_STACK_OVERFLOW, /**< Regular expression backtrack stack overflow. */ 654 U_REGEX_TIME_OUT, /**< Maximum allowed match time exceeded */ 655 U_REGEX_STOPPED_BY_CALLER, /**< Matching operation aborted by user callback fn. */ 656 U_REGEX_ERROR_LIMIT, /**< This must always be the last value to indicate the limit for regexp errors */ 657 658 /* 659 * The error code in the range 0x10400-0x104ff are reserved for IDNA related error codes 660 */ 661 U_IDNA_PROHIBITED_ERROR=0x10400, 662 U_IDNA_ERROR_START=0x10400, 663 U_IDNA_UNASSIGNED_ERROR, 664 U_IDNA_CHECK_BIDI_ERROR, 665 U_IDNA_STD3_ASCII_RULES_ERROR, 666 U_IDNA_ACE_PREFIX_ERROR, 667 U_IDNA_VERIFICATION_ERROR, 668 U_IDNA_LABEL_TOO_LONG_ERROR, 669 U_IDNA_ZERO_LENGTH_LABEL_ERROR, 670 U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR, 671 U_IDNA_ERROR_LIMIT, 672 /* 673 * Aliases for StringPrep 674 */ 675 U_STRINGPREP_PROHIBITED_ERROR = U_IDNA_PROHIBITED_ERROR, 676 U_STRINGPREP_UNASSIGNED_ERROR = U_IDNA_UNASSIGNED_ERROR, 677 U_STRINGPREP_CHECK_BIDI_ERROR = U_IDNA_CHECK_BIDI_ERROR, 678 679 /* 680 * The error code in the range 0x10500-0x105ff are reserved for Plugin related error codes 681 */ 682 U_PLUGIN_ERROR_START=0x10500, /**< Start of codes indicating plugin failures */ 683 U_PLUGIN_TOO_HIGH=0x10500, /**< The plugin's level is too high to be loaded right now. */ 684 U_PLUGIN_DIDNT_SET_LEVEL, /**< The plugin didn't call uplug_setPlugLevel in response to a QUERY */ 685 U_PLUGIN_ERROR_LIMIT, /**< This must always be the last value to indicate the limit for plugin errors */ 686 687 U_ERROR_LIMIT=U_PLUGIN_ERROR_LIMIT /**< This must always be the last value to indicate the limit for UErrorCode (last error code +1) */ 688} UErrorCode; 689 690/* Use the following to determine if an UErrorCode represents */ 691/* operational success or failure. */ 692 693#ifdef __cplusplus 694 /** 695 * Does the error code indicate success? 696 * @stable ICU 2.0 697 */ 698 static 699 inline UBool U_SUCCESS(UErrorCode code) { return (UBool)(code<=U_ZERO_ERROR); } 700 /** 701 * Does the error code indicate a failure? 702 * @stable ICU 2.0 703 */ 704 static 705 inline UBool U_FAILURE(UErrorCode code) { return (UBool)(code>U_ZERO_ERROR); } 706#else 707 /** 708 * Does the error code indicate success? 709 * @stable ICU 2.0 710 */ 711# define U_SUCCESS(x) ((x)<=U_ZERO_ERROR) 712 /** 713 * Does the error code indicate a failure? 714 * @stable ICU 2.0 715 */ 716# define U_FAILURE(x) ((x)>U_ZERO_ERROR) 717#endif 718 719/** 720 * Return a string for a UErrorCode value. 721 * The string will be the same as the name of the error code constant 722 * in the UErrorCode enum above. 723 * @stable ICU 2.0 724 */ 725U_STABLE const char * U_EXPORT2 726u_errorName(UErrorCode code); 727 728 729#endif /* _UTYPES */ 730