src/hb-subset.h

   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
  32 HB_BEGIN_DECLS
  33
  34 /*
  35  * hb_subset_profile_t
  36  * Things that change based on target environment, e.g. OS.
  37  * Threadsafe for multiple concurrent subset operations.
  38  */
  39
  40 typedef struct hb_subset_profile_t hb_subset_profile_t;
  41
  42 HB_EXTERN hb_subset_profile_t *
  43 hb_subset_profile_create (void);
  44
  45 HB_EXTERN void
  46 hb_subset_profile_destroy (hb_subset_profile_t *profile);
  47
  48 /*
  49  * hb_subset_input_t
  50  *
  51  * Things that change based on the input. Characters to keep, etc.
  52  */
  53
  54 typedef struct hb_subset_input_t hb_subset_input_t;
  55
  56 HB_EXTERN hb_subset_input_t *
  57 hb_subset_input_create_or_fail (void);
  58
  59 HB_EXTERN hb_subset_input_t *
  60 hb_subset_input_reference (hb_subset_input_t *subset_input);
  61
  62 HB_EXTERN void
  63 hb_subset_input_destroy (hb_subset_input_t *subset_input);
  64
  65 HB_EXTERN hb_set_t *
  66 hb_subset_input_unicode_set (hb_subset_input_t *subset_input);
  67
  68 HB_EXTERN hb_set_t *
  69 hb_subset_input_glyph_set (hb_subset_input_t *subset_input);
  70
  71 HB_EXTERN hb_bool_t *
  72 hb_subset_input_drop_hints (hb_subset_input_t *subset_input);
  73
  74 HB_EXTERN hb_bool_t *
  75 hb_subset_input_drop_ot_layout (hb_subset_input_t *subset_input);
  76
  77 /* hb_subset() */
  78 HB_EXTERN hb_face_t *
  79 hb_subset (hb_face_t *source,
  80            hb_subset_profile_t *profile,
  81            hb_subset_input_t *input);
  82
  83 /* hb_subset_get_all_codepoints */
  84 HB_EXTERN void
  85 hb_subset_get_all_codepoints (hb_face_t *source, hb_set_t *out);
  86
  87 HB_END_DECLS
  88
  89 #endif /* HB_SUBSET_H */