/* * Copyright © 2007,2008,2009 Red Hat, Inc. * Copyright © 2010,2012 Google, Inc. * * This is part of HarfBuzz, a text shaping library. * * Permission is hereby granted, without written agreement and without * license or royalty fees, to use, copy, modify, and distribute this * software and its documentation for any purpose, provided that the * above copyright notice and the following two paragraphs appear in * all copies of this software. * * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH * DAMAGE. * * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. * * Red Hat Author(s): Behdad Esfahbod * Google Author(s): Behdad Esfahbod */ #ifndef HB_OT_LAYOUT_COMMON_HH #define HB_OT_LAYOUT_COMMON_HH #include "hb.hh" #include "hb-ot-layout.hh" #include "hb-open-type.hh" #include "hb-set.hh" #include "hb-bimap.hh" #ifndef HB_MAX_NESTING_LEVEL #define HB_MAX_NESTING_LEVEL 6 #endif #ifndef HB_MAX_CONTEXT_LENGTH #define HB_MAX_CONTEXT_LENGTH 64 #endif #ifndef HB_CLOSURE_MAX_STAGES /* * The maximum number of times a lookup can be applied during shaping. * Used to limit the number of iterations of the closure algorithm. * This must be larger than the number of times add_pause() is * called in a collect_features call of any shaper. */ #define HB_CLOSURE_MAX_STAGES 32 #endif #ifndef HB_MAX_SCRIPTS #define HB_MAX_SCRIPTS 500 #endif #ifndef HB_MAX_LANGSYS #define HB_MAX_LANGSYS 2000 #endif #ifndef HB_MAX_FEATURES #define HB_MAX_FEATURES 750 #endif #ifndef HB_MAX_FEATURE_INDICES #define HB_MAX_FEATURE_INDICES 1500 #endif #ifndef HB_MAX_LOOKUP_INDICES #define HB_MAX_LOOKUP_INDICES 20000 #endif namespace OT { #define NOT_COVERED ((unsigned int) -1) template static inline void Coverage_serialize (hb_serialize_context_t *c, Iterator it); template static inline void ClassDef_serialize (hb_serialize_context_t *c, Iterator it); static void ClassDef_remap_and_serialize (hb_serialize_context_t *c, const hb_set_t &glyphset, const hb_map_t &gid_klass_map, hb_sorted_vector_t &glyphs, const hb_set_t &klasses, hb_map_t *klass_map /*INOUT*/); struct hb_subset_layout_context_t : hb_dispatch_context_t { const char *get_name () { return "SUBSET_LAYOUT"; } static return_t default_return_value () { return hb_empty_t (); } bool visitScript () { return script_count++ < HB_MAX_SCRIPTS; } bool visitLangSys () { return langsys_count++ < HB_MAX_LANGSYS; } bool visitFeatureIndex (int count) { feature_index_count += count; return feature_index_count < HB_MAX_FEATURE_INDICES; } bool visitLookupIndex() { lookup_index_count++; return lookup_index_count < HB_MAX_LOOKUP_INDICES; } hb_subset_context_t *subset_context; const hb_tag_t table_tag; const hb_map_t *lookup_index_map; const hb_map_t *feature_index_map; hb_subset_layout_context_t (hb_subset_context_t *c_, hb_tag_t tag_, hb_map_t *lookup_map_, hb_map_t *feature_map_) : subset_context (c_), table_tag (tag_), lookup_index_map (lookup_map_), feature_index_map (feature_map_), script_count (0), langsys_count (0), feature_index_count (0), lookup_index_count (0) {} private: unsigned script_count; unsigned langsys_count; unsigned feature_index_count; unsigned lookup_index_count; }; struct hb_collect_variation_indices_context_t : hb_dispatch_context_t { template return_t dispatch (const T &obj) { obj.collect_variation_indices (this); return hb_empty_t (); } static return_t default_return_value () { return hb_empty_t (); } hb_set_t *layout_variation_indices; const hb_set_t *glyph_set; const hb_map_t *gpos_lookups; hb_collect_variation_indices_context_t (hb_set_t *layout_variation_indices_, const hb_set_t *glyph_set_, const hb_map_t *gpos_lookups_) : layout_variation_indices (layout_variation_indices_), glyph_set (glyph_set_), gpos_lookups (gpos_lookups_) {} }; template struct subset_offset_array_t { subset_offset_array_t (hb_subset_context_t *subset_context_, OutputArray& out_, const void *base_) : subset_context (subset_context_), out (out_), base (base_) {} template bool operator () (T&& offset) { auto *o = out.serialize_append (subset_context->serializer); if (unlikely (!o)) return false; auto snap = subset_context->serializer->snapshot (); bool ret = o->serialize_subset (subset_context, offset, base); if (!ret) { out.pop (); subset_context->serializer->revert (snap); } return ret; } private: hb_subset_context_t *subset_context; OutputArray &out; const void *base; }; template struct subset_offset_array_arg_t { subset_offset_array_arg_t (hb_subset_context_t *subset_context_, OutputArray& out_, const void *base_, Arg &&arg_) : subset_context (subset_context_), out (out_), base (base_), arg (arg_) {} template bool operator () (T&& offset) { auto *o = out.serialize_append (subset_context->serializer); if (unlikely (!o)) return false; auto snap = subset_context->serializer->snapshot (); bool ret = o->serialize_subset (subset_context, offset, base, arg); if (!ret) { out.pop (); subset_context->serializer->revert (snap); } return ret; } private: hb_subset_context_t *subset_context; OutputArray &out; const void *base; Arg &&arg; }; /* * Helper to subset an array of offsets. Subsets the thing pointed to by each offset * and discards the offset in the array if the subset operation results in an empty * thing. */ struct { template subset_offset_array_t operator () (hb_subset_context_t *subset_context, OutputArray& out, const void *base) const { return subset_offset_array_t (subset_context, out, base); } /* Variant with one extra argument passed to serialize_subset */ template subset_offset_array_arg_t operator () (hb_subset_context_t *subset_context, OutputArray& out, const void *base, Arg &&arg) const { return subset_offset_array_arg_t (subset_context, out, base, arg); } } HB_FUNCOBJ (subset_offset_array); template struct subset_record_array_t { subset_record_array_t (hb_subset_layout_context_t *c_, OutputArray* out_, const void *base_) : subset_layout_context (c_), out (out_), base (base_) {} template void operator () (T&& record) { auto snap = subset_layout_context->subset_context->serializer->snapshot (); bool ret = record.subset (subset_layout_context, base); if (!ret) subset_layout_context->subset_context->serializer->revert (snap); else out->len++; } private: hb_subset_layout_context_t *subset_layout_context; OutputArray *out; const void *base; }; /* * Helper to subset a RecordList/record array. Subsets each Record in the array and * discards the record if the subset operation returns false. */ struct { template subset_record_array_t operator () (hb_subset_layout_context_t *c, OutputArray* out, const void *base) const { return subset_record_array_t (c, out, base); } } HB_FUNCOBJ (subset_record_array); /* * * OpenType Layout Common Table Formats * */ /* * Script, ScriptList, LangSys, Feature, FeatureList, Lookup, LookupList */ struct Record_sanitize_closure_t { hb_tag_t tag; const void *list_base; }; template struct Record { int cmp (hb_tag_t a) const { return tag.cmp (a); } bool subset (hb_subset_layout_context_t *c, const void *base) const { TRACE_SUBSET (this); auto *out = c->subset_context->serializer->embed (this); if (unlikely (!out)) return_trace (false); bool ret = out->offset.serialize_subset (c->subset_context, offset, base, c, &tag); return_trace (ret); } bool sanitize (hb_sanitize_context_t *c, const void *base) const { TRACE_SANITIZE (this); const Record_sanitize_closure_t closure = {tag, base}; return_trace (c->check_struct (this) && offset.sanitize (c, base, &closure)); } Tag tag; /* 4-byte Tag identifier */ OffsetTo offset; /* Offset from beginning of object holding * the Record */ public: DEFINE_SIZE_STATIC (6); }; template struct RecordArrayOf : SortedArrayOf> { const OffsetTo& get_offset (unsigned int i) const { return (*this)[i].offset; } OffsetTo& get_offset (unsigned int i) { return (*this)[i].offset; } const Tag& get_tag (unsigned int i) const { return (*this)[i].tag; } unsigned int get_tags (unsigned int start_offset, unsigned int *record_count /* IN/OUT */, hb_tag_t *record_tags /* OUT */) const { if (record_count) { + this->sub_array (start_offset, record_count) | hb_map (&Record::tag) | hb_sink (hb_array (record_tags, *record_count)) ; } return this->len; } bool find_index (hb_tag_t tag, unsigned int *index) const { return this->bfind (tag, index, HB_BFIND_NOT_FOUND_STORE, Index::NOT_FOUND_INDEX); } }; template struct RecordListOf : RecordArrayOf { const Type& operator [] (unsigned int i) const { return this+this->get_offset (i); } bool subset (hb_subset_context_t *c, hb_subset_layout_context_t *l) const { TRACE_SUBSET (this); auto *out = c->serializer->start_embed (*this); if (unlikely (!c->serializer->extend_min (out))) return_trace (false); + this->iter () | hb_apply (subset_record_array (l, out, this)) ; return_trace (true); } bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (RecordArrayOf::sanitize (c, this)); } }; struct Feature; struct RecordListOfFeature : RecordListOf { bool subset (hb_subset_context_t *c, hb_subset_layout_context_t *l) const { TRACE_SUBSET (this); auto *out = c->serializer->start_embed (*this); if (unlikely (!out || !c->serializer->extend_min (out))) return_trace (false); unsigned count = this->len; + hb_zip (*this, hb_range (count)) | hb_filter (l->feature_index_map, hb_second) | hb_map (hb_first) | hb_apply (subset_record_array (l, out, this)) ; return_trace (true); } }; struct RangeRecord { int cmp (hb_codepoint_t g) const { return g < first ? -1 : g <= last ? 0 : +1; } bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this)); } bool intersects (const hb_set_t *glyphs) const { return glyphs->intersects (first, last); } template bool collect_coverage (set_t *glyphs) const { return glyphs->add_range (first, last); } HBGlyphID first; /* First GlyphID in the range */ HBGlyphID last; /* Last GlyphID in the range */ HBUINT16 value; /* Value */ public: DEFINE_SIZE_STATIC (6); }; DECLARE_NULL_NAMESPACE_BYTES (OT, RangeRecord); struct IndexArray : ArrayOf { bool intersects (const hb_map_t *indexes) const { return hb_any (*this, indexes); } template void serialize (hb_serialize_context_t *c, hb_subset_layout_context_t *l, Iterator it) { if (!it) return; if (unlikely (!c->extend_min ((*this)))) return; for (const auto _ : it) { if (!l->visitLookupIndex()) break; Index i; i = _; c->copy (i); this->len++; } } unsigned int get_indexes (unsigned int start_offset, unsigned int *_count /* IN/OUT */, unsigned int *_indexes /* OUT */) const { if (_count) { + this->sub_array (start_offset, _count) | hb_sink (hb_array (_indexes, *_count)) ; } return this->len; } void add_indexes_to (hb_set_t* output /* OUT */) const { output->add_array (arrayZ, len); } }; struct LangSys { unsigned int get_feature_count () const { return featureIndex.len; } hb_tag_t get_feature_index (unsigned int i) const { return featureIndex[i]; } unsigned int get_feature_indexes (unsigned int start_offset, unsigned int *feature_count /* IN/OUT */, unsigned int *feature_indexes /* OUT */) const { return featureIndex.get_indexes (start_offset, feature_count, feature_indexes); } void add_feature_indexes_to (hb_set_t *feature_indexes) const { featureIndex.add_indexes_to (feature_indexes); } bool has_required_feature () const { return reqFeatureIndex != 0xFFFFu; } unsigned int get_required_feature_index () const { if (reqFeatureIndex == 0xFFFFu) return Index::NOT_FOUND_INDEX; return reqFeatureIndex; } LangSys* copy (hb_serialize_context_t *c) const { TRACE_SERIALIZE (this); return_trace (c->embed (*this)); } bool operator == (const LangSys& o) const { if (featureIndex.len != o.featureIndex.len || reqFeatureIndex != o.reqFeatureIndex) return false; for (const auto _ : + hb_zip (featureIndex, o.featureIndex)) if (_.first != _.second) return false; return true; } bool subset (hb_subset_context_t *c, hb_subset_layout_context_t *l, const Tag *tag = nullptr) const { TRACE_SUBSET (this); auto *out = c->serializer->start_embed (*this); if (unlikely (!out || !c->serializer->extend_min (out))) return_trace (false); out->reqFeatureIndex = l->feature_index_map->has (reqFeatureIndex) ? l->feature_index_map->get (reqFeatureIndex) : 0xFFFFu; if (!l->visitFeatureIndex (featureIndex.len)) return_trace (false); auto it = + hb_iter (featureIndex) | hb_filter (l->feature_index_map) | hb_map (l->feature_index_map) ; bool ret = bool (it); out->featureIndex.serialize (c->serializer, l, it); return_trace (ret); } bool sanitize (hb_sanitize_context_t *c, const Record_sanitize_closure_t * = nullptr) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && featureIndex.sanitize (c)); } Offset16 lookupOrderZ; /* = Null (reserved for an offset to a * reordering table) */ HBUINT16 reqFeatureIndex;/* Index of a feature required for this * language system--if no required features * = 0xFFFFu */ IndexArray featureIndex; /* Array of indices into the FeatureList */ public: DEFINE_SIZE_ARRAY_SIZED (6, featureIndex); }; DECLARE_NULL_NAMESPACE_BYTES (OT, LangSys); struct Script { unsigned int get_lang_sys_count () const { return langSys.len; } const Tag& get_lang_sys_tag (unsigned int i) const { return langSys.get_tag (i); } unsigned int get_lang_sys_tags (unsigned int start_offset, unsigned int *lang_sys_count /* IN/OUT */, hb_tag_t *lang_sys_tags /* OUT */) const { return langSys.get_tags (start_offset, lang_sys_count, lang_sys_tags); } const LangSys& get_lang_sys (unsigned int i) const { if (i == Index::NOT_FOUND_INDEX) return get_default_lang_sys (); return this+langSys[i].offset; } bool find_lang_sys_index (hb_tag_t tag, unsigned int *index) const { return langSys.find_index (tag, index); } bool has_default_lang_sys () const { return defaultLangSys != 0; } const LangSys& get_default_lang_sys () const { return this+defaultLangSys; } bool subset (hb_subset_context_t *c, hb_subset_layout_context_t *l, const Tag *tag) const { TRACE_SUBSET (this); if (!l->visitScript ()) return_trace (false); auto *out = c->serializer->start_embed (*this); if (unlikely (!out || !c->serializer->extend_min (out))) return_trace (false); bool defaultLang = false; if (has_default_lang_sys ()) { c->serializer->push (); const LangSys& ls = this+defaultLangSys; bool ret = ls.subset (c, l); if (!ret && tag && *tag != HB_TAG ('D', 'F', 'L', 'T')) { c->serializer->pop_discard (); out->defaultLangSys = 0; } else { c->serializer->add_link (out->defaultLangSys, c->serializer->pop_pack ()); defaultLang = true; } } + langSys.iter () | hb_filter ([=] (const Record& record) {return l->visitLangSys (); }) | hb_filter ([&] (const Record& record) { const LangSys& d = this+defaultLangSys; const LangSys& l = this+record.offset; return !(l == d); }) | hb_apply (subset_record_array (l, &(out->langSys), this)) ; return_trace (bool (out->langSys.len) || defaultLang || l->table_tag == HB_OT_TAG_GSUB); } bool sanitize (hb_sanitize_context_t *c, const Record_sanitize_closure_t * = nullptr) const { TRACE_SANITIZE (this); return_trace (defaultLangSys.sanitize (c, this) && langSys.sanitize (c, this)); } protected: OffsetTo defaultLangSys; /* Offset to DefaultLangSys table--from * beginning of Script table--may be Null */ RecordArrayOf langSys; /* Array of LangSysRecords--listed * alphabetically by LangSysTag */ public: DEFINE_SIZE_ARRAY_SIZED (4, langSys); }; typedef RecordListOf