|
ICU 57.1
57.1
|
C API: Basic definitions for the ICU LayoutEngine. More...
Go to the source code of this file.
Data Structures | |
| struct | LEPoint |
| Used to hold a pair of (x, y) values which represent a point. More... | |
Macros | |
| #define | NULL 0 |
| Used to represent empty pointers. More... | |
| #define | LE_GLYPH_MASK 0x0000FFFF |
| Used to mask off the glyph ID part of an LEGlyphID. More... | |
| #define | LE_GLYPH_SHIFT 0 |
| Used to shift the glyph ID part of an LEGlyphID into the low-order bits. More... | |
| #define | LE_SUB_FONT_MASK 0x00FF0000 |
| Used to mask off the sub-font ID part of an LEGlyphID. More... | |
| #define | LE_SUB_FONT_SHIFT 16 |
| Used to shift the sub-font ID part of an LEGlyphID into the low-order bits. More... | |
| #define | LE_CLIENT_MASK 0xFF000000 |
| Used to mask off the client-defined part of an LEGlyphID. More... | |
| #define | LE_CLIENT_SHIFT 24 |
| Used to shift the sub-font ID part of an LEGlyphID into the low-order bits. More... | |
| #define | LE_GET_GLYPH(gid) ((gid & LE_GLYPH_MASK) >> LE_GLYPH_SHIFT) |
| A convenience macro to get the Glyph ID part of an LEGlyphID. More... | |
| #define | LE_GET_SUB_FONT(gid) ((gid & LE_SUB_FONT_MASK) >> LE_SUB_FONT_SHIFT) |
| A convenience macro to get the sub-font ID part of an LEGlyphID. More... | |
| #define | LE_GET_CLIENT(gid) ((gid & LE_CLIENT_MASK) >> LE_CLIENT_SHIFT) |
| A convenience macro to get the client-defined part of an LEGlyphID. More... | |
| #define | LE_SET_GLYPH(gid, glyph) ((gid & ~LE_GLYPH_MASK) | ((glyph << LE_GLYPH_SHIFT) & LE_GLYPH_MASK)) |
| A convenience macro to set the Glyph ID part of an LEGlyphID. More... | |
| #define | LE_SET_SUB_FONT(gid, font) ((gid & ~LE_SUB_FONT_MASK) | ((font << LE_SUB_FONT_SHIFT) & LE_SUB_FONT_MASK)) |
| A convenience macro to set the sub-font ID part of an LEGlyphID. More... | |
| #define | LE_SET_CLIENT(gid, client) ((gid & ~LE_CLIENT_MASK) | ((client << LE_CLIENT_SHIFT) & LE_CLIENT_MASK)) |
| A convenience macro to set the client-defined part of an LEGlyphID. More... | |
| #define | LE_ASSERT_BAD_FONT 0 |
| #define | LE_DEBUG_BAD_FONT(x) |
| #define | LE_UINT32_MAX 0xFFFFFFFFU |
| #define | LE_UINTPTR_MAX LE_UINT32_MAX |
| Max value representable by a uintptr. | |
| #define | LE_RANGE_CHECK(type, count, ptrfn) (( (LE_UINTPTR_MAX / sizeof(type)) < (size_t)count ) ? NULL : (ptrfn)) |
| Range check for overflow. | |
| #define | LE_ARRAY_SIZE(array) (sizeof array / sizeof array[0]) |
| A convenience macro to get the length of an array. More... | |
| #define | LE_ARRAY_SIZE(array) (sizeof array / sizeof array[0]) |
| A convenience macro to get the length of an array. More... | |
| #define | LE_ARRAY_COPY(dst, src, count) memcpy((void *) (dst), (void *) (src), (count) * sizeof (src)[0]) |
| A convenience macro for copying an array. More... | |
| #define | LE_NEW_ARRAY(type, count) LE_RANGE_CHECK(type,count,(type *) malloc((count) * sizeof(type))) |
| Allocate an array of basic types. More... | |
| #define | LE_GROW_ARRAY(array, newSize) realloc((void *) (array), (newSize) * sizeof (array)[0]) |
| Re-allocate an array of basic types. More... | |
| #define | LE_DELETE_ARRAY(array) free((void *) (array)) |
| Free an array of basic types. More... | |
| #define | LE_MAKE_TAG(a, b, c, d) |
| A macro to construct the four-letter tags used to label TrueType tables, and for script, language and feature tags in OpenType tables. More... | |
| #define | LE_DEFAULT_FEATURE_FLAG (LE_Kerning_FEATURE_FLAG | LE_Ligatures_FEATURE_FLAG) |
| default features | |
| #define | LE_SUCCESS(code) (U_SUCCESS((UErrorCode)code)) |
| A convenience macro to test for the success of a LayoutEngine call. More... | |
| #define | LE_FAILURE(code) (U_FAILURE((UErrorCode)code)) |
| A convenience macro to test for the failure of a LayoutEngine call. More... | |
| #define | LE_Kerning_FEATURE_FLAG (1 << LE_Kerning_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_Ligatures_FEATURE_FLAG (1 << LE_Ligatures_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_CLIG_FEATURE_FLAG (1 << LE_CLIG_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_DLIG_FEATURE_FLAG (1 << LE_DLIG_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_HLIG_FEATURE_FLAG (1 << LE_HLIG_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_LIGA_FEATURE_FLAG (1 << LE_LIGA_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_RLIG_FEATURE_FLAG (1 << LE_RLIG_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_SMCP_FEATURE_FLAG (1 << LE_SMCP_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_FRAC_FEATURE_FLAG (1 << LE_FRAC_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_AFRC_FEATURE_FLAG (1 << LE_AFRC_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_ZERO_FEATURE_FLAG (1 << LE_ZERO_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_SWSH_FEATURE_FLAG (1 << LE_SWSH_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_CSWH_FEATURE_FLAG (1 << LE_CSWH_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_SALT_FEATURE_FLAG (1 << LE_SALT_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_NALT_FEATURE_FLAG (1 << LE_NALT_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_RUBY_FEATURE_FLAG (1 << LE_RUBY_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_SS01_FEATURE_FLAG (1 << LE_SS01_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_SS02_FEATURE_FLAG (1 << LE_SS02_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_SS03_FEATURE_FLAG (1 << LE_SS03_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_SS04_FEATURE_FLAG (1 << LE_SS04_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_SS05_FEATURE_FLAG (1 << LE_SS05_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_SS06_FEATURE_FLAG (1 << LE_SS06_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_SS07_FEATURE_FLAG (1 << LE_SS07_FEATURE_ENUM) |
| Flags for typographic features. More... | |
| #define | LE_CHAR_FILTER_FEATURE_FLAG (1 << LE_CHAR_FILTER_FEATURE_ENUM) |
| Flags for typographic features. More... | |
Typedefs | |
| typedef int32_t | le_int32 |
| A type used for signed, 32-bit integers. More... | |
| typedef uint32_t | le_uint32 |
| A type used for unsigned, 32-bit integers. More... | |
| typedef int16_t | le_int16 |
| A type used for signed, 16-bit integers. More... | |
| typedef uint16_t | le_uint16 |
| A type used for unsigned, 16-bit integers. More... | |
| typedef int8_t | le_int8 |
| A type used for signed, 8-bit integers. More... | |
| typedef uint8_t | le_uint8 |
| A type used for unsigned, 8-bit integers. More... | |
| typedef UBool | le_bool |
| A type used for boolean values. More... | |
| typedef le_uint32 | LETag |
| Used for four character tags. More... | |
| typedef le_uint16 | TTGlyphID |
| Used for 16-bit glyph indices as they're represented in TrueType font tables. More... | |
| typedef le_uint32 | LEGlyphID |
| Used for glyph indices. More... | |
| typedef UChar | LEUnicode16 |
| Used to represent 16-bit Unicode code points. More... | |
| typedef UChar32 | LEUnicode32 |
| Used to represent 32-bit Unicode code points. More... | |
| typedef UChar | LEUnicode |
| Used to represent 16-bit Unicode code points. More... | |
| typedef struct LEPoint | LEPoint |
| Used to hold a pair of (x, y) values which represent a point. More... | |
| typedef enum LEErrorCode | LEErrorCode |
| Error codes returned by the LayoutEngine. More... | |
C API: Basic definitions for the ICU LayoutEngine.
Definition in file LETypes.h.
| #define LE_AFRC_FEATURE_FLAG (1 << LE_AFRC_FEATURE_ENUM) |
| #define LE_ARRAY_COPY | ( | dst, | |
| src, | |||
| count | |||
| ) | memcpy((void *) (dst), (void *) (src), (count) * sizeof (src)[0]) |
| #define LE_ARRAY_SIZE | ( | array | ) | (sizeof array / sizeof array[0]) |
| #define LE_ARRAY_SIZE | ( | array | ) | (sizeof array / sizeof array[0]) |
| #define LE_CHAR_FILTER_FEATURE_FLAG (1 << LE_CHAR_FILTER_FEATURE_ENUM) |
| #define LE_CLIENT_MASK 0xFF000000 |
Used to mask off the client-defined part of an LEGlyphID.
| #define LE_CLIENT_SHIFT 24 |
Used to shift the sub-font ID part of an LEGlyphID into the low-order bits.
| #define LE_CLIG_FEATURE_FLAG (1 << LE_CLIG_FEATURE_ENUM) |
| #define LE_CSWH_FEATURE_FLAG (1 << LE_CSWH_FEATURE_ENUM) |
| #define LE_DEBUG_BAD_FONT | ( | x | ) |
| #define LE_DELETE_ARRAY | ( | array | ) | free((void *) (array)) |
Free an array of basic types.
This is used to isolate the rest of the LayoutEngine code from cmemory.h.
| #define LE_DLIG_FEATURE_FLAG (1 << LE_DLIG_FEATURE_ENUM) |
| #define LE_FAILURE | ( | code | ) | (U_FAILURE((UErrorCode)code)) |
A convenience macro to test for the failure of a LayoutEngine call.
| #define LE_FRAC_FEATURE_FLAG (1 << LE_FRAC_FEATURE_ENUM) |
| #define LE_GET_CLIENT | ( | gid | ) | ((gid & LE_CLIENT_MASK) >> LE_CLIENT_SHIFT) |
A convenience macro to get the client-defined part of an LEGlyphID.
| #define LE_GET_GLYPH | ( | gid | ) | ((gid & LE_GLYPH_MASK) >> LE_GLYPH_SHIFT) |
A convenience macro to get the Glyph ID part of an LEGlyphID.
| #define LE_GET_SUB_FONT | ( | gid | ) | ((gid & LE_SUB_FONT_MASK) >> LE_SUB_FONT_SHIFT) |
A convenience macro to get the sub-font ID part of an LEGlyphID.
| #define LE_GLYPH_MASK 0x0000FFFF |
Used to mask off the glyph ID part of an LEGlyphID.
| #define LE_GLYPH_SHIFT 0 |
Used to shift the glyph ID part of an LEGlyphID into the low-order bits.
| #define LE_GROW_ARRAY | ( | array, | |
| newSize | |||
| ) | realloc((void *) (array), (newSize) * sizeof (array)[0]) |
Re-allocate an array of basic types.
This is used to isolate the rest of the LayoutEngine code from cmemory.h.
| #define LE_HLIG_FEATURE_FLAG (1 << LE_HLIG_FEATURE_ENUM) |
| #define LE_Kerning_FEATURE_FLAG (1 << LE_Kerning_FEATURE_ENUM) |
| #define LE_LIGA_FEATURE_FLAG (1 << LE_LIGA_FEATURE_ENUM) |
| #define LE_Ligatures_FEATURE_FLAG (1 << LE_Ligatures_FEATURE_ENUM) |
| #define LE_MAKE_TAG | ( | a, | |
| b, | |||
| c, | |||
| d | |||
| ) |
A macro to construct the four-letter tags used to label TrueType tables, and for script, language and feature tags in OpenType tables.
WARNING: THIS MACRO WILL ONLY WORK CORRECTLY IF THE ARGUMENT CHARACTERS ARE ASCII.
| #define LE_NALT_FEATURE_FLAG (1 << LE_NALT_FEATURE_ENUM) |
| #define LE_NEW_ARRAY | ( | type, | |
| count | |||
| ) | LE_RANGE_CHECK(type,count,(type *) malloc((count) * sizeof(type))) |
Allocate an array of basic types.
This is used to isolate the rest of the LayoutEngine code from cmemory.h.
| #define LE_RLIG_FEATURE_FLAG (1 << LE_RLIG_FEATURE_ENUM) |
| #define LE_RUBY_FEATURE_FLAG (1 << LE_RUBY_FEATURE_ENUM) |
| #define LE_SALT_FEATURE_FLAG (1 << LE_SALT_FEATURE_ENUM) |
| #define LE_SET_CLIENT | ( | gid, | |
| client | |||
| ) | ((gid & ~LE_CLIENT_MASK) | ((client << LE_CLIENT_SHIFT) & LE_CLIENT_MASK)) |
A convenience macro to set the client-defined part of an LEGlyphID.
| #define LE_SET_GLYPH | ( | gid, | |
| glyph | |||
| ) | ((gid & ~LE_GLYPH_MASK) | ((glyph << LE_GLYPH_SHIFT) & LE_GLYPH_MASK)) |
A convenience macro to set the Glyph ID part of an LEGlyphID.
| #define LE_SET_SUB_FONT | ( | gid, | |
| font | |||
| ) | ((gid & ~LE_SUB_FONT_MASK) | ((font << LE_SUB_FONT_SHIFT) & LE_SUB_FONT_MASK)) |
A convenience macro to set the sub-font ID part of an LEGlyphID.
| #define LE_SMCP_FEATURE_FLAG (1 << LE_SMCP_FEATURE_ENUM) |
| #define LE_SS01_FEATURE_FLAG (1 << LE_SS01_FEATURE_ENUM) |
| #define LE_SS02_FEATURE_FLAG (1 << LE_SS02_FEATURE_ENUM) |
| #define LE_SS03_FEATURE_FLAG (1 << LE_SS03_FEATURE_ENUM) |
| #define LE_SS04_FEATURE_FLAG (1 << LE_SS04_FEATURE_ENUM) |
| #define LE_SS05_FEATURE_FLAG (1 << LE_SS05_FEATURE_ENUM) |
| #define LE_SS06_FEATURE_FLAG (1 << LE_SS06_FEATURE_ENUM) |
| #define LE_SS07_FEATURE_FLAG (1 << LE_SS07_FEATURE_ENUM) |
| #define LE_SUB_FONT_MASK 0x00FF0000 |
Used to mask off the sub-font ID part of an LEGlyphID.
| #define LE_SUB_FONT_SHIFT 16 |
Used to shift the sub-font ID part of an LEGlyphID into the low-order bits.
| #define LE_SUCCESS | ( | code | ) | (U_SUCCESS((UErrorCode)code)) |
A convenience macro to test for the success of a LayoutEngine call.
| #define LE_SWSH_FEATURE_FLAG (1 << LE_SWSH_FEATURE_ENUM) |
| #define LE_ZERO_FEATURE_FLAG (1 << LE_ZERO_FEATURE_ENUM) |
| #define NULL 0 |
Used to represent empty pointers.
A type used for boolean values.
| typedef int16_t le_int16 |
A type used for signed, 16-bit integers.
| typedef int32_t le_int32 |
A type used for signed, 32-bit integers.
| typedef int8_t le_int8 |
A type used for signed, 8-bit integers.
| typedef uint16_t le_uint16 |
A type used for unsigned, 16-bit integers.
| typedef uint32_t le_uint32 |
A type used for unsigned, 32-bit integers.
| typedef uint8_t le_uint8 |
A type used for unsigned, 8-bit integers.
| typedef enum LEErrorCode LEErrorCode |
Error codes returned by the LayoutEngine.
Used for glyph indices.
The low-order 16 bits are the glyph ID within the font. The next 8 bits are the sub-font ID within a compound font. The high- order 8 bits are client defined. The LayoutEngine will never change or look at the client defined bits.
Used to hold a pair of (x, y) values which represent a point.
Used for four character tags.
Used to represent 16-bit Unicode code points.
| typedef UChar LEUnicode16 |
Used to represent 16-bit Unicode code points.
| typedef UChar32 LEUnicode32 |
Used to represent 32-bit Unicode code points.
Used for 16-bit glyph indices as they're represented in TrueType font tables.
| enum LEErrorCode |
Error codes returned by the LayoutEngine.
| enum LEFeatureENUMs |
This API is for internal use only.
| Enumerator | |
|---|---|
| LE_Kerning_FEATURE_ENUM | Requests Kerning. Formerly LayoutEngine::kTypoFlagKern |
| LE_Ligatures_FEATURE_ENUM | Requests Ligatures. Formerly LayoutEngine::kTypoFlagLiga |
| LE_CLIG_FEATURE_ENUM | Feature specific enum. |
| LE_DLIG_FEATURE_ENUM | Feature specific enum. |
| LE_HLIG_FEATURE_ENUM | Feature specific enum. |
| LE_LIGA_FEATURE_ENUM | Feature specific enum. |
| LE_RLIG_FEATURE_ENUM | Feature specific enum. |
| LE_SMCP_FEATURE_ENUM | Feature specific enum. |
| LE_FRAC_FEATURE_ENUM | Feature specific enum. |
| LE_AFRC_FEATURE_ENUM | Feature specific enum. |
| LE_ZERO_FEATURE_ENUM | Feature specific enum. |
| LE_SWSH_FEATURE_ENUM | Feature specific enum. |
| LE_CSWH_FEATURE_ENUM | Feature specific enum. |
| LE_SALT_FEATURE_ENUM | Feature specific enum. |
| LE_NALT_FEATURE_ENUM | Feature specific enum. |
| LE_RUBY_FEATURE_ENUM | Feature specific enum. |
| LE_SS01_FEATURE_ENUM | Feature specific enum. |
| LE_SS02_FEATURE_ENUM | Feature specific enum. |
| LE_SS03_FEATURE_ENUM | Feature specific enum. |
| LE_SS04_FEATURE_ENUM | Feature specific enum. |
| LE_SS05_FEATURE_ENUM | Feature specific enum. |
| LE_SS06_FEATURE_ENUM | Feature specific enum. |
| LE_SS07_FEATURE_ENUM | Feature specific enum. |
| LE_CHAR_FILTER_FEATURE_ENUM | Apply CharSubstitutionFilter. |
| enum LEFeatureTags |
This enumeration defines constants for all the common OpenType feature tags.
| enum LETableTags |
This enumeration defines constants for the standard TrueType, OpenType and AAT table tags.