Gecko [ emad.team ]

Name	Size	Permission	Date
alphaindex.h	25.29 KB	-rw-r--r--	2020-03-25 19:17
appendable.h	8.38 KB	-rw-r--r--	2020-03-25 19:17
basictz.h	8.77 KB	-rw-r--r--	2020-03-25 19:17
bms.h	8.68 KB	-rw-r--r--	2020-03-25 19:17
bmsearch.h	7.33 KB	-rw-r--r--	2020-03-25 19:17
brkiter.h	24.24 KB	-rw-r--r--	2020-03-25 19:17
bytestream.h	9.16 KB	-rw-r--r--	2020-03-25 19:17
bytestrie.h	19.19 KB	-rw-r--r--	2020-03-25 19:17
bytestriebuilder.h	6.73 KB	-rw-r--r--	2020-03-25 19:17
calendar.h	102.76 KB	-rw-r--r--	2020-03-25 19:17
caniter.h	7.23 KB	-rw-r--r--	2020-03-25 19:17
chariter.h	23.71 KB	-rw-r--r--	2020-03-25 19:17
choicfmt.h	27.82 KB	-rw-r--r--	2020-03-25 19:17
coleitr.h	12.69 KB	-rw-r--r--	2020-03-25 19:17
coll.h	53.44 KB	-rw-r--r--	2020-03-25 19:17
colldata.h	12.42 KB	-rw-r--r--	2020-03-25 19:17
curramt.h	3.57 KB	-rw-r--r--	2020-03-25 19:17
currpinf.h	6.93 KB	-rw-r--r--	2020-03-25 19:17
currunit.h	2.99 KB	-rw-r--r--	2020-03-25 19:17
datefmt.h	33.67 KB	-rw-r--r--	2020-03-25 19:17
dbbi.h	966 B	-rw-r--r--	2020-03-25 19:17
dcfmtsym.h	14.91 KB	-rw-r--r--	2020-03-25 19:17
decimfmt.h	97.38 KB	-rw-r--r--	2020-03-25 19:17
docmain.h	6.28 KB	-rw-r--r--	2020-03-25 19:17
dtfmtsym.h	30.27 KB	-rw-r--r--	2020-03-25 19:17
dtintrv.h	3.65 KB	-rw-r--r--	2020-03-25 19:17
dtitvfmt.h	39.24 KB	-rw-r--r--	2020-03-25 19:17
dtitvinf.h	18.56 KB	-rw-r--r--	2020-03-25 19:17
dtptngen.h	19.54 KB	-rw-r--r--	2020-03-25 19:17
dtrule.h	8.51 KB	-rw-r--r--	2020-03-25 19:17
enumset.h	1.8 KB	-rw-r--r--	2020-03-25 19:17
errorcode.h	4.67 KB	-rw-r--r--	2020-03-25 19:17
fieldpos.h	8.51 KB	-rw-r--r--	2020-03-25 19:17
fmtable.h	22.09 KB	-rw-r--r--	2020-03-25 19:17
format.h	12.33 KB	-rw-r--r--	2020-03-25 19:17
fpositer.h	2.97 KB	-rw-r--r--	2020-03-25 19:17
gender.h	3.02 KB	-rw-r--r--	2020-03-25 19:17
gregocal.h	33.28 KB	-rw-r--r--	2020-03-25 19:17
icudataver.h	990 B	-rw-r--r--	2020-03-25 19:17
icuplug.h	11.49 KB	-rw-r--r--	2020-03-25 19:17
idna.h	12.68 KB	-rw-r--r--	2020-03-25 19:17
listformatter.h	3.97 KB	-rw-r--r--	2020-03-25 19:17
localpointer.h	9.13 KB	-rw-r--r--	2020-03-25 19:17
locdspnm.h	7.14 KB	-rw-r--r--	2020-03-25 19:17
locid.h	30.48 KB	-rw-r--r--	2020-03-25 19:17
measfmt.h	1.94 KB	-rw-r--r--	2020-03-25 19:17
measunit.h	1.6 KB	-rw-r--r--	2020-03-25 19:17
measure.h	3.24 KB	-rw-r--r--	2020-03-25 19:17
messagepattern.h	33.6 KB	-rw-r--r--	2020-03-25 19:17
msgfmt.h	43.59 KB	-rw-r--r--	2020-03-25 19:17
normalizer2.h	28.34 KB	-rw-r--r--	2020-03-25 19:17
normlzr.h	29.26 KB	-rw-r--r--	2020-03-25 19:17
numfmt.h	43.59 KB	-rw-r--r--	2020-03-25 19:17
numsys.h	5.37 KB	-rw-r--r--	2020-03-25 19:17
parseerr.h	2.97 KB	-rw-r--r--	2020-03-25 19:17
parsepos.h	5.34 KB	-rw-r--r--	2020-03-25 19:17
platform.h	24.23 KB	-rw-r--r--	2020-03-25 19:17
plurfmt.h	24.58 KB	-rw-r--r--	2020-03-25 19:17
plurrule.h	14.56 KB	-rw-r--r--	2020-03-25 19:17
ptypes.h	3.36 KB	-rw-r--r--	2020-03-25 19:17
putil.h	5.61 KB	-rw-r--r--	2020-03-25 19:17
rbbi.h	29.15 KB	-rw-r--r--	2020-03-25 19:17
rbnf.h	45.32 KB	-rw-r--r--	2020-03-25 19:17
rbtz.h	15.33 KB	-rw-r--r--	2020-03-25 19:17
regex.h	83.1 KB	-rw-r--r--	2020-03-25 19:17
rep.h	9.33 KB	-rw-r--r--	2020-03-25 19:17
resbund.h	17.89 KB	-rw-r--r--	2020-03-25 19:17
schriter.h	6.15 KB	-rw-r--r--	2020-03-25 19:17
search.h	22.1 KB	-rw-r--r--	2020-03-25 19:17
selfmt.h	14.13 KB	-rw-r--r--	2020-03-25 19:17
simpletz.h	45.1 KB	-rw-r--r--	2020-03-25 19:17
smpdtfmt.h	57.58 KB	-rw-r--r--	2020-03-25 19:17
sortkey.h	10.98 KB	-rw-r--r--	2020-03-25 19:17
std_string.h	783 B	-rw-r--r--	2020-03-25 19:17
strenum.h	9.92 KB	-rw-r--r--	2020-03-25 19:17
stringpiece.h	6.38 KB	-rw-r--r--	2020-03-25 19:17
stringtriebuilder.h	14.75 KB	-rw-r--r--	2020-03-25 19:17
stsearch.h	21.76 KB	-rw-r--r--	2020-03-25 19:17
symtable.h	4.1 KB	-rw-r--r--	2020-03-25 19:17
tblcoll.h	34.23 KB	-rw-r--r--	2020-03-25 19:17
timezone.h	37.28 KB	-rw-r--r--	2020-03-25 19:17
tmunit.h	3.39 KB	-rw-r--r--	2020-03-25 19:17
tmutamt.h	4.69 KB	-rw-r--r--	2020-03-25 19:17
tmutfmt.h	8.51 KB	-rw-r--r--	2020-03-25 19:17
translit.h	53.76 KB	-rw-r--r--	2020-03-25 19:17
tzfmt.h	32.06 KB	-rw-r--r--	2020-03-25 19:17
tznames.h	14.83 KB	-rw-r--r--	2020-03-25 19:17
tzrule.h	35.21 KB	-rw-r--r--	2020-03-25 19:17
tztrans.h	5.96 KB	-rw-r--r--	2020-03-25 19:17
ubidi.h	88.57 KB	-rw-r--r--	2020-03-25 19:17
ubrk.h	19.13 KB	-rw-r--r--	2020-03-25 19:17
ucal.h	50.49 KB	-rw-r--r--	2020-03-25 19:17
ucasemap.h	16.45 KB	-rw-r--r--	2020-03-25 19:17
ucat.h	5.25 KB	-rw-r--r--	2020-03-25 19:17
uchar.h	115.43 KB	-rw-r--r--	2020-03-25 19:17
ucharstrie.h	20.8 KB	-rw-r--r--	2020-03-25 19:17
ucharstriebuilder.h	6.83 KB	-rw-r--r--	2020-03-25 19:17
uchriter.h	12.82 KB	-rw-r--r--	2020-03-25 19:17
uclean.h	10.38 KB	-rw-r--r--	2020-03-25 19:17
ucnv.h	82.6 KB	-rw-r--r--	2020-03-25 19:17
ucnv_cb.h	6.48 KB	-rw-r--r--	2020-03-25 19:17
ucnv_err.h	20.87 KB	-rw-r--r--	2020-03-25 19:17
ucnvsel.h	6.03 KB	-rw-r--r--	2020-03-25 19:17
ucol.h	57.93 KB	-rw-r--r--	2020-03-25 19:17
ucoleitr.h	12.25 KB	-rw-r--r--	2020-03-25 19:17
uconfig.h	10.79 KB	-rw-r--r--	2020-03-25 19:17
ucsdet.h	12.6 KB	-rw-r--r--	2020-03-25 19:17
ucurr.h	12.96 KB	-rw-r--r--	2020-03-25 19:17
udat.h	46.47 KB	-rw-r--r--	2020-03-25 19:17
udata.h	14.81 KB	-rw-r--r--	2020-03-25 19:17
udateintervalformat.h	6.5 KB	-rw-r--r--	2020-03-25 19:17
udatpg.h	23.24 KB	-rw-r--r--	2020-03-25 19:17
udisplaycontext.h	4.34 KB	-rw-r--r--	2020-03-25 19:17
uenum.h	7.79 KB	-rw-r--r--	2020-03-25 19:17
ugender.h	1.85 KB	-rw-r--r--	2020-03-25 19:17
uidna.h	32.81 KB	-rw-r--r--	2020-03-25 19:17
uiter.h	22.67 KB	-rw-r--r--	2020-03-25 19:17
uldnames.h	10.5 KB	-rw-r--r--	2020-03-25 19:17
uloc.h	44.07 KB	-rw-r--r--	2020-03-25 19:17
ulocdata.h	10.37 KB	-rw-r--r--	2020-03-25 19:17
umachine.h	10.23 KB	-rw-r--r--	2020-03-25 19:17
umisc.h	1.23 KB	-rw-r--r--	2020-03-25 19:17
umsg.h	24.12 KB	-rw-r--r--	2020-03-25 19:17
unifilt.h	3.52 KB	-rw-r--r--	2020-03-25 19:17
unifunct.h	3.87 KB	-rw-r--r--	2020-03-25 19:17
unimatch.h	5.93 KB	-rw-r--r--	2020-03-25 19:17
unirepl.h	3.21 KB	-rw-r--r--	2020-03-25 19:17
uniset.h	63.07 KB	-rw-r--r--	2020-03-25 19:17
unistr.h	164.33 KB	-rw-r--r--	2020-03-25 19:17
unorm.h	22.89 KB	-rw-r--r--	2020-03-25 19:17
unorm2.h	21.91 KB	-rw-r--r--	2020-03-25 19:17
unum.h	39.21 KB	-rw-r--r--	2020-03-25 19:17
uobject.h	12.21 KB	-rw-r--r--	2020-03-25 19:17
upluralrules.h	4.47 KB	-rw-r--r--	2020-03-25 19:17
uregex.h	71.47 KB	-rw-r--r--	2020-03-25 19:17
urename.h	120.88 KB	-rw-r--r--	2020-03-25 19:17
urep.h	5.27 KB	-rw-r--r--	2020-03-25 19:17
ures.h	35.92 KB	-rw-r--r--	2020-03-25 19:17
uscript.h	20.46 KB	-rw-r--r--	2020-03-25 19:17
usearch.h	36.09 KB	-rw-r--r--	2020-03-25 19:17
uset.h	39.45 KB	-rw-r--r--	2020-03-25 19:17
usetiter.h	9.38 KB	-rw-r--r--	2020-03-25 19:17
ushape.h	17.89 KB	-rw-r--r--	2020-03-25 19:17
uspoof.h	38.91 KB	-rw-r--r--	2020-03-25 19:17
usprep.h	8.02 KB	-rw-r--r--	2020-03-25 19:17
ustdio.h	37.05 KB	-rw-r--r--	2020-03-25 19:17
ustream.h	1.6 KB	-rw-r--r--	2020-03-25 19:17
ustring.h	73.01 KB	-rw-r--r--	2020-03-25 19:17
ustringtrie.h	3.04 KB	-rw-r--r--	2020-03-25 19:17
utext.h	57.97 KB	-rw-r--r--	2020-03-25 19:17
utf.h	7.64 KB	-rw-r--r--	2020-03-25 19:17
utf16.h	18.24 KB	-rw-r--r--	2020-03-25 19:17
utf32.h	653 B	-rw-r--r--	2020-03-25 19:17
utf8.h	23.02 KB	-rw-r--r--	2020-03-25 19:17
utf_old.h	42.5 KB	-rw-r--r--	2020-03-25 19:17
utmscale.h	13.37 KB	-rw-r--r--	2020-03-25 19:17
utrace.h	13.09 KB	-rw-r--r--	2020-03-25 19:17
utrans.h	23.08 KB	-rw-r--r--	2020-03-25 19:17
utypes.h	30.72 KB	-rw-r--r--	2020-03-25 19:17
uvernum.h	5.53 KB	-rw-r--r--	2020-03-25 19:17
uversion.h	6.29 KB	-rw-r--r--	2020-03-25 19:17
vtzone.h	20.09 KB	-rw-r--r--	2020-03-25 19:17

Rename

/*
*******************************************************************************
*
*   Copyright (C) 2002-2012, International Business Machines
*   Corporation and others.  All Rights Reserved.
*
*******************************************************************************
*/

#ifndef STRENUM_H
#define STRENUM_H

#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 UChar*, 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 clone functions in all subclasses return a base class pointer
     * because some compilers do not support covariant (same-as-this)
     * return types; cast to the appropriate subclass if necessary.
     * 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 UChar* 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 UChar*. 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 UChar* 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

/* STRENUM_H */
#endif