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

ICU 74.2 74.2

umutablecptrie.h
Go to the documentation of this file.
1// © 2017 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3
4// umutablecptrie.h (split out of ucptrie.h)
5// created: 2018jan24 Markus W. Scherer
6
7#ifndef __UMUTABLECPTRIE_H__
8#define __UMUTABLECPTRIE_H__
9
10#include "unicode/utypes.h"
11
12#include "unicode/ucpmap.h"
13#include "unicode/ucptrie.h"
14#include "unicode/utf8.h"
15
16#if U_SHOW_CPLUSPLUS_API
17#include "unicode/localpointer.h"
18#endif // U_SHOW_CPLUSPLUS_API
19
20 U_CDECL_BEGIN
21
49 typedef struct UMutableCPTrie UMutableCPTrie;
50
64 U_CAPI UMutableCPTrie * U_EXPORT2
65umutablecptrie_open(uint32_t initialValue, uint32_t errorValue, UErrorCode *pErrorCode);
66
76 U_CAPI UMutableCPTrie * U_EXPORT2
77umutablecptrie_clone(const UMutableCPTrie *other, UErrorCode *pErrorCode);
78
85 U_CAPI void U_EXPORT2
86umutablecptrie_close(UMutableCPTrie *trie);
87
97 U_CAPI UMutableCPTrie * U_EXPORT2
98umutablecptrie_fromUCPMap(const UCPMap *map, UErrorCode *pErrorCode);
99
109 U_CAPI UMutableCPTrie * U_EXPORT2
110umutablecptrie_fromUCPTrie(const UCPTrie *trie, UErrorCode *pErrorCode);
111
120 U_CAPI uint32_t U_EXPORT2
121umutablecptrie_get(const UMutableCPTrie *trie, UChar32 c);
122
152 U_CAPI UChar32 U_EXPORT2
153umutablecptrie_getRange(const UMutableCPTrie *trie, UChar32 start,
154 UCPMapRangeOption option, uint32_t surrogateValue,
155 UCPMapValueFilter *filter, const void *context, uint32_t *pValue);
156
166 U_CAPI void U_EXPORT2
167umutablecptrie_set(UMutableCPTrie *trie, UChar32 c, uint32_t value, UErrorCode *pErrorCode);
168
180 U_CAPI void U_EXPORT2
181umutablecptrie_setRange(UMutableCPTrie *trie,
182 UChar32 start, UChar32 end,
183 uint32_t value, UErrorCode *pErrorCode);
184
215 U_CAPI UCPTrie * U_EXPORT2
216umutablecptrie_buildImmutable(UMutableCPTrie *trie, UCPTrieType type, UCPTrieValueWidth valueWidth,
217 UErrorCode *pErrorCode);
218
219 U_CDECL_END
220
221#if U_SHOW_CPLUSPLUS_API
222
223U_NAMESPACE_BEGIN
224
234 U_DEFINE_LOCAL_OPEN_POINTER(LocalUMutableCPTriePointer, UMutableCPTrie, umutablecptrie_close);
235
236U_NAMESPACE_END
237
238#endif
239
240#endif
LocalUMutableCPTriePointer
"Smart pointer" class, closes a UMutableCPTrie via umutablecptrie_close().
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition localpointer.h:550
UCPTrie
Immutable Unicode code point trie structure.
Definition ucptrie.h:59
ucpmap.h
C API: This file defines an abstract map from Unicode code points to integer values.
UCPMapValueFilter
uint32_t UCPMapValueFilter(const void *context, uint32_t value)
Callback function type: Modifies a map value.
Definition ucpmap.h:113
UCPMap
struct UCPMap UCPMap
Abstract map from Unicode code points (U+0000..U+10FFFF) to integer values.
Definition ucpmap.h:30
UCPMapRangeOption
UCPMapRangeOption
Selectors for how ucpmap_getRange() etc.
Definition ucpmap.h:41
ucptrie.h
C API: This file defines an immutable Unicode code point trie.
UCPTrieType
UCPTrieType
Selectors for the type of a UCPTrie.
Definition ucptrie.h:119
UCPTrieValueWidth
UCPTrieValueWidth
Selectors for the number of bits in a UCPTrie data value.
Definition ucptrie.h:149
UChar32
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition umachine.h:435
U_CDECL_END
#define U_CDECL_END
This is used to end a declaration of a library private ICU C API.
Definition umachine.h:86
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition umachine.h:110
U_CDECL_BEGIN
#define U_CDECL_BEGIN
This is used to begin a declaration of a library private ICU C API.
Definition umachine.h:85
umutablecptrie_close
U_CAPI void umutablecptrie_close(UMutableCPTrie *trie)
Closes a mutable trie and releases associated memory.
umutablecptrie_get
U_CAPI uint32_t umutablecptrie_get(const UMutableCPTrie *trie, UChar32 c)
Returns the value for a code point as stored in the trie.
umutablecptrie_clone
U_CAPI UMutableCPTrie * umutablecptrie_clone(const UMutableCPTrie *other, UErrorCode *pErrorCode)
Clones a mutable trie.
umutablecptrie_set
U_CAPI void umutablecptrie_set(UMutableCPTrie *trie, UChar32 c, uint32_t value, UErrorCode *pErrorCode)
Sets a value for a code point.
umutablecptrie_fromUCPMap
U_CAPI UMutableCPTrie * umutablecptrie_fromUCPMap(const UCPMap *map, UErrorCode *pErrorCode)
Creates a mutable trie with the same contents as the UCPMap.
umutablecptrie_getRange
U_CAPI UChar32 umutablecptrie_getRange(const UMutableCPTrie *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.
umutablecptrie_fromUCPTrie
U_CAPI UMutableCPTrie * umutablecptrie_fromUCPTrie(const UCPTrie *trie, UErrorCode *pErrorCode)
Creates a mutable trie with the same contents as the immutable one.
umutablecptrie_setRange
U_CAPI void umutablecptrie_setRange(UMutableCPTrie *trie, UChar32 start, UChar32 end, uint32_t value, UErrorCode *pErrorCode)
Sets a value for each code point [start..end].
umutablecptrie_open
U_CAPI UMutableCPTrie * umutablecptrie_open(uint32_t initialValue, uint32_t errorValue, UErrorCode *pErrorCode)
Creates a mutable trie that initially maps each Unicode code point to the same value.
UMutableCPTrie
struct UMutableCPTrie UMutableCPTrie
Mutable Unicode code point trie.
Definition umutablecptrie.h:49
umutablecptrie_buildImmutable
U_CAPI UCPTrie * umutablecptrie_buildImmutable(UMutableCPTrie *trie, UCPTrieType type, UCPTrieValueWidth valueWidth, UErrorCode *pErrorCode)
Compacts the data and builds an immutable UCPTrie according to the parameters.
utf8.h
C API: 8-bit Unicode handling macros.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition utypes.h:415