ICU 70.1 70.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
35#if U_SHOW_CPLUSPLUS_API
37#endif // U_SHOW_CPLUSPLUS_API
38
39#ifndef USET_DEFINED
40
41#ifndef U_IN_DOXYGEN
42#define USET_DEFINED
43#endif
50typedef struct USet USet;
51#endif
52
58enum {
64
92
103
159typedef enum USetSpanCondition {
208#ifndef U_HIDE_DEPRECATED_API
214#endif // U_HIDE_DEPRECATED_API
216
217enum {
226
232typedef struct USerializedSet {
237 const uint16_t *array;
242 int32_t bmpLength;
247 int32_t length;
254
255/*********************************************************************
256 * USet API
257 *********************************************************************/
258
266U_CAPI USet* U_EXPORT2
268
279U_CAPI USet* U_EXPORT2
281
291U_CAPI USet* U_EXPORT2
292uset_openPattern(const UChar* pattern, int32_t patternLength,
293 UErrorCode* ec);
294
306U_CAPI USet* U_EXPORT2
307uset_openPatternOptions(const UChar* pattern, int32_t patternLength,
308 uint32_t options,
309 UErrorCode* ec);
310
317U_CAPI void U_EXPORT2
319
320#if U_SHOW_CPLUSPLUS_API
321
322U_NAMESPACE_BEGIN
323
334
335U_NAMESPACE_END
336
337#endif
338
348U_CAPI USet * U_EXPORT2
349uset_clone(const USet *set);
350
360U_CAPI UBool U_EXPORT2
361uset_isFrozen(const USet *set);
362
377U_CAPI void U_EXPORT2
379
390U_CAPI USet * U_EXPORT2
392
402U_CAPI void U_EXPORT2
404 UChar32 start, UChar32 end);
405
427U_CAPI int32_t U_EXPORT2
429 const UChar *pattern, int32_t patternLength,
430 uint32_t options,
431 UErrorCode *status);
432
455U_CAPI void U_EXPORT2
457 UProperty prop, int32_t value, UErrorCode* ec);
458
494U_CAPI void U_EXPORT2
496 const UChar *prop, int32_t propLength,
497 const UChar *value, int32_t valueLength,
498 UErrorCode* ec);
499
509U_CAPI UBool U_EXPORT2
510uset_resemblesPattern(const UChar *pattern, int32_t patternLength,
511 int32_t pos);
512
528U_CAPI int32_t U_EXPORT2
530 UChar* result, int32_t resultCapacity,
531 UBool escapeUnprintable,
532 UErrorCode* ec);
533
542U_CAPI void U_EXPORT2
544
557U_CAPI void U_EXPORT2
558uset_addAll(USet* set, const USet *additionalSet);
559
569U_CAPI void U_EXPORT2
571
581U_CAPI void U_EXPORT2
582uset_addString(USet* set, const UChar* str, int32_t strLen);
583
593U_CAPI void U_EXPORT2
594uset_addAllCodePoints(USet* set, const UChar *str, int32_t strLen);
595
604U_CAPI void U_EXPORT2
606
616U_CAPI void U_EXPORT2
618
628U_CAPI void U_EXPORT2
629uset_removeString(USet* set, const UChar* str, int32_t strLen);
630
631#ifndef U_HIDE_DRAFT_API
641U_CAPI void U_EXPORT2
642uset_removeAllCodePoints(USet *set, const UChar *str, int32_t length);
643#endif // U_HIDE_DRAFT_API
644
656U_CAPI void U_EXPORT2
657uset_removeAll(USet* set, const USet* removeSet);
658
671U_CAPI void U_EXPORT2
672uset_retain(USet* set, UChar32 start, UChar32 end);
673
674#ifndef U_HIDE_DRAFT_API
686U_CAPI void U_EXPORT2
687uset_retainString(USet *set, const UChar *str, int32_t length);
688
698U_CAPI void U_EXPORT2
699uset_retainAllCodePoints(USet *set, const UChar *str, int32_t length);
700#endif // U_HIDE_DRAFT_API
701
714U_CAPI void U_EXPORT2
715uset_retainAll(USet* set, const USet* retain);
716
725U_CAPI void U_EXPORT2
727
741U_CAPI void U_EXPORT2
743
744#ifndef U_HIDE_DRAFT_API
758U_CAPI void U_EXPORT2
760
771U_CAPI void U_EXPORT2
772uset_complementString(USet *set, const UChar *str, int32_t length);
773
783U_CAPI void U_EXPORT2
784uset_complementAllCodePoints(USet *set, const UChar *str, int32_t length);
785#endif // U_HIDE_DRAFT_API
786
798U_CAPI void U_EXPORT2
799uset_complementAll(USet* set, const USet* complement);
800
808U_CAPI void U_EXPORT2
810
837U_CAPI void U_EXPORT2
838uset_closeOver(USet* set, int32_t attributes);
839
846U_CAPI void U_EXPORT2
848
856U_CAPI UBool U_EXPORT2
857uset_isEmpty(const USet* set);
858
859#ifndef U_HIDE_DRAFT_API
865U_CAPI UBool U_EXPORT2
867#endif // U_HIDE_DRAFT_API
868
877U_CAPI UBool U_EXPORT2
879
889U_CAPI UBool U_EXPORT2
890uset_containsRange(const USet* set, UChar32 start, UChar32 end);
891
900U_CAPI UBool U_EXPORT2
901uset_containsString(const USet* set, const UChar* str, int32_t strLen);
902
913U_CAPI int32_t U_EXPORT2
914uset_indexOf(const USet* set, UChar32 c);
915
931U_CAPI UChar32 U_EXPORT2
932uset_charAt(const USet* set, int32_t charIndex);
933
947U_CAPI int32_t U_EXPORT2
948uset_size(const USet* set);
949
950#ifndef U_HIDE_DRAFT_API
959U_CAPI int32_t U_EXPORT2
961#endif // U_HIDE_DRAFT_API
962
971U_CAPI int32_t U_EXPORT2
973
1002U_CAPI int32_t U_EXPORT2
1003uset_getItem(const USet* set, int32_t itemIndex,
1004 UChar32* start, UChar32* end,
1005 UChar* str, int32_t strCapacity,
1006 UErrorCode* ec);
1007
1016U_CAPI UBool U_EXPORT2
1017uset_containsAll(const USet* set1, const USet* set2);
1018
1029U_CAPI UBool U_EXPORT2
1030uset_containsAllCodePoints(const USet* set, const UChar *str, int32_t strLen);
1031
1040U_CAPI UBool U_EXPORT2
1041uset_containsNone(const USet* set1, const USet* set2);
1042
1051U_CAPI UBool U_EXPORT2
1052uset_containsSome(const USet* set1, const USet* set2);
1053
1073U_CAPI int32_t U_EXPORT2
1074uset_span(const USet *set, const UChar *s, int32_t length, USetSpanCondition spanCondition);
1075
1094U_CAPI int32_t U_EXPORT2
1095uset_spanBack(const USet *set, const UChar *s, int32_t length, USetSpanCondition spanCondition);
1096
1116U_CAPI int32_t U_EXPORT2
1117uset_spanUTF8(const USet *set, const char *s, int32_t length, USetSpanCondition spanCondition);
1118
1137U_CAPI int32_t U_EXPORT2
1138uset_spanBackUTF8(const USet *set, const char *s, int32_t length, USetSpanCondition spanCondition);
1139
1148U_CAPI UBool U_EXPORT2
1149uset_equals(const USet* set1, const USet* set2);
1150
1151/*********************************************************************
1152 * Serialized set API
1153 *********************************************************************/
1154
1204U_CAPI int32_t U_EXPORT2
1205uset_serialize(const USet* set, uint16_t* dest, int32_t destCapacity, UErrorCode* pErrorCode);
1206
1215U_CAPI UBool U_EXPORT2
1216uset_getSerializedSet(USerializedSet* fillSet, const uint16_t* src, int32_t srcLength);
1217
1225U_CAPI void U_EXPORT2
1227
1236U_CAPI UBool U_EXPORT2
1238
1248U_CAPI int32_t U_EXPORT2
1250
1264U_CAPI UBool U_EXPORT2
1265uset_getSerializedRange(const USerializedSet* set, int32_t rangeIndex,
1266 UChar32* pStart, UChar32* pEnd);
1267
1268#endif
"Smart pointer" class, closes a USet via uset_close().
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:550
A serialized form of a Unicode set.
Definition: uset.h:232
uint16_t staticArray[USET_SERIALIZED_STATIC_ARRAY_CAPACITY]
A small buffer for the array to reduce memory allocations.
Definition: uset.h:252
int32_t bmpLength
The length of the array that contains BMP characters.
Definition: uset.h:242
const uint16_t * array
The serialized Unicode Set.
Definition: uset.h:237
int32_t length
The total length of the array.
Definition: uset.h:247
C API: Unicode Properties.
UProperty
Selection constants for Unicode properties.
Definition: uchar.h:195
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition: umachine.h:467
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:418
U_CAPI UBool uset_containsAll(const USet *set1, const USet *set2)
Returns true if set1 contains all the characters and strings of set2.
U_CAPI UBool uset_hasStrings(const USet *set)
U_CAPI USet * uset_open(UChar32 start, UChar32 end)
Creates a USet object that contains the range of characters start..end, inclusive.
U_CAPI UBool uset_serializedContains(const USerializedSet *set, UChar32 c)
Returns true if the given USerializedSet contains the given character.
U_CAPI UBool uset_getSerializedSet(USerializedSet *fillSet, const uint16_t *src, int32_t srcLength)
Given a serialized array, fill in the given serialized set object.
U_CAPI void uset_set(USet *set, UChar32 start, UChar32 end)
Causes the USet object to represent the range start - end.
U_CAPI void uset_addString(USet *set, const UChar *str, int32_t strLen)
Adds the given string to the given USet.
U_CAPI UBool uset_containsString(const USet *set, const UChar *str, int32_t strLen)
Returns true if the given USet contains the given string.
@ USET_IGNORE_SPACE
Ignore white space within patterns unless quoted or escaped.
Definition: uset.h:63
@ USET_ADD_CASE_MAPPINGS
Enable case insensitive matching.
Definition: uset.h:101
@ USET_CASE_INSENSITIVE
Enable case insensitive matching.
Definition: uset.h:91
U_CAPI UBool uset_isEmpty(const USet *set)
Returns true if the given USet contains no characters and no strings.
U_CAPI int32_t uset_getItemCount(const USet *set)
Returns the number of items in this set.
U_CAPI int32_t uset_getSerializedRangeCount(const USerializedSet *set)
Returns the number of disjoint ranges of characters contained in the given serialized set.
U_CAPI 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 ...
U_CAPI void uset_retainAll(USet *set, const USet *retain)
Retains only the elements in this set that are contained in the specified set.
U_CAPI void uset_setSerializedToOne(USerializedSet *fillSet, UChar32 c)
Set the USerializedSet to contain the given character (and nothing else).
U_CAPI void uset_complementString(USet *set, const UChar *str, int32_t length)
Complements the specified string in this set.
U_CAPI 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...
U_CAPI void uset_complementRange(USet *set, UChar32 start, UChar32 end)
Complements the specified range in this set.
U_CAPI 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...
U_CAPI void uset_addRange(USet *set, UChar32 start, UChar32 end)
Adds the given range of characters to the given USet.
U_CAPI void uset_add(USet *set, UChar32 c)
Adds the given character to the given USet.
U_CAPI void uset_complementAllCodePoints(USet *set, const UChar *str, int32_t length)
Complements EACH of the characters in this string.
U_CAPI int32_t uset_size(const USet *set)
Returns the number of characters and strings contained in this set.
U_CAPI 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...
U_CAPI USet * uset_openPatternOptions(const UChar *pattern, int32_t patternLength, uint32_t options, UErrorCode *ec)
Creates a set from the given pattern.
U_CAPI void uset_removeAllStrings(USet *set)
Remove all strings from this set.
U_CAPI void uset_clear(USet *set)
Removes all of the elements from this set.
U_CAPI void uset_removeAllCodePoints(USet *set, const UChar *str, int32_t length)
Removes EACH of the characters in this string.
USetSpanCondition
Argument values for whether span() and similar functions continue while the current character is cont...
Definition: uset.h:159
@ USET_SPAN_NOT_CONTAINED
Continues a span() while there is no set element at the current position.
Definition: uset.h:172
@ USET_SPAN_CONTAINED
Spans the longest substring that is a concatenation of set elements (characters or strings).
Definition: uset.h:187
@ USET_SPAN_CONDITION_COUNT
One more than the last span condition.
Definition: uset.h:213
@ USET_SPAN_SIMPLE
Continues a span() while there is a set element at the current position.
Definition: uset.h:207
U_CAPI void uset_remove(USet *set, UChar32 c)
Removes the given character from the given USet.
U_CAPI USet * uset_openPattern(const UChar *pattern, int32_t patternLength, UErrorCode *ec)
Creates a set from the given pattern.
U_CAPI void uset_removeRange(USet *set, UChar32 start, UChar32 end)
Removes the given range of characters from the given USet.
U_CAPI USet * uset_openEmpty(void)
Create an empty USet object.
U_CAPI 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.
U_CAPI UBool uset_isFrozen(const USet *set)
Determines whether the set has been frozen (made immutable) or not.
U_CAPI int32_t uset_getRangeCount(const USet *set)
U_CAPI USet * uset_cloneAsThawed(const USet *set)
Clone the set and make the clone mutable.
U_CAPI 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.
U_CAPI 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.
U_CAPI 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 ...
U_CAPI USet * uset_clone(const USet *set)
Returns a copy of this object.
U_CAPI void uset_freeze(USet *set)
Freeze the set (make it immutable).
U_CAPI 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...
struct USerializedSet USerializedSet
A serialized form of a Unicode set.
U_CAPI void uset_retain(USet *set, UChar32 start, UChar32 end)
Retain only the elements in this set that are contained in the specified range.
U_CAPI int32_t uset_toPattern(const USet *set, UChar *result, int32_t resultCapacity, UBool escapeUnprintable, UErrorCode *ec)
Returns a string representation of this set.
U_CAPI 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...
U_CAPI void uset_complement(USet *set)
This is equivalent to uset_complementRange(set, 0, 0x10FFFF).
@ USET_SERIALIZED_STATIC_ARRAY_CAPACITY
Capacity of USerializedSet::staticArray.
Definition: uset.h:224
U_CAPI UBool uset_containsSome(const USet *set1, const USet *set2)
Returns true if set1 contains some of the characters and strings of set2.
U_CAPI 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...
U_CAPI UBool uset_containsNone(const USet *set1, const USet *set2)
Returns true if set1 contains none of the characters and strings of set2.
U_CAPI void uset_retainAllCodePoints(USet *set, const UChar *str, int32_t length)
Retains EACH of the characters in this string.
U_CAPI UBool uset_contains(const USet *set, UChar32 c)
Returns true if the given USet contains the given character.
U_CAPI 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.
U_CAPI void uset_complementAll(USet *set, const USet *complement)
Complements in this set all elements contained in the specified set.
U_CAPI 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.
U_CAPI void uset_close(USet *set)
Disposes of the storage used by a USet object.
struct USet USet
USet is the C API type corresponding to C++ class UnicodeSet.
Definition: uset.h:50
U_CAPI void uset_addAll(USet *set, const USet *additionalSet)
Adds all of the elements in the specified set to this set if they're not already present.
U_CAPI void uset_removeString(USet *set, const UChar *str, int32_t strLen)
Removes the given string to the given USet.
U_CAPI void uset_compact(USet *set)
Reallocate this objects internal structures to take up the least possible space, without changing thi...
U_CAPI 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.
U_CAPI void uset_closeOver(USet *set, int32_t attributes)
Close this set over the given attribute.
U_CAPI void uset_addAllCodePoints(USet *set, const UChar *str, int32_t strLen)
Adds each of the characters in this string to the set.
U_CAPI void uset_retainString(USet *set, const UChar *str, int32_t length)
Retains only the specified string from this set if it is present.
U_CAPI void uset_removeAll(USet *set, const USet *removeSet)
Removes from this set all of its elements that are contained in the specified set.
U_CAPI 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.
U_CAPI UBool uset_getSerializedRange(const USerializedSet *set, int32_t rangeIndex, UChar32 *pStart, UChar32 *pEnd)
Returns a range of characters contained in the given serialized set.
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415