ICU 65.1: umachine.h Source File

00001 // © 2016 and later: Unicode, Inc. and others.
00002 // License & terms of use: http://www.unicode.org/copyright.html
00003 /*
00004 ******************************************************************************
00005 *
00006 *   Copyright (C) 1999-2015, International Business Machines
00007 *   Corporation and others.  All Rights Reserved.
00008 *
00009 ******************************************************************************
00010 *   file name:  umachine.h
00011 *   encoding:   UTF-8
00012 *   tab size:   8 (not used)
00013 *   indentation:4
00014 *
00015 *   created on: 1999sep13
00016 *   created by: Markus W. Scherer
00017 *
00018 *   This file defines basic types and constants for ICU to be
00019 *   platform-independent. umachine.h and utf.h are included into
00020 *   utypes.h to provide all the general definitions for ICU.
00021 *   All of these definitions used to be in utypes.h before
00022 *   the UTF-handling macros made this unmaintainable.
00023 */
00024 
00025 #ifndef __UMACHINE_H__
00026 #define __UMACHINE_H__
00027 
00028 
00041 /*==========================================================================*/
00042 /* Include platform-dependent definitions                                   */
00043 /* which are contained in the platform-specific file platform.h             */
00044 /*==========================================================================*/
00045 
00046 #include "unicode/ptypes.h" /* platform.h is included in ptypes.h */
00047 
00048 /*
00049  * ANSI C headers:
00050  * stddef.h defines wchar_t
00051  */
00052 #include <stddef.h>
00053 
00054 /*==========================================================================*/
00055 /* For C wrappers, we use the symbol U_STABLE.                                */
00056 /* This works properly if the includer is C or C++.                         */
00057 /* Functions are declared   U_STABLE return-type U_EXPORT2 function-name()... */
00058 /*==========================================================================*/
00059 
00078 #ifdef __cplusplus
00079 #   define U_CFUNC extern "C"
00080 #   define U_CDECL_BEGIN extern "C" {
00081 #   define U_CDECL_END   }
00082 #else
00083 #   define U_CFUNC extern
00084 #   define U_CDECL_BEGIN
00085 #   define U_CDECL_END
00086 #endif
00087 
00088 #ifndef U_ATTRIBUTE_DEPRECATED
00089 
00094 #if U_GCC_MAJOR_MINOR >= 302
00095 #    define U_ATTRIBUTE_DEPRECATED __attribute__ ((deprecated))
00096 
00101 #elif defined(_MSC_VER) && (_MSC_VER >= 1400)
00102 #    define U_ATTRIBUTE_DEPRECATED __declspec(deprecated)
00103 #else
00104 #    define U_ATTRIBUTE_DEPRECATED
00105 #endif
00106 #endif
00107 
00109 #define U_CAPI U_CFUNC U_EXPORT
00110 
00111 #define U_STABLE U_CAPI
00112 
00113 #define U_DRAFT  U_CAPI
00114 
00115 #define U_DEPRECATED U_CAPI U_ATTRIBUTE_DEPRECATED
00116 
00117 #define U_OBSOLETE U_CAPI
00118 
00119 #define U_INTERNAL U_CAPI
00120 
00128 #ifndef U_OVERRIDE
00129 #define U_OVERRIDE override
00130 #endif
00131 
00139 #if !defined(U_FINAL) || defined(U_IN_DOXYGEN)
00140 #define U_FINAL final
00141 #endif
00142 
00143 // Before ICU 65, function-like, multi-statement ICU macros were just defined as
00144 // series of statements wrapped in { } blocks and the caller could choose to
00145 // either treat them as if they were actual functions and end the invocation
00146 // with a trailing ; creating an empty statement after the block or else omit
00147 // this trailing ; using the knowledge that the macro would expand to { }.
00148 //
00149 // But doing so doesn't work well with macros that look like functions and
00150 // compiler warnings about empty statements (ICU-20601) and ICU 65 therefore
00151 // switches to the standard solution of wrapping such macros in do { } while.
00152 //
00153 // This will however break existing code that depends on being able to invoke
00154 // these macros without a trailing ; so to be able to remain compatible with
00155 // such code the wrapper is itself defined as macros so that it's possible to
00156 // build ICU 65 and later with the old macro behaviour, like this:
00157 //
00158 // export CPPFLAGS='-DUPRV_BLOCK_MACRO_BEGIN="" -DUPRV_BLOCK_MACRO_END=""'
00159 // runConfigureICU ...
00160 //
00161 
00167 #ifndef UPRV_BLOCK_MACRO_BEGIN
00168 #define UPRV_BLOCK_MACRO_BEGIN do
00169 #endif
00170 
00176 #ifndef UPRV_BLOCK_MACRO_END
00177 #define UPRV_BLOCK_MACRO_END while (FALSE)
00178 #endif
00179 
00180 /*==========================================================================*/
00181 /* limits for int32_t etc., like in POSIX inttypes.h                        */
00182 /*==========================================================================*/
00183 
00184 #ifndef INT8_MIN
00185 
00186 #   define INT8_MIN        ((int8_t)(-128))
00187 #endif
00188 #ifndef INT16_MIN
00189 
00190 #   define INT16_MIN       ((int16_t)(-32767-1))
00191 #endif
00192 #ifndef INT32_MIN
00193 
00194 #   define INT32_MIN       ((int32_t)(-2147483647-1))
00195 #endif
00196 
00197 #ifndef INT8_MAX
00198 
00199 #   define INT8_MAX        ((int8_t)(127))
00200 #endif
00201 #ifndef INT16_MAX
00202 
00203 #   define INT16_MAX       ((int16_t)(32767))
00204 #endif
00205 #ifndef INT32_MAX
00206 
00207 #   define INT32_MAX       ((int32_t)(2147483647))
00208 #endif
00209 
00210 #ifndef UINT8_MAX
00211 
00212 #   define UINT8_MAX       ((uint8_t)(255U))
00213 #endif
00214 #ifndef UINT16_MAX
00215 
00216 #   define UINT16_MAX      ((uint16_t)(65535U))
00217 #endif
00218 #ifndef UINT32_MAX
00219 
00220 #   define UINT32_MAX      ((uint32_t)(4294967295U))
00221 #endif
00222 
00223 #if defined(U_INT64_T_UNAVAILABLE)
00224 # error int64_t is required for decimal format and rule-based number format.
00225 #else
00226 # ifndef INT64_C
00227 
00232 #   define INT64_C(c) c ## LL
00233 # endif
00234 # ifndef UINT64_C
00235 
00240 #   define UINT64_C(c) c ## ULL
00241 # endif
00242 # ifndef U_INT64_MIN
00243 
00244 #     define U_INT64_MIN       ((int64_t)(INT64_C(-9223372036854775807)-1))
00245 # endif
00246 # ifndef U_INT64_MAX
00247 
00248 #     define U_INT64_MAX       ((int64_t)(INT64_C(9223372036854775807)))
00249 # endif
00250 # ifndef U_UINT64_MAX
00251 
00252 #     define U_UINT64_MAX      ((uint64_t)(UINT64_C(18446744073709551615)))
00253 # endif
00254 #endif
00255 
00256 /*==========================================================================*/
00257 /* Boolean data type                                                        */
00258 /*==========================================================================*/
00259 
00261 typedef int8_t UBool;
00262 
00263 #ifndef TRUE
00264 
00265 #   define TRUE  1
00266 #endif
00267 #ifndef FALSE
00268 
00269 #   define FALSE 0
00270 #endif
00271 
00272 
00273 /*==========================================================================*/
00274 /* Unicode data types                                                       */
00275 /*==========================================================================*/
00276 
00277 /* wchar_t-related definitions -------------------------------------------- */
00278 
00279 /*
00280  * \def U_WCHAR_IS_UTF16
00281  * Defined if wchar_t uses UTF-16.
00282  *
00283  * @stable ICU 2.0
00284  */
00285 /*
00286  * \def U_WCHAR_IS_UTF32
00287  * Defined if wchar_t uses UTF-32.
00288  *
00289  * @stable ICU 2.0
00290  */
00291 #if !defined(U_WCHAR_IS_UTF16) && !defined(U_WCHAR_IS_UTF32)
00292 #   ifdef __STDC_ISO_10646__
00293 #       if (U_SIZEOF_WCHAR_T==2)
00294 #           define U_WCHAR_IS_UTF16
00295 #       elif (U_SIZEOF_WCHAR_T==4)
00296 #           define  U_WCHAR_IS_UTF32
00297 #       endif
00298 #   elif defined __UCS2__
00299 #       if (U_PF_OS390 <= U_PLATFORM && U_PLATFORM <= U_PF_OS400) && (U_SIZEOF_WCHAR_T==2)
00300 #           define U_WCHAR_IS_UTF16
00301 #       endif
00302 #   elif defined(__UCS4__) || (U_PLATFORM == U_PF_OS400 && defined(__UTF32__))
00303 #       if (U_SIZEOF_WCHAR_T==4)
00304 #           define U_WCHAR_IS_UTF32
00305 #       endif
00306 #   elif U_PLATFORM_IS_DARWIN_BASED || (U_SIZEOF_WCHAR_T==4 && U_PLATFORM_IS_LINUX_BASED)
00307 #       define U_WCHAR_IS_UTF32
00308 #   elif U_PLATFORM_HAS_WIN32_API
00309 #       define U_WCHAR_IS_UTF16
00310 #   endif
00311 #endif
00312 
00313 /* UChar and UChar32 definitions -------------------------------------------- */
00314 
00316 #define U_SIZEOF_UCHAR 2
00317 
00323 #if (U_PLATFORM == U_PF_AIX) && defined(__cplusplus) &&(U_CPLUSPLUS_VERSION < 11)
00324 // for AIX, uchar.h needs to be included
00325 # include <uchar.h>
00326 # define U_CHAR16_IS_TYPEDEF 1
00327 #elif defined(_MSC_VER) && (_MSC_VER < 1900)
00328 // Versions of Visual Studio/MSVC below 2015 do not support char16_t as a real type,
00329 // and instead use a typedef.  https://msdn.microsoft.com/library/bb531344.aspx
00330 # define U_CHAR16_IS_TYPEDEF 1
00331 #else
00332 # define U_CHAR16_IS_TYPEDEF 0
00333 #endif
00334 
00335 
00360 #if 1
00361     // #if 1 is normal. UChar defaults to char16_t in C++.
00362     // For configuration testing of UChar=uint16_t temporarily change this to #if 0.
00363     // The intltest Makefile #defines UCHAR_TYPE=char16_t,
00364     // so we only #define it to uint16_t if it is undefined so far.
00365 #elif !defined(UCHAR_TYPE)
00366 #   define UCHAR_TYPE uint16_t
00367 #endif
00368 
00369 #if defined(U_COMBINED_IMPLEMENTATION) || defined(U_COMMON_IMPLEMENTATION) || \
00370         defined(U_I18N_IMPLEMENTATION) || defined(U_IO_IMPLEMENTATION)
00371     // Inside the ICU library code, never configurable.
00372     typedef char16_t UChar;
00373 #elif defined(UCHAR_TYPE)
00374     typedef UCHAR_TYPE UChar;
00375 #elif defined(__cplusplus)
00376     typedef char16_t UChar;
00377 #else
00378     typedef uint16_t UChar;
00379 #endif
00380 
00400 #if U_SIZEOF_WCHAR_T==2
00401     typedef wchar_t OldUChar;
00402 #elif defined(__CHAR16_TYPE__)
00403     typedef __CHAR16_TYPE__ OldUChar;
00404 #else
00405     typedef uint16_t OldUChar;
00406 #endif
00407 
00425 typedef int32_t UChar32;
00426 
00445 #define U_SENTINEL (-1)
00446 
00447 #include "unicode/urename.h"
00448 
00449 #endif