ICU 70.1  70.1
uchriter.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) 1998-2005, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 **********************************************************************
8 */
9 
10 #ifndef UCHRITER_H
11 #define UCHRITER_H
12 
13 #include "unicode/utypes.h"
14 
15 #if U_SHOW_CPLUSPLUS_API
16 
17 #include "unicode/chariter.h"
18 
24 U_NAMESPACE_BEGIN
25 
39 public:
49  UCharCharacterIterator(ConstChar16Ptr textPtr, int32_t length);
50 
64  UCharCharacterIterator(ConstChar16Ptr textPtr, int32_t length,
65  int32_t position);
66 
83  UCharCharacterIterator(ConstChar16Ptr textPtr, int32_t length,
84  int32_t textBegin,
85  int32_t textEnd,
86  int32_t position);
87 
96 
102 
113 
122  virtual bool operator==(const ForwardCharacterIterator& that) const override;
123 
129  virtual int32_t hashCode(void) const override;
130 
138  virtual UCharCharacterIterator* clone() const override;
139 
147  virtual char16_t first(void) override;
148 
157  virtual char16_t firstPostInc(void) override;
158 
168  virtual UChar32 first32(void) override;
169 
178  virtual UChar32 first32PostInc(void) override;
179 
187  virtual char16_t last(void) override;
188 
196  virtual UChar32 last32(void) override;
197 
206  virtual char16_t setIndex(int32_t position) override;
207 
219  virtual UChar32 setIndex32(int32_t position) override;
220 
226  virtual char16_t current(void) const override;
227 
233  virtual UChar32 current32(void) const override;
234 
242  virtual char16_t next(void) override;
243 
252  virtual char16_t nextPostInc(void) override;
253 
264  virtual UChar32 next32(void) override;
265 
274  virtual UChar32 next32PostInc(void) override;
275 
285  virtual UBool hasNext() override;
286 
294  virtual char16_t previous(void) override;
295 
303  virtual UChar32 previous32(void) override;
304 
314  virtual UBool hasPrevious() override;
315 
327  virtual int32_t move(int32_t delta, EOrigin origin) override;
328 
340 #ifdef move32
341  // One of the system headers right now is sometimes defining a conflicting macro we don't use
342 #undef move32
343 #endif
344  virtual int32_t move32(int32_t delta, EOrigin origin) override;
345 
350  void setText(ConstChar16Ptr newText, int32_t newTextLength);
351 
359  virtual void getText(UnicodeString& result) override;
360 
366  static UClassID U_EXPORT2 getStaticClassID(void);
367 
373  virtual UClassID getDynamicClassID(void) const override;
374 
375 protected:
385  const char16_t* text;
386 
387 };
388 
389 U_NAMESPACE_END
390 
391 #endif /* U_SHOW_CPLUSPLUS_API */
392 
393 #endif
C++ API: Character Iterator.
Abstract class that defines an API for iteration on text objects.
Definition: chariter.h:361
EOrigin
Origin enumeration for the move() and move32() functions.
Definition: chariter.h:367
const char16_t * wrapper with implicit conversion from distinct but bit-compatible pointer types.
Definition: char16ptr.h:149
Abstract class that defines an API for forward-only iteration on text objects.
Definition: chariter.h:94
A concrete subclass of CharacterIterator that iterates over the characters (code units or code points...
Definition: uchriter.h:38
virtual UChar32 first32PostInc(void) override
Sets the iterator to refer to the first code point in its iteration range, returns that code point,...
virtual char16_t first(void) override
Sets the iterator to refer to the first code unit in its iteration range, and returns that code unit.
virtual int32_t move(int32_t delta, EOrigin origin) override
Moves the current position relative to the start or end of the iteration range, or relative to the cu...
virtual char16_t current(void) const override
Returns the code unit the iterator currently refers to.
virtual UChar32 first32(void) override
Sets the iterator to refer to the first code point in its iteration range, and returns that code unit...
UCharCharacterIterator(ConstChar16Ptr textPtr, int32_t length, int32_t textBegin, int32_t textEnd, int32_t position)
Create an iterator over the char16_t array referred to by "textPtr".
UCharCharacterIterator(const UCharCharacterIterator &that)
Copy constructor.
void setText(ConstChar16Ptr newText, int32_t newTextLength)
Sets the iterator to iterate over a new range of text.
virtual UChar32 previous32(void) override
Advances to the previous code point in the iteration range (toward startIndex()), and returns that co...
virtual UChar32 setIndex32(int32_t position) override
Sets the iterator to refer to the beginning of the code point that contains the "position"-th code un...
UCharCharacterIterator(ConstChar16Ptr textPtr, int32_t length, int32_t position)
Create an iterator over the char16_t array referred to by "textPtr".
virtual UChar32 next32PostInc(void) override
Gets the current code point for returning and advances to the next code point in the iteration range ...
virtual char16_t firstPostInc(void) override
Sets the iterator to refer to the first code unit in its iteration range, returns that code unit,...
virtual int32_t move32(int32_t delta, EOrigin origin) override
Moves the current position relative to the start or end of the iteration range, or relative to the cu...
virtual UChar32 last32(void) override
Sets the iterator to refer to the last code point in its iteration range, and returns that code unit.
virtual UCharCharacterIterator * clone() const override
Returns a new UCharCharacterIterator referring to the same character in the same range of the same st...
virtual bool operator==(const ForwardCharacterIterator &that) const override
Returns true if the iterators iterate over the same range of the same string and are pointing at the ...
static UClassID getStaticClassID(void)
Return a class ID for this class (not really public)
virtual void getText(UnicodeString &result) override
Copies the char16_t array under iteration into the UnicodeString referred to by "result".
virtual UChar32 current32(void) const override
Returns the code point the iterator currently refers to.
UCharCharacterIterator & operator=(const UCharCharacterIterator &that)
Assignment operator.
virtual char16_t last(void) override
Sets the iterator to refer to the last code unit in its iteration range, and returns that code unit.
virtual char16_t previous(void) override
Advances to the previous code unit in the iteration range (toward startIndex()), and returns that cod...
virtual ~UCharCharacterIterator()
Destructor.
virtual char16_t nextPostInc(void) override
Gets the current code unit for returning and advances to the next code unit in the iteration range (t...
virtual UChar32 next32(void) override
Advances to the next code point in the iteration range (toward endIndex()), and returns that code poi...
virtual UBool hasPrevious() override
Returns false if there are no more code units or code points before the current position in the itera...
virtual char16_t next(void) override
Advances to the next code unit in the iteration range (toward endIndex()), and returns that code unit...
UCharCharacterIterator(ConstChar16Ptr textPtr, int32_t length)
Create an iterator over the char16_t array referred to by "textPtr".
virtual int32_t hashCode(void) const override
Generates a hash code for this iterator.
const char16_t * text
Protected member text.
Definition: uchriter.h:385
UCharCharacterIterator()
Protected constructor.
virtual UBool hasNext() override
Returns false if there are no more code units or code points at or after the current position in the ...
virtual char16_t setIndex(int32_t position) override
Sets the iterator to refer to the "position"-th code unit in the text-storage object the iterator ref...
virtual UClassID getDynamicClassID(void) const override
Return a class ID for this object (not really public)
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:467
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
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:300