Implement the Unicode Canonical Composition algorithm
[framework/uifw/harfbuzz.git] / src / hb-ot-shape.cc
index 062cbfa..929a662 100644 (file)
@@ -1,5 +1,6 @@
 /*
- * Copyright (C) 2009  Red Hat, Inc.
+ * Copyright © 2009,2010  Red Hat, Inc.
+ * Copyright © 2010,2011  Google, Inc.
  *
  *  This is part of HarfBuzz, a text shaping library.
  *
  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  *
  * Red Hat Author(s): Behdad Esfahbod
+ * Google Author(s): Behdad Esfahbod
  */
 
-#include "hb-ot-shape.h"
+#include "hb-ot-shape-private.hh"
+#include "hb-ot-shape-complex-private.hh"
 
-#include "hb-buffer-private.hh"
+#include "hb-font-private.hh"
 
-#include "hb-ot-layout.h"
+HB_BEGIN_DECLS
 
-/* XXX vertical */
-hb_tag_t default_features[] = {
-  HB_TAG('c','a','l','t'),
+
+hb_tag_t common_features[] = {
   HB_TAG('c','c','m','p'),
-  HB_TAG('c','l','i','g'),
-  HB_TAG('c','s','w','h'),
-  HB_TAG('c','u','r','s'),
-  HB_TAG('k','e','r','n'),
-  HB_TAG('l','i','g','a'),
   HB_TAG('l','o','c','l'),
   HB_TAG('m','a','r','k'),
   HB_TAG('m','k','m','k'),
-  HB_TAG('r','l','i','g')
+  HB_TAG('r','l','i','g'),
 };
 
-enum {
-  MASK_ALWAYS_ON = 1 << 0,
-  MASK_RTLM      = 1 << 1
+hb_tag_t horizontal_features[] = {
+  HB_TAG('c','a','l','t'),
+  HB_TAG('c','l','i','g'),
+  HB_TAG('c','u','r','s'),
+  HB_TAG('k','e','r','n'),
+  HB_TAG('l','i','g','a'),
 };
-#define MASK_BITS_USED 2
 
-struct lookup_map {
-  unsigned int index;
-  hb_mask_t mask;
+/* Note:
+ * Technically speaking, vrt2 and vert are mutually exclusive.
+ * According to the spec, valt and vpal are also mutually exclusive.
+ * But we apply them all for now.
+ */
+hb_tag_t vertical_features[] = {
+  HB_TAG('v','a','l','t'),
+  HB_TAG('v','e','r','t'),
+  HB_TAG('v','k','r','n'),
+  HB_TAG('v','p','a','l'),
+  HB_TAG('v','r','t','2'),
 };
 
-
 static void
-add_feature (hb_face_t    *face,
-            hb_tag_t      table_tag,
-            unsigned int  feature_index,
-            hb_mask_t     mask,
-            lookup_map   *lookups,
-            unsigned int *num_lookups,
-            unsigned int  room_lookups)
+hb_ot_shape_collect_features (hb_ot_shape_planner_t          *planner,
+                             const hb_segment_properties_t  *props,
+                             const hb_feature_t             *user_features,
+                             unsigned int                    num_user_features)
 {
-  unsigned int i = room_lookups - *num_lookups;
-  lookups += *num_lookups;
-
-  unsigned int *lookup_indices = (unsigned int *) lookups;
-
-  hb_ot_layout_feature_get_lookup_indexes (face, table_tag, feature_index, 0,
-                                          &i,
-                                          lookup_indices);
-
-  *num_lookups += i;
-
-  while (i--) {
-    lookups[i].mask = mask;
-    lookups[i].index = lookup_indices[i];
-  }
-}
-
-static hb_bool_t
-maybe_add_feature (hb_face_t    *face,
-                  hb_tag_t      table_tag,
-                  unsigned int  script_index,
-                  unsigned int  language_index,
-                  hb_tag_t      feature_tag,
-                  hb_mask_t     mask,
-                  lookup_map   *lookups,
-                  unsigned int *num_lookups,
-                  unsigned int  room_lookups)
-{
-  unsigned int feature_index;
-  if (hb_ot_layout_language_find_feature (face, table_tag, script_index, language_index,
-                                         feature_tag,
-                                         &feature_index))
-  {
-    add_feature (face, table_tag, feature_index, mask, lookups, num_lookups, room_lookups);
-    return TRUE;
-  }
-  return FALSE;
-}
-
-static int
-cmp_lookups (const void *p1, const void *p2)
-{
-  const lookup_map *a = (const lookup_map *) p1;
-  const lookup_map *b = (const lookup_map *) p2;
-
-  return a->index - b->index;
-}
-
-static void
-setup_lookups (hb_face_t    *face,
-              hb_buffer_t  *buffer,
-              hb_feature_t *features,
-              unsigned int  num_features,
-              hb_tag_t      table_tag,
-              lookup_map   *lookups,
-              unsigned int *num_lookups,
-              hb_direction_t original_direction)
-{
-  unsigned int i, j, script_index, language_index, feature_index, room_lookups;
-
-  room_lookups = *num_lookups;
-  *num_lookups = 0;
-
-  hb_ot_layout_table_choose_script (face, table_tag,
-                                   hb_ot_tags_from_script (buffer->script),
-                                   &script_index);
-  hb_ot_layout_script_find_language (face, table_tag, script_index,
-                                    hb_ot_tag_from_language (buffer->language),
-                                    &language_index);
-
-  if (hb_ot_layout_language_get_required_feature_index (face, table_tag, script_index, language_index,
-                                                       &feature_index))
-    add_feature (face, table_tag, feature_index, 1, lookups, num_lookups, room_lookups);
-
-  for (i = 0; i < ARRAY_LENGTH (default_features); i++)
-    maybe_add_feature (face, table_tag, script_index, language_index, default_features[i], 1, lookups, num_lookups, room_lookups);
-
-  switch (original_direction) {
+  switch (props->direction) {
     case HB_DIRECTION_LTR:
-      maybe_add_feature (face, table_tag, script_index, language_index, HB_TAG ('l','t','r','a'), 1, lookups, num_lookups, room_lookups);
-      maybe_add_feature (face, table_tag, script_index, language_index, HB_TAG ('l','t','r','m'), 1, lookups, num_lookups, room_lookups);
+      planner->map.add_bool_feature (HB_TAG ('l','t','r','a'));
+      planner->map.add_bool_feature (HB_TAG ('l','t','r','m'));
       break;
     case HB_DIRECTION_RTL:
-      maybe_add_feature (face, table_tag, script_index, language_index, HB_TAG ('r','t','l','a'), 1, lookups, num_lookups, room_lookups);
+      planner->map.add_bool_feature (HB_TAG ('r','t','l','a'));
+      planner->map.add_bool_feature (HB_TAG ('r','t','l','m'), false);
       break;
     case HB_DIRECTION_TTB:
     case HB_DIRECTION_BTT:
+    case HB_DIRECTION_INVALID:
     default:
       break;
   }
 
-  unsigned int next_bit = MASK_BITS_USED;
-  hb_mask_t global_mask = 0;
-  for (i = 0; i < num_features; i++)
-  {
-    hb_feature_t *feature = &features[i];
-    if (!hb_ot_layout_language_find_feature (face, table_tag, script_index, language_index,
-                                            feature->tag,
-                                            &feature_index))
-      continue;
-
-    if (feature->value == 1 && feature->start == 0 && feature->end == (unsigned int) -1) {
-      add_feature (face, table_tag, feature_index, 1, lookups, num_lookups, room_lookups);
-      continue;
-    }
-
-    /* Allocate bits for the features */
+#define ADD_FEATURES(array) \
+  HB_STMT_START { \
+    for (unsigned int i = 0; i < ARRAY_LENGTH (array); i++) \
+      planner->map.add_bool_feature (array[i]); \
+  } HB_STMT_END
 
-    unsigned int bits_needed = _hb_bit_storage (feature->value);
-    if (!bits_needed)
-      continue; /* Feature disabled */
+  hb_ot_shape_complex_collect_features (planner->shaper, &planner->map, props);
 
-    if (next_bit + bits_needed > 8 * sizeof (hb_mask_t))
-      continue; /* Oh well... */
+  ADD_FEATURES (common_features);
 
-    unsigned int mask = (1 << (next_bit + bits_needed)) - (1 << next_bit);
-    unsigned int value = feature->value << next_bit;
-    next_bit += bits_needed;
+  if (HB_DIRECTION_IS_HORIZONTAL (props->direction))
+    ADD_FEATURES (horizontal_features);
+  else
+    ADD_FEATURES (vertical_features);
 
-    add_feature (face, table_tag, feature_index, mask, lookups, num_lookups, room_lookups);
+#undef ADD_FEATURES
 
-    if (feature->start == 0 && feature->end == (unsigned int) -1)
-      global_mask |= value;
-    else
-      buffer->or_masks (mask, feature->start, feature->end);
+  for (unsigned int i = 0; i < num_user_features; i++) {
+    const hb_feature_t *feature = &user_features[i];
+    planner->map.add_feature (feature->tag, feature->value, (feature->start == 0 && feature->end == (unsigned int) -1));
   }
+}
+
 
-  if (global_mask)
-    buffer->or_masks (global_mask, 0, (unsigned int) -1);
+static void
+hb_ot_shape_setup_masks (hb_ot_shape_context_t *c)
+{
+  hb_mask_t global_mask = c->plan->map.get_global_mask ();
+  c->buffer->reset_masks (global_mask);
 
-  qsort (lookups, *num_lookups, sizeof (lookups[0]), cmp_lookups);
+  hb_ot_shape_complex_setup_masks (c->plan->shaper, &c->plan->map, c->buffer); /* BUFFER: Clobbers var2 */
 
-  if (*num_lookups)
+  for (unsigned int i = 0; i < c->num_user_features; i++)
   {
-    for (i = 1, j = 0; i < *num_lookups; i++)
-      if (lookups[i].index != lookups[j].index)
-       lookups[++j] = lookups[i];
-      else
-        lookups[j].mask |= lookups[i].mask;
-    j++;
-    *num_lookups = j;
+    const hb_feature_t *feature = &c->user_features[i];
+    if (!(feature->start == 0 && feature->end == (unsigned int)-1)) {
+      unsigned int shift;
+      hb_mask_t mask = c->plan->map.get_mask (feature->tag, &shift);
+      c->buffer->set_masks (feature->value << shift, mask, feature->start, feature->end);
+    }
   }
 }
 
 
-static hb_bool_t
-hb_ot_substitute_complex (hb_font_t    *font HB_UNUSED,
-                         hb_face_t    *face,
-                         hb_buffer_t  *buffer,
-                         hb_feature_t *features,
-                         unsigned int  num_features,
-                         hb_direction_t original_direction)
+static void
+hb_ot_substitute_complex (hb_ot_shape_context_t *c)
 {
-  lookup_map lookups[1000];
-  unsigned int num_lookups = ARRAY_LENGTH (lookups);
-  unsigned int i;
-
-  if (!hb_ot_layout_has_substitution (face))
-    return FALSE;
-
-  setup_lookups (face, buffer, features, num_features,
-                HB_OT_TAG_GSUB,
-                lookups, &num_lookups,
-                original_direction);
+  if (!hb_ot_layout_has_substitution (c->face))
+    return;
 
-  for (i = 0; i < num_lookups; i++)
-    hb_ot_layout_substitute_lookup (face, buffer, lookups[i].index, lookups[i].mask);
+  c->plan->map.substitute (c->face, c->buffer);
 
-  return TRUE;
+  c->applied_substitute_complex = TRUE;
+  return;
 }
 
-static hb_bool_t
-hb_ot_position_complex (hb_font_t    *font,
-                       hb_face_t    *face,
-                       hb_buffer_t  *buffer,
-                       hb_feature_t *features,
-                       unsigned int  num_features,
-                       hb_direction_t original_direction)
+static void
+hb_ot_position_complex (hb_ot_shape_context_t *c)
 {
-  lookup_map lookups[1000];
-  unsigned int num_lookups = ARRAY_LENGTH (lookups);
-  unsigned int i;
 
-  if (!hb_ot_layout_has_positioning (face))
-    return FALSE;
+  if (!hb_ot_layout_has_positioning (c->face))
+    return;
 
-  setup_lookups (face, buffer, features, num_features,
-                HB_OT_TAG_GPOS,
-                lookups, &num_lookups,
-                original_direction);
+  unsigned int count = c->buffer->len;
+  for (unsigned int i = 0; i < count; i++) {
+    hb_font_add_glyph_origin_for_direction (c->font, c->buffer->info[i].codepoint,
+                                           HB_DIRECTION_LTR,
+                                           &c->buffer->pos[i].x_offset,
+                                           &c->buffer->pos[i].y_offset);
+  }
 
-  for (i = 0; i < num_lookups; i++)
-    hb_ot_layout_position_lookup (font, face, buffer, lookups[i].index, lookups[i].mask);
+  c->plan->map.position (c->font, c->buffer);
+
+  for (unsigned int i = 0; i < count; i++) {
+    hb_font_subtract_glyph_origin_for_direction (c->font, c->buffer->info[i].codepoint,
+                                                HB_DIRECTION_LTR,
+                                                &c->buffer->pos[i].x_offset,
+                                                &c->buffer->pos[i].y_offset);
+  }
 
-  hb_ot_layout_position_finish (font, face, buffer);
+  hb_ot_layout_position_finish (c->buffer);
 
-  return TRUE;
+  c->applied_position_complex = TRUE;
+  return;
 }
 
 
@@ -270,12 +176,12 @@ hb_ot_position_complex (hb_font_t    *font,
 
 /* Prepare */
 
-static inline hb_bool_t
-is_variation_selector (hb_codepoint_t unicode)
+void
+_hb_set_unicode_props (hb_buffer_t *buffer)
 {
-  return unlikely ((unicode >=  0x180B && unicode <=  0x180D) || /* MONGOLIAN FREE VARIATION SELECTOR ONE..THREE */
-                  (unicode >=  0xFE00 && unicode <=  0xFE0F) || /* VARIATION SELECTOR-1..16 */
-                  (unicode >= 0xE0100 && unicode <= 0xE01EF));  /* VARIATION SELECTOR-17..256 */
+  unsigned int count = buffer->len;
+  for (unsigned int i = 1; i < count; i++)
+    hb_glyph_info_set_unicode_props (&buffer->info[i], buffer->unicode);
 }
 
 static void
@@ -283,83 +189,98 @@ hb_form_clusters (hb_buffer_t *buffer)
 {
   unsigned int count = buffer->len;
   for (unsigned int i = 1; i < count; i++)
-    if (buffer->unicode->get_general_category (buffer->info[i].codepoint) == HB_CATEGORY_NON_SPACING_MARK)
+    if (FLAG (buffer->info[i].general_category()) &
+       (FLAG (HB_UNICODE_GENERAL_CATEGORY_SPACING_MARK) |
+        FLAG (HB_UNICODE_GENERAL_CATEGORY_ENCLOSING_MARK) |
+        FLAG (HB_UNICODE_GENERAL_CATEGORY_NON_SPACING_MARK)))
       buffer->info[i].cluster = buffer->info[i - 1].cluster;
 }
 
-static hb_direction_t
+static void
 hb_ensure_native_direction (hb_buffer_t *buffer)
 {
-  hb_direction_t original_direction = buffer->direction;
-
-  /* TODO vertical */
-  if (HB_DIRECTION_IS_HORIZONTAL (original_direction) &&
-      original_direction != _hb_script_get_horizontal_direction (buffer->script))
+  hb_direction_t direction = buffer->props.direction;
+
+  /* TODO vertical:
+   * The only BTT vertical script is Ogham, but it's not clear to me whether OpenType
+   * Ogham fonts are supposed to be implemented BTT or not.  Need to research that
+   * first. */
+  if ((HB_DIRECTION_IS_HORIZONTAL (direction) && direction != hb_script_get_horizontal_direction (buffer->props.script)) ||
+      (HB_DIRECTION_IS_VERTICAL   (direction) && direction != HB_DIRECTION_TTB))
   {
     hb_buffer_reverse_clusters (buffer);
-    buffer->direction = HB_DIRECTION_REVERSE (buffer->direction);
+    buffer->props.direction = HB_DIRECTION_REVERSE (buffer->props.direction);
   }
+}
 
-  return original_direction;
+static void
+hb_reset_glyph_infos (hb_buffer_t *buffer)
+{
+  unsigned int count = buffer->len;
+  for (unsigned int i = 0; i < count; i++)
+    buffer->info[i].var1.u32 = buffer->info[i].var2.u32 = 0;
 }
 
 
 /* Substitute */
 
 static void
-hb_mirror_chars (hb_buffer_t *buffer)
+hb_mirror_chars (hb_ot_shape_context_t *c)
 {
-  hb_unicode_get_mirroring_func_t get_mirroring = buffer->unicode->get_mirroring;
+  hb_unicode_funcs_t *unicode = c->buffer->unicode;
 
-  if (HB_DIRECTION_IS_FORWARD (buffer->direction))
+  if (HB_DIRECTION_IS_FORWARD (c->target_direction))
     return;
 
-  unsigned int count = buffer->len;
+  hb_mask_t rtlm_mask = c->plan->map.get_1_mask (HB_TAG ('r','t','l','m'));
+
+  unsigned int count = c->buffer->len;
   for (unsigned int i = 0; i < count; i++) {
-    hb_codepoint_t codepoint = get_mirroring (buffer->info[i].codepoint);
-    if (likely (codepoint == buffer->info[i].codepoint))
-      buffer->info[i].mask |= MASK_RTLM;
+    hb_codepoint_t codepoint = hb_unicode_mirroring (unicode, c->buffer->info[i].codepoint);
+    if (likely (codepoint == c->buffer->info[i].codepoint))
+      c->buffer->info[i].mask |= rtlm_mask; /* XXX this should be moved to before setting user-feature masks */
     else
-      buffer->info[i].codepoint = codepoint;
+      c->buffer->info[i].codepoint = codepoint;
   }
 }
 
 static void
 hb_map_glyphs (hb_font_t    *font,
-              hb_face_t    *face,
               hb_buffer_t  *buffer)
 {
+  hb_codepoint_t glyph;
+
   if (unlikely (!buffer->len))
     return;
 
+  buffer->clear_output ();
+
   unsigned int count = buffer->len - 1;
-  for (unsigned int i = 0; i < count; i++) {
-    if (unlikely (is_variation_selector (buffer->info[i + 1].codepoint))) {
-      buffer->info[i].codepoint = hb_font_get_glyph (font, face, buffer->info[i].codepoint, buffer->info[i + 1].codepoint);
-      i++;
+  for (buffer->idx = 0; buffer->idx < count;) {
+    if (unlikely (is_variation_selector (buffer->info[buffer->idx + 1].codepoint))) {
+      hb_font_get_glyph (font, buffer->info[buffer->idx].codepoint, buffer->info[buffer->idx + 1].codepoint, &glyph);
+      buffer->replace_glyph (glyph);
+      buffer->skip_glyph ();
     } else {
-      buffer->info[i].codepoint = hb_font_get_glyph (font, face, buffer->info[i].codepoint, 0);
+      hb_font_get_glyph (font, buffer->info[buffer->idx].codepoint, 0, &glyph);
+      buffer->replace_glyph (glyph);
     }
   }
-  buffer->info[count].codepoint = hb_font_get_glyph (font, face, buffer->info[count].codepoint, 0);
+  if (likely (buffer->idx < buffer->len)) {
+    hb_font_get_glyph (font, buffer->info[buffer->idx].codepoint, 0, &glyph);
+    buffer->replace_glyph (glyph);
+  }
+  buffer->swap_buffers ();
 }
 
 static void
-hb_substitute_default (hb_font_t    *font,
-                      hb_face_t    *face,
-                      hb_buffer_t  *buffer,
-                      hb_feature_t *features HB_UNUSED,
-                      unsigned int  num_features HB_UNUSED)
+hb_substitute_default (hb_ot_shape_context_t *c)
 {
-  hb_map_glyphs (font, face, buffer);
+  hb_map_glyphs (c->font, c->buffer);
 }
 
 static void
-hb_substitute_complex_fallback (hb_font_t    *font HB_UNUSED,
-                               hb_face_t    *face HB_UNUSED,
-                               hb_buffer_t  *buffer HB_UNUSED,
-                               hb_feature_t *features HB_UNUSED,
-                               unsigned int  num_features HB_UNUSED)
+hb_substitute_complex_fallback (hb_ot_shape_context_t *c HB_UNUSED)
 {
   /* TODO Arabic */
 }
@@ -368,111 +289,152 @@ hb_substitute_complex_fallback (hb_font_t    *font HB_UNUSED,
 /* Position */
 
 static void
-hb_position_default (hb_font_t    *font,
-                    hb_face_t    *face,
-                    hb_buffer_t  *buffer,
-                    hb_feature_t *features HB_UNUSED,
-                    unsigned int  num_features HB_UNUSED)
+hb_position_default (hb_ot_shape_context_t *c)
 {
-  hb_buffer_clear_positions (buffer);
+  hb_ot_layout_position_start (c->buffer);
 
-  unsigned int count = buffer->len;
+  unsigned int count = c->buffer->len;
   for (unsigned int i = 0; i < count; i++) {
-    hb_glyph_metrics_t metrics;
-    hb_font_get_glyph_metrics (font, face, buffer->info[i].codepoint, &metrics);
-    buffer->pos[i].x_advance = metrics.x_advance;
-    buffer->pos[i].y_advance = metrics.y_advance;
+    hb_font_get_glyph_advance_for_direction (c->font, c->buffer->info[i].codepoint,
+                                            c->buffer->props.direction,
+                                            &c->buffer->pos[i].x_advance,
+                                            &c->buffer->pos[i].y_advance);
+    hb_font_subtract_glyph_origin_for_direction (c->font, c->buffer->info[i].codepoint,
+                                                c->buffer->props.direction,
+                                                &c->buffer->pos[i].x_offset,
+                                                &c->buffer->pos[i].y_offset);
   }
 }
 
 static void
-hb_position_complex_fallback (hb_font_t    *font HB_UNUSED,
-                             hb_face_t    *face HB_UNUSED,
-                             hb_buffer_t  *buffer HB_UNUSED,
-                             hb_feature_t *features HB_UNUSED,
-                             unsigned int  num_features HB_UNUSED)
+hb_position_complex_fallback (hb_ot_shape_context_t *c HB_UNUSED)
 {
   /* TODO Mark pos */
 }
 
 static void
-hb_truetype_kern (hb_font_t    *font,
-                 hb_face_t    *face,
-                 hb_buffer_t  *buffer,
-                 hb_feature_t *features HB_UNUSED,
-                 unsigned int  num_features HB_UNUSED)
+hb_truetype_kern (hb_ot_shape_context_t *c)
 {
   /* TODO Check for kern=0 */
-  unsigned int count = buffer->len;
+  unsigned int count = c->buffer->len;
   for (unsigned int i = 1; i < count; i++) {
-    hb_position_t kern, kern1, kern2;
-    kern = hb_font_get_kerning (font, face, buffer->info[i - 1].codepoint, buffer->info[i].codepoint);
-    kern1 = kern >> 1;
-    kern2 = kern - kern1;
-    buffer->pos[i - 1].x_advance += kern1;
-    buffer->pos[i].x_advance += kern2;
-    buffer->pos[i].x_offset += kern2;
+    hb_position_t x_kern, y_kern, kern1, kern2;
+    hb_font_get_glyph_kerning_for_direction (c->font,
+                                            c->buffer->info[i - 1].codepoint, c->buffer->info[i].codepoint,
+                                            c->buffer->props.direction,
+                                            &x_kern, &y_kern);
+
+    kern1 = x_kern >> 1;
+    kern2 = x_kern - kern1;
+    c->buffer->pos[i - 1].x_advance += kern1;
+    c->buffer->pos[i].x_advance += kern2;
+    c->buffer->pos[i].x_offset += kern2;
+
+    kern1 = y_kern >> 1;
+    kern2 = y_kern - kern1;
+    c->buffer->pos[i - 1].y_advance += kern1;
+    c->buffer->pos[i].y_advance += kern2;
+    c->buffer->pos[i].y_offset += kern2;
   }
 }
 
 static void
-hb_position_complex_fallback_visual (hb_font_t    *font,
-                                    hb_face_t    *face,
-                                    hb_buffer_t  *buffer,
-                                    hb_feature_t *features,
-                                    unsigned int  num_features)
+hb_position_complex_fallback_visual (hb_ot_shape_context_t *c)
 {
-  hb_truetype_kern (font, face, buffer, features, num_features);
+  hb_truetype_kern (c);
 }
 
 
 /* Do it! */
 
-void
-hb_ot_shape (hb_font_t    *font,
-            hb_face_t    *face,
-            hb_buffer_t  *buffer,
-            hb_feature_t *features,
-            unsigned int  num_features)
+static void
+hb_ot_shape_execute_internal (hb_ot_shape_context_t *c)
 {
-  hb_direction_t original_direction;
-  hb_bool_t substitute_fallback, position_fallback;
+  /* Save the original direction, we use it later. */
+  c->target_direction = c->buffer->props.direction;
 
-  hb_form_clusters (buffer);
+  hb_reset_glyph_infos (c->buffer); /* BUFFER: Clear buffer var1 and var2 */
 
-  /* SUBSTITUTE */
+  _hb_set_unicode_props (c->buffer); /* BUFFER: Set general_category and combining_class in var1 */
+
+  hb_form_clusters (c->buffer);
 
-  buffer->clear_masks ();
+  hb_ensure_native_direction (c->buffer);
 
-  /* Mirroring needs to see the original direction */
-  hb_mirror_chars (buffer);
+  _hb_ot_shape_normalize (c);
 
-  original_direction = hb_ensure_native_direction (buffer);
+  hb_ot_shape_setup_masks (c); /* BUFFER: Clobbers var2 */
 
-  hb_substitute_default (font, face, buffer, features, num_features);
+  /* SUBSTITUTE */
+  {
+    hb_mirror_chars (c);
 
-  substitute_fallback = !hb_ot_substitute_complex (font, face, buffer, features, num_features, original_direction);
+    hb_substitute_default (c);
 
-  if (substitute_fallback)
-    hb_substitute_complex_fallback (font, face, buffer, features, num_features);
+    hb_ot_substitute_complex (c);
 
+    if (!c->applied_substitute_complex)
+      hb_substitute_complex_fallback (c);
+  }
 
   /* POSITION */
+  {
+    hb_position_default (c);
+
+    hb_ot_position_complex (c);
+
+    hb_bool_t position_fallback = !c->applied_position_complex;
+    if (position_fallback)
+      hb_position_complex_fallback (c);
+
+    if (HB_DIRECTION_IS_BACKWARD (c->buffer->props.direction))
+      hb_buffer_reverse (c->buffer);
+
+    if (position_fallback)
+      hb_position_complex_fallback_visual (c);
+  }
 
-  buffer->clear_masks ();
+  c->buffer->props.direction = c->target_direction;
+}
+
+static void
+hb_ot_shape_plan_internal (hb_ot_shape_plan_t       *plan,
+                          hb_face_t                *face,
+                          const hb_segment_properties_t  *props,
+                          const hb_feature_t       *user_features,
+                          unsigned int              num_user_features)
+{
+  hb_ot_shape_planner_t planner;
 
-  hb_position_default (font, face, buffer, features, num_features);
+  planner.shaper = hb_ot_shape_complex_categorize (props);
 
-  position_fallback = !hb_ot_position_complex (font, face, buffer, features, num_features, original_direction);
+  hb_ot_shape_collect_features (&planner, props, user_features, num_user_features);
 
-  if (position_fallback)
-    hb_position_complex_fallback (font, face, buffer, features, num_features);
+  planner.compile (face, props, *plan);
+}
 
-  if (HB_DIRECTION_IS_BACKWARD (buffer->direction))
-    hb_buffer_reverse (buffer);
+static void
+hb_ot_shape_execute (hb_ot_shape_plan_t *plan,
+                    hb_font_t          *font,
+                    hb_buffer_t        *buffer,
+                    const hb_feature_t *user_features,
+                    unsigned int        num_user_features)
+{
+  hb_ot_shape_context_t c = {plan, font, font->face, buffer, user_features, num_user_features};
+  hb_ot_shape_execute_internal (&c);
+}
 
-  if (position_fallback)
-    hb_position_complex_fallback_visual (font, face, buffer, features, num_features);
+void
+hb_ot_shape (hb_font_t          *font,
+            hb_buffer_t        *buffer,
+            const hb_feature_t *features,
+            unsigned int        num_features)
+{
+  hb_ot_shape_plan_t plan;
 
-  buffer->direction = original_direction;
+  hb_ot_shape_plan_internal (&plan, font->face, &buffer->props, features, num_features);
+  hb_ot_shape_execute (&plan, font, buffer, features, num_features);
 }
+
+
+HB_END_DECLS