ICU 59.1  59.1
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 
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 
89 #define U_PF_UNKNOWN 0
90 
91 #define U_PF_WINDOWS 1000
92 
93 #define U_PF_MINGW 1800
94 
99 #define U_PF_CYGWIN 1900
100 /* Reserve 2000 for U_PF_UNIX? */
102 #define U_PF_HPUX 2100
103 
104 #define U_PF_SOLARIS 2600
105 
106 #define U_PF_BSD 3000
107 
108 #define U_PF_AIX 3100
109 
110 #define U_PF_IRIX 3200
111 
119 #define U_PF_DARWIN 3500
120 
121 #define U_PF_IPHONE 3550
122 
123 #define U_PF_QNX 3700
124 
125 #define U_PF_LINUX 4000
126 
132 #define U_PF_BROWSER_NATIVE_CLIENT 4020
133 
134 #define U_PF_ANDROID 4050
135 /* Maximum value for Linux-based platform is 4499 */
137 #define U_PF_OS390 9000
138 
139 #define U_PF_OS400 9400
140 
141 #ifdef U_PLATFORM
142  /* Use the predefined value. */
143 #elif defined(__MINGW32__)
144 # define U_PLATFORM U_PF_MINGW
145 #elif defined(__CYGWIN__)
146 # define U_PLATFORM U_PF_CYGWIN
147 #elif defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
148 # define U_PLATFORM U_PF_WINDOWS
149 #elif defined(__ANDROID__)
150 # define U_PLATFORM U_PF_ANDROID
151  /* Android wchar_t support depends on the API level. */
152 # include <android/api-level.h>
153 #elif defined(__pnacl__) || defined(__native_client__)
154 # define U_PLATFORM U_PF_BROWSER_NATIVE_CLIENT
155 #elif defined(linux) || defined(__linux__) || defined(__linux)
156 # define U_PLATFORM U_PF_LINUX
157 #elif defined(__APPLE__) && defined(__MACH__)
158 # include <TargetConditionals.h>
159 # if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE /* variant of TARGET_OS_MAC */
160 # define U_PLATFORM U_PF_IPHONE
161 # else
162 # define U_PLATFORM U_PF_DARWIN
163 # endif
164 #elif defined(BSD) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__MirBSD__)
165 # if defined(__FreeBSD__)
166 # include <sys/endian.h>
167 # endif
168 # define U_PLATFORM U_PF_BSD
169 #elif defined(sun) || defined(__sun)
170  /* Check defined(__SVR4) || defined(__svr4__) to distinguish Solaris from SunOS? */
171 # define U_PLATFORM U_PF_SOLARIS
172 # if defined(__GNUC__)
173  /* Solaris/GCC needs this header file to get the proper endianness. Normally, this
174  * header file is included with stddef.h but on Solairs/GCC, the GCC version of stddef.h
175  * is included which does not include this header file.
176  */
177 # include <sys/isa_defs.h>
178 # endif
179 #elif defined(_AIX) || defined(__TOS_AIX__)
180 # define U_PLATFORM U_PF_AIX
181 #elif defined(_hpux) || defined(hpux) || defined(__hpux)
182 # define U_PLATFORM U_PF_HPUX
183 #elif defined(sgi) || defined(__sgi)
184 # define U_PLATFORM U_PF_IRIX
185 #elif defined(__QNX__) || defined(__QNXNTO__)
186 # define U_PLATFORM U_PF_QNX
187 #elif defined(__TOS_MVS__)
188 # define U_PLATFORM U_PF_OS390
189 #elif defined(__OS400__) || defined(__TOS_OS400__)
190 # define U_PLATFORM U_PF_OS400
191 #else
192 # define U_PLATFORM U_PF_UNKNOWN
193 #endif
194 
201 /* Commented out because this is already set in mh-cygwin-msvc
202 #if U_PLATFORM == U_PF_CYGWIN && defined(_MSC_VER)
203 # define CYGWINMSVC
204 #endif
205 */
206 
213 #ifdef U_PLATFORM_USES_ONLY_WIN32_API
214  /* Use the predefined value. */
215 #elif (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_MINGW) || defined(CYGWINMSVC)
216 # define U_PLATFORM_USES_ONLY_WIN32_API 1
217 #else
218  /* Cygwin implements POSIX. */
219 # define U_PLATFORM_USES_ONLY_WIN32_API 0
220 #endif
221 
228 #ifdef U_PLATFORM_HAS_WIN32_API
229  /* Use the predefined value. */
230 #elif U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN
231 # define U_PLATFORM_HAS_WIN32_API 1
232 #else
233 # define U_PLATFORM_HAS_WIN32_API 0
234 #endif
235 
242 #ifdef U_PLATFORM_HAS_WINUWP_API
243  /* Use the predefined value. */
244 #else
245 # define U_PLATFORM_HAS_WINUWP_API 0
246 #endif
247 
254 #ifdef U_PLATFORM_IMPLEMENTS_POSIX
255  /* Use the predefined value. */
256 #elif U_PLATFORM_USES_ONLY_WIN32_API
257 # define U_PLATFORM_IMPLEMENTS_POSIX 0
258 #else
259 # define U_PLATFORM_IMPLEMENTS_POSIX 1
260 #endif
261 
267 #ifdef U_PLATFORM_IS_LINUX_BASED
268  /* Use the predefined value. */
269 #elif U_PF_LINUX <= U_PLATFORM && U_PLATFORM <= 4499
270 # define U_PLATFORM_IS_LINUX_BASED 1
271 #else
272 # define U_PLATFORM_IS_LINUX_BASED 0
273 #endif
274 
280 #ifdef U_PLATFORM_IS_DARWIN_BASED
281  /* Use the predefined value. */
282 #elif U_PF_DARWIN <= U_PLATFORM && U_PLATFORM <= U_PF_IPHONE
283 # define U_PLATFORM_IS_DARWIN_BASED 1
284 #else
285 # define U_PLATFORM_IS_DARWIN_BASED 0
286 #endif
287 
295 #ifdef U_HAVE_STDINT_H
296  /* Use the predefined value. */
297 #elif U_PLATFORM_USES_ONLY_WIN32_API
298 # if defined(__BORLANDC__) || U_PLATFORM == U_PF_MINGW || (defined(_MSC_VER) && _MSC_VER>=1600)
299  /* Windows Visual Studio 9 and below do not have stdint.h & inttypes.h, but VS 2010 adds them. */
300 # define U_HAVE_STDINT_H 1
301 # else
302 # define U_HAVE_STDINT_H 0
303 # endif
304 #elif U_PLATFORM == U_PF_SOLARIS
305  /* Solaris has inttypes.h but not stdint.h. */
306 # define U_HAVE_STDINT_H 0
307 #elif U_PLATFORM == U_PF_AIX && !defined(_AIX51) && defined(_POWER)
308  /* PPC AIX <= 4.3 has inttypes.h but not stdint.h. */
309 # define U_HAVE_STDINT_H 0
310 #else
311 # define U_HAVE_STDINT_H 1
312 #endif
313 
320 #ifdef U_HAVE_INTTYPES_H
321  /* Use the predefined value. */
322 #elif U_PLATFORM == U_PF_SOLARIS
323  /* Solaris has inttypes.h but not stdint.h. */
324 # define U_HAVE_INTTYPES_H 1
325 #elif U_PLATFORM == U_PF_AIX && !defined(_AIX51) && defined(_POWER)
326  /* PPC AIX <= 4.3 has inttypes.h but not stdint.h. */
327 # define U_HAVE_INTTYPES_H 1
328 #else
329  /* Most platforms have both inttypes.h and stdint.h, or neither. */
330 # define U_HAVE_INTTYPES_H U_HAVE_STDINT_H
331 #endif
332 
354 #ifndef U_IOSTREAM_SOURCE
355 #define U_IOSTREAM_SOURCE 199711
356 #endif
357 
358 /*===========================================================================*/
360 /*===========================================================================*/
361 
372 #ifdef __GNUC__
373 # define U_GCC_MAJOR_MINOR (__GNUC__ * 100 + __GNUC_MINOR__)
374 #else
375 # define U_GCC_MAJOR_MINOR 0
376 #endif
377 
383 #ifdef U_IS_BIG_ENDIAN
384  /* Use the predefined value. */
385 #elif defined(BYTE_ORDER) && defined(BIG_ENDIAN)
386 # define U_IS_BIG_ENDIAN (BYTE_ORDER == BIG_ENDIAN)
387 #elif defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__)
388  /* gcc */
389 # define U_IS_BIG_ENDIAN (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
390 #elif defined(__BIG_ENDIAN__) || defined(_BIG_ENDIAN)
391 # define U_IS_BIG_ENDIAN 1
392 #elif defined(__LITTLE_ENDIAN__) || defined(_LITTLE_ENDIAN)
393 # define U_IS_BIG_ENDIAN 0
394 #elif U_PLATFORM == U_PF_OS390 || U_PLATFORM == U_PF_OS400 || defined(__s390__) || defined(__s390x__)
395  /* These platforms do not appear to predefine any endianness macros. */
396 # define U_IS_BIG_ENDIAN 1
397 #elif defined(_PA_RISC1_0) || defined(_PA_RISC1_1) || defined(_PA_RISC2_0)
398  /* HPPA do not appear to predefine any endianness macros. */
399 # define U_IS_BIG_ENDIAN 1
400 #elif defined(sparc) || defined(__sparc) || defined(__sparc__)
401  /* Some sparc based systems (e.g. Linux) do not predefine any endianness macros. */
402 # define U_IS_BIG_ENDIAN 1
403 #else
404 # define U_IS_BIG_ENDIAN 0
405 #endif
406 
412 #ifdef U_HAVE_PLACEMENT_NEW
413  /* Use the predefined value. */
414 #elif defined(__BORLANDC__)
415 # define U_HAVE_PLACEMENT_NEW 0
416 #else
417 # define U_HAVE_PLACEMENT_NEW 1
418 #endif
419 
426 #ifdef U_HAVE_DEBUG_LOCATION_NEW
427  /* Use the predefined value. */
428 #elif defined(_MSC_VER)
429 # define U_HAVE_DEBUG_LOCATION_NEW 1
430 #else
431 # define U_HAVE_DEBUG_LOCATION_NEW 0
432 #endif
433 
434 /* Compatibility with compilers other than clang: http://clang.llvm.org/docs/LanguageExtensions.html */
435 #ifndef __has_attribute
436 # define __has_attribute(x) 0
437 #endif
438 #ifndef __has_cpp_attribute
439 # define __has_cpp_attribute(x) 0
440 #endif
441 #ifndef __has_builtin
442 # define __has_builtin(x) 0
443 #endif
444 #ifndef __has_feature
445 # define __has_feature(x) 0
446 #endif
447 #ifndef __has_extension
448 # define __has_extension(x) 0
449 #endif
450 #ifndef __has_warning
451 # define __has_warning(x) 0
452 #endif
453 
459 #if defined(__GNUC__) && __GNUC__>=3
460 # define U_MALLOC_ATTR __attribute__ ((__malloc__))
461 #else
462 # define U_MALLOC_ATTR
463 #endif
464 
470 #if (defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3))) || __has_attribute(alloc_size)
471 # define U_ALLOC_SIZE_ATTR(X) __attribute__ ((alloc_size(X)))
472 # define U_ALLOC_SIZE_ATTR2(X,Y) __attribute__ ((alloc_size(X,Y)))
473 #else
474 # define U_ALLOC_SIZE_ATTR(X)
475 # define U_ALLOC_SIZE_ATTR2(X,Y)
476 #endif
477 
484 #ifdef U_CPLUSPLUS_VERSION
485 # if U_CPLUSPLUS_VERSION != 0 && !defined(__cplusplus)
486 # undef U_CPLUSPLUS_VERSION
487 # define U_CPLUSPLUS_VERSION 0
488 # endif
489  /* Otherwise use the predefined value. */
490 #elif !defined(__cplusplus)
491 # define U_CPLUSPLUS_VERSION 0
492 #elif __cplusplus >= 201402L
493 # define U_CPLUSPLUS_VERSION 14
494 #elif __cplusplus >= 201103L
495 # define U_CPLUSPLUS_VERSION 11
496 #else
497  // C++98 or C++03
498 # define U_CPLUSPLUS_VERSION 1
499 #endif
500 
501 #if (U_PLATFORM == U_PF_AIX || U_PLATFORM == U_PF_OS390) && defined(__cplusplus) &&(U_CPLUSPLUS_VERSION < 11)
502 // add in std::nullptr_t
503 namespace std {
504  typedef decltype(nullptr) nullptr_t;
505 };
506 #endif
507 
514 #ifdef U_HAVE_RVALUE_REFERENCES
515  /* Use the predefined value. */
516 #elif U_CPLUSPLUS_VERSION >= 11 || __has_feature(cxx_rvalue_references) \
517  || defined(__GXX_EXPERIMENTAL_CXX0X__) \
518  || (defined(_MSC_VER) && _MSC_VER >= 1600) /* Visual Studio 2010 */
519 # define U_HAVE_RVALUE_REFERENCES 1
520 #else
521 # define U_HAVE_RVALUE_REFERENCES 0
522 #endif
523 
531 #ifdef U_NOEXCEPT
532  /* Use the predefined value. */
533 #elif defined(_HAS_EXCEPTIONS) && !_HAS_EXCEPTIONS /* Visual Studio */
534 # define U_NOEXCEPT
535 #elif U_CPLUSPLUS_VERSION >= 11 || __has_feature(cxx_noexcept) || __has_extension(cxx_noexcept) \
536  || (defined(_MSC_VER) && _MSC_VER >= 1900) /* Visual Studio 2015 */
537 # define U_NOEXCEPT noexcept
538 #else
539 # define U_NOEXCEPT
540 #endif
541 
548 #ifndef __cplusplus
549  // Not for C.
550 #elif defined(U_FALLTHROUGH)
551  // Use the predefined value.
552 #elif defined(__clang__)
553  // Test for compiler vs. feature separately.
554  // Other compilers might choke on the feature test.
555 # if __has_cpp_attribute(clang::fallthrough) || \
556  (__has_feature(cxx_attributes) && __has_warning("-Wimplicit-fallthrough"))
557 # define U_FALLTHROUGH [[clang::fallthrough]]
558 # endif
559 #endif
560 
561 #ifndef U_FALLTHROUGH
562 # define U_FALLTHROUGH
563 #endif
564 
567 /*===========================================================================*/
569 /*===========================================================================*/
570 
575 #define U_ASCII_FAMILY 0
576 
581 #define U_EBCDIC_FAMILY 1
582 
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 
655 #ifdef U_CHARSET_IS_UTF8
656  /* Use the predefined value. */
657 #elif U_PLATFORM == U_PF_ANDROID || U_PLATFORM_IS_DARWIN_BASED
658 # define U_CHARSET_IS_UTF8 1
659 #else
660 # define U_CHARSET_IS_UTF8 0
661 #endif
662 
665 /*===========================================================================*/
667 /*===========================================================================*/
668 
675 #ifdef U_HAVE_WCHAR_H
676  /* Use the predefined value. */
677 #elif U_PLATFORM == U_PF_ANDROID && __ANDROID_API__ < 9
678  /*
679  * Android before Gingerbread (Android 2.3, API level 9) did not support wchar_t.
680  * The type and header existed, but the library functions did not work as expected.
681  * The size of wchar_t was 1 but L"xyz" string literals had 32-bit units anyway.
682  */
683 # define U_HAVE_WCHAR_H 0
684 #else
685 # define U_HAVE_WCHAR_H 1
686 #endif
687 
694 #ifdef U_SIZEOF_WCHAR_T
695  /* Use the predefined value. */
696 #elif (U_PLATFORM == U_PF_ANDROID && __ANDROID_API__ < 9)
697  /*
698  * Classic Mac OS and Mac OS X before 10.3 (Panther) did not support wchar_t or wstring.
699  * Newer Mac OS X has size 4.
700  */
701 # define U_SIZEOF_WCHAR_T 1
702 #elif U_PLATFORM_HAS_WIN32_API || U_PLATFORM == U_PF_CYGWIN
703 # define U_SIZEOF_WCHAR_T 2
704 #elif U_PLATFORM == U_PF_AIX
705  /*
706  * AIX 6.1 information, section "Wide character data representation":
707  * "... the wchar_t datatype is 32-bit in the 64-bit environment and
708  * 16-bit in the 32-bit environment."
709  * and
710  * "All locales use Unicode for their wide character code values (process code),
711  * except the IBM-eucTW codeset."
712  */
713 # ifdef __64BIT__
714 # define U_SIZEOF_WCHAR_T 4
715 # else
716 # define U_SIZEOF_WCHAR_T 2
717 # endif
718 #elif U_PLATFORM == U_PF_OS390
719  /*
720  * z/OS V1R11 information center, section "LP64 | ILP32":
721  * "In 31-bit mode, the size of long and pointers is 4 bytes and the size of wchar_t is 2 bytes.
722  * Under LP64, the size of long and pointer is 8 bytes and the size of wchar_t is 4 bytes."
723  */
724 # ifdef _LP64
725 # define U_SIZEOF_WCHAR_T 4
726 # else
727 # define U_SIZEOF_WCHAR_T 2
728 # endif
729 #elif U_PLATFORM == U_PF_OS400
730 # if defined(__UTF32__)
731  /*
732  * LOCALETYPE(*LOCALEUTF) is specified.
733  * Wide-character strings are in UTF-32,
734  * narrow-character strings are in UTF-8.
735  */
736 # define U_SIZEOF_WCHAR_T 4
737 # elif defined(__UCS2__)
738  /*
739  * LOCALETYPE(*LOCALEUCS2) is specified.
740  * Wide-character strings are in UCS-2,
741  * narrow-character strings are in EBCDIC.
742  */
743 # define U_SIZEOF_WCHAR_T 2
744 #else
745  /*
746  * LOCALETYPE(*CLD) or LOCALETYPE(*LOCALE) is specified.
747  * Wide-character strings are in 16-bit EBCDIC,
748  * narrow-character strings are in EBCDIC.
749  */
750 # define U_SIZEOF_WCHAR_T 2
751 # endif
752 #else
753 # define U_SIZEOF_WCHAR_T 4
754 #endif
755 
756 #ifndef U_HAVE_WCSCPY
757 #define U_HAVE_WCSCPY U_HAVE_WCHAR_H
758 #endif
759 
770 #ifdef U_HAVE_CHAR16_T
771  /* Use the predefined value. */
772 #else
773  /*
774  * Notes:
775  * Visual Studio 10 (_MSC_VER>=1600) defines char16_t but
776  * does not support u"abc" string literals.
777  * gcc 4.4 defines the __CHAR16_TYPE__ macro to a usable type but
778  * does not support u"abc" string literals.
779  * C++11 and C11 require support for UTF-16 literals
780  * TODO: Fix for plain C. Doesn't work on Mac.
781  */
782 # if U_CPLUSPLUS_VERSION >= 11 || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L)
783 # define U_HAVE_CHAR16_T 1
784 # else
785 # define U_HAVE_CHAR16_T 0
786 # endif
787 #endif
788 
796 #ifdef U_DECLARE_UTF16
797  /* Use the predefined value. */
798 #elif U_HAVE_CHAR16_T \
799  || (defined(__xlC__) && defined(__IBM_UTF_LITERAL) && U_SIZEOF_WCHAR_T != 2) \
800  || (defined(__HP_aCC) && __HP_aCC >= 035000) \
801  || (defined(__HP_cc) && __HP_cc >= 111106)
802 # define U_DECLARE_UTF16(string) u ## string
803 #elif U_SIZEOF_WCHAR_T == 2 \
804  && (U_CHARSET_FAMILY == 0 || (U_PF_OS390 <= U_PLATFORM && U_PLATFORM <= U_PF_OS400 && defined(__UCS2__)))
805 # define U_DECLARE_UTF16(string) L ## string
806 #else
807  /* Leave U_DECLARE_UTF16 undefined. See unistr.h. */
808 #endif
809 
812 /*===========================================================================*/
814 /*===========================================================================*/
815 
816 #ifdef U_EXPORT
817  /* Use the predefined value. */
818 #elif defined(U_STATIC_IMPLEMENTATION)
819 # define U_EXPORT
820 #elif defined(__GNUC__)
821 # define U_EXPORT __attribute__((visibility("default")))
822 #elif (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x550) \
823  || (defined(__SUNPRO_C) && __SUNPRO_C >= 0x550)
824 # define U_EXPORT __global
825 /*#elif defined(__HP_aCC) || defined(__HP_cc)
826 # define U_EXPORT __declspec(dllexport)*/
827 #elif defined(_MSC_VER)
828 # define U_EXPORT __declspec(dllexport)
829 #else
830 # define U_EXPORT
831 #endif
832 
833 /* U_CALLCONV is releated to U_EXPORT2 */
834 #ifdef U_EXPORT2
835  /* Use the predefined value. */
836 #elif defined(_MSC_VER)
837 # define U_EXPORT2 __cdecl
838 #else
839 # define U_EXPORT2
840 #endif
841 
842 #ifdef U_IMPORT
843  /* Use the predefined value. */
844 #elif defined(_MSC_VER)
845  /* Windows needs to export/import data. */
846 # define U_IMPORT __declspec(dllimport)
847 #else
848 # define U_IMPORT
849 #endif
850 
868 #if U_PLATFORM == U_PF_OS390 && defined(__cplusplus)
869 # define U_CALLCONV __cdecl
870 #else
871 # define U_CALLCONV U_EXPORT2
872 #endif
873 
874 /* @} */
875 
876 #endif
C API: definitions of ICU version numbers.
User-configurable settings.