1/* 2********************************************************************** 3* Copyright (C) 1996-2010, 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/utf.h" 38#include "unicode/uversion.h" 39#include "unicode/uconfig.h" 40 41/*! 42 * \file 43 * \brief Basic definitions for ICU, for both C and C++ APIs 44 * 45 * This file defines basic types, constants, and enumerations directly or 46 * indirectly by including other header files, especially utf.h for the 47 * basic character and string definitions and umachine.h for consistent 48 * integer and other types. 49 */ 50 51 52/** 53 * \def U_SHOW_CPLUSPLUS_API 54 * @internal 55 */ 56#ifdef XP_CPLUSPLUS 57# ifndef U_SHOW_CPLUSPLUS_API 58# define U_SHOW_CPLUSPLUS_API 1 59# endif 60#else 61# undef U_SHOW_CPLUSPLUS_API 62# define U_SHOW_CPLUSPLUS_API 0 63#endif 64 65/** @{ API visibility control */ 66 67/** 68 * \def U_HIDE_DRAFT_API 69 * Define this to 1 to request that draft API be "hidden" 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#ifdef U_HIDE_DRAFT_API 79#include "unicode/udraft.h" 80#endif 81 82#ifdef U_HIDE_DEPRECATED_API 83#include "unicode/udeprctd.h" 84#endif 85 86#ifdef U_HIDE_DEPRECATED_API 87#include "unicode/uobslete.h" 88#endif 89 90#ifdef U_HIDE_INTERNAL_API 91#include "unicode/uintrnal.h" 92#endif 93 94#ifdef U_HIDE_SYSTEM_API 95#include "unicode/usystem.h" 96#endif 97 98/** @} */ 99 100 101/*===========================================================================*/ 102/* char Character set family */ 103/*===========================================================================*/ 104 105/** 106 * U_CHARSET_FAMILY is equal to this value when the platform is an ASCII based platform. 107 * @stable ICU 2.0 108 */ 109#define U_ASCII_FAMILY 0 110 111/** 112 * U_CHARSET_FAMILY is equal to this value when the platform is an EBCDIC based platform. 113 * @stable ICU 2.0 114 */ 115#define U_EBCDIC_FAMILY 1 116 117/** 118 * \def U_CHARSET_FAMILY 119 * 120 * <p>These definitions allow to specify the encoding of text 121 * in the char data type as defined by the platform and the compiler. 122 * It is enough to determine the code point values of "invariant characters", 123 * which are the ones shared by all encodings that are in use 124 * on a given platform.</p> 125 * 126 * <p>Those "invariant characters" should be all the uppercase and lowercase 127 * latin letters, the digits, the space, and "basic punctuation". 128 * Also, '\\n', '\\r', '\\t' should be available.</p> 129 * 130 * <p>The list of "invariant characters" is:<br> 131 * \code 132 * A-Z a-z 0-9 SPACE " % & ' ( ) * + , - . / : ; < = > ? _ 133 * \endcode 134 * <br> 135 * (52 letters + 10 numbers + 20 punc/sym/space = 82 total)</p> 136 * 137 * <p>This matches the IBM Syntactic Character Set (CS 640).</p> 138 * 139 * <p>In other words, all the graphic characters in 7-bit ASCII should 140 * be safely accessible except the following:</p> 141 * 142 * \code 143 * '\' <backslash> 144 * '[' <left bracket> 145 * ']' <right bracket> 146 * '{' <left brace> 147 * '}' <right brace> 148 * '^' <circumflex> 149 * '~' <tilde> 150 * '!' <exclamation mark> 151 * '#' <number sign> 152 * '|' <vertical line> 153 * '$' <dollar sign> 154 * '@' <commercial at> 155 * '`' <grave accent> 156 * \endcode 157 * @stable ICU 2.0 158 */ 159 160#ifndef U_CHARSET_FAMILY 161# define U_CHARSET_FAMILY 0 162#endif 163 164/** 165 * \def U_CHARSET_IS_UTF8 166 * 167 * Hardcode the default charset to UTF-8. 168 * 169 * If this is set to 1, then 170 * - ICU will assume that all non-invariant char*, StringPiece, std::string etc. 171 * contain UTF-8 text, regardless of what the system API uses 172 * - some ICU code will use fast functions like u_strFromUTF8() 173 * rather than the more general and more heavy-weight conversion API (ucnv.h) 174 * - ucnv_getDefaultName() always returns "UTF-8" 175 * - ucnv_setDefaultName() is disabled and will not change the default charset 176 * - static builds of ICU are smaller 177 * - more functionality is available with the UCONFIG_NO_CONVERSION build-time 178 * configuration option (see unicode/uconfig.h) 179 * - the UCONFIG_NO_CONVERSION build option in uconfig.h is more usable 180 * 181 * @stable ICU 4.2 182 * @see UCONFIG_NO_CONVERSION 183 */ 184#ifndef U_CHARSET_IS_UTF8 185# define U_CHARSET_IS_UTF8 0 186#endif 187 188/*===========================================================================*/ 189/* ICUDATA naming scheme */ 190/*===========================================================================*/ 191 192/** 193 * \def U_ICUDATA_TYPE_LETTER 194 * 195 * This is a platform-dependent string containing one letter: 196 * - b for big-endian, ASCII-family platforms 197 * - l for little-endian, ASCII-family platforms 198 * - e for big-endian, EBCDIC-family platforms 199 * This letter is part of the common data file name. 200 * @stable ICU 2.0 201 */ 202 203/** 204 * \def U_ICUDATA_TYPE_LITLETTER 205 * The non-string form of U_ICUDATA_TYPE_LETTER 206 * @stable ICU 2.0 207 */ 208#if U_CHARSET_FAMILY 209# if U_IS_BIG_ENDIAN 210 /* EBCDIC - should always be BE */ 211# define U_ICUDATA_TYPE_LETTER "e" 212# define U_ICUDATA_TYPE_LITLETTER e 213# else 214# error "Don't know what to do with little endian EBCDIC!" 215# define U_ICUDATA_TYPE_LETTER "x" 216# define U_ICUDATA_TYPE_LITLETTER x 217# endif 218#else 219# if U_IS_BIG_ENDIAN 220 /* Big-endian ASCII */ 221# define U_ICUDATA_TYPE_LETTER "b" 222# define U_ICUDATA_TYPE_LITLETTER b 223# else 224 /* Little-endian ASCII */ 225# define U_ICUDATA_TYPE_LETTER "l" 226# define U_ICUDATA_TYPE_LITLETTER l 227# endif 228#endif 229 230/** 231 * A single string literal containing the icudata stub name. i.e. 'icudt18e' for 232 * ICU 1.8.x on EBCDIC, etc.. 233 * @stable ICU 2.0 234 */ 235#define U_ICUDATA_NAME "icudt" U_ICU_VERSION_SHORT U_ICUDATA_TYPE_LETTER /**< @internal */ 236#define U_USRDATA_NAME "usrdt" U_ICU_VERSION_SHORT U_ICUDATA_TYPE_LETTER /**< @internal */ 237#define U_USE_USRDATA 0 /**< @internal */ 238 239/** 240 * U_ICU_ENTRY_POINT is the name of the DLL entry point to the ICU data library. 241 * Defined as a literal, not a string. 242 * Tricky Preprocessor use - ## operator replaces macro paramters with the literal string 243 * from the corresponding macro invocation, _before_ other macro substitutions. 244 * Need a nested \#defines to get the actual version numbers rather than 245 * the literal text U_ICU_VERSION_MAJOR_NUM into the name. 246 * The net result will be something of the form 247 * \#define U_ICU_ENTRY_POINT icudt19_dat 248 * @stable ICU 2.4 249 */ 250#define U_ICUDATA_ENTRY_POINT U_DEF2_ICUDATA_ENTRY_POINT(U_ICU_VERSION_MAJOR_NUM, U_ICU_VERSION_MINOR_NUM) 251 252/** 253 * Do not use. 254 * @internal 255 */ 256#define U_DEF2_ICUDATA_ENTRY_POINT(major, minor) U_DEF_ICUDATA_ENTRY_POINT(major, minor) 257/** 258 * Do not use. 259 * @internal 260 */ 261#ifndef U_DEF_ICUDATA_ENTRY_POINT 262/* affected by symbol renaming. See platform.h */ 263#define U_DEF_ICUDATA_ENTRY_POINT(major, minor) icudt##major##minor##_dat 264#endif 265 266/** 267 * \def U_CALLCONV 268 * Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary 269 * in callback function typedefs to make sure that the calling convention 270 * is compatible. 271 * 272 * This is only used for non-ICU-API functions. 273 * When a function is a public ICU API, 274 * you must use the U_CAPI and U_EXPORT2 qualifiers. 275 * @stable ICU 2.0 276 */ 277#if defined(OS390) && defined(XP_CPLUSPLUS) 278# define U_CALLCONV __cdecl 279#else 280# define U_CALLCONV U_EXPORT2 281#endif 282 283/** 284 * \def NULL 285 * Define NULL if necessary, to 0 for C++ and to ((void *)0) for C. 286 * @stable ICU 2.0 287 */ 288#ifndef NULL 289#ifdef XP_CPLUSPLUS 290#define NULL 0 291#else 292#define NULL ((void *)0) 293#endif 294#endif 295 296/*===========================================================================*/ 297/* Calendar/TimeZone data types */ 298/*===========================================================================*/ 299 300/** 301 * Date and Time data type. 302 * This is a primitive data type that holds the date and time 303 * as the number of milliseconds since 1970-jan-01, 00:00 UTC. 304 * UTC leap seconds are ignored. 305 * @stable ICU 2.0 306 */ 307typedef double UDate; 308 309/** The number of milliseconds per second @stable ICU 2.0 */ 310#define U_MILLIS_PER_SECOND (1000) 311/** The number of milliseconds per minute @stable ICU 2.0 */ 312#define U_MILLIS_PER_MINUTE (60000) 313/** The number of milliseconds per hour @stable ICU 2.0 */ 314#define U_MILLIS_PER_HOUR (3600000) 315/** The number of milliseconds per day @stable ICU 2.0 */ 316#define U_MILLIS_PER_DAY (86400000) 317 318 319/*===========================================================================*/ 320/* UClassID-based RTTI */ 321/*===========================================================================*/ 322 323/** 324 * UClassID is used to identify classes without using RTTI, since RTTI 325 * is not yet supported by all C++ compilers. Each class hierarchy which needs 326 * to implement polymorphic clone() or operator==() defines two methods, 327 * described in detail below. UClassID values can be compared using 328 * operator==(). Nothing else should be done with them. 329 * 330 * \par 331 * getDynamicClassID() is declared in the base class of the hierarchy as 332 * a pure virtual. Each concrete subclass implements it in the same way: 333 * 334 * \code 335 * class Base { 336 * public: 337 * virtual UClassID getDynamicClassID() const = 0; 338 * } 339 * 340 * class Derived { 341 * public: 342 * virtual UClassID getDynamicClassID() const 343 * { return Derived::getStaticClassID(); } 344 * } 345 * \endcode 346 * 347 * Each concrete class implements getStaticClassID() as well, which allows 348 * clients to test for a specific type. 349 * 350 * \code 351 * class Derived { 352 * public: 353 * static UClassID U_EXPORT2 getStaticClassID(); 354 * private: 355 * static char fgClassID; 356 * } 357 * 358 * // In Derived.cpp: 359 * UClassID Derived::getStaticClassID() 360 * { return (UClassID)&Derived::fgClassID; } 361 * char Derived::fgClassID = 0; // Value is irrelevant 362 * \endcode 363 * @stable ICU 2.0 364 */ 365typedef void* UClassID; 366 367/*===========================================================================*/ 368/* Shared library/DLL import-export API control */ 369/*===========================================================================*/ 370 371/* 372 * Control of symbol import/export. 373 * ICU is separated into three libraries. 374 */ 375 376/* 377 * \def U_COMBINED_IMPLEMENTATION 378 * Set to export library symbols from inside the ICU library 379 * when all of ICU is in a single library. 380 * This can be set as a compiler option while building ICU, and it 381 * needs to be the first one tested to override U_COMMON_API, U_I18N_API, etc. 382 * @stable ICU 2.0 383 */ 384 385/** 386 * \def U_DATA_API 387 * Set to export library symbols from inside the stubdata library, 388 * and to import them from outside. 389 * @stable ICU 3.0 390 */ 391 392/** 393 * \def U_COMMON_API 394 * Set to export library symbols from inside the common library, 395 * and to import them from outside. 396 * @stable ICU 2.0 397 */ 398 399/** 400 * \def U_I18N_API 401 * Set to export library symbols from inside the i18n library, 402 * and to import them from outside. 403 * @stable ICU 2.0 404 */ 405 406/** 407 * \def U_LAYOUT_API 408 * Set to export library symbols from inside the layout engine library, 409 * and to import them from outside. 410 * @stable ICU 2.0 411 */ 412 413/** 414 * \def U_LAYOUTEX_API 415 * Set to export library symbols from inside the layout extensions library, 416 * and to import them from outside. 417 * @stable ICU 2.6 418 */ 419 420/** 421 * \def U_IO_API 422 * Set to export library symbols from inside the ustdio library, 423 * and to import them from outside. 424 * @stable ICU 2.0 425 */ 426 427/** 428 * \def U_TOOLUTIL_API 429 * Set to export library symbols from inside the toolutil library, 430 * and to import them from outside. 431 * @stable ICU 3.4 432 */ 433 434#if defined(U_COMBINED_IMPLEMENTATION) 435#define U_DATA_API U_EXPORT 436#define U_COMMON_API U_EXPORT 437#define U_I18N_API U_EXPORT 438#define U_LAYOUT_API U_EXPORT 439#define U_LAYOUTEX_API U_EXPORT 440#define U_IO_API U_EXPORT 441#define U_TOOLUTIL_API U_EXPORT 442#elif defined(U_STATIC_IMPLEMENTATION) 443#define U_DATA_API 444#define U_COMMON_API 445#define U_I18N_API 446#define U_LAYOUT_API 447#define U_LAYOUTEX_API 448#define U_IO_API 449#define U_TOOLUTIL_API 450#elif defined(U_COMMON_IMPLEMENTATION) 451#define U_DATA_API U_IMPORT 452#define U_COMMON_API U_EXPORT 453#define U_I18N_API U_IMPORT 454#define U_LAYOUT_API U_IMPORT 455#define U_LAYOUTEX_API U_IMPORT 456#define U_IO_API U_IMPORT 457#define U_TOOLUTIL_API U_IMPORT 458#elif defined(U_I18N_IMPLEMENTATION) 459#define U_DATA_API U_IMPORT 460#define U_COMMON_API U_IMPORT 461#define U_I18N_API U_EXPORT 462#define U_LAYOUT_API U_IMPORT 463#define U_LAYOUTEX_API U_IMPORT 464#define U_IO_API U_IMPORT 465#define U_TOOLUTIL_API U_IMPORT 466#elif defined(U_LAYOUT_IMPLEMENTATION) 467#define U_DATA_API U_IMPORT 468#define U_COMMON_API U_IMPORT 469#define U_I18N_API U_IMPORT 470#define U_LAYOUT_API U_EXPORT 471#define U_LAYOUTEX_API U_IMPORT 472#define U_IO_API U_IMPORT 473#define U_TOOLUTIL_API U_IMPORT 474#elif defined(U_LAYOUTEX_IMPLEMENTATION) 475#define U_DATA_API U_IMPORT 476#define U_COMMON_API U_IMPORT 477#define U_I18N_API U_IMPORT 478#define U_LAYOUT_API U_IMPORT 479#define U_LAYOUTEX_API U_EXPORT 480#define U_IO_API U_IMPORT 481#define U_TOOLUTIL_API U_IMPORT 482#elif defined(U_IO_IMPLEMENTATION) 483#define U_DATA_API U_IMPORT 484#define U_COMMON_API U_IMPORT 485#define U_I18N_API U_IMPORT 486#define U_LAYOUT_API U_IMPORT 487#define U_LAYOUTEX_API U_IMPORT 488#define U_IO_API U_EXPORT 489#define U_TOOLUTIL_API U_IMPORT 490#elif defined(U_TOOLUTIL_IMPLEMENTATION) 491#define U_DATA_API U_IMPORT 492#define U_COMMON_API U_IMPORT 493#define U_I18N_API U_IMPORT 494#define U_LAYOUT_API U_IMPORT 495#define U_LAYOUTEX_API U_IMPORT 496#define U_IO_API U_IMPORT 497#define U_TOOLUTIL_API U_EXPORT 498#else 499#define U_DATA_API U_IMPORT 500#define U_COMMON_API U_IMPORT 501#define U_I18N_API U_IMPORT 502#define U_LAYOUT_API U_IMPORT 503#define U_LAYOUTEX_API U_IMPORT 504#define U_IO_API U_IMPORT 505#define U_TOOLUTIL_API U_IMPORT 506#endif 507 508/** 509 * \def U_STANDARD_CPP_NAMESPACE 510 * Control of C++ Namespace 511 * @stable ICU 2.0 512 */ 513#ifdef __cplusplus 514#define U_STANDARD_CPP_NAMESPACE :: 515#else 516#define U_STANDARD_CPP_NAMESPACE 517#endif 518 519 520/*===========================================================================*/ 521/* Global delete operator */ 522/*===========================================================================*/ 523 524/* 525 * The ICU4C library must not use the global new and delete operators. 526 * These operators here are defined to enable testing for this. 527 * See Jitterbug 2581 for details of why this is necessary. 528 * 529 * Verification that ICU4C's memory usage is correct, i.e., 530 * that global new/delete are not used: 531 * 532 * a) Check for imports of global new/delete (see uobject.cpp for details) 533 * b) Verify that new is never imported. 534 * c) Verify that delete is only imported from object code for interface/mixin classes. 535 * d) Add global delete and delete[] only for the ICU4C library itself 536 * and define them in a way that crashes or otherwise easily shows a problem. 537 * 538 * The following implements d). 539 * The operator implementations crash; this is intentional and used for library debugging. 540 * 541 * Note: This is currently only done on Windows because 542 * some Linux/Unix compilers have problems with defining global new/delete. 543 * On Windows, U_WINDOWS is defined, and it is _MSC_VER>=1200 for MSVC 6.0 and higher. 544 */ 545#if defined(XP_CPLUSPLUS) && defined(WIN32) && 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)) 546 547#ifndef U_HIDE_INTERNAL_API 548/** 549 * Global operator new, defined only inside ICU4C, must not be used. 550 * Crashes intentionally. 551 * @internal 552 */ 553inline void * 554operator new(size_t /*size*/) { 555 char *q=NULL; 556 *q=5; /* break it */ 557 return q; 558} 559 560#ifdef _Ret_bytecap_ 561/* This is only needed to suppress a Visual C++ 2008 warning for operator new[]. */ 562_Ret_bytecap_(_Size) 563#endif 564/** 565 * Global operator new[], defined only inside ICU4C, must not be used. 566 * Crashes intentionally. 567 * @internal 568 */ 569inline void * 570operator new[](size_t /*size*/) { 571 char *q=NULL; 572 *q=5; /* break it */ 573 return q; 574} 575 576/** 577 * Global operator delete, defined only inside ICU4C, must not be used. 578 * Crashes intentionally. 579 * @internal 580 */ 581inline void 582operator delete(void * /*p*/) { 583 char *q=NULL; 584 *q=5; /* break it */ 585} 586 587/** 588 * Global operator delete[], defined only inside ICU4C, must not be used. 589 * Crashes intentionally. 590 * @internal 591 */ 592inline void 593operator delete[](void * /*p*/) { 594 char *q=NULL; 595 *q=5; /* break it */ 596} 597 598#endif /* U_HIDE_INTERNAL_API */ 599#endif 600 601/*===========================================================================*/ 602/* UErrorCode */ 603/*===========================================================================*/ 604 605/** 606 * Error code to replace exception handling, so that the code is compatible with all C++ compilers, 607 * and to use the same mechanism for C and C++. 608 * 609 * \par 610 * ICU functions that take a reference (C++) or a pointer (C) to a UErrorCode 611 * first test if(U_FAILURE(errorCode)) { return immediately; } 612 * so that in a chain of such functions the first one that sets an error code 613 * causes the following ones to not perform any operations. 614 * 615 * \par 616 * Error codes should be tested using U_FAILURE() and U_SUCCESS(). 617 * @stable ICU 2.0 618 */ 619typedef enum UErrorCode { 620 /* The ordering of U_ERROR_INFO_START Vs U_USING_FALLBACK_WARNING looks weird 621 * and is that way because VC++ debugger displays first encountered constant, 622 * which is not the what the code is used for 623 */ 624 625 U_USING_FALLBACK_WARNING = -128, /**< A resource bundle lookup returned a fallback result (not an error) */ 626 627 U_ERROR_WARNING_START = -128, /**< Start of information results (semantically successful) */ 628 629 U_USING_DEFAULT_WARNING = -127, /**< A resource bundle lookup returned a result from the root locale (not an error) */ 630 631 U_SAFECLONE_ALLOCATED_WARNING = -126, /**< A SafeClone operation required allocating memory (informational only) */ 632 633 U_STATE_OLD_WARNING = -125, /**< ICU has to use compatibility layer to construct the service. Expect performance/memory usage degradation. Consider upgrading */ 634 635 U_STRING_NOT_TERMINATED_WARNING = -124,/**< An output string could not be NUL-terminated because output length==destCapacity. */ 636 637 U_SORT_KEY_TOO_SHORT_WARNING = -123, /**< Number of levels requested in getBound is higher than the number of levels in the sort key */ 638 639 U_AMBIGUOUS_ALIAS_WARNING = -122, /**< This converter alias can go to different converter implementations */ 640 641 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 */ 642 643 U_PLUGIN_CHANGED_LEVEL_WARNING = -120, /**< A plugin caused a level change. May not be an error, but later plugins may not load. */ 644 645 U_ERROR_WARNING_LIMIT, /**< This must always be the last warning value to indicate the limit for UErrorCode warnings (last warning code +1) */ 646 647 648 U_ZERO_ERROR = 0, /**< No error, no warning. */ 649 650 U_ILLEGAL_ARGUMENT_ERROR = 1, /**< Start of codes indicating failure */ 651 U_MISSING_RESOURCE_ERROR = 2, /**< The requested resource cannot be found */ 652 U_INVALID_FORMAT_ERROR = 3, /**< Data format is not what is expected */ 653 U_FILE_ACCESS_ERROR = 4, /**< The requested file cannot be found */ 654 U_INTERNAL_PROGRAM_ERROR = 5, /**< Indicates a bug in the library code */ 655 U_MESSAGE_PARSE_ERROR = 6, /**< Unable to parse a message (message format) */ 656 U_MEMORY_ALLOCATION_ERROR = 7, /**< Memory allocation error */ 657 U_INDEX_OUTOFBOUNDS_ERROR = 8, /**< Trying to access the index that is out of bounds */ 658 U_PARSE_ERROR = 9, /**< Equivalent to Java ParseException */ 659 U_INVALID_CHAR_FOUND = 10, /**< Character conversion: Unmappable input sequence. In other APIs: Invalid character. */ 660 U_TRUNCATED_CHAR_FOUND = 11, /**< Character conversion: Incomplete input sequence. */ 661 U_ILLEGAL_CHAR_FOUND = 12, /**< Character conversion: Illegal input sequence/combination of input units. */ 662 U_INVALID_TABLE_FORMAT = 13, /**< Conversion table file found, but corrupted */ 663 U_INVALID_TABLE_FILE = 14, /**< Conversion table file not found */ 664 U_BUFFER_OVERFLOW_ERROR = 15, /**< A result would not fit in the supplied buffer */ 665 U_UNSUPPORTED_ERROR = 16, /**< Requested operation not supported in current context */ 666 U_RESOURCE_TYPE_MISMATCH = 17, /**< an operation is requested over a resource that does not support it */ 667 U_ILLEGAL_ESCAPE_SEQUENCE = 18, /**< ISO-2022 illlegal escape sequence */ 668 U_UNSUPPORTED_ESCAPE_SEQUENCE = 19, /**< ISO-2022 unsupported escape sequence */ 669 U_NO_SPACE_AVAILABLE = 20, /**< No space available for in-buffer expansion for Arabic shaping */ 670 U_CE_NOT_FOUND_ERROR = 21, /**< Currently used only while setting variable top, but can be used generally */ 671 U_PRIMARY_TOO_LONG_ERROR = 22, /**< User tried to set variable top to a primary that is longer than two bytes */ 672 U_STATE_TOO_OLD_ERROR = 23, /**< ICU cannot construct a service from this state, as it is no longer supported */ 673 U_TOO_MANY_ALIASES_ERROR = 24, /**< There are too many aliases in the path to the requested resource. 674 It is very possible that a circular alias definition has occured */ 675 U_ENUM_OUT_OF_SYNC_ERROR = 25, /**< UEnumeration out of sync with underlying collection */ 676 U_INVARIANT_CONVERSION_ERROR = 26, /**< Unable to convert a UChar* string to char* with the invariant converter. */ 677 U_INVALID_STATE_ERROR = 27, /**< Requested operation can not be completed with ICU in its current state */ 678 U_COLLATOR_VERSION_MISMATCH = 28, /**< Collator version is not compatible with the base version */ 679 U_USELESS_COLLATOR_ERROR = 29, /**< Collator is options only and no base is specified */ 680 U_NO_WRITE_PERMISSION = 30, /**< Attempt to modify read-only or constant data. */ 681 682 U_STANDARD_ERROR_LIMIT, /**< This must always be the last value to indicate the limit for standard errors */ 683 /* 684 * the error code range 0x10000 0x10100 are reserved for Transliterator 685 */ 686 U_BAD_VARIABLE_DEFINITION=0x10000,/**< Missing '$' or duplicate variable name */ 687 U_PARSE_ERROR_START = 0x10000, /**< Start of Transliterator errors */ 688 U_MALFORMED_RULE, /**< Elements of a rule are misplaced */ 689 U_MALFORMED_SET, /**< A UnicodeSet pattern is invalid*/ 690 U_MALFORMED_SYMBOL_REFERENCE, /**< UNUSED as of ICU 2.4 */ 691 U_MALFORMED_UNICODE_ESCAPE, /**< A Unicode escape pattern is invalid*/ 692 U_MALFORMED_VARIABLE_DEFINITION, /**< A variable definition is invalid */ 693 U_MALFORMED_VARIABLE_REFERENCE, /**< A variable reference is invalid */ 694 U_MISMATCHED_SEGMENT_DELIMITERS, /**< UNUSED as of ICU 2.4 */ 695 U_MISPLACED_ANCHOR_START, /**< A start anchor appears at an illegal position */ 696 U_MISPLACED_CURSOR_OFFSET, /**< A cursor offset occurs at an illegal position */ 697 U_MISPLACED_QUANTIFIER, /**< A quantifier appears after a segment close delimiter */ 698 U_MISSING_OPERATOR, /**< A rule contains no operator */ 699 U_MISSING_SEGMENT_CLOSE, /**< UNUSED as of ICU 2.4 */ 700 U_MULTIPLE_ANTE_CONTEXTS, /**< More than one ante context */ 701 U_MULTIPLE_CURSORS, /**< More than one cursor */ 702 U_MULTIPLE_POST_CONTEXTS, /**< More than one post context */ 703 U_TRAILING_BACKSLASH, /**< A dangling backslash */ 704 U_UNDEFINED_SEGMENT_REFERENCE, /**< A segment reference does not correspond to a defined segment */ 705 U_UNDEFINED_VARIABLE, /**< A variable reference does not correspond to a defined variable */ 706 U_UNQUOTED_SPECIAL, /**< A special character was not quoted or escaped */ 707 U_UNTERMINATED_QUOTE, /**< A closing single quote is missing */ 708 U_RULE_MASK_ERROR, /**< A rule is hidden by an earlier more general rule */ 709 U_MISPLACED_COMPOUND_FILTER, /**< A compound filter is in an invalid location */ 710 U_MULTIPLE_COMPOUND_FILTERS, /**< More than one compound filter */ 711 U_INVALID_RBT_SYNTAX, /**< A "::id" rule was passed to the RuleBasedTransliterator parser */ 712 U_INVALID_PROPERTY_PATTERN, /**< UNUSED as of ICU 2.4 */ 713 U_MALFORMED_PRAGMA, /**< A 'use' pragma is invlalid */ 714 U_UNCLOSED_SEGMENT, /**< A closing ')' is missing */ 715 U_ILLEGAL_CHAR_IN_SEGMENT, /**< UNUSED as of ICU 2.4 */ 716 U_VARIABLE_RANGE_EXHAUSTED, /**< Too many stand-ins generated for the given variable range */ 717 U_VARIABLE_RANGE_OVERLAP, /**< The variable range overlaps characters used in rules */ 718 U_ILLEGAL_CHARACTER, /**< A special character is outside its allowed context */ 719 U_INTERNAL_TRANSLITERATOR_ERROR, /**< Internal transliterator system error */ 720 U_INVALID_ID, /**< A "::id" rule specifies an unknown transliterator */ 721 U_INVALID_FUNCTION, /**< A "&fn()" rule specifies an unknown transliterator */ 722 U_PARSE_ERROR_LIMIT, /**< The limit for Transliterator errors */ 723 724 /* 725 * the error code range 0x10100 0x10200 are reserved for formatting API parsing error 726 */ 727 U_UNEXPECTED_TOKEN=0x10100, /**< Syntax error in format pattern */ 728 U_FMT_PARSE_ERROR_START=0x10100, /**< Start of format library errors */ 729 U_MULTIPLE_DECIMAL_SEPARATORS, /**< More than one decimal separator in number pattern */ 730 U_MULTIPLE_DECIMAL_SEPERATORS = U_MULTIPLE_DECIMAL_SEPARATORS, /**< Typo: kept for backward compatibility. Use U_MULTIPLE_DECIMAL_SEPARATORS */ 731 U_MULTIPLE_EXPONENTIAL_SYMBOLS, /**< More than one exponent symbol in number pattern */ 732 U_MALFORMED_EXPONENTIAL_PATTERN, /**< Grouping symbol in exponent pattern */ 733 U_MULTIPLE_PERCENT_SYMBOLS, /**< More than one percent symbol in number pattern */ 734 U_MULTIPLE_PERMILL_SYMBOLS, /**< More than one permill symbol in number pattern */ 735 U_MULTIPLE_PAD_SPECIFIERS, /**< More than one pad symbol in number pattern */ 736 U_PATTERN_SYNTAX_ERROR, /**< Syntax error in format pattern */ 737 U_ILLEGAL_PAD_POSITION, /**< Pad symbol misplaced in number pattern */ 738 U_UNMATCHED_BRACES, /**< Braces do not match in message pattern */ 739 U_UNSUPPORTED_PROPERTY, /**< UNUSED as of ICU 2.4 */ 740 U_UNSUPPORTED_ATTRIBUTE, /**< UNUSED as of ICU 2.4 */ 741 U_ARGUMENT_TYPE_MISMATCH, /**< Argument name and argument index mismatch in MessageFormat functions */ 742 U_DUPLICATE_KEYWORD, /**< Duplicate keyword in PluralFormat */ 743 U_UNDEFINED_KEYWORD, /**< Undefined Plural keyword */ 744 U_DEFAULT_KEYWORD_MISSING, /**< Missing DEFAULT rule in plural rules */ 745 U_DECIMAL_NUMBER_SYNTAX_ERROR, /**< Decimal number syntax error */ 746 U_FMT_PARSE_ERROR_LIMIT, /**< The limit for format library errors */ 747 748 /* 749 * the error code range 0x10200 0x102ff are reserved for Break Iterator related error 750 */ 751 U_BRK_INTERNAL_ERROR=0x10200, /**< An internal error (bug) was detected. */ 752 U_BRK_ERROR_START=0x10200, /**< Start of codes indicating Break Iterator failures */ 753 U_BRK_HEX_DIGITS_EXPECTED, /**< Hex digits expected as part of a escaped char in a rule. */ 754 U_BRK_SEMICOLON_EXPECTED, /**< Missing ';' at the end of a RBBI rule. */ 755 U_BRK_RULE_SYNTAX, /**< Syntax error in RBBI rule. */ 756 U_BRK_UNCLOSED_SET, /**< UnicodeSet witing an RBBI rule missing a closing ']'. */ 757 U_BRK_ASSIGN_ERROR, /**< Syntax error in RBBI rule assignment statement. */ 758 U_BRK_VARIABLE_REDFINITION, /**< RBBI rule $Variable redefined. */ 759 U_BRK_MISMATCHED_PAREN, /**< Mis-matched parentheses in an RBBI rule. */ 760 U_BRK_NEW_LINE_IN_QUOTED_STRING, /**< Missing closing quote in an RBBI rule. */ 761 U_BRK_UNDEFINED_VARIABLE, /**< Use of an undefined $Variable in an RBBI rule. */ 762 U_BRK_INIT_ERROR, /**< Initialization failure. Probable missing ICU Data. */ 763 U_BRK_RULE_EMPTY_SET, /**< Rule contains an empty Unicode Set. */ 764 U_BRK_UNRECOGNIZED_OPTION, /**< !!option in RBBI rules not recognized. */ 765 U_BRK_MALFORMED_RULE_TAG, /**< The {nnn} tag on a rule is mal formed */ 766 U_BRK_ERROR_LIMIT, /**< This must always be the last value to indicate the limit for Break Iterator failures */ 767 768 /* 769 * The error codes in the range 0x10300-0x103ff are reserved for regular expression related errrs 770 */ 771 U_REGEX_INTERNAL_ERROR=0x10300, /**< An internal error (bug) was detected. */ 772 U_REGEX_ERROR_START=0x10300, /**< Start of codes indicating Regexp failures */ 773 U_REGEX_RULE_SYNTAX, /**< Syntax error in regexp pattern. */ 774 U_REGEX_INVALID_STATE, /**< RegexMatcher in invalid state for requested operation */ 775 U_REGEX_BAD_ESCAPE_SEQUENCE, /**< Unrecognized backslash escape sequence in pattern */ 776 U_REGEX_PROPERTY_SYNTAX, /**< Incorrect Unicode property */ 777 U_REGEX_UNIMPLEMENTED, /**< Use of regexp feature that is not yet implemented. */ 778 U_REGEX_MISMATCHED_PAREN, /**< Incorrectly nested parentheses in regexp pattern. */ 779 U_REGEX_NUMBER_TOO_BIG, /**< Decimal number is too large. */ 780 U_REGEX_BAD_INTERVAL, /**< Error in {min,max} interval */ 781 U_REGEX_MAX_LT_MIN, /**< In {min,max}, max is less than min. */ 782 U_REGEX_INVALID_BACK_REF, /**< Back-reference to a non-existent capture group. */ 783 U_REGEX_INVALID_FLAG, /**< Invalid value for match mode flags. */ 784 U_REGEX_LOOK_BEHIND_LIMIT, /**< Look-Behind pattern matches must have a bounded maximum length. */ 785 U_REGEX_SET_CONTAINS_STRING, /**< Regexps cannot have UnicodeSets containing strings.*/ 786 U_REGEX_OCTAL_TOO_BIG, /**< Octal character constants must be <= 0377. */ 787 U_REGEX_MISSING_CLOSE_BRACKET, /**< Missing closing bracket on a bracket expression. */ 788 U_REGEX_INVALID_RANGE, /**< In a character range [x-y], x is greater than y. */ 789 U_REGEX_STACK_OVERFLOW, /**< Regular expression backtrack stack overflow. */ 790 U_REGEX_TIME_OUT, /**< Maximum allowed match time exceeded */ 791 U_REGEX_STOPPED_BY_CALLER, /**< Matching operation aborted by user callback fn. */ 792 U_REGEX_ERROR_LIMIT, /**< This must always be the last value to indicate the limit for regexp errors */ 793 794 /* 795 * The error code in the range 0x10400-0x104ff are reserved for IDNA related error codes 796 */ 797 U_IDNA_PROHIBITED_ERROR=0x10400, 798 U_IDNA_ERROR_START=0x10400, 799 U_IDNA_UNASSIGNED_ERROR, 800 U_IDNA_CHECK_BIDI_ERROR, 801 U_IDNA_STD3_ASCII_RULES_ERROR, 802 U_IDNA_ACE_PREFIX_ERROR, 803 U_IDNA_VERIFICATION_ERROR, 804 U_IDNA_LABEL_TOO_LONG_ERROR, 805 U_IDNA_ZERO_LENGTH_LABEL_ERROR, 806 U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR, 807 U_IDNA_ERROR_LIMIT, 808 /* 809 * Aliases for StringPrep 810 */ 811 U_STRINGPREP_PROHIBITED_ERROR = U_IDNA_PROHIBITED_ERROR, 812 U_STRINGPREP_UNASSIGNED_ERROR = U_IDNA_UNASSIGNED_ERROR, 813 U_STRINGPREP_CHECK_BIDI_ERROR = U_IDNA_CHECK_BIDI_ERROR, 814 815 /* 816 * The error code in the range 0x10500-0x105ff are reserved for Plugin related error codes 817 */ 818 U_PLUGIN_ERROR_START=0x10500, /**< Start of codes indicating plugin failures */ 819 U_PLUGIN_TOO_HIGH=0x10500, /**< The plugin's level is too high to be loaded right now. */ 820 U_PLUGIN_DIDNT_SET_LEVEL, /**< The plugin didn't call uplug_setPlugLevel in response to a QUERY */ 821 U_PLUGIN_ERROR_LIMIT, /**< This must always be the last value to indicate the limit for plugin errors */ 822 823 U_ERROR_LIMIT=U_PLUGIN_ERROR_LIMIT /**< This must always be the last value to indicate the limit for UErrorCode (last error code +1) */ 824} UErrorCode; 825 826/* Use the following to determine if an UErrorCode represents */ 827/* operational success or failure. */ 828 829#ifdef XP_CPLUSPLUS 830 /** 831 * Does the error code indicate success? 832 * @stable ICU 2.0 833 */ 834 static 835 inline UBool U_SUCCESS(UErrorCode code) { return (UBool)(code<=U_ZERO_ERROR); } 836 /** 837 * Does the error code indicate a failure? 838 * @stable ICU 2.0 839 */ 840 static 841 inline UBool U_FAILURE(UErrorCode code) { return (UBool)(code>U_ZERO_ERROR); } 842#else 843 /** 844 * Does the error code indicate success? 845 * @stable ICU 2.0 846 */ 847# define U_SUCCESS(x) ((x)<=U_ZERO_ERROR) 848 /** 849 * Does the error code indicate a failure? 850 * @stable ICU 2.0 851 */ 852# define U_FAILURE(x) ((x)>U_ZERO_ERROR) 853#endif 854 855/** 856 * Return a string for a UErrorCode value. 857 * The string will be the same as the name of the error code constant 858 * in the UErrorCode enum above. 859 * @stable ICU 2.0 860 */ 861U_STABLE const char * U_EXPORT2 862u_errorName(UErrorCode code); 863 864 865#endif /* _UTYPES */ 866