1 // © 2016 and later: Unicode, Inc. and others. 2 // License & terms of use: http://www.unicode.org/copyright.html 4 ******************************************************************** 6 * Copyright (C) 1997-2011, International Business Machines 7 * Corporation and others. All Rights Reserved. 9 ******************************************************************** 17 #if U_SHOW_CPLUSPLUS_API 101 enum { DONE = 0xffff };
432 inline int32_t setToStart();
459 inline int32_t setToEnd();
558 inline int32_t startIndex()
const;
569 inline int32_t endIndex()
const;
579 inline int32_t getIndex()
const;
587 inline int32_t getLength()
const;
614 // One of the system headers right now is sometimes defining a conflicting macro we don't use 701 CharacterIterator::setToStart() {
702 return move(0, kStart);
706 CharacterIterator::setToEnd() {
707 return move(0, kEnd);
711 CharacterIterator::startIndex()
const{
716 CharacterIterator::endIndex()
const{
721 CharacterIterator::getIndex()
const{
726 CharacterIterator::getLength()
const{
732 #endif/* U_SHOW_CPLUSPLUS_API */ Abstract class that defines an API for iteration on text objects.
virtual char16_t firstPostInc()
Sets the iterator to refer to the first code unit in its iteration range, returns that code unit,...
EOrigin
Origin enumeration for the move() and move32() functions.
int32_t textLength
Base class text length field.
virtual UChar32 previous32()=0
Advances to the previous code point in the iteration range (toward startIndex()), and returns that co...
CharacterIterator(int32_t length, int32_t position)
Constructor, just setting the length and position fields in this base class.
virtual char16_t last()=0
Sets the iterator to refer to the last code unit in its iteration range, and returns that code unit.
virtual void getText(UnicodeString &result)=0
Copies the text under iteration into the UnicodeString referred to by "result".
virtual int32_t move(int32_t delta, EOrigin origin)=0
Moves the current position relative to the start or end of the iteration range, or relative to the cu...
virtual UChar32 first32()=0
Sets the iterator to refer to the first code point in its iteration range, and returns that code unit...
virtual char16_t next()=0
Advances to the next code unit in the iteration range (toward endIndex()), and returns that code unit...
virtual UChar32 last32()=0
Sets the iterator to refer to the last code point in its iteration range, and returns that code unit.
virtual ~CharacterIterator()
Destructor.
virtual char16_t current() const =0
Returns the code unit the iterator currently refers to.
virtual UChar32 setIndex32(int32_t position)=0
Sets the iterator to refer to the beginning of the code point that contains the "position"-th code un...
int32_t begin
Base class field for the start of the iteration range.
CharacterIterator(int32_t length)
Constructor, just setting the length field in this base class.
virtual CharacterIterator * clone() const =0
Returns a pointer to a new CharacterIterator of the same concrete class as this one,...
int32_t pos
Base class field for the current position.
virtual UChar32 next32()=0
Advances to the next code point in the iteration range (toward endIndex()), and returns that code poi...
int32_t end
Base class field for the end of the iteration range.
virtual int32_t move32(int32_t delta, EOrigin origin)=0
Moves the current position relative to the start or end of the iteration range, or relative to the cu...
virtual UChar32 first32PostInc()
Sets the iterator to refer to the first code point in its iteration range, returns that code point,...
CharacterIterator(const CharacterIterator &that)
Copy constructor.
virtual UChar32 current32() const =0
Returns the code point the iterator currently refers to.
virtual UBool hasPrevious()=0
Returns false if there are no more code units or code points before the current position in the itera...
virtual char16_t previous()=0
Advances to the previous code unit in the iteration range (toward startIndex()), and returns that cod...
virtual char16_t first()=0
Sets the iterator to refer to the first code unit in its iteration range, and returns that code unit.
virtual char16_t setIndex(int32_t position)=0
Sets the iterator to refer to the "position"-th code unit in the text-storage object the iterator ref...
CharacterIterator(int32_t length, int32_t textBegin, int32_t textEnd, int32_t position)
Constructor, just setting the length, start, end, and position fields in this base class.
CharacterIterator()
Empty constructor.
CharacterIterator & operator=(const CharacterIterator &that)
Assignment operator.
Abstract class that defines an API for forward-only iteration on text objects.
virtual UClassID getDynamicClassID() const override=0
Returns a UClassID for this ForwardCharacterIterator ("poor man's RTTI").
virtual ~ForwardCharacterIterator()
Destructor.
virtual UChar32 next32PostInc()=0
Gets the current code point for returning and advances to the next code point in the iteration range ...
virtual int32_t hashCode() const =0
Generates a hash code for this iterator.
ForwardCharacterIterator & operator=(const ForwardCharacterIterator &)
Assignment operator to be overridden in the implementing class.
ForwardCharacterIterator(const ForwardCharacterIterator &other)
Copy constructor to be overridden in the implementing class.
virtual bool operator==(const ForwardCharacterIterator &that) const =0
Returns true when both iterators refer to the same character in the same character-storage object.
ForwardCharacterIterator()
Default constructor to be overridden in the implementing class.
virtual UBool hasNext()=0
Returns false if there are no more code units or code points at or after the current position in the ...
virtual char16_t nextPostInc()=0
Gets the current code unit for returning and advances to the next code unit in the iteration range (t...
UObject is the common ICU "boilerplate" class.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
bool operator!=(const StringPiece &x, const StringPiece &y)
Global operator != for StringPiece.
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
int8_t UBool
The ICU boolean type, a signed-byte integer.
C++ API: Common ICU base class UObject.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
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.
