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_THIS2 (coverage, attachPoint);
77 coverage; /* Offset to Coverage table -- from
78 * beginning of AttachList table */
79 OffsetArrayOf<AttachPoint>
80 attachPoint; /* Array of AttachPoint tables
81 * in Coverage Index order */
83 ASSERT_SIZE (AttachList, 4);
86 * Ligature Caret Table
89 struct CaretValueFormat1
91 friend struct CaretValue;
94 inline int get_caret_value (hb_ot_layout_context_t *context, hb_codepoint_t glyph_id HB_GNUC_UNUSED) const
97 return context->font->x_scale * coordinate / 0x10000;
100 inline bool sanitize (SANITIZE_ARG_DEF) {
102 return SANITIZE_SELF ();
106 USHORT caretValueFormat; /* Format identifier--format = 1 */
107 SHORT coordinate; /* X or Y value, in design units */
109 ASSERT_SIZE (CaretValueFormat1, 4);
111 struct CaretValueFormat2
113 friend struct CaretValue;
116 inline int get_caret_value (hb_ot_layout_context_t *context, hb_codepoint_t glyph_id) const
118 return /* TODO contour point */ 0;
121 inline bool sanitize (SANITIZE_ARG_DEF) {
123 return SANITIZE_SELF ();
127 USHORT caretValueFormat; /* Format identifier--format = 2 */
128 USHORT caretValuePoint; /* Contour point index on glyph */
130 ASSERT_SIZE (CaretValueFormat2, 4);
132 struct CaretValueFormat3
134 friend struct CaretValue;
136 inline int get_caret_value (hb_ot_layout_context_t *context, hb_codepoint_t glyph_id HB_GNUC_UNUSED) const
139 return context->font->x_scale * coordinate / 0x10000 +
140 ((this+deviceTable).get_delta (context->font->x_ppem) << 6);
143 inline bool sanitize (SANITIZE_ARG_DEF) {
145 return SANITIZE_SELF () && SANITIZE_THIS (deviceTable);
149 USHORT caretValueFormat; /* Format identifier--format = 3 */
150 SHORT coordinate; /* X or Y value, in design units */
152 deviceTable; /* Offset to Device table for X or Y
153 * value--from beginning of CaretValue
156 ASSERT_SIZE (CaretValueFormat3, 6);
160 inline int get_caret_value (hb_ot_layout_context_t *context, hb_codepoint_t glyph_id) const
163 case 1: return u.format1->get_caret_value (context, glyph_id);
164 case 2: return u.format2->get_caret_value (context, glyph_id);
165 case 3: return u.format3->get_caret_value (context, glyph_id);
170 inline bool sanitize (SANITIZE_ARG_DEF) {
172 if (!SANITIZE (u.format)) return false;
174 case 1: return u.format1->sanitize (SANITIZE_ARG);
175 case 2: return u.format2->sanitize (SANITIZE_ARG);
176 case 3: return u.format3->sanitize (SANITIZE_ARG);
183 USHORT format; /* Format identifier */
184 CaretValueFormat1 format1[VAR];
185 CaretValueFormat2 format2[VAR];
186 CaretValueFormat3 format3[VAR];
192 inline unsigned int get_lig_carets (hb_ot_layout_context_t *context,
193 hb_codepoint_t glyph_id,
194 unsigned int start_offset,
195 unsigned int *caret_count /* IN/OUT */,
196 int *caret_array /* OUT */) const
199 const OffsetTo<CaretValue> *array = carets.sub_array (start_offset, caret_count);
200 unsigned int count = *caret_count;
201 for (unsigned int i = 0; i < count; i++)
202 caret_array[i] = (this+array[i]).get_caret_value (context, glyph_id);
208 inline bool sanitize (SANITIZE_ARG_DEF) {
210 return SANITIZE_THIS (carets);
214 OffsetArrayOf<CaretValue>
215 carets; /* Offset array of CaretValue tables
216 * --from beginning of LigGlyph table
217 * --in increasing coordinate order */
219 ASSERT_SIZE (LigGlyph, 2);
223 inline unsigned int get_lig_carets (hb_ot_layout_context_t *context,
224 hb_codepoint_t glyph_id,
225 unsigned int start_offset,
226 unsigned int *caret_count /* IN/OUT */,
227 int *caret_array /* OUT */) const
229 unsigned int index = (this+coverage) (glyph_id);
230 if (index == NOT_COVERED)
236 const LigGlyph &lig_glyph = this+ligGlyph[index];
237 return lig_glyph.get_lig_carets (context, glyph_id, start_offset, caret_count, caret_array);
240 inline bool sanitize (SANITIZE_ARG_DEF) {
242 return SANITIZE_THIS2 (coverage, ligGlyph);
247 coverage; /* Offset to Coverage table--from
248 * beginning of LigCaretList table */
249 OffsetArrayOf<LigGlyph>
250 ligGlyph; /* Array of LigGlyph tables
251 * in Coverage Index order */
253 ASSERT_SIZE (LigCaretList, 4);
256 struct MarkGlyphSetsFormat1
258 inline bool covers (unsigned int set_index, hb_codepoint_t glyph_id) const
259 { return (this+coverage[set_index]).get_coverage (glyph_id) != NOT_COVERED; }
261 inline bool sanitize (SANITIZE_ARG_DEF) {
263 return SANITIZE_THIS (coverage);
267 USHORT format; /* Format identifier--format = 1 */
268 LongOffsetArrayOf<Coverage>
269 coverage; /* Array of long offsets to mark set
272 ASSERT_SIZE (MarkGlyphSetsFormat1, 4);
276 inline bool covers (unsigned int set_index, hb_codepoint_t glyph_id) const
279 case 1: return u.format1->covers (set_index, glyph_id);
280 default:return false;
284 inline bool sanitize (SANITIZE_ARG_DEF) {
286 if (!SANITIZE (u.format)) return false;
288 case 1: return u.format1->sanitize (SANITIZE_ARG);
295 USHORT format; /* Format identifier */
296 MarkGlyphSetsFormat1 format1[VAR];
307 static const hb_tag_t Tag = HB_OT_TAG_GDEF;
310 UnclassifiedGlyph = 0,
317 STATIC_DEFINE_GET_FOR_DATA_CHECK_MAJOR_VERSION (GDEF, 1, 1);
319 inline bool has_glyph_classes () const { return glyphClassDef != 0; }
320 inline hb_ot_layout_class_t get_glyph_class (hb_codepoint_t glyph) const
321 { return (this+glyphClassDef).get_class (glyph); }
323 inline bool has_mark_attachment_types () const { return markAttachClassDef != 0; }
324 inline hb_ot_layout_class_t get_mark_attachment_type (hb_codepoint_t glyph) const
325 { return (this+markAttachClassDef).get_class (glyph); }
327 inline bool has_attach_points () const { return attachList != 0; }
328 inline unsigned int get_attach_points (hb_codepoint_t glyph_id,
329 unsigned int start_offset,
330 unsigned int *point_count /* IN/OUT */,
331 unsigned int *point_array /* OUT */) const
332 { return (this+attachList).get_attach_points (glyph_id, start_offset, point_count, point_array); }
334 inline bool has_lig_carets () const { return ligCaretList != 0; }
335 inline unsigned int get_lig_carets (hb_ot_layout_context_t *context,
336 hb_codepoint_t glyph_id,
337 unsigned int start_offset,
338 unsigned int *caret_count /* IN/OUT */,
339 int *caret_array /* OUT */) const
340 { return (this+ligCaretList).get_lig_carets (context, glyph_id, start_offset, caret_count, caret_array); }
342 inline bool has_mark_sets () const { return version >= 0x00010002 && markGlyphSetsDef[0] != 0; }
343 inline bool mark_set_covers (unsigned int set_index, hb_codepoint_t glyph_id) const
344 { return version >= 0x00010002 && (this+markGlyphSetsDef[0]).covers (set_index, glyph_id); }
346 inline bool sanitize (SANITIZE_ARG_DEF) {
348 if (!SANITIZE (version)) return false;
349 if (HB_UNLIKELY (version.major != 1)) return false;
350 return SANITIZE_THIS2 (glyphClassDef, attachList) &&
351 SANITIZE_THIS2 (ligCaretList, markAttachClassDef) &&
352 (version < 0x00010002 || SANITIZE_THIS (markGlyphSetsDef[0]));
356 FixedVersion version; /* Version of the GDEF table--currently
359 glyphClassDef; /* Offset to class definition table
360 * for glyph type--from beginning of
361 * GDEF header (may be Null) */
363 attachList; /* Offset to list of glyphs with
364 * attachment points--from beginning
365 * of GDEF header (may be Null) */
366 OffsetTo<LigCaretList>
367 ligCaretList; /* Offset to list of positioning points
368 * for ligature carets--from beginning
369 * of GDEF header (may be Null) */
371 markAttachClassDef; /* Offset to class definition table for
372 * mark attachment type--from beginning
373 * of GDEF header (may be Null) */
374 OffsetTo<MarkGlyphSets>
375 markGlyphSetsDef[VAR]; /* Offset to the table of mark set
376 * definitions--from beginning of GDEF
377 * header (may be NULL). Introduced
378 * in version 00010002. */
380 ASSERT_SIZE_VAR (GDEF, 12, OffsetTo<MarkGlyphSets>);
383 #endif /* HB_OT_LAYOUT_GDEF_PRIVATE_HH */