ICU 60.0.1  60.0.1
umachine.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 ******************************************************************************
5 *
6 * Copyright (C) 1999-2015, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 ******************************************************************************
10 * file name: umachine.h
11 * encoding: UTF-8
12 * tab size: 8 (not used)
13 * indentation:4
14 *
15 * created on: 1999sep13
16 * created by: Markus W. Scherer
17 *
18 * This file defines basic types and constants for ICU to be
19 * platform-independent. umachine.h and utf.h are included into
20 * utypes.h to provide all the general definitions for ICU.
21 * All of these definitions used to be in utypes.h before
22 * the UTF-handling macros made this unmaintainable.
23 */
24 
25 #ifndef __UMACHINE_H__
26 #define __UMACHINE_H__
27 
28 
41 /*==========================================================================*/
42 /* Include platform-dependent definitions */
43 /* which are contained in the platform-specific file platform.h */
44 /*==========================================================================*/
45 
46 #include "unicode/ptypes.h" /* platform.h is included in ptypes.h */
47 
48 /*
49  * ANSI C headers:
50  * stddef.h defines wchar_t
51  */
52 #include <stddef.h>
53 
54 /*==========================================================================*/
55 /* For C wrappers, we use the symbol U_STABLE. */
56 /* This works properly if the includer is C or C++. */
57 /* Functions are declared U_STABLE return-type U_EXPORT2 function-name()... */
58 /*==========================================================================*/
59 
78 #ifdef __cplusplus
79 # define U_CFUNC extern "C"
80 # define U_CDECL_BEGIN extern "C" {
81 # define U_CDECL_END }
82 #else
83 # define U_CFUNC extern
84 # define U_CDECL_BEGIN
85 # define U_CDECL_END
86 #endif
87 
88 #ifndef U_ATTRIBUTE_DEPRECATED
89 
94 #if U_GCC_MAJOR_MINOR >= 302
95 # define U_ATTRIBUTE_DEPRECATED __attribute__ ((deprecated))
96 
101 #elif defined(_MSC_VER) && (_MSC_VER >= 1400)
102 # define U_ATTRIBUTE_DEPRECATED __declspec(deprecated)
103 #else
104 # define U_ATTRIBUTE_DEPRECATED
105 #endif
106 #endif
107 
109 #define U_CAPI U_CFUNC U_EXPORT
110 
111 #define U_STABLE U_CAPI
112 
113 #define U_DRAFT U_CAPI
114 
115 #define U_DEPRECATED U_CAPI U_ATTRIBUTE_DEPRECATED
116 
117 #define U_OBSOLETE U_CAPI
118 
119 #define U_INTERNAL U_CAPI
120 
137 #if U_CPLUSPLUS_VERSION >= 11
138 /* C++11 */
139 #ifndef U_OVERRIDE
140 #define U_OVERRIDE override
141 #endif
142 #ifndef U_FINAL
143 #define U_FINAL final
144 #endif
145 #else
146 /* not C++11 - define to nothing */
147 #ifndef U_OVERRIDE
148 #define U_OVERRIDE
149 #endif
150 #ifndef U_FINAL
151 #define U_FINAL
152 #endif
153 #endif
154 
155 /*==========================================================================*/
156 /* limits for int32_t etc., like in POSIX inttypes.h */
157 /*==========================================================================*/
158 
159 #ifndef INT8_MIN
160 
161 # define INT8_MIN ((int8_t)(-128))
162 #endif
163 #ifndef INT16_MIN
164 
165 # define INT16_MIN ((int16_t)(-32767-1))
166 #endif
167 #ifndef INT32_MIN
168 
169 # define INT32_MIN ((int32_t)(-2147483647-1))
170 #endif
171 
172 #ifndef INT8_MAX
173 
174 # define INT8_MAX ((int8_t)(127))
175 #endif
176 #ifndef INT16_MAX
177 
178 # define INT16_MAX ((int16_t)(32767))
179 #endif
180 #ifndef INT32_MAX
181 
182 # define INT32_MAX ((int32_t)(2147483647))
183 #endif
184 
185 #ifndef UINT8_MAX
186 
187 # define UINT8_MAX ((uint8_t)(255U))
188 #endif
189 #ifndef UINT16_MAX
190 
191 # define UINT16_MAX ((uint16_t)(65535U))
192 #endif
193 #ifndef UINT32_MAX
194 
195 # define UINT32_MAX ((uint32_t)(4294967295U))
196 #endif
197 
198 #if defined(U_INT64_T_UNAVAILABLE)
199 # error int64_t is required for decimal format and rule-based number format.
200 #else
201 # ifndef INT64_C
202 
207 # define INT64_C(c) c ## LL
208 # endif
209 # ifndef UINT64_C
210 
215 # define UINT64_C(c) c ## ULL
216 # endif
217 # ifndef U_INT64_MIN
218 
219 # define U_INT64_MIN ((int64_t)(INT64_C(-9223372036854775807)-1))
220 # endif
221 # ifndef U_INT64_MAX
222 
223 # define U_INT64_MAX ((int64_t)(INT64_C(9223372036854775807)))
224 # endif
225 # ifndef U_UINT64_MAX
226 
227 # define U_UINT64_MAX ((uint64_t)(UINT64_C(18446744073709551615)))
228 # endif
229 #endif
230 
231 /*==========================================================================*/
232 /* Boolean data type */
233 /*==========================================================================*/
234 
236 typedef int8_t UBool;
237 
238 #ifndef TRUE
239 
240 # define TRUE 1
241 #endif
242 #ifndef FALSE
243 
244 # define FALSE 0
245 #endif
246 
247 
248 /*==========================================================================*/
249 /* Unicode data types */
250 /*==========================================================================*/
251 
252 /* wchar_t-related definitions -------------------------------------------- */
253 
254 /*
255  * \def U_WCHAR_IS_UTF16
256  * Defined if wchar_t uses UTF-16.
257  *
258  * @stable ICU 2.0
259  */
260 /*
261  * \def U_WCHAR_IS_UTF32
262  * Defined if wchar_t uses UTF-32.
263  *
264  * @stable ICU 2.0
265  */
266 #if !defined(U_WCHAR_IS_UTF16) && !defined(U_WCHAR_IS_UTF32)
267 # ifdef __STDC_ISO_10646__
268 # if (U_SIZEOF_WCHAR_T==2)
269 # define U_WCHAR_IS_UTF16
270 # elif (U_SIZEOF_WCHAR_T==4)
271 # define U_WCHAR_IS_UTF32
272 # endif
273 # elif defined __UCS2__
274 # if (U_PF_OS390 <= U_PLATFORM && U_PLATFORM <= U_PF_OS400) && (U_SIZEOF_WCHAR_T==2)
275 # define U_WCHAR_IS_UTF16
276 # endif
277 # elif defined(__UCS4__) || (U_PLATFORM == U_PF_OS400 && defined(__UTF32__))
278 # if (U_SIZEOF_WCHAR_T==4)
279 # define U_WCHAR_IS_UTF32
280 # endif
281 # elif U_PLATFORM_IS_DARWIN_BASED || (U_SIZEOF_WCHAR_T==4 && U_PLATFORM_IS_LINUX_BASED)
282 # define U_WCHAR_IS_UTF32
283 # elif U_PLATFORM_HAS_WIN32_API
284 # define U_WCHAR_IS_UTF16
285 # endif
286 #endif
287 
288 /* UChar and UChar32 definitions -------------------------------------------- */
289 
291 #define U_SIZEOF_UCHAR 2
292 
298 #if (U_PLATFORM == U_PF_AIX) && defined(__cplusplus) &&(U_CPLUSPLUS_VERSION < 11)
299 // for AIX, uchar.h needs to be included
300 # include <uchar.h>
301 # define U_CHAR16_IS_TYPEDEF 1
302 #else
303 # define U_CHAR16_IS_TYPEDEF 0
304 #endif
305 
306 
331 #if 1
332  // #if 1 is normal. UChar defaults to char16_t in C++.
333  // For configuration testing of UChar=uint16_t temporarily change this to #if 0.
334  // The intltest Makefile #defines UCHAR_TYPE=char16_t,
335  // so we only #define it to uint16_t if it is undefined so far.
336 #elif !defined(UCHAR_TYPE)
337 # define UCHAR_TYPE uint16_t
338 #endif
339 
340 #if defined(U_COMBINED_IMPLEMENTATION) || defined(U_COMMON_IMPLEMENTATION) || \
341  defined(U_I18N_IMPLEMENTATION) || defined(U_IO_IMPLEMENTATION)
342  // Inside the ICU library code, never configurable.
343  typedef char16_t UChar;
344 #elif defined(UCHAR_TYPE)
345  typedef UCHAR_TYPE UChar;
346 #elif defined(__cplusplus)
347  typedef char16_t UChar;
348 #else
349  typedef uint16_t UChar;
350 #endif
351 
371 #if U_SIZEOF_WCHAR_T==2
372  typedef wchar_t OldUChar;
373 #elif defined(__CHAR16_TYPE__)
374  typedef __CHAR16_TYPE__ OldUChar;
375 #else
376  typedef uint16_t OldUChar;
377 #endif
378 
396 typedef int32_t UChar32;
397 
416 #define U_SENTINEL (-1)
417 
418 #include "unicode/urename.h"
419 
420 #endif
uint16_t OldUChar
Default ICU 58 definition of UChar.
Definition: umachine.h:376
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition: umachine.h:396
C API: Unicode Properties.
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:349
C API: Definitions of integer types of various widths.
int8_t UBool
The ICU boolean type.
Definition: umachine.h:236