ICU 55.1 55.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Macros | Typedefs
umachine.h File Reference

Basic types and constants for UTF. More...

`#include "unicode/ptypes.h"`
`#include <stddef.h>`
`#include "unicode/urename.h"`

Go to the source code of this file.

## Macros
#define | U_CFUNC extern
| This is used in a declaration of a library private ICU C function.
#define | U_CDECL_BEGIN
| This is used to begin a declaration of a library private ICU C API.
#define | U_CDECL_END
| This is used to end a declaration of a library private ICU C API.
#define | U_ATTRIBUTE_DEPRECATED
| This is used for GCC specific attributes.
#define | U_CAPI U_CFUNC U_EXPORT
| This is used to declare a function as a public ICU C API.
#define | U_STABLE U_CAPI
| This is used to declare a function as a stable public ICU C API.
#define | U_DRAFT U_CAPI
| This is used to declare a function as a draft public ICU C API.
#define | U_DEPRECATED U_CAPI U_ATTRIBUTE_DEPRECATED
| This is used to declare a function as a deprecated public ICU C API.
#define | U_OBSOLETE U_CAPI
| This is used to declare a function as an obsolete public ICU C API.
#define | U_INTERNAL U_CAPI
| This is used to declare a function as an internal ICU C API.
#define | INT8_MIN ((int8_t)(-128))
| The smallest value an 8 bit signed integer can hold.
#define | INT16_MIN ((int16_t)(-32767-1))
| The smallest value a 16 bit signed integer can hold.
#define | INT32_MIN ((int32_t)(-2147483647-1))
| The smallest value a 32 bit signed integer can hold.
#define | INT8_MAX ((int8_t)(127))
| The largest value an 8 bit signed integer can hold.
#define | INT16_MAX ((int16_t)(32767))
| The largest value a 16 bit signed integer can hold.
#define | INT32_MAX ((int32_t)(2147483647))
| The largest value a 32 bit signed integer can hold.
#define | UINT8_MAX ((uint8_t)(255U))
| The largest value an 8 bit unsigned integer can hold.
#define | UINT16_MAX ((uint16_t)(65535U))
| The largest value a 16 bit unsigned integer can hold.
#define | UINT32_MAX ((uint32_t)(4294967295U))
| The largest value a 32 bit unsigned integer can hold.
#define | INT64_C(c) c ## LL
| Provides a platform independent way to specify a signed 64-bit integer constant.
#define | UINT64_C(c) c ## ULL
| Provides a platform independent way to specify an unsigned 64-bit integer constant.
#define | U_INT64_MIN ((int64_t)(INT64_C(-9223372036854775807)-1))
| The smallest value a 64 bit signed integer can hold.
#define | U_INT64_MAX ((int64_t)(INT64_C(9223372036854775807)))
| The largest value a 64 bit signed integer can hold.
#define | U_UINT64_MAX ((uint64_t)(UINT64_C(18446744073709551615)))
| The largest value a 64 bit unsigned integer can hold.
#define | TRUE 1
| The TRUE value of a UBool.
#define | FALSE 0
| The FALSE value of a UBool.
#define | U_SIZEOF_UCHAR 2
| Number of bytes in a UChar.
#define | U_SENTINEL (-1)
| This value is intended for sentinel values for APIs that (take or) return single code points (UChar32).

## Typedefs
typedef int8_t | UBool
| The ICU boolean type.
typedef uint16_t | 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.
typedef int32_t | UChar32
| Define UChar32 as a type for single Unicode code points.

## Detailed Description

Basic types and constants for UTF.

## Basic types and constants for UTF

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.

Definition in file umachine.h.

## Macro Definition Documentation

#define FALSE 0

The FALSE value of a UBool.

Stable:
  ICU 2.0

Definition at line 242 of file umachine.h.

Referenced by icu::BytesTrie::hasUniqueValue(), icu::UCharsTrie::hasUniqueValue(), icu::BreakIterator::isBufferClone(), icu::ParsePosition::operator==(), and icu::UnicodeString::truncate().

#define INT16_MAX ((int16_t)(32767))

The largest value a 16 bit signed integer can hold.

Stable:
  ICU 2.0

Definition at line 176 of file umachine.h.

#define INT16_MIN ((int16_t)(-32767-1))

The smallest value a 16 bit signed integer can hold.

Stable:
  ICU 2.0

Definition at line 163 of file umachine.h.

#define INT32_MAX ((int32_t)(2147483647))

The largest value a 32 bit signed integer can hold.

Stable:
  ICU 2.0

Definition at line 180 of file umachine.h.

Referenced by icu::UnicodeString::remove().

#define INT32_MIN ((int32_t)(-2147483647-1))

The smallest value a 32 bit signed integer can hold.

Stable:
  ICU 2.0

Definition at line 167 of file umachine.h.

#define INT64_C | ( |  | c | ) | c ## LL

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

Definition at line 205 of file umachine.h.

#define INT8_MAX ((int8_t)(127))

The largest value an 8 bit signed integer can hold.

Stable:
  ICU 2.0

Definition at line 172 of file umachine.h.

#define INT8_MIN ((int8_t)(-128))

The smallest value an 8 bit signed integer can hold.

Stable:
  ICU 2.0

Definition at line 159 of file umachine.h.

#define TRUE 1

The TRUE value of a UBool.

Stable:
  ICU 2.0

Definition at line 238 of file umachine.h.

Referenced by icu::Calendar::internalSet(), icu::ParsePosition::operator==(), icu::UnicodeString::truncate(), icu::ures_getNextUnicodeString(), icu::ures_getUnicodeString(), icu::ures_getUnicodeStringByIndex(), and icu::ures_getUnicodeStringByKey().

#define U_ATTRIBUTE_DEPRECATED

This is used for GCC specific attributes.

Internal:
  Do not use. This API is for internal use only.

Definition at line 102 of file umachine.h.

#define U_CAPI U_CFUNC U_EXPORT

This is used to declare a function as a public ICU C API.

Stable:
  ICU 2.0

Definition at line 107 of file umachine.h.

#define U_CDECL_BEGIN

This is used to begin a declaration of a library private ICU C API.

Stable:
  ICU 2.4

Definition at line 82 of file umachine.h.

#define U_CDECL_END

This is used to end a declaration of a library private ICU C API.

Stable:
  ICU 2.4

Definition at line 83 of file umachine.h.

#define U_CFUNC extern

This is used in a declaration of a library private ICU C function.

Stable:
  ICU 2.4

Definition at line 81 of file umachine.h.

#define U_INT64_MAX ((int64_t)(INT64_C(9223372036854775807)))

The largest value a 64 bit signed integer can hold.

Stable:
  ICU 2.8

Definition at line 221 of file umachine.h.

#define U_INT64_MIN ((int64_t)(INT64_C(-9223372036854775807)-1))

The smallest value a 64 bit signed integer can hold.

Stable:
  ICU 2.8

Definition at line 217 of file umachine.h.

#define U_SENTINEL (-1)

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().

Returns
  -1

See Also
  UChar32

Stable:
  ICU 2.4

Definition at line 352 of file umachine.h.

#define U_SIZEOF_UCHAR 2

Number of bytes in a UChar.

Stable:
  ICU 2.0

Definition at line 289 of file umachine.h.

#define U_UINT64_MAX ((uint64_t)(UINT64_C(18446744073709551615)))

The largest value a 64 bit unsigned integer can hold.

Stable:
  ICU 2.8

Definition at line 225 of file umachine.h.

#define UINT16_MAX ((uint16_t)(65535U))

The largest value a 16 bit unsigned integer can hold.

Stable:
  ICU 2.0

Definition at line 189 of file umachine.h.

#define UINT32_MAX ((uint32_t)(4294967295U))

The largest value a 32 bit unsigned integer can hold.

Stable:
  ICU 2.0

Definition at line 193 of file umachine.h.

#define UINT64_C | ( |  | c | ) | c ## ULL

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

Definition at line 213 of file umachine.h.

#define UINT8_MAX ((uint8_t)(255U))

The largest value an 8 bit unsigned integer can hold.

Stable:
  ICU 2.0

Definition at line 185 of file umachine.h.

## Typedef Documentation

typedef int8_t UBool

The ICU boolean type.

Stable:
  ICU 2.0

Definition at line 234 of file umachine.h.

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

Definition at line 312 of file umachine.h.

typedef int32_t UChar32

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 Also
  U_SENTINEL

Stable:
  ICU 2.4

Definition at line 332 of file umachine.h.