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"
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) {
51 return SANITIZE (tag) && SANITIZE_BASE (offset, base);
54 Tag tag; /* 4-byte Tag identifier */
56 offset; /* Offset from beginning of object holding
60 template <typename Type>
61 struct RecordArrayOf : ArrayOf<Record<Type> > {
62 inline const Tag& get_tag (unsigned int i) const
64 if (HB_UNLIKELY (i >= this->len)) return Null(Tag);
65 return this->array[i].tag;
67 inline bool get_tags (unsigned int *record_count /* IN/OUT */,
68 hb_tag_t *record_tags /* OUT */) const
70 unsigned int count = MIN (this->len, *record_count);
71 for (unsigned int i = 0; i < count; i++)
72 record_tags[i] = this->array[i].tag;
74 *record_count = this->len;
77 inline bool find_index (hb_tag_t tag, unsigned int *index) const
81 unsigned int count = this->len;
82 for (unsigned int i = 0; i < count; i++)
84 if (t == this->array[i].tag)
86 if (index) *index = i;
90 if (index) *index = NO_INDEX;
95 template <typename Type>
96 struct RecordListOf : RecordArrayOf<Type>
98 inline const Type& operator [] (unsigned int i) const
99 { return this+RecordArrayOf<Type>::operator[](i).offset; }
101 inline bool sanitize (SANITIZE_ARG_DEF) {
103 return RecordArrayOf<Type>::sanitize (SANITIZE_ARG, CONST_CHARP(this));
108 struct IndexArray : ArrayOf<USHORT>
110 inline unsigned int operator [] (unsigned int i) const
112 if (HB_UNLIKELY (i >= this->len))
114 return this->array[i];
116 inline bool get_indexes (unsigned int *_count /* IN/OUT */,
117 unsigned int *_indexes /* OUT */) const
119 unsigned int count = MIN (this->len, *_count);
120 for (unsigned int i = 0; i < count; i++)
121 _indexes[i] = this->array[i];
136 inline unsigned int get_feature_count (void) const
137 { return featureIndex.len; }
138 inline hb_tag_t get_feature_index (unsigned int i) const
139 { return featureIndex[i]; }
140 inline bool get_feature_indexes (unsigned int *feature_count /* IN/OUT */,
141 hb_tag_t *feature_tags /* OUT */) const
142 { return featureIndex.get_indexes (feature_count, feature_tags); }
144 inline bool has_required_feature (void) const { return reqFeatureIndex != 0xffff; }
145 inline int get_required_feature_index (void) const
147 if (reqFeatureIndex == 0xffff)
149 return reqFeatureIndex;;
152 inline bool sanitize (SANITIZE_ARG_DEF) {
154 return SANITIZE_SELF () && SANITIZE (featureIndex);
157 Offset lookupOrder; /* = Null (reserved for an offset to a
158 * reordering table) */
159 USHORT reqFeatureIndex;/* Index of a feature required for this
160 * language system--if no required features
162 IndexArray featureIndex; /* Array of indices into the FeatureList */
164 ASSERT_SIZE_DATA (LangSys, 6, "\0\0\xFF\xFF");
169 inline unsigned int get_lang_sys_count (void) const
170 { return langSys.len; }
171 inline const Tag& get_lang_sys_tag (unsigned int i) const
172 { return langSys.get_tag (i); }
173 inline bool get_lang_sys_tags (unsigned int *lang_sys_count /* IN/OUT */,
174 hb_tag_t *lang_sys_tags /* OUT */) const
175 { return langSys.get_tags (lang_sys_count, lang_sys_tags); }
176 inline const LangSys& get_lang_sys (unsigned int i) const
178 if (i == NO_INDEX) return get_default_lang_sys ();
179 return this+langSys[i].offset;
181 inline bool find_lang_sys_index (hb_tag_t tag, unsigned int *index) const
182 { return langSys.find_index (tag, index); }
184 inline bool has_default_lang_sys (void) const { return defaultLangSys != 0; }
185 inline const LangSys& get_default_lang_sys (void) const { return this+defaultLangSys; }
187 inline bool sanitize (SANITIZE_ARG_DEF) {
189 return SANITIZE_THIS (defaultLangSys) && SANITIZE_THIS (langSys);
194 defaultLangSys; /* Offset to DefaultLangSys table--from
195 * beginning of Script table--may be Null */
196 RecordArrayOf<LangSys>
197 langSys; /* Array of LangSysRecords--listed
198 * alphabetically by LangSysTag */
200 ASSERT_SIZE (Script, 4);
202 typedef RecordListOf<Script> ScriptList;
203 ASSERT_SIZE (ScriptList, 2);
208 inline unsigned int get_lookup_count (void) const
209 { return lookupIndex.len; }
210 inline hb_tag_t get_lookup_index (unsigned int i) const
211 { return lookupIndex[i]; }
212 inline bool get_lookup_indexes (unsigned int *lookup_count /* IN/OUT */,
213 hb_tag_t *lookup_tags /* OUT */) const
214 { return lookupIndex.get_indexes (lookup_count, lookup_tags); }
216 inline bool sanitize (SANITIZE_ARG_DEF) {
218 return SANITIZE_SELF () && SANITIZE (lookupIndex);
221 /* TODO: implement get_feature_parameters() */
222 /* TODO: implement FeatureSize and other special features? */
223 Offset featureParams; /* Offset to Feature Parameters table (if one
224 * has been defined for the feature), relative
225 * to the beginning of the Feature Table; = Null
227 IndexArray lookupIndex; /* Array of LookupList indices */
229 ASSERT_SIZE (Feature, 4);
231 typedef RecordListOf<Feature> FeatureList;
232 ASSERT_SIZE (FeatureList, 2);
235 struct LookupFlag : USHORT
238 RightToLeft = 0x0001u,
239 IgnoreBaseGlyphs = 0x0002u,
240 IgnoreLigatures = 0x0004u,
241 IgnoreMarks = 0x0008u,
242 UseMarkFilteringSet = 0x0010u,
244 MarkAttachmentType = 0xFF00u,
247 ASSERT_SIZE (LookupFlag, 2);
249 struct LookupSubTable
251 inline bool sanitize (SANITIZE_ARG_DEF) {
253 return SANITIZE_SELF ();
257 USHORT format; /* Subtable format. Different for GSUB and GPOS */
259 ASSERT_SIZE (LookupSubTable, 2);
263 inline const LookupSubTable& get_subtable (unsigned int i) const { return this+subTable[i]; }
264 inline unsigned int get_subtable_count (void) const { return subTable.len; }
266 inline unsigned int get_type (void) const { return lookupType; }
267 inline unsigned int get_flag (void) const
269 unsigned int flag = lookupFlag;
270 if (HB_UNLIKELY (flag & LookupFlag::UseMarkFilteringSet))
272 const USHORT &markFilteringSet = CONST_NEXT (USHORT, subTable);
273 flag += (markFilteringSet << 16);
278 inline bool sanitize (SANITIZE_ARG_DEF) {
280 if (!(SANITIZE_SELF () && SANITIZE_THIS (subTable))) return false;
281 if (HB_UNLIKELY (lookupFlag & LookupFlag::UseMarkFilteringSet))
283 USHORT &markFilteringSet = NEXT (USHORT, subTable);
284 if (!SANITIZE (markFilteringSet)) return false;
289 USHORT lookupType; /* Different enumerations for GSUB and GPOS */
290 USHORT lookupFlag; /* Lookup qualifiers */
291 OffsetArrayOf<LookupSubTable>
292 subTable; /* Array of SubTables */
293 USHORT markFilteringSetX[0]; /* Index (base 0) into GDEF mark glyph sets
294 * structure. This field is only present if bit
295 * UseMarkFilteringSet of lookup flags is set. */
297 ASSERT_SIZE (Lookup, 6);
299 template <typename Type>
300 struct OffsetListOf : OffsetArrayOf<Type>
302 inline const Type& operator [] (unsigned int i) const
304 if (HB_UNLIKELY (i >= this->len)) return Null(Type);
305 return this+this->array[i];
308 inline bool sanitize (SANITIZE_ARG_DEF) {
310 return OffsetArrayOf<Type>::sanitize (SANITIZE_ARG, CONST_CHARP(this));
312 inline bool sanitize (SANITIZE_ARG_DEF, unsigned int user_data) {
314 return OffsetArrayOf<Type>::sanitize (SANITIZE_ARG, CONST_CHARP(this), user_data);
318 typedef OffsetListOf<Lookup> LookupList;
319 ASSERT_SIZE (LookupList, 2);
326 struct CoverageFormat1
328 friend struct Coverage;
331 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
333 if (HB_UNLIKELY (glyph_id > 0xFFFF))
338 unsigned int num_glyphs = glyphArray.len;
339 for (unsigned int i = 0; i < num_glyphs; i++)
340 if (gid == glyphArray[i])
345 inline bool sanitize (SANITIZE_ARG_DEF) {
347 return SANITIZE (glyphArray);
351 USHORT coverageFormat; /* Format identifier--format = 1 */
353 glyphArray; /* Array of GlyphIDs--in numerical order */
355 ASSERT_SIZE (CoverageFormat1, 4);
357 struct CoverageRangeRecord
359 friend struct CoverageFormat2;
362 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
364 if (glyph_id >= start && glyph_id <= end)
365 return (unsigned int) startCoverageIndex + (glyph_id - start);
370 inline bool sanitize (SANITIZE_ARG_DEF) {
372 return SANITIZE_SELF ();
376 GlyphID start; /* First GlyphID in the range */
377 GlyphID end; /* Last GlyphID in the range */
378 USHORT startCoverageIndex; /* Coverage Index of first GlyphID in
381 ASSERT_SIZE_DATA (CoverageRangeRecord, 6, "\000\001");
383 struct CoverageFormat2
385 friend struct Coverage;
388 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
391 unsigned int count = rangeRecord.len;
392 for (unsigned int i = 0; i < count; i++)
394 unsigned int coverage = rangeRecord[i].get_coverage (glyph_id);
395 if (coverage != NOT_COVERED)
401 inline bool sanitize (SANITIZE_ARG_DEF) {
403 return SANITIZE (rangeRecord);
407 USHORT coverageFormat; /* Format identifier--format = 2 */
408 ArrayOf<CoverageRangeRecord>
409 rangeRecord; /* Array of glyph ranges--ordered by
410 * Start GlyphID. rangeCount entries
413 ASSERT_SIZE (CoverageFormat2, 4);
417 inline unsigned int operator() (hb_codepoint_t glyph_id) const { return get_coverage (glyph_id); }
419 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
422 case 1: return u.format1->get_coverage(glyph_id);
423 case 2: return u.format2->get_coverage(glyph_id);
424 default:return NOT_COVERED;
428 inline bool sanitize (SANITIZE_ARG_DEF) {
430 if (!SANITIZE (u.format)) return false;
432 case 1: return u.format1->sanitize (SANITIZE_ARG);
433 case 2: return u.format2->sanitize (SANITIZE_ARG);
440 USHORT format; /* Format identifier */
441 CoverageFormat1 format1[];
442 CoverageFormat2 format2[];
445 ASSERT_SIZE (Coverage, 2);
449 * Class Definition Table
452 struct ClassDefFormat1
454 friend struct ClassDef;
457 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
459 if ((unsigned int) (glyph_id - startGlyph) < classValue.len)
460 return classValue[glyph_id - startGlyph];
464 inline bool sanitize (SANITIZE_ARG_DEF) {
466 return SANITIZE_SELF () && SANITIZE (classValue);
469 USHORT classFormat; /* Format identifier--format = 1 */
470 GlyphID startGlyph; /* First GlyphID of the classValueArray */
472 classValue; /* Array of Class Values--one per GlyphID */
474 ASSERT_SIZE (ClassDefFormat1, 6);
476 struct ClassRangeRecord
478 friend struct ClassDefFormat2;
481 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
483 if (glyph_id >= start && glyph_id <= end)
489 inline bool sanitize (SANITIZE_ARG_DEF) {
491 return SANITIZE_SELF ();
495 GlyphID start; /* First GlyphID in the range */
496 GlyphID end; /* Last GlyphID in the range */
497 USHORT classValue; /* Applied to all glyphs in the range */
499 ASSERT_SIZE_DATA (ClassRangeRecord, 6, "\000\001");
501 struct ClassDefFormat2
503 friend struct ClassDef;
506 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
509 unsigned int count = rangeRecord.len;
510 for (unsigned int i = 0; i < count; i++)
512 int classValue = rangeRecord[i].get_class (glyph_id);
519 inline bool sanitize (SANITIZE_ARG_DEF) {
521 return SANITIZE (rangeRecord);
524 USHORT classFormat; /* Format identifier--format = 2 */
525 ArrayOf<ClassRangeRecord>
526 rangeRecord; /* Array of glyph ranges--ordered by
529 ASSERT_SIZE (ClassDefFormat2, 4);
533 inline unsigned int operator() (hb_codepoint_t glyph_id) const { return get_class (glyph_id); }
535 inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
538 case 1: return u.format1->get_class(glyph_id);
539 case 2: return u.format2->get_class(glyph_id);
544 inline bool sanitize (SANITIZE_ARG_DEF) {
546 if (!SANITIZE (u.format)) return false;
548 case 1: return u.format1->sanitize (SANITIZE_ARG);
549 case 2: return u.format2->sanitize (SANITIZE_ARG);
556 USHORT format; /* Format identifier */
557 ClassDefFormat1 format1[];
558 ClassDefFormat2 format2[];
561 ASSERT_SIZE (ClassDef, 2);
570 inline int operator() (unsigned int ppem_size) const { return get_delta (ppem_size); }
572 inline int get_delta (unsigned int ppem_size) const
574 unsigned int f = deltaFormat;
575 if (HB_UNLIKELY (f < 1 || f > 3))
578 if (ppem_size < startSize || ppem_size > endSize)
581 unsigned int s = ppem_size - startSize;
583 unsigned int byte = deltaValue[s >> (4 - f)];
584 unsigned int bits = (byte >> (16 - (((s & ((1 << (4 - f)) - 1)) + 1) << f)));
585 unsigned int mask = (0xFFFF >> (16 - (1 << f)));
587 int delta = bits & mask;
589 if ((unsigned int) delta >= ((mask + 1) >> 1))
595 inline unsigned int get_size () const
597 unsigned int f = deltaFormat;
598 if (HB_UNLIKELY (f < 1 || f > 3 || startSize > endSize)) return sizeof (*this);
599 return sizeof (*this) + ((endSize - startSize + (1 << (4 - f)) - 1) >> (4 - f));
602 inline bool sanitize (SANITIZE_ARG_DEF) {
604 return SANITIZE_GET_SIZE ();
608 USHORT startSize; /* Smallest size to correct--in ppem */
609 USHORT endSize; /* Largest size to correct--in ppem */
610 USHORT deltaFormat; /* Format of DeltaValue array data: 1, 2, or 3 */
611 USHORT deltaValue[]; /* Array of compressed data */
613 ASSERT_SIZE (Device, 6);
616 #endif /* HB_OT_LAYOUT_COMMON_PRIVATE_HH */