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 unsigned int get_tags (unsigned int start_offset,
73 unsigned int *record_count /* IN/OUT */,
74 hb_tag_t *record_tags /* OUT */) const
77 const Record<Type> *array = this->const_sub_array (start_offset, record_count);
78 unsigned int count = *record_count;
79 for (unsigned int i = 0; i < count; i++)
80 record_tags[i] = array[i].tag;
84 inline bool find_index (hb_tag_t tag, unsigned int *index) const
88 const Record<Type> *a = this->const_array();
89 unsigned int count = this->len;
90 for (unsigned int i = 0; i < count; i++)
94 if (index) *index = i;
98 if (index) *index = NO_INDEX;
103 template <typename Type>
104 struct RecordListOf : RecordArrayOf<Type>
106 inline const Type& operator [] (unsigned int i) const
107 { return this+RecordArrayOf<Type>::operator [](i).offset; }
109 inline bool sanitize (SANITIZE_ARG_DEF) {
111 return RecordArrayOf<Type>::sanitize (SANITIZE_ARG, CONST_CHARP(this));
116 struct IndexArray : ArrayOf<USHORT>
118 inline unsigned int operator [] (unsigned int i) const
120 if (HB_UNLIKELY (i >= this->len))
122 return this->const_array()[i];
124 inline unsigned int get_indexes (unsigned int start_offset,
125 unsigned int *_count /* IN/OUT */,
126 unsigned int *_indexes /* OUT */) const
129 const USHORT *array = this->const_sub_array (start_offset, _count);
130 unsigned int count = *_count;
131 for (unsigned int i = 0; i < count; i++)
132 _indexes[i] = array[i];
146 inline unsigned int get_feature_count (void) const
147 { return featureIndex.len; }
148 inline hb_tag_t get_feature_index (unsigned int i) const
149 { return featureIndex[i]; }
150 inline unsigned int get_feature_indexes (unsigned int start_offset,
151 unsigned int *feature_count /* IN/OUT */,
152 unsigned int *feature_indexes /* OUT */) const
153 { return featureIndex.get_indexes (start_offset, feature_count, feature_indexes); }
155 inline bool has_required_feature (void) const { return reqFeatureIndex != 0xffff; }
156 inline int get_required_feature_index (void) const
158 if (reqFeatureIndex == 0xffff)
160 return reqFeatureIndex;;
163 inline bool sanitize (SANITIZE_ARG_DEF) {
165 return SANITIZE_SELF () && SANITIZE (featureIndex);
168 Offset lookupOrder; /* = Null (reserved for an offset to a
169 * reordering table) */
170 USHORT reqFeatureIndex;/* Index of a feature required for this
171 * language system--if no required features
173 IndexArray featureIndex; /* Array of indices into the FeatureList */
175 ASSERT_SIZE_DATA (LangSys, 6, "\0\0\xFF\xFF");
180 inline unsigned int get_lang_sys_count (void) const
181 { return langSys.len; }
182 inline const Tag& get_lang_sys_tag (unsigned int i) const
183 { return langSys.get_tag (i); }
184 inline unsigned int get_lang_sys_tags (unsigned int start_offset,
185 unsigned int *lang_sys_count /* IN/OUT */,
186 hb_tag_t *lang_sys_tags /* OUT */) const
187 { return langSys.get_tags (start_offset, lang_sys_count, lang_sys_tags); }
188 inline const LangSys& get_lang_sys (unsigned int i) const
190 if (i == NO_INDEX) return get_default_lang_sys ();
191 return this+langSys[i].offset;
193 inline bool find_lang_sys_index (hb_tag_t tag, unsigned int *index) const
194 { return langSys.find_index (tag, index); }
196 inline bool has_default_lang_sys (void) const { return defaultLangSys != 0; }
197 inline const LangSys& get_default_lang_sys (void) const { return this+defaultLangSys; }
199 inline bool sanitize (SANITIZE_ARG_DEF) {
201 return SANITIZE_THIS (defaultLangSys) && SANITIZE_THIS (langSys);
206 defaultLangSys; /* Offset to DefaultLangSys table--from
207 * beginning of Script table--may be Null */
208 RecordArrayOf<LangSys>
209 langSys; /* Array of LangSysRecords--listed
210 * alphabetically by LangSysTag */
212 ASSERT_SIZE (Script, 4);
214 typedef RecordListOf<Script> ScriptList;
215 ASSERT_SIZE (ScriptList, 2);
220 inline unsigned int get_lookup_count (void) const
221 { return lookupIndex.len; }
222 inline hb_tag_t get_lookup_index (unsigned int i) const
223 { return lookupIndex[i]; }
224 inline unsigned int get_lookup_indexes (unsigned int start_index,
225 unsigned int *lookup_count /* IN/OUT */,
226 unsigned int *lookup_tags /* OUT */) const
227 { return lookupIndex.get_indexes (start_index, lookup_count, lookup_tags); }
229 inline bool sanitize (SANITIZE_ARG_DEF) {
231 return SANITIZE_SELF () && SANITIZE (lookupIndex);
234 /* TODO: implement get_feature_parameters() */
235 /* TODO: implement FeatureSize and other special features? */
236 Offset featureParams; /* Offset to Feature Parameters table (if one
237 * has been defined for the feature), relative
238 * to the beginning of the Feature Table; = Null
240 IndexArray lookupIndex; /* Array of LookupList indices */
242 ASSERT_SIZE (Feature, 4);
244 typedef RecordListOf<Feature> FeatureList;
245 ASSERT_SIZE (FeatureList, 2);
248 struct LookupFlag : USHORT
251 RightToLeft = 0x0001u,
252 IgnoreBaseGlyphs = 0x0002u,
253 IgnoreLigatures = 0x0004u,
254 IgnoreMarks = 0x0008u,
255 IgnoreFlags = 0x000Eu,
256 UseMarkFilteringSet = 0x0010u,
258 MarkAttachmentType = 0xFF00u
261 ASSERT_SIZE (LookupFlag, 2);
263 struct LookupSubTable
265 inline bool sanitize (SANITIZE_ARG_DEF) {
267 return SANITIZE_SELF ();
271 USHORT format; /* Subtable format. Different for GSUB and GPOS */
273 ASSERT_SIZE (LookupSubTable, 2);
277 inline const LookupSubTable& get_subtable (unsigned int i) const { return this+subTable[i]; }
278 inline unsigned int get_subtable_count (void) const { return subTable.len; }
280 inline unsigned int get_type (void) const { return lookupType; }
281 inline unsigned int get_flag (void) const
283 unsigned int flag = lookupFlag;
284 if (HB_UNLIKELY (flag & LookupFlag::UseMarkFilteringSet))
286 const USHORT &markFilteringSet = CONST_NEXT (USHORT, subTable);
287 flag += (markFilteringSet << 16);
292 inline bool sanitize (SANITIZE_ARG_DEF) {
294 if (!(SANITIZE (lookupType) && SANITIZE (lookupFlag) && SANITIZE_THIS (subTable))) return false;
295 if (HB_UNLIKELY (lookupFlag & LookupFlag::UseMarkFilteringSet))
297 USHORT &markFilteringSet = NEXT (USHORT, subTable);
298 if (!SANITIZE (markFilteringSet)) return false;
303 USHORT lookupType; /* Different enumerations for GSUB and GPOS */
304 USHORT lookupFlag; /* Lookup qualifiers */
305 OffsetArrayOf<LookupSubTable>
306 subTable; /* Array of SubTables */
307 USHORT markFilteringSetX[VAR]; /* Index (base 0) into GDEF mark glyph sets
308 * structure. This field is only present if bit
309 * UseMarkFilteringSet of lookup flags is set. */
311 ASSERT_SIZE_VAR (Lookup, 6, USHORT);
313 typedef OffsetListOf<Lookup> LookupList;
314 ASSERT_SIZE (LookupList, 2);
321 struct CoverageFormat1
323 friend struct Coverage;
326 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
328 if (HB_UNLIKELY (glyph_id > 0xFFFF))
333 unsigned int num_glyphs = glyphArray.len;
334 for (unsigned int i = 0; i < num_glyphs; i++)
335 if (gid == glyphArray[i])
340 inline bool sanitize (SANITIZE_ARG_DEF) {
342 return SANITIZE (glyphArray);
346 USHORT coverageFormat; /* Format identifier--format = 1 */
348 glyphArray; /* Array of GlyphIDs--in numerical order */
350 ASSERT_SIZE (CoverageFormat1, 4);
352 struct CoverageRangeRecord
354 friend struct CoverageFormat2;
357 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
359 if (glyph_id >= start && glyph_id <= end)
360 return (unsigned int) startCoverageIndex + (glyph_id - start);
365 inline bool sanitize (SANITIZE_ARG_DEF) {
367 return SANITIZE_SELF ();
371 GlyphID start; /* First GlyphID in the range */
372 GlyphID end; /* Last GlyphID in the range */
373 USHORT startCoverageIndex; /* Coverage Index of first GlyphID in
376 ASSERT_SIZE_DATA (CoverageRangeRecord, 6, "\000\001");
378 struct CoverageFormat2
380 friend struct Coverage;
383 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
386 unsigned int count = rangeRecord.len;
387 for (unsigned int i = 0; i < count; i++)
389 unsigned int coverage = rangeRecord[i].get_coverage (glyph_id);
390 if (coverage != NOT_COVERED)
396 inline bool sanitize (SANITIZE_ARG_DEF) {
398 return SANITIZE (rangeRecord);
402 USHORT coverageFormat; /* Format identifier--format = 2 */
403 ArrayOf<CoverageRangeRecord>
404 rangeRecord; /* Array of glyph ranges--ordered by
405 * Start GlyphID. rangeCount entries
408 ASSERT_SIZE (CoverageFormat2, 4);
412 inline unsigned int operator() (hb_codepoint_t glyph_id) const { return get_coverage (glyph_id); }
414 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
417 case 1: return u.format1->get_coverage(glyph_id);
418 case 2: return u.format2->get_coverage(glyph_id);
419 default:return NOT_COVERED;
423 inline bool sanitize (SANITIZE_ARG_DEF) {
425 if (!SANITIZE (u.format)) return false;
427 case 1: return u.format1->sanitize (SANITIZE_ARG);
428 case 2: return u.format2->sanitize (SANITIZE_ARG);
435 USHORT format; /* Format identifier */
436 CoverageFormat1 format1[VAR];
437 CoverageFormat2 format2[VAR];
443 * Class Definition Table
446 struct ClassDefFormat1
448 friend struct ClassDef;
451 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
453 if ((unsigned int) (glyph_id - startGlyph) < classValue.len)
454 return classValue[glyph_id - startGlyph];
458 inline bool sanitize (SANITIZE_ARG_DEF) {
460 return SANITIZE_SELF () && SANITIZE (classValue);
463 USHORT classFormat; /* Format identifier--format = 1 */
464 GlyphID startGlyph; /* First GlyphID of the classValueArray */
466 classValue; /* Array of Class Values--one per GlyphID */
468 ASSERT_SIZE (ClassDefFormat1, 6);
470 struct ClassRangeRecord
472 friend struct ClassDefFormat2;
475 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
477 if (glyph_id >= start && glyph_id <= end)
483 inline bool sanitize (SANITIZE_ARG_DEF) {
485 return SANITIZE_SELF ();
489 GlyphID start; /* First GlyphID in the range */
490 GlyphID end; /* Last GlyphID in the range */
491 USHORT classValue; /* Applied to all glyphs in the range */
493 ASSERT_SIZE_DATA (ClassRangeRecord, 6, "\000\001");
495 struct ClassDefFormat2
497 friend struct ClassDef;
500 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
503 unsigned int count = rangeRecord.len;
504 for (unsigned int i = 0; i < count; i++)
506 int classValue = rangeRecord[i].get_class (glyph_id);
513 inline bool sanitize (SANITIZE_ARG_DEF) {
515 return SANITIZE (rangeRecord);
518 USHORT classFormat; /* Format identifier--format = 2 */
519 ArrayOf<ClassRangeRecord>
520 rangeRecord; /* Array of glyph ranges--ordered by
523 ASSERT_SIZE (ClassDefFormat2, 4);
527 inline unsigned int operator() (hb_codepoint_t glyph_id) const { return get_class (glyph_id); }
529 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
532 case 1: return u.format1->get_class(glyph_id);
533 case 2: return u.format2->get_class(glyph_id);
538 inline bool sanitize (SANITIZE_ARG_DEF) {
540 if (!SANITIZE (u.format)) return false;
542 case 1: return u.format1->sanitize (SANITIZE_ARG);
543 case 2: return u.format2->sanitize (SANITIZE_ARG);
550 USHORT format; /* Format identifier */
551 ClassDefFormat1 format1[VAR];
552 ClassDefFormat2 format2[VAR];
563 inline int operator() (unsigned int ppem_size) const { return get_delta (ppem_size); }
565 inline int get_delta (unsigned int ppem_size) const
567 unsigned int f = deltaFormat;
568 if (HB_UNLIKELY (f < 1 || f > 3))
571 if (ppem_size < startSize || ppem_size > endSize)
574 unsigned int s = ppem_size - startSize;
576 unsigned int byte = deltaValue[s >> (4 - f)];
577 unsigned int bits = (byte >> (16 - (((s & ((1 << (4 - f)) - 1)) + 1) << f)));
578 unsigned int mask = (0xFFFF >> (16 - (1 << f)));
580 int delta = bits & mask;
582 if ((unsigned int) delta >= ((mask + 1) >> 1))
588 inline unsigned int get_size () const
590 unsigned int f = deltaFormat;
591 if (HB_UNLIKELY (f < 1 || f > 3 || startSize > endSize)) return sizeof (*this);
592 return sizeof (*this) + ((endSize - startSize + (1 << (4 - f)) - 1) >> (4 - f));
595 inline bool sanitize (SANITIZE_ARG_DEF) {
597 return SANITIZE_GET_SIZE ();
601 USHORT startSize; /* Smallest size to correct--in ppem */
602 USHORT endSize; /* Largest size to correct--in ppem */
603 USHORT deltaFormat; /* Format of DeltaValue array data: 1, 2, or 3 */
604 USHORT deltaValue[VAR]; /* Array of compressed data */
606 ASSERT_SIZE_VAR (Device, 6, USHORT);
609 #endif /* HB_OT_LAYOUT_COMMON_PRIVATE_HH */