2018-01-18 07:09:07 +01:00
|
|
|
/*
|
2018-02-10 20:37:28 +01:00
|
|
|
* Copyright © 2018 Google, Inc.
|
2018-01-18 07:09:07 +01:00
|
|
|
*
|
|
|
|
* This is part of HarfBuzz, a text shaping library.
|
|
|
|
*
|
|
|
|
* Permission is hereby granted, without written agreement and without
|
|
|
|
* license or royalty fees, to use, copy, modify, and distribute this
|
|
|
|
* software and its documentation for any purpose, provided that the
|
|
|
|
* above copyright notice and the following two paragraphs appear in
|
|
|
|
* all copies of this software.
|
|
|
|
*
|
|
|
|
* IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
|
|
|
|
* DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
|
|
|
|
* ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
|
|
|
|
* IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
|
|
|
* DAMAGE.
|
|
|
|
*
|
|
|
|
* THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
|
|
|
|
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
|
|
|
|
* ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
|
|
|
|
* PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
|
|
|
|
*
|
|
|
|
* Google Author(s): Rod Sheeter
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef HB_SUBSET_H
|
|
|
|
#define HB_SUBSET_H
|
|
|
|
|
2018-02-05 02:22:07 +01:00
|
|
|
#include "hb.h"
|
2022-10-28 19:44:48 +02:00
|
|
|
#include "hb-ot.h"
|
2018-01-18 07:09:07 +01:00
|
|
|
|
|
|
|
HB_BEGIN_DECLS
|
|
|
|
|
2021-07-26 02:13:49 +02:00
|
|
|
/**
|
|
|
|
* hb_subset_input_t:
|
2018-02-13 22:50:50 +01:00
|
|
|
*
|
2018-01-18 07:09:07 +01:00
|
|
|
* Things that change based on the input. Characters to keep, etc.
|
|
|
|
*/
|
|
|
|
|
|
|
|
typedef struct hb_subset_input_t hb_subset_input_t;
|
|
|
|
|
2022-02-11 21:44:58 +01:00
|
|
|
/**
|
|
|
|
* hb_subset_plan_t:
|
|
|
|
*
|
|
|
|
* Contains information about how the subset operation will be executed.
|
|
|
|
* Such as mappings from the old glyph ids to the new ones in the subset.
|
|
|
|
*/
|
|
|
|
|
|
|
|
typedef struct hb_subset_plan_t hb_subset_plan_t;
|
|
|
|
|
2021-06-23 22:55:11 +02:00
|
|
|
/**
|
2021-07-29 20:52:14 +02:00
|
|
|
* hb_subset_flags_t:
|
2021-08-07 22:05:51 +02:00
|
|
|
* @HB_SUBSET_FLAGS_DEFAULT: all flags at their default value of false.
|
2021-07-29 20:52:14 +02:00
|
|
|
* @HB_SUBSET_FLAGS_NO_HINTING: If set hinting instructions will be dropped in
|
|
|
|
* the produced subset. Otherwise hinting instructions will be retained.
|
|
|
|
* @HB_SUBSET_FLAGS_RETAIN_GIDS: If set glyph indices will not be modified in
|
2021-06-23 22:55:11 +02:00
|
|
|
* the produced subset. If glyphs are dropped their indices will be retained
|
2021-08-07 22:05:51 +02:00
|
|
|
* as an empty glyph.
|
2021-07-29 20:52:14 +02:00
|
|
|
* @HB_SUBSET_FLAGS_DESUBROUTINIZE: If set and subsetting a CFF font the
|
2021-06-23 22:55:11 +02:00
|
|
|
* subsetter will attempt to remove subroutines from the CFF glyphs.
|
2021-07-29 20:52:14 +02:00
|
|
|
* @HB_SUBSET_FLAGS_NAME_LEGACY: If set non-unicode name records will be
|
2021-08-07 22:05:51 +02:00
|
|
|
* retained in the subset.
|
2021-07-30 00:25:41 +02:00
|
|
|
* @HB_SUBSET_FLAGS_SET_OVERLAPS_FLAG: If set the subsetter will set the
|
2021-08-07 22:05:51 +02:00
|
|
|
* OVERLAP_SIMPLE flag on each simple glyph.
|
2021-07-29 20:52:14 +02:00
|
|
|
* @HB_SUBSET_FLAGS_PASSTHROUGH_UNRECOGNIZED: If set the subsetter will not
|
2021-06-23 22:55:11 +02:00
|
|
|
* drop unrecognized tables and instead pass them through untouched.
|
2021-07-29 20:52:14 +02:00
|
|
|
* @HB_SUBSET_FLAGS_NOTDEF_OUTLINE: If set the notdef glyph outline will be
|
2021-08-07 22:05:51 +02:00
|
|
|
* retained in the final subset.
|
2021-07-29 20:52:14 +02:00
|
|
|
* @HB_SUBSET_FLAGS_GLYPH_NAMES: If set the PS glyph names will be retained
|
2021-08-07 22:05:51 +02:00
|
|
|
* in the final subset.
|
2021-07-29 20:52:14 +02:00
|
|
|
* @HB_SUBSET_FLAGS_NO_PRUNE_UNICODE_RANGES: If set then the unicode ranges in
|
2021-07-22 21:41:48 +02:00
|
|
|
* OS/2 will not be recalculated.
|
2022-10-13 20:53:41 +02:00
|
|
|
* @HB_SUBSET_FLAGS_PATCH_MODE: If set the subsetter behaviour will be modified
|
|
|
|
* to produce a subset that is better suited to patching. For example cmap
|
|
|
|
* subtable format will be kept stable.
|
|
|
|
* @HB_SUBSET_FLAGS_OMIT_GLYF: If set the subsetter won't actually produce the final
|
|
|
|
* glyf table bytes. The table directory will include and entry as if the table was
|
|
|
|
* there but the actual final font blob will be truncated prior to the glyf data. This
|
|
|
|
* is a useful performance optimization when a font aware binary patching algorithm
|
|
|
|
* is being used to diff two subsets.
|
2021-06-23 22:55:11 +02:00
|
|
|
*
|
|
|
|
* List of boolean properties that can be configured on the subset input.
|
|
|
|
*
|
2021-08-18 09:32:04 +02:00
|
|
|
* Since: 2.9.0
|
2021-06-23 22:55:11 +02:00
|
|
|
**/
|
2021-07-30 00:25:41 +02:00
|
|
|
typedef enum { /*< flags >*/
|
|
|
|
HB_SUBSET_FLAGS_DEFAULT = 0x00000000u,
|
|
|
|
HB_SUBSET_FLAGS_NO_HINTING = 0x00000001u,
|
|
|
|
HB_SUBSET_FLAGS_RETAIN_GIDS = 0x00000002u,
|
|
|
|
HB_SUBSET_FLAGS_DESUBROUTINIZE = 0x00000004u,
|
|
|
|
HB_SUBSET_FLAGS_NAME_LEGACY = 0x00000008u,
|
|
|
|
HB_SUBSET_FLAGS_SET_OVERLAPS_FLAG = 0x00000010u,
|
|
|
|
HB_SUBSET_FLAGS_PASSTHROUGH_UNRECOGNIZED = 0x00000020u,
|
|
|
|
HB_SUBSET_FLAGS_NOTDEF_OUTLINE = 0x00000040u,
|
|
|
|
HB_SUBSET_FLAGS_GLYPH_NAMES = 0x00000080u,
|
|
|
|
HB_SUBSET_FLAGS_NO_PRUNE_UNICODE_RANGES = 0x00000100u,
|
2022-10-14 01:42:00 +02:00
|
|
|
// Not supported yet: HB_SUBSET_FLAGS_PATCH_MODE = 0x00000200u,
|
|
|
|
// Not supported yet: HB_SUBSET_FLAGS_OMIT_GLYF = 0x00000400u,
|
2021-07-29 20:52:14 +02:00
|
|
|
} hb_subset_flags_t;
|
2021-06-09 20:09:14 +02:00
|
|
|
|
2021-08-13 19:53:20 +02:00
|
|
|
/**
|
|
|
|
* hb_subset_sets_t:
|
2021-09-07 15:05:42 +02:00
|
|
|
* @HB_SUBSET_SETS_GLYPH_INDEX: the set of glyph indexes to retain in the subset.
|
|
|
|
* @HB_SUBSET_SETS_UNICODE: the set of unicode codepoints to retain in the subset.
|
2021-08-13 19:53:20 +02:00
|
|
|
* @HB_SUBSET_SETS_NO_SUBSET_TABLE_TAG: the set of table tags which specifies tables that should not be
|
|
|
|
* subsetted.
|
|
|
|
* @HB_SUBSET_SETS_DROP_TABLE_TAG: the set of table tags which specifies tables which will be dropped
|
|
|
|
* in the subset.
|
2021-08-26 00:10:21 +02:00
|
|
|
* @HB_SUBSET_SETS_NAME_ID: the set of name ids that will be retained.
|
|
|
|
* @HB_SUBSET_SETS_NAME_LANG_ID: the set of name lang ids that will be retained.
|
|
|
|
* @HB_SUBSET_SETS_LAYOUT_FEATURE_TAG: the set of layout feature tags that will be retained
|
|
|
|
* in the subset.
|
2022-06-30 23:00:48 +02:00
|
|
|
* @HB_SUBSET_SETS_LAYOUT_SCRIPT_TAG: the set of layout script tags that will be retained
|
2022-07-23 16:45:32 +02:00
|
|
|
* in the subset. Defaults to all tags. Since: 5.0.0
|
2021-08-13 19:53:20 +02:00
|
|
|
*
|
|
|
|
* List of sets that can be configured on the subset input.
|
|
|
|
*
|
2021-09-07 13:46:08 +02:00
|
|
|
* Since: 2.9.1
|
2021-08-13 19:53:20 +02:00
|
|
|
**/
|
2021-08-25 23:56:55 +02:00
|
|
|
typedef enum {
|
2021-08-26 00:01:28 +02:00
|
|
|
HB_SUBSET_SETS_GLYPH_INDEX = 0,
|
|
|
|
HB_SUBSET_SETS_UNICODE,
|
2021-08-13 19:53:20 +02:00
|
|
|
HB_SUBSET_SETS_NO_SUBSET_TABLE_TAG,
|
|
|
|
HB_SUBSET_SETS_DROP_TABLE_TAG,
|
2021-08-26 00:10:21 +02:00
|
|
|
HB_SUBSET_SETS_NAME_ID,
|
|
|
|
HB_SUBSET_SETS_NAME_LANG_ID,
|
|
|
|
HB_SUBSET_SETS_LAYOUT_FEATURE_TAG,
|
2022-06-30 23:00:48 +02:00
|
|
|
HB_SUBSET_SETS_LAYOUT_SCRIPT_TAG,
|
2021-08-13 19:53:20 +02:00
|
|
|
} hb_subset_sets_t;
|
|
|
|
|
2018-01-18 07:09:07 +01:00
|
|
|
HB_EXTERN hb_subset_input_t *
|
2018-02-14 07:07:12 +01:00
|
|
|
hb_subset_input_create_or_fail (void);
|
2018-02-13 22:50:50 +01:00
|
|
|
|
|
|
|
HB_EXTERN hb_subset_input_t *
|
2021-06-28 21:57:39 +02:00
|
|
|
hb_subset_input_reference (hb_subset_input_t *input);
|
2018-01-18 07:09:07 +01:00
|
|
|
|
|
|
|
HB_EXTERN void
|
2021-06-28 21:57:39 +02:00
|
|
|
hb_subset_input_destroy (hb_subset_input_t *input);
|
2018-01-18 07:09:07 +01:00
|
|
|
|
2021-06-23 22:38:47 +02:00
|
|
|
HB_EXTERN hb_bool_t
|
|
|
|
hb_subset_input_set_user_data (hb_subset_input_t *input,
|
|
|
|
hb_user_data_key_t *key,
|
|
|
|
void * data,
|
|
|
|
hb_destroy_func_t destroy,
|
|
|
|
hb_bool_t replace);
|
|
|
|
|
|
|
|
HB_EXTERN void *
|
|
|
|
hb_subset_input_get_user_data (const hb_subset_input_t *input,
|
2022-02-11 23:54:23 +01:00
|
|
|
hb_user_data_key_t *key);
|
2021-06-23 22:38:47 +02:00
|
|
|
|
2021-09-16 20:23:09 +02:00
|
|
|
HB_EXTERN hb_set_t *
|
|
|
|
hb_subset_input_unicode_set (hb_subset_input_t *input);
|
|
|
|
|
|
|
|
HB_EXTERN hb_set_t *
|
|
|
|
hb_subset_input_glyph_set (hb_subset_input_t *input);
|
|
|
|
|
2019-04-05 19:05:55 +02:00
|
|
|
HB_EXTERN hb_set_t *
|
2021-08-13 19:53:20 +02:00
|
|
|
hb_subset_input_set (hb_subset_input_t *input, hb_subset_sets_t set_type);
|
2021-06-09 20:09:14 +02:00
|
|
|
|
2021-07-29 20:52:14 +02:00
|
|
|
HB_EXTERN hb_subset_flags_t
|
|
|
|
hb_subset_input_get_flags (hb_subset_input_t *input);
|
2021-06-09 20:09:14 +02:00
|
|
|
|
|
|
|
HB_EXTERN void
|
2021-07-29 20:52:14 +02:00
|
|
|
hb_subset_input_set_flags (hb_subset_input_t *input,
|
2021-07-30 00:25:41 +02:00
|
|
|
unsigned value);
|
2021-06-09 20:09:14 +02:00
|
|
|
|
2022-06-22 04:29:52 +02:00
|
|
|
HB_EXTERN hb_bool_t
|
|
|
|
hb_subset_input_pin_axis_to_default (hb_subset_input_t *input,
|
|
|
|
hb_face_t *face,
|
|
|
|
hb_tag_t axis_tag);
|
|
|
|
|
|
|
|
HB_EXTERN hb_bool_t
|
|
|
|
hb_subset_input_pin_axis_location (hb_subset_input_t *input,
|
|
|
|
hb_face_t *face,
|
|
|
|
hb_tag_t axis_tag,
|
|
|
|
float axis_value);
|
2022-10-14 21:38:19 +02:00
|
|
|
|
|
|
|
#ifdef HB_EXPERIMENTAL_API
|
2022-11-10 19:33:26 +01:00
|
|
|
HB_EXTERN hb_bool_t
|
2022-10-28 19:44:48 +02:00
|
|
|
hb_subset_input_override_name_table (hb_subset_input_t *input,
|
|
|
|
hb_ot_name_id_t name_id,
|
2022-11-10 19:33:26 +01:00
|
|
|
unsigned platform_id,
|
|
|
|
unsigned encoding_id,
|
|
|
|
unsigned language_id,
|
2022-10-28 19:44:48 +02:00
|
|
|
const char *name_str,
|
|
|
|
int str_len);
|
|
|
|
|
2022-06-22 04:29:52 +02:00
|
|
|
#endif
|
|
|
|
|
2022-12-05 21:18:41 +01:00
|
|
|
HB_EXTERN hb_face_t *
|
|
|
|
hb_subset_preprocess (hb_face_t *source);
|
|
|
|
|
2021-06-10 01:33:50 +02:00
|
|
|
HB_EXTERN hb_face_t *
|
|
|
|
hb_subset_or_fail (hb_face_t *source, const hb_subset_input_t *input);
|
|
|
|
|
2022-02-11 21:44:58 +01:00
|
|
|
HB_EXTERN hb_face_t *
|
2022-02-11 23:54:23 +01:00
|
|
|
hb_subset_plan_execute_or_fail (hb_subset_plan_t *plan);
|
2022-02-11 21:44:58 +01:00
|
|
|
|
|
|
|
HB_EXTERN hb_subset_plan_t *
|
2022-02-12 01:01:33 +01:00
|
|
|
hb_subset_plan_create_or_fail (hb_face_t *face,
|
|
|
|
const hb_subset_input_t *input);
|
2022-02-11 21:44:58 +01:00
|
|
|
|
|
|
|
HB_EXTERN void
|
|
|
|
hb_subset_plan_destroy (hb_subset_plan_t *plan);
|
|
|
|
|
|
|
|
HB_EXTERN const hb_map_t*
|
|
|
|
hb_subset_plan_old_to_new_glyph_mapping (const hb_subset_plan_t *plan);
|
|
|
|
|
|
|
|
HB_EXTERN const hb_map_t*
|
|
|
|
hb_subset_plan_new_to_old_glyph_mapping (const hb_subset_plan_t *plan);
|
|
|
|
|
|
|
|
HB_EXTERN const hb_map_t*
|
2022-02-28 22:45:40 +01:00
|
|
|
hb_subset_plan_unicode_to_old_glyph_mapping (const hb_subset_plan_t *plan);
|
2022-02-11 21:44:58 +01:00
|
|
|
|
2022-02-11 23:54:23 +01:00
|
|
|
|
|
|
|
HB_EXTERN hb_subset_plan_t *
|
|
|
|
hb_subset_plan_reference (hb_subset_plan_t *plan);
|
|
|
|
|
|
|
|
HB_EXTERN hb_bool_t
|
|
|
|
hb_subset_plan_set_user_data (hb_subset_plan_t *plan,
|
|
|
|
hb_user_data_key_t *key,
|
|
|
|
void *data,
|
|
|
|
hb_destroy_func_t destroy,
|
|
|
|
hb_bool_t replace);
|
|
|
|
|
|
|
|
HB_EXTERN void *
|
|
|
|
hb_subset_plan_get_user_data (const hb_subset_plan_t *plan,
|
|
|
|
hb_user_data_key_t *key);
|
|
|
|
|
|
|
|
|
2018-01-18 07:09:07 +01:00
|
|
|
HB_END_DECLS
|
|
|
|
|
|
|
|
#endif /* HB_SUBSET_H */
|