Gecko [ naturenectar.co.uk ]

Name	Size	Permission	Date
alphaindex.h	26.53 KB	-rw-r--r--	2023-02-22 10:28
appendable.h	8.53 KB	-rw-r--r--	2023-02-22 10:28
basictz.h	9.98 KB	-rw-r--r--	2023-02-22 10:28
brkiter.h	27.81 KB	-rw-r--r--	2023-02-22 10:28
bytestream.h	10.75 KB	-rw-r--r--	2023-02-22 10:28
bytestrie.h	20.78 KB	-rw-r--r--	2023-02-22 10:28
bytestriebuilder.h	7.48 KB	-rw-r--r--	2023-02-22 10:28
calendar.h	102.25 KB	-rw-r--r--	2023-02-22 10:28
caniter.h	7.47 KB	-rw-r--r--	2023-02-22 10:28
casemap.h	25.33 KB	-rw-r--r--	2023-02-22 10:28
char16ptr.h	7.22 KB	-rw-r--r--	2023-02-22 10:28
chariter.h	24.06 KB	-rw-r--r--	2023-02-22 10:28
choicfmt.h	23.98 KB	-rw-r--r--	2023-02-22 10:28
coleitr.h	13.78 KB	-rw-r--r--	2023-02-22 10:28
coll.h	56.27 KB	-rw-r--r--	2023-02-22 10:28
compactdecimalformat.h	6.88 KB	-rw-r--r--	2023-02-22 10:28
curramt.h	3.78 KB	-rw-r--r--	2023-02-22 10:28
currpinf.h	7.3 KB	-rw-r--r--	2023-02-22 10:28
currunit.h	4.02 KB	-rw-r--r--	2023-02-22 10:28
datefmt.h	40.71 KB	-rw-r--r--	2023-02-22 10:28
dbbi.h	1.19 KB	-rw-r--r--	2023-02-22 10:28
dcfmtsym.h	20.61 KB	-rw-r--r--	2023-02-22 10:28
decimfmt.h	87.57 KB	-rw-r--r--	2023-02-22 10:28
displayoptions.h	7.11 KB	-rw-r--r--	2023-02-22 10:28
docmain.h	7.21 KB	-rw-r--r--	2023-02-22 10:28
dtfmtsym.h	38.22 KB	-rw-r--r--	2023-02-22 10:28
dtintrv.h	3.85 KB	-rw-r--r--	2023-02-22 10:28
dtitvfmt.h	49.27 KB	-rw-r--r--	2023-02-22 10:28
dtitvinf.h	18.63 KB	-rw-r--r--	2023-02-22 10:28
dtptngen.h	28.69 KB	-rw-r--r--	2023-02-22 10:28
dtrule.h	8.69 KB	-rw-r--r--	2023-02-22 10:28
edits.h	20.74 KB	-rw-r--r--	2023-02-22 10:28
enumset.h	2.08 KB	-rw-r--r--	2023-02-22 10:28
errorcode.h	4.84 KB	-rw-r--r--	2023-02-22 10:28
fieldpos.h	8.7 KB	-rw-r--r--	2023-02-22 10:28
filteredbrk.h	5.37 KB	-rw-r--r--	2023-02-22 10:28
fmtable.h	24.43 KB	-rw-r--r--	2023-02-22 10:28
format.h	12.5 KB	-rw-r--r--	2023-02-22 10:28
formattedvalue.h	9.75 KB	-rw-r--r--	2023-02-22 10:28
fpositer.h	3.03 KB	-rw-r--r--	2023-02-22 10:28
gender.h	3.35 KB	-rw-r--r--	2023-02-22 10:28
gregocal.h	31.04 KB	-rw-r--r--	2023-02-22 10:28
icudataver.h	1.02 KB	-rw-r--r--	2023-02-22 10:28
icuplug.h	11.83 KB	-rw-r--r--	2023-02-22 10:28
idna.h	12.71 KB	-rw-r--r--	2023-02-22 10:28
listformatter.h	8.61 KB	-rw-r--r--	2023-02-22 10:28
localebuilder.h	11.08 KB	-rw-r--r--	2023-02-22 10:28
localematcher.h	26.84 KB	-rw-r--r--	2023-02-22 10:28
localpointer.h	19.36 KB	-rw-r--r--	2023-02-22 10:28
locdspnm.h	7.12 KB	-rw-r--r--	2023-02-22 10:28
locid.h	47.66 KB	-rw-r--r--	2023-02-22 10:28
measfmt.h	11.42 KB	-rw-r--r--	2023-02-22 10:28
measunit.h	106.33 KB	-rw-r--r--	2023-02-22 10:28
measure.h	4.33 KB	-rw-r--r--	2023-02-22 10:28
messagepattern.h	33.71 KB	-rw-r--r--	2023-02-22 10:28
msgfmt.h	44.17 KB	-rw-r--r--	2023-02-22 10:28
normalizer2.h	33.66 KB	-rw-r--r--	2023-02-22 10:28
normlzr.h	30.96 KB	-rw-r--r--	2023-02-22 10:28
nounit.h	2.25 KB	-rw-r--r--	2023-02-22 10:28
numberformatter.h	94.82 KB	-rw-r--r--	2023-02-22 10:28
numberrangeformatter.h	25.02 KB	-rw-r--r--	2023-02-22 10:28
numfmt.h	49.84 KB	-rw-r--r--	2023-02-22 10:28
numsys.h	7.22 KB	-rw-r--r--	2023-02-22 10:28
parseerr.h	3.08 KB	-rw-r--r--	2023-02-22 10:28
parsepos.h	5.57 KB	-rw-r--r--	2023-02-22 10:28
platform.h	28.55 KB	-rw-r--r--	2023-02-22 10:28
plurfmt.h	25.25 KB	-rw-r--r--	2023-02-22 10:28
plurrule.h	20.62 KB	-rw-r--r--	2023-02-22 10:28
ptypes.h	3.49 KB	-rw-r--r--	2023-02-22 10:28
putil.h	6.32 KB	-rw-r--r--	2023-02-22 10:28
rbbi.h	28.46 KB	-rw-r--r--	2023-02-22 10:28
rbnf.h	49.82 KB	-rw-r--r--	2023-02-22 10:28
rbtz.h	15.77 KB	-rw-r--r--	2023-02-22 10:28
regex.h	84.41 KB	-rw-r--r--	2023-02-22 10:28
region.h	9.18 KB	-rw-r--r--	2023-02-22 10:28
reldatefmt.h	22.22 KB	-rw-r--r--	2023-02-22 10:28
rep.h	9.37 KB	-rw-r--r--	2023-02-22 10:28
resbund.h	18.09 KB	-rw-r--r--	2023-02-22 10:28
schriter.h	6.1 KB	-rw-r--r--	2023-02-22 10:28
scientificnumberformatter.h	6.44 KB	-rw-r--r--	2023-02-22 10:28
search.h	22.22 KB	-rw-r--r--	2023-02-22 10:28
selfmt.h	14.35 KB	-rw-r--r--	2023-02-22 10:28
simpleformatter.h	12.59 KB	-rw-r--r--	2023-02-22 10:28
simpletz.h	45.65 KB	-rw-r--r--	2023-02-22 10:28
smpdtfmt.h	71.93 KB	-rw-r--r--	2023-02-22 10:28
sortkey.h	11.18 KB	-rw-r--r--	2023-02-22 10:28
std_string.h	1.05 KB	-rw-r--r--	2023-02-22 10:28
strenum.h	9.92 KB	-rw-r--r--	2023-02-22 10:28
stringoptions.h	5.79 KB	-rw-r--r--	2023-02-22 10:28
stringpiece.h	10.05 KB	-rw-r--r--	2023-02-22 10:28
stringtriebuilder.h	15.47 KB	-rw-r--r--	2023-02-22 10:28
stsearch.h	21.42 KB	-rw-r--r--	2023-02-22 10:28
symtable.h	4.27 KB	-rw-r--r--	2023-02-22 10:28
tblcoll.h	36.92 KB	-rw-r--r--	2023-02-22 10:28
timezone.h	43.81 KB	-rw-r--r--	2023-02-22 10:28
tmunit.h	3.4 KB	-rw-r--r--	2023-02-22 10:28
tmutamt.h	4.91 KB	-rw-r--r--	2023-02-22 10:28
tmutfmt.h	7.42 KB	-rw-r--r--	2023-02-22 10:28
translit.h	65.82 KB	-rw-r--r--	2023-02-22 10:28
tzfmt.h	42.93 KB	-rw-r--r--	2023-02-22 10:28
tznames.h	16.85 KB	-rw-r--r--	2023-02-22 10:28
tzrule.h	34.86 KB	-rw-r--r--	2023-02-22 10:28
tztrans.h	6.13 KB	-rw-r--r--	2023-02-22 10:28
ubidi.h	89.61 KB	-rw-r--r--	2023-02-22 10:28
ubiditransform.h	12.71 KB	-rw-r--r--	2023-02-22 10:28
ubrk.h	24.43 KB	-rw-r--r--	2023-02-22 10:28
ucal.h	60.68 KB	-rw-r--r--	2023-02-22 10:28
ucasemap.h	15.21 KB	-rw-r--r--	2023-02-22 10:28
ucat.h	5.35 KB	-rw-r--r--	2023-02-22 10:28
uchar.h	145.09 KB	-rw-r--r--	2023-02-22 10:28
ucharstrie.h	22.53 KB	-rw-r--r--	2023-02-22 10:28
ucharstriebuilder.h	7.48 KB	-rw-r--r--	2023-02-22 10:28
uchriter.h	13.42 KB	-rw-r--r--	2023-02-22 10:28
uclean.h	11.2 KB	-rw-r--r--	2023-02-22 10:28
ucnv.h	83.46 KB	-rw-r--r--	2023-02-22 10:28
ucnv_cb.h	6.58 KB	-rw-r--r--	2023-02-22 10:28
ucnv_err.h	20.98 KB	-rw-r--r--	2023-02-22 10:28
ucnvsel.h	6.24 KB	-rw-r--r--	2023-02-22 10:28
ucol.h	61.95 KB	-rw-r--r--	2023-02-22 10:28
ucoleitr.h	9.82 KB	-rw-r--r--	2023-02-22 10:28
uconfig.h	12.07 KB	-rw-r--r--	2023-02-22 10:28
ucpmap.h	5.54 KB	-rw-r--r--	2023-02-22 10:28
ucptrie.h	22.51 KB	-rw-r--r--	2023-02-22 10:28
ucsdet.h	14.69 KB	-rw-r--r--	2023-02-22 10:28
ucurr.h	16.72 KB	-rw-r--r--	2023-02-22 10:28
udat.h	62.36 KB	-rw-r--r--	2023-02-22 10:28
udata.h	15.63 KB	-rw-r--r--	2023-02-22 10:28
udateintervalformat.h	11.93 KB	-rw-r--r--	2023-02-22 10:28
udatpg.h	30.18 KB	-rw-r--r--	2023-02-22 10:28
udisplaycontext.h	5.94 KB	-rw-r--r--	2023-02-22 10:28
udisplayoptions.h	8.8 KB	-rw-r--r--	2023-02-22 10:28
uenum.h	7.79 KB	-rw-r--r--	2023-02-22 10:28
ufieldpositer.h	4.41 KB	-rw-r--r--	2023-02-22 10:28
uformattable.h	10.97 KB	-rw-r--r--	2023-02-22 10:28
uformattedvalue.h	12.25 KB	-rw-r--r--	2023-02-22 10:28
ugender.h	2.06 KB	-rw-r--r--	2023-02-22 10:28
uidna.h	33.43 KB	-rw-r--r--	2023-02-22 10:28
uiter.h	22.75 KB	-rw-r--r--	2023-02-22 10:28
uldnames.h	10.48 KB	-rw-r--r--	2023-02-22 10:28
ulistformatter.h	10.78 KB	-rw-r--r--	2023-02-22 10:28
uloc.h	54.66 KB	-rw-r--r--	2023-02-22 10:28
ulocdata.h	11.3 KB	-rw-r--r--	2023-02-22 10:28
umachine.h	15.73 KB	-rw-r--r--	2023-02-22 10:28
umisc.h	1.34 KB	-rw-r--r--	2023-02-22 10:28
umsg.h	24.25 KB	-rw-r--r--	2023-02-22 10:28
umutablecptrie.h	8.3 KB	-rw-r--r--	2023-02-22 10:28
unifilt.h	4 KB	-rw-r--r--	2023-02-22 10:28
unifunct.h	4.05 KB	-rw-r--r--	2023-02-22 10:28
unimatch.h	6.1 KB	-rw-r--r--	2023-02-22 10:28
unirepl.h	3.38 KB	-rw-r--r--	2023-02-22 10:28
uniset.h	66.12 KB	-rw-r--r--	2023-02-22 10:28
unistr.h	170.53 KB	-rw-r--r--	2023-02-22 10:28
unorm.h	20.55 KB	-rw-r--r--	2023-02-22 10:28
unorm2.h	24.68 KB	-rw-r--r--	2023-02-22 10:28
unum.h	56.6 KB	-rw-r--r--	2023-02-22 10:28
unumberformatter.h	30.26 KB	-rw-r--r--	2023-02-22 10:28
unumberrangeformatter.h	15.35 KB	-rw-r--r--	2023-02-22 10:28
unumsys.h	7.26 KB	-rw-r--r--	2023-02-22 10:28
uobject.h	10.68 KB	-rw-r--r--	2023-02-22 10:28
upluralrules.h	8.79 KB	-rw-r--r--	2023-02-22 10:28
uregex.h	71.99 KB	-rw-r--r--	2023-02-22 10:28
uregion.h	9.81 KB	-rw-r--r--	2023-02-22 10:28
ureldatefmt.h	17.04 KB	-rw-r--r--	2023-02-22 10:28
urename.h	135.69 KB	-rw-r--r--	2023-02-22 10:28
urep.h	5.38 KB	-rw-r--r--	2023-02-22 10:28
ures.h	36.54 KB	-rw-r--r--	2023-02-22 10:28
uscript.h	27.8 KB	-rw-r--r--	2023-02-22 10:28
usearch.h	39.21 KB	-rw-r--r--	2023-02-22 10:28
uset.h	44.19 KB	-rw-r--r--	2023-02-22 10:28
usetiter.h	9.63 KB	-rw-r--r--	2023-02-22 10:28
ushape.h	18 KB	-rw-r--r--	2023-02-22 10:28
uspoof.h	65.84 KB	-rw-r--r--	2023-02-22 10:28
usprep.h	8.19 KB	-rw-r--r--	2023-02-22 10:28
ustdio.h	38.56 KB	-rw-r--r--	2023-02-22 10:28
ustream.h	1.89 KB	-rw-r--r--	2023-02-22 10:28
ustring.h	72.36 KB	-rw-r--r--	2023-02-22 10:28
ustringtrie.h	3.15 KB	-rw-r--r--	2023-02-22 10:28
utext.h	58.08 KB	-rw-r--r--	2023-02-22 10:28
utf.h	7.87 KB	-rw-r--r--	2023-02-22 10:28
utf16.h	23.35 KB	-rw-r--r--	2023-02-22 10:28
utf32.h	763 B	-rw-r--r--	2023-02-22 10:28
utf8.h	30.83 KB	-rw-r--r--	2023-02-22 10:28
utf_old.h	45.8 KB	-rw-r--r--	2023-02-22 10:28
utmscale.h	13.78 KB	-rw-r--r--	2023-02-22 10:28
utrace.h	17.18 KB	-rw-r--r--	2023-02-22 10:28
utrans.h	25.54 KB	-rw-r--r--	2023-02-22 10:28
utypes.h	31.06 KB	-rw-r--r--	2023-02-22 10:28
uvernum.h	6.33 KB	-rw-r--r--	2023-02-22 10:28
uversion.h	5.99 KB	-rw-r--r--	2023-02-22 10:28
vtzone.h	20.68 KB	-rw-r--r--	2023-02-22 10:28

Rename

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

/**
 * \file 
 * \brief C++ API: Collation Element Iterator.
 */

/**
* File coleitr.h
*
* Created by: Helena Shih
*
* Modification History:
*
*  Date       Name        Description
*
*  8/18/97    helena      Added internal API documentation.
* 08/03/98    erm         Synched with 1.2 version CollationElementIterator.java
* 12/10/99    aliu        Ported Thai collation support from Java.
* 01/25/01    swquek      Modified into a C++ wrapper calling C APIs (ucoliter.h)
* 02/19/01    swquek      Removed CollationElementsIterator() since it is 
*                         private constructor and no calls are made to it
* 2012-2014   markus      Rewritten in C++ again.
*/

#ifndef COLEITR_H
#define COLEITR_H

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

#if !UCONFIG_NO_COLLATION

#include "unicode/unistr.h"
#include "unicode/uobject.h"

struct UCollationElements;
struct UHashtable;

U_NAMESPACE_BEGIN

struct CollationData;

class CharacterIterator;
class CollationIterator;
class RuleBasedCollator;
class UCollationPCE;
class UVector32;

/**
* The CollationElementIterator class is used as an iterator to walk through 
* each character of an international string. Use the iterator to return the
* ordering priority of the positioned character. The ordering priority of a 
* character, which we refer to as a key, defines how a character is collated in 
* the given collation object.
* For example, consider the following in Slovak and in traditional Spanish collation:
* <pre>
* "ca" -> the first key is key('c') and second key is key('a').
* "cha" -> the first key is key('ch') and second key is key('a').</pre>
* And in German phonebook collation,
* <pre> \htmlonly "&#x00E6;b"-> the first key is key('a'), the second key is key('e'), and
* the third key is key('b'). \endhtmlonly </pre>
* The key of a character, is an integer composed of primary order(short),
* secondary order(char), and tertiary order(char). Java strictly defines the 
* size and signedness of its primitive data types. Therefore, the static
* functions primaryOrder(), secondaryOrder(), and tertiaryOrder() return 
* int32_t to ensure the correctness of the key value.
* Example of the iterator usage: (without error checking)
* <pre>
* \code
* void CollationElementIterator_Example()
* {
* UnicodeString str = "This is a test";
* UErrorCode success = U_ZERO_ERROR;
* RuleBasedCollator* rbc =
* (RuleBasedCollator*) RuleBasedCollator::createInstance(success);
* CollationElementIterator* c =
* rbc->createCollationElementIterator( str );
* int32_t order = c->next(success);
* c->reset();
* order = c->previous(success);
* delete c;
* delete rbc;
* }
* \endcode
* </pre>
* 
* The method next() returns the collation order of the next character based on
* the comparison level of the collator. The method previous() returns the
* collation order of the previous character based on the comparison level of
* the collator. The Collation Element Iterator moves only in one direction
* between calls to reset(), setOffset(), or setText(). That is, next() 
* and previous() can not be inter-used. Whenever previous() is to be called after 
* next() or vice versa, reset(), setOffset() or setText() has to be called first
* to reset the status, shifting pointers to either the end or the start of
* the string (reset() or setText()), or the specified position (setOffset()).
* Hence at the next call of next() or previous(), the first or last collation order,
* or collation order at the specified position will be returned. If a change of
* direction is done without one of these calls, the result is undefined.
* 
* The result of a forward iterate (next()) and reversed result of the backward
* iterate (previous()) on the same string are equivalent, if collation orders
* with the value 0 are ignored.
* Character based on the comparison level of the collator. A collation order 
* consists of primary order, secondary order and tertiary order. The data 
* type of the collation order is int32_t. 
*
* Note, CollationElementIterator should not be subclassed.
* @see Collator
* @see RuleBasedCollator
* @version 1.8 Jan 16 2001
*/
class U_I18N_API CollationElementIterator U_FINAL : public UObject {
public:

// CollationElementIterator public data member ------------------------------

enum {
        /**
         * NULLORDER indicates that an error has occurred while processing
         * @stable ICU 2.0
         */
        NULLORDER = (int32_t)0xffffffff
    };

// CollationElementIterator public constructor/destructor -------------------

/**
    * Copy constructor.
    *
    * @param other    the object to be copied from
    * @stable ICU 2.0
    */
    CollationElementIterator(const CollationElementIterator& other);

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

// CollationElementIterator public methods ----------------------------------

/**
    * Returns true if "other" is the same as "this"
    *
    * @param other    the object to be compared
    * @return         true if "other" is the same as "this"
    * @stable ICU 2.0
    */
    bool operator==(const CollationElementIterator& other) const;

/**
    * Returns true if "other" is not the same as "this".
    *
    * @param other    the object to be compared
    * @return         true if "other" is not the same as "this"
    * @stable ICU 2.0
    */
    bool operator!=(const CollationElementIterator& other) const;

/**
    * Resets the cursor to the beginning of the string.
    * @stable ICU 2.0
    */
    void reset(void);

/**
    * Gets the ordering priority of the next character in the string.
    * @param status the error code status.
    * @return the next character's ordering. otherwise returns NULLORDER if an 
    *         error has occurred or if the end of string has been reached
    * @stable ICU 2.0
    */
    int32_t next(UErrorCode& status);

/**
    * Get the ordering priority of the previous collation element in the string.
    * @param status the error code status.
    * @return the previous element's ordering. otherwise returns NULLORDER if an 
    *         error has occurred or if the start of string has been reached
    * @stable ICU 2.0
    */
    int32_t previous(UErrorCode& status);

/**
    * Gets the primary order of a collation order.
    * @param order the collation order
    * @return the primary order of a collation order.
    * @stable ICU 2.0
    */
    static inline int32_t primaryOrder(int32_t order);

/**
    * Gets the secondary order of a collation order.
    * @param order the collation order
    * @return the secondary order of a collation order.
    * @stable ICU 2.0
    */
    static inline int32_t secondaryOrder(int32_t order);

/**
    * Gets the tertiary order of a collation order.
    * @param order the collation order
    * @return the tertiary order of a collation order.
    * @stable ICU 2.0
    */
    static inline int32_t tertiaryOrder(int32_t order);

/**
    * Return the maximum length of any expansion sequences that end with the 
    * specified comparison order.
    * @param order a collation order returned by previous or next.
    * @return maximum size of the expansion sequences ending with the collation 
    *         element or 1 if collation element does not occur at the end of any 
    *         expansion sequence
    * @stable ICU 2.0
    */
    int32_t getMaxExpansion(int32_t order) const;

/**
    * Gets the comparison order in the desired strength. Ignore the other
    * differences.
    * @param order The order value
    * @stable ICU 2.0
    */
    int32_t strengthOrder(int32_t order) const;

/**
    * Sets the source string.
    * @param str the source string.
    * @param status the error code status.
    * @stable ICU 2.0
    */
    void setText(const UnicodeString& str, UErrorCode& status);

/**
    * Sets the source string.
    * @param str the source character iterator.
    * @param status the error code status.
    * @stable ICU 2.0
    */
    void setText(CharacterIterator& str, UErrorCode& status);

/**
    * Checks if a comparison order is ignorable.
    * @param order the collation order.
    * @return true if a character is ignorable, false otherwise.
    * @stable ICU 2.0
    */
    static inline UBool isIgnorable(int32_t order);

/**
    * Gets the offset of the currently processed character in the source string.
    * @return the offset of the character.
    * @stable ICU 2.0
    */
    int32_t getOffset(void) const;

/**
    * Sets the offset of the currently processed character in the source string.
    * @param newOffset the new offset.
    * @param status the error code status.
    * @return the offset of the character.
    * @stable ICU 2.0
    */
    void setOffset(int32_t newOffset, UErrorCode& status);

/**
    * ICU "poor man's RTTI", returns a UClassID for the actual class.
    *
    * @stable ICU 2.2
    */
    virtual UClassID getDynamicClassID() const override;

/**
    * ICU "poor man's RTTI", returns a UClassID for this class.
    *
    * @stable ICU 2.2
    */
    static UClassID U_EXPORT2 getStaticClassID();

#ifndef U_HIDE_INTERNAL_API
 /** @internal */
 static inline CollationElementIterator *fromUCollationElements(UCollationElements *uc) {
 return reinterpret_cast<CollationElementIterator *>(uc);
 }
 /** @internal */
 static inline const CollationElementIterator *fromUCollationElements(const UCollationElements *uc) {
 return reinterpret_cast<const CollationElementIterator *>(uc);
 }
 /** @internal */
 inline UCollationElements *toUCollationElements() {
 return reinterpret_cast<UCollationElements *>(this);
 }
 /** @internal */
 inline const UCollationElements *toUCollationElements() const {
 return reinterpret_cast<const UCollationElements *>(this);
 }
#endif // U_HIDE_INTERNAL_API

private:
    friend class RuleBasedCollator;
    friend class UCollationPCE;

/**
    * CollationElementIterator constructor. This takes the source string and the 
    * collation object. The cursor will walk thru the source string based on the 
    * predefined collation rules. If the source string is empty, NULLORDER will 
    * be returned on the calls to next().
    * @param sourceText    the source string.
    * @param order         the collation object.
    * @param status        the error code status.
    */
    CollationElementIterator(const UnicodeString& sourceText,
        const RuleBasedCollator* order, UErrorCode& status);
    // Note: The constructors should take settings & tailoring, not a collator,
    // to avoid circular dependencies.
    // However, for operator==() we would need to be able to compare tailoring data for equality
    // without making CollationData or CollationTailoring depend on TailoredSet.
    // (See the implementation of RuleBasedCollator::operator==().)
    // That might require creating an intermediate class that would be used
    // by both CollationElementIterator and RuleBasedCollator
    // but only contain the part of RBC== related to data and rules.

/**
    * Assignment operator
    *
    * @param other    the object to be copied
    */
    const CollationElementIterator&
        operator=(const CollationElementIterator& other);

CollationElementIterator() = delete; // default constructor not implemented

/** Normalizes dir_=1 (just after setOffset()) to dir_=0 (just after reset()). */
    inline int8_t normalizeDir() const { return dir_ == 1 ? 0 : dir_; }

static UHashtable *computeMaxExpansions(const CollationData *data, UErrorCode &errorCode);

static int32_t getMaxExpansion(const UHashtable *maxExpansions, int32_t order);

// CollationElementIterator private data members ----------------------------

CollationIterator *iter_; // owned
 const RuleBasedCollator *rbc_; // aliased
 uint32_t otherHalf_;
 /**
 * <0: backwards; 0: just after reset() (previous() begins from end);
 * 1: just after setOffset(); >1: forward
 */
 int8_t dir_;
 /**
 * Stores offsets from expansions and from unsafe-backwards iteration,
 * so that getOffset() returns intermediate offsets for the CEs
 * that are consistent with forward iteration.
 */
 UVector32 *offsets_;

UnicodeString string_;
};

// CollationElementIterator inline method definitions --------------------------

inline int32_t CollationElementIterator::primaryOrder(int32_t order)
{
    return (order >> 16) & 0xffff;
}

inline int32_t CollationElementIterator::secondaryOrder(int32_t order)
{
    return (order >> 8) & 0xff;
}

inline int32_t CollationElementIterator::tertiaryOrder(int32_t order)
{
    return order & 0xff;
}

inline UBool CollationElementIterator::isIgnorable(int32_t order)
{
    return (order & 0xffff0000) == 0;
}

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_COLLATION */

#endif /* U_SHOW_CPLUSPLUS_API */

#endif