/*
- * 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.
*
*/
#include "hb-ot-shape-private.hh"
+#include "hb-ot-shape-normalize-private.hh"
-#include "hb-ot-map-private.hh"
+#include "hb-font-private.hh"
+#include "hb-set-private.hh"
-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'),
+};
+
+
+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'),
+};
+
+/* 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'),
+};
+
+
+
+struct hb_ot_shape_planner_t
+{
+ hb_ot_map_builder_t map;
+ hb_ot_complex_shaper_t shaper;
+
+ hb_ot_shape_planner_t (void) : map () {}
+ ~hb_ot_shape_planner_t (void) { map.finish (); }
+
+ inline void compile (hb_face_t *face,
+ const hb_segment_properties_t *props,
+ struct hb_ot_shape_plan_t &plan)
+ {
+ plan.shaper = shaper;
+ map.compile (face, props, plan.map);
+ }
+
+ private:
+ NO_COPY (hb_ot_shape_planner_t);
};
static void
-hb_ot_shape_collect_features (hb_ot_shape_context_t *c)
+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)
{
- switch (c->original_direction) {
+ switch (props->direction) {
case HB_DIRECTION_LTR:
- c->map->add_bool_feature (HB_TAG ('l','t','r','a'));
- c->map->add_bool_feature (HB_TAG ('l','t','r','m'));
+ 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:
- c->map->add_bool_feature (HB_TAG ('r','t','l','a'));
- c->map->add_bool_feature (HB_TAG ('r','t','l','m'), false);
+ 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;
}
- for (unsigned int i = 0; i < ARRAY_LENGTH (default_features); i++)
- c->map->add_bool_feature (default_features[i]);
+#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
- /* complex */
+ hb_ot_shape_complex_collect_features (planner->shaper, &planner->map, props);
- for (unsigned int i = 0; i < c->num_features; i++) {
- const hb_feature_t *feature = &c->features[i];
- c->map->add_feature (feature->tag, feature->value, (feature->start == 0 && feature->end == (unsigned int) -1));
+ ADD_FEATURES (common_features);
+
+ if (HB_DIRECTION_IS_HORIZONTAL (props->direction))
+ ADD_FEATURES (horizontal_features);
+ else
+ ADD_FEATURES (vertical_features);
+
+#undef ADD_FEATURES
+
+ 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));
}
}
-static void
-hb_ot_shape_setup_lookups (hb_ot_shape_context_t *c)
+struct hb_ot_shape_context_t
{
- hb_ot_shape_collect_features (c);
-
- /* Compile features */
- c->map->compile (c);
+ /* Input to hb_ot_shape_execute() */
+ hb_ot_shape_plan_t *plan;
+ hb_font_t *font;
+ hb_face_t *face;
+ hb_buffer_t *buffer;
+ const hb_feature_t *user_features;
+ unsigned int num_user_features;
+
+ /* Transient stuff */
+ hb_direction_t target_direction;
+ hb_bool_t applied_position_complex;
+};
- /* Set masks in buffer */
+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);
- hb_mask_t global_mask = c->map->get_global_mask ();
- if (global_mask)
- c->buffer->set_masks (global_mask, global_mask, 0, (unsigned int) -1);
+ hb_ot_shape_complex_setup_masks (c->plan->shaper, &c->plan->map, c->buffer, c->font);
- for (unsigned int i = 0; i < c->num_features; i++)
+ for (unsigned int i = 0; i < c->num_user_features; i++)
{
- hb_feature_t *feature = &c->features[i];
+ 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->map->get_mask (feature->tag, &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);
}
}
-
- /* complex */
-}
-
-
-static void
-hb_ot_substitute_complex (hb_ot_shape_context_t *c)
-{
- if (!hb_ot_layout_has_substitution (c->face))
- return;
-
- c->map->substitute (c);
-
- c->applied_substitute_complex = TRUE;
- return;
-}
-
-static void
-hb_ot_position_complex (hb_ot_shape_context_t *c)
-{
-
- if (!hb_ot_layout_has_positioning (c->face))
- return;
-
- c->map->position (c);
-
- hb_ot_layout_position_finish (c->font, c->face, c->buffer);
-
- c->applied_position_complex = TRUE;
- return;
}
/* Prepare */
-static inline hb_bool_t
-is_variation_selector (hb_codepoint_t unicode)
+static 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 = 0; i < count; i++)
+ _hb_glyph_info_set_unicode_props (&buffer->info[i], buffer->unicode);
}
static void
{
unsigned int count = buffer->len;
for (unsigned int i = 1; i < count; i++)
- if (buffer->unicode->v.get_general_category (buffer->info[i].codepoint) == HB_CATEGORY_NON_SPACING_MARK)
- buffer->info[i].cluster = buffer->info[i - 1].cluster;
+ if (FLAG (_hb_glyph_info_get_general_category (&buffer->info[i])) &
+ (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; /* XXX do the min() here */
}
static void
{
hb_direction_t direction = buffer->props.direction;
- /* TODO vertical */
- if (HB_DIRECTION_IS_HORIZONTAL (direction) &&
- direction != _hb_script_get_horizontal_direction (buffer->props.script))
+ /* 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->props.direction = HB_DIRECTION_REVERSE (buffer->props.direction);
static void
hb_mirror_chars (hb_ot_shape_context_t *c)
{
- hb_unicode_get_mirroring_func_t get_mirroring = c->buffer->unicode->v.get_mirroring;
+ hb_unicode_funcs_t *unicode = c->buffer->unicode;
- if (HB_DIRECTION_IS_FORWARD (c->buffer->props.direction))
+ if (HB_DIRECTION_IS_FORWARD (c->target_direction))
return;
- hb_mask_t rtlm_mask = c->map->get_mask (HB_TAG ('r','t','l','m'));
+ 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 (c->buffer->info[i].codepoint);
+ 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;
+ c->buffer->info[i].mask |= rtlm_mask; /* XXX this should be moved to before setting user-feature masks */
else
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 (buffer->i = 0; buffer->i < count;) {
- if (unlikely (is_variation_selector (buffer->info[buffer->i + 1].codepoint))) {
- buffer->add_output_glyph (hb_font_get_glyph (font, face, buffer->info[buffer->i].codepoint, buffer->info[buffer->i + 1].codepoint));
- buffer->i++;
+ for (buffer->idx = 0; buffer->idx < count;) {
+ if (unlikely (_hb_unicode_is_variation_selector (buffer->cur(+1).codepoint))) {
+ hb_font_get_glyph (font, buffer->cur().codepoint, buffer->cur(+1).codepoint, &glyph);
+ buffer->replace_glyphs (2, 1, &glyph);
} else {
- buffer->add_output_glyph (hb_font_get_glyph (font, face, buffer->info[buffer->i].codepoint, 0));
+ hb_font_get_glyph (font, buffer->cur().codepoint, 0, &glyph);
+ buffer->replace_glyph (glyph);
}
}
- if (likely (buffer->i < buffer->len))
- buffer->add_output_glyph (hb_font_get_glyph (font, face, buffer->info[buffer->i].codepoint, 0));
- buffer->swap ();
+ if (likely (buffer->idx < buffer->len)) {
+ hb_font_get_glyph (font, buffer->cur().codepoint, 0, &glyph);
+ buffer->replace_glyph (glyph);
+ }
+ buffer->swap_buffers ();
}
static void
hb_substitute_default (hb_ot_shape_context_t *c)
{
- hb_map_glyphs (c->font, c->face, c->buffer);
+ hb_ot_layout_substitute_start (c->buffer);
+
+ hb_mirror_chars (c);
+
+ hb_map_glyphs (c->font, c->buffer);
}
static void
-hb_substitute_complex_fallback (hb_ot_shape_context_t *c HB_UNUSED)
+hb_ot_substitute_complex (hb_ot_shape_context_t *c)
{
- /* TODO Arabic */
+ if (hb_ot_layout_has_substitution (c->face)) {
+ c->plan->map.substitute (c->face, c->buffer);
+ }
+
+ hb_ot_layout_substitute_finish (c->buffer);
+
+ return;
}
static void
hb_position_default (hb_ot_shape_context_t *c)
{
- hb_buffer_clear_positions (c->buffer);
+ hb_ot_layout_position_start (c->buffer);
unsigned int count = c->buffer->len;
for (unsigned int i = 0; i < count; i++) {
- hb_glyph_metrics_t metrics;
- hb_font_get_glyph_metrics (c->font, c->face, c->buffer->info[i].codepoint, &metrics);
- c->buffer->pos[i].x_advance = metrics.x_advance;
- c->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_ot_position_complex (hb_ot_shape_context_t *c)
+{
+
+ if (hb_ot_layout_has_positioning (c->face))
+ {
+ /* Change glyph origin to what GPOS expects, apply GPOS, change it back. */
+
+ 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);
+ }
+
+ 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);
+ }
+
+ c->applied_position_complex = true;
}
+
+ hb_ot_layout_position_finish (c->buffer);
+
+ return;
}
static void
/* TODO Check for kern=0 */
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 (c->font, c->face, c->buffer->info[i - 1].codepoint, c->buffer->info[i].codepoint);
- kern1 = kern >> 1;
- kern2 = kern - kern1;
+ 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;
}
}
hb_truetype_kern (c);
}
+static void
+hb_hide_zerowidth (hb_ot_shape_context_t *c)
+{
+ /* TODO Save the space character in the font? */
+ hb_codepoint_t space;
+ if (!hb_font_get_glyph (c->font, ' ', 0, &space))
+ return; /* No point! */
+
+ unsigned int count = c->buffer->len;
+ for (unsigned int i = 0; i < count; i++)
+ if (unlikely (_hb_glyph_info_is_zero_width (&c->buffer->info[i]))) {
+ c->buffer->info[i].codepoint = space;
+ c->buffer->pos[i].x_advance = 0;
+ c->buffer->pos[i].y_advance = 0;
+ }
+}
+
/* Do it! */
static void
-hb_ot_shape_internal (hb_ot_shape_context_t *c)
+hb_ot_shape_execute_internal (hb_ot_shape_context_t *c)
{
- hb_ot_shape_setup_lookups (c);
+ c->buffer->deallocate_var_all ();
+
+ /* Save the original direction, we use it later. */
+ c->target_direction = c->buffer->props.direction;
+
+ HB_BUFFER_ALLOCATE_VAR (c->buffer, unicode_props0);
+ HB_BUFFER_ALLOCATE_VAR (c->buffer, unicode_props1);
+
+ hb_set_unicode_props (c->buffer);
hb_form_clusters (c->buffer);
- /* SUBSTITUTE */
- {
- c->buffer->clear_masks ();
+ hb_ensure_native_direction (c->buffer);
- /* Mirroring needs to see the original direction */
- hb_mirror_chars (c);
+ _hb_ot_shape_normalize (c->font, c->buffer, hb_ot_shape_complex_normalization_preference (c->plan->shaper));
- hb_ensure_native_direction (c->buffer);
+ hb_ot_shape_setup_masks (c);
+ /* SUBSTITUTE */
+ {
hb_substitute_default (c);
hb_ot_substitute_complex (c);
-
- if (!c->applied_substitute_complex)
- hb_substitute_complex_fallback (c);
}
/* POSITION */
{
- c->buffer->clear_masks ();
-
hb_position_default (c);
hb_ot_position_complex (c);
hb_position_complex_fallback_visual (c);
}
- c->buffer->props.direction = c->original_direction;
+ hb_hide_zerowidth (c);
+
+ HB_BUFFER_DEALLOCATE_VAR (c->buffer, unicode_props1);
+ HB_BUFFER_DEALLOCATE_VAR (c->buffer, unicode_props0);
+
+ c->buffer->props.direction = c->target_direction;
+
+ c->buffer->deallocate_var_all ();
}
-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_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_context_t c = {font, face, buffer, features, num_features};
- hb_ot_map_t map;
+ hb_ot_shape_planner_t planner;
+
+ assert (HB_DIRECTION_IS_VALID (props->direction));
+
+ planner.shaper = hb_ot_shape_complex_categorize (props);
+
+ hb_ot_shape_collect_features (&planner, props, user_features, num_user_features);
- /* Setup transient context members */
- c.original_direction = buffer->props.direction;
- c.map = ↦
+ planner.compile (face, props, *plan);
+}
- hb_ot_shape_internal (&c);
+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);
}
+hb_bool_t
+_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;
-HB_END_DECLS
+ buffer->guess_properties ();
+
+ hb_ot_shape_plan_internal (&plan, font->face, &buffer->props, features, num_features);
+ hb_ot_shape_execute (&plan, font, buffer, features, num_features);
+
+ return true;
+}
+
+
+void
+hb_ot_shape_glyphs_closure (hb_font_t *font,
+ hb_buffer_t *buffer,
+ const hb_feature_t *features,
+ unsigned int num_features,
+ hb_set_t *glyphs)
+{
+ hb_ot_shape_plan_t plan;
+
+ buffer->guess_properties ();
+
+ hb_ot_shape_plan_internal (&plan, font->face, &buffer->props, features, num_features);
+
+ /* TODO: normalization? have shapers do closure()? */
+ /* TODO: Deal with mirrored chars? */
+ hb_map_glyphs (font, buffer);
+
+ /* Seed it. It's user's responsibility to have cleard glyphs
+ * if that's what they desire. */
+ unsigned int count = buffer->len;
+ for (unsigned int i = 0; i < count; i++)
+ hb_set_add (glyphs, buffer->info[i].codepoint);
+
+ /* And find transitive closure. */
+ hb_set_t copy;
+ copy.init ();
+
+ do {
+ copy.set (glyphs);
+ plan.map.substitute_closure (font->face, glyphs);
+ } while (!copy.equal (glyphs));
+}