comparison mupdf-source/thirdparty/harfbuzz/src/hb-subset.h @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
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_PATCH_MODE: If set the subsetter behaviour will be modified
75 * to produce a subset that is better suited to patching. For example cmap
76 * subtable format will be kept stable.
77 * @HB_SUBSET_FLAGS_OMIT_GLYF: If set the subsetter won't actually produce the final
78 * glyf table bytes. The table directory will include and entry as if the table was
79 * there but the actual final font blob will be truncated prior to the glyf data. This
80 * is a useful performance optimization when a font aware binary patching algorithm
81 * is being used to diff two subsets.
82 *
83 * List of boolean properties that can be configured on the subset input.
84 *
85 * Since: 2.9.0
86 **/
87 typedef enum { /*< flags >*/
88 HB_SUBSET_FLAGS_DEFAULT = 0x00000000u,
89 HB_SUBSET_FLAGS_NO_HINTING = 0x00000001u,
90 HB_SUBSET_FLAGS_RETAIN_GIDS = 0x00000002u,
91 HB_SUBSET_FLAGS_DESUBROUTINIZE = 0x00000004u,
92 HB_SUBSET_FLAGS_NAME_LEGACY = 0x00000008u,
93 HB_SUBSET_FLAGS_SET_OVERLAPS_FLAG = 0x00000010u,
94 HB_SUBSET_FLAGS_PASSTHROUGH_UNRECOGNIZED = 0x00000020u,
95 HB_SUBSET_FLAGS_NOTDEF_OUTLINE = 0x00000040u,
96 HB_SUBSET_FLAGS_GLYPH_NAMES = 0x00000080u,
97 HB_SUBSET_FLAGS_NO_PRUNE_UNICODE_RANGES = 0x00000100u,
98 // Not supported yet: HB_SUBSET_FLAGS_PATCH_MODE = 0x00000200u,
99 // Not supported yet: HB_SUBSET_FLAGS_OMIT_GLYF = 0x00000400u,
100 } hb_subset_flags_t;
101
102 /**
103 * hb_subset_sets_t:
104 * @HB_SUBSET_SETS_GLYPH_INDEX: the set of glyph indexes to retain in the subset.
105 * @HB_SUBSET_SETS_UNICODE: the set of unicode codepoints to retain in the subset.
106 * @HB_SUBSET_SETS_NO_SUBSET_TABLE_TAG: the set of table tags which specifies tables that should not be
107 * subsetted.
108 * @HB_SUBSET_SETS_DROP_TABLE_TAG: the set of table tags which specifies tables which will be dropped
109 * in the subset.
110 * @HB_SUBSET_SETS_NAME_ID: the set of name ids that will be retained.
111 * @HB_SUBSET_SETS_NAME_LANG_ID: the set of name lang ids that will be retained.
112 * @HB_SUBSET_SETS_LAYOUT_FEATURE_TAG: the set of layout feature tags that will be retained
113 * in the subset.
114 * @HB_SUBSET_SETS_LAYOUT_SCRIPT_TAG: the set of layout script tags that will be retained
115 * in the subset. Defaults to all tags. Since: 5.0.0
116 *
117 * List of sets that can be configured on the subset input.
118 *
119 * Since: 2.9.1
120 **/
121 typedef enum {
122 HB_SUBSET_SETS_GLYPH_INDEX = 0,
123 HB_SUBSET_SETS_UNICODE,
124 HB_SUBSET_SETS_NO_SUBSET_TABLE_TAG,
125 HB_SUBSET_SETS_DROP_TABLE_TAG,
126 HB_SUBSET_SETS_NAME_ID,
127 HB_SUBSET_SETS_NAME_LANG_ID,
128 HB_SUBSET_SETS_LAYOUT_FEATURE_TAG,
129 HB_SUBSET_SETS_LAYOUT_SCRIPT_TAG,
130 } hb_subset_sets_t;
131
132 HB_EXTERN hb_subset_input_t *
133 hb_subset_input_create_or_fail (void);
134
135 HB_EXTERN hb_subset_input_t *
136 hb_subset_input_reference (hb_subset_input_t *input);
137
138 HB_EXTERN void
139 hb_subset_input_destroy (hb_subset_input_t *input);
140
141 HB_EXTERN hb_bool_t
142 hb_subset_input_set_user_data (hb_subset_input_t *input,
143 hb_user_data_key_t *key,
144 void * data,
145 hb_destroy_func_t destroy,
146 hb_bool_t replace);
147
148 HB_EXTERN void *
149 hb_subset_input_get_user_data (const hb_subset_input_t *input,
150 hb_user_data_key_t *key);
151
152 HB_EXTERN hb_set_t *
153 hb_subset_input_unicode_set (hb_subset_input_t *input);
154
155 HB_EXTERN hb_set_t *
156 hb_subset_input_glyph_set (hb_subset_input_t *input);
157
158 HB_EXTERN hb_set_t *
159 hb_subset_input_set (hb_subset_input_t *input, hb_subset_sets_t set_type);
160
161 HB_EXTERN hb_subset_flags_t
162 hb_subset_input_get_flags (hb_subset_input_t *input);
163
164 HB_EXTERN void
165 hb_subset_input_set_flags (hb_subset_input_t *input,
166 unsigned value);
167
168 HB_EXTERN hb_bool_t
169 hb_subset_input_pin_axis_to_default (hb_subset_input_t *input,
170 hb_face_t *face,
171 hb_tag_t axis_tag);
172
173 HB_EXTERN hb_bool_t
174 hb_subset_input_pin_axis_location (hb_subset_input_t *input,
175 hb_face_t *face,
176 hb_tag_t axis_tag,
177 float axis_value);
178
179 #ifdef HB_EXPERIMENTAL_API
180 HB_EXTERN hb_bool_t
181 hb_subset_input_override_name_table (hb_subset_input_t *input,
182 hb_ot_name_id_t name_id,
183 unsigned platform_id,
184 unsigned encoding_id,
185 unsigned language_id,
186 const char *name_str,
187 int str_len);
188
189 #endif
190
191 HB_EXTERN hb_face_t *
192 hb_subset_preprocess (hb_face_t *source);
193
194 HB_EXTERN hb_face_t *
195 hb_subset_or_fail (hb_face_t *source, const hb_subset_input_t *input);
196
197 HB_EXTERN hb_face_t *
198 hb_subset_plan_execute_or_fail (hb_subset_plan_t *plan);
199
200 HB_EXTERN hb_subset_plan_t *
201 hb_subset_plan_create_or_fail (hb_face_t *face,
202 const hb_subset_input_t *input);
203
204 HB_EXTERN void
205 hb_subset_plan_destroy (hb_subset_plan_t *plan);
206
207 HB_EXTERN const hb_map_t*
208 hb_subset_plan_old_to_new_glyph_mapping (const hb_subset_plan_t *plan);
209
210 HB_EXTERN const hb_map_t*
211 hb_subset_plan_new_to_old_glyph_mapping (const hb_subset_plan_t *plan);
212
213 HB_EXTERN const hb_map_t*
214 hb_subset_plan_unicode_to_old_glyph_mapping (const hb_subset_plan_t *plan);
215
216
217 HB_EXTERN hb_subset_plan_t *
218 hb_subset_plan_reference (hb_subset_plan_t *plan);
219
220 HB_EXTERN hb_bool_t
221 hb_subset_plan_set_user_data (hb_subset_plan_t *plan,
222 hb_user_data_key_t *key,
223 void *data,
224 hb_destroy_func_t destroy,
225 hb_bool_t replace);
226
227 HB_EXTERN void *
228 hb_subset_plan_get_user_data (const hb_subset_plan_t *plan,
229 hb_user_data_key_t *key);
230
231
232 HB_END_DECLS
233
234 #endif /* HB_SUBSET_H */