/* * Copyright © 2014 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_CMAP_TABLE_HH #define HB_OT_CMAP_TABLE_HH #include "hb-open-type.hh" #include "hb-set.hh" /* * cmap -- Character to Glyph Index Mapping * https://docs.microsoft.com/en-us/typography/opentype/spec/cmap */ #define HB_OT_TAG_cmap HB_TAG('c','m','a','p') namespace OT { struct CmapSubtableFormat0 { bool get_glyph (hb_codepoint_t codepoint, hb_codepoint_t *glyph) const { hb_codepoint_t gid = codepoint < 256 ? glyphIdArray[codepoint] : 0; if (!gid) return false; *glyph = gid; return true; } void collect_unicodes (hb_set_t *out) const { for (unsigned int i = 0; i < 256; i++) if (glyphIdArray[i]) out->add (i); } void collect_mapping (hb_set_t *unicodes, /* OUT */ hb_map_t *mapping /* OUT */) const { for (unsigned i = 0; i < 256; i++) if (glyphIdArray[i]) { hb_codepoint_t glyph = glyphIdArray[i]; unicodes->add (i); mapping->set (i, glyph); } } bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this)); } protected: HBUINT16 format; /* Format number is set to 0. */ HBUINT16 length; /* Byte length of this subtable. */ HBUINT16 language; /* Ignore. */ HBUINT8 glyphIdArray[256];/* An array that maps character * code to glyph index values. */ public: DEFINE_SIZE_STATIC (6 + 256); }; struct CmapSubtableFormat4 { template HBUINT16* serialize_endcode_array (hb_serialize_context_t *c, Iterator it) { HBUINT16 *endCode = c->start_embed (); hb_codepoint_t prev_endcp = 0xFFFF; for (const auto& _ : +it) { if (prev_endcp != 0xFFFF && prev_endcp + 1u != _.first) { HBUINT16 end_code; end_code = prev_endcp; c->copy (end_code); } prev_endcp = _.first; } { // last endCode HBUINT16 endcode; endcode = prev_endcp; if (unlikely (!c->copy (endcode))) return nullptr; // There must be a final entry with end_code == 0xFFFF. if (prev_endcp != 0xFFFF) { HBUINT16 finalcode; finalcode = 0xFFFF; if (unlikely (!c->copy (finalcode))) return nullptr; } } return endCode; } template HBUINT16* serialize_startcode_array (hb_serialize_context_t *c, Iterator it) { HBUINT16 *startCode = c->start_embed (); hb_codepoint_t prev_cp = 0xFFFF; for (const auto& _ : +it) { if (prev_cp == 0xFFFF || prev_cp + 1u != _.first) { HBUINT16 start_code; start_code = _.first; c->copy (start_code); } prev_cp = _.first; } // There must be a final entry with end_code == 0xFFFF. if (it.len () == 0 || prev_cp != 0xFFFF) { HBUINT16 finalcode; finalcode = 0xFFFF; if (unlikely (!c->copy (finalcode))) return nullptr; } return startCode; } template HBINT16* serialize_idDelta_array (hb_serialize_context_t *c, Iterator it, HBUINT16 *endCode, HBUINT16 *startCode, unsigned segcount) { unsigned i = 0; hb_codepoint_t last_gid = 0, start_gid = 0, last_cp = 0xFFFF; bool use_delta = true; HBINT16 *idDelta = c->start_embed (); if ((char *)idDelta - (char *)startCode != (int) segcount * (int) HBINT16::static_size) return nullptr; for (const auto& _ : +it) { if (_.first == startCode[i]) { use_delta = true; start_gid = _.second; } else if (_.second != last_gid + 1) use_delta = false; if (_.first == endCode[i]) { HBINT16 delta; if (use_delta) delta = (int)start_gid - (int)startCode[i]; else delta = 0; c->copy (delta); i++; } last_gid = _.second; last_cp = _.first; } if (it.len () == 0 || last_cp != 0xFFFF) { HBINT16 delta; delta = 1; if (unlikely (!c->copy (delta))) return nullptr; } return idDelta; } template HBUINT16* serialize_rangeoffset_glyid (hb_serialize_context_t *c, Iterator it, HBUINT16 *endCode, HBUINT16 *startCode, HBINT16 *idDelta, unsigned segcount) { HBUINT16 *idRangeOffset = c->allocate_size (HBUINT16::static_size * segcount); if (unlikely (!c->check_success (idRangeOffset))) return nullptr; if (unlikely ((char *)idRangeOffset - (char *)idDelta != (int) segcount * (int) HBINT16::static_size)) return nullptr; + hb_range (segcount) | hb_filter ([&] (const unsigned _) { return idDelta[_] == 0; }) | hb_apply ([&] (const unsigned i) { idRangeOffset[i] = 2 * (c->start_embed () - idRangeOffset - i); + it | hb_filter ([&] (const hb_item_type _) { return _.first >= startCode[i] && _.first <= endCode[i]; }) | hb_apply ([&] (const hb_item_type _) { HBUINT16 glyID; glyID = _.second; c->copy (glyID); }) ; }) ; return idRangeOffset; } template void serialize (hb_serialize_context_t *c, Iterator it) { auto format4_iter = + it | hb_filter ([&] (const hb_pair_t _) { return _.first <= 0xFFFF; }) ; if (format4_iter.len () == 0) return; unsigned table_initpos = c->length (); if (unlikely (!c->extend_min (*this))) return; this->format = 4; //serialize endCode[] HBUINT16 *endCode = serialize_endcode_array (c, format4_iter); if (unlikely (!endCode)) return; unsigned segcount = (c->length () - min_size) / HBUINT16::static_size; // 2 bytes of padding. if (unlikely (!c->allocate_size (HBUINT16::static_size))) return; // 2 bytes of padding. // serialize startCode[] HBUINT16 *startCode = serialize_startcode_array (c, format4_iter); if (unlikely (!startCode)) return; //serialize idDelta[] HBINT16 *idDelta = serialize_idDelta_array (c, format4_iter, endCode, startCode, segcount); if (unlikely (!idDelta)) return; HBUINT16 *idRangeOffset = serialize_rangeoffset_glyid (c, format4_iter, endCode, startCode, idDelta, segcount); if (unlikely (!c->check_success (idRangeOffset))) return; if (unlikely (!c->check_assign(this->length, c->length () - table_initpos, HB_SERIALIZE_ERROR_INT_OVERFLOW))) return; this->segCountX2 = segcount * 2; this->entrySelector = hb_max (1u, hb_bit_storage (segcount)) - 1; this->searchRange = 2 * (1u << this->entrySelector); this->rangeShift = segcount * 2 > this->searchRange ? 2 * segcount - this->searchRange : 0; } struct accelerator_t { accelerator_t () {} accelerator_t (const CmapSubtableFormat4 *subtable) { init (subtable); } ~accelerator_t () { fini (); } void init (const CmapSubtableFormat4 *subtable) { segCount = subtable->segCountX2 / 2; endCount = subtable->values.arrayZ; startCount = endCount + segCount + 1; idDelta = startCount + segCount; idRangeOffset = idDelta + segCount; glyphIdArray = idRangeOffset + segCount; glyphIdArrayLength = (subtable->length - 16 - 8 * segCount) / 2; } void fini () {} bool get_glyph (hb_codepoint_t codepoint, hb_codepoint_t *glyph) const { struct CustomRange { int cmp (hb_codepoint_t k, unsigned distance) const { if (k > last) return +1; if (k < (&last)[distance]) return -1; return 0; } HBUINT16 last; }; const HBUINT16 *found = hb_bsearch (codepoint, this->endCount, this->segCount, 2, _hb_cmp_method, this->segCount + 1); if (!found) return false; unsigned int i = found - endCount; hb_codepoint_t gid; unsigned int rangeOffset = this->idRangeOffset[i]; if (rangeOffset == 0) gid = codepoint + this->idDelta[i]; else { /* Somebody has been smoking... */ unsigned int index = rangeOffset / 2 + (codepoint - this->startCount[i]) + i - this->segCount; if (unlikely (index >= this->glyphIdArrayLength)) return false; gid = this->glyphIdArray[index]; if (unlikely (!gid)) return false; gid += this->idDelta[i]; } gid &= 0xFFFFu; if (!gid) return false; *glyph = gid; return true; } HB_INTERNAL static bool get_glyph_func (const void *obj, hb_codepoint_t codepoint, hb_codepoint_t *glyph) { return ((const accelerator_t *) obj)->get_glyph (codepoint, glyph); } void collect_unicodes (hb_set_t *out) const { unsigned int count = this->segCount; if (count && this->startCount[count - 1] == 0xFFFFu) count--; /* Skip sentinel segment. */ for (unsigned int i = 0; i < count; i++) { hb_codepoint_t start = this->startCount[i]; hb_codepoint_t end = this->endCount[i]; unsigned int rangeOffset = this->idRangeOffset[i]; if (rangeOffset == 0) { for (hb_codepoint_t codepoint = start; codepoint <= end; codepoint++) { hb_codepoint_t gid = (codepoint + this->idDelta[i]) & 0xFFFFu; if (unlikely (!gid)) continue; out->add (codepoint); } } else { for (hb_codepoint_t codepoint = start; codepoint <= end; codepoint++) { unsigned int index = rangeOffset / 2 + (codepoint - this->startCount[i]) + i - this->segCount; if (unlikely (index >= this->glyphIdArrayLength)) break; hb_codepoint_t gid = this->glyphIdArray[index]; if (unlikely (!gid)) continue; out->add (codepoint); } } } } void collect_mapping (hb_set_t *unicodes, /* OUT */ hb_map_t *mapping /* OUT */) const { unsigned count = this->segCount; if (count && this->startCount[count - 1] == 0xFFFFu) count--; /* Skip sentinel segment. */ for (unsigned i = 0; i < count; i++) { hb_codepoint_t start = this->startCount[i]; hb_codepoint_t end = this->endCount[i]; unsigned rangeOffset = this->idRangeOffset[i]; if (rangeOffset == 0) { for (hb_codepoint_t codepoint = start; codepoint <= end; codepoint++) { hb_codepoint_t gid = (codepoint + this->idDelta[i]) & 0xFFFFu; if (unlikely (!gid)) continue; unicodes->add (codepoint); mapping->set (codepoint, gid); } } else { for (hb_codepoint_t codepoint = start; codepoint <= end; codepoint++) { unsigned index = rangeOffset / 2 + (codepoint - this->startCount[i]) + i - this->segCount; if (unlikely (index >= this->glyphIdArrayLength)) break; hb_codepoint_t gid = this->glyphIdArray[index]; if (unlikely (!gid)) continue; unicodes->add (codepoint); mapping->set (codepoint, gid); } } } } const HBUINT16 *endCount; const HBUINT16 *startCount; const HBUINT16 *idDelta; const HBUINT16 *idRangeOffset; const HBUINT16 *glyphIdArray; unsigned int segCount; unsigned int glyphIdArrayLength; }; bool get_glyph (hb_codepoint_t codepoint, hb_codepoint_t *glyph) const { accelerator_t accel (this); return accel.get_glyph_func (&accel, codepoint, glyph); } void collect_unicodes (hb_set_t *out) const { accelerator_t accel (this); accel.collect_unicodes (out); } void collect_mapping (hb_set_t *unicodes, /* OUT */ hb_map_t *mapping /* OUT */) const { accelerator_t accel (this); accel.collect_mapping (unicodes, mapping); } bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); if (unlikely (!c->check_struct (this))) return_trace (false); if (unlikely (!c->check_range (this, length))) { /* Some broken fonts have too long of a "length" value. * If that is the case, just change the value to truncate * the subtable at the end of the blob. */ uint16_t new_length = (uint16_t) hb_min ((uintptr_t) 65535, (uintptr_t) (c->end - (char *) this)); if (!c->try_set (&length, new_length)) return_trace (false); } return_trace (16 + 4 * (unsigned int) segCountX2 <= length); } protected: HBUINT16 format; /* Format number is set to 4. */ HBUINT16 length; /* This is the length in bytes of the * subtable. */ HBUINT16 language; /* Ignore. */ HBUINT16 segCountX2; /* 2 x segCount. */ HBUINT16 searchRange; /* 2 * (2**floor(log2(segCount))) */ HBUINT16 entrySelector; /* log2(searchRange/2) */ HBUINT16 rangeShift; /* 2 x segCount - searchRange */ UnsizedArrayOf values; #if 0 HBUINT16 endCount[segCount]; /* End characterCode for each segment, * last=0xFFFFu. */ HBUINT16 reservedPad; /* Set to 0. */ HBUINT16 startCount[segCount]; /* Start character code for each segment. */ HBINT16 idDelta[segCount]; /* Delta for all character codes in segment. */ HBUINT16 idRangeOffset[segCount];/* Offsets into glyphIdArray or 0 */ UnsizedArrayOf glyphIdArray; /* Glyph index array (arbitrary length) */ #endif public: DEFINE_SIZE_ARRAY (14, values); }; struct CmapSubtableLongGroup { friend struct CmapSubtableFormat12; friend struct CmapSubtableFormat13; template friend struct CmapSubtableLongSegmented; friend struct cmap; int cmp (hb_codepoint_t codepoint) const { if (codepoint < startCharCode) return -1; if (codepoint > endCharCode) return +1; return 0; } bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this)); } private: HBUINT32 startCharCode; /* First character code in this group. */ HBUINT32 endCharCode; /* Last character code in this group. */ HBUINT32 glyphID; /* Glyph index; interpretation depends on * subtable format. */ public: DEFINE_SIZE_STATIC (12); }; DECLARE_NULL_NAMESPACE_BYTES (OT, CmapSubtableLongGroup); template struct CmapSubtableTrimmed { bool get_glyph (hb_codepoint_t codepoint, hb_codepoint_t *glyph) const { /* Rely on our implicit array bound-checking. */ hb_codepoint_t gid = glyphIdArray[codepoint - startCharCode]; if (!gid) return false; *glyph = gid; return true; } void collect_unicodes (hb_set_t *out) const { hb_codepoint_t start = startCharCode; unsigned int count = glyphIdArray.len; for (unsigned int i = 0; i < count; i++) if (glyphIdArray[i]) out->add (start + i); } void collect_mapping (hb_set_t *unicodes, /* OUT */ hb_map_t *mapping /* OUT */) const { hb_codepoint_t start_cp = startCharCode; unsigned count = glyphIdArray.len; for (unsigned i = 0; i < count; i++) if (glyphIdArray[i]) { hb_codepoint_t unicode = start_cp + i; hb_codepoint_t glyphid = glyphIdArray[i]; unicodes->add (unicode); mapping->set (unicode, glyphid); } } bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && glyphIdArray.sanitize (c)); } protected: UINT formatReserved; /* Subtable format and (maybe) padding. */ UINT length; /* Byte length of this subtable. */ UINT language; /* Ignore. */ UINT startCharCode; /* First character code covered. */ ArrayOf glyphIdArray; /* Array of glyph index values for character * codes in the range. */ public: DEFINE_SIZE_ARRAY (5 * sizeof (UINT), glyphIdArray); }; struct CmapSubtableFormat6 : CmapSubtableTrimmed {}; struct CmapSubtableFormat10 : CmapSubtableTrimmed {}; template struct CmapSubtableLongSegmented { friend struct cmap; bool get_glyph (hb_codepoint_t codepoint, hb_codepoint_t *glyph) const { hb_codepoint_t gid = T::group_get_glyph (groups.bsearch (codepoint), codepoint); if (!gid) return false; *glyph = gid; return true; } void collect_unicodes (hb_set_t *out, unsigned int num_glyphs) const { for (unsigned int i = 0; i < this->groups.len; i++) { hb_codepoint_t start = this->groups[i].startCharCode; hb_codepoint_t end = hb_min ((hb_codepoint_t) this->groups[i].endCharCode, (hb_codepoint_t) HB_UNICODE_MAX); hb_codepoint_t gid = this->groups[i].glyphID; if (!gid) { /* Intention is: if (hb_is_same (T, CmapSubtableFormat13)) continue; */ if (! T::group_get_glyph (this->groups[i], end)) continue; start++; gid++; } if (unlikely ((unsigned int) gid >= num_glyphs)) continue; if (unlikely ((unsigned int) (gid + end - start) >= num_glyphs)) end = start + (hb_codepoint_t) num_glyphs - gid; out->add_range (start, end); } } void collect_mapping (hb_set_t *unicodes, /* OUT */ hb_map_t *mapping, /* OUT */ unsigned num_glyphs) const { for (unsigned i = 0; i < this->groups.len; i++) { hb_codepoint_t start = this->groups[i].startCharCode; hb_codepoint_t end = hb_min ((hb_codepoint_t) this->groups[i].endCharCode, (hb_codepoint_t) HB_UNICODE_MAX); hb_codepoint_t gid = this->groups[i].glyphID; if (!gid) { /* Intention is: if (hb_is_same (T, CmapSubtableFormat13)) continue; */ if (! T::group_get_glyph (this->groups[i], end)) continue; start++; gid++; } if (unlikely ((unsigned int) gid >= num_glyphs)) continue; if (unlikely ((unsigned int) (gid + end - start) >= num_glyphs)) end = start + (hb_codepoint_t) num_glyphs - gid; for (unsigned cp = start; cp <= end; cp++) { unicodes->add (cp); mapping->set (cp, gid); gid++; } } } bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && groups.sanitize (c)); } protected: HBUINT16 format; /* Subtable format; set to 12. */ HBUINT16 reserved; /* Reserved; set to 0. */ HBUINT32 length; /* Byte length of this subtable. */ HBUINT32 language; /* Ignore. */ SortedArray32Of groups; /* Groupings. */ public: DEFINE_SIZE_ARRAY (16, groups); }; struct CmapSubtableFormat12 : CmapSubtableLongSegmented { static hb_codepoint_t group_get_glyph (const CmapSubtableLongGroup &group, hb_codepoint_t u) { return likely (group.startCharCode <= group.endCharCode) ? group.glyphID + (u - group.startCharCode) : 0; } template void serialize (hb_serialize_context_t *c, Iterator it) { if (it.len () == 0) return; unsigned table_initpos = c->length (); if (unlikely (!c->extend_min (*this))) return; hb_codepoint_t startCharCode = 0xFFFF, endCharCode = 0xFFFF; hb_codepoint_t glyphID = 0; for (const auto& _ : +it) { if (startCharCode == 0xFFFF) { startCharCode = _.first; endCharCode = _.first; glyphID = _.second; } else if (!_is_gid_consecutive (endCharCode, startCharCode, glyphID, _.first, _.second)) { CmapSubtableLongGroup grouprecord; grouprecord.startCharCode = startCharCode; grouprecord.endCharCode = endCharCode; grouprecord.glyphID = glyphID; c->copy (grouprecord); startCharCode = _.first; endCharCode = _.first; glyphID = _.second; } else endCharCode = _.first; } CmapSubtableLongGroup record; record.startCharCode = startCharCode; record.endCharCode = endCharCode; record.glyphID = glyphID; c->copy (record); this->format = 12; this->reserved = 0; this->length = c->length () - table_initpos; this->groups.len = (this->length - min_size)/CmapSubtableLongGroup::static_size; } static size_t get_sub_table_size (const hb_sorted_vector_t &groups_data) { return 16 + 12 * groups_data.length; } private: static bool _is_gid_consecutive (hb_codepoint_t endCharCode, hb_codepoint_t startCharCode, hb_codepoint_t glyphID, hb_codepoint_t cp, hb_codepoint_t new_gid) { return (cp - 1 == endCharCode) && new_gid == glyphID + (cp - startCharCode); } }; struct CmapSubtableFormat13 : CmapSubtableLongSegmented { static hb_codepoint_t group_get_glyph (const CmapSubtableLongGroup &group, hb_codepoint_t u HB_UNUSED) { return group.glyphID; } }; typedef enum { GLYPH_VARIANT_NOT_FOUND = 0, GLYPH_VARIANT_FOUND = 1, GLYPH_VARIANT_USE_DEFAULT = 2 } glyph_variant_t; struct UnicodeValueRange { int cmp (const hb_codepoint_t &codepoint) const { if (codepoint < startUnicodeValue) return -1; if (codepoint > startUnicodeValue + additionalCount) return +1; return 0; } bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this)); } HBUINT24 startUnicodeValue; /* First value in this range. */ HBUINT8 additionalCount; /* Number of additional values in this * range. */ public: DEFINE_SIZE_STATIC (4); }; struct DefaultUVS : SortedArray32Of { void collect_unicodes (hb_set_t *out) const { unsigned int count = len; for (unsigned int i = 0; i < count; i++) { hb_codepoint_t first = arrayZ[i].startUnicodeValue; hb_codepoint_t last = hb_min ((hb_codepoint_t) (first + arrayZ[i].additionalCount), (hb_codepoint_t) HB_UNICODE_MAX); out->add_range (first, last); } } DefaultUVS* copy (hb_serialize_context_t *c, const hb_set_t *unicodes) const { DefaultUVS *out = c->start_embed (); if (unlikely (!out)) return nullptr; auto snap = c->snapshot (); HBUINT32 len; len = 0; if (unlikely (!c->copy (len))) return nullptr; unsigned init_len = c->length (); hb_codepoint_t lastCode = HB_MAP_VALUE_INVALID; int count = -1; for (const UnicodeValueRange& _ : as_array ()) { for (const unsigned addcnt : hb_range ((unsigned) _.additionalCount + 1)) { unsigned curEntry = (unsigned) _.startUnicodeValue + addcnt; if (!unicodes->has (curEntry)) continue; count += 1; if (lastCode == HB_MAP_VALUE_INVALID) lastCode = curEntry; else if (lastCode + count != curEntry) { UnicodeValueRange rec; rec.startUnicodeValue = lastCode; rec.additionalCount = count - 1; c->copy (rec); lastCode = curEntry; count = 0; } } } if (lastCode != HB_MAP_VALUE_INVALID) { UnicodeValueRange rec; rec.startUnicodeValue = lastCode; rec.additionalCount = count; c->copy (rec); } if (c->length () - init_len == 0) { c->revert (snap); return nullptr; } else { if (unlikely (!c->check_assign (out->len, (c->length () - init_len) / UnicodeValueRange::static_size, HB_SERIALIZE_ERROR_INT_OVERFLOW))) return nullptr; return out; } } public: DEFINE_SIZE_ARRAY (4, *this); }; struct UVSMapping { int cmp (const hb_codepoint_t &codepoint) const { return unicodeValue.cmp (codepoint); } bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this)); } HBUINT24 unicodeValue; /* Base Unicode value of the UVS */ HBGlyphID glyphID; /* Glyph ID of the UVS */ public: DEFINE_SIZE_STATIC (5); }; struct NonDefaultUVS : SortedArray32Of { void collect_unicodes (hb_set_t *out) const { for (const auto& a : as_array ()) out->add (a.unicodeValue); } void collect_mapping (hb_set_t *unicodes, /* OUT */ hb_map_t *mapping /* OUT */) const { for (const auto& a : as_array ()) { hb_codepoint_t unicode = a.unicodeValue; hb_codepoint_t glyphid = a.glyphID; unicodes->add (unicode); mapping->set (unicode, glyphid); } } void closure_glyphs (const hb_set_t *unicodes, hb_set_t *glyphset) const { + as_array () | hb_filter (unicodes, &UVSMapping::unicodeValue) | hb_map (&UVSMapping::glyphID) | hb_sink (glyphset) ; } NonDefaultUVS* copy (hb_serialize_context_t *c, const hb_set_t *unicodes, const hb_set_t *glyphs_requested, const hb_map_t *glyph_map) const { NonDefaultUVS *out = c->start_embed (); if (unlikely (!out)) return nullptr; auto it = + as_array () | hb_filter ([&] (const UVSMapping& _) { return unicodes->has (_.unicodeValue) || glyphs_requested->has (_.glyphID); }) ; if (!it) return nullptr; HBUINT32 len; len = it.len (); if (unlikely (!c->copy (len))) return nullptr; for (const UVSMapping& _ : it) { UVSMapping mapping; mapping.unicodeValue = _.unicodeValue; mapping.glyphID = glyph_map->get (_.glyphID); c->copy (mapping); } return out; } public: DEFINE_SIZE_ARRAY (4, *this); }; struct VariationSelectorRecord { glyph_variant_t get_glyph (hb_codepoint_t codepoint, hb_codepoint_t *glyph, const void *base) const { if ((base+defaultUVS).bfind (codepoint)) return GLYPH_VARIANT_USE_DEFAULT; const UVSMapping &nonDefault = (base+nonDefaultUVS).bsearch (codepoint); if (nonDefault.glyphID) { *glyph = nonDefault.glyphID; return GLYPH_VARIANT_FOUND; } return GLYPH_VARIANT_NOT_FOUND; } VariationSelectorRecord(const VariationSelectorRecord& other) { *this = other; } void operator= (const VariationSelectorRecord& other) { varSelector = other.varSelector; HBUINT32 offset = other.defaultUVS; defaultUVS = offset; offset = other.nonDefaultUVS; nonDefaultUVS = offset; } void collect_unicodes (hb_set_t *out, const void *base) const { (base+defaultUVS).collect_unicodes (out); (base+nonDefaultUVS).collect_unicodes (out); } void collect_mapping (const void *base, hb_set_t *unicodes, /* OUT */ hb_map_t *mapping /* OUT */) const { (base+defaultUVS).collect_unicodes (unicodes); (base+nonDefaultUVS).collect_mapping (unicodes, mapping); } int cmp (const hb_codepoint_t &variation_selector) const { return varSelector.cmp (variation_selector); } bool sanitize (hb_sanitize_context_t *c, const void *base) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && defaultUVS.sanitize (c, base) && nonDefaultUVS.sanitize (c, base)); } hb_pair_t copy (hb_serialize_context_t *c, const hb_set_t *unicodes, const hb_set_t *glyphs_requested, const hb_map_t *glyph_map, const void *base) const { auto snap = c->snapshot (); auto *out = c->embed (*this); if (unlikely (!out)) return hb_pair (0, 0); out->defaultUVS = 0; out->nonDefaultUVS = 0; unsigned non_default_uvs_objidx = 0; if (nonDefaultUVS != 0) { c->push (); if (c->copy (base+nonDefaultUVS, unicodes, glyphs_requested, glyph_map)) non_default_uvs_objidx = c->pop_pack (); else c->pop_discard (); } unsigned default_uvs_objidx = 0; if (defaultUVS != 0) { c->push (); if (c->copy (base+defaultUVS, unicodes)) default_uvs_objidx = c->pop_pack (); else c->pop_discard (); } if (!default_uvs_objidx && !non_default_uvs_objidx) c->revert (snap); return hb_pair (default_uvs_objidx, non_default_uvs_objidx); } HBUINT24 varSelector; /* Variation selector. */ Offset32To defaultUVS; /* Offset to Default UVS Table. May be 0. */ Offset32To nonDefaultUVS; /* Offset to Non-Default UVS Table. May be 0. */ public: DEFINE_SIZE_STATIC (11); }; struct CmapSubtableFormat14 { glyph_variant_t get_glyph_variant (hb_codepoint_t codepoint, hb_codepoint_t variation_selector, hb_codepoint_t *glyph) const { return record.bsearch (variation_selector).get_glyph (codepoint, glyph, this); } void collect_variation_selectors (hb_set_t *out) const { for (const auto& a : record.as_array ()) out->add (a.varSelector); } void collect_variation_unicodes (hb_codepoint_t variation_selector, hb_set_t *out) const { record.bsearch (variation_selector).collect_unicodes (out, this); } void serialize (hb_serialize_context_t *c, const hb_set_t *unicodes, const hb_set_t *glyphs_requested, const hb_map_t *glyph_map, const void *base) { auto snap = c->snapshot (); unsigned table_initpos = c->length (); const char* init_tail = c->tail; if (unlikely (!c->extend_min (*this))) return; this->format = 14; auto src_tbl = reinterpret_cast (base); /* * Some versions of OTS require that offsets are in order. Due to the use * of push()/pop_pack() serializing the variation records in order results * in the offsets being in reverse order (first record has the largest * offset). While this is perfectly valid, it will cause some versions of * OTS to consider this table bad. * * So to prevent this issue we serialize the variation records in reverse * order, so that the offsets are ordered from small to large. Since * variation records are supposed to be in increasing order of varSelector * we then have to reverse the order of the written variation selector * records after everything is finalized. */ hb_vector_t> obj_indices; for (int i = src_tbl->record.len - 1; i >= 0; i--) { hb_pair_t result = src_tbl->record[i].copy (c, unicodes, glyphs_requested, glyph_map, base); if (result.first || result.second) obj_indices.push (result); } if (c->length () - table_initpos == CmapSubtableFormat14::min_size) { c->revert (snap); return; } if (unlikely (!c->check_success (!obj_indices.in_error ()))) return; int tail_len = init_tail - c->tail; c->check_assign (this->length, c->length () - table_initpos + tail_len, HB_SERIALIZE_ERROR_INT_OVERFLOW); c->check_assign (this->record.len, (c->length () - table_initpos - CmapSubtableFormat14::min_size) / VariationSelectorRecord::static_size, HB_SERIALIZE_ERROR_INT_OVERFLOW); /* Correct the incorrect write order by reversing the order of the variation records array. */ _reverse_variation_records (); /* Now that records are in the right order, we can set up the offsets. */ _add_links_to_variation_records (c, obj_indices); } void _reverse_variation_records () { record.as_array ().reverse (); } void _add_links_to_variation_records (hb_serialize_context_t *c, const hb_vector_t>& obj_indices) { for (unsigned i = 0; i < obj_indices.length; i++) { /* * Since the record array has been reversed (see comments in copy()) * but obj_indices has not been, the indices at obj_indices[i] * are for the variation record at record[j]. */ int j = obj_indices.length - 1 - i; c->add_link (record[j].defaultUVS, obj_indices[i].first); c->add_link (record[j].nonDefaultUVS, obj_indices[i].second); } } void closure_glyphs (const hb_set_t *unicodes, hb_set_t *glyphset) const { + hb_iter (record) | hb_filter (hb_bool, &VariationSelectorRecord::nonDefaultUVS) | hb_map (&VariationSelectorRecord::nonDefaultUVS) | hb_map (hb_add (this)) | hb_apply ([=] (const NonDefaultUVS& _) { _.closure_glyphs (unicodes, glyphset); }) ; } void collect_unicodes (hb_set_t *out) const { for (const VariationSelectorRecord& _ : record) _.collect_unicodes (out, this); } void collect_mapping (hb_set_t *unicodes, /* OUT */ hb_map_t *mapping /* OUT */) const { for (const VariationSelectorRecord& _ : record) _.collect_mapping (this, unicodes, mapping); } bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && record.sanitize (c, this)); } protected: HBUINT16 format; /* Format number is set to 14. */ HBUINT32 length; /* Byte length of this subtable. */ SortedArray32Of record; /* Variation selector records; sorted * in increasing order of `varSelector'. */ public: DEFINE_SIZE_ARRAY (10, record); }; struct CmapSubtable { /* Note: We intentionally do NOT implement subtable formats 2 and 8. */ bool get_glyph (hb_codepoint_t codepoint, hb_codepoint_t *glyph) const { switch (u.format) { case 0: return u.format0 .get_glyph (codepoint, glyph); case 4: return u.format4 .get_glyph (codepoint, glyph); case 6: return u.format6 .get_glyph (codepoint, glyph); case 10: return u.format10.get_glyph (codepoint, glyph); case 12: return u.format12.get_glyph (codepoint, glyph); case 13: return u.format13.get_glyph (codepoint, glyph); case 14: default: return false; } } void collect_unicodes (hb_set_t *out, unsigned int num_glyphs = UINT_MAX) const { switch (u.format) { case 0: u.format0 .collect_unicodes (out); return; case 4: u.format4 .collect_unicodes (out); return; case 6: u.format6 .collect_unicodes (out); return; case 10: u.format10.collect_unicodes (out); return; case 12: u.format12.collect_unicodes (out, num_glyphs); return; case 13: u.format13.collect_unicodes (out, num_glyphs); return; case 14: default: return; } } void collect_mapping (hb_set_t *unicodes, /* OUT */ hb_map_t *mapping, /* OUT */ unsigned num_glyphs = UINT_MAX) const { switch (u.format) { case 0: u.format0 .collect_mapping (unicodes, mapping); return; case 4: u.format4 .collect_mapping (unicodes, mapping); return; case 6: u.format6 .collect_mapping (unicodes, mapping); return; case 10: u.format10.collect_mapping (unicodes, mapping); return; case 12: u.format12.collect_mapping (unicodes, mapping, num_glyphs); return; case 13: u.format13.collect_mapping (unicodes, mapping, num_glyphs); return; case 14: default: return; } } template void serialize (hb_serialize_context_t *c, Iterator it, unsigned format, const hb_subset_plan_t *plan, const void *base) { switch (format) { case 4: return u.format4.serialize (c, it); case 12: return u.format12.serialize (c, it); case 14: return u.format14.serialize (c, plan->unicodes, plan->glyphs_requested, plan->glyph_map, base); default: return; } } bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); if (!u.format.sanitize (c)) return_trace (false); switch (u.format) { case 0: return_trace (u.format0 .sanitize (c)); case 4: return_trace (u.format4 .sanitize (c)); case 6: return_trace (u.format6 .sanitize (c)); case 10: return_trace (u.format10.sanitize (c)); case 12: return_trace (u.format12.sanitize (c)); case 13: return_trace (u.format13.sanitize (c)); case 14: return_trace (u.format14.sanitize (c)); default:return_trace (true); } } public: union { HBUINT16 format; /* Format identifier */ CmapSubtableFormat0 format0; CmapSubtableFormat4 format4; CmapSubtableFormat6 format6; CmapSubtableFormat10 format10; CmapSubtableFormat12 format12; CmapSubtableFormat13 format13; CmapSubtableFormat14 format14; } u; public: DEFINE_SIZE_UNION (2, format); }; struct EncodingRecord { int cmp (const EncodingRecord &other) const { int ret; ret = platformID.cmp (other.platformID); if (ret) return ret; ret = encodingID.cmp (other.encodingID); if (ret) return ret; return 0; } bool sanitize (hb_sanitize_context_t *c, const void *base) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && subtable.sanitize (c, base)); } template EncodingRecord* copy (hb_serialize_context_t *c, Iterator it, unsigned format, const void *base, const hb_subset_plan_t *plan, /* INOUT */ unsigned *objidx) const { TRACE_SERIALIZE (this); auto snap = c->snapshot (); auto *out = c->embed (this); if (unlikely (!out)) return_trace (nullptr); out->subtable = 0; if (*objidx == 0) { CmapSubtable *cmapsubtable = c->push (); unsigned origin_length = c->length (); cmapsubtable->serialize (c, it, format, plan, &(base+subtable)); if (c->length () - origin_length > 0) *objidx = c->pop_pack (); else c->pop_discard (); } if (*objidx == 0) { c->revert (snap); return_trace (nullptr); } c->add_link (out->subtable, *objidx); return_trace (out); } HBUINT16 platformID; /* Platform ID. */ HBUINT16 encodingID; /* Platform-specific encoding ID. */ Offset32To subtable; /* Byte offset from beginning of table to the subtable for this encoding. */ public: DEFINE_SIZE_STATIC (8); }; struct cmap { static constexpr hb_tag_t tableTag = HB_OT_TAG_cmap; template void serialize (hb_serialize_context_t *c, Iterator it, EncodingRecIter encodingrec_iter, const void *base, const hb_subset_plan_t *plan) { if (unlikely (!c->extend_min ((*this)))) return; this->version = 0; unsigned format4objidx = 0, format12objidx = 0, format14objidx = 0; for (const EncodingRecord& _ : encodingrec_iter) { unsigned format = (base+_.subtable).u.format; if (format != 4 && format != 12 && format != 14) continue; hb_set_t unicodes_set; (base+_.subtable).collect_unicodes (&unicodes_set); if (format == 4) c->copy (_, + it | hb_filter (unicodes_set, hb_first), 4u, base, plan, &format4objidx); else if (format == 12) c->copy (_, + it | hb_filter (unicodes_set, hb_first), 12u, base, plan, &format12objidx); else if (format == 14) c->copy (_, it, 14u, base, plan, &format14objidx); } c->check_assign(this->encodingRecord.len, (c->length () - cmap::min_size)/EncodingRecord::static_size, HB_SERIALIZE_ERROR_INT_OVERFLOW); } void closure_glyphs (const hb_set_t *unicodes, hb_set_t *glyphset) const { + hb_iter (encodingRecord) | hb_map (&EncodingRecord::subtable) | hb_map (hb_add (this)) | hb_filter ([&] (const CmapSubtable& _) { return _.u.format == 14; }) | hb_apply ([=] (const CmapSubtable& _) { _.u.format14.closure_glyphs (unicodes, glyphset); }) ; } bool subset (hb_subset_context_t *c) const { TRACE_SUBSET (this); cmap *cmap_prime = c->serializer->start_embed (); if (unlikely (!c->serializer->check_success (cmap_prime))) return_trace (false); auto encodingrec_iter = + hb_iter (encodingRecord) | hb_filter ([&] (const EncodingRecord& _) { if ((_.platformID == 0 && _.encodingID == 3) || (_.platformID == 0 && _.encodingID == 4) || (_.platformID == 3 && _.encodingID == 1) || (_.platformID == 3 && _.encodingID == 10) || (this + _.subtable).u.format == 14) return true; return false; }) ; if (unlikely (!encodingrec_iter.len ())) return_trace (false); const EncodingRecord *unicode_bmp= nullptr, *unicode_ucs4 = nullptr, *ms_bmp = nullptr, *ms_ucs4 = nullptr; bool has_format12 = false; for (const EncodingRecord& _ : encodingrec_iter) { unsigned format = (this + _.subtable).u.format; if (format == 12) has_format12 = true; const EncodingRecord *table = hb_addressof (_); if (_.platformID == 0 && _.encodingID == 3) unicode_bmp = table; else if (_.platformID == 0 && _.encodingID == 4) unicode_ucs4 = table; else if (_.platformID == 3 && _.encodingID == 1) ms_bmp = table; else if (_.platformID == 3 && _.encodingID == 10) ms_ucs4 = table; } if (unlikely (!has_format12 && !unicode_bmp && !ms_bmp)) return_trace (false); if (unlikely (has_format12 && (!unicode_ucs4 && !ms_ucs4))) return_trace (false); auto it = + hb_iter (c->plan->unicodes) | hb_map ([&] (hb_codepoint_t _) { hb_codepoint_t new_gid = HB_MAP_VALUE_INVALID; c->plan->new_gid_for_codepoint (_, &new_gid); return hb_pair_t (_, new_gid); }) | hb_filter ([&] (const hb_pair_t _) { return (_.second != HB_MAP_VALUE_INVALID); }) ; cmap_prime->serialize (c->serializer, it, encodingrec_iter, this, c->plan); return_trace (true); } const CmapSubtable *find_best_subtable (bool *symbol = nullptr) const { if (symbol) *symbol = false; const CmapSubtable *subtable; /* Symbol subtable. * Prefer symbol if available. * https://github.com/harfbuzz/harfbuzz/issues/1918 */ if ((subtable = this->find_subtable (3, 0))) { if (symbol) *symbol = true; return subtable; } /* 32-bit subtables. */ if ((subtable = this->find_subtable (3, 10))) return subtable; if ((subtable = this->find_subtable (0, 6))) return subtable; if ((subtable = this->find_subtable (0, 4))) return subtable; /* 16-bit subtables. */ if ((subtable = this->find_subtable (3, 1))) return subtable; if ((subtable = this->find_subtable (0, 3))) return subtable; if ((subtable = this->find_subtable (0, 2))) return subtable; if ((subtable = this->find_subtable (0, 1))) return subtable; if ((subtable = this->find_subtable (0, 0))) return subtable; /* Meh. */ return &Null (CmapSubtable); } struct accelerator_t { void init (hb_face_t *face) { this->table = hb_sanitize_context_t ().reference_table (face); bool symbol; this->subtable = table->find_best_subtable (&symbol); this->subtable_uvs = &Null (CmapSubtableFormat14); { const CmapSubtable *st = table->find_subtable (0, 5); if (st && st->u.format == 14) subtable_uvs = &st->u.format14; } this->get_glyph_data = subtable; if (unlikely (symbol)) this->get_glyph_funcZ = get_glyph_from_symbol; else { switch (subtable->u.format) { /* Accelerate format 4 and format 12. */ default: this->get_glyph_funcZ = get_glyph_from; break; case 12: this->get_glyph_funcZ = get_glyph_from; break; case 4: { this->format4_accel.init (&subtable->u.format4); this->get_glyph_data = &this->format4_accel; this->get_glyph_funcZ = this->format4_accel.get_glyph_func; break; } } } } void fini () { this->table.destroy (); } bool get_nominal_glyph (hb_codepoint_t unicode, hb_codepoint_t *glyph) const { if (unlikely (!this->get_glyph_funcZ)) return false; return this->get_glyph_funcZ (this->get_glyph_data, unicode, glyph); } unsigned int get_nominal_glyphs (unsigned int count, const hb_codepoint_t *first_unicode, unsigned int unicode_stride, hb_codepoint_t *first_glyph, unsigned int glyph_stride) const { if (unlikely (!this->get_glyph_funcZ)) return 0; hb_cmap_get_glyph_func_t get_glyph_funcZ = this->get_glyph_funcZ; const void *get_glyph_data = this->get_glyph_data; unsigned int done; for (done = 0; done < count && get_glyph_funcZ (get_glyph_data, *first_unicode, first_glyph); done++) { first_unicode = &StructAtOffsetUnaligned (first_unicode, unicode_stride); first_glyph = &StructAtOffsetUnaligned (first_glyph, glyph_stride); } return done; } bool get_variation_glyph (hb_codepoint_t unicode, hb_codepoint_t variation_selector, hb_codepoint_t *glyph) const { switch (this->subtable_uvs->get_glyph_variant (unicode, variation_selector, glyph)) { case GLYPH_VARIANT_NOT_FOUND: return false; case GLYPH_VARIANT_FOUND: return true; case GLYPH_VARIANT_USE_DEFAULT: break; } return get_nominal_glyph (unicode, glyph); } void collect_unicodes (hb_set_t *out, unsigned int num_glyphs) const { subtable->collect_unicodes (out, num_glyphs); } void collect_mapping (hb_set_t *unicodes, hb_map_t *mapping, unsigned num_glyphs = UINT_MAX) const { subtable->collect_mapping (unicodes, mapping, num_glyphs); } void collect_variation_selectors (hb_set_t *out) const { subtable_uvs->collect_variation_selectors (out); } void collect_variation_unicodes (hb_codepoint_t variation_selector, hb_set_t *out) const { subtable_uvs->collect_variation_unicodes (variation_selector, out); } protected: typedef bool (*hb_cmap_get_glyph_func_t) (const void *obj, hb_codepoint_t codepoint, hb_codepoint_t *glyph); template HB_INTERNAL static bool get_glyph_from (const void *obj, hb_codepoint_t codepoint, hb_codepoint_t *glyph) { const Type *typed_obj = (const Type *) obj; return typed_obj->get_glyph (codepoint, glyph); } template HB_INTERNAL static bool get_glyph_from_symbol (const void *obj, hb_codepoint_t codepoint, hb_codepoint_t *glyph) { const Type *typed_obj = (const Type *) obj; if (likely (typed_obj->get_glyph (codepoint, glyph))) return true; if (codepoint <= 0x00FFu) { /* For symbol-encoded OpenType fonts, we duplicate the * U+F000..F0FF range at U+0000..U+00FF. That's what * Windows seems to do, and that's hinted about at: * https://docs.microsoft.com/en-us/typography/opentype/spec/recom * under "Non-Standard (Symbol) Fonts". */ return typed_obj->get_glyph (0xF000u + codepoint, glyph); } return false; } private: hb_nonnull_ptr_t subtable; hb_nonnull_ptr_t subtable_uvs; hb_cmap_get_glyph_func_t get_glyph_funcZ; const void *get_glyph_data; CmapSubtableFormat4::accelerator_t format4_accel; public: hb_blob_ptr_t table; }; protected: const CmapSubtable *find_subtable (unsigned int platform_id, unsigned int encoding_id) const { EncodingRecord key; key.platformID = platform_id; key.encodingID = encoding_id; const EncodingRecord &result = encodingRecord.bsearch (key); if (!result.subtable) return nullptr; return &(this+result.subtable); } const EncodingRecord *find_encodingrec (unsigned int platform_id, unsigned int encoding_id) const { EncodingRecord key; key.platformID = platform_id; key.encodingID = encoding_id; return encodingRecord.as_array ().bsearch (key); } bool find_subtable (unsigned format) const { auto it = + hb_iter (encodingRecord) | hb_map (&EncodingRecord::subtable) | hb_map (hb_add (this)) | hb_filter ([&] (const CmapSubtable& _) { return _.u.format == format; }) ; return it.len (); } public: bool sanitize (hb_sanitize_context_t *c) const { TRACE_SANITIZE (this); return_trace (c->check_struct (this) && likely (version == 0) && encodingRecord.sanitize (c, this)); } protected: HBUINT16 version; /* Table version number (0). */ SortedArray16Of encodingRecord; /* Encoding tables. */ public: DEFINE_SIZE_ARRAY (4, encodingRecord); }; struct cmap_accelerator_t : cmap::accelerator_t {}; } /* namespace OT */ #endif /* HB_OT_CMAP_TABLE_HH */