/*
**********************************************************************
-* Copyright (c) 2002-2003, International Business Machines
+* Copyright (c) 2002-2004, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
-* $Source: /cvs/root/ICU/icuSources/common/unicode/usetiter.h,v $
-**********************************************************************
*/
#ifndef USETITER_H
#define USETITER_H
* }
* </pre>
* @author M. Davis
- * @draft ICU 2.2
+ * @stable ICU 2.4
*/
class U_COMMON_API UnicodeSetIterator : public UObject {
protected:
-
+
/**
* Value of <tt>codepoint</tt> if the iterator points to a string.
* If <tt>codepoint == IS_STRING</tt>, then examine
* <tt>string</tt> for the current iteration result.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
enum { IS_STRING = -1 };
/**
* Current code point, or the special value <tt>IS_STRING</tt>, if
* the iterator points to a string.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
UChar32 codepoint;
* iterating over code points using <tt>next()</tt>, or if
* <tt>codepoint == IS_STRING</tt>, then the value of
* <tt>codepointEnd</tt> is undefined.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
UChar32 codepointEnd;
* If <tt>codepoint == IS_STRING</tt>, then <tt>string</tt> points
* to the current string. If <tt>codepoint != IS_STRING</tt>, the
* value of <tt>string</tt> is undefined.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
const UnicodeString* string;
* Create an iterator over the given set. The iterator is valid
* only so long as <tt>set</tt> is valid.
* @param set set to iterate over
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
UnicodeSetIterator(const UnicodeSet& set);
-
+
/**
* Create an iterator over nothing. <tt>next()</tt> and
* <tt>nextRange()</tt> return false. This is a convenience
* constructor allowing the target to be set later.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
UnicodeSetIterator();
-
+
/**
* Destructor.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
virtual ~UnicodeSetIterator();
* <tt>nextRange()</tt> was called, and the caller can retrieve it
* with <tt>getCodepoint()</tt> and, for a range,
* <tt>getCodepointEnd()</tt>.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
inline UBool isString() const;
/**
* Returns the current code point, if <tt>isString()</tt> returned
* false. Otherwise returns an undefined result.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
inline UChar32 getCodepoint() const;
* Returns the end of the current code point range, if
* <tt>isString()</tt> returned false and <tt>nextRange()</tt> was
* called. Otherwise returns an undefined result.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
inline UChar32 getCodepointEnd() const;
/**
* Returns the current string, if <tt>isString()</tt> returned
* true. Otherwise returns an undefined result.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
inline const UnicodeString& getString() const;
* false. If <tt>codepoint == IS_STRING</tt>, the value is a
* string in the <tt>string</tt> field. Otherwise the value is a
* single code point in the <tt>codepoint</tt> field.
- *
+ *
* <p>The order of iteration is all code points in sorted order,
* followed by all strings sorted order. <tt>codepointEnd</tt> is
* undefined after calling this method. <tt>string</tt> is
*
* @return true if there was another element in the set and this
* object contains the element.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
UBool next();
-
+
/**
* Returns the next element in the set, either a code point range
* or a string. If there are no more elements in the set, return
* string in the <tt>string</tt> field. Otherwise the value is a
* range of one or more code points from <tt>codepoint</tt> to
* <tt>codepointeEnd</tt> inclusive.
- *
+ *
* <p>The order of iteration is all code points ranges in sorted
* order, followed by all strings sorted order. Ranges are
* disjoint and non-contiguous. <tt>string</tt> is undefined
*
* @return true if there was another element in the set and this
* object contains the element.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
UBool nextRange();
-
+
/**
* Sets this iterator to visit the elements of the given set and
* resets it to the start of that set. The iterator is valid only
* so long as <tt>set</tt> is valid.
* @param set the set to iterate over.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
void reset(const UnicodeSet& set);
-
+
/**
* Resets this iterator to the start of the set.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
void reset();
-
+
/**
- * ICU "poor man's RTTI", returns a UClassID for the actual class.
+ * ICU "poor man's RTTI", returns a UClassID for this class.
*
- * @draft ICU 2.2
+ * @stable ICU 2.4
*/
- virtual inline UClassID getDynamicClassID() const;
+ static UClassID U_EXPORT2 getStaticClassID();
/**
- * ICU "poor man's RTTI", returns a UClassID for this class.
+ * ICU "poor man's RTTI", returns a UClassID for the actual class.
*
- * @draft ICU 2.2
+ * @stable ICU 2.4
*/
- static inline UClassID getStaticClassID();
+ virtual UClassID getDynamicClassID() const;
// ======================= PRIVATES ===========================
-
+
protected:
// endElement and nextElements are really UChar32's, but we keep
// them as signed int32_t's so we can do comparisons with
// endElement set to -1. Leave them as int32_t's.
/** The set
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
const UnicodeSet* set;
/** End range
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
int32_t endRange;
/** Range
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
int32_t range;
/** End element
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
int32_t endElement;
/** Next element
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
int32_t nextElement;
//UBool abbreviated;
/** Next string
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
int32_t nextString;
/** String count
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
int32_t stringCount;
/** Copy constructor. Disallowed.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
UnicodeSetIterator(const UnicodeSetIterator&); // disallow
/** Assignment operator. Disallowed.
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
UnicodeSetIterator& operator=(const UnicodeSetIterator&); // disallow
/** Load range
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
virtual void loadRange(int32_t range);
-private:
-
- /**
- * The address of this static class variable serves as this class's ID
- * for ICU "poor man's RTTI".
- */
- static const char fgClassID;
};
-inline UClassID
-UnicodeSetIterator::getStaticClassID()
-{ return (UClassID)&fgClassID; }
-
-inline UClassID
-UnicodeSetIterator::getDynamicClassID() const
-{ return UnicodeSetIterator::getStaticClassID(); }
-
inline UBool UnicodeSetIterator::isString() const {
return codepoint == (UChar32)IS_STRING;
}
projects / apple / icu.git / blobdiff