src/hb-subset-plan.hh

   1 /*
   2  * Copyright © 2018  Google, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Google Author(s): Garret Rieger, Roderick Sheeter
  25  */
  26
  27 #ifndef HB_SUBSET_PLAN_HH
  28 #define HB_SUBSET_PLAN_HH
  29
  30 #include "hb.hh"
  31
  32 #include "hb-subset.h"
  33 #include "hb-subset-input.hh"
  34
  35 #include "hb-map.hh"
  36 #include "hb-set.hh"
  37
  38 struct hb_subset_plan_t
  39 {
  40   hb_object_header_t header;
  41
  42   bool successful;
  43   unsigned flags;
  44
  45   // For each cp that we'd like to retain maps to the corresponding gid.
  46   hb_set_t *unicodes;
  47
  48   // name_ids we would like to retain
  49   hb_set_t *name_ids;
  50
  51   // name_languages we would like to retain
  52   hb_set_t *name_languages;
  53
  54   //layout features which will be preserved
  55   hb_set_t *layout_features;
  56
  57   //glyph ids requested to retain
  58   hb_set_t *glyphs_requested;
  59
  60   // Tables which should not be processed, just pass them through.
  61   hb_set_t *no_subset_tables;
  62
  63   // Tables which should be dropped.
  64   hb_set_t *drop_tables;
  65
  66   // The glyph subset
  67   hb_map_t *codepoint_to_glyph;
  68
  69   // Old -> New glyph id mapping
  70   hb_map_t *glyph_map;
  71   hb_map_t *reverse_glyph_map;
  72
  73   // Plan is only good for a specific source/dest so keep them with it
  74   hb_face_t *source;
  75   hb_face_t *dest;
  76
  77   unsigned int _num_output_glyphs;
  78   hb_set_t *_glyphset;
  79   hb_set_t *_glyphset_gsub;
  80   hb_set_t *_glyphset_mathed;
  81   hb_set_t *_glyphset_colred;
  82
  83   //active lookups we'd like to retain
  84   hb_map_t *gsub_lookups;
  85   hb_map_t *gpos_lookups;
  86
  87   //active langsys we'd like to retain
  88   hb_hashmap_t<unsigned, hb_set_t *> *gsub_langsys;
  89   hb_hashmap_t<unsigned, hb_set_t *> *gpos_langsys;
  90
  91   //active features after removing redundant langsys and prune_features
  92   hb_map_t *gsub_features;
  93   hb_map_t *gpos_features;
  94
  95   //active layers/palettes we'd like to retain
  96   hb_map_t *colrv1_layers;
  97   hb_map_t *colr_palettes;
  98
  99   //The set of layout item variation store delta set indices to be retained
 100   hb_set_t *layout_variation_indices;
 101   //Old -> New layout item variation store delta set index mapping
 102   hb_map_t *layout_variation_idx_map;
 103
 104  public:
 105
 106   bool in_error () const { return !successful; }
 107
 108   bool check_success(bool success)
 109   {
 110     successful = (successful && success);
 111     return successful;
 112   }
 113
 114   /*
 115    * The set of input glyph ids which will be retained in the subset.
 116    * Does NOT include ids kept due to retain_gids. You probably want to use
 117    * glyph_map/reverse_glyph_map.
 118    */
 119   inline const hb_set_t *
 120   glyphset () const
 121   {
 122     return _glyphset;
 123   }
 124
 125   /*
 126    * The set of input glyph ids which will be retained in the subset.
 127    */
 128   inline const hb_set_t *
 129   glyphset_gsub () const
 130   {
 131     return _glyphset_gsub;
 132   }
 133
 134   /*
 135    * The total number of output glyphs in the final subset.
 136    */
 137   inline unsigned int
 138   num_output_glyphs () const
 139   {
 140     return _num_output_glyphs;
 141   }
 142
 143   /*
 144    * Given an output gid , returns true if that glyph id is an empty
 145    * glyph (ie. it's a gid that we are dropping all data for).
 146    */
 147   inline bool is_empty_glyph (hb_codepoint_t gid) const
 148   {
 149     return !_glyphset->has (gid);
 150   }
 151
 152   inline bool new_gid_for_codepoint (hb_codepoint_t codepoint,
 153                                      hb_codepoint_t *new_gid) const
 154   {
 155     hb_codepoint_t old_gid = codepoint_to_glyph->get (codepoint);
 156     if (old_gid == HB_MAP_VALUE_INVALID)
 157       return false;
 158
 159     return new_gid_for_old_gid (old_gid, new_gid);
 160   }
 161
 162   inline bool new_gid_for_old_gid (hb_codepoint_t old_gid,
 163                                    hb_codepoint_t *new_gid) const
 164   {
 165     hb_codepoint_t gid = glyph_map->get (old_gid);
 166     if (gid == HB_MAP_VALUE_INVALID)
 167       return false;
 168
 169     *new_gid = gid;
 170     return true;
 171   }
 172
 173   inline bool old_gid_for_new_gid (hb_codepoint_t  new_gid,
 174                                    hb_codepoint_t *old_gid) const
 175   {
 176     hb_codepoint_t gid = reverse_glyph_map->get (new_gid);
 177     if (gid == HB_MAP_VALUE_INVALID)
 178       return false;
 179
 180     *old_gid = gid;
 181     return true;
 182   }
 183
 184   inline bool
 185   add_table (hb_tag_t tag,
 186              hb_blob_t *contents)
 187   {
 188     if (HB_DEBUG_SUBSET)
 189     {
 190       hb_blob_t *source_blob = source->reference_table (tag);
 191       DEBUG_MSG(SUBSET, nullptr, "add table %c%c%c%c, dest %d bytes, source %d bytes",
 192                 HB_UNTAG(tag),
 193                 hb_blob_get_length (contents),
 194                 hb_blob_get_length (source_blob));
 195       hb_blob_destroy (source_blob);
 196     }
 197     return hb_face_builder_add_table (dest, tag, contents);
 198   }
 199 };
 200
 201 typedef struct hb_subset_plan_t hb_subset_plan_t;
 202
 203 HB_INTERNAL hb_subset_plan_t *
 204 hb_subset_plan_create (hb_face_t           *face,
 205                        const hb_subset_input_t   *input);
 206
 207 HB_INTERNAL void
 208 hb_subset_plan_destroy (hb_subset_plan_t *plan);
 209
 210 #endif /* HB_SUBSET_PLAN_HH */