ICU 52.1  52.1
utypes.h
Go to the documentation of this file.
1 /*
2 **********************************************************************
3 * Copyright (C) 1996-2012, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 **********************************************************************
6 *
7 * FILE NAME : UTYPES.H (formerly ptypes.h)
8 *
9 * Date Name Description
10 * 12/11/96 helena Creation.
11 * 02/27/97 aliu Added typedefs for UClassID, int8, int16, int32,
12 * uint8, uint16, and uint32.
13 * 04/01/97 aliu Added XP_CPLUSPLUS and modified to work under C as
14 * well as C++.
15 * Modified to use memcpy() for uprv_arrayCopy() fns.
16 * 04/14/97 aliu Added TPlatformUtilities.
17 * 05/07/97 aliu Added import/export specifiers (replacing the old
18 * broken EXT_CLASS). Added version number for our
19 * code. Cleaned up header.
20 * 6/20/97 helena Java class name change.
21 * 08/11/98 stephen UErrorCode changed from typedef to enum
22 * 08/12/98 erm Changed T_ANALYTIC_PACKAGE_VERSION to 3
23 * 08/14/98 stephen Added uprv_arrayCopy() for int8_t, int16_t, int32_t
24 * 12/09/98 jfitz Added BUFFER_OVERFLOW_ERROR (bug 1100066)
25 * 04/20/99 stephen Cleaned up & reworked for autoconf.
26 * Renamed to utypes.h.
27 * 05/05/99 stephen Changed to use <inttypes.h>
28 * 12/07/99 helena Moved copyright notice string from ucnv_bld.h here.
29 *******************************************************************************
30 */
31 
32 #ifndef UTYPES_H
33 #define UTYPES_H
34 
35 
36 #include "unicode/umachine.h"
37 #include "unicode/uversion.h"
38 #include "unicode/uconfig.h"
39 #include <float.h>
40 
41 #if !U_NO_DEFAULT_INCLUDE_UTF_HEADERS
42 # include "unicode/utf.h"
43 #endif
44 
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 
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 
90 /*===========================================================================*/
91 /* ICUDATA naming scheme */
92 /*===========================================================================*/
93 
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 
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
140 #define U_USE_USRDATA 1
141 #endif /* U_HIDE_INTERNAL_API */
142 
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 
161 #define U_DEF2_ICUDATA_ENTRY_POINT(major,suff) U_DEF_ICUDATA_ENTRY_POINT(major,suff)
162 
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 
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 
201 typedef double UDate;
202 
204 #define U_MILLIS_PER_SECOND (1000)
205 
206 #define U_MILLIS_PER_MINUTE (60000)
207 
208 #define U_MILLIS_PER_HOUR (3600000)
209 
210 #define U_MILLIS_PER_DAY (86400000)
211 
216 #define U_DATE_MAX DBL_MAX
217 
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 
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 
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 
410 inline void *
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[]. */
419 _Ret_bytecap_(_Size)
420 #endif
421 
426 inline void *
427 operator new[](size_t /*size*/) {
428  char *q=NULL;
429  *q=5; /* break it */
430  return q;
431 }
432 
438 inline void
439 operator delete(void * /*p*/) {
440  char *q=NULL;
441  *q=5; /* break it */
442 }
443 
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 
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 
540  /*
541  * the error code range 0x10000 0x10100 are reserved for Transliterator
542  */
581  /*
582  * the error code range 0x10100 0x10200 are reserved for formatting API parsing error
583  */
606  /*
607  * the error code range 0x10200 0x102ff are reserved for Break Iterator related error
608  */
626  /*
627  * The error codes in the range 0x10300-0x103ff are reserved for regular expression related errrs
628  */
653  /*
654  * The error code in the range 0x10400-0x104ff are reserved for IDNA related error codes
655  */
656  U_IDNA_PROHIBITED_ERROR=0x10400,
657  U_IDNA_ERROR_START=0x10400,
658  U_IDNA_UNASSIGNED_ERROR,
659  U_IDNA_CHECK_BIDI_ERROR,
660  U_IDNA_STD3_ASCII_RULES_ERROR,
661  U_IDNA_ACE_PREFIX_ERROR,
662  U_IDNA_VERIFICATION_ERROR,
663  U_IDNA_LABEL_TOO_LONG_ERROR,
664  U_IDNA_ZERO_LENGTH_LABEL_ERROR,
665  U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR,
666  U_IDNA_ERROR_LIMIT,
667  /*
668  * Aliases for StringPrep
669  */
670  U_STRINGPREP_PROHIBITED_ERROR = U_IDNA_PROHIBITED_ERROR,
671  U_STRINGPREP_UNASSIGNED_ERROR = U_IDNA_UNASSIGNED_ERROR,
672  U_STRINGPREP_CHECK_BIDI_ERROR = U_IDNA_CHECK_BIDI_ERROR,
673 
674  /*
675  * The error code in the range 0x10500-0x105ff are reserved for Plugin related error codes
676  */
683 } UErrorCode;
684 
685 /* Use the following to determine if an UErrorCode represents */
686 /* operational success or failure. */
687 
688 #ifdef __cplusplus
689 
693  static
694  inline UBool U_SUCCESS(UErrorCode code) { return (UBool)(code<=U_ZERO_ERROR); }
699  static
700  inline UBool U_FAILURE(UErrorCode code) { return (UBool)(code>U_ZERO_ERROR); }
701 #else
702 
706 # define U_SUCCESS(x) ((x)<=U_ZERO_ERROR)
707 
711 # define U_FAILURE(x) ((x)>U_ZERO_ERROR)
712 #endif
713 
720 U_STABLE const char * U_EXPORT2
721 u_errorName(UErrorCode code);
722 
723 
724 #endif /* _UTYPES */