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 #include "hb-ot.h" 32 33 HB_BEGIN_DECLS 34 35 /** 36 * hb_subset_input_t: 37 * 38 * Things that change based on the input. Characters to keep, etc. 39 */ 40 41 typedef struct hb_subset_input_t hb_subset_input_t; 42 43 /** 44 * hb_subset_plan_t: 45 * 46 * Contains information about how the subset operation will be executed. 47 * Such as mappings from the old glyph ids to the new ones in the subset. 48 */ 49 50 typedef struct hb_subset_plan_t hb_subset_plan_t; 51 52 /** 53 * hb_subset_flags_t: 54 * @HB_SUBSET_FLAGS_DEFAULT: all flags at their default value of false. 55 * @HB_SUBSET_FLAGS_NO_HINTING: If set hinting instructions will be dropped in 56 * the produced subset. Otherwise hinting instructions will be retained. 57 * @HB_SUBSET_FLAGS_RETAIN_GIDS: If set glyph indices will not be modified in 58 * the produced subset. If glyphs are dropped their indices will be retained 59 * as an empty glyph. 60 * @HB_SUBSET_FLAGS_DESUBROUTINIZE: If set and subsetting a CFF font the 61 * subsetter will attempt to remove subroutines from the CFF glyphs. 62 * @HB_SUBSET_FLAGS_NAME_LEGACY: If set non-unicode name records will be 63 * retained in the subset. 64 * @HB_SUBSET_FLAGS_SET_OVERLAPS_FLAG: If set the subsetter will set the 65 * OVERLAP_SIMPLE flag on each simple glyph. 66 * @HB_SUBSET_FLAGS_PASSTHROUGH_UNRECOGNIZED: If set the subsetter will not 67 * drop unrecognized tables and instead pass them through untouched. 68 * @HB_SUBSET_FLAGS_NOTDEF_OUTLINE: If set the notdef glyph outline will be 69 * retained in the final subset. 70 * @HB_SUBSET_FLAGS_GLYPH_NAMES: If set the PS glyph names will be retained 71 * in the final subset. 72 * @HB_SUBSET_FLAGS_NO_PRUNE_UNICODE_RANGES: If set then the unicode ranges in 73 * OS/2 will not be recalculated. 74 * @HB_SUBSET_FLAGS_NO_LAYOUT_CLOSURE: If set don't perform glyph closure on layout 75 * substitution rules (GSUB). Since: 7.2.0. 76 * @HB_SUBSET_FLAGS_OPTIMIZE_IUP_DELTAS: If set perform IUP delta optimization on the 77 * remaining gvar table's deltas. Since: 8.5.0 78 * @HB_SUBSET_FLAGS_IFTB_REQUIREMENTS: If set enforce requirements on the output subset 79 * to allow it to be used with incremental font transfer IFTB patches. Primarily, 80 * this forces all outline data to use long (32 bit) offsets. Since: EXPERIMENTAL 81 * 82 * List of boolean properties that can be configured on the subset input. 83 * 84 * Since: 2.9.0 85 **/ 86 typedef enum { /*< flags >*/ 87 HB_SUBSET_FLAGS_DEFAULT = 0x00000000u, 88 HB_SUBSET_FLAGS_NO_HINTING = 0x00000001u, 89 HB_SUBSET_FLAGS_RETAIN_GIDS = 0x00000002u, 90 HB_SUBSET_FLAGS_DESUBROUTINIZE = 0x00000004u, 91 HB_SUBSET_FLAGS_NAME_LEGACY = 0x00000008u, 92 HB_SUBSET_FLAGS_SET_OVERLAPS_FLAG = 0x00000010u, 93 HB_SUBSET_FLAGS_PASSTHROUGH_UNRECOGNIZED = 0x00000020u, 94 HB_SUBSET_FLAGS_NOTDEF_OUTLINE = 0x00000040u, 95 HB_SUBSET_FLAGS_GLYPH_NAMES = 0x00000080u, 96 HB_SUBSET_FLAGS_NO_PRUNE_UNICODE_RANGES = 0x00000100u, 97 HB_SUBSET_FLAGS_NO_LAYOUT_CLOSURE = 0x00000200u, 98 HB_SUBSET_FLAGS_OPTIMIZE_IUP_DELTAS = 0x00000400u, 99 #ifdef HB_EXPERIMENTAL_API 100 HB_SUBSET_FLAGS_IFTB_REQUIREMENTS = 0x00000800u, 101 #endif 102 } hb_subset_flags_t; 103 104 /** 105 * hb_subset_sets_t: 106 * @HB_SUBSET_SETS_GLYPH_INDEX: the set of glyph indexes to retain in the subset. 107 * @HB_SUBSET_SETS_UNICODE: the set of unicode codepoints to retain in the subset. 108 * @HB_SUBSET_SETS_NO_SUBSET_TABLE_TAG: the set of table tags which specifies tables that should not be 109 * subsetted. 110 * @HB_SUBSET_SETS_DROP_TABLE_TAG: the set of table tags which specifies tables which will be dropped 111 * in the subset. 112 * @HB_SUBSET_SETS_NAME_ID: the set of name ids that will be retained. 113 * @HB_SUBSET_SETS_NAME_LANG_ID: the set of name lang ids that will be retained. 114 * @HB_SUBSET_SETS_LAYOUT_FEATURE_TAG: the set of layout feature tags that will be retained 115 * in the subset. 116 * @HB_SUBSET_SETS_LAYOUT_SCRIPT_TAG: the set of layout script tags that will be retained 117 * in the subset. Defaults to all tags. Since: 5.0.0 118 * 119 * List of sets that can be configured on the subset input. 120 * 121 * Since: 2.9.1 122 **/ 123 typedef enum { 124 HB_SUBSET_SETS_GLYPH_INDEX = 0, 125 HB_SUBSET_SETS_UNICODE, 126 HB_SUBSET_SETS_NO_SUBSET_TABLE_TAG, 127 HB_SUBSET_SETS_DROP_TABLE_TAG, 128 HB_SUBSET_SETS_NAME_ID, 129 HB_SUBSET_SETS_NAME_LANG_ID, 130 HB_SUBSET_SETS_LAYOUT_FEATURE_TAG, 131 HB_SUBSET_SETS_LAYOUT_SCRIPT_TAG, 132 } hb_subset_sets_t; 133 134 HB_EXTERN hb_subset_input_t * 135 hb_subset_input_create_or_fail (void); 136 137 HB_EXTERN hb_subset_input_t * 138 hb_subset_input_reference (hb_subset_input_t *input); 139 140 HB_EXTERN void 141 hb_subset_input_destroy (hb_subset_input_t *input); 142 143 HB_EXTERN hb_bool_t 144 hb_subset_input_set_user_data (hb_subset_input_t *input, 145 hb_user_data_key_t *key, 146 void * data, 147 hb_destroy_func_t destroy, 148 hb_bool_t replace); 149 150 HB_EXTERN void * 151 hb_subset_input_get_user_data (const hb_subset_input_t *input, 152 hb_user_data_key_t *key); 153 154 HB_EXTERN void 155 hb_subset_input_keep_everything (hb_subset_input_t *input); 156 157 HB_EXTERN hb_set_t * 158 hb_subset_input_unicode_set (hb_subset_input_t *input); 159 160 HB_EXTERN hb_set_t * 161 hb_subset_input_glyph_set (hb_subset_input_t *input); 162 163 HB_EXTERN hb_set_t * 164 hb_subset_input_set (hb_subset_input_t *input, hb_subset_sets_t set_type); 165 166 HB_EXTERN hb_map_t* 167 hb_subset_input_old_to_new_glyph_mapping (hb_subset_input_t *input); 168 169 HB_EXTERN hb_subset_flags_t 170 hb_subset_input_get_flags (hb_subset_input_t *input); 171 172 HB_EXTERN void 173 hb_subset_input_set_flags (hb_subset_input_t *input, 174 unsigned value); 175 176 HB_EXTERN hb_bool_t 177 hb_subset_input_pin_all_axes_to_default (hb_subset_input_t *input, 178 hb_face_t *face); 179 180 HB_EXTERN hb_bool_t 181 hb_subset_input_pin_axis_to_default (hb_subset_input_t *input, 182 hb_face_t *face, 183 hb_tag_t axis_tag); 184 185 HB_EXTERN hb_bool_t 186 hb_subset_input_pin_axis_location (hb_subset_input_t *input, 187 hb_face_t *face, 188 hb_tag_t axis_tag, 189 float axis_value); 190 191 HB_EXTERN hb_bool_t 192 hb_subset_input_get_axis_range (hb_subset_input_t *input, 193 hb_tag_t axis_tag, 194 float *axis_min_value, 195 float *axis_max_value, 196 float *axis_def_value); 197 198 HB_EXTERN hb_bool_t 199 hb_subset_input_set_axis_range (hb_subset_input_t *input, 200 hb_face_t *face, 201 hb_tag_t axis_tag, 202 float axis_min_value, 203 float axis_max_value, 204 float axis_def_value); 205 206 HB_EXTERN hb_bool_t 207 hb_subset_axis_range_from_string (const char *str, int len, 208 float *axis_min_value, 209 float *axis_max_value, 210 float *axis_def_value); 211 212 HB_EXTERN void 213 hb_subset_axis_range_to_string (hb_subset_input_t *input, 214 hb_tag_t axis_tag, 215 char *buf, 216 unsigned size); 217 218 #ifdef HB_EXPERIMENTAL_API 219 HB_EXTERN hb_bool_t 220 hb_subset_input_override_name_table (hb_subset_input_t *input, 221 hb_ot_name_id_t name_id, 222 unsigned platform_id, 223 unsigned encoding_id, 224 unsigned language_id, 225 const char *name_str, 226 int str_len); 227 #endif 228 229 HB_EXTERN hb_face_t * 230 hb_subset_preprocess (hb_face_t *source); 231 232 HB_EXTERN hb_face_t * 233 hb_subset_or_fail (hb_face_t *source, const hb_subset_input_t *input); 234 235 HB_EXTERN hb_face_t * 236 hb_subset_plan_execute_or_fail (hb_subset_plan_t *plan); 237 238 HB_EXTERN hb_subset_plan_t * 239 hb_subset_plan_create_or_fail (hb_face_t *face, 240 const hb_subset_input_t *input); 241 242 HB_EXTERN void 243 hb_subset_plan_destroy (hb_subset_plan_t *plan); 244 245 HB_EXTERN hb_map_t * 246 hb_subset_plan_old_to_new_glyph_mapping (const hb_subset_plan_t *plan); 247 248 HB_EXTERN hb_map_t * 249 hb_subset_plan_new_to_old_glyph_mapping (const hb_subset_plan_t *plan); 250 251 HB_EXTERN hb_map_t * 252 hb_subset_plan_unicode_to_old_glyph_mapping (const hb_subset_plan_t *plan); 253 254 255 HB_EXTERN hb_subset_plan_t * 256 hb_subset_plan_reference (hb_subset_plan_t *plan); 257 258 HB_EXTERN hb_bool_t 259 hb_subset_plan_set_user_data (hb_subset_plan_t *plan, 260 hb_user_data_key_t *key, 261 void *data, 262 hb_destroy_func_t destroy, 263 hb_bool_t replace); 264 265 HB_EXTERN void * 266 hb_subset_plan_get_user_data (const hb_subset_plan_t *plan, 267 hb_user_data_key_t *key); 268 269 270 HB_END_DECLS 271 272 #endif /* HB_SUBSET_H */ 273