/* * Copyright © 2016 Elie Roux * Copyright © 2018 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. * * Google Author(s): Behdad Esfahbod */ #ifndef HB_OT_LAYOUT_BASE_TABLE_HH #define HB_OT_LAYOUT_BASE_TABLE_HH #include "hb-open-type-private.hh" #include "hb-ot-layout-common-private.hh" namespace OT { #define NOT_INDEXED ((unsigned int) -1) /* * BASE -- The BASE Table */ struct BaseCoordFormat1 { inline int get_coord (void) const { return coordinate; } inline bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this)); } protected: HBUINT16 format; /* Format identifier--format = 1 */ HBINT16 coordinate; /* X or Y value, in design units */ public: DEFINE_SIZE_STATIC (4); }; struct BaseCoordFormat2 { inline int get_coord (void) const { /* TODO */ return coordinate; } inline bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this)); } protected: HBUINT16 format; /* Format identifier--format = 2 */ HBINT16 coordinate; /* X or Y value, in design units */ GlyphID referenceGlyph; /* Glyph ID of control glyph */ HBUINT16 coordPoint; /* Index of contour point on the * reference glyph */ public: DEFINE_SIZE_STATIC (8); }; struct BaseCoordFormat3 { inline int get_coord (void) const { /* TODO */ return coordinate; } inline bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && deviceTable.sanitize (c, this)); } protected: HBUINT16 format; /* Format identifier--format = 3 */ HBINT16 coordinate; /* X or Y value, in design units */ OffsetTo deviceTable; /* Offset to Device table for X or * Y value, from beginning of * BaseCoord table (may be NULL). */ public: DEFINE_SIZE_STATIC (6); }; struct BaseCoord { inline int get_coord (void) const { switch (u.format) { case 1: return u.format1.get_coord (); case 2: return u.format2.get_coord (); case 3: return u.format3.get_coord (); default:return 0; } } inline bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); if (!u.format.sanitize (c)) return_trace (false); switch (u.format) { case 1: return_trace (u.format1.sanitize (c)); case 2: return_trace (u.format2.sanitize (c)); case 3: return_trace (u.format3.sanitize (c)); default:return_trace (false); } } protected: union { HBUINT16 format; BaseCoordFormat1 format1; BaseCoordFormat2 format2; BaseCoordFormat3 format3; } u; public: DEFINE_SIZE_UNION (2, format); }; struct FeatMinMaxRecord { inline int get_min_value (void) const { return (this+minCoord).get_coord(); } inline int get_max_value (void) const { return (this+maxCoord).get_coord(); } inline const Tag &get_tag () const { return tag; } inline bool sanitize (hb_sanitize_context_t *c, const void *base) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && minCoord.sanitize (c, base) && maxCoord.sanitize (c, base)); } protected: Tag tag; /* 4-byte feature identification tag--must * match feature tag in FeatureList */ OffsetTo minCoord; /* Offset to BaseCoord table that defines * the minimum extent value, from beginning * of MinMax table (may be NULL) */ OffsetTo maxCoord; /* Offset to BaseCoord table that defines * the maximum extent value, from beginning * of MinMax table (may be NULL) */ public: DEFINE_SIZE_STATIC (8); }; struct MinMax { inline unsigned int get_feature_tag_index (Tag featureTableTag) const { /* TODO bsearch */ unsigned int count = featMinMaxRecords.len; for (unsigned int i = 0; i < count; i++) { Tag tag = featMinMaxRecords[i].get_tag(); int cmp = tag.cmp(featureTableTag); if (cmp == 0) return i; if (cmp > 0) return NOT_INDEXED; } return NOT_INDEXED; } inline int get_min_value (unsigned int featureTableTagIndex) const { if (featureTableTagIndex == NOT_INDEXED) return (this+minCoord).get_coord(); return featMinMaxRecords[featureTableTagIndex].get_min_value(); } inline int get_max_value (unsigned int featureTableTagIndex) const { if (featureTableTagIndex == NOT_INDEXED) return (this+maxCoord).get_coord(); return featMinMaxRecords[featureTableTagIndex].get_max_value(); } inline bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && minCoord.sanitize (c, this) && maxCoord.sanitize (c, this) && featMinMaxRecords.sanitize (c, this)); } protected: OffsetTo minCoord; /* Offset to BaseCoord table that defines * minimum extent value, from the beginning * of MinMax table (may be NULL) */ OffsetTo maxCoord; /* Offset to BaseCoord table that defines * maximum extent value, from the beginning * of MinMax table (may be NULL) */ ArrayOf featMinMaxRecords; /* Array of FeatMinMaxRecords, in alphabetical * order by featureTableTag */ public: DEFINE_SIZE_ARRAY (6, featMinMaxRecords); }; /* TODO... */ struct BaseLangSysRecord { inline const Tag& get_tag(void) const { return baseLangSysTag; } inline unsigned int get_feature_tag_index (Tag featureTableTag) const { return (this+minMax).get_feature_tag_index(featureTableTag); } inline int get_min_value (unsigned int featureTableTagIndex) const { return (this+minMax).get_min_value(featureTableTagIndex); } inline int get_max_value (unsigned int featureTableTagIndex) const { return (this+minMax).get_max_value(featureTableTagIndex); } inline bool sanitize (hb_sanitize_context_t *c, const void *base) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && minMax.sanitize (c, base)); } protected: Tag baseLangSysTag; OffsetTo minMax; public: DEFINE_SIZE_STATIC (6); }; struct BaseValues { inline unsigned int get_default_base_tag_index (void) const { return defaultIndex; } inline int get_base_coord (unsigned int baselineTagIndex) const { return (this+baseCoords[baselineTagIndex]).get_coord(); } inline bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && defaultIndex <= baseCoordCount && baseCoords.sanitize (c, this)); } protected: Index defaultIndex; HBUINT16 baseCoordCount; OffsetArrayOf baseCoords; public: DEFINE_SIZE_ARRAY (6, baseCoords); }; struct BaseScript { inline unsigned int get_lang_tag_index (Tag baseLangSysTag) const { Tag tag; int cmp; for (unsigned int i = 0; i < baseLangSysCount; i++) { tag = baseLangSysRecords[i].get_tag(); // taking advantage of alphabetical order cmp = tag.cmp(baseLangSysTag); if (cmp == 0) return i; if (cmp > 0) return NOT_INDEXED; } return NOT_INDEXED; } inline unsigned int get_feature_tag_index (unsigned int baseLangSysIndex, Tag featureTableTag) const { if (baseLangSysIndex == NOT_INDEXED) { if (unlikely(defaultMinMax)) return NOT_INDEXED; return (this+defaultMinMax).get_feature_tag_index(featureTableTag); } if (unlikely(baseLangSysIndex >= baseLangSysCount)) return NOT_INDEXED; return baseLangSysRecords[baseLangSysIndex].get_feature_tag_index(featureTableTag); } inline int get_min_value (unsigned int baseLangSysIndex, unsigned int featureTableTagIndex) const { if (baseLangSysIndex == NOT_INDEXED) return (this+defaultMinMax).get_min_value(featureTableTagIndex); return baseLangSysRecords[baseLangSysIndex].get_max_value(featureTableTagIndex); } inline int get_max_value (unsigned int baseLangSysIndex, unsigned int featureTableTagIndex) const { if (baseLangSysIndex == NOT_INDEXED) return (this+defaultMinMax).get_min_value(featureTableTagIndex); return baseLangSysRecords[baseLangSysIndex].get_max_value(featureTableTagIndex); } inline unsigned int get_default_base_tag_index (void) const { return (this+baseValues).get_default_base_tag_index(); } inline int get_base_coord (unsigned int baselineTagIndex) const { return (this+baseValues).get_base_coord(baselineTagIndex); } inline bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && baseValues.sanitize (c, this) && defaultMinMax.sanitize (c, this) && baseLangSysRecords.sanitize (c, this)); } protected: OffsetTo baseValues; OffsetTo defaultMinMax; HBUINT16 baseLangSysCount; ArrayOf baseLangSysRecords; public: DEFINE_SIZE_ARRAY (8, baseLangSysRecords); }; struct BaseScriptRecord { inline const Tag& get_tag (void) const { return baseScriptTag; } inline unsigned int get_default_base_tag_index(void) const { return (this+baseScript).get_default_base_tag_index(); } inline int get_base_coord(unsigned int baselineTagIndex) const { return (this+baseScript).get_base_coord(baselineTagIndex); } inline unsigned int get_lang_tag_index (Tag baseLangSysTag) const { return (this+baseScript).get_lang_tag_index(baseLangSysTag); } inline unsigned int get_feature_tag_index (unsigned int baseLangSysIndex, Tag featureTableTag) const { return (this+baseScript).get_feature_tag_index(baseLangSysIndex, featureTableTag); } inline int get_max_value (unsigned int baseLangSysIndex, unsigned int featureTableTagIndex) const { return (this+baseScript).get_max_value(baseLangSysIndex, featureTableTagIndex); } inline int get_min_value (unsigned int baseLangSysIndex, unsigned int featureTableTagIndex) const { return (this+baseScript).get_min_value(baseLangSysIndex, featureTableTagIndex); } inline bool sanitize (hb_sanitize_context_t *c, const void *base) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && baseScript != Null(OffsetTo) && baseScript.sanitize (c, base)); } protected: Tag baseScriptTag; OffsetTo baseScript; public: DEFINE_SIZE_STATIC (6); }; struct BaseScriptList { inline unsigned int get_base_script_index (Tag baseScriptTag) const { for (unsigned int i = 0; i < baseScriptCount; i++) if (baseScriptRecords[i].get_tag() == baseScriptTag) return i; return NOT_INDEXED; } inline unsigned int get_default_base_tag_index (unsigned int baseScriptIndex) const { if (unlikely(baseScriptIndex >= baseScriptCount)) return NOT_INDEXED; return baseScriptRecords[baseScriptIndex].get_default_base_tag_index(); } inline int get_base_coord(unsigned int baseScriptIndex, unsigned int baselineTagIndex) const { return baseScriptRecords[baseScriptIndex].get_base_coord(baselineTagIndex); } inline unsigned int get_lang_tag_index (unsigned int baseScriptIndex, Tag baseLangSysTag) const { if (unlikely(baseScriptIndex >= baseScriptCount)) return NOT_INDEXED; return baseScriptRecords[baseScriptIndex].get_lang_tag_index(baseLangSysTag); } inline unsigned int get_feature_tag_index (unsigned int baseScriptIndex, unsigned int baseLangSysIndex, Tag featureTableTag) const { if (unlikely(baseScriptIndex >= baseScriptCount)) return NOT_INDEXED; return baseScriptRecords[baseScriptIndex].get_feature_tag_index(baseLangSysIndex, featureTableTag); } inline int get_max_value (unsigned int baseScriptIndex, unsigned int baseLangSysIndex, unsigned int featureTableTagIndex) const { return baseScriptRecords[baseScriptIndex].get_max_value(baseLangSysIndex, featureTableTagIndex); } inline int get_min_value (unsigned int baseScriptIndex, unsigned int baseLangSysIndex, unsigned int featureTableTagIndex) const { return baseScriptRecords[baseScriptIndex].get_min_value(baseLangSysIndex, featureTableTagIndex); } inline bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && baseScriptRecords.sanitize (c, this)); } protected: HBUINT16 baseScriptCount; ArrayOf baseScriptRecords; public: DEFINE_SIZE_ARRAY (4, baseScriptRecords); }; struct BaseTagList { inline unsigned int get_tag_index(Tag baselineTag) const { for (unsigned int i = 0; i < baseTagCount; i++) if (baselineTags[i] == baselineTag) return i; return NOT_INDEXED; } inline bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this)); } protected: HBUINT16 baseTagCount; SortedArrayOf baselineTags; public: DEFINE_SIZE_ARRAY (4, baselineTags); }; struct Axis { inline unsigned int get_base_tag_index(Tag baselineTag) const { if (unlikely(baseTagList == Null(OffsetTo))) return NOT_INDEXED; return (this+baseTagList).get_tag_index(baselineTag); } inline unsigned int get_default_base_tag_index_for_script_index (unsigned int baseScriptIndex) const { if (unlikely(baseScriptList == Null(OffsetTo))) return NOT_INDEXED; return (this+baseScriptList).get_default_base_tag_index(baseScriptIndex); } inline int get_base_coord(unsigned int baseScriptIndex, unsigned int baselineTagIndex) const { return (this+baseScriptList).get_base_coord(baseScriptIndex, baselineTagIndex); } inline unsigned int get_lang_tag_index (unsigned int baseScriptIndex, Tag baseLangSysTag) const { if (unlikely(baseScriptList == Null(OffsetTo))) return NOT_INDEXED; return (this+baseScriptList).get_lang_tag_index(baseScriptIndex, baseLangSysTag); } inline unsigned int get_feature_tag_index (unsigned int baseScriptIndex, unsigned int baseLangSysIndex, Tag featureTableTag) const { if (unlikely(baseScriptList == Null(OffsetTo))) return NOT_INDEXED; return (this+baseScriptList).get_feature_tag_index(baseScriptIndex, baseLangSysIndex, featureTableTag); } inline int get_max_value (unsigned int baseScriptIndex, unsigned int baseLangSysIndex, unsigned int featureTableTagIndex) const { return (this+baseScriptList).get_max_value(baseScriptIndex, baseLangSysIndex, featureTableTagIndex); } inline int get_min_value (unsigned int baseScriptIndex, unsigned int baseLangSysIndex, unsigned int featureTableTagIndex) const { return (this+baseScriptList).get_min_value(baseScriptIndex, baseLangSysIndex, featureTableTagIndex); } inline bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && baseTagList.sanitize (c, this) && baseScriptList.sanitize (c, this)); } protected: OffsetTo baseTagList; OffsetTo baseScriptList; public: DEFINE_SIZE_STATIC (4); }; struct BASE { static const hb_tag_t tableTag = HB_OT_TAG_BASE; inline bool has_vert_axis(void) { return vertAxis != Null(OffsetTo); } inline bool has_horiz_axis(void) { return horizAxis != Null(OffsetTo); } // horizontal axis base coords: inline unsigned int get_horiz_base_tag_index(Tag baselineTag) const { if (unlikely(horizAxis == Null(OffsetTo))) return NOT_INDEXED; return (this+horizAxis).get_base_tag_index(baselineTag); } inline unsigned int get_horiz_default_base_tag_index_for_script_index (unsigned int baseScriptIndex) const { if (unlikely(horizAxis == Null(OffsetTo))) return NOT_INDEXED; return (this+horizAxis).get_default_base_tag_index_for_script_index(baseScriptIndex); } inline int get_horiz_base_coord(unsigned int baseScriptIndex, unsigned int baselineTagIndex) const { return (this+horizAxis).get_base_coord(baseScriptIndex, baselineTagIndex); } // vertical axis base coords: inline unsigned int get_vert_base_tag_index(Tag baselineTag) const { if (unlikely(vertAxis == Null(OffsetTo))) return NOT_INDEXED; return (this+vertAxis).get_base_tag_index(baselineTag); } inline unsigned int get_vert_default_base_tag_index_for_script_index (unsigned int baseScriptIndex) const { if (unlikely(vertAxis == Null(OffsetTo))) return NOT_INDEXED; return (this+vertAxis).get_default_base_tag_index_for_script_index(baseScriptIndex); } inline int get_vert_base_coord(unsigned int baseScriptIndex, unsigned int baselineTagIndex) const { return (this+vertAxis).get_base_coord(baseScriptIndex, baselineTagIndex); } // horizontal axis min/max coords: inline unsigned int get_horiz_lang_tag_index (unsigned int baseScriptIndex, Tag baseLangSysTag) const { if (unlikely(horizAxis == Null(OffsetTo))) return NOT_INDEXED; return (this+horizAxis).get_lang_tag_index (baseScriptIndex, baseLangSysTag); } inline unsigned int get_horiz_feature_tag_index (unsigned int baseScriptIndex, unsigned int baseLangSysIndex, Tag featureTableTag) const { if (unlikely(horizAxis == Null(OffsetTo))) return NOT_INDEXED; return (this+horizAxis).get_feature_tag_index (baseScriptIndex, baseLangSysIndex, featureTableTag); } inline int get_horiz_max_value (unsigned int baseScriptIndex, unsigned int baseLangSysIndex, unsigned int featureTableTagIndex) const { return (this+horizAxis).get_max_value (baseScriptIndex, baseLangSysIndex, featureTableTagIndex); } inline int get_horiz_min_value (unsigned int baseScriptIndex, unsigned int baseLangSysIndex, unsigned int featureTableTagIndex) const { return (this+horizAxis).get_min_value (baseScriptIndex, baseLangSysIndex, featureTableTagIndex); } // vertical axis min/max coords: inline unsigned int get_vert_lang_tag_index (unsigned int baseScriptIndex, Tag baseLangSysTag) const { if (unlikely(vertAxis == Null(OffsetTo))) return NOT_INDEXED; return (this+vertAxis).get_lang_tag_index (baseScriptIndex, baseLangSysTag); } inline unsigned int get_vert_feature_tag_index (unsigned int baseScriptIndex, unsigned int baseLangSysIndex, Tag featureTableTag) const { if (unlikely(vertAxis == Null(OffsetTo))) return NOT_INDEXED; return (this+vertAxis).get_feature_tag_index (baseScriptIndex, baseLangSysIndex, featureTableTag); } inline int get_vert_max_value (unsigned int baseScriptIndex, unsigned int baseLangSysIndex, unsigned int featureTableTagIndex) const { return (this+vertAxis).get_max_value (baseScriptIndex, baseLangSysIndex, featureTableTagIndex); } inline int get_vert_min_value (unsigned int baseScriptIndex, unsigned int baseLangSysIndex, unsigned int featureTableTagIndex) const { return (this+vertAxis).get_min_value (baseScriptIndex, baseLangSysIndex, featureTableTagIndex); } inline bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && likely (version.major == 1) && horizAxis.sanitize (c, this) && vertAxis.sanitize (c, this) && (version.to_int () < 0x00010001u || varStore.sanitize (c, this))); } protected: FixedVersion<> version; OffsetTo horizAxis; OffsetTo vertAxis; LOffsetTo varStore; /* Offset to the table of Item Variation * Store--from beginning of BASE * header (may be NULL). Introduced * in version 0x00010001. */ public: DEFINE_SIZE_MIN (8); }; } /* namespace OT */ #endif /* HB_OT_LAYOUT_BASE_TABLE_HH */