1 // © 2016 and later: Unicode, Inc. and others. 2 // License & terms of use: http://www.unicode.org/copyright.html 4 ***************************************************************************** 5 * Copyright (C) 1996-2014, International Business Machines Corporation and others. 7 ***************************************************************************** 11 * Created by: Helena Shih 13 * Modification History: 15 * Date Name Description 17 * 6/20/97 helena Java class name change. 18 * 8/18/97 helena Added internal API documentation. 19 * 6/26/98 erm Changed to use byte arrays and memcmp. 20 ***************************************************************************** 28 #if U_SHOW_CPLUSPLUS_API 35 #if !UCONFIG_NO_COLLATION 43 /* forward declaration */ 44 classRuleBasedCollator;
45 classCollationKeyByteSink;
165 UBool isBogus()
const;
176 const uint8_t* getByteArray(int32_t& count)
const;
178 #ifdef U_USE_COLLATION_KEY_DEPRECATES 186 uint8_t* toByteArray(int32_t& count)
const;
189 #ifndef U_HIDE_DEPRECATED_API 200 #endif/* U_HIDE_DEPRECATED_API */ 254 uint8_t *reallocate(int32_t newCapacity, int32_t length);
258 void setLength(int32_t newLength);
260 uint8_t *getBytes() {
261 return (fFlagAndLength >= 0) ? fUnion.fStackBuffer : fUnion.fFields.fBytes;
263 const uint8_t *getBytes()
const{
264 return (fFlagAndLength >= 0) ? fUnion.fStackBuffer : fUnion.fFields.fBytes;
266 int32_t getCapacity()
const{
267 return fFlagAndLength >= 0 ?
static_cast<int32_t
>(
sizeof(fUnion)) : fUnion.fFields.fCapacity;
269 int32_t getLength()
const{
return fFlagAndLength & 0x7fffffff; }
275 CollationKey& setToBogus();
280 CollationKey& reset();
286 friendclassCollationKeyByteSink;
288 // Class fields. sizeof(CollationKey) is intended to be 48 bytes 289 // on a machine with 64-bit pointers. 290 // We use a union to maximize the size of the internal buffer, 291 // similar to UnicodeString but not as tight and complex. 293 // (implicit) *vtable; 299 int32_t fFlagAndLength;
304 mutable int32_t fHashCode;
309 unionStackBufferOrFields {
311 uint8_t fStackBuffer[32];
322 return !(*
this == other);
326 CollationKey::isBogus()
const 328 return fHashCode == 2;
// kBogusHashCode 332 CollationKey::getByteArray(int32_t &count)
const 340 #endif/* #if !UCONFIG_NO_COLLATION */ 342 #endif/* U_SHOW_CPLUSPLUS_API */ Collation keys are generated by the Collator class.
virtual ~CollationKey()
Sort key destructor.
CollationKey(const CollationKey &other)
Copy constructor.
virtual UClassID getDynamicClassID() const override
ICU "poor man's RTTI", returns a UClassID for the actual class.
UCollationResult compareTo(const CollationKey &target, UErrorCode &status) const
Convenience method which does a string(bit-wise) comparison of the two collation keys.
static UClassID getStaticClassID()
ICU "poor man's RTTI", returns a UClassID for this class.
CollationKey(const uint8_t *values, int32_t count)
Creates a collation key based on the collation key values.
Collator::EComparisonResult compareTo(const CollationKey &target) const
Convenience method which does a string(bit-wise) comparison of the two collation keys.
CollationKey()
This creates an empty collation key based on the null string.
const CollationKey & operator=(const CollationKey &other)
Assignment operator.
bool operator==(const CollationKey &source) const
Compare if two collation keys are the same.
int32_t hashCode() const
Creates an integer that is unique to the collation key.
EComparisonResult
LESS is returned if source string is compared to be less than target string in the compare() method.
The RuleBasedCollator class provides the implementation of Collator, using data-driven tables.
UObject is the common ICU "boilerplate" class.
C++ API: Collation Service.
bool operator!=(const StringPiece &x, const StringPiece &y)
Global operator != for StringPiece.
UCollationResult
UCOL_LESS is returned if source string is compared to be less than target string in the ucol_strcoll(...
int8_t UBool
The ICU boolean type, a signed-byte integer.
C++ API: Common ICU base class UObject.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
