---

coleitr.h

// 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. * <p>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> * <p> * 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 spefcifieid position will be returned. If a change of * direction is done without one of these calls, the result is undefined. * <p> * 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 <strong>int32_t</strong>. * * 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 occured 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 */ UBool 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 */ UBool 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 occured 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 occured 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; /** * 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. /** * 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 CharacterIterator& sourceText, const RuleBasedCollator* order, UErrorCode& status); /** * Assignment operator * * @param other the object to be copied */ const CollationElementIterator& operator=(const CollationElementIterator& other); CollationElementIterator(); // 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

---

docroot: /home/induvedam/public_html

---

curdir: /usr/include/unicode

	.		8192
	..		8192
X	alphaindex.h		27118
X	appendable.h		8694
X	basictz.h		9491
X	brkiter.h		28464
X	bytestream.h		11037
X	bytestrie.h		21266
X	bytestriebuilder.h		7248
X	calendar.h		108278
X	caniter.h		7611
X	casemap.h		25933
X	char16ptr.h		7393
X	chariter.h		24632
X	choicfmt.h		24482
X	coleitr.h		14094
X	coll.h		57581
X	compactdecimalformat.h		7047
X	curramt.h		3851
X	currpinf.h		7473
X	currunit.h		4094
X	datefmt.h		41641
X	dbbi.h		1223
X	dcfmtsym.h		20897
X	decimfmt.h		89278
X	docmain.h		7142
X	dtfmtsym.h		38609
X	dtintrv.h		3930
X	dtitvfmt.h		47634
X	dtitvinf.h		19064
X	dtptngen.h		26419
X	dtrule.h		8888
X	edits.h		21237
X	enumset.h		2130
X	errorcode.h		4956
X	fieldpos.h		8899
X	filteredbrk.h		5501
X	fmtable.h		25007
X	format.h		12802
X	formattedvalue.h		9987
X	fpositer.h		3109
X	gender.h		3408
X	gregocal.h		32472
X	icudataver.h		1051
X	icuplug.h		12166
X	idna.h		13000
X	listformatter.h		9493
X	localebuilder.h		11502
X	localematcher.h		25147
X	localpointer.h		19829
X	locdspnm.h		7292
X	locid.h		48821
X	measfmt.h		11603
X	measunit.h		97563
X	measure.h		4423
X	messagepattern.h		34521
X	msgfmt.h		45168
X	normalizer2.h		34851
X	normlzr.h		31682
X	nounit.h		2754
X	numberformatter.h		86276
X	numberrangeformatter.h		28617
X	numfmt.h		50950
X	numsys.h		7500
X	parseerr.h		3155
X	parsepos.h		5692
X	platform.h		28751
X	plurfmt.h		25800
X	plurrule.h		18780
X	ptypes.h		3577
X	putil.h		6487
X	rbbi.h		27218
X	rbnf.h		49899
X	rbtz.h		15979
X	regex.h		86367
X	region.h		9404
X	reldatefmt.h		22801
X	rep.h		9599
X	resbund.h		18503
X	schriter.h		6475
X	scientificnumberformatter.h		6553
X	search.h		22757
X	selfmt.h		14643
X	simpleformatter.h		12888
X	simpletz.h		46527
X	smpdtfmt.h		72713
X	sortkey.h		11444
X	std_string.h		1076
X	strenum.h		10158
X	stringoptions.h		5926
X	stringpiece.h		10597
X	stringtriebuilder.h		15698
X	stsearch.h		21810
X	symtable.h		4374
X	tblcoll.h		37489
X	timezone.h		42005
X	tmunit.h		3461
X	tmutamt.h		5015
X	tmutfmt.h		8042
X	translit.h		67400
X	tzfmt.h		43916
X	tznames.h		17252
X	tzrule.h		36215
X	tztrans.h		6271
X	ubidi.h		91711
X	ubiditransform.h		12950
X	ubrk.h		24547
X	ucal.h		58265
X	ucasemap.h		15546
X	ucat.h		5484
X	uchar.h		144630
X	ucharstrie.h		23120
X	ucharstriebuilder.h		7378
X	uchriter.h		13521
X	uclean.h		11474
X	ucnv.h		85085
X	ucnv_cb.h		6748
X	ucnv_err.h		21492
X	ucnvsel.h		6283
X	ucol.h		62939
X	ucoleitr.h		9684
X	uconfig.h		12356
X	ucpmap.h		5663
X	ucptrie.h		23002
X	ucsdet.h		15018
X	ucurr.h		16507
X	udat.h		62851
X	udata.h		15930
X	udateintervalformat.h		10995
X	udatpg.h		27447
X	udisplaycontext.h		6029
X	uenum.h		7970
X	ufieldpositer.h		4461
X	uformattable.h		11198
X	uformattedvalue.h		12413
X	ugender.h		2052
X	uidna.h		34169
X	uiter.h		23319
X	uldnames.h		10702
X	ulistformatter.h		11086
X	uloc.h		54432
X	ulocdata.h		11533
X	umachine.h		14884
X	umisc.h		1365
X	umsg.h		24812
X	umutablecptrie.h		8435
X	unifilt.h		4055
X	unifunct.h		4141
X	unimatch.h		6244
X	unirepl.h		3464
X	uniset.h		66459
X	unistr.h		174523
X	unorm.h		21015
X	unorm2.h		25254
X	unum.h		54743
X	unumberformatter.h		25824
X	unumsys.h		7387
X	uobject.h		10936
X	upluralrules.h		8013
X	uregex.h		73784
X	uregion.h		10073
X	ureldatefmt.h		17409
X	urename.h		134449
X	urep.h		5507
X	ures.h		37415
X	uscript.h		27867
X	usearch.h		39039
X	uset.h		40958
X	usetiter.h		9781
X	ushape.h		18432
X	uspoof.h		67480
X	usprep.h		8331
X	ustdio.h		39469
X	ustream.h		1934
X	ustring.h		74211
X	ustringtrie.h		3224
X	utext.h		59527
X	utf.h		8046
X	utf16.h		23878
X	utf32.h		763
X	utf8.h		31700
X	utf_old.h		46929
X	utmscale.h		14113
X	utrace.h		17706
X	utrans.h		26130
X	utypes.h		31481
X	uvernum.h		6832
X	uversion.h		6145
X	vtzone.h		20784