ICU 63.1  63.1
Data Structures | Namespaces | Macros | Enumerations | Functions
ucptrie.h File Reference

This file defines an immutable Unicode code point trie. More...

#include "unicode/utypes.h"
#include "unicode/localpointer.h"
#include "unicode/ucpmap.h"
#include "unicode/utf8.h"

Go to the source code of this file.

Data Structures

struct  UCPTrie
 Immutable Unicode code point trie structure. More...
 

Namespaces

 icu
 File coll.h.
 

Macros

#define UCPTRIE_16(trie, i)   ((trie)->data.ptr16[i])
 Macro parameter value for a trie with 16-bit data values. More...
 
#define UCPTRIE_32(trie, i)   ((trie)->data.ptr32[i])
 Macro parameter value for a trie with 32-bit data values. More...
 
#define UCPTRIE_8(trie, i)   ((trie)->data.ptr8[i])
 Macro parameter value for a trie with 8-bit data values. More...
 
#define UCPTRIE_FAST_GET(trie, dataAccess, c)   dataAccess(trie, _UCPTRIE_CP_INDEX(trie, 0xffff, c))
 Returns a trie value for a code point, with range checking. More...
 
#define UCPTRIE_SMALL_GET(trie, dataAccess, c)   dataAccess(trie, _UCPTRIE_CP_INDEX(trie, UCPTRIE_SMALL_MAX, c))
 Returns a 16-bit trie value for a code point, with range checking. More...
 
#define UCPTRIE_FAST_U16_NEXT(trie, dataAccess, src, limit, c, result)
 UTF-16: Reads the next code point (UChar32 c, out), post-increments src, and gets a value from the trie. More...
 
#define UCPTRIE_FAST_U16_PREV(trie, dataAccess, start, src, c, result)
 UTF-16: Reads the previous code point (UChar32 c, out), pre-decrements src, and gets a value from the trie. More...
 
#define UCPTRIE_FAST_U8_NEXT(trie, dataAccess, src, limit, result)
 UTF-8: Post-increments src and gets a value from the trie. More...
 
#define UCPTRIE_FAST_U8_PREV(trie, dataAccess, start, src, result)
 UTF-8: Pre-decrements src and gets a value from the trie. More...
 
#define UCPTRIE_ASCII_GET(trie, dataAccess, c)   dataAccess(trie, c)
 Returns a trie value for an ASCII code point, without range checking. More...
 
#define UCPTRIE_FAST_BMP_GET(trie, dataAccess, c)   dataAccess(trie, _UCPTRIE_FAST_INDEX(trie, c))
 Returns a trie value for a BMP code point (U+0000..U+FFFF), without range checking. More...
 
#define UCPTRIE_FAST_SUPP_GET(trie, dataAccess, c)   dataAccess(trie, _UCPTRIE_SMALL_INDEX(trie, c))
 Returns a trie value for a supplementary code point (U+10000..U+10FFFF), without range checking. More...
 

Enumerations

enum  UCPTrieType { UCPTRIE_TYPE_ANY = -1, UCPTRIE_TYPE_FAST, UCPTRIE_TYPE_SMALL }
 Selectors for the type of a UCPTrie. More...
 
enum  UCPTrieValueWidth { UCPTRIE_VALUE_BITS_ANY = -1, UCPTRIE_VALUE_BITS_16, UCPTRIE_VALUE_BITS_32, UCPTRIE_VALUE_BITS_8 }
 Selectors for the number of bits in a UCPTrie data value. More...
 

Functions

U_CAPI UCPTrieucptrie_openFromBinary (UCPTrieType type, UCPTrieValueWidth valueWidth, const void *data, int32_t length, int32_t *pActualLength, UErrorCode *pErrorCode)
 Opens a trie from its binary form, stored in 32-bit-aligned memory. More...
 
U_CAPI void ucptrie_close (UCPTrie *trie)
 Closes a trie and releases associated memory. More...
 
U_CAPI UCPTrieType ucptrie_getType (const UCPTrie *trie)
 Returns the trie type. More...
 
U_CAPI UCPTrieValueWidth ucptrie_getValueWidth (const UCPTrie *trie)
 Returns the number of bits in a trie data value. More...
 
U_CAPI uint32_t ucptrie_get (const UCPTrie *trie, UChar32 c)
 Returns the value for a code point as stored in the trie, with range checking. More...
 
U_CAPI UChar32 ucptrie_getRange (const UCPTrie *trie, UChar32 start, UCPMapRangeOption option, uint32_t surrogateValue, UCPMapValueFilter *filter, const void *context, uint32_t *pValue)
 Returns the last code point such that all those from start to there have the same value. More...
 
U_CAPI int32_t ucptrie_toBinary (const UCPTrie *trie, void *data, int32_t capacity, UErrorCode *pErrorCode)
 Writes a memory-mappable form of the trie into 32-bit aligned memory. More...
 

Detailed Description

This file defines an immutable Unicode code point trie.

See also
UCPTrie
UMutableCPTrie

Definition in file ucptrie.h.

Macro Definition Documentation

◆ UCPTRIE_16

#define UCPTRIE_16 (   trie,
 
)    ((trie)->data.ptr16[i])

Macro parameter value for a trie with 16-bit data values.

Use the name of this macro as a "dataAccess" parameter in other macros. Do not use this macro in any other way.

See also
UCPTRIE_VALUE_BITS_16
Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 346 of file ucptrie.h.

◆ UCPTRIE_32

#define UCPTRIE_32 (   trie,
 
)    ((trie)->data.ptr32[i])

Macro parameter value for a trie with 32-bit data values.

Use the name of this macro as a "dataAccess" parameter in other macros. Do not use this macro in any other way.

See also
UCPTRIE_VALUE_BITS_32
Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 356 of file ucptrie.h.

◆ UCPTRIE_8

#define UCPTRIE_8 (   trie,
 
)    ((trie)->data.ptr8[i])

Macro parameter value for a trie with 8-bit data values.

Use the name of this macro as a "dataAccess" parameter in other macros. Do not use this macro in any other way.

See also
UCPTRIE_VALUE_BITS_8
Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 366 of file ucptrie.h.

◆ UCPTRIE_ASCII_GET

#define UCPTRIE_ASCII_GET (   trie,
  dataAccess,
 
)    dataAccess(trie, c)

Returns a trie value for an ASCII code point, without range checking.

Parameters
trie(const UCPTrie *, in) the trie (of either fast or small type)
dataAccessUCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width
c(UChar32, in) the input code point; must be U+0000..U+007F
Returns
The ASCII code point's trie value.
Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 537 of file ucptrie.h.

◆ UCPTRIE_FAST_BMP_GET

#define UCPTRIE_FAST_BMP_GET (   trie,
  dataAccess,
 
)    dataAccess(trie, _UCPTRIE_FAST_INDEX(trie, c))

Returns a trie value for a BMP code point (U+0000..U+FFFF), without range checking.

Can be used to look up a value for a UTF-16 code unit if other parts of the string processing check for surrogates.

Parameters
trie(const UCPTrie *, in) the trie; must have type UCPTRIE_TYPE_FAST
dataAccessUCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width
c(UChar32, in) the input code point, must be U+0000..U+FFFF
Returns
The BMP code point's trie value.
Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 550 of file ucptrie.h.

◆ UCPTRIE_FAST_GET

#define UCPTRIE_FAST_GET (   trie,
  dataAccess,
 
)    dataAccess(trie, _UCPTRIE_CP_INDEX(trie, 0xffff, c))

Returns a trie value for a code point, with range checking.

Returns the trie error value if c is not in the range 0..U+10FFFF.

Parameters
trie(const UCPTrie *, in) the trie; must have type UCPTRIE_TYPE_FAST
dataAccessUCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width
c(UChar32, in) the input code point
Returns
The code point's trie value.
Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 378 of file ucptrie.h.

◆ UCPTRIE_FAST_SUPP_GET

#define UCPTRIE_FAST_SUPP_GET (   trie,
  dataAccess,
 
)    dataAccess(trie, _UCPTRIE_SMALL_INDEX(trie, c))

Returns a trie value for a supplementary code point (U+10000..U+10FFFF), without range checking.

Parameters
trie(const UCPTrie *, in) the trie; must have type UCPTRIE_TYPE_FAST
dataAccessUCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width
c(UChar32, in) the input code point, must be U+10000..U+10FFFF
Returns
The supplementary code point's trie value.
Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 562 of file ucptrie.h.

◆ UCPTRIE_FAST_U16_NEXT

#define UCPTRIE_FAST_U16_NEXT (   trie,
  dataAccess,
  src,
  limit,
  c,
  result 
)
Value:
{ \
(c) = *(src)++; \
int32_t __index; \
if (!U16_IS_SURROGATE(c)) { \
__index = _UCPTRIE_FAST_INDEX(trie, c); \
} else { \
uint16_t __c2; \
if (U16_IS_SURROGATE_LEAD(c) && (src) != (limit) && U16_IS_TRAIL(__c2 = *(src))) { \
++(src); \
(c) = U16_GET_SUPPLEMENTARY((c), __c2); \
__index = _UCPTRIE_SMALL_INDEX(trie, c); \
} else { \
__index = (trie)->dataLength - UCPTRIE_ERROR_VALUE_NEG_DATA_OFFSET; \
} \
} \
(result) = dataAccess(trie, __index); \
}
#define U16_IS_SURROGATE_LEAD(c)
Assuming c is a surrogate code point (U16_IS_SURROGATE(c)), is it a lead surrogate?
Definition: utf16.h:83
#define U16_IS_TRAIL(c)
Is this code unit a trail surrogate (U+dc00..U+dfff)?
Definition: utf16.h:66
#define U16_GET_SUPPLEMENTARY(lead, trail)
Get a supplementary code point value (U+10000..U+10ffff) from its lead and trail surrogates.
Definition: utf16.h:111
#define U16_IS_SURROGATE(c)
Is this code unit a surrogate (U+d800..U+dfff)?
Definition: utf16.h:74

UTF-16: Reads the next code point (UChar32 c, out), post-increments src, and gets a value from the trie.

Sets the trie error value if c is an unpaired surrogate.

Parameters
trie(const UCPTrie *, in) the trie; must have type UCPTRIE_TYPE_FAST
dataAccessUCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width
src(const UChar *, in/out) the source text pointer
limit(const UChar *, in) the limit pointer for the text, or NULL if NUL-terminated
c(UChar32, out) variable for the code point
result(out) variable for the trie lookup result
Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 406 of file ucptrie.h.

◆ UCPTRIE_FAST_U16_PREV

#define UCPTRIE_FAST_U16_PREV (   trie,
  dataAccess,
  start,
  src,
  c,
  result 
)
Value:
{ \
(c) = *--(src); \
int32_t __index; \
if (!U16_IS_SURROGATE(c)) { \
__index = _UCPTRIE_FAST_INDEX(trie, c); \
} else { \
uint16_t __c2; \
if (U16_IS_SURROGATE_TRAIL(c) && (src) != (start) && U16_IS_LEAD(__c2 = *((src) - 1))) { \
--(src); \
(c) = U16_GET_SUPPLEMENTARY(__c2, (c)); \
__index = _UCPTRIE_SMALL_INDEX(trie, c); \
} else { \
__index = (trie)->dataLength - UCPTRIE_ERROR_VALUE_NEG_DATA_OFFSET; \
} \
} \
(result) = dataAccess(trie, __index); \
}
#define U16_IS_LEAD(c)
Is this code unit a lead surrogate (U+d800..U+dbff)?
Definition: utf16.h:58
#define U16_GET_SUPPLEMENTARY(lead, trail)
Get a supplementary code point value (U+10000..U+10ffff) from its lead and trail surrogates.
Definition: utf16.h:111
#define U16_IS_SURROGATE_TRAIL(c)
Assuming c is a surrogate code point (U16_IS_SURROGATE(c)), is it a trail surrogate?
Definition: utf16.h:92
#define U16_IS_SURROGATE(c)
Is this code unit a surrogate (U+d800..U+dfff)?
Definition: utf16.h:74

UTF-16: Reads the previous code point (UChar32 c, out), pre-decrements src, and gets a value from the trie.

Sets the trie error value if c is an unpaired surrogate.

Parameters
trie(const UCPTrie *, in) the trie; must have type UCPTRIE_TYPE_FAST
dataAccessUCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width
start(const UChar *, in) the start pointer for the text
src(const UChar *, in/out) the source text pointer
c(UChar32, out) variable for the code point
result(out) variable for the trie lookup result
Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 437 of file ucptrie.h.

◆ UCPTRIE_FAST_U8_NEXT

#define UCPTRIE_FAST_U8_NEXT (   trie,
  dataAccess,
  src,
  limit,
  result 
)
Value:
{ \
int32_t __lead = (uint8_t)*(src)++; \
if (!U8_IS_SINGLE(__lead)) { \
uint8_t __t1, __t2, __t3; \
if ((src) != (limit) && \
(__lead >= 0xe0 ? \
__lead < 0xf0 ? /* U+0800..U+FFFF except surrogates */ \
U8_LEAD3_T1_BITS[__lead &= 0xf] & (1 << ((__t1 = *(src)) >> 5)) && \
++(src) != (limit) && (__t2 = *(src) - 0x80) <= 0x3f && \
(__lead = ((int32_t)(trie)->index[(__lead << 6) + (__t1 & 0x3f)]) + __t2, 1) \
: /* U+10000..U+10FFFF */ \
(__lead -= 0xf0) <= 4 && \
U8_LEAD4_T1_BITS[(__t1 = *(src)) >> 4] & (1 << __lead) && \
(__lead = (__lead << 6) | (__t1 & 0x3f), ++(src) != (limit)) && \
(__t2 = *(src) - 0x80) <= 0x3f && \
++(src) != (limit) && (__t3 = *(src) - 0x80) <= 0x3f && \
(__lead = __lead >= (trie)->shifted12HighStart ? \
(trie)->dataLength - UCPTRIE_HIGH_VALUE_NEG_DATA_OFFSET : \
ucptrie_internalSmallU8Index((trie), __lead, __t2, __t3), 1) \
: /* U+0080..U+07FF */ \
__lead >= 0xc2 && (__t1 = *(src) - 0x80) <= 0x3f && \
(__lead = (int32_t)(trie)->index[__lead & 0x1f] + __t1, 1))) { \
++(src); \
} else { \
__lead = (trie)->dataLength - UCPTRIE_ERROR_VALUE_NEG_DATA_OFFSET; /* ill-formed*/ \
} \
} \
(result) = dataAccess(trie, __lead); \
}
#define U8_IS_SINGLE(c)
Does this code unit (byte) encode a code point by itself (US-ASCII 0..0x7f)?
Definition: utf8.h:172
#define U8_LEAD4_T1_BITS
Internal bit vector for 4-byte UTF-8 validity check, for use in U8_IS_VALID_LEAD4_AND_T1.
Definition: utf8.h:107
#define U8_LEAD3_T1_BITS
Internal bit vector for 3-byte UTF-8 validity check, for use in U8_IS_VALID_LEAD3_AND_T1.
Definition: utf8.h:90

UTF-8: Post-increments src and gets a value from the trie.

Sets the trie error value for an ill-formed byte sequence.

Unlike UCPTRIE_FAST_U16_NEXT() this UTF-8 macro does not provide the code point because it would be more work to do so and is often not needed. If the trie value differs from the error value, then the byte sequence is well-formed, and the code point can be assembled without revalidation.

Parameters
trie(const UCPTrie *, in) the trie; must have type UCPTRIE_TYPE_FAST
dataAccessUCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width
src(const char *, in/out) the source text pointer
limit(const char *, in) the limit pointer for the text (must not be NULL)
result(out) variable for the trie lookup result
Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 471 of file ucptrie.h.

◆ UCPTRIE_FAST_U8_PREV

#define UCPTRIE_FAST_U8_PREV (   trie,
  dataAccess,
  start,
  src,
  result 
)
Value:
{ \
int32_t __index = (uint8_t)*--(src); \
if (!U8_IS_SINGLE(__index)) { \
__index = ucptrie_internalU8PrevIndex((trie), __index, (const uint8_t *)(start), \
(const uint8_t *)(src)); \
(src) -= __index & 7; \
__index >>= 3; \
} \
(result) = dataAccess(trie, __index); \
}
#define U8_IS_SINGLE(c)
Does this code unit (byte) encode a code point by itself (US-ASCII 0..0x7f)?
Definition: utf8.h:172

UTF-8: Pre-decrements src and gets a value from the trie.

Sets the trie error value for an ill-formed byte sequence.

Unlike UCPTRIE_FAST_U16_PREV() this UTF-8 macro does not provide the code point because it would be more work to do so and is often not needed. If the trie value differs from the error value, then the byte sequence is well-formed, and the code point can be assembled without revalidation.

Parameters
trie(const UCPTrie *, in) the trie; must have type UCPTRIE_TYPE_FAST
dataAccessUCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width
start(const char *, in) the start pointer for the text
src(const char *, in/out) the source text pointer
result(out) variable for the trie lookup result
Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 517 of file ucptrie.h.

◆ UCPTRIE_SMALL_GET

#define UCPTRIE_SMALL_GET (   trie,
  dataAccess,
 
)    dataAccess(trie, _UCPTRIE_CP_INDEX(trie, UCPTRIE_SMALL_MAX, c))

Returns a 16-bit trie value for a code point, with range checking.

Returns the trie error value if c is not in the range U+0000..U+10FFFF.

Parameters
trie(const UCPTrie *, in) the trie; must have type UCPTRIE_TYPE_SMALL
dataAccessUCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width
c(UChar32, in) the input code point
Returns
The code point's trie value.
Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 390 of file ucptrie.h.

Enumeration Type Documentation

◆ UCPTrieType

Selectors for the type of a UCPTrie.

Different trade-offs for size vs. speed.

See also
umutablecptrie_buildImmutable
ucptrie_openFromBinary
ucptrie_getType
Draft:
This API may be changed in the future versions and was introduced in ICU 63
Enumerator
UCPTRIE_TYPE_ANY 

For ucptrie_openFromBinary() to accept any type.

ucptrie_getType() will return the actual type.

Draft:
This API may be changed in the future versions and was introduced in ICU 63
UCPTRIE_TYPE_FAST 

Fast/simple/larger BMP data structure.

Use functions and "fast" macros.

Draft:
This API may be changed in the future versions and was introduced in ICU 63
UCPTRIE_TYPE_SMALL 

Small/slower BMP data structure.

Use functions and "small" macros.

Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 120 of file ucptrie.h.

◆ UCPTrieValueWidth

Selectors for the number of bits in a UCPTrie data value.

See also
umutablecptrie_buildImmutable
ucptrie_openFromBinary
ucptrie_getValueWidth
Draft:
This API may be changed in the future versions and was introduced in ICU 63
Enumerator
UCPTRIE_VALUE_BITS_ANY 

For ucptrie_openFromBinary() to accept any data value width.

ucptrie_getValueWidth() will return the actual data value width.

Draft:
This API may be changed in the future versions and was introduced in ICU 63
UCPTRIE_VALUE_BITS_16 

The trie stores 16 bits per data value.

It returns them as unsigned values 0..0xffff=65535.

Draft:
This API may be changed in the future versions and was introduced in ICU 63
UCPTRIE_VALUE_BITS_32 

The trie stores 32 bits per data value.

Draft:
This API may be changed in the future versions and was introduced in ICU 63
UCPTRIE_VALUE_BITS_8 

The trie stores 8 bits per data value.

It returns them as unsigned values 0..0xff=255.

Draft:
This API may be changed in the future versions and was introduced in ICU 63

Definition at line 150 of file ucptrie.h.

Function Documentation

◆ ucptrie_close()

U_CAPI void ucptrie_close ( UCPTrie trie)

Closes a trie and releases associated memory.

Parameters
triethe trie
Draft:
This API may be changed in the future versions and was introduced in ICU 63

◆ ucptrie_get()

U_CAPI uint32_t ucptrie_get ( const UCPTrie trie,
UChar32  c 
)

Returns the value for a code point as stored in the trie, with range checking.

Returns the trie error value if c is not in the range 0..U+10FFFF.

Easier to use than UCPTRIE_FAST_GET() and similar macros but slower. Easier to use because, unlike the macros, this function works on all UCPTrie objects, for all types and value widths.

Parameters
triethe trie
cthe code point
Returns
the trie value, or the trie error value if the code point is not in the range 0..U+10FFFF
Draft:
This API may be changed in the future versions and was introduced in ICU 63

◆ ucptrie_getRange()

U_CAPI UChar32 ucptrie_getRange ( const UCPTrie trie,
UChar32  start,
UCPMapRangeOption  option,
uint32_t  surrogateValue,
UCPMapValueFilter filter,
const void *  context,
uint32_t *  pValue 
)

Returns the last code point such that all those from start to there have the same value.

Can be used to efficiently iterate over all same-value ranges in a trie. (This is normally faster than iterating over code points and get()ting each value, but much slower than a data structure that stores ranges directly.)

If the UCPMapValueFilter function pointer is not NULL, then the value to be delivered is passed through that function, and the return value is the end of the range where all values are modified to the same actual value. The value is unchanged if that function pointer is NULL.

Example:

UChar32 start = 0, end;
uint32_t value;
while ((end = ucptrie_getRange(trie, start, UCPMAP_RANGE_NORMAL, 0,
NULL, NULL, &value)) >= 0) {
// Work with the range start..end and its value.
start = end + 1;
}
Parameters
triethe trie
startrange start
optiondefines whether surrogates are treated normally, or as having the surrogateValue; usually UCPMAP_RANGE_NORMAL
surrogateValuevalue for surrogates; ignored if option==UCPMAP_RANGE_NORMAL
filtera pointer to a function that may modify the trie data value, or NULL if the values from the trie are to be used unmodified
contextan opaque pointer that is passed on to the filter function
pValueif not NULL, receives the value that every code point start..end has; may have been modified by filter(context, trie value) if that function pointer is not NULL
Returns
the range end code point, or -1 if start is not a valid code point
Draft:
This API may be changed in the future versions and was introduced in ICU 63

◆ ucptrie_getType()

U_CAPI UCPTrieType ucptrie_getType ( const UCPTrie trie)

Returns the trie type.

Parameters
triethe trie
Returns
the trie type
See also
ucptrie_openFromBinary
UCPTRIE_TYPE_ANY
Draft:
This API may be changed in the future versions and was introduced in ICU 63

◆ ucptrie_getValueWidth()

U_CAPI UCPTrieValueWidth ucptrie_getValueWidth ( const UCPTrie trie)

Returns the number of bits in a trie data value.

Parameters
triethe trie
Returns
the number of bits in a trie data value
See also
ucptrie_openFromBinary
UCPTRIE_VALUE_BITS_ANY
Draft:
This API may be changed in the future versions and was introduced in ICU 63

◆ ucptrie_openFromBinary()

U_CAPI UCPTrie* ucptrie_openFromBinary ( UCPTrieType  type,
UCPTrieValueWidth  valueWidth,
const void *  data,
int32_t  length,
int32_t *  pActualLength,
UErrorCode pErrorCode 
)

Opens a trie from its binary form, stored in 32-bit-aligned memory.

Inverse of ucptrie_toBinary().

The memory must remain valid and unchanged as long as the trie is used. You must ucptrie_close() the trie once you are done using it.

Parameters
typeselects the trie type; results in an U_INVALID_FORMAT_ERROR if it does not match the binary data; use UCPTRIE_TYPE_ANY to accept any type
valueWidthselects the number of bits in a data value; results in an U_INVALID_FORMAT_ERROR if it does not match the binary data; use UCPTRIE_VALUE_BITS_ANY to accept any data value width
dataa pointer to 32-bit-aligned memory containing the binary data of a UCPTrie
lengththe number of bytes available at data; can be more than necessary
pActualLengthreceives the actual number of bytes at data taken up by the trie data; can be NULL
pErrorCodean in/out ICU UErrorCode
Returns
the trie
See also
umutablecptrie_open
umutablecptrie_buildImmutable
ucptrie_toBinary
Draft:
This API may be changed in the future versions and was introduced in ICU 63

◆ ucptrie_toBinary()

U_CAPI int32_t ucptrie_toBinary ( const UCPTrie trie,
void *  data,
int32_t  capacity,
UErrorCode pErrorCode 
)

Writes a memory-mappable form of the trie into 32-bit aligned memory.

Inverse of ucptrie_openFromBinary().

Parameters
triethe trie
dataa pointer to 32-bit-aligned memory to be filled with the trie data; can be NULL if capacity==0
capacitythe number of bytes available at data, or 0 for pure preflighting
pErrorCodean in/out ICU UErrorCode; U_BUFFER_OVERFLOW_ERROR if the capacity is too small
Returns
the number of bytes written or (if buffer overflow) needed for the trie
See also
ucptrie_openFromBinary()
Draft:
This API may be changed in the future versions and was introduced in ICU 63