hb-subset.h (10488B)
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 do not 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_NO_BIDI_CLOSURE: If set do not pull mirrored versions of input 79 * codepoints into the subset. Since: 11.1.0 80 * @HB_SUBSET_FLAGS_IFTB_REQUIREMENTS: If set enforce requirements on the output subset 81 * to allow it to be used with incremental font transfer IFTB patches. Primarily, 82 * this forces all outline data to use long (32 bit) offsets. Since: EXPERIMENTAL 83 * @HB_SUBSET_FLAGS_RETAIN_NUM_GLYPHS: If this flag is set along side 84 * HB_SUBSET_FLAGS_RETAIN_GIDS then the number of glyphs in the font won't 85 * be reduced as a result of subsetting. If necessary empty glyphs will be 86 * included at the end of the font to keep the number of glyphs unchanged. 87 * 88 * List of boolean properties that can be configured on the subset input. 89 * 90 * Since: 2.9.0 91 **/ 92 typedef enum { /*< flags >*/ 93 HB_SUBSET_FLAGS_DEFAULT = 0x00000000u, 94 HB_SUBSET_FLAGS_NO_HINTING = 0x00000001u, 95 HB_SUBSET_FLAGS_RETAIN_GIDS = 0x00000002u, 96 HB_SUBSET_FLAGS_DESUBROUTINIZE = 0x00000004u, 97 HB_SUBSET_FLAGS_NAME_LEGACY = 0x00000008u, 98 HB_SUBSET_FLAGS_SET_OVERLAPS_FLAG = 0x00000010u, 99 HB_SUBSET_FLAGS_PASSTHROUGH_UNRECOGNIZED = 0x00000020u, 100 HB_SUBSET_FLAGS_NOTDEF_OUTLINE = 0x00000040u, 101 HB_SUBSET_FLAGS_GLYPH_NAMES = 0x00000080u, 102 HB_SUBSET_FLAGS_NO_PRUNE_UNICODE_RANGES = 0x00000100u, 103 HB_SUBSET_FLAGS_NO_LAYOUT_CLOSURE = 0x00000200u, 104 HB_SUBSET_FLAGS_OPTIMIZE_IUP_DELTAS = 0x00000400u, 105 HB_SUBSET_FLAGS_NO_BIDI_CLOSURE = 0x00000800u, 106 #ifdef HB_EXPERIMENTAL_API 107 HB_SUBSET_FLAGS_IFTB_REQUIREMENTS = 0x00001000u, 108 HB_SUBSET_FLAGS_RETAIN_NUM_GLYPHS = 0x00002000u, 109 #endif 110 } hb_subset_flags_t; 111 112 /** 113 * hb_subset_sets_t: 114 * @HB_SUBSET_SETS_GLYPH_INDEX: the set of glyph indexes to retain in the subset. 115 * @HB_SUBSET_SETS_UNICODE: the set of unicode codepoints to retain in the subset. 116 * @HB_SUBSET_SETS_NO_SUBSET_TABLE_TAG: the set of table tags which specifies tables that should not be 117 * subsetted. 118 * @HB_SUBSET_SETS_DROP_TABLE_TAG: the set of table tags which specifies tables which will be dropped 119 * in the subset. 120 * @HB_SUBSET_SETS_NAME_ID: the set of name ids that will be retained. 121 * @HB_SUBSET_SETS_NAME_LANG_ID: the set of name lang ids that will be retained. 122 * @HB_SUBSET_SETS_LAYOUT_FEATURE_TAG: the set of layout feature tags that will be retained 123 * in the subset. 124 * @HB_SUBSET_SETS_LAYOUT_SCRIPT_TAG: the set of layout script tags that will be retained 125 * in the subset. Defaults to all tags. Since: 5.0.0 126 * 127 * List of sets that can be configured on the subset input. 128 * 129 * Since: 2.9.1 130 **/ 131 typedef enum { 132 HB_SUBSET_SETS_GLYPH_INDEX = 0, 133 HB_SUBSET_SETS_UNICODE, 134 HB_SUBSET_SETS_NO_SUBSET_TABLE_TAG, 135 HB_SUBSET_SETS_DROP_TABLE_TAG, 136 HB_SUBSET_SETS_NAME_ID, 137 HB_SUBSET_SETS_NAME_LANG_ID, 138 HB_SUBSET_SETS_LAYOUT_FEATURE_TAG, 139 HB_SUBSET_SETS_LAYOUT_SCRIPT_TAG, 140 } hb_subset_sets_t; 141 142 HB_EXTERN hb_subset_input_t * 143 hb_subset_input_create_or_fail (void); 144 145 HB_EXTERN hb_subset_input_t * 146 hb_subset_input_reference (hb_subset_input_t *input); 147 148 HB_EXTERN void 149 hb_subset_input_destroy (hb_subset_input_t *input); 150 151 HB_EXTERN hb_bool_t 152 hb_subset_input_set_user_data (hb_subset_input_t *input, 153 hb_user_data_key_t *key, 154 void * data, 155 hb_destroy_func_t destroy, 156 hb_bool_t replace); 157 158 HB_EXTERN void * 159 hb_subset_input_get_user_data (const hb_subset_input_t *input, 160 hb_user_data_key_t *key); 161 162 HB_EXTERN void 163 hb_subset_input_keep_everything (hb_subset_input_t *input); 164 165 HB_EXTERN hb_set_t * 166 hb_subset_input_unicode_set (hb_subset_input_t *input); 167 168 HB_EXTERN hb_set_t * 169 hb_subset_input_glyph_set (hb_subset_input_t *input); 170 171 HB_EXTERN hb_set_t * 172 hb_subset_input_set (hb_subset_input_t *input, hb_subset_sets_t set_type); 173 174 HB_EXTERN hb_map_t* 175 hb_subset_input_old_to_new_glyph_mapping (hb_subset_input_t *input); 176 177 HB_EXTERN hb_subset_flags_t 178 hb_subset_input_get_flags (hb_subset_input_t *input); 179 180 HB_EXTERN void 181 hb_subset_input_set_flags (hb_subset_input_t *input, 182 unsigned value); 183 184 HB_EXTERN hb_bool_t 185 hb_subset_input_pin_all_axes_to_default (hb_subset_input_t *input, 186 hb_face_t *face); 187 188 HB_EXTERN hb_bool_t 189 hb_subset_input_pin_axis_to_default (hb_subset_input_t *input, 190 hb_face_t *face, 191 hb_tag_t axis_tag); 192 193 HB_EXTERN hb_bool_t 194 hb_subset_input_pin_axis_location (hb_subset_input_t *input, 195 hb_face_t *face, 196 hb_tag_t axis_tag, 197 float axis_value); 198 199 HB_EXTERN hb_bool_t 200 hb_subset_input_get_axis_range (hb_subset_input_t *input, 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_input_set_axis_range (hb_subset_input_t *input, 208 hb_face_t *face, 209 hb_tag_t axis_tag, 210 float axis_min_value, 211 float axis_max_value, 212 float axis_def_value); 213 214 HB_EXTERN hb_bool_t 215 hb_subset_axis_range_from_string (const char *str, int len, 216 float *axis_min_value, 217 float *axis_max_value, 218 float *axis_def_value); 219 220 HB_EXTERN void 221 hb_subset_axis_range_to_string (hb_subset_input_t *input, 222 hb_tag_t axis_tag, 223 char *buf, 224 unsigned size); 225 226 #ifdef HB_EXPERIMENTAL_API 227 HB_EXTERN hb_bool_t 228 hb_subset_input_override_name_table (hb_subset_input_t *input, 229 hb_ot_name_id_t name_id, 230 unsigned platform_id, 231 unsigned encoding_id, 232 unsigned language_id, 233 const char *name_str, 234 int str_len); 235 236 237 /* 238 * Raw outline data access 239 */ 240 241 HB_EXTERN hb_blob_t* 242 hb_subset_cff_get_charstring_data (hb_face_t* face, hb_codepoint_t glyph_index); 243 244 HB_EXTERN hb_blob_t* 245 hb_subset_cff_get_charstrings_index (hb_face_t* face); 246 247 HB_EXTERN hb_blob_t* 248 hb_subset_cff2_get_charstring_data (hb_face_t* face, hb_codepoint_t glyph_index); 249 250 HB_EXTERN hb_blob_t* 251 hb_subset_cff2_get_charstrings_index (hb_face_t* face); 252 #endif 253 254 HB_EXTERN hb_face_t * 255 hb_subset_preprocess (hb_face_t *source); 256 257 HB_EXTERN hb_face_t * 258 hb_subset_or_fail (hb_face_t *source, const hb_subset_input_t *input); 259 260 HB_EXTERN hb_face_t * 261 hb_subset_plan_execute_or_fail (hb_subset_plan_t *plan); 262 263 HB_EXTERN hb_subset_plan_t * 264 hb_subset_plan_create_or_fail (hb_face_t *face, 265 const hb_subset_input_t *input); 266 267 HB_EXTERN void 268 hb_subset_plan_destroy (hb_subset_plan_t *plan); 269 270 HB_EXTERN hb_map_t * 271 hb_subset_plan_old_to_new_glyph_mapping (const hb_subset_plan_t *plan); 272 273 HB_EXTERN hb_map_t * 274 hb_subset_plan_new_to_old_glyph_mapping (const hb_subset_plan_t *plan); 275 276 HB_EXTERN hb_map_t * 277 hb_subset_plan_unicode_to_old_glyph_mapping (const hb_subset_plan_t *plan); 278 279 280 HB_EXTERN hb_subset_plan_t * 281 hb_subset_plan_reference (hb_subset_plan_t *plan); 282 283 HB_EXTERN hb_bool_t 284 hb_subset_plan_set_user_data (hb_subset_plan_t *plan, 285 hb_user_data_key_t *key, 286 void *data, 287 hb_destroy_func_t destroy, 288 hb_bool_t replace); 289 290 HB_EXTERN void * 291 hb_subset_plan_get_user_data (const hb_subset_plan_t *plan, 292 hb_user_data_key_t *key); 293 294 295 HB_END_DECLS 296 297 #endif /* HB_SUBSET_H */