ICU 56.1  56.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
tblcoll.h
Go to the documentation of this file.
1 /*
2 ******************************************************************************
3 * Copyright (C) 1996-2015, International Business Machines Corporation and
4 * others. All Rights Reserved.
5 ******************************************************************************
6 */
7 
60 #ifndef TBLCOLL_H
61 #define TBLCOLL_H
62 
63 #include "unicode/utypes.h"
64 
65 #if !UCONFIG_NO_COLLATION
66 
67 #include "unicode/coll.h"
68 #include "unicode/locid.h"
69 #include "unicode/uiter.h"
70 #include "unicode/ucol.h"
71 
73 
74 struct CollationCacheEntry;
75 struct CollationData;
76 struct CollationSettings;
77 struct CollationTailoring;
81 class StringSearch;
85 class CollationElementIterator;
86 class CollationKey;
87 class SortKeyByteSink;
88 class UnicodeSet;
89 class UnicodeString;
90 class UVector64;
91 
112 public:
121  RuleBasedCollator(const UnicodeString& rules, UErrorCode& status);
122 
132  RuleBasedCollator(const UnicodeString& rules,
133  ECollationStrength collationStrength,
134  UErrorCode& status);
135 
145  RuleBasedCollator(const UnicodeString& rules,
146  UColAttributeValue decompositionMode,
147  UErrorCode& status);
148 
159  RuleBasedCollator(const UnicodeString& rules,
160  ECollationStrength collationStrength,
161  UColAttributeValue decompositionMode,
162  UErrorCode& status);
163 
164 #ifndef U_HIDE_INTERNAL_API
165 
169  RuleBasedCollator(const UnicodeString &rules,
170  UParseError &parseError, UnicodeString &reason,
171  UErrorCode &errorCode);
172 #endif /* U_HIDE_INTERNAL_API */
173 
179  RuleBasedCollator(const RuleBasedCollator& other);
180 
181 
199  RuleBasedCollator(const uint8_t *bin, int32_t length,
200  const RuleBasedCollator *base,
201  UErrorCode &status);
202 
207  virtual ~RuleBasedCollator();
208 
214  RuleBasedCollator& operator=(const RuleBasedCollator& other);
215 
222  virtual UBool operator==(const Collator& other) const;
223 
229  virtual Collator* clone(void) const;
230 
241  virtual CollationElementIterator* createCollationElementIterator(
242  const UnicodeString& source) const;
243 
253  virtual CollationElementIterator* createCollationElementIterator(
254  const CharacterIterator& source) const;
255 
256  // Make deprecated versions of Collator::compare() visible.
257  using Collator::compare;
258 
271  virtual UCollationResult compare(const UnicodeString& source,
272  const UnicodeString& target,
273  UErrorCode &status) const;
274 
288  virtual UCollationResult compare(const UnicodeString& source,
289  const UnicodeString& target,
290  int32_t length,
291  UErrorCode &status) const;
292 
309  virtual UCollationResult compare(const UChar* source, int32_t sourceLength,
310  const UChar* target, int32_t targetLength,
311  UErrorCode &status) const;
312 
324  virtual UCollationResult compare(UCharIterator &sIter,
325  UCharIterator &tIter,
326  UErrorCode &status) const;
327 
341  virtual UCollationResult compareUTF8(const StringPiece &source,
342  const StringPiece &target,
343  UErrorCode &status) const;
344 
359  virtual CollationKey& getCollationKey(const UnicodeString& source,
360  CollationKey& key,
361  UErrorCode& status) const;
362 
378  virtual CollationKey& getCollationKey(const UChar *source,
379  int32_t sourceLength,
380  CollationKey& key,
381  UErrorCode& status) const;
382 
388  virtual int32_t hashCode() const;
389 
400  virtual Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;
401 
407  const UnicodeString& getRules() const;
408 
414  virtual void getVersion(UVersionInfo info) const;
415 
416 #ifndef U_HIDE_DEPRECATED_API
417 
433  int32_t getMaxExpansion(int32_t order) const;
434 #endif /* U_HIDE_DEPRECATED_API */
435 
446  virtual UClassID getDynamicClassID(void) const;
447 
459  static UClassID U_EXPORT2 getStaticClassID(void);
460 
461 #ifndef U_HIDE_DEPRECATED_API
462 
472  uint8_t *cloneRuleData(int32_t &length, UErrorCode &status) const;
473 #endif /* U_HIDE_DEPRECATED_API */
474 
485  int32_t cloneBinary(uint8_t *buffer, int32_t capacity, UErrorCode &status) const;
486 
498  void getRules(UColRuleOption delta, UnicodeString &buffer) const;
499 
507  virtual void setAttribute(UColAttribute attr, UColAttributeValue value,
508  UErrorCode &status);
509 
518  UErrorCode &status) const;
519 
536  virtual Collator &setMaxVariable(UColReorderCode group, UErrorCode &errorCode);
537 
544  virtual UColReorderCode getMaxVariable() const;
545 
562  virtual uint32_t setVariableTop(const UChar *varTop, int32_t len, UErrorCode &status);
563 
579  virtual uint32_t setVariableTop(const UnicodeString &varTop, UErrorCode &status);
580 
592  virtual void setVariableTop(uint32_t varTop, UErrorCode &status);
593 
601  virtual uint32_t getVariableTop(UErrorCode &status) const;
602 
612  virtual UnicodeSet *getTailoredSet(UErrorCode &status) const;
613 
628  virtual int32_t getSortKey(const UnicodeString& source, uint8_t *result,
629  int32_t resultLength) const;
630 
647  virtual int32_t getSortKey(const UChar *source, int32_t sourceLength,
648  uint8_t *result, int32_t resultLength) const;
649 
663  virtual int32_t getReorderCodes(int32_t *dest,
664  int32_t destCapacity,
665  UErrorCode& status) const;
666 
678  virtual void setReorderCodes(const int32_t* reorderCodes,
679  int32_t reorderCodesLength,
680  UErrorCode& status) ;
681 
687  const char *left, int32_t leftLength,
688  const char *right, int32_t rightLength,
689  UErrorCode &errorCode) const;
690 
714  virtual int32_t internalGetShortDefinitionString(const char *locale,
715  char *buffer,
716  int32_t capacity,
717  UErrorCode &status) const;
718 
723  virtual int32_t internalNextSortKeyPart(
724  UCharIterator *iter, uint32_t state[2],
725  uint8_t *dest, int32_t count, UErrorCode &errorCode) const;
726 
732 
733 #ifndef U_HIDE_INTERNAL_API
734 
740  const char *internalGetLocaleID(ULocDataLocaleType type, UErrorCode &errorCode) const;
741 
754  void internalGetContractionsAndExpansions(
755  UnicodeSet *contractions, UnicodeSet *expansions,
756  UBool addPrefixes, UErrorCode &errorCode) const;
757 
763  void internalAddContractions(UChar32 c, UnicodeSet &set, UErrorCode &errorCode) const;
764 
769  void internalBuildTailoring(
770  const UnicodeString &rules,
771  int32_t strength,
772  UColAttributeValue decompositionMode,
773  UParseError *outParseError, UnicodeString *outReason,
774  UErrorCode &errorCode);
775 
778  return dynamic_cast<RuleBasedCollator *>(fromUCollator(uc));
779  }
781  static inline const RuleBasedCollator *rbcFromUCollator(const UCollator *uc) {
782  return dynamic_cast<const RuleBasedCollator *>(fromUCollator(uc));
783  }
784 
789  void internalGetCEs(const UnicodeString &str, UVector64 &ces, UErrorCode &errorCode) const;
790 #endif // U_HIDE_INTERNAL_API
791 
792 protected:
800  virtual void setLocales(const Locale& requestedLocale, const Locale& validLocale, const Locale& actualLocale);
801 
802 private:
803  friend class CollationElementIterator;
804  friend class Collator;
805 
806  RuleBasedCollator(const CollationCacheEntry *entry);
807 
813  enum Attributes {
814  ATTR_VARIABLE_TOP = UCOL_ATTRIBUTE_COUNT,
815  ATTR_LIMIT
816  };
817 
818  void adoptTailoring(CollationTailoring *t, UErrorCode &errorCode);
819 
820  // Both lengths must be <0 or else both must be >=0.
821  UCollationResult doCompare(const UChar *left, int32_t leftLength,
822  const UChar *right, int32_t rightLength,
823  UErrorCode &errorCode) const;
824  UCollationResult doCompare(const uint8_t *left, int32_t leftLength,
825  const uint8_t *right, int32_t rightLength,
826  UErrorCode &errorCode) const;
827 
828  void writeSortKey(const UChar *s, int32_t length,
829  SortKeyByteSink &sink, UErrorCode &errorCode) const;
830 
831  void writeIdenticalLevel(const UChar *s, const UChar *limit,
832  SortKeyByteSink &sink, UErrorCode &errorCode) const;
833 
834  const CollationSettings &getDefaultSettings() const;
835 
836  void setAttributeDefault(int32_t attribute) {
837  explicitlySetAttributes &= ~((uint32_t)1 << attribute);
838  }
839  void setAttributeExplicitly(int32_t attribute) {
840  explicitlySetAttributes |= (uint32_t)1 << attribute;
841  }
842  UBool attributeHasBeenSetExplicitly(int32_t attribute) const {
843  // assert(0 <= attribute < ATTR_LIMIT);
844  return (UBool)((explicitlySetAttributes & ((uint32_t)1 << attribute)) != 0);
845  }
846 
854  UBool isUnsafe(UChar32 c) const;
855 
856  static void computeMaxExpansions(const CollationTailoring *t, UErrorCode &errorCode);
857  UBool initMaxExpansions(UErrorCode &errorCode) const;
858 
859  void setFastLatinOptions(CollationSettings &ownedSettings) const;
860 
861  const CollationData *data;
862  const CollationSettings *settings; // reference-counted
863  const CollationTailoring *tailoring; // alias of cacheEntry->tailoring
864  const CollationCacheEntry *cacheEntry; // reference-counted
865  Locale validLocale;
866  uint32_t explicitlySetAttributes;
867 
868  UBool actualLocaleIsSameAsValid;
869 };
870 
872 
873 #endif // !UCONFIG_NO_COLLATION
874 #endif // TBLCOLL_H