FM / unicode

/usr/include/unicode

Name	Size	Mode	Actions
alphaindex.h	27158	0644	edit dl rm
appendable.h	8739	0644	edit dl rm
basictz.h	10163	0644	edit dl rm
brkiter.h	28478	0644	edit dl rm
bytestream.h	11013	0644	edit dl rm
bytestrie.h	21268	0644	edit dl rm
bytestriebuilder.h	7640	0644	edit dl rm
calendar.h	108424	0644	edit dl rm
caniter.h	7621	0644	edit dl rm
casemap.h	25933	0644	edit dl rm
char16ptr.h	7393	0644	edit dl rm
chariter.h	24638	0644	edit dl rm
choicfmt.h	24544	0644	edit dl rm
coleitr.h	14102	0644	edit dl rm
coll.h	57615	0644	edit dl rm
compactdecimalformat.h	7047	0644	edit dl rm
curramt.h	3869	0644	edit dl rm
currpinf.h	7479	0644	edit dl rm
currunit.h	4112	0644	edit dl rm
datefmt.h	41690	0644	edit dl rm
dbbi.h	1223	0644	edit dl rm
dcfmtsym.h	21101	0644	edit dl rm
decimfmt.h	89676	0644	edit dl rm
docmain.h	7380	0644	edit dl rm
dtfmtsym.h	39126	0644	edit dl rm
dtintrv.h	3935	0644	edit dl rm
dtitvfmt.h	50448	0644	edit dl rm
dtitvinf.h	19072	0644	edit dl rm
dtptngen.h	26692	0644	edit dl rm
dtrule.h	8898	0644	edit dl rm
edits.h	21237	0644	edit dl rm
enumset.h	2130	0644	edit dl rm
errorcode.h	4956	0644	edit dl rm
fieldpos.h	8906	0644	edit dl rm
filteredbrk.h	5501	0644	edit dl rm
fmtable.h	25020	0644	edit dl rm
format.h	12802	0644	edit dl rm
formattedvalue.h	9987	0644	edit dl rm
fpositer.h	3107	0644	edit dl rm
gender.h	3408	0644	edit dl rm
gregocal.h	32642	0644	edit dl rm
icudataver.h	1049	0644	edit dl rm
icuplug.h	12109	0644	edit dl rm
idna.h	13000	0644	edit dl rm
listformatter.h	9004	0644	edit dl rm
localebuilder.h	11350	0644	edit dl rm
localematcher.h	27467	0644	edit dl rm
localpointer.h	19825	0644	edit dl rm
locdspnm.h	7292	0644	edit dl rm
locid.h	48804	0644	edit dl rm
measfmt.h	11690	0644	edit dl rm
measunit.h	107613	0644	edit dl rm
measure.h	4431	0644	edit dl rm
messagepattern.h	34517	0644	edit dl rm
msgfmt.h	45278	0644	edit dl rm
normalizer2.h	34466	0644	edit dl rm
normlzr.h	31690	0644	edit dl rm
nounit.h	2305	0644	edit dl rm
numberformatter.h	94505	0644	edit dl rm
numberrangeformatter.h	25790	0644	edit dl rm
numfmt.h	51034	0644	edit dl rm
numsys.h	7509	0644	edit dl rm
parseerr.h	3155	0644	edit dl rm
parsepos.h	5699	0644	edit dl rm
platform.h	28768	0644	edit dl rm
plurfmt.h	25847	0644	edit dl rm
plurrule.h	21316	0644	edit dl rm
ptypes.h	3577	0644	edit dl rm
putil.h	6471	0644	edit dl rm
rbbi.h	28413	0644	edit dl rm
rbnf.h	50021	0644	edit dl rm
rbtz.h	16210	0644	edit dl rm
regex.h	86385	0644	edit dl rm
region.h	9402	0644	edit dl rm
reldatefmt.h	22751	0644	edit dl rm
rep.h	9599	0644	edit dl rm
resbund.h	18513	0644	edit dl rm
schriter.h	6511	0644	edit dl rm
scientificnumberformatter.h	6589	0644	edit dl rm
search.h	22755	0644	edit dl rm
selfmt.h	14686	0644	edit dl rm
simpleformatter.h	12888	0644	edit dl rm
simpletz.h	46798	0644	edit dl rm
smpdtfmt.h	72778	0644	edit dl rm
sortkey.h	11452	0644	edit dl rm
std_string.h	1076	0644	edit dl rm
strenum.h	10157	0644	edit dl rm
stringoptions.h	5926	0644	edit dl rm
stringpiece.h	10287	0644	edit dl rm
stringtriebuilder.h	15842	0644	edit dl rm
stsearch.h	21926	0644	edit dl rm
symtable.h	4374	0644	edit dl rm
tblcoll.h	37801	0644	edit dl rm
timezone.h	44858	0644	edit dl rm
tmunit.h	3479	0644	edit dl rm
tmutamt.h	5029	0644	edit dl rm
tmutfmt.h	7602	0644	edit dl rm
translit.h	67397	0644	edit dl rm
tzfmt.h	43961	0644	edit dl rm
tznames.h	17251	0644	edit dl rm
tzrule.h	36450	0644	edit dl rm
tztrans.h	6278	0644	edit dl rm
ubidi.h	91759	0644	edit dl rm
ubiditransform.h	13003	0644	edit dl rm
ubrk.h	25043	0644	edit dl rm
ucal.h	62463	0644	edit dl rm
ucasemap.h	15579	0644	edit dl rm
ucat.h	5478	0644	edit dl rm
uchar.h	148111	0644	edit dl rm
ucharstrie.h	23066	0644	edit dl rm
ucharstriebuilder.h	7645	0644	edit dl rm
uchriter.h	13747	0644	edit dl rm
uclean.h	11468	0644	edit dl rm
ucnv.h	85051	0644	edit dl rm
ucnvsel.h	6339	0644	edit dl rm
ucnv_cb.h	6738	0644	edit dl rm
ucnv_err.h	21481	0644	edit dl rm
ucol.h	62987	0644	edit dl rm
ucoleitr.h	10056	0644	edit dl rm
uconfig.h	12356	0644	edit dl rm
ucpmap.h	5663	0644	edit dl rm
ucptrie.h	23044	0644	edit dl rm
ucsdet.h	15043	0644	edit dl rm
ucurr.h	17122	0644	edit dl rm
udat.h	63902	0644	edit dl rm
udata.h	16004	0644	edit dl rm
udateintervalformat.h	12218	0644	edit dl rm
udatpg.h	27405	0644	edit dl rm
udisplaycontext.h	6084	0644	edit dl rm
uenum.h	7981	0644	edit dl rm
ufieldpositer.h	4513	0644	edit dl rm
uformattable.h	11233	0644	edit dl rm
uformattedvalue.h	12600	0644	edit dl rm
ugender.h	2106	0644	edit dl rm
uidna.h	34229	0644	edit dl rm
uiter.h	23299	0644	edit dl rm
uldnames.h	10733	0644	edit dl rm
ulistformatter.h	11043	0644	edit dl rm
uloc.h	55936	0644	edit dl rm
ulocdata.h	11572	0644	edit dl rm
umachine.h	16439	0644	edit dl rm
umisc.h	1365	0644	edit dl rm
umsg.h	24832	0644	edit dl rm
umutablecptrie.h	8490	0644	edit dl rm
unifilt.h	4091	0644	edit dl rm
unifunct.h	4151	0644	edit dl rm
unimatch.h	6244	0644	edit dl rm
unirepl.h	3464	0644	edit dl rm
uniset.h	68108	0644	edit dl rm
unistr.h	174627	0644	edit dl rm
unorm.h	21042	0644	edit dl rm
unorm2.h	25269	0644	edit dl rm
unum.h	56269	0644	edit dl rm
unumberformatter.h	31177	0644	edit dl rm
unumberrangeformatter.h	15737	0644	edit dl rm
unumsys.h	7430	0644	edit dl rm
uobject.h	10934	0644	edit dl rm
upluralrules.h	8997	0644	edit dl rm
uregex.h	73719	0644	edit dl rm
uregion.h	10047	0644	edit dl rm
ureldatefmt.h	17448	0644	edit dl rm
urename.h	137853	0644	edit dl rm
urep.h	5507	0644	edit dl rm
ures.h	37418	0644	edit dl rm
uscript.h	28291	0644	edit dl rm
usearch.h	40153	0644	edit dl rm
uset.h	45503	0644	edit dl rm
usetiter.h	9910	0644	edit dl rm
ushape.h	18430	0644	edit dl rm
uspoof.h	67425	0644	edit dl rm
usprep.h	8382	0644	edit dl rm
ustdio.h	39482	0644	edit dl rm
ustream.h	1934	0644	edit dl rm
ustring.h	74096	0644	edit dl rm
ustringtrie.h	3224	0644	edit dl rm
utext.h	59471	0644	edit dl rm
utf.h	8057	0644	edit dl rm
utf8.h	31572	0644	edit dl rm
utf16.h	23910	0644	edit dl rm
utf32.h	763	0644	edit dl rm
utf_old.h	46929	0644	edit dl rm
utmscale.h	14107	0644	edit dl rm
utrace.h	17595	0644	edit dl rm
utrans.h	26157	0644	edit dl rm
utypes.h	31807	0644	edit dl rm
uvernum.h	6839	0644	edit dl rm
uversion.h	6137	0644	edit dl rm
vtzone.h	21303	0644	edit dl rm

Edit: /usr/include/unicode/chariter.h (24638B)

// © 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 bool 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 bool 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 override = 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 bool
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

cmd: