2 * Copyright (C) 2007,2008,2009 Red Hat, Inc.
4 * This is part of HarfBuzz, a text shaping 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.
24 * Red Hat Author(s): Behdad Esfahbod
27 #ifndef HB_OT_LAYOUT_GDEF_PRIVATE_HH
28 #define HB_OT_LAYOUT_GDEF_PRIVATE_HH
30 #include "hb-ot-layout-common-private.hh"
32 #include "hb-font-private.h"
36 * Attachment List Table
39 typedef ArrayOf<USHORT> AttachPoint; /* Array of contour point indices--in
40 * increasing numerical order */
41 ASSERT_SIZE (AttachPoint, 2);
45 inline unsigned int get_attach_points (hb_codepoint_t glyph_id,
46 unsigned int start_offset,
47 unsigned int *point_count /* IN/OUT */,
48 unsigned int *point_array /* OUT */) const
50 unsigned int index = (this+coverage) (glyph_id);
51 if (index == NOT_COVERED)
58 const AttachPoint &points = this+attachPoint[index];
61 const USHORT *array = points.sub_array (start_offset, point_count);
62 unsigned int count = *point_count;
63 for (unsigned int i = 0; i < count; i++)
64 point_array[i] = array[i];
70 inline bool sanitize (SANITIZE_ARG_DEF) {
72 return SANITIZE_THIS (coverage)
73 && SANITIZE_THIS (attachPoint);
78 coverage; /* Offset to Coverage table -- from
79 * beginning of AttachList table */
80 OffsetArrayOf<AttachPoint>
81 attachPoint; /* Array of AttachPoint tables
82 * in Coverage Index order */
84 ASSERT_SIZE (AttachList, 4);
87 * Ligature Caret Table
90 struct CaretValueFormat1
92 friend struct CaretValue;
95 inline int get_caret_value (hb_ot_layout_context_t *context, hb_codepoint_t glyph_id HB_UNUSED) const
98 return _hb_16dot16_mul_round (context->font->x_scale, coordinate);
101 inline bool sanitize (SANITIZE_ARG_DEF) {
103 return SANITIZE_SELF ();
107 USHORT caretValueFormat; /* Format identifier--format = 1 */
108 SHORT coordinate; /* X or Y value, in design units */
110 ASSERT_SIZE (CaretValueFormat1, 4);
112 struct CaretValueFormat2
114 friend struct CaretValue;
117 inline int get_caret_value (hb_ot_layout_context_t *context, hb_codepoint_t glyph_id) const
121 if (hb_font_get_contour_point (context->font, context->face, caretValuePoint, glyph_id, &x, &y))
127 inline bool sanitize (SANITIZE_ARG_DEF) {
129 return SANITIZE_SELF ();
133 USHORT caretValueFormat; /* Format identifier--format = 2 */
134 USHORT caretValuePoint; /* Contour point index on glyph */
136 ASSERT_SIZE (CaretValueFormat2, 4);
138 struct CaretValueFormat3
140 friend struct CaretValue;
142 inline int get_caret_value (hb_ot_layout_context_t *context, hb_codepoint_t glyph_id HB_UNUSED) const
145 return _hb_16dot16_mul_round (context->font->x_scale, coordinate) +
146 ((this+deviceTable).get_delta (context->font->x_ppem) << 16);
149 inline bool sanitize (SANITIZE_ARG_DEF) {
151 return SANITIZE_SELF () && SANITIZE_THIS (deviceTable);
155 USHORT caretValueFormat; /* Format identifier--format = 3 */
156 SHORT coordinate; /* X or Y value, in design units */
158 deviceTable; /* Offset to Device table for X or Y
159 * value--from beginning of CaretValue
162 ASSERT_SIZE (CaretValueFormat3, 6);
166 inline int get_caret_value (hb_ot_layout_context_t *context, hb_codepoint_t glyph_id) const
169 case 1: return u.format1->get_caret_value (context, glyph_id);
170 case 2: return u.format2->get_caret_value (context, glyph_id);
171 case 3: return u.format3->get_caret_value (context, glyph_id);
176 inline bool sanitize (SANITIZE_ARG_DEF) {
178 if (!SANITIZE (u.format)) return false;
180 case 1: return u.format1->sanitize (SANITIZE_ARG);
181 case 2: return u.format2->sanitize (SANITIZE_ARG);
182 case 3: return u.format3->sanitize (SANITIZE_ARG);
189 USHORT format; /* Format identifier */
190 CaretValueFormat1 format1[VAR];
191 CaretValueFormat2 format2[VAR];
192 CaretValueFormat3 format3[VAR];
198 inline unsigned int get_lig_carets (hb_ot_layout_context_t *context,
199 hb_codepoint_t glyph_id,
200 unsigned int start_offset,
201 unsigned int *caret_count /* IN/OUT */,
202 int *caret_array /* OUT */) const
205 const OffsetTo<CaretValue> *array = carets.sub_array (start_offset, caret_count);
206 unsigned int count = *caret_count;
207 for (unsigned int i = 0; i < count; i++)
208 caret_array[i] = (this+array[i]).get_caret_value (context, glyph_id);
214 inline bool sanitize (SANITIZE_ARG_DEF) {
216 return SANITIZE_THIS (carets);
220 OffsetArrayOf<CaretValue>
221 carets; /* Offset array of CaretValue tables
222 * --from beginning of LigGlyph table
223 * --in increasing coordinate order */
225 ASSERT_SIZE (LigGlyph, 2);
229 inline unsigned int get_lig_carets (hb_ot_layout_context_t *context,
230 hb_codepoint_t glyph_id,
231 unsigned int start_offset,
232 unsigned int *caret_count /* IN/OUT */,
233 int *caret_array /* OUT */) const
235 unsigned int index = (this+coverage) (glyph_id);
236 if (index == NOT_COVERED)
242 const LigGlyph &lig_glyph = this+ligGlyph[index];
243 return lig_glyph.get_lig_carets (context, glyph_id, start_offset, caret_count, caret_array);
246 inline bool sanitize (SANITIZE_ARG_DEF) {
248 return SANITIZE_THIS (coverage)
249 && SANITIZE_THIS (ligGlyph);
254 coverage; /* Offset to Coverage table--from
255 * beginning of LigCaretList table */
256 OffsetArrayOf<LigGlyph>
257 ligGlyph; /* Array of LigGlyph tables
258 * in Coverage Index order */
260 ASSERT_SIZE (LigCaretList, 4);
263 struct MarkGlyphSetsFormat1
265 inline bool covers (unsigned int set_index, hb_codepoint_t glyph_id) const
266 { return (this+coverage[set_index]).get_coverage (glyph_id) != NOT_COVERED; }
268 inline bool sanitize (SANITIZE_ARG_DEF) {
270 return SANITIZE_THIS (coverage);
274 USHORT format; /* Format identifier--format = 1 */
275 LongOffsetArrayOf<Coverage>
276 coverage; /* Array of long offsets to mark set
279 ASSERT_SIZE (MarkGlyphSetsFormat1, 4);
283 inline bool covers (unsigned int set_index, hb_codepoint_t glyph_id) const
286 case 1: return u.format1->covers (set_index, glyph_id);
287 default:return false;
291 inline bool sanitize (SANITIZE_ARG_DEF) {
293 if (!SANITIZE (u.format)) return false;
295 case 1: return u.format1->sanitize (SANITIZE_ARG);
302 USHORT format; /* Format identifier */
303 MarkGlyphSetsFormat1 format1[VAR];
314 static const hb_tag_t Tag = HB_OT_TAG_GDEF;
317 UnclassifiedGlyph = 0,
324 inline bool has_glyph_classes () const { return glyphClassDef != 0; }
325 inline hb_ot_layout_class_t get_glyph_class (hb_codepoint_t glyph) const
326 { return (this+glyphClassDef).get_class (glyph); }
328 inline bool has_mark_attachment_types () const { return markAttachClassDef != 0; }
329 inline hb_ot_layout_class_t get_mark_attachment_type (hb_codepoint_t glyph) const
330 { return (this+markAttachClassDef).get_class (glyph); }
332 inline bool has_attach_points () const { return attachList != 0; }
333 inline unsigned int get_attach_points (hb_codepoint_t glyph_id,
334 unsigned int start_offset,
335 unsigned int *point_count /* IN/OUT */,
336 unsigned int *point_array /* OUT */) const
337 { return (this+attachList).get_attach_points (glyph_id, start_offset, point_count, point_array); }
339 inline bool has_lig_carets () const { return ligCaretList != 0; }
340 inline unsigned int get_lig_carets (hb_ot_layout_context_t *context,
341 hb_codepoint_t glyph_id,
342 unsigned int start_offset,
343 unsigned int *caret_count /* IN/OUT */,
344 int *caret_array /* OUT */) const
345 { return (this+ligCaretList).get_lig_carets (context, glyph_id, start_offset, caret_count, caret_array); }
347 inline bool has_mark_sets () const { return version >= 0x00010002 && markGlyphSetsDef[0] != 0; }
348 inline bool mark_set_covers (unsigned int set_index, hb_codepoint_t glyph_id) const
349 { return version >= 0x00010002 && (this+markGlyphSetsDef[0]).covers (set_index, glyph_id); }
351 inline bool sanitize (SANITIZE_ARG_DEF) {
353 return SANITIZE (version) && likely (version.major == 1) &&
354 SANITIZE_THIS (glyphClassDef) && SANITIZE_THIS (attachList) &&
355 SANITIZE_THIS (ligCaretList) && SANITIZE_THIS (markAttachClassDef) &&
356 (version < 0x00010002 || SANITIZE_THIS (markGlyphSetsDef[0]));
360 FixedVersion version; /* Version of the GDEF table--currently
363 glyphClassDef; /* Offset to class definition table
364 * for glyph type--from beginning of
365 * GDEF header (may be Null) */
367 attachList; /* Offset to list of glyphs with
368 * attachment points--from beginning
369 * of GDEF header (may be Null) */
370 OffsetTo<LigCaretList>
371 ligCaretList; /* Offset to list of positioning points
372 * for ligature carets--from beginning
373 * of GDEF header (may be Null) */
375 markAttachClassDef; /* Offset to class definition table for
376 * mark attachment type--from beginning
377 * of GDEF header (may be Null) */
378 OffsetTo<MarkGlyphSets>
379 markGlyphSetsDef[VAR]; /* Offset to the table of mark set
380 * definitions--from beginning of GDEF
381 * header (may be NULL). Introduced
382 * in version 00010002. */
384 ASSERT_SIZE_VAR (GDEF, 12, OffsetTo<MarkGlyphSets>);
387 #endif /* HB_OT_LAYOUT_GDEF_PRIVATE_HH */