hb-ot-shape-complex-indic.cc 56.5 KB
Newer Older
B
Behdad Esfahbod 已提交
1
/*
B
Minor  
Behdad Esfahbod 已提交
2
 * Copyright © 2011,2012  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
 *
 *  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
 */

B
Behdad Esfahbod 已提交
27
#include "hb-ot-shape-complex-indic-private.hh"
B
Behdad Esfahbod 已提交
28
#include "hb-ot-layout-private.hh"
29

B
Behdad Esfahbod 已提交
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 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
/* buffer var allocations */
#define indic_category() complex_var_u8_0() /* indic_category_t */
#define indic_position() complex_var_u8_1() /* indic_position_t */


/*
 * Indic shaper.
 */


#define IN_HALF_BLOCK(u, Base) (((u) & ~0x7F) == (Base))

#define IS_DEVA(u) (IN_HALF_BLOCK (u, 0x0900))
#define IS_BENG(u) (IN_HALF_BLOCK (u, 0x0980))
#define IS_GURU(u) (IN_HALF_BLOCK (u, 0x0A00))
#define IS_GUJR(u) (IN_HALF_BLOCK (u, 0x0A80))
#define IS_ORYA(u) (IN_HALF_BLOCK (u, 0x0B00))
#define IS_TAML(u) (IN_HALF_BLOCK (u, 0x0B80))
#define IS_TELU(u) (IN_HALF_BLOCK (u, 0x0C00))
#define IS_KNDA(u) (IN_HALF_BLOCK (u, 0x0C80))
#define IS_MLYM(u) (IN_HALF_BLOCK (u, 0x0D00))
#define IS_SINH(u) (IN_HALF_BLOCK (u, 0x0D80))
#define IS_KHMR(u) (IN_HALF_BLOCK (u, 0x1780))


#define MATRA_POS_LEFT(u)	POS_PRE_M
#define MATRA_POS_RIGHT(u)	( \
				  IS_DEVA(u) ? POS_AFTER_SUB  : \
				  IS_BENG(u) ? POS_AFTER_POST : \
				  IS_GURU(u) ? POS_AFTER_POST : \
				  IS_GUJR(u) ? POS_AFTER_POST : \
				  IS_ORYA(u) ? POS_AFTER_POST : \
				  IS_TAML(u) ? POS_AFTER_POST : \
				  IS_TELU(u) ? (u <= 0x0C42 ? POS_BEFORE_SUB : POS_AFTER_SUB) : \
				  IS_KNDA(u) ? (u < 0x0CC3 || u > 0xCD6 ? POS_BEFORE_SUB : POS_AFTER_SUB) : \
				  IS_MLYM(u) ? POS_AFTER_POST : \
				  IS_SINH(u) ? POS_AFTER_SUB  : \
				  IS_KHMR(u) ? POS_AFTER_POST : \
				  /*default*/  POS_AFTER_SUB    \
				)
#define MATRA_POS_TOP(u)	( /* BENG and MLYM don't have top matras. */ \
				  IS_DEVA(u) ? POS_AFTER_SUB  : \
				  IS_GURU(u) ? POS_AFTER_POST : /* Deviate from spec */ \
				  IS_GUJR(u) ? POS_AFTER_SUB  : \
				  IS_ORYA(u) ? POS_AFTER_MAIN : \
				  IS_TAML(u) ? POS_AFTER_SUB  : \
				  IS_TELU(u) ? POS_BEFORE_SUB : \
				  IS_KNDA(u) ? POS_BEFORE_SUB : \
				  IS_SINH(u) ? POS_AFTER_SUB  : \
				  IS_KHMR(u) ? POS_AFTER_POST : \
				  /*default*/  POS_AFTER_SUB    \
				)
#define MATRA_POS_BOTTOM(u)	( \
				  IS_DEVA(u) ? POS_AFTER_SUB  : \
				  IS_BENG(u) ? POS_AFTER_SUB  : \
				  IS_GURU(u) ? POS_AFTER_POST : \
				  IS_GUJR(u) ? POS_AFTER_POST : \
				  IS_ORYA(u) ? POS_AFTER_SUB  : \
				  IS_TAML(u) ? POS_AFTER_POST : \
				  IS_TELU(u) ? POS_BEFORE_SUB : \
				  IS_KNDA(u) ? POS_BEFORE_SUB : \
				  IS_MLYM(u) ? POS_AFTER_POST : \
				  IS_SINH(u) ? POS_AFTER_SUB  : \
				  IS_KHMR(u) ? POS_AFTER_POST : \
				  /*default*/  POS_AFTER_SUB    \
				)

static inline indic_position_t
matra_position (hb_codepoint_t u, indic_position_t side)
{
  switch ((int) side)
  {
    case POS_PRE_C:	return MATRA_POS_LEFT (u);
    case POS_POST_C:	return MATRA_POS_RIGHT (u);
    case POS_ABOVE_C:	return MATRA_POS_TOP (u);
    case POS_BELOW_C:	return MATRA_POS_BOTTOM (u);
  };
  return side;
}

/* XXX
 * This is a hack for now.  We should move this data into the main Indic table.
 * Or completely remove it and just check in the tables.
 */
static const hb_codepoint_t ra_chars[] = {
  0x0930, /* Devanagari */
  0x09B0, /* Bengali */
  0x09F0, /* Bengali */
  0x0A30, /* Gurmukhi */	/* No Reph */
  0x0AB0, /* Gujarati */
  0x0B30, /* Oriya */
  0x0BB0, /* Tamil */		/* No Reph */
  0x0C30, /* Telugu */		/* Reph formed only with ZWJ */
  0x0CB0, /* Kannada */
  0x0D30, /* Malayalam */	/* No Reph, Logical Repha */

  0x0DBB, /* Sinhala */		/* Reph formed only with ZWJ */

  0x179A, /* Khmer */		/* No Reph, Visual Repha */
};

static inline bool
is_ra (hb_codepoint_t u)
{
  for (unsigned int i = 0; i < ARRAY_LENGTH (ra_chars); i++)
    if (u == ra_chars[i])
      return true;
  return false;
}

static inline bool
is_one_of (const hb_glyph_info_t &info, unsigned int flags)
{
  /* If it ligated, all bets are off. */
  if (is_a_ligature (info)) return false;
  return !!(FLAG (info.indic_category()) & flags);
}

#define JOINER_FLAGS (FLAG (OT_ZWJ) | FLAG (OT_ZWNJ))
static inline bool
is_joiner (const hb_glyph_info_t &info)
{
  return is_one_of (info, JOINER_FLAGS);
}

/* Note:
 *
 * We treat Vowels and placeholders 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! */
#define CONSONANT_FLAGS (FLAG (OT_C) | FLAG (OT_CM) | FLAG (OT_Ra) | FLAG (OT_V) | FLAG (OT_NBSP) | FLAG (OT_DOTTEDCIRCLE))
static inline bool
is_consonant (const hb_glyph_info_t &info)
{
  return is_one_of (info, CONSONANT_FLAGS);
}

#define HALANT_OR_COENG_FLAGS (FLAG (OT_H) | FLAG (OT_Coeng))
static inline bool
is_halant_or_coeng (const hb_glyph_info_t &info)
{
  return is_one_of (info, HALANT_OR_COENG_FLAGS);
}

static inline void
set_indic_properties (hb_glyph_info_t &info)
{
  hb_codepoint_t u = info.codepoint;
  unsigned int type = hb_indic_get_categories (u);
  indic_category_t cat = (indic_category_t) (type & 0x7F);
  indic_position_t pos = (indic_position_t) (type >> 8);


  /*
   * Re-assign category
   */


  /* The spec says U+0952 is OT_A.  However, testing shows that Uniscribe
B
Behdad Esfahbod 已提交
189
   * treats U+0951..U+0954 all behave similarly.
B
Behdad Esfahbod 已提交
190 191 192 193 194
   * TESTS:
   * U+092E,U+0947,U+0952
   * U+092E,U+0952,U+0947
   * U+092E,U+0947,U+0951
   * U+092E,U+0951,U+0947
B
Behdad Esfahbod 已提交
195
   */
B
Behdad Esfahbod 已提交
196
  if (unlikely (hb_in_range<hb_codepoint_t> (u, 0x0951, 0x0954)))
B
Behdad Esfahbod 已提交
197
    cat = OT_A;
B
Behdad Esfahbod 已提交
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214

  if (unlikely (u == 0x17D1))
    cat = OT_X;
  if (cat == OT_X &&
      unlikely (hb_in_range<hb_codepoint_t> (u, 0x17CB, 0x17D3))) /* Khmer Various signs */
  {
    /* These are like Top Matras. */
    cat = OT_M;
    pos = POS_ABOVE_C;
  }
  if (u == 0x17C6) /* Khmer Bindu doesn't like to be repositioned. */
    cat = OT_N;

  if (unlikely (u == 0x17D2)) cat = OT_Coeng; /* Khmer coeng */
  else if (unlikely (u == 0x200C)) cat = OT_ZWNJ;
  else if (unlikely (u == 0x200D)) cat = OT_ZWJ;
  else if (unlikely (u == 0x25CC)) cat = OT_DOTTEDCIRCLE;
B
Behdad Esfahbod 已提交
215
  else if (unlikely (u == 0x0A71)) cat = OT_SM; /* GURMUKHI ADDAK.  Move it to the end. */
B
Behdad Esfahbod 已提交
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235

  if (cat == OT_Repha) {
    /* There are two kinds of characters marked as Repha:
     * - The ones that are GenCat=Mn are already positioned visually, ie. after base. (eg. Khmer)
     * - The ones that are GenCat=Lo is encoded logically, ie. beginning of syllable. (eg. Malayalam)
     *
     * We recategorize the first kind to look like a Nukta and attached to the base directly.
     */
    if (_hb_glyph_info_get_general_category (&info) == HB_UNICODE_GENERAL_CATEGORY_NON_SPACING_MARK)
      cat = OT_N;
  }



  /*
   * Re-assign position.
   */

  if ((FLAG (cat) & CONSONANT_FLAGS))
  {
236
    pos = POS_BASE_C;
B
Behdad Esfahbod 已提交
237 238 239 240 241 242 243
    if (is_ra (u))
      cat = OT_Ra;
  }
  else if (cat == OT_M)
  {
    pos = matra_position (u, pos);
  }
B
Behdad Esfahbod 已提交
244
  else if ((FLAG (cat) & (FLAG (OT_SM) | FLAG (OT_VD) | FLAG (OT_A) | FLAG (OT_Avag))))
B
Behdad Esfahbod 已提交
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
  {
    pos = POS_SMVD;
  }

  if (unlikely (u == 0x0B01)) pos = POS_BEFORE_SUB; /* Oriya Bindu is BeforeSub in the spec. */



  info.indic_category() = cat;
  info.indic_position() = pos;
}

/*
 * Things above this line should ideally be moved to the Indic table itself.
 */

B
Behdad Esfahbod 已提交
261

262 263 264 265 266 267 268 269 270 271
/*
 * Indic configurations.  Note that we do not want to keep every single script-specific
 * behavior in these tables necessarily.  This should mainly be used for per-script
 * properties that are cheaper keeping here, than in the code.  Ie. if, say, one and
 * only one script has an exception, that one script can be if'ed directly in the code,
 * instead of adding a new flag in these structs.
 */

enum base_position_t {
  BASE_POS_FIRST,
272
  BASE_POS_LAST_SINHALA,
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
  BASE_POS_LAST
};
enum reph_position_t {
  REPH_POS_DEFAULT     = POS_BEFORE_POST,

  REPH_POS_AFTER_MAIN  = POS_AFTER_MAIN,
  REPH_POS_BEFORE_SUB  = POS_BEFORE_SUB,
  REPH_POS_AFTER_SUB   = POS_AFTER_SUB,
  REPH_POS_BEFORE_POST = POS_BEFORE_POST,
  REPH_POS_AFTER_POST  = POS_AFTER_POST
};
enum reph_mode_t {
  REPH_MODE_IMPLICIT,  /* Reph formed out of initial Ra,H sequence. */
  REPH_MODE_EXPLICIT,  /* Reph formed out of initial Ra,H,ZWJ sequence. */
  REPH_MODE_VIS_REPHA, /* Encoded Repha character, no reordering needed. */
  REPH_MODE_LOG_REPHA  /* Encoded Repha character, needs reordering. */
};
290 291 292 293
enum blwf_mode_t {
  BLWF_MODE_PRE_AND_POST, /* Below-forms feature applied to pre-base and post-base. */
  BLWF_MODE_POST_ONLY     /* Below-forms feature applied to post-base only. */
};
294 295 296 297 298 299 300 301
struct indic_config_t
{
  hb_script_t     script;
  bool            has_old_spec;
  hb_codepoint_t  virama;
  base_position_t base_pos;
  reph_position_t reph_pos;
  reph_mode_t     reph_mode;
302
  blwf_mode_t     blwf_mode;
303 304 305 306 307
};

static const indic_config_t indic_configs[] =
{
  /* Default.  Should be first. */
308 309 310 311 312 313 314 315 316 317
  {HB_SCRIPT_INVALID,	false,     0,BASE_POS_LAST, REPH_POS_DEFAULT,    REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  {HB_SCRIPT_DEVANAGARI,true, 0x094D,BASE_POS_LAST, REPH_POS_BEFORE_POST,REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  {HB_SCRIPT_BENGALI,	true, 0x09CD,BASE_POS_LAST, REPH_POS_AFTER_SUB,  REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  {HB_SCRIPT_GURMUKHI,	true, 0x0A4D,BASE_POS_LAST, REPH_POS_BEFORE_SUB, REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  {HB_SCRIPT_GUJARATI,	true, 0x0ACD,BASE_POS_LAST, REPH_POS_BEFORE_POST,REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  {HB_SCRIPT_ORIYA,	true, 0x0B4D,BASE_POS_LAST, REPH_POS_AFTER_MAIN, REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  {HB_SCRIPT_TAMIL,	true, 0x0BCD,BASE_POS_LAST, REPH_POS_AFTER_POST, REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  {HB_SCRIPT_TELUGU,	true, 0x0C4D,BASE_POS_LAST, REPH_POS_AFTER_POST, REPH_MODE_EXPLICIT, BLWF_MODE_POST_ONLY},
  {HB_SCRIPT_KANNADA,	true, 0x0CCD,BASE_POS_LAST, REPH_POS_AFTER_POST, REPH_MODE_IMPLICIT, BLWF_MODE_POST_ONLY},
  {HB_SCRIPT_MALAYALAM,	true, 0x0D4D,BASE_POS_LAST, REPH_POS_AFTER_MAIN, REPH_MODE_LOG_REPHA,BLWF_MODE_PRE_AND_POST},
318 319
  {HB_SCRIPT_SINHALA,	false,0x0DCA,BASE_POS_LAST_SINHALA,
						    REPH_POS_AFTER_MAIN, REPH_MODE_EXPLICIT, BLWF_MODE_PRE_AND_POST},
320 321
  {HB_SCRIPT_KHMER,	false,0x17D2,BASE_POS_FIRST,REPH_POS_DEFAULT,    REPH_MODE_VIS_REPHA,BLWF_MODE_PRE_AND_POST},
  {HB_SCRIPT_JAVANESE,	false,0xA9C0,BASE_POS_LAST, REPH_POS_DEFAULT,    REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
322 323 324 325 326 327 328
};



/*
 * Indic shaper.
 */
B
Behdad Esfahbod 已提交
329

330
struct feature_list_t {
331
  hb_tag_t tag;
B
Behdad Esfahbod 已提交
332
  hb_ot_map_feature_flags_t flags;
333 334 335
};

static const feature_list_t
336
indic_features[] =
B
Behdad Esfahbod 已提交
337
{
338 339 340 341
  /*
   * Basic features.
   * These features are applied in order, one at a time, after initial_reordering.
   */
342 343 344 345 346 347 348
  {HB_TAG('n','u','k','t'), F_GLOBAL},
  {HB_TAG('a','k','h','n'), F_GLOBAL},
  {HB_TAG('r','p','h','f'), F_NONE},
  {HB_TAG('r','k','r','f'), F_GLOBAL},
  {HB_TAG('p','r','e','f'), F_NONE},
  {HB_TAG('b','l','w','f'), F_NONE},
  {HB_TAG('a','b','v','f'), F_NONE},
349
  {HB_TAG('h','a','l','f'), F_NONE},
350 351 352
  {HB_TAG('p','s','t','f'), F_NONE},
  {HB_TAG('v','a','t','u'), F_GLOBAL},
  {HB_TAG('c','j','c','t'), F_GLOBAL},
353
  {HB_TAG('c','f','a','r'), F_NONE},
354 355 356
  /*
   * Other features.
   * These features are applied all at once, after final_reordering.
357 358
   * Default Bengali font in Windows for example has intermixed
   * lookups for init,pres,abvs,blws features.
359
   */
B
Behdad Esfahbod 已提交
360 361 362 363 364 365
  {HB_TAG('i','n','i','t'), F_NONE},
  {HB_TAG('p','r','e','s'), F_GLOBAL},
  {HB_TAG('a','b','v','s'), F_GLOBAL},
  {HB_TAG('b','l','w','s'), F_GLOBAL},
  {HB_TAG('p','s','t','s'), F_GLOBAL},
  {HB_TAG('h','a','l','n'), F_GLOBAL},
366
  /* Positioning features, though we don't care about the types. */
B
Behdad Esfahbod 已提交
367 368 369
  {HB_TAG('d','i','s','t'), F_GLOBAL},
  {HB_TAG('a','b','v','m'), F_GLOBAL},
  {HB_TAG('b','l','w','m'), F_GLOBAL},
370 371
};

372 373 374
/*
 * Must be in the same order as the indic_features array.
 */
375 376
enum {
  _NUKT,
B
Behdad Esfahbod 已提交
377
  _AKHN,
378
  RPHF,
B
Minor  
Behdad Esfahbod 已提交
379
  _RKRF,
380
  PREF,
381
  BLWF,
B
Behdad Esfahbod 已提交
382
  ABVF,
383
  HALF,
384
  PSTF,
385
  _VATU,
386
  _CJCT,
387
  CFAR,
388 389 390 391 392 393 394 395 396 397 398 399 400

  INIT,
  _PRES,
  _ABVS,
  _BLWS,
  _PSTS,
  _HALN,
  _DIST,
  _ABVM,
  _BLWM,

  INDIC_NUM_FEATURES,
  INDIC_BASIC_FEATURES = INIT /* Don't forget to update this! */
B
Behdad Esfahbod 已提交
401 402
};

403 404 405 406
static void
setup_syllables (const hb_ot_shape_plan_t *plan,
		 hb_font_t *font,
		 hb_buffer_t *buffer);
B
Behdad Esfahbod 已提交
407
static void
408
initial_reordering (const hb_ot_shape_plan_t *plan,
409
		    hb_font_t *font,
B
Behdad Esfahbod 已提交
410
		    hb_buffer_t *buffer);
411
static void
412
final_reordering (const hb_ot_shape_plan_t *plan,
413
		  hb_font_t *font,
B
Behdad Esfahbod 已提交
414
		  hb_buffer_t *buffer);
415 416 417 418
static void
clear_syllables (const hb_ot_shape_plan_t *plan,
		 hb_font_t *font,
		 hb_buffer_t *buffer);
B
Behdad Esfahbod 已提交
419

420
static void
421
collect_features_indic (hb_ot_shape_planner_t *plan)
B
Behdad Esfahbod 已提交
422
{
423 424
  hb_ot_map_builder_t *map = &plan->map;

425 426 427
  /* Do this before any lookups have been applied. */
  map->add_gsub_pause (setup_syllables);

B
Behdad Esfahbod 已提交
428
  map->add_global_bool_feature (HB_TAG('l','o','c','l'));
B
Minor  
Behdad Esfahbod 已提交
429 430
  /* 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. */
B
Behdad Esfahbod 已提交
431
  map->add_global_bool_feature (HB_TAG('c','c','m','p'));
432 433


434 435 436
  unsigned int i = 0;
  map->add_gsub_pause (initial_reordering);
  for (; i < INDIC_BASIC_FEATURES; i++) {
437
    map->add_feature (indic_features[i].tag, 1, indic_features[i].flags | F_MANUAL_ZWJ);
B
Behdad Esfahbod 已提交
438
    map->add_gsub_pause (NULL);
439
  }
B
Behdad Esfahbod 已提交
440
  map->add_gsub_pause (final_reordering);
441
  for (; i < INDIC_NUM_FEATURES; i++) {
442
    map->add_feature (indic_features[i].tag, 1, indic_features[i].flags | F_MANUAL_ZWJ);
443
  }
444 445 446 447

  map->add_global_bool_feature (HB_TAG('c','a','l','t'));
  map->add_global_bool_feature (HB_TAG('c','l','i','g'));

448
  map->add_gsub_pause (clear_syllables);
B
Behdad Esfahbod 已提交
449 450
}

451
static void
452
override_features_indic (hb_ot_shape_planner_t *plan)
453
{
454
  /* Uniscribe does not apply 'kern' in Khmer. */
455
  if (hb_options ().uniscribe_bug_compatible)
456 457 458 459
  {
    switch ((hb_tag_t) plan->props.script)
    {
      case HB_SCRIPT_KHMER:
460
	plan->map.add_feature (HB_TAG('k','e','r','n'), 0, F_GLOBAL);
461 462 463
	break;
    }
  }
B
Behdad Esfahbod 已提交
464

B
Behdad Esfahbod 已提交
465
  plan->map.add_feature (HB_TAG('l','i','g','a'), 0, F_GLOBAL);
466 467
}

468

469
struct would_substitute_feature_t
470
{
471
  inline void init (const hb_ot_map_t *map, hb_tag_t feature_tag)
472 473 474 475 476 477
  {
    map->get_stage_lookups (0/*GSUB*/,
			    map->get_feature_stage (0/*GSUB*/, feature_tag),
			    &lookups, &count);
  }

478 479 480 481
  inline bool would_substitute (const hb_codepoint_t *glyphs,
				unsigned int          glyphs_count,
				bool                  zero_context,
				hb_face_t            *face) const
482 483
  {
    for (unsigned int i = 0; i < count; i++)
484
      if (hb_ot_layout_lookup_would_substitute_fast (face, lookups[i].index, glyphs, glyphs_count, zero_context))
485 486 487 488 489 490 491 492 493 494 495
	return true;
    return false;
  }

  private:
  const hb_ot_map_t::lookup_map_t *lookups;
  unsigned int count;
};

struct indic_shape_plan_t
{
496
  ASSERT_POD ();
497 498 499 500 501 502

  inline bool get_virama_glyph (hb_font_t *font, hb_codepoint_t *pglyph) const
  {
    hb_codepoint_t glyph = virama_glyph;
    if (unlikely (virama_glyph == (hb_codepoint_t) -1))
    {
503
      if (!config->virama || !font->get_glyph (config->virama, 0, &glyph))
504 505 506 507 508 509 510 511 512 513 514 515
	glyph = 0;
      /* Technically speaking, the spec says we should apply 'locl' to virama too.
       * Maybe one day... */

      /* Our get_glyph() function needs a font, so we can't get the virama glyph
       * during shape planning...  Instead, overwrite it here.  It's safe.  Don't worry! */
      (const_cast<indic_shape_plan_t *> (this))->virama_glyph = glyph;
    }

    *pglyph = glyph;
    return glyph != 0;
  }
516

517
  const indic_config_t *config;
518 519 520 521

  bool is_old_spec;
  hb_codepoint_t virama_glyph;

522
  would_substitute_feature_t rphf;
523 524 525 526 527
  would_substitute_feature_t pref;
  would_substitute_feature_t blwf;
  would_substitute_feature_t pstf;

  hb_mask_t mask_array[INDIC_NUM_FEATURES];
528 529 530 531 532
};

static void *
data_create_indic (const hb_ot_shape_plan_t *plan)
{
533 534
  indic_shape_plan_t *indic_plan = (indic_shape_plan_t *) calloc (1, sizeof (indic_shape_plan_t));
  if (unlikely (!indic_plan))
535 536
    return NULL;

537 538 539 540 541
  indic_plan->config = &indic_configs[0];
  for (unsigned int i = 1; i < ARRAY_LENGTH (indic_configs); i++)
    if (plan->props.script == indic_configs[i].script) {
      indic_plan->config = &indic_configs[i];
      break;
542
    }
543

B
Behdad Esfahbod 已提交
544
  indic_plan->is_old_spec = indic_plan->config->has_old_spec && ((plan->map.chosen_script[0] & 0x000000FF) != '2');
545
  indic_plan->virama_glyph = (hb_codepoint_t) -1;
546

547
  indic_plan->rphf.init (&plan->map, HB_TAG('r','p','h','f'));
548 549 550 551 552
  indic_plan->pref.init (&plan->map, HB_TAG('p','r','e','f'));
  indic_plan->blwf.init (&plan->map, HB_TAG('b','l','w','f'));
  indic_plan->pstf.init (&plan->map, HB_TAG('p','s','t','f'));

  for (unsigned int i = 0; i < ARRAY_LENGTH (indic_plan->mask_array); i++)
B
Behdad Esfahbod 已提交
553 554
    indic_plan->mask_array[i] = (indic_features[i].flags & F_GLOBAL) ?
				 0 : plan->map.get_1_mask (indic_features[i].tag);
555

556
  return indic_plan;
557 558 559 560 561 562 563 564 565 566
}

static void
data_destroy_indic (void *data)
{
  free (data);
}

static indic_position_t
consonant_position_from_face (const indic_shape_plan_t *indic_plan,
567 568
			      const hb_codepoint_t glyphs[2],
			      hb_face_t *face)
569
{
570 571 572 573 574 575 576 577 578 579
  /* For old-spec, the order of glyphs is Consonant,Virama,
   * whereas for new-spec, it's Virama,Consonant.  However,
   * some broken fonts (like Free Sans) simply copied lookups
   * from old-spec to new-spec without modification.
   * And oddly enough, Uniscribe seems to respect those lookups.
   * Eg. in the sequence U+0924,U+094D,U+0930, Uniscribe finds
   * base at 0.  The font however, only has lookups matching
   * 930,94D in 'blwf', not the expected 94D,930 (with new-spec
   * table).  As such, we simply match both sequences.  Seems
   * to work. */
580
  bool zero_context = indic_plan->is_old_spec ? false : true;
581 582 583 584 585 586 587
  hb_codepoint_t glyphs_r[2] = {glyphs[1], glyphs[0]};
  if (indic_plan->blwf.would_substitute (glyphs  , 2, zero_context, face) ||
      indic_plan->blwf.would_substitute (glyphs_r, 2, zero_context, face))
    return POS_BELOW_C;
  if (indic_plan->pstf.would_substitute (glyphs  , 2, zero_context, face) ||
      indic_plan->pstf.would_substitute (glyphs_r, 2, zero_context, face))
    return POS_POST_C;
588 589 590
  if (indic_plan->pref.would_substitute (glyphs  , 2, zero_context, face) ||
      indic_plan->pref.would_substitute (glyphs_r, 2, zero_context, face))
    return POS_POST_C;
591 592 593 594
  return POS_BASE_C;
}


595 596 597 598
enum syllable_type_t {
  consonant_syllable,
  vowel_syllable,
  standalone_cluster,
B
Behdad Esfahbod 已提交
599
  avagraha_cluster,
600 601 602 603 604 605 606
  broken_cluster,
  non_indic_cluster,
};

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


607
static void
608 609 610
setup_masks_indic (const hb_ot_shape_plan_t *plan HB_UNUSED,
		   hb_buffer_t              *buffer,
		   hb_font_t                *font HB_UNUSED)
611 612 613 614 615 616 617 618 619 620 621 622
{
  HB_BUFFER_ALLOCATE_VAR (buffer, indic_category);
  HB_BUFFER_ALLOCATE_VAR (buffer, indic_position);

  /* 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++)
    set_indic_properties (buffer->info[i]);
}

623 624 625 626 627 628 629 630
static void
setup_syllables (const hb_ot_shape_plan_t *plan HB_UNUSED,
		 hb_font_t *font HB_UNUSED,
		 hb_buffer_t *buffer)
{
  find_syllables (buffer);
}

631 632 633 634 635 636 637 638 639 640 641
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;
}



642
static void
643
update_consonant_positions (const hb_ot_shape_plan_t *plan,
644 645
			    hb_font_t         *font,
			    hb_buffer_t       *buffer)
646
{
647
  const indic_shape_plan_t *indic_plan = (const indic_shape_plan_t *) plan->data;
648

649 650 651
  if (indic_plan->config->base_pos != BASE_POS_LAST)
    return;

652
  hb_codepoint_t glyphs[2];
653
  if (indic_plan->get_virama_glyph (font, &glyphs[0]))
654 655 656 657 658
  {
    hb_face_t *face = font->face;
    unsigned int count = buffer->len;
    for (unsigned int i = 0; i < count; i++)
      if (buffer->info[i].indic_position() == POS_BASE_C) {
659 660
	glyphs[1] = buffer->info[i].codepoint;
	buffer->info[i].indic_position() = consonant_position_from_face (indic_plan, glyphs, face);
661 662 663 664
      }
  }
}

665

B
Minor  
Behdad Esfahbod 已提交
666 667 668
/* Rules from:
 * https://www.microsoft.com/typography/otfntdev/devanot/shaping.aspx */

B
Behdad Esfahbod 已提交
669
static void
670 671 672
initial_reordering_consonant_syllable (const hb_ot_shape_plan_t *plan,
				       hb_face_t *face,
				       hb_buffer_t *buffer,
673
				       unsigned int start, unsigned int end)
B
Behdad Esfahbod 已提交
674
{
675
  const indic_shape_plan_t *indic_plan = (const indic_shape_plan_t *) plan->data;
B
Minor  
Behdad Esfahbod 已提交
676
  hb_glyph_info_t *info = buffer->info;
B
Behdad Esfahbod 已提交
677

B
Behdad Esfahbod 已提交
678

B
Behdad Esfahbod 已提交
679 680 681 682 683 684 685 686 687 688 689 690 691 692
  /* 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.
   */

693
  unsigned int base = end;
B
Behdad Esfahbod 已提交
694
  bool has_reph = false;
B
Behdad Esfahbod 已提交
695

B
Behdad Esfahbod 已提交
696
  {
B
Behdad Esfahbod 已提交
697 698 699 700
    /* -> 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;
701
    if (indic_plan->mask_array[RPHF] &&
B
Behdad Esfahbod 已提交
702
	start + 3 <= end &&
703
	(
704 705
	 (indic_plan->config->reph_mode == REPH_MODE_IMPLICIT && !is_joiner (info[start + 2])) ||
	 (indic_plan->config->reph_mode == REPH_MODE_EXPLICIT && info[start + 2].indic_category() == OT_ZWJ)
706
	))
B
Behdad Esfahbod 已提交
707
    {
708 709 710 711 712 713 714 715 716 717
      /* See if it matches the 'rphf' feature. */
      hb_codepoint_t glyphs[2] = {info[start].codepoint, info[start + 1].codepoint};
      if (indic_plan->rphf.would_substitute (glyphs, ARRAY_LENGTH (glyphs), true, face))
      {
	limit += 2;
	while (limit < end && is_joiner (info[limit]))
	  limit++;
	base = start;
	has_reph = true;
      }
718 719 720 721 722 723 724 725
    } else if (indic_plan->config->reph_mode == REPH_MODE_LOG_REPHA && info[start].indic_category() == OT_Repha)
    {
	limit += 1;
	while (limit < end && is_joiner (info[limit]))
	  limit++;
	base = start;
	has_reph = true;
    }
B
Behdad Esfahbod 已提交
726

B
Behdad Esfahbod 已提交
727
    switch (indic_plan->config->base_pos)
728
    {
729 730 731 732
      default:
        assert (false);
	/* fallthrough */

733 734 735 736 737 738 739 740 741
      case BASE_POS_LAST:
      {
	/* -> starting from the end of the syllable, move backwards */
	unsigned int i = end;
	bool seen_below = false;
	do {
	  i--;
	  /* -> until a consonant is found */
	  if (is_consonant (info[i]))
742
	  {
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
	    /* -> 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 || seen_below))
	    {
	      base = i;
	      break;
	    }
	    if (info[i].indic_position() == POS_BELOW_C)
	      seen_below = true;

	    /* -> or that is not a pre-base reordering Ra,
	     *
	     * IMPLEMENTATION NOTES:
	     *
B
Behdad Esfahbod 已提交
758
	     * Our pre-base reordering Ra's are marked POS_POST_C, so will be skipped
759 760 761 762 763
	     * by the logic above already.
	     */

	    /* -> or arrive at the first consonant. The consonant stopped at will
	     * be the base. */
764 765
	    base = i;
	  }
766 767 768 769 770 771
	  else
	  {
	    /* A ZWJ after a Halant stops the base search, and requests an explicit
	     * half form.
	     * A ZWJ before a Halant, requests a subjoined form instead, and hence
	     * search continues.  This is particularly important for Bengali
B
Typo  
Behdad Esfahbod 已提交
772
	     * sequence Ra,H,Ya that should form Ya-Phalaa by subjoining Ya. */
773 774 775 776 777 778 779 780
	    if (start < i &&
		info[i].indic_category() == OT_ZWJ &&
		info[i - 1].indic_category() == OT_H)
	      break;
	  }
	} while (i > limit);
      }
      break;
781

782
      case BASE_POS_LAST_SINHALA:
783
      {
784 785 786 787
        /* Sinhala base positioning is slightly different from main Indic, in that:
	 * 1. It's ZWJ behavior is different,
	 * 2. We don't need to look into the font for consonant positions.
	 */
788

789 790
	if (!has_reph)
	  base = limit;
791

792 793 794
	/* Find the last base consonant that is not blocked by ZWJ.  If there is
	 * a ZWJ right before a base consonant, that would request a subjoined form. */
	for (unsigned int i = limit; i < end; i++)
795
	  if (is_consonant (info[i]))
796 797 798 799 800 801
	  {
	    if (limit < i && info[i - 1].indic_category() == OT_ZWJ)
	      break;
	    else
	      base = i;
	  }
802

803 804
	/* Mark all subsequent consonants as below. */
	for (unsigned int i = base + 1; i < end; i++)
805
	  if (is_consonant (info[i]))
806 807 808
	    info[i].indic_position() = POS_BELOW_C;
      }
      break;
809 810 811 812 813 814 815 816 817 818 819

      case BASE_POS_FIRST:
      {
	/* The first consonant is always the base. */

	assert (indic_plan->config->reph_mode == REPH_MODE_VIS_REPHA);

	base = start;

	/* Mark all subsequent consonants as below. */
	for (unsigned int i = base + 1; i < end; i++)
820
	  if (is_consonant (info[i]))
821 822 823
	    info[i].indic_position() = POS_BELOW_C;
      }
      break;
824
    }
B
Behdad Esfahbod 已提交
825

B
Behdad Esfahbod 已提交
826 827
    /* -> 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
828 829 830
     *    base consonants.
     *
     *  Only do this for unforced Reph. (ie. not for Ra,H,ZWJ. */
831
    if (has_reph && base == start && limit - base <= 2) {
B
Behdad Esfahbod 已提交
832 833 834
      /* Have no other consonant, so Reph is not formed and Ra becomes base. */
      has_reph = false;
    }
B
Behdad Esfahbod 已提交
835
  }
836

837

B
Behdad Esfahbod 已提交
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
  /* 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 已提交
870 871
  /* Reorder characters */

B
Minor  
Behdad Esfahbod 已提交
872
  for (unsigned int i = start; i < base; i++)
B
Minor  
Behdad Esfahbod 已提交
873
    info[i].indic_position() = MIN (POS_PRE_C, (indic_position_t) info[i].indic_position());
874

875 876
  if (base < end)
    info[base].indic_position() = POS_BASE_C;
B
Behdad Esfahbod 已提交
877

878 879 880 881 882 883 884 885 886 887 888 889
  /* Mark final consonants.  A final consonant is one appearing after a matra,
   * like in Khmer. */
  for (unsigned int i = base + 1; i < end; i++)
    if (info[i].indic_category() == OT_M) {
      for (unsigned int j = i + 1; j < end; j++)
        if (is_consonant (info[j])) {
	  info[j].indic_position() = POS_FINAL_C;
	  break;
	}
      break;
    }

890
  /* Handle beginning Ra */
B
Behdad Esfahbod 已提交
891
  if (has_reph)
892
    info[start].indic_position() = POS_RA_TO_BECOME_REPH;
893

894
  /* For old-style Indic script tags, move the first post-base Halant after
895 896
   * last consonant.  Only do this if there is *not* a Halant after last
   * consonant.  Otherwise it becomes messy. */
897
  if (indic_plan->is_old_spec) {
B
Minor  
Behdad Esfahbod 已提交
898
    for (unsigned int i = base + 1; i < end; i++)
899 900 901
      if (info[i].indic_category() == OT_H) {
        unsigned int j;
        for (j = end - 1; j > i; j--)
902
	  if (is_consonant (info[j]) || info[j].indic_category() == OT_H)
903
	    break;
904
	if (info[j].indic_category() != OT_H && j > i) {
905 906 907 908 909 910 911 912 913
	  /* 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;
      }
  }

914
  /* Attach misc marks to previous char to move with them. */
915
  {
916 917 918 919 920 921
    indic_position_t last_pos = POS_START;
    for (unsigned int i = start; i < end; i++)
    {
      if ((FLAG (info[i].indic_category()) & (JOINER_FLAGS | FLAG (OT_N) | FLAG (OT_RS) | HALANT_OR_COENG_FLAGS)))
      {
	info[i].indic_position() = last_pos;
922
	if (unlikely (info[i].indic_category() == OT_H &&
923 924 925 926 927
		      info[i].indic_position() == POS_PRE_M))
	{
	  /*
	   * Uniscribe doesn't move the Halant with Left Matra.
	   * TEST: U+092B,U+093F,U+094DE
928 929 930 931 932
	   * We follow.  This is important for the Sinhala
	   * U+0DDA split matra since it decomposes to U+0DD9,U+0DCA
	   * where U+0DD9 is a left matra and U+0DCA is the virama.
	   * We don't want to move the virama with the left matra.
	   * TEST: U+0D9A,U+0DDA
933
	   */
934
	  for (unsigned int j = i; j > start; j--)
935
	    if (info[j - 1].indic_position() != POS_PRE_M) {
936 937 938
	      info[i].indic_position() = info[j - 1].indic_position();
	      break;
	    }
939 940 941
	}
      } else if (info[i].indic_position() != POS_SMVD) {
        last_pos = (indic_position_t) info[i].indic_position();
942
      }
943
    }
944
  }
945 946 947 948
  /* Re-attach ZWJ, ZWNJ, and halant to next char, for after-base consonants. */
  {
    unsigned int last_halant = end;
    for (unsigned int i = base + 1; i < end; i++)
949
      if (is_halant_or_coeng (info[i]))
950 951 952
        last_halant = i;
      else if (is_consonant (info[i])) {
	for (unsigned int j = last_halant; j < i; j++)
953 954
	  if (info[j].indic_position() != POS_SMVD)
	    info[j].indic_position() = info[i].indic_position();
B
Behdad Esfahbod 已提交
955
	last_halant = end;
956 957
      }
  }
B
Behdad Esfahbod 已提交
958

959

960
  {
961 962 963 964 965
    /* Use syllable() for sort accounting temporarily. */
    unsigned int syllable = info[start].syllable();
    for (unsigned int i = start; i < end; i++)
      info[i].syllable() = i - start;

966
    /* Sit tight, rock 'n roll! */
967
    hb_bubble_sort (info + start, end - start, compare_indic_order);
968 969
    /* Find base again */
    base = end;
B
Minor  
Behdad Esfahbod 已提交
970
    for (unsigned int i = start; i < end; i++)
971 972 973
      if (info[i].indic_position() == POS_BASE_C)
      {
	base = i;
974 975
	break;
      }
976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
    /* Things are out-of-control for post base positions, they may shuffle
     * around like crazy.  In old-spec mode, we move halants around, so in
     * that case merge all clusters after base.  Otherwise, check the sort
     * order and merge as needed.
     * For pre-base stuff, we handle cluster issues in final reordering. */
    if (indic_plan->is_old_spec || end - base > 127)
      buffer->merge_clusters (base, end);
    else
    {
      /* Note!  syllable() is a one-byte field. */
      for (unsigned int i = base; i < end; i++)
        if (info[i].syllable() != 255)
	{
	  unsigned int max = i;
	  unsigned int j = start + info[i].syllable();
	  while (j != i)
	  {
	    max = MAX (max, j);
	    unsigned int next = start + info[j].syllable();
	    info[j].syllable() = 255; /* So we don't process j later again. */
	    j = next;
	  }
	  if (i != max)
	    buffer->merge_clusters (i, max + 1);
	}
    }

    /* Put syllable back in. */
    for (unsigned int i = start; i < end; i++)
      info[i].syllable() = syllable;
1006
  }
B
Behdad Esfahbod 已提交
1007

B
Behdad Esfahbod 已提交
1008 1009
  /* Setup masks now */

B
Behdad Esfahbod 已提交
1010 1011 1012
  {
    hb_mask_t mask;

1013
    /* Reph */
1014
    for (unsigned int i = start; i < end && info[i].indic_position() == POS_RA_TO_BECOME_REPH; i++)
1015
      info[i].mask |= indic_plan->mask_array[RPHF];
1016

B
Behdad Esfahbod 已提交
1017
    /* Pre-base */
1018
    mask = indic_plan->mask_array[HALF];
1019 1020
    if (!indic_plan->is_old_spec &&
	indic_plan->config->blwf_mode == BLWF_MODE_PRE_AND_POST)
1021
      mask |= indic_plan->mask_array[BLWF];
B
Minor  
Behdad Esfahbod 已提交
1022
    for (unsigned int i = start; i < base; i++)
B
Behdad Esfahbod 已提交
1023 1024
      info[i].mask  |= mask;
    /* Base */
B
Behdad Esfahbod 已提交
1025
    mask = 0;
1026 1027
    if (base < end)
      info[base].mask |= mask;
B
Behdad Esfahbod 已提交
1028
    /* Post-base */
1029
    mask = indic_plan->mask_array[BLWF] | indic_plan->mask_array[ABVF] | indic_plan->mask_array[PSTF];
B
Minor  
Behdad Esfahbod 已提交
1030
    for (unsigned int i = base + 1; i < end; i++)
B
Behdad Esfahbod 已提交
1031 1032
      info[i].mask  |= mask;
  }
B
Behdad Esfahbod 已提交
1033

1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
  if (indic_plan->is_old_spec &&
      buffer->props.script == HB_SCRIPT_DEVANAGARI)
  {
    /* Old-spec eye-lash Ra needs special handling.  From the
     * spec:
     *
     * "The feature 'below-base form' is applied to consonants
     * having below-base forms and following the base consonant.
     * The exception is vattu, which may appear below half forms
     * as well as below the base glyph. The feature 'below-base
     * form' will be applied to all such occurrences of Ra as well."
     *
     * Test case: U+0924,U+094D,U+0930,U+094d,U+0915
     * with Sanskrit 2003 font.
     *
     * However, note that Ra,Halant,ZWJ is the correct way to
     * request eyelash form of Ra, so we wouldbn't inhibit it
     * in that sequence.
     *
     * Test case: U+0924,U+094D,U+0930,U+094d,U+200D,U+0915
     */
    for (unsigned int i = start; i + 1 < base; i++)
      if (info[i  ].indic_category() == OT_Ra &&
	  info[i+1].indic_category() == OT_H  &&
	  (i + 2 == base ||
	   info[i+2].indic_category() != OT_ZWJ))
      {
	info[i  ].mask |= indic_plan->mask_array[BLWF];
	info[i+1].mask |= indic_plan->mask_array[BLWF];
      }
  }

1066
  if (indic_plan->mask_array[PREF] && base + 2 < end)
1067
  {
1068
    /* Find a Halant,Ra sequence and mark it for pre-base reordering processing. */
1069 1070 1071
    for (unsigned int i = base + 1; i + 1 < end; i++) {
      hb_codepoint_t glyphs[2] = {info[i].codepoint, info[i + 1].codepoint};
      if (indic_plan->pref.would_substitute (glyphs, ARRAY_LENGTH (glyphs), true, face))
1072
      {
1073 1074
	info[i++].mask |= indic_plan->mask_array[PREF];
	info[i++].mask |= indic_plan->mask_array[PREF];
B
Behdad Esfahbod 已提交
1075 1076 1077 1078 1079 1080 1081 1082

	/* Mark the subsequent stuff with 'cfar'.  Used in Khmer.
	 * Read the feature spec.
	 * This allows distinguishing the following cases with MS Khmer fonts:
	 * U+1784,U+17D2,U+179A,U+17D2,U+1782
	 * U+1784,U+17D2,U+1782,U+17D2,U+179A
	 */
	for (; i < end; i++)
1083
	  info[i].mask |= indic_plan->mask_array[CFAR];
B
Behdad Esfahbod 已提交
1084

1085 1086
	break;
      }
1087
    }
1088 1089
  }

B
Behdad Esfahbod 已提交
1090
  /* Apply ZWJ/ZWNJ effects */
B
Minor  
Behdad Esfahbod 已提交
1091
  for (unsigned int i = start + 1; i < end; i++)
B
Behdad Esfahbod 已提交
1092 1093
    if (is_joiner (info[i])) {
      bool non_joiner = info[i].indic_category() == OT_ZWNJ;
1094
      unsigned int j = i;
B
Behdad Esfahbod 已提交
1095 1096 1097

      do {
	j--;
1098

1099 1100
	/* ZWJ/ZWNJ should disable CJCT.  They do that by simply
	 * being there, since we don't skip them for the CJCT
1101
	 * feature (ie. F_MANUAL_ZWJ) */
B
Behdad Esfahbod 已提交
1102 1103

	/* A ZWNJ disables HALF. */
1104
	if (non_joiner)
1105
	  info[j].mask &= ~indic_plan->mask_array[HALF];
1106

B
Behdad Esfahbod 已提交
1107 1108
      } while (j > start && !is_consonant (info[j]));
    }
B
Behdad Esfahbod 已提交
1109 1110 1111 1112
}


static void
1113
initial_reordering_vowel_syllable (const hb_ot_shape_plan_t *plan,
1114
				   hb_face_t *face,
B
Behdad Esfahbod 已提交
1115
				   hb_buffer_t *buffer,
1116
				   unsigned int start, unsigned int end)
B
Behdad Esfahbod 已提交
1117
{
B
Behdad Esfahbod 已提交
1118
  /* We made the vowels look like consonants.  So let's call the consonant logic! */
1119
  initial_reordering_consonant_syllable (plan, face, buffer, start, end);
B
Behdad Esfahbod 已提交
1120 1121 1122
}

static void
1123
initial_reordering_standalone_cluster (const hb_ot_shape_plan_t *plan,
1124
				       hb_face_t *face,
B
Behdad Esfahbod 已提交
1125
				       hb_buffer_t *buffer,
1126
				       unsigned int start, unsigned int end)
B
Behdad Esfahbod 已提交
1127
{
1128 1129 1130
  /* We treat NBSP/dotted-circle as if they are consonants, so we should just chain.
   * Only if not in compatibility mode that is... */

1131
  if (hb_options ().uniscribe_bug_compatible)
1132 1133 1134 1135 1136 1137 1138 1139
  {
    /* For dotted-circle, this is what Uniscribe does:
     * If dotted-circle is the last glyph, it just does nothing.
     * Ie. It doesn't form Reph. */
    if (buffer->info[end - 1].indic_category() == OT_DOTTEDCIRCLE)
      return;
  }

1140
  initial_reordering_consonant_syllable (plan, face, buffer, start, end);
B
Behdad Esfahbod 已提交
1141 1142
}

1143 1144
static void
initial_reordering_broken_cluster (const hb_ot_shape_plan_t *plan,
1145
				   hb_face_t *face,
1146 1147 1148 1149
				   hb_buffer_t *buffer,
				   unsigned int start, unsigned int end)
{
  /* We already inserted dotted-circles, so just call the standalone_cluster. */
1150
  initial_reordering_standalone_cluster (plan, face, buffer, start, end);
1151 1152
}

B
Behdad Esfahbod 已提交
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
static void
initial_reordering_avagraha_cluster (const hb_ot_shape_plan_t *plan HB_UNUSED,
				     hb_face_t *face HB_UNUSED,
				     hb_buffer_t *buffer HB_UNUSED,
				     unsigned int start HB_UNUSED, unsigned int end HB_UNUSED)
{
  /* 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. */
}

B
Behdad Esfahbod 已提交
1163
static void
1164
initial_reordering_non_indic_cluster (const hb_ot_shape_plan_t *plan HB_UNUSED,
1165
				      hb_face_t *face HB_UNUSED,
1166 1167
				      hb_buffer_t *buffer HB_UNUSED,
				      unsigned int start HB_UNUSED, unsigned int end HB_UNUSED)
B
Behdad Esfahbod 已提交
1168 1169 1170 1171 1172
{
  /* 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. */
}

1173 1174 1175

static void
initial_reordering_syllable (const hb_ot_shape_plan_t *plan,
1176
			     hb_face_t *face,
1177 1178 1179 1180 1181
			     hb_buffer_t *buffer,
			     unsigned int start, unsigned int end)
{
  syllable_type_t syllable_type = (syllable_type_t) (buffer->info[start].syllable() & 0x0F);
  switch (syllable_type) {
1182 1183 1184
  case consonant_syllable:	initial_reordering_consonant_syllable (plan, face, buffer, start, end); return;
  case vowel_syllable:		initial_reordering_vowel_syllable     (plan, face, buffer, start, end); return;
  case standalone_cluster:	initial_reordering_standalone_cluster (plan, face, buffer, start, end); return;
B
Behdad Esfahbod 已提交
1185
  case avagraha_cluster:	initial_reordering_avagraha_cluster   (plan, face, buffer, start, end); return;
1186 1187
  case broken_cluster:		initial_reordering_broken_cluster     (plan, face, buffer, start, end); return;
  case non_indic_cluster:	initial_reordering_non_indic_cluster  (plan, face, buffer, start, end); return;
1188 1189 1190
  }
}

1191
static inline void
B
Behdad Esfahbod 已提交
1192
insert_dotted_circles (const hb_ot_shape_plan_t *plan HB_UNUSED,
1193 1194 1195
		       hb_font_t *font,
		       hb_buffer_t *buffer)
{
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
  /* Note: This loop is extra overhead, but should not be measurable. */
  bool has_broken_syllables = false;
  unsigned int count = buffer->len;
  for (unsigned int i = 0; i < count; i++)
    if ((buffer->info[i].syllable() & 0x0F) == broken_cluster) {
      has_broken_syllables = true;
      break;
    }
  if (likely (!has_broken_syllables))
    return;


1208 1209 1210 1211
  hb_codepoint_t dottedcircle_glyph;
  if (!font->get_glyph (0x25CC, 0, &dottedcircle_glyph))
    return;

1212
  hb_glyph_info_t dottedcircle = {0};
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
  dottedcircle.codepoint = 0x25CC;
  set_indic_properties (dottedcircle);
  dottedcircle.codepoint = dottedcircle_glyph;

  buffer->clear_output ();

  buffer->idx = 0;
  unsigned int last_syllable = 0;
  while (buffer->idx < buffer->len)
  {
    unsigned int syllable = buffer->cur().syllable();
    syllable_type_t syllable_type = (syllable_type_t) (syllable & 0x0F);
    if (unlikely (last_syllable != syllable && syllable_type == broken_cluster))
    {
1227 1228
      last_syllable = syllable;

1229 1230 1231 1232
      hb_glyph_info_t info = dottedcircle;
      info.cluster = buffer->cur().cluster;
      info.mask = buffer->cur().mask;
      info.syllable() = buffer->cur().syllable();
1233 1234 1235 1236 1237 1238 1239

      /* Insert dottedcircle after possible Repha. */
      while (buffer->idx < buffer->len &&
	     last_syllable == buffer->cur().syllable() &&
	     buffer->cur().indic_category() == OT_Repha)
        buffer->next_glyph ();

1240 1241
      buffer->output_info (info);
    }
1242 1243
    else
      buffer->next_glyph ();
1244 1245 1246 1247 1248
  }

  buffer->swap_buffers ();
}

B
Behdad Esfahbod 已提交
1249
static void
1250
initial_reordering (const hb_ot_shape_plan_t *plan,
1251
		    hb_font_t *font,
B
Behdad Esfahbod 已提交
1252
		    hb_buffer_t *buffer)
B
Behdad Esfahbod 已提交
1253
{
1254
  update_consonant_positions (plan, font, buffer);
1255
  insert_dotted_circles (plan, font, buffer);
1256 1257

  hb_glyph_info_t *info = buffer->info;
1258 1259
  unsigned int count = buffer->len;
  if (unlikely (!count)) return;
1260 1261 1262 1263
  unsigned int last = 0;
  unsigned int last_syllable = info[0].syllable();
  for (unsigned int i = 1; i < count; i++)
    if (last_syllable != info[i].syllable()) {
1264
      initial_reordering_syllable (plan, font->face, buffer, last, i);
1265 1266 1267
      last = i;
      last_syllable = info[last].syllable();
    }
1268
  initial_reordering_syllable (plan, font->face, buffer, last, count);
B
Behdad Esfahbod 已提交
1269 1270
}

B
Behdad Esfahbod 已提交
1271
static void
1272 1273
final_reordering_syllable (const hb_ot_shape_plan_t *plan,
			   hb_buffer_t *buffer,
1274
			   unsigned int start, unsigned int end)
B
Behdad Esfahbod 已提交
1275
{
1276
  const indic_shape_plan_t *indic_plan = (const indic_shape_plan_t *) plan->data;
1277 1278
  hb_glyph_info_t *info = buffer->info;

1279 1280 1281 1282 1283 1284
  /* 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.
1285 1286 1287
   */

  /* Find base again */
1288 1289 1290 1291 1292 1293 1294
  unsigned int base;
  for (base = start; base < end; base++)
    if (info[base].indic_position() >= POS_BASE_C) {
      if (start < base && info[base].indic_position() > POS_BASE_C)
        base--;
      break;
    }
1295 1296 1297 1298 1299 1300 1301
  if (base == end && start < base &&
      info[base - 1].indic_category() != OT_ZWJ)
    base--;
  while (start < base &&
	 (info[base].indic_category() == OT_H ||
	  info[base].indic_category() == OT_N))
    base--;
1302

B
Minor  
Behdad Esfahbod 已提交
1303

1304
  /*   o Reorder matras:
1305 1306 1307 1308 1309 1310 1311
   *
   *     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.
1312 1313
   */

1314
  if (start + 1 < end && start < base) /* Otherwise there can't be any pre-base matra characters. */
1315
  {
1316 1317 1318
    /* If we lost track of base, alas, position before last thingy. */
    unsigned int new_pos = base == end ? base - 2 : base - 1;

1319 1320 1321
    /* Malayalam / Tamil do not have "half" forms or explicit virama forms.
     * The glyphs formed by 'half' are Chillus or ligated explicit viramas.
     * We want to position matra after them.
1322
     */
1323
    if (buffer->props.script != HB_SCRIPT_MALAYALAM && buffer->props.script != HB_SCRIPT_TAMIL)
1324
    {
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
      while (new_pos > start &&
	     !(is_one_of (info[new_pos], (FLAG (OT_M) | FLAG (OT_H) | FLAG (OT_Coeng)))))
	new_pos--;

      /* If we found no Halant we are done.
       * Otherwise only proceed if the Halant does
       * not belong to the Matra itself! */
      if (is_halant_or_coeng (info[new_pos]) &&
	  info[new_pos].indic_position() != POS_PRE_M)
      {
	/* -> If ZWJ or ZWNJ follow this halant, position is moved after it. */
	if (new_pos + 1 < end && is_joiner (info[new_pos + 1]))
	  new_pos++;
      }
      else
        new_pos = start; /* No move. */
    }
1342

1343
    if (start < new_pos && info[new_pos].indic_position () != POS_PRE_M)
1344
    {
1345
      /* Now go see if there's actually any matras... */
B
Behdad Esfahbod 已提交
1346
      for (unsigned int i = new_pos; i > start; i--)
1347
	if (info[i - 1].indic_position () == POS_PRE_M)
1348
	{
B
Behdad Esfahbod 已提交
1349 1350 1351 1352
	  unsigned int old_pos = i - 1;
	  hb_glyph_info_t tmp = info[old_pos];
	  memmove (&info[old_pos], &info[old_pos + 1], (new_pos - old_pos) * sizeof (info[0]));
	  info[new_pos] = tmp;
1353 1354
	  if (old_pos < base && base <= new_pos) /* Shouldn't actually happen. */
	    base--;
1355
	  buffer->merge_clusters (new_pos, MIN (end, base + 1));
B
Behdad Esfahbod 已提交
1356
	  new_pos--;
1357
	}
1358
    } else {
1359
      for (unsigned int i = start; i < base; i++)
1360
	if (info[i].indic_position () == POS_PRE_M) {
1361
	  buffer->merge_clusters (i, MIN (end, base + 1));
1362 1363
	  break;
	}
1364
    }
1365 1366 1367 1368
  }


  /*   o Reorder reph:
1369 1370 1371 1372 1373 1374
   *
   *     Reph’s 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.
1375 1376
   */

1377 1378 1379 1380 1381 1382 1383 1384 1385
  /* Two cases:
   *
   * - If repha is encoded as a sequence of characters (Ra,H or Ra,H,ZWJ), then
   *   we should only move it if the sequence ligated to the repha form.
   *
   * - If repha is encoded separately and in the logical position, we should only
   *   move it if it did NOT ligate.  If it ligated, it's probably the font trying
   *   to make it work without the reordering.
   */
B
Behdad Esfahbod 已提交
1386 1387 1388
  if (start + 1 < end &&
      info[start].indic_position() == POS_RA_TO_BECOME_REPH &&
      ((info[start].indic_category() == OT_Repha) ^ is_a_ligature (info[start])))
1389
  {
1390 1391 1392
    unsigned int new_reph_pos;
    reph_position_t reph_pos = indic_plan->config->reph_pos;

1393

1394 1395
    /*       1. If reph should be positioned after post-base consonant forms,
     *          proceed to step 5.
1396
     */
1397
    if (reph_pos == REPH_POS_AFTER_POST)
1398
    {
1399
      goto reph_step_5;
1400 1401 1402
    }

    /*       2. If the reph repositioning class is not after post-base: target
1403 1404 1405 1406 1407 1408 1409 1410 1411
     *          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.
1412 1413 1414
     */
    {
      new_reph_pos = start + 1;
1415
      while (new_reph_pos < base && !is_halant_or_coeng (info[new_reph_pos]))
1416 1417
	new_reph_pos++;

B
Indent  
Behdad Esfahbod 已提交
1418 1419
      if (new_reph_pos < base && is_halant_or_coeng (info[new_reph_pos]))
      {
1420 1421 1422 1423 1424 1425 1426 1427
	/* ->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
1428 1429
     *          first consonant not ligated with main, or find the first
     *          consonant that is not a potential pre-base reordering Ra.
1430
     */
1431
    if (reph_pos == REPH_POS_AFTER_MAIN)
1432
    {
1433
      new_reph_pos = base;
1434
      while (new_reph_pos + 1 < end && info[new_reph_pos + 1].indic_position() <= POS_AFTER_MAIN)
1435 1436 1437
	new_reph_pos++;
      if (new_reph_pos < end)
        goto reph_move;
1438 1439 1440
    }

    /*       4. If reph should be positioned before post-base consonant, find
1441 1442 1443
     *          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.
1444
     */
1445
    /* This is our take on what step 4 is trying to say (and failing, BADLY). */
1446
    if (reph_pos == REPH_POS_AFTER_SUB)
1447
    {
1448 1449
      new_reph_pos = base;
      while (new_reph_pos < end &&
1450
	     !( FLAG (info[new_reph_pos + 1].indic_position()) & (FLAG (POS_POST_C) | FLAG (POS_AFTER_POST) | FLAG (POS_SMVD))))
1451 1452 1453
	new_reph_pos++;
      if (new_reph_pos < end)
        goto reph_move;
1454 1455 1456
    }

    /*       5. If no consonant is found in steps 3 or 4, move reph to a position
1457 1458 1459 1460 1461 1462
     *          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.
     */
1463 1464
    reph_step_5:
    {
1465 1466 1467 1468 1469
      /* Copied from step 2. */
      new_reph_pos = start + 1;
      while (new_reph_pos < base && !is_halant_or_coeng (info[new_reph_pos]))
	new_reph_pos++;

B
Indent  
Behdad Esfahbod 已提交
1470 1471
      if (new_reph_pos < base && is_halant_or_coeng (info[new_reph_pos]))
      {
1472 1473 1474 1475 1476
	/* ->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;
      }
1477
    }
1478

1479 1480 1481 1482 1483 1484 1485
    /*       6. Otherwise, reorder reph to the end of the syllable.
     */
    {
      new_reph_pos = end - 1;
      while (new_reph_pos > start && info[new_reph_pos].indic_position() == POS_SMVD)
	new_reph_pos--;

1486 1487 1488 1489 1490 1491 1492
      /*
       * 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.
       * Uniscribe doesn't do this.
       * TEST: U+0930,U+094D,U+0915,U+094B,U+094D
       */
1493
      if (!hb_options ().uniscribe_bug_compatible &&
1494
	  unlikely (is_halant_or_coeng (info[new_reph_pos]))) {
1495 1496 1497 1498 1499 1500 1501
	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;
1502 1503
    }

1504 1505
    reph_move:
    {
1506
      buffer->merge_clusters (start, new_reph_pos + 1);
1507

1508 1509 1510 1511
      /* 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;
1512 1513
      if (start < base && base <= new_reph_pos)
	base--;
1514
    }
1515 1516 1517 1518
  }


  /*   o Reorder pre-base reordering consonants:
1519 1520 1521 1522 1523
   *
   *     If a pre-base reordering consonant is found, reorder it according to
   *     the following rules:
   */

1524
  if (indic_plan->mask_array[PREF] && base + 1 < end) /* Otherwise there can't be any pre-base reordering Ra. */
1525
  {
1526
    for (unsigned int i = base + 1; i < end; i++)
1527
      if ((info[i].mask & indic_plan->mask_array[PREF]) != 0)
1528
      {
1529 1530 1531 1532
	/*       1. Only reorder a glyph produced by substitution during application
	 *          of the <pref> feature. (Note that a font may shape a Ra consonant with
	 *          the feature generally but block it in certain contexts.)
	 */
1533
	if (i + 1 == end || (info[i + 1].mask & indic_plan->mask_array[PREF]) == 0)
1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
	{
	  /*
	   *       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.
	   */

	  unsigned int new_pos = base;
1544 1545 1546 1547 1548
	  /* Malayalam / Tamil do not have "half" forms or explicit virama forms.
	   * The glyphs formed by 'half' are Chillus or ligated explicit viramas.
	   * We want to position matra after them.
	   */
	  if (buffer->props.script != HB_SCRIPT_MALAYALAM && buffer->props.script != HB_SCRIPT_TAMIL)
1549
	  {
1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565
	    while (new_pos > start &&
		   !(is_one_of (info[new_pos - 1], FLAG(OT_M) | HALANT_OR_COENG_FLAGS)))
	      new_pos--;

	    /* In Khmer coeng model, a V,Ra can go *after* matras.  If it goes after a
	     * split matra, it should be reordered to *before* the left part of such matra. */
	    if (new_pos > start && info[new_pos - 1].indic_category() == OT_M)
	    {
	      unsigned int old_pos = i;
	      for (unsigned int i = base + 1; i < old_pos; i++)
		if (info[i].indic_category() == OT_M)
		{
		  new_pos--;
		  break;
		}
	    }
1566 1567
	  }

1568
	  if (new_pos > start && is_halant_or_coeng (info[new_pos - 1]))
B
Indent  
Behdad Esfahbod 已提交
1569
	  {
1570 1571 1572
	    /* -> If ZWJ or ZWNJ follow this halant, position is moved after it. */
	    if (new_pos < end && is_joiner (info[new_pos]))
	      new_pos++;
B
Indent  
Behdad Esfahbod 已提交
1573
	  }
1574 1575 1576

	  {
	    unsigned int old_pos = i;
1577
	    buffer->merge_clusters (new_pos, old_pos + 1);
1578 1579 1580
	    hb_glyph_info_t tmp = info[old_pos];
	    memmove (&info[new_pos + 1], &info[new_pos], (old_pos - new_pos) * sizeof (info[0]));
	    info[new_pos] = tmp;
1581 1582
	    if (new_pos <= base && base < old_pos)
	      base++;
1583 1584 1585 1586
	  }
	}

        break;
1587
      }
1588
  }
1589 1590


1591
  /* Apply 'init' to the Left Matra if it's a word start. */
1592
  if (info[start].indic_position () == POS_PRE_M &&
1593
      (!start ||
B
Minor  
Behdad Esfahbod 已提交
1594
       !(FLAG (_hb_glyph_info_get_general_category (&info[start - 1])) &
1595
	 FLAG_RANGE (HB_UNICODE_GENERAL_CATEGORY_FORMAT, HB_UNICODE_GENERAL_CATEGORY_NON_SPACING_MARK))))
1596
    info[start].mask |= indic_plan->mask_array[INIT];
1597

1598

B
Behdad Esfahbod 已提交
1599 1600 1601
  /*
   * Finish off the clusters and go home!
   */
1602
  if (hb_options ().uniscribe_bug_compatible)
1603
  {
1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617
    switch ((hb_tag_t) plan->props.script)
    {
      case HB_SCRIPT_TAMIL:
      case HB_SCRIPT_SINHALA:
        break;

      default:
	/* Uniscribe merges the entire cluster... Except for Tamil & Sinhala.
	 * 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. */
	buffer->merge_clusters (start, end);
	break;
    }
1618
  }
1619
}
1620 1621


1622
static void
1623
final_reordering (const hb_ot_shape_plan_t *plan,
B
Behdad Esfahbod 已提交
1624
		  hb_font_t *font HB_UNUSED,
B
Behdad Esfahbod 已提交
1625
		  hb_buffer_t *buffer)
1626 1627
{
  unsigned int count = buffer->len;
1628
  if (unlikely (!count)) return;
1629 1630 1631

  hb_glyph_info_t *info = buffer->info;
  unsigned int last = 0;
1632
  unsigned int last_syllable = info[0].syllable();
1633
  for (unsigned int i = 1; i < count; i++)
1634
    if (last_syllable != info[i].syllable()) {
1635
      final_reordering_syllable (plan, buffer, last, i);
1636
      last = i;
1637
      last_syllable = info[last].syllable();
1638
    }
1639
  final_reordering_syllable (plan, buffer, last, count);
1640

B
Behdad Esfahbod 已提交
1641 1642 1643 1644 1645
  HB_BUFFER_DEALLOCATE_VAR (buffer, indic_category);
  HB_BUFFER_DEALLOCATE_VAR (buffer, indic_position);
}


1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657
static void
clear_syllables (const hb_ot_shape_plan_t *plan HB_UNUSED,
		 hb_font_t *font HB_UNUSED,
		 hb_buffer_t *buffer)
{
  hb_glyph_info_t *info = buffer->info;
  unsigned int count = buffer->len;
  for (unsigned int i = 0; i < count; i++)
    info[i].syllable() = 0;
}


1658
static hb_ot_shape_normalization_mode_t
B
Behdad Esfahbod 已提交
1659
normalization_preference_indic (const hb_segment_properties_t *props HB_UNUSED)
1660 1661 1662 1663
{
  return HB_OT_SHAPE_NORMALIZATION_MODE_COMPOSED_DIACRITICS_NO_SHORT_CIRCUIT;
}

1664 1665
static bool
decompose_indic (const hb_ot_shape_normalize_context_t *c,
1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702
		 hb_codepoint_t  ab,
		 hb_codepoint_t *a,
		 hb_codepoint_t *b)
{
  switch (ab)
  {
    /* Don't decompose these. */
    case 0x0931  : return false;
    case 0x0B94  : return false;


    /*
     * Decompose split matras that don't have Unicode decompositions.
     */

    case 0x0F77  : *a = 0x0FB2; *b= 0x0F81; return true;
    case 0x0F79  : *a = 0x0FB3; *b= 0x0F81; return true;
    case 0x17BE  : *a = 0x17C1; *b= 0x17BE; return true;
    case 0x17BF  : *a = 0x17C1; *b= 0x17BF; return true;
    case 0x17C0  : *a = 0x17C1; *b= 0x17C0; return true;
    case 0x17C4  : *a = 0x17C1; *b= 0x17C4; return true;
    case 0x17C5  : *a = 0x17C1; *b= 0x17C5; return true;
    case 0x1925  : *a = 0x1920; *b= 0x1923; return true;
    case 0x1926  : *a = 0x1920; *b= 0x1924; return true;
    case 0x1B3C  : *a = 0x1B42; *b= 0x1B3C; return true;
    case 0x1112E  : *a = 0x11127; *b= 0x11131; return true;
    case 0x1112F  : *a = 0x11127; *b= 0x11132; return true;
#if 0
    /* This one has no decomposition in Unicode, but needs no decomposition either. */
    /* case 0x0AC9  : return false; */
    case 0x0B57  : *a = no decomp, -> RIGHT; return true;
    case 0x1C29  : *a = no decomp, -> LEFT; return true;
    case 0xA9C0  : *a = no decomp, -> RIGHT; return true;
    case 0x111BF  : *a = no decomp, -> ABOVE; return true;
#endif
  }

1703
  if ((ab == 0x0DDA || hb_in_range<hb_codepoint_t> (ab, 0x0DDC, 0x0DDE)))
1704
  {
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723
    /*
     * Sinhala split matras...  Let the fun begin.
     *
     * These four characters have Unicode decompositions.  However, Uniscribe
     * decomposes them "Khmer-style", that is, it uses the character itself to
     * get the second half.  The first half of all four decompositions is always
     * U+0DD9.
     *
     * Now, there are buggy fonts, namely, the widely used lklug.ttf, that are
     * broken with Uniscribe.  But we need to support them.  As such, we only
     * do the Uniscribe-style decomposition if the character is transformed into
     * its "sec.half" form by the 'pstf' feature.  Otherwise, we fall back to
     * Unicode decomposition.
     *
     * Note that we can't unconditionally use Unicode decomposition.  That would
     * break some other fonts, that are designed to work with Uniscribe, and
     * don't have positioning features for the Unicode-style decomposition.
     *
     * Argh...
1724 1725 1726 1727 1728
     *
     * The Uniscribe behavior is now documented in the newly published Sinhala
     * spec in 2012:
     *
     *   http://www.microsoft.com/typography/OpenTypeDev/sinhala/intro.htm#shaping
1729 1730 1731 1732 1733 1734
     */

    const indic_shape_plan_t *indic_plan = (const indic_shape_plan_t *) c->plan->data;

    hb_codepoint_t glyph;

1735
    if (hb_options ().uniscribe_bug_compatible ||
1736 1737 1738 1739 1740 1741 1742 1743
	(c->font->get_glyph (ab, 0, &glyph) &&
	 indic_plan->pstf.would_substitute (&glyph, 1, true, c->font->face)))
    {
      /* Ok, safe to use Uniscribe-style decomposition. */
      *a = 0x0DD9;
      *b = ab;
      return true;
    }
1744 1745
  }

1746
  return c->unicode->decompose (ab, a, b);
1747 1748
}

1749 1750
static bool
compose_indic (const hb_ot_shape_normalize_context_t *c,
1751 1752 1753 1754 1755
	       hb_codepoint_t  a,
	       hb_codepoint_t  b,
	       hb_codepoint_t *ab)
{
  /* Avoid recomposing split matras. */
1756
  if (HB_UNICODE_GENERAL_CATEGORY_IS_MARK (c->unicode->general_category (a)))
1757 1758 1759 1760 1761
    return false;

  /* Composition-exclusion exceptions that we want to recompose. */
  if (a == 0x09AF && b == 0x09BC) { *ab = 0x09DF; return true; }

1762
  return c->unicode->compose (a, b, ab);
1763 1764 1765
}


1766 1767 1768 1769 1770
const hb_ot_complex_shaper_t _hb_ot_complex_shaper_indic =
{
  "indic",
  collect_features_indic,
  override_features_indic,
1771 1772
  data_create_indic,
  data_destroy_indic,
1773
  NULL, /* preprocess_text */
1774
  normalization_preference_indic,
1775 1776
  decompose_indic,
  compose_indic,
1777
  setup_masks_indic,
1778
  HB_OT_SHAPE_ZERO_WIDTH_MARKS_NONE,
1779
  false, /* fallback_position */
1780
};