ICU 77.1  77.1
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
usetiter.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 **********************************************************************
5 * Copyright (c) 2002-2014, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 **********************************************************************
8 */
9 #ifndef USETITER_H
10 #define USETITER_H
11 
12 #include "unicode/utypes.h"
13 
14 #if U_SHOW_CPLUSPLUS_API
15 
16 #include "unicode/uobject.h"
17 #include "unicode/unistr.h"
18 
24 U_NAMESPACE_BEGIN
25 
26 class UnicodeSet;
27 class UnicodeString;
28 
67 class U_COMMON_API UnicodeSetIterator final : public UObject {
73  enum { IS_STRING = -1 };
74 
79  UChar32 codepoint;
80 
89  UChar32 codepointEnd;
90 
96  const UnicodeString* string;
97 
98  public:
99 
107 
115 
121 
137  inline UBool isString() const;
138 
144  inline UChar32 getCodepoint() const;
145 
152  inline UChar32 getCodepointEnd() const;
153 
166 
177  // Finish code point/range iteration.
178  range = endRange;
179  endElement = -1;
180  nextElement = 0;
181  return *this;
182  }
183 
207 
228 
236  void reset(const UnicodeSet& set);
237 
242  void reset();
243 
249  static UClassID U_EXPORT2 getStaticClassID();
250 
256  virtual UClassID getDynamicClassID() const override;
257 
258  // ======================= PRIVATES ===========================
259 
260 private:
261 
262  // endElement and nextElements are really UChar32's, but we keep
263  // them as signed int32_t's so we can do comparisons with
264  // endElement set to -1. Leave them as int32_t's.
267  const UnicodeSet* set;
270  int32_t endRange;
273  int32_t range;
276  int32_t endElement;
279  int32_t nextElement;
282  int32_t nextString;
285  int32_t stringCount;
286 
291  UnicodeString *cpString;
292 
295  UnicodeSetIterator(const UnicodeSetIterator&) = delete;
296 
299  UnicodeSetIterator& operator=(const UnicodeSetIterator&) = delete;
300 
303  void loadRange(int32_t range);
304 };
305 
306 inline UBool UnicodeSetIterator::isString() const {
307  return codepoint < 0;
308 }
309 
310 inline UChar32 UnicodeSetIterator::getCodepoint() const {
311  return codepoint;
312 }
313 
314 inline UChar32 UnicodeSetIterator::getCodepointEnd() const {
315  return codepointEnd;
316 }
317 
318 
319 U_NAMESPACE_END
320 
321 #endif /* U_SHOW_CPLUSPLUS_API */
322 
323 #endif
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
UnicodeSetIterator iterates over the contents of a UnicodeSet.
Definition: usetiter.h:67
UBool next()
Advances the iteration position to the next element in the set, which can be either a single code poi...
UnicodeSetIterator(const UnicodeSet &set)
Create an iterator over the given set.
void reset()
Resets this iterator to the start of the set.
UBool nextRange()
Returns the next element in the set, either a code point range or a string.
UnicodeSetIterator & skipToStrings()
Skips over the remaining code points/ranges, if any.
Definition: usetiter.h:176
const UnicodeString & getString()
Returns the current string, if isString() returned true.
void reset(const UnicodeSet &set)
Sets this iterator to visit the elements of the given set and resets it to the start of that set.
virtual UClassID getDynamicClassID() const override
ICU "poor man's RTTI", returns a UClassID for the actual class.
static UClassID getStaticClassID()
ICU "poor man's RTTI", returns a UClassID for this class.
virtual ~UnicodeSetIterator()
Destructor.
UnicodeSetIterator()
Create an iterator over nothing.
A mutable set of Unicode characters and multicharacter strings.
Definition: uniset.h:285
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition: umachine.h:427
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:247
C++ API: Unicode String.
C++ API: Common ICU base class UObject.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
Basic definitions for ICU, for both C and C++ APIs.
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside.
Definition: utypes.h:315