ICU 55.1  55.1
platform.h
Go to the documentation of this file.
1 /*
2 ******************************************************************************
3 *
4 * Copyright (C) 1997-2015, International Business Machines
5 * Corporation and others. All Rights Reserved.
6 *
7 ******************************************************************************
8 *
9 * FILE NAME : platform.h
10 *
11 * Date Name Description
12 * 05/13/98 nos Creation (content moved here from ptypes.h).
13 * 03/02/99 stephen Added AS400 support.
14 * 03/30/99 stephen Added Linux support.
15 * 04/13/99 stephen Reworked for autoconf.
16 ******************************************************************************
17 */
18 
19 #ifndef _PLATFORM_H
20 #define _PLATFORM_H
21 
22 #include "unicode/uconfig.h"
23 #include "unicode/uvernum.h"
24 
57 #ifdef U_IN_DOXYGEN
58 /*
59  * Problem: "platform.h:335: warning: documentation for unknown define U_HAVE_STD_STRING found." means that U_HAVE_STD_STRING is not documented.
60  * 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.
61  */
62 
63 /* None for now. */
64 #endif
65 
87 #define U_PF_UNKNOWN 0
88 
89 #define U_PF_WINDOWS 1000
90 
91 #define U_PF_MINGW 1800
92 
97 #define U_PF_CYGWIN 1900
98 /* Reserve 2000 for U_PF_UNIX? */
100 #define U_PF_HPUX 2100
101 
102 #define U_PF_SOLARIS 2600
103 
104 #define U_PF_BSD 3000
105 
106 #define U_PF_AIX 3100
107 
108 #define U_PF_IRIX 3200
109 
117 #define U_PF_DARWIN 3500
118 
119 #define U_PF_IPHONE 3550
120 
121 #define U_PF_QNX 3700
122 
123 #define U_PF_LINUX 4000
124 
130 #define U_PF_BROWSER_NATIVE_CLIENT 4020
131 
132 #define U_PF_ANDROID 4050
133 /* Maximum value for Linux-based platform is 4499 */
135 #define U_PF_OS390 9000
136 
137 #define U_PF_OS400 9400
138 
139 #ifdef U_PLATFORM
140  /* Use the predefined value. */
141 #elif defined(__MINGW32__)
142 # define U_PLATFORM U_PF_MINGW
143 #elif defined(__CYGWIN__)
144 # define U_PLATFORM U_PF_CYGWIN
145 #elif defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
146 # define U_PLATFORM U_PF_WINDOWS
147 #elif defined(__ANDROID__)
148 # define U_PLATFORM U_PF_ANDROID
149  /* Android wchar_t support depends on the API level. */
150 # include <android/api-level.h>
151 #elif defined(__native_client__)
152 # define U_PLATFORM U_PF_BROWSER_NATIVE_CLIENT
153 #elif defined(linux) || defined(__linux__) || defined(__linux)
154 # define U_PLATFORM U_PF_LINUX
155 #elif defined(__APPLE__) && defined(__MACH__)
156 # include <TargetConditionals.h>
157 # if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE /* variant of TARGET_OS_MAC */
158 # define U_PLATFORM U_PF_IPHONE
159 # else
160 # define U_PLATFORM U_PF_DARWIN
161 # endif
162 #elif defined(BSD) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__MirBSD__)
163 # define U_PLATFORM U_PF_BSD
164 #elif defined(sun) || defined(__sun)
165  /* Check defined(__SVR4) || defined(__svr4__) to distinguish Solaris from SunOS? */
166 # define U_PLATFORM U_PF_SOLARIS
167 # if defined(__GNUC__)
168  /* Solaris/GCC needs this header file to get the proper endianness. Normally, this
169  * header file is included with stddef.h but on Solairs/GCC, the GCC version of stddef.h
170  * is included which does not include this header file.
171  */
172 # include <sys/isa_defs.h>
173 # endif
174 #elif defined(_AIX) || defined(__TOS_AIX__)
175 # define U_PLATFORM U_PF_AIX
176 #elif defined(_hpux) || defined(hpux) || defined(__hpux)
177 # define U_PLATFORM U_PF_HPUX
178 #elif defined(sgi) || defined(__sgi)
179 # define U_PLATFORM U_PF_IRIX
180 #elif defined(__QNX__) || defined(__QNXNTO__)
181 # define U_PLATFORM U_PF_QNX
182 #elif defined(__TOS_MVS__)
183 # define U_PLATFORM U_PF_OS390
184 #elif defined(__OS400__) || defined(__TOS_OS400__)
185 # define U_PLATFORM U_PF_OS400
186 #else
187 # define U_PLATFORM U_PF_UNKNOWN
188 #endif
189 
196 /* Commented out because this is already set in mh-cygwin-msvc
197 #if U_PLATFORM == U_PF_CYGWIN && defined(_MSC_VER)
198 # define CYGWINMSVC
199 #endif
200 */
201 
208 #ifdef U_PLATFORM_USES_ONLY_WIN32_API
209  /* Use the predefined value. */
210 #elif (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_MINGW) || defined(CYGWINMSVC)
211 # define U_PLATFORM_USES_ONLY_WIN32_API 1
212 #else
213  /* Cygwin implements POSIX. */
214 # define U_PLATFORM_USES_ONLY_WIN32_API 0
215 #endif
216 
223 #ifdef U_PLATFORM_HAS_WIN32_API
224  /* Use the predefined value. */
225 #elif U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN
226 # define U_PLATFORM_HAS_WIN32_API 1
227 #else
228 # define U_PLATFORM_HAS_WIN32_API 0
229 #endif
230 
237 #ifdef U_PLATFORM_IMPLEMENTS_POSIX
238  /* Use the predefined value. */
239 #elif U_PLATFORM_USES_ONLY_WIN32_API
240 # define U_PLATFORM_IMPLEMENTS_POSIX 0
241 #else
242 # define U_PLATFORM_IMPLEMENTS_POSIX 1
243 #endif
244 
250 #ifdef U_PLATFORM_IS_LINUX_BASED
251  /* Use the predefined value. */
252 #elif U_PF_LINUX <= U_PLATFORM && U_PLATFORM <= 4499
253 # define U_PLATFORM_IS_LINUX_BASED 1
254 #else
255 # define U_PLATFORM_IS_LINUX_BASED 0
256 #endif
257 
263 #ifdef U_PLATFORM_IS_DARWIN_BASED
264  /* Use the predefined value. */
265 #elif U_PF_DARWIN <= U_PLATFORM && U_PLATFORM <= U_PF_IPHONE
266 # define U_PLATFORM_IS_DARWIN_BASED 1
267 #else
268 # define U_PLATFORM_IS_DARWIN_BASED 0
269 #endif
270 
278 #ifdef U_HAVE_STDINT_H
279  /* Use the predefined value. */
280 #elif U_PLATFORM_USES_ONLY_WIN32_API
281 # if defined(__BORLANDC__) || U_PLATFORM == U_PF_MINGW || (defined(_MSC_VER) && _MSC_VER>=1600)
282  /* Windows Visual Studio 9 and below do not have stdint.h & inttypes.h, but VS 2010 adds them. */
283 # define U_HAVE_STDINT_H 1
284 # else
285 # define U_HAVE_STDINT_H 0
286 # endif
287 #elif U_PLATFORM == U_PF_SOLARIS
288  /* Solaris has inttypes.h but not stdint.h. */
289 # define U_HAVE_STDINT_H 0
290 #elif U_PLATFORM == U_PF_AIX && !defined(_AIX51) && defined(_POWER)
291  /* PPC AIX <= 4.3 has inttypes.h but not stdint.h. */
292 # define U_HAVE_STDINT_H 0
293 #else
294 # define U_HAVE_STDINT_H 1
295 #endif
296 
303 #ifdef U_HAVE_INTTYPES_H
304  /* Use the predefined value. */
305 #elif U_PLATFORM == U_PF_SOLARIS
306  /* Solaris has inttypes.h but not stdint.h. */
307 # define U_HAVE_INTTYPES_H 1
308 #elif U_PLATFORM == U_PF_AIX && !defined(_AIX51) && defined(_POWER)
309  /* PPC AIX <= 4.3 has inttypes.h but not stdint.h. */
310 # define U_HAVE_INTTYPES_H 1
311 #else
312  /* Most platforms have both inttypes.h and stdint.h, or neither. */
313 # define U_HAVE_INTTYPES_H U_HAVE_STDINT_H
314 #endif
315 
337 #ifndef U_IOSTREAM_SOURCE
338 #define U_IOSTREAM_SOURCE 199711
339 #endif
340 
346 #ifdef U_HAVE_STD_STRING
347  /* Use the predefined value. */
348 #else
349 # define U_HAVE_STD_STRING 1
350 #endif
351 
352 /*===========================================================================*/
354 /*===========================================================================*/
355 
366 #ifdef __GNUC__
367 # define U_GCC_MAJOR_MINOR (__GNUC__ * 100 + __GNUC_MINOR__)
368 #else
369 # define U_GCC_MAJOR_MINOR 0
370 #endif
371 
377 #ifdef U_IS_BIG_ENDIAN
378  /* Use the predefined value. */
379 #elif defined(BYTE_ORDER) && defined(BIG_ENDIAN)
380 # define U_IS_BIG_ENDIAN (BYTE_ORDER == BIG_ENDIAN)
381 #elif defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__)
382  /* gcc */
383 # define U_IS_BIG_ENDIAN (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
384 #elif defined(__BIG_ENDIAN__) || defined(_BIG_ENDIAN)
385 # define U_IS_BIG_ENDIAN 1
386 #elif defined(__LITTLE_ENDIAN__) || defined(_LITTLE_ENDIAN)
387 # define U_IS_BIG_ENDIAN 0
388 #elif U_PLATFORM == U_PF_OS390 || U_PLATFORM == U_PF_OS400 || defined(__s390__) || defined(__s390x__)
389  /* These platforms do not appear to predefine any endianness macros. */
390 # define U_IS_BIG_ENDIAN 1
391 #elif defined(_PA_RISC1_0) || defined(_PA_RISC1_1) || defined(_PA_RISC2_0)
392  /* HPPA do not appear to predefine any endianness macros. */
393 # define U_IS_BIG_ENDIAN 1
394 #elif defined(sparc) || defined(__sparc) || defined(__sparc__)
395  /* Some sparc based systems (e.g. Linux) do not predefine any endianness macros. */
396 # define U_IS_BIG_ENDIAN 1
397 #else
398 # define U_IS_BIG_ENDIAN 0
399 #endif
400 
406 #ifdef U_HAVE_PLACEMENT_NEW
407  /* Use the predefined value. */
408 #elif defined(__BORLANDC__)
409 # define U_HAVE_PLACEMENT_NEW 0
410 #else
411 # define U_HAVE_PLACEMENT_NEW 1
412 #endif
413 
420 #ifdef U_HAVE_DEBUG_LOCATION_NEW
421  /* Use the predefined value. */
422 #elif defined(_MSC_VER)
423 # define U_HAVE_DEBUG_LOCATION_NEW 1
424 #else
425 # define U_HAVE_DEBUG_LOCATION_NEW 0
426 #endif
427 
428 /* Compatibility with non clang compilers */
429 #ifndef __has_attribute
430 # define __has_attribute(x) 0
431 #endif
432 
438 #if defined(__GNUC__) && __GNUC__>=3
439 # define U_MALLOC_ATTR __attribute__ ((__malloc__))
440 #else
441 # define U_MALLOC_ATTR
442 #endif
443 
449 #if (defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3))) || __has_attribute(alloc_size)
450 # define U_ALLOC_SIZE_ATTR(X) __attribute__ ((alloc_size(X)))
451 # define U_ALLOC_SIZE_ATTR2(X,Y) __attribute__ ((alloc_size(X,Y)))
452 #else
453 # define U_ALLOC_SIZE_ATTR(X)
454 # define U_ALLOC_SIZE_ATTR2(X,Y)
455 #endif
456 
459 /*===========================================================================*/
461 /*===========================================================================*/
462 
467 #define U_ASCII_FAMILY 0
468 
473 #define U_EBCDIC_FAMILY 1
474 
517 #ifdef U_CHARSET_FAMILY
518  /* Use the predefined value. */
519 #elif U_PLATFORM == U_PF_OS390 && (!defined(__CHARSET_LIB) || !__CHARSET_LIB)
520 # define U_CHARSET_FAMILY U_EBCDIC_FAMILY
521 #elif U_PLATFORM == U_PF_OS400 && !defined(__UTF32__)
522 # define U_CHARSET_FAMILY U_EBCDIC_FAMILY
523 #else
524 # define U_CHARSET_FAMILY U_ASCII_FAMILY
525 #endif
526 
547 #ifdef U_CHARSET_IS_UTF8
548  /* Use the predefined value. */
549 #elif U_PLATFORM == U_PF_ANDROID || U_PLATFORM_IS_DARWIN_BASED
550 # define U_CHARSET_IS_UTF8 1
551 #else
552 # define U_CHARSET_IS_UTF8 0
553 #endif
554 
557 /*===========================================================================*/
559 /*===========================================================================*/
560 
567 #ifdef U_HAVE_WCHAR_H
568  /* Use the predefined value. */
569 #elif U_PLATFORM == U_PF_ANDROID && __ANDROID_API__ < 9
570  /*
571  * Android before Gingerbread (Android 2.3, API level 9) did not support wchar_t.
572  * The type and header existed, but the library functions did not work as expected.
573  * The size of wchar_t was 1 but L"xyz" string literals had 32-bit units anyway.
574  */
575 # define U_HAVE_WCHAR_H 0
576 #else
577 # define U_HAVE_WCHAR_H 1
578 #endif
579 
586 #ifdef U_SIZEOF_WCHAR_T
587  /* Use the predefined value. */
588 #elif (U_PLATFORM == U_PF_ANDROID && __ANDROID_API__ < 9)
589  /*
590  * Classic Mac OS and Mac OS X before 10.3 (Panther) did not support wchar_t or wstring.
591  * Newer Mac OS X has size 4.
592  */
593 # define U_SIZEOF_WCHAR_T 1
594 #elif U_PLATFORM_HAS_WIN32_API || U_PLATFORM == U_PF_CYGWIN
595 # define U_SIZEOF_WCHAR_T 2
596 #elif U_PLATFORM == U_PF_AIX
597  /*
598  * AIX 6.1 information, section "Wide character data representation":
599  * "... the wchar_t datatype is 32-bit in the 64-bit environment and
600  * 16-bit in the 32-bit environment."
601  * and
602  * "All locales use Unicode for their wide character code values (process code),
603  * except the IBM-eucTW codeset."
604  */
605 # ifdef __64BIT__
606 # define U_SIZEOF_WCHAR_T 4
607 # else
608 # define U_SIZEOF_WCHAR_T 2
609 # endif
610 #elif U_PLATFORM == U_PF_OS390
611  /*
612  * z/OS V1R11 information center, section "LP64 | ILP32":
613  * "In 31-bit mode, the size of long and pointers is 4 bytes and the size of wchar_t is 2 bytes.
614  * Under LP64, the size of long and pointer is 8 bytes and the size of wchar_t is 4 bytes."
615  */
616 # ifdef _LP64
617 # define U_SIZEOF_WCHAR_T 4
618 # else
619 # define U_SIZEOF_WCHAR_T 2
620 # endif
621 #elif U_PLATFORM == U_PF_OS400
622 # if defined(__UTF32__)
623  /*
624  * LOCALETYPE(*LOCALEUTF) is specified.
625  * Wide-character strings are in UTF-32,
626  * narrow-character strings are in UTF-8.
627  */
628 # define U_SIZEOF_WCHAR_T 4
629 # elif defined(__UCS2__)
630  /*
631  * LOCALETYPE(*LOCALEUCS2) is specified.
632  * Wide-character strings are in UCS-2,
633  * narrow-character strings are in EBCDIC.
634  */
635 # define U_SIZEOF_WCHAR_T 2
636 #else
637  /*
638  * LOCALETYPE(*CLD) or LOCALETYPE(*LOCALE) is specified.
639  * Wide-character strings are in 16-bit EBCDIC,
640  * narrow-character strings are in EBCDIC.
641  */
642 # define U_SIZEOF_WCHAR_T 2
643 # endif
644 #else
645 # define U_SIZEOF_WCHAR_T 4
646 #endif
647 
648 #ifndef U_HAVE_WCSCPY
649 #define U_HAVE_WCSCPY U_HAVE_WCHAR_H
650 #endif
651 
662 #ifdef U_HAVE_CHAR16_T
663  /* Use the predefined value. */
664 #else
665  /*
666  * Notes:
667  * Visual Studio 10 (_MSC_VER>=1600) defines char16_t but
668  * does not support u"abc" string literals.
669  * gcc 4.4 defines the __CHAR16_TYPE__ macro to a usable type but
670  * does not support u"abc" string literals.
671  * C++11 and C11 require support for UTF-16 literals
672  */
673 # if (defined(__cplusplus) && __cplusplus >= 201103L) || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L)
674 # define U_HAVE_CHAR16_T 1
675 # else
676 # define U_HAVE_CHAR16_T 0
677 # endif
678 #endif
679 
687 #ifdef U_DECLARE_UTF16
688  /* Use the predefined value. */
689 #elif U_HAVE_CHAR16_T \
690  || (defined(__xlC__) && defined(__IBM_UTF_LITERAL) && U_SIZEOF_WCHAR_T != 2) \
691  || (defined(__HP_aCC) && __HP_aCC >= 035000) \
692  || (defined(__HP_cc) && __HP_cc >= 111106)
693 # define U_DECLARE_UTF16(string) u ## string
694 #elif U_SIZEOF_WCHAR_T == 2 \
695  && (U_CHARSET_FAMILY == 0 || (U_PF_OS390 <= U_PLATFORM && U_PLATFORM <= U_PF_OS400 && defined(__UCS2__)))
696 # define U_DECLARE_UTF16(string) L ## string
697 #else
698  /* Leave U_DECLARE_UTF16 undefined. See unistr.h. */
699 #endif
700 
703 /*===========================================================================*/
705 /*===========================================================================*/
706 
707 #ifdef U_EXPORT
708  /* Use the predefined value. */
709 #elif defined(U_STATIC_IMPLEMENTATION)
710 # define U_EXPORT
711 #elif defined(__GNUC__)
712 # define U_EXPORT __attribute__((visibility("default")))
713 #elif (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x550) \
714  || (defined(__SUNPRO_C) && __SUNPRO_C >= 0x550)
715 # define U_EXPORT __global
716 /*#elif defined(__HP_aCC) || defined(__HP_cc)
717 # define U_EXPORT __declspec(dllexport)*/
718 #elif defined(_MSC_VER)
719 # define U_EXPORT __declspec(dllexport)
720 #else
721 # define U_EXPORT
722 #endif
723 
724 /* U_CALLCONV is releated to U_EXPORT2 */
725 #ifdef U_EXPORT2
726  /* Use the predefined value. */
727 #elif defined(_MSC_VER)
728 # define U_EXPORT2 __cdecl
729 #else
730 # define U_EXPORT2
731 #endif
732 
733 #ifdef U_IMPORT
734  /* Use the predefined value. */
735 #elif defined(_MSC_VER)
736  /* Windows needs to export/import data. */
737 # define U_IMPORT __declspec(dllimport)
738 #else
739 # define U_IMPORT
740 #endif
741 
753 #if U_PLATFORM == U_PF_OS390 && defined(__cplusplus)
754 # define U_CALLCONV __cdecl
755 #else
756 # define U_CALLCONV U_EXPORT2
757 #endif
758 
759 /* @} */
760 
761 #endif
C API: definitions of ICU version numbers.
User-configurable settings.