ICU 56.1: plruns.h Source File

ICU 56.1 56.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

plruns.h
Go to the documentation of this file.
1 /*
2 *
3 * (C) Copyright IBM Corp. 1998-2011 - All Rights Reserved
4 *
5 */
6
7 #ifndef __PLRUNS_H
8 #define __PLRUNS_H
9
10 #include "unicode/utypes.h"
11
12 #ifndef U_HIDE_INTERNAL_API
13
14 #include "unicode/ubidi.h"
15 #include "layout/LETypes.h"
16
17 #include "layout/loengine.h"
18
22 typedef void pl_fontRuns;
26 typedef void pl_valueRuns;
30 typedef void pl_localeRuns;
31
56 U_INTERNAL pl_fontRuns * U_EXPORT2
57 pl_openFontRuns(const le_font **fonts,
58 const le_int32 *limits,
59 le_int32 count);
60
72 U_INTERNAL pl_fontRuns * U_EXPORT2
73 pl_openEmptyFontRuns(le_int32 initialCapacity);
74
83 U_INTERNAL void U_EXPORT2
84 pl_closeFontRuns(pl_fontRuns *fontRuns);
85
95 U_INTERNAL le_int32 U_EXPORT2
96 pl_getFontRunCount(const pl_fontRuns *fontRuns);
97
105 U_INTERNAL void U_EXPORT2
106 pl_resetFontRuns(pl_fontRuns *fontRuns);
107
118 U_INTERNAL le_int32 U_EXPORT2
119 pl_getFontRunLastLimit(const pl_fontRuns *fontRuns);
120
131 U_INTERNAL le_int32 U_EXPORT2
132 pl_getFontRunLimit(const pl_fontRuns *fontRuns,
133 le_int32 run);
134
147 U_INTERNAL const le_font * U_EXPORT2
148 pl_getFontRunFont(const pl_fontRuns *fontRuns,
149 le_int32 run);
150
151
170 U_INTERNAL le_int32 U_EXPORT2
171 pl_addFontRun(pl_fontRuns *fontRuns,
172 const le_font *font,
173 le_int32 limit);
174
189 U_INTERNAL pl_valueRuns * U_EXPORT2
190 pl_openValueRuns(const le_int32 *values,
191 const le_int32 *limits,
192 le_int32 count);
193
205 U_INTERNAL pl_valueRuns * U_EXPORT2
206 pl_openEmptyValueRuns(le_int32 initialCapacity);
207
216 U_INTERNAL void U_EXPORT2
217 pl_closeValueRuns(pl_valueRuns *valueRuns);
218
228 U_INTERNAL le_int32 U_EXPORT2
229 pl_getValueRunCount(const pl_valueRuns *valueRuns);
230
238 U_INTERNAL void U_EXPORT2
239 pl_resetValueRuns(pl_valueRuns *valueRuns);
240
251 U_INTERNAL le_int32 U_EXPORT2
252 pl_getValueRunLastLimit(const pl_valueRuns *valueRuns);
253
264 U_INTERNAL le_int32 U_EXPORT2
265 pl_getValueRunLimit(const pl_valueRuns *valueRuns,
266 le_int32 run);
267
280 U_INTERNAL le_int32 U_EXPORT2
281 pl_getValueRunValue(const pl_valueRuns *valueRuns,
282 le_int32 run);
283
284
302 U_INTERNAL le_int32 U_EXPORT2
303 pl_addValueRun(pl_valueRuns *valueRuns,
304 le_int32 value,
305 le_int32 limit);
306
321 U_INTERNAL pl_localeRuns * U_EXPORT2
322 pl_openLocaleRuns(const char **locales,
323 const le_int32 *limits,
324 le_int32 count);
325
337 U_INTERNAL pl_localeRuns * U_EXPORT2
338 pl_openEmptyLocaleRuns(le_int32 initialCapacity);
339
348 U_INTERNAL void U_EXPORT2
349 pl_closeLocaleRuns(pl_localeRuns *localeRuns);
350
360 U_INTERNAL le_int32 U_EXPORT2
361 pl_getLocaleRunCount(const pl_localeRuns *localeRuns);
362
370 U_INTERNAL void U_EXPORT2
371 pl_resetLocaleRuns(pl_localeRuns *localeRuns);
372
383 U_INTERNAL le_int32 U_EXPORT2
384 pl_getLocaleRunLastLimit(const pl_localeRuns *localeRuns);
385
396 U_INTERNAL le_int32 U_EXPORT2
397 pl_getLocaleRunLimit(const pl_localeRuns *localeRuns,
398 le_int32 run);
399
412 U_INTERNAL const char * U_EXPORT2
413 pl_getLocaleRunLocale(const pl_localeRuns *localeRuns,
414 le_int32 run);
415
416
435 U_INTERNAL le_int32 U_EXPORT2
436 pl_addLocaleRun(pl_localeRuns *localeRuns,
437 const char *locale,
438 le_int32 limit);
439
440 #endif /* U_HIDE_INTERNAL_API */
441 #endif
pl_localeRuns
void pl_localeRuns
Opaque datatype representing an array of locale runs.
Definition: plruns.h:30
pl_valueRuns
void pl_valueRuns
Opaque datatype representing an array of value runs.
Definition: plruns.h:26
pl_addFontRun
le_int32 pl_addFontRun(pl_fontRuns *fontRuns, const le_font *font, le_int32 limit)
Add a new font run to the given pl_fontRuns object.
pl_getFontRunLastLimit
le_int32 pl_getFontRunLastLimit(const pl_fontRuns *fontRuns)
Get the limit index for the last font run.
ubidi.h
C API: Bidi algorithm.
pl_openFontRuns
pl_fontRuns * pl_openFontRuns(const le_font **fonts, const le_int32 *limits, le_int32 count)
Construct a pl_fontRuns object from pre-existing arrays of fonts and limit indices.
pl_addLocaleRun
le_int32 pl_addLocaleRun(pl_localeRuns *localeRuns, const char *locale, le_int32 limit)
Add a new run to the given pl_localeRuns object.
pl_getLocaleRunCount
le_int32 pl_getLocaleRunCount(const pl_localeRuns *localeRuns)
Get the number of font runs.
U_INTERNAL
#define U_INTERNAL
This is used to declare a function as an internal ICU C API.
Definition: umachine.h:117
LETypes.h
C API: Basic definitions for the ICU LayoutEngine.
pl_resetFontRuns
void pl_resetFontRuns(pl_fontRuns *fontRuns)
Reset the number of font runs to zero.
le_int32
int32_t le_int32
A type used for signed, 32-bit integers.
Definition: LETypes.h:34
pl_getValueRunValue
le_int32 pl_getValueRunValue(const pl_valueRuns *valueRuns, le_int32 run)
Get the value assoicated with the given run * of text.
pl_getValueRunLimit
le_int32 pl_getValueRunLimit(const pl_valueRuns *valueRuns, le_int32 run)
Get the limit index for a particular value run.
pl_getFontRunCount
le_int32 pl_getFontRunCount(const pl_fontRuns *fontRuns)
Get the number of font runs.
pl_openValueRuns
pl_valueRuns * pl_openValueRuns(const le_int32 *values, const le_int32 *limits, le_int32 count)
Construct a pl_valueRuns object from pre-existing arrays of values and limit indices.
pl_resetValueRuns
void pl_resetValueRuns(pl_valueRuns *valueRuns)
Reset the number of value runs to zero.
pl_getFontRunFont
const le_font * pl_getFontRunFont(const pl_fontRuns *fontRuns, le_int32 run)
Get the le_font object assoicated with the given run of text.
pl_getLocaleRunLastLimit
le_int32 pl_getLocaleRunLastLimit(const pl_localeRuns *localeRuns)
Get the limit index for the last font run.
pl_openEmptyFontRuns
pl_fontRuns * pl_openEmptyFontRuns(le_int32 initialCapacity)
Construct an empty pl_fontRuns object.
pl_getValueRunCount
le_int32 pl_getValueRunCount(const pl_valueRuns *valueRuns)
Get the number of value runs.
pl_openEmptyLocaleRuns
pl_localeRuns * pl_openEmptyLocaleRuns(le_int32 initialCapacity)
Construct an empty pl_localeRuns object.
pl_openLocaleRuns
pl_localeRuns * pl_openLocaleRuns(const char **locales, const le_int32 *limits, le_int32 count)
Construct a pl_localeRuns object from pre-existing arrays of fonts and limit indices.
pl_getLocaleRunLocale
const char * pl_getLocaleRunLocale(const pl_localeRuns *localeRuns, le_int32 run)
Get the le_font object assoicated with the given run of text.
pl_addValueRun
le_int32 pl_addValueRun(pl_valueRuns *valueRuns, le_int32 value, le_int32 limit)
Add a new font run to the given pl_valueRuns object.
pl_closeFontRuns
void pl_closeFontRuns(pl_fontRuns *fontRuns)
Close the given pl_fontRuns object.
pl_openEmptyValueRuns
pl_valueRuns * pl_openEmptyValueRuns(le_int32 initialCapacity)
Construct an empty pl_valueRuns object.
pl_getValueRunLastLimit
le_int32 pl_getValueRunLastLimit(const pl_valueRuns *valueRuns)
Get the limit index for the last value run.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
pl_fontRuns
void pl_fontRuns
Opaque datatype representing an array of font runs.
Definition: plruns.h:22
pl_closeLocaleRuns
void pl_closeLocaleRuns(pl_localeRuns *localeRuns)
Close the given pl_localeRuns object.
pl_getLocaleRunLimit
le_int32 pl_getLocaleRunLimit(const pl_localeRuns *localeRuns, le_int32 run)
Get the limit index for a particular font run.
pl_getFontRunLimit
le_int32 pl_getFontRunLimit(const pl_fontRuns *fontRuns, le_int32 run)
Get the limit index for a particular font run.
pl_resetLocaleRuns
void pl_resetLocaleRuns(pl_localeRuns *localeRuns)
Reset the number of locale runs to zero.
pl_closeValueRuns
void pl_closeValueRuns(pl_valueRuns *valueRuns)
Close the given pl_valueRuns object.