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