golden hour

/opt/alt/libicu65/usr/include/unicode

File/Folder	Size	Actions
alphaindex.h	26.48 KB
appendable.h	8.49 KB
basictz.h	9.15 KB
brkiter.h	27.8 KB
bytestream.h	9.6 KB
bytestrie.h	20.77 KB
bytestriebuilder.h	7.08 KB
calendar.h	105.74 KB
caniter.h	7.43 KB
casemap.h	25.33 KB
char16ptr.h	7.22 KB
chariter.h	24.05 KB
choicfmt.h	23.91 KB
coleitr.h	13.76 KB
coll.h	56.23 KB
compactdecimalformat.h	6.88 KB
curramt.h	3.76 KB
currpinf.h	7.3 KB
currunit.h	4.05 KB
datefmt.h	40.67 KB
dbbi.h	1.19 KB
dcfmtsym.h	20.13 KB
decimfmt.h	87.38 KB
docmain.h	6.97 KB
dtfmtsym.h	37.7 KB
dtintrv.h	3.84 KB
dtitvfmt.h	46.63 KB
dtitvinf.h	18.51 KB
dtptngen.h	25.08 KB
dtrule.h	8.68 KB
edits.h	20.74 KB
enumset.h	2.08 KB
errorcode.h	4.84 KB
fieldpos.h	8.69 KB
filteredbrk.h	5.37 KB
fmtable.h	24.42 KB
format.h	12.5 KB
formattedvalue.h	10.27 KB
fpositer.h	3.04 KB
gender.h	3.33 KB
gregocal.h	31.71 KB
icudataver.h	1.03 KB
icuplug.h	11.88 KB
idna.h	12.7 KB
listformatter.h	9.47 KB
localebuilder.h	11.27 KB
localematcher.h	22.5 KB
localpointer.h	19.69 KB
locdspnm.h	7.12 KB
locid.h	47.4 KB
measfmt.h	11.33 KB
measunit.h	93.31 KB
measure.h	4.32 KB
messagepattern.h	33.71 KB
msgfmt.h	44.11 KB
normalizer2.h	34.03 KB
normlzr.h	30.94 KB
nounit.h	2.69 KB
numberformatter.h	86.31 KB
numberrangeformatter.h	30.14 KB
numfmt.h	49.81 KB
numsys.h	7.19 KB
parseerr.h	3.08 KB
parsepos.h	5.56 KB
platform.h	28.08 KB
plurfmt.h	25.2 KB
plurrule.h	18.39 KB
ptypes.h	3.49 KB
putil.h	6.33 KB
rbbi.h	26.58 KB
rbnf.h	48.73 KB
rbtz.h	15.6 KB
regex.h	84.36 KB
region.h	9.18 KB
reldatefmt.h	22.62 KB
rep.h	9.37 KB
resbund.h	18.07 KB
schriter.h	6.32 KB
scientificnumberformatter.h	6.4 KB
search.h	22.22 KB
selfmt.h	14.3 KB
simpleformatter.h	12.59 KB
simpletz.h	45.44 KB
smpdtfmt.h	70.97 KB
sortkey.h	11.18 KB
std_string.h	1.05 KB
strenum.h	9.92 KB
stringoptions.h	5.79 KB
stringpiece.h	7.38 KB
stringtriebuilder.h	15.33 KB
stsearch.h	21.3 KB
symtable.h	4.27 KB
tblcoll.h	36.61 KB
timezone.h	41.02 KB
tmunit.h	3.38 KB
tmutamt.h	4.9 KB
tmutfmt.h	7.85 KB
translit.h	65.82 KB
tzfmt.h	42.89 KB
tznames.h	16.85 KB
tzrule.h	35.37 KB
tztrans.h	6.12 KB
ubidi.h	89.56 KB
ubiditransform.h	12.65 KB
ubrk.h	23.97 KB
ucal.h	56.9 KB
ucasemap.h	15.18 KB
ucat.h	5.36 KB
uchar.h	140.56 KB
ucharstrie.h	22.58 KB
ucharstriebuilder.h	7.21 KB
uchriter.h	13.2 KB
uclean.h	11.21 KB
ucnv.h	83.09 KB
ucnv_cb.h	6.59 KB
ucnv_err.h	20.99 KB
ucnvsel.h	6.14 KB
ucol.h	61.46 KB
ucoleitr.h	9.46 KB
uconfig.h	12.07 KB
ucpmap.h	5.53 KB
ucptrie.h	22.46 KB
ucsdet.h	14.67 KB
ucurr.h	16.12 KB
udat.h	60.88 KB
udata.h	15.56 KB
udateintervalformat.h	10.03 KB
udatpg.h	26.01 KB
udisplaycontext.h	5.89 KB
uenum.h	7.78 KB
ufieldpositer.h	4.36 KB
uformattable.h	10.94 KB
uformattedvalue.h	12.14 KB
ugender.h	2 KB
uidna.h	33.37 KB
uiter.h	22.77 KB
uldnames.h	10.45 KB
ulistformatter.h	8.83 KB
uloc.h	52.54 KB
ulocdata.h	11.26 KB
umachine.h	14.53 KB
umisc.h	1.33 KB
umsg.h	24.23 KB
umutablecptrie.h	8.24 KB
unifilt.h	3.96 KB
unifunct.h	4.04 KB
unimatch.h	6.1 KB
unirepl.h	3.38 KB
uniset.h	64.9 KB
unistr.h	170.43 KB
unorm.h	20.52 KB
unorm2.h	24.66 KB
unum.h	53.62 KB
unumberformatter.h	25.36 KB
unumsys.h	7.21 KB
uobject.h	10.68 KB
upluralrules.h	7.88 KB
uregex.h	72.05 KB
uregion.h	9.84 KB
ureldatefmt.h	17.26 KB
urename.h	130.97 KB
urep.h	5.38 KB
ures.h	36.54 KB
uscript.h	26.87 KB
usearch.h	38.12 KB
uset.h	40 KB
usetiter.h	9.55 KB
ushape.h	18 KB
uspoof.h	65.9 KB
usprep.h	8.14 KB
ustdio.h	38.54 KB
ustream.h	1.89 KB
ustring.h	72.47 KB
ustringtrie.h	3.15 KB
utext.h	58.13 KB
utf.h	7.86 KB
utf16.h	23.32 KB
utf32.h	763 B
utf8.h	30.96 KB
utf_old.h	45.83 KB
utmscale.h	13.78 KB
utrace.h	15.73 KB
utrans.h	25.52 KB
utypes.h	30.74 KB
uvernum.h	6.67 KB
uversion.h	6 KB
vtzone.h	20.3 KB

Edit: chariter.h

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
********************************************************************
*
*   Copyright (C) 1997-2011, International Business Machines
*   Corporation and others.  All Rights Reserved.
*
********************************************************************
*/

#ifndef CHARITER_H
#define CHARITER_H

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

#include "unicode/uobject.h"
#include "unicode/unistr.h"
/**
 * \file
 * \brief C++ API: Character Iterator
 */
 
U_NAMESPACE_BEGIN
/**
 * Abstract class that defines an API for forward-only iteration
 * on text objects.
 * This is a minimal interface for iteration without random access
 * or backwards iteration. It is especially useful for wrapping
 * streams with converters into an object for collation or
 * normalization.
 *
 * Characters can be accessed in two ways: as code units or as
 * code points.
 * Unicode code points are 21-bit integers and are the scalar values
 * of Unicode characters. ICU uses the type UChar32 for them.
 * Unicode code units are the storage units of a given
 * Unicode/UCS Transformation Format (a character encoding scheme).
 * With UTF-16, all code points can be represented with either one
 * or two code units ("surrogates").
 * String storage is typically based on code units, while properties
 * of characters are typically determined using code point values.
 * Some processes may be designed to work with sequences of code units,
 * or it may be known that all characters that are important to an
 * algorithm can be represented with single code units.
 * Other processes will need to use the code point access functions.
 *
 * ForwardCharacterIterator provides nextPostInc() to access
 * a code unit and advance an internal position into the text object,
 * similar to a <code>return text[position++]</code>. 
 * It provides next32PostInc() to access a code point and advance an internal
 * position.
 *
 * next32PostInc() assumes that the current position is that of
 * the beginning of a code point, i.e., of its first code unit.
 * After next32PostInc(), this will be true again.
 * In general, access to code units and code points in the same
 * iteration loop should not be mixed. In UTF-16, if the current position
 * is on a second code unit (Low Surrogate), then only that code unit
 * is returned even by next32PostInc().
 *
 * For iteration with either function, there are two ways to
 * check for the end of the iteration. When there are no more
 * characters in the text object:
 * <ul>
 * <li>The hasNext() function returns FALSE.</li>
 * <li>nextPostInc() and next32PostInc() return DONE
 * when one attempts to read beyond the end of the text object.</li>
 * </ul>
 *
 * Example:
 * \code 
 * void function1(ForwardCharacterIterator &it) {
 * UChar32 c;
 * while(it.hasNext()) {
 * c=it.next32PostInc();
 * // use c
 * }
 * }
 *
 * void function1(ForwardCharacterIterator &it) {
 * char16_t c;
 * while((c=it.nextPostInc())!=ForwardCharacterIterator::DONE) {
 * // use c
 * }
 * }
 * \endcode
 * 
 *
 * @stable ICU 2.0
 */
class U_COMMON_API ForwardCharacterIterator : public UObject {
public:
 /**
 * Value returned by most of ForwardCharacterIterator's functions
 * when the iterator has reached the limits of its iteration.
 * @stable ICU 2.0
 */
 enum { DONE = 0xffff };
 
 /**
 * Destructor. 
 * @stable ICU 2.0
 */
 virtual ~ForwardCharacterIterator();
 
 /**
 * Returns true when both iterators refer to the same
 * character in the same character-storage object. 
 * @param that The ForwardCharacterIterator to be compared for equality
 * @return true when both iterators refer to the same
 * character in the same character-storage object
 * @stable ICU 2.0
 */
 virtual UBool operator==(const ForwardCharacterIterator& that) const = 0;
 
 /**
 * Returns true when the iterators refer to different
 * text-storage objects, or to different characters in the
 * same text-storage object. 
 * @param that The ForwardCharacterIterator to be compared for inequality
 * @return true when the iterators refer to different
 * text-storage objects, or to different characters in the
 * same text-storage object
 * @stable ICU 2.0
 */
 inline UBool operator!=(const ForwardCharacterIterator& that) const;
 
 /**
 * Generates a hash code for this iterator. 
 * @return the hash code.
 * @stable ICU 2.0
 */
 virtual int32_t hashCode(void) const = 0;
 
 /**
 * Returns a UClassID for this ForwardCharacterIterator ("poor man's
 * RTTI"). Despite the fact that this function is public,
 * DO NOT CONSIDER IT PART OF CHARACTERITERATOR'S API! 
 * @return a UClassID for this ForwardCharacterIterator 
 * @stable ICU 2.0
 */
 virtual UClassID getDynamicClassID(void) const = 0;
 
 /**
 * Gets the current code unit for returning and advances to the next code unit
 * in the iteration range
 * (toward endIndex()). If there are
 * no more code units to return, returns DONE.
 * @return the current code unit.
 * @stable ICU 2.0
 */
 virtual char16_t nextPostInc(void) = 0;
 
 /**
 * Gets the current code point for returning and advances to the next code point
 * in the iteration range
 * (toward endIndex()). If there are
 * no more code points to return, returns DONE.
 * @return the current code point.
 * @stable ICU 2.0
 */
 virtual UChar32 next32PostInc(void) = 0;
 
 /**
 * Returns FALSE if there are no more code units or code points
 * at or after the current position in the iteration range.
 * This is used with nextPostInc() or next32PostInc() in forward
 * iteration.
 * @returns FALSE if there are no more code units or code points
 * at or after the current position in the iteration range.
 * @stable ICU 2.0
 */
 virtual UBool hasNext() = 0;
 
protected:
 /** Default constructor to be overridden in the implementing class. @stable ICU 2.0*/
 ForwardCharacterIterator();
 
 /** Copy constructor to be overridden in the implementing class. @stable ICU 2.0*/
 ForwardCharacterIterator(const ForwardCharacterIterator &other);
 
 /**
 * Assignment operator to be overridden in the implementing class.
 * @stable ICU 2.0
 */
 ForwardCharacterIterator &operator=(const ForwardCharacterIterator&) { return *this; }
};

/**
 * Abstract class that defines an API for iteration
 * on text objects.
 * This is an interface for forward and backward iteration
 * and random access into a text object.
 *
 * The API provides backward compatibility to the Java and older ICU
 * CharacterIterator classes but extends them significantly:
 * <ol>
 * <li>CharacterIterator is now a subclass of ForwardCharacterIterator.</li>
 * <li>While the old API functions provided forward iteration with
 * "pre-increment" semantics, the new one also provides functions
 * with "post-increment" semantics. They are more efficient and should
 * be the preferred iterator functions for new implementations.
 * The backward iteration always had "pre-decrement" semantics, which
 * are efficient.</li>
 * <li>Just like ForwardCharacterIterator, it provides access to
 * both code units and code points. Code point access versions are available
 * for the old and the new iteration semantics.</li>
 * <li>There are new functions for setting and moving the current position
 * without returning a character, for efficiency.</li>
 * </ol>
 *
 * See ForwardCharacterIterator for examples for using the new forward iteration
 * functions. For backward iteration, there is also a hasPrevious() function
 * that can be used analogously to hasNext().
 * The old functions work as before and are shown below.
 *
 * Examples for some of the new functions:
 *
 * Forward iteration with hasNext():
 * \code
 * void forward1(CharacterIterator &it) {
 * UChar32 c;
 * for(it.setToStart(); it.hasNext();) {
 * c=it.next32PostInc();
 * // use c
 * }
 * }
 * \endcode
 * Forward iteration more similar to loops with the old forward iteration,
 * showing a way to convert simple for() loops:
 * \code
 * void forward2(CharacterIterator &it) {
 * char16_t c;
 * for(c=it.firstPostInc(); c!=CharacterIterator::DONE; c=it.nextPostInc()) {
 * // use c
 * }
 * }
 * \endcode
 * Backward iteration with setToEnd() and hasPrevious():
 * \code
 * void backward1(CharacterIterator &it) {
 * UChar32 c;
 * for(it.setToEnd(); it.hasPrevious();) {
 * c=it.previous32();
 * // use c
 * }
 * }
 * \endcode
 * Backward iteration with a more traditional for() loop:
 * \code
 * void backward2(CharacterIterator &it) {
 * char16_t c;
 * for(c=it.last(); c!=CharacterIterator::DONE; c=it.previous()) {
 * // use c
 * }
 * }
 * \endcode
 *
 * Example for random access:
 * \code
 * void random(CharacterIterator &it) {
 * // set to the third code point from the beginning
 * it.move32(3, CharacterIterator::kStart);
 * // get a code point from here without moving the position
 * UChar32 c=it.current32();
 * // get the position
 * int32_t pos=it.getIndex();
 * // get the previous code unit
 * char16_t u=it.previous();
 * // move back one more code unit
 * it.move(-1, CharacterIterator::kCurrent);
 * // set the position back to where it was
 * // and read the same code point c and move beyond it
 * it.setIndex(pos);
 * if(c!=it.next32PostInc()) {
 * exit(1); // CharacterIterator inconsistent
 * }
 * }
 * \endcode
 *
 * Examples, especially for the old API:
 *
 * Function processing characters, in this example simple output
 * <pre>
 * \code
 * void processChar( char16_t c )
 * {
 * cout << " " << c;
 * }
 * \endcode
 * </pre>
 * Traverse the text from start to finish
 * <pre> 
 * \code
 * void traverseForward(CharacterIterator& iter)
 * {
 * for(char16_t c = iter.first(); c != CharacterIterator.DONE; c = iter.next()) {
 * processChar(c);
 * }
 * }
 * \endcode
 * </pre>
 * Traverse the text backwards, from end to start
 * <pre>
 * \code
 * void traverseBackward(CharacterIterator& iter)
 * {
 * for(char16_t c = iter.last(); c != CharacterIterator.DONE; c = iter.previous()) {
 * processChar(c);
 * }
 * }
 * \endcode
 * </pre>
 * Traverse both forward and backward from a given position in the text. 
 * Calls to notBoundary() in this example represents some additional stopping criteria.
 * <pre>
 * \code
 * void traverseOut(CharacterIterator& iter, int32_t pos)
 * {
 * char16_t c;
 * for (c = iter.setIndex(pos);
 * c != CharacterIterator.DONE && (Unicode::isLetter(c) || Unicode::isDigit(c));
 * c = iter.next()) {}
 * int32_t end = iter.getIndex();
 * for (c = iter.setIndex(pos);
 * c != CharacterIterator.DONE && (Unicode::isLetter(c) || Unicode::isDigit(c));
 * c = iter.previous()) {}
 * int32_t start = iter.getIndex() + 1;
 * 
 * cout << "start: " << start << " end: " << end << endl;
 * for (c = iter.setIndex(start); iter.getIndex() < end; c = iter.next() ) {
 * processChar(c);
 * }
 * }
 * \endcode
 * </pre>
 * Creating a StringCharacterIterator and calling the test functions
 * <pre>
 * \code
 * void CharacterIterator_Example( void )
 * {
 * cout << endl << "===== CharacterIterator_Example: =====" << endl;
 * UnicodeString text("Ein kleiner Satz.");
 * StringCharacterIterator iterator(text);
 * cout << "----- traverseForward: -----------" << endl;
 * traverseForward( iterator );
 * cout << endl << endl << "----- traverseBackward: ----------" << endl;
 * traverseBackward( iterator );
 * cout << endl << endl << "----- traverseOut: ---------------" << endl;
 * traverseOut( iterator, 7 );
 * cout << endl << endl << "-----" << endl;
 * }
 * \endcode
 * </pre>
 *
 * @stable ICU 2.0
 */
class U_COMMON_API CharacterIterator : public ForwardCharacterIterator {
public:
 /**
 * Origin enumeration for the move() and move32() functions.
 * @stable ICU 2.0
 */
 enum EOrigin { kStart, kCurrent, kEnd };

/**
     * Destructor.
     * @stable ICU 2.0
     */
    virtual ~CharacterIterator();

/**
     * Returns a pointer to a new CharacterIterator of the same
     * concrete class as this one, and referring to the same
     * character in the same text-storage object as this one.  The
     * caller is responsible for deleting the new clone.  
     * @return a pointer to a new CharacterIterator
     * @stable ICU 2.0
     */
    virtual CharacterIterator* clone() const = 0;

/**
     * Sets the iterator to refer to the first code unit in its
     * iteration range, and returns that code unit.
     * This can be used to begin an iteration with next().
     * @return the first code unit in its iteration range.
     * @stable ICU 2.0
     */
    virtual char16_t         first(void) = 0;

/**
     * Sets the iterator to refer to the first code unit in its
     * iteration range, returns that code unit, and moves the position
     * to the second code unit. This is an alternative to setToStart()
     * for forward iteration with nextPostInc().
     * @return the first code unit in its iteration range.
     * @stable ICU 2.0
     */
    virtual char16_t         firstPostInc(void);

/**
     * Sets the iterator to refer to the first code point in its
     * iteration range, and returns that code unit,
     * This can be used to begin an iteration with next32().
     * Note that an iteration with next32PostInc(), beginning with,
     * e.g., setToStart() or firstPostInc(), is more efficient.
     * @return the first code point in its iteration range.
     * @stable ICU 2.0
     */
    virtual UChar32       first32(void) = 0;

/**
     * Sets the iterator to refer to the first code point in its
     * iteration range, returns that code point, and moves the position
     * to the second code point. This is an alternative to setToStart()
     * for forward iteration with next32PostInc().
     * @return the first code point in its iteration range.
     * @stable ICU 2.0
     */
    virtual UChar32       first32PostInc(void);

/**
     * Sets the iterator to refer to the first code unit or code point in its
     * iteration range. This can be used to begin a forward
     * iteration with nextPostInc() or next32PostInc().
     * @return the start position of the iteration range
     * @stable ICU 2.0
     */
    inline int32_t    setToStart();

/**
     * Sets the iterator to refer to the last code unit in its
     * iteration range, and returns that code unit.
     * This can be used to begin an iteration with previous().
     * @return the last code unit.
     * @stable ICU 2.0
     */
    virtual char16_t         last(void) = 0;
        
    /**
     * Sets the iterator to refer to the last code point in its
     * iteration range, and returns that code unit.
     * This can be used to begin an iteration with previous32().
     * @return the last code point.
     * @stable ICU 2.0
     */
    virtual UChar32       last32(void) = 0;

/**
     * Sets the iterator to the end of its iteration range, just behind
     * the last code unit or code point. This can be used to begin a backward
     * iteration with previous() or previous32().
     * @return the end position of the iteration range
     * @stable ICU 2.0
     */
    inline int32_t    setToEnd();

/**
     * Sets the iterator to refer to the "position"-th code unit
     * in the text-storage object the iterator refers to, and
     * returns that code unit.  
     * @param position the "position"-th code unit in the text-storage object
     * @return the "position"-th code unit.
     * @stable ICU 2.0
     */
    virtual char16_t         setIndex(int32_t position) = 0;

/**
     * Sets the iterator to refer to the beginning of the code point
     * that contains the "position"-th code unit
     * in the text-storage object the iterator refers to, and
     * returns that code point.
     * The current position is adjusted to the beginning of the code point
     * (its first code unit).
     * @param position the "position"-th code unit in the text-storage object
     * @return the "position"-th code point.
     * @stable ICU 2.0
     */
    virtual UChar32       setIndex32(int32_t position) = 0;

/**
     * Returns the code unit the iterator currently refers to. 
     * @return the current code unit. 
     * @stable ICU 2.0
     */
    virtual char16_t         current(void) const = 0;
        
    /**
     * Returns the code point the iterator currently refers to.  
     * @return the current code point.
     * @stable ICU 2.0
     */
    virtual UChar32       current32(void) const = 0;
        
    /**
     * Advances to the next code unit in the iteration range
     * (toward endIndex()), and returns that code unit.  If there are
     * no more code units to return, returns DONE.
     * @return the next code unit.
     * @stable ICU 2.0
     */
    virtual char16_t         next(void) = 0;
        
    /**
     * Advances to the next code point in the iteration range
     * (toward endIndex()), and returns that code point.  If there are
     * no more code points to return, returns DONE.
     * Note that iteration with "pre-increment" semantics is less
     * efficient than iteration with "post-increment" semantics
     * that is provided by next32PostInc().
     * @return the next code point.
     * @stable ICU 2.0
     */
    virtual UChar32       next32(void) = 0;
        
    /**
     * Advances to the previous code unit in the iteration range
     * (toward startIndex()), and returns that code unit.  If there are
     * no more code units to return, returns DONE.  
     * @return the previous code unit.
     * @stable ICU 2.0
     */
    virtual char16_t         previous(void) = 0;

/**
     * Advances to the previous code point in the iteration range
     * (toward startIndex()), and returns that code point.  If there are
     * no more code points to return, returns DONE. 
     * @return the previous code point. 
     * @stable ICU 2.0
     */
    virtual UChar32       previous32(void) = 0;

/**
     * Returns FALSE if there are no more code units or code points
     * before the current position in the iteration range.
     * This is used with previous() or previous32() in backward
     * iteration.
     * @return FALSE if there are no more code units or code points
     * before the current position in the iteration range, return TRUE otherwise.
     * @stable ICU 2.0
     */
    virtual UBool        hasPrevious() = 0;

/**
     * Returns the numeric index in the underlying text-storage
     * object of the character returned by first().  Since it's
     * possible to create an iterator that iterates across only
     * part of a text-storage object, this number isn't
     * necessarily 0.  
     * @returns the numeric index in the underlying text-storage
     * object of the character returned by first().
     * @stable ICU 2.0
     */
    inline int32_t       startIndex(void) const;
        
    /**
     * Returns the numeric index in the underlying text-storage
     * object of the position immediately BEYOND the character
     * returned by last().  
     * @return the numeric index in the underlying text-storage
     * object of the position immediately BEYOND the character
     * returned by last().
     * @stable ICU 2.0
     */
    inline int32_t       endIndex(void) const;
        
    /**
     * Returns the numeric index in the underlying text-storage
     * object of the character the iterator currently refers to
     * (i.e., the character returned by current()).  
     * @return the numeric index in the text-storage object of 
     * the character the iterator currently refers to
     * @stable ICU 2.0
     */
    inline int32_t       getIndex(void) const;

/**
     * Returns the length of the entire text in the underlying
     * text-storage object.
     * @return the length of the entire text in the text-storage object
     * @stable ICU 2.0
     */
    inline int32_t           getLength() const;

/**
     * Moves the current position relative to the start or end of the
     * iteration range, or relative to the current position itself.
     * The movement is expressed in numbers of code units forward
     * or backward by specifying a positive or negative delta.
     * @param delta the position relative to origin. A positive delta means forward;
     * a negative delta means backward.
     * @param origin Origin enumeration {kStart, kCurrent, kEnd}
     * @return the new position
     * @stable ICU 2.0
     */
    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 current position itself.
     * The movement is expressed in numbers of code points forward
     * or backward by specifying a positive or negative delta.
     * @param delta the position relative to origin. A positive delta means forward;
     * a negative delta means backward.
     * @param origin Origin enumeration {kStart, kCurrent, kEnd}
     * @return the new position
     * @stable ICU 2.0
     */
#ifdef move32
     // One of the system headers right now is sometimes defining a conflicting macro we don't use
#undef move32
#endif
    virtual int32_t      move32(int32_t delta, EOrigin origin) = 0;

/**
     * Copies the text under iteration into the UnicodeString
     * referred to by "result".  
     * @param result Receives a copy of the text under iteration.  
     * @stable ICU 2.0
     */
    virtual void            getText(UnicodeString&  result) = 0;

protected:
    /**
     * Empty constructor.
     * @stable ICU 2.0
     */
    CharacterIterator();

/**
     * Constructor, just setting the length field in this base class.
     * @stable ICU 2.0
     */
    CharacterIterator(int32_t length);

/**
     * Constructor, just setting the length and position fields in this base class.
     * @stable ICU 2.0
     */
    CharacterIterator(int32_t length, int32_t position);

/**
     * Constructor, just setting the length, start, end, and position fields in this base class.
     * @stable ICU 2.0
     */
    CharacterIterator(int32_t length, int32_t textBegin, int32_t textEnd, int32_t position);
  
    /**
     * Copy constructor.
     *
     * @param that The CharacterIterator to be copied
     * @stable ICU 2.0
     */
    CharacterIterator(const CharacterIterator &that);

/**
     * Assignment operator.  Sets this CharacterIterator to have the same behavior,
     * as the one passed in.
     * @param that The CharacterIterator passed in.
     * @return the newly set CharacterIterator.
     * @stable ICU 2.0
     */
    CharacterIterator &operator=(const CharacterIterator &that);

/**
     * Base class text length field.
     * Necessary this for correct getText() and hashCode().
     * @stable ICU 2.0
     */
    int32_t textLength;

/**
     * Base class field for the current position.
     * @stable ICU 2.0
     */
    int32_t  pos;

/**
     * Base class field for the start of the iteration range.
     * @stable ICU 2.0
     */
    int32_t  begin;

/**
     * Base class field for the end of the iteration range.
     * @stable ICU 2.0
     */
    int32_t  end;
};

inline UBool
ForwardCharacterIterator::operator!=(const ForwardCharacterIterator& that) const {
    return !operator==(that);
}

inline int32_t
CharacterIterator::setToStart() {
    return move(0, kStart);
}

inline int32_t
CharacterIterator::setToEnd() {
    return move(0, kEnd);
}

inline int32_t
CharacterIterator::startIndex(void) const {
    return begin;
}

inline int32_t
CharacterIterator::endIndex(void) const {
    return end;
}

inline int32_t
CharacterIterator::getIndex(void) const {
    return pos;
}

inline int32_t
CharacterIterator::getLength(void) const {
    return textLength;
}

U_NAMESPACE_END

#endif /* U_SHOW_CPLUSPLUS_API */

#endif