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_COMMON_PRIVATE_HH
28 #define HB_OT_LAYOUT_COMMON_PRIVATE_HH
30 #include "hb-ot-layout-private.h"
32 #include "hb-open-type-private.hh"
35 #define NO_CONTEXT ((unsigned int) 0x110000)
36 #define NOT_COVERED ((unsigned int) 0x110000)
37 #define MAX_NESTING_LEVEL 8
42 * OpenType Layout Common Table Formats
48 * Script, ScriptList, LangSys, Feature, FeatureList, Lookup, LookupList
51 template <typename Type>
54 static inline unsigned int get_size () { return sizeof (Record<Type>); }
56 inline bool sanitize (SANITIZE_ARG_DEF, void *base) {
58 return SANITIZE_SELF () && SANITIZE_BASE (offset, base);
61 Tag tag; /* 4-byte Tag identifier */
63 offset; /* Offset from beginning of object holding
67 template <typename Type>
68 struct RecordArrayOf : ArrayOf<Record<Type> > {
69 inline const Tag& get_tag (unsigned int i) const
71 if (HB_UNLIKELY (i >= this->len)) return Null(Tag);
72 return (*this)[i].tag;
74 inline unsigned int get_tags (unsigned int start_offset,
75 unsigned int *record_count /* IN/OUT */,
76 hb_tag_t *record_tags /* OUT */) const
79 const Record<Type> *array = this->sub_array (start_offset, record_count);
80 unsigned int count = *record_count;
81 for (unsigned int i = 0; i < count; i++)
82 record_tags[i] = array[i].tag;
86 inline bool find_index (hb_tag_t tag, unsigned int *index) const
91 const Record<Type> *a = this->array();
92 unsigned int count = this->len;
93 for (unsigned int i = 0; i < count; i++)
97 if (index) *index = i;
101 if (index) *index = NO_INDEX;
106 template <typename Type>
107 struct RecordListOf : RecordArrayOf<Type>
109 inline const Type& operator [] (unsigned int i) const
110 { return this+RecordArrayOf<Type>::operator [](i).offset; }
112 inline bool sanitize (SANITIZE_ARG_DEF) {
114 return RecordArrayOf<Type>::sanitize (SANITIZE_ARG, CharP(this));
119 struct IndexArray : ArrayOf<USHORT>
121 inline unsigned int operator [] (unsigned int i) const
123 if (HB_UNLIKELY (i >= this->len))
125 return this->array()[i];
127 inline unsigned int get_indexes (unsigned int start_offset,
128 unsigned int *_count /* IN/OUT */,
129 unsigned int *_indexes /* OUT */) const
132 const USHORT *array = this->sub_array (start_offset, _count);
133 unsigned int count = *_count;
134 for (unsigned int i = 0; i < count; i++)
135 _indexes[i] = array[i];
149 inline unsigned int get_feature_count (void) const
150 { return featureIndex.len; }
151 inline hb_tag_t get_feature_index (unsigned int i) const
152 { return featureIndex[i]; }
153 inline unsigned int get_feature_indexes (unsigned int start_offset,
154 unsigned int *feature_count /* IN/OUT */,
155 unsigned int *feature_indexes /* OUT */) const
156 { return featureIndex.get_indexes (start_offset, feature_count, feature_indexes); }
158 inline bool has_required_feature (void) const { return reqFeatureIndex != 0xffff; }
159 inline int get_required_feature_index (void) const
161 if (reqFeatureIndex == 0xffff)
163 return reqFeatureIndex;;
166 inline bool sanitize (SANITIZE_ARG_DEF) {
168 return SANITIZE_SELF () && SANITIZE (featureIndex);
171 Offset lookupOrder; /* = Null (reserved for an offset to a
172 * reordering table) */
173 USHORT reqFeatureIndex;/* Index of a feature required for this
174 * language system--if no required features
176 IndexArray featureIndex; /* Array of indices into the FeatureList */
178 ASSERT_SIZE (LangSys, 6);
179 DEFINE_NULL_DATA (LangSys, 6, "\0\0\xFF\xFF");
184 inline unsigned int get_lang_sys_count (void) const
185 { return langSys.len; }
186 inline const Tag& get_lang_sys_tag (unsigned int i) const
187 { return langSys.get_tag (i); }
188 inline unsigned int get_lang_sys_tags (unsigned int start_offset,
189 unsigned int *lang_sys_count /* IN/OUT */,
190 hb_tag_t *lang_sys_tags /* OUT */) const
191 { return langSys.get_tags (start_offset, lang_sys_count, lang_sys_tags); }
192 inline const LangSys& get_lang_sys (unsigned int i) const
194 if (i == NO_INDEX) return get_default_lang_sys ();
195 return this+langSys[i].offset;
197 inline bool find_lang_sys_index (hb_tag_t tag, unsigned int *index) const
198 { return langSys.find_index (tag, index); }
200 inline bool has_default_lang_sys (void) const { return defaultLangSys != 0; }
201 inline const LangSys& get_default_lang_sys (void) const { return this+defaultLangSys; }
203 inline bool sanitize (SANITIZE_ARG_DEF) {
205 return SANITIZE_THIS2 (defaultLangSys, langSys);
210 defaultLangSys; /* Offset to DefaultLangSys table--from
211 * beginning of Script table--may be Null */
212 RecordArrayOf<LangSys>
213 langSys; /* Array of LangSysRecords--listed
214 * alphabetically by LangSysTag */
216 ASSERT_SIZE (Script, 4);
218 typedef RecordListOf<Script> ScriptList;
219 ASSERT_SIZE (ScriptList, 2);
224 inline unsigned int get_lookup_count (void) const
225 { return lookupIndex.len; }
226 inline hb_tag_t get_lookup_index (unsigned int i) const
227 { return lookupIndex[i]; }
228 inline unsigned int get_lookup_indexes (unsigned int start_index,
229 unsigned int *lookup_count /* IN/OUT */,
230 unsigned int *lookup_tags /* OUT */) const
231 { return lookupIndex.get_indexes (start_index, lookup_count, lookup_tags); }
233 inline bool sanitize (SANITIZE_ARG_DEF) {
235 return SANITIZE_SELF () && SANITIZE (lookupIndex);
238 /* TODO: implement get_feature_parameters() */
239 /* TODO: implement FeatureSize and other special features? */
240 Offset featureParams; /* Offset to Feature Parameters table (if one
241 * has been defined for the feature), relative
242 * to the beginning of the Feature Table; = Null
244 IndexArray lookupIndex; /* Array of LookupList indices */
246 ASSERT_SIZE (Feature, 4);
248 typedef RecordListOf<Feature> FeatureList;
249 ASSERT_SIZE (FeatureList, 2);
252 struct LookupFlag : USHORT
255 RightToLeft = 0x0001u,
256 IgnoreBaseGlyphs = 0x0002u,
257 IgnoreLigatures = 0x0004u,
258 IgnoreMarks = 0x0008u,
259 IgnoreFlags = 0x000Eu,
260 UseMarkFilteringSet = 0x0010u,
262 MarkAttachmentType = 0xFF00u
265 ASSERT_SIZE (LookupFlag, 2);
267 struct LookupSubTable
269 inline bool sanitize (SANITIZE_ARG_DEF) {
271 return SANITIZE_SELF ();
275 USHORT format; /* Subtable format. Different for GSUB and GPOS */
277 ASSERT_SIZE (LookupSubTable, 2);
281 inline const LookupSubTable& get_subtable (unsigned int i) const { return this+subTable[i]; }
282 inline unsigned int get_subtable_count (void) const { return subTable.len; }
284 inline unsigned int get_type (void) const { return lookupType; }
285 inline unsigned int get_flag (void) const
287 unsigned int flag = lookupFlag;
288 if (HB_UNLIKELY (flag & LookupFlag::UseMarkFilteringSet))
290 const USHORT &markFilteringSet = StructAfter<USHORT> (subTable);
291 flag += (markFilteringSet << 16);
296 inline bool sanitize (SANITIZE_ARG_DEF) {
298 /* We sanitize subtables shallow here since we don't have their actual
299 * type. Real sanitize of the referenced data is done by GSUB/GPOS/... */
300 if (!(SANITIZE_SELF () && HB_LIKELY (subTable.sanitize_shallow (SANITIZE_ARG)))) return false;
301 if (HB_UNLIKELY (lookupFlag & LookupFlag::UseMarkFilteringSet))
303 USHORT &markFilteringSet = StructAfter<USHORT> (subTable);
304 if (!SANITIZE (markFilteringSet)) return false;
309 USHORT lookupType; /* Different enumerations for GSUB and GPOS */
310 USHORT lookupFlag; /* Lookup qualifiers */
311 OffsetArrayOf<LookupSubTable>
312 subTable; /* Array of SubTables */
313 USHORT markFilteringSetX[VAR]; /* Index (base 0) into GDEF mark glyph sets
314 * structure. This field is only present if bit
315 * UseMarkFilteringSet of lookup flags is set. */
317 ASSERT_SIZE_VAR (Lookup, 6, USHORT);
319 typedef OffsetListOf<Lookup> LookupList;
320 ASSERT_SIZE (LookupList, 2);
327 struct CoverageFormat1
329 friend struct Coverage;
332 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
334 if (HB_UNLIKELY (glyph_id > 0xFFFF))
339 unsigned int num_glyphs = glyphArray.len;
340 for (unsigned int i = 0; i < num_glyphs; i++)
341 if (gid == glyphArray[i])
346 inline bool sanitize (SANITIZE_ARG_DEF) {
348 return SANITIZE (glyphArray);
352 USHORT coverageFormat; /* Format identifier--format = 1 */
354 glyphArray; /* Array of GlyphIDs--in numerical order */
356 ASSERT_SIZE (CoverageFormat1, 4);
358 struct CoverageRangeRecord
360 friend struct CoverageFormat2;
362 static inline unsigned int get_size () { return sizeof (CoverageRangeRecord); }
365 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
367 if (glyph_id >= start && glyph_id <= end)
368 return (unsigned int) startCoverageIndex + (glyph_id - start);
373 inline bool sanitize (SANITIZE_ARG_DEF) {
375 return SANITIZE_SELF ();
379 GlyphID start; /* First GlyphID in the range */
380 GlyphID end; /* Last GlyphID in the range */
381 USHORT startCoverageIndex; /* Coverage Index of first GlyphID in
384 ASSERT_SIZE (CoverageRangeRecord, 6);
385 DEFINE_NULL_DATA (CoverageRangeRecord, 6, "\000\001");
387 struct CoverageFormat2
389 friend struct Coverage;
392 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
395 unsigned int count = rangeRecord.len;
396 for (unsigned int i = 0; i < count; i++)
398 unsigned int coverage = rangeRecord[i].get_coverage (glyph_id);
399 if (coverage != NOT_COVERED)
405 inline bool sanitize (SANITIZE_ARG_DEF) {
407 return SANITIZE (rangeRecord);
411 USHORT coverageFormat; /* Format identifier--format = 2 */
412 ArrayOf<CoverageRangeRecord>
413 rangeRecord; /* Array of glyph ranges--ordered by
414 * Start GlyphID. rangeCount entries
417 ASSERT_SIZE (CoverageFormat2, 4);
421 inline unsigned int operator () (hb_codepoint_t glyph_id) const { return get_coverage (glyph_id); }
423 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
426 case 1: return u.format1->get_coverage(glyph_id);
427 case 2: return u.format2->get_coverage(glyph_id);
428 default:return NOT_COVERED;
432 inline bool sanitize (SANITIZE_ARG_DEF) {
434 if (!SANITIZE (u.format)) return false;
436 case 1: return u.format1->sanitize (SANITIZE_ARG);
437 case 2: return u.format2->sanitize (SANITIZE_ARG);
444 USHORT format; /* Format identifier */
445 CoverageFormat1 format1[VAR];
446 CoverageFormat2 format2[VAR];
452 * Class Definition Table
455 struct ClassDefFormat1
457 friend struct ClassDef;
460 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
462 if ((unsigned int) (glyph_id - startGlyph) < classValue.len)
463 return classValue[glyph_id - startGlyph];
467 inline bool sanitize (SANITIZE_ARG_DEF) {
469 return SANITIZE_SELF () && SANITIZE (classValue);
472 USHORT classFormat; /* Format identifier--format = 1 */
473 GlyphID startGlyph; /* First GlyphID of the classValueArray */
475 classValue; /* Array of Class Values--one per GlyphID */
477 ASSERT_SIZE (ClassDefFormat1, 6);
479 struct ClassRangeRecord
481 friend struct ClassDefFormat2;
483 static inline unsigned int get_size () { return sizeof (ClassRangeRecord); }
486 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
488 if (glyph_id >= start && glyph_id <= end)
494 inline bool sanitize (SANITIZE_ARG_DEF) {
496 return SANITIZE_SELF ();
500 GlyphID start; /* First GlyphID in the range */
501 GlyphID end; /* Last GlyphID in the range */
502 USHORT classValue; /* Applied to all glyphs in the range */
504 ASSERT_SIZE (ClassRangeRecord, 6);
505 DEFINE_NULL_DATA (ClassRangeRecord, 6, "\000\001");
507 struct ClassDefFormat2
509 friend struct ClassDef;
512 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
515 unsigned int count = rangeRecord.len;
516 for (unsigned int i = 0; i < count; i++)
518 int classValue = rangeRecord[i].get_class (glyph_id);
525 inline bool sanitize (SANITIZE_ARG_DEF) {
527 return SANITIZE (rangeRecord);
530 USHORT classFormat; /* Format identifier--format = 2 */
531 ArrayOf<ClassRangeRecord>
532 rangeRecord; /* Array of glyph ranges--ordered by
535 ASSERT_SIZE (ClassDefFormat2, 4);
539 inline hb_ot_layout_class_t operator () (hb_codepoint_t glyph_id) const { return get_class (glyph_id); }
541 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
544 case 1: return u.format1->get_class(glyph_id);
545 case 2: return u.format2->get_class(glyph_id);
550 inline bool sanitize (SANITIZE_ARG_DEF) {
552 if (!SANITIZE (u.format)) return false;
554 case 1: return u.format1->sanitize (SANITIZE_ARG);
555 case 2: return u.format2->sanitize (SANITIZE_ARG);
562 USHORT format; /* Format identifier */
563 ClassDefFormat1 format1[VAR];
564 ClassDefFormat2 format2[VAR];
575 inline int operator () (unsigned int ppem_size) const { return get_delta (ppem_size); }
577 inline int get_delta (unsigned int ppem_size) const
579 unsigned int f = deltaFormat;
580 if (HB_UNLIKELY (f < 1 || f > 3))
583 if (ppem_size < startSize || ppem_size > endSize)
586 unsigned int s = ppem_size - startSize;
588 unsigned int byte = deltaValue[s >> (4 - f)];
589 unsigned int bits = (byte >> (16 - (((s & ((1 << (4 - f)) - 1)) + 1) << f)));
590 unsigned int mask = (0xFFFF >> (16 - (1 << f)));
592 int delta = bits & mask;
594 if ((unsigned int) delta >= ((mask + 1) >> 1))
600 inline unsigned int get_size () const
602 unsigned int f = deltaFormat;
603 if (HB_UNLIKELY (f < 1 || f > 3 || startSize > endSize)) return 3 * USHORT::get_size ();
604 return 3 * USHORT::get_size () + ((endSize - startSize + (1 << (4 - f)) - 1) >> (4 - f));
607 inline bool sanitize (SANITIZE_ARG_DEF) {
609 return SANITIZE_SELF() && SANITIZE_MEM (this, this->get_size ());
613 USHORT startSize; /* Smallest size to correct--in ppem */
614 USHORT endSize; /* Largest size to correct--in ppem */
615 USHORT deltaFormat; /* Format of DeltaValue array data: 1, 2, or 3 */
616 USHORT deltaValue[VAR]; /* Array of compressed data */
618 ASSERT_SIZE_VAR (Device, 6, USHORT);
621 #endif /* HB_OT_LAYOUT_COMMON_PRIVATE_HH */