hb-ot-shape-complex-indic.cc 19.0 KB
Newer Older
B
Behdad Esfahbod 已提交
1
/*
B
Behdad Esfahbod 已提交
2
 * Copyright © 2011  Google, Inc.
B
Behdad Esfahbod 已提交
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
 *
 *  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
 */

#include "hb-ot-shape-complex-private.hh"

HB_BEGIN_DECLS


/* buffer var allocations */
33 34
#define indic_category() complex_var_persistent_u8_0() /* indic_category_t */
#define indic_position() complex_var_persistent_u8_1() /* indic_matra_category_t */
B
Behdad Esfahbod 已提交
35 36 37

#define INDIC_TABLE_ELEMENT_TYPE uint8_t

B
Behdad Esfahbod 已提交
38 39 40
/* Cateories used in the OpenType spec:
 * https://www.microsoft.com/typography/otfntdev/devanot/shaping.aspx
 */
41 42
/* Note: This enum is duplicated in the -machine.rl source file.
 * Not sure how to avoid duplication. */
43
enum indic_category_t {
B
Behdad Esfahbod 已提交
44 45
  OT_X = 0,
  OT_C,
46
  OT_Ra, /* Not explicitly listed in the OT spec, but used in the grammar. */
B
Behdad Esfahbod 已提交
47 48 49 50 51 52 53 54 55
  OT_V,
  OT_N,
  OT_H,
  OT_ZWNJ,
  OT_ZWJ,
  OT_M,
  OT_SM,
  OT_VD,
  OT_A,
56
  OT_NBSP
B
Behdad Esfahbod 已提交
57 58
};

59 60 61 62 63 64 65 66 67
/* Visual positions in a syllable from left to right. */
enum indic_position_t {
  POS_PRE,
  POS_BASE,
  POS_ABOVE,
  POS_BELOW,
  POS_POST,
};

B
Behdad Esfahbod 已提交
68 69
/* Categories used in IndicSyllabicCategory.txt from UCD */
/* The assignments are guesswork */
B
Behdad Esfahbod 已提交
70
enum indic_syllabic_category_t {
B
Behdad Esfahbod 已提交
71 72
  INDIC_SYLLABIC_CATEGORY_OTHER			= OT_X,

73
  INDIC_SYLLABIC_CATEGORY_AVAGRAHA		= OT_X,
B
Behdad Esfahbod 已提交
74 75 76 77 78 79 80 81 82
  INDIC_SYLLABIC_CATEGORY_BINDU			= OT_SM,
  INDIC_SYLLABIC_CATEGORY_CONSONANT		= OT_C,
  INDIC_SYLLABIC_CATEGORY_CONSONANT_DEAD	= OT_C,
  INDIC_SYLLABIC_CATEGORY_CONSONANT_FINAL	= OT_C,
  INDIC_SYLLABIC_CATEGORY_CONSONANT_HEAD_LETTER	= OT_C,
  INDIC_SYLLABIC_CATEGORY_CONSONANT_MEDIAL	= OT_C,
  INDIC_SYLLABIC_CATEGORY_CONSONANT_PLACEHOLDER	= OT_NBSP,
  INDIC_SYLLABIC_CATEGORY_CONSONANT_SUBJOINED	= OT_C,
  INDIC_SYLLABIC_CATEGORY_CONSONANT_REPHA	= OT_C,
83
  INDIC_SYLLABIC_CATEGORY_MODIFYING_LETTER	= OT_X,
B
Behdad Esfahbod 已提交
84
  INDIC_SYLLABIC_CATEGORY_NUKTA			= OT_N,
85 86 87
  INDIC_SYLLABIC_CATEGORY_REGISTER_SHIFTER	= OT_X,
  INDIC_SYLLABIC_CATEGORY_TONE_LETTER		= OT_X,
  INDIC_SYLLABIC_CATEGORY_TONE_MARK		= OT_X,
B
Behdad Esfahbod 已提交
88 89 90 91
  INDIC_SYLLABIC_CATEGORY_VIRAMA		= OT_H,
  INDIC_SYLLABIC_CATEGORY_VISARGA		= OT_SM,
  INDIC_SYLLABIC_CATEGORY_VOWEL			= OT_V,
  INDIC_SYLLABIC_CATEGORY_VOWEL_DEPENDENT	= OT_M,
92
  INDIC_SYLLABIC_CATEGORY_VOWEL_INDEPENDENT	= OT_V
B
Behdad Esfahbod 已提交
93 94
};

B
Behdad Esfahbod 已提交
95
/* Categories used in IndicSMatraCategory.txt from UCD */
B
Behdad Esfahbod 已提交
96
enum indic_matra_category_t {
97
  INDIC_MATRA_CATEGORY_NOT_APPLICABLE		= POS_BASE,
B
Behdad Esfahbod 已提交
98

99 100 101 102
  INDIC_MATRA_CATEGORY_LEFT			= POS_PRE,
  INDIC_MATRA_CATEGORY_TOP			= POS_ABOVE,
  INDIC_MATRA_CATEGORY_BOTTOM			= POS_BELOW,
  INDIC_MATRA_CATEGORY_RIGHT			= POS_POST,
103 104

  /* We don't really care much about these since we decompose them
105 106 107 108 109 110 111 112 113 114 115
   * in the generic pre-shaping layer.  They will only be used if
   * the font does not cover the decomposition.  In which case, we
   * define these as aliases to the place we want the split-matra
   * glyph to show up.  Quite arbitrary. */
  INDIC_MATRA_CATEGORY_BOTTOM_AND_RIGHT		= INDIC_MATRA_CATEGORY_BOTTOM,
  INDIC_MATRA_CATEGORY_LEFT_AND_RIGHT		= INDIC_MATRA_CATEGORY_LEFT,
  INDIC_MATRA_CATEGORY_TOP_AND_BOTTOM		= INDIC_MATRA_CATEGORY_BOTTOM,
  INDIC_MATRA_CATEGORY_TOP_AND_BOTTOM_AND_RIGHT	= INDIC_MATRA_CATEGORY_BOTTOM,
  INDIC_MATRA_CATEGORY_TOP_AND_LEFT		= INDIC_MATRA_CATEGORY_LEFT,
  INDIC_MATRA_CATEGORY_TOP_AND_LEFT_AND_RIGHT	= INDIC_MATRA_CATEGORY_LEFT,
  INDIC_MATRA_CATEGORY_TOP_AND_RIGHT		= INDIC_MATRA_CATEGORY_RIGHT,
116 117 118 119

  INDIC_MATRA_CATEGORY_INVISIBLE		= INDIC_MATRA_CATEGORY_NOT_APPLICABLE,
  INDIC_MATRA_CATEGORY_OVERSTRUCK		= INDIC_MATRA_CATEGORY_NOT_APPLICABLE,
  INDIC_MATRA_CATEGORY_VISUAL_ORDER_LEFT	= INDIC_MATRA_CATEGORY_NOT_APPLICABLE
B
Behdad Esfahbod 已提交
120 121
};

122 123
/* Note: We use ASSERT_STATIC_EXPR_ZERO() instead of ASSERT_STATIC_EXPR() and the comma operation
 * because gcc fails to optimize the latter and fills the table in at runtime. */
B
Behdad Esfahbod 已提交
124
#define INDIC_COMBINE_CATEGORIES(S,M) \
125 126 127
  (ASSERT_STATIC_EXPR_ZERO (M == INDIC_MATRA_CATEGORY_NOT_APPLICABLE || (S == INDIC_SYLLABIC_CATEGORY_VIRAMA || S == INDIC_SYLLABIC_CATEGORY_VOWEL_DEPENDENT)) + \
   ASSERT_STATIC_EXPR_ZERO (S < 16 && M < 16) + \
   ((M << 4) | S))
B
Behdad Esfahbod 已提交
128 129 130

#include "hb-ot-shape-complex-indic-table.hh"

131 132 133 134 135 136
/* XXX
 * This is a hack for now.  We should:
 * 1. Move this data into the main Indic table,
 * and/or
 * 2. Probe font lookups to determine consonant positions.
 */
B
Behdad Esfahbod 已提交
137
static const struct consonant_position_t {
138
  hb_codepoint_t u;
139
  indic_position_t position;
140
} consonant_positions[] = {
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
  {0x0930, POS_BELOW},
  {0x09AC, POS_BELOW},
  {0x09AF, POS_POST},
  {0x09B0, POS_BELOW},
  {0x09F0, POS_BELOW},
  {0x0A2F, POS_POST},
  {0x0A30, POS_BELOW},
  {0x0A35, POS_BELOW},
  {0x0A39, POS_BELOW},
  {0x0AB0, POS_BELOW},
  {0x0B24, POS_BELOW},
  {0x0B28, POS_BELOW},
  {0x0B2C, POS_BELOW},
  {0x0B2D, POS_BELOW},
  {0x0B2E, POS_BELOW},
  {0x0B2F, POS_POST},
  {0x0B30, POS_BELOW},
  {0x0B32, POS_BELOW},
  {0x0B33, POS_BELOW},
  {0x0B5F, POS_POST},
  {0x0B71, POS_BELOW},
  {0x0C15, POS_BELOW},
  {0x0C16, POS_BELOW},
  {0x0C17, POS_BELOW},
  {0x0C18, POS_BELOW},
  {0x0C19, POS_BELOW},
  {0x0C1A, POS_BELOW},
  {0x0C1B, POS_BELOW},
  {0x0C1C, POS_BELOW},
  {0x0C1D, POS_BELOW},
  {0x0C1E, POS_BELOW},
  {0x0C1F, POS_BELOW},
  {0x0C20, POS_BELOW},
  {0x0C21, POS_BELOW},
  {0x0C22, POS_BELOW},
  {0x0C23, POS_BELOW},
  {0x0C24, POS_BELOW},
  {0x0C25, POS_BELOW},
  {0x0C26, POS_BELOW},
  {0x0C27, POS_BELOW},
  {0x0C28, POS_BELOW},
  {0x0C2A, POS_BELOW},
  {0x0C2B, POS_BELOW},
  {0x0C2C, POS_BELOW},
  {0x0C2D, POS_BELOW},
  {0x0C2E, POS_BELOW},
  {0x0C2F, POS_BELOW},
  {0x0C30, POS_BELOW},
  {0x0C32, POS_BELOW},
  {0x0C33, POS_BELOW},
  {0x0C35, POS_BELOW},
  {0x0C36, POS_BELOW},
  {0x0C37, POS_BELOW},
  {0x0C38, POS_BELOW},
  {0x0C39, POS_BELOW},
  {0x0C95, POS_BELOW},
  {0x0C96, POS_BELOW},
  {0x0C97, POS_BELOW},
  {0x0C98, POS_BELOW},
  {0x0C99, POS_BELOW},
  {0x0C9A, POS_BELOW},
  {0x0C9B, POS_BELOW},
  {0x0C9C, POS_BELOW},
  {0x0C9D, POS_BELOW},
  {0x0C9E, POS_BELOW},
  {0x0C9F, POS_BELOW},
  {0x0CA0, POS_BELOW},
  {0x0CA1, POS_BELOW},
  {0x0CA2, POS_BELOW},
  {0x0CA3, POS_BELOW},
  {0x0CA4, POS_BELOW},
  {0x0CA5, POS_BELOW},
  {0x0CA6, POS_BELOW},
  {0x0CA7, POS_BELOW},
  {0x0CA8, POS_BELOW},
  {0x0CAA, POS_BELOW},
  {0x0CAB, POS_BELOW},
  {0x0CAC, POS_BELOW},
  {0x0CAD, POS_BELOW},
  {0x0CAE, POS_BELOW},
  {0x0CAF, POS_BELOW},
  {0x0CB0, POS_BELOW},
  {0x0CB2, POS_BELOW},
  {0x0CB3, POS_BELOW},
  {0x0CB5, POS_BELOW},
  {0x0CB6, POS_BELOW},
  {0x0CB7, POS_BELOW},
  {0x0CB8, POS_BELOW},
  {0x0CB9, POS_BELOW},
  {0x0CDE, POS_BELOW},
  {0x0D2F, POS_POST},
  {0x0D30, POS_POST},
  {0x0D32, POS_BELOW},
  {0x0D35, POS_POST},
235 236
};

237 238 239 240 241 242 243
/* XXX
 * This is a hack for now.  We should move this data into the main Indic table.
 */
static const hb_codepoint_t ra_chars[] = {
  0x0930, /* Devanagari */
  0x09B0, /* Bengali */
  0x09F0, /* Bengali */
244
//0x09F1, /* Bengali */
245 246 247 248 249 250 251 252 253
//0x0A30, /* Gurmukhi */
  0x0AB0, /* Gujarati */
  0x0B30, /* Oriya */
//0x0BB0, /* Tamil */
//0x0C30, /* Telugu */
  0x0CB0, /* Kannada */
//0x0D30, /* Malayalam */
};

B
Behdad Esfahbod 已提交
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
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;
}

276 277 278 279 280 281 282 283 284
static bool
is_ra (hb_codepoint_t u)
{
  return !!bsearch (&u, ra_chars,
		    ARRAY_LENGTH (ra_chars),
		    sizeof (ra_chars[0]),
		    compare_codepoint);
}

285
static bool
B
Behdad Esfahbod 已提交
286
is_joiner (const hb_glyph_info_t &info)
287
{
B
Behdad Esfahbod 已提交
288 289 290 291 292 293 294
  return !!(FLAG (info.indic_category()) & (FLAG (OT_ZWJ) | FLAG (OT_ZWNJ)));
}

static bool
is_consonant (const hb_glyph_info_t &info)
{
  return !!(FLAG (info.indic_category()) & (FLAG (OT_C) | FLAG (OT_Ra)));
295
}
296 297 298 299 300

static const struct {
  hb_tag_t tag;
  hb_bool_t is_global;
} indic_basic_features[] =
B
Behdad Esfahbod 已提交
301
{
302 303 304 305 306 307 308 309 310
  {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'), false},
  {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},
B
Behdad Esfahbod 已提交
311
  {HB_TAG('c','j','c','t'), false},
312 313 314 315 316 317 318 319 320 321 322 323 324
};

/* Same order as the indic_basic_features array */
enum {
  _NUKT,
  AKHN,
  RPHF,
  RKRF,
  PREF,
  BLWF,
  HALF,
  _VATU,
  PSTF,
B
Behdad Esfahbod 已提交
325
  CJCT,
B
Behdad Esfahbod 已提交
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
};

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'),
};

B
Behdad Esfahbod 已提交
341 342 343 344 345 346

static void
initial_reordering (const hb_ot_map_t *map,
		    hb_face_t *face,
		    hb_buffer_t *buffer,
		    void *user_data HB_UNUSED);
347 348 349 350
static void
final_reordering (const hb_ot_map_t *map,
		  hb_face_t *face,
		  hb_buffer_t *buffer,
B
Behdad Esfahbod 已提交
351
		  void *user_data HB_UNUSED);
B
Behdad Esfahbod 已提交
352 353

void
354
_hb_ot_shape_complex_collect_features_indic (hb_ot_map_builder_t *map, const hb_segment_properties_t  *props)
B
Behdad Esfahbod 已提交
355
{
356
  map->add_bool_feature (HB_TAG('l','o','c','l'));
B
Minor  
Behdad Esfahbod 已提交
357 358
  /* 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. */
359 360
  map->add_bool_feature (HB_TAG('c','c','m','p'));

B
Behdad Esfahbod 已提交
361
  map->add_gsub_pause (initial_reordering, NULL);
362

B
Behdad Esfahbod 已提交
363
  for (unsigned int i = 0; i < ARRAY_LENGTH (indic_basic_features); i++)
364
    map->add_bool_feature (indic_basic_features[i].tag, indic_basic_features[i].is_global);
B
Behdad Esfahbod 已提交
365

366 367
  map->add_gsub_pause (final_reordering, NULL);

B
Behdad Esfahbod 已提交
368
  for (unsigned int i = 0; i < ARRAY_LENGTH (indic_other_features); i++)
369
    map->add_bool_feature (indic_other_features[i], true);
B
Behdad Esfahbod 已提交
370 371
}

372

373 374 375 376 377 378 379
bool
_hb_ot_shape_complex_prefer_decomposed_indic (void)
{
  /* We want split matras decomposed by the common shaping logic. */
  return TRUE;
}

380

B
Behdad Esfahbod 已提交
381
void
382
_hb_ot_shape_complex_setup_masks_indic (hb_ot_map_t *map, hb_buffer_t *buffer)
B
Behdad Esfahbod 已提交
383
{
384 385 386
  HB_BUFFER_ALLOCATE_VAR (buffer, indic_category);
  HB_BUFFER_ALLOCATE_VAR (buffer, indic_position);

B
Behdad Esfahbod 已提交
387 388 389 390
  /* We cannot setup masks here.  We save information about characters
   * and setup masks later on in a pause-callback. */

  unsigned int count = buffer->len;
B
Behdad Esfahbod 已提交
391 392
  for (unsigned int i = 0; i < count; i++)
  {
393
    unsigned int type = get_indic_categories (buffer->info[i].codepoint);
B
Behdad Esfahbod 已提交
394

395 396
    buffer->info[i].indic_category() = type & 0x0F;
    buffer->info[i].indic_position() = type >> 4;
B
Behdad Esfahbod 已提交
397

398
    if (buffer->info[i].indic_category() == OT_C) {
B
Behdad Esfahbod 已提交
399
      buffer->info[i].indic_position() = consonant_position (buffer->info[i].codepoint);
400 401
      if (is_ra (buffer->info[i].codepoint))
	buffer->info[i].indic_category() = OT_Ra;
B
Behdad Esfahbod 已提交
402 403 404 405
    } else if (buffer->info[i].codepoint == 0x200C)
      buffer->info[i].indic_category() = OT_ZWNJ;
    else if (buffer->info[i].codepoint == 0x200D)
      buffer->info[i].indic_category() = OT_ZWJ;
B
Behdad Esfahbod 已提交
406
  }
B
Behdad Esfahbod 已提交
407
}
B
Behdad Esfahbod 已提交
408

B
Behdad Esfahbod 已提交
409 410 411 412 413 414 415 416
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;
}
417

B
Behdad Esfahbod 已提交
418 419 420 421 422
static void
found_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;
B
Minor  
Behdad Esfahbod 已提交
423
  hb_glyph_info_t *info = buffer->info;
B
Behdad Esfahbod 已提交
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445

  /* 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 = 0;

  /* -> starting from the end of the syllable, move backwards */
  i = end;
446
  unsigned int limit = start + (info[start].indic_category() == OT_Ra ? 2 : 0);
B
Behdad Esfahbod 已提交
447 448 449
  do {
    i--;
    /* -> until a consonant is found */
B
Behdad Esfahbod 已提交
450
    if (is_consonant (info[i]))
B
Behdad Esfahbod 已提交
451 452 453
    {
      /* -> that does not have a below-base or post-base form
       * (post-base forms have to follow below-base forms), */
B
Minor  
Behdad Esfahbod 已提交
454 455
      if (info[i].indic_position() != POS_BELOW &&
	  info[i].indic_position() != POS_POST)
B
Behdad Esfahbod 已提交
456 457 458 459 460
      {
        base = i;
	break;
      }

461 462 463 464 465 466 467 468 469 470 471 472 473
      /* -> or that is not a pre-base reordering Ra,
       *
       *   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.
       *
       * IMPLEMENTATION NOTES:
       *
       * We do this by adjusting limit accordingly before entering the loop.
       */

      /* -> or arrive at the first consonant. The consonant stopped at will
       * be the base. */
B
Behdad Esfahbod 已提交
474 475
      base = i;
    }
476
  } while (i > limit);
B
Behdad Esfahbod 已提交
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
  if (base < start)
    base = start; /* Just in case... */


  /* 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.
   */


B
Behdad Esfahbod 已提交
513 514 515
  /* Reorder characters */

  for (i = start; i < base; i++)
B
Minor  
Behdad Esfahbod 已提交
516 517
    info[i].indic_position() = POS_PRE;
  info[base].indic_position() = POS_BASE;
B
Behdad Esfahbod 已提交
518

519 520

  /* Handle beginning Ra */
521
  if (start + 3 <= end &&
522
      info[start].indic_category() == OT_Ra &&
523
      info[start + 1].indic_category() == OT_H &&
524
      !is_joiner (info[start + 2]))
525 526 527 528 529
   {
    info[start].indic_position() = POS_POST;
    info[start].mask = mask_array[RPHF];
   }

530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
  /* 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--)
	  if ((FLAG (info[j].indic_category()) & (FLAG (OT_C) | FLAG (OT_Ra))))
	    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;
      }
  }

B
Behdad Esfahbod 已提交
550 551
  /* Attach ZWJ, ZWNJ, nukta, and halant to previous char to move with them. */
  for (i = start + 1; i < end; i++)
B
Minor  
Behdad Esfahbod 已提交
552
    if ((FLAG (info[i].indic_category()) &
B
Behdad Esfahbod 已提交
553
	 (FLAG (OT_ZWNJ) | FLAG (OT_ZWJ) | FLAG (OT_N) | FLAG (OT_H))))
B
Minor  
Behdad Esfahbod 已提交
554
      info[i].indic_position() = info[i - 1].indic_position();
B
Behdad Esfahbod 已提交
555 556 557 558 559 560

  /* We do bubble-sort, skip malicious clusters attempts */
  if (end - start > 20)
    return;

  /* Sit tight, rock 'n roll! */
B
Minor  
Behdad Esfahbod 已提交
561
  hb_bubble_sort (info + start, end - start, compare_indic_order);
B
Behdad Esfahbod 已提交
562

B
Behdad Esfahbod 已提交
563 564 565 566
  /* Setup masks now */

  /* Pre-base */
  for (i = start; i < base; i++)
B
Behdad Esfahbod 已提交
567
    info[i].mask  |= mask_array[HALF] | mask_array[AKHN] | mask_array[CJCT];
B
Behdad Esfahbod 已提交
568
  /* Base */
B
Behdad Esfahbod 已提交
569
  info[base].mask |= mask_array[AKHN] | mask_array[CJCT];
B
Behdad Esfahbod 已提交
570 571
  /* Post-base */
  for (i = base + 1; i < end; i++)
B
Behdad Esfahbod 已提交
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
    info[i].mask  |= mask_array[BLWF] | mask_array[PSTF] | mask_array[CJCT];

  /* 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 - 1;

      do {
	info[j].mask &= !mask_array[HALF];
	if (non_joiner)
	  info[j].mask &= !mask_array[CJCT];
	j--;
      } while (j > start && !is_consonant (info[j]));
    }
B
Behdad Esfahbod 已提交
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
}


static void
found_vowel_syllable (const hb_ot_map_t *map, hb_buffer_t *buffer, hb_mask_t *mask_array,
		      unsigned int start, unsigned int end)
{
  /* TODO
   * Not clear to me how this should work.  Do the matras move to before the
   * independent vowel?  No idea.
   */
}

static void
found_standalone_cluster (const hb_ot_map_t *map, hb_buffer_t *buffer, hb_mask_t *mask_array,
			  unsigned int start, unsigned int end)
{
  /* TODO
   * Easiest thing to do here is to convert the NBSP to consonant and
   * call found_consonant_syllable.
   */
}

static void
found_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"

B
Behdad Esfahbod 已提交
620 621 622 623 624 625 626 627 628 629 630 631 632 633
static void
remove_joiners (hb_buffer_t *buffer)
{
  buffer->clear_output ();
  unsigned int count = buffer->len;
  for (buffer->idx = 0; buffer->idx < count;)
    if (unlikely (is_joiner (buffer->info[buffer->idx])))
      buffer->skip_glyph ();
    else
      buffer->next_glyph ();

  buffer->swap_buffers ();
}

B
Behdad Esfahbod 已提交
634 635 636 637 638 639
static void
initial_reordering (const hb_ot_map_t *map,
		    hb_face_t *face,
		    hb_buffer_t *buffer,
		    void *user_data HB_UNUSED)
{
B
Behdad Esfahbod 已提交
640 641 642
  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++)
643
    mask_array[i] = map->get_1_mask (indic_basic_features[i].tag);
B
Behdad Esfahbod 已提交
644 645

  find_syllables (map, buffer, mask_array);
B
Behdad Esfahbod 已提交
646 647

  remove_joiners (buffer);
B
Behdad Esfahbod 已提交
648 649
}

B
Behdad Esfahbod 已提交
650 651 652 653 654 655 656 657 658 659 660
static void
final_reordering (const hb_ot_map_t *map,
		  hb_face_t *face,
		  hb_buffer_t *buffer,
		  void *user_data HB_UNUSED)
{
  HB_BUFFER_DEALLOCATE_VAR (buffer, indic_category);
  HB_BUFFER_DEALLOCATE_VAR (buffer, indic_position);
}


B
Behdad Esfahbod 已提交
661 662

HB_END_DECLS