2 * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
4 * This is part of HarfBuzz, an OpenType Layout engine library.
6 * Permission is hereby granted, without written agreement and without
7 * license or royalty fees, to use, copy, modify, and distribute this
8 * software and its documentation for any purpose, provided that the
9 * above copyright notice and the following two paragraphs appear in
10 * all copies of this software.
12 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
13 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
14 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
15 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
18 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
19 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
21 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
22 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
25 #ifndef HARFBUZZ_SHAPER_H
26 #define HARFBUZZ_SHAPER_H
28 #include "harfbuzz-global.h"
29 #include "harfbuzz-gdef.h"
30 #include "harfbuzz-gpos.h"
31 #include "harfbuzz-gsub.h"
32 #include "harfbuzz-external.h"
33 #include "harfbuzz-stream-private.h"
38 using anything else than signed or unsigned for bitfields in C is non standard,
39 but accepted by almost all compilers. And it gives a significant reduction in
40 memory consumption as HB_CharAttributes and HB_GlyphAttributes will not have
44 typedef unsigned hb_bitfield;
46 typedef hb_uint8 hb_bitfield;
79 HB_ScriptCount = HB_Script_Inherited
81 HB_Script_Latin = Common,
82 HB_Script_Ethiopic = Common,
83 HB_Script_Cherokee = Common,
84 HB_Script_CanadianAboriginal = Common,
85 HB_Script_Mongolian = Common,
86 HB_Script_Hiragana = Common,
87 HB_Script_Katakana = Common,
88 HB_Script_Bopomofo = Common,
89 HB_Script_Han = Common,
90 HB_Script_Yi = Common,
91 HB_Script_OldItalic = Common,
92 HB_Script_Gothic = Common,
93 HB_Script_Deseret = Common,
94 HB_Script_Tagalog = Common,
95 HB_Script_Hanunoo = Common,
96 HB_Script_Buhid = Common,
97 HB_Script_Tagbanwa = Common,
98 HB_Script_Limbu = Common,
99 HB_Script_TaiLe = Common,
100 HB_Script_LinearB = Common,
101 HB_Script_Ugaritic = Common,
102 HB_Script_Shavian = Common,
103 HB_Script_Osmanya = Common,
104 HB_Script_Cypriot = Common,
105 HB_Script_Braille = Common,
106 HB_Script_Buginese = Common,
107 HB_Script_Coptic = Common,
108 HB_Script_NewTaiLue = Common,
109 HB_Script_Glagolitic = Common,
110 HB_Script_Tifinagh = Common,
111 HB_Script_SylotiNagri = Common,
112 HB_Script_OldPersian = Common,
113 HB_Script_Kharoshthi = Common,
114 HB_Script_Balinese = Common,
115 HB_Script_Cuneiform = Common,
116 HB_Script_Phoenician = Common,
117 HB_Script_PhagsPa = Common,
138 /*HB_LineBreakType*/ hb_bitfield lineBreakType :2;
139 /*HB_Bool*/ hb_bitfield whiteSpace :1; /* A unicode whitespace character, except NBSP, ZWNBSP */
140 /*HB_Bool*/ hb_bitfield charStop :1; /* Valid cursor position (for left/right arrow) */
141 /*HB_Bool*/ hb_bitfield wordBoundary :1;
142 /*HB_Bool*/ hb_bitfield sentenceBoundary :1;
143 hb_bitfield unused :2;
146 void HB_GetCharAttributes(const HB_UChar16 *string, hb_uint32 stringLength,
147 const HB_ScriptItem *items, hb_uint32 numItems,
148 HB_CharAttributes *attributes);
150 /* requires HB_GetCharAttributes to be called before */
151 void HB_GetWordBoundaries(const HB_UChar16 *string, hb_uint32 stringLength,
152 const HB_ScriptItem *items, hb_uint32 numItems,
153 HB_CharAttributes *attributes);
155 /* requires HB_GetCharAttributes to be called before */
156 void HB_GetSentenceBoundaries(const HB_UChar16 *string, hb_uint32 stringLength,
157 const HB_ScriptItem *items, hb_uint32 numItems,
158 HB_CharAttributes *attributes);
164 } HB_StringToGlyphsFlags;
167 HB_ShaperFlag_Default = 0,
168 HB_ShaperFlag_NoKerning = 1,
169 HB_ShaperFlag_UseDesignMetrics = 2
173 highest value means highest priority for justification. Justification is done by first inserting kashidas
174 starting with the highest priority positions, then stretching spaces, afterwards extending inter char
175 spacing, and last spacing between arabic words.
176 NoJustification is for example set for arabic where no Kashida can be inserted or for diacritics.
179 HB_NoJustification= 0, /* Justification can't be applied after this glyph */
180 HB_Arabic_Space = 1, /* This glyph represents a space inside arabic text */
181 HB_Character = 2, /* Inter-character justification point follows this glyph */
182 HB_Space = 4, /* This glyph represents a blank outside an Arabic run */
183 HB_Arabic_Normal = 7, /* Normal Middle-Of-Word glyph that connects to the right (begin) */
184 HB_Arabic_Waw = 8, /* Next character is final form of Waw/Ain/Qaf/Fa */
185 HB_Arabic_BaRa = 9, /* Next two chars are Ba + Ra/Ya/AlefMaksura */
186 HB_Arabic_Alef = 10, /* Next character is final form of Alef/Tah/Lam/Kaf/Gaf */
187 HB_Arabic_HaaDal = 11, /* Next character is final form of Haa/Dal/Taa Marbutah */
188 HB_Arabic_Seen = 12, /* Initial or Medial form Of Seen/Sad */
189 HB_Arabic_Kashida = 13 /* Kashida(U+640) in middle of word */
190 } HB_JustificationClass;
192 /* This structure is binary compatible with Uniscribe's SCRIPT_VISATTR. Would be nice to keep
193 * it like that. If this is a problem please tell Trolltech :)
196 hb_bitfield justification :4; /* Justification class */
197 hb_bitfield clusterStart :1; /* First glyph of representation of cluster */
198 hb_bitfield mark :1; /* needs to be positioned around base char */
199 hb_bitfield zeroWidth :1; /* ZWJ, ZWNJ etc, with no width */
200 hb_bitfield dontPrint :1;
201 hb_bitfield combiningClass :8;
202 } HB_GlyphAttributes;
204 typedef struct HB_FaceRec_ {
205 HB_Bool isSymbolFont;
210 HB_Bool supported_scripts[HB_ScriptCount];
212 HB_Script current_script;
213 int current_flags; /* HB_ShaperFlags */
214 HB_Bool has_opentype_kerning;
215 HB_Bool glyphs_substituted;
216 HB_GlyphAttributes *tmpAttributes;
217 unsigned int *tmpLogClusters;
222 typedef HB_Error (*HB_GetFontTableFunc)(void *font, HB_Tag tag, HB_Byte *buffer, HB_UInt *length);
224 HB_Face HB_NewFace(void *font, HB_GetFontTableFunc tableFunc);
225 void HB_FreeFace(HB_Face face);
229 HB_Fixed width, height;
230 HB_Fixed xOffset, yOffset;
238 HB_Bool (*convertStringToGlyphIndices)(HB_Font font, const HB_UChar16 *string, hb_uint32 length, HB_Glyph *glyphs, hb_uint32 *numGlyphs, HB_Bool rightToLeft);
239 void (*getGlyphAdvances)(HB_Font font, const HB_Glyph *glyphs, hb_uint32 numGlyphs, HB_Fixed *advances, int flags /*HB_ShaperFlag*/);
240 HB_Bool (*canRender)(HB_Font font, const HB_UChar16 *string, hb_uint32 length);
241 /* implementation needs to make sure to load a scaled glyph, so /no/ FT_LOAD_NO_SCALE */
242 HB_Error (*getPointInOutline)(HB_Font font, HB_Glyph glyph, int flags /*HB_ShaperFlag*/, hb_uint32 point, HB_Fixed *xpos, HB_Fixed *ypos, hb_uint32 *nPoints);
243 void (*getGlyphMetrics)(HB_Font font, HB_Glyph glyph, HB_GlyphMetrics *metrics);
244 HB_Fixed (*getFontMetric)(HB_Font font, HB_FontMetric metric);
247 typedef struct HB_Font_ {
248 const HB_FontClass *klass;
251 HB_UShort x_ppem, y_ppem;
252 HB_16Dot16 x_scale, y_scale;
257 typedef struct HB_ShaperItem_ HB_ShaperItem;
259 struct HB_ShaperItem_ {
260 const HB_UChar16 *string; /* input: the Unicode UTF16 text to be shaped */
261 hb_uint32 stringLength; /* input: the length of the input in 16-bit words */
262 HB_ScriptItem item; /* input: the current run to be shaped: a run of text all in the same script that is a substring of <string> */
263 HB_Font font; /* input: the font: scale, units and function pointers supplying glyph indices and metrics */
264 HB_Face face; /* input: the shaper state; current script, access to the OpenType tables , etc. */
265 int shaperFlags; /* input (unused) should be set to 0; intended to support flags defined in HB_ShaperFlag */
266 HB_Bool glyphIndicesPresent; /* input: true if the <glyphs> array contains glyph indices ready to be shaped */
267 hb_uint32 initialGlyphCount; /* input: if glyphIndicesPresent is true, the number of glyph indices in the <glyphs> array */
269 hb_uint32 num_glyphs; /* input: capacity of output arrays <glyphs>, <attributes>, <advances>, <offsets>, and <log_clusters>; */
270 /* output: required capacity (may be larger than actual capacity) */
272 HB_Glyph *glyphs; /* output: <num_glyphs> indices of shaped glyphs */
273 HB_GlyphAttributes *attributes; /* output: <num_glyphs> glyph attributes */
274 HB_Fixed *advances; /* output: <num_glyphs> advances */
275 HB_FixedPoint *offsets; /* output: <num_glyphs> offsets */
276 unsigned short *log_clusters; /* output: for each output glyph, the index in the input of the start of its logical cluster */
279 HB_Bool kerning_applied; /* output: true if kerning was applied by the shaper */
282 HB_Bool HB_ShapeItem(HB_ShaperItem *item);