ICU 67.1  67.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 
128 #ifndef U_OVERRIDE
129 #define U_OVERRIDE override
130 #endif
131 
139 #if !defined(U_FINAL) || defined(U_IN_DOXYGEN)
140 #define U_FINAL final
141 #endif
142 
143 // Before ICU 65, function-like, multi-statement ICU macros were just defined as
144 // series of statements wrapped in { } blocks and the caller could choose to
145 // either treat them as if they were actual functions and end the invocation
146 // with a trailing ; creating an empty statement after the block or else omit
147 // this trailing ; using the knowledge that the macro would expand to { }.
148 //
149 // But doing so doesn't work well with macros that look like functions and
150 // compiler warnings about empty statements (ICU-20601) and ICU 65 therefore
151 // switches to the standard solution of wrapping such macros in do { } while.
152 //
153 // This will however break existing code that depends on being able to invoke
154 // these macros without a trailing ; so to be able to remain compatible with
155 // such code the wrapper is itself defined as macros so that it's possible to
156 // build ICU 65 and later with the old macro behaviour, like this:
157 //
158 // export CPPFLAGS='-DUPRV_BLOCK_MACRO_BEGIN="" -DUPRV_BLOCK_MACRO_END=""'
159 // runConfigureICU ...
160 //
161 
167 #ifndef UPRV_BLOCK_MACRO_BEGIN
168 #define UPRV_BLOCK_MACRO_BEGIN do
169 #endif
170 
176 #ifndef UPRV_BLOCK_MACRO_END
177 #define UPRV_BLOCK_MACRO_END while (FALSE)
178 #endif
179 
180 /*==========================================================================*/
181 /* limits for int32_t etc., like in POSIX inttypes.h */
182 /*==========================================================================*/
183 
184 #ifndef INT8_MIN
185 
186 # define INT8_MIN ((int8_t)(-128))
187 #endif
188 #ifndef INT16_MIN
189 
190 # define INT16_MIN ((int16_t)(-32767-1))
191 #endif
192 #ifndef INT32_MIN
193 
194 # define INT32_MIN ((int32_t)(-2147483647-1))
195 #endif
196 
197 #ifndef INT8_MAX
198 
199 # define INT8_MAX ((int8_t)(127))
200 #endif
201 #ifndef INT16_MAX
202 
203 # define INT16_MAX ((int16_t)(32767))
204 #endif
205 #ifndef INT32_MAX
206 
207 # define INT32_MAX ((int32_t)(2147483647))
208 #endif
209 
210 #ifndef UINT8_MAX
211 
212 # define UINT8_MAX ((uint8_t)(255U))
213 #endif
214 #ifndef UINT16_MAX
215 
216 # define UINT16_MAX ((uint16_t)(65535U))
217 #endif
218 #ifndef UINT32_MAX
219 
220 # define UINT32_MAX ((uint32_t)(4294967295U))
221 #endif
222 
223 #if defined(U_INT64_T_UNAVAILABLE)
224 # error int64_t is required for decimal format and rule-based number format.
225 #else
226 # ifndef INT64_C
227 
232 # define INT64_C(c) c ## LL
233 # endif
234 # ifndef UINT64_C
235 
240 # define UINT64_C(c) c ## ULL
241 # endif
242 # ifndef U_INT64_MIN
243 
244 # define U_INT64_MIN ((int64_t)(INT64_C(-9223372036854775807)-1))
245 # endif
246 # ifndef U_INT64_MAX
247 
248 # define U_INT64_MAX ((int64_t)(INT64_C(9223372036854775807)))
249 # endif
250 # ifndef U_UINT64_MAX
251 
252 # define U_UINT64_MAX ((uint64_t)(UINT64_C(18446744073709551615)))
253 # endif
254 #endif
255 
256 /*==========================================================================*/
257 /* Boolean data type */
258 /*==========================================================================*/
259 
261 typedef int8_t UBool;
262 
263 #ifndef TRUE
264 
265 # define TRUE 1
266 #endif
267 #ifndef FALSE
268 
269 # define FALSE 0
270 #endif
271 
272 
273 /*==========================================================================*/
274 /* Unicode data types */
275 /*==========================================================================*/
276 
277 /* wchar_t-related definitions -------------------------------------------- */
278 
279 /*
280  * \def U_WCHAR_IS_UTF16
281  * Defined if wchar_t uses UTF-16.
282  *
283  * @stable ICU 2.0
284  */
285 /*
286  * \def U_WCHAR_IS_UTF32
287  * Defined if wchar_t uses UTF-32.
288  *
289  * @stable ICU 2.0
290  */
291 #if !defined(U_WCHAR_IS_UTF16) && !defined(U_WCHAR_IS_UTF32)
292 # ifdef __STDC_ISO_10646__
293 # if (U_SIZEOF_WCHAR_T==2)
294 # define U_WCHAR_IS_UTF16
295 # elif (U_SIZEOF_WCHAR_T==4)
296 # define U_WCHAR_IS_UTF32
297 # endif
298 # elif defined __UCS2__
299 # if (U_PF_OS390 <= U_PLATFORM && U_PLATFORM <= U_PF_OS400) && (U_SIZEOF_WCHAR_T==2)
300 # define U_WCHAR_IS_UTF16
301 # endif
302 # elif defined(__UCS4__) || (U_PLATFORM == U_PF_OS400 && defined(__UTF32__))
303 # if (U_SIZEOF_WCHAR_T==4)
304 # define U_WCHAR_IS_UTF32
305 # endif
306 # elif U_PLATFORM_IS_DARWIN_BASED || (U_SIZEOF_WCHAR_T==4 && U_PLATFORM_IS_LINUX_BASED)
307 # define U_WCHAR_IS_UTF32
308 # elif U_PLATFORM_HAS_WIN32_API
309 # define U_WCHAR_IS_UTF16
310 # endif
311 #endif
312 
313 /* UChar and UChar32 definitions -------------------------------------------- */
314 
316 #define U_SIZEOF_UCHAR 2
317 
323 #if (U_PLATFORM == U_PF_AIX) && defined(__cplusplus) &&(U_CPLUSPLUS_VERSION < 11)
324 // for AIX, uchar.h needs to be included
325 # include <uchar.h>
326 # define U_CHAR16_IS_TYPEDEF 1
327 #elif defined(_MSC_VER) && (_MSC_VER < 1900)
328 // Versions of Visual Studio/MSVC below 2015 do not support char16_t as a real type,
329 // and instead use a typedef. https://msdn.microsoft.com/library/bb531344.aspx
330 # define U_CHAR16_IS_TYPEDEF 1
331 #else
332 # define U_CHAR16_IS_TYPEDEF 0
333 #endif
334 
335 
360 #if 1
361  // #if 1 is normal. UChar defaults to char16_t in C++.
362  // For configuration testing of UChar=uint16_t temporarily change this to #if 0.
363  // The intltest Makefile #defines UCHAR_TYPE=char16_t,
364  // so we only #define it to uint16_t if it is undefined so far.
365 #elif !defined(UCHAR_TYPE)
366 # define UCHAR_TYPE uint16_t
367 #endif
368 
369 #if defined(U_COMBINED_IMPLEMENTATION) || defined(U_COMMON_IMPLEMENTATION) || \
370  defined(U_I18N_IMPLEMENTATION) || defined(U_IO_IMPLEMENTATION)
371  // Inside the ICU library code, never configurable.
372  typedef char16_t UChar;
373 #elif defined(UCHAR_TYPE)
374  typedef UCHAR_TYPE UChar;
375 #elif (U_CPLUSPLUS_VERSION >= 11)
376  typedef char16_t UChar;
377 #else
378  typedef uint16_t UChar;
379 #endif
380 
400 #if U_SIZEOF_WCHAR_T==2
401  typedef wchar_t OldUChar;
402 #elif defined(__CHAR16_TYPE__)
403  typedef __CHAR16_TYPE__ OldUChar;
404 #else
405  typedef uint16_t OldUChar;
406 #endif
407 
425 typedef int32_t UChar32;
426 
445 #define U_SENTINEL (-1)
446 
447 #include "unicode/urename.h"
448 
449 #endif
uint16_t OldUChar
Default ICU 58 definition of UChar.
Definition: umachine.h:405
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition: umachine.h:425
C API: Unicode Properties.
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:376
C API: Definitions of integer types of various widths.
int8_t UBool
The ICU boolean type.
Definition: umachine.h:261