harfbuzz/src/hb-ot-shape-complex-indic.cc

721 lines
23 KiB
C++
Raw Normal View History

/*
2011-06-07 21:02:48 +00:00
* Copyright © 2011 Google, Inc.
*
* 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.
*
* Google Author(s): Behdad Esfahbod
*/
2012-04-20 02:34:06 +00:00
#include "hb-ot-shape-complex-indic-private.hh"
static int
compare_codepoint (const void *pa, const void *pb)
{
hb_codepoint_t a = * (hb_codepoint_t *) pa;
hb_codepoint_t b = * (hb_codepoint_t *) pb;
return a < b ? -1 : a == b ? 0 : +1;
}
static indic_position_t
consonant_position (hb_codepoint_t u)
{
consonant_position_t *record;
record = (consonant_position_t *) bsearch (&u, consonant_positions,
ARRAY_LENGTH (consonant_positions),
sizeof (consonant_positions[0]),
compare_codepoint);
return record ? record->position : POS_BASE_C;
}
static bool
is_ra (hb_codepoint_t u)
{
return !!bsearch (&u, ra_chars,
ARRAY_LENGTH (ra_chars),
sizeof (ra_chars[0]),
compare_codepoint);
}
static bool
is_joiner (const hb_glyph_info_t &info)
{
return !!(FLAG (info.indic_category()) & (FLAG (OT_ZWJ) | FLAG (OT_ZWNJ)));
}
static bool
is_consonant (const hb_glyph_info_t &info)
{
/* Note:
*
* We treat Vowels and NBSP as if they were consonants. This is safe because Vowels
* cannot happen in a consonant syllable. The plus side however is, we can call the
* consonant syllable logic from the vowel syllable function and get it all right! */
return !!(FLAG (info.indic_category()) & (FLAG (OT_C) | FLAG (OT_Ra) | FLAG (OT_V) | FLAG (OT_NBSP)));
}
static const struct {
hb_tag_t tag;
hb_bool_t is_global;
} indic_basic_features[] =
{
{HB_TAG('n','u','k','t'), true},
{HB_TAG('a','k','h','n'), false},
{HB_TAG('r','p','h','f'), false},
{HB_TAG('r','k','r','f'), true},
{HB_TAG('p','r','e','f'), false},
{HB_TAG('b','l','w','f'), false},
{HB_TAG('h','a','l','f'), false},
{HB_TAG('v','a','t','u'), true},
{HB_TAG('p','s','t','f'), false},
{HB_TAG('c','j','c','t'), false},
};
/* Same order as the indic_basic_features array */
enum {
_NUKT,
AKHN,
RPHF,
2012-05-09 09:38:31 +00:00
_RKRF,
PREF,
BLWF,
HALF,
_VATU,
PSTF,
CJCT
};
static const hb_tag_t indic_other_features[] =
{
HB_TAG('p','r','e','s'),
HB_TAG('a','b','v','s'),
HB_TAG('b','l','w','s'),
HB_TAG('p','s','t','s'),
HB_TAG('h','a','l','n'),
HB_TAG('d','i','s','t'),
HB_TAG('a','b','v','m'),
HB_TAG('b','l','w','m'),
};
static void
initial_reordering (const hb_ot_map_t *map,
hb_face_t *face,
hb_buffer_t *buffer,
void *user_data HB_UNUSED);
static void
final_reordering (const hb_ot_map_t *map,
hb_face_t *face,
hb_buffer_t *buffer,
void *user_data HB_UNUSED);
void
_hb_ot_shape_complex_collect_features_indic (hb_ot_map_builder_t *map, const hb_segment_properties_t *props)
{
map->add_bool_feature (HB_TAG('l','o','c','l'));
2011-07-20 20:42:10 +00:00
/* The Indic specs do not require ccmp, but we apply it here since if
* there is a use of it, it's typically at the beginning. */
map->add_bool_feature (HB_TAG('c','c','m','p'));
map->add_gsub_pause (initial_reordering, NULL);
2012-05-09 09:07:18 +00:00
for (unsigned int i = 0; i < ARRAY_LENGTH (indic_basic_features); i++) {
map->add_bool_feature (indic_basic_features[i].tag, indic_basic_features[i].is_global);
2012-05-09 09:07:18 +00:00
map->add_gsub_pause (NULL, NULL);
}
map->add_gsub_pause (final_reordering, NULL);
2012-05-09 09:07:18 +00:00
for (unsigned int i = 0; i < ARRAY_LENGTH (indic_other_features); i++) {
map->add_bool_feature (indic_other_features[i], true);
2012-05-09 09:07:18 +00:00
map->add_gsub_pause (NULL, NULL);
}
}
hb_ot_shape_normalization_mode_t
_hb_ot_shape_complex_normalization_preference_indic (void)
{
/* We want split matras decomposed by the common shaping logic. */
return HB_OT_SHAPE_NORMALIZATION_MODE_DECOMPOSED;
}
void
_hb_ot_shape_complex_setup_masks_indic (hb_ot_map_t *map, hb_buffer_t *buffer, hb_font_t *font)
{
2011-07-28 21:06:46 +00:00
HB_BUFFER_ALLOCATE_VAR (buffer, indic_category);
HB_BUFFER_ALLOCATE_VAR (buffer, indic_position);
HB_BUFFER_ALLOCATE_VAR (buffer, indic_syllable);
2011-07-28 21:06:46 +00:00
/* We cannot setup masks here. We save information about characters
* and setup masks later on in a pause-callback. */
unsigned int count = buffer->len;
for (unsigned int i = 0; i < count; i++)
{
2012-05-09 15:40:00 +00:00
hb_glyph_info_t &info = buffer->info[i];
unsigned int type = get_indic_categories (info.codepoint);
info.indic_category() = type & 0x0F;
info.indic_position() = type >> 4;
if (info.indic_category() == OT_C) {
info.indic_position() = consonant_position (info.codepoint);
if (is_ra (info.codepoint))
info.indic_category() = OT_Ra;
} else if (info.indic_category() == OT_SM ||
info.indic_category() == OT_VD) {
info.indic_position() = POS_SMVD;
} else if (unlikely (info.codepoint == 0x200C))
info.indic_category() = OT_ZWNJ;
else if (unlikely (info.codepoint == 0x200D))
info.indic_category() = OT_ZWJ;
if (unlikely (info.codepoint == 0x0952)) {
info.indic_category() = OT_A;
info.indic_position() = POS_SMVD;
2012-05-09 13:41:51 +00:00
}
}
}
static int
compare_indic_order (const hb_glyph_info_t *pa, const hb_glyph_info_t *pb)
{
int a = pa->indic_position();
int b = pb->indic_position();
return a < b ? -1 : a == b ? 0 : +1;
}
static void
initial_reordering_consonant_syllable (const hb_ot_map_t *map, hb_buffer_t *buffer, hb_mask_t *mask_array,
unsigned int start, unsigned int end)
{
unsigned int i;
2011-07-30 23:15:53 +00:00
hb_glyph_info_t *info = buffer->info;
/* Comments from:
* https://www.microsoft.com/typography/otfntdev/devanot/shaping.aspx */
/* 1. Find base consonant:
*
* The shaping engine finds the base consonant of the syllable, using the
* following algorithm: starting from the end of the syllable, move backwards
* until a consonant is found that does not have a below-base or post-base
* form (post-base forms have to follow below-base forms), or that is not a
* pre-base reordering Ra, or arrive at the first consonant. The consonant
* stopped at will be the base.
*
* o If the syllable starts with Ra + Halant (in a script that has Reph)
* and has more than one consonant, Ra is excluded from candidates for
* base consonants.
*/
unsigned int base = end;
2012-05-09 09:43:43 +00:00
bool has_reph = false;
2012-05-09 09:43:43 +00:00
/* -> If the syllable starts with Ra + Halant (in a script that has Reph)
* and has more than one consonant, Ra is excluded from candidates for
* base consonants. */
unsigned int limit = start;
2012-05-09 09:43:43 +00:00
if (mask_array[RPHF] &&
2012-05-10 09:41:51 +00:00
start + 3 <= end &&
2012-05-09 09:43:43 +00:00
info[start].indic_category() == OT_Ra &&
2012-05-10 09:41:51 +00:00
info[start + 1].indic_category() == OT_H &&
!is_joiner (info[start + 2]))
2012-05-09 09:43:43 +00:00
{
limit += 2;
base = start;
2012-05-09 09:43:43 +00:00
has_reph = true;
};
2012-05-09 09:43:43 +00:00
/* -> starting from the end of the syllable, move backwards */
i = end;
do {
i--;
/* -> until a consonant is found */
2011-07-31 19:01:28 +00:00
if (is_consonant (info[i]))
{
/* -> that does not have a below-base or post-base form
* (post-base forms have to follow below-base forms), */
if (info[i].indic_position() != POS_BELOW_C &&
info[i].indic_position() != POS_POST_C)
{
base = i;
break;
}
/* -> or that is not a pre-base reordering Ra,
*
* TODO
*/
/* -> or arrive at the first consonant. The consonant stopped at will
* be the base. */
base = i;
}
else
if (is_joiner (info[i]))
break;
} while (i > limit);
if (base < start)
base = start; /* Just in case... */
/* -> If the syllable starts with Ra + Halant (in a script that has Reph)
* and has more than one consonant, Ra is excluded from candidates for
* base consonants. */
if (has_reph && base == start) {
/* Have no other consonant, so Reph is not formed and Ra becomes base. */
has_reph = false;
}
/* 2. Decompose and reorder Matras:
*
* Each matra and any syllable modifier sign in the cluster are moved to the
* appropriate position relative to the consonant(s) in the cluster. The
* shaping engine decomposes two- or three-part matras into their constituent
* parts before any repositioning. Matra characters are classified by which
* consonant in a conjunct they have affinity for and are reordered to the
* following positions:
*
* o Before first half form in the syllable
* o After subjoined consonants
* o After post-form consonant
* o After main consonant (for above marks)
*
* IMPLEMENTATION NOTES:
*
* The normalize() routine has already decomposed matras for us, so we don't
* need to worry about that.
*/
/* 3. Reorder marks to canonical order:
*
* Adjacent nukta and halant or nukta and vedic sign are always repositioned
* if necessary, so that the nukta is first.
*
* IMPLEMENTATION NOTES:
*
* We don't need to do this: the normalize() routine already did this for us.
*/
/* Reorder characters */
for (i = start; i < base; i++)
info[i].indic_position() = POS_PRE_C;
info[base].indic_position() = POS_BASE_C;
/* Handle beginning Ra */
if (has_reph)
info[start].indic_position() = POS_RA_TO_BECOME_REPH;
/* For old-style Indic script tags, move the first post-base Halant after
* last consonant. */
if ((map->get_chosen_script (0) & 0x000000FF) != '2') {
/* We should only do this for Indic scripts which have a version two I guess. */
for (i = base + 1; i < end; i++)
if (info[i].indic_category() == OT_H) {
unsigned int j;
for (j = end - 1; j > i; j--)
2012-05-10 10:17:16 +00:00
if (is_consonant (info[j]))
break;
if (j > i) {
/* Move Halant to after last consonant. */
hb_glyph_info_t t = info[i];
memmove (&info[i], &info[i + 1], (j - i) * sizeof (info[0]));
info[j] = t;
}
break;
}
}
/* Attach ZWJ, ZWNJ, nukta, and halant to previous char to move with them. */
for (i = start + 1; i < end; i++)
2011-07-30 23:15:53 +00:00
if ((FLAG (info[i].indic_category()) &
(FLAG (OT_ZWNJ) | FLAG (OT_ZWJ) | FLAG (OT_N) | FLAG (OT_H))))
2011-07-30 23:15:53 +00:00
info[i].indic_position() = info[i - 1].indic_position();
/* We do bubble-sort, skip malicious clusters attempts */
if (end - start < 64)
2012-05-10 09:31:20 +00:00
{
/* Sit tight, rock 'n roll! */
hb_bubble_sort (info + start, end - start, compare_indic_order);
2012-05-10 09:31:20 +00:00
/* Find base again */
base = end;
for (i = start; i < end; i++)
if (info[i].indic_position() == POS_BASE_C) {
base = i;
break;
}
}
/* Setup masks now */
2011-07-31 20:00:35 +00:00
{
hb_mask_t mask;
/* Reph */
if (has_reph)
info[start].mask |= mask_array[RPHF];
2011-07-31 20:00:35 +00:00
/* Pre-base */
mask = mask_array[HALF] | mask_array[AKHN] | mask_array[CJCT];
for (i = start; i < base; i++)
info[i].mask |= mask;
/* Base */
mask = mask_array[AKHN] | mask_array[CJCT];
info[base].mask |= mask;
/* Post-base */
mask = mask_array[BLWF] | mask_array[PSTF] | mask_array[CJCT];
for (i = base + 1; i < end; i++)
info[i].mask |= mask;
}
/* Apply ZWJ/ZWNJ effects */
for (i = start + 1; i < end; i++)
if (is_joiner (info[i])) {
bool non_joiner = info[i].indic_category() == OT_ZWNJ;
unsigned int j = i;
do {
j--;
/* Reading the Unicode and OpenType specs, I think the following line
* is correct, but this is not what the test suite expects currently.
* The test suite has been drinking, not me... But disable while
* investigating.
*/
//info[j].mask &= ~mask_array[CJCT];
if (non_joiner)
info[j].mask &= ~mask_array[HALF];
} while (j > start && !is_consonant (info[j]));
}
}
static void
initial_reordering_vowel_syllable (const hb_ot_map_t *map, hb_buffer_t *buffer, hb_mask_t *mask_array,
unsigned int start, unsigned int end)
{
/* We made the vowels look like consonants. So let's call the consonant logic! */
initial_reordering_consonant_syllable (map, buffer, mask_array, start, end);
}
static void
initial_reordering_standalone_cluster (const hb_ot_map_t *map, hb_buffer_t *buffer, hb_mask_t *mask_array,
unsigned int start, unsigned int end)
{
/* We made the vowels look like consonants. So let's call the consonant logic! */
initial_reordering_consonant_syllable (map, buffer, mask_array, start, end);
}
static void
initial_reordering_non_indic (const hb_ot_map_t *map, hb_buffer_t *buffer, hb_mask_t *mask_array,
unsigned int start, unsigned int end)
{
/* Nothing to do right now. If we ever switch to using the output
* buffer in the reordering process, we'd need to next_glyph() here. */
}
#include "hb-ot-shape-complex-indic-machine.hh"
static void
initial_reordering (const hb_ot_map_t *map,
hb_face_t *face,
hb_buffer_t *buffer,
void *user_data HB_UNUSED)
{
hb_mask_t mask_array[ARRAY_LENGTH (indic_basic_features)] = {0};
unsigned int num_masks = ARRAY_LENGTH (indic_basic_features);
for (unsigned int i = 0; i < num_masks; i++)
mask_array[i] = map->get_1_mask (indic_basic_features[i].tag);
find_syllables (map, buffer, mask_array);
}
static void
final_reordering_syllable (hb_buffer_t *buffer,
unsigned int start, unsigned int end)
{
hb_glyph_info_t *info = buffer->info;
/* 4. Final reordering:
*
* After the localized forms and basic shaping forms GSUB features have been
* applied (see below), the shaping engine performs some final glyph
* reordering before applying all the remaining font features to the entire
* cluster.
*/
/* Find base again */
unsigned int base = end;
for (unsigned int i = start; i < end; i++)
if (info[i].indic_position() == POS_BASE_C) {
base = i;
break;
}
if (base == start) {
/* There's no Reph, and no left Matra to reposition. Just merge the cluster
* and go home. */
buffer->merge_clusters (start, end);
return;
}
2012-05-10 11:09:08 +00:00
unsigned int start_of_last_cluster = base;
/* o Reorder matras:
*
* If a pre-base matra character had been reordered before applying basic
* features, the glyph can be moved closer to the main consonant based on
* whether half-forms had been formed. Actual position for the matra is
* defined as after last standalone halant glyph, after initial matra
* position and before the main consonant. If ZWJ or ZWNJ follow this
* halant, position is moved after it.
*/
unsigned int new_matra_pos = base - 1;
while (new_matra_pos > start &&
!(FLAG (info[new_matra_pos].indic_category()) & (FLAG (OT_M) | FLAG (OT_H))))
new_matra_pos--;
/* If we found no Halant we are done. Otherwise... */
if (info[new_matra_pos].indic_category() == OT_H) {
/* -> If ZWJ or ZWNJ follow this halant, position is moved after it. */
if (new_matra_pos + 1 < end && is_joiner (info[new_matra_pos + 1]))
new_matra_pos++;
/* Now go see if there's actually any matras... */
for (unsigned int i = new_matra_pos; i > start; i--)
if (info[i - 1].indic_position () == POS_LEFT_MATRA)
{
unsigned int old_matra_pos = i - 1;
hb_glyph_info_t matra = info[old_matra_pos];
memmove (&info[old_matra_pos], &info[old_matra_pos + 1], (new_matra_pos - old_matra_pos) * sizeof (info[0]));
info[new_matra_pos] = matra;
2012-05-10 11:09:08 +00:00
start_of_last_cluster = MIN (new_matra_pos, start_of_last_cluster);
new_matra_pos--;
}
}
/* o Reorder reph:
*
* Rephs original position is always at the beginning of the syllable,
* (i.e. it is not reordered at the character reordering stage). However,
* it will be reordered according to the basic-forms shaping results.
* Possible positions for reph, depending on the script, are; after main,
* before post-base consonant forms, and after post-base consonant forms.
*/
/* If there's anything after the Ra that has the REPH pos, it ought to be halant.
* Which means that the font has failed to ligate the Reph. In which case, we
* shouldn't move. */
if (start + 1 < end &&
info[start].indic_position() == POS_RA_TO_BECOME_REPH &&
info[start + 1].indic_position() != POS_RA_TO_BECOME_REPH)
{
unsigned int new_reph_pos;
enum reph_position_t {
REPH_AFTER_MAIN, /* Malayalam, Oriya */
REPH_BEFORE_SUBSCRIPT, /* Gurmukhi */
REPH_AFTER_SUBSCRIPT, /* Bengali */
REPH_BEFORE_POSTSCRIPT, /* Devanagari, Gujarati */
REPH_AFTER_POSTSCRIPT, /* Kannada, Tamil, Telugu */
} reph_pos = REPH_BEFORE_POSTSCRIPT; /* XXX */ /* XXX Figure out old behavior too */
/* 1. If reph should be positioned after post-base consonant forms,
* proceed to step 5.
*/
reph_step_1:
{
if (reph_pos == REPH_AFTER_POSTSCRIPT)
goto reph_step_5;
}
/* 2. If the reph repositioning class is not after post-base: target
* position is after the first explicit halant glyph between the
* first post-reph consonant and last main consonant. If ZWJ or ZWNJ
* are following this halant, position is moved after it. If such
* position is found, this is the target position. Otherwise,
* proceed to the next step.
*
* Note: in old-implementation fonts, where classifications were
* fixed in shaping engine, there was no case where reph position
* will be found on this step.
*/
reph_step_2:
{
new_reph_pos = start + 1;
while (new_reph_pos < base && info[new_reph_pos].indic_category() != OT_H)
new_reph_pos++;
if (new_reph_pos < base && info[new_reph_pos].indic_category() == OT_H) {
/* ->If ZWJ or ZWNJ are following this halant, position is moved after it. */
if (new_reph_pos + 1 < base && is_joiner (info[new_reph_pos + 1]))
new_reph_pos++;
goto reph_move;
}
}
/* 3. If reph should be repositioned after the main consonant: find the
* first consonant not ligated with main, or find the first
* consonant that is not a potential pre-base reordering Ra.
*/
reph_step_3:
{
/* XXX */
}
/* 4. If reph should be positioned before post-base consonant, find
* first post-base classified consonant not ligated with main. If no
* consonant is found, the target position should be before the
* first matra, syllable modifier sign or vedic sign.
*/
reph_step_4:
{
/* XXX */
}
/* 5. If no consonant is found in steps 3 or 4, move reph to a position
* immediately before the first post-base matra, syllable modifier
* sign or vedic sign that has a reordering class after the intended
* reph position. For example, if the reordering position for reph
* is post-main, it will skip above-base matras that also have a
* post-main position.
*/
reph_step_5:
{
/* XXX */
}
/* 6. Otherwise, reorder reph to the end of the syllable.
*/
reph_step_6:
{
new_reph_pos = end - 1;
while (new_reph_pos > start && info[new_reph_pos].indic_position() == POS_SMVD)
new_reph_pos--;
if (unlikely (info[new_reph_pos].indic_category() == OT_H)) {
/* *If* the Reph is to be ending up after a Matra,Halant sequence,
* position it before that Halant so it can interact with the Matra.
* However, if it's a plain Consonant,Halant we shouldn't do that.
*/
for (unsigned int i = base + 1; i < new_reph_pos; i++)
if (info[i].indic_category() == OT_M) {
/* Ok, got it. */
new_reph_pos--;
}
}
goto reph_move;
}
reph_move:
{
/* Move */
hb_glyph_info_t reph = info[start];
memmove (&info[start], &info[start + 1], (new_reph_pos - start) * sizeof (info[0]));
info[new_reph_pos] = reph;
start_of_last_cluster = start; /* Yay, one big cluster! */
}
}
/* o Reorder pre-base reordering consonants:
*
* If a pre-base reordering consonant is found, reorder it according to
* the following rules:
*
* 1. Only reorder a glyph produced by substitution during application
* of the feature. (Note that a font may shape a Ra consonant with
* the feature generally but block it in certain contexts.)
*
* 2. Try to find a target position the same way as for pre-base matra.
* If it is found, reorder pre-base consonant glyph.
*
* 3. If position is not found, reorder immediately before main
* consonant.
*/
/* Finish off the clusters and go home! */
2012-05-10 16:38:22 +00:00
/* For testing purposes we want to enable this to test against Uniscribe.
* One day when we don't compare to Uniscribe output anymore, we want to
* disable this because we believe it would make for superior cursor
* positioning. */
if (1) {
/* This is what Uniscribe does. Ie. add cluster boundaries after Halant,ZWNJ.
* This means, half forms are submerged into the main consonants cluster.
* This is unnecessary, and makes cursor positioning harder, but that's what
* Uniscribe does. */
unsigned int cluster_start = start;
for (unsigned int i = start + 1; i < start_of_last_cluster; i++)
if (info[i - 1].indic_category() == OT_H && info[i].indic_category() == OT_ZWNJ) {
i++;
buffer->merge_clusters (cluster_start, i);
cluster_start = i;
}
start_of_last_cluster = cluster_start;
}
buffer->merge_clusters (start_of_last_cluster, end);
}
static void
final_reordering (const hb_ot_map_t *map,
hb_face_t *face,
hb_buffer_t *buffer,
void *user_data HB_UNUSED)
{
unsigned int count = buffer->len;
if (!count) return;
hb_glyph_info_t *info = buffer->info;
unsigned int last = 0;
unsigned int last_syllable = info[0].indic_syllable();
for (unsigned int i = 1; i < count; i++)
if (last_syllable != info[i].indic_syllable()) {
final_reordering_syllable (buffer, last, i);
last = i;
last_syllable = info[last].indic_syllable();
}
final_reordering_syllable (buffer, last, count);
HB_BUFFER_DEALLOCATE_VAR (buffer, indic_syllable);
HB_BUFFER_DEALLOCATE_VAR (buffer, indic_category);
HB_BUFFER_DEALLOCATE_VAR (buffer, indic_position);
}