ICU 76.1: common/unicode/platform.h Source File

ICU 76.1 76.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
91 #define U_PF_WINDOWS 1000
93 #define U_PF_MINGW 1800
99 #define U_PF_CYGWIN 1900
100 /* Reserve 2000 for U_PF_UNIX? */
102 #define U_PF_HPUX 2100
104 #define U_PF_SOLARIS 2600
106 #define U_PF_BSD 3000
108 #define U_PF_AIX 3100
110 #define U_PF_IRIX 3200
119 #define U_PF_DARWIN 3500
121 #define U_PF_IPHONE 3550
123 #define U_PF_QNX 3700
125 #define U_PF_LINUX 4000
132 #define U_PF_BROWSER_NATIVE_CLIENT 4020
134 #define U_PF_ANDROID 4050
136 #define U_PF_HAIKU 4080
138 #define U_PF_FUCHSIA 4100
139 /* Maximum value for Linux-based platform is 4499 */
147 #define U_PF_EMSCRIPTEN 5010
149 #define U_PF_OS390 9000
151 #define U_PF_OS400 9400
152
153 #ifdef U_PLATFORM
154 /* Use the predefined value. */
155 #elif defined(__MINGW32__)
156 # define U_PLATFORM U_PF_MINGW
157 #elif defined(__CYGWIN__)
158 # define U_PLATFORM U_PF_CYGWIN
159 /* Cygwin uchar.h doesn't exist until Cygwin 3.5. */
160 # include <cygwin/version.h>
161 #elif defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
162 # define U_PLATFORM U_PF_WINDOWS
163 #elif defined(__ANDROID__)
164 # define U_PLATFORM U_PF_ANDROID
165 /* Android wchar_t support depends on the API level. */
166 # include <android/api-level.h>
167 #elif defined(__pnacl__) || defined(__native_client__)
168 # define U_PLATFORM U_PF_BROWSER_NATIVE_CLIENT
169 #elif defined(__Fuchsia__)
170 # define U_PLATFORM U_PF_FUCHSIA
171 #elif defined(linux) || defined(__linux__) || defined(__linux)
172 # define U_PLATFORM U_PF_LINUX
173 #elif defined(__APPLE__) && defined(__MACH__)
174 # include <TargetConditionals.h>
175 # if (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) && (defined(TARGET_OS_MACCATALYST) && !TARGET_OS_MACCATALYST) /* variant of TARGET_OS_MAC */
176 # define U_PLATFORM U_PF_IPHONE
177 # else
178 # define U_PLATFORM U_PF_DARWIN
179 # endif
180 #elif defined(BSD) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__MirBSD__)
181 # if defined(__FreeBSD__)
182 # include <sys/endian.h>
183 # endif
184 # define U_PLATFORM U_PF_BSD
185 #elif defined(sun) || defined(__sun)
186 /* Check defined(__SVR4) || defined(__svr4__) to distinguish Solaris from SunOS? */
187 # define U_PLATFORM U_PF_SOLARIS
188 # if defined(__GNUC__)
189 /* Solaris/GCC needs this header file to get the proper endianness. Normally, this
190 * header file is included with stddef.h but on Solairs/GCC, the GCC version of stddef.h
191 * is included which does not include this header file.
192 */
193 # include <sys/isa_defs.h>
194 # endif
195 #elif defined(_AIX) || defined(__TOS_AIX__)
196 # define U_PLATFORM U_PF_AIX
197 #elif defined(_hpux) || defined(hpux) || defined(__hpux)
198 # define U_PLATFORM U_PF_HPUX
199 #elif defined(sgi) || defined(__sgi)
200 # define U_PLATFORM U_PF_IRIX
201 #elif defined(__QNX__) || defined(__QNXNTO__)
202 # define U_PLATFORM U_PF_QNX
203 #elif defined(__TOS_MVS__)
204 # define U_PLATFORM U_PF_OS390
205 #elif defined(__OS400__) || defined(__TOS_OS400__)
206 # define U_PLATFORM U_PF_OS400
207 #elif defined(__HAIKU__)
208 # define U_PLATFORM U_PF_HAIKU
209 #elif defined(__EMSCRIPTEN__)
210 # define U_PLATFORM U_PF_EMSCRIPTEN
211 #else
212 # define U_PLATFORM U_PF_UNKNOWN
213 #endif
214
222 #if (defined(_MSC_VER) && !(defined(__clang__) && __clang__)) || defined(U_IN_DOXYGEN)
223 # define U_REAL_MSVC
224 #endif
225
232 /* Commented out because this is already set in mh-cygwin-msvc
233 #if U_PLATFORM == U_PF_CYGWIN && defined(_MSC_VER)
234 # define CYGWINMSVC
235 #endif
236 */
237 #ifdef U_IN_DOXYGEN
238 # define CYGWINMSVC
239 #endif
240
247 #ifdef U_PLATFORM_USES_ONLY_WIN32_API
248 /* Use the predefined value. */
249 #elif (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_MINGW) || defined(CYGWINMSVC)
250 # define U_PLATFORM_USES_ONLY_WIN32_API 1
251 #else
252 /* Cygwin implements POSIX. */
253 # define U_PLATFORM_USES_ONLY_WIN32_API 0
254 #endif
255
262 #ifdef U_PLATFORM_HAS_WIN32_API
263 /* Use the predefined value. */
264 #elif U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN
265 # define U_PLATFORM_HAS_WIN32_API 1
266 #else
267 # define U_PLATFORM_HAS_WIN32_API 0
268 #endif
269
276 #ifdef U_PLATFORM_HAS_WINUWP_API
277 /* Use the predefined value. */
278 #else
279 # define U_PLATFORM_HAS_WINUWP_API 0
280 #endif
281
288 #ifdef U_PLATFORM_IMPLEMENTS_POSIX
289 /* Use the predefined value. */
290 #elif U_PLATFORM_USES_ONLY_WIN32_API
291 # define U_PLATFORM_IMPLEMENTS_POSIX 0
292 #else
293 # define U_PLATFORM_IMPLEMENTS_POSIX 1
294 #endif
295
301 #ifdef U_PLATFORM_IS_LINUX_BASED
302 /* Use the predefined value. */
303 #elif U_PF_LINUX <= U_PLATFORM && U_PLATFORM <= 4499
304 # define U_PLATFORM_IS_LINUX_BASED 1
305 #else
306 # define U_PLATFORM_IS_LINUX_BASED 0
307 #endif
308
314 #ifdef U_PLATFORM_IS_DARWIN_BASED
315 /* Use the predefined value. */
316 #elif U_PF_DARWIN <= U_PLATFORM && U_PLATFORM <= U_PF_IPHONE
317 # define U_PLATFORM_IS_DARWIN_BASED 1
318 #else
319 # define U_PLATFORM_IS_DARWIN_BASED 0
320 #endif
321
322 /*===========================================================================*/
324 /*===========================================================================*/
325
336 #ifdef __GNUC__
337 # define U_GCC_MAJOR_MINOR (__GNUC__ * 100 + __GNUC_MINOR__)
338 #else
339 # define U_GCC_MAJOR_MINOR 0
340 #endif
341
347 #ifdef U_IS_BIG_ENDIAN
348 /* Use the predefined value. */
349 #elif defined(BYTE_ORDER) && defined(BIG_ENDIAN)
350 # define U_IS_BIG_ENDIAN (BYTE_ORDER == BIG_ENDIAN)
351 #elif defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__)
352 /* gcc */
353 # define U_IS_BIG_ENDIAN (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
354 #elif defined(__BIG_ENDIAN__) || defined(_BIG_ENDIAN)
355 # define U_IS_BIG_ENDIAN 1
356 #elif defined(__LITTLE_ENDIAN__) || defined(_LITTLE_ENDIAN)
357 # define U_IS_BIG_ENDIAN 0
358 #elif U_PLATFORM == U_PF_OS390 || U_PLATFORM == U_PF_OS400 || defined(__s390__) || defined(__s390x__)
359 /* These platforms do not appear to predefine any endianness macros. */
360 # define U_IS_BIG_ENDIAN 1
361 #elif defined(_PA_RISC1_0) || defined(_PA_RISC1_1) || defined(_PA_RISC2_0)
362 /* HPPA do not appear to predefine any endianness macros. */
363 # define U_IS_BIG_ENDIAN 1
364 #elif defined(sparc) || defined(__sparc) || defined(__sparc__)
365 /* Some sparc based systems (e.g. Linux) do not predefine any endianness macros. */
366 # define U_IS_BIG_ENDIAN 1
367 #else
368 # define U_IS_BIG_ENDIAN 0
369 #endif
370
376 #ifdef U_HAVE_PLACEMENT_NEW
377 /* Use the predefined value. */
378 #elif defined(__BORLANDC__)
379 # define U_HAVE_PLACEMENT_NEW 0
380 #else
381 # define U_HAVE_PLACEMENT_NEW 1
382 #endif
383
390 #ifdef U_HAVE_DEBUG_LOCATION_NEW
391 /* Use the predefined value. */
392 #elif defined(_MSC_VER)
393 # define U_HAVE_DEBUG_LOCATION_NEW 1
394 #else
395 # define U_HAVE_DEBUG_LOCATION_NEW 0
396 #endif
397
398 /* Compatibility with compilers other than clang: http://clang.llvm.org/docs/LanguageExtensions.html */
399 #ifdef __has_attribute
400 # define UPRV_HAS_ATTRIBUTE(x) __has_attribute(x)
401 #else
402 # define UPRV_HAS_ATTRIBUTE(x) 0
403 #endif
404 #ifdef __has_cpp_attribute
405 # define UPRV_HAS_CPP_ATTRIBUTE(x) __has_cpp_attribute(x)
406 #else
407 # define UPRV_HAS_CPP_ATTRIBUTE(x) 0
408 #endif
409 #ifdef __has_declspec_attribute
410 # define UPRV_HAS_DECLSPEC_ATTRIBUTE(x) __has_declspec_attribute(x)
411 #else
412 # define UPRV_HAS_DECLSPEC_ATTRIBUTE(x) 0
413 #endif
414 #ifdef __has_builtin
415 # define UPRV_HAS_BUILTIN(x) __has_builtin(x)
416 #else
417 # define UPRV_HAS_BUILTIN(x) 0
418 #endif
419 #ifdef __has_feature
420 # define UPRV_HAS_FEATURE(x) __has_feature(x)
421 #else
422 # define UPRV_HAS_FEATURE(x) 0
423 #endif
424 #ifdef __has_extension
425 # define UPRV_HAS_EXTENSION(x) __has_extension(x)
426 #else
427 # define UPRV_HAS_EXTENSION(x) 0
428 #endif
429 #ifdef __has_warning
430 # define UPRV_HAS_WARNING(x) __has_warning(x)
431 #else
432 # define UPRV_HAS_WARNING(x) 0
433 #endif
434
435
436 #if defined(__clang__)
437 #define UPRV_NO_SANITIZE_UNDEFINED __attribute__((no_sanitize("undefined")))
438 #else
439 #define UPRV_NO_SANITIZE_UNDEFINED
440 #endif
441
447 #if defined(__GNUC__) && __GNUC__>=3
448 # define U_MALLOC_ATTR __attribute__ ((__malloc__))
449 #else
450 # define U_MALLOC_ATTR
451 #endif
452
458 #if (defined(__GNUC__) && \
459 (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3))) || \
460 UPRV_HAS_ATTRIBUTE(alloc_size)
461 # define U_ALLOC_SIZE_ATTR(X) __attribute__ ((alloc_size(X)))
462 # define U_ALLOC_SIZE_ATTR2(X,Y) __attribute__ ((alloc_size(X,Y)))
463 #else
464 # define U_ALLOC_SIZE_ATTR(X)
465 # define U_ALLOC_SIZE_ATTR2(X,Y)
466 #endif
467
474 #ifdef U_CPLUSPLUS_VERSION
475 # if U_CPLUSPLUS_VERSION != 0 && !defined(__cplusplus)
476 # undef U_CPLUSPLUS_VERSION
477 # define U_CPLUSPLUS_VERSION 0
478 # endif
479 /* Otherwise use the predefined value. */
480 #elif !defined(__cplusplus)
481 # define U_CPLUSPLUS_VERSION 0
482 #elif __cplusplus >= 201703L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
483 # define U_CPLUSPLUS_VERSION 17
484 #elif __cplusplus >= 201402L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201402L)
485 # define U_CPLUSPLUS_VERSION 14
486 #elif __cplusplus >= 201103L || (defined(_MSVC_LANG) && _MSVC_LANG >= 201103L)
487 # define U_CPLUSPLUS_VERSION 11
488 #else
489 // C++98 or C++03
490 # define U_CPLUSPLUS_VERSION 1
491 #endif
492
499 #ifndef __cplusplus
500 // Not for C.
501 #elif defined(U_FALLTHROUGH)
502 // Use the predefined value.
503 #elif defined(__clang__)
504 // Test for compiler vs. feature separately.
505 // Other compilers might choke on the feature test.
506 # if UPRV_HAS_CPP_ATTRIBUTE(clang::fallthrough) || \
507 (UPRV_HAS_FEATURE(cxx_attributes) && \
508 UPRV_HAS_WARNING("-Wimplicit-fallthrough"))
509 # define U_FALLTHROUGH [[clang::fallthrough]]
510 # endif
511 #elif defined(__GNUC__) && (__GNUC__ >= 7)
512 # define U_FALLTHROUGH __attribute__((fallthrough))
513 #endif
514
515 #ifndef U_FALLTHROUGH
516 # define U_FALLTHROUGH
517 #endif
518
521 /*===========================================================================*/
523 /*===========================================================================*/
524
529 #define U_ASCII_FAMILY 0
530
535 #define U_EBCDIC_FAMILY 1
536
579 #ifdef U_CHARSET_FAMILY
580 /* Use the predefined value. */
581 #elif U_PLATFORM == U_PF_OS390 && (!defined(__CHARSET_LIB) || !__CHARSET_LIB)
582 # define U_CHARSET_FAMILY U_EBCDIC_FAMILY
583 #elif U_PLATFORM == U_PF_OS400 && !defined(__UTF32__)
584 # define U_CHARSET_FAMILY U_EBCDIC_FAMILY
585 #else
586 # define U_CHARSET_FAMILY U_ASCII_FAMILY
587 #endif
588
609 #ifdef U_CHARSET_IS_UTF8
610 /* Use the predefined value. */
611 #elif U_PLATFORM_IS_LINUX_BASED || U_PLATFORM_IS_DARWIN_BASED || \
612 U_PLATFORM == U_PF_EMSCRIPTEN
613 # define U_CHARSET_IS_UTF8 1
614 #else
615 # define U_CHARSET_IS_UTF8 0
616 #endif
617
620 /*===========================================================================*/
622 /*===========================================================================*/
623
630 #ifdef U_HAVE_WCHAR_H
631 /* Use the predefined value. */
632 #elif U_PLATFORM == U_PF_ANDROID && __ANDROID_API__ < 9
633 /*
634 * Android before Gingerbread (Android 2.3, API level 9) did not support wchar_t.
635 * The type and header existed, but the library functions did not work as expected.
636 * The size of wchar_t was 1 but L"xyz" string literals had 32-bit units anyway.
637 */
638 # define U_HAVE_WCHAR_H 0
639 #else
640 # define U_HAVE_WCHAR_H 1
641 #endif
642
649 #ifdef U_SIZEOF_WCHAR_T
650 /* Use the predefined value. */
651 #elif (U_PLATFORM == U_PF_ANDROID && __ANDROID_API__ < 9)
652 /*
653 * Classic Mac OS and Mac OS X before 10.3 (Panther) did not support wchar_t or wstring.
654 * Newer Mac OS X has size 4.
655 */
656 # define U_SIZEOF_WCHAR_T 1
657 #elif U_PLATFORM_HAS_WIN32_API || U_PLATFORM == U_PF_CYGWIN
658 # define U_SIZEOF_WCHAR_T 2
659 #elif U_PLATFORM == U_PF_AIX
660 /*
661 * AIX 6.1 information, section "Wide character data representation":
662 * "... the wchar_t datatype is 32-bit in the 64-bit environment and
663 * 16-bit in the 32-bit environment."
664 * and
665 * "All locales use Unicode for their wide character code values (process code),
666 * except the IBM-eucTW codeset."
667 */
668 # ifdef __64BIT__
669 # define U_SIZEOF_WCHAR_T 4
670 # else
671 # define U_SIZEOF_WCHAR_T 2
672 # endif
673 #elif U_PLATFORM == U_PF_OS390
674 /*
675 * z/OS V1R11 information center, section "LP64 | ILP32":
676 * "In 31-bit mode, the size of long and pointers is 4 bytes and the size of wchar_t is 2 bytes.
677 * Under LP64, the size of long and pointer is 8 bytes and the size of wchar_t is 4 bytes."
678 */
679 # ifdef _LP64
680 # define U_SIZEOF_WCHAR_T 4
681 # else
682 # define U_SIZEOF_WCHAR_T 2
683 # endif
684 #elif U_PLATFORM == U_PF_OS400
685 # if defined(__UTF32__)
686 /*
687 * LOCALETYPE(*LOCALEUTF) is specified.
688 * Wide-character strings are in UTF-32,
689 * narrow-character strings are in UTF-8.
690 */
691 # define U_SIZEOF_WCHAR_T 4
692 # elif defined(__UCS2__)
693 /*
694 * LOCALETYPE(*LOCALEUCS2) is specified.
695 * Wide-character strings are in UCS-2,
696 * narrow-character strings are in EBCDIC.
697 */
698 # define U_SIZEOF_WCHAR_T 2
699 # else
700 /*
701 * LOCALETYPE(*CLD) or LOCALETYPE(*LOCALE) is specified.
702 * Wide-character strings are in 16-bit EBCDIC,
703 * narrow-character strings are in EBCDIC.
704 */
705 # define U_SIZEOF_WCHAR_T 2
706 # endif
707 #else
708 # define U_SIZEOF_WCHAR_T 4
709 #endif
710
711 #ifndef U_HAVE_WCSCPY
712 #define U_HAVE_WCSCPY U_HAVE_WCHAR_H
713 #endif
714
725 #ifdef U_HAVE_CHAR16_T
726 /* Use the predefined value. */
727 #else
728 /*
729 * Notes:
730 * C++11 and C11 require support for UTF-16 literals
731 * Doesn't work on Mac C11 (see workaround in ptypes.h)
732 * or Cygwin less than 3.5.
733 */
734 # if defined(__cplusplus)
735 # define U_HAVE_CHAR16_T 1
736 # elif U_PLATFORM_IS_DARWIN_BASED || (U_PLATFORM == U_PF_CYGWIN && CYGWIN_VERSION_DLL_MAJOR < 3005)
737 # define U_HAVE_CHAR16_T 0
738 # else
739 // conformant C11
740 # define U_HAVE_CHAR16_T 1
741 # endif
742 #endif
743
753 #ifdef U_DECLARE_UTF16
754 /* Use the predefined value. */
755 #elif U_HAVE_CHAR16_T \
756 || (defined(__xlC__) && defined(__IBM_UTF_LITERAL) && U_SIZEOF_WCHAR_T != 2) \
757 || (defined(__HP_aCC) && __HP_aCC >= 035000) \
758 || (defined(__HP_cc) && __HP_cc >= 111106) \
759 || (defined(U_IN_DOXYGEN))
760 # define U_DECLARE_UTF16(string) u ## string
761 #elif U_SIZEOF_WCHAR_T == 2 \
762 && (U_CHARSET_FAMILY == 0 || (U_PF_OS390 <= U_PLATFORM && U_PLATFORM <= U_PF_OS400 && defined(__UCS2__)))
763 # define U_DECLARE_UTF16(string) L ## string
764 #else
765 /* Leave U_DECLARE_UTF16 undefined. See unistr.h. */
766 #endif
767
770 /*===========================================================================*/
772 /*===========================================================================*/
773
774 #ifdef U_EXPORT
775 /* Use the predefined value. */
776 #elif defined(U_STATIC_IMPLEMENTATION)
777 # define U_EXPORT
778 #elif defined(_MSC_VER) || (UPRV_HAS_DECLSPEC_ATTRIBUTE(__dllexport__) && \
779 UPRV_HAS_DECLSPEC_ATTRIBUTE(__dllimport__))
780 # define U_EXPORT __declspec(dllexport)
781 #elif defined(__GNUC__) || defined(__open_xl__)
782 # define U_EXPORT __attribute__((visibility("default")))
783 #elif (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x550) \
784 || (defined(__SUNPRO_C) && __SUNPRO_C >= 0x550)
785 # define U_EXPORT __global
786 /*#elif defined(__HP_aCC) || defined(__HP_cc)
787 # define U_EXPORT __declspec(dllexport)*/
788 #else
789 # define U_EXPORT
790 #endif
791
792 /* U_CALLCONV is related to U_EXPORT2 */
793 #ifdef U_EXPORT2
794 /* Use the predefined value. */
795 #elif defined(_MSC_VER)
796 # define U_EXPORT2 __cdecl
797 #else
798 # define U_EXPORT2
799 #endif
800
801 #ifdef U_IMPORT
802 /* Use the predefined value. */
803 #elif defined(_MSC_VER) || (UPRV_HAS_DECLSPEC_ATTRIBUTE(__dllexport__) && \
804 UPRV_HAS_DECLSPEC_ATTRIBUTE(__dllimport__))
805 /* Windows needs to export/import data. */
806 # define U_IMPORT __declspec(dllimport)
807 #else
808 # define U_IMPORT
809 #endif
810
818 #ifdef U_HIDDEN
819 /* Use the predefined value. */
820 #elif defined(__GNUC__) || defined(__open_xl__)
821 # define U_HIDDEN __attribute__((visibility("hidden")))
822 #else
823 # define U_HIDDEN
824 #endif
825
843 #if U_PLATFORM == U_PF_OS390 && defined(__cplusplus)
844 # define U_CALLCONV __cdecl
845 #else
846 # define U_CALLCONV U_EXPORT2
847 #endif
848
854 #if U_PLATFORM == U_PF_OS390 && defined(__cplusplus)
855 # define U_CALLCONV_FPTR U_CALLCONV
856 #else
857 # define U_CALLCONV_FPTR
858 #endif
861 #endif // _PLATFORM_H
uconfig.h
User-configurable settings.
uvernum.h
C API: definitions of ICU version numbers.