/* * 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): Garret Rieger, Rod Sheeter, Behdad Esfahbod */ #include "hb-subset-instancer-solver.hh" #include "hb-subset.hh" #include "hb-set.hh" #include "hb-utf.hh" hb_subset_input_t::hb_subset_input_t () { for (auto& set : sets_iter ()) set = hb::shared_ptr (hb_set_create ()); if (in_error ()) return; flags = HB_SUBSET_FLAGS_DEFAULT; hb_set_add_range (sets.name_ids, 0, 6); hb_set_add (sets.name_languages, 0x0409); hb_tag_t default_drop_tables[] = { // Layout disabled by default HB_TAG ('m', 'o', 'r', 'x'), HB_TAG ('m', 'o', 'r', 't'), HB_TAG ('k', 'e', 'r', 'x'), HB_TAG ('k', 'e', 'r', 'n'), // Copied from fontTools: HB_TAG ('J', 'S', 'T', 'F'), HB_TAG ('D', 'S', 'I', 'G'), HB_TAG ('E', 'B', 'D', 'T'), HB_TAG ('E', 'B', 'L', 'C'), HB_TAG ('E', 'B', 'S', 'C'), HB_TAG ('S', 'V', 'G', ' '), HB_TAG ('P', 'C', 'L', 'T'), HB_TAG ('L', 'T', 'S', 'H'), // Graphite tables HB_TAG ('F', 'e', 'a', 't'), HB_TAG ('G', 'l', 'a', 't'), HB_TAG ('G', 'l', 'o', 'c'), HB_TAG ('S', 'i', 'l', 'f'), HB_TAG ('S', 'i', 'l', 'l'), }; sets.drop_tables->add_array (default_drop_tables, ARRAY_LENGTH (default_drop_tables)); hb_tag_t default_no_subset_tables[] = { HB_TAG ('g', 'a', 's', 'p'), HB_TAG ('f', 'p', 'g', 'm'), HB_TAG ('p', 'r', 'e', 'p'), HB_TAG ('V', 'D', 'M', 'X'), HB_TAG ('D', 'S', 'I', 'G'), }; sets.no_subset_tables->add_array (default_no_subset_tables, ARRAY_LENGTH (default_no_subset_tables)); //copied from _layout_features_groups in fonttools hb_tag_t default_layout_features[] = { // default shaper // common HB_TAG ('r', 'v', 'r', 'n'), HB_TAG ('c', 'c', 'm', 'p'), HB_TAG ('l', 'i', 'g', 'a'), HB_TAG ('l', 'o', 'c', 'l'), HB_TAG ('m', 'a', 'r', 'k'), HB_TAG ('m', 'k', 'm', 'k'), HB_TAG ('r', 'l', 'i', 'g'), //fractions HB_TAG ('f', 'r', 'a', 'c'), HB_TAG ('n', 'u', 'm', 'r'), HB_TAG ('d', 'n', 'o', 'm'), //horizontal HB_TAG ('c', 'a', 'l', 't'), HB_TAG ('c', 'l', 'i', 'g'), HB_TAG ('c', 'u', 'r', 's'), HB_TAG ('k', 'e', 'r', 'n'), HB_TAG ('r', 'c', 'l', 't'), //vertical HB_TAG ('v', 'a', 'l', 't'), HB_TAG ('v', 'e', 'r', 't'), HB_TAG ('v', 'k', 'r', 'n'), HB_TAG ('v', 'p', 'a', 'l'), HB_TAG ('v', 'r', 't', '2'), //ltr HB_TAG ('l', 't', 'r', 'a'), HB_TAG ('l', 't', 'r', 'm'), //rtl HB_TAG ('r', 't', 'l', 'a'), HB_TAG ('r', 't', 'l', 'm'), //random HB_TAG ('r', 'a', 'n', 'd'), //justify HB_TAG ('j', 'a', 'l', 't'), // HarfBuzz doesn't use; others might //East Asian spacing HB_TAG ('c', 'h', 'w', 's'), HB_TAG ('v', 'c', 'h', 'w'), HB_TAG ('h', 'a', 'l', 't'), HB_TAG ('v', 'h', 'a', 'l'), //private HB_TAG ('H', 'a', 'r', 'f'), HB_TAG ('H', 'A', 'R', 'F'), HB_TAG ('B', 'u', 'z', 'z'), HB_TAG ('B', 'U', 'Z', 'Z'), //shapers //arabic HB_TAG ('i', 'n', 'i', 't'), HB_TAG ('m', 'e', 'd', 'i'), HB_TAG ('f', 'i', 'n', 'a'), HB_TAG ('i', 's', 'o', 'l'), HB_TAG ('m', 'e', 'd', '2'), HB_TAG ('f', 'i', 'n', '2'), HB_TAG ('f', 'i', 'n', '3'), HB_TAG ('c', 's', 'w', 'h'), HB_TAG ('m', 's', 'e', 't'), HB_TAG ('s', 't', 'c', 'h'), //hangul HB_TAG ('l', 'j', 'm', 'o'), HB_TAG ('v', 'j', 'm', 'o'), HB_TAG ('t', 'j', 'm', 'o'), //tibetan HB_TAG ('a', 'b', 'v', 's'), HB_TAG ('b', 'l', 'w', 's'), HB_TAG ('a', 'b', 'v', 'm'), HB_TAG ('b', 'l', 'w', 'm'), //indic HB_TAG ('n', 'u', 'k', 't'), HB_TAG ('a', 'k', 'h', 'n'), HB_TAG ('r', 'p', 'h', 'f'), HB_TAG ('r', 'k', 'r', 'f'), HB_TAG ('p', 'r', 'e', 'f'), HB_TAG ('b', 'l', 'w', 'f'), HB_TAG ('h', 'a', 'l', 'f'), HB_TAG ('a', 'b', 'v', 'f'), HB_TAG ('p', 's', 't', 'f'), HB_TAG ('c', 'f', 'a', 'r'), HB_TAG ('v', 'a', 't', 'u'), HB_TAG ('c', 'j', 'c', 't'), HB_TAG ('i', 'n', 'i', 't'), HB_TAG ('p', 'r', 'e', 's'), HB_TAG ('a', 'b', 'v', 's'), HB_TAG ('b', 'l', 'w', 's'), HB_TAG ('p', 's', 't', 's'), HB_TAG ('h', 'a', 'l', 'n'), HB_TAG ('d', 'i', 's', 't'), HB_TAG ('a', 'b', 'v', 'm'), HB_TAG ('b', 'l', 'w', 'm'), }; sets.layout_features->add_array (default_layout_features, ARRAY_LENGTH (default_layout_features)); sets.layout_scripts->invert (); // Default to all scripts. } /** * hb_subset_input_create_or_fail: * * Creates a new subset input object. * * Return value: (transfer full): New subset input, or `NULL` if failed. Destroy * with hb_subset_input_destroy(). * * Since: 1.8.0 **/ hb_subset_input_t * hb_subset_input_create_or_fail (void) { hb_subset_input_t *input = hb_object_create(); if (unlikely (!input)) return nullptr; if (input->in_error ()) { hb_subset_input_destroy (input); return nullptr; } return input; } /** * hb_subset_input_reference: (skip) * @input: a #hb_subset_input_t object. * * Increases the reference count on @input. * * Return value: @input. * * Since: 1.8.0 **/ hb_subset_input_t * hb_subset_input_reference (hb_subset_input_t *input) { return hb_object_reference (input); } /** * hb_subset_input_destroy: * @input: a #hb_subset_input_t object. * * Decreases the reference count on @input, and if it reaches zero, destroys * @input, freeing all memory. * * Since: 1.8.0 **/ void hb_subset_input_destroy (hb_subset_input_t *input) { if (!hb_object_destroy (input)) return; hb_free (input); } /** * hb_subset_input_unicode_set: * @input: a #hb_subset_input_t object. * * Gets the set of Unicode code points to retain, the caller should modify the * set as needed. * * Return value: (transfer none): pointer to the #hb_set_t of Unicode code * points. * * Since: 1.8.0 **/ HB_EXTERN hb_set_t * hb_subset_input_unicode_set (hb_subset_input_t *input) { return input->sets.unicodes; } /** * hb_subset_input_glyph_set: * @input: a #hb_subset_input_t object. * * Gets the set of glyph IDs to retain, the caller should modify the set as * needed. * * Return value: (transfer none): pointer to the #hb_set_t of glyph IDs. * * Since: 1.8.0 **/ HB_EXTERN hb_set_t * hb_subset_input_glyph_set (hb_subset_input_t *input) { return input->sets.glyphs; } /** * hb_subset_input_set: * @input: a #hb_subset_input_t object. * @set_type: a #hb_subset_sets_t set type. * * Gets the set of the specified type. * * Return value: (transfer none): pointer to the #hb_set_t of the specified type. * * Since: 2.9.1 **/ HB_EXTERN hb_set_t * hb_subset_input_set (hb_subset_input_t *input, hb_subset_sets_t set_type) { return input->sets_iter () [set_type]; } /** * hb_subset_input_get_flags: * @input: a #hb_subset_input_t object. * * Gets all of the subsetting flags in the input object. * * Return value: the subsetting flags bit field. * * Since: 2.9.0 **/ HB_EXTERN hb_subset_flags_t hb_subset_input_get_flags (hb_subset_input_t *input) { return (hb_subset_flags_t) input->flags; } /** * hb_subset_input_set_flags: * @input: a #hb_subset_input_t object. * @value: bit field of flags * * Sets all of the flags in the input object to the values specified by the bit * field. * * Since: 2.9.0 **/ HB_EXTERN void hb_subset_input_set_flags (hb_subset_input_t *input, unsigned value) { input->flags = (hb_subset_flags_t) value; } /** * hb_subset_input_set_user_data: (skip) * @input: a #hb_subset_input_t object. * @key: The user-data key to set * @data: A pointer to the user data * @destroy: (nullable): A callback to call when @data is not needed anymore * @replace: Whether to replace an existing data with the same key * * Attaches a user-data key/data pair to the given subset input object. * * Return value: `true` if success, `false` otherwise * * Since: 2.9.0 **/ hb_bool_t hb_subset_input_set_user_data (hb_subset_input_t *input, hb_user_data_key_t *key, void * data, hb_destroy_func_t destroy, hb_bool_t replace) { return hb_object_set_user_data (input, key, data, destroy, replace); } /** * hb_subset_input_get_user_data: (skip) * @input: a #hb_subset_input_t object. * @key: The user-data key to query * * Fetches the user data associated with the specified key, * attached to the specified subset input object. * * Return value: (transfer none): A pointer to the user data * * Since: 2.9.0 **/ void * hb_subset_input_get_user_data (const hb_subset_input_t *input, hb_user_data_key_t *key) { return hb_object_get_user_data (input, key); } /** * hb_subset_input_keep_everything: * @input: a #hb_subset_input_t object * * Configure input object to keep everything in the font face. * That is, all Unicodes, glyphs, names, layout items, * glyph names, etc. * * The input can be tailored afterwards by the caller. * * Since: 7.0.0 */ void hb_subset_input_keep_everything (hb_subset_input_t *input) { const hb_subset_sets_t indices[] = {HB_SUBSET_SETS_UNICODE, HB_SUBSET_SETS_GLYPH_INDEX, HB_SUBSET_SETS_NAME_ID, HB_SUBSET_SETS_NAME_LANG_ID, HB_SUBSET_SETS_LAYOUT_FEATURE_TAG, HB_SUBSET_SETS_LAYOUT_SCRIPT_TAG}; for (auto idx : hb_iter (indices)) { hb_set_t *set = hb_subset_input_set (input, idx); hb_set_clear (set); hb_set_invert (set); } // Don't drop any tables hb_set_clear (hb_subset_input_set (input, HB_SUBSET_SETS_DROP_TABLE_TAG)); hb_subset_input_set_flags (input, HB_SUBSET_FLAGS_NOTDEF_OUTLINE | HB_SUBSET_FLAGS_GLYPH_NAMES | HB_SUBSET_FLAGS_NAME_LEGACY | HB_SUBSET_FLAGS_NO_PRUNE_UNICODE_RANGES | HB_SUBSET_FLAGS_PASSTHROUGH_UNRECOGNIZED); } #ifndef HB_NO_VAR /** * hb_subset_input_pin_all_axes_to_default: (skip) * @input: a #hb_subset_input_t object. * @face: a #hb_face_t object. * * Pin all axes to default locations in the given subset input object. * * All axes in a font must be pinned. Additionally, `CFF2` table, if present, * will be de-subroutinized. * * Return value: `true` if success, `false` otherwise * * Since: 8.3.1 **/ HB_EXTERN hb_bool_t hb_subset_input_pin_all_axes_to_default (hb_subset_input_t *input, hb_face_t *face) { unsigned axis_count = hb_ot_var_get_axis_count (face); if (!axis_count) return false; hb_ot_var_axis_info_t *axis_infos = (hb_ot_var_axis_info_t *) hb_calloc (axis_count, sizeof (hb_ot_var_axis_info_t)); if (unlikely (!axis_infos)) return false; (void) hb_ot_var_get_axis_infos (face, 0, &axis_count, axis_infos); for (unsigned i = 0; i < axis_count; i++) { hb_tag_t axis_tag = axis_infos[i].tag; double default_val = (double) axis_infos[i].default_value; if (!input->axes_location.set (axis_tag, Triple (default_val, default_val, default_val))) { hb_free (axis_infos); return false; } } hb_free (axis_infos); return true; } /** * hb_subset_input_pin_axis_to_default: (skip) * @input: a #hb_subset_input_t object. * @face: a #hb_face_t object. * @axis_tag: Tag of the axis to be pinned * * Pin an axis to its default location in the given subset input object. * * All axes in a font must be pinned. Additionally, `CFF2` table, if present, * will be de-subroutinized. * * Return value: `true` if success, `false` otherwise * * Since: 6.0.0 **/ HB_EXTERN hb_bool_t hb_subset_input_pin_axis_to_default (hb_subset_input_t *input, hb_face_t *face, hb_tag_t axis_tag) { hb_ot_var_axis_info_t axis_info; if (!hb_ot_var_find_axis_info (face, axis_tag, &axis_info)) return false; double default_val = (double) axis_info.default_value; return input->axes_location.set (axis_tag, Triple (default_val, default_val, default_val)); } /** * hb_subset_input_pin_axis_location: (skip) * @input: a #hb_subset_input_t object. * @face: a #hb_face_t object. * @axis_tag: Tag of the axis to be pinned * @axis_value: Location on the axis to be pinned at * * Pin an axis to a fixed location in the given subset input object. * * All axes in a font must be pinned. Additionally, `CFF2` table, if present, * will be de-subroutinized. * * Return value: `true` if success, `false` otherwise * * Since: 6.0.0 **/ HB_EXTERN hb_bool_t hb_subset_input_pin_axis_location (hb_subset_input_t *input, hb_face_t *face, hb_tag_t axis_tag, float axis_value) { hb_ot_var_axis_info_t axis_info; if (!hb_ot_var_find_axis_info (face, axis_tag, &axis_info)) return false; double val = hb_clamp((double) axis_value, (double) axis_info.min_value, (double) axis_info.max_value); return input->axes_location.set (axis_tag, Triple (val, val, val)); } /** * hb_subset_input_set_axis_range: (skip) * @input: a #hb_subset_input_t object. * @face: a #hb_face_t object. * @axis_tag: Tag of the axis * @axis_min_value: Minimum value of the axis variation range to set, if NaN the existing min will be used. * @axis_max_value: Maximum value of the axis variation range to set if NaN the existing max will be used. * @axis_def_value: Default value of the axis variation range to set, if NaN the existing default will be used. * * Restricting the range of variation on an axis in the given subset input object. * New min/default/max values will be clamped if they're not within the fvar axis range. * * If the fvar axis default value is not within the new range, the new default * value will be changed to the new min or max value, whichever is closer to the fvar * axis default. * * Note: input min value can not be bigger than input max value. If the input * default value is not within the new min/max range, it'll be clamped. * Note: currently it supports gvar and cvar tables only. * * Return value: `true` if success, `false` otherwise * * Since: 8.5.0 **/ HB_EXTERN hb_bool_t hb_subset_input_set_axis_range (hb_subset_input_t *input, hb_face_t *face, hb_tag_t axis_tag, float axis_min_value, float axis_max_value, float axis_def_value) { hb_ot_var_axis_info_t axis_info; if (!hb_ot_var_find_axis_info (face, axis_tag, &axis_info)) return false; float min = !std::isnan(axis_min_value) ? axis_min_value : axis_info.min_value; float max = !std::isnan(axis_max_value) ? axis_max_value : axis_info.max_value; float def = !std::isnan(axis_def_value) ? axis_def_value : axis_info.default_value; if (min > max) return false; float new_min_val = hb_clamp(min, axis_info.min_value, axis_info.max_value); float new_max_val = hb_clamp(max, axis_info.min_value, axis_info.max_value); float new_default_val = hb_clamp(def, new_min_val, new_max_val); return input->axes_location.set (axis_tag, Triple ((double) new_min_val, (double) new_default_val, (double) new_max_val)); } /** * hb_subset_input_get_axis_range: (skip) * @input: a #hb_subset_input_t object. * @axis_tag: Tag of the axis * @axis_min_value: Set to the previously configured minimum value of the axis variation range. * @axis_max_value: Set to the previously configured maximum value of the axis variation range. * @axis_def_value: Set to the previously configured default value of the axis variation range. * * Gets the axis range assigned by previous calls to hb_subset_input_set_axis_range. * * Return value: `true` if a range has been set for this axis tag, `false` otherwise. * * Since: 8.5.0 **/ HB_EXTERN hb_bool_t hb_subset_input_get_axis_range (hb_subset_input_t *input, hb_tag_t axis_tag, float *axis_min_value, float *axis_max_value, float *axis_def_value) { Triple* triple; if (!input->axes_location.has(axis_tag, &triple)) { return false; } *axis_min_value = triple->minimum; *axis_def_value = triple->middle; *axis_max_value = triple->maximum; return true; } #endif /** * hb_subset_preprocess: * @source: a #hb_face_t object. * * Preprocesses the face and attaches data that will be needed by the * subsetter. Future subsetting operations can then use the precomputed data * to speed up the subsetting operation. * * See [subset-preprocessing](https://github.com/harfbuzz/harfbuzz/blob/main/docs/subset-preprocessing.md) * for more information. * * Note: the preprocessed face may contain sub-blobs that reference the memory * backing the source #hb_face_t. Therefore in the case that this memory is not * owned by the source face you will need to ensure that memory lives * as long as the returned #hb_face_t. * * Returns: a new #hb_face_t. * * Since: 6.0.0 **/ HB_EXTERN hb_face_t * hb_subset_preprocess (hb_face_t *source) { hb_subset_input_t* input = hb_subset_input_create_or_fail (); if (!input) return hb_face_reference (source); hb_subset_input_keep_everything (input); input->attach_accelerator_data = true; // Always use long loca in the preprocessed version. This allows // us to store the glyph bytes unpadded which allows the future subset // operation to run faster by skipping the trim padding step. input->force_long_loca = true; hb_face_t* new_source = hb_subset_or_fail (source, input); hb_subset_input_destroy (input); if (!new_source) { DEBUG_MSG (SUBSET, nullptr, "Preprocessing failed due to subset failure."); return hb_face_reference (source); } return new_source; } /** * hb_subset_input_old_to_new_glyph_mapping: * @input: a #hb_subset_input_t object. * * Returns a map which can be used to provide an explicit mapping from old to new glyph * id's in the produced subset. The caller should populate the map as desired. * If this map is left empty then glyph ids will be automatically mapped to new * values by the subsetter. If populated, the mapping must be unique. That * is no two original glyph ids can be mapped to the same new id. * Additionally, if a mapping is provided then the retain gids option cannot * be enabled. * * Any glyphs that are retained in the subset which are not specified * in this mapping will be assigned glyph ids after the highest glyph * id in the mapping. * * Note: this will accept and apply non-monotonic mappings, however this * may result in unsorted Coverage tables. Such fonts may not work for all * use cases (for example ots will reject unsorted coverage tables). So it's * recommended, if possible, to supply a monotonic mapping. * * Return value: (transfer none): pointer to the #hb_map_t of the custom glyphs ID map. * * Since: 7.3.0 **/ HB_EXTERN hb_map_t* hb_subset_input_old_to_new_glyph_mapping (hb_subset_input_t *input) { return &input->glyph_map; } #ifdef HB_EXPERIMENTAL_API /** * hb_subset_input_override_name_table: * @input: a #hb_subset_input_t object. * @name_id: name_id of a nameRecord * @platform_id: platform ID of a nameRecord * @encoding_id: encoding ID of a nameRecord * @language_id: language ID of a nameRecord * @name_str: pointer to name string new value or null to indicate should remove * @str_len: the size of @name_str, or -1 if it is `NULL`-terminated * * Override the name string of the NameRecord identified by name_id, * platform_id, encoding_id and language_id. If a record with that name_id * doesn't exist, create it and insert to the name table. * * Note: for mac platform, we only support name_str with all ascii characters, * name_str with non-ascii characters will be ignored. * * XSince: EXPERIMENTAL **/ HB_EXTERN hb_bool_t hb_subset_input_override_name_table (hb_subset_input_t *input, hb_ot_name_id_t name_id, unsigned platform_id, unsigned encoding_id, unsigned language_id, const char *name_str, int str_len /* -1 means nul-terminated */) { if (!name_str) { str_len = 0; } else if (str_len == -1) { str_len = strlen (name_str); } hb_bytes_t name_bytes (nullptr, 0); if (str_len) { if (platform_id == 1) { const uint8_t *src = reinterpret_cast (name_str); const uint8_t *src_end = src + str_len; hb_codepoint_t unicode; const hb_codepoint_t replacement = HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT; while (src < src_end) { src = hb_utf8_t::next (src, src_end, &unicode, replacement); if (unicode >= 0x0080u) { printf ("Non-ascii character detected, ignored...This API supports ascii characters only for mac platform\n"); return false; } } } char *override_name = (char *) hb_malloc (str_len); if (unlikely (!override_name)) return false; hb_memcpy (override_name, name_str, str_len); name_bytes = hb_bytes_t (override_name, str_len); } input->name_table_overrides.set (hb_ot_name_record_ids_t (platform_id, encoding_id, language_id, name_id), name_bytes); return true; } #endif