w32tex
About: TeX Live provides a comprehensive TeX system including all the major TeX-related programs, macro packages, and fonts that are free software. Windows sources.
  Fossies Dox: w32tex-src.tar.xz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

platform.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) 1997-2016, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 ******************************************************************************
10 *
11 * FILE NAME : platform.h
12 *
13 * Date Name Description
14 * 05/13/98 nos Creation (content moved here from ptypes.h).
15 * 03/02/99 stephen Added AS400 support.
16 * 03/30/99 stephen Added Linux support.
17 * 04/13/99 stephen Reworked for autoconf.
18 ******************************************************************************
19 */
20 
21 #ifndef _PLATFORM_H
22 #define _PLATFORM_H
23 
24 #include "unicode/uconfig.h"
25 #include "unicode/uvernum.h"
26 
27 /**
28  * \file
29  * \brief Basic types for the platform.
30  *
31  * This file used to be generated by autoconf/configure.
32  * Starting with ICU 49, platform.h is a normal source file,
33  * to simplify cross-compiling and working with non-autoconf/make build systems.
34  *
35  * When a value in this file does not work on a platform, then please
36  * try to derive it from the U_PLATFORM value
37  * (for which we might need a new value constant in rare cases)
38  * and/or from other macros that are predefined by the compiler
39  * or defined in standard (POSIX or platform or compiler) headers.
40  *
41  * As a temporary workaround, you can add an explicit \#define for some macros
42  * before it is first tested, or add an equivalent -D macro definition
43  * to the compiler's command line.
44  *
45  * Note: Some compilers provide ways to show the predefined macros.
46  * For example, with gcc you can compile an empty .c file and have the compiler
47  * print the predefined macros with
48  * \code
49  * gcc -E -dM -x c /dev/null | sort
50  * \endcode
51  * (You can provide an actual empty .c file rather than /dev/null.
52  * <code>-x c++</code> is for C++.)
53  */
54 
55 /**
56  * Define some things so that they can be documented.
57  * @internal
58  */
59 #ifdef U_IN_DOXYGEN
60 /*
61  * Problem: "platform.h:335: warning: documentation for unknown define U_HAVE_STD_STRING found." means that U_HAVE_STD_STRING is not documented.
62  * Solution: #define any defines for non @internal API here, so that they are visible in the docs. If you just set PREDEFINED in Doxyfile.in, they won't be documented.
63  */
64 
65 /* None for now. */
66 #endif
67 
68 /**
69  * \def U_PLATFORM
70  * The U_PLATFORM macro defines the platform we're on.
71  *
72  * We used to define one different, value-less macro per platform.
73  * That made it hard to know the set of relevant platforms and macros,
74  * and hard to deal with variants of platforms.
75  *
76  * Starting with ICU 49, we define platforms as numeric macros,
77  * with ranges of values for related platforms and their variants.
78  * The U_PLATFORM macro is set to one of these values.
79  *
80  * Historical note from the Solaris Wikipedia article:
81  * AT&T and Sun collaborated on a project to merge the most popular Unix variants
82  * on the market at that time: BSD, System V, and Xenix.
83  * This became Unix System V Release 4 (SVR4).
84  *
85  * @internal
86  */
87 
88 /** Unknown platform. @internal */
89 #define U_PF_UNKNOWN 0
90 /** Windows @internal */
91 #define U_PF_WINDOWS 1000
92 /** MinGW. Windows, calls to Win32 API, but using GNU gcc and binutils. @internal */
93 #define U_PF_MINGW 1800
94 /**
95  * Cygwin. Windows, calls to cygwin1.dll for Posix functions,
96  * using MSVC or GNU gcc and binutils.
97  * @internal
98  */
99 #define U_PF_CYGWIN 1900
100 /* Reserve 2000 for U_PF_UNIX? */
101 /** HP-UX is based on UNIX System V. @internal */
102 #define U_PF_HPUX 2100
103 /** Solaris is a Unix operating system based on SVR4. @internal */
104 #define U_PF_SOLARIS 2600
105 /** BSD is a UNIX operating system derivative. @internal */
106 #define U_PF_BSD 3000
107 /** AIX is based on UNIX System V Releases and 4.3 BSD. @internal */
108 #define U_PF_AIX 3100
109 /** IRIX is based on UNIX System V with BSD extensions. @internal */
110 #define U_PF_IRIX 3200
111 /**
112  * Darwin is a POSIX-compliant operating system, composed of code developed by Apple,
113  * as well as code derived from NeXTSTEP, BSD, and other projects,
114  * built around the Mach kernel.
115  * Darwin forms the core set of components upon which Mac OS X, Apple TV, and iOS are based.
116  * (Original description modified from WikiPedia.)
117  * @internal
118  */
119 #define U_PF_DARWIN 3500
120 /** iPhone OS (iOS) is a derivative of Mac OS X. @internal */
121 #define U_PF_IPHONE 3550
122 /** QNX is a commercial Unix-like real-time operating system related to BSD. @internal */
123 #define U_PF_QNX 3700
124 /** Linux is a Unix-like operating system. @internal */
125 #define U_PF_LINUX 4000
126 /**
127  * Native Client is pretty close to Linux.
128  * See https://developer.chrome.com/native-client and
129  * http://www.chromium.org/nativeclient
130  * @internal
131  */
132 #define U_PF_BROWSER_NATIVE_CLIENT 4020
133 /** Android is based on Linux. @internal */
134 #define U_PF_ANDROID 4050
135 /** Fuchsia is a POSIX-ish platform. @internal */
136 #define U_PF_FUCHSIA 4100
137 /* Maximum value for Linux-based platform is 4499 */
138 /**
139  * Emscripten is a C++ transpiler for the Web that can target asm.js or
140  * WebAssembly. It provides some POSIX-compatible wrappers and stubs and
141  * some Linux-like functionality, but is not fully compatible with
142  * either.
143  * @internal
144  */
145 #define U_PF_EMSCRIPTEN 5010
146 /** z/OS is the successor to OS/390 which was the successor to MVS. @internal */
147 #define U_PF_OS390 9000
148 /** "IBM i" is the current name of what used to be i5/OS and earlier OS/400. @internal */
149 #define U_PF_OS400 9400
150 
151 #ifdef U_PLATFORM
152  /* Use the predefined value. */
153 #elif defined(__MINGW32__)
154 # define U_PLATFORM U_PF_MINGW
155 #elif defined(__CYGWIN__)
156 # define U_PLATFORM U_PF_CYGWIN
157 #elif defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
158 # define U_PLATFORM U_PF_WINDOWS
159 #elif defined(__ANDROID__)
160 # define U_PLATFORM U_PF_ANDROID
161  /* Android wchar_t support depends on the API level. */
162 # include <android/api-level.h>
163 #elif defined(__pnacl__) || defined(__native_client__)
164 # define U_PLATFORM U_PF_BROWSER_NATIVE_CLIENT
165 #elif defined(__Fuchsia__)
166 # define U_PLATFORM U_PF_FUCHSIA
167 #elif defined(linux) || defined(__linux__) || defined(__linux)
168 # define U_PLATFORM U_PF_LINUX
169 #elif defined(__APPLE__) && defined(__MACH__)
170 # include <TargetConditionals.h>
171 # if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE /* variant of TARGET_OS_MAC */
172 # define U_PLATFORM U_PF_IPHONE
173 # else
174 # define U_PLATFORM U_PF_DARWIN
175 # endif
176 #elif defined(BSD) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__MirBSD__)
177 # if defined(__FreeBSD__)
178 # include <sys/endian.h>
179 # endif
180 # define U_PLATFORM U_PF_BSD
181 #elif defined(sun) || defined(__sun)
182  /* Check defined(__SVR4) || defined(__svr4__) to distinguish Solaris from SunOS? */
183 # define U_PLATFORM U_PF_SOLARIS
184 # if defined(__GNUC__)
185  /* Solaris/GCC needs this header file to get the proper endianness. Normally, this
186  * header file is included with stddef.h but on Solairs/GCC, the GCC version of stddef.h
187  * is included which does not include this header file.
188  */
189 # include <sys/isa_defs.h>
190 # endif
191 #elif defined(_AIX) || defined(__TOS_AIX__)
192 # define U_PLATFORM U_PF_AIX
193 #elif defined(_hpux) || defined(hpux) || defined(__hpux)
194 # define U_PLATFORM U_PF_HPUX
195 #elif defined(sgi) || defined(__sgi)
196 # define U_PLATFORM U_PF_IRIX
197 #elif defined(__QNX__) || defined(__QNXNTO__)
198 # define U_PLATFORM U_PF_QNX
199 #elif defined(__TOS_MVS__)
200 # define U_PLATFORM U_PF_OS390
201 #elif defined(__OS400__) || defined(__TOS_OS400__)
202 # define U_PLATFORM U_PF_OS400
203 #elif defined(__EMSCRIPTEN__)
204 # define U_PLATFORM U_PF_EMSCRIPTEN
205 #else
206 # define U_PLATFORM U_PF_UNKNOWN
207 #endif
208 
209 /**
210  * \def CYGWINMSVC
211  * Defined if this is Windows with Cygwin, but using MSVC rather than gcc.
212  * Otherwise undefined.
213  * @internal
214  */
215 /* Commented out because this is already set in mh-cygwin-msvc
216 #if U_PLATFORM == U_PF_CYGWIN && defined(_MSC_VER)
217 # define CYGWINMSVC
218 #endif
219 */
220 #ifdef U_IN_DOXYGEN
221 # define CYGWINMSVC
222 #endif
223 
224 /**
225  * \def U_PLATFORM_USES_ONLY_WIN32_API
226  * Defines whether the platform uses only the Win32 API.
227  * Set to 1 for Windows/MSVC and MinGW but not Cygwin.
228  * @internal
229  */
230 #ifdef U_PLATFORM_USES_ONLY_WIN32_API
231  /* Use the predefined value. */
232 #elif (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_MINGW) || defined(CYGWINMSVC)
233 # define U_PLATFORM_USES_ONLY_WIN32_API 1
234 #else
235  /* Cygwin implements POSIX. */
236 # define U_PLATFORM_USES_ONLY_WIN32_API 0
237 #endif
238 
239 /**
240  * \def U_PLATFORM_HAS_WIN32_API
241  * Defines whether the Win32 API is available on the platform.
242  * Set to 1 for Windows/MSVC, MinGW and Cygwin.
243  * @internal
244  */
245 #ifdef U_PLATFORM_HAS_WIN32_API
246  /* Use the predefined value. */
247 #elif U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN
248 # define U_PLATFORM_HAS_WIN32_API 1
249 #else
250 # define U_PLATFORM_HAS_WIN32_API 0
251 #endif
252 
253 /**
254  * \def U_PLATFORM_HAS_WINUWP_API
255  * Defines whether target is intended for Universal Windows Platform API
256  * Set to 1 for Windows10 Release Solution Configuration
257  * @internal
258  */
259 #ifdef U_PLATFORM_HAS_WINUWP_API
260  /* Use the predefined value. */
261 #else
262 # define U_PLATFORM_HAS_WINUWP_API 0
263 #endif
264 
265 /**
266  * \def U_PLATFORM_IMPLEMENTS_POSIX
267  * Defines whether the platform implements (most of) the POSIX API.
268  * Set to 1 for Cygwin and most other platforms.
269  * @internal
270  */
271 #ifdef U_PLATFORM_IMPLEMENTS_POSIX
272  /* Use the predefined value. */
273 #elif U_PLATFORM_USES_ONLY_WIN32_API
274 # define U_PLATFORM_IMPLEMENTS_POSIX 0
275 #else
276 # define U_PLATFORM_IMPLEMENTS_POSIX 1
277 #endif
278 
279 /**
280  * \def U_PLATFORM_IS_LINUX_BASED
281  * Defines whether the platform is Linux or one of its derivatives.
282  * @internal
283  */
284 #ifdef U_PLATFORM_IS_LINUX_BASED
285  /* Use the predefined value. */
286 #elif U_PF_LINUX <= U_PLATFORM && U_PLATFORM <= 4499
287 # define U_PLATFORM_IS_LINUX_BASED 1
288 #else
289 # define U_PLATFORM_IS_LINUX_BASED 0
290 #endif
291 
292 /**
293  * \def U_PLATFORM_IS_DARWIN_BASED
294  * Defines whether the platform is Darwin or one of its derivatives.
295  * @internal
296  */
297 #ifdef U_PLATFORM_IS_DARWIN_BASED
298  /* Use the predefined value. */
299 #elif U_PF_DARWIN <= U_PLATFORM && U_PLATFORM <= U_PF_IPHONE
300 # define U_PLATFORM_IS_DARWIN_BASED 1
301 #else
302 # define U_PLATFORM_IS_DARWIN_BASED 0
303 #endif
304 
305 /**
306  * \def U_HAVE_STDINT_H
307  * Defines whether stdint.h is available. It is a C99 standard header.
308  * We used to include inttypes.h which includes stdint.h but we usually do not need
309  * the additional definitions from inttypes.h.
310  * @internal
311  */
312 #ifdef U_HAVE_STDINT_H
313  /* Use the predefined value. */
314 #elif U_PLATFORM_USES_ONLY_WIN32_API
315 # if defined(__BORLANDC__) || U_PLATFORM == U_PF_MINGW || (defined(_MSC_VER) && _MSC_VER>=1600)
316  /* Windows Visual Studio 9 and below do not have stdint.h & inttypes.h, but VS 2010 adds them. */
317 # define U_HAVE_STDINT_H 1
318 # else
319 # define U_HAVE_STDINT_H 0
320 # endif
321 #elif U_PLATFORM == U_PF_SOLARIS
322  /* Solaris has inttypes.h but not stdint.h. */
323 # define U_HAVE_STDINT_H 0
324 #elif U_PLATFORM == U_PF_AIX && !defined(_AIX51) && defined(_POWER)
325  /* PPC AIX <= 4.3 has inttypes.h but not stdint.h. */
326 # define U_HAVE_STDINT_H 0
327 #else
328 # define U_HAVE_STDINT_H 1
329 #endif
330 
331 /**
332  * \def U_HAVE_INTTYPES_H
333  * Defines whether inttypes.h is available. It is a C99 standard header.
334  * We include inttypes.h where it is available but stdint.h is not.
335  * @internal
336  */
337 /*
338  I have inttypes.h (--ak).
339 */
340 #ifdef ICUFORXeTeX
341 #define U_HAVE_INTTYPES_H 1
342 #endif
343 
344 #ifdef U_HAVE_INTTYPES_H
345  /* Use the predefined value. */
346 #elif U_PLATFORM == U_PF_SOLARIS
347  /* Solaris has inttypes.h but not stdint.h. */
348 # define U_HAVE_INTTYPES_H 1
349 #elif U_PLATFORM == U_PF_AIX && !defined(_AIX51) && defined(_POWER)
350  /* PPC AIX <= 4.3 has inttypes.h but not stdint.h. */
351 # define U_HAVE_INTTYPES_H 1
352 #else
353  /* Most platforms have both inttypes.h and stdint.h, or neither. */
354 # define U_HAVE_INTTYPES_H U_HAVE_STDINT_H
355 #endif
356 
357 /*===========================================================================*/
358 /** @{ Compiler and environment features */
359 /*===========================================================================*/
360 
361 /**
362  * \def U_GCC_MAJOR_MINOR
363  * Indicates whether the compiler is gcc (test for != 0),
364  * and if so, contains its major (times 100) and minor version numbers.
365  * If the compiler is not gcc, then U_GCC_MAJOR_MINOR == 0.
366  *
367  * For example, for testing for whether we have gcc, and whether it's 4.6 or higher,
368  * use "#if U_GCC_MAJOR_MINOR >= 406".
369  * @internal
370  */
371 #ifdef __GNUC__
372 # define U_GCC_MAJOR_MINOR (__GNUC__ * 100 + __GNUC_MINOR__)
373 #else
374 # define U_GCC_MAJOR_MINOR 0
375 #endif
376 
377 /**
378  * \def U_IS_BIG_ENDIAN
379  * Determines the endianness of the platform.
380  * @internal
381  */
382 #ifdef U_IS_BIG_ENDIAN
383  /* Use the predefined value. */
384 #elif defined(BYTE_ORDER) && defined(BIG_ENDIAN)
385 # define U_IS_BIG_ENDIAN (BYTE_ORDER == BIG_ENDIAN)
386 #elif defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__)
387  /* gcc */
388 # define U_IS_BIG_ENDIAN (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
389 #elif defined(__BIG_ENDIAN__) || defined(_BIG_ENDIAN)
390 # define U_IS_BIG_ENDIAN 1
391 #elif defined(__LITTLE_ENDIAN__) || defined(_LITTLE_ENDIAN)
392 # define U_IS_BIG_ENDIAN 0
393 #elif U_PLATFORM == U_PF_OS390 || U_PLATFORM == U_PF_OS400 || defined(__s390__) || defined(__s390x__)
394  /* These platforms do not appear to predefine any endianness macros. */
395 # define U_IS_BIG_ENDIAN 1
396 #elif defined(_PA_RISC1_0) || defined(_PA_RISC1_1) || defined(_PA_RISC2_0)
397  /* HPPA do not appear to predefine any endianness macros. */
398 # define U_IS_BIG_ENDIAN 1
399 #elif defined(sparc) || defined(__sparc) || defined(__sparc__)
400  /* Some sparc based systems (e.g. Linux) do not predefine any endianness macros. */
401 # define U_IS_BIG_ENDIAN 1
402 #else
403 # define U_IS_BIG_ENDIAN 0
404 #endif
405 
406 /**
407  * \def U_HAVE_PLACEMENT_NEW
408  * Determines whether to override placement new and delete for STL.
409  * @stable ICU 2.6
410  */
411 #ifdef U_HAVE_PLACEMENT_NEW
412  /* Use the predefined value. */
413 #elif defined(__BORLANDC__)
414 # define U_HAVE_PLACEMENT_NEW 0
415 #else
416 # define U_HAVE_PLACEMENT_NEW 1
417 #endif
418 
419 /**
420  * \def U_HAVE_DEBUG_LOCATION_NEW
421  * Define this to define the MFC debug version of the operator new.
422  *
423  * @stable ICU 3.4
424  */
425 #ifdef U_HAVE_DEBUG_LOCATION_NEW
426  /* Use the predefined value. */
427 #elif defined(_MSC_VER)
428 # define U_HAVE_DEBUG_LOCATION_NEW 1
429 #else
430 # define U_HAVE_DEBUG_LOCATION_NEW 0
431 #endif
432 
433 /* Compatibility with compilers other than clang: http://clang.llvm.org/docs/LanguageExtensions.html */
434 #ifdef __has_attribute
435 # define UPRV_HAS_ATTRIBUTE(x) __has_attribute(x)
436 #else
437 # define UPRV_HAS_ATTRIBUTE(x) 0
438 #endif
439 #ifdef __has_cpp_attribute
440 # define UPRV_HAS_CPP_ATTRIBUTE(x) __has_cpp_attribute(x)
441 #else
442 # define UPRV_HAS_CPP_ATTRIBUTE(x) 0
443 #endif
444 #ifdef __has_declspec_attribute
445 # define UPRV_HAS_DECLSPEC_ATTRIBUTE(x) __has_declspec_attribute(x)
446 #else
447 # define UPRV_HAS_DECLSPEC_ATTRIBUTE(x) 0
448 #endif
449 #ifdef __has_builtin
450 # define UPRV_HAS_BUILTIN(x) __has_builtin(x)
451 #else
452 # define UPRV_HAS_BUILTIN(x) 0
453 #endif
454 #ifdef __has_feature
455 # define UPRV_HAS_FEATURE(x) __has_feature(x)
456 #else
457 # define UPRV_HAS_FEATURE(x) 0
458 #endif
459 #ifdef __has_extension
460 # define UPRV_HAS_EXTENSION(x) __has_extension(x)
461 #else
462 # define UPRV_HAS_EXTENSION(x) 0
463 #endif
464 #ifdef __has_warning
465 # define UPRV_HAS_WARNING(x) __has_warning(x)
466 #else
467 # define UPRV_HAS_WARNING(x) 0
468 #endif
469 
470 /**
471  * \def U_MALLOC_ATTR
472  * Attribute to mark functions as malloc-like
473  * @internal
474  */
475 #if defined(__GNUC__) && __GNUC__>=3
476 # define U_MALLOC_ATTR __attribute__ ((__malloc__))
477 #else
478 # define U_MALLOC_ATTR
479 #endif
480 
481 /**
482  * \def U_ALLOC_SIZE_ATTR
483  * Attribute to specify the size of the allocated buffer for malloc-like functions
484  * @internal
485  */
486 #if (defined(__GNUC__) && \
487  (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3))) || \
488  UPRV_HAS_ATTRIBUTE(alloc_size)
489 # define U_ALLOC_SIZE_ATTR(X) __attribute__ ((alloc_size(X)))
490 # define U_ALLOC_SIZE_ATTR2(X,Y) __attribute__ ((alloc_size(X,Y)))
491 #else
492 # define U_ALLOC_SIZE_ATTR(X)
493 # define U_ALLOC_SIZE_ATTR2(X,Y)
494 #endif
495 
496 /**
497  * \def U_CPLUSPLUS_VERSION
498  * 0 if no C++; 1, 11, 14, ... if C++.
499  * Support for specific features cannot always be determined by the C++ version alone.
500  * @internal
501  */
502 #ifdef U_CPLUSPLUS_VERSION
503 # if U_CPLUSPLUS_VERSION != 0 && !defined(__cplusplus)
504 # undef U_CPLUSPLUS_VERSION
505 # define U_CPLUSPLUS_VERSION 0
506 # endif
507  /* Otherwise use the predefined value. */
508 #elif !defined(__cplusplus)
509 # define U_CPLUSPLUS_VERSION 0
510 #elif __cplusplus >= 201402L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201402L)
511 # define U_CPLUSPLUS_VERSION 14
512 #elif __cplusplus >= 201103L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201103L)
513 # define U_CPLUSPLUS_VERSION 11
514 #else
515  // C++98 or C++03
516 # define U_CPLUSPLUS_VERSION 1
517 #endif
518 
519 #if (U_PLATFORM == U_PF_AIX || U_PLATFORM == U_PF_OS390) && defined(__cplusplus) &&(U_CPLUSPLUS_VERSION < 11)
520 // add in std::nullptr_t
521 namespace std {
522  typedef decltype(nullptr) nullptr_t;
523 };
524 #endif
525 
526 /**
527  * \def U_NOEXCEPT
528  * "noexcept" if supported, otherwise empty.
529  * Some code, especially STL containers, uses move semantics of objects only
530  * if the move constructor and the move operator are declared as not throwing exceptions.
531  * @internal
532  */
533 #ifdef U_NOEXCEPT
534  /* Use the predefined value. */
535 #else
536 # define U_NOEXCEPT noexcept
537 #endif
538 
539 /**
540  * \def U_FALLTHROUGH
541  * Annotate intentional fall-through between switch labels.
542  * http://clang.llvm.org/docs/AttributeReference.html#fallthrough-clang-fallthrough
543  * @internal
544  */
545 #ifndef __cplusplus
546  // Not for C.
547 #elif defined(U_FALLTHROUGH)
548  // Use the predefined value.
549 #elif defined(__clang__)
550  // Test for compiler vs. feature separately.
551  // Other compilers might choke on the feature test.
552 # if UPRV_HAS_CPP_ATTRIBUTE(clang::fallthrough) || \
553  (UPRV_HAS_FEATURE(cxx_attributes) && \
554  UPRV_HAS_WARNING("-Wimplicit-fallthrough"))
555 # define U_FALLTHROUGH [[clang::fallthrough]]
556 # endif
557 #elif defined(__GNUC__) && (__GNUC__ >= 7)
558 # define U_FALLTHROUGH __attribute__((fallthrough))
559 #endif
560 
561 #ifndef U_FALLTHROUGH
562 # define U_FALLTHROUGH
563 #endif
564 
565 /** @} */
566 
567 /*===========================================================================*/
568 /** @{ Character data types */
569 /*===========================================================================*/
570 
571 /**
572  * U_CHARSET_FAMILY is equal to this value when the platform is an ASCII based platform.
573  * @stable ICU 2.0
574  */
575 #define U_ASCII_FAMILY 0
576 
577 /**
578  * U_CHARSET_FAMILY is equal to this value when the platform is an EBCDIC based platform.
579  * @stable ICU 2.0
580  */
581 #define U_EBCDIC_FAMILY 1
582 
583 /**
584  * \def U_CHARSET_FAMILY
585  *
586  * <p>These definitions allow to specify the encoding of text
587  * in the char data type as defined by the platform and the compiler.
588  * It is enough to determine the code point values of "invariant characters",
589  * which are the ones shared by all encodings that are in use
590  * on a given platform.</p>
591  *
592  * <p>Those "invariant characters" should be all the uppercase and lowercase
593  * latin letters, the digits, the space, and "basic punctuation".
594  * Also, '\\n', '\\r', '\\t' should be available.</p>
595  *
596  * <p>The list of "invariant characters" is:<br>
597  * \code
598  * A-Z a-z 0-9 SPACE " % &amp; ' ( ) * + , - . / : ; < = > ? _
599  * \endcode
600  * <br>
601  * (52 letters + 10 numbers + 20 punc/sym/space = 82 total)</p>
602  *
603  * <p>This matches the IBM Syntactic Character Set (CS 640).</p>
604  *
605  * <p>In other words, all the graphic characters in 7-bit ASCII should
606  * be safely accessible except the following:</p>
607  *
608  * \code
609  * '\' <backslash>
610  * '[' <left bracket>
611  * ']' <right bracket>
612  * '{' <left brace>
613  * '}' <right brace>
614  * '^' <circumflex>
615  * '~' <tilde>
616  * '!' <exclamation mark>
617  * '#' <number sign>
618  * '|' <vertical line>
619  * '$' <dollar sign>
620  * '@' <commercial at>
621  * '`' <grave accent>
622  * \endcode
623  * @stable ICU 2.0
624  */
625 #ifdef U_CHARSET_FAMILY
626  /* Use the predefined value. */
627 #elif U_PLATFORM == U_PF_OS390 && (!defined(__CHARSET_LIB) || !__CHARSET_LIB)
628 # define U_CHARSET_FAMILY U_EBCDIC_FAMILY
629 #elif U_PLATFORM == U_PF_OS400 && !defined(__UTF32__)
630 # define U_CHARSET_FAMILY U_EBCDIC_FAMILY
631 #else
632 # define U_CHARSET_FAMILY U_ASCII_FAMILY
633 #endif
634 
635 /**
636  * \def U_CHARSET_IS_UTF8
637  *
638  * Hardcode the default charset to UTF-8.
639  *
640  * If this is set to 1, then
641  * - ICU will assume that all non-invariant char*, StringPiece, std::string etc.
642  * contain UTF-8 text, regardless of what the system API uses
643  * - some ICU code will use fast functions like u_strFromUTF8()
644  * rather than the more general and more heavy-weight conversion API (ucnv.h)
645  * - ucnv_getDefaultName() always returns "UTF-8"
646  * - ucnv_setDefaultName() is disabled and will not change the default charset
647  * - static builds of ICU are smaller
648  * - more functionality is available with the UCONFIG_NO_CONVERSION build-time
649  * configuration option (see unicode/uconfig.h)
650  * - the UCONFIG_NO_CONVERSION build option in uconfig.h is more usable
651  *
652  * @stable ICU 4.2
653  * @see UCONFIG_NO_CONVERSION
654  */
655 #ifdef U_CHARSET_IS_UTF8
656  /* Use the predefined value. */
657 #elif U_PLATFORM_IS_LINUX_BASED || U_PLATFORM_IS_DARWIN_BASED || \
658  U_PLATFORM == U_PF_EMSCRIPTEN
659 # define U_CHARSET_IS_UTF8 1
660 #else
661 # define U_CHARSET_IS_UTF8 0
662 #endif
663 
664 /** @} */
665 
666 /*===========================================================================*/
667 /** @{ Information about wchar support */
668 /*===========================================================================*/
669 
670 /**
671  * \def U_HAVE_WCHAR_H
672  * Indicates whether <wchar.h> is available (1) or not (0). Set to 1 by default.
673  *
674  * @stable ICU 2.0
675  */
676 #ifdef U_HAVE_WCHAR_H
677  /* Use the predefined value. */
678 #elif U_PLATFORM == U_PF_ANDROID && __ANDROID_API__ < 9
679  /*
680  * Android before Gingerbread (Android 2.3, API level 9) did not support wchar_t.
681  * The type and header existed, but the library functions did not work as expected.
682  * The size of wchar_t was 1 but L"xyz" string literals had 32-bit units anyway.
683  */
684 # define U_HAVE_WCHAR_H 0
685 #else
686 # define U_HAVE_WCHAR_H 1
687 #endif
688 
689 /**
690  * \def U_SIZEOF_WCHAR_T
691  * U_SIZEOF_WCHAR_T==sizeof(wchar_t)
692  *
693  * @stable ICU 2.0
694  */
695 #ifdef U_SIZEOF_WCHAR_T
696  /* Use the predefined value. */
697 #elif (U_PLATFORM == U_PF_ANDROID && __ANDROID_API__ < 9)
698  /*
699  * Classic Mac OS and Mac OS X before 10.3 (Panther) did not support wchar_t or wstring.
700  * Newer Mac OS X has size 4.
701  */
702 # define U_SIZEOF_WCHAR_T 1
703 #elif U_PLATFORM_HAS_WIN32_API || U_PLATFORM == U_PF_CYGWIN
704 # define U_SIZEOF_WCHAR_T 2
705 #elif U_PLATFORM == U_PF_AIX
706  /*
707  * AIX 6.1 information, section "Wide character data representation":
708  * "... the wchar_t datatype is 32-bit in the 64-bit environment and
709  * 16-bit in the 32-bit environment."
710  * and
711  * "All locales use Unicode for their wide character code values (process code),
712  * except the IBM-eucTW codeset."
713  */
714 # ifdef __64BIT__
715 # define U_SIZEOF_WCHAR_T 4
716 # else
717 # define U_SIZEOF_WCHAR_T 2
718 # endif
719 #elif U_PLATFORM == U_PF_OS390
720  /*
721  * z/OS V1R11 information center, section "LP64 | ILP32":
722  * "In 31-bit mode, the size of long and pointers is 4 bytes and the size of wchar_t is 2 bytes.
723  * Under LP64, the size of long and pointer is 8 bytes and the size of wchar_t is 4 bytes."
724  */
725 # ifdef _LP64
726 # define U_SIZEOF_WCHAR_T 4
727 # else
728 # define U_SIZEOF_WCHAR_T 2
729 # endif
730 #elif U_PLATFORM == U_PF_OS400
731 # if defined(__UTF32__)
732  /*
733  * LOCALETYPE(*LOCALEUTF) is specified.
734  * Wide-character strings are in UTF-32,
735  * narrow-character strings are in UTF-8.
736  */
737 # define U_SIZEOF_WCHAR_T 4
738 # elif defined(__UCS2__)
739  /*
740  * LOCALETYPE(*LOCALEUCS2) is specified.
741  * Wide-character strings are in UCS-2,
742  * narrow-character strings are in EBCDIC.
743  */
744 # define U_SIZEOF_WCHAR_T 2
745 # else
746  /*
747  * LOCALETYPE(*CLD) or LOCALETYPE(*LOCALE) is specified.
748  * Wide-character strings are in 16-bit EBCDIC,
749  * narrow-character strings are in EBCDIC.
750  */
751 # define U_SIZEOF_WCHAR_T 2
752 # endif
753 #else
754 # define U_SIZEOF_WCHAR_T 4
755 #endif
756 
757 #ifndef U_HAVE_WCSCPY
758 #define U_HAVE_WCSCPY U_HAVE_WCHAR_H
759 #endif
760 
761 /** @} */
762 
763 /**
764  * \def U_HAVE_CHAR16_T
765  * Defines whether the char16_t type is available for UTF-16
766  * and u"abc" UTF-16 string literals are supported.
767  * This is a new standard type and standard string literal syntax in C++0x
768  * but has been available in some compilers before.
769  * @internal
770  */
771 #ifdef U_HAVE_CHAR16_T
772  /* Use the predefined value. */
773 #else
774  /*
775  * Notes:
776  * Visual Studio 2010 (_MSC_VER==1600) defines char16_t as a typedef
777  * and does not support u"abc" string literals.
778  * Visual Studio 2015 (_MSC_VER>=1900) and above adds support for
779  * both char16_t and u"abc" string literals.
780  * gcc 4.4 defines the __CHAR16_TYPE__ macro to a usable type but
781  * does not support u"abc" string literals.
782  * C++11 and C11 require support for UTF-16 literals
783  * TODO: Fix for plain C. Doesn't work on Mac.
784  */
785 # if U_CPLUSPLUS_VERSION >= 11 || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L)
786 # define U_HAVE_CHAR16_T 1
787 # else
788 # define U_HAVE_CHAR16_T 0
789 # endif
790 #endif
791 
792 /**
793  * @{
794  * \def U_DECLARE_UTF16
795  * Do not use this macro because it is not defined on all platforms.
796  * Use the UNICODE_STRING or U_STRING_DECL macros instead.
797  * @internal
798  */
799 #ifdef U_DECLARE_UTF16
800  /* Use the predefined value. */
801 #elif U_HAVE_CHAR16_T \
802  || (defined(__xlC__) && defined(__IBM_UTF_LITERAL) && U_SIZEOF_WCHAR_T != 2) \
803  || (defined(__HP_aCC) && __HP_aCC >= 035000) \
804  || (defined(__HP_cc) && __HP_cc >= 111106) \
805  || (defined(U_IN_DOXYGEN))
806 # define U_DECLARE_UTF16(string) u ## string
807 #elif U_SIZEOF_WCHAR_T == 2 \
808  && (U_CHARSET_FAMILY == 0 || (U_PF_OS390 <= U_PLATFORM && U_PLATFORM <= U_PF_OS400 && defined(__UCS2__)))
809 # define U_DECLARE_UTF16(string) L ## string
810 #else
811  /* Leave U_DECLARE_UTF16 undefined. See unistr.h. */
812 #endif
813 
814 /** @} */
815 
816 /*===========================================================================*/
817 /** @{ Symbol import-export control */
818 /*===========================================================================*/
819 
820 #ifdef U_EXPORT
821  /* Use the predefined value. */
822 #elif defined(U_STATIC_IMPLEMENTATION)
823 # define U_EXPORT
824 #elif defined(_MSC_VER) || (UPRV_HAS_DECLSPEC_ATTRIBUTE(dllexport) && \
825  UPRV_HAS_DECLSPEC_ATTRIBUTE(dllimport))
826 # define U_EXPORT __declspec(dllexport)
827 #elif defined(__GNUC__)
828 # define U_EXPORT __attribute__((visibility("default")))
829 #elif (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x550) \
830  || (defined(__SUNPRO_C) && __SUNPRO_C >= 0x550)
831 # define U_EXPORT __global
832 /*#elif defined(__HP_aCC) || defined(__HP_cc)
833 # define U_EXPORT __declspec(dllexport)*/
834 #else
835 # define U_EXPORT
836 #endif
837 
838 /* U_CALLCONV is related to U_EXPORT2 */
839 #ifdef U_EXPORT2
840  /* Use the predefined value. */
841 #elif defined(_MSC_VER)
842 # define U_EXPORT2 __cdecl
843 #else
844 # define U_EXPORT2
845 #endif
846 
847 #ifdef U_IMPORT
848  /* Use the predefined value. */
849 #elif defined(_MSC_VER) || (UPRV_HAS_DECLSPEC_ATTRIBUTE(dllexport) && \
850  UPRV_HAS_DECLSPEC_ATTRIBUTE(dllimport))
851  /* Windows needs to export/import data. */
852 # define U_IMPORT __declspec(dllimport)
853 #else
854 # define U_IMPORT
855 #endif
856 
857 /**
858  * \def U_CALLCONV
859  * Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary
860  * in callback function typedefs to make sure that the calling convention
861  * is compatible.
862  *
863  * This is only used for non-ICU-API functions.
864  * When a function is a public ICU API,
865  * you must use the U_CAPI and U_EXPORT2 qualifiers.
866  *
867  * Please note, you need to use U_CALLCONV after the *.
868  *
869  * NO : "static const char U_CALLCONV *func( . . . )"
870  * YES: "static const char* U_CALLCONV func( . . . )"
871  *
872  * @stable ICU 2.0
873  */
874 #if U_PLATFORM == U_PF_OS390 && defined(__cplusplus)
875 # define U_CALLCONV __cdecl
876 #else
877 # define U_CALLCONV U_EXPORT2
878 #endif
879 
880 /**
881  * \def U_CALLCONV_FPTR
882  * Similar to U_CALLCONV, but only used on function pointers.
883  * @internal
884  */
885 #if U_PLATFORM == U_PF_OS390 && defined(__cplusplus)
886 # define U_CALLCONV_FPTR U_CALLCONV
887 #else
888 # define U_CALLCONV_FPTR
889 #endif
890 /* @} */
891 
892 #endif // _PLATFORM_H
STL namespace.
User-configurable settings.
C API: definitions of ICU version numbers.