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

   1 /*
   2  * Copyright © 2011,2012  Google, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Google Author(s): Behdad Esfahbod
  25  */
  26
  27 #include "hb-ot-shape-complex-indic.hh"
  28 #include "hb-ot-shape-complex-vowel-constraints.hh"
  29 #include "hb-ot-layout.hh"
  30
  31
  32 /*
  33  * Indic shaper.
  34  */
  35
  36
  37 /*
  38  * Indic configurations.  Note that we do not want to keep every single script-specific
  39  * behavior in these tables necessarily.  This should mainly be used for per-script
  40  * properties that are cheaper keeping here, than in the code.  Ie. if, say, one and
  41  * only one script has an exception, that one script can be if'ed directly in the code,
  42  * instead of adding a new flag in these structs.
  43  */
  44
  45 enum base_position_t {
  46   BASE_POS_LAST_SINHALA,
  47   BASE_POS_LAST
  48 };
  49 enum reph_position_t {
  50   REPH_POS_AFTER_MAIN  = POS_AFTER_MAIN,
  51   REPH_POS_BEFORE_SUB  = POS_BEFORE_SUB,
  52   REPH_POS_AFTER_SUB   = POS_AFTER_SUB,
  53   REPH_POS_BEFORE_POST = POS_BEFORE_POST,
  54   REPH_POS_AFTER_POST  = POS_AFTER_POST
  55 };
  56 enum reph_mode_t {
  57   REPH_MODE_IMPLICIT,  /* Reph formed out of initial Ra,H sequence. */
  58   REPH_MODE_EXPLICIT,  /* Reph formed out of initial Ra,H,ZWJ sequence. */
  59   REPH_MODE_LOG_REPHA  /* Encoded Repha character, needs reordering. */
  60 };
  61 enum blwf_mode_t {
  62   BLWF_MODE_PRE_AND_POST, /* Below-forms feature applied to pre-base and post-base. */
  63   BLWF_MODE_POST_ONLY     /* Below-forms feature applied to post-base only. */
  64 };
  65 struct indic_config_t
  66 {
  67   hb_script_t     script;
  68   bool            has_old_spec;
  69   hb_codepoint_t  virama;
  70   base_position_t base_pos;
  71   reph_position_t reph_pos;
  72   reph_mode_t     reph_mode;
  73   blwf_mode_t     blwf_mode;
  74 };
  75
  76 static const indic_config_t indic_configs[] =
  77 {
  78   /* Default.  Should be first. */
  79   {HB_SCRIPT_INVALID,   false,      0,BASE_POS_LAST, REPH_POS_BEFORE_POST,REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  80   {HB_SCRIPT_DEVANAGARI,true, 0x094Du,BASE_POS_LAST, REPH_POS_BEFORE_POST,REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  81   {HB_SCRIPT_BENGALI,   true, 0x09CDu,BASE_POS_LAST, REPH_POS_AFTER_SUB,  REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  82   {HB_SCRIPT_GURMUKHI,  true, 0x0A4Du,BASE_POS_LAST, REPH_POS_BEFORE_SUB, REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  83   {HB_SCRIPT_GUJARATI,  true, 0x0ACDu,BASE_POS_LAST, REPH_POS_BEFORE_POST,REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  84   {HB_SCRIPT_ORIYA,     true, 0x0B4Du,BASE_POS_LAST, REPH_POS_AFTER_MAIN, REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  85   {HB_SCRIPT_TAMIL,     true, 0x0BCDu,BASE_POS_LAST, REPH_POS_AFTER_POST, REPH_MODE_IMPLICIT, BLWF_MODE_PRE_AND_POST},
  86   {HB_SCRIPT_TELUGU,    true, 0x0C4Du,BASE_POS_LAST, REPH_POS_AFTER_POST, REPH_MODE_EXPLICIT, BLWF_MODE_POST_ONLY},
  87   {HB_SCRIPT_KANNADA,   true, 0x0CCDu,BASE_POS_LAST, REPH_POS_AFTER_POST, REPH_MODE_IMPLICIT, BLWF_MODE_POST_ONLY},
  88   {HB_SCRIPT_MALAYALAM, true, 0x0D4Du,BASE_POS_LAST, REPH_POS_AFTER_MAIN, REPH_MODE_LOG_REPHA,BLWF_MODE_PRE_AND_POST},
  89   {HB_SCRIPT_SINHALA,   false,0x0DCAu,BASE_POS_LAST_SINHALA,
  90                                                      REPH_POS_AFTER_POST, REPH_MODE_EXPLICIT, BLWF_MODE_PRE_AND_POST},
  91 };
  92
  93
  94
  95 /*
  96  * Indic shaper.
  97  */
  98
  99 static const hb_ot_map_feature_t
 100 indic_features[] =
 101 {
 102   /*
 103    * Basic features.
 104    * These features are applied in order, one at a time, after initial_reordering.
 105    */
 106   {HB_TAG('n','u','k','t'), F_GLOBAL_MANUAL_JOINERS},
 107   {HB_TAG('a','k','h','n'), F_GLOBAL_MANUAL_JOINERS},
 108   {HB_TAG('r','p','h','f'),        F_MANUAL_JOINERS},
 109   {HB_TAG('r','k','r','f'), F_GLOBAL_MANUAL_JOINERS},
 110   {HB_TAG('p','r','e','f'),        F_MANUAL_JOINERS},
 111   {HB_TAG('b','l','w','f'),        F_MANUAL_JOINERS},
 112   {HB_TAG('a','b','v','f'),        F_MANUAL_JOINERS},
 113   {HB_TAG('h','a','l','f'),        F_MANUAL_JOINERS},
 114   {HB_TAG('p','s','t','f'),        F_MANUAL_JOINERS},
 115   {HB_TAG('v','a','t','u'), F_GLOBAL_MANUAL_JOINERS},
 116   {HB_TAG('c','j','c','t'), F_GLOBAL_MANUAL_JOINERS},
 117   /*
 118    * Other features.
 119    * These features are applied all at once, after final_reordering
 120    * but before clearing syllables.
 121    * Default Bengali font in Windows for example has intermixed
 122    * lookups for init,pres,abvs,blws features.
 123    */
 124   {HB_TAG('i','n','i','t'),        F_MANUAL_JOINERS},
 125   {HB_TAG('p','r','e','s'), F_GLOBAL_MANUAL_JOINERS},
 126   {HB_TAG('a','b','v','s'), F_GLOBAL_MANUAL_JOINERS},
 127   {HB_TAG('b','l','w','s'), F_GLOBAL_MANUAL_JOINERS},
 128   {HB_TAG('p','s','t','s'), F_GLOBAL_MANUAL_JOINERS},
 129   {HB_TAG('h','a','l','n'), F_GLOBAL_MANUAL_JOINERS},
 130   /*
 131    * Positioning features.
 132    * We don't care about the types.
 133    */
 134   {HB_TAG('d','i','s','t'), F_GLOBAL},
 135   {HB_TAG('a','b','v','m'), F_GLOBAL},
 136   {HB_TAG('b','l','w','m'), F_GLOBAL},
 137 };
 138
 139 /*
 140  * Must be in the same order as the indic_features array.
 141  */
 142 enum {
 143   _NUKT,
 144   _AKHN,
 145   RPHF,
 146   _RKRF,
 147   PREF,
 148   BLWF,
 149   ABVF,
 150   HALF,
 151   PSTF,
 152   _VATU,
 153   _CJCT,
 154
 155   INIT,
 156   _PRES,
 157   _ABVS,
 158   _BLWS,
 159   _PSTS,
 160   _HALN,
 161
 162   _DIST,
 163   _ABVM,
 164   _BLWM,
 165
 166   INDIC_NUM_FEATURES,
 167   INDIC_BASIC_FEATURES = INIT, /* Don't forget to update this! */
 168 };
 169
 170 static void
 171 setup_syllables (const hb_ot_shape_plan_t *plan,
 172                  hb_font_t *font,
 173                  hb_buffer_t *buffer);
 174 static void
 175 initial_reordering (const hb_ot_shape_plan_t *plan,
 176                     hb_font_t *font,
 177                     hb_buffer_t *buffer);
 178 static void
 179 final_reordering (const hb_ot_shape_plan_t *plan,
 180                   hb_font_t *font,
 181                   hb_buffer_t *buffer);
 182 static void
 183 clear_syllables (const hb_ot_shape_plan_t *plan,
 184                  hb_font_t *font,
 185                  hb_buffer_t *buffer);
 186
 187 static void
 188 collect_features_indic (hb_ot_shape_planner_t *plan)
 189 {
 190   hb_ot_map_builder_t *map = &plan->map;
 191
 192   /* Do this before any lookups have been applied. */
 193   map->add_gsub_pause (setup_syllables);
 194
 195   map->enable_feature (HB_TAG('l','o','c','l'));
 196   /* The Indic specs do not require ccmp, but we apply it here since if
 197    * there is a use of it, it's typically at the beginning. */
 198   map->enable_feature (HB_TAG('c','c','m','p'));
 199
 200
 201   unsigned int i = 0;
 202   map->add_gsub_pause (initial_reordering);
 203
 204   for (; i < INDIC_BASIC_FEATURES; i++) {
 205     map->add_feature (indic_features[i]);
 206     map->add_gsub_pause (nullptr);
 207   }
 208
 209   map->add_gsub_pause (final_reordering);
 210
 211   for (; i < INDIC_NUM_FEATURES; i++)
 212     map->add_feature (indic_features[i]);
 213
 214   map->enable_feature (HB_TAG('c','a','l','t'));
 215   map->enable_feature (HB_TAG('c','l','i','g'));
 216
 217   map->add_gsub_pause (clear_syllables);
 218 }
 219
 220 static void
 221 override_features_indic (hb_ot_shape_planner_t *plan)
 222 {
 223   plan->map.disable_feature (HB_TAG('l','i','g','a'));
 224 }
 225
 226
 227 struct would_substitute_feature_t
 228 {
 229   void init (const hb_ot_map_t *map, hb_tag_t feature_tag, bool zero_context_)
 230   {
 231     zero_context = zero_context_;
 232     map->get_stage_lookups (0/*GSUB*/,
 233                             map->get_feature_stage (0/*GSUB*/, feature_tag),
 234                             &lookups, &count);
 235   }
 236
 237   bool would_substitute (const hb_codepoint_t *glyphs,
 238                          unsigned int          glyphs_count,
 239                          hb_face_t            *face) const
 240   {
 241     for (unsigned int i = 0; i < count; i++)
 242       if (hb_ot_layout_lookup_would_substitute (face, lookups[i].index, glyphs, glyphs_count, zero_context))
 243         return true;
 244     return false;
 245   }
 246
 247   private:
 248   const hb_ot_map_t::lookup_map_t *lookups;
 249   unsigned int count;
 250   bool zero_context;
 251 };
 252
 253 struct indic_shape_plan_t
 254 {
 255   bool load_virama_glyph (hb_font_t *font, hb_codepoint_t *pglyph) const
 256   {
 257     hb_codepoint_t glyph = virama_glyph.get_relaxed ();
 258     if (unlikely (glyph == (hb_codepoint_t) -1))
 259     {
 260       if (!config->virama || !font->get_nominal_glyph (config->virama, &glyph))
 261         glyph = 0;
 262       /* Technically speaking, the spec says we should apply 'locl' to virama too.
 263        * Maybe one day... */
 264
 265       /* Our get_nominal_glyph() function needs a font, so we can't get the virama glyph
 266        * during shape planning...  Instead, overwrite it here. */
 267       virama_glyph.set_relaxed ((int) glyph);
 268     }
 269
 270     *pglyph = glyph;
 271     return glyph != 0;
 272   }
 273
 274   const indic_config_t *config;
 275
 276   bool is_old_spec;
 277   bool uniscribe_bug_compatible;
 278   mutable hb_atomic_int_t virama_glyph;
 279
 280   would_substitute_feature_t rphf;
 281   would_substitute_feature_t pref;
 282   would_substitute_feature_t blwf;
 283   would_substitute_feature_t pstf;
 284
 285   hb_mask_t mask_array[INDIC_NUM_FEATURES];
 286 };
 287
 288 static void *
 289 data_create_indic (const hb_ot_shape_plan_t *plan)
 290 {
 291   indic_shape_plan_t *indic_plan = (indic_shape_plan_t *) calloc (1, sizeof (indic_shape_plan_t));
 292   if (unlikely (!indic_plan))
 293     return nullptr;
 294
 295   indic_plan->config = &indic_configs[0];
 296   for (unsigned int i = 1; i < ARRAY_LENGTH (indic_configs); i++)
 297     if (plan->props.script == indic_configs[i].script) {
 298       indic_plan->config = &indic_configs[i];
 299       break;
 300     }
 301
 302   indic_plan->is_old_spec = indic_plan->config->has_old_spec && ((plan->map.chosen_script[0] & 0x000000FFu) != '2');
 303   indic_plan->uniscribe_bug_compatible = hb_options ().uniscribe_bug_compatible;
 304   indic_plan->virama_glyph.set_relaxed (-1);
 305
 306   /* Use zero-context would_substitute() matching for new-spec of the main
 307    * Indic scripts, and scripts with one spec only, but not for old-specs.
 308    * The new-spec for all dual-spec scripts says zero-context matching happens.
 309    *
 310    * However, testing with Malayalam shows that old and new spec both allow
 311    * context.  Testing with Bengali new-spec however shows that it doesn't.
 312    * So, the heuristic here is the way it is.  It should *only* be changed,
 313    * as we discover more cases of what Windows does.  DON'T TOUCH OTHERWISE.
 314    */
 315   bool zero_context = !indic_plan->is_old_spec && plan->props.script != HB_SCRIPT_MALAYALAM;
 316   indic_plan->rphf.init (&plan->map, HB_TAG('r','p','h','f'), zero_context);
 317   indic_plan->pref.init (&plan->map, HB_TAG('p','r','e','f'), zero_context);
 318   indic_plan->blwf.init (&plan->map, HB_TAG('b','l','w','f'), zero_context);
 319   indic_plan->pstf.init (&plan->map, HB_TAG('p','s','t','f'), zero_context);
 320
 321   for (unsigned int i = 0; i < ARRAY_LENGTH (indic_plan->mask_array); i++)
 322     indic_plan->mask_array[i] = (indic_features[i].flags & F_GLOBAL) ?
 323                                  0 : plan->map.get_1_mask (indic_features[i].tag);
 324
 325   return indic_plan;
 326 }
 327
 328 static void
 329 data_destroy_indic (void *data)
 330 {
 331   free (data);
 332 }
 333
 334 static indic_position_t
 335 consonant_position_from_face (const indic_shape_plan_t *indic_plan,
 336                               const hb_codepoint_t consonant,
 337                               const hb_codepoint_t virama,
 338                               hb_face_t *face)
 339 {
 340   /* For old-spec, the order of glyphs is Consonant,Virama,
 341    * whereas for new-spec, it's Virama,Consonant.  However,
 342    * some broken fonts (like Free Sans) simply copied lookups
 343    * from old-spec to new-spec without modification.
 344    * And oddly enough, Uniscribe seems to respect those lookups.
 345    * Eg. in the sequence U+0924,U+094D,U+0930, Uniscribe finds
 346    * base at 0.  The font however, only has lookups matching
 347    * 930,94D in 'blwf', not the expected 94D,930 (with new-spec
 348    * table).  As such, we simply match both sequences.  Seems
 349    * to work. */
 350   hb_codepoint_t glyphs[3] = {virama, consonant, virama};
 351   if (indic_plan->blwf.would_substitute (glyphs  , 2, face) ||
 352       indic_plan->blwf.would_substitute (glyphs+1, 2, face))
 353     return POS_BELOW_C;
 354   if (indic_plan->pstf.would_substitute (glyphs  , 2, face) ||
 355       indic_plan->pstf.would_substitute (glyphs+1, 2, face))
 356     return POS_POST_C;
 357   if (indic_plan->pref.would_substitute (glyphs  , 2, face) ||
 358       indic_plan->pref.would_substitute (glyphs+1, 2, face))
 359     return POS_POST_C;
 360   return POS_BASE_C;
 361 }
 362
 363
 364 enum syllable_type_t {
 365   consonant_syllable,
 366   vowel_syllable,
 367   standalone_cluster,
 368   symbol_cluster,
 369   broken_cluster,
 370   non_indic_cluster,
 371 };
 372
 373 #include "hb-ot-shape-complex-indic-machine.hh"
 374
 375
 376 static void
 377 setup_masks_indic (const hb_ot_shape_plan_t *plan HB_UNUSED,
 378                    hb_buffer_t              *buffer,
 379                    hb_font_t                *font HB_UNUSED)
 380 {
 381   HB_BUFFER_ALLOCATE_VAR (buffer, indic_category);
 382   HB_BUFFER_ALLOCATE_VAR (buffer, indic_position);
 383
 384   /* We cannot setup masks here.  We save information about characters
 385    * and setup masks later on in a pause-callback. */
 386
 387   unsigned int count = buffer->len;
 388   hb_glyph_info_t *info = buffer->info;
 389   for (unsigned int i = 0; i < count; i++)
 390     set_indic_properties (info[i]);
 391 }
 392
 393 static void
 394 setup_syllables (const hb_ot_shape_plan_t *plan HB_UNUSED,
 395                  hb_font_t *font HB_UNUSED,
 396                  hb_buffer_t *buffer)
 397 {
 398   find_syllables (buffer);
 399   foreach_syllable (buffer, start, end)
 400     buffer->unsafe_to_break (start, end);
 401 }
 402
 403 static int
 404 compare_indic_order (const hb_glyph_info_t *pa, const hb_glyph_info_t *pb)
 405 {
 406   int a = pa->indic_position();
 407   int b = pb->indic_position();
 408
 409   return a < b ? -1 : a == b ? 0 : +1;
 410 }
 411
 412
 413
 414 static void
 415 update_consonant_positions (const hb_ot_shape_plan_t *plan,
 416                             hb_font_t         *font,
 417                             hb_buffer_t       *buffer)
 418 {
 419   const indic_shape_plan_t *indic_plan = (const indic_shape_plan_t *) plan->data;
 420
 421   if (indic_plan->config->base_pos != BASE_POS_LAST)
 422     return;
 423
 424   hb_codepoint_t virama;
 425   if (indic_plan->load_virama_glyph (font, &virama))
 426   {
 427     hb_face_t *face = font->face;
 428     unsigned int count = buffer->len;
 429     hb_glyph_info_t *info = buffer->info;
 430     for (unsigned int i = 0; i < count; i++)
 431       if (info[i].indic_position() == POS_BASE_C)
 432       {
 433         hb_codepoint_t consonant = info[i].codepoint;
 434         info[i].indic_position() = consonant_position_from_face (indic_plan, consonant, virama, face);
 435       }
 436   }
 437 }
 438
 439
 440 /* Rules from:
 441  * https://docs.microsqoft.com/en-us/typography/script-development/devanagari */
 442
 443 static void
 444 initial_reordering_consonant_syllable (const hb_ot_shape_plan_t *plan,
 445                                        hb_face_t *face,
 446                                        hb_buffer_t *buffer,
 447                                        unsigned int start, unsigned int end)
 448 {
 449   const indic_shape_plan_t *indic_plan = (const indic_shape_plan_t *) plan->data;
 450   hb_glyph_info_t *info = buffer->info;
 451
 452   /* https://github.com/harfbuzz/harfbuzz/issues/435#issuecomment-335560167
 453    * // For compatibility with legacy usage in Kannada,
 454    * // Ra+h+ZWJ must behave like Ra+ZWJ+h...
 455    */
 456   if (buffer->props.script == HB_SCRIPT_KANNADA &&
 457       start + 3 <= end &&
 458       is_one_of (info[start  ], FLAG (OT_Ra)) &&
 459       is_one_of (info[start+1], FLAG (OT_H)) &&
 460       is_one_of (info[start+2], FLAG (OT_ZWJ)))
 461   {
 462     buffer->merge_clusters (start+1, start+3);
 463     hb_glyph_info_t tmp = info[start+1];
 464     info[start+1] = info[start+2];
 465     info[start+2] = tmp;
 466   }
 467
 468   /* 1. Find base consonant:
 469    *
 470    * The shaping engine finds the base consonant of the syllable, using the
 471    * following algorithm: starting from the end of the syllable, move backwards
 472    * until a consonant is found that does not have a below-base or post-base
 473    * form (post-base forms have to follow below-base forms), or that is not a
 474    * pre-base-reordering Ra, or arrive at the first consonant. The consonant
 475    * stopped at will be the base.
 476    *
 477    *   o If the syllable starts with Ra + Halant (in a script that has Reph)
 478    *     and has more than one consonant, Ra is excluded from candidates for
 479    *     base consonants.
 480    */
 481
 482   unsigned int base = end;
 483   bool has_reph = false;
 484
 485   {
 486     /* -> If the syllable starts with Ra + Halant (in a script that has Reph)
 487      *    and has more than one consonant, Ra is excluded from candidates for
 488      *    base consonants. */
 489     unsigned int limit = start;
 490     if (indic_plan->mask_array[RPHF] &&
 491         start + 3 <= end &&
 492         (
 493          (indic_plan->config->reph_mode == REPH_MODE_IMPLICIT && !is_joiner (info[start + 2])) ||
 494          (indic_plan->config->reph_mode == REPH_MODE_EXPLICIT && info[start + 2].indic_category() == OT_ZWJ)
 495         ))
 496     {
 497       /* See if it matches the 'rphf' feature. */
 498       hb_codepoint_t glyphs[3] = {info[start].codepoint,
 499                                   info[start + 1].codepoint,
 500                                   indic_plan->config->reph_mode == REPH_MODE_EXPLICIT ?
 501                                     info[start + 2].codepoint : 0};
 502       if (indic_plan->rphf.would_substitute (glyphs, 2, face) ||
 503           (indic_plan->config->reph_mode == REPH_MODE_EXPLICIT &&
 504            indic_plan->rphf.would_substitute (glyphs, 3, face)))
 505       {
 506         limit += 2;
 507         while (limit < end && is_joiner (info[limit]))
 508           limit++;
 509         base = start;
 510         has_reph = true;
 511       }
 512     } else if (indic_plan->config->reph_mode == REPH_MODE_LOG_REPHA && info[start].indic_category() == OT_Repha)
 513     {
 514         limit += 1;
 515         while (limit < end && is_joiner (info[limit]))
 516           limit++;
 517         base = start;
 518         has_reph = true;
 519     }
 520
 521     switch (indic_plan->config->base_pos)
 522     {
 523       case BASE_POS_LAST:
 524       {
 525         /* -> starting from the end of the syllable, move backwards */
 526         unsigned int i = end;
 527         bool seen_below = false;
 528         do {
 529           i--;
 530           /* -> until a consonant is found */
 531           if (is_consonant (info[i]))
 532           {
 533             /* -> that does not have a below-base or post-base form
 534              * (post-base forms have to follow below-base forms), */
 535             if (info[i].indic_position() != POS_BELOW_C &&
 536                 (info[i].indic_position() != POS_POST_C || seen_below))
 537             {
 538               base = i;
 539               break;
 540             }
 541             if (info[i].indic_position() == POS_BELOW_C)
 542               seen_below = true;
 543
 544             /* -> or that is not a pre-base-reordering Ra,
 545              *
 546              * IMPLEMENTATION NOTES:
 547              *
 548              * Our pre-base-reordering Ra's are marked POS_POST_C, so will be skipped
 549              * by the logic above already.
 550              */
 551
 552             /* -> or arrive at the first consonant. The consonant stopped at will
 553              * be the base. */
 554             base = i;
 555           }
 556           else
 557           {
 558             /* A ZWJ after a Halant stops the base search, and requests an explicit
 559              * half form.
 560              * A ZWJ before a Halant, requests a subjoined form instead, and hence
 561              * search continues.  This is particularly important for Bengali
 562              * sequence Ra,H,Ya that should form Ya-Phalaa by subjoining Ya. */
 563             if (start < i &&
 564                 info[i].indic_category() == OT_ZWJ &&
 565                 info[i - 1].indic_category() == OT_H)
 566               break;
 567           }
 568         } while (i > limit);
 569       }
 570       break;
 571
 572       case BASE_POS_LAST_SINHALA:
 573       {
 574         /* Sinhala base positioning is slightly different from main Indic, in that:
 575          * 1. Its ZWJ behavior is different,
 576          * 2. We don't need to look into the font for consonant positions.
 577          */
 578
 579         if (!has_reph)
 580           base = limit;
 581
 582         /* Find the last base consonant that is not blocked by ZWJ.  If there is
 583          * a ZWJ right before a base consonant, that would request a subjoined form. */
 584         for (unsigned int i = limit; i < end; i++)
 585           if (is_consonant (info[i]))
 586           {
 587             if (limit < i && info[i - 1].indic_category() == OT_ZWJ)
 588               break;
 589             else
 590               base = i;
 591           }
 592
 593         /* Mark all subsequent consonants as below. */
 594         for (unsigned int i = base + 1; i < end; i++)
 595           if (is_consonant (info[i]))
 596             info[i].indic_position() = POS_BELOW_C;
 597       }
 598       break;
 599     }
 600
 601     /* -> If the syllable starts with Ra + Halant (in a script that has Reph)
 602      *    and has more than one consonant, Ra is excluded from candidates for
 603      *    base consonants.
 604      *
 605      *  Only do this for unforced Reph. (ie. not for Ra,H,ZWJ. */
 606     if (has_reph && base == start && limit - base <= 2) {
 607       /* Have no other consonant, so Reph is not formed and Ra becomes base. */
 608       has_reph = false;
 609     }
 610   }
 611
 612
 613   /* 2. Decompose and reorder Matras:
 614    *
 615    * Each matra and any syllable modifier sign in the syllable are moved to the
 616    * appropriate position relative to the consonant(s) in the syllable. The
 617    * shaping engine decomposes two- or three-part matras into their constituent
 618    * parts before any repositioning. Matra characters are classified by which
 619    * consonant in a conjunct they have affinity for and are reordered to the
 620    * following positions:
 621    *
 622    *   o Before first half form in the syllable
 623    *   o After subjoined consonants
 624    *   o After post-form consonant
 625    *   o After main consonant (for above marks)
 626    *
 627    * IMPLEMENTATION NOTES:
 628    *
 629    * The normalize() routine has already decomposed matras for us, so we don't
 630    * need to worry about that.
 631    */
 632
 633
 634   /* 3.  Reorder marks to canonical order:
 635    *
 636    * Adjacent nukta and halant or nukta and vedic sign are always repositioned
 637    * if necessary, so that the nukta is first.
 638    *
 639    * IMPLEMENTATION NOTES:
 640    *
 641    * We don't need to do this: the normalize() routine already did this for us.
 642    */
 643
 644
 645   /* Reorder characters */
 646
 647   for (unsigned int i = start; i < base; i++)
 648     info[i].indic_position() = MIN (POS_PRE_C, (indic_position_t) info[i].indic_position());
 649
 650   if (base < end)
 651     info[base].indic_position() = POS_BASE_C;
 652
 653   /* Mark final consonants.  A final consonant is one appearing after a matra.
 654    * Happens in Sinhala. */
 655   for (unsigned int i = base + 1; i < end; i++)
 656     if (info[i].indic_category() == OT_M) {
 657       for (unsigned int j = i + 1; j < end; j++)
 658         if (is_consonant (info[j])) {
 659          info[j].indic_position() = POS_FINAL_C;
 660          break;
 661        }
 662       break;
 663     }
 664
 665   /* Handle beginning Ra */
 666   if (has_reph)
 667     info[start].indic_position() = POS_RA_TO_BECOME_REPH;
 668
 669   /* For old-style Indic script tags, move the first post-base Halant after
 670    * last consonant.
 671    *
 672    * Reports suggest that in some scripts Uniscribe does this only if there
 673    * is *not* a Halant after last consonant already.  We know that is the
 674    * case for Kannada, while it reorders unconditionally in other scripts,
 675    * eg. Malayalam, Bengali, and Devanagari.  We don't currently know about
 676    * other scripts, so we blacklist Kannada.
 677    *
 678    * Kannada test case:
 679    * U+0C9A,U+0CCD,U+0C9A,U+0CCD
 680    * With some versions of Lohit Kannada.
 681    * https://bugs.freedesktop.org/show_bug.cgi?id=59118
 682    *
 683    * Malayalam test case:
 684    * U+0D38,U+0D4D,U+0D31,U+0D4D,U+0D31,U+0D4D
 685    * With lohit-ttf-20121122/Lohit-Malayalam.ttf
 686    *
 687    * Bengali test case:
 688    * U+0998,U+09CD,U+09AF,U+09CD
 689    * With Windows XP vrinda.ttf
 690    * https://github.com/harfbuzz/harfbuzz/issues/1073
 691    *
 692    * Devanagari test case:
 693    * U+091F,U+094D,U+0930,U+094D
 694    * With chandas.ttf
 695    * https://github.com/harfbuzz/harfbuzz/issues/1071
 696    */
 697   if (indic_plan->is_old_spec)
 698   {
 699     bool disallow_double_halants = buffer->props.script == HB_SCRIPT_KANNADA;
 700     for (unsigned int i = base + 1; i < end; i++)
 701       if (info[i].indic_category() == OT_H)
 702       {
 703         unsigned int j;
 704         for (j = end - 1; j > i; j--)
 705           if (is_consonant (info[j]) ||
 706               (disallow_double_halants && info[j].indic_category() == OT_H))
 707             break;
 708         if (info[j].indic_category() != OT_H && j > i) {
 709           /* Move Halant to after last consonant. */
 710           hb_glyph_info_t t = info[i];
 711           memmove (&info[i], &info[i + 1], (j - i) * sizeof (info[0]));
 712           info[j] = t;
 713         }
 714         break;
 715       }
 716   }
 717
 718   /* Attach misc marks to previous char to move with them. */
 719   {
 720     indic_position_t last_pos = POS_START;
 721     for (unsigned int i = start; i < end; i++)
 722     {
 723       if ((FLAG_UNSAFE (info[i].indic_category()) & (JOINER_FLAGS | FLAG (OT_N) | FLAG (OT_RS) | MEDIAL_FLAGS | FLAG (OT_H))))
 724       {
 725         info[i].indic_position() = last_pos;
 726         if (unlikely (info[i].indic_category() == OT_H &&
 727                       info[i].indic_position() == POS_PRE_M))
 728         {
 729           /*
 730            * Uniscribe doesn't move the Halant with Left Matra.
 731            * TEST: U+092B,U+093F,U+094DE
 732            * We follow.  This is important for the Sinhala
 733            * U+0DDA split matra since it decomposes to U+0DD9,U+0DCA
 734            * where U+0DD9 is a left matra and U+0DCA is the virama.
 735            * We don't want to move the virama with the left matra.
 736            * TEST: U+0D9A,U+0DDA
 737            */
 738           for (unsigned int j = i; j > start; j--)
 739             if (info[j - 1].indic_position() != POS_PRE_M) {
 740               info[i].indic_position() = info[j - 1].indic_position();
 741               break;
 742             }
 743         }
 744       } else if (info[i].indic_position() != POS_SMVD) {
 745         last_pos = (indic_position_t) info[i].indic_position();
 746       }
 747     }
 748   }
 749   /* For post-base consonants let them own anything before them
 750    * since the last consonant or matra. */
 751   {
 752     unsigned int last = base;
 753     for (unsigned int i = base + 1; i < end; i++)
 754       if (is_consonant (info[i]))
 755       {
 756         for (unsigned int j = last + 1; j < i; j++)
 757           if (info[j].indic_position() < POS_SMVD)
 758             info[j].indic_position() = info[i].indic_position();
 759         last = i;
 760       } else if (info[i].indic_category() == OT_M)
 761         last = i;
 762   }
 763
 764
 765   {
 766     /* Use syllable() for sort accounting temporarily. */
 767     unsigned int syllable = info[start].syllable();
 768     for (unsigned int i = start; i < end; i++)
 769       info[i].syllable() = i - start;
 770
 771     /* Sit tight, rock 'n roll! */
 772     hb_stable_sort (info + start, end - start, compare_indic_order);
 773     /* Find base again */
 774     base = end;
 775     for (unsigned int i = start; i < end; i++)
 776       if (info[i].indic_position() == POS_BASE_C)
 777       {
 778         base = i;
 779         break;
 780       }
 781     /* Things are out-of-control for post base positions, they may shuffle
 782      * around like crazy.  In old-spec mode, we move halants around, so in
 783      * that case merge all clusters after base.  Otherwise, check the sort
 784      * order and merge as needed.
 785      * For pre-base stuff, we handle cluster issues in final reordering.
 786      *
 787      * We could use buffer->sort() for this, if there was no special
 788      * reordering of pre-base stuff happening later...
 789      * We don't want to merge_clusters all of that, which buffer->sort()
 790      * would.
 791      */
 792     if (indic_plan->is_old_spec || end - start > 127)
 793       buffer->merge_clusters (base, end);
 794     else
 795     {
 796       /* Note!  syllable() is a one-byte field. */
 797       for (unsigned int i = base; i < end; i++)
 798         if (info[i].syllable() != 255)
 799         {
 800           unsigned int max = i;
 801           unsigned int j = start + info[i].syllable();
 802           while (j != i)
 803           {
 804             max = MAX (max, j);
 805             unsigned int next = start + info[j].syllable();
 806             info[j].syllable() = 255; /* So we don't process j later again. */
 807             j = next;
 808           }
 809           if (i != max)
 810             buffer->merge_clusters (i, max + 1);
 811         }
 812     }
 813
 814     /* Put syllable back in. */
 815     for (unsigned int i = start; i < end; i++)
 816       info[i].syllable() = syllable;
 817   }
 818
 819   /* Setup masks now */
 820
 821   {
 822     hb_mask_t mask;
 823
 824     /* Reph */
 825     for (unsigned int i = start; i < end && info[i].indic_position() == POS_RA_TO_BECOME_REPH; i++)
 826       info[i].mask |= indic_plan->mask_array[RPHF];
 827
 828     /* Pre-base */
 829     mask = indic_plan->mask_array[HALF];
 830     if (!indic_plan->is_old_spec &&
 831         indic_plan->config->blwf_mode == BLWF_MODE_PRE_AND_POST)
 832       mask |= indic_plan->mask_array[BLWF];
 833     for (unsigned int i = start; i < base; i++)
 834       info[i].mask  |= mask;
 835     /* Base */
 836     mask = 0;
 837     if (base < end)
 838       info[base].mask |= mask;
 839     /* Post-base */
 840     mask = indic_plan->mask_array[BLWF] | indic_plan->mask_array[ABVF] | indic_plan->mask_array[PSTF];
 841     for (unsigned int i = base + 1; i < end; i++)
 842       info[i].mask  |= mask;
 843   }
 844
 845   if (indic_plan->is_old_spec &&
 846       buffer->props.script == HB_SCRIPT_DEVANAGARI)
 847   {
 848     /* Old-spec eye-lash Ra needs special handling.  From the
 849      * spec:
 850      *
 851      * "The feature 'below-base form' is applied to consonants
 852      * having below-base forms and following the base consonant.
 853      * The exception is vattu, which may appear below half forms
 854      * as well as below the base glyph. The feature 'below-base
 855      * form' will be applied to all such occurrences of Ra as well."
 856      *
 857      * Test case: U+0924,U+094D,U+0930,U+094d,U+0915
 858      * with Sanskrit 2003 font.
 859      *
 860      * However, note that Ra,Halant,ZWJ is the correct way to
 861      * request eyelash form of Ra, so we wouldbn't inhibit it
 862      * in that sequence.
 863      *
 864      * Test case: U+0924,U+094D,U+0930,U+094d,U+200D,U+0915
 865      */
 866     for (unsigned int i = start; i + 1 < base; i++)
 867       if (info[i  ].indic_category() == OT_Ra &&
 868           info[i+1].indic_category() == OT_H  &&
 869           (i + 2 == base ||
 870            info[i+2].indic_category() != OT_ZWJ))
 871       {
 872         info[i  ].mask |= indic_plan->mask_array[BLWF];
 873         info[i+1].mask |= indic_plan->mask_array[BLWF];
 874       }
 875   }
 876
 877   unsigned int pref_len = 2;
 878   if (indic_plan->mask_array[PREF] && base + pref_len < end)
 879   {
 880     /* Find a Halant,Ra sequence and mark it for pre-base-reordering processing. */
 881     for (unsigned int i = base + 1; i + pref_len - 1 < end; i++) {
 882       hb_codepoint_t glyphs[2];
 883       for (unsigned int j = 0; j < pref_len; j++)
 884         glyphs[j] = info[i + j].codepoint;
 885       if (indic_plan->pref.would_substitute (glyphs, pref_len, face))
 886       {
 887         for (unsigned int j = 0; j < pref_len; j++)
 888           info[i++].mask |= indic_plan->mask_array[PREF];
 889         break;
 890       }
 891     }
 892   }
 893
 894   /* Apply ZWJ/ZWNJ effects */
 895   for (unsigned int i = start + 1; i < end; i++)
 896     if (is_joiner (info[i])) {
 897       bool non_joiner = info[i].indic_category() == OT_ZWNJ;
 898       unsigned int j = i;
 899
 900       do {
 901         j--;
 902
 903         /* ZWJ/ZWNJ should disable CJCT.  They do that by simply
 904          * being there, since we don't skip them for the CJCT
 905          * feature (ie. F_MANUAL_ZWJ) */
 906
 907         /* A ZWNJ disables HALF. */
 908         if (non_joiner)
 909           info[j].mask &= ~indic_plan->mask_array[HALF];
 910
 911       } while (j > start && !is_consonant (info[j]));
 912     }
 913 }
 914
 915 static void
 916 initial_reordering_standalone_cluster (const hb_ot_shape_plan_t *plan,
 917                                        hb_face_t *face,
 918                                        hb_buffer_t *buffer,
 919                                        unsigned int start, unsigned int end)
 920 {
 921   const indic_shape_plan_t *indic_plan = (const indic_shape_plan_t *) plan->data;
 922
 923   /* We treat placeholder/dotted-circle as if they are consonants, so we
 924    * should just chain.  Only if not in compatibility mode that is... */
 925
 926   if (indic_plan->uniscribe_bug_compatible)
 927   {
 928     /* For dotted-circle, this is what Uniscribe does:
 929      * If dotted-circle is the last glyph, it just does nothing.
 930      * Ie. It doesn't form Reph. */
 931     if (buffer->info[end - 1].indic_category() == OT_DOTTEDCIRCLE)
 932       return;
 933   }
 934
 935   initial_reordering_consonant_syllable (plan, face, buffer, start, end);
 936 }
 937
 938 static void
 939 initial_reordering_syllable (const hb_ot_shape_plan_t *plan,
 940                              hb_face_t *face,
 941                              hb_buffer_t *buffer,
 942                              unsigned int start, unsigned int end)
 943 {
 944   syllable_type_t syllable_type = (syllable_type_t) (buffer->info[start].syllable() & 0x0F);
 945   switch (syllable_type)
 946   {
 947     case vowel_syllable: /* We made the vowels look like consonants.  So let's call the consonant logic! */
 948     case consonant_syllable:
 949      initial_reordering_consonant_syllable (plan, face, buffer, start, end);
 950      break;
 951
 952     case broken_cluster: /* We already inserted dotted-circles, so just call the standalone_cluster. */
 953     case standalone_cluster:
 954      initial_reordering_standalone_cluster (plan, face, buffer, start, end);
 955      break;
 956
 957     case symbol_cluster:
 958     case non_indic_cluster:
 959       break;
 960   }
 961 }
 962
 963 static inline void
 964 insert_dotted_circles (const hb_ot_shape_plan_t *plan HB_UNUSED,
 965                        hb_font_t *font,
 966                        hb_buffer_t *buffer)
 967 {
 968   if (unlikely (buffer->flags & HB_BUFFER_FLAG_DO_NOT_INSERT_DOTTED_CIRCLE))
 969     return;
 970
 971   /* Note: This loop is extra overhead, but should not be measurable.
 972    * TODO Use a buffer scratch flag to remove the loop. */
 973   bool has_broken_syllables = false;
 974   unsigned int count = buffer->len;
 975   hb_glyph_info_t *info = buffer->info;
 976   for (unsigned int i = 0; i < count; i++)
 977     if ((info[i].syllable() & 0x0F) == broken_cluster)
 978     {
 979       has_broken_syllables = true;
 980       break;
 981     }
 982   if (likely (!has_broken_syllables))
 983     return;
 984
 985
 986   hb_codepoint_t dottedcircle_glyph;
 987   if (!font->get_nominal_glyph (0x25CCu, &dottedcircle_glyph))
 988     return;
 989
 990   hb_glyph_info_t dottedcircle = {0};
 991   dottedcircle.codepoint = 0x25CCu;
 992   set_indic_properties (dottedcircle);
 993   dottedcircle.codepoint = dottedcircle_glyph;
 994
 995   buffer->clear_output ();
 996
 997   buffer->idx = 0;
 998   unsigned int last_syllable = 0;
 999   while (buffer->idx < buffer->len && buffer->successful)
1000   {
1001     unsigned int syllable = buffer->cur().syllable();
1002     syllable_type_t syllable_type = (syllable_type_t) (syllable & 0x0F);
1003     if (unlikely (last_syllable != syllable && syllable_type == broken_cluster))
1004     {
1005       last_syllable = syllable;
1006
1007       hb_glyph_info_t ginfo = dottedcircle;
1008       ginfo.cluster = buffer->cur().cluster;
1009       ginfo.mask = buffer->cur().mask;
1010       ginfo.syllable() = buffer->cur().syllable();
1011       /* TODO Set glyph_props? */
1012
1013       /* Insert dottedcircle after possible Repha. */
1014       while (buffer->idx < buffer->len && buffer->successful &&
1015              last_syllable == buffer->cur().syllable() &&
1016              buffer->cur().indic_category() == OT_Repha)
1017         buffer->next_glyph ();
1018
1019       buffer->output_info (ginfo);
1020     }
1021     else
1022       buffer->next_glyph ();
1023   }
1024   buffer->swap_buffers ();
1025 }
1026
1027 static void
1028 initial_reordering (const hb_ot_shape_plan_t *plan,
1029                     hb_font_t *font,
1030                     hb_buffer_t *buffer)
1031 {
1032   update_consonant_positions (plan, font, buffer);
1033   insert_dotted_circles (plan, font, buffer);
1034
1035   foreach_syllable (buffer, start, end)
1036     initial_reordering_syllable (plan, font->face, buffer, start, end);
1037 }
1038
1039 static void
1040 final_reordering_syllable (const hb_ot_shape_plan_t *plan,
1041                            hb_buffer_t *buffer,
1042                            unsigned int start, unsigned int end)
1043 {
1044   const indic_shape_plan_t *indic_plan = (const indic_shape_plan_t *) plan->data;
1045   hb_glyph_info_t *info = buffer->info;
1046
1047
1048   /* This function relies heavily on halant glyphs.  Lots of ligation
1049    * and possibly multiple substitutions happened prior to this
1050    * phase, and that might have messed up our properties.  Recover
1051    * from a particular case of that where we're fairly sure that a
1052    * class of OT_H is desired but has been lost. */
1053   /* We don't call load_virama_glyph(), since we know it's already
1054    * loaded. */
1055   hb_codepoint_t virama_glyph = indic_plan->virama_glyph.get_relaxed ();
1056   if (virama_glyph)
1057   {
1058     for (unsigned int i = start; i < end; i++)
1059       if (info[i].codepoint == virama_glyph &&
1060           _hb_glyph_info_ligated (&info[i]) &&
1061           _hb_glyph_info_multiplied (&info[i]))
1062       {
1063         /* This will make sure that this glyph passes is_halant() test. */
1064         info[i].indic_category() = OT_H;
1065         _hb_glyph_info_clear_ligated_and_multiplied (&info[i]);
1066       }
1067   }
1068
1069
1070   /* 4. Final reordering:
1071    *
1072    * After the localized forms and basic shaping forms GSUB features have been
1073    * applied (see below), the shaping engine performs some final glyph
1074    * reordering before applying all the remaining font features to the entire
1075    * syllable.
1076    */
1077
1078   bool try_pref = !!indic_plan->mask_array[PREF];
1079
1080   /* Find base again */
1081   unsigned int base;
1082   for (base = start; base < end; base++)
1083     if (info[base].indic_position() >= POS_BASE_C)
1084     {
1085       if (try_pref && base + 1 < end)
1086       {
1087         for (unsigned int i = base + 1; i < end; i++)
1088           if ((info[i].mask & indic_plan->mask_array[PREF]) != 0)
1089           {
1090             if (!(_hb_glyph_info_substituted (&info[i]) &&
1091                   _hb_glyph_info_ligated_and_didnt_multiply (&info[i])))
1092             {
1093               /* Ok, this was a 'pref' candidate but didn't form any.
1094                * Base is around here... */
1095               base = i;
1096               while (base < end && is_halant (info[base]))
1097                 base++;
1098               info[base].indic_position() = POS_BASE_C;
1099
1100               try_pref = false;
1101             }
1102             break;
1103           }
1104       }
1105       /* For Malayalam, skip over unformed below- (but NOT post-) forms. */
1106       if (buffer->props.script == HB_SCRIPT_MALAYALAM)
1107       {
1108         for (unsigned int i = base + 1; i < end; i++)
1109         {
1110           while (i < end && is_joiner (info[i]))
1111             i++;
1112           if (i == end || !is_halant (info[i]))
1113             break;
1114           i++; /* Skip halant. */
1115           while (i < end && is_joiner (info[i]))
1116             i++;
1117           if (i < end && is_consonant (info[i]) && info[i].indic_position() == POS_BELOW_C)
1118           {
1119             base = i;
1120             info[base].indic_position() = POS_BASE_C;
1121           }
1122         }
1123       }
1124
1125       if (start < base && info[base].indic_position() > POS_BASE_C)
1126         base--;
1127       break;
1128     }
1129   if (base == end && start < base &&
1130       is_one_of (info[base - 1], FLAG (OT_ZWJ)))
1131     base--;
1132   if (base < end)
1133     while (start < base &&
1134            is_one_of (info[base], (FLAG (OT_N) | FLAG (OT_H))))
1135       base--;
1136
1137
1138   /*   o Reorder matras:
1139    *
1140    *     If a pre-base matra character had been reordered before applying basic
1141    *     features, the glyph can be moved closer to the main consonant based on
1142    *     whether half-forms had been formed. Actual position for the matra is
1143    *     defined as “after last standalone halant glyph, after initial matra
1144    *     position and before the main consonant”. If ZWJ or ZWNJ follow this
1145    *     halant, position is moved after it.
1146    *
1147    * IMPLEMENTATION NOTES:
1148    *
1149    * It looks like the last sentence is wrong.  Testing, with Windows 7 Uniscribe
1150    * and Devanagari shows that the behavior is best described as:
1151    *
1152    * "If ZWJ follows this halant, matra is NOT repositioned after this halant.
1153    *  If ZWNJ follows this halant, position is moved after it."
1154    *
1155    * Test case, with Adobe Devanagari or Nirmala UI:
1156    *
1157    *   U+091F,U+094D,U+200C,U+092F,U+093F
1158    *   (Matra moves to the middle, after ZWNJ.)
1159    *
1160    *   U+091F,U+094D,U+200D,U+092F,U+093F
1161    *   (Matra does NOT move, stays to the left.)
1162    *
1163    * https://github.com/harfbuzz/harfbuzz/issues/1070
1164    */
1165
1166   if (start + 1 < end && start < base) /* Otherwise there can't be any pre-base matra characters. */
1167   {
1168     /* If we lost track of base, alas, position before last thingy. */
1169     unsigned int new_pos = base == end ? base - 2 : base - 1;
1170
1171     /* Malayalam / Tamil do not have "half" forms or explicit virama forms.
1172      * The glyphs formed by 'half' are Chillus or ligated explicit viramas.
1173      * We want to position matra after them.
1174      */
1175     if (buffer->props.script != HB_SCRIPT_MALAYALAM && buffer->props.script != HB_SCRIPT_TAMIL)
1176     {
1177     search:
1178       while (new_pos > start &&
1179              !(is_one_of (info[new_pos], (FLAG (OT_M) | FLAG (OT_H)))))
1180         new_pos--;
1181
1182       /* If we found no Halant we are done.
1183        * Otherwise only proceed if the Halant does
1184        * not belong to the Matra itself! */
1185       if (is_halant (info[new_pos]) &&
1186           info[new_pos].indic_position() != POS_PRE_M)
1187       {
1188 #if 0 // See comment above
1189         /* -> If ZWJ or ZWNJ follow this halant, position is moved after it. */
1190         if (new_pos + 1 < end && is_joiner (info[new_pos + 1]))
1191           new_pos++;
1192 #endif
1193         if (new_pos + 1 < end)
1194         {
1195           /* -> If ZWJ follows this halant, matra is NOT repositioned after this halant. */
1196           if (info[new_pos + 1].indic_category() == OT_ZWJ)
1197           {
1198             /* Keep searching. */
1199             if (new_pos > start)
1200             {
1201               new_pos--;
1202               goto search;
1203             }
1204           }
1205           /* -> If ZWNJ follows this halant, position is moved after it.
1206            *
1207            * IMPLEMENTATION NOTES:
1208            *
1209            * This is taken care of by the state-machine. A Halant,ZWNJ is a terminating
1210            * sequence for a consonant syllable; any pre-base matras occurring after it
1211            * will belong to the subsequent syllable.
1212            */
1213         }
1214       }
1215       else
1216         new_pos = start; /* No move. */
1217     }
1218
1219     if (start < new_pos && info[new_pos].indic_position () != POS_PRE_M)
1220     {
1221       /* Now go see if there's actually any matras... */
1222       for (unsigned int i = new_pos; i > start; i--)
1223         if (info[i - 1].indic_position () == POS_PRE_M)
1224         {
1225           unsigned int old_pos = i - 1;
1226           if (old_pos < base && base <= new_pos) /* Shouldn't actually happen. */
1227             base--;
1228
1229           hb_glyph_info_t tmp = info[old_pos];
1230           memmove (&info[old_pos], &info[old_pos + 1], (new_pos - old_pos) * sizeof (info[0]));
1231           info[new_pos] = tmp;
1232
1233           /* Note: this merge_clusters() is intentionally *after* the reordering.
1234            * Indic matra reordering is special and tricky... */
1235           buffer->merge_clusters (new_pos, MIN (end, base + 1));
1236
1237           new_pos--;
1238         }
1239     } else {
1240       for (unsigned int i = start; i < base; i++)
1241         if (info[i].indic_position () == POS_PRE_M) {
1242           buffer->merge_clusters (i, MIN (end, base + 1));
1243           break;
1244         }
1245     }
1246   }
1247
1248
1249   /*   o Reorder reph:
1250    *
1251    *     Reph’s original position is always at the beginning of the syllable,
1252    *     (i.e. it is not reordered at the character reordering stage). However,
1253    *     it will be reordered according to the basic-forms shaping results.
1254    *     Possible positions for reph, depending on the script, are; after main,
1255    *     before post-base consonant forms, and after post-base consonant forms.
1256    */
1257
1258   /* Two cases:
1259    *
1260    * - If repha is encoded as a sequence of characters (Ra,H or Ra,H,ZWJ), then
1261    *   we should only move it if the sequence ligated to the repha form.
1262    *
1263    * - If repha is encoded separately and in the logical position, we should only
1264    *   move it if it did NOT ligate.  If it ligated, it's probably the font trying
1265    *   to make it work without the reordering.
1266    */
1267   if (start + 1 < end &&
1268       info[start].indic_position() == POS_RA_TO_BECOME_REPH &&
1269       ((info[start].indic_category() == OT_Repha) ^
1270        _hb_glyph_info_ligated_and_didnt_multiply (&info[start])))
1271   {
1272     unsigned int new_reph_pos;
1273     reph_position_t reph_pos = indic_plan->config->reph_pos;
1274
1275     /*       1. If reph should be positioned after post-base consonant forms,
1276      *          proceed to step 5.
1277      */
1278     if (reph_pos == REPH_POS_AFTER_POST)
1279     {
1280       goto reph_step_5;
1281     }
1282
1283     /*       2. If the reph repositioning class is not after post-base: target
1284      *          position is after the first explicit halant glyph between the
1285      *          first post-reph consonant and last main consonant. If ZWJ or ZWNJ
1286      *          are following this halant, position is moved after it. If such
1287      *          position is found, this is the target position. Otherwise,
1288      *          proceed to the next step.
1289      *
1290      *          Note: in old-implementation fonts, where classifications were
1291      *          fixed in shaping engine, there was no case where reph position
1292      *          will be found on this step.
1293      */
1294     {
1295       new_reph_pos = start + 1;
1296       while (new_reph_pos < base && !is_halant (info[new_reph_pos]))
1297         new_reph_pos++;
1298
1299       if (new_reph_pos < base && is_halant (info[new_reph_pos]))
1300       {
1301         /* ->If ZWJ or ZWNJ are following this halant, position is moved after it. */
1302         if (new_reph_pos + 1 < base && is_joiner (info[new_reph_pos + 1]))
1303           new_reph_pos++;
1304         goto reph_move;
1305       }
1306     }
1307
1308     /*       3. If reph should be repositioned after the main consonant: find the
1309      *          first consonant not ligated with main, or find the first
1310      *          consonant that is not a potential pre-base-reordering Ra.
1311      */
1312     if (reph_pos == REPH_POS_AFTER_MAIN)
1313     {
1314       new_reph_pos = base;
1315       while (new_reph_pos + 1 < end && info[new_reph_pos + 1].indic_position() <= POS_AFTER_MAIN)
1316         new_reph_pos++;
1317       if (new_reph_pos < end)
1318         goto reph_move;
1319     }
1320
1321     /*       4. If reph should be positioned before post-base consonant, find
1322      *          first post-base classified consonant not ligated with main. If no
1323      *          consonant is found, the target position should be before the
1324      *          first matra, syllable modifier sign or vedic sign.
1325      */
1326     /* This is our take on what step 4 is trying to say (and failing, BADLY). */
1327     if (reph_pos == REPH_POS_AFTER_SUB)
1328     {
1329       new_reph_pos = base;
1330       while (new_reph_pos + 1 < end &&
1331              !( FLAG_UNSAFE (info[new_reph_pos + 1].indic_position()) & (FLAG (POS_POST_C) | FLAG (POS_AFTER_POST) | FLAG (POS_SMVD))))
1332         new_reph_pos++;
1333       if (new_reph_pos < end)
1334         goto reph_move;
1335     }
1336
1337     /*       5. If no consonant is found in steps 3 or 4, move reph to a position
1338      *          immediately before the first post-base matra, syllable modifier
1339      *          sign or vedic sign that has a reordering class after the intended
1340      *          reph position. For example, if the reordering position for reph
1341      *          is post-main, it will skip above-base matras that also have a
1342      *          post-main position.
1343      */
1344     reph_step_5:
1345     {
1346       /* Copied from step 2. */
1347       new_reph_pos = start + 1;
1348       while (new_reph_pos < base && !is_halant (info[new_reph_pos]))
1349         new_reph_pos++;
1350
1351       if (new_reph_pos < base && is_halant (info[new_reph_pos]))
1352       {
1353         /* ->If ZWJ or ZWNJ are following this halant, position is moved after it. */
1354         if (new_reph_pos + 1 < base && is_joiner (info[new_reph_pos + 1]))
1355           new_reph_pos++;
1356         goto reph_move;
1357       }
1358     }
1359
1360     /*       6. Otherwise, reorder reph to the end of the syllable.
1361      */
1362     {
1363       new_reph_pos = end - 1;
1364       while (new_reph_pos > start && info[new_reph_pos].indic_position() == POS_SMVD)
1365         new_reph_pos--;
1366
1367       /*
1368        * If the Reph is to be ending up after a Matra,Halant sequence,
1369        * position it before that Halant so it can interact with the Matra.
1370        * However, if it's a plain Consonant,Halant we shouldn't do that.
1371        * Uniscribe doesn't do this.
1372        * TEST: U+0930,U+094D,U+0915,U+094B,U+094D
1373        */
1374       if (!indic_plan->uniscribe_bug_compatible &&
1375           unlikely (is_halant (info[new_reph_pos]))) {
1376         for (unsigned int i = base + 1; i < new_reph_pos; i++)
1377           if (info[i].indic_category() == OT_M) {
1378             /* Ok, got it. */
1379             new_reph_pos--;
1380           }
1381       }
1382       goto reph_move;
1383     }
1384
1385     reph_move:
1386     {
1387       /* Move */
1388       buffer->merge_clusters (start, new_reph_pos + 1);
1389       hb_glyph_info_t reph = info[start];
1390       memmove (&info[start], &info[start + 1], (new_reph_pos - start) * sizeof (info[0]));
1391       info[new_reph_pos] = reph;
1392
1393       if (start < base && base <= new_reph_pos)
1394         base--;
1395     }
1396   }
1397
1398
1399   /*   o Reorder pre-base-reordering consonants:
1400    *
1401    *     If a pre-base-reordering consonant is found, reorder it according to
1402    *     the following rules:
1403    */
1404
1405   if (try_pref && base + 1 < end) /* Otherwise there can't be any pre-base-reordering Ra. */
1406   {
1407     for (unsigned int i = base + 1; i < end; i++)
1408       if ((info[i].mask & indic_plan->mask_array[PREF]) != 0)
1409       {
1410         /*       1. Only reorder a glyph produced by substitution during application
1411          *          of the <pref> feature. (Note that a font may shape a Ra consonant with
1412          *          the feature generally but block it in certain contexts.)
1413          */
1414         /* Note: We just check that something got substituted.  We don't check that
1415          * the <pref> feature actually did it...
1416          *
1417          * Reorder pref only if it ligated. */
1418         if (_hb_glyph_info_ligated_and_didnt_multiply (&info[i]))
1419         {
1420           /*
1421            *       2. Try to find a target position the same way as for pre-base matra.
1422            *          If it is found, reorder pre-base consonant glyph.
1423            *
1424            *       3. If position is not found, reorder immediately before main
1425            *          consonant.
1426            */
1427
1428           unsigned int new_pos = base;
1429           /* Malayalam / Tamil do not have "half" forms or explicit virama forms.
1430            * The glyphs formed by 'half' are Chillus or ligated explicit viramas.
1431            * We want to position matra after them.
1432            */
1433           if (buffer->props.script != HB_SCRIPT_MALAYALAM && buffer->props.script != HB_SCRIPT_TAMIL)
1434           {
1435             while (new_pos > start &&
1436                    !(is_one_of (info[new_pos - 1], FLAG(OT_M) | FLAG (OT_H))))
1437               new_pos--;
1438           }
1439
1440           if (new_pos > start && is_halant (info[new_pos - 1]))
1441           {
1442             /* -> If ZWJ or ZWNJ follow this halant, position is moved after it. */
1443             if (new_pos < end && is_joiner (info[new_pos]))
1444               new_pos++;
1445           }
1446
1447           {
1448             unsigned int old_pos = i;
1449
1450             buffer->merge_clusters (new_pos, old_pos + 1);
1451             hb_glyph_info_t tmp = info[old_pos];
1452             memmove (&info[new_pos + 1], &info[new_pos], (old_pos - new_pos) * sizeof (info[0]));
1453             info[new_pos] = tmp;
1454
1455             if (new_pos <= base && base < old_pos)
1456               base++;
1457           }
1458         }
1459
1460         break;
1461       }
1462   }
1463
1464
1465   /* Apply 'init' to the Left Matra if it's a word start. */
1466   if (info[start].indic_position () == POS_PRE_M)
1467   {
1468     if (!start ||
1469         !(FLAG_UNSAFE (_hb_glyph_info_get_general_category (&info[start - 1])) &
1470          FLAG_RANGE (HB_UNICODE_GENERAL_CATEGORY_FORMAT, HB_UNICODE_GENERAL_CATEGORY_NON_SPACING_MARK)))
1471       info[start].mask |= indic_plan->mask_array[INIT];
1472     else
1473       buffer->unsafe_to_break (start - 1, start + 1);
1474   }
1475
1476
1477   /*
1478    * Finish off the clusters and go home!
1479    */
1480   if (indic_plan->uniscribe_bug_compatible)
1481   {
1482     switch ((hb_tag_t) plan->props.script)
1483     {
1484       case HB_SCRIPT_TAMIL:
1485       case HB_SCRIPT_SINHALA:
1486         break;
1487
1488       default:
1489         /* Uniscribe merges the entire syllable into a single cluster... Except for Tamil & Sinhala.
1490          * This means, half forms are submerged into the main consonant's cluster.
1491          * This is unnecessary, and makes cursor positioning harder, but that's what
1492          * Uniscribe does. */
1493         buffer->merge_clusters (start, end);
1494         break;
1495     }
1496   }
1497 }
1498
1499
1500 static void
1501 final_reordering (const hb_ot_shape_plan_t *plan,
1502                   hb_font_t *font HB_UNUSED,
1503                   hb_buffer_t *buffer)
1504 {
1505   unsigned int count = buffer->len;
1506   if (unlikely (!count)) return;
1507
1508   foreach_syllable (buffer, start, end)
1509     final_reordering_syllable (plan, buffer, start, end);
1510
1511   HB_BUFFER_DEALLOCATE_VAR (buffer, indic_category);
1512   HB_BUFFER_DEALLOCATE_VAR (buffer, indic_position);
1513 }
1514
1515
1516 static void
1517 clear_syllables (const hb_ot_shape_plan_t *plan HB_UNUSED,
1518                  hb_font_t *font HB_UNUSED,
1519                  hb_buffer_t *buffer)
1520 {
1521   hb_glyph_info_t *info = buffer->info;
1522   unsigned int count = buffer->len;
1523   for (unsigned int i = 0; i < count; i++)
1524     info[i].syllable() = 0;
1525 }
1526
1527
1528 static void
1529 preprocess_text_indic (const hb_ot_shape_plan_t *plan,
1530                        hb_buffer_t              *buffer,
1531                        hb_font_t                *font)
1532 {
1533   _hb_preprocess_text_vowel_constraints (plan, buffer, font);
1534 }
1535
1536 static bool
1537 decompose_indic (const hb_ot_shape_normalize_context_t *c,
1538                  hb_codepoint_t  ab,
1539                  hb_codepoint_t *a,
1540                  hb_codepoint_t *b)
1541 {
1542   switch (ab)
1543   {
1544     /* Don't decompose these. */
1545     case 0x0931u  : return false; /* DEVANAGARI LETTER RRA */
1546     // https://github.com/harfbuzz/harfbuzz/issues/779
1547     case 0x09DCu  : return false; /* BENGALI LETTER RRA */
1548     case 0x09DDu  : return false; /* BENGALI LETTER RHA */
1549     case 0x0B94u  : return false; /* TAMIL LETTER AU */
1550
1551
1552     /*
1553      * Decompose split matras that don't have Unicode decompositions.
1554      */
1555
1556 #if 0
1557     /* Gujarati */
1558     /* This one has no decomposition in Unicode, but needs no decomposition either. */
1559     /* case 0x0AC9u  : return false; */
1560
1561     /* Oriya */
1562     case 0x0B57u  : *a = no decomp, -> RIGHT; return true;
1563 #endif
1564   }
1565
1566   if ((ab == 0x0DDAu || hb_in_range<hb_codepoint_t> (ab, 0x0DDCu, 0x0DDEu)))
1567   {
1568     /*
1569      * Sinhala split matras...  Let the fun begin.
1570      *
1571      * These four characters have Unicode decompositions.  However, Uniscribe
1572      * decomposes them "Khmer-style", that is, it uses the character itself to
1573      * get the second half.  The first half of all four decompositions is always
1574      * U+0DD9.
1575      *
1576      * Now, there are buggy fonts, namely, the widely used lklug.ttf, that are
1577      * broken with Uniscribe.  But we need to support them.  As such, we only
1578      * do the Uniscribe-style decomposition if the character is transformed into
1579      * its "sec.half" form by the 'pstf' feature.  Otherwise, we fall back to
1580      * Unicode decomposition.
1581      *
1582      * Note that we can't unconditionally use Unicode decomposition.  That would
1583      * break some other fonts, that are designed to work with Uniscribe, and
1584      * don't have positioning features for the Unicode-style decomposition.
1585      *
1586      * Argh...
1587      *
1588      * The Uniscribe behavior is now documented in the newly published Sinhala
1589      * spec in 2012:
1590      *
1591      *   https://docs.microsoft.com/en-us/typography/script-development/sinhala#shaping
1592      */
1593
1594     const indic_shape_plan_t *indic_plan = (const indic_shape_plan_t *) c->plan->data;
1595
1596     hb_codepoint_t glyph;
1597
1598     if (hb_options ().uniscribe_bug_compatible ||
1599         (c->font->get_nominal_glyph (ab, &glyph) &&
1600          indic_plan->pstf.would_substitute (&glyph, 1, c->font->face)))
1601     {
1602       /* Ok, safe to use Uniscribe-style decomposition. */
1603       *a = 0x0DD9u;
1604       *b = ab;
1605       return true;
1606     }
1607   }
1608
1609   return (bool) c->unicode->decompose (ab, a, b);
1610 }
1611
1612 static bool
1613 compose_indic (const hb_ot_shape_normalize_context_t *c,
1614                hb_codepoint_t  a,
1615                hb_codepoint_t  b,
1616                hb_codepoint_t *ab)
1617 {
1618   /* Avoid recomposing split matras. */
1619   if (HB_UNICODE_GENERAL_CATEGORY_IS_MARK (c->unicode->general_category (a)))
1620     return false;
1621
1622   /* Composition-exclusion exceptions that we want to recompose. */
1623   if (a == 0x09AFu && b == 0x09BCu) { *ab = 0x09DFu; return true; }
1624
1625   return (bool) c->unicode->compose (a, b, ab);
1626 }
1627
1628
1629 const hb_ot_complex_shaper_t _hb_ot_complex_shaper_indic =
1630 {
1631   collect_features_indic,
1632   override_features_indic,
1633   data_create_indic,
1634   data_destroy_indic,
1635   preprocess_text_indic,
1636   nullptr, /* postprocess_glyphs */
1637   HB_OT_SHAPE_NORMALIZATION_MODE_COMPOSED_DIACRITICS_NO_SHORT_CIRCUIT,
1638   decompose_indic,
1639   compose_indic,
1640   setup_masks_indic,
1641   HB_TAG_NONE, /* gpos_tag */
1642   nullptr, /* reorder_marks */
1643   HB_OT_SHAPE_ZERO_WIDTH_MARKS_NONE,
1644   false, /* fallback_position */
1645 };