Gecko [ georgetownmover.com ]

Name	Size	Permission	Date
alphaindex.h	26.48 KB	-rw-r--r--	2024-02-06 07:47
appendable.h	8.49 KB	-rw-r--r--	2024-02-06 07:47
basictz.h	9.68 KB	-rw-r--r--	2024-02-06 07:47
brkiter.h	27.8 KB	-rw-r--r--	2024-02-06 07:47
bytestream.h	10.73 KB	-rw-r--r--	2024-02-06 07:47
bytestrie.h	20.77 KB	-rw-r--r--	2024-02-06 07:47
bytestriebuilder.h	7.29 KB	-rw-r--r--	2024-02-06 07:47
calendar.h	105.88 KB	-rw-r--r--	2024-02-06 07:47
caniter.h	7.43 KB	-rw-r--r--	2024-02-06 07:47
casemap.h	25.33 KB	-rw-r--r--	2024-02-06 07:47
char16ptr.h	7.22 KB	-rw-r--r--	2024-02-06 07:47
chariter.h	24.05 KB	-rw-r--r--	2024-02-06 07:47
choicfmt.h	23.91 KB	-rw-r--r--	2024-02-06 07:47
coleitr.h	13.76 KB	-rw-r--r--	2024-02-06 07:47
coll.h	56.26 KB	-rw-r--r--	2024-02-06 07:47
compactdecimalformat.h	6.88 KB	-rw-r--r--	2024-02-06 07:47
curramt.h	3.76 KB	-rw-r--r--	2024-02-06 07:47
currpinf.h	7.3 KB	-rw-r--r--	2024-02-06 07:47
currunit.h	4 KB	-rw-r--r--	2024-02-06 07:47
datefmt.h	40.67 KB	-rw-r--r--	2024-02-06 07:47
dbbi.h	1.19 KB	-rw-r--r--	2024-02-06 07:47
dcfmtsym.h	20.42 KB	-rw-r--r--	2024-02-06 07:47
decimfmt.h	87.58 KB	-rw-r--r--	2024-02-06 07:47
docmain.h	7.21 KB	-rw-r--r--	2024-02-06 07:47
dtfmtsym.h	37.73 KB	-rw-r--r--	2024-02-06 07:47
dtintrv.h	3.84 KB	-rw-r--r--	2024-02-06 07:47
dtitvfmt.h	49.29 KB	-rw-r--r--	2024-02-06 07:47
dtitvinf.h	18.62 KB	-rw-r--r--	2024-02-06 07:47
dtptngen.h	26.06 KB	-rw-r--r--	2024-02-06 07:47
dtrule.h	8.68 KB	-rw-r--r--	2024-02-06 07:47
edits.h	20.74 KB	-rw-r--r--	2024-02-06 07:47
enumset.h	2.08 KB	-rw-r--r--	2024-02-06 07:47
errorcode.h	4.84 KB	-rw-r--r--	2024-02-06 07:47
fieldpos.h	8.69 KB	-rw-r--r--	2024-02-06 07:47
filteredbrk.h	5.37 KB	-rw-r--r--	2024-02-06 07:47
fmtable.h	24.42 KB	-rw-r--r--	2024-02-06 07:47
format.h	12.5 KB	-rw-r--r--	2024-02-06 07:47
formattedvalue.h	9.75 KB	-rw-r--r--	2024-02-06 07:47
fpositer.h	3.04 KB	-rw-r--r--	2024-02-06 07:47
gender.h	3.33 KB	-rw-r--r--	2024-02-06 07:47
gregocal.h	31.71 KB	-rw-r--r--	2024-02-06 07:47
icudataver.h	1.02 KB	-rw-r--r--	2024-02-06 07:47
icuplug.h	11.83 KB	-rw-r--r--	2024-02-06 07:47
idna.h	12.7 KB	-rw-r--r--	2024-02-06 07:47
listformatter.h	8.79 KB	-rw-r--r--	2024-02-06 07:47
localebuilder.h	11.23 KB	-rw-r--r--	2024-02-06 07:47
localematcher.h	26.98 KB	-rw-r--r--	2024-02-06 07:47
localpointer.h	19.36 KB	-rw-r--r--	2024-02-06 07:47
locdspnm.h	7.12 KB	-rw-r--r--	2024-02-06 07:47
locid.h	47.65 KB	-rw-r--r--	2024-02-06 07:47
measfmt.h	11.37 KB	-rw-r--r--	2024-02-06 07:47
measunit.h	104.66 KB	-rw-r--r--	2024-02-06 07:47
measure.h	4.32 KB	-rw-r--r--	2024-02-06 07:47
messagepattern.h	33.71 KB	-rw-r--r--	2024-02-06 07:47
msgfmt.h	44.12 KB	-rw-r--r--	2024-02-06 07:47
normalizer2.h	33.66 KB	-rw-r--r--	2024-02-06 07:47
normlzr.h	30.94 KB	-rw-r--r--	2024-02-06 07:47
nounit.h	2.3 KB	-rw-r--r--	2024-02-06 07:47
numberformatter.h	92.23 KB	-rw-r--r--	2024-02-06 07:47
numberrangeformatter.h	25.04 KB	-rw-r--r--	2024-02-06 07:47
numfmt.h	49.77 KB	-rw-r--r--	2024-02-06 07:47
numsys.h	7.32 KB	-rw-r--r--	2024-02-06 07:47
parseerr.h	3.08 KB	-rw-r--r--	2024-02-06 07:47
parsepos.h	5.56 KB	-rw-r--r--	2024-02-06 07:47
platform.h	28.08 KB	-rw-r--r--	2024-02-06 07:47
plurfmt.h	25.18 KB	-rw-r--r--	2024-02-06 07:47
plurrule.h	20.84 KB	-rw-r--r--	2024-02-06 07:47
ptypes.h	3.49 KB	-rw-r--r--	2024-02-06 07:47
putil.h	6.32 KB	-rw-r--r--	2024-02-06 07:47
rbbi.h	27.57 KB	-rw-r--r--	2024-02-06 07:47
rbnf.h	48.73 KB	-rw-r--r--	2024-02-06 07:47
rbtz.h	15.72 KB	-rw-r--r--	2024-02-06 07:47
regex.h	84.34 KB	-rw-r--r--	2024-02-06 07:47
region.h	9.18 KB	-rw-r--r--	2024-02-06 07:47
reldatefmt.h	22.22 KB	-rw-r--r--	2024-02-06 07:47
rep.h	9.37 KB	-rw-r--r--	2024-02-06 07:47
resbund.h	18.07 KB	-rw-r--r--	2024-02-06 07:47
schriter.h	6.32 KB	-rw-r--r--	2024-02-06 07:47
scientificnumberformatter.h	6.4 KB	-rw-r--r--	2024-02-06 07:47
search.h	22.22 KB	-rw-r--r--	2024-02-06 07:47
selfmt.h	14.3 KB	-rw-r--r--	2024-02-06 07:47
simpleformatter.h	12.59 KB	-rw-r--r--	2024-02-06 07:47
simpletz.h	45.55 KB	-rw-r--r--	2024-02-06 07:47
smpdtfmt.h	71 KB	-rw-r--r--	2024-02-06 07:47
sortkey.h	11.18 KB	-rw-r--r--	2024-02-06 07:47
std_string.h	1.05 KB	-rw-r--r--	2024-02-06 07:47
strenum.h	9.92 KB	-rw-r--r--	2024-02-06 07:47
stringoptions.h	5.79 KB	-rw-r--r--	2024-02-06 07:47
stringpiece.h	10.05 KB	-rw-r--r--	2024-02-06 07:47
stringtriebuilder.h	15.33 KB	-rw-r--r--	2024-02-06 07:47
stsearch.h	21.3 KB	-rw-r--r--	2024-02-06 07:47
symtable.h	4.27 KB	-rw-r--r--	2024-02-06 07:47
tblcoll.h	36.65 KB	-rw-r--r--	2024-02-06 07:47
timezone.h	41.52 KB	-rw-r--r--	2024-02-06 07:47
tmunit.h	3.38 KB	-rw-r--r--	2024-02-06 07:47
tmutamt.h	4.9 KB	-rw-r--r--	2024-02-06 07:47
tmutfmt.h	7.85 KB	-rw-r--r--	2024-02-06 07:47
translit.h	65.81 KB	-rw-r--r--	2024-02-06 07:47
tzfmt.h	42.89 KB	-rw-r--r--	2024-02-06 07:47
tznames.h	16.85 KB	-rw-r--r--	2024-02-06 07:47
tzrule.h	35.37 KB	-rw-r--r--	2024-02-06 07:47
tztrans.h	6.12 KB	-rw-r--r--	2024-02-06 07:47
ubidi.h	89.54 KB	-rw-r--r--	2024-02-06 07:47
ubiditransform.h	12.7 KB	-rw-r--r--	2024-02-06 07:47
ubrk.h	24.45 KB	-rw-r--r--	2024-02-06 07:47
ucal.h	61 KB	-rw-r--r--	2024-02-06 07:47
ucasemap.h	15.21 KB	-rw-r--r--	2024-02-06 07:47
ucat.h	5.35 KB	-rw-r--r--	2024-02-06 07:47
uchar.h	141.13 KB	-rw-r--r--	2024-02-06 07:47
ucharstrie.h	22.53 KB	-rw-r--r--	2024-02-06 07:47
ucharstriebuilder.h	7.3 KB	-rw-r--r--	2024-02-06 07:47
uchriter.h	13.2 KB	-rw-r--r--	2024-02-06 07:47
uclean.h	11.2 KB	-rw-r--r--	2024-02-06 07:47
ucnv.h	83.04 KB	-rw-r--r--	2024-02-06 07:47
ucnv_cb.h	6.58 KB	-rw-r--r--	2024-02-06 07:47
ucnv_err.h	20.97 KB	-rw-r--r--	2024-02-06 07:47
ucnvsel.h	6.19 KB	-rw-r--r--	2024-02-06 07:47
ucol.h	61.51 KB	-rw-r--r--	2024-02-06 07:47
ucoleitr.h	9.82 KB	-rw-r--r--	2024-02-06 07:47
uconfig.h	12.07 KB	-rw-r--r--	2024-02-06 07:47
ucpmap.h	5.53 KB	-rw-r--r--	2024-02-06 07:47
ucptrie.h	22.51 KB	-rw-r--r--	2024-02-06 07:47
ucsdet.h	14.69 KB	-rw-r--r--	2024-02-06 07:47
ucurr.h	16.77 KB	-rw-r--r--	2024-02-06 07:47
udat.h	62.11 KB	-rw-r--r--	2024-02-06 07:47
udata.h	15.62 KB	-rw-r--r--	2024-02-06 07:47
udateintervalformat.h	11.98 KB	-rw-r--r--	2024-02-06 07:47
udatpg.h	26.76 KB	-rw-r--r--	2024-02-06 07:47
udisplaycontext.h	5.94 KB	-rw-r--r--	2024-02-06 07:47
uenum.h	7.79 KB	-rw-r--r--	2024-02-06 07:47
ufieldpositer.h	4.41 KB	-rw-r--r--	2024-02-06 07:47
uformattable.h	10.97 KB	-rw-r--r--	2024-02-06 07:47
uformattedvalue.h	12.3 KB	-rw-r--r--	2024-02-06 07:47
ugender.h	2.06 KB	-rw-r--r--	2024-02-06 07:47
uidna.h	33.43 KB	-rw-r--r--	2024-02-06 07:47
uiter.h	22.75 KB	-rw-r--r--	2024-02-06 07:47
uldnames.h	10.48 KB	-rw-r--r--	2024-02-06 07:47
ulistformatter.h	10.78 KB	-rw-r--r--	2024-02-06 07:47
uloc.h	54.6 KB	-rw-r--r--	2024-02-06 07:47
ulocdata.h	11.3 KB	-rw-r--r--	2024-02-06 07:47
umachine.h	16.05 KB	-rw-r--r--	2024-02-06 07:47
umisc.h	1.33 KB	-rw-r--r--	2024-02-06 07:47
umsg.h	24.25 KB	-rw-r--r--	2024-02-06 07:47
umutablecptrie.h	8.29 KB	-rw-r--r--	2024-02-06 07:47
unifilt.h	3.96 KB	-rw-r--r--	2024-02-06 07:47
unifunct.h	4.04 KB	-rw-r--r--	2024-02-06 07:47
unimatch.h	6.1 KB	-rw-r--r--	2024-02-06 07:47
unirepl.h	3.38 KB	-rw-r--r--	2024-02-06 07:47
uniset.h	65.04 KB	-rw-r--r--	2024-02-06 07:47
unistr.h	170.46 KB	-rw-r--r--	2024-02-06 07:47
unorm.h	20.52 KB	-rw-r--r--	2024-02-06 07:47
unorm2.h	24.68 KB	-rw-r--r--	2024-02-06 07:47
unum.h	54.88 KB	-rw-r--r--	2024-02-06 07:47
unumberformatter.h	30.55 KB	-rw-r--r--	2024-02-06 07:47
unumberrangeformatter.h	15.38 KB	-rw-r--r--	2024-02-06 07:47
unumsys.h	7.26 KB	-rw-r--r--	2024-02-06 07:47
uobject.h	10.68 KB	-rw-r--r--	2024-02-06 07:47
upluralrules.h	8.8 KB	-rw-r--r--	2024-02-06 07:47
uregex.h	71.99 KB	-rw-r--r--	2024-02-06 07:47
uregion.h	9.81 KB	-rw-r--r--	2024-02-06 07:47
ureldatefmt.h	17.04 KB	-rw-r--r--	2024-02-06 07:47
urename.h	133.97 KB	-rw-r--r--	2024-02-06 07:47
urep.h	5.38 KB	-rw-r--r--	2024-02-06 07:47
ures.h	36.54 KB	-rw-r--r--	2024-02-06 07:47
uscript.h	27.19 KB	-rw-r--r--	2024-02-06 07:47
usearch.h	39.07 KB	-rw-r--r--	2024-02-06 07:47
uset.h	42.59 KB	-rw-r--r--	2024-02-06 07:47
usetiter.h	9.55 KB	-rw-r--r--	2024-02-06 07:47
ushape.h	18 KB	-rw-r--r--	2024-02-06 07:47
uspoof.h	65.84 KB	-rw-r--r--	2024-02-06 07:47
usprep.h	8.19 KB	-rw-r--r--	2024-02-06 07:47
ustdio.h	38.55 KB	-rw-r--r--	2024-02-06 07:47
ustream.h	1.89 KB	-rw-r--r--	2024-02-06 07:47
ustring.h	72.35 KB	-rw-r--r--	2024-02-06 07:47
ustringtrie.h	3.15 KB	-rw-r--r--	2024-02-06 07:47
utext.h	58.08 KB	-rw-r--r--	2024-02-06 07:47
utf.h	7.87 KB	-rw-r--r--	2024-02-06 07:47
utf16.h	23.35 KB	-rw-r--r--	2024-02-06 07:47
utf32.h	763 B	-rw-r--r--	2024-02-06 07:47
utf8.h	30.83 KB	-rw-r--r--	2024-02-06 07:47
utf_old.h	45.83 KB	-rw-r--r--	2024-02-06 07:47
utmscale.h	13.78 KB	-rw-r--r--	2024-02-06 07:47
utrace.h	17.18 KB	-rw-r--r--	2024-02-06 07:47
utrans.h	25.54 KB	-rw-r--r--	2024-02-06 07:47
utypes.h	31.06 KB	-rw-r--r--	2024-02-06 07:47
uvernum.h	6.68 KB	-rw-r--r--	2024-02-06 07:47
uversion.h	5.99 KB	-rw-r--r--	2024-02-06 07:47
vtzone.h	20.67 KB	-rw-r--r--	2024-02-06 07:47

Rename

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

#ifndef STRENUM_H
#define STRENUM_H

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

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

/**
 * \file 
 * \brief C++ API: String Enumeration
 */
 
U_NAMESPACE_BEGIN

/**
 * Base class for 'pure' C++ implementations of uenum api. Adds a
 * method that returns the next UnicodeString since in C++ this can
 * be a common storage format for strings.
 *
 * The model is that the enumeration is over strings maintained by
 * a 'service.' At any point, the service might change, invalidating
 * the enumerator (though this is expected to be rare). The iterator
 * returns an error if this has occurred. Lack of the error is no
 * guarantee that the service didn't change immediately after the
 * call, so the returned string still might not be 'valid' on
 * subsequent use.
 *
 * Strings may take the form of const char*, const char16_t*, or const
 * UnicodeString*. The type you get is determine by the variant of
 * 'next' that you call. In general the StringEnumeration is
 * optimized for one of these types, but all StringEnumerations can
 * return all types. Returned strings are each terminated with a NUL.
 * Depending on the service data, they might also include embedded NUL
 * characters, so API is provided to optionally return the true
 * length, counting the embedded NULs but not counting the terminating
 * NUL.
 *
 * The pointers returned by next, unext, and snext become invalid
 * upon any subsequent call to the enumeration's destructor, next,
 * unext, snext, or reset.
 *
 * ICU 2.8 adds some default implementations and helper functions
 * for subclasses.
 *
 * @stable ICU 2.4 
 */
class U_COMMON_API StringEnumeration : public UObject { 
public:
 /**
 * Destructor.
 * @stable ICU 2.4
 */
 virtual ~StringEnumeration();

/**
     * Clone this object, an instance of a subclass of StringEnumeration.
     * Clones can be used concurrently in multiple threads.
     * If a subclass does not implement clone(), or if an error occurs,
     * then NULL is returned.
     * The caller must delete the clone.
     *
     * @return a clone of this object
     *
     * @see getDynamicClassID
     * @stable ICU 2.8
     */
    virtual StringEnumeration *clone() const;

/**
 * Return the number of elements that the iterator traverses. If
 * the iterator is out of sync with its service, status is set to
 * U_ENUM_OUT_OF_SYNC_ERROR, and the return value is zero.
 *
 * The return value will not change except possibly as a result of
 * a subsequent call to reset, or if the iterator becomes out of sync.
 *
 * This is a convenience function. It can end up being very
 * expensive as all the items might have to be pre-fetched
 * (depending on the storage format of the data being
 * traversed).
 *
 * @param status the error code.
 * @return number of elements in the iterator.
 *
 * @stable ICU 2.4 */
 virtual int32_t count(UErrorCode& status) const = 0;

/**
 * Returns the next element as a NUL-terminated char*. If there
 * are no more elements, returns NULL. If the resultLength pointer
 * is not NULL, the length of the string (not counting the
 * terminating NUL) is returned at that address. If an error
 * status is returned, the value at resultLength is undefined.
 *
 * The returned pointer is owned by this iterator and must not be
 * deleted by the caller. The pointer is valid until the next call
 * to next, unext, snext, reset, or the enumerator's destructor.
 *
 * If the iterator is out of sync with its service, status is set
 * to U_ENUM_OUT_OF_SYNC_ERROR and NULL is returned.
 *
 * If the native service string is a char16_t* string, it is
 * converted to char* with the invariant converter. If the
 * conversion fails (because a character cannot be converted) then
 * status is set to U_INVARIANT_CONVERSION_ERROR and the return
 * value is undefined (though not NULL).
 *
 * Starting with ICU 2.8, the default implementation calls snext()
 * and handles the conversion.
 * Either next() or snext() must be implemented differently by a subclass.
 *
 * @param status the error code.
 * @param resultLength a pointer to receive the length, can be NULL.
 * @return a pointer to the string, or NULL.
 *
 * @stable ICU 2.4 
 */
 virtual const char* next(int32_t *resultLength, UErrorCode& status);

/**
 * Returns the next element as a NUL-terminated char16_t*. If there
 * are no more elements, returns NULL. If the resultLength pointer
 * is not NULL, the length of the string (not counting the
 * terminating NUL) is returned at that address. If an error
 * status is returned, the value at resultLength is undefined.
 *
 * The returned pointer is owned by this iterator and must not be
 * deleted by the caller. The pointer is valid until the next call
 * to next, unext, snext, reset, or the enumerator's destructor.
 *
 * If the iterator is out of sync with its service, status is set
 * to U_ENUM_OUT_OF_SYNC_ERROR and NULL is returned.
 *
 * Starting with ICU 2.8, the default implementation calls snext()
 * and handles the conversion.
 *
 * @param status the error code.
 * @param resultLength a ponter to receive the length, can be NULL.
 * @return a pointer to the string, or NULL.
 *
 * @stable ICU 2.4 
 */
 virtual const char16_t* unext(int32_t *resultLength, UErrorCode& status);

/**
 * Returns the next element a UnicodeString*. If there are no
 * more elements, returns NULL.
 *
 * The returned pointer is owned by this iterator and must not be
 * deleted by the caller. The pointer is valid until the next call
 * to next, unext, snext, reset, or the enumerator's destructor.
 *
 * If the iterator is out of sync with its service, status is set
 * to U_ENUM_OUT_OF_SYNC_ERROR and NULL is returned.
 *
 * Starting with ICU 2.8, the default implementation calls next()
 * and handles the conversion.
 * Either next() or snext() must be implemented differently by a subclass.
 *
 * @param status the error code.
 * @return a pointer to the string, or NULL.
 *
 * @stable ICU 2.4 
 */
 virtual const UnicodeString* snext(UErrorCode& status);

/**
 * Resets the iterator. This re-establishes sync with the
 * service and rewinds the iterator to start at the first
 * element.
 *
 * Previous pointers returned by next, unext, or snext become
 * invalid, and the value returned by count might change.
 *
 * @param status the error code.
 *
 * @stable ICU 2.4 
 */
 virtual void reset(UErrorCode& status) = 0;

/**
     * Compares this enumeration to other to check if both are equal
     *
     * @param that The other string enumeration to compare this object to
     * @return true if the enumerations are equal. false if not.
     * @stable ICU 3.6 
     */
    virtual UBool operator==(const StringEnumeration& that)const;
    /**
     * Compares this enumeration to other to check if both are not equal
     *
     * @param that The other string enumeration to compare this object to
     * @return true if the enumerations are equal. false if not.
     * @stable ICU 3.6 
     */
    virtual UBool operator!=(const StringEnumeration& that)const;

protected:
    /**
     * UnicodeString field for use with default implementations and subclasses.
     * @stable ICU 2.8
     */
    UnicodeString unistr;
    /**
     * char * default buffer for use with default implementations and subclasses.
     * @stable ICU 2.8
     */
    char charsBuffer[32];
    /**
     * char * buffer for use with default implementations and subclasses.
     * Allocated in constructor and in ensureCharsCapacity().
     * @stable ICU 2.8
     */
    char *chars;
    /**
     * Capacity of chars, for use with default implementations and subclasses.
     * @stable ICU 2.8
     */
    int32_t charsCapacity;

/**
     * Default constructor for use with default implementations and subclasses.
     * @stable ICU 2.8
     */
    StringEnumeration();

/**
     * Ensures that chars is at least as large as the requested capacity.
     * For use with default implementations and subclasses.
     *
     * @param capacity Requested capacity.
     * @param status ICU in/out error code.
     * @stable ICU 2.8
     */
    void ensureCharsCapacity(int32_t capacity, UErrorCode &status);

/**
     * Converts s to Unicode and sets unistr to the result.
     * For use with default implementations and subclasses,
     * especially for implementations of snext() in terms of next().
     * This is provided with a helper function instead of a default implementation
     * of snext() to avoid potential infinite loops between next() and snext().
     *
     * For example:
     * \code
     * const UnicodeString* snext(UErrorCode& status) {
     *   int32_t resultLength=0;
     *   const char *s=next(&resultLength, status);
     *   return setChars(s, resultLength, status);
     * }
     * \endcode
     *
     * @param s String to be converted to Unicode.
     * @param length Length of the string.
     * @param status ICU in/out error code.
     * @return A pointer to unistr.
     * @stable ICU 2.8
     */
    UnicodeString *setChars(const char *s, int32_t length, UErrorCode &status);
};

U_NAMESPACE_END

#endif /* U_SHOW_CPLUSPLUS_API */

/* STRENUM_H */
#endif