ICU 4.8.1.1  4.8.1.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ucoleitr.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (C) 2001-2009, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 *******************************************************************************
6 *
7 * File ucoleitr.cpp
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 
36 #define UCOL_PROCESSED_NULLORDER ((int64_t)U_INT64_MAX)
37 
38 #include "unicode/ucol.h"
39 
46 
119 ucol_openElements(const UCollator *coll,
120  const UChar *text,
121  int32_t textLength,
122  UErrorCode *status);
123 
124 
132 U_STABLE int32_t U_EXPORT2
133 ucol_keyHashCode(const uint8_t* key, int32_t length);
134 
141 U_STABLE void U_EXPORT2
143 
153 U_STABLE void U_EXPORT2
155 
169 
179 U_STABLE int32_t U_EXPORT2
180 ucol_next(UCollationElements *elems, UErrorCode *status);
181 
198 U_STABLE int32_t U_EXPORT2
200 
214 U_INTERNAL int64_t U_EXPORT2
215 ucol_nextProcessed(UCollationElements *elems, int32_t *ixLow, int32_t *ixHigh, UErrorCode *status);
216 
237 U_INTERNAL int64_t U_EXPORT2
238 ucol_previousProcessed(UCollationElements *elems, int32_t *ixLow, int32_t *ixHigh, UErrorCode *status);
239 
251 U_STABLE int32_t U_EXPORT2
252 ucol_getMaxExpansion(const UCollationElements *elems, int32_t order);
253 
266 U_STABLE void U_EXPORT2
268  const UChar *text,
269  int32_t textLength,
270  UErrorCode *status);
271 
281 U_STABLE int32_t U_EXPORT2
282 ucol_getOffset(const UCollationElements *elems);
283 
296 U_STABLE void U_EXPORT2
298  int32_t offset,
299  UErrorCode *status);
300 
307 U_STABLE int32_t U_EXPORT2
308 ucol_primaryOrder (int32_t order);
309 
316 U_STABLE int32_t U_EXPORT2
317 ucol_secondaryOrder (int32_t order);
318 
325 U_STABLE int32_t U_EXPORT2
326 ucol_tertiaryOrder (int32_t order);
327 
328 #endif /* #if !UCONFIG_NO_COLLATION */
329 
330 #endif
int32_t ucol_tertiaryOrder(int32_t order)
Get the tertiary order of a collation order.
UCollationElements * ucol_openElements(const UCollator *coll, const UChar *text, int32_t textLength, UErrorCode *status)
Open the collation elements for a string.
int32_t ucol_secondaryOrder(int32_t order)
Get the secondary order of a collation order.
#define U_INTERNAL
This is used to declare a function as an internal ICU C API.
Definition: umachine.h:145
int32_t ucol_previous(UCollationElements *elems, UErrorCode *status)
Get the ordering priority of the previous collation element in the text.
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...
int32_t ucol_keyHashCode(const uint8_t *key, int32_t length)
get a hash code for a key...
struct UCollationElements UCollationElements
File coleitr.h.
Definition: coleitr.h:49
int64_t ucol_previousProcessed(UCollationElements *elems, int32_t *ixLow, int32_t *ixHigh, UErrorCode *status)
Get the processed ordering priority of the previous collation element in the text.
void ucol_setText(UCollationElements *elems, const UChar *text, int32_t textLength, UErrorCode *status)
Set the text containing the collation elements.
C API: Collator.
#define U_EXPORT2
Definition: platform.h:314
int32_t ucol_next(UCollationElements *elems, UErrorCode *status)
Get the ordering priority of the next collation element in the text.
uint16_t UChar
Define UChar to be wchar_t if that is 16 bits wide; always assumed to be unsigned.
Definition: umachine.h:325
void ucol_closeElements(UCollationElements *elems)
Close a UCollationElements.
void ucol_setOffset(UCollationElements *elems, int32_t offset, UErrorCode *status)
Set the offset of the current source character.
int64_t ucol_nextProcessed(UCollationElements *elems, int32_t *ixLow, int32_t *ixHigh, UErrorCode *status)
Get the processed ordering priority of the next collation element in the text.
void ucol_reset(UCollationElements *elems)
Reset the collation elements to their initial state.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:639
struct UCollator UCollator
structure representing a collator object instance
Definition: ucol.h:62
Basic definitions for ICU, for both C and C++ APIs.
int32_t ucol_getOffset(const UCollationElements *elems)
Get the offset of the current source character.
int32_t ucol_primaryOrder(int32_t order)
Get the primary order of a collation order.
void ucol_forceHanImplicit(UCollationElements *elems, UErrorCode *status)
Set the collation elements to use implicit ordering for Han even if they've been tailored.
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:137