2 * Copyright © 2007,2008,2009 Red Hat, Inc.
3 * Copyright © 2010,2012 Google, Inc.
5 * This is part of HarfBuzz, a text shaping library.
7 * Permission is hereby granted, without written agreement and without
8 * license or royalty fees, to use, copy, modify, and distribute this
9 * software and its documentation for any purpose, provided that the
10 * above copyright notice and the following two paragraphs appear in
11 * all copies of this software.
13 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
14 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
15 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
16 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
19 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
20 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
21 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
22 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
23 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
25 * Red Hat Author(s): Behdad Esfahbod
26 * Google Author(s): Behdad Esfahbod
29 #ifndef HB_OT_LAYOUT_COMMON_PRIVATE_HH
30 #define HB_OT_LAYOUT_COMMON_PRIVATE_HH
32 #include "hb-ot-layout-private.hh"
33 #include "hb-open-type-private.hh"
34 #include "hb-set-private.hh"
37 #ifndef HB_MAX_NESTING_LEVEL
38 #define HB_MAX_NESTING_LEVEL 6
40 #ifndef HB_MAX_CONTEXT_LENGTH
41 #define HB_MAX_CONTEXT_LENGTH 64
48 #define TRACE_DISPATCH(this, format) \
49 hb_auto_trace_t<context_t::max_debug_depth, typename context_t::return_t> trace \
50 (&c->debug_depth, c->get_name (), this, HB_FUNC, \
51 "format %d", (int) format);
54 #define NOT_COVERED ((unsigned int) -1)
60 * OpenType Layout Common Table Formats
66 * Script, ScriptList, LangSys, Feature, FeatureList, Lookup, LookupList
69 template <typename Type>
72 inline int cmp (hb_tag_t a) const {
76 struct sanitize_closure_t {
78 const void *list_base;
80 inline bool sanitize (hb_sanitize_context_t *c, const void *base) const
82 TRACE_SANITIZE (this);
83 const sanitize_closure_t closure = {tag, base};
84 return_trace (c->check_struct (this) && offset.sanitize (c, base, &closure));
87 Tag tag; /* 4-byte Tag identifier */
89 offset; /* Offset from beginning of object holding
92 DEFINE_SIZE_STATIC (6);
95 template <typename Type>
96 struct RecordArrayOf : SortedArrayOf<Record<Type> > {
97 inline const Tag& get_tag (unsigned int i) const
99 /* We cheat slightly and don't define separate Null objects
100 * for Record types. Instead, we return the correct Null(Tag)
102 if (unlikely (i >= this->len)) return Null(Tag);
103 return (*this)[i].tag;
105 inline unsigned int get_tags (unsigned int start_offset,
106 unsigned int *record_count /* IN/OUT */,
107 hb_tag_t *record_tags /* OUT */) const
110 const Record<Type> *arr = this->sub_array (start_offset, record_count);
111 unsigned int count = *record_count;
112 for (unsigned int i = 0; i < count; i++)
113 record_tags[i] = arr[i].tag;
117 inline bool find_index (hb_tag_t tag, unsigned int *index) const
119 /* If we want to allow non-sorted data, we can lsearch(). */
120 int i = this->/*lsearch*/bsearch (tag);
122 if (index) *index = i;
125 if (index) *index = Index::NOT_FOUND_INDEX;
131 template <typename Type>
132 struct RecordListOf : RecordArrayOf<Type>
134 inline const Type& operator [] (unsigned int i) const
135 { return this+RecordArrayOf<Type>::operator [](i).offset; }
137 inline bool sanitize (hb_sanitize_context_t *c) const
139 TRACE_SANITIZE (this);
140 return_trace (RecordArrayOf<Type>::sanitize (c, this));
147 inline int cmp (hb_codepoint_t g) const {
148 return g < start ? -1 : g <= end ? 0 : +1 ;
151 inline bool sanitize (hb_sanitize_context_t *c) const
153 TRACE_SANITIZE (this);
154 return_trace (c->check_struct (this));
157 inline bool intersects (const hb_set_t *glyphs) const {
158 return glyphs->intersects (start, end);
161 template <typename set_t>
162 inline void add_coverage (set_t *glyphs) const {
163 glyphs->add_range (start, end);
166 GlyphID start; /* First GlyphID in the range */
167 GlyphID end; /* Last GlyphID in the range */
168 USHORT value; /* Value */
170 DEFINE_SIZE_STATIC (6);
172 DEFINE_NULL_DATA (RangeRecord, "\000\001");
175 struct IndexArray : ArrayOf<Index>
177 inline unsigned int get_indexes (unsigned int start_offset,
178 unsigned int *_count /* IN/OUT */,
179 unsigned int *_indexes /* OUT */) const
182 const USHORT *arr = this->sub_array (start_offset, _count);
183 unsigned int count = *_count;
184 for (unsigned int i = 0; i < count; i++)
185 _indexes[i] = arr[i];
199 inline unsigned int get_feature_count (void) const
200 { return featureIndex.len; }
201 inline hb_tag_t get_feature_index (unsigned int i) const
202 { return featureIndex[i]; }
203 inline unsigned int get_feature_indexes (unsigned int start_offset,
204 unsigned int *feature_count /* IN/OUT */,
205 unsigned int *feature_indexes /* OUT */) const
206 { return featureIndex.get_indexes (start_offset, feature_count, feature_indexes); }
208 inline bool has_required_feature (void) const { return reqFeatureIndex != 0xFFFFu; }
209 inline unsigned int get_required_feature_index (void) const
211 if (reqFeatureIndex == 0xFFFFu)
212 return Index::NOT_FOUND_INDEX;
213 return reqFeatureIndex;;
216 inline bool sanitize (hb_sanitize_context_t *c,
217 const Record<LangSys>::sanitize_closure_t * = NULL) const
219 TRACE_SANITIZE (this);
220 return_trace (c->check_struct (this) && featureIndex.sanitize (c));
223 Offset<> lookupOrderZ; /* = Null (reserved for an offset to a
224 * reordering table) */
225 USHORT reqFeatureIndex;/* Index of a feature required for this
226 * language system--if no required features
228 IndexArray featureIndex; /* Array of indices into the FeatureList */
230 DEFINE_SIZE_ARRAY (6, featureIndex);
232 DEFINE_NULL_DATA (LangSys, "\0\0\xFF\xFF");
237 inline unsigned int get_lang_sys_count (void) const
238 { return langSys.len; }
239 inline const Tag& get_lang_sys_tag (unsigned int i) const
240 { return langSys.get_tag (i); }
241 inline unsigned int get_lang_sys_tags (unsigned int start_offset,
242 unsigned int *lang_sys_count /* IN/OUT */,
243 hb_tag_t *lang_sys_tags /* OUT */) const
244 { return langSys.get_tags (start_offset, lang_sys_count, lang_sys_tags); }
245 inline const LangSys& get_lang_sys (unsigned int i) const
247 if (i == Index::NOT_FOUND_INDEX) return get_default_lang_sys ();
248 return this+langSys[i].offset;
250 inline bool find_lang_sys_index (hb_tag_t tag, unsigned int *index) const
251 { return langSys.find_index (tag, index); }
253 inline bool has_default_lang_sys (void) const { return defaultLangSys != 0; }
254 inline const LangSys& get_default_lang_sys (void) const { return this+defaultLangSys; }
256 inline bool sanitize (hb_sanitize_context_t *c,
257 const Record<Script>::sanitize_closure_t * = NULL) const
259 TRACE_SANITIZE (this);
260 return_trace (defaultLangSys.sanitize (c, this) && langSys.sanitize (c, this));
265 defaultLangSys; /* Offset to DefaultLangSys table--from
266 * beginning of Script table--may be Null */
267 RecordArrayOf<LangSys>
268 langSys; /* Array of LangSysRecords--listed
269 * alphabetically by LangSysTag */
271 DEFINE_SIZE_ARRAY (4, langSys);
274 typedef RecordListOf<Script> ScriptList;
277 /* http://www.microsoft.com/typography/otspec/features_pt.htm#size */
278 struct FeatureParamsSize
280 inline bool sanitize (hb_sanitize_context_t *c) const
282 TRACE_SANITIZE (this);
283 if (unlikely (!c->check_struct (this))) return_trace (false);
285 /* This subtable has some "history", if you will. Some earlier versions of
286 * Adobe tools calculated the offset of the FeatureParams sutable from the
287 * beginning of the FeatureList table! Now, that is dealt with in the
288 * Feature implementation. But we still need to be able to tell junk from
289 * real data. Note: We don't check that the nameID actually exists.
291 * Read Roberts wrote on 9/15/06 on opentype-list@indx.co.uk :
293 * Yes, it is correct that a new version of the AFDKO (version 2.0) will be
294 * coming out soon, and that the makeotf program will build a font with a
295 * 'size' feature that is correct by the specification.
297 * The specification for this feature tag is in the "OpenType Layout Tag
298 * Registry". You can see a copy of this at:
299 * http://partners.adobe.com/public/developer/opentype/index_tag8.html#size
301 * Here is one set of rules to determine if the 'size' feature is built
302 * correctly, or as by the older versions of MakeOTF. You may be able to do
305 * Assume that the offset to the size feature is according to specification,
306 * and make the following value checks. If it fails, assume the the size
307 * feature is calculated as versions of MakeOTF before the AFDKO 2.0 built it.
308 * If this fails, reject the 'size' feature. The older makeOTF's calculated the
309 * offset from the beginning of the FeatureList table, rather than from the
310 * beginning of the 'size' Feature table.
312 * If "design size" == 0:
315 * Else if ("subfamily identifier" == 0 and
316 * "range start" == 0 and
317 * "range end" == 0 and
318 * "range start" == 0 and
319 * "menu name ID" == 0)
320 * passes check: this is the format used when there is a design size
321 * specified, but there is no recommended size range.
323 * Else if ("design size" < "range start" or
324 * "design size" > "range end" or
325 * "range end" <= "range start" or
326 * "menu name ID" < 256 or
327 * "menu name ID" > 32767 or
328 * menu name ID is not a name ID which is actually in the name table)
335 return_trace (false);
336 else if (subfamilyID == 0 &&
337 subfamilyNameID == 0 &&
341 else if (designSize < rangeStart ||
342 designSize > rangeEnd ||
343 subfamilyNameID < 256 ||
344 subfamilyNameID > 32767)
345 return_trace (false);
350 USHORT designSize; /* Represents the design size in 720/inch
351 * units (decipoints). The design size entry
352 * must be non-zero. When there is a design
353 * size but no recommended size range, the
354 * rest of the array will consist of zeros. */
355 USHORT subfamilyID; /* Has no independent meaning, but serves
356 * as an identifier that associates fonts
357 * in a subfamily. All fonts which share a
358 * Preferred or Font Family name and which
359 * differ only by size range shall have the
360 * same subfamily value, and no fonts which
361 * differ in weight or style shall have the
362 * same subfamily value. If this value is
363 * zero, the remaining fields in the array
364 * will be ignored. */
365 USHORT subfamilyNameID;/* If the preceding value is non-zero, this
366 * value must be set in the range 256 - 32767
367 * (inclusive). It records the value of a
368 * field in the name table, which must
369 * contain English-language strings encoded
370 * in Windows Unicode and Macintosh Roman,
371 * and may contain additional strings
372 * localized to other scripts and languages.
373 * Each of these strings is the name an
374 * application should use, in combination
375 * with the family name, to represent the
376 * subfamily in a menu. Applications will
377 * choose the appropriate version based on
378 * their selection criteria. */
379 USHORT rangeStart; /* Large end of the recommended usage range
380 * (inclusive), stored in 720/inch units
382 USHORT rangeEnd; /* Small end of the recommended usage range
383 (exclusive), stored in 720/inch units
386 DEFINE_SIZE_STATIC (10);
389 /* http://www.microsoft.com/typography/otspec/features_pt.htm#ssxx */
390 struct FeatureParamsStylisticSet
392 inline bool sanitize (hb_sanitize_context_t *c) const
394 TRACE_SANITIZE (this);
395 /* Right now minorVersion is at zero. Which means, any table supports
396 * the uiNameID field. */
397 return_trace (c->check_struct (this));
400 USHORT version; /* (set to 0): This corresponds to a “minor”
401 * version number. Additional data may be
402 * added to the end of this Feature Parameters
403 * table in the future. */
405 USHORT uiNameID; /* The 'name' table name ID that specifies a
406 * string (or strings, for multiple languages)
407 * for a user-interface label for this
408 * feature. The values of uiLabelNameId and
409 * sampleTextNameId are expected to be in the
410 * font-specific name ID range (256-32767),
411 * though that is not a requirement in this
412 * Feature Parameters specification. The
413 * user-interface label for the feature can
414 * be provided in multiple languages. An
415 * English string should be included as a
416 * fallback. The string should be kept to a
417 * minimal length to fit comfortably with
418 * different application interfaces. */
420 DEFINE_SIZE_STATIC (4);
423 /* http://www.microsoft.com/typography/otspec/features_ae.htm#cv01-cv99 */
424 struct FeatureParamsCharacterVariants
426 inline bool sanitize (hb_sanitize_context_t *c) const
428 TRACE_SANITIZE (this);
429 return_trace (c->check_struct (this) &&
430 characters.sanitize (c));
433 USHORT format; /* Format number is set to 0. */
434 USHORT featUILableNameID; /* The ‘name’ table name ID that
435 * specifies a string (or strings,
436 * for multiple languages) for a
437 * user-interface label for this
438 * feature. (May be NULL.) */
439 USHORT featUITooltipTextNameID;/* The ‘name’ table name ID that
440 * specifies a string (or strings,
441 * for multiple languages) that an
442 * application can use for tooltip
443 * text for this feature. (May be
445 USHORT sampleTextNameID; /* The ‘name’ table name ID that
446 * specifies sample text that
447 * illustrates the effect of this
448 * feature. (May be NULL.) */
449 USHORT numNamedParameters; /* Number of named parameters. (May
451 USHORT firstParamUILabelNameID;/* The first ‘name’ table name ID
452 * used to specify strings for
453 * user-interface labels for the
454 * feature parameters. (Must be zero
455 * if numParameters is zero.) */
457 characters; /* Array of the Unicode Scalar Value
458 * of the characters for which this
459 * feature provides glyph variants.
462 DEFINE_SIZE_ARRAY (14, characters);
467 inline bool sanitize (hb_sanitize_context_t *c, hb_tag_t tag) const
469 TRACE_SANITIZE (this);
470 if (tag == HB_TAG ('s','i','z','e'))
471 return_trace (u.size.sanitize (c));
472 if ((tag & 0xFFFF0000u) == HB_TAG ('s','s','\0','\0')) /* ssXX */
473 return_trace (u.stylisticSet.sanitize (c));
474 if ((tag & 0xFFFF0000u) == HB_TAG ('c','v','\0','\0')) /* cvXX */
475 return_trace (u.characterVariants.sanitize (c));
479 inline const FeatureParamsSize& get_size_params (hb_tag_t tag) const
481 if (tag == HB_TAG ('s','i','z','e'))
483 return Null(FeatureParamsSize);
488 FeatureParamsSize size;
489 FeatureParamsStylisticSet stylisticSet;
490 FeatureParamsCharacterVariants characterVariants;
492 DEFINE_SIZE_STATIC (17);
497 inline unsigned int get_lookup_count (void) const
498 { return lookupIndex.len; }
499 inline hb_tag_t get_lookup_index (unsigned int i) const
500 { return lookupIndex[i]; }
501 inline unsigned int get_lookup_indexes (unsigned int start_index,
502 unsigned int *lookup_count /* IN/OUT */,
503 unsigned int *lookup_tags /* OUT */) const
504 { return lookupIndex.get_indexes (start_index, lookup_count, lookup_tags); }
506 inline const FeatureParams &get_feature_params (void) const
507 { return this+featureParams; }
509 inline bool sanitize (hb_sanitize_context_t *c,
510 const Record<Feature>::sanitize_closure_t *closure = NULL) const
512 TRACE_SANITIZE (this);
513 if (unlikely (!(c->check_struct (this) && lookupIndex.sanitize (c))))
514 return_trace (false);
516 /* Some earlier versions of Adobe tools calculated the offset of the
517 * FeatureParams subtable from the beginning of the FeatureList table!
519 * If sanitizing "failed" for the FeatureParams subtable, try it with the
520 * alternative location. We would know sanitize "failed" if old value
521 * of the offset was non-zero, but it's zeroed now.
523 * Only do this for the 'size' feature, since at the time of the faulty
524 * Adobe tools, only the 'size' feature had FeatureParams defined.
527 OffsetTo<FeatureParams> orig_offset = featureParams;
528 if (unlikely (!featureParams.sanitize (c, this, closure ? closure->tag : HB_TAG_NONE)))
529 return_trace (false);
531 if (likely (orig_offset.is_null ()))
534 if (featureParams == 0 && closure &&
535 closure->tag == HB_TAG ('s','i','z','e') &&
536 closure->list_base && closure->list_base < this)
538 unsigned int new_offset_int = (unsigned int) orig_offset -
539 (((char *) this) - ((char *) closure->list_base));
541 OffsetTo<FeatureParams> new_offset;
542 /* Check that it did not overflow. */
543 new_offset.set (new_offset_int);
544 if (new_offset == new_offset_int &&
545 c->try_set (&featureParams, new_offset) &&
546 !featureParams.sanitize (c, this, closure ? closure->tag : HB_TAG_NONE))
547 return_trace (false);
549 if (c->edit_count > 1)
550 c->edit_count--; /* This was a "legitimate" edit; don't contribute to error count. */
556 OffsetTo<FeatureParams>
557 featureParams; /* Offset to Feature Parameters table (if one
558 * has been defined for the feature), relative
559 * to the beginning of the Feature Table; = Null
561 IndexArray lookupIndex; /* Array of LookupList indices */
563 DEFINE_SIZE_ARRAY (4, lookupIndex);
566 typedef RecordListOf<Feature> FeatureList;
569 struct LookupFlag : USHORT
572 RightToLeft = 0x0001u,
573 IgnoreBaseGlyphs = 0x0002u,
574 IgnoreLigatures = 0x0004u,
575 IgnoreMarks = 0x0008u,
576 IgnoreFlags = 0x000Eu,
577 UseMarkFilteringSet = 0x0010u,
579 MarkAttachmentType = 0xFF00u
582 DEFINE_SIZE_STATIC (2);
586 /* This has to be outside the namespace. */
587 HB_MARK_AS_FLAG_T (OT::LookupFlag::Flags);
592 inline unsigned int get_subtable_count (void) const { return subTable.len; }
594 template <typename SubTableType>
595 inline const SubTableType& get_subtable (unsigned int i) const
596 { return this+CastR<OffsetArrayOf<SubTableType> > (subTable)[i]; }
598 template <typename SubTableType>
599 inline const OffsetArrayOf<SubTableType>& get_subtables (void) const
600 { return CastR<OffsetArrayOf<SubTableType> > (subTable); }
601 template <typename SubTableType>
602 inline OffsetArrayOf<SubTableType>& get_subtables (void)
603 { return CastR<OffsetArrayOf<SubTableType> > (subTable); }
605 inline unsigned int get_type (void) const { return lookupType; }
607 /* lookup_props is a 32-bit integer where the lower 16-bit is LookupFlag and
608 * higher 16-bit is mark-filtering-set if the lookup uses one.
609 * Not to be confused with glyph_props which is very similar. */
610 inline uint32_t get_props (void) const
612 unsigned int flag = lookupFlag;
613 if (unlikely (flag & LookupFlag::UseMarkFilteringSet))
615 const USHORT &markFilteringSet = StructAfter<USHORT> (subTable);
616 flag += (markFilteringSet << 16);
621 template <typename SubTableType, typename context_t>
622 inline typename context_t::return_t dispatch (context_t *c) const
624 unsigned int lookup_type = get_type ();
625 TRACE_DISPATCH (this, lookup_type);
626 unsigned int count = get_subtable_count ();
627 for (unsigned int i = 0; i < count; i++) {
628 typename context_t::return_t r = get_subtable<SubTableType> (i).dispatch (c, lookup_type);
629 if (c->stop_sublookup_iteration (r))
632 return_trace (c->default_return_value ());
635 inline bool serialize (hb_serialize_context_t *c,
636 unsigned int lookup_type,
637 uint32_t lookup_props,
638 unsigned int num_subtables)
640 TRACE_SERIALIZE (this);
641 if (unlikely (!c->extend_min (*this))) return_trace (false);
642 lookupType.set (lookup_type);
643 lookupFlag.set (lookup_props & 0xFFFFu);
644 if (unlikely (!subTable.serialize (c, num_subtables))) return_trace (false);
645 if (lookupFlag & LookupFlag::UseMarkFilteringSet)
647 USHORT &markFilteringSet = StructAfter<USHORT> (subTable);
648 markFilteringSet.set (lookup_props >> 16);
653 inline bool sanitize (hb_sanitize_context_t *c) const
655 TRACE_SANITIZE (this);
656 /* Real sanitize of the subtables is done by GSUB/GPOS/... */
657 if (!(c->check_struct (this) && subTable.sanitize (c))) return_trace (false);
658 if (lookupFlag & LookupFlag::UseMarkFilteringSet)
660 const USHORT &markFilteringSet = StructAfter<USHORT> (subTable);
661 if (!markFilteringSet.sanitize (c)) return_trace (false);
667 USHORT lookupType; /* Different enumerations for GSUB and GPOS */
668 USHORT lookupFlag; /* Lookup qualifiers */
670 subTable; /* Array of SubTables */
671 USHORT markFilteringSetX[VAR]; /* Index (base 0) into GDEF mark glyph sets
672 * structure. This field is only present if bit
673 * UseMarkFilteringSet of lookup flags is set. */
675 DEFINE_SIZE_ARRAY2 (6, subTable, markFilteringSetX);
678 typedef OffsetListOf<Lookup> LookupList;
685 struct CoverageFormat1
687 friend struct Coverage;
690 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
692 int i = glyphArray.bsearch (glyph_id);
693 ASSERT_STATIC (((unsigned int) -1) == NOT_COVERED);
697 inline bool serialize (hb_serialize_context_t *c,
698 Supplier<GlyphID> &glyphs,
699 unsigned int num_glyphs)
701 TRACE_SERIALIZE (this);
702 if (unlikely (!c->extend_min (*this))) return_trace (false);
703 glyphArray.len.set (num_glyphs);
704 if (unlikely (!c->extend (glyphArray))) return_trace (false);
705 for (unsigned int i = 0; i < num_glyphs; i++)
706 glyphArray[i] = glyphs[i];
707 glyphs.advance (num_glyphs);
711 inline bool sanitize (hb_sanitize_context_t *c) const
713 TRACE_SANITIZE (this);
714 return_trace (glyphArray.sanitize (c));
717 inline bool intersects_coverage (const hb_set_t *glyphs, unsigned int index) const {
718 return glyphs->has (glyphArray[index]);
721 template <typename set_t>
722 inline void add_coverage (set_t *glyphs) const {
723 unsigned int count = glyphArray.len;
724 for (unsigned int i = 0; i < count; i++)
725 glyphs->add (glyphArray[i]);
729 /* Older compilers need this to be public. */
731 inline void init (const struct CoverageFormat1 &c_) { c = &c_; i = 0; };
732 inline bool more (void) { return i < c->glyphArray.len; }
733 inline void next (void) { i++; }
734 inline hb_codepoint_t get_glyph (void) { return c->glyphArray[i]; }
735 inline unsigned int get_coverage (void) { return i; }
738 const struct CoverageFormat1 *c;
744 USHORT coverageFormat; /* Format identifier--format = 1 */
745 SortedArrayOf<GlyphID>
746 glyphArray; /* Array of GlyphIDs--in numerical order */
748 DEFINE_SIZE_ARRAY (4, glyphArray);
751 struct CoverageFormat2
753 friend struct Coverage;
756 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
758 int i = rangeRecord.bsearch (glyph_id);
760 const RangeRecord &range = rangeRecord[i];
761 return (unsigned int) range.value + (glyph_id - range.start);
766 inline bool serialize (hb_serialize_context_t *c,
767 Supplier<GlyphID> &glyphs,
768 unsigned int num_glyphs)
770 TRACE_SERIALIZE (this);
771 if (unlikely (!c->extend_min (*this))) return_trace (false);
773 if (unlikely (!num_glyphs))
775 rangeRecord.len.set (0);
779 unsigned int num_ranges = 1;
780 for (unsigned int i = 1; i < num_glyphs; i++)
781 if (glyphs[i - 1] + 1 != glyphs[i])
783 rangeRecord.len.set (num_ranges);
784 if (unlikely (!c->extend (rangeRecord))) return_trace (false);
786 unsigned int range = 0;
787 rangeRecord[range].start = glyphs[0];
788 rangeRecord[range].value.set (0);
789 for (unsigned int i = 1; i < num_glyphs; i++)
790 if (glyphs[i - 1] + 1 != glyphs[i]) {
792 rangeRecord[range].start = glyphs[i];
793 rangeRecord[range].value.set (i);
794 rangeRecord[range].end = glyphs[i];
796 rangeRecord[range].end = glyphs[i];
798 glyphs.advance (num_glyphs);
802 inline bool sanitize (hb_sanitize_context_t *c) const
804 TRACE_SANITIZE (this);
805 return_trace (rangeRecord.sanitize (c));
808 inline bool intersects_coverage (const hb_set_t *glyphs, unsigned int index) const {
810 unsigned int count = rangeRecord.len;
811 for (i = 0; i < count; i++) {
812 const RangeRecord &range = rangeRecord[i];
813 if (range.value <= index &&
814 index < (unsigned int) range.value + (range.end - range.start) &&
815 range.intersects (glyphs))
817 else if (index < range.value)
823 template <typename set_t>
824 inline void add_coverage (set_t *glyphs) const {
825 unsigned int count = rangeRecord.len;
826 for (unsigned int i = 0; i < count; i++)
827 rangeRecord[i].add_coverage (glyphs);
831 /* Older compilers need this to be public. */
834 inline void init (const CoverageFormat2 &c_)
839 j = c->rangeRecord.len ? c_.rangeRecord[0].start : 0;
841 inline bool more (void) { return i < c->rangeRecord.len; }
842 inline void next (void)
844 if (j >= c->rangeRecord[i].end)
849 j = c->rangeRecord[i].start;
850 coverage = c->rangeRecord[i].value;
857 inline hb_codepoint_t get_glyph (void) { return j; }
858 inline unsigned int get_coverage (void) { return coverage; }
861 const struct CoverageFormat2 *c;
862 unsigned int i, j, coverage;
867 USHORT coverageFormat; /* Format identifier--format = 2 */
868 SortedArrayOf<RangeRecord>
869 rangeRecord; /* Array of glyph ranges--ordered by
870 * Start GlyphID. rangeCount entries
873 DEFINE_SIZE_ARRAY (4, rangeRecord);
878 inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
881 case 1: return u.format1.get_coverage(glyph_id);
882 case 2: return u.format2.get_coverage(glyph_id);
883 default:return NOT_COVERED;
887 inline bool serialize (hb_serialize_context_t *c,
888 Supplier<GlyphID> &glyphs,
889 unsigned int num_glyphs)
891 TRACE_SERIALIZE (this);
892 if (unlikely (!c->extend_min (*this))) return_trace (false);
893 unsigned int num_ranges = 1;
894 for (unsigned int i = 1; i < num_glyphs; i++)
895 if (glyphs[i - 1] + 1 != glyphs[i])
897 u.format.set (num_glyphs * 2 < num_ranges * 3 ? 1 : 2);
899 case 1: return_trace (u.format1.serialize (c, glyphs, num_glyphs));
900 case 2: return_trace (u.format2.serialize (c, glyphs, num_glyphs));
901 default:return_trace (false);
905 inline bool sanitize (hb_sanitize_context_t *c) const
907 TRACE_SANITIZE (this);
908 if (!u.format.sanitize (c)) return_trace (false);
910 case 1: return_trace (u.format1.sanitize (c));
911 case 2: return_trace (u.format2.sanitize (c));
912 default:return_trace (true);
916 inline bool intersects (const hb_set_t *glyphs) const {
917 /* TODO speed this up */
919 for (iter.init (*this); iter.more (); iter.next ()) {
920 if (glyphs->has (iter.get_glyph ()))
926 inline bool intersects_coverage (const hb_set_t *glyphs, unsigned int index) const {
928 case 1: return u.format1.intersects_coverage (glyphs, index);
929 case 2: return u.format2.intersects_coverage (glyphs, index);
930 default:return false;
934 template <typename set_t>
935 inline void add_coverage (set_t *glyphs) const {
937 case 1: u.format1.add_coverage (glyphs); break;
938 case 2: u.format2.add_coverage (glyphs); break;
944 Iter (void) : format (0) {};
945 inline void init (const Coverage &c_) {
946 format = c_.u.format;
948 case 1: u.format1.init (c_.u.format1); return;
949 case 2: u.format2.init (c_.u.format2); return;
953 inline bool more (void) {
955 case 1: return u.format1.more ();
956 case 2: return u.format2.more ();
957 default:return false;
960 inline void next (void) {
962 case 1: u.format1.next (); break;
963 case 2: u.format2.next (); break;
967 inline hb_codepoint_t get_glyph (void) {
969 case 1: return u.format1.get_glyph ();
970 case 2: return u.format2.get_glyph ();
974 inline unsigned int get_coverage (void) {
976 case 1: return u.format1.get_coverage ();
977 case 2: return u.format2.get_coverage ();
985 CoverageFormat1::Iter format1;
986 CoverageFormat2::Iter format2;
992 USHORT format; /* Format identifier */
993 CoverageFormat1 format1;
994 CoverageFormat2 format2;
997 DEFINE_SIZE_UNION (2, format);
1002 * Class Definition Table
1005 struct ClassDefFormat1
1007 friend struct ClassDef;
1010 inline unsigned int get_class (hb_codepoint_t glyph_id) const
1012 unsigned int i = (unsigned int) (glyph_id - startGlyph);
1013 if (unlikely (i < classValue.len))
1014 return classValue[i];
1018 inline bool sanitize (hb_sanitize_context_t *c) const
1020 TRACE_SANITIZE (this);
1021 return_trace (c->check_struct (this) && classValue.sanitize (c));
1024 template <typename set_t>
1025 inline void add_class (set_t *glyphs, unsigned int klass) const {
1026 unsigned int count = classValue.len;
1027 for (unsigned int i = 0; i < count; i++)
1028 if (classValue[i] == klass)
1029 glyphs->add (startGlyph + i);
1032 inline bool intersects_class (const hb_set_t *glyphs, unsigned int klass) const {
1033 unsigned int count = classValue.len;
1036 /* Match if there's any glyph that is not listed! */
1037 hb_codepoint_t g = -1;
1038 if (!hb_set_next (glyphs, &g))
1042 g = startGlyph + count - 1;
1043 if (hb_set_next (glyphs, &g))
1047 for (unsigned int i = 0; i < count; i++)
1048 if (classValue[i] == klass && glyphs->has (startGlyph + i))
1054 USHORT classFormat; /* Format identifier--format = 1 */
1055 GlyphID startGlyph; /* First GlyphID of the classValueArray */
1057 classValue; /* Array of Class Values--one per GlyphID */
1059 DEFINE_SIZE_ARRAY (6, classValue);
1062 struct ClassDefFormat2
1064 friend struct ClassDef;
1067 inline unsigned int get_class (hb_codepoint_t glyph_id) const
1069 int i = rangeRecord.bsearch (glyph_id);
1070 if (unlikely (i != -1))
1071 return rangeRecord[i].value;
1075 inline bool sanitize (hb_sanitize_context_t *c) const
1077 TRACE_SANITIZE (this);
1078 return_trace (rangeRecord.sanitize (c));
1081 template <typename set_t>
1082 inline void add_class (set_t *glyphs, unsigned int klass) const {
1083 unsigned int count = rangeRecord.len;
1084 for (unsigned int i = 0; i < count; i++)
1085 if (rangeRecord[i].value == klass)
1086 rangeRecord[i].add_coverage (glyphs);
1089 inline bool intersects_class (const hb_set_t *glyphs, unsigned int klass) const {
1090 unsigned int count = rangeRecord.len;
1093 /* Match if there's any glyph that is not listed! */
1094 hb_codepoint_t g = (hb_codepoint_t) -1;
1095 for (unsigned int i = 0; i < count; i++)
1097 if (!hb_set_next (glyphs, &g))
1099 if (g < rangeRecord[i].start)
1101 g = rangeRecord[i].end;
1103 if (g != (hb_codepoint_t) -1 && hb_set_next (glyphs, &g))
1107 for (unsigned int i = 0; i < count; i++)
1108 if (rangeRecord[i].value == klass && rangeRecord[i].intersects (glyphs))
1114 USHORT classFormat; /* Format identifier--format = 2 */
1115 SortedArrayOf<RangeRecord>
1116 rangeRecord; /* Array of glyph ranges--ordered by
1119 DEFINE_SIZE_ARRAY (4, rangeRecord);
1124 inline unsigned int get_class (hb_codepoint_t glyph_id) const
1127 case 1: return u.format1.get_class(glyph_id);
1128 case 2: return u.format2.get_class(glyph_id);
1133 inline bool sanitize (hb_sanitize_context_t *c) const
1135 TRACE_SANITIZE (this);
1136 if (!u.format.sanitize (c)) return_trace (false);
1138 case 1: return_trace (u.format1.sanitize (c));
1139 case 2: return_trace (u.format2.sanitize (c));
1140 default:return_trace (true);
1144 inline void add_class (hb_set_t *glyphs, unsigned int klass) const {
1146 case 1: u.format1.add_class (glyphs, klass); return;
1147 case 2: u.format2.add_class (glyphs, klass); return;
1152 inline bool intersects_class (const hb_set_t *glyphs, unsigned int klass) const {
1154 case 1: return u.format1.intersects_class (glyphs, klass);
1155 case 2: return u.format2.intersects_class (glyphs, klass);
1156 default:return false;
1162 USHORT format; /* Format identifier */
1163 ClassDefFormat1 format1;
1164 ClassDefFormat2 format2;
1167 DEFINE_SIZE_UNION (2, format);
1172 * Item Variation Store
1175 struct VarRegionAxis
1177 inline float evaluate (int coord) const
1179 int start = startCoord, peak = peakCoord, end = endCoord;
1181 /* TODO Move these to sanitize(). */
1182 if (unlikely (start > peak || peak > end))
1184 if (unlikely (start < 0 && end > 0 && peak != 0))
1187 if (peak == 0 || coord == peak)
1190 if (coord <= start || end <= coord)
1195 return float (coord - start) / (peak - start);
1197 return float (end - coord) / (end - peak);
1200 inline bool sanitize (hb_sanitize_context_t *c) const
1202 TRACE_SANITIZE (this);
1203 return_trace (c->check_struct (this));
1204 /* TODO Handle invalid start/peak/end configs, so we don't
1205 * have to do that at runtime. */
1213 DEFINE_SIZE_STATIC (6);
1216 struct VarRegionList
1218 inline float evaluate (unsigned int region_index,
1219 int *coords, unsigned int coord_len) const
1221 if (unlikely (region_index >= regionCount))
1224 const VarRegionAxis *axes = axesZ + (region_index * axisCount);
1227 unsigned int count = MIN (coord_len, (unsigned int) axisCount);
1228 for (unsigned int i = 0; i < count; i++)
1230 float factor = axes[i].evaluate (coords[i]);
1238 inline bool sanitize (hb_sanitize_context_t *c) const
1240 TRACE_SANITIZE (this);
1241 return_trace (c->check_struct (this) &&
1242 c->check_array (axesZ, axesZ[0].static_size,
1243 (unsigned int) axisCount * (unsigned int) regionCount));
1249 VarRegionAxis axesZ[VAR];
1251 DEFINE_SIZE_ARRAY (4, axesZ);
1256 inline unsigned int get_row_size (void) const
1257 { return shortCount + regionIndices.len; }
1259 inline unsigned int get_size (void) const
1260 { return itemCount * get_row_size (); }
1262 inline float get_delta (unsigned int inner,
1263 int *coords, unsigned int coord_count,
1264 const VarRegionList ®ions) const
1266 if (unlikely (inner >= itemCount))
1269 unsigned int count = regionIndices.len;
1270 unsigned int scount = shortCount;
1272 const BYTE *bytes = &StructAfter<BYTE> (regionIndices);
1273 const BYTE *row = bytes + inner * (scount + count);
1278 const SHORT *scursor = reinterpret_cast<const SHORT *> (row);
1279 for (; i < scount; i++)
1281 float scalar = regions.evaluate (regionIndices.array[i], coords, coord_count);
1282 delta += scalar * *scursor++;
1284 const INT8 *bcursor = reinterpret_cast<const INT8 *> (scursor);
1285 for (; i < count; i++)
1287 float scalar = regions.evaluate (regionIndices.array[i], coords, coord_count);
1288 delta += scalar * *bcursor++;
1294 inline bool sanitize (hb_sanitize_context_t *c) const
1296 TRACE_SANITIZE (this);
1297 return_trace (c->check_struct (this) &&
1298 regionIndices.sanitize(c) &&
1299 shortCount <= regionIndices.len &&
1300 c->check_array (&StructAfter<BYTE> (regionIndices),
1301 get_row_size (), itemCount));
1307 ArrayOf<USHORT> regionIndices;
1310 DEFINE_SIZE_ARRAY2 (6, regionIndices, bytesX);
1313 struct VariationStore
1315 inline float get_delta (unsigned int outer, unsigned int inner,
1316 int *coords, unsigned int coord_count) const
1318 if (unlikely (outer >= dataSets.len))
1321 return (this+dataSets[outer]).get_delta (inner,
1322 coords, coord_count,
1326 inline float get_delta (unsigned int index,
1327 int *coords, unsigned int coord_count) const
1329 unsigned int outer = index >> 16;
1330 unsigned int inner = index & 0xFFFF;
1331 return get_delta (outer, inner, coords, coord_count);
1334 inline bool sanitize (hb_sanitize_context_t *c) const
1336 TRACE_SANITIZE (this);
1337 return_trace (c->check_struct (this) &&
1339 regions.sanitize (c, this) &&
1340 dataSets.sanitize (c, this));
1345 LOffsetTo<VarRegionList> regions;
1346 OffsetArrayOf<VarData, ULONG> dataSets;
1348 DEFINE_SIZE_ARRAY (8, dataSets);
1352 * Feature Variations
1355 struct ConditionFormat1
1357 friend struct Condition;
1360 inline bool evaluate (const int *coords, unsigned int coord_len) const
1362 int coord = axisIndex < coord_len ? coords[axisIndex] : 0;
1363 return filterRangeMinValue <= coord && coord <= filterRangeMaxValue;
1366 inline bool sanitize (hb_sanitize_context_t *c) const
1368 TRACE_SANITIZE (this);
1369 return_trace (c->check_struct (this));
1373 USHORT format; /* Format identifier--format = 1 */
1375 F2DOT14 filterRangeMinValue;
1376 F2DOT14 filterRangeMaxValue;
1378 DEFINE_SIZE_STATIC (8);
1383 inline bool evaluate (const int *coords, unsigned int coord_len) const
1386 case 1: return u.format1.evaluate (coords, coord_len);
1387 default:return false;
1391 inline bool sanitize (hb_sanitize_context_t *c) const
1393 TRACE_SANITIZE (this);
1394 if (!u.format.sanitize (c)) return_trace (false);
1396 case 1: return_trace (u.format1.sanitize (c));
1397 default:return_trace (true);
1403 USHORT format; /* Format identifier */
1404 ConditionFormat1 format1;
1407 DEFINE_SIZE_UNION (2, format);
1412 inline bool evaluate (const int *coords, unsigned int coord_len) const
1414 unsigned int count = conditions.len;
1415 for (unsigned int i = 0; i < count; i++)
1416 if (!(this+conditions.array[i]).evaluate (coords, coord_len))
1421 inline bool sanitize (hb_sanitize_context_t *c) const
1423 TRACE_SANITIZE (this);
1424 return_trace (conditions.sanitize (c, this));
1428 OffsetArrayOf<Condition, ULONG> conditions;
1430 DEFINE_SIZE_ARRAY (2, conditions);
1433 struct FeatureTableSubstitutionRecord
1435 friend struct FeatureTableSubstitution;
1437 inline bool sanitize (hb_sanitize_context_t *c, const void *base) const
1439 TRACE_SANITIZE (this);
1440 return_trace (c->check_struct (this) && feature.sanitize (c, base));
1444 USHORT featureIndex;
1445 LOffsetTo<Feature> feature;
1447 DEFINE_SIZE_STATIC (6);
1450 struct FeatureTableSubstitution
1452 inline const Feature *find_substitute (unsigned int feature_index) const
1454 unsigned int count = substitutions.len;
1455 for (unsigned int i = 0; i < count; i++)
1457 const FeatureTableSubstitutionRecord &record = substitutions.array[i];
1458 if (record.featureIndex == feature_index)
1459 return &(this+record.feature);
1464 inline bool sanitize (hb_sanitize_context_t *c) const
1466 TRACE_SANITIZE (this);
1467 return_trace (version.sanitize (c) &&
1468 likely (version.major == 1) &&
1469 substitutions.sanitize (c, this));
1473 FixedVersion<> version; /* Version--0x00010000u */
1474 ArrayOf<FeatureTableSubstitutionRecord>
1477 DEFINE_SIZE_ARRAY (6, substitutions);
1480 struct FeatureVariationRecord
1482 friend struct FeatureVariations;
1484 inline bool sanitize (hb_sanitize_context_t *c, const void *base) const
1486 TRACE_SANITIZE (this);
1487 return_trace (conditions.sanitize (c, base) &&
1488 substitutions.sanitize (c, base));
1492 LOffsetTo<ConditionSet>
1494 LOffsetTo<FeatureTableSubstitution>
1497 DEFINE_SIZE_STATIC (8);
1500 struct FeatureVariations
1502 static const unsigned int NOT_FOUND_INDEX = 0xFFFFFFFFu;
1504 inline bool find_index (const int *coords, unsigned int coord_len,
1505 unsigned int *index) const
1507 unsigned int count = varRecords.len;
1508 for (unsigned int i = 0; i < count; i++)
1510 const FeatureVariationRecord &record = varRecords.array[i];
1511 if ((this+record.conditions).evaluate (coords, coord_len))
1517 *index = NOT_FOUND_INDEX;
1521 inline const Feature *find_substitute (unsigned int variations_index,
1522 unsigned int feature_index) const
1524 const FeatureVariationRecord &record = varRecords[variations_index];
1525 return (this+record.substitutions).find_substitute (feature_index);
1528 inline bool sanitize (hb_sanitize_context_t *c) const
1530 TRACE_SANITIZE (this);
1531 return_trace (version.sanitize (c) &&
1532 likely (version.major == 1) &&
1533 varRecords.sanitize (c, this));
1537 FixedVersion<> version; /* Version--0x00010000u */
1538 LArrayOf<FeatureVariationRecord>
1541 DEFINE_SIZE_ARRAY (8, varRecords);
1549 struct HintingDevice
1551 friend struct Device;
1555 inline hb_position_t get_x_delta (hb_font_t *font) const
1556 { return get_delta (font->x_ppem, font->x_scale); }
1558 inline hb_position_t get_y_delta (hb_font_t *font) const
1559 { return get_delta (font->y_ppem, font->y_scale); }
1561 inline unsigned int get_size (void) const
1563 unsigned int f = deltaFormat;
1564 if (unlikely (f < 1 || f > 3 || startSize > endSize)) return 3 * USHORT::static_size;
1565 return USHORT::static_size * (4 + ((endSize - startSize) >> (4 - f)));
1568 inline bool sanitize (hb_sanitize_context_t *c) const
1570 TRACE_SANITIZE (this);
1571 return_trace (c->check_struct (this) && c->check_range (this, this->get_size ()));
1576 inline int get_delta (unsigned int ppem, int scale) const
1578 if (!ppem) return 0;
1580 int pixels = get_delta_pixels (ppem);
1582 if (!pixels) return 0;
1584 return (int) (pixels * (int64_t) scale / ppem);
1586 inline int get_delta_pixels (unsigned int ppem_size) const
1588 unsigned int f = deltaFormat;
1589 if (unlikely (f < 1 || f > 3))
1592 if (ppem_size < startSize || ppem_size > endSize)
1595 unsigned int s = ppem_size - startSize;
1597 unsigned int byte = deltaValue[s >> (4 - f)];
1598 unsigned int bits = (byte >> (16 - (((s & ((1 << (4 - f)) - 1)) + 1) << f)));
1599 unsigned int mask = (0xFFFFu >> (16 - (1 << f)));
1601 int delta = bits & mask;
1603 if ((unsigned int) delta >= ((mask + 1) >> 1))
1610 USHORT startSize; /* Smallest size to correct--in ppem */
1611 USHORT endSize; /* Largest size to correct--in ppem */
1612 USHORT deltaFormat; /* Format of DeltaValue array data: 1, 2, or 3
1613 * 1 Signed 2-bit value, 8 values per uint16
1614 * 2 Signed 4-bit value, 4 values per uint16
1615 * 3 Signed 8-bit value, 2 values per uint16
1617 USHORT deltaValue[VAR]; /* Array of compressed data */
1619 DEFINE_SIZE_ARRAY (6, deltaValue);
1622 struct VariationDevice
1624 friend struct Device;
1628 inline hb_position_t get_x_delta (hb_font_t *font, const VariationStore &store) const
1629 { return font->em_scalef_x (get_delta (font, store)); }
1631 inline hb_position_t get_y_delta (hb_font_t *font, const VariationStore &store) const
1632 { return font->em_scalef_y (get_delta (font, store)); }
1634 inline bool sanitize (hb_sanitize_context_t *c) const
1636 TRACE_SANITIZE (this);
1637 return_trace (c->check_struct (this));
1642 inline float get_delta (hb_font_t *font, const VariationStore &store) const
1644 return store.get_delta (outerIndex, innerIndex, font->coords, font->num_coords);
1650 USHORT deltaFormat; /* Format identifier for this table: 0x0x8000 */
1652 DEFINE_SIZE_STATIC (6);
1661 USHORT format; /* Format identifier */
1663 DEFINE_SIZE_STATIC (6);
1668 inline hb_position_t get_x_delta (hb_font_t *font, const VariationStore &store=Null(VariationStore)) const
1672 case 1: case 2: case 3:
1673 return u.hinting.get_x_delta (font);
1675 return u.variation.get_x_delta (font, store);
1680 inline hb_position_t get_y_delta (hb_font_t *font, const VariationStore &store=Null(VariationStore)) const
1684 case 1: case 2: case 3:
1685 return u.hinting.get_y_delta (font);
1687 return u.variation.get_y_delta (font, store);
1693 inline bool sanitize (hb_sanitize_context_t *c) const
1695 TRACE_SANITIZE (this);
1696 if (!u.b.format.sanitize (c)) return_trace (false);
1697 switch (u.b.format) {
1698 case 1: case 2: case 3:
1699 return_trace (u.hinting.sanitize (c));
1701 return_trace (u.variation.sanitize (c));
1703 return_trace (true);
1710 HintingDevice hinting;
1711 VariationDevice variation;
1714 DEFINE_SIZE_UNION (6, b);
1718 } /* namespace OT */
1721 #endif /* HB_OT_LAYOUT_COMMON_PRIVATE_HH */