[apple/icu.git] / icuSources / common / unicode / umachine.h

/*
******************************************************************************
*
*   Copyright (C) 1999-2012, International Business Machines
*   Corporation and others.  All Rights Reserved.
*
******************************************************************************
*   file name:  umachine.h
*   encoding:   US-ASCII
*   tab size:   8 (not used)
*   indentation:4
*
*   created on: 1999sep13
*   created by: Markus W. Scherer
*
*   This file defines basic types and constants for utf.h to be
*   platform-independent. umachine.h and utf.h are included into
*   utypes.h to provide all the general definitions for ICU.
*   All of these definitions used to be in utypes.h before
*   the UTF-handling macros made this unmaintainable.
*/

#ifndef __UMACHINE_H__
#define __UMACHINE_H__


/**
 * \file
 * \brief Basic types and constants for UTF
 *
 * <h2> Basic types and constants for UTF </h2>
 *   This file defines basic types and constants for utf.h to be
 *   platform-independent. umachine.h and utf.h are included into
 *   utypes.h to provide all the general definitions for ICU.
 *   All of these definitions used to be in utypes.h before
 *   the UTF-handling macros made this unmaintainable.
 *
 */
/*==========================================================================*/
/* Include platform-dependent definitions                                   */
/* which are contained in the platform-specific file platform.h             */
/*==========================================================================*/

#include "unicode/ptypes.h" /* platform.h is included in ptypes.h */

/*
 * ANSI C headers:
 * stddef.h defines wchar_t
 */
#include <stddef.h>

/*==========================================================================*/
/* For C wrappers, we use the symbol U_STABLE.                                */
/* This works properly if the includer is C or C++.                         */
/* Functions are declared   U_STABLE return-type U_EXPORT2 function-name()... */
/*==========================================================================*/

/**
 * \def U_CFUNC
 * This is used in a declaration of a library private ICU C function.
 * @stable ICU 2.4
 */

/**
 * \def U_CDECL_BEGIN
 * This is used to begin a declaration of a library private ICU C API.
 * @stable ICU 2.4
 */

/**
 * \def U_CDECL_END
 * This is used to end a declaration of a library private ICU C API
 * @stable ICU 2.4
 */

#ifdef __cplusplus
#   define U_CFUNC extern "C"
#   define U_CDECL_BEGIN extern "C" {
#   define U_CDECL_END   }
#else
#   define U_CFUNC extern
#   define U_CDECL_BEGIN
#   define U_CDECL_END
#endif

#ifndef U_ATTRIBUTE_DEPRECATED
/**
 * \def U_ATTRIBUTE_DEPRECATED
 *  This is used for GCC specific attributes
 * @internal
 */
#if U_GCC_MAJOR_MINOR >= 302
#    define U_ATTRIBUTE_DEPRECATED __attribute__ ((deprecated))
/**
 * \def U_ATTRIBUTE_DEPRECATED
 * This is used for Visual C++ specific attributes 
 * @internal
 */
#elif defined(_MSC_VER) && (_MSC_VER >= 1400)
#    define U_ATTRIBUTE_DEPRECATED __declspec(deprecated)
#else
#    define U_ATTRIBUTE_DEPRECATED
#endif
#endif

/** This is used to declare a function as a public ICU C API @stable ICU 2.0*/
#define U_CAPI U_CFUNC U_EXPORT
/** This is used to declare a function as a stable public ICU C API*/
#define U_STABLE U_CAPI
/** This is used to declare a function as a draft public ICU C API  */
#define U_DRAFT  U_CAPI
/** This is used to declare a function as a deprecated public ICU C API  */
#define U_DEPRECATED U_CAPI U_ATTRIBUTE_DEPRECATED
/** This is used to declare a function as an obsolete public ICU C API  */
#define U_OBSOLETE U_CAPI
/** This is used to declare a function as an internal ICU C API  */
#define U_INTERNAL U_CAPI

/*==========================================================================*/
/* limits for int32_t etc., like in POSIX inttypes.h                        */
/*==========================================================================*/

#ifndef INT8_MIN
/** The smallest value an 8 bit signed integer can hold @stable ICU 2.0 */
#   define INT8_MIN        ((int8_t)(-128))
#endif
#ifndef INT16_MIN
/** The smallest value a 16 bit signed integer can hold @stable ICU 2.0 */
#   define INT16_MIN       ((int16_t)(-32767-1))
#endif
#ifndef INT32_MIN
/** The smallest value a 32 bit signed integer can hold @stable ICU 2.0 */
#   define INT32_MIN       ((int32_t)(-2147483647-1))
#endif

#ifndef INT8_MAX
/** The largest value an 8 bit signed integer can hold @stable ICU 2.0 */
#   define INT8_MAX        ((int8_t)(127))
#endif
#ifndef INT16_MAX
/** The largest value a 16 bit signed integer can hold @stable ICU 2.0 */
#   define INT16_MAX       ((int16_t)(32767))
#endif
#ifndef INT32_MAX
/** The largest value a 32 bit signed integer can hold @stable ICU 2.0 */
#   define INT32_MAX       ((int32_t)(2147483647))
#endif

#ifndef UINT8_MAX
/** The largest value an 8 bit unsigned integer can hold @stable ICU 2.0 */
#   define UINT8_MAX       ((uint8_t)(255U))
#endif
#ifndef UINT16_MAX
/** The largest value a 16 bit unsigned integer can hold @stable ICU 2.0 */
#   define UINT16_MAX      ((uint16_t)(65535U))
#endif
#ifndef UINT32_MAX
/** The largest value a 32 bit unsigned integer can hold @stable ICU 2.0 */
#   define UINT32_MAX      ((uint32_t)(4294967295U))
#endif

#if defined(U_INT64_T_UNAVAILABLE)
# error int64_t is required for decimal format and rule-based number format.
#else
# ifndef INT64_C
/**
 * Provides a platform independent way to specify a signed 64-bit integer constant.
 * note: may be wrong for some 64 bit platforms - ensure your compiler provides INT64_C
 * @stable ICU 2.8
 */
#   define INT64_C(c) c ## LL
# endif
# ifndef UINT64_C
/**
 * Provides a platform independent way to specify an unsigned 64-bit integer constant.
 * note: may be wrong for some 64 bit platforms - ensure your compiler provides UINT64_C
 * @stable ICU 2.8
 */
#   define UINT64_C(c) c ## ULL
# endif
# ifndef U_INT64_MIN
/** The smallest value a 64 bit signed integer can hold @stable ICU 2.8 */
#     define U_INT64_MIN       ((int64_t)(INT64_C(-9223372036854775807)-1))
# endif
# ifndef U_INT64_MAX
/** The largest value a 64 bit signed integer can hold @stable ICU 2.8 */
#     define U_INT64_MAX       ((int64_t)(INT64_C(9223372036854775807)))
# endif
# ifndef U_UINT64_MAX
/** The largest value a 64 bit unsigned integer can hold @stable ICU 2.8 */
#     define U_UINT64_MAX      ((uint64_t)(UINT64_C(18446744073709551615)))
# endif
#endif

/*==========================================================================*/
/* Boolean data type                                                        */
/*==========================================================================*/

/** The ICU boolean type @stable ICU 2.0 */
typedef int8_t UBool;

#ifndef TRUE
/** The TRUE value of a UBool @stable ICU 2.0 */
#   define TRUE  1
#endif
#ifndef FALSE
/** The FALSE value of a UBool @stable ICU 2.0 */
#   define FALSE 0
#endif


/*==========================================================================*/
/* Unicode data types                                                       */
/*==========================================================================*/

/* wchar_t-related definitions -------------------------------------------- */

/*
 * \def U_WCHAR_IS_UTF16
 * Defined if wchar_t uses UTF-16.
 *
 * @stable ICU 2.0
 */
/*
 * \def U_WCHAR_IS_UTF32
 * Defined if wchar_t uses UTF-32.
 *
 * @stable ICU 2.0
 */
#if !defined(U_WCHAR_IS_UTF16) && !defined(U_WCHAR_IS_UTF32)
#   ifdef __STDC_ISO_10646__
#       if (U_SIZEOF_WCHAR_T==2)
#           define U_WCHAR_IS_UTF16
#       elif (U_SIZEOF_WCHAR_T==4)
#           define  U_WCHAR_IS_UTF32
#       endif
#   elif defined __UCS2__
#       if (U_PF_OS390 <= U_PLATFORM && U_PLATFORM <= U_PF_OS400) && (U_SIZEOF_WCHAR_T==2)
#           define U_WCHAR_IS_UTF16
#       endif
#   elif defined(__UCS4__) || (U_PLATFORM == U_PF_OS400 && defined(__UTF32__))
#       if (U_SIZEOF_WCHAR_T==4)
#           define U_WCHAR_IS_UTF32
#       endif
#   elif U_PLATFORM_IS_DARWIN_BASED || (U_SIZEOF_WCHAR_T==4 && U_PLATFORM_IS_LINUX_BASED)
#       define U_WCHAR_IS_UTF32
#   elif U_PLATFORM_HAS_WIN32_API
#       define U_WCHAR_IS_UTF16
#   endif
#endif

/* UChar and UChar32 definitions -------------------------------------------- */

/** Number of bytes in a UChar. @stable ICU 2.0 */
#define U_SIZEOF_UCHAR 2

/**
 * \var UChar
 * Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t),
 * or wchar_t if that is 16 bits wide; always assumed to be unsigned.
 * If neither is available, then define UChar to be uint16_t.
 *
 * This makes the definition of UChar platform-dependent
 * but allows direct string type compatibility with platforms with
 * 16-bit wchar_t types.
 *
 * @stable ICU 4.4
 */
#if defined(UCHAR_TYPE)
    typedef UCHAR_TYPE UChar;
/* Not #elif U_HAVE_CHAR16_T -- because that is type-incompatible with pre-C++11 callers
    typedef char16_t UChar;  */
#elif U_SIZEOF_WCHAR_T==2
    typedef wchar_t UChar;
#elif defined(__CHAR16_TYPE__)
    typedef __CHAR16_TYPE__ UChar;
#else
    typedef uint16_t UChar;
#endif

/**
 * Define UChar32 as a type for single Unicode code points.
 * UChar32 is a signed 32-bit integer (same as int32_t).
 *
 * The Unicode code point range is 0..0x10ffff.
 * All other values (negative or >=0x110000) are illegal as Unicode code points.
 * They may be used as sentinel values to indicate "done", "error"
 * or similar non-code point conditions.
 *
 * Before ICU 2.4 (Jitterbug 2146), UChar32 was defined
 * to be wchar_t if that is 32 bits wide (wchar_t may be signed or unsigned)
 * or else to be uint32_t.
 * That is, the definition of UChar32 was platform-dependent.
 *
 * @see U_SENTINEL
 * @stable ICU 2.4
 */
typedef int32_t UChar32;

/**
 * This value is intended for sentinel values for APIs that
 * (take or) return single code points (UChar32).
 * It is outside of the Unicode code point range 0..0x10ffff.
 * 
 * For example, a "done" or "error" value in a new API
 * could be indicated with U_SENTINEL.
 *
 * ICU APIs designed before ICU 2.4 usually define service-specific "done"
 * values, mostly 0xffff.
 * Those may need to be distinguished from
 * actual U+ffff text contents by calling functions like
 * CharacterIterator::hasNext() or UnicodeString::length().
 *
 * @return -1
 * @see UChar32
 * @stable ICU 2.4
 */
#define U_SENTINEL (-1)

#include "unicode/urename.h"

#endif
Commit	Line	Data
b75a7d8f A	1	/*
	2	******************************************************************************
	3	*
4388f060	4	* Copyright (C) 1999-2012, International Business Machines
b75a7d8f A	5	* Corporation and others. All Rights Reserved.
	6	*
	7	******************************************************************************
	8	* file name: umachine.h
	9	* encoding: US-ASCII
	10	* tab size: 8 (not used)
	11	* indentation:4
	12	*
	13	* created on: 1999sep13
	14	* created by: Markus W. Scherer
	15	*
	16	* This file defines basic types and constants for utf.h to be
	17	* platform-independent. umachine.h and utf.h are included into
	18	* utypes.h to provide all the general definitions for ICU.
	19	* All of these definitions used to be in utypes.h before
	20	* the UTF-handling macros made this unmaintainable.
	21	*/
	22
	23	#ifndef __UMACHINE_H__
	24	#define __UMACHINE_H__
	25
	26
	27	/**
	28	* \file
729e4ab9 A	29	* \brief Basic types and constants for UTF
729e4ab9 A	30	*
b75a7d8f A	31	* <h2> Basic types and constants for UTF </h2>
	32	* This file defines basic types and constants for utf.h to be
	33	* platform-independent. umachine.h and utf.h are included into
	34	* utypes.h to provide all the general definitions for ICU.
	35	* All of these definitions used to be in utypes.h before
	36	* the UTF-handling macros made this unmaintainable.
729e4ab9	37	*
b75a7d8f A	38	*/
	39	/==========================================================================/
	40	/* Include platform-dependent definitions */
	41	/* which are contained in the platform-specific file platform.h */
	42	/==========================================================================/
	43
4388f060	44	#include "unicode/ptypes.h" /* platform.h is included in ptypes.h */
b75a7d8f	45
374ca955 A	46	/*
	47	* ANSI C headers:
	48	* stddef.h defines wchar_t
	49	*/
	50	#include <stddef.h>
	51
b75a7d8f	52	/==========================================================================/
374ca955	53	/* For C wrappers, we use the symbol U_STABLE. */
b75a7d8f	54	/* This works properly if the includer is C or C++. */
374ca955	55	/* Functions are declared U_STABLE return-type U_EXPORT2 function-name()... */
b75a7d8f A	56	/==========================================================================/
	57
	58	/**
	59	* \def U_CFUNC
	60	* This is used in a declaration of a library private ICU C function.
	61	* @stable ICU 2.4
	62	*/
	63
	64	/**
	65	* \def U_CDECL_BEGIN
	66	* This is used to begin a declaration of a library private ICU C API.
	67	* @stable ICU 2.4
	68	*/
	69
	70	/**
	71	* \def U_CDECL_END
729e4ab9	72	* This is used to end a declaration of a library private ICU C API
b75a7d8f A	73	* @stable ICU 2.4
	74	*/
	75
4388f060	76	#ifdef __cplusplus
b75a7d8f A	77	# define U_CFUNC extern "C"
	78	# define U_CDECL_BEGIN extern "C" {
	79	# define U_CDECL_END }
	80	#else
	81	# define U_CFUNC extern
	82	# define U_CDECL_BEGIN
	83	# define U_CDECL_END
	84	#endif
	85
4388f060	86	#ifndef U_ATTRIBUTE_DEPRECATED
729e4ab9 A	87	/**
	88	* \def U_ATTRIBUTE_DEPRECATED
	89	* This is used for GCC specific attributes
	90	* @internal
	91	*/
51004dcb	92	#if U_GCC_MAJOR_MINOR >= 302
729e4ab9 A	93	# define U_ATTRIBUTE_DEPRECATED __attribute__ ((deprecated))
	94	/**
	95	* \def U_ATTRIBUTE_DEPRECATED
	96	* This is used for Visual C++ specific attributes
	97	* @internal
	98	*/
4388f060	99	#elif defined(_MSC_VER) && (_MSC_VER >= 1400)
729e4ab9 A	100	# define U_ATTRIBUTE_DEPRECATED __declspec(deprecated)
	101	#else
	102	# define U_ATTRIBUTE_DEPRECATED
	103	#endif
4388f060 A	104	#endif
4388f060 A	105
b75a7d8f A	106	/** This is used to declare a function as a public ICU C API @stable ICU 2.0*/
b75a7d8f A	107	#define U_CAPI U_CFUNC U_EXPORT
729e4ab9	108	/** This is used to declare a function as a stable public ICU C API*/
374ca955	109	#define U_STABLE U_CAPI
729e4ab9	110	/** This is used to declare a function as a draft public ICU C API */
374ca955	111	#define U_DRAFT U_CAPI
729e4ab9 A	112	/** This is used to declare a function as a deprecated public ICU C API */
	113	#define U_DEPRECATED U_CAPI U_ATTRIBUTE_DEPRECATED
	114	/** This is used to declare a function as an obsolete public ICU C API */
374ca955	115	#define U_OBSOLETE U_CAPI
729e4ab9	116	/** This is used to declare a function as an internal ICU C API */
374ca955	117	#define U_INTERNAL U_CAPI
b75a7d8f A	118
	119	/==========================================================================/
	120	/* limits for int32_t etc., like in POSIX inttypes.h */
	121	/==========================================================================/
	122
	123	#ifndef INT8_MIN
	124	/** The smallest value an 8 bit signed integer can hold @stable ICU 2.0 */
	125	# define INT8_MIN ((int8_t)(-128))
	126	#endif
	127	#ifndef INT16_MIN
	128	/** The smallest value a 16 bit signed integer can hold @stable ICU 2.0 */
	129	# define INT16_MIN ((int16_t)(-32767-1))
	130	#endif
	131	#ifndef INT32_MIN
	132	/** The smallest value a 32 bit signed integer can hold @stable ICU 2.0 */
	133	# define INT32_MIN ((int32_t)(-2147483647-1))
	134	#endif
	135
	136	#ifndef INT8_MAX
	137	/** The largest value an 8 bit signed integer can hold @stable ICU 2.0 */
	138	# define INT8_MAX ((int8_t)(127))
	139	#endif
	140	#ifndef INT16_MAX
	141	/** The largest value a 16 bit signed integer can hold @stable ICU 2.0 */
	142	# define INT16_MAX ((int16_t)(32767))
	143	#endif
	144	#ifndef INT32_MAX
	145	/** The largest value a 32 bit signed integer can hold @stable ICU 2.0 */
	146	# define INT32_MAX ((int32_t)(2147483647))
	147	#endif
	148
	149	#ifndef UINT8_MAX
	150	/** The largest value an 8 bit unsigned integer can hold @stable ICU 2.0 */
	151	# define UINT8_MAX ((uint8_t)(255U))
	152	#endif
	153	#ifndef UINT16_MAX
	154	/** The largest value a 16 bit unsigned integer can hold @stable ICU 2.0 */
	155	# define UINT16_MAX ((uint16_t)(65535U))
	156	#endif
	157	#ifndef UINT32_MAX
	158	/** The largest value a 32 bit unsigned integer can hold @stable ICU 2.0 */
	159	# define UINT32_MAX ((uint32_t)(4294967295U))
	160	#endif
	161
	162	#if defined(U_INT64_T_UNAVAILABLE)
374ca955	163	# error int64_t is required for decimal format and rule-based number format.
b75a7d8f	164	#else
374ca955 A	165	# ifndef INT64_C
	166	/**
	167	* Provides a platform independent way to specify a signed 64-bit integer constant.
	168	* note: may be wrong for some 64 bit platforms - ensure your compiler provides INT64_C
73c04bcf	169	* @stable ICU 2.8
374ca955 A	170	*/
	171	# define INT64_C(c) c ## LL
	172	# endif
	173	# ifndef UINT64_C
	174	/**
	175	* Provides a platform independent way to specify an unsigned 64-bit integer constant.
	176	* note: may be wrong for some 64 bit platforms - ensure your compiler provides UINT64_C
73c04bcf	177	* @stable ICU 2.8
374ca955 A	178	*/
	179	# define UINT64_C(c) c ## ULL
	180	# endif
	181	# ifndef U_INT64_MIN
	182	/** The smallest value a 64 bit signed integer can hold @stable ICU 2.8 */
	183	# define U_INT64_MIN ((int64_t)(INT64_C(-9223372036854775807)-1))
	184	# endif
	185	# ifndef U_INT64_MAX
	186	/** The largest value a 64 bit signed integer can hold @stable ICU 2.8 */
	187	# define U_INT64_MAX ((int64_t)(INT64_C(9223372036854775807)))
	188	# endif
	189	# ifndef U_UINT64_MAX
	190	/** The largest value a 64 bit unsigned integer can hold @stable ICU 2.8 */
	191	# define U_UINT64_MAX ((uint64_t)(UINT64_C(18446744073709551615)))
	192	# endif
b75a7d8f A	193	#endif
	194
	195	/==========================================================================/
	196	/* Boolean data type */
	197	/==========================================================================/
	198
	199	/** The ICU boolean type @stable ICU 2.0 */
	200	typedef int8_t UBool;
	201
	202	#ifndef TRUE
	203	/** The TRUE value of a UBool @stable ICU 2.0 */
	204	# define TRUE 1
	205	#endif
	206	#ifndef FALSE
	207	/** The FALSE value of a UBool @stable ICU 2.0 */
	208	# define FALSE 0
	209	#endif
	210
	211
374ca955 A	212	/==========================================================================/
	213	/* Unicode data types */
	214	/==========================================================================/
	215
	216	/* wchar_t-related definitions -------------------------------------------- */
	217
374ca955 A	218	/*
	219	* \def U_WCHAR_IS_UTF16
	220	* Defined if wchar_t uses UTF-16.
	221	*
	222	* @stable ICU 2.0
	223	*/
	224	/*
	225	* \def U_WCHAR_IS_UTF32
	226	* Defined if wchar_t uses UTF-32.
	227	*
	228	* @stable ICU 2.0
	229	*/
	230	#if !defined(U_WCHAR_IS_UTF16) && !defined(U_WCHAR_IS_UTF32)
729e4ab9	231	# ifdef __STDC_ISO_10646__
374ca955 A	232	# if (U_SIZEOF_WCHAR_T==2)
	233	# define U_WCHAR_IS_UTF16
	234	# elif (U_SIZEOF_WCHAR_T==4)
	235	# define U_WCHAR_IS_UTF32
	236	# endif
	237	# elif defined __UCS2__
4388f060	238	# if (U_PF_OS390 <= U_PLATFORM && U_PLATFORM <= U_PF_OS400) && (U_SIZEOF_WCHAR_T==2)
374ca955 A	239	# define U_WCHAR_IS_UTF16
374ca955 A	240	# endif
4388f060	241	# elif defined(__UCS4__) \|\| (U_PLATFORM == U_PF_OS400 && defined(__UTF32__))
374ca955 A	242	# if (U_SIZEOF_WCHAR_T==4)
	243	# define U_WCHAR_IS_UTF32
	244	# endif
4388f060 A	245	# elif U_PLATFORM_IS_DARWIN_BASED \|\| (U_SIZEOF_WCHAR_T==4 && U_PLATFORM_IS_LINUX_BASED)
	246	# define U_WCHAR_IS_UTF32
	247	# elif U_PLATFORM_HAS_WIN32_API
729e4ab9	248	# define U_WCHAR_IS_UTF16
374ca955 A	249	# endif
	250	#endif
	251
	252	/* UChar and UChar32 definitions -------------------------------------------- */
	253
	254	/** Number of bytes in a UChar. @stable ICU 2.0 */
	255	#define U_SIZEOF_UCHAR 2
	256
	257	/**
	258	* \var UChar
51004dcb	259	* Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t),
4388f060 A	260	* or wchar_t if that is 16 bits wide; always assumed to be unsigned.
	261	* If neither is available, then define UChar to be uint16_t.
	262	*
374ca955 A	263	* This makes the definition of UChar platform-dependent
	264	* but allows direct string type compatibility with platforms with
	265	* 16-bit wchar_t types.
	266	*
4388f060	267	* @stable ICU 4.4
374ca955	268	*/
51004dcb A	269	#if defined(UCHAR_TYPE)
	270	typedef UCHAR_TYPE UChar;
	271	/* Not #elif U_HAVE_CHAR16_T -- because that is type-incompatible with pre-C++11 callers
	272	typedef char16_t UChar; */
4388f060 A	273	#elif U_SIZEOF_WCHAR_T==2
	274	typedef wchar_t UChar;
	275	#elif defined(__CHAR16_TYPE__)
	276	typedef __CHAR16_TYPE__ UChar;
374ca955 A	277	#else
	278	typedef uint16_t UChar;
	279	#endif
	280
	281	/**
	282	* Define UChar32 as a type for single Unicode code points.
	283	* UChar32 is a signed 32-bit integer (same as int32_t).
	284	*
	285	* The Unicode code point range is 0..0x10ffff.
	286	* All other values (negative or >=0x110000) are illegal as Unicode code points.
	287	* They may be used as sentinel values to indicate "done", "error"
	288	* or similar non-code point conditions.
	289	*
	290	* Before ICU 2.4 (Jitterbug 2146), UChar32 was defined
	291	* to be wchar_t if that is 32 bits wide (wchar_t may be signed or unsigned)
	292	* or else to be uint32_t.
	293	* That is, the definition of UChar32 was platform-dependent.
	294	*
	295	* @see U_SENTINEL
	296	* @stable ICU 2.4
	297	*/
	298	typedef int32_t UChar32;
	299
b75a7d8f	300	/**
4388f060 A	301	* This value is intended for sentinel values for APIs that
	302	* (take or) return single code points (UChar32).
	303	* It is outside of the Unicode code point range 0..0x10ffff.
	304	*
	305	* For example, a "done" or "error" value in a new API
	306	* could be indicated with U_SENTINEL.
	307	*
	308	* ICU APIs designed before ICU 2.4 usually define service-specific "done"
	309	* values, mostly 0xffff.
	310	* Those may need to be distinguished from
	311	* actual U+ffff text contents by calling functions like
	312	* CharacterIterator::hasNext() or UnicodeString::length().
	313	*
	314	* @return -1
	315	* @see UChar32
	316	* @stable ICU 2.4
729e4ab9	317	*/
4388f060	318	#define U_SENTINEL (-1)
b75a7d8f A	319
	320	#include "unicode/urename.h"
	321
	322	#endif