ICU 71.1 71.1

ucol.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 *******************************************************************************
5 * Copyright (c) 1996-2015, International Business Machines Corporation and others.
6 * All Rights Reserved.
7 *******************************************************************************
8 */
9
10 #ifndef UCOL_H
11 #define UCOL_H
12
13 #include "unicode/utypes.h"
14
15 #if !UCONFIG_NO_COLLATION
16
17 #include "unicode/unorm.h"
18 #include "unicode/parseerr.h"
19 #include "unicode/uloc.h"
20 #include "unicode/uset.h"
21 #include "unicode/uscript.h"
22
23 #if U_SHOW_CPLUSPLUS_API
24 #include "unicode/localpointer.h"
25 #endif // U_SHOW_CPLUSPLUS_API
26
57 struct UCollator;
61 typedef struct UCollator UCollator;
62
63
76 typedef enum {
78 UCOL_EQUAL = 0,
80 UCOL_GREATER = 1,
82 UCOL_LESS = -1
83 } UCollationResult ;
84
85
92 typedef enum {
94 UCOL_DEFAULT = -1,
95
97 UCOL_PRIMARY = 0,
99 UCOL_SECONDARY = 1,
101 UCOL_TERTIARY = 2,
103 UCOL_DEFAULT_STRENGTH = UCOL_TERTIARY,
104 UCOL_CE_STRENGTH_LIMIT,
106 UCOL_QUATERNARY=3,
108 UCOL_IDENTICAL=15,
109 UCOL_STRENGTH_LIMIT,
110
114 UCOL_OFF = 16,
118 UCOL_ON = 17,
119
121 UCOL_SHIFTED = 20,
123 UCOL_NON_IGNORABLE = 21,
124
127 UCOL_LOWER_FIRST = 24,
129 UCOL_UPPER_FIRST = 25,
130
131 #ifndef U_HIDE_DEPRECATED_API
132
136 UCOL_ATTRIBUTE_VALUE_COUNT
137 #endif /* U_HIDE_DEPRECATED_API */
138 } UColAttributeValue;
139
149 typedef enum {
155 UCOL_REORDER_CODE_DEFAULT = -1,
160 UCOL_REORDER_CODE_NONE = USCRIPT_UNKNOWN,
167 UCOL_REORDER_CODE_OTHERS = USCRIPT_UNKNOWN,
173 UCOL_REORDER_CODE_SPACE = 0x1000,
179 UCOL_REORDER_CODE_FIRST = UCOL_REORDER_CODE_SPACE,
185 UCOL_REORDER_CODE_PUNCTUATION = 0x1001,
191 UCOL_REORDER_CODE_SYMBOL = 0x1002,
197 UCOL_REORDER_CODE_CURRENCY = 0x1003,
203 UCOL_REORDER_CODE_DIGIT = 0x1004,
204 #ifndef U_HIDE_DEPRECATED_API
205
209 UCOL_REORDER_CODE_LIMIT = 0x1005
210 #endif /* U_HIDE_DEPRECATED_API */
211 } UColReorderCode;
212
239 typedef UColAttributeValue UCollationStrength;
240
245 typedef enum {
252 UCOL_FRENCH_COLLATION,
263 UCOL_ALTERNATE_HANDLING,
272 UCOL_CASE_FIRST,
282 UCOL_CASE_LEVEL,
292 UCOL_NORMALIZATION_MODE,
296 UCOL_DECOMPOSITION_MODE = UCOL_NORMALIZATION_MODE,
313 UCOL_STRENGTH,
314 #ifndef U_HIDE_DEPRECATED_API
315
326 UCOL_HIRAGANA_QUATERNARY_MODE = UCOL_STRENGTH + 1,
327 #endif /* U_HIDE_DEPRECATED_API */
328
346 UCOL_NUMERIC_COLLATION = UCOL_STRENGTH + 2,
347
348 /* Do not conditionalize the following with #ifndef U_HIDE_DEPRECATED_API,
349 * it is needed for layout of RuleBasedCollator object. */
350 #ifndef U_FORCE_HIDE_DEPRECATED_API
351
355 UCOL_ATTRIBUTE_COUNT
356 #endif // U_FORCE_HIDE_DEPRECATED_API
357 } UColAttribute;
358
362 typedef enum {
368 UCOL_TAILORING_ONLY,
376 UCOL_FULL_RULES
377 } UColRuleOption ;
378
404 U_CAPI UCollator* U_EXPORT2
405 ucol_open(const char *loc, UErrorCode *status);
406
432 U_CAPI UCollator* U_EXPORT2
433 ucol_openRules( const UChar *rules,
434 int32_t rulesLength,
435 UColAttributeValue normalizationMode,
436 UCollationStrength strength,
437 UParseError *parseError,
438 UErrorCode *status);
439
440 #ifndef U_HIDE_DEPRECATED_API
441
474 U_DEPRECATED UCollator* U_EXPORT2
475 ucol_openFromShortString( const char *definition,
476 UBool forceDefaults,
477 UParseError *parseError,
478 UErrorCode *status);
479 #endif /* U_HIDE_DEPRECATED_API */
480
481 #ifndef U_HIDE_DEPRECATED_API
482
495 U_DEPRECATED int32_t U_EXPORT2
496 ucol_getContractions( const UCollator *coll,
497 USet *conts,
498 UErrorCode *status);
499 #endif /* U_HIDE_DEPRECATED_API */
500
512 U_CAPI void U_EXPORT2
513 ucol_getContractionsAndExpansions( const UCollator *coll,
514 USet *contractions, USet *expansions,
515 UBool addPrefixes, UErrorCode *status);
516
527 U_CAPI void U_EXPORT2
528 ucol_close(UCollator *coll);
529
530 #if U_SHOW_CPLUSPLUS_API
531
532 U_NAMESPACE_BEGIN
533
543 U_DEFINE_LOCAL_OPEN_POINTER(LocalUCollatorPointer, UCollator, ucol_close);
544
545 U_NAMESPACE_END
546
547 #endif
548
564 U_CAPI UCollationResult U_EXPORT2
565 ucol_strcoll( const UCollator *coll,
566 const UChar *source,
567 int32_t sourceLength,
568 const UChar *target,
569 int32_t targetLength);
570
589 U_CAPI UCollationResult U_EXPORT2
590 ucol_strcollUTF8(
591 const UCollator *coll,
592 const char *source,
593 int32_t sourceLength,
594 const char *target,
595 int32_t targetLength,
596 UErrorCode *status);
597
612 U_CAPI UBool U_EXPORT2
613 ucol_greater(const UCollator *coll,
614 const UChar *source, int32_t sourceLength,
615 const UChar *target, int32_t targetLength);
616
631 U_CAPI UBool U_EXPORT2
632 ucol_greaterOrEqual(const UCollator *coll,
633 const UChar *source, int32_t sourceLength,
634 const UChar *target, int32_t targetLength);
635
650 U_CAPI UBool U_EXPORT2
651 ucol_equal(const UCollator *coll,
652 const UChar *source, int32_t sourceLength,
653 const UChar *target, int32_t targetLength);
654
667 U_CAPI UCollationResult U_EXPORT2
668 ucol_strcollIter( const UCollator *coll,
669 UCharIterator *sIter,
670 UCharIterator *tIter,
671 UErrorCode *status);
672
682 U_CAPI UCollationStrength U_EXPORT2
683 ucol_getStrength(const UCollator *coll);
684
694 U_CAPI void U_EXPORT2
695 ucol_setStrength(UCollator *coll,
696 UCollationStrength strength);
697
714 U_CAPI int32_t U_EXPORT2
715 ucol_getReorderCodes(const UCollator* coll,
716 int32_t* dest,
717 int32_t destCapacity,
718 UErrorCode *pErrorCode);
759 U_CAPI void U_EXPORT2
760 ucol_setReorderCodes(UCollator* coll,
761 const int32_t* reorderCodes,
762 int32_t reorderCodesLength,
763 UErrorCode *pErrorCode);
764
784 U_CAPI int32_t U_EXPORT2
785 ucol_getEquivalentReorderCodes(int32_t reorderCode,
786 int32_t* dest,
787 int32_t destCapacity,
788 UErrorCode *pErrorCode);
789
802 U_CAPI int32_t U_EXPORT2
803 ucol_getDisplayName( const char *objLoc,
804 const char *dispLoc,
805 UChar *result,
806 int32_t resultLength,
807 UErrorCode *status);
808
818 U_CAPI const char* U_EXPORT2
819 ucol_getAvailable(int32_t localeIndex);
820
829 U_CAPI int32_t U_EXPORT2
830 ucol_countAvailable(void);
831
832 #if !UCONFIG_NO_SERVICE
833
841 U_CAPI UEnumeration* U_EXPORT2
842 ucol_openAvailableLocales(UErrorCode *status);
843 #endif
844
854 U_CAPI UEnumeration* U_EXPORT2
855 ucol_getKeywords(UErrorCode *status);
856
868 U_CAPI UEnumeration* U_EXPORT2
869 ucol_getKeywordValues(const char *keyword, UErrorCode *status);
870
887 U_CAPI UEnumeration* U_EXPORT2
888 ucol_getKeywordValuesForLocale(const char* key,
889 const char* locale,
890 UBool commonlyUsed,
891 UErrorCode* status);
892
924 U_CAPI int32_t U_EXPORT2
925 ucol_getFunctionalEquivalent(char* result, int32_t resultCapacity,
926 const char* keyword, const char* locale,
927 UBool* isAvailable, UErrorCode* status);
928
937 U_CAPI const UChar* U_EXPORT2
938 ucol_getRules( const UCollator *coll,
939 int32_t *length);
940
941 #ifndef U_HIDE_DEPRECATED_API
942
962 U_DEPRECATED int32_t U_EXPORT2
963 ucol_getShortDefinitionString(const UCollator *coll,
964 const char *locale,
965 char *buffer,
966 int32_t capacity,
967 UErrorCode *status);
968
988 U_DEPRECATED int32_t U_EXPORT2
989 ucol_normalizeShortDefinitionString(const char *source,
990 char *destination,
991 int32_t capacity,
992 UParseError *parseError,
993 UErrorCode *status);
994 #endif /* U_HIDE_DEPRECATED_API */
995
996
1019 U_CAPI int32_t U_EXPORT2
1020 ucol_getSortKey(const UCollator *coll,
1021 const UChar *source,
1022 int32_t sourceLength,
1023 uint8_t *result,
1024 int32_t resultLength);
1025
1026
1047 U_CAPI int32_t U_EXPORT2
1048 ucol_nextSortKeyPart(const UCollator *coll,
1049 UCharIterator *iter,
1050 uint32_t state[2],
1051 uint8_t *dest, int32_t count,
1052 UErrorCode *status);
1053
1061 typedef enum {
1063 UCOL_BOUND_LOWER = 0,
1065 UCOL_BOUND_UPPER = 1,
1067 UCOL_BOUND_UPPER_LONG = 2,
1068 #ifndef U_HIDE_DEPRECATED_API
1069
1073 UCOL_BOUND_VALUE_COUNT
1074 #endif /* U_HIDE_DEPRECATED_API */
1075 } UColBoundMode;
1076
1114 U_CAPI int32_t U_EXPORT2
1115 ucol_getBound(const uint8_t *source,
1116 int32_t sourceLength,
1117 UColBoundMode boundType,
1118 uint32_t noOfLevels,
1119 uint8_t *result,
1120 int32_t resultLength,
1121 UErrorCode *status);
1122
1131 U_CAPI void U_EXPORT2
1132 ucol_getVersion(const UCollator* coll, UVersionInfo info);
1133
1141 U_CAPI void U_EXPORT2
1142 ucol_getUCAVersion(const UCollator* coll, UVersionInfo info);
1143
1191 U_CAPI int32_t U_EXPORT2
1192 ucol_mergeSortkeys(const uint8_t *src1, int32_t src1Length,
1193 const uint8_t *src2, int32_t src2Length,
1194 uint8_t *dest, int32_t destCapacity);
1195
1207 U_CAPI void U_EXPORT2
1208 ucol_setAttribute(UCollator *coll, UColAttribute attr, UColAttributeValue value, UErrorCode *status);
1209
1221 U_CAPI UColAttributeValue U_EXPORT2
1222 ucol_getAttribute(const UCollator *coll, UColAttribute attr, UErrorCode *status);
1223
1240 U_CAPI void U_EXPORT2
1241 ucol_setMaxVariable(UCollator *coll, UColReorderCode group, UErrorCode *pErrorCode);
1242
1250 U_CAPI UColReorderCode U_EXPORT2
1251 ucol_getMaxVariable(const UCollator *coll);
1252
1253 #ifndef U_HIDE_DEPRECATED_API
1254
1274 U_DEPRECATED uint32_t U_EXPORT2
1275 ucol_setVariableTop(UCollator *coll,
1276 const UChar *varTop, int32_t len,
1277 UErrorCode *status);
1278 #endif /* U_HIDE_DEPRECATED_API */
1279
1291 U_CAPI uint32_t U_EXPORT2 ucol_getVariableTop(const UCollator *coll, UErrorCode *status);
1292
1293 #ifndef U_HIDE_DEPRECATED_API
1294
1308 U_DEPRECATED void U_EXPORT2
1309 ucol_restoreVariableTop(UCollator *coll, const uint32_t varTop, UErrorCode *status);
1310 #endif /* U_HIDE_DEPRECATED_API */
1311
1322 U_CAPI UCollator* U_EXPORT2 ucol_clone(const UCollator *coll, UErrorCode *status);
1323
1324 #ifndef U_HIDE_DEPRECATED_API
1325
1349 U_DEPRECATED UCollator* U_EXPORT2
1350 ucol_safeClone(const UCollator *coll,
1351 void *stackBuffer,
1352 int32_t *pBufferSize,
1353 UErrorCode *status);
1354
1355
1359 #define U_COL_SAFECLONE_BUFFERSIZE 1
1360
1361 #endif /* U_HIDE_DEPRECATED_API */
1362
1378 U_CAPI int32_t U_EXPORT2
1379 ucol_getRulesEx(const UCollator *coll, UColRuleOption delta, UChar *buffer, int32_t bufferLen);
1380
1381 #ifndef U_HIDE_DEPRECATED_API
1382
1396 U_DEPRECATED const char * U_EXPORT2
1397 ucol_getLocale(const UCollator *coll, ULocDataLocaleType type, UErrorCode *status);
1398 #endif /* U_HIDE_DEPRECATED_API */
1399
1414 U_CAPI const char * U_EXPORT2
1415 ucol_getLocaleByType(const UCollator *coll, ULocDataLocaleType type, UErrorCode *status);
1416
1427 U_CAPI USet * U_EXPORT2
1428 ucol_getTailoredSet(const UCollator *coll, UErrorCode *status);
1429
1430 #ifndef U_HIDE_INTERNAL_API
1431
1442 U_CAPI int32_t U_EXPORT2
1443 ucol_getUnsafeSet( const UCollator *coll,
1444 USet *unsafe,
1445 UErrorCode *status);
1446
1467 U_CAPI void U_EXPORT2
1468 ucol_prepareShortStringOpen( const char *definition,
1469 UBool forceDefaults,
1470 UParseError *parseError,
1471 UErrorCode *status);
1472 #endif /* U_HIDE_INTERNAL_API */
1473
1485 U_CAPI int32_t U_EXPORT2
1486 ucol_cloneBinary(const UCollator *coll,
1487 uint8_t *buffer, int32_t capacity,
1488 UErrorCode *status);
1489
1507 U_CAPI UCollator* U_EXPORT2
1508 ucol_openBinary(const uint8_t *bin, int32_t length,
1509 const UCollator *base,
1510 UErrorCode *status);
1511
1512
1513 #endif /* #if !UCONFIG_NO_COLLATION */
1514
1515 #endif
UCOL_IDENTICAL
@ UCOL_IDENTICAL
Identical collation strength.
Definition: ucol.h:108
UCOL_QUATERNARY
@ UCOL_QUATERNARY
Quaternary collation strength.
Definition: ucol.h:106
UCOL_EQUAL
@ UCOL_EQUAL
string a == string b
Definition: ucol.h:78
ucol_setAttribute
U_CAPI void ucol_setAttribute(UCollator *coll, UColAttribute attr, UColAttributeValue value, UErrorCode *status)
Universal attribute setter.
ucol_getKeywordValuesForLocale
U_CAPI UEnumeration * ucol_getKeywordValuesForLocale(const char *key, const char *locale, UBool commonlyUsed, UErrorCode *status)
Given a key and a locale, returns an array of string values in a preferred order that would make a di...
parseerr.h
C API: Parse Error Information.
ucol_getVersion
U_CAPI void ucol_getVersion(const UCollator *coll, UVersionInfo info)
Gets the version information for a Collator.
UCOL_REORDER_CODE_SPACE
@ UCOL_REORDER_CODE_SPACE
Characters with the space property.
Definition: ucol.h:173
ucol_strcollIter
U_CAPI UCollationResult ucol_strcollIter(const UCollator *coll, UCharIterator *sIter, UCharIterator *tIter, UErrorCode *status)
Compare two UTF-8 encoded strings.
UColAttribute
UColAttribute
Attributes that collation service understands.
Definition: ucol.h:245
ucol_restoreVariableTop
void ucol_restoreVariableTop(UCollator *coll, const uint32_t varTop, UErrorCode *status)
Sets the variable top to the specified primary weight.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
ucol_normalizeShortDefinitionString
int32_t ucol_normalizeShortDefinitionString(const char *source, char *destination, int32_t capacity, UParseError *parseError, UErrorCode *status)
Verifies and normalizes short definition string.
ucol_getReorderCodes
U_CAPI int32_t ucol_getReorderCodes(const UCollator *coll, int32_t *dest, int32_t destCapacity, UErrorCode *pErrorCode)
Retrieves the reordering codes for this collator.
ucol_prepareShortStringOpen
U_CAPI void ucol_prepareShortStringOpen(const char *definition, UBool forceDefaults, UParseError *parseError, UErrorCode *status)
Touches all resources needed for instantiating a collator from a short string definition,...
uscript.h
C API: Unicode Script Information.
ucol_getFunctionalEquivalent
U_CAPI int32_t ucol_getFunctionalEquivalent(char *result, int32_t resultCapacity, const char *keyword, const char *locale, UBool *isAvailable, UErrorCode *status)
Return the functionally equivalent locale for the specified input locale, with respect to given keywo...
UCOL_DEFAULT
@ UCOL_DEFAULT
accepted by most attributes
Definition: ucol.h:94
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
UCOL_DECOMPOSITION_MODE
@ UCOL_DECOMPOSITION_MODE
An alias for UCOL_NORMALIZATION_MODE attribute.
Definition: ucol.h:296
LocalUCollatorPointer
UCOL_REORDER_CODE_DIGIT
@ UCOL_REORDER_CODE_DIGIT
Characters with the digit property.
Definition: ucol.h:203
ULocDataLocaleType
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested,...
Definition: uloc.h:338
ucol_mergeSortkeys
U_CAPI int32_t ucol_mergeSortkeys(const uint8_t *src1, int32_t src1Length, const uint8_t *src2, int32_t src2Length, uint8_t *dest, int32_t destCapacity)
Merges two sort keys.
USCRIPT_UNKNOWN
@ USCRIPT_UNKNOWN
Definition: uscript.h:287
UCOL_LESS
@ UCOL_LESS
string a < string b
Definition: ucol.h:82
ucol_setMaxVariable
U_CAPI void ucol_setMaxVariable(UCollator *coll, UColReorderCode group, UErrorCode *pErrorCode)
Sets the variable top to the top of the specified reordering group.
UCOL_ATTRIBUTE_COUNT
@ UCOL_ATTRIBUTE_COUNT
One more than the highest normal UColAttribute value.
Definition: ucol.h:355
UColRuleOption
UColRuleOption
Options for retrieving the rule string.
Definition: ucol.h:362
ucol_getDisplayName
U_CAPI int32_t ucol_getDisplayName(const char *objLoc, const char *dispLoc, UChar *result, int32_t resultLength, UErrorCode *status)
Get the display name for a UCollator.
UCOL_PRIMARY
@ UCOL_PRIMARY
Primary collation strength.
Definition: ucol.h:97
ucol_setReorderCodes
U_CAPI void ucol_setReorderCodes(UCollator *coll, const int32_t *reorderCodes, int32_t reorderCodesLength, UErrorCode *pErrorCode)
Sets the reordering codes for this collator.
ucol_getSortKey
U_CAPI int32_t ucol_getSortKey(const UCollator *coll, const UChar *source, int32_t sourceLength, uint8_t *result, int32_t resultLength)
Get a sort key for a string from a UCollator.
U_DEPRECATED
#define U_DEPRECATED
This is used to declare a function as a deprecated public ICU C API
Definition: umachine.h:116
ucol_getKeywordValues
U_CAPI UEnumeration * ucol_getKeywordValues(const char *keyword, UErrorCode *status)
Given a keyword, create a string enumeration of all values for that keyword that are currently in use...
ucol_getLocale
const char * ucol_getLocale(const UCollator *coll, ULocDataLocaleType type, UErrorCode *status)
gets the locale name of the collator.
UCOL_ATTRIBUTE_VALUE_COUNT
@ UCOL_ATTRIBUTE_VALUE_COUNT
One more than the highest normal UColAttributeValue value.
Definition: ucol.h:136
UCOL_BOUND_LOWER
@ UCOL_BOUND_LOWER
lower bound
Definition: ucol.h:1063
ucol_countAvailable
U_CAPI int32_t ucol_countAvailable(void)
Determine how many locales have collation rules available.
ucol_openBinary
U_CAPI UCollator * ucol_openBinary(const uint8_t *bin, int32_t length, const UCollator *base, UErrorCode *status)
Opens a collator from a collator binary image created using ucol_cloneBinary.
UCOL_REORDER_CODE_CURRENCY
@ UCOL_REORDER_CODE_CURRENCY
Characters with the currency property.
Definition: ucol.h:197
UCOL_REORDER_CODE_SYMBOL
@ UCOL_REORDER_CODE_SYMBOL
Characters with the symbol property.
Definition: ucol.h:191
ucol_getTailoredSet
U_CAPI USet * ucol_getTailoredSet(const UCollator *coll, UErrorCode *status)
Get a Unicode set that contains all the characters and sequences tailored in this collator.
UColAttributeValue
UColAttributeValue
Enum containing attribute values for controlling collation behavior.
Definition: ucol.h:92
UCollationResult
UCollationResult
UCOL_LESS is returned if source string is compared to be less than target string in the ucol_strcoll(...
Definition: ucol.h:76
UParseError
A UParseError struct is used to returned detailed information about parsing errors.
Definition: parseerr.h:58
UCOL_SECONDARY
@ UCOL_SECONDARY
Secondary collation strength.
Definition: ucol.h:99
UCOL_REORDER_CODE_OTHERS
@ UCOL_REORDER_CODE_OTHERS
A special reordering code that is used to specify all other codes used for reordering except for the ...
Definition: ucol.h:167
ucol_open
U_CAPI UCollator * ucol_open(const char *loc, UErrorCode *status)
Open a UCollator for comparing strings.
ucol_getBound
U_CAPI int32_t ucol_getBound(const uint8_t *source, int32_t sourceLength, UColBoundMode boundType, uint32_t noOfLevels, uint8_t *result, int32_t resultLength, UErrorCode *status)
Produce a bound for a given sortkey and a number of levels.
ucol_clone
U_CAPI UCollator * ucol_clone(const UCollator *coll, UErrorCode *status)
Thread safe cloning operation.
uloc.h
C API: Locale.
ucol_getEquivalentReorderCodes
U_CAPI int32_t ucol_getEquivalentReorderCodes(int32_t reorderCode, int32_t *dest, int32_t destCapacity, UErrorCode *pErrorCode)
Retrieves the reorder codes that are grouped with the given reorder code.
ucol_getContractions
int32_t ucol_getContractions(const UCollator *coll, USet *conts, UErrorCode *status)
Get a set containing the contractions defined by the collator.
UCOL_CASE_FIRST
@ UCOL_CASE_FIRST
Controls the ordering of upper and lower case letters.
Definition: ucol.h:272
ucol_openRules
U_CAPI UCollator * ucol_openRules(const UChar *rules, int32_t rulesLength, UColAttributeValue normalizationMode, UCollationStrength strength, UParseError *parseError, UErrorCode *status)
Produce a UCollator instance according to the rules supplied.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
ucol_cloneBinary
U_CAPI int32_t ucol_cloneBinary(const UCollator *coll, uint8_t *buffer, int32_t capacity, UErrorCode *status)
Creates a binary image of a collator.
ucol_setVariableTop
uint32_t ucol_setVariableTop(UCollator *coll, const UChar *varTop, int32_t len, UErrorCode *status)
Sets the variable top to the primary weight of the specified string.
UCOL_NON_IGNORABLE
@ UCOL_NON_IGNORABLE
Valid for UCOL_ALTERNATE_HANDLING.
Definition: ucol.h:123
UCOL_REORDER_CODE_DEFAULT
@ UCOL_REORDER_CODE_DEFAULT
A special reordering code that is used to specify the default reordering codes for a locale.
Definition: ucol.h:155
UCOL_DEFAULT_STRENGTH
@ UCOL_DEFAULT_STRENGTH
Default collation strength.
Definition: ucol.h:103
ucol_getAttribute
U_CAPI UColAttributeValue ucol_getAttribute(const UCollator *coll, UColAttribute attr, UErrorCode *status)
Universal attribute getter.
ucol_getContractionsAndExpansions
U_CAPI void ucol_getContractionsAndExpansions(const UCollator *coll, USet *contractions, USet *expansions, UBool addPrefixes, UErrorCode *status)
Get a set containing the expansions defined by the collator.
UCOL_LOWER_FIRST
@ UCOL_LOWER_FIRST
Valid for UCOL_CASE_FIRST - lower case sorts before upper case.
Definition: ucol.h:127
ucol_getUCAVersion
U_CAPI void ucol_getUCAVersion(const UCollator *coll, UVersionInfo info)
Gets the UCA version information for a Collator.
UCOL_BOUND_VALUE_COUNT
@ UCOL_BOUND_VALUE_COUNT
One more than the highest normal UColBoundMode value.
Definition: ucol.h:1073
UColBoundMode
UColBoundMode
enum that is taken by ucol_getBound API See below for explanation do not change the values assigned...
Definition: ucol.h:1061
ucol_close
U_CAPI void ucol_close(UCollator *coll)
Close a UCollator.
UCollator
struct UCollator UCollator
structure representing a collator object instance
Definition: ucol.h:61
UCOL_REORDER_CODE_PUNCTUATION
@ UCOL_REORDER_CODE_PUNCTUATION
Characters with the punctuation property.
Definition: ucol.h:185
ucol_getRulesEx
U_CAPI int32_t ucol_getRulesEx(const UCollator *coll, UColRuleOption delta, UChar *buffer, int32_t bufferLen)
Returns current rules.
ucol_openFromShortString
UCollator * ucol_openFromShortString(const char *definition, UBool forceDefaults, UParseError *parseError, UErrorCode *status)
Open a collator defined by a short form string.
ucol_nextSortKeyPart
U_CAPI int32_t ucol_nextSortKeyPart(const UCollator *coll, UCharIterator *iter, uint32_t state[2], uint8_t *dest, int32_t count, UErrorCode *status)
Gets the next count bytes of a sort key.
UCOL_REORDER_CODE_NONE
@ UCOL_REORDER_CODE_NONE
A special reordering code that is used to specify no reordering codes.
Definition: ucol.h:160
ucol_getShortDefinitionString
int32_t ucol_getShortDefinitionString(const UCollator *coll, const char *locale, char *buffer, int32_t capacity, UErrorCode *status)
Get the short definition string for a collator.
ucol_greater
U_CAPI UBool ucol_greater(const UCollator *coll, const UChar *source, int32_t sourceLength, const UChar *target, int32_t targetLength)
Determine if one string is greater than another.
ucol_getStrength
U_CAPI UCollationStrength ucol_getStrength(const UCollator *coll)
Get the collation strength used in a UCollator.
UCOL_STRENGTH
@ UCOL_STRENGTH
The strength attribute.
Definition: ucol.h:313
UCOL_ALTERNATE_HANDLING
@ UCOL_ALTERNATE_HANDLING
Attribute for handling variable elements.
Definition: ucol.h:263
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
Definition: localpointer.h:550
UCOL_HIRAGANA_QUATERNARY_MODE
@ UCOL_HIRAGANA_QUATERNARY_MODE
When turned on, this attribute positions Hiragana before all non-ignorables on quaternary level Thi...
Definition: ucol.h:326
ucol_getKeywords
U_CAPI UEnumeration * ucol_getKeywords(UErrorCode *status)
Create a string enumerator of all possible keywords that are relevant to collation.
ucol_getLocaleByType
const U_CAPI char * ucol_getLocaleByType(const UCollator *coll, ULocDataLocaleType type, UErrorCode *status)
gets the locale name of the collator.
ucol_strcollUTF8
U_CAPI UCollationResult ucol_strcollUTF8(const UCollator *coll, const char *source, int32_t sourceLength, const char *target, int32_t targetLength, UErrorCode *status)
Compare two strings in UTF-8.
UCOL_OFF
@ UCOL_OFF
Turn the feature off - works for UCOL_FRENCH_COLLATION, UCOL_CASE_LEVEL, UCOL_HIRAGANA_QUATERNARY_MOD...
Definition: ucol.h:114
ucol_openAvailableLocales
U_CAPI UEnumeration * ucol_openAvailableLocales(UErrorCode *status)
Create a string enumerator of all locales for which a valid collator may be opened.
ucol_equal
U_CAPI UBool ucol_equal(const UCollator *coll, const UChar *source, int32_t sourceLength, const UChar *target, int32_t targetLength)
Compare two strings for equality.
unorm.h
C API: Unicode Normalization.
ucol_safeClone
UCollator * ucol_safeClone(const UCollator *coll, void *stackBuffer, int32_t *pBufferSize, UErrorCode *status)
Thread safe cloning operation.
UCharIterator
C API for code unit iteration.
Definition: uiter.h:341
ucol_getAvailable
const U_CAPI char * ucol_getAvailable(int32_t localeIndex)
Get a locale for which collation rules are available.
ucol_getUnsafeSet
U_CAPI int32_t ucol_getUnsafeSet(const UCollator *coll, USet *unsafe, UErrorCode *status)
Calculates the set of unsafe code points, given a collator.
UCOL_BOUND_UPPER
@ UCOL_BOUND_UPPER
upper bound that will match strings of exact size
Definition: ucol.h:1065
uset.h
C API: Unicode Set.
UCOL_FRENCH_COLLATION
@ UCOL_FRENCH_COLLATION
Attribute for direction of secondary weights - used in Canadian French.
Definition: ucol.h:252
UCOL_NUMERIC_COLLATION
@ UCOL_NUMERIC_COLLATION
When turned on, this attribute makes substrings of digits sort according to their numeric values.
Definition: ucol.h:346
ucol_getMaxVariable
U_CAPI UColReorderCode ucol_getMaxVariable(const UCollator *coll)
Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING.
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
UCOL_REORDER_CODE_LIMIT
@ UCOL_REORDER_CODE_LIMIT
One more than the highest normal UColReorderCode value.
Definition: ucol.h:209
ucol_strcoll
U_CAPI UCollationResult ucol_strcoll(const UCollator *coll, const UChar *source, int32_t sourceLength, const UChar *target, int32_t targetLength)
Compare two strings.
UCOL_CASE_LEVEL
@ UCOL_CASE_LEVEL
Controls whether an extra case level (positioned before the third level) is generated or not.
Definition: ucol.h:282
UCOL_TERTIARY
@ UCOL_TERTIARY
Tertiary collation strength.
Definition: ucol.h:101
ucol_getRules
const U_CAPI UChar * ucol_getRules(const UCollator *coll, int32_t *length)
Get the collation tailoring rules from a UCollator.
UCOL_FULL_RULES
@ UCOL_FULL_RULES
Retrieves the "UCA rules" concatenated with the tailoring rules.
Definition: ucol.h:376
UCOL_UPPER_FIRST
@ UCOL_UPPER_FIRST
upper case sorts before lower case
Definition: ucol.h:129
UCOL_REORDER_CODE_FIRST
@ UCOL_REORDER_CODE_FIRST
The first entry in the enumeration of reordering groups.
Definition: ucol.h:179
UChar
char16_t UChar
Definition: umachine.h:418
ucol_getVariableTop
U_CAPI uint32_t ucol_getVariableTop(const UCollator *coll, UErrorCode *status)
Gets the variable top value of a Collator.
UVersionInfo
uint8_t UVersionInfo[U_MAX_VERSION_LENGTH]
The binary form of a version on ICU APIs is an array of 4 uint8_t.
Definition: uversion.h:59
UEnumeration
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:44
UCOL_ON
@ UCOL_ON
Turn the feature on - works for UCOL_FRENCH_COLLATION, UCOL_CASE_LEVEL, UCOL_HIRAGANA_QUATERNARY_MODE...
Definition: ucol.h:118
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
UCOL_TAILORING_ONLY
@ UCOL_TAILORING_ONLY
Retrieves the tailoring rules only.
Definition: ucol.h:368
ucol_setStrength
U_CAPI void ucol_setStrength(UCollator *coll, UCollationStrength strength)
Set the collation strength used in a UCollator.
USet
struct USet USet
USet is the C API type corresponding to C++ class UnicodeSet.
Definition: uset.h:50
UCOL_BOUND_UPPER_LONG
@ UCOL_BOUND_UPPER_LONG
upper bound that will match all the strings that have the same initial substring as the given string
Definition: ucol.h:1067
ucol_greaterOrEqual
U_CAPI UBool ucol_greaterOrEqual(const UCollator *coll, const UChar *source, int32_t sourceLength, const UChar *target, int32_t targetLength)
Determine if one string is greater than or equal to another.
UCOL_NORMALIZATION_MODE
@ UCOL_NORMALIZATION_MODE
Controls whether the normalization check and necessary normalizations are performed.
Definition: ucol.h:292
UCOL_GREATER
@ UCOL_GREATER
string a > string b
Definition: ucol.h:80
UColReorderCode
UColReorderCode
Enum containing the codes for reordering segments of the collation table that are not script codes.
Definition: ucol.h:149
UCOL_SHIFTED
@ UCOL_SHIFTED
Valid for UCOL_ALTERNATE_HANDLING.
Definition: ucol.h:121
UCollationStrength
UColAttributeValue UCollationStrength
Base letter represents a primary difference.
Definition: ucol.h:239