ICU 63.1 63.1

uset.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 *
6 * Copyright (C) 2002-2014, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 *******************************************************************************
10 * file name: uset.h
11 * encoding: UTF-8
12 * tab size: 8 (not used)
13 * indentation:4
14 *
15 * created on: 2002mar07
16 * created by: Markus W. Scherer
17 *
18 * C version of UnicodeSet.
19 */
20
21
29 #ifndef __USET_H__
30 #define __USET_H__
31
32 #include "unicode/utypes.h"
33 #include "unicode/uchar.h"
34 #include "unicode/localpointer.h"
35
36 #ifndef USET_DEFINED
37
38 #ifndef U_IN_DOXYGEN
39 #define USET_DEFINED
40 #endif
41
47 typedef struct USet USet;
48 #endif
49
55 enum {
60 USET_IGNORE_SPACE = 1,
61
88 USET_CASE_INSENSITIVE = 2,
89
98 USET_ADD_CASE_MAPPINGS = 4
99 };
100
156 typedef enum USetSpanCondition {
169 USET_SPAN_NOT_CONTAINED = 0,
184 USET_SPAN_CONTAINED = 1,
204 USET_SPAN_SIMPLE = 2,
205 #ifndef U_HIDE_DEPRECATED_API
206
210 USET_SPAN_CONDITION_COUNT
211 #endif // U_HIDE_DEPRECATED_API
212 } USetSpanCondition;
213
214 enum {
221 USET_SERIALIZED_STATIC_ARRAY_CAPACITY=8
222 };
223
229 typedef struct USerializedSet {
234 const uint16_t *array;
239 int32_t bmpLength;
244 int32_t length;
249 uint16_t staticArray[USET_SERIALIZED_STATIC_ARRAY_CAPACITY];
250 } USerializedSet;
251
252 /*********************************************************************
253 * USet API
254 *********************************************************************/
255
263 U_STABLE USet* U_EXPORT2
264 uset_openEmpty(void);
265
276 U_STABLE USet* U_EXPORT2
277 uset_open(UChar32 start, UChar32 end);
278
288 U_STABLE USet* U_EXPORT2
289 uset_openPattern(const UChar* pattern, int32_t patternLength,
290 UErrorCode* ec);
291
303 U_STABLE USet* U_EXPORT2
304 uset_openPatternOptions(const UChar* pattern, int32_t patternLength,
305 uint32_t options,
306 UErrorCode* ec);
307
314 U_STABLE void U_EXPORT2
315 uset_close(USet* set);
316
317 #if U_SHOW_CPLUSPLUS_API
318
319 U_NAMESPACE_BEGIN
320
330 U_DEFINE_LOCAL_OPEN_POINTER(LocalUSetPointer, USet, uset_close);
331
332 U_NAMESPACE_END
333
334 #endif
335
345 U_STABLE USet * U_EXPORT2
346 uset_clone(const USet *set);
347
357 U_STABLE UBool U_EXPORT2
358 uset_isFrozen(const USet *set);
359
374 U_STABLE void U_EXPORT2
375 uset_freeze(USet *set);
376
387 U_STABLE USet * U_EXPORT2
388 uset_cloneAsThawed(const USet *set);
389
399 U_STABLE void U_EXPORT2
400 uset_set(USet* set,
401 UChar32 start, UChar32 end);
402
424 U_STABLE int32_t U_EXPORT2
425 uset_applyPattern(USet *set,
426 const UChar *pattern, int32_t patternLength,
427 uint32_t options,
428 UErrorCode *status);
429
452 U_STABLE void U_EXPORT2
453 uset_applyIntPropertyValue(USet* set,
454 UProperty prop, int32_t value, UErrorCode* ec);
455
491 U_STABLE void U_EXPORT2
492 uset_applyPropertyAlias(USet* set,
493 const UChar *prop, int32_t propLength,
494 const UChar *value, int32_t valueLength,
495 UErrorCode* ec);
496
506 U_STABLE UBool U_EXPORT2
507 uset_resemblesPattern(const UChar *pattern, int32_t patternLength,
508 int32_t pos);
509
525 U_STABLE int32_t U_EXPORT2
526 uset_toPattern(const USet* set,
527 UChar* result, int32_t resultCapacity,
528 UBool escapeUnprintable,
529 UErrorCode* ec);
530
539 U_STABLE void U_EXPORT2
540 uset_add(USet* set, UChar32 c);
541
554 U_STABLE void U_EXPORT2
555 uset_addAll(USet* set, const USet *additionalSet);
556
566 U_STABLE void U_EXPORT2
567 uset_addRange(USet* set, UChar32 start, UChar32 end);
568
578 U_STABLE void U_EXPORT2
579 uset_addString(USet* set, const UChar* str, int32_t strLen);
580
590 U_STABLE void U_EXPORT2
591 uset_addAllCodePoints(USet* set, const UChar *str, int32_t strLen);
592
601 U_STABLE void U_EXPORT2
602 uset_remove(USet* set, UChar32 c);
603
613 U_STABLE void U_EXPORT2
614 uset_removeRange(USet* set, UChar32 start, UChar32 end);
615
625 U_STABLE void U_EXPORT2
626 uset_removeString(USet* set, const UChar* str, int32_t strLen);
627
639 U_STABLE void U_EXPORT2
640 uset_removeAll(USet* set, const USet* removeSet);
641
656 U_STABLE void U_EXPORT2
657 uset_retain(USet* set, UChar32 start, UChar32 end);
658
671 U_STABLE void U_EXPORT2
672 uset_retainAll(USet* set, const USet* retain);
673
682 U_STABLE void U_EXPORT2
683 uset_compact(USet* set);
684
693 U_STABLE void U_EXPORT2
694 uset_complement(USet* set);
695
707 U_STABLE void U_EXPORT2
708 uset_complementAll(USet* set, const USet* complement);
709
717 U_STABLE void U_EXPORT2
718 uset_clear(USet* set);
719
746 U_STABLE void U_EXPORT2
747 uset_closeOver(USet* set, int32_t attributes);
748
755 U_STABLE void U_EXPORT2
756 uset_removeAllStrings(USet* set);
757
765 U_STABLE UBool U_EXPORT2
766 uset_isEmpty(const USet* set);
767
776 U_STABLE UBool U_EXPORT2
777 uset_contains(const USet* set, UChar32 c);
778
788 U_STABLE UBool U_EXPORT2
789 uset_containsRange(const USet* set, UChar32 start, UChar32 end);
790
799 U_STABLE UBool U_EXPORT2
800 uset_containsString(const USet* set, const UChar* str, int32_t strLen);
801
812 U_STABLE int32_t U_EXPORT2
813 uset_indexOf(const USet* set, UChar32 c);
814
825 U_STABLE UChar32 U_EXPORT2
826 uset_charAt(const USet* set, int32_t charIndex);
827
836 U_STABLE int32_t U_EXPORT2
837 uset_size(const USet* set);
838
847 U_STABLE int32_t U_EXPORT2
848 uset_getItemCount(const USet* set);
849
868 U_STABLE int32_t U_EXPORT2
869 uset_getItem(const USet* set, int32_t itemIndex,
870 UChar32* start, UChar32* end,
871 UChar* str, int32_t strCapacity,
872 UErrorCode* ec);
873
882 U_STABLE UBool U_EXPORT2
883 uset_containsAll(const USet* set1, const USet* set2);
884
895 U_STABLE UBool U_EXPORT2
896 uset_containsAllCodePoints(const USet* set, const UChar *str, int32_t strLen);
897
906 U_STABLE UBool U_EXPORT2
907 uset_containsNone(const USet* set1, const USet* set2);
908
917 U_STABLE UBool U_EXPORT2
918 uset_containsSome(const USet* set1, const USet* set2);
919
939 U_STABLE int32_t U_EXPORT2
940 uset_span(const USet *set, const UChar *s, int32_t length, USetSpanCondition spanCondition);
941
960 U_STABLE int32_t U_EXPORT2
961 uset_spanBack(const USet *set, const UChar *s, int32_t length, USetSpanCondition spanCondition);
962
982 U_STABLE int32_t U_EXPORT2
983 uset_spanUTF8(const USet *set, const char *s, int32_t length, USetSpanCondition spanCondition);
984
1003 U_STABLE int32_t U_EXPORT2
1004 uset_spanBackUTF8(const USet *set, const char *s, int32_t length, USetSpanCondition spanCondition);
1005
1014 U_STABLE UBool U_EXPORT2
1015 uset_equals(const USet* set1, const USet* set2);
1016
1017 /*********************************************************************
1018 * Serialized set API
1019 *********************************************************************/
1020
1070 U_STABLE int32_t U_EXPORT2
1071 uset_serialize(const USet* set, uint16_t* dest, int32_t destCapacity, UErrorCode* pErrorCode);
1072
1081 U_STABLE UBool U_EXPORT2
1082 uset_getSerializedSet(USerializedSet* fillSet, const uint16_t* src, int32_t srcLength);
1083
1091 U_STABLE void U_EXPORT2
1092 uset_setSerializedToOne(USerializedSet* fillSet, UChar32 c);
1093
1102 U_STABLE UBool U_EXPORT2
1103 uset_serializedContains(const USerializedSet* set, UChar32 c);
1104
1114 U_STABLE int32_t U_EXPORT2
1115 uset_getSerializedRangeCount(const USerializedSet* set);
1116
1130 U_STABLE UBool U_EXPORT2
1131 uset_getSerializedRange(const USerializedSet* set, int32_t rangeIndex,
1132 UChar32* pStart, UChar32* pEnd);
1133
1134 #endif
uset_containsRange
UBool uset_containsRange(const USet *set, UChar32 start, UChar32 end)
Returns TRUE if the given USet contains all characters c where start <= c && c <= end...
USerializedSet::staticArray
uint16_t staticArray[USET_SERIALIZED_STATIC_ARRAY_CAPACITY]
A small buffer for the array to reduce memory allocations.
Definition: uset.h:249
uset_removeAll
void uset_removeAll(USet *set, const USet *removeSet)
Removes from this set all of its elements that are contained in the specified set.
uset_clear
void uset_clear(USet *set)
Removes all of the elements from this set.
uset_containsAllCodePoints
UBool uset_containsAllCodePoints(const USet *set, const UChar *str, int32_t strLen)
Returns true if this set contains all the characters of the given string.
uset_clone
USet * uset_clone(const USet *set)
Returns a copy of this object.
uset_applyPattern
int32_t uset_applyPattern(USet *set, const UChar *pattern, int32_t patternLength, uint32_t options, UErrorCode *status)
Modifies the set to represent the set specified by the given pattern.
uset_retain
void uset_retain(USet *set, UChar32 start, UChar32 end)
Retain only the elements in this set that are contained in the specified range.
uset_getSerializedRange
UBool uset_getSerializedRange(const USerializedSet *set, int32_t rangeIndex, UChar32 *pStart, UChar32 *pEnd)
Returns a range of characters contained in the given serialized set.
uset_addAll
void uset_addAll(USet *set, const USet *additionalSet)
Adds all of the elements in the specified set to this set if they&#39;re not already present.
USET_SPAN_CONTAINED
Spans the longest substring that is a concatenation of set elements (characters or strings)...
Definition: uset.h:184
uset_resemblesPattern
UBool uset_resemblesPattern(const UChar *pattern, int32_t patternLength, int32_t pos)
Return true if the given position, in the given pattern, appears to be the start of a UnicodeSet patt...
USET_SPAN_CONDITION_COUNT
One more than the last span condition.
Definition: uset.h:210
uset_set
void uset_set(USet *set, UChar32 start, UChar32 end)
Causes the USet object to represent the range start - end.
USerializedSet::array
const uint16_t * array
The serialized Unicode Set.
Definition: uset.h:234
uset_size
int32_t uset_size(const USet *set)
Returns the number of characters and strings contained in the given USet.
uset_cloneAsThawed
USet * uset_cloneAsThawed(const USet *set)
Clone the set and make the clone mutable.
uset_removeString
void uset_removeString(USet *set, const UChar *str, int32_t strLen)
Removes the given string to the given USet.
LocalUSetPointer
"Smart pointer" class, closes a USet via uset_close().
uset_addAllCodePoints
void uset_addAllCodePoints(USet *set, const UChar *str, int32_t strLen)
Adds each of the characters in this string to the set.
uset_charAt
UChar32 uset_charAt(const USet *set, int32_t charIndex)
Returns the character at the given index within this set, where the set is ordered by ascending code ...
uset_contains
UBool uset_contains(const USet *set, UChar32 c)
Returns TRUE if the given USet contains the given character.
uset_isEmpty
UBool uset_isEmpty(const USet *set)
Returns TRUE if the given USet contains no characters and no strings.
uset_spanBack
int32_t uset_spanBack(const USet *set, const UChar *s, int32_t length, USetSpanCondition spanCondition)
Returns the start of the trailing substring of the input string which consists only of characters and...
uset_removeAllStrings
void uset_removeAllStrings(USet *set)
Remove all strings from this set.
uset_compact
void uset_compact(USet *set)
Reallocate this objects internal structures to take up the least possible space, without changing thi...
uset_applyPropertyAlias
void uset_applyPropertyAlias(USet *set, const UChar *prop, int32_t propLength, const UChar *value, int32_t valueLength, UErrorCode *ec)
Modifies the set to contain those code points which have the given value for the given property...
uset_freeze
void uset_freeze(USet *set)
Freeze the set (make it immutable).
USET_IGNORE_SPACE
Ignore white space within patterns unless quoted or escaped.
Definition: uset.h:60
uset_openPattern
USet * uset_openPattern(const UChar *pattern, int32_t patternLength, UErrorCode *ec)
Creates a set from the given pattern.
USerializedSet
struct USerializedSet USerializedSet
A serialized form of a Unicode set.
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:137
uset_openEmpty
USet * uset_openEmpty(void)
Create an empty USet object.
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:487
uset_containsAll
UBool uset_containsAll(const USet *set1, const USet *set2)
Returns true if set1 contains all the characters and strings of set2.
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
uset_complementAll
void uset_complementAll(USet *set, const USet *complement)
Complements in this set all elements contained in the specified set.
uset_getItemCount
int32_t uset_getItemCount(const USet *set)
Returns the number of items in this set.
UChar32
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition: umachine.h:389
uset_removeRange
void uset_removeRange(USet *set, UChar32 start, UChar32 end)
Removes the given range of characters from the given USet.
uset_add
void uset_add(USet *set, UChar32 c)
Adds the given character to the given USet.
uset_equals
UBool uset_equals(const USet *set1, const USet *set2)
Returns true if set1 contains all of the characters and strings of set2, and vis versa.
uset_spanBackUTF8
int32_t uset_spanBackUTF8(const USet *set, const char *s, int32_t length, USetSpanCondition spanCondition)
Returns the start of the trailing substring of the input string which consists only of characters and...
uset_containsString
UBool uset_containsString(const USet *set, const UChar *str, int32_t strLen)
Returns TRUE if the given USet contains the given string.
uset_span
int32_t uset_span(const USet *set, const UChar *s, int32_t length, USetSpanCondition spanCondition)
Returns the length of the initial substring of the input string which consists only of characters and...
uset_applyIntPropertyValue
void uset_applyIntPropertyValue(USet *set, UProperty prop, int32_t value, UErrorCode *ec)
Modifies the set to contain those code points which have the given value for the given binary or enum...
uset_addString
void uset_addString(USet *set, const UChar *str, int32_t strLen)
Adds the given string to the given USet.
uset_openPatternOptions
USet * uset_openPatternOptions(const UChar *pattern, int32_t patternLength, uint32_t options, UErrorCode *ec)
Creates a set from the given pattern.
uset_getSerializedRangeCount
int32_t uset_getSerializedRangeCount(const USerializedSet *set)
Returns the number of disjoint ranges of characters contained in the given serialized set...
USetSpanCondition
USetSpanCondition
Argument values for whether span() and similar functions continue while the current character is cont...
Definition: uset.h:156
uchar.h
C API: Unicode Properties.
uset_getItem
int32_t uset_getItem(const USet *set, int32_t itemIndex, UChar32 *start, UChar32 *end, UChar *str, int32_t strCapacity, UErrorCode *ec)
Returns an item of this set.
UChar
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:342
uset_complement
void uset_complement(USet *set)
Inverts this set.
U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:138
uset_containsSome
UBool uset_containsSome(const USet *set1, const USet *set2)
Returns true if set1 contains some of the characters and strings of set2.
USerializedSet::length
int32_t length
The total length of the array.
Definition: uset.h:244
uset_retainAll
void uset_retainAll(USet *set, const USet *retain)
Retains only the elements in this set that are contained in the specified set.
UProperty
UProperty
Selection constants for Unicode properties.
Definition: uchar.h:195
uset_serializedContains
UBool uset_serializedContains(const USerializedSet *set, UChar32 c)
Returns TRUE if the given USerializedSet contains the given character.
uset_toPattern
int32_t uset_toPattern(const USet *set, UChar *result, int32_t resultCapacity, UBool escapeUnprintable, UErrorCode *ec)
Returns a string representation of this set.
uset_open
USet * uset_open(UChar32 start, UChar32 end)
Creates a USet object that contains the range of characters start..end, inclusive.
uset_remove
void uset_remove(USet *set, UChar32 c)
Removes the given character from the given USet.
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:401
USet
struct USet USet
USet is the C API type corresponding to C++ class UnicodeSet.
Definition: uset.h:47
uset_containsNone
UBool uset_containsNone(const USet *set1, const USet *set2)
Returns true if set1 contains none of the characters and strings of set2.
uset_isFrozen
UBool uset_isFrozen(const USet *set)
Determines whether the set has been frozen (made immutable) or not.
USET_CASE_INSENSITIVE
Enable case insensitive matching.
Definition: uset.h:88
uset_addRange
void uset_addRange(USet *set, UChar32 start, UChar32 end)
Adds the given range of characters to the given USet.
USET_ADD_CASE_MAPPINGS
Enable case insensitive matching.
Definition: uset.h:98
uset_indexOf
int32_t uset_indexOf(const USet *set, UChar32 c)
Returns the index of the given character within this set, where the set is ordered by ascending code ...
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
USerializedSet::bmpLength
int32_t bmpLength
The length of the array that contains BMP characters.
Definition: uset.h:239
USerializedSet
A serialized form of a Unicode set.
Definition: uset.h:229
USET_SPAN_SIMPLE
Continues a span() while there is a set element at the current position.
Definition: uset.h:204
uset_setSerializedToOne
void uset_setSerializedToOne(USerializedSet *fillSet, UChar32 c)
Set the USerializedSet to contain the given character (and nothing else).
uset_getSerializedSet
UBool uset_getSerializedSet(USerializedSet *fillSet, const uint16_t *src, int32_t srcLength)
Given a serialized array, fill in the given serialized set object.
uset_spanUTF8
int32_t uset_spanUTF8(const USet *set, const char *s, int32_t length, USetSpanCondition spanCondition)
Returns the length of the initial substring of the input string which consists only of characters and...
uset_serialize
int32_t uset_serialize(const USet *set, uint16_t *dest, int32_t destCapacity, UErrorCode *pErrorCode)
Serializes this set into an array of 16-bit integers.
USET_SERIALIZED_STATIC_ARRAY_CAPACITY
Capacity of USerializedSet::staticArray.
Definition: uset.h:221
uset_closeOver
void uset_closeOver(USet *set, int32_t attributes)
Close this set over the given attribute.
USET_SPAN_NOT_CONTAINED
Continues a span() while there is no set element at the current position.
Definition: uset.h:169
U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:111
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:225
uset_close
void uset_close(USet *set)
Disposes of the storage used by a USet object.