2 * Copyright © 2018 Google, Inc.
4 * This is part of HarfBuzz, a text shaping library.
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.
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
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.
24 * Google Author(s): Rod Sheeter
38 * Things that change based on the input. Characters to keep, etc.
41 typedef struct hb_subset_input_t hb_subset_input_t
;
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.
50 typedef struct hb_subset_plan_t hb_subset_plan_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
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_IFTB_REQUIREMENTS: If set enforce requirements on the output subset
77 * to allow it to be used with incremental font transfer IFTB patches. Primarily,
78 * this forces all outline data to use long (32 bit) offsets. Since: EXPERIMENTAL
80 * List of boolean properties that can be configured on the subset input.
84 typedef enum { /*< flags >*/
85 HB_SUBSET_FLAGS_DEFAULT
= 0x00000000u
,
86 HB_SUBSET_FLAGS_NO_HINTING
= 0x00000001u
,
87 HB_SUBSET_FLAGS_RETAIN_GIDS
= 0x00000002u
,
88 HB_SUBSET_FLAGS_DESUBROUTINIZE
= 0x00000004u
,
89 HB_SUBSET_FLAGS_NAME_LEGACY
= 0x00000008u
,
90 HB_SUBSET_FLAGS_SET_OVERLAPS_FLAG
= 0x00000010u
,
91 HB_SUBSET_FLAGS_PASSTHROUGH_UNRECOGNIZED
= 0x00000020u
,
92 HB_SUBSET_FLAGS_NOTDEF_OUTLINE
= 0x00000040u
,
93 HB_SUBSET_FLAGS_GLYPH_NAMES
= 0x00000080u
,
94 HB_SUBSET_FLAGS_NO_PRUNE_UNICODE_RANGES
= 0x00000100u
,
95 HB_SUBSET_FLAGS_NO_LAYOUT_CLOSURE
= 0x00000200u
,
96 #ifdef HB_EXPERIMENTAL_API
97 HB_SUBSET_FLAGS_IFTB_REQUIREMENTS
= 0x00000400u
,
103 * @HB_SUBSET_SETS_GLYPH_INDEX: the set of glyph indexes to retain in the subset.
104 * @HB_SUBSET_SETS_UNICODE: the set of unicode codepoints to retain in the subset.
105 * @HB_SUBSET_SETS_NO_SUBSET_TABLE_TAG: the set of table tags which specifies tables that should not be
107 * @HB_SUBSET_SETS_DROP_TABLE_TAG: the set of table tags which specifies tables which will be dropped
109 * @HB_SUBSET_SETS_NAME_ID: the set of name ids that will be retained.
110 * @HB_SUBSET_SETS_NAME_LANG_ID: the set of name lang ids that will be retained.
111 * @HB_SUBSET_SETS_LAYOUT_FEATURE_TAG: the set of layout feature tags that will be retained
113 * @HB_SUBSET_SETS_LAYOUT_SCRIPT_TAG: the set of layout script tags that will be retained
114 * in the subset. Defaults to all tags. Since: 5.0.0
116 * List of sets that can be configured on the subset input.
121 HB_SUBSET_SETS_GLYPH_INDEX
= 0,
122 HB_SUBSET_SETS_UNICODE
,
123 HB_SUBSET_SETS_NO_SUBSET_TABLE_TAG
,
124 HB_SUBSET_SETS_DROP_TABLE_TAG
,
125 HB_SUBSET_SETS_NAME_ID
,
126 HB_SUBSET_SETS_NAME_LANG_ID
,
127 HB_SUBSET_SETS_LAYOUT_FEATURE_TAG
,
128 HB_SUBSET_SETS_LAYOUT_SCRIPT_TAG
,
131 HB_EXTERN hb_subset_input_t
*
132 hb_subset_input_create_or_fail (void);
134 HB_EXTERN hb_subset_input_t
*
135 hb_subset_input_reference (hb_subset_input_t
*input
);
138 hb_subset_input_destroy (hb_subset_input_t
*input
);
141 hb_subset_input_set_user_data (hb_subset_input_t
*input
,
142 hb_user_data_key_t
*key
,
144 hb_destroy_func_t destroy
,
148 hb_subset_input_get_user_data (const hb_subset_input_t
*input
,
149 hb_user_data_key_t
*key
);
152 hb_subset_input_keep_everything (hb_subset_input_t
*input
);
155 hb_subset_input_unicode_set (hb_subset_input_t
*input
);
158 hb_subset_input_glyph_set (hb_subset_input_t
*input
);
161 hb_subset_input_set (hb_subset_input_t
*input
, hb_subset_sets_t set_type
);
164 hb_subset_input_old_to_new_glyph_mapping (hb_subset_input_t
*input
);
166 HB_EXTERN hb_subset_flags_t
167 hb_subset_input_get_flags (hb_subset_input_t
*input
);
170 hb_subset_input_set_flags (hb_subset_input_t
*input
,
174 hb_subset_input_pin_axis_to_default (hb_subset_input_t
*input
,
179 hb_subset_input_pin_axis_location (hb_subset_input_t
*input
,
184 #ifdef HB_EXPERIMENTAL_API
186 hb_subset_input_set_axis_range (hb_subset_input_t
*input
,
189 float axis_min_value
,
190 float axis_max_value
,
191 float *axis_def_value
);
194 hb_subset_input_override_name_table (hb_subset_input_t
*input
,
195 hb_ot_name_id_t name_id
,
196 unsigned platform_id
,
197 unsigned encoding_id
,
198 unsigned language_id
,
199 const char *name_str
,
204 HB_EXTERN hb_face_t
*
205 hb_subset_preprocess (hb_face_t
*source
);
207 HB_EXTERN hb_face_t
*
208 hb_subset_or_fail (hb_face_t
*source
, const hb_subset_input_t
*input
);
210 HB_EXTERN hb_face_t
*
211 hb_subset_plan_execute_or_fail (hb_subset_plan_t
*plan
);
213 HB_EXTERN hb_subset_plan_t
*
214 hb_subset_plan_create_or_fail (hb_face_t
*face
,
215 const hb_subset_input_t
*input
);
218 hb_subset_plan_destroy (hb_subset_plan_t
*plan
);
221 hb_subset_plan_old_to_new_glyph_mapping (const hb_subset_plan_t
*plan
);
224 hb_subset_plan_new_to_old_glyph_mapping (const hb_subset_plan_t
*plan
);
227 hb_subset_plan_unicode_to_old_glyph_mapping (const hb_subset_plan_t
*plan
);
230 HB_EXTERN hb_subset_plan_t
*
231 hb_subset_plan_reference (hb_subset_plan_t
*plan
);
234 hb_subset_plan_set_user_data (hb_subset_plan_t
*plan
,
235 hb_user_data_key_t
*key
,
237 hb_destroy_func_t destroy
,
241 hb_subset_plan_get_user_data (const hb_subset_plan_t
*plan
,
242 hb_user_data_key_t
*key
);
247 #endif /* HB_SUBSET_H */