comparison mupdf-source/thirdparty/harfbuzz/src/hb-ot-shaper-indic.cc @ 2:b50eed0cc0ef upstream

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