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

ICU 74.2 74.2

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_FUCHSIA 4100
137/* Maximum value for Linux-based platform is 4499 */
145#define U_PF_EMSCRIPTEN 5010
147#define U_PF_OS390 9000
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) && (defined(TARGET_OS_MACCATALYST) && !TARGET_OS_MACCATALYST) /* 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
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
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
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
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
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
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
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
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
337#ifdef U_HAVE_INTTYPES_H
338 /* Use the predefined value. */
339#elif U_PLATFORM == U_PF_SOLARIS
340 /* Solaris has inttypes.h but not stdint.h. */
341# define U_HAVE_INTTYPES_H 1
342#elif U_PLATFORM == U_PF_AIX && !defined(_AIX51) && defined(_POWER)
343 /* PPC AIX <= 4.3 has inttypes.h but not stdint.h. */
344# define U_HAVE_INTTYPES_H 1
345#else
346 /* Most platforms have both inttypes.h and stdint.h, or neither. */
347# define U_HAVE_INTTYPES_H U_HAVE_STDINT_H
348#endif
349
350/*===========================================================================*/
352/*===========================================================================*/
353
364#ifdef __GNUC__
365# define U_GCC_MAJOR_MINOR (__GNUC__ * 100 + __GNUC_MINOR__)
366#else
367# define U_GCC_MAJOR_MINOR 0
368#endif
369
375#ifdef U_IS_BIG_ENDIAN
376 /* Use the predefined value. */
377#elif defined(BYTE_ORDER) && defined(BIG_ENDIAN)
378# define U_IS_BIG_ENDIAN (BYTE_ORDER == BIG_ENDIAN)
379#elif defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__)
380 /* gcc */
381# define U_IS_BIG_ENDIAN (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
382#elif defined(__BIG_ENDIAN__) || defined(_BIG_ENDIAN)
383# define U_IS_BIG_ENDIAN 1
384#elif defined(__LITTLE_ENDIAN__) || defined(_LITTLE_ENDIAN)
385# define U_IS_BIG_ENDIAN 0
386#elif U_PLATFORM == U_PF_OS390 || U_PLATFORM == U_PF_OS400 || defined(__s390__) || defined(__s390x__)
387 /* These platforms do not appear to predefine any endianness macros. */
388# define U_IS_BIG_ENDIAN 1
389#elif defined(_PA_RISC1_0) || defined(_PA_RISC1_1) || defined(_PA_RISC2_0)
390 /* HPPA do not appear to predefine any endianness macros. */
391# define U_IS_BIG_ENDIAN 1
392#elif defined(sparc) || defined(__sparc) || defined(__sparc__)
393 /* Some sparc based systems (e.g. Linux) do not predefine any endianness macros. */
394# define U_IS_BIG_ENDIAN 1
395#else
396# define U_IS_BIG_ENDIAN 0
397#endif
398
404#ifdef U_HAVE_PLACEMENT_NEW
405 /* Use the predefined value. */
406#elif defined(__BORLANDC__)
407# define U_HAVE_PLACEMENT_NEW 0
408#else
409# define U_HAVE_PLACEMENT_NEW 1
410#endif
411
418#ifdef U_HAVE_DEBUG_LOCATION_NEW
419 /* Use the predefined value. */
420#elif defined(_MSC_VER)
421# define U_HAVE_DEBUG_LOCATION_NEW 1
422#else
423# define U_HAVE_DEBUG_LOCATION_NEW 0
424#endif
425
426/* Compatibility with compilers other than clang: http://clang.llvm.org/docs/LanguageExtensions.html */
427#ifdef __has_attribute
428# define UPRV_HAS_ATTRIBUTE(x) __has_attribute(x)
429#else
430# define UPRV_HAS_ATTRIBUTE(x) 0
431#endif
432#ifdef __has_cpp_attribute
433# define UPRV_HAS_CPP_ATTRIBUTE(x) __has_cpp_attribute(x)
434#else
435# define UPRV_HAS_CPP_ATTRIBUTE(x) 0
436#endif
437#ifdef __has_declspec_attribute
438# define UPRV_HAS_DECLSPEC_ATTRIBUTE(x) __has_declspec_attribute(x)
439#else
440# define UPRV_HAS_DECLSPEC_ATTRIBUTE(x) 0
441#endif
442#ifdef __has_builtin
443# define UPRV_HAS_BUILTIN(x) __has_builtin(x)
444#else
445# define UPRV_HAS_BUILTIN(x) 0
446#endif
447#ifdef __has_feature
448# define UPRV_HAS_FEATURE(x) __has_feature(x)
449#else
450# define UPRV_HAS_FEATURE(x) 0
451#endif
452#ifdef __has_extension
453# define UPRV_HAS_EXTENSION(x) __has_extension(x)
454#else
455# define UPRV_HAS_EXTENSION(x) 0
456#endif
457#ifdef __has_warning
458# define UPRV_HAS_WARNING(x) __has_warning(x)
459#else
460# define UPRV_HAS_WARNING(x) 0
461#endif
462
463
464#if defined(__clang__)
465#define UPRV_NO_SANITIZE_UNDEFINED __attribute__((no_sanitize("undefined")))
466#else
467#define UPRV_NO_SANITIZE_UNDEFINED
468#endif
469
475#if defined(__GNUC__) && __GNUC__>=3
476# define U_MALLOC_ATTR __attribute__ ((__malloc__))
477#else
478# define U_MALLOC_ATTR
479#endif
480
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
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
525#ifndef __cplusplus
526 // Not for C.
527#elif defined(U_FALLTHROUGH)
528 // Use the predefined value.
529#elif defined(__clang__)
530 // Test for compiler vs. feature separately.
531 // Other compilers might choke on the feature test.
532# if UPRV_HAS_CPP_ATTRIBUTE(clang::fallthrough) || \
533 (UPRV_HAS_FEATURE(cxx_attributes) && \
534 UPRV_HAS_WARNING("-Wimplicit-fallthrough"))
535# define U_FALLTHROUGH [[clang::fallthrough]]
536# endif
537#elif defined(__GNUC__) && (__GNUC__ >= 7)
538# define U_FALLTHROUGH __attribute__((fallthrough))
539#endif
540
541#ifndef U_FALLTHROUGH
542# define U_FALLTHROUGH
543#endif
544
547/*===========================================================================*/
549/*===========================================================================*/
550
555#define U_ASCII_FAMILY 0
556
561#define U_EBCDIC_FAMILY 1
562
605#ifdef U_CHARSET_FAMILY
606 /* Use the predefined value. */
607#elif U_PLATFORM == U_PF_OS390 && (!defined(__CHARSET_LIB) || !__CHARSET_LIB)
608# define U_CHARSET_FAMILY U_EBCDIC_FAMILY
609#elif U_PLATFORM == U_PF_OS400 && !defined(__UTF32__)
610# define U_CHARSET_FAMILY U_EBCDIC_FAMILY
611#else
612# define U_CHARSET_FAMILY U_ASCII_FAMILY
613#endif
614
635#ifdef U_CHARSET_IS_UTF8
636 /* Use the predefined value. */
637#elif U_PLATFORM_IS_LINUX_BASED || U_PLATFORM_IS_DARWIN_BASED || \
638 U_PLATFORM == U_PF_EMSCRIPTEN
639# define U_CHARSET_IS_UTF8 1
640#else
641# define U_CHARSET_IS_UTF8 0
642#endif
643
646/*===========================================================================*/
648/*===========================================================================*/
649
656#ifdef U_HAVE_WCHAR_H
657 /* Use the predefined value. */
658#elif U_PLATFORM == U_PF_ANDROID && __ANDROID_API__ < 9
659 /*
660 * Android before Gingerbread (Android 2.3, API level 9) did not support wchar_t.
661 * The type and header existed, but the library functions did not work as expected.
662 * The size of wchar_t was 1 but L"xyz" string literals had 32-bit units anyway.
663 */
664# define U_HAVE_WCHAR_H 0
665#else
666# define U_HAVE_WCHAR_H 1
667#endif
668
675#ifdef U_SIZEOF_WCHAR_T
676 /* Use the predefined value. */
677#elif (U_PLATFORM == U_PF_ANDROID && __ANDROID_API__ < 9)
678 /*
679 * Classic Mac OS and Mac OS X before 10.3 (Panther) did not support wchar_t or wstring.
680 * Newer Mac OS X has size 4.
681 */
682# define U_SIZEOF_WCHAR_T 1
683#elif U_PLATFORM_HAS_WIN32_API || U_PLATFORM == U_PF_CYGWIN
684# define U_SIZEOF_WCHAR_T 2
685#elif U_PLATFORM == U_PF_AIX
686 /*
687 * AIX 6.1 information, section "Wide character data representation":
688 * "... the wchar_t datatype is 32-bit in the 64-bit environment and
689 * 16-bit in the 32-bit environment."
690 * and
691 * "All locales use Unicode for their wide character code values (process code),
692 * except the IBM-eucTW codeset."
693 */
694# ifdef __64BIT__
695# define U_SIZEOF_WCHAR_T 4
696# else
697# define U_SIZEOF_WCHAR_T 2
698# endif
699#elif U_PLATFORM == U_PF_OS390
700 /*
701 * z/OS V1R11 information center, section "LP64 | ILP32":
702 * "In 31-bit mode, the size of long and pointers is 4 bytes and the size of wchar_t is 2 bytes.
703 * Under LP64, the size of long and pointer is 8 bytes and the size of wchar_t is 4 bytes."
704 */
705# ifdef _LP64
706# define U_SIZEOF_WCHAR_T 4
707# else
708# define U_SIZEOF_WCHAR_T 2
709# endif
710#elif U_PLATFORM == U_PF_OS400
711# if defined(__UTF32__)
712 /*
713 * LOCALETYPE(*LOCALEUTF) is specified.
714 * Wide-character strings are in UTF-32,
715 * narrow-character strings are in UTF-8.
716 */
717# define U_SIZEOF_WCHAR_T 4
718# elif defined(__UCS2__)
719 /*
720 * LOCALETYPE(*LOCALEUCS2) is specified.
721 * Wide-character strings are in UCS-2,
722 * narrow-character strings are in EBCDIC.
723 */
724# define U_SIZEOF_WCHAR_T 2
725# else
726 /*
727 * LOCALETYPE(*CLD) or LOCALETYPE(*LOCALE) is specified.
728 * Wide-character strings are in 16-bit EBCDIC,
729 * narrow-character strings are in EBCDIC.
730 */
731# define U_SIZEOF_WCHAR_T 2
732# endif
733#else
734# define U_SIZEOF_WCHAR_T 4
735#endif
736
737#ifndef U_HAVE_WCSCPY
738#define U_HAVE_WCSCPY U_HAVE_WCHAR_H
739#endif
740
751#ifdef U_HAVE_CHAR16_T
752 /* Use the predefined value. */
753#else
754 /*
755 * Notes:
756 * C++11 and C11 require support for UTF-16 literals
757 * TODO: Fix for plain C. Doesn't work on Mac.
758 */
759# if U_CPLUSPLUS_VERSION >= 11 || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L)
760# define U_HAVE_CHAR16_T 1
761# else
762# define U_HAVE_CHAR16_T 0
763# endif
764#endif
765
773#ifdef U_DECLARE_UTF16
774 /* Use the predefined value. */
775#elif U_HAVE_CHAR16_T \
776 || (defined(__xlC__) && defined(__IBM_UTF_LITERAL) && U_SIZEOF_WCHAR_T != 2) \
777 || (defined(__HP_aCC) && __HP_aCC >= 035000) \
778 || (defined(__HP_cc) && __HP_cc >= 111106) \
779 || (defined(U_IN_DOXYGEN))
780# define U_DECLARE_UTF16(string) u ## string
781#elif U_SIZEOF_WCHAR_T == 2 \
782 && (U_CHARSET_FAMILY == 0 || (U_PF_OS390 <= U_PLATFORM && U_PLATFORM <= U_PF_OS400 && defined(__UCS2__)))
783# define U_DECLARE_UTF16(string) L ## string
784#else
785 /* Leave U_DECLARE_UTF16 undefined. See unistr.h. */
786#endif
787
790/*===========================================================================*/
792/*===========================================================================*/
793
794#ifdef U_EXPORT
795 /* Use the predefined value. */
796#elif defined(U_STATIC_IMPLEMENTATION)
797# define U_EXPORT
798#elif defined(_MSC_VER) || (UPRV_HAS_DECLSPEC_ATTRIBUTE(__dllexport__) && \
799 UPRV_HAS_DECLSPEC_ATTRIBUTE(__dllimport__))
800# define U_EXPORT __declspec(dllexport)
801#elif defined(__GNUC__)
802# define U_EXPORT __attribute__((visibility("default")))
803#elif (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x550) \
804 || (defined(__SUNPRO_C) && __SUNPRO_C >= 0x550)
805# define U_EXPORT __global
806/*#elif defined(__HP_aCC) || defined(__HP_cc)
807# define U_EXPORT __declspec(dllexport)*/
808#else
809# define U_EXPORT
810#endif
811
812/* U_CALLCONV is related to U_EXPORT2 */
813#ifdef U_EXPORT2
814 /* Use the predefined value. */
815#elif defined(_MSC_VER)
816# define U_EXPORT2 __cdecl
817#else
818# define U_EXPORT2
819#endif
820
821#ifdef U_IMPORT
822 /* Use the predefined value. */
823#elif defined(_MSC_VER) || (UPRV_HAS_DECLSPEC_ATTRIBUTE(__dllexport__) && \
824 UPRV_HAS_DECLSPEC_ATTRIBUTE(__dllimport__))
825 /* Windows needs to export/import data. */
826# define U_IMPORT __declspec(dllimport)
827#else
828# define U_IMPORT
829#endif
830
838#ifdef U_HIDDEN
839 /* Use the predefined value. */
840#elif defined(__GNUC__)
841# define U_HIDDEN __attribute__((visibility("hidden")))
842#else
843# define U_HIDDEN
844#endif
845
863#if U_PLATFORM == U_PF_OS390 && defined(__cplusplus)
864# define U_CALLCONV __cdecl
865#else
866# define U_CALLCONV U_EXPORT2
867#endif
868
874#if U_PLATFORM == U_PF_OS390 && defined(__cplusplus)
875# define U_CALLCONV_FPTR U_CALLCONV
876#else
877# define U_CALLCONV_FPTR
878#endif
881#endif // _PLATFORM_H
uconfig.h
User-configurable settings.
uvernum.h
C API: definitions of ICU version numbers.