ICU 52.1  52.1
platform.h
Go to the documentation of this file.
1 /*
2 ******************************************************************************
3 *
4 * Copyright (C) 1997-2013, 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 
125 #define U_PF_ANDROID 4050
126 
127 #define U_PF_CLASSIC_MACOS 8000
128 
129 #define U_PF_OS390 9000
130 
131 #define U_PF_OS400 9400
132 
133 #ifdef U_PLATFORM
134  /* Use the predefined value. */
135 #elif defined(__MINGW32__)
136 # define U_PLATFORM U_PF_MINGW
137 #elif defined(__CYGWIN__)
138 # define U_PLATFORM U_PF_CYGWIN
139 #elif defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
140 # define U_PLATFORM U_PF_WINDOWS
141 #elif defined(__ANDROID__)
142 # define U_PLATFORM U_PF_ANDROID
143  /* Android wchar_t support depends on the API level. */
144 # include <android/api-level.h>
145 #elif defined(linux) || defined(__linux__) || defined(__linux)
146 # define U_PLATFORM U_PF_LINUX
147 #elif defined(__APPLE__) && defined(__MACH__)
148 # include <TargetConditionals.h>
149 # if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE /* variant of TARGET_OS_MAC */
150 # define U_PLATFORM U_PF_IPHONE
151 # else
152 # define U_PLATFORM U_PF_DARWIN
153 # endif
154 #elif defined(BSD) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__MirBSD__)
155 # define U_PLATFORM U_PF_BSD
156 #elif defined(sun) || defined(__sun)
157  /* Check defined(__SVR4) || defined(__svr4__) to distinguish Solaris from SunOS? */
158 # define U_PLATFORM U_PF_SOLARIS
159 # if defined(__GNUC__)
160  /* Solaris/GCC needs this header file to get the proper endianness. Normally, this
161  * header file is included with stddef.h but on Solairs/GCC, the GCC version of stddef.h
162  * is included which does not include this header file.
163  */
164 # include <sys/isa_defs.h>
165 # endif
166 #elif defined(_AIX) || defined(__TOS_AIX__)
167 # define U_PLATFORM U_PF_AIX
168 #elif defined(_hpux) || defined(hpux) || defined(__hpux)
169 # define U_PLATFORM U_PF_HPUX
170 #elif defined(sgi) || defined(__sgi)
171 # define U_PLATFORM U_PF_IRIX
172 #elif defined(macintosh)
173 # define U_PLATFORM U_PF_CLASSIC_MACOS
174 #elif defined(__QNX__) || defined(__QNXNTO__)
175 # define U_PLATFORM U_PF_QNX
176 #elif defined(__TOS_MVS__)
177 # define U_PLATFORM U_PF_OS390
178 #elif defined(__OS400__) || defined(__TOS_OS400__)
179 # define U_PLATFORM U_PF_OS400
180 #else
181 # define U_PLATFORM U_PF_UNKNOWN
182 #endif
183 
190 /* Commented out because this is already set in mh-cygwin-msvc
191 #if U_PLATFORM == U_PF_CYGWIN && defined(_MSC_VER)
192 # define CYGWINMSVC
193 #endif
194 */
195 
202 #ifdef U_PLATFORM_USES_ONLY_WIN32_API
203  /* Use the predefined value. */
204 #elif (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_MINGW) || defined(CYGWINMSVC)
205 # define U_PLATFORM_USES_ONLY_WIN32_API 1
206 #else
207  /* Cygwin implements POSIX. */
208 # define U_PLATFORM_USES_ONLY_WIN32_API 0
209 #endif
210 
217 #ifdef U_PLATFORM_HAS_WIN32_API
218  /* Use the predefined value. */
219 #elif U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN
220 # define U_PLATFORM_HAS_WIN32_API 1
221 #else
222 # define U_PLATFORM_HAS_WIN32_API 0
223 #endif
224 
231 #ifdef U_PLATFORM_IMPLEMENTS_POSIX
232  /* Use the predefined value. */
233 #elif U_PLATFORM_USES_ONLY_WIN32_API || U_PLATFORM == U_PF_CLASSIC_MACOS
234 # define U_PLATFORM_IMPLEMENTS_POSIX 0
235 #else
236 # define U_PLATFORM_IMPLEMENTS_POSIX 1
237 #endif
238 
244 #ifdef U_PLATFORM_IS_LINUX_BASED
245  /* Use the predefined value. */
246 #elif U_PF_LINUX <= U_PLATFORM && U_PLATFORM <= U_PF_ANDROID
247 # define U_PLATFORM_IS_LINUX_BASED 1
248 #else
249 # define U_PLATFORM_IS_LINUX_BASED 0
250 #endif
251 
257 #ifdef U_PLATFORM_IS_DARWIN_BASED
258  /* Use the predefined value. */
259 #elif U_PF_DARWIN <= U_PLATFORM && U_PLATFORM <= U_PF_IPHONE
260 # define U_PLATFORM_IS_DARWIN_BASED 1
261 #else
262 # define U_PLATFORM_IS_DARWIN_BASED 0
263 #endif
264 
272 #ifdef U_HAVE_STDINT_H
273  /* Use the predefined value. */
274 #elif U_PLATFORM_USES_ONLY_WIN32_API
275 # if defined(__BORLANDC__) || U_PLATFORM == U_PF_MINGW || (defined(_MSC_VER) && _MSC_VER>=1600)
276  /* Windows Visual Studio 9 and below do not have stdint.h & inttypes.h, but VS 2010 adds them. */
277 # define U_HAVE_STDINT_H 1
278 # else
279 # define U_HAVE_STDINT_H 0
280 # endif
281 #elif U_PLATFORM == U_PF_SOLARIS
282  /* Solaris has inttypes.h but not stdint.h. */
283 # define U_HAVE_STDINT_H 0
284 #elif U_PLATFORM == U_PF_AIX && !defined(_AIX51) && defined(_POWER)
285  /* PPC AIX <= 4.3 has inttypes.h but not stdint.h. */
286 # define U_HAVE_STDINT_H 0
287 #else
288 # define U_HAVE_STDINT_H 1
289 #endif
290 
297 #ifdef U_HAVE_INTTYPES_H
298  /* Use the predefined value. */
299 #elif U_PLATFORM == U_PF_SOLARIS
300  /* Solaris has inttypes.h but not stdint.h. */
301 # define U_HAVE_INTTYPES_H 1
302 #elif U_PLATFORM == U_PF_AIX && !defined(_AIX51) && defined(_POWER)
303  /* PPC AIX <= 4.3 has inttypes.h but not stdint.h. */
304 # define U_HAVE_INTTYPES_H 1
305 #else
306  /* Most platforms have both inttypes.h and stdint.h, or neither. */
307 # define U_HAVE_INTTYPES_H U_HAVE_STDINT_H
308 #endif
309 
331 #ifndef U_IOSTREAM_SOURCE
332 #define U_IOSTREAM_SOURCE 199711
333 #endif
334 
340 #ifdef U_HAVE_STD_STRING
341  /* Use the predefined value. */
342 #else
343 # define U_HAVE_STD_STRING 1
344 #endif
345 
346 /*===========================================================================*/
348 /*===========================================================================*/
349 
360 #ifdef __GNUC__
361 # define U_GCC_MAJOR_MINOR (__GNUC__ * 100 + __GNUC_MINOR__)
362 #else
363 # define U_GCC_MAJOR_MINOR 0
364 #endif
365 
371 #ifdef U_IS_BIG_ENDIAN
372  /* Use the predefined value. */
373 #elif defined(BYTE_ORDER) && defined(BIG_ENDIAN)
374 # define U_IS_BIG_ENDIAN (BYTE_ORDER == BIG_ENDIAN)
375 #elif defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__)
376  /* gcc */
377 # define U_IS_BIG_ENDIAN (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
378 #elif defined(__BIG_ENDIAN__) || defined(_BIG_ENDIAN)
379 # define U_IS_BIG_ENDIAN 1
380 #elif defined(__LITTLE_ENDIAN__) || defined(_LITTLE_ENDIAN)
381 # define U_IS_BIG_ENDIAN 0
382 #elif U_PLATFORM == U_PF_OS390 || U_PLATFORM == U_PF_OS400 || defined(__s390__) || defined(__s390x__)
383  /* These platforms do not appear to predefine any endianness macros. */
384 # define U_IS_BIG_ENDIAN 1
385 #elif defined(_PA_RISC1_0) || defined(_PA_RISC1_1) || defined(_PA_RISC2_0)
386  /* HPPA do not appear to predefine any endianness macros. */
387 # define U_IS_BIG_ENDIAN 1
388 #elif defined(sparc) || defined(__sparc) || defined(__sparc__)
389  /* Some sparc based systems (e.g. Linux) do not predefine any endianness macros. */
390 # define U_IS_BIG_ENDIAN 1
391 #else
392 # define U_IS_BIG_ENDIAN 0
393 #endif
394 
400 #ifdef U_HAVE_PLACEMENT_NEW
401  /* Use the predefined value. */
402 #elif defined(__BORLANDC__)
403 # define U_HAVE_PLACEMENT_NEW 0
404 #else
405 # define U_HAVE_PLACEMENT_NEW 1
406 #endif
407 
414 #ifdef U_HAVE_DEBUG_LOCATION_NEW
415  /* Use the predefined value. */
416 #elif defined(_MSC_VER)
417 # define U_HAVE_DEBUG_LOCATION_NEW 1
418 #else
419 # define U_HAVE_DEBUG_LOCATION_NEW 0
420 #endif
421 
422 /* Compatibility with non clang compilers */
423 #ifndef __has_attribute
424 # define __has_attribute(x) 0
425 #endif
426 
432 #if defined(__GNUC__) && __GNUC__>=3
433 # define U_MALLOC_ATTR __attribute__ ((__malloc__))
434 #else
435 # define U_MALLOC_ATTR
436 #endif
437 
443 #if (defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3))) || __has_attribute(alloc_size)
444 # define U_ALLOC_SIZE_ATTR(X) __attribute__ ((alloc_size(X)))
445 # define U_ALLOC_SIZE_ATTR2(X,Y) __attribute__ ((alloc_size(X,Y)))
446 #else
447 # define U_ALLOC_SIZE_ATTR(X)
448 # define U_ALLOC_SIZE_ATTR2(X,Y)
449 #endif
450 
453 /*===========================================================================*/
455 /*===========================================================================*/
456 
461 #define U_ASCII_FAMILY 0
462 
467 #define U_EBCDIC_FAMILY 1
468 
511 #ifdef U_CHARSET_FAMILY
512  /* Use the predefined value. */
513 #elif U_PLATFORM == U_PF_OS390 && (!defined(__CHARSET_LIB) || !__CHARSET_LIB)
514 # define U_CHARSET_FAMILY U_EBCDIC_FAMILY
515 #elif U_PLATFORM == U_PF_OS400 && !defined(__UTF32__)
516 # define U_CHARSET_FAMILY U_EBCDIC_FAMILY
517 #else
518 # define U_CHARSET_FAMILY U_ASCII_FAMILY
519 #endif
520 
541 #ifdef U_CHARSET_IS_UTF8
542  /* Use the predefined value. */
543 #elif U_PLATFORM == U_PF_ANDROID || U_PLATFORM_IS_DARWIN_BASED
544 # define U_CHARSET_IS_UTF8 1
545 #else
546 # define U_CHARSET_IS_UTF8 0
547 #endif
548 
551 /*===========================================================================*/
553 /*===========================================================================*/
554 
561 #ifdef U_HAVE_WCHAR_H
562  /* Use the predefined value. */
563 #elif U_PLATFORM == U_PF_ANDROID && __ANDROID_API__ < 9
564  /*
565  * Android before Gingerbread (Android 2.3, API level 9) did not support wchar_t.
566  * The type and header existed, but the library functions did not work as expected.
567  * The size of wchar_t was 1 but L"xyz" string literals had 32-bit units anyway.
568  */
569 # define U_HAVE_WCHAR_H 0
570 #else
571 # define U_HAVE_WCHAR_H 1
572 #endif
573 
580 #ifdef U_SIZEOF_WCHAR_T
581  /* Use the predefined value. */
582 #elif (U_PLATFORM == U_PF_ANDROID && __ANDROID_API__ < 9) || U_PLATFORM == U_PF_CLASSIC_MACOS
583  /*
584  * Classic Mac OS and Mac OS X before 10.3 (Panther) did not support wchar_t or wstring.
585  * Newer Mac OS X has size 4.
586  */
587 # define U_SIZEOF_WCHAR_T 1
588 #elif U_PLATFORM_HAS_WIN32_API || U_PLATFORM == U_PF_CYGWIN
589 # define U_SIZEOF_WCHAR_T 2
590 #elif U_PLATFORM == U_PF_AIX
591  /*
592  * AIX 6.1 information, section "Wide character data representation":
593  * "... the wchar_t datatype is 32-bit in the 64-bit environment and
594  * 16-bit in the 32-bit environment."
595  * and
596  * "All locales use Unicode for their wide character code values (process code),
597  * except the IBM-eucTW codeset."
598  */
599 # ifdef __64BIT__
600 # define U_SIZEOF_WCHAR_T 4
601 # else
602 # define U_SIZEOF_WCHAR_T 2
603 # endif
604 #elif U_PLATFORM == U_PF_OS390
605  /*
606  * z/OS V1R11 information center, section "LP64 | ILP32":
607  * "In 31-bit mode, the size of long and pointers is 4 bytes and the size of wchar_t is 2 bytes.
608  * Under LP64, the size of long and pointer is 8 bytes and the size of wchar_t is 4 bytes."
609  */
610 # ifdef _LP64
611 # define U_SIZEOF_WCHAR_T 4
612 # else
613 # define U_SIZEOF_WCHAR_T 2
614 # endif
615 #elif U_PLATFORM == U_PF_OS400
616 # if defined(__UTF32__)
617  /*
618  * LOCALETYPE(*LOCALEUTF) is specified.
619  * Wide-character strings are in UTF-32,
620  * narrow-character strings are in UTF-8.
621  */
622 # define U_SIZEOF_WCHAR_T 4
623 # elif defined(__UCS2__)
624  /*
625  * LOCALETYPE(*LOCALEUCS2) is specified.
626  * Wide-character strings are in UCS-2,
627  * narrow-character strings are in EBCDIC.
628  */
629 # define U_SIZEOF_WCHAR_T 2
630 #else
631  /*
632  * LOCALETYPE(*CLD) or LOCALETYPE(*LOCALE) is specified.
633  * Wide-character strings are in 16-bit EBCDIC,
634  * narrow-character strings are in EBCDIC.
635  */
636 # define U_SIZEOF_WCHAR_T 2
637 # endif
638 #else
639 # define U_SIZEOF_WCHAR_T 4
640 #endif
641 
642 #ifndef U_HAVE_WCSCPY
643 #define U_HAVE_WCSCPY U_HAVE_WCHAR_H
644 #endif
645 
656 #ifdef U_HAVE_CHAR16_T
657  /* Use the predefined value. */
658 #else
659  /*
660  * Notes:
661  * Visual Studio 10 (_MSC_VER>=1600) defines char16_t but
662  * does not support u"abc" string literals.
663  * gcc 4.4 defines the __CHAR16_TYPE__ macro to a usable type but
664  * does not support u"abc" string literals.
665  * C++11 and C11 require support for UTF-16 literals
666  */
667 # if (defined(__cplusplus) && __cplusplus >= 201103L) || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L)
668 # define U_HAVE_CHAR16_T 1
669 # else
670 # define U_HAVE_CHAR16_T 0
671 # endif
672 #endif
673 
681 #ifdef U_DECLARE_UTF16
682  /* Use the predefined value. */
683 #elif U_HAVE_CHAR16_T \
684  || (defined(__xlC__) && defined(__IBM_UTF_LITERAL) && U_SIZEOF_WCHAR_T != 2) \
685  || (defined(__HP_aCC) && __HP_aCC >= 035000) \
686  || (defined(__HP_cc) && __HP_cc >= 111106)
687 # define U_DECLARE_UTF16(string) u ## string
688 #elif U_SIZEOF_WCHAR_T == 2 \
689  && (U_CHARSET_FAMILY == 0 || (U_PF_OS390 <= U_PLATFORM && U_PLATFORM <= U_PF_OS400 && defined(__UCS2__)))
690 # define U_DECLARE_UTF16(string) L ## string
691 #else
692  /* Leave U_DECLARE_UTF16 undefined. See unistr.h. */
693 #endif
694 
697 /*===========================================================================*/
699 /*===========================================================================*/
700 
701 #ifdef U_EXPORT
702  /* Use the predefined value. */
703 #elif defined(U_STATIC_IMPLEMENTATION)
704 # define U_EXPORT
705 #elif defined(__GNUC__)
706 # define U_EXPORT __attribute__((visibility("default")))
707 #elif (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x550) \
708  || (defined(__SUNPRO_C) && __SUNPRO_C >= 0x550)
709 # define U_EXPORT __global
710 /*#elif defined(__HP_aCC) || defined(__HP_cc)
711 # define U_EXPORT __declspec(dllexport)*/
712 #elif defined(_MSC_VER)
713 # define U_EXPORT __declspec(dllexport)
714 #else
715 # define U_EXPORT
716 #endif
717 
718 /* U_CALLCONV is releated to U_EXPORT2 */
719 #ifdef U_EXPORT2
720  /* Use the predefined value. */
721 #elif defined(_MSC_VER)
722 # define U_EXPORT2 __cdecl
723 #else
724 # define U_EXPORT2
725 #endif
726 
727 #ifdef U_IMPORT
728  /* Use the predefined value. */
729 #elif defined(_MSC_VER)
730  /* Windows needs to export/import data. */
731 # define U_IMPORT __declspec(dllimport)
732 #else
733 # define U_IMPORT
734 #endif
735 
747 #if U_PLATFORM == U_PF_OS390 && defined(__cplusplus)
748 # define U_CALLCONV __cdecl
749 #else
750 # define U_CALLCONV U_EXPORT2
751 #endif
752 
753 /* @} */
754 
755 #endif
C API: definitions of ICU version numbers.
User-configurable settings.