2
**********************************************************************
3
* Copyright (C) 2003-2008, International Business Machines
4
* Corporation and others. All Rights Reserved.
5
**********************************************************************
12
#include "layout/LETypes.h"
13
#include "layout/LEFontInstance.h"
15
#include "unicode/utypes.h"
16
#include "unicode/locid.h"
20
* \brief C++ API: base class for building classes which represent data that is associated with runs of text.
26
* The initial size of an array if it is unspecified.
30
#define INITIAL_CAPACITY 16
33
* When an array needs to grow, it will double in size until
34
* it becomes this large, then it will grow by this amount.
38
#define CAPACITY_GROW_LIMIT 128
41
* The <code>RunArray</code> class is a base class for building classes
42
* which represent data that is associated with runs of text. This class
43
* maintains an array of limit indices into the text, subclasses
44
* provide one or more arrays of data.
48
class U_LAYOUTEX_API RunArray : public UObject
52
* Construct a <code>RunArray</code> object from a pre-existing
53
* array of limit indices.
55
* @param limits is an array of limit indices. This array must remain
56
* valid until the <code>RunArray</code> object is destroyed.
58
* @param count is the number of entries in the limit array.
62
inline RunArray(const le_int32 *limits, le_int32 count);
65
* Construct an empty <code>RunArray</code> object. Clients can add limit
66
* indices array using the <code>add</code> method.
68
* @param initialCapacity is the initial size of the limit indices array. If
69
* this value is zero, no array will be allocated.
75
RunArray(le_int32 initialCapacity);
78
* The destructor; virtual so that subclass destructors are invoked as well.
85
* Get the number of entries in the limit indices array.
87
* @return the number of entries in the limit indices array.
91
inline le_int32 getCount() const;
94
* Reset the limit indices array. This method sets the number of entries in the
95
* limit indices array to zero. It does not delete the array.
97
* Note: Subclass arrays will also be reset and not deleted.
104
* Get the last limit index. This is the number of characters in
107
* @return the last limit index.
111
inline le_int32 getLimit() const;
114
* Get the limit index for a particular run of text.
116
* @param run is the run. This is an index into the limit index array.
118
* @return the limit index for the run, or -1 if <code>run</code> is out of bounds.
122
inline le_int32 getLimit(le_int32 run) const;
125
* Add a limit index to the limit indices array and return the run index
126
* where it was stored. If the array does not exist, it will be created by
127
* calling the <code>init</code> method. If it is full, it will be grown by
128
* calling the <code>grow</code> method.
130
* If the <code>RunArray</code> object was created with a client-supplied
131
* limit indices array, this method will return a run index of -1.
133
* Subclasses should not override this method. Rather they should provide
134
* a new <code>add</code> method which takes a limit index along with whatever
135
* other data they implement. The new <code>add</code> method should
136
* first call this method to grow the data arrays, and use the return value
137
* to store the data in their own arrays.
139
* @param limit is the limit index to add to the array.
141
* @return the run index where the limit index was stored, or -1 if the limit index cannt be stored.
148
le_int32 add(le_int32 limit);
151
* ICU "poor man's RTTI", returns a UClassID for this class.
155
static inline UClassID getStaticClassID() { return (UClassID)&fgClassID; }
158
* ICU "poor man's RTTI", returns a UClassID for the actual class.
162
virtual inline UClassID getDynamicClassID() const { return getStaticClassID(); }
166
* Create a data array with the given initial size. This method will be
167
* called by the <code>add</code> method if there is no limit indices
168
* array. Subclasses which override this method must also call it from
169
* the overriding method to create the limit indices array.
171
* @param capacity is the initial size of the data array.
177
virtual void init(le_int32 capacity);
180
* Grow a data array to the given initial size. This method will be
181
* called by the <code>add</code> method if the limit indices
182
* array is full. Subclasses which override this method must also call it from
183
* the overriding method to grow the limit indices array.
185
* @param capacity is the initial size of the data array.
191
virtual void grow(le_int32 capacity);
194
* Set by the constructors to indicate whether
195
* or not the client supplied the data arrays.
196
* If they were supplied by the client, the
197
* <code>add</code> method won't change the arrays
198
* and the destructor won't delete them.
202
le_bool fClientArrays;
206
* The address of this static class variable serves as this class's ID
207
* for ICU "poor man's RTTI".
209
static const char fgClassID;
211
le_int32 ensureCapacity();
214
inline RunArray(const RunArray & /*other*/);
215
inline RunArray &operator=(const RunArray & /*other*/) { return *this; };
217
const le_int32 *fLimits;
222
inline RunArray::RunArray()
223
: UObject(), fClientArrays(FALSE), fLimits(NULL), fCount(0), fCapacity(0)
225
// nothing else to do...
228
inline RunArray::RunArray(const RunArray & /*other*/)
229
: UObject(), fClientArrays(FALSE), fLimits(NULL), fCount(0), fCapacity(0)
231
// nothing else to do...
234
inline RunArray::RunArray(const le_int32 *limits, le_int32 count)
235
: UObject(), fClientArrays(TRUE), fLimits(limits), fCount(count), fCapacity(count)
237
// nothing else to do...
240
inline le_int32 RunArray::getCount() const
245
inline void RunArray::reset()
250
inline le_int32 RunArray::getLimit(le_int32 run) const
252
if (run < 0 || run >= fCount) {
259
inline le_int32 RunArray::getLimit() const
261
return getLimit(fCount - 1);
265
* The <code>FontRuns</code> class associates pointers to <code>LEFontInstance</code>
266
* objects with runs of text.
270
class U_LAYOUTEX_API FontRuns : public RunArray
274
* Construct a <code>FontRuns</code> object from pre-existing arrays of fonts
277
* @param fonts is the address of an array of pointers to <code>LEFontInstance</code> objects. This
278
* array, and the <code>LEFontInstance</code> objects to which it points must remain
279
* valid until the <code>FontRuns</code> object is destroyed.
281
* @param limits is the address of an array of limit indices. This array must remain valid until
282
* the <code>FontRuns</code> object is destroyed.
284
* @param count is the number of entries in the two arrays.
288
inline FontRuns(const LEFontInstance **fonts, const le_int32 *limits, le_int32 count);
291
* Construct an empty <code>FontRuns</code> object. Clients can add font and limit
292
* indices arrays using the <code>add</code> method.
294
* @param initialCapacity is the initial size of the font and limit indices arrays. If
295
* this value is zero, no arrays will be allocated.
301
FontRuns(le_int32 initialCapacity);
304
* The destructor; virtual so that subclass destructors are invoked as well.
311
* Get the <code>LEFontInstance</code> object assoicated with the given run
312
* of text. Use <code>RunArray::getLimit(run)</code> to get the corresponding
315
* @param run is the index into the font and limit indices arrays.
317
* @return the <code>LEFontInstance</code> associated with the given text run.
319
* @see RunArray::getLimit
323
const LEFontInstance *getFont(le_int32 run) const;
327
* Add an <code>LEFontInstance</code> and limit index pair to the data arrays and return
328
* the run index where the data was stored. This method calls
329
* <code>RunArray::add(limit)</code> which will create or grow the arrays as needed.
331
* If the <code>FontRuns</code> object was created with a client-supplied
332
* font and limit indices arrays, this method will return a run index of -1.
334
* Subclasses should not override this method. Rather they should provide a new <code>add</code>
335
* method which takes a font and a limit index along with whatever other data they implement.
336
* The new <code>add</code> method should first call this method to grow the font and limit indices
337
* arrays, and use the returned run index to store data their own arrays.
339
* @param font is the address of the <code>LEFontInstance</code> to add. This object must
340
* remain valid until the <code>FontRuns</code> object is destroyed.
342
* @param limit is the limit index to add
344
* @return the run index where the font and limit index were stored, or -1 if the data cannot be stored.
348
le_int32 add(const LEFontInstance *font, le_int32 limit);
351
* ICU "poor man's RTTI", returns a UClassID for this class.
355
static inline UClassID getStaticClassID() { return (UClassID)&fgClassID; }
358
* ICU "poor man's RTTI", returns a UClassID for the actual class.
362
virtual inline UClassID getDynamicClassID() const { return getStaticClassID(); }
365
virtual void init(le_int32 capacity);
366
virtual void grow(le_int32 capacity);
371
inline FontRuns(const FontRuns &other);
372
inline FontRuns &operator=(const FontRuns & /*other*/) { return *this; };
375
* The address of this static class variable serves as this class's ID
376
* for ICU "poor man's RTTI".
378
static const char fgClassID;
380
const LEFontInstance **fFonts;
383
inline FontRuns::FontRuns()
384
: RunArray(0), fFonts(NULL)
386
// nothing else to do...
389
inline FontRuns::FontRuns(const FontRuns & /*other*/)
390
: RunArray(0), fFonts(NULL)
392
// nothing else to do...
395
inline FontRuns::FontRuns(const LEFontInstance **fonts, const le_int32 *limits, le_int32 count)
396
: RunArray(limits, count), fFonts(fonts)
398
// nothing else to do...
402
* The <code>LocaleRuns</code> class associates pointers to <code>Locale</code>
403
* objects with runs of text.
407
class U_LAYOUTEX_API LocaleRuns : public RunArray
411
* Construct a <code>LocaleRuns</code> object from pre-existing arrays of locales
414
* @param locales is the address of an array of pointers to <code>Locale</code> objects. This array,
415
* and the <code>Locale</code> objects to which it points, must remain valid until
416
* the <code>LocaleRuns</code> object is destroyed.
418
* @param limits is the address of an array of limit indices. This array must remain valid until the
419
* <code>LocaleRuns</code> object is destroyed.
421
* @param count is the number of entries in the two arrays.
425
inline LocaleRuns(const Locale **locales, const le_int32 *limits, le_int32 count);
428
* Construct an empty <code>LocaleRuns</code> object. Clients can add locale and limit
429
* indices arrays using the <code>add</code> method.
431
* @param initialCapacity is the initial size of the locale and limit indices arrays. If
432
* this value is zero, no arrays will be allocated.
438
LocaleRuns(le_int32 initialCapacity);
441
* The destructor; virtual so that subclass destructors are invoked as well.
445
virtual ~LocaleRuns();
448
* Get the <code>Locale</code> object assoicated with the given run
449
* of text. Use <code>RunArray::getLimit(run)</code> to get the corresponding
452
* @param run is the index into the font and limit indices arrays.
454
* @return the <code>Locale</code> associated with the given text run.
456
* @see RunArray::getLimit
460
const Locale *getLocale(le_int32 run) const;
464
* Add a <code>Locale</code> and limit index pair to the data arrays and return
465
* the run index where the data was stored. This method calls
466
* <code>RunArray::add(limit)</code> which will create or grow the arrays as needed.
468
* If the <code>LocaleRuns</code> object was created with a client-supplied
469
* locale and limit indices arrays, this method will return a run index of -1.
471
* Subclasses should not override this method. Rather they should provide a new <code>add</code>
472
* method which takes a locale and a limit index along with whatever other data they implement.
473
* The new <code>add</code> method should first call this method to grow the font and limit indices
474
* arrays, and use the returned run index to store data their own arrays.
476
* @param locale is the address of the <code>Locale</code> to add. This object must remain valid
477
* until the <code>LocaleRuns</code> object is destroyed.
479
* @param limit is the limit index to add
481
* @return the run index where the locale and limit index were stored, or -1 if the data cannot be stored.
485
le_int32 add(const Locale *locale, le_int32 limit);
488
* ICU "poor man's RTTI", returns a UClassID for this class.
492
static inline UClassID getStaticClassID() { return (UClassID)&fgClassID; }
495
* ICU "poor man's RTTI", returns a UClassID for the actual class.
499
virtual inline UClassID getDynamicClassID() const { return getStaticClassID(); }
502
virtual void init(le_int32 capacity);
503
virtual void grow(le_int32 capacity);
508
const Locale **fLocales;
513
inline LocaleRuns(const LocaleRuns &other);
514
inline LocaleRuns &operator=(const LocaleRuns & /*other*/) { return *this; };
517
* The address of this static class variable serves as this class's ID
518
* for ICU "poor man's RTTI".
520
static const char fgClassID;
523
inline LocaleRuns::LocaleRuns()
524
: RunArray(0), fLocales(NULL)
526
// nothing else to do...
529
inline LocaleRuns::LocaleRuns(const LocaleRuns & /*other*/)
530
: RunArray(0), fLocales(NULL)
532
// nothing else to do...
535
inline LocaleRuns::LocaleRuns(const Locale **locales, const le_int32 *limits, le_int32 count)
536
: RunArray(limits, count), fLocales(locales)
538
// nothing else to do...
542
* The <code>ValueRuns</code> class associates integer values with runs of text.
546
class U_LAYOUTEX_API ValueRuns : public RunArray
550
* Construct a <code>ValueRuns</code> object from pre-existing arrays of values
553
* @param values is the address of an array of integer. This array must remain valid until
554
* the <code>ValueRuns</code> object is destroyed.
556
* @param limits is the address of an array of limit indices. This array must remain valid until
557
* the <code>ValueRuns</code> object is destroyed.
559
* @param count is the number of entries in the two arrays.
563
inline ValueRuns(const le_int32 *values, const le_int32 *limits, le_int32 count);
566
* Construct an empty <code>ValueRuns</code> object. Clients can add value and limit
567
* indices arrays using the <code>add</code> method.
569
* @param initialCapacity is the initial size of the value and limit indices arrays. If
570
* this value is zero, no arrays will be allocated.
576
ValueRuns(le_int32 initialCapacity);
579
* The destructor; virtual so that subclass destructors are invoked as well.
583
virtual ~ValueRuns();
586
* Get the integer value assoicated with the given run
587
* of text. Use <code>RunArray::getLimit(run)</code> to get the corresponding
590
* @param run is the index into the font and limit indices arrays.
592
* @return the integer value associated with the given text run.
594
* @see RunArray::getLimit
598
le_int32 getValue(le_int32 run) const;
602
* Add an integer value and limit index pair to the data arrays and return
603
* the run index where the data was stored. This method calls
604
* <code>RunArray::add(limit)</code> which will create or grow the arrays as needed.
606
* If the <code>ValueRuns</code> object was created with a client-supplied
607
* font and limit indices arrays, this method will return a run index of -1.
609
* Subclasses should not override this method. Rather they should provide a new <code>add</code>
610
* method which takes an integer value and a limit index along with whatever other data they implement.
611
* The new <code>add</code> method should first call this method to grow the font and limit indices
612
* arrays, and use the returned run index to store data their own arrays.
614
* @param value is the integer value to add
616
* @param limit is the limit index to add
618
* @return the run index where the value and limit index were stored, or -1 if the data cannot be stored.
622
le_int32 add(le_int32 value, le_int32 limit);
625
* ICU "poor man's RTTI", returns a UClassID for this class.
629
static inline UClassID getStaticClassID() { return (UClassID)&fgClassID; }
632
* ICU "poor man's RTTI", returns a UClassID for the actual class.
636
virtual inline UClassID getDynamicClassID() const { return getStaticClassID(); }
639
virtual void init(le_int32 capacity);
640
virtual void grow(le_int32 capacity);
645
inline ValueRuns(const ValueRuns &other);
646
inline ValueRuns &operator=(const ValueRuns & /*other*/) { return *this; };
649
* The address of this static class variable serves as this class's ID
650
* for ICU "poor man's RTTI".
652
static const char fgClassID;
654
const le_int32 *fValues;
657
inline ValueRuns::ValueRuns()
658
: RunArray(0), fValues(NULL)
660
// nothing else to do...
663
inline ValueRuns::ValueRuns(const ValueRuns & /*other*/)
664
: RunArray(0), fValues(NULL)
666
// nothing else to do...
669
inline ValueRuns::ValueRuns(const le_int32 *values, const le_int32 *limits, le_int32 count)
670
: RunArray(limits, count), fValues(values)
672
// nothing else to do...