ICU 52.1  52.1
ucol.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (c) 1996-2013, International Business Machines Corporation and others.
4 * All Rights Reserved.
5 *******************************************************************************
6 */
7 
8 #ifndef UCOL_H
9 #define UCOL_H
10 
11 #include "unicode/utypes.h"
12 
13 #if !UCONFIG_NO_COLLATION
14 
15 #include "unicode/unorm.h"
16 #include "unicode/localpointer.h"
17 #include "unicode/parseerr.h"
18 #include "unicode/uloc.h"
19 #include "unicode/uset.h"
20 #include "unicode/uscript.h"
21 
58 struct UCollator;
62 typedef struct UCollator UCollator;
63 
64 
77 typedef enum {
83  UCOL_LESS = -1
85 
86 
93 typedef enum {
96 
105  UCOL_CE_STRENGTH_LIMIT,
110  UCOL_STRENGTH_LIMIT,
111 
115  UCOL_OFF = 16,
119  UCOL_ON = 17,
120 
125 
131 
132  UCOL_ATTRIBUTE_VALUE_COUNT
133 
135 
145  typedef enum {
207 
235 
240 typedef enum {
305 #ifndef U_HIDE_DEPRECATED_API
306 
317 #endif /* U_HIDE_DEPRECATED_API */
318 
333 } UColAttribute;
334 
338 typedef enum {
353 } UColRuleOption ;
354 
372 U_STABLE UCollator* U_EXPORT2
373 ucol_open(const char *loc, UErrorCode *status);
374 
400 U_STABLE UCollator* U_EXPORT2
401 ucol_openRules( const UChar *rules,
402  int32_t rulesLength,
403  UColAttributeValue normalizationMode,
404  UCollationStrength strength,
405  UParseError *parseError,
406  UErrorCode *status);
407 
442 U_STABLE UCollator* U_EXPORT2
443 ucol_openFromShortString( const char *definition,
444  UBool forceDefaults,
445  UParseError *parseError,
446  UErrorCode *status);
447 
448 #ifndef U_HIDE_DEPRECATED_API
449 
462 U_DEPRECATED int32_t U_EXPORT2
463 ucol_getContractions( const UCollator *coll,
464  USet *conts,
465  UErrorCode *status);
466 #endif /* U_HIDE_DEPRECATED_API */
467 
479 U_STABLE void U_EXPORT2
481  USet *contractions, USet *expansions,
482  UBool addPrefixes, UErrorCode *status);
483 
494 U_STABLE void U_EXPORT2
495 ucol_close(UCollator *coll);
496 
497 #if U_SHOW_CPLUSPLUS_API
498 
500 
511 
513 
514 #endif
515 
531 U_STABLE UCollationResult U_EXPORT2
532 ucol_strcoll( const UCollator *coll,
533  const UChar *source,
534  int32_t sourceLength,
535  const UChar *target,
536  int32_t targetLength);
537 
556 U_STABLE UCollationResult U_EXPORT2
558  const UCollator *coll,
559  const char *source,
560  int32_t sourceLength,
561  const char *target,
562  int32_t targetLength,
563  UErrorCode *status);
564 
579 U_STABLE UBool U_EXPORT2
580 ucol_greater(const UCollator *coll,
581  const UChar *source, int32_t sourceLength,
582  const UChar *target, int32_t targetLength);
583 
598 U_STABLE UBool U_EXPORT2
599 ucol_greaterOrEqual(const UCollator *coll,
600  const UChar *source, int32_t sourceLength,
601  const UChar *target, int32_t targetLength);
602 
617 U_STABLE UBool U_EXPORT2
618 ucol_equal(const UCollator *coll,
619  const UChar *source, int32_t sourceLength,
620  const UChar *target, int32_t targetLength);
621 
634 U_STABLE UCollationResult U_EXPORT2
635 ucol_strcollIter( const UCollator *coll,
636  UCharIterator *sIter,
637  UCharIterator *tIter,
638  UErrorCode *status);
639 
649 U_STABLE UCollationStrength U_EXPORT2
650 ucol_getStrength(const UCollator *coll);
651 
661 U_STABLE void U_EXPORT2
663  UCollationStrength strength);
664 
681 U_STABLE int32_t U_EXPORT2
682 ucol_getReorderCodes(const UCollator* coll,
683  int32_t* dest,
684  int32_t destCapacity,
685  UErrorCode *pErrorCode);
721 U_STABLE void U_EXPORT2
723  const int32_t* reorderCodes,
724  int32_t reorderCodesLength,
725  UErrorCode *pErrorCode);
726 
743 U_STABLE int32_t U_EXPORT2
744 ucol_getEquivalentReorderCodes(int32_t reorderCode,
745  int32_t* dest,
746  int32_t destCapacity,
747  UErrorCode *pErrorCode);
748 
761 U_STABLE int32_t U_EXPORT2
762 ucol_getDisplayName( const char *objLoc,
763  const char *dispLoc,
764  UChar *result,
765  int32_t resultLength,
766  UErrorCode *status);
767 
777 U_STABLE const char* U_EXPORT2
778 ucol_getAvailable(int32_t localeIndex);
779 
788 U_STABLE int32_t U_EXPORT2
789 ucol_countAvailable(void);
790 
791 #if !UCONFIG_NO_SERVICE
792 
800 U_STABLE UEnumeration* U_EXPORT2
802 #endif
803 
813 U_STABLE UEnumeration* U_EXPORT2
815 
827 U_STABLE UEnumeration* U_EXPORT2
828 ucol_getKeywordValues(const char *keyword, UErrorCode *status);
829 
846 U_STABLE UEnumeration* U_EXPORT2
847 ucol_getKeywordValuesForLocale(const char* key,
848  const char* locale,
849  UBool commonlyUsed,
850  UErrorCode* status);
851 
882 U_STABLE int32_t U_EXPORT2
883 ucol_getFunctionalEquivalent(char* result, int32_t resultCapacity,
884  const char* keyword, const char* locale,
885  UBool* isAvailable, UErrorCode* status);
886 
895 U_STABLE const UChar* U_EXPORT2
896 ucol_getRules( const UCollator *coll,
897  int32_t *length);
898 
919 U_STABLE int32_t U_EXPORT2
921  const char *locale,
922  char *buffer,
923  int32_t capacity,
924  UErrorCode *status);
925 
946 U_STABLE int32_t U_EXPORT2
947 ucol_normalizeShortDefinitionString(const char *source,
948  char *destination,
949  int32_t capacity,
950  UParseError *parseError,
951  UErrorCode *status);
952 
953 
973 U_STABLE int32_t U_EXPORT2
974 ucol_getSortKey(const UCollator *coll,
975  const UChar *source,
976  int32_t sourceLength,
977  uint8_t *result,
978  int32_t resultLength);
979 
980 
1001 U_STABLE int32_t U_EXPORT2
1002 ucol_nextSortKeyPart(const UCollator *coll,
1003  UCharIterator *iter,
1004  uint32_t state[2],
1005  uint8_t *dest, int32_t count,
1006  UErrorCode *status);
1007 
1015 typedef enum {
1022  UCOL_BOUND_VALUE_COUNT
1023 } UColBoundMode;
1024 
1062 U_STABLE int32_t U_EXPORT2
1063 ucol_getBound(const uint8_t *source,
1064  int32_t sourceLength,
1065  UColBoundMode boundType,
1066  uint32_t noOfLevels,
1067  uint8_t *result,
1068  int32_t resultLength,
1069  UErrorCode *status);
1070 
1079 U_STABLE void U_EXPORT2
1080 ucol_getVersion(const UCollator* coll, UVersionInfo info);
1081 
1089 U_STABLE void U_EXPORT2
1090 ucol_getUCAVersion(const UCollator* coll, UVersionInfo info);
1091 
1128 U_STABLE int32_t U_EXPORT2
1129 ucol_mergeSortkeys(const uint8_t *src1, int32_t src1Length,
1130  const uint8_t *src2, int32_t src2Length,
1131  uint8_t *dest, int32_t destCapacity);
1132 
1144 U_STABLE void U_EXPORT2
1146 
1158 U_STABLE UColAttributeValue U_EXPORT2
1159 ucol_getAttribute(const UCollator *coll, UColAttribute attr, UErrorCode *status);
1160 
1180 U_STABLE uint32_t U_EXPORT2
1182  const UChar *varTop, int32_t len,
1183  UErrorCode *status);
1184 
1196 U_STABLE uint32_t U_EXPORT2 ucol_getVariableTop(const UCollator *coll, UErrorCode *status);
1197 
1209 U_STABLE void U_EXPORT2
1210 ucol_restoreVariableTop(UCollator *coll, const uint32_t varTop, UErrorCode *status);
1211 
1235 U_STABLE UCollator* U_EXPORT2
1236 ucol_safeClone(const UCollator *coll,
1237  void *stackBuffer,
1238  int32_t *pBufferSize,
1239  UErrorCode *status);
1240 
1241 #ifndef U_HIDE_DEPRECATED_API
1242 
1246 #define U_COL_SAFECLONE_BUFFERSIZE 1
1247 
1248 #endif /* U_HIDE_DEPRECATED_API */
1249 
1265 U_STABLE int32_t U_EXPORT2
1266 ucol_getRulesEx(const UCollator *coll, UColRuleOption delta, UChar *buffer, int32_t bufferLen);
1267 
1268 #ifndef U_HIDE_DEPRECATED_API
1269 
1283 U_DEPRECATED const char * U_EXPORT2
1284 ucol_getLocale(const UCollator *coll, ULocDataLocaleType type, UErrorCode *status);
1285 #endif /* U_HIDE_DEPRECATED_API */
1286 
1301 U_STABLE const char * U_EXPORT2
1302 ucol_getLocaleByType(const UCollator *coll, ULocDataLocaleType type, UErrorCode *status);
1303 
1314 U_STABLE USet * U_EXPORT2
1315 ucol_getTailoredSet(const UCollator *coll, UErrorCode *status);
1316 
1317 #ifndef U_HIDE_INTERNAL_API
1318 
1330 ucol_getAttributeOrDefault(const UCollator *coll, UColAttribute attr, UErrorCode *status);
1331 
1340 U_INTERNAL UBool U_EXPORT2
1341 ucol_equals(const UCollator *source, const UCollator *target);
1342 
1354 U_INTERNAL int32_t U_EXPORT2
1355 ucol_getUnsafeSet( const UCollator *coll,
1356  USet *unsafe,
1357  UErrorCode *status);
1358 
1362 U_INTERNAL void U_EXPORT2
1363 ucol_forgetUCA(void);
1364 
1385 U_INTERNAL void U_EXPORT2
1386 ucol_prepareShortStringOpen( const char *definition,
1387  UBool forceDefaults,
1388  UParseError *parseError,
1389  UErrorCode *status);
1390 #endif /* U_HIDE_INTERNAL_API */
1391 
1403 U_STABLE int32_t U_EXPORT2
1404 ucol_cloneBinary(const UCollator *coll,
1405  uint8_t *buffer, int32_t capacity,
1406  UErrorCode *status);
1407 
1425 U_STABLE UCollator* U_EXPORT2
1426 ucol_openBinary(const uint8_t *bin, int32_t length,
1427  const UCollator *base,
1428  UErrorCode *status);
1429 
1430 
1431 #endif /* #if !UCONFIG_NO_COLLATION */
1432 
1433 #endif