Go to the documentation of this file.
67 #if U_SHOW_CPLUSPLUS_API
69 #if !UCONFIG_NO_COLLATION
78 struct CollationCacheEntry;
80 struct CollationSettings;
81 struct CollationTailoring;
89 class CollationElementIterator;
91 class SortKeyByteSink;
168 #ifndef U_HIDE_INTERNAL_API
314 const char16_t* target, int32_t targetLength,
383 int32_t sourceLength,
394 #ifndef U_FORCE_HIDE_DEPRECATED_API
406 #endif // U_FORCE_HIDE_DEPRECATED_API
422 #ifndef U_HIDE_DEPRECATED_API
467 #ifndef U_HIDE_DEPRECATED_API
552 #ifndef U_FORCE_HIDE_DEPRECATED_API
600 #endif // U_FORCE_HIDE_DEPRECATED_API
637 int32_t resultLength)
const;
655 virtual int32_t
getSortKey(
const char16_t *source, int32_t sourceLength,
656 uint8_t *result, int32_t resultLength)
const;
672 int32_t destCapacity,
687 int32_t reorderCodesLength,
695 const char *left, int32_t leftLength,
696 const char *right, int32_t rightLength,
733 uint8_t *dest, int32_t count,
UErrorCode &errorCode)
const;
742 #ifndef U_HIDE_INTERNAL_API
799 #endif // U_HIDE_INTERNAL_API
827 void adoptTailoring(CollationTailoring *t,
UErrorCode &errorCode);
831 const char16_t *right, int32_t rightLength,
834 const uint8_t *right, int32_t rightLength,
837 void writeSortKey(
const char16_t *s, int32_t length,
838 SortKeyByteSink &sink,
UErrorCode &errorCode)
const;
840 void writeIdenticalLevel(
const char16_t *s,
const char16_t *limit,
841 SortKeyByteSink &sink,
UErrorCode &errorCode)
const;
843 const CollationSettings &getDefaultSettings()
const;
845 void setAttributeDefault(int32_t attribute) {
846 explicitlySetAttributes &= ~((uint32_t)1 << attribute);
848 void setAttributeExplicitly(int32_t attribute) {
849 explicitlySetAttributes |= (uint32_t)1 << attribute;
851 UBool attributeHasBeenSetExplicitly(int32_t attribute)
const {
853 return (
UBool)((explicitlySetAttributes & ((uint32_t)1 << attribute)) != 0);
865 static void U_CALLCONV computeMaxExpansions(
const CollationTailoring *t,
UErrorCode &errorCode);
868 void setFastLatinOptions(CollationSettings &ownedSettings)
const;
870 const CollationData *data;
871 const CollationSettings *settings;
872 const CollationTailoring *tailoring;
873 const CollationCacheEntry *cacheEntry;
875 uint32_t explicitlySetAttributes;
877 UBool actualLocaleIsSameAsValid;
882 #endif // !UCONFIG_NO_COLLATION
void internalGetCEs(const UnicodeString &str, UVector64 &ces, UErrorCode &errorCode) const
Appends the CEs for the string to the vector.
C++ API: Collation Service.
virtual int32_t getSortKey(const char16_t *source, int32_t sourceLength, uint8_t *result, int32_t resultLength) const
Get the sort key as an array of bytes from a char16_t buffer.
#define U_FINAL
Defined to the C++11 "final" keyword if available.
virtual void setVariableTop(uint32_t varTop, UErrorCode &status)
Sets the variable top to the specified primary weight.
static RuleBasedCollator * rbcFromUCollator(UCollator *uc)
virtual CollationElementIterator * createCollationElementIterator(const UnicodeString &source) const
Creates a collation element iterator for the source string.
virtual UBool operator==(const Collator &other) const
Returns true if argument is the same as this object.
Collation keys are generated by the Collator class.
UColAttribute
Attributes that collation service understands.
int32_t cloneBinary(uint8_t *buffer, int32_t capacity, UErrorCode &status) const
Creates a binary image of a collator.
virtual int32_t getSortKey(const UnicodeString &source, uint8_t *result, int32_t resultLength) const
Get the sort key as an array of bytes from a UnicodeString.
Basic definitions for ICU, for both C and C++ APIs.
A mutable set of Unicode characters and multicharacter strings.
ECollationStrength
Base letter represents a primary difference.
virtual int32_t internalNextSortKeyPart(UCharIterator *iter, uint32_t state[2], uint8_t *dest, int32_t count, UErrorCode &errorCode) const
Implements ucol_nextSortKeyPart().
virtual UCollationResult compareUTF8(const StringPiece &source, const StringPiece &target, UErrorCode &status) const
Compares two UTF-8 strings using the Collator.
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
virtual RuleBasedCollator * clone() const
Makes a copy of this object.
int8_t UBool
The ICU boolean type, a signed-byte integer.
virtual UColReorderCode getMaxVariable() const
Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING.
RuleBasedCollator(const RuleBasedCollator &other)
Copy constructor.
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested,...
virtual int32_t getReorderCodes(int32_t *dest, int32_t destCapacity, UErrorCode &status) const
Retrieves the reordering codes for this collator.
@ UCOL_ATTRIBUTE_COUNT
One more than the highest normal UColAttribute value.
UColRuleOption
Options for retrieving the rule string.
virtual UnicodeSet * getTailoredSet(UErrorCode &status) const
Get a UnicodeSet that contains all the characters and sequences tailored in this collator.
virtual int32_t hashCode() const
Generates the hash code for the rule-based collation object.
The Collator class performs locale-sensitive string comparison.
RuleBasedCollator(const UnicodeString &rules, UColAttributeValue decompositionMode, UErrorCode &status)
RuleBasedCollator constructor.
virtual void setReorderCodes(const int32_t *reorderCodes, int32_t reorderCodesLength, UErrorCode &status)
Sets the ordering of scripts for this collator.
UColAttributeValue
Enum containing attribute values for controlling collation behavior.
UCollationResult
UCOL_LESS is returned if source string is compared to be less than target string in the ucol_strcoll(...
RuleBasedCollator(const UnicodeString &rules, ECollationStrength collationStrength, UErrorCode &status)
RuleBasedCollator constructor.
A UParseError struct is used to returned detailed information about parsing errors.
virtual uint32_t getVariableTop(UErrorCode &status) const
Gets the variable top value of a Collator.
virtual int32_t internalGetShortDefinitionString(const char *locale, char *buffer, int32_t capacity, UErrorCode &status) const
Get the short definition string for a collator.
virtual CollationKey & getCollationKey(const char16_t *source, int32_t sourceLength, CollationKey &key, UErrorCode &status) const
Transforms a specified region of the string into a series of characters that can be compared with Col...
virtual UCollationResult compare(UCharIterator &sIter, UCharIterator &tIter, UErrorCode &status) const
Compares two strings using the Collator.
virtual CollationKey & getCollationKey(const UnicodeString &source, CollationKey &key, UErrorCode &status) const
Transforms the string into a series of characters that can be compared with CollationKey....
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
virtual UCollationResult compare(const char16_t *source, int32_t sourceLength, const char16_t *target, int32_t targetLength, UErrorCode &status) const
The comparison function compares the character data stored in two different string arrays.
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
RuleBasedCollator(const UnicodeString &rules, ECollationStrength collationStrength, UColAttributeValue decompositionMode, UErrorCode &status)
RuleBasedCollator constructor.
virtual Collator & setMaxVariable(UColReorderCode group, UErrorCode &errorCode)
Sets the variable top to the top of the specified reordering group.
virtual UCollationResult compare(const UnicodeString &source, const UnicodeString &target, int32_t length, UErrorCode &status) const
Does the same thing as compare but limits the comparison to a specified length.
The RuleBasedCollator class provides the implementation of Collator, using data-driven tables.
struct UCollator UCollator
structure representing a collator object instance
RuleBasedCollator(const UnicodeString &rules, UParseError &parseError, UnicodeString &reason, UErrorCode &errorCode)
TODO: document & propose as public API.
virtual void setLocales(const Locale &requestedLocale, const Locale &validLocale, const Locale &actualLocale)
Used internally by registration to define the requested and valid locales.
const char * internalGetLocaleID(ULocDataLocaleType type, UErrorCode &errorCode) const
Implements ucol_getLocaleByType().
Abstract class that defines an API for iteration on text objects.
void getRules(UColRuleOption delta, UnicodeString &buffer) const
Returns current rules.
RuleBasedCollator(const uint8_t *bin, int32_t length, const RuleBasedCollator *base, UErrorCode &status)
Opens a collator from a collator binary image created using cloneBinary.
RuleBasedCollator & operator=(const RuleBasedCollator &other)
Assignment operator.
virtual ~RuleBasedCollator()
Destructor.
C API for code unit iteration.
virtual UCollationResult compare(const UnicodeString &source, const UnicodeString &target, UErrorCode &status) const
The comparison function compares the character data stored in two different strings.
virtual void getVersion(UVersionInfo info) const
Gets the version information for a Collator.
void internalAddContractions(UChar32 c, UnicodeSet &set, UErrorCode &errorCode) const
Adds the contractions that start with character c to the set.
virtual uint32_t setVariableTop(const char16_t *varTop, int32_t len, UErrorCode &status)
Sets the variable top to the primary weight of the specified string.
int32_t getMaxExpansion(int32_t order) const
Returns the maximum length of any expansion sequences that end with the specified comparison order.
C API: Unicode Character Iteration.
virtual UCollationResult internalCompareUTF8(const char *left, int32_t leftLength, const char *right, int32_t rightLength, UErrorCode &errorCode) const
Implements ucol_strcollUTF8().
static Collator * fromUCollator(UCollator *uc)
uint8_t UVersionInfo[U_MAX_VERSION_LENGTH]
The binary form of a version on ICU APIs is an array of 4 uint8_t.
void internalGetContractionsAndExpansions(UnicodeSet *contractions, UnicodeSet *expansions, UBool addPrefixes, UErrorCode &errorCode) const
Implements ucol_getContractionsAndExpansions().
C++ API: Locale ID object.
virtual Locale getLocale(ULocDataLocaleType type, UErrorCode &status) const
Gets the locale of the Collator.
void internalBuildTailoring(const UnicodeString &rules, int32_t strength, UColAttributeValue decompositionMode, UParseError *outParseError, UnicodeString *outReason, UErrorCode &errorCode)
Implements from-rule constructors, and ucol_openRules().
virtual UColAttributeValue getAttribute(UColAttribute attr, UErrorCode &status) const
Universal attribute getter.
uint8_t * cloneRuleData(int32_t &length, UErrorCode &status) const
Do not use this method: The caller and the ICU library might use different heaps.
const UnicodeString & getRules() const
Gets the tailoring rules for this collator.
virtual EComparisonResult compare(const UnicodeString &source, const UnicodeString &target) const
The comparison function compares the character data stored in two different strings.
RuleBasedCollator()
Only for use in ucol_openRules().
The CollationElementIterator class is used as an iterator to walk through each character of an inte...
A string-like object that points to a sized piece of memory.
RuleBasedCollator(const UnicodeString &rules, UErrorCode &status)
RuleBasedCollator constructor.
A Locale object represents a specific geographical, political, or cultural region.
virtual CollationElementIterator * createCollationElementIterator(const CharacterIterator &source) const
Creates a collation element iterator for the source.
static const RuleBasedCollator * rbcFromUCollator(const UCollator *uc)
UColReorderCode
Enum containing the codes for reordering segments of the collation table that are not script codes.
virtual uint32_t setVariableTop(const UnicodeString &varTop, UErrorCode &status)
Sets the variable top to the primary weight of the specified string.
virtual UClassID getDynamicClassID(void) const
Returns a unique class ID POLYMORPHICALLY.
virtual void setAttribute(UColAttribute attr, UColAttributeValue value, UErrorCode &status)
Universal attribute setter.
static UClassID getStaticClassID(void)
Returns the class ID for this class.