/*
**********************************************************************
- * Copyright (C) 2003, International Business Machines
+ * Copyright (C) 2003-2008, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
*/
#include "unicode/utypes.h"
#include "unicode/locid.h"
+/**
+ * \file
+ * \brief C++ API: base class for building classes which represent data that is associated with runs of text.
+ */
+
U_NAMESPACE_BEGIN
/**
* The initial size of an array if it is unspecified.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
#define INITIAL_CAPACITY 16
* When an array needs to grow, it will double in size until
* it becomes this large, then it will grow by this amount.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
#define CAPACITY_GROW_LIMIT 128
* maintains an array of limit indices into the text, subclasses
* provide one or more arrays of data.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
class U_LAYOUTEX_API RunArray : public UObject
{
* Construct a <code>RunArray</code> object from a pre-existing
* array of limit indices.
*
- * @param limits is an array of limit indices.
+ * @param limits is an array of limit indices. This array must remain
+ * valid until the <code>RunArray</code> object is destroyed.
*
* @param count is the number of entries in the limit array.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
- RunArray(const le_int32 *limits, le_int32 count);
+ inline RunArray(const le_int32 *limits, le_int32 count);
/**
* Construct an empty <code>RunArray</code> object. Clients can add limit
*
* @see add
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
- RunArray(le_int32 initalCapacity);
+ RunArray(le_int32 initialCapacity);
/**
* The destructor; virtual so that subclass destructors are invoked as well.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
virtual ~RunArray();
*
* @return the number of entries in the limit indices array.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
- le_int32 getCount() const;
+ inline le_int32 getCount() const;
+
+ /**
+ * Reset the limit indices array. This method sets the number of entries in the
+ * limit indices array to zero. It does not delete the array.
+ *
+ * Note: Subclass arrays will also be reset and not deleted.
+ *
+ * @stable ICU 3.6
+ */
+ inline void reset();
/**
* Get the last limit index. This is the number of characters in
*
* @return the last limit index.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
- le_int32 getLimit() const;
+ inline le_int32 getLimit() const;
/**
* Get the limit index for a particular run of text.
*
* @return the limit index for the run, or -1 if <code>run</code> is out of bounds.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
- le_int32 getLimit(le_int32 run) const;
+ inline le_int32 getLimit(le_int32 run) const;
/**
* Add a limit index to the limit indices array and return the run index
* @see init
* @see grow
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
le_int32 add(le_int32 limit);
/**
- * 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.6
+ * @stable ICU 3.2
*/
- virtual inline UClassID getDynamicClassID() const { return getStaticClassID(); }
+ static inline UClassID getStaticClassID() { return (UClassID)&fgClassID; }
/**
- * 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.6
+ * @stable ICU 3.2
*/
- static inline UClassID getStaticClassID() { return (UClassID)&fgClassID; }
+ virtual inline UClassID getDynamicClassID() const { return getStaticClassID(); }
protected:
/**
*
* @see add
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
virtual void init(le_int32 capacity);
*
* @see add
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
virtual void grow(le_int32 capacity);
* <code>add</code> method won't change the arrays
* and the destructor won't delete them.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
le_bool fClientArrays;
le_int32 ensureCapacity();
- RunArray();
- RunArray(const RunArray & /*other*/);
- RunArray &operator=(const RunArray & /*other*/) { return *this; };
+ inline RunArray();
+ inline RunArray(const RunArray & /*other*/);
+ inline RunArray &operator=(const RunArray & /*other*/) { return *this; };
const le_int32 *fLimits;
le_int32 fCount;
};
inline RunArray::RunArray()
- : UObject(), fClientArrays(false), fLimits(NULL), fCount(0), fCapacity(0)
+ : UObject(), fClientArrays(FALSE), fLimits(NULL), fCount(0), fCapacity(0)
{
- // nothing else to do...
+ // nothing else to do...
}
inline RunArray::RunArray(const RunArray & /*other*/)
- : UObject(), fClientArrays(false), fLimits(NULL), fCount(0), fCapacity(0)
+ : UObject(), fClientArrays(FALSE), fLimits(NULL), fCount(0), fCapacity(0)
{
- // nothing else to do...
+ // nothing else to do...
}
inline RunArray::RunArray(const le_int32 *limits, le_int32 count)
- : UObject(), fClientArrays(true), fLimits(limits), fCount(count), fCapacity(count)
+ : UObject(), fClientArrays(TRUE), fLimits(limits), fCount(count), fCapacity(count)
{
// nothing else to do...
}
-inline RunArray::RunArray(le_int32 initialCapacity)
- : fClientArrays(false), fLimits(NULL), fCount(0), fCapacity(initialCapacity)
-{
- if (initialCapacity > 0) {
- fLimits = LE_NEW_ARRAY(le_int32, fCapacity);
- }
-}
-
-inline RunArray::~RunArray()
+inline le_int32 RunArray::getCount() const
{
- if (! fClientArrays) {
- LE_DELETE_ARRAY(fLimits);
- fLimits = NULL;
- }
+ return fCount;
}
-inline le_int32 RunArray::getCount() const
+inline void RunArray::reset()
{
- return fCount;
+ fCount = 0;
}
inline le_int32 RunArray::getLimit(le_int32 run) const
* The <code>FontRuns</code> class associates pointers to <code>LEFontInstance</code>
* objects with runs of text.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
class U_LAYOUTEX_API FontRuns : public RunArray
{
* Construct a <code>FontRuns</code> object from pre-existing arrays of fonts
* and limit indices.
*
- * @param fonts is the address of an array of pointers to <code>LEFontInstance</code> objects.
+ * @param fonts is the address of an array of pointers to <code>LEFontInstance</code> objects. This
+ * array, and the <code>LEFontInstance</code> objects to which it points must remain
+ * valid until the <code>FontRuns</code> object is destroyed.
*
- * @param limits is the address of an array of limit indices.
+ * @param limits is the address of an array of limit indices. This array must remain valid until
+ * the <code>FontRuns</code> object is destroyed.
*
* @param count is the number of entries in the two arrays.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
- FontRuns(const LEFontInstance **fonts, const le_int32 *limits, le_int32 count);
+ inline FontRuns(const LEFontInstance **fonts, const le_int32 *limits, le_int32 count);
/**
* Construct an empty <code>FontRuns</code> object. Clients can add font and limit
*
* @see add
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
FontRuns(le_int32 initialCapacity);
/**
* The destructor; virtual so that subclass destructors are invoked as well.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
virtual ~FontRuns();
*
* @see RunArray::getLimit
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
const LEFontInstance *getFont(le_int32 run) const;
* The new <code>add</code> method should first call this method to grow the font and limit indices
* arrays, and use the returned run index to store data their own arrays.
*
- * @param font is the address of the <code>LEFontInstance</code> to add
+ * @param font is the address of the <code>LEFontInstance</code> to add. This object must
+ * remain valid until the <code>FontRuns</code> object is destroyed.
*
* @param limit is the limit index to add
*
* @return the run index where the font and limit index were stored, or -1 if the data cannot be stored.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
le_int32 add(const LEFontInstance *font, le_int32 limit);
/**
- * 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.6
+ * @stable ICU 3.2
*/
- virtual inline UClassID getDynamicClassID() const { return getStaticClassID(); }
+ static inline UClassID getStaticClassID() { return (UClassID)&fgClassID; }
/**
- * 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.6
+ * @stable ICU 3.2
*/
- static inline UClassID getStaticClassID() { return (UClassID)&fgClassID; }
+ virtual inline UClassID getDynamicClassID() const { return getStaticClassID(); }
protected:
virtual void init(le_int32 capacity);
private:
- FontRuns();
- FontRuns(const FontRuns &other);
- FontRuns &operator=(const FontRuns & /*other*/) { return *this; };
+ inline FontRuns();
+ inline FontRuns(const FontRuns &other);
+ inline FontRuns &operator=(const FontRuns & /*other*/) { return *this; };
/**
* The address of this static class variable serves as this class's ID
};
inline FontRuns::FontRuns()
- : RunArray(0), fFonts(NULL)
+ : RunArray(0), fFonts(NULL)
{
- // nothing else to do...
+ // nothing else to do...
}
inline FontRuns::FontRuns(const FontRuns & /*other*/)
- : RunArray(0), fFonts(NULL)
+ : RunArray(0), fFonts(NULL)
{
- // nothing else to do...
+ // nothing else to do...
}
inline FontRuns::FontRuns(const LEFontInstance **fonts, const le_int32 *limits, le_int32 count)
// nothing else to do...
}
-inline FontRuns::FontRuns(le_int32 initialCapacity)
- : RunArray(initialCapacity), fFonts(NULL)
-{
- if (initialCapacity > 0) {
- fFonts = LE_NEW_ARRAY(const LEFontInstance *, initialCapacity);
- }
-}
-
-inline FontRuns::~FontRuns()
-{
- if (! fClientArrays) {
- LE_DELETE_ARRAY(fFonts);
- fFonts = NULL;
- }
-}
-
/**
* The <code>LocaleRuns</code> class associates pointers to <code>Locale</code>
* objects with runs of text.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
class U_LAYOUTEX_API LocaleRuns : public RunArray
{
* Construct a <code>LocaleRuns</code> object from pre-existing arrays of locales
* and limit indices.
*
- * @param locales is the address of an array of pointers to <code>Locale</code> objects.
+ * @param locales is the address of an array of pointers to <code>Locale</code> objects. This array,
+ * and the <code>Locale</code> objects to which it points, must remain valid until
+ * the <code>LocaleRuns</code> object is destroyed.
*
- * @param limits is the address of an array of limit indices.
+ * @param limits is the address of an array of limit indices. This array must remain valid until the
+ * <code>LocaleRuns</code> object is destroyed.
*
* @param count is the number of entries in the two arrays.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
- LocaleRuns(const Locale **locales, const le_int32 *limits, le_int32 count);
+ inline LocaleRuns(const Locale **locales, const le_int32 *limits, le_int32 count);
/**
* Construct an empty <code>LocaleRuns</code> object. Clients can add locale and limit
*
* @see add
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
LocaleRuns(le_int32 initialCapacity);
/**
* The destructor; virtual so that subclass destructors are invoked as well.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
virtual ~LocaleRuns();
*
* @see RunArray::getLimit
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
const Locale *getLocale(le_int32 run) const;
* The new <code>add</code> method should first call this method to grow the font and limit indices
* arrays, and use the returned run index to store data their own arrays.
*
- * @param locale is the address of the <code>Locale</code> to add
+ * @param locale is the address of the <code>Locale</code> to add. This object must remain valid
+ * until the <code>LocaleRuns</code> object is destroyed.
*
* @param limit is the limit index to add
*
* @return the run index where the locale and limit index were stored, or -1 if the data cannot be stored.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
le_int32 add(const Locale *locale, le_int32 limit);
/**
- * 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.6
+ * @stable ICU 3.2
*/
- virtual inline UClassID getDynamicClassID() const { return getStaticClassID(); }
+ static inline UClassID getStaticClassID() { return (UClassID)&fgClassID; }
/**
- * 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.6
+ * @stable ICU 3.2
*/
- static inline UClassID getStaticClassID() { return (UClassID)&fgClassID; }
+ virtual inline UClassID getDynamicClassID() const { return getStaticClassID(); }
protected:
virtual void init(le_int32 capacity);
virtual void grow(le_int32 capacity);
+ /**
+ * @internal
+ */
+ const Locale **fLocales;
+
private:
- LocaleRuns();
- LocaleRuns(const LocaleRuns &other);
- LocaleRuns &operator=(const LocaleRuns & /*other*/) { return *this; };
+ inline LocaleRuns();
+ inline LocaleRuns(const LocaleRuns &other);
+ inline LocaleRuns &operator=(const LocaleRuns & /*other*/) { return *this; };
/**
* The address of this static class variable serves as this class's ID
* for ICU "poor man's RTTI".
*/
static const char fgClassID;
-
- const Locale **fLocales;
};
inline LocaleRuns::LocaleRuns()
- : RunArray(0), fLocales(NULL)
+ : RunArray(0), fLocales(NULL)
{
- // nothing else to do...
+ // nothing else to do...
}
inline LocaleRuns::LocaleRuns(const LocaleRuns & /*other*/)
- : RunArray(0), fLocales(NULL)
+ : RunArray(0), fLocales(NULL)
{
- // nothing else to do...
+ // nothing else to do...
}
inline LocaleRuns::LocaleRuns(const Locale **locales, const le_int32 *limits, le_int32 count)
// nothing else to do...
}
-inline LocaleRuns::LocaleRuns(le_int32 initialCapacity)
- : RunArray(initialCapacity), fLocales(NULL)
-{
- if (initialCapacity > 0) {
- fLocales = LE_NEW_ARRAY(const Locale *, initialCapacity);
- }
-}
-
-inline LocaleRuns::~LocaleRuns()
-{
- if (! fClientArrays) {
- LE_DELETE_ARRAY(fLocales);
- fLocales = NULL;
- }
-}
-
/**
* The <code>ValueRuns</code> class associates integer values with runs of text.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
class U_LAYOUTEX_API ValueRuns : public RunArray
{
* Construct a <code>ValueRuns</code> object from pre-existing arrays of values
* and limit indices.
*
- * @param values is the address of an array of integer.
+ * @param values is the address of an array of integer. This array must remain valid until
+ * the <code>ValueRuns</code> object is destroyed.
*
- * @param limits is the address of an array of limit indices.
+ * @param limits is the address of an array of limit indices. This array must remain valid until
+ * the <code>ValueRuns</code> object is destroyed.
*
* @param count is the number of entries in the two arrays.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
- ValueRuns(const le_int32 *values, const le_int32 *limits, le_int32 count);
+ inline ValueRuns(const le_int32 *values, const le_int32 *limits, le_int32 count);
/**
* Construct an empty <code>ValueRuns</code> object. Clients can add value and limit
*
* @see add
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
ValueRuns(le_int32 initialCapacity);
/**
* The destructor; virtual so that subclass destructors are invoked as well.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
virtual ~ValueRuns();
*
* @see RunArray::getLimit
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
le_int32 getValue(le_int32 run) const;
*
* @return the run index where the value and limit index were stored, or -1 if the data cannot be stored.
*
- * @draft ICU 2.6
+ * @stable ICU 3.2
*/
le_int32 add(le_int32 value, le_int32 limit);
/**
- * 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.6
+ * @stable ICU 3.2
*/
- virtual inline UClassID getDynamicClassID() const { return getStaticClassID(); }
+ static inline UClassID getStaticClassID() { return (UClassID)&fgClassID; }
/**
- * 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.6
+ * @stable ICU 3.2
*/
- static inline UClassID getStaticClassID() { return (UClassID)&fgClassID; }
+ virtual inline UClassID getDynamicClassID() const { return getStaticClassID(); }
protected:
virtual void init(le_int32 capacity);
private:
- ValueRuns();
- ValueRuns(const ValueRuns &other);
- ValueRuns &operator=(const ValueRuns & /*other*/) { return *this; };
+ inline ValueRuns();
+ inline ValueRuns(const ValueRuns &other);
+ inline ValueRuns &operator=(const ValueRuns & /*other*/) { return *this; };
/**
* The address of this static class variable serves as this class's ID
};
inline ValueRuns::ValueRuns()
- : RunArray(0), fValues(NULL)
+ : RunArray(0), fValues(NULL)
{
- // nothing else to do...
+ // nothing else to do...
}
inline ValueRuns::ValueRuns(const ValueRuns & /*other*/)
- : RunArray(0), fValues(NULL)
+ : RunArray(0), fValues(NULL)
{
- // nothing else to do...
+ // nothing else to do...
}
inline ValueRuns::ValueRuns(const le_int32 *values, const le_int32 *limits, le_int32 count)
// nothing else to do...
}
-inline ValueRuns::ValueRuns(le_int32 initialCapacity)
- : RunArray(initialCapacity), fValues(NULL)
-{
- if (initialCapacity > 0) {
- fValues = LE_NEW_ARRAY(le_int32, initialCapacity);
- }
-}
-
-inline ValueRuns::~ValueRuns()
-{
- if (! fClientArrays) {
- LE_DELETE_ARRAY(fValues);
- fValues = NULL;
- }
-}
-
U_NAMESPACE_END
#endif
projects / apple / icu.git / blobdiff