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-private.hh"
  31
  32 #include "hb-subset.h"
  33
  34 #include "hb-object-private.hh"
  35
  36 struct hb_subset_plan_t {
  37   hb_object_header_t header;
  38   ASSERT_POD ();
  39
  40   hb_bool_t drop_hints;
  41
  42   // TODO(Q1) actual map, drop this crap
  43   // Look at me ma, I'm a poor mans map codepoint : new gid
  44   // codepoints is sorted and aligned with gids_to_retain.
  45
  46   // These first two lists provide a mapping from cp -> gid
  47   // As a result it does not list the full set of glyphs to retain.
  48   hb_prealloced_array_t<hb_codepoint_t> codepoints;
  49   hb_prealloced_array_t<hb_codepoint_t> gids_to_retain;
  50
  51   // This list contains the complete set of glyphs to retain and may contain
  52   // more glyphs then the lists above.
  53   hb_prealloced_array_t<hb_codepoint_t> gids_to_retain_sorted;
  54
  55   // Plan is only good for a specific source/dest so keep them with it
  56   hb_face_t *source;
  57   hb_face_t *dest;
  58 };
  59
  60 typedef struct hb_subset_plan_t hb_subset_plan_t;
  61
  62 HB_INTERNAL hb_subset_plan_t *
  63 hb_subset_plan_create (hb_face_t           *face,
  64                        hb_subset_profile_t *profile,
  65                        hb_subset_input_t   *input);
  66
  67 HB_INTERNAL hb_bool_t
  68 hb_subset_plan_new_gid_for_old_id(hb_subset_plan_t *plan,
  69                                   hb_codepoint_t old_gid,
  70                                   hb_codepoint_t *new_gid /* OUT */);
  71
  72 HB_INTERNAL hb_bool_t
  73 hb_subset_plan_new_gid_for_codepoint(hb_subset_plan_t *plan,
  74                                      hb_codepoint_t codepont,
  75                                      hb_codepoint_t *new_gid /* OUT */);
  76
  77 HB_INTERNAL hb_bool_t
  78 hb_subset_plan_add_table(hb_subset_plan_t *plan,
  79                          hb_tag_t tag,
  80                          hb_blob_t *contents);
  81
  82 HB_INTERNAL void
  83 hb_subset_plan_destroy (hb_subset_plan_t *plan);
  84
  85 #endif /* HB_SUBSET_PLAN_HH */