ICU 56.1: ucoleitr.h Source File

ICU 56.1 56.1

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

- File List
- Globals

ucoleitr.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (C) 2001-2014, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 *******************************************************************************
6 *
7 * File ucoleitr.h
8 *
9 * Modification History:
10 *
11 * Date Name Description
12 * 02/15/2001 synwee Modified all methods to process its own function
13 * instead of calling the equivalent c++ api (coleitr.h)
14 *******************************************************************************/
15
16 #ifndef UCOLEITR_H
17 #define UCOLEITR_H
18
19 #include "unicode/utypes.h"
20
21 #if !UCONFIG_NO_COLLATION
22
28 #define UCOL_NULLORDER ((int32_t)0xFFFFFFFF)
29
30 #include "unicode/ucol.h"
31
37 typedef struct UCollationElements UCollationElements;
38
110 U_STABLE UCollationElements* U_EXPORT2
111 ucol_openElements(const UCollator *coll,
112 const UChar *text,
113 int32_t textLength,
114 UErrorCode *status);
115
116
124 U_STABLE int32_t U_EXPORT2
125 ucol_keyHashCode(const uint8_t* key, int32_t length);
126
133 U_STABLE void U_EXPORT2
134 ucol_closeElements(UCollationElements *elems);
135
145 U_STABLE void U_EXPORT2
146 ucol_reset(UCollationElements *elems);
147
157 U_STABLE int32_t U_EXPORT2
158 ucol_next(UCollationElements *elems, UErrorCode *status);
159
173 U_STABLE int32_t U_EXPORT2
174 ucol_previous(UCollationElements *elems, UErrorCode *status);
175
187 U_STABLE int32_t U_EXPORT2
188 ucol_getMaxExpansion(const UCollationElements *elems, int32_t order);
189
202 U_STABLE void U_EXPORT2
203 ucol_setText( UCollationElements *elems,
204 const UChar *text,
205 int32_t textLength,
206 UErrorCode *status);
207
217 U_STABLE int32_t U_EXPORT2
218 ucol_getOffset(const UCollationElements *elems);
219
232 U_STABLE void U_EXPORT2
233 ucol_setOffset(UCollationElements *elems,
234 int32_t offset,
235 UErrorCode *status);
236
243 U_STABLE int32_t U_EXPORT2
244 ucol_primaryOrder (int32_t order);
245
252 U_STABLE int32_t U_EXPORT2
253 ucol_secondaryOrder (int32_t order);
254
261 U_STABLE int32_t U_EXPORT2
262 ucol_tertiaryOrder (int32_t order);
263
264 #endif /* #if !UCONFIG_NO_COLLATION */
265
266 #endif
ucol_tertiaryOrder
int32_t ucol_tertiaryOrder(int32_t order)
Get the tertiary order of a collation order.
ucol_openElements
UCollationElements * ucol_openElements(const UCollator *coll, const UChar *text, int32_t textLength, UErrorCode *status)
Open the collation elements for a string.
ucol_secondaryOrder
int32_t ucol_secondaryOrder(int32_t order)
Get the secondary order of a collation order.
ucol_previous
int32_t ucol_previous(UCollationElements *elems, UErrorCode *status)
Get the ordering priority of the previous collation element in the text.
ucol_getMaxExpansion
int32_t ucol_getMaxExpansion(const UCollationElements *elems, int32_t order)
Get the maximum length of any expansion sequences that end with the specified comparison order...
ucol_keyHashCode
int32_t ucol_keyHashCode(const uint8_t *key, int32_t length)
get a hash code for a key...
UCollationElements
struct UCollationElements UCollationElements
The UCollationElements struct.
Definition: ucoleitr.h:37
ucol_setText
void ucol_setText(UCollationElements *elems, const UChar *text, int32_t textLength, UErrorCode *status)
Set the text containing the collation elements.
ucol.h
C API: Collator.
ucol_next
int32_t ucol_next(UCollationElements *elems, UErrorCode *status)
Get the ordering priority of the next collation element in the text.
UChar
uint16_t UChar
Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...
Definition: umachine.h:312
ucol_closeElements
void ucol_closeElements(UCollationElements *elems)
Close a UCollationElements.
ucol_setOffset
void ucol_setOffset(UCollationElements *elems, int32_t offset, UErrorCode *status)
Set the offset of the current source character.
ucol_reset
void ucol_reset(UCollationElements *elems)
Reset the collation elements to their initial state.
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
UCollator
struct UCollator UCollator
structure representing a collator object instance
Definition: ucol.h:56
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
ucol_getOffset
int32_t ucol_getOffset(const UCollationElements *elems)
Get the offset of the current source character.
ucol_primaryOrder
int32_t ucol_primaryOrder(int32_t order)
Get the primary order of a collation order.
U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:109