ICU 73.2  73.2
uniset.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) 1999-2016, International Business Machines Corporation
6 * and others. All Rights Reserved.
7 ***************************************************************************
8 * Date Name Description
9 * 10/20/99 alan Creation.
10 ***************************************************************************
11 */
12 
13 #ifndef UNICODESET_H
14 #define UNICODESET_H
15 
16 #include "unicode/utypes.h"
17 
18 #if U_SHOW_CPLUSPLUS_API
19 
20 #include "unicode/ucpmap.h"
21 #include "unicode/unifilt.h"
22 #include "unicode/unistr.h"
23 #include "unicode/uset.h"
24 
30 U_NAMESPACE_BEGIN
31 
32 // Forward Declarations.
33 class BMPSet;
34 class ParsePosition;
35 class RBBIRuleScanner;
36 class SymbolTable;
37 class UnicodeSetStringSpan;
38 class UVector;
39 class RuleCharacterIterator;
40 
285 class U_COMMON_API UnicodeSet final : public UnicodeFilter {
286 private:
291  static constexpr int32_t INITIAL_CAPACITY = 25;
292  // fFlags constant
293  static constexpr uint8_t kIsBogus = 1; // This set is bogus (i.e. not valid)
294 
295  UChar32* list = stackList; // MUST be terminated with HIGH
296  int32_t capacity = INITIAL_CAPACITY; // capacity of list
297  int32_t len = 1; // length of list used; 1 <= len <= capacity
298  uint8_t fFlags = 0; // Bit flag (see constants above)
299 
300  BMPSet *bmpSet = nullptr; // The set is frozen iff either bmpSet or stringSpan is not nullptr.
301  UChar32* buffer = nullptr; // internal buffer, may be nullptr
302  int32_t bufferCapacity = 0; // capacity of buffer
303 
313  char16_t *pat = nullptr;
314  int32_t patLen = 0;
315 
316  UVector* strings = nullptr; // maintained in sorted order
317  UnicodeSetStringSpan *stringSpan = nullptr;
318 
324  UChar32 stackList[INITIAL_CAPACITY];
325 
326 public:
336  inline UBool isBogus(void) const;
337 
354  void setToBogus();
355 
356 public:
357 
358  enum {
363  MIN_VALUE = 0,
364 
369  MAX_VALUE = 0x10ffff
370  };
371 
372  //----------------------------------------------------------------
373  // Constructors &c
374  //----------------------------------------------------------------
375 
376 public:
377 
382  UnicodeSet();
383 
392  UnicodeSet(UChar32 start, UChar32 end);
393 
394 #ifndef U_HIDE_INTERNAL_API
395 
399  kSerialized /* result of serialize() */
400  };
401 
412  UnicodeSet(const uint16_t buffer[], int32_t bufferLen,
413  ESerialization serialization, UErrorCode &status);
414 #endif /* U_HIDE_INTERNAL_API */
415 
424  UnicodeSet(const UnicodeString& pattern,
425  UErrorCode& status);
426 
427 #ifndef U_HIDE_INTERNAL_API
428 
442  UnicodeSet(const UnicodeString& pattern,
443  uint32_t options,
444  const SymbolTable* symbols,
445  UErrorCode& status);
446 #endif /* U_HIDE_INTERNAL_API */
447 
463  UnicodeSet(const UnicodeString& pattern, ParsePosition& pos,
464  uint32_t options,
465  const SymbolTable* symbols,
466  UErrorCode& status);
467 
472  UnicodeSet(const UnicodeSet& o);
473 
478  virtual ~UnicodeSet();
479 
485  UnicodeSet& operator=(const UnicodeSet& o);
486 
498  virtual bool operator==(const UnicodeSet& o) const;
499 
505  inline bool operator!=(const UnicodeSet& o) const;
506 
516  virtual UnicodeSet* clone() const override;
517 
525  virtual int32_t hashCode(void) const;
526 
535  inline static UnicodeSet *fromUSet(USet *uset);
536 
545  inline static const UnicodeSet *fromUSet(const USet *uset);
546 
554  inline USet *toUSet();
555 
556 
564  inline const USet * toUSet() const;
565 
566 
567  //----------------------------------------------------------------
568  // Freezable API
569  //----------------------------------------------------------------
570 
579  inline UBool isFrozen() const;
580 
594  UnicodeSet *freeze();
595 
604  UnicodeSet *cloneAsThawed() const;
605 
606  //----------------------------------------------------------------
607  // Public API
608  //----------------------------------------------------------------
609 
619  UnicodeSet& set(UChar32 start, UChar32 end);
620 
626  static UBool resemblesPattern(const UnicodeString& pattern,
627  int32_t pos);
628 
641  UnicodeSet& applyPattern(const UnicodeString& pattern,
642  UErrorCode& status);
643 
644 #ifndef U_HIDE_INTERNAL_API
645 
663  UnicodeSet& applyPattern(const UnicodeString& pattern,
664  uint32_t options,
665  const SymbolTable* symbols,
666  UErrorCode& status);
667 #endif /* U_HIDE_INTERNAL_API */
668 
702  UnicodeSet& applyPattern(const UnicodeString& pattern,
703  ParsePosition& pos,
704  uint32_t options,
705  const SymbolTable* symbols,
706  UErrorCode& status);
707 
721  virtual UnicodeString& toPattern(UnicodeString& result,
722  UBool escapeUnprintable = false) const override;
723 
746  UnicodeSet& applyIntPropertyValue(UProperty prop,
747  int32_t value,
748  UErrorCode& ec);
749 
779  UnicodeSet& applyPropertyAlias(const UnicodeString& prop,
780  const UnicodeString& value,
781  UErrorCode& ec);
782 
795  virtual int32_t size(void) const;
796 
803  virtual UBool isEmpty(void) const;
804 
809  UBool hasStrings() const;
810 
818  virtual UBool contains(UChar32 c) const override;
819 
828  virtual UBool contains(UChar32 start, UChar32 end) const;
829 
837  UBool contains(const UnicodeString& s) const;
838 
846  virtual UBool containsAll(const UnicodeSet& c) const;
847 
855  UBool containsAll(const UnicodeString& s) const;
856 
865  UBool containsNone(UChar32 start, UChar32 end) const;
866 
874  UBool containsNone(const UnicodeSet& c) const;
875 
883  UBool containsNone(const UnicodeString& s) const;
884 
893  inline UBool containsSome(UChar32 start, UChar32 end) const;
894 
902  inline UBool containsSome(const UnicodeSet& s) const;
903 
911  inline UBool containsSome(const UnicodeString& s) const;
912 
931  int32_t span(const char16_t *s, int32_t length, USetSpanCondition spanCondition) const;
932 
945  inline int32_t span(const UnicodeString &s, int32_t start, USetSpanCondition spanCondition) const;
946 
964  int32_t spanBack(const char16_t *s, int32_t length, USetSpanCondition spanCondition) const;
965 
979  inline int32_t spanBack(const UnicodeString &s, int32_t limit, USetSpanCondition spanCondition) const;
980 
999  int32_t spanUTF8(const char *s, int32_t length, USetSpanCondition spanCondition) const;
1000 
1018  int32_t spanBackUTF8(const char *s, int32_t length, USetSpanCondition spanCondition) const;
1019 
1024  virtual UMatchDegree matches(const Replaceable& text,
1025  int32_t& offset,
1026  int32_t limit,
1027  UBool incremental) override;
1028 
1029 private:
1052  static int32_t matchRest(const Replaceable& text,
1053  int32_t start, int32_t limit,
1054  const UnicodeString& s);
1055 
1065  int32_t findCodePoint(UChar32 c) const;
1066 
1067 public:
1068 
1076  virtual void addMatchSetTo(UnicodeSet& toUnionTo) const override;
1077 
1086  int32_t indexOf(UChar32 c) const;
1087 
1103  UChar32 charAt(int32_t index) const;
1104 
1119  virtual UnicodeSet& add(UChar32 start, UChar32 end);
1120 
1131  UnicodeSet& add(UChar32 c);
1132 
1144  UnicodeSet& add(const UnicodeString& s);
1145 
1146  private:
1152  static int32_t getSingleCP(const UnicodeString& s);
1153 
1154  void _add(const UnicodeString& s);
1155 
1156  public:
1165  UnicodeSet& addAll(const UnicodeString& s);
1166 
1174  UnicodeSet& retainAll(const UnicodeString& s);
1175 
1183  UnicodeSet& complementAll(const UnicodeString& s);
1184 
1192  UnicodeSet& removeAll(const UnicodeString& s);
1193 
1202  static UnicodeSet* U_EXPORT2 createFrom(const UnicodeString& s);
1203 
1204 
1212  static UnicodeSet* U_EXPORT2 createFromAll(const UnicodeString& s);
1213 
1225  virtual UnicodeSet& retain(UChar32 start, UChar32 end);
1226 
1227 
1236  UnicodeSet& retain(UChar32 c);
1237 
1248  UnicodeSet& retain(const UnicodeString &s);
1249 
1263  virtual UnicodeSet& remove(UChar32 start, UChar32 end);
1264 
1275  UnicodeSet& remove(UChar32 c);
1276 
1286  UnicodeSet& remove(const UnicodeString& s);
1287 
1300  virtual UnicodeSet& complement();
1301 
1314  virtual UnicodeSet& complement(UChar32 start, UChar32 end);
1315 
1326  UnicodeSet& complement(UChar32 c);
1327 
1337  UnicodeSet& complement(const UnicodeString& s);
1338 
1351  virtual UnicodeSet& addAll(const UnicodeSet& c);
1352 
1364  virtual UnicodeSet& retainAll(const UnicodeSet& c);
1365 
1377  virtual UnicodeSet& removeAll(const UnicodeSet& c);
1378 
1389  virtual UnicodeSet& complementAll(const UnicodeSet& c);
1390 
1397  virtual UnicodeSet& clear(void);
1398 
1426  UnicodeSet& closeOver(int32_t attribute);
1427 
1434  virtual UnicodeSet &removeAllStrings();
1435 
1443  virtual int32_t getRangeCount(void) const;
1444 
1452  virtual UChar32 getRangeStart(int32_t index) const;
1453 
1461  virtual UChar32 getRangeEnd(int32_t index) const;
1462 
1511  int32_t serialize(uint16_t *dest, int32_t destCapacity, UErrorCode& ec) const;
1512 
1519  virtual UnicodeSet& compact();
1520 
1532  static UClassID U_EXPORT2 getStaticClassID(void);
1533 
1542  virtual UClassID getDynamicClassID(void) const override;
1543 
1544 private:
1545 
1546  // Private API for the USet API
1547 
1548  friend class USetAccess;
1549 
1550  const UnicodeString* getString(int32_t index) const;
1551 
1552  //----------------------------------------------------------------
1553  // RuleBasedTransliterator support
1554  //----------------------------------------------------------------
1555 
1556 private:
1557 
1563  virtual UBool matchesIndexValue(uint8_t v) const override;
1564 
1565 private:
1566  friend class RBBIRuleScanner;
1567 
1568  //----------------------------------------------------------------
1569  // Implementation: Clone as thawed (see ICU4J Freezable)
1570  //----------------------------------------------------------------
1571 
1572  UnicodeSet(const UnicodeSet& o, UBool /* asThawed */);
1573  UnicodeSet& copyFrom(const UnicodeSet& o, UBool asThawed);
1574 
1575  //----------------------------------------------------------------
1576  // Implementation: Pattern parsing
1577  //----------------------------------------------------------------
1578 
1579  void applyPatternIgnoreSpace(const UnicodeString& pattern,
1580  ParsePosition& pos,
1581  const SymbolTable* symbols,
1582  UErrorCode& status);
1583 
1584  void applyPattern(RuleCharacterIterator& chars,
1585  const SymbolTable* symbols,
1586  UnicodeString& rebuiltPat,
1587  uint32_t options,
1588  UnicodeSet& (UnicodeSet::*caseClosure)(int32_t attribute),
1589  int32_t depth,
1590  UErrorCode& ec);
1591 
1592  void closeOverCaseInsensitive(bool simple);
1593  void closeOverAddCaseMappings();
1594 
1595  //----------------------------------------------------------------
1596  // Implementation: Utility methods
1597  //----------------------------------------------------------------
1598 
1599  static int32_t nextCapacity(int32_t minCapacity);
1600 
1601  bool ensureCapacity(int32_t newLen);
1602 
1603  bool ensureBufferCapacity(int32_t newLen);
1604 
1605  void swapBuffers(void);
1606 
1607  UBool allocateStrings(UErrorCode &status);
1608  int32_t stringsSize() const;
1609  UBool stringsContains(const UnicodeString &s) const;
1610 
1611  UnicodeString& _toPattern(UnicodeString& result,
1612  UBool escapeUnprintable) const;
1613 
1614  UnicodeString& _generatePattern(UnicodeString& result,
1615  UBool escapeUnprintable) const;
1616 
1617  static void _appendToPat(UnicodeString& buf, const UnicodeString& s, UBool escapeUnprintable);
1618 
1619  static void _appendToPat(UnicodeString& buf, UChar32 c, UBool escapeUnprintable);
1620 
1621  static void _appendToPat(UnicodeString &result, UChar32 start, UChar32 end,
1622  UBool escapeUnprintable);
1623 
1624  //----------------------------------------------------------------
1625  // Implementation: Fundamental operators
1626  //----------------------------------------------------------------
1627 
1628  void exclusiveOr(const UChar32* other, int32_t otherLen, int8_t polarity);
1629 
1630  void add(const UChar32* other, int32_t otherLen, int8_t polarity);
1631 
1632  void retain(const UChar32* other, int32_t otherLen, int8_t polarity);
1633 
1639  static UBool resemblesPropertyPattern(const UnicodeString& pattern,
1640  int32_t pos);
1641 
1642  static UBool resemblesPropertyPattern(RuleCharacterIterator& chars,
1643  int32_t iterOpts);
1644 
1684  UnicodeSet& applyPropertyPattern(const UnicodeString& pattern,
1685  ParsePosition& ppos,
1686  UErrorCode &ec);
1687 
1688  void applyPropertyPattern(RuleCharacterIterator& chars,
1689  UnicodeString& rebuiltPat,
1690  UErrorCode& ec);
1691 
1696  typedef UBool (*Filter)(UChar32 codePoint, void* context);
1697 
1707  void applyFilter(Filter filter,
1708  void* context,
1709  const UnicodeSet* inclusions,
1710  UErrorCode &status);
1711 
1715  void setPattern(const UnicodeString& newPat) {
1716  setPattern(newPat.getBuffer(), newPat.length());
1717  }
1718  void setPattern(const char16_t *newPat, int32_t newPatLen);
1722  void releasePattern();
1723 
1724  friend class UnicodeSetIterator;
1725 };
1726 
1727 
1728 
1729 inline bool UnicodeSet::operator!=(const UnicodeSet& o) const {
1730  return !operator==(o);
1731 }
1732 
1733 inline UBool UnicodeSet::isFrozen() const {
1734  return (UBool)(bmpSet!=nullptr || stringSpan!=nullptr);
1735 }
1736 
1737 inline UBool UnicodeSet::containsSome(UChar32 start, UChar32 end) const {
1738  return !containsNone(start, end);
1739 }
1740 
1741 inline UBool UnicodeSet::containsSome(const UnicodeSet& s) const {
1742  return !containsNone(s);
1743 }
1744 
1745 inline UBool UnicodeSet::containsSome(const UnicodeString& s) const {
1746  return !containsNone(s);
1747 }
1748 
1749 inline UBool UnicodeSet::isBogus() const {
1750  return (UBool)(fFlags & kIsBogus);
1751 }
1752 
1753 inline UnicodeSet *UnicodeSet::fromUSet(USet *uset) {
1754  return reinterpret_cast<UnicodeSet *>(uset);
1755 }
1756 
1757 inline const UnicodeSet *UnicodeSet::fromUSet(const USet *uset) {
1758  return reinterpret_cast<const UnicodeSet *>(uset);
1759 }
1760 
1761 inline USet *UnicodeSet::toUSet() {
1762  return reinterpret_cast<USet *>(this);
1763 }
1764 
1765 inline const USet *UnicodeSet::toUSet() const {
1766  return reinterpret_cast<const USet *>(this);
1767 }
1768 
1769 inline int32_t UnicodeSet::span(const UnicodeString &s, int32_t start, USetSpanCondition spanCondition) const {
1770  int32_t sLength=s.length();
1771  if(start<0) {
1772  start=0;
1773  } else if(start>sLength) {
1774  start=sLength;
1775  }
1776  return start+span(s.getBuffer()+start, sLength-start, spanCondition);
1777 }
1778 
1779 inline int32_t UnicodeSet::spanBack(const UnicodeString &s, int32_t limit, USetSpanCondition spanCondition) const {
1780  int32_t sLength=s.length();
1781  if(limit<0) {
1782  limit=0;
1783  } else if(limit>sLength) {
1784  limit=sLength;
1785  }
1786  return spanBack(s.getBuffer(), limit, spanCondition);
1787 }
1788 
1789 U_NAMESPACE_END
1790 
1791 #endif /* U_SHOW_CPLUSPLUS_API */
1792 
1793 #endif
icu::UnicodeString::getBuffer
char16_t * getBuffer(int32_t minCapacity)
Get a read/write pointer to the internal buffer.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
icu::UnicodeSet
A mutable set of Unicode characters and multicharacter strings.
Definition: uniset.h:285
icu::UnicodeSet::ESerialization
ESerialization
Definition: uniset.h:398
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:247
icu::Replaceable
Replaceable is an abstract base class representing a string of characters that supports the replaceme...
Definition: rep.h:77
icu::operator==
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
icu::UnicodeMatcher::matchesIndexValue
virtual UBool matchesIndexValue(uint8_t v) const =0
Returns true if this matcher will match a character c, where c & 0xFF == v, at offset,...
U_COMMON_API
#define U_COMMON_API
Definition: utypes.h:300
UProperty
UProperty
Selection constants for Unicode properties.
Definition: uchar.h:195
icu::UnicodeFilter::matches
virtual UMatchDegree matches(const Replaceable &text, int32_t &offset, int32_t limit, UBool incremental) override
Implement UnicodeMatcher API.
icu::SymbolTable
An interface that defines both lookup protocol and parsing of symbolic names.
Definition: symtable.h:59
USetSpanCondition
USetSpanCondition
Argument values for whether span() and similar functions continue while the current character is cont...
Definition: uset.h:184
icu::UnicodeString::length
int32_t length(void) const
Return the length of the UnicodeString object.
Definition: unistr.h:3903
icu::UnicodeFilter::getStaticClassID
static UClassID getStaticClassID()
ICU "poor man's RTTI", returns a UClassID for this class.
icu::UnicodeFilter::clone
virtual UnicodeFilter * clone() const override=0
Clones this object polymorphically.
unifilt.h
C++ API: Unicode Filter.
icu::UnicodeFunctor::getDynamicClassID
virtual UClassID getDynamicClassID(void) const override=0
Returns a unique class ID polymorphically.
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:295
UChar32
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition: umachine.h:435
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
icu::UMatchDegree
UMatchDegree
Constants returned by UnicodeMatcher::matches() indicating the degree of match.
Definition: unimatch.h:33
icu::UnicodeFilter::contains
virtual UBool contains(UChar32 c) const =0
Returns true for characters that are in the selected subset.
ucpmap.h
C API: This file defines an abstract map from Unicode code points to integer values.
icu::operator!=
bool operator!=(const StringPiece &x, const StringPiece &y)
Global operator != for StringPiece.
Definition: stringpiece.h:335
uset.h
C API: Unicode Set.
icu::UnicodeFilter
UnicodeFilter defines a protocol for selecting a subset of the full range (U+0000 to U+10FFFF) of Uni...
Definition: unifilt.h:65
icu::ParsePosition
ParsePosition is a simple class used by Format and its subclasses to keep track of the current positi...
Definition: parsepos.h:52
icu::UnicodeMatcher::toPattern
virtual UnicodeString & toPattern(UnicodeString &result, UBool escapeUnprintable=false) const =0
Returns a string representation of this matcher.
USet
struct USet USet
USet is the C API type corresponding to C++ class UnicodeSet.
Definition: uset.h:50
icu::UnicodeMatcher::addMatchSetTo
virtual void addMatchSetTo(UnicodeSet &toUnionTo) const =0
Union the set of all characters that may be matched by this object into the given set.
unistr.h
C++ API: Unicode String.
INITIAL_CAPACITY
#define INITIAL_CAPACITY
The initial size of an array if it is unspecified.
Definition: RunArrays.h:32