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-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 inline bool sanitize (SANITIZE_ARG_DEF, const void *base) {
56 return SANITIZE (tag) && SANITIZE_BASE (offset, base);
59 Tag tag; /* 4-byte Tag identifier */
61 offset; /* Offset from beginning of object holding
65 template <typename Type>
66 struct RecordArrayOf : ArrayOf<Record<Type> > {
67 inline const Tag& get_tag (unsigned int i) const
69 if (HB_UNLIKELY (i >= this->len)) return Null(Tag);
70 return (*this)[i].tag;
72 inline bool get_tags (unsigned int *record_count /* IN/OUT */,
73 hb_tag_t *record_tags /* OUT */) const
75 const Record<Type> *a = this->const_array();
76 unsigned int count = MIN (this->len, *record_count);
77 for (unsigned int i = 0; i < count; i++)
78 record_tags[i] = a[i].tag;
80 *record_count = this->len;
83 inline bool find_index (hb_tag_t tag, unsigned int *index) const
87 const Record<Type> *a = this->const_array();
88 unsigned int count = this->len;
89 for (unsigned int i = 0; i < count; i++)
93 if (index) *index = i;
97 if (index) *index = NO_INDEX;
102 template <typename Type>
103 struct RecordListOf : RecordArrayOf<Type>
105 inline const Type& operator [] (unsigned int i) const
106 { return this+RecordArrayOf<Type>::operator [](i).offset; }
108 inline bool sanitize (SANITIZE_ARG_DEF) {
110 return RecordArrayOf<Type>::sanitize (SANITIZE_ARG, CONST_CHARP(this));
115 struct IndexArray : ArrayOf<USHORT>
117 inline unsigned int operator [] (unsigned int i) const
119 if (HB_UNLIKELY (i >= this->len))
121 return this->const_array()[i];
123 inline bool get_indexes (unsigned int *_count /* IN/OUT */,
124 unsigned int *_indexes /* OUT */) const
126 unsigned int count = MIN (this->len, *_count);
127 const USHORT *a = this->const_array();
128 for (unsigned int i = 0; i < count; i++)
144 inline unsigned int get_feature_count (void) const
145 { return featureIndex.len; }
146 inline hb_tag_t get_feature_index (unsigned int i) const
147 { return featureIndex[i]; }
148 inline bool get_feature_indexes (unsigned int *feature_count /* IN/OUT */,
149 unsigned int *feature_indexes /* OUT */) const
150 { return featureIndex.get_indexes (feature_count, feature_indexes); }
152 inline bool has_required_feature (void) const { return reqFeatureIndex != 0xffff; }
153 inline int get_required_feature_index (void) const
155 if (reqFeatureIndex == 0xffff)
157 return reqFeatureIndex;;
160 inline bool sanitize (SANITIZE_ARG_DEF) {
162 return SANITIZE_SELF () && SANITIZE (featureIndex);
165 Offset lookupOrder; /* = Null (reserved for an offset to a
166 * reordering table) */
167 USHORT reqFeatureIndex;/* Index of a feature required for this
168 * language system--if no required features
170 IndexArray featureIndex; /* Array of indices into the FeatureList */
172 ASSERT_SIZE_DATA (LangSys, 6, "\0\0\xFF\xFF");
177 inline unsigned int get_lang_sys_count (void) const
178 { return langSys.len; }
179 inline const Tag& get_lang_sys_tag (unsigned int i) const
180 { return langSys.get_tag (i); }
181 inline bool get_lang_sys_tags (unsigned int *lang_sys_count /* IN/OUT */,
182 hb_tag_t *lang_sys_tags /* OUT */) const
183 { return langSys.get_tags (lang_sys_count, lang_sys_tags); }
184 inline const LangSys& get_lang_sys (unsigned int i) const
186 if (i == NO_INDEX) return get_default_lang_sys ();
187 return this+langSys[i].offset;
189 inline bool find_lang_sys_index (hb_tag_t tag, unsigned int *index) const
190 { return langSys.find_index (tag, index); }
192 inline bool has_default_lang_sys (void) const { return defaultLangSys != 0; }
193 inline const LangSys& get_default_lang_sys (void) const { return this+defaultLangSys; }
195 inline bool sanitize (SANITIZE_ARG_DEF) {
197 return SANITIZE_THIS (defaultLangSys) && SANITIZE_THIS (langSys);
202 defaultLangSys; /* Offset to DefaultLangSys table--from
203 * beginning of Script table--may be Null */
204 RecordArrayOf<LangSys>
205 langSys; /* Array of LangSysRecords--listed
206 * alphabetically by LangSysTag */
208 ASSERT_SIZE (Script, 4);
210 typedef RecordListOf<Script> ScriptList;
211 ASSERT_SIZE (ScriptList, 2);
216 inline unsigned int get_lookup_count (void) const
217 { return lookupIndex.len; }
218 inline hb_tag_t get_lookup_index (unsigned int i) const
219 { return lookupIndex[i]; }
220 inline bool get_lookup_indexes (unsigned int *lookup_count /* IN/OUT */,
221 unsigned int *lookup_tags /* OUT */) const
222 { return lookupIndex.get_indexes (lookup_count, lookup_tags); }
224 inline bool sanitize (SANITIZE_ARG_DEF) {
226 return SANITIZE_SELF () && SANITIZE (lookupIndex);
229 /* TODO: implement get_feature_parameters() */
230 /* TODO: implement FeatureSize and other special features? */
231 Offset featureParams; /* Offset to Feature Parameters table (if one
232 * has been defined for the feature), relative
233 * to the beginning of the Feature Table; = Null
235 IndexArray lookupIndex; /* Array of LookupList indices */
237 ASSERT_SIZE (Feature, 4);
239 typedef RecordListOf<Feature> FeatureList;
240 ASSERT_SIZE (FeatureList, 2);
243 struct LookupFlag : USHORT
246 RightToLeft = 0x0001u,
247 IgnoreBaseGlyphs = 0x0002u,
248 IgnoreLigatures = 0x0004u,
249 IgnoreMarks = 0x0008u,
250 IgnoreFlags = 0x000Eu,
251 UseMarkFilteringSet = 0x0010u,
253 MarkAttachmentType = 0xFF00u
256 ASSERT_SIZE (LookupFlag, 2);
258 struct LookupSubTable
260 inline bool sanitize (SANITIZE_ARG_DEF) {
262 return SANITIZE_SELF ();
266 USHORT format; /* Subtable format. Different for GSUB and GPOS */
268 ASSERT_SIZE (LookupSubTable, 2);
272 inline const LookupSubTable& get_subtable (unsigned int i) const { return this+subTable[i]; }
273 inline unsigned int get_subtable_count (void) const { return subTable.len; }
275 inline unsigned int get_type (void) const { return lookupType; }
276 inline unsigned int get_flag (void) const
278 unsigned int flag = lookupFlag;
279 if (HB_UNLIKELY (flag & LookupFlag::UseMarkFilteringSet))
281 const USHORT &markFilteringSet = CONST_NEXT (USHORT, subTable);
282 flag += (markFilteringSet << 16);
287 inline bool sanitize (SANITIZE_ARG_DEF) {
289 if (!(SANITIZE_SELF/*XXXXXXXXXXXXXX*/ () && SANITIZE_THIS (subTable))) return false;
290 if (HB_UNLIKELY (lookupFlag & LookupFlag::UseMarkFilteringSet))
292 USHORT &markFilteringSet = NEXT (USHORT, subTable);
293 if (!SANITIZE (markFilteringSet)) return false;
298 USHORT lookupType; /* Different enumerations for GSUB and GPOS */
299 USHORT lookupFlag; /* Lookup qualifiers */
300 OffsetArrayOf<LookupSubTable>
301 subTable; /* Array of SubTables */
302 USHORT markFilteringSetX[VAR]; /* Index (base 0) into GDEF mark glyph sets
303 * structure. This field is only present if bit
304 * UseMarkFilteringSet of lookup flags is set. */
306 ASSERT_SIZE_VAR (Lookup, 6, USHORT);
308 typedef OffsetListOf<Lookup> LookupList;
309 ASSERT_SIZE (LookupList, 2);
316 struct CoverageFormat1
318 friend struct Coverage;
321 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
323 if (HB_UNLIKELY (glyph_id > 0xFFFF))
328 unsigned int num_glyphs = glyphArray.len;
329 for (unsigned int i = 0; i < num_glyphs; i++)
330 if (gid == glyphArray[i])
335 inline bool sanitize (SANITIZE_ARG_DEF) {
337 return SANITIZE (glyphArray);
341 USHORT coverageFormat; /* Format identifier--format = 1 */
343 glyphArray; /* Array of GlyphIDs--in numerical order */
345 ASSERT_SIZE (CoverageFormat1, 4);
347 struct CoverageRangeRecord
349 friend struct CoverageFormat2;
352 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
354 if (glyph_id >= start && glyph_id <= end)
355 return (unsigned int) startCoverageIndex + (glyph_id - start);
360 inline bool sanitize (SANITIZE_ARG_DEF) {
362 return SANITIZE_SELF ();
366 GlyphID start; /* First GlyphID in the range */
367 GlyphID end; /* Last GlyphID in the range */
368 USHORT startCoverageIndex; /* Coverage Index of first GlyphID in
371 ASSERT_SIZE_DATA (CoverageRangeRecord, 6, "\000\001");
373 struct CoverageFormat2
375 friend struct Coverage;
378 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
381 unsigned int count = rangeRecord.len;
382 for (unsigned int i = 0; i < count; i++)
384 unsigned int coverage = rangeRecord[i].get_coverage (glyph_id);
385 if (coverage != NOT_COVERED)
391 inline bool sanitize (SANITIZE_ARG_DEF) {
393 return SANITIZE (rangeRecord);
397 USHORT coverageFormat; /* Format identifier--format = 2 */
398 ArrayOf<CoverageRangeRecord>
399 rangeRecord; /* Array of glyph ranges--ordered by
400 * Start GlyphID. rangeCount entries
403 ASSERT_SIZE (CoverageFormat2, 4);
407 inline unsigned int operator() (hb_codepoint_t glyph_id) const { return get_coverage (glyph_id); }
409 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
412 case 1: return u.format1->get_coverage(glyph_id);
413 case 2: return u.format2->get_coverage(glyph_id);
414 default:return NOT_COVERED;
418 inline bool sanitize (SANITIZE_ARG_DEF) {
420 if (!SANITIZE (u.format)) return false;
422 case 1: return u.format1->sanitize (SANITIZE_ARG);
423 case 2: return u.format2->sanitize (SANITIZE_ARG);
430 USHORT format; /* Format identifier */
431 CoverageFormat1 format1[VAR];
432 CoverageFormat2 format2[VAR];
438 * Class Definition Table
441 struct ClassDefFormat1
443 friend struct ClassDef;
446 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
448 if ((unsigned int) (glyph_id - startGlyph) < classValue.len)
449 return classValue[glyph_id - startGlyph];
453 inline bool sanitize (SANITIZE_ARG_DEF) {
455 return SANITIZE_SELF () && SANITIZE (classValue);
458 USHORT classFormat; /* Format identifier--format = 1 */
459 GlyphID startGlyph; /* First GlyphID of the classValueArray */
461 classValue; /* Array of Class Values--one per GlyphID */
463 ASSERT_SIZE (ClassDefFormat1, 6);
465 struct ClassRangeRecord
467 friend struct ClassDefFormat2;
470 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
472 if (glyph_id >= start && glyph_id <= end)
478 inline bool sanitize (SANITIZE_ARG_DEF) {
480 return SANITIZE_SELF ();
484 GlyphID start; /* First GlyphID in the range */
485 GlyphID end; /* Last GlyphID in the range */
486 USHORT classValue; /* Applied to all glyphs in the range */
488 ASSERT_SIZE_DATA (ClassRangeRecord, 6, "\000\001");
490 struct ClassDefFormat2
492 friend struct ClassDef;
495 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
498 unsigned int count = rangeRecord.len;
499 for (unsigned int i = 0; i < count; i++)
501 int classValue = rangeRecord[i].get_class (glyph_id);
508 inline bool sanitize (SANITIZE_ARG_DEF) {
510 return SANITIZE (rangeRecord);
513 USHORT classFormat; /* Format identifier--format = 2 */
514 ArrayOf<ClassRangeRecord>
515 rangeRecord; /* Array of glyph ranges--ordered by
518 ASSERT_SIZE (ClassDefFormat2, 4);
522 inline unsigned int operator() (hb_codepoint_t glyph_id) const { return get_class (glyph_id); }
524 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
527 case 1: return u.format1->get_class(glyph_id);
528 case 2: return u.format2->get_class(glyph_id);
533 inline bool sanitize (SANITIZE_ARG_DEF) {
535 if (!SANITIZE (u.format)) return false;
537 case 1: return u.format1->sanitize (SANITIZE_ARG);
538 case 2: return u.format2->sanitize (SANITIZE_ARG);
545 USHORT format; /* Format identifier */
546 ClassDefFormat1 format1[VAR];
547 ClassDefFormat2 format2[VAR];
558 inline int operator() (unsigned int ppem_size) const { return get_delta (ppem_size); }
560 inline int get_delta (unsigned int ppem_size) const
562 unsigned int f = deltaFormat;
563 if (HB_UNLIKELY (f < 1 || f > 3))
566 if (ppem_size < startSize || ppem_size > endSize)
569 unsigned int s = ppem_size - startSize;
571 unsigned int byte = deltaValue[s >> (4 - f)];
572 unsigned int bits = (byte >> (16 - (((s & ((1 << (4 - f)) - 1)) + 1) << f)));
573 unsigned int mask = (0xFFFF >> (16 - (1 << f)));
575 int delta = bits & mask;
577 if ((unsigned int) delta >= ((mask + 1) >> 1))
583 inline unsigned int get_size () const
585 unsigned int f = deltaFormat;
586 if (HB_UNLIKELY (f < 1 || f > 3 || startSize > endSize)) return sizeof (*this);
587 return sizeof (*this) + ((endSize - startSize + (1 << (4 - f)) - 1) >> (4 - f));
590 inline bool sanitize (SANITIZE_ARG_DEF) {
592 return SANITIZE_GET_SIZE ();
596 USHORT startSize; /* Smallest size to correct--in ppem */
597 USHORT endSize; /* Largest size to correct--in ppem */
598 USHORT deltaFormat; /* Format of DeltaValue array data: 1, 2, or 3 */
599 USHORT deltaValue[VAR]; /* Array of compressed data */
601 ASSERT_SIZE_VAR (Device, 6, USHORT);
604 #endif /* HB_OT_LAYOUT_COMMON_PRIVATE_HH */