ICU 58.2  58.2
Public Types | Public Member Functions | Static Public Member Functions | Friends
icu::UnicodeSet Class Reference

A mutable set of Unicode characters and multicharacter strings. More...

#include <uniset.h>

Inheritance diagram for icu::UnicodeSet:
icu::UnicodeFilter icu::UnicodeFunctor icu::UnicodeMatcher icu::UObject icu::UMemory

Public Types

enum  { MIN_VALUE = 0, MAX_VALUE = 0x10ffff }
 
enum  ESerialization { kSerialized }
 

Public Member Functions

UBool isBogus (void) const
 Determine if this object contains a valid set. More...
 
void setToBogus ()
 Make this UnicodeSet object invalid. More...
 
 UnicodeSet ()
 Constructs an empty set. More...
 
 UnicodeSet (UChar32 start, UChar32 end)
 Constructs a set containing the given range. More...
 
 UnicodeSet (const uint16_t buffer[], int32_t bufferLen, ESerialization serialization, UErrorCode &status)
 Constructs a set from the output of serialize(). More...
 
 UnicodeSet (const UnicodeString &pattern, UErrorCode &status)
 Constructs a set from the given pattern. More...
 
 UnicodeSet (const UnicodeString &pattern, uint32_t options, const SymbolTable *symbols, UErrorCode &status)
 Constructs a set from the given pattern. More...
 
 UnicodeSet (const UnicodeString &pattern, ParsePosition &pos, uint32_t options, const SymbolTable *symbols, UErrorCode &status)
 Constructs a set from the given pattern. More...
 
 UnicodeSet (const UnicodeSet &o)
 Constructs a set that is identical to the given UnicodeSet. More...
 
virtual ~UnicodeSet ()
 Destructs the set. More...
 
UnicodeSetoperator= (const UnicodeSet &o)
 Assigns this object to be a copy of another. More...
 
virtual UBool operator== (const UnicodeSet &o) const
 Compares the specified object with this set for equality. More...
 
UBool operator!= (const UnicodeSet &o) const
 Compares the specified object with this set for equality. More...
 
virtual UnicodeFunctorclone () const
 Returns a copy of this object. More...
 
virtual int32_t hashCode (void) const
 Returns the hash code value for this set. More...
 
USettoUSet ()
 Produce a USet * pointer for this UnicodeSet. More...
 
const USettoUSet () const
 Produce a const USet * pointer for this UnicodeSet. More...
 
UBool isFrozen () const
 Determines whether the set has been frozen (made immutable) or not. More...
 
UnicodeFunctorfreeze ()
 Freeze the set (make it immutable). More...
 
UnicodeFunctorcloneAsThawed () const
 Clone the set and make the clone mutable. More...
 
UnicodeSetset (UChar32 start, UChar32 end)
 Make this object represent the range start - end. More...
 
UnicodeSetapplyPattern (const UnicodeString &pattern, UErrorCode &status)
 Modifies this set to represent the set specified by the given pattern, ignoring Unicode Pattern_White_Space characters. More...
 
UnicodeSetapplyPattern (const UnicodeString &pattern, uint32_t options, const SymbolTable *symbols, UErrorCode &status)
 Modifies this set to represent the set specified by the given pattern, optionally ignoring Unicode Pattern_White_Space characters. More...
 
UnicodeSetapplyPattern (const UnicodeString &pattern, ParsePosition &pos, uint32_t options, const SymbolTable *symbols, UErrorCode &status)
 Parses the given pattern, starting at the given position. More...
 
virtual UnicodeStringtoPattern (UnicodeString &result, UBool escapeUnprintable=FALSE) const
 Returns a string representation of this set. More...
 
UnicodeSetapplyIntPropertyValue (UProperty prop, int32_t value, UErrorCode &ec)
 Modifies this set to contain those code points which have the given value for the given binary or enumerated property, as returned by u_getIntPropertyValue. More...
 
UnicodeSetapplyPropertyAlias (const UnicodeString &prop, const UnicodeString &value, UErrorCode &ec)
 Modifies this set to contain those code points which have the given value for the given property. More...
 
virtual int32_t size (void) const
 Returns the number of elements in this set (its cardinality). More...
 
virtual UBool isEmpty (void) const
 Returns true if this set contains no elements. More...
 
virtual UBool contains (UChar32 c) const
 Returns true if this set contains the given character. More...
 
virtual UBool contains (UChar32 start, UChar32 end) const
 Returns true if this set contains every character of the given range. More...
 
UBool contains (const UnicodeString &s) const
 Returns true if this set contains the given multicharacter string. More...
 
virtual UBool containsAll (const UnicodeSet &c) const
 Returns true if this set contains all the characters and strings of the given set. More...
 
UBool containsAll (const UnicodeString &s) const
 Returns true if this set contains all the characters of the given string. More...
 
UBool containsNone (UChar32 start, UChar32 end) const
 Returns true if this set contains none of the characters of the given range. More...
 
UBool containsNone (const UnicodeSet &c) const
 Returns true if this set contains none of the characters and strings of the given set. More...
 
UBool containsNone (const UnicodeString &s) const
 Returns true if this set contains none of the characters of the given string. More...
 
UBool containsSome (UChar32 start, UChar32 end) const
 Returns true if this set contains one or more of the characters in the given range. More...
 
UBool containsSome (const UnicodeSet &s) const
 Returns true if this set contains one or more of the characters and strings of the given set. More...
 
UBool containsSome (const UnicodeString &s) const
 Returns true if this set contains one or more of the characters of the given string. More...
 
int32_t span (const UChar *s, int32_t length, USetSpanCondition spanCondition) const
 Returns the length of the initial substring of the input string which consists only of characters and strings that are contained in this set (USET_SPAN_CONTAINED, USET_SPAN_SIMPLE), or only of characters and strings that are not contained in this set (USET_SPAN_NOT_CONTAINED). More...
 
int32_t span (const UnicodeString &s, int32_t start, USetSpanCondition spanCondition) const
 Returns the end of the substring of the input string according to the USetSpanCondition. More...
 
int32_t spanBack (const UChar *s, int32_t length, USetSpanCondition spanCondition) const
 Returns the start of the trailing substring of the input string which consists only of characters and strings that are contained in this set (USET_SPAN_CONTAINED, USET_SPAN_SIMPLE), or only of characters and strings that are not contained in this set (USET_SPAN_NOT_CONTAINED). More...
 
int32_t spanBack (const UnicodeString &s, int32_t limit, USetSpanCondition spanCondition) const
 Returns the start of the substring of the input string according to the USetSpanCondition. More...
 
int32_t spanUTF8 (const char *s, int32_t length, USetSpanCondition spanCondition) const
 Returns the length of the initial substring of the input string which consists only of characters and strings that are contained in this set (USET_SPAN_CONTAINED, USET_SPAN_SIMPLE), or only of characters and strings that are not contained in this set (USET_SPAN_NOT_CONTAINED). More...
 
int32_t spanBackUTF8 (const char *s, int32_t length, USetSpanCondition spanCondition) const
 Returns the start of the trailing substring of the input string which consists only of characters and strings that are contained in this set (USET_SPAN_CONTAINED, USET_SPAN_SIMPLE), or only of characters and strings that are not contained in this set (USET_SPAN_NOT_CONTAINED). More...
 
virtual UMatchDegree matches (const Replaceable &text, int32_t &offset, int32_t limit, UBool incremental)
 Implement UnicodeMatcher::matches() More...
 
virtual void addMatchSetTo (UnicodeSet &toUnionTo) const
 Implementation of UnicodeMatcher API. More...
 
int32_t indexOf (UChar32 c) const
 Returns the index of the given character within this set, where the set is ordered by ascending code point. More...
 
UChar32 charAt (int32_t index) const
 Returns the character at the given index within this set, where the set is ordered by ascending code point. More...
 
virtual UnicodeSetadd (UChar32 start, UChar32 end)
 Adds the specified range to this set if it is not already present. More...
 
UnicodeSetadd (UChar32 c)
 Adds the specified character to this set if it is not already present. More...
 
UnicodeSetadd (const UnicodeString &s)
 Adds the specified multicharacter to this set if it is not already present. More...
 
UnicodeSetaddAll (const UnicodeString &s)
 Adds each of the characters in this string to the set. More...
 
UnicodeSetretainAll (const UnicodeString &s)
 Retains EACH of the characters in this string. More...
 
UnicodeSetcomplementAll (const UnicodeString &s)
 Complement EACH of the characters in this string. More...
 
UnicodeSetremoveAll (const UnicodeString &s)
 Remove EACH of the characters in this string. More...
 
virtual UnicodeSetretain (UChar32 start, UChar32 end)
 Retain only the elements in this set that are contained in the specified range. More...
 
UnicodeSetretain (UChar32 c)
 Retain the specified character from this set if it is present. More...
 
virtual UnicodeSetremove (UChar32 start, UChar32 end)
 Removes the specified range from this set if it is present. More...
 
UnicodeSetremove (UChar32 c)
 Removes the specified character from this set if it is present. More...
 
UnicodeSetremove (const UnicodeString &s)
 Removes the specified string from this set if it is present. More...
 
virtual UnicodeSetcomplement (void)
 Inverts this set. More...
 
virtual UnicodeSetcomplement (UChar32 start, UChar32 end)
 Complements the specified range in this set. More...
 
UnicodeSetcomplement (UChar32 c)
 Complements the specified character in this set. More...
 
UnicodeSetcomplement (const UnicodeString &s)
 Complement the specified string in this set. More...
 
virtual UnicodeSetaddAll (const UnicodeSet &c)
 Adds all of the elements in the specified set to this set if they're not already present. More...
 
virtual UnicodeSetretainAll (const UnicodeSet &c)
 Retains only the elements in this set that are contained in the specified set. More...
 
virtual UnicodeSetremoveAll (const UnicodeSet &c)
 Removes from this set all of its elements that are contained in the specified set. More...
 
virtual UnicodeSetcomplementAll (const UnicodeSet &c)
 Complements in this set all elements contained in the specified set. More...
 
virtual UnicodeSetclear (void)
 Removes all of the elements from this set. More...
 
UnicodeSetcloseOver (int32_t attribute)
 Close this set over the given attribute. More...
 
virtual UnicodeSetremoveAllStrings ()
 Remove all strings from this set. More...
 
virtual int32_t getRangeCount (void) const
 Iteration method that returns the number of ranges contained in this set. More...
 
virtual UChar32 getRangeStart (int32_t index) const
 Iteration method that returns the first character in the specified range of this set. More...
 
virtual UChar32 getRangeEnd (int32_t index) const
 Iteration method that returns the last character in the specified range of this set. More...
 
int32_t serialize (uint16_t *dest, int32_t destCapacity, UErrorCode &ec) const
 Serializes this set into an array of 16-bit integers. More...
 
virtual UnicodeSetcompact ()
 Reallocate this objects internal structures to take up the least possible space, without changing this object's value. More...
 
virtual UClassID getDynamicClassID (void) const
 Implement UnicodeFunctor API. More...
 
- Public Member Functions inherited from icu::UnicodeFilter
virtual ~UnicodeFilter ()
 Destructor. More...
 
virtual UnicodeMatchertoMatcher () const
 UnicodeFunctor API. More...
 
virtual void setData (const TransliterationRuleData *)
 UnicodeFunctor API. More...
 
- Public Member Functions inherited from icu::UnicodeFunctor
virtual ~UnicodeFunctor ()
 Destructor. More...
 
virtual UnicodeReplacertoReplacer () const
 Cast 'this' to a UnicodeReplacer* pointer and return the pointer, or null if this is not a UnicodeReplacer*. More...
 
- Public Member Functions inherited from icu::UObject
virtual ~UObject ()
 Destructor. More...
 
- Public Member Functions inherited from icu::UnicodeMatcher
virtual ~UnicodeMatcher ()
 Destructor. More...
 

Static Public Member Functions

static UnicodeSetfromUSet (USet *uset)
 Get a UnicodeSet pointer from a USet. More...
 
static const UnicodeSetfromUSet (const USet *uset)
 Get a UnicodeSet pointer from a const USet. More...
 
static UBool resemblesPattern (const UnicodeString &pattern, int32_t pos)
 Return true if the given position, in the given pattern, appears to be the start of a UnicodeSet pattern. More...
 
static UnicodeSetcreateFrom (const UnicodeString &s)
 Makes a set from a multicharacter string. More...
 
static UnicodeSetcreateFromAll (const UnicodeString &s)
 Makes a set from each of the characters in the string. More...
 
static UClassID getStaticClassID (void)
 Return the class ID for this class. More...
 
- Static Public Member Functions inherited from icu::UnicodeFilter
static UClassID getStaticClassID ()
 ICU "poor man's RTTI", returns a UClassID for this class. More...
 
- Static Public Member Functions inherited from icu::UnicodeFunctor
static UClassID getStaticClassID (void)
 Return the class ID for this class. More...
 

Friends

class USetAccess
 
class RBBIRuleScanner
 
class UnicodeSetIterator
 
void UnicodeSet_initInclusion (int32_t src, UErrorCode &status)
 

Detailed Description

A mutable set of Unicode characters and multicharacter strings.

Objects of this class represent character classes used in regular expressions. A character specifies a subset of Unicode code points. Legal code points are U+0000 to U+10FFFF, inclusive.

The UnicodeSet class is not designed to be subclassed.

UnicodeSet supports two APIs. The first is the operand API that allows the caller to modify the value of a UnicodeSet object. It conforms to Java 2's java.util.Set interface, although UnicodeSet does not actually implement that interface. All methods of Set are supported, with the modification that they take a character range or single character instead of an Object, and they take a UnicodeSet instead of a Collection. The operand API may be thought of in terms of boolean logic: a boolean OR is implemented by add, a boolean AND is implemented by retain, a boolean XOR is implemented by complement taking an argument, and a boolean NOT is implemented by complement with no argument. In terms of traditional set theory function names, add is a union, retain is an intersection, remove is an asymmetric difference, and complement with no argument is a set complement with respect to the superset range MIN_VALUE-MAX_VALUE

The second API is the applyPattern()/toPattern() API from the java.text.Format-derived classes. Unlike the methods that add characters, add categories, and control the logic of the set, the method applyPattern() sets all attributes of a UnicodeSet at once, based on a string pattern.

Pattern syntax

Patterns are accepted by the constructors and the applyPattern() methods and returned by the toPattern() method. These patterns follow a syntax similar to that employed by version 8 regular expression character classes. Here are some simple examples:

[] No characters
[a] The character 'a'
[ae] The characters 'a' and 'e'
[a-e] The characters 'a' through 'e' inclusive, in Unicode code point order
[\u4E01] The character U+4E01
[a{ab}{ac}] The character 'a' and the multicharacter strings "ab" and "ac"
[\p{Lu}] All characters in the general category Uppercase Letter

Any character may be preceded by a backslash in order to remove any special meaning. White space characters, as defined by UCharacter.isWhitespace(), are ignored, unless they are escaped.

Property patterns specify a set of characters having a certain property as defined by the Unicode standard. Both the POSIX-like "[:Lu:]" and the Perl-like syntax "\\p{Lu}" are recognized. For a complete list of supported property patterns, see the User's Guide for UnicodeSet at http://icu-project.org/userguide/unicodeSet.html. Actual determination of property data is defined by the underlying Unicode database as implemented by UCharacter.

Patterns specify individual characters, ranges of characters, and Unicode property sets. When elements are concatenated, they specify their union. To complement a set, place a '^' immediately after the opening '['. Property patterns are inverted by modifying their delimiters; "[:^foo]" and "\\P{foo}". In any other location, '^' has no special meaning.

Ranges are indicated by placing two a '-' between two characters, as in "a-z". This specifies the range of all characters from the left to the right, in Unicode order. If the left character is greater than or equal to the right character it is a syntax error. If a '-' occurs as the first character after the opening '[' or '[^', or if it occurs as the last character before the closing ']', then it is taken as a literal. Thus "[a\-b]", "[-ab]", and "[ab-]" all indicate the same set of three characters, 'a', 'b', and '-'.

Sets may be intersected using the '&' operator or the asymmetric set difference may be taken using the '-' operator, for example, "[[:L:]&[\\u0000-\\u0FFF]]" indicates the set of all Unicode letters with values less than 4096. Operators ('&' and '|') have equal precedence and bind left-to-right. Thus "[[:L:]-[a-z]-[\\u0100-\\u01FF]]" is equivalent to "[[[:L:]-[a-z]]-[\\u0100-\\u01FF]]". This only really matters for difference; intersection is commutative.

[a]The set containing 'a'
[a-z]The set containing 'a' through 'z' and all letters in between, in Unicode order
[^a-z]The set containing all characters but 'a' through 'z', that is, U+0000 through 'a'-1 and 'z'+1 through U+10FFFF
[[pat1][pat2]] The union of sets specified by pat1 and pat2
[[pat1]&[pat2]] The intersection of sets specified by pat1 and pat2
[[pat1]-[pat2]] The asymmetric difference of sets specified by pat1 and pat2
[:Lu:] or \p{Lu} The set of characters having the specified Unicode property; in this case, Unicode uppercase letters
[:^Lu:] or \P{Lu} The set of characters not having the given Unicode property

Warning: you cannot add an empty string ("") to a UnicodeSet.

Formal syntax

pattern :=  ('[' '^'? item* ']') | property
item :=  char | (char '-' char) | pattern-expr
pattern-expr :=  pattern | pattern-expr pattern | pattern-expr op pattern
op :=  '&' | '-'
special :=  '[' | ']' | '-'
char :=  any character that is not special
| ('\'
any character)
| ('\u' hex hex hex hex)
hex :=  any character for which Character.digit(c, 16) returns a non-negative result
property :=  a Unicode property set pattern


Legend:
a := b   a may be replaced by b
a? zero or one instance of a
a* one or more instances of a
a | b either a or b
'a' the literal string between the quotes

Note:

Author
Alan Liu
Stable:
ICU 2.0

Definition at line 278 of file uniset.h.

Member Enumeration Documentation

anonymous enum
Enumerator
MIN_VALUE 

Minimum value that can be stored in a UnicodeSet.

Stable:
ICU 2.4
MAX_VALUE 

Maximum value that can be stored in a UnicodeSet.

Stable:
ICU 2.4

Definition at line 338 of file uniset.h.

Internal:
Do not use.

This API is for internal use only.

Definition at line 378 of file uniset.h.

Constructor & Destructor Documentation

icu::UnicodeSet::UnicodeSet ( )

Constructs an empty set.

Stable:
ICU 2.0
icu::UnicodeSet::UnicodeSet ( UChar32  start,
UChar32  end 
)

Constructs a set containing the given range.

If end < start then an empty set is created.

Parameters
startfirst character, inclusive, of range
endlast character, inclusive, of range
Stable:
ICU 2.4
icu::UnicodeSet::UnicodeSet ( const uint16_t  buffer[],
int32_t  bufferLen,
ESerialization  serialization,
UErrorCode status 
)

Constructs a set from the output of serialize().

Parameters
bufferthe 16 bit array
bufferLenthe original length returned from serialize()
serializationthe value 'kSerialized'
statuserror code
Internal:
Do not use. This API is for internal use only.
icu::UnicodeSet::UnicodeSet ( const UnicodeString pattern,
UErrorCode status 
)

Constructs a set from the given pattern.

See the class description for the syntax of the pattern language.

Parameters
patterna string specifying what characters are in the set
statusreturns U_ILLEGAL_ARGUMENT_ERROR if the pattern contains a syntax error.
Stable:
ICU 2.0
icu::UnicodeSet::UnicodeSet ( const UnicodeString pattern,
uint32_t  options,
const SymbolTable symbols,
UErrorCode status 
)

Constructs a set from the given pattern.

See the class description for the syntax of the pattern language.

Parameters
patterna string specifying what characters are in the set
optionsbitmask for options to apply to the pattern. Valid options are USET_IGNORE_SPACE and USET_CASE_INSENSITIVE.
symbolsa symbol table mapping variable names to values and stand-in characters to UnicodeSets; may be NULL
statusreturns U_ILLEGAL_ARGUMENT_ERROR if the pattern contains a syntax error.
Internal:
Do not use. This API is for internal use only.
icu::UnicodeSet::UnicodeSet ( const UnicodeString pattern,
ParsePosition pos,
uint32_t  options,
const SymbolTable symbols,
UErrorCode status 
)

Constructs a set from the given pattern.

See the class description for the syntax of the pattern language.

Parameters
patterna string specifying what characters are in the set
poson input, the position in pattern at which to start parsing. On output, the position after the last character parsed.
optionsbitmask for options to apply to the pattern. Valid options are USET_IGNORE_SPACE and USET_CASE_INSENSITIVE.
symbolsa symbol table mapping variable names to values and stand-in characters to UnicodeSets; may be NULL
statusinput-output error code
Stable:
ICU 2.8
icu::UnicodeSet::UnicodeSet ( const UnicodeSet o)

Constructs a set that is identical to the given UnicodeSet.

Stable:
ICU 2.0
virtual icu::UnicodeSet::~UnicodeSet ( )
virtual

Destructs the set.

Stable:
ICU 2.0

Member Function Documentation

virtual UnicodeSet& icu::UnicodeSet::add ( UChar32  start,
UChar32  end 
)
virtual

Adds the specified range to this set if it is not already present.

If this set already contains the specified range, the call leaves this set unchanged. If end > start then an empty range is added, leaving the set unchanged. This is equivalent to a boolean logic OR, or a set UNION. A frozen set will not be modified.

Parameters
startfirst character, inclusive, of range to be added to this set.
endlast character, inclusive, of range to be added to this set.
Stable:
ICU 2.0
UnicodeSet& icu::UnicodeSet::add ( UChar32  c)

Adds the specified character to this set if it is not already present.

If this set already contains the specified character, the call leaves this set unchanged. A frozen set will not be modified.

Stable:
ICU 2.0
UnicodeSet& icu::UnicodeSet::add ( const UnicodeString s)

Adds the specified multicharacter to this set if it is not already present.

If this set already contains the multicharacter, the call leaves this set unchanged. Thus "ch" => {"ch"}
Warning: you cannot add an empty string ("") to a UnicodeSet. A frozen set will not be modified.

Parameters
sthe source string
Returns
this object, for chaining
Stable:
ICU 2.4
UnicodeSet& icu::UnicodeSet::addAll ( const UnicodeString s)

Adds each of the characters in this string to the set.

Thus "ch" => {"c", "h"} If this set already any particular character, it has no effect on that character. A frozen set will not be modified.

Parameters
sthe source string
Returns
this object, for chaining
Stable:
ICU 2.4
virtual UnicodeSet& icu::UnicodeSet::addAll ( const UnicodeSet c)
virtual

Adds all of the elements in the specified set to this set if they're not already present.

This operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. A frozen set will not be modified.

Parameters
cset whose elements are to be added to this set.
See also
add(UChar32, UChar32)
Stable:
ICU 2.0
virtual void icu::UnicodeSet::addMatchSetTo ( UnicodeSet toUnionTo) const
virtual

Implementation of UnicodeMatcher API.

Union the set of all characters that may be matched by this object into the given set.

Parameters
toUnionTothe set into which to union the source characters
Stable:
ICU 2.4

Implements icu::UnicodeMatcher.

UnicodeSet& icu::UnicodeSet::applyIntPropertyValue ( UProperty  prop,
int32_t  value,
UErrorCode ec 
)

Modifies this set to contain those code points which have the given value for the given binary or enumerated property, as returned by u_getIntPropertyValue.

Prior contents of this set are lost. A frozen set will not be modified.

Parameters
propa property in the range UCHAR_BIN_START..UCHAR_BIN_LIMIT-1 or UCHAR_INT_START..UCHAR_INT_LIMIT-1 or UCHAR_MASK_START..UCHAR_MASK_LIMIT-1.
valuea value in the range u_getIntPropertyMinValue(prop).. u_getIntPropertyMaxValue(prop), with one exception. If prop is UCHAR_GENERAL_CATEGORY_MASK, then value should not be a UCharCategory, but rather a mask value produced by U_GET_GC_MASK(). This allows grouped categories such as [:L:] to be represented.
ecerror code input/output parameter
Returns
a reference to this set
Stable:
ICU 2.4
UnicodeSet& icu::UnicodeSet::applyPattern ( const UnicodeString pattern,
UErrorCode status 
)

Modifies this set to represent the set specified by the given pattern, ignoring Unicode Pattern_White_Space characters.

See the class description for the syntax of the pattern language. A frozen set will not be modified.

Parameters
patterna string specifying what characters are in the set
statusreturns U_ILLEGAL_ARGUMENT_ERROR if the pattern contains a syntax error. Empties the set passed before applying the pattern.
Returns
a reference to this
Stable:
ICU 2.0
UnicodeSet& icu::UnicodeSet::applyPattern ( const UnicodeString pattern,
uint32_t  options,
const SymbolTable symbols,
UErrorCode status 
)

Modifies this set to represent the set specified by the given pattern, optionally ignoring Unicode Pattern_White_Space characters.

See the class description for the syntax of the pattern language. A frozen set will not be modified.

Parameters
patterna string specifying what characters are in the set
optionsbitmask for options to apply to the pattern. Valid options are USET_IGNORE_SPACE and USET_CASE_INSENSITIVE.
symbolsa symbol table mapping variable names to values and stand-ins to UnicodeSets; may be NULL
statusreturns U_ILLEGAL_ARGUMENT_ERROR if the pattern contains a syntax error. Empties the set passed before applying the pattern.
Returns
a reference to this
Internal:
Do not use. This API is for internal use only.
UnicodeSet& icu::UnicodeSet::applyPattern ( const UnicodeString pattern,
ParsePosition pos,
uint32_t  options,
const SymbolTable symbols,
UErrorCode status 
)

Parses the given pattern, starting at the given position.

The character at pattern.charAt(pos.getIndex()) must be '[', or the parse fails. Parsing continues until the corresponding closing ']'. If a syntax error is encountered between the opening and closing brace, the parse fails. Upon return from a successful parse, the ParsePosition is updated to point to the character following the closing ']', and a StringBuffer containing a pairs list for the parsed pattern is returned. This method calls itself recursively to parse embedded subpatterns. Empties the set passed before applying the pattern. A frozen set will not be modified.

Parameters
patternthe string containing the pattern to be parsed. The portion of the string from pos.getIndex(), which must be a '[', to the corresponding closing ']', is parsed.
posupon entry, the position at which to being parsing. The character at pattern.charAt(pos.getIndex()) must be a '['. Upon return from a successful parse, pos.getIndex() is either the character after the closing ']' of the parsed pattern, or pattern.length() if the closing ']' is the last character of the pattern string.
optionsbitmask for options to apply to the pattern. Valid options are USET_IGNORE_SPACE and USET_CASE_INSENSITIVE.
symbolsa symbol table mapping variable names to values and stand-ins to UnicodeSets; may be NULL
statusreturns U_ILLEGAL_ARGUMENT_ERROR if the pattern contains a syntax error.
Returns
a reference to this
Stable:
ICU 2.8
UnicodeSet& icu::UnicodeSet::applyPropertyAlias ( const UnicodeString prop,
const UnicodeString value,
UErrorCode ec 
)

Modifies this set to contain those code points which have the given value for the given property.

Prior contents of this set are lost. A frozen set will not be modified.

Parameters
propa property alias, either short or long. The name is matched loosely. See PropertyAliases.txt for names and a description of loose matching. If the value string is empty, then this string is interpreted as either a General_Category value alias, a Script value alias, a binary property alias, or a special ID. Special IDs are matched loosely and correspond to the following sets:

"ANY" = [\u0000-\U0010FFFF], "ASCII" = [\u0000-\u007F], "Assigned" = [:^Cn:].

Parameters
valuea value alias, either short or long. The name is matched loosely. See PropertyValueAliases.txt for names and a description of loose matching. In addition to aliases listed, numeric values and canonical combining classes may be expressed numerically, e.g., ("nv", "0.5") or ("ccc", "220"). The value string may also be empty.
ecerror code input/output parameter
Returns
a reference to this set
Stable:
ICU 2.4
UChar32 icu::UnicodeSet::charAt ( int32_t  index) const

Returns the character at the given index within this set, where the set is ordered by ascending code point.

If the index is out of range, return (UChar32)-1. The inverse of this method is indexOf().

Parameters
indexan index from 0..size()-1
Returns
the character at the given index, or (UChar32)-1.
Stable:
ICU 2.4
virtual UnicodeSet& icu::UnicodeSet::clear ( void  )
virtual

Removes all of the elements from this set.

This set will be empty after this call returns. A frozen set will not be modified.

Stable:
ICU 2.0
virtual UnicodeFunctor* icu::UnicodeSet::clone ( ) const
virtual

Returns a copy of this object.

All UnicodeFunctor objects have to support cloning in order to allow classes using UnicodeFunctors, such as Transliterator, to implement cloning. If this set is frozen, then the clone will be frozen as well. Use cloneAsThawed() for a mutable clone of a frozen set.

See also
cloneAsThawed
Stable:
ICU 2.0

Implements icu::UnicodeFunctor.

UnicodeFunctor* icu::UnicodeSet::cloneAsThawed ( ) const

Clone the set and make the clone mutable.

See the ICU4J Freezable interface for details.

Returns
the mutable clone
See also
freeze
isFrozen
Stable:
ICU 3.8
UnicodeSet& icu::UnicodeSet::closeOver ( int32_t  attribute)

Close this set over the given attribute.

For the attribute USET_CASE, the result is to modify this set so that:

  1. For each character or string 'a' in this set, all strings or characters 'b' such that foldCase(a) == foldCase(b) are added to this set.
  2. For each string 'e' in the resulting set, if e != foldCase(e), 'e' will be removed.

Example: [aq\u00DF{Bc}{bC}{Fi}] => [aAqQ\u00DF\uFB01{ss}{bc}{fi}]

(Here foldCase(x) refers to the operation u_strFoldCase, and a == b denotes that the contents are the same, not pointer comparison.)

A frozen set will not be modified.

Parameters
attributebitmask for attributes to close over. Currently only the USET_CASE bit is supported. Any undefined bits are ignored.
Returns
a reference to this set.
Stable:
ICU 4.2
virtual UnicodeSet& icu::UnicodeSet::compact ( )
virtual

Reallocate this objects internal structures to take up the least possible space, without changing this object's value.

A frozen set will not be modified.

Stable:
ICU 2.4
virtual UnicodeSet& icu::UnicodeSet::complement ( void  )
virtual

Inverts this set.

This operation modifies this set so that its value is its complement. This is equivalent to complement(MIN_VALUE, MAX_VALUE). A frozen set will not be modified.

Stable:
ICU 2.0
virtual UnicodeSet& icu::UnicodeSet::complement ( UChar32  start,
UChar32  end 
)
virtual

Complements the specified range in this set.

Any character in the range will be removed if it is in this set, or will be added if it is not in this set. If end > start then an empty range is complemented, leaving the set unchanged. This is equivalent to a boolean logic XOR. A frozen set will not be modified.

Parameters
startfirst character, inclusive, of range to be removed from this set.
endlast character, inclusive, of range to be removed from this set.
Stable:
ICU 2.0
UnicodeSet& icu::UnicodeSet::complement ( UChar32  c)

Complements the specified character in this set.

The character will be removed if it is in this set, or will be added if it is not in this set. A frozen set will not be modified.

Stable:
ICU 2.0
UnicodeSet& icu::UnicodeSet::complement ( const UnicodeString s)

Complement the specified string in this set.

The set will not contain the specified string once the call returns.
Warning: you cannot add an empty string ("") to a UnicodeSet. A frozen set will not be modified.

Parameters
sthe string to complement
Returns
this object, for chaining
Stable:
ICU 2.4
UnicodeSet& icu::UnicodeSet::complementAll ( const UnicodeString s)

Complement EACH of the characters in this string.

Note: "ch" == {"c", "h"} If this set already any particular character, it has no effect on that character. A frozen set will not be modified.

Parameters
sthe source string
Returns
this object, for chaining
Stable:
ICU 2.4
virtual UnicodeSet& icu::UnicodeSet::complementAll ( const UnicodeSet c)
virtual

Complements in this set all elements contained in the specified set.

Any character in the other set will be removed if it is in this set, or will be added if it is not in this set. A frozen set will not be modified.

Parameters
cset that defines which elements will be xor'ed from this set.
Stable:
ICU 2.4
virtual UBool icu::UnicodeSet::contains ( UChar32  c) const
virtual

Returns true if this set contains the given character.

This function works faster with a frozen set.

Parameters
ccharacter to be checked for containment
Returns
true if the test condition is met
Stable:
ICU 2.0

Implements icu::UnicodeFilter.

virtual UBool icu::UnicodeSet::contains ( UChar32  start,
UChar32  end 
) const
virtual

Returns true if this set contains every character of the given range.

Parameters
startfirst character, inclusive, of the range
endlast character, inclusive, of the range
Returns
true if the test condition is met
Stable:
ICU 2.0
UBool icu::UnicodeSet::contains ( const UnicodeString s) const

Returns true if this set contains the given multicharacter string.

Parameters
sstring to be checked for containment
Returns
true if this set contains the specified string
Stable:
ICU 2.4
virtual UBool icu::UnicodeSet::containsAll ( const UnicodeSet c) const
virtual

Returns true if this set contains all the characters and strings of the given set.

Parameters
cset to be checked for containment
Returns
true if the test condition is met
Stable:
ICU 2.4
UBool icu::UnicodeSet::containsAll ( const UnicodeString s) const

Returns true if this set contains all the characters of the given string.

Parameters
sstring containing characters to be checked for containment
Returns
true if the test condition is met
Stable:
ICU 2.4
UBool icu::UnicodeSet::containsNone ( UChar32  start,
UChar32  end 
) const

Returns true if this set contains none of the characters of the given range.

Parameters
startfirst character, inclusive, of the range
endlast character, inclusive, of the range
Returns
true if the test condition is met
Stable:
ICU 2.4
UBool icu::UnicodeSet::containsNone ( const UnicodeSet c) const

Returns true if this set contains none of the characters and strings of the given set.

Parameters
cset to be checked for containment
Returns
true if the test condition is met
Stable:
ICU 2.4
UBool icu::UnicodeSet::containsNone ( const UnicodeString s) const

Returns true if this set contains none of the characters of the given string.

Parameters
sstring containing characters to be checked for containment
Returns
true if the test condition is met
Stable:
ICU 2.4
UBool icu::UnicodeSet::containsSome ( UChar32  start,
UChar32  end 
) const
inline

Returns true if this set contains one or more of the characters in the given range.

Parameters
startfirst character, inclusive, of the range
endlast character, inclusive, of the range
Returns
true if the condition is met
Stable:
ICU 2.4

Definition at line 1661 of file uniset.h.

UBool icu::UnicodeSet::containsSome ( const UnicodeSet s) const
inline

Returns true if this set contains one or more of the characters and strings of the given set.

Parameters
sThe set to be checked for containment
Returns
true if the condition is met
Stable:
ICU 2.4

Definition at line 1665 of file uniset.h.

UBool icu::UnicodeSet::containsSome ( const UnicodeString s) const
inline

Returns true if this set contains one or more of the characters of the given string.

Parameters
sstring containing characters to be checked for containment
Returns
true if the condition is met
Stable:
ICU 2.4

Definition at line 1669 of file uniset.h.

static UnicodeSet* icu::UnicodeSet::createFrom ( const UnicodeString s)
static

Makes a set from a multicharacter string.

Thus "ch" => {"ch"}
Warning: you cannot add an empty string ("") to a UnicodeSet.

Parameters
sthe source string
Returns
a newly created set containing the given string. The caller owns the return object and is responsible for deleting it.
Stable:
ICU 2.4
static UnicodeSet* icu::UnicodeSet::createFromAll ( const UnicodeString s)
static

Makes a set from each of the characters in the string.

Thus "ch" => {"c", "h"}

Parameters
sthe source string
Returns
a newly created set containing the given characters The caller owns the return object and is responsible for deleting it.
Stable:
ICU 2.4
UnicodeFunctor* icu::UnicodeSet::freeze ( )

Freeze the set (make it immutable).

Once frozen, it cannot be unfrozen and is therefore thread-safe until it is deleted. See the ICU4J Freezable interface for details. Freezing the set may also make some operations faster, for example contains() and span(). A frozen set will not be modified. (It remains frozen.)

Returns
this set.
See also
isFrozen
cloneAsThawed
Stable:
ICU 3.8
UnicodeSet * icu::UnicodeSet::fromUSet ( USet uset)
inlinestatic

Get a UnicodeSet pointer from a USet.

Parameters
useta USet (the ICU plain C type for UnicodeSet)
Returns
the corresponding UnicodeSet pointer.
Stable:
ICU 4.2

Definition at line 1677 of file uniset.h.

const UnicodeSet * icu::UnicodeSet::fromUSet ( const USet uset)
inlinestatic

Get a UnicodeSet pointer from a const USet.

Parameters
useta const USet (the ICU plain C type for UnicodeSet)
Returns
the corresponding UnicodeSet pointer.
Stable:
ICU 4.2

Definition at line 1681 of file uniset.h.

virtual UClassID icu::UnicodeSet::getDynamicClassID ( void  ) const
virtual

Implement UnicodeFunctor API.

Returns
The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs.
Stable:
ICU 2.4

Implements icu::UnicodeFunctor.

virtual int32_t icu::UnicodeSet::getRangeCount ( void  ) const
virtual

Iteration method that returns the number of ranges contained in this set.

See also
getRangeStart
getRangeEnd
Stable:
ICU 2.4
virtual UChar32 icu::UnicodeSet::getRangeEnd ( int32_t  index) const
virtual

Iteration method that returns the last character in the specified range of this set.

See also
getRangeStart
getRangeEnd
Stable:
ICU 2.4
virtual UChar32 icu::UnicodeSet::getRangeStart ( int32_t  index) const
virtual

Iteration method that returns the first character in the specified range of this set.

See also
getRangeCount
getRangeEnd
Stable:
ICU 2.4
static UClassID icu::UnicodeSet::getStaticClassID ( void  )
static

Return the class ID for this class.

This is useful only for comparing to a return value from getDynamicClassID(). For example:

.      Base* polymorphic_pointer = createPolymorphicObject();
.      if (polymorphic_pointer->getDynamicClassID() ==
.          Derived::getStaticClassID()) ...
Returns
The class ID for all objects of this class.
Stable:
ICU 2.0
virtual int32_t icu::UnicodeSet::hashCode ( void  ) const
virtual

Returns the hash code value for this set.

Returns
the hash code value for this set.
See also
Object::hashCode()
Stable:
ICU 2.0
int32_t icu::UnicodeSet::indexOf ( UChar32  c) const

Returns the index of the given character within this set, where the set is ordered by ascending code point.

If the character is not in this set, return -1. The inverse of this method is charAt().

Returns
an index from 0..size()-1, or -1
Stable:
ICU 2.4
UBool icu::UnicodeSet::isBogus ( void  ) const
inline

Determine if this object contains a valid set.

A bogus set has no value. It is different from an empty set. It can be used to indicate that no set value is available.

Returns
TRUE if the set is bogus/invalid, FALSE otherwise
See also
setToBogus()
Stable:
ICU 4.0

Definition at line 1673 of file uniset.h.

virtual UBool icu::UnicodeSet::isEmpty ( void  ) const
virtual

Returns true if this set contains no elements.

Returns
true if this set contains no elements.
Stable:
ICU 2.0
UBool icu::UnicodeSet::isFrozen ( ) const
inline

Determines whether the set has been frozen (made immutable) or not.

See the ICU4J Freezable interface for details.

Returns
TRUE/FALSE for whether the set has been frozen
See also
freeze
cloneAsThawed
Stable:
ICU 3.8

Definition at line 1657 of file uniset.h.

References NULL.

virtual UMatchDegree icu::UnicodeSet::matches ( const Replaceable text,
int32_t &  offset,
int32_t  limit,
UBool  incremental 
)
virtual

Implement UnicodeMatcher::matches()

Stable:
ICU 2.4

Reimplemented from icu::UnicodeFilter.

UBool icu::UnicodeSet::operator!= ( const UnicodeSet o) const
inline

Compares the specified object with this set for equality.

Returns true if the specified set is not equal to this set.

Stable:
ICU 2.0

Definition at line 1653 of file uniset.h.

References icu::operator==().

UnicodeSet& icu::UnicodeSet::operator= ( const UnicodeSet o)

Assigns this object to be a copy of another.

A frozen set will not be modified.

Stable:
ICU 2.0
virtual UBool icu::UnicodeSet::operator== ( const UnicodeSet o) const
virtual

Compares the specified object with this set for equality.

Returns true if the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set).

Parameters
oset to be compared for equality with this set.
Returns
true if the specified set is equal to this set.
Stable:
ICU 2.0
virtual UnicodeSet& icu::UnicodeSet::remove ( UChar32  start,
UChar32  end 
)
virtual

Removes the specified range from this set if it is present.

The set will not contain the specified range once the call returns. If end > start then an empty range is removed, leaving the set unchanged. A frozen set will not be modified.

Parameters
startfirst character, inclusive, of range to be removed from this set.
endlast character, inclusive, of range to be removed from this set.
Stable:
ICU 2.0
UnicodeSet& icu::UnicodeSet::remove ( UChar32  c)

Removes the specified character from this set if it is present.

The set will not contain the specified range once the call returns. A frozen set will not be modified.

Stable:
ICU 2.0
UnicodeSet& icu::UnicodeSet::remove ( const UnicodeString s)

Removes the specified string from this set if it is present.

The set will not contain the specified character once the call returns. A frozen set will not be modified.

Parameters
sthe source string
Returns
this object, for chaining
Stable:
ICU 2.4
UnicodeSet& icu::UnicodeSet::removeAll ( const UnicodeString s)

Remove EACH of the characters in this string.

Note: "ch" == {"c", "h"} If this set already any particular character, it has no effect on that character. A frozen set will not be modified.

Parameters
sthe source string
Returns
this object, for chaining
Stable:
ICU 2.4
virtual UnicodeSet& icu::UnicodeSet::removeAll ( const UnicodeSet c)
virtual

Removes from this set all of its elements that are contained in the specified set.

This operation effectively modifies this set so that its value is the asymmetric set difference of the two sets. A frozen set will not be modified.

Parameters
cset that defines which elements will be removed from this set.
Stable:
ICU 2.0
virtual UnicodeSet& icu::UnicodeSet::removeAllStrings ( )
virtual

Remove all strings from this set.

Returns
a reference to this set.
Stable:
ICU 4.2
static UBool icu::UnicodeSet::resemblesPattern ( const UnicodeString pattern,
int32_t  pos 
)
static

Return true if the given position, in the given pattern, appears to be the start of a UnicodeSet pattern.

Stable:
ICU 2.4
virtual UnicodeSet& icu::UnicodeSet::retain ( UChar32  start,
UChar32  end 
)
virtual

Retain only the elements in this set that are contained in the specified range.

If end > start then an empty range is retained, leaving the set empty. This is equivalent to a boolean logic AND, or a set INTERSECTION. A frozen set will not be modified.

Parameters
startfirst character, inclusive, of range to be retained to this set.
endlast character, inclusive, of range to be retained to this set.
Stable:
ICU 2.0
UnicodeSet& icu::UnicodeSet::retain ( UChar32  c)

Retain the specified character from this set if it is present.

A frozen set will not be modified.

Stable:
ICU 2.0
UnicodeSet& icu::UnicodeSet::retainAll ( const UnicodeString s)

Retains EACH of the characters in this string.

Note: "ch" == {"c", "h"} If this set already any particular character, it has no effect on that character. A frozen set will not be modified.

Parameters
sthe source string
Returns
this object, for chaining
Stable:
ICU 2.4
virtual UnicodeSet& icu::UnicodeSet::retainAll ( const UnicodeSet c)
virtual

Retains only the elements in this set that are contained in the specified set.

In other words, removes from this set all of its elements that are not contained in the specified set. This operation effectively modifies this set so that its value is the intersection of the two sets. A frozen set will not be modified.

Parameters
cset that defines which elements this set will retain.
Stable:
ICU 2.0
int32_t icu::UnicodeSet::serialize ( uint16_t *  dest,
int32_t  destCapacity,
UErrorCode ec 
) const

Serializes this set into an array of 16-bit integers.

Serialization (currently) only records the characters in the set; multicharacter strings are ignored.

The array has following format (each line is one 16-bit integer):

length = (n+2*m) | (m!=0?0x8000:0) bmpLength = n; present if m!=0 bmp[0] bmp[1] ... bmp[n-1] supp-high[0] supp-low[0] supp-high[1] supp-low[1] ... supp-high[m-1] supp-low[m-1]

The array starts with a header. After the header are n bmp code points, then m supplementary code points. Either n or m or both may be zero. n+2*m is always <= 0x7FFF.

If there are no supplementary characters (if m==0) then the header is one 16-bit integer, 'length', with value n.

If there are supplementary characters (if m!=0) then the header is two 16-bit integers. The first, 'length', has value (n+2*m)|0x8000. The second, 'bmpLength', has value n.

After the header the code points are stored in ascending order. Supplementary code points are stored as most significant 16 bits followed by least significant 16 bits.

Parameters
destpointer to buffer of destCapacity 16-bit integers. May be NULL only if destCapacity is zero.
destCapacitysize of dest, or zero. Must not be negative.
ecerror code. Will be set to U_INDEX_OUTOFBOUNDS_ERROR if n+2*m > 0x7FFF. Will be set to U_BUFFER_OVERFLOW_ERROR if n+2*m+(m!=0?2:1) > destCapacity.
Returns
the total length of the serialized format, including the header, that is, n+2*m+(m!=0?2:1), or 0 on error other than U_BUFFER_OVERFLOW_ERROR.
Stable:
ICU 2.4
UnicodeSet& icu::UnicodeSet::set ( UChar32  start,
UChar32  end 
)

Make this object represent the range start - end.

If end > start then this object is set to an an empty range. A frozen set will not be modified.

Parameters
startfirst character in the set, inclusive
endlast character in the set, inclusive
Stable:
ICU 2.4
void icu::UnicodeSet::setToBogus ( )

Make this UnicodeSet object invalid.

The string will test TRUE with isBogus().

A bogus set has no value. It is different from an empty set. It can be used to indicate that no set value is available.

This utility function is used throughout the UnicodeSet implementation to indicate that a UnicodeSet operation failed, and may be used in other functions, especially but not exclusively when such functions do not take a UErrorCode for simplicity.

See also
isBogus()
Stable:
ICU 4.0
virtual int32_t icu::UnicodeSet::size ( void  ) const
virtual

Returns the number of elements in this set (its cardinality).

Note than the elements of a set may include both individual codepoints and strings.

Returns
the number of elements in this set (its cardinality).
Stable:
ICU 2.0
int32_t icu::UnicodeSet::span ( const UChar s,
int32_t  length,
USetSpanCondition  spanCondition 
) const

Returns the length of the initial substring of the input string which consists only of characters and strings that are contained in this set (USET_SPAN_CONTAINED, USET_SPAN_SIMPLE), or only of characters and strings that are not contained in this set (USET_SPAN_NOT_CONTAINED).

See USetSpanCondition for details. Similar to the strspn() C library function. Unpaired surrogates are treated according to contains() of their surrogate code points. This function works faster with a frozen set and with a non-negative string length argument.

Parameters
sstart of the string
lengthof the string; can be -1 for NUL-terminated
spanConditionspecifies the containment condition
Returns
the length of the initial substring according to the spanCondition; 0 if the start of the string does not fit the spanCondition
Stable:
ICU 3.8
See also
USetSpanCondition
int32_t icu::UnicodeSet::span ( const UnicodeString s,
int32_t  start,
USetSpanCondition  spanCondition 
) const
inline

Returns the end of the substring of the input string according to the USetSpanCondition.

Same as start+span(s.getBuffer()+start, s.length()-start, spanCondition) after pinning start to 0<=start<=s.length().

Parameters
sthe string
startthe start index in the string for the span operation
spanConditionspecifies the containment condition
Returns
the exclusive end of the substring according to the spanCondition; the substring s.tempSubStringBetween(start, end) fulfills the spanCondition
Stable:
ICU 4.4
See also
USetSpanCondition

Definition at line 1693 of file uniset.h.

References icu::UnicodeString::getBuffer(), and icu::UnicodeString::length().

int32_t icu::UnicodeSet::spanBack ( const UChar s,
int32_t  length,
USetSpanCondition  spanCondition 
) const

Returns the start of the trailing substring of the input string which consists only of characters and strings that are contained in this set (USET_SPAN_CONTAINED, USET_SPAN_SIMPLE), or only of characters and strings that are not contained in this set (USET_SPAN_NOT_CONTAINED).

See USetSpanCondition for details. Unpaired surrogates are treated according to contains() of their surrogate code points. This function works faster with a frozen set and with a non-negative string length argument.

Parameters
sstart of the string
lengthof the string; can be -1 for NUL-terminated
spanConditionspecifies the containment condition
Returns
the start of the trailing substring according to the spanCondition; the string length if the end of the string does not fit the spanCondition
Stable:
ICU 3.8
See also
USetSpanCondition
int32_t icu::UnicodeSet::spanBack ( const UnicodeString s,
int32_t  limit,
USetSpanCondition  spanCondition 
) const
inline

Returns the start of the substring of the input string according to the USetSpanCondition.

Same as spanBack(s.getBuffer(), limit, spanCondition) after pinning limit to 0<=end<=s.length().

Parameters
sthe string
limitthe exclusive-end index in the string for the span operation (use s.length() or INT32_MAX for spanning back from the end of the string)
spanConditionspecifies the containment condition
Returns
the start of the substring according to the spanCondition; the substring s.tempSubStringBetween(start, limit) fulfills the spanCondition
Stable:
ICU 4.4
See also
USetSpanCondition

Definition at line 1703 of file uniset.h.

References icu::UnicodeString::getBuffer(), icu::UnicodeString::length(), and U_NAMESPACE_END.

int32_t icu::UnicodeSet::spanBackUTF8 ( const char *  s,
int32_t  length,
USetSpanCondition  spanCondition 
) const

Returns the start of the trailing substring of the input string which consists only of characters and strings that are contained in this set (USET_SPAN_CONTAINED, USET_SPAN_SIMPLE), or only of characters and strings that are not contained in this set (USET_SPAN_NOT_CONTAINED).

See USetSpanCondition for details. Malformed byte sequences are treated according to contains(0xfffd). This function works faster with a frozen set and with a non-negative string length argument.

Parameters
sstart of the string (UTF-8)
lengthof the string; can be -1 for NUL-terminated
spanConditionspecifies the containment condition
Returns
the start of the trailing substring according to the spanCondition; the string length if the end of the string does not fit the spanCondition
Stable:
ICU 3.8
See also
USetSpanCondition
int32_t icu::UnicodeSet::spanUTF8 ( const char *  s,
int32_t  length,
USetSpanCondition  spanCondition 
) const

Returns the length of the initial substring of the input string which consists only of characters and strings that are contained in this set (USET_SPAN_CONTAINED, USET_SPAN_SIMPLE), or only of characters and strings that are not contained in this set (USET_SPAN_NOT_CONTAINED).

See USetSpanCondition for details. Similar to the strspn() C library function. Malformed byte sequences are treated according to contains(0xfffd). This function works faster with a frozen set and with a non-negative string length argument.

Parameters
sstart of the string (UTF-8)
lengthof the string; can be -1 for NUL-terminated
spanConditionspecifies the containment condition
Returns
the length of the initial substring according to the spanCondition; 0 if the start of the string does not fit the spanCondition
Stable:
ICU 3.8
See also
USetSpanCondition
virtual UnicodeString& icu::UnicodeSet::toPattern ( UnicodeString result,
UBool  escapeUnprintable = FALSE 
) const
virtual

Returns a string representation of this set.

If the result of calling this function is passed to a UnicodeSet constructor, it will produce another set that is equal to this one. A frozen set will not be modified.

Parameters
resultthe string to receive the rules. Previous contents will be deleted.
escapeUnprintableif TRUE then convert unprintable character to their hex escape representations, \uxxxx or \Uxxxxxxxx. Unprintable characters are those other than U+000A, U+0020..U+007E.
Stable:
ICU 2.0

Implements icu::UnicodeMatcher.

USet * icu::UnicodeSet::toUSet ( )
inline

Produce a USet * pointer for this UnicodeSet.

USet is the plain C type for UnicodeSet

Returns
a USet pointer for this UnicodeSet
Stable:
ICU 4.2

Definition at line 1685 of file uniset.h.

const USet * icu::UnicodeSet::toUSet ( ) const
inline

Produce a const USet * pointer for this UnicodeSet.

USet is the plain C type for UnicodeSet

Returns
a const USet pointer for this UnicodeSet
Stable:
ICU 4.2

Definition at line 1689 of file uniset.h.

Friends And Related Function Documentation

void UnicodeSet_initInclusion ( int32_t  src,
UErrorCode status 
)
friend
Internal:
Do not use.

This API is for internal use only.


The documentation for this class was generated from the following file: