2 * Copyright © 2009,2010 Red Hat, Inc.
3 * Copyright © 2010,2011 Google, Inc.
5 * This is part of HarfBuzz, a text shaping library.
7 * Permission is hereby granted, without written agreement and without
8 * license or royalty fees, to use, copy, modify, and distribute this
9 * software and its documentation for any purpose, provided that the
10 * above copyright notice and the following two paragraphs appear in
11 * all copies of this software.
13 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
14 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
15 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
16 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
19 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
20 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
21 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
22 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
23 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
25 * Red Hat Author(s): Behdad Esfahbod
26 * Google Author(s): Behdad Esfahbod
29 #ifndef HB_OT_MAP_PRIVATE_HH
30 #define HB_OT_MAP_PRIVATE_HH
32 #include "hb-buffer-private.hh"
34 #include "hb-ot-layout.h"
38 static const hb_tag_t table_tags[2] = {HB_OT_TAG_GSUB, HB_OT_TAG_GPOS};
42 friend struct hb_ot_map_builder_t;
46 hb_ot_map_t (void) { memset (this, 0, sizeof (*this)); }
48 typedef void (*gsub_pause_func_t) (const hb_ot_map_t *map, hb_face_t *face, hb_buffer_t *buffer, void *user_data);
49 typedef void (*gpos_pause_func_t) (const hb_ot_map_t *map, hb_font_t *font, hb_buffer_t *buffer, void *user_data);
51 inline hb_mask_t get_global_mask (void) const { return global_mask; }
53 inline hb_mask_t get_mask (hb_tag_t tag, unsigned int *shift = NULL) const {
54 const feature_map_t *map = features.bsearch (&tag);
55 if (shift) *shift = map ? map->shift : 0;
56 return map ? map->mask : 0;
59 inline hb_mask_t get_1_mask (hb_tag_t tag) const {
60 const feature_map_t *map = features.bsearch (&tag);
61 return map ? map->_1_mask : 0;
64 inline hb_tag_t get_chosen_script (unsigned int table_index) const
65 { return chosen_script[table_index]; }
67 inline void substitute (hb_face_t *face, hb_buffer_t *buffer) const
68 { apply (0, (hb_ot_map_t::apply_lookup_func_t) hb_ot_layout_substitute_lookup, face, buffer); }
69 inline void position (hb_font_t *font, hb_buffer_t *buffer) const
70 { apply (1, (hb_ot_map_t::apply_lookup_func_t) hb_ot_layout_position_lookup, font, buffer); }
72 HB_INTERNAL void substitute_closure (hb_face_t *face,
73 hb_set_t *glyphs) const;
76 inline void finish (void) {
86 struct feature_map_t {
87 hb_tag_t tag; /* should be first for our bsearch to work */
88 unsigned int index[2]; /* GSUB/GPOS */
89 unsigned int stage[2]; /* GSUB/GPOS */
92 hb_mask_t _1_mask; /* mask for value=1, for quick access */
94 static int cmp (const feature_map_t *a, const feature_map_t *b)
95 { return a->tag < b->tag ? -1 : a->tag > b->tag ? 1 : 0; }
102 static int cmp (const lookup_map_t *a, const lookup_map_t *b)
103 { return a->index < b->index ? -1 : a->index > b->index ? 1 : 0; }
106 typedef void (*pause_func_t) (const hb_ot_map_t *map, void *face_or_font, hb_buffer_t *buffer, void *user_data);
113 unsigned int num_lookups; /* Cumulative */
114 pause_callback_t callback;
117 typedef hb_bool_t (*apply_lookup_func_t) (void *face_or_font,
119 unsigned int lookup_index,
122 HB_INTERNAL void add_lookups (hb_face_t *face,
123 unsigned int table_index,
124 unsigned int feature_index,
127 HB_INTERNAL void apply (unsigned int table_index,
128 hb_ot_map_t::apply_lookup_func_t apply_lookup_func,
130 hb_buffer_t *buffer) const;
132 hb_mask_t global_mask;
134 hb_tag_t chosen_script[2];
135 hb_prealloced_array_t<feature_map_t, 8> features;
136 hb_prealloced_array_t<lookup_map_t, 32> lookups[2]; /* GSUB/GPOS */
137 hb_prealloced_array_t<pause_map_t, 1> pauses[2]; /* GSUB/GPOS */
141 struct hb_ot_map_builder_t
145 hb_ot_map_builder_t (void) { memset (this, 0, sizeof (*this)); }
147 HB_INTERNAL void add_feature (hb_tag_t tag, unsigned int value, bool global);
149 inline void add_bool_feature (hb_tag_t tag, bool global = true)
150 { add_feature (tag, 1, global); }
152 inline void add_gsub_pause (hb_ot_map_t::gsub_pause_func_t pause_func, void *user_data)
153 { add_pause (0, (hb_ot_map_t::pause_func_t) pause_func, user_data); }
154 inline void add_gpos_pause (hb_ot_map_t::gpos_pause_func_t pause_func, void *user_data)
155 { add_pause (1, (hb_ot_map_t::pause_func_t) pause_func, user_data); }
157 HB_INTERNAL void compile (hb_face_t *face,
158 const hb_segment_properties_t *props,
159 struct hb_ot_map_t &m);
161 inline void finish (void) {
162 feature_infos.finish ();
169 struct feature_info_t {
171 unsigned int seq; /* sequence#, used for stable sorting only */
172 unsigned int max_value;
173 bool global; /* whether the feature applies value to every glyph in the buffer */
174 unsigned int default_value; /* for non-global features, what should the unset glyphs take */
175 unsigned int stage[2]; /* GSUB/GPOS */
177 static int cmp (const feature_info_t *a, const feature_info_t *b)
178 { return (a->tag != b->tag) ? (a->tag < b->tag ? -1 : 1) : (a->seq < b->seq ? -1 : 1); }
181 struct pause_info_t {
183 hb_ot_map_t::pause_callback_t callback;
186 HB_INTERNAL void add_pause (unsigned int table_index, hb_ot_map_t::pause_func_t pause_func, void *user_data);
188 unsigned int current_stage[2]; /* GSUB/GPOS */
189 hb_prealloced_array_t<feature_info_t,16> feature_infos;
190 hb_prealloced_array_t<pause_info_t, 1> pauses[2]; /* GSUB/GPOS */
195 #endif /* HB_OT_MAP_PRIVATE_HH */