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 drop_hints : 1;
  43   bool drop_layout : 1;
  44   bool desubroutinize : 1;
  45
  46   // For each cp that we'd like to retain maps to the corresponding gid.
  47   hb_set_t *unicodes;
  48
  49   // The glyph subset
  50   hb_map_t *codepoint_to_glyph;
  51
  52   // Old -> New glyph id mapping
  53   hb_map_t *glyph_map;
  54   hb_map_t *reverse_glyph_map;
  55
  56   // Plan is only good for a specific source/dest so keep them with it
  57   hb_face_t *source;
  58   hb_face_t *dest;
  59
  60   unsigned int _num_output_glyphs;
  61   hb_set_t *_glyphset;
  62
  63  public:
  64
  65   /*
  66    * The set of input glyph ids which will be retained in the subset.
  67    */
  68   inline const hb_set_t *
  69   glyphset () const
  70   {
  71     return _glyphset;
  72   }
  73
  74   /*
  75    * The total number of output glyphs in the final subset.
  76    */
  77   inline unsigned int
  78   num_output_glyphs () const
  79   {
  80     return _num_output_glyphs;
  81   }
  82
  83   /*
  84    * Given an output gid , returns true if that glyph id is an empty
  85    * glyph (ie. it's a gid that we are dropping all data for).
  86    */
  87   inline bool is_empty_glyph (hb_codepoint_t gid) const
  88   {
  89     return !_glyphset->has (gid);
  90   }
  91
  92   inline bool new_gid_for_codepoint (hb_codepoint_t codepoint,
  93                                      hb_codepoint_t *new_gid) const
  94   {
  95     hb_codepoint_t old_gid = codepoint_to_glyph->get (codepoint);
  96     if (old_gid == HB_MAP_VALUE_INVALID)
  97       return false;
  98
  99     return new_gid_for_old_gid (old_gid, new_gid);
 100   }
 101
 102   inline bool new_gid_for_old_gid (hb_codepoint_t old_gid,
 103                                    hb_codepoint_t *new_gid) const
 104   {
 105     hb_codepoint_t gid = glyph_map->get (old_gid);
 106     if (gid == HB_MAP_VALUE_INVALID)
 107       return false;
 108
 109     *new_gid = gid;
 110     return true;
 111   }
 112
 113   inline bool old_gid_for_new_gid (hb_codepoint_t  new_gid,
 114                                    hb_codepoint_t *old_gid) const
 115   {
 116     hb_codepoint_t gid = reverse_glyph_map->get (new_gid);
 117     if (gid == HB_MAP_VALUE_INVALID)
 118       return false;
 119
 120     *old_gid = gid;
 121     return true;
 122   }
 123
 124   inline bool
 125   add_table (hb_tag_t tag,
 126              hb_blob_t *contents)
 127   {
 128     hb_blob_t *source_blob = source->reference_table (tag);
 129     DEBUG_MSG(SUBSET, nullptr, "add table %c%c%c%c, dest %d bytes, source %d bytes",
 130               HB_UNTAG(tag),
 131               hb_blob_get_length (contents),
 132               hb_blob_get_length (source_blob));
 133     hb_blob_destroy (source_blob);
 134     return hb_face_builder_add_table (dest, tag, contents);
 135   }
 136 };
 137
 138 typedef struct hb_subset_plan_t hb_subset_plan_t;
 139
 140 HB_INTERNAL hb_subset_plan_t *
 141 hb_subset_plan_create (hb_face_t           *face,
 142                        hb_subset_input_t   *input);
 143
 144 HB_INTERNAL void
 145 hb_subset_plan_destroy (hb_subset_plan_t *plan);
 146
 147 #endif /* HB_SUBSET_PLAN_HH */