2 * Copyright (C) 2007,2008,2009 Red Hat, Inc.
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.
24 * Red Hat Author(s): Behdad Esfahbod
27 #ifndef HB_OT_LAYOUT_COMMON_PRIVATE_HH
28 #define HB_OT_LAYOUT_COMMON_PRIVATE_HH
30 #include "hb-ot-layout-private.h"
32 #include "hb-open-types-private.hh"
37 * OpenType Layout Common Table Formats
43 * Script, ScriptList, LangSys, Feature, FeatureList, Lookup, LookupList
46 template <typename Type>
49 inline bool sanitize (SANITIZE_ARG_DEF, const void *base) {
50 /* Note: Only accept ASCII-visible tags (mind DEL)
51 * This is one of the few times (only time?) we check
52 * for data integrity, as opposed o just boundary checks
54 return (tag & 0x80808080) == 0 && offset.sanitize (SANITIZE_ARG, base);
57 Tag tag; /* 4-byte Tag identifier */
59 offset; /* Offset from beginning of object holding
63 template <typename Type>
64 struct RecordArrayOf : ArrayOf<Record<Type> > {};
66 template <typename Type>
67 struct RecordListOf : RecordArrayOf<Type>
69 inline const Type& operator [] (unsigned int i) const
71 if (HB_UNLIKELY (i >= this->len)) return Null(Type);
72 return this+this->array[i].offset;
74 inline const Tag& get_tag (unsigned int i) const
76 if (HB_UNLIKELY (i >= this->len)) return Null(Tag);
77 return this->array[i].tag;
80 inline bool sanitize (SANITIZE_ARG_DEF) {
81 return RecordArrayOf<Type>::sanitize (SANITIZE_ARG, CONST_CHARP(this));
93 inline const unsigned int get_feature_index (unsigned int i) const { return featureIndex[i]; }
94 inline unsigned int get_feature_count (void) const { return featureIndex.len; }
96 inline bool has_required_feature (void) const { return reqFeatureIndex != 0xffff; }
97 inline int get_required_feature_index (void) const
99 if (reqFeatureIndex == 0xffff)
101 return reqFeatureIndex;;
104 inline bool sanitize (SANITIZE_ARG_DEF) {
105 return SANITIZE_SELF () && SANITIZE (featureIndex);
108 Offset lookupOrder; /* = Null (reserved for an offset to a
109 * reordering table) */
110 USHORT reqFeatureIndex;/* Index of a feature required for this
111 * language system--if no required features
114 featureIndex; /* Array of indices into the FeatureList */
116 ASSERT_SIZE_DATA (LangSys, 6, "\0\0\xFF\xFF");
121 inline const LangSys& get_lang_sys (unsigned int i) const
123 if (i == NO_INDEX) return get_default_lang_sys ();
124 return this+langSys[i].offset;
126 inline unsigned int get_lang_sys_count (void) const { return langSys.len; }
127 inline const Tag& get_lang_sys_tag (unsigned int i) const { return langSys[i].tag; }
129 // LONGTERMTODO bsearch
130 DEFINE_TAG_FIND_INTERFACE (LangSys, lang_sys); /* find_lang_sys_index (), get_lang_sys_by_tag (tag) */
132 inline bool has_default_lang_sys (void) const { return defaultLangSys != 0; }
133 inline const LangSys& get_default_lang_sys (void) const { return this+defaultLangSys; }
135 inline bool sanitize (SANITIZE_ARG_DEF) {
136 return SANITIZE_THIS (defaultLangSys) && SANITIZE_THIS (langSys);
141 defaultLangSys; /* Offset to DefaultLangSys table--from
142 * beginning of Script table--may be Null */
143 RecordArrayOf<LangSys>
144 langSys; /* Array of LangSysRecords--listed
145 * alphabetically by LangSysTag */
147 ASSERT_SIZE (Script, 4);
149 typedef RecordListOf<Script> ScriptList;
150 ASSERT_SIZE (ScriptList, 2);
155 inline const unsigned int get_lookup_index (unsigned int i) const { return lookupIndex[i]; }
156 inline unsigned int get_lookup_count (void) const { return lookupIndex.len; }
158 inline bool sanitize (SANITIZE_ARG_DEF) {
159 return SANITIZE_SELF () && SANITIZE (lookupIndex);
162 /* TODO: implement get_feature_parameters() */
163 /* TODO: implement FeatureSize and other special features? */
164 Offset featureParams; /* Offset to Feature Parameters table (if one
165 * has been defined for the feature), relative
166 * to the beginning of the Feature Table; = Null
169 lookupIndex; /* Array of LookupList indices */
171 ASSERT_SIZE (Feature, 4);
173 typedef RecordListOf<Feature> FeatureList;
174 ASSERT_SIZE (FeatureList, 2);
177 struct LookupFlag : USHORT
180 RightToLeft = 0x0001u,
181 IgnoreBaseGlyphs = 0x0002u,
182 IgnoreLigatures = 0x0004u,
183 IgnoreMarks = 0x0008u,
184 UseMarkFilteringSet = 0x0010u,
186 MarkAttachmentType = 0xFF00u,
189 ASSERT_SIZE (LookupFlag, 2);
191 struct LookupSubTable
193 inline bool sanitize (SANITIZE_ARG_DEF) {
194 return SANITIZE_SELF ();
198 USHORT format; /* Subtable format. Different for GSUB and GPOS */
200 ASSERT_SIZE (LookupSubTable, 2);
204 inline const LookupSubTable& get_subtable (unsigned int i) const { return this+subTable[i]; }
205 inline unsigned int get_subtable_count (void) const { return subTable.len; }
207 inline unsigned int get_type (void) const { return lookupType; }
208 inline unsigned int get_flag (void) const
210 unsigned int flag = lookupFlag;
211 if (HB_UNLIKELY (flag & LookupFlag::UseMarkFilteringSet))
213 const USHORT &markFilteringSet = CONST_CAST (USHORT, subTable, subTable.get_size ());
214 flag += (markFilteringSet << 16);
219 inline bool sanitize (SANITIZE_ARG_DEF) {
220 if (!(SANITIZE_SELF () && SANITIZE_THIS (subTable))) return false;
221 if (HB_UNLIKELY (lookupFlag & LookupFlag::UseMarkFilteringSet))
223 USHORT &markFilteringSet = CAST (USHORT, subTable, subTable.get_size ());
224 if (!SANITIZE (markFilteringSet)) return false;
229 USHORT lookupType; /* Different enumerations for GSUB and GPOS */
230 USHORT lookupFlag; /* Lookup qualifiers */
231 OffsetArrayOf<LookupSubTable>
232 subTable; /* Array of SubTables */
233 USHORT markFilteringSetX[0]; /* Index (base 0) into GDEF mark glyph sets
234 * structure. This field is only present if bit
235 * UseMarkFilteringSet of lookup flags is set. */
237 ASSERT_SIZE (Lookup, 6);
239 template <typename Type>
240 struct OffsetListOf : OffsetArrayOf<Type>
242 inline const Type& operator [] (unsigned int i) const
244 if (HB_UNLIKELY (i >= this->len)) return Null(Type);
245 return this+this->array[i];
248 inline bool sanitize (SANITIZE_ARG_DEF) {
249 return OffsetArrayOf<Type>::sanitize (SANITIZE_ARG, CONST_CHARP(this));
253 typedef OffsetListOf<Lookup> LookupList;
254 ASSERT_SIZE (LookupList, 2);
261 struct CoverageFormat1
263 friend struct Coverage;
266 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
268 if (HB_UNLIKELY (glyph_id > 0xFFFF))
273 unsigned int num_glyphs = glyphArray.len;
274 for (unsigned int i = 0; i < num_glyphs; i++)
275 if (gid == glyphArray[i])
280 inline bool sanitize (SANITIZE_ARG_DEF) {
281 return SANITIZE (glyphArray);
285 USHORT coverageFormat; /* Format identifier--format = 1 */
287 glyphArray; /* Array of GlyphIDs--in numerical order */
289 ASSERT_SIZE (CoverageFormat1, 4);
291 struct CoverageRangeRecord
293 friend struct CoverageFormat2;
296 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
298 if (glyph_id >= start && glyph_id <= end)
299 return (unsigned int) startCoverageIndex + (glyph_id - start);
304 inline bool sanitize (SANITIZE_ARG_DEF) {
305 return SANITIZE_SELF ();
309 GlyphID start; /* First GlyphID in the range */
310 GlyphID end; /* Last GlyphID in the range */
311 USHORT startCoverageIndex; /* Coverage Index of first GlyphID in
314 ASSERT_SIZE_DATA (CoverageRangeRecord, 6, "\000\001");
316 struct CoverageFormat2
318 friend struct Coverage;
321 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
324 unsigned int count = rangeRecord.len;
325 for (unsigned int i = 0; i < count; i++)
327 unsigned int coverage = rangeRecord[i].get_coverage (glyph_id);
328 if (coverage != NOT_COVERED)
334 inline bool sanitize (SANITIZE_ARG_DEF) {
335 return SANITIZE (rangeRecord);
339 USHORT coverageFormat; /* Format identifier--format = 2 */
340 ArrayOf<CoverageRangeRecord>
341 rangeRecord; /* Array of glyph ranges--ordered by
342 * Start GlyphID. rangeCount entries
345 ASSERT_SIZE (CoverageFormat2, 4);
349 inline unsigned int operator() (hb_codepoint_t glyph_id) const { return get_coverage (glyph_id); }
351 unsigned int get_coverage (hb_codepoint_t glyph_id) const
354 case 1: return u.format1->get_coverage(glyph_id);
355 case 2: return u.format2->get_coverage(glyph_id);
356 default:return NOT_COVERED;
360 inline bool sanitize (SANITIZE_ARG_DEF) {
361 if (!SANITIZE (u.format)) return false;
363 case 1: return u.format1->sanitize (SANITIZE_ARG);
364 case 2: return u.format2->sanitize (SANITIZE_ARG);
371 USHORT format; /* Format identifier */
372 CoverageFormat1 format1[];
373 CoverageFormat2 format2[];
376 ASSERT_SIZE (Coverage, 2);
380 * Class Definition Table
383 struct ClassDefFormat1
385 friend struct ClassDef;
388 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
390 if ((unsigned int) (glyph_id - startGlyph) < classValue.len)
391 return classValue[glyph_id - startGlyph];
395 inline bool sanitize (SANITIZE_ARG_DEF) {
396 return SANITIZE_SELF () && SANITIZE (classValue);
399 USHORT classFormat; /* Format identifier--format = 1 */
400 GlyphID startGlyph; /* First GlyphID of the classValueArray */
402 classValue; /* Array of Class Values--one per GlyphID */
404 ASSERT_SIZE (ClassDefFormat1, 6);
406 struct ClassRangeRecord
408 friend struct ClassDefFormat2;
411 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
413 if (glyph_id >= start && glyph_id <= end)
419 inline bool sanitize (SANITIZE_ARG_DEF) {
420 return SANITIZE_SELF ();
424 GlyphID start; /* First GlyphID in the range */
425 GlyphID end; /* Last GlyphID in the range */
426 USHORT classValue; /* Applied to all glyphs in the range */
428 ASSERT_SIZE_DATA (ClassRangeRecord, 6, "\000\001");
430 struct ClassDefFormat2
432 friend struct ClassDef;
435 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
438 unsigned int count = rangeRecord.len;
439 for (unsigned int i = 0; i < count; i++)
441 int classValue = rangeRecord[i].get_class (glyph_id);
448 inline bool sanitize (SANITIZE_ARG_DEF) {
449 return SANITIZE (rangeRecord);
452 USHORT classFormat; /* Format identifier--format = 2 */
453 ArrayOf<ClassRangeRecord>
454 rangeRecord; /* Array of glyph ranges--ordered by
457 ASSERT_SIZE (ClassDefFormat2, 4);
461 inline unsigned int operator() (hb_codepoint_t glyph_id) const { return get_class (glyph_id); }
463 hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
466 case 1: return u.format1->get_class(glyph_id);
467 case 2: return u.format2->get_class(glyph_id);
472 inline bool sanitize (SANITIZE_ARG_DEF) {
473 if (!SANITIZE (u.format)) return false;
475 case 1: return u.format1->sanitize (SANITIZE_ARG);
476 case 2: return u.format2->sanitize (SANITIZE_ARG);
483 USHORT format; /* Format identifier */
484 ClassDefFormat1 format1[];
485 ClassDefFormat2 format2[];
488 ASSERT_SIZE (ClassDef, 2);
497 int get_delta (unsigned int ppem_size) const
499 unsigned int f = deltaFormat;
500 if (HB_UNLIKELY (f < 1 || f > 3))
503 if (ppem_size < startSize || ppem_size > endSize)
506 unsigned int s = ppem_size - startSize;
508 unsigned int byte = deltaValue[s >> (4 - f)];
509 unsigned int bits = (byte >> (16 - (((s & ((1 << (4 - f)) - 1)) + 1) << f)));
510 unsigned int mask = (0xFFFF >> (16 - (1 << f)));
512 int delta = bits & mask;
514 if (delta >= ((mask + 1) >> 1))
520 inline int operator() (unsigned int ppem_size) const { return get_delta (ppem_size); }
523 USHORT startSize; /* Smallest size to correct--in ppem */
524 USHORT endSize; /* Largest size to correct--in ppem */
525 USHORT deltaFormat; /* Format of DeltaValue array data: 1, 2, or 3 */
526 USHORT deltaValue[]; /* Array of compressed data */
528 ASSERT_SIZE (Device, 6);
531 #endif /* HB_OT_LAYOUT_COMMON_PRIVATE_HH */