When forming clusters, participate all mark types
[framework/uifw/harfbuzz.git] / src / hb-ot-map-private.hh
index 786a0d0..84b4ccf 100644 (file)
@@ -1,6 +1,6 @@
 /*
- * Copyright (C) 2009,2010  Red Hat, Inc.
- * Copyright (C) 2010  Google, Inc.
+ * Copyright © 2009,2010  Red Hat, Inc.
+ * Copyright © 2010,2011  Google, Inc.
  *
  *  This is part of HarfBuzz, a text shaping library.
  *
 #ifndef HB_OT_MAP_PRIVATE_HH
 #define HB_OT_MAP_PRIVATE_HH
 
-#include "hb-ot-shape-private.hh"
+#include "hb-buffer-private.hh"
 
 #include "hb-ot-layout.h"
 
 HB_BEGIN_DECLS
 
 
-#define MAX_FEATURES 100 /* FIXME */
-#define MAX_LOOKUPS 1000 /* FIXME */
-
 static const hb_tag_t table_tags[2] = {HB_OT_TAG_GSUB, HB_OT_TAG_GPOS};
 
-struct hb_mask_allocator_t {
+struct hb_ot_map_t
+{
+  friend struct hb_ot_map_builder_t;
 
-  struct feature_info_t {
-    hb_tag_t tag;
-    unsigned int value;
-    unsigned int seq;
-    bool global;
+  public:
 
-    static int
-    cmp (const void *p1, const void *p2)
-    {
-      const feature_info_t *a = reinterpret_cast<const feature_info_t *>(p1);
-      const feature_info_t *b = reinterpret_cast<const feature_info_t *>(p2);
+  typedef void (*gsub_pause_func_t) (const hb_ot_map_t *map, hb_face_t *face, hb_buffer_t *buffer, void *user_data);
+  typedef void (*gpos_pause_func_t) (const hb_ot_map_t *map, hb_font_t *font, hb_buffer_t *buffer, void *user_data);
 
-      if (a->tag != b->tag)
-        return a->tag < b->tag ? -1 : 1;
+  inline hb_mask_t get_global_mask (void) const { return global_mask; }
 
-      return a->seq < b->seq ? -1 : 1;
-    }
-  };
+  inline hb_mask_t get_mask (hb_tag_t tag, unsigned int *shift = NULL) const {
+    const feature_map_t *map = features.bsearch (&tag);
+    if (shift) *shift = map ? map->shift : 0;
+    return map ? map->mask : 0;
+  }
+
+  inline hb_mask_t get_1_mask (hb_tag_t tag) const {
+    const feature_map_t *map = features.bsearch (&tag);
+    return map ? map->_1_mask : 0;
+  }
+
+  inline void substitute (hb_face_t *face, hb_buffer_t *buffer) const
+  { apply (0, (hb_ot_map_t::apply_lookup_func_t) hb_ot_layout_substitute_lookup, face, buffer); }
+  inline void position (hb_font_t *font, hb_buffer_t *buffer) const
+  { apply (1, (hb_ot_map_t::apply_lookup_func_t) hb_ot_layout_position_lookup, font, buffer); }
+
+  inline void finish (void) {
+    features.finish ();
+    lookups[0].finish ();
+    lookups[1].finish ();
+    pauses[0].finish ();
+    pauses[1].finish ();
+  }
+
+  private:
 
   struct feature_map_t {
     hb_tag_t tag; /* should be first for our bsearch to work */
-    unsigned int index[2]; /* GSUB, GPOS */
+    unsigned int index[2]; /* GSUB/GPOS */
+    unsigned int stage[2]; /* GSUB/GPOS */
     unsigned int shift;
     hb_mask_t mask;
+    hb_mask_t _1_mask; /* mask for value=1, for quick access */
 
-    static int
-    cmp (const void *p1, const void *p2)
-    {
-      const feature_map_t *a = reinterpret_cast<const feature_map_t *>(p1);
-      const feature_map_t *b = reinterpret_cast<const feature_map_t *>(p2);
-
-      return a->tag < b->tag ? -1 : a->tag > b->tag ? 1 : 0;
-    }
+    static int cmp (const feature_map_t *a, const feature_map_t *b)
+    { return a->tag < b->tag ? -1 : a->tag > b->tag ? 1 : 0; }
   };
 
   struct lookup_map_t {
     unsigned int index;
     hb_mask_t mask;
 
-    static int
-    cmp (const void *p1, const void *p2)
-    {
-      const lookup_map_t *a = reinterpret_cast<const lookup_map_t *>(p1);
-      const lookup_map_t *b = reinterpret_cast<const lookup_map_t *>(p2);
-
-      return a->index < b->index ? -1 : a->index > b->index ? 1 : 0;
-    }
+    static int cmp (const lookup_map_t *a, const lookup_map_t *b)
+    { return a->index < b->index ? -1 : a->index > b->index ? 1 : 0; }
   };
 
+  typedef void (*pause_func_t) (const hb_ot_map_t *map, void *face_or_font, hb_buffer_t *buffer, void *user_data);
+  typedef struct {
+    pause_func_t func;
+    void *user_data;
+  } pause_callback_t;
 
-  void
-  add_lookups (hb_ot_shape_context_t *c,
-              unsigned int  table_index,
-              unsigned int  feature_index,
-              hb_mask_t     mask)
-  {
-    unsigned int i = MAX_LOOKUPS - lookup_count[table_index];
-    lookup_map_t *lookups = lookup_maps[table_index] + lookup_count[table_index];
-
-    unsigned int *lookup_indices = (unsigned int *) lookups;
-
-    hb_ot_layout_feature_get_lookup_indexes (c->face,
-                                            table_tags[table_index],
-                                            feature_index,
-                                            0, &i,
-                                            lookup_indices);
+  struct pause_map_t {
+    unsigned int num_lookups; /* Cumulative */
+    pause_callback_t callback;
+  };
 
-    lookup_count[table_index] += i;
+  typedef hb_bool_t (*apply_lookup_func_t) (void *face_or_font,
+                                           hb_buffer_t  *buffer,
+                                           unsigned int  lookup_index,
+                                           hb_mask_t     mask);
 
-    while (i--) {
-      lookups[i].mask = mask;
-      lookups[i].index = lookup_indices[i];
-    }
-  }
+  HB_INTERNAL void add_lookups (hb_face_t    *face,
+                               unsigned int  table_index,
+                               unsigned int  feature_index,
+                               hb_mask_t     mask);
 
+  HB_INTERNAL void apply (unsigned int table_index,
+                         hb_ot_map_t::apply_lookup_func_t apply_lookup_func,
+                         void *face_or_font,
+                         hb_buffer_t *buffer) const;
 
+  hb_mask_t global_mask;
 
+  hb_prealloced_array_t<feature_map_t, 8> features;
+  hb_prealloced_array_t<lookup_map_t, 32> lookups[2]; /* GSUB/GPOS */
+  hb_prealloced_array_t<pause_map_t, 1> pauses[2]; /* GSUB/GPOS */
+};
 
-  hb_mask_allocator_t (void) : feature_count (0) {}
 
-  void add_feature (hb_tag_t tag,
-                   unsigned int value,
-                   bool global)
-  {
-    feature_info_t *info = &feature_infos[feature_count++];
-    info->tag = tag;
-    info->value = value;
-    info->seq = feature_count;
-    info->global = global;
-  }
+struct hb_ot_map_builder_t
+{
+  public:
 
-  void compile (hb_ot_shape_context_t *c)
-  {
-   global_mask = 0;
-   lookup_count[0] = lookup_count[1] = 0;
-
-    if (!feature_count)
-      return;
-
-
-    /* Fetch script/language indices for GSUB/GPOS.  We need these later to skip
-     * features not available in either table and not waste precious bits for them. */
-
-    const hb_tag_t *script_tags;
-    hb_tag_t language_tag;
-
-    script_tags = hb_ot_tags_from_script (c->buffer->props.script);
-    language_tag = hb_ot_tag_from_language (c->buffer->props.language);
+  HB_INTERNAL void add_feature (hb_tag_t tag, unsigned int value, bool global);
 
-    unsigned int script_index[2], language_index[2];
-    for (unsigned int table_index = 0; table_index < 2; table_index++) {
-      hb_tag_t table_tag = table_tags[table_index];
-      hb_ot_layout_table_choose_script (c->face, table_tag, script_tags, &script_index[table_index]);
-      hb_ot_layout_script_find_language (c->face, table_tag, script_index[table_index], language_tag, &language_index[table_index]);
-    }
-
-
-    /* Sort the features so we can bsearch later */
-    qsort (feature_infos, feature_count, sizeof (feature_infos[0]), feature_info_t::cmp);
-
-    /* Remove dups, let later-occurring features override earlier ones. */
-    unsigned int j = 0;
-    for (unsigned int i = 1; i < feature_count; i++)
-      if (feature_infos[i].tag != feature_infos[j].tag)
-       feature_infos[++j] = feature_infos[i];
-      else {
-       if (feature_infos[i].global)
-         feature_infos[j] = feature_infos[i];
-       else {
-         feature_infos[j].global = feature_infos[j].global && (feature_infos[j].value == feature_infos[i].value);
-         feature_infos[j].value = MAX (feature_infos[j].value, feature_infos[i].value);
-       }
-      }
-    feature_count = j + 1;
-
-
-    /* Allocate bits now */
-    unsigned int next_bit = 1;
-    j = 0;
-    for (unsigned int i = 0; i < feature_count; i++) {
-      const feature_info_t *info = &feature_infos[i];
-
-      unsigned int bits_needed;
-
-      if (info->global && info->value == 1)
-        /* Uses the global bit */
-        bits_needed = 0;
-      else
-        bits_needed = _hb_bit_storage (info->value);
-
-      if (!info->value || next_bit + bits_needed > 8 * sizeof (hb_mask_t))
-        continue; /* Feature disabled, or not enough bits. */
-
-
-      bool found = false;
-      unsigned int feature_index[2];
-      for (unsigned int table_index = 0; table_index < 2; table_index++)
-        found |= hb_ot_layout_language_find_feature (c->face,
-                                                    table_tags[table_index],
-                                                    script_index[table_index],
-                                                    language_index[table_index],
-                                                    info->tag,
-                                                    &feature_index[table_index]);
-      if (!found)
-        continue;
-
-
-      feature_map_t *map = &feature_maps[j++];
-
-      map->tag = info->tag;
-      map->index[0] = feature_index[0];
-      map->index[1] = feature_index[1];
-      if (info->global && info->value == 1) {
-        /* Uses the global bit */
-        map->shift = 0;
-       map->mask = 1;
-      } else {
-       map->shift = next_bit;
-       map->mask = (1 << (next_bit + bits_needed)) - (1 << next_bit);
-       next_bit += bits_needed;
-       if (info->global)
-         global_mask |= map->mask;
-      }
-
-    }
-    feature_count = j;
-
-
-    for (unsigned int table_index = 0; table_index < 2; table_index++) {
-      hb_tag_t table_tag = table_tags[table_index];
-
-      /* Collect lookup indices for features */
-
-      unsigned int required_feature_index;
-      if (hb_ot_layout_language_get_required_feature_index (c->face,
-                                                           table_tag,
-                                                           script_index[table_index],
-                                                           language_index[table_index],
-                                                           &required_feature_index))
-       add_lookups (c, table_index, required_feature_index, 1);
-
-      for (unsigned i = 0; i < feature_count; i++)
-       add_lookups (c, table_index, feature_maps[i].index[table_index], feature_maps[i].mask);
-
-      /* Sort lookups and merge duplicates */
-
-      qsort (lookup_maps[table_index], lookup_count[table_index], sizeof (lookup_maps[table_index][0]), lookup_map_t::cmp);
-
-      if (lookup_count[table_index])
-      {
-       unsigned int j = 0;
-       for (unsigned int i = 1; i < lookup_count[table_index]; i++)
-         if (lookup_maps[table_index][i].index != lookup_maps[table_index][j].index)
-           lookup_maps[table_index][++j] = lookup_maps[table_index][i];
-         else
-           lookup_maps[table_index][j].mask |= lookup_maps[table_index][i].mask;
-       j++;
-       lookup_count[table_index] = j;
-      }
-    }
-  }
+  inline void add_bool_feature (hb_tag_t tag, bool global = true)
+  { add_feature (tag, 1, global); }
 
-  hb_mask_t get_global_mask (void) { return global_mask; }
-
-  hb_mask_t get_mask (hb_tag_t tag, unsigned int *shift) const {
-    const feature_map_t *map = (const feature_map_t *) bsearch (&tag, feature_maps, feature_count, sizeof (feature_maps[0]), feature_map_t::cmp);
-    if (likely (map)) {
-      if (shift) *shift = map->shift;
-      return map->mask;
-    } else {
-      if (shift) *shift = 0;
-      return 0;
-    }
-  }
+  inline void add_gsub_pause (hb_ot_map_t::gsub_pause_func_t pause_func, void *user_data)
+  { add_pause (0, (hb_ot_map_t::pause_func_t) pause_func, user_data); }
+  inline void add_gpos_pause (hb_ot_map_t::gpos_pause_func_t pause_func, void *user_data)
+  { add_pause (1, (hb_ot_map_t::pause_func_t) pause_func, user_data); }
 
-  void substitute (hb_ot_shape_context_t *c) const {
-    for (unsigned int i = 0; i < lookup_count[0]; i++)
-      hb_ot_layout_substitute_lookup (c->face, c->buffer, lookup_maps[0][i].index, lookup_maps[0][i].mask);
-  }
+  HB_INTERNAL void compile (hb_face_t *face,
+                           const hb_segment_properties_t *props,
+                           struct hb_ot_map_t &m);
 
-  void position (hb_ot_shape_context_t *c) const {
-    for (unsigned int i = 0; i < lookup_count[1]; i++)
-      hb_ot_layout_position_lookup (c->font, c->face, c->buffer, lookup_maps[1][i].index, lookup_maps[1][i].mask);
+  inline void finish (void) {
+    feature_infos.finish ();
+    pauses[0].finish ();
+    pauses[1].finish ();
   }
 
   private:
 
-  hb_mask_t global_mask;
+  struct feature_info_t {
+    hb_tag_t tag;
+    unsigned int seq; /* sequence#, used for stable sorting only */
+    unsigned int max_value;
+    bool global; /* whether the feature applies value to every glyph in the buffer */
+    unsigned int default_value; /* for non-global features, what should the unset glyphs take */
+    unsigned int stage[2]; /* GSUB/GPOS */
+
+    static int cmp (const feature_info_t *a, const feature_info_t *b)
+    { return (a->tag != b->tag) ?  (a->tag < b->tag ? -1 : 1) : (a->seq < b->seq ? -1 : 1); }
+  };
 
-  unsigned int feature_count;
-  feature_info_t feature_infos[MAX_FEATURES]; /* used before compile() only */
-  feature_map_t feature_maps[MAX_FEATURES];
+  struct pause_info_t {
+    unsigned int stage;
+    hb_ot_map_t::pause_callback_t callback;
+  };
 
-  lookup_map_t lookup_maps[2][MAX_LOOKUPS]; /* GSUB/GPOS */
-  unsigned int lookup_count[2];
-};
+  HB_INTERNAL void add_pause (unsigned int table_index, hb_ot_map_t::pause_func_t pause_func, void *user_data);
 
+  unsigned int current_stage[2]; /* GSUB/GPOS */
+  hb_prealloced_array_t<feature_info_t,16> feature_infos;
+  hb_prealloced_array_t<pause_info_t, 1> pauses[2]; /* GSUB/GPOS */
+};
 
 
 HB_END_DECLS