src/hb-subset.h

   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): Rod Sheeter
  25  */
  26
  27 #ifndef HB_SUBSET_H
  28 #define HB_SUBSET_H
  29
  30 #include "hb.h"
  31
  32 HB_BEGIN_DECLS
  33
  34 /**
  35  * hb_subset_input_t:
  36  *
  37  * Things that change based on the input. Characters to keep, etc.
  38  */
  39
  40 typedef struct hb_subset_input_t hb_subset_input_t;
  41
  42 /**
  43  * hb_subset_flags_t:
  44  * @HB_SUBSET_FLAGS_DEFAULT: all flags at their default value of false.
  45  * @HB_SUBSET_FLAGS_NO_HINTING: If set hinting instructions will be dropped in
  46  * the produced subset. Otherwise hinting instructions will be retained.
  47  * @HB_SUBSET_FLAGS_RETAIN_GIDS: If set glyph indices will not be modified in
  48  * the produced subset. If glyphs are dropped their indices will be retained
  49  * as an empty glyph.
  50  * @HB_SUBSET_FLAGS_DESUBROUTINIZE: If set and subsetting a CFF font the
  51  * subsetter will attempt to remove subroutines from the CFF glyphs.
  52  * @HB_SUBSET_FLAGS_NAME_LEGACY: If set non-unicode name records will be
  53  * retained in the subset.
  54  * @HB_SUBSET_FLAGS_SET_OVERLAPS_FLAG:  If set the subsetter will set the
  55  * OVERLAP_SIMPLE flag on each simple glyph.
  56  * @HB_SUBSET_FLAGS_PASSTHROUGH_UNRECOGNIZED: If set the subsetter will not
  57  * drop unrecognized tables and instead pass them through untouched.
  58  * @HB_SUBSET_FLAGS_NOTDEF_OUTLINE: If set the notdef glyph outline will be
  59  * retained in the final subset.
  60  * @HB_SUBSET_FLAGS_GLYPH_NAMES: If set the PS glyph names will be retained
  61  * in the final subset.
  62  * @HB_SUBSET_FLAGS_NO_PRUNE_UNICODE_RANGES: If set then the unicode ranges in
  63  * OS/2 will not be recalculated.
  64  *
  65  * List of boolean properties that can be configured on the subset input.
  66  *
  67  * Since: 2.9.0
  68  **/
  69 typedef enum { /*< flags >*/
  70   HB_SUBSET_FLAGS_DEFAULT =                  0x00000000u,
  71   HB_SUBSET_FLAGS_NO_HINTING =               0x00000001u,
  72   HB_SUBSET_FLAGS_RETAIN_GIDS =              0x00000002u,
  73   HB_SUBSET_FLAGS_DESUBROUTINIZE =           0x00000004u,
  74   HB_SUBSET_FLAGS_NAME_LEGACY =              0x00000008u,
  75   HB_SUBSET_FLAGS_SET_OVERLAPS_FLAG =        0x00000010u,
  76   HB_SUBSET_FLAGS_PASSTHROUGH_UNRECOGNIZED = 0x00000020u,
  77   HB_SUBSET_FLAGS_NOTDEF_OUTLINE =           0x00000040u,
  78   HB_SUBSET_FLAGS_GLYPH_NAMES =              0x00000080u,
  79   HB_SUBSET_FLAGS_NO_PRUNE_UNICODE_RANGES =  0x00000100u,
  80 } hb_subset_flags_t;
  81
  82 /**
  83  * hb_subset_sets_t:
  84  * @HB_SUBSET_SETS_GLYPH_INDEX: the set of glyph indexes to retain in the subset.
  85  * @HB_SUBSET_SETS_UNICODE: the set of unicode codepoints to retain in the subset.
  86  * @HB_SUBSET_SETS_NO_SUBSET_TABLE_TAG: the set of table tags which specifies tables that should not be
  87  * subsetted.
  88  * @HB_SUBSET_SETS_DROP_TABLE_TAG: the set of table tags which specifies tables which will be dropped
  89  * in the subset.
  90  * @HB_SUBSET_SETS_NAME_ID: the set of name ids that will be retained.
  91  * @HB_SUBSET_SETS_NAME_LANG_ID: the set of name lang ids that will be retained.
  92  * @HB_SUBSET_SETS_LAYOUT_FEATURE_TAG: the set of layout feature tags that will be retained
  93  * in the subset.
  94  *
  95  * List of sets that can be configured on the subset input.
  96  *
  97  * Since: 2.9.1
  98  **/
  99 typedef enum {
 100   HB_SUBSET_SETS_GLYPH_INDEX = 0,
 101   HB_SUBSET_SETS_UNICODE,
 102   HB_SUBSET_SETS_NO_SUBSET_TABLE_TAG,
 103   HB_SUBSET_SETS_DROP_TABLE_TAG,
 104   HB_SUBSET_SETS_NAME_ID,
 105   HB_SUBSET_SETS_NAME_LANG_ID,
 106   HB_SUBSET_SETS_LAYOUT_FEATURE_TAG,
 107 } hb_subset_sets_t;
 108
 109 HB_EXTERN hb_subset_input_t *
 110 hb_subset_input_create_or_fail (void);
 111
 112 HB_EXTERN hb_subset_input_t *
 113 hb_subset_input_reference (hb_subset_input_t *input);
 114
 115 HB_EXTERN void
 116 hb_subset_input_destroy (hb_subset_input_t *input);
 117
 118 HB_EXTERN hb_bool_t
 119 hb_subset_input_set_user_data (hb_subset_input_t  *input,
 120                                hb_user_data_key_t *key,
 121                                void *              data,
 122                                hb_destroy_func_t   destroy,
 123                                hb_bool_t           replace);
 124
 125 HB_EXTERN void *
 126 hb_subset_input_get_user_data (const hb_subset_input_t *input,
 127                                hb_user_data_key_t          *key);
 128
 129 HB_EXTERN hb_set_t *
 130 hb_subset_input_unicode_set (hb_subset_input_t *input);
 131
 132 HB_EXTERN hb_set_t *
 133 hb_subset_input_glyph_set (hb_subset_input_t *input);
 134
 135 HB_EXTERN hb_set_t *
 136 hb_subset_input_set (hb_subset_input_t *input, hb_subset_sets_t set_type);
 137
 138 HB_EXTERN hb_subset_flags_t
 139 hb_subset_input_get_flags (hb_subset_input_t *input);
 140
 141 HB_EXTERN void
 142 hb_subset_input_set_flags (hb_subset_input_t *input,
 143                            unsigned value);
 144
 145 HB_EXTERN hb_face_t *
 146 hb_subset_or_fail (hb_face_t *source, const hb_subset_input_t *input);
 147
 148 HB_END_DECLS
 149
 150 #endif /* HB_SUBSET_H */