harfbuzz/src/hb-ot-shape.cc

625 lines
17 KiB
C++
Raw Normal View History

/*
2010-05-29 02:21:47 +02:00
* Copyright (C) 2009,2010 Red Hat, Inc.
*
2010-04-22 06:11:43 +02:00
* This is part of HarfBuzz, a text shaping library.
*
* Permission is hereby granted, without written agreement and without
* license or royalty fees, to use, copy, modify, and distribute this
* software and its documentation for any purpose, provided that the
* above copyright notice and the following two paragraphs appear in
* all copies of this software.
*
* IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
* DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
* ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
* IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
* THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
* ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
* PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
*
* Red Hat Author(s): Behdad Esfahbod
*/
#include "hb-ot-shape.h"
#include "hb-buffer-private.hh"
2010-05-29 02:21:47 +02:00
#include "hb-open-type-private.hh"
#include "hb-ot-layout.h"
2010-07-23 21:11:18 +02:00
HB_BEGIN_DECLS
2010-05-21 18:59:04 +02:00
/* XXX vertical */
hb_tag_t default_features[] = {
2010-05-21 19:06:35 +02:00
HB_TAG('c','a','l','t'),
HB_TAG('c','c','m','p'),
HB_TAG('c','l','i','g'),
2010-05-21 19:06:35 +02:00
HB_TAG('c','s','w','h'),
HB_TAG('c','u','r','s'),
HB_TAG('k','e','r','n'),
2010-05-21 19:06:35 +02:00
HB_TAG('l','i','g','a'),
HB_TAG('l','o','c','l'),
HB_TAG('m','a','r','k'),
HB_TAG('m','k','m','k'),
2010-05-21 19:06:35 +02:00
HB_TAG('r','l','i','g')
};
2010-05-20 16:14:44 +02:00
struct lookup_map {
unsigned int index;
hb_mask_t mask;
};
static void
add_feature (hb_face_t *face,
hb_tag_t table_tag,
unsigned int feature_index,
2010-05-20 16:14:44 +02:00
hb_mask_t mask,
lookup_map *lookups,
unsigned int *num_lookups,
unsigned int room_lookups)
{
unsigned int i = room_lookups - *num_lookups;
2010-05-20 16:14:44 +02:00
lookups += *num_lookups;
unsigned int *lookup_indices = (unsigned int *) lookups;
hb_ot_layout_feature_get_lookup_indexes (face, table_tag, feature_index, 0,
&i,
2010-05-20 16:14:44 +02:00
lookup_indices);
*num_lookups += i;
2010-05-20 16:14:44 +02:00
while (i--) {
lookups[i].mask = mask;
lookups[i].index = lookup_indices[i];
}
}
static int
cmp_lookups (const void *p1, const void *p2)
{
2010-05-20 16:14:44 +02:00
const lookup_map *a = (const lookup_map *) p1;
const lookup_map *b = (const lookup_map *) p2;
2010-05-20 16:14:44 +02:00
return a->index - b->index;
}
#define MAX_FEATURES 100
2010-05-29 02:21:47 +02:00
struct hb_mask_allocator_t {
2010-05-29 02:21:47 +02:00
struct feature_info_t {
hb_tag_t tag;
unsigned int value;
2010-06-02 05:03:54 +02:00
unsigned int seq;
2010-05-29 02:21:47 +02:00
bool global;
2010-05-29 02:21:47 +02:00
static int
cmp (const void *p1, const void *p2)
{
const feature_info_t *a = (const feature_info_t *) p1;
const feature_info_t *b = (const feature_info_t *) p2;
2010-05-29 02:21:47 +02:00
if (a->tag != b->tag)
return a->tag < b->tag ? -1 : 1;
2010-06-02 05:03:54 +02:00
return a->seq < b->seq ? -1 : 1;
2010-05-29 02:21:47 +02:00
}
};
2010-05-29 02:21:47 +02:00
struct feature_map_t {
hb_tag_t tag; /* should be first */
unsigned int index;
unsigned int shift;
hb_mask_t mask;
static int
cmp (const void *p1, const void *p2)
{
2010-05-29 02:21:47 +02:00
const feature_map_t *a = (const feature_map_t *) p1;
const feature_map_t *b = (const feature_map_t *) p2;
return a->tag < b->tag ? -1 : a->tag > b->tag ? 1 : 0;
}
};
2010-05-29 02:54:43 +02:00
hb_mask_allocator_t (void) : count (0) {}
2010-05-29 02:21:47 +02:00
2010-05-29 02:37:06 +02:00
void add_feature (hb_tag_t tag,
unsigned int value,
bool global)
{
2010-05-29 02:21:47 +02:00
feature_info_t *info = &infos[count++];
info->tag = tag;
2010-05-29 02:37:06 +02:00
info->value = value;
2010-06-02 05:03:54 +02:00
info->seq = count;
2010-05-29 02:21:47 +02:00
info->global = global;
}
2010-05-29 02:54:43 +02:00
void compile (hb_face_t *face,
hb_tag_t table_tag,
unsigned int script_index,
unsigned int language_index)
{
2010-05-29 02:21:47 +02:00
global_mask = 0;
unsigned int next_bit = 1;
2010-05-29 02:21:47 +02:00
if (!count)
return;
qsort (infos, count, sizeof (infos[0]), feature_info_t::cmp);
unsigned int j = 0;
for (unsigned int i = 1; i < count; i++)
if (infos[i].tag != infos[j].tag)
infos[++j] = infos[i];
else {
2010-05-29 02:41:20 +02:00
if (infos[i].global)
infos[j] = infos[i];
else {
infos[j].global = infos[j].global && (infos[j].value == infos[i].value);
2010-05-29 02:21:47 +02:00
infos[j].value = MAX (infos[j].value, infos[i].value);
2010-05-29 02:41:20 +02:00
}
2010-05-29 02:21:47 +02:00
}
count = j + 1;
/* Allocate bits now */
j = 0;
for (unsigned int i = 0; i < count; i++) {
const feature_info_t *info = &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. */
unsigned int feature_index;
if (!hb_ot_layout_language_find_feature (face, table_tag, script_index, language_index,
info->tag, &feature_index))
continue;
feature_map_t *map = &maps[j++];
map->tag = info->tag;
map->index = feature_index;
if (info->global && info->value == 1) {
2010-07-23 23:32:26 +02:00
/* Use the global bit */
2010-05-29 02:21:47 +02:00
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 && map->mask != 1)
global_mask |= map->mask;
}
count = j;
}
2010-05-29 02:21:47 +02:00
hb_mask_t get_global_mask (void) { return global_mask; }
const feature_map_t *find_feature (hb_tag_t tag) const {
static const feature_map_t off_map = { HB_TAG_NONE, Index::NOT_FOUND_INDEX, 0, 0 };
const feature_map_t *map = (const feature_map_t *) bsearch (&tag, maps, count, sizeof (maps[0]), feature_map_t::cmp);
return map ? map : &off_map;
}
2010-05-29 02:21:47 +02:00
private:
unsigned int count;
feature_info_t infos[MAX_FEATURES];
feature_map_t maps[MAX_FEATURES];
2010-05-29 02:21:47 +02:00
hb_mask_t global_mask;
};
static void
2010-04-23 20:44:55 +02:00
setup_lookups (hb_face_t *face,
hb_buffer_t *buffer,
hb_feature_t *features,
unsigned int num_features,
hb_tag_t table_tag,
2010-05-20 16:14:44 +02:00
lookup_map *lookups,
2010-05-21 18:53:10 +02:00
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->props.script),
&script_index);
hb_ot_layout_script_find_language (face, table_tag, script_index,
hb_ot_tag_from_language (buffer->props.language),
&language_index);
if (hb_ot_layout_language_get_required_feature_index (face, table_tag, script_index, language_index,
&feature_index))
2010-05-20 16:14:44 +02:00
add_feature (face, table_tag, feature_index, 1, lookups, num_lookups, room_lookups);
2010-05-29 02:54:43 +02:00
hb_mask_allocator_t allocator;
2010-05-29 02:21:47 +02:00
switch (original_direction) {
case HB_DIRECTION_LTR:
2010-05-29 02:37:06 +02:00
allocator.add_feature (HB_TAG ('l','t','r','a'), 1, true);
allocator.add_feature (HB_TAG ('l','t','r','m'), 1, true);
2010-05-29 02:21:47 +02:00
break;
case HB_DIRECTION_RTL:
2010-05-29 02:37:06 +02:00
allocator.add_feature (HB_TAG ('r','t','l','a'), 1, true);
allocator.add_feature (HB_TAG ('r','t','l','m'), 1, false);
2010-05-29 02:21:47 +02:00
break;
case HB_DIRECTION_TTB:
case HB_DIRECTION_BTT:
default:
break;
}
for (i = 0; i < ARRAY_LENGTH (default_features); i++)
2010-05-29 02:37:06 +02:00
allocator.add_feature (default_features[i], 1, true);
/* XXX complex-shaper features go here */
for (unsigned int i = 0; i < num_features; i++) {
const hb_feature_t *feature = &features[i];
allocator.add_feature (feature->tag, feature->value, (feature->start == 0 && feature->end == (unsigned int) -1));
}
2010-05-29 02:21:47 +02:00
/* Compile features */
2010-05-29 02:54:43 +02:00
allocator.compile (face, table_tag, script_index, language_index);
2010-05-29 02:21:47 +02:00
/* Gather lookup indices for features and set buffer masks at the same time */
const hb_mask_allocator_t::feature_map_t *map;
2010-05-29 02:21:47 +02:00
hb_mask_t global_mask = allocator.get_global_mask ();
if (global_mask)
buffer->set_masks (global_mask, global_mask, 0, (unsigned int) -1);
2010-05-21 18:53:10 +02:00
switch (original_direction) {
case HB_DIRECTION_LTR:
2010-05-29 02:21:47 +02:00
map = allocator.find_feature (HB_TAG ('l','t','r','a'));
add_feature (face, table_tag, map->index, map->mask, lookups, num_lookups, room_lookups);
map = allocator.find_feature (HB_TAG ('l','t','r','m'));
add_feature (face, table_tag, map->index, map->mask, lookups, num_lookups, room_lookups);
2010-05-21 18:53:10 +02:00
break;
case HB_DIRECTION_RTL:
2010-05-29 02:21:47 +02:00
map = allocator.find_feature (HB_TAG ('r','t','l','a'));
add_feature (face, table_tag, map->index, map->mask, lookups, num_lookups, room_lookups);
map = allocator.find_feature (HB_TAG ('r','t','l','m'));
add_feature (face, table_tag, map->index, map->mask, lookups, num_lookups, room_lookups);
2010-05-21 18:53:10 +02:00
break;
case HB_DIRECTION_TTB:
case HB_DIRECTION_BTT:
default:
break;
}
for (i = 0; i < ARRAY_LENGTH (default_features); i++)
2010-05-20 14:40:18 +02:00
{
2010-05-29 02:21:47 +02:00
map = allocator.find_feature (default_features[i]);
add_feature (face, table_tag, map->index, map->mask, lookups, num_lookups, room_lookups);
}
2010-05-20 16:40:12 +02:00
for (i = 0; i < num_features; i++)
{
2010-05-29 02:21:47 +02:00
hb_feature_t *feature = &features[i];
map = allocator.find_feature (feature->tag);
add_feature (face, table_tag, map->index, map->mask, lookups, num_lookups, room_lookups);
if (!(feature->start == 0 && feature->end == (unsigned int)-1))
buffer->set_masks (features[i].value << map->shift, map->mask, feature->start, feature->end);
2010-05-20 14:40:18 +02:00
}
2010-05-29 02:21:47 +02:00
/* Sort lookups and merge duplicates */
qsort (lookups, *num_lookups, sizeof (lookups[0]), cmp_lookups);
if (*num_lookups)
{
for (i = 1, j = 0; i < *num_lookups; i++)
2010-05-20 16:14:44 +02:00
if (lookups[i].index != lookups[j].index)
lookups[++j] = lookups[i];
2010-05-20 16:14:44 +02:00
else
lookups[j].mask |= lookups[i].mask;
j++;
*num_lookups = j;
}
}
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,
2010-05-21 18:53:10 +02:00
unsigned int num_features,
hb_direction_t original_direction)
{
lookup_map lookups[1000]; /* FIXME */
unsigned int num_lookups = ARRAY_LENGTH (lookups);
unsigned int i;
if (!hb_ot_layout_has_substitution (face))
return FALSE;
2010-04-23 20:44:55 +02:00
setup_lookups (face, buffer, features, num_features,
HB_OT_TAG_GSUB,
2010-05-21 18:53:10 +02:00
lookups, &num_lookups,
original_direction);
for (i = 0; i < num_lookups; i++)
2010-05-20 16:14:44 +02:00
hb_ot_layout_substitute_lookup (face, buffer, lookups[i].index, lookups[i].mask);
return TRUE;
}
static hb_bool_t
hb_ot_position_complex (hb_font_t *font,
hb_face_t *face,
hb_buffer_t *buffer,
hb_feature_t *features,
2010-05-21 18:53:10 +02:00
unsigned int num_features,
hb_direction_t original_direction)
{
2010-05-20 16:14:44 +02:00
lookup_map lookups[1000];
unsigned int num_lookups = ARRAY_LENGTH (lookups);
unsigned int i;
if (!hb_ot_layout_has_positioning (face))
return FALSE;
2010-04-23 20:44:55 +02:00
setup_lookups (face, buffer, features, num_features,
HB_OT_TAG_GPOS,
2010-05-21 18:53:10 +02:00
lookups, &num_lookups,
original_direction);
for (i = 0; i < num_lookups; i++)
2010-05-20 16:14:44 +02:00
hb_ot_layout_position_lookup (font, face, buffer, lookups[i].index, lookups[i].mask);
hb_ot_layout_position_finish (font, face, buffer);
return TRUE;
}
/* Main shaper */
/* Prepare */
static inline hb_bool_t
is_variation_selector (hb_codepoint_t unicode)
{
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 */
}
static void
hb_form_clusters (hb_buffer_t *buffer)
{
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;
}
static hb_direction_t
hb_ensure_native_direction (hb_buffer_t *buffer)
{
hb_direction_t original_direction = buffer->props.direction;
/* TODO vertical */
if (HB_DIRECTION_IS_HORIZONTAL (original_direction) &&
original_direction != _hb_script_get_horizontal_direction (buffer->props.script))
{
hb_buffer_reverse_clusters (buffer);
buffer->props.direction = HB_DIRECTION_REVERSE (buffer->props.direction);
}
return original_direction;
}
/* Substitute */
static void
hb_mirror_chars (hb_buffer_t *buffer)
{
hb_unicode_get_mirroring_func_t get_mirroring = buffer->unicode->v.get_mirroring;
if (HB_DIRECTION_IS_FORWARD (buffer->props.direction))
return;
// map = allocator.find_feature (HB_TAG ('r','t','l','m'));
unsigned int count = buffer->len;
for (unsigned int i = 0; i < count; i++) {
2010-05-21 18:58:20 +02:00
hb_codepoint_t codepoint = get_mirroring (buffer->info[i].codepoint);
if (likely (codepoint == buffer->info[i].codepoint))
;// buffer->info[i].mask |= map->mask;
2010-05-21 18:58:20 +02:00
else
buffer->info[i].codepoint = codepoint;
}
}
static void
hb_map_glyphs (hb_font_t *font,
hb_face_t *face,
hb_buffer_t *buffer)
{
if (unlikely (!buffer->len))
return;
2010-06-03 04:24:54 +02:00
buffer->clear_output ();
unsigned int count = buffer->len - 1;
2010-06-03 04:24:54 +02:00
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++;
} else {
2010-06-03 04:24:54 +02:00
buffer->add_output_glyph (hb_font_get_glyph (font, face, buffer->info[buffer->i].codepoint, 0));
}
}
if (likely (buffer->i < buffer->len))
buffer->add_output_glyph (hb_font_get_glyph (font, face, buffer->info[buffer->i].codepoint, 0));
2010-06-03 04:24:54 +02:00
buffer->swap ();
}
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_map_glyphs (font, face, buffer);
}
static void
2010-05-21 15:37:47 +02:00
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)
{
/* TODO Arabic */
}
/* 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_buffer_clear_positions (buffer);
unsigned int count = 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;
}
}
static void
2010-05-21 15:37:47 +02:00
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)
{
/* 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)
{
/* TODO Check for kern=0 */
unsigned int count = 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;
}
}
static void
2010-05-21 15:37:47 +02:00
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_truetype_kern (font, face, buffer, features, num_features);
}
/* 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)
{
hb_direction_t original_direction;
hb_bool_t substitute_fallback, position_fallback;
hb_form_clusters (buffer);
2010-05-21 18:58:20 +02:00
/* SUBSTITUTE */
2010-05-29 02:55:52 +02:00
{
buffer->clear_masks ();
2010-05-21 18:58:20 +02:00
2010-05-29 02:55:52 +02:00
/* Mirroring needs to see the original direction */
hb_mirror_chars (buffer);
2010-05-29 02:55:52 +02:00
original_direction = hb_ensure_native_direction (buffer);
2010-05-29 02:55:52 +02:00
hb_substitute_default (font, face, buffer, features, num_features);
2010-05-21 19:24:34 +02:00
2010-05-29 02:55:52 +02:00
substitute_fallback = !hb_ot_substitute_complex (font, face, buffer, features, num_features, original_direction);
2010-05-29 02:55:52 +02:00
if (substitute_fallback)
hb_substitute_complex_fallback (font, face, buffer, features, num_features);
}
2010-05-21 18:58:20 +02:00
/* POSITION */
2010-05-29 02:55:52 +02:00
{
buffer->clear_masks ();
2010-05-21 18:58:20 +02:00
2010-05-29 02:55:52 +02:00
hb_position_default (font, face, buffer, features, num_features);
2010-05-29 02:55:52 +02:00
position_fallback = !hb_ot_position_complex (font, face, buffer, features, num_features, original_direction);
2010-05-29 02:55:52 +02:00
if (position_fallback)
hb_position_complex_fallback (font, face, buffer, features, num_features);
if (HB_DIRECTION_IS_BACKWARD (buffer->props.direction))
2010-05-29 02:55:52 +02:00
hb_buffer_reverse (buffer);
2010-05-29 02:55:52 +02:00
if (position_fallback)
hb_position_complex_fallback_visual (font, face, buffer, features, num_features);
}
buffer->props.direction = original_direction;
}
2010-07-23 21:11:18 +02:00
HB_END_DECLS