src/hb-ot-map-private.hh

   1 /*
   2  * Copyright © 2009,2010  Red Hat, Inc.
   3  * Copyright © 2010,2011,2012  Google, Inc.
   4  *
   5  *  This is part of HarfBuzz, a text shaping library.
   6  *
   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.
  12  *
  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
  17  * DAMAGE.
  18  *
  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.
  24  *
  25  * Red Hat Author(s): Behdad Esfahbod
  26  * Google Author(s): Behdad Esfahbod
  27  */
  28
  29 #ifndef HB_OT_MAP_PRIVATE_HH
  30 #define HB_OT_MAP_PRIVATE_HH
  31
  32 #include "hb-buffer-private.hh"
  33
  34 #include "hb-ot-layout-private.hh"
  35
  36
  37 static const hb_tag_t table_tags[2] = {HB_OT_TAG_GSUB, HB_OT_TAG_GPOS};
  38
  39 struct hb_ot_map_t
  40 {
  41   friend struct hb_ot_map_builder_t;
  42
  43   public:
  44
  45   struct feature_map_t {
  46     hb_tag_t tag; /* should be first for our bsearch to work */
  47     unsigned int index[2]; /* GSUB/GPOS */
  48     unsigned int stage[2]; /* GSUB/GPOS */
  49     unsigned int shift;
  50     hb_mask_t mask;
  51     hb_mask_t _1_mask; /* mask for value=1, for quick access */
  52
  53     static int cmp (const feature_map_t *a, const feature_map_t *b)
  54     { return a->tag < b->tag ? -1 : a->tag > b->tag ? 1 : 0; }
  55   };
  56
  57   struct lookup_map_t {
  58     unsigned int index;
  59     hb_mask_t mask;
  60
  61     static int cmp (const lookup_map_t *a, const lookup_map_t *b)
  62     { return a->index < b->index ? -1 : a->index > b->index ? 1 : 0; }
  63   };
  64
  65   typedef void (*pause_func_t) (const struct hb_ot_shape_plan_t *plan, hb_font_t *font, hb_buffer_t *buffer);
  66
  67   struct pause_map_t {
  68     unsigned int num_lookups; /* Cumulative */
  69     pause_func_t callback;
  70   };
  71
  72
  73   hb_ot_map_t (void) { memset (this, 0, sizeof (*this)); }
  74
  75   inline hb_mask_t get_global_mask (void) const { return global_mask; }
  76
  77   inline hb_mask_t get_mask (hb_tag_t feature_tag, unsigned int *shift = NULL) const {
  78     const feature_map_t *map = features.bsearch (&feature_tag);
  79     if (shift) *shift = map ? map->shift : 0;
  80     return map ? map->mask : 0;
  81   }
  82
  83   inline hb_mask_t get_1_mask (hb_tag_t feature_tag) const {
  84     const feature_map_t *map = features.bsearch (&feature_tag);
  85     return map ? map->_1_mask : 0;
  86   }
  87
  88   inline unsigned int get_feature_index (unsigned int table_index, hb_tag_t feature_tag) const {
  89     const feature_map_t *map = features.bsearch (&feature_tag);
  90     return map ? map->index[table_index] : HB_OT_LAYOUT_NO_FEATURE_INDEX;
  91   }
  92
  93   inline unsigned int get_feature_stage (unsigned int table_index, hb_tag_t feature_tag) const {
  94     const feature_map_t *map = features.bsearch (&feature_tag);
  95     return map ? map->stage[table_index] : (unsigned int) -1;
  96   }
  97
  98   inline void get_stage_lookups (unsigned int table_index, unsigned int stage,
  99                                  const struct lookup_map_t **plookups, unsigned int *lookup_count) const {
 100     if (unlikely (stage == (unsigned int) -1)) {
 101       *plookups = NULL;
 102       *lookup_count = 0;
 103       return;
 104     }
 105     assert (stage <= pauses[table_index].len);
 106     unsigned int start = stage ? pauses[table_index][stage - 1].num_lookups : 0;
 107     unsigned int end   = stage < pauses[table_index].len ? pauses[table_index][stage].num_lookups : lookups[table_index].len;
 108     *plookups = &lookups[table_index][start];
 109     *lookup_count = end - start;
 110   }
 111
 112   inline hb_tag_t get_chosen_script (unsigned int table_index) const
 113   { return chosen_script[table_index]; }
 114
 115   HB_INTERNAL void substitute_closure (const struct hb_ot_shape_plan_t *plan, hb_face_t *face, hb_set_t *glyphs) const;
 116   HB_INTERNAL void substitute (const struct hb_ot_shape_plan_t *plan, hb_font_t *font, hb_buffer_t *buffer) const;
 117   HB_INTERNAL void position (const struct hb_ot_shape_plan_t *plan, hb_font_t *font, hb_buffer_t *buffer) const;
 118
 119   inline void finish (void) {
 120     features.finish ();
 121     lookups[0].finish ();
 122     lookups[1].finish ();
 123     pauses[0].finish ();
 124     pauses[1].finish ();
 125   }
 126
 127
 128   private:
 129
 130   HB_INTERNAL void add_lookups (hb_face_t    *face,
 131                                 unsigned int  table_index,
 132                                 unsigned int  feature_index,
 133                                 hb_mask_t     mask);
 134
 135   hb_mask_t global_mask;
 136
 137   hb_tag_t chosen_script[2];
 138   hb_prealloced_array_t<feature_map_t, 8> features;
 139   hb_prealloced_array_t<lookup_map_t, 32> lookups[2]; /* GSUB/GPOS */
 140   hb_prealloced_array_t<pause_map_t, 1> pauses[2]; /* GSUB/GPOS */
 141 };
 142
 143
 144 struct hb_ot_map_builder_t
 145 {
 146   public:
 147
 148   hb_ot_map_builder_t (void) { memset (this, 0, sizeof (*this)); }
 149
 150   HB_INTERNAL void add_feature (hb_tag_t tag, unsigned int value, bool global);
 151
 152   inline void add_bool_feature (hb_tag_t tag, bool global = true)
 153   { add_feature (tag, 1, global); }
 154
 155   inline void add_gsub_pause (hb_ot_map_t::pause_func_t pause_func)
 156   { add_pause (0, pause_func); }
 157   inline void add_gpos_pause (hb_ot_map_t::pause_func_t pause_func)
 158   { add_pause (1, pause_func); }
 159
 160   HB_INTERNAL void compile (hb_face_t *face,
 161                             const hb_segment_properties_t *props,
 162                             struct hb_ot_map_t &m);
 163
 164   inline void finish (void) {
 165     feature_infos.finish ();
 166     pauses[0].finish ();
 167     pauses[1].finish ();
 168   }
 169
 170   private:
 171
 172   struct feature_info_t {
 173     hb_tag_t tag;
 174     unsigned int seq; /* sequence#, used for stable sorting only */
 175     unsigned int max_value;
 176     bool global; /* whether the feature applies value to every glyph in the buffer */
 177     unsigned int default_value; /* for non-global features, what should the unset glyphs take */
 178     unsigned int stage[2]; /* GSUB/GPOS */
 179
 180     static int cmp (const feature_info_t *a, const feature_info_t *b)
 181     { return (a->tag != b->tag) ?  (a->tag < b->tag ? -1 : 1) : (a->seq < b->seq ? -1 : 1); }
 182   };
 183
 184   struct pause_info_t {
 185     unsigned int stage;
 186     hb_ot_map_t::pause_func_t callback;
 187   };
 188
 189   HB_INTERNAL void add_pause (unsigned int table_index, hb_ot_map_t::pause_func_t pause_func);
 190
 191   unsigned int current_stage[2]; /* GSUB/GPOS */
 192   hb_prealloced_array_t<feature_info_t,16> feature_infos;
 193   hb_prealloced_array_t<pause_info_t, 1> pauses[2]; /* GSUB/GPOS */
 194 };
 195
 196
 197
 198 #endif /* HB_OT_MAP_PRIVATE_HH */