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