2 * Copyright © 2010,2011,2012 Google, Inc.
4 * This is part of HarfBuzz, a text shaping library.
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.
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
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.
24 * Google Author(s): Behdad Esfahbod
27 #ifndef HB_OT_SHAPE_COMPLEX_PRIVATE_HH
28 #define HB_OT_SHAPE_COMPLEX_PRIVATE_HH
30 #include "hb-private.hh"
32 #include "hb-ot-shape-private.hh"
33 #include "hb-ot-shape-normalize-private.hh"
37 /* buffer var allocations, used by complex shapers */
38 #define complex_var_u8_0() var2.u8[2]
39 #define complex_var_u8_1() var2.u8[3]
42 #define HB_OT_SHAPE_COMPLEX_MAX_COMBINING_MARKS 32
44 enum hb_ot_shape_zero_width_marks_type_t {
45 HB_OT_SHAPE_ZERO_WIDTH_MARKS_NONE,
46 HB_OT_SHAPE_ZERO_WIDTH_MARKS_BY_GDEF_EARLY,
47 HB_OT_SHAPE_ZERO_WIDTH_MARKS_BY_GDEF_LATE
51 /* Master OT shaper list */
52 #define HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS \
53 HB_COMPLEX_SHAPER_IMPLEMENT (default) /* should be first */ \
54 HB_COMPLEX_SHAPER_IMPLEMENT (arabic) \
55 HB_COMPLEX_SHAPER_IMPLEMENT (hangul) \
56 HB_COMPLEX_SHAPER_IMPLEMENT (hebrew) \
57 HB_COMPLEX_SHAPER_IMPLEMENT (indic) \
58 HB_COMPLEX_SHAPER_IMPLEMENT (khmer) \
59 HB_COMPLEX_SHAPER_IMPLEMENT (myanmar) \
60 HB_COMPLEX_SHAPER_IMPLEMENT (myanmar_old) \
61 HB_COMPLEX_SHAPER_IMPLEMENT (thai) \
62 HB_COMPLEX_SHAPER_IMPLEMENT (tibetan) \
63 HB_COMPLEX_SHAPER_IMPLEMENT (use) \
64 /* ^--- Add new shapers here */
67 struct hb_ot_complex_shaper_t
70 * Called during shape_plan().
71 * Shapers should use plan->map to add their features and callbacks.
74 void (*collect_features) (hb_ot_shape_planner_t *plan);
76 /* override_features()
77 * Called during shape_plan().
78 * Shapers should use plan->map to override features and add callbacks after
79 * common features are added.
82 void (*override_features) (hb_ot_shape_planner_t *plan);
86 * Called at the end of shape_plan().
87 * Whatever shapers return will be accessible through plan->data later.
88 * If nullptr is returned, means a plan failure.
90 void *(*data_create) (const hb_ot_shape_plan_t *plan);
93 * Called when the shape_plan is being destroyed.
94 * plan->data is passed here for destruction.
95 * If nullptr is returned, means a plan failure.
98 void (*data_destroy) (void *data);
102 * Called during shape().
103 * Shapers can use to modify text before shaping starts.
106 void (*preprocess_text) (const hb_ot_shape_plan_t *plan,
110 /* postprocess_glyphs()
111 * Called during shape().
112 * Shapers can use to modify glyphs after shaping ends.
115 void (*postprocess_glyphs) (const hb_ot_shape_plan_t *plan,
120 hb_ot_shape_normalization_mode_t normalization_preference;
123 * Called during shape()'s normalization.
126 bool (*decompose) (const hb_ot_shape_normalize_context_t *c,
132 * Called during shape()'s normalization.
135 bool (*compose) (const hb_ot_shape_normalize_context_t *c,
141 * Called during shape().
142 * Shapers should use map to get feature masks and set on buffer.
143 * Shapers may NOT modify characters.
146 void (*setup_masks) (const hb_ot_shape_plan_t *plan,
151 * Called during shape().
152 * If set and returns true, GDEF/GSUB/GPOS of the font are ignored
153 * and fallback operations used.
156 bool (*disable_otl) (const hb_ot_shape_plan_t *plan);
159 * Called during shape().
160 * Shapers can use to modify ordering of combining marks.
163 void (*reorder_marks) (const hb_ot_shape_plan_t *plan,
168 hb_ot_shape_zero_width_marks_type_t zero_width_marks;
170 bool fallback_position;
173 #define HB_COMPLEX_SHAPER_IMPLEMENT(name) extern HB_INTERNAL const hb_ot_complex_shaper_t _hb_ot_complex_shaper_##name;
174 HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS
175 #undef HB_COMPLEX_SHAPER_IMPLEMENT
178 static inline const hb_ot_complex_shaper_t *
179 hb_ot_shape_complex_categorize (const hb_ot_shape_planner_t *planner)
181 switch ((hb_tag_t) planner->props.script)
184 return &_hb_ot_complex_shaper_default;
187 /* Unicode-1.1 additions */
188 case HB_SCRIPT_ARABIC:
190 /* Unicode-3.0 additions */
191 case HB_SCRIPT_MONGOLIAN:
192 case HB_SCRIPT_SYRIAC:
194 /* Unicode-5.0 additions */
196 case HB_SCRIPT_PHAGS_PA:
198 /* Unicode-6.0 additions */
199 case HB_SCRIPT_MANDAIC:
201 /* Unicode-7.0 additions */
202 case HB_SCRIPT_MANICHAEAN:
203 case HB_SCRIPT_PSALTER_PAHLAVI:
205 /* Unicode-9.0 additions */
206 case HB_SCRIPT_ADLAM:
208 /* For Arabic script, use the Arabic shaper even if no OT script tag was found.
209 * This is because we do fallback shaping for Arabic script (and not others).
210 * But note that Arabic shaping is applicable only to horizontal layout; for
211 * vertical text, just use the generic shaper instead. */
212 if ((planner->map.chosen_script[0] != HB_OT_TAG_DEFAULT_SCRIPT ||
213 planner->props.script == HB_SCRIPT_ARABIC) &&
214 HB_DIRECTION_IS_HORIZONTAL(planner->props.direction))
215 return &_hb_ot_complex_shaper_arabic;
217 return &_hb_ot_complex_shaper_default;
220 /* Unicode-1.1 additions */
224 return &_hb_ot_complex_shaper_thai;
227 /* Unicode-1.1 additions */
228 case HB_SCRIPT_HANGUL:
230 return &_hb_ot_complex_shaper_hangul;
233 /* Unicode-2.0 additions */
234 case HB_SCRIPT_TIBETAN:
236 return &_hb_ot_complex_shaper_tibetan;
239 /* Unicode-1.1 additions */
240 case HB_SCRIPT_HEBREW:
242 return &_hb_ot_complex_shaper_hebrew;
245 /* ^--- Add new shapers here */
248 /* Unicode-4.1 additions */
249 case HB_SCRIPT_NEW_TAI_LUE:
252 /* Unicode-1.1 additions */
253 case HB_SCRIPT_BENGALI:
254 case HB_SCRIPT_DEVANAGARI:
255 case HB_SCRIPT_GUJARATI:
256 case HB_SCRIPT_GURMUKHI:
257 case HB_SCRIPT_KANNADA:
258 case HB_SCRIPT_MALAYALAM:
259 case HB_SCRIPT_ORIYA:
260 case HB_SCRIPT_TAMIL:
261 case HB_SCRIPT_TELUGU:
263 /* Unicode-3.0 additions */
264 case HB_SCRIPT_SINHALA:
266 /* If the designer designed the font for the 'DFLT' script,
267 * (or we ended up arbitrarily pick 'latn'), use the default shaper.
268 * Otherwise, use the specific shaper.
269 * Note that for some simple scripts, there may not be *any*
270 * GSUB/GPOS needed, so there may be no scripts found! */
271 if (planner->map.chosen_script[0] == HB_TAG ('D','F','L','T') ||
272 planner->map.chosen_script[0] == HB_TAG ('l','a','t','n'))
273 return &_hb_ot_complex_shaper_default;
275 return &_hb_ot_complex_shaper_indic;
277 case HB_SCRIPT_KHMER:
278 /* A number of Khmer fonts in the wild don't have a 'pref' feature,
279 * and as such won't shape properly via the Indic shaper;
280 * however, they typically have 'liga' / 'clig' features that implement
281 * the necessary "reordering" by means of ligature substitutions.
282 * So we send such pref-less fonts through the generic shaper instead. */
283 if (planner->map.found_script[0] &&
284 hb_ot_layout_language_find_feature (planner->face, HB_OT_TAG_GSUB,
285 planner->map.script_index[0],
286 planner->map.language_index[0],
287 HB_TAG ('p','r','e','f'),
289 return &_hb_ot_complex_shaper_khmer;
291 return &_hb_ot_complex_shaper_default;
293 case HB_SCRIPT_MYANMAR:
294 if (planner->map.chosen_script[0] == HB_TAG ('m','y','m','2'))
295 return &_hb_ot_complex_shaper_myanmar;
296 else if (planner->map.chosen_script[0] == HB_TAG ('m','y','m','r'))
297 return &_hb_ot_complex_shaper_myanmar_old;
299 return &_hb_ot_complex_shaper_default;
302 /* Unicode-2.0 additions */
303 //case HB_SCRIPT_TIBETAN:
305 /* Unicode-3.0 additions */
306 //case HB_SCRIPT_MONGOLIAN:
307 //case HB_SCRIPT_SINHALA:
309 /* Unicode-3.2 additions */
310 case HB_SCRIPT_BUHID:
311 case HB_SCRIPT_HANUNOO:
312 case HB_SCRIPT_TAGALOG:
313 case HB_SCRIPT_TAGBANWA:
315 /* Unicode-4.0 additions */
316 case HB_SCRIPT_LIMBU:
317 case HB_SCRIPT_TAI_LE:
319 /* Unicode-4.1 additions */
320 case HB_SCRIPT_BUGINESE:
321 case HB_SCRIPT_KHAROSHTHI:
322 case HB_SCRIPT_SYLOTI_NAGRI:
323 case HB_SCRIPT_TIFINAGH:
325 /* Unicode-5.0 additions */
326 case HB_SCRIPT_BALINESE:
327 //case HB_SCRIPT_NKO:
328 //case HB_SCRIPT_PHAGS_PA:
330 /* Unicode-5.1 additions */
332 case HB_SCRIPT_KAYAH_LI:
333 case HB_SCRIPT_LEPCHA:
334 case HB_SCRIPT_REJANG:
335 case HB_SCRIPT_SAURASHTRA:
336 case HB_SCRIPT_SUNDANESE:
338 /* Unicode-5.2 additions */
339 case HB_SCRIPT_EGYPTIAN_HIEROGLYPHS:
340 case HB_SCRIPT_JAVANESE:
341 case HB_SCRIPT_KAITHI:
342 case HB_SCRIPT_MEETEI_MAYEK:
343 case HB_SCRIPT_TAI_THAM:
344 case HB_SCRIPT_TAI_VIET:
346 /* Unicode-6.0 additions */
347 case HB_SCRIPT_BATAK:
348 case HB_SCRIPT_BRAHMI:
349 //case HB_SCRIPT_MANDAIC:
351 /* Unicode-6.1 additions */
352 case HB_SCRIPT_CHAKMA:
353 case HB_SCRIPT_SHARADA:
354 case HB_SCRIPT_TAKRI:
356 /* Unicode-7.0 additions */
357 case HB_SCRIPT_DUPLOYAN:
358 case HB_SCRIPT_GRANTHA:
359 case HB_SCRIPT_KHOJKI:
360 case HB_SCRIPT_KHUDAWADI:
361 case HB_SCRIPT_MAHAJANI:
362 //case HB_SCRIPT_MANICHAEAN:
364 case HB_SCRIPT_PAHAWH_HMONG:
365 //case HB_SCRIPT_PSALTER_PAHLAVI:
366 case HB_SCRIPT_SIDDHAM:
367 case HB_SCRIPT_TIRHUTA:
369 /* Unicode-8.0 additions */
371 //case HB_SCRIPT_MULTANI:
373 /* Unicode-9.0 additions */
374 case HB_SCRIPT_BHAIKSUKI:
375 case HB_SCRIPT_MARCHEN:
378 /* Unicode-10.0 additions */
379 case HB_SCRIPT_MASARAM_GONDI:
380 case HB_SCRIPT_SOYOMBO:
381 case HB_SCRIPT_ZANABAZAR_SQUARE:
383 /* If the designer designed the font for the 'DFLT' script,
384 * (or we ended up arbitrarily pick 'latn'), use the default shaper.
385 * Otherwise, use the specific shaper.
386 * Note that for some simple scripts, there may not be *any*
387 * GSUB/GPOS needed, so there may be no scripts found! */
388 if (planner->map.chosen_script[0] == HB_TAG ('D','F','L','T') ||
389 planner->map.chosen_script[0] == HB_TAG ('l','a','t','n'))
390 return &_hb_ot_complex_shaper_default;
392 return &_hb_ot_complex_shaper_use;
397 #endif /* HB_OT_SHAPE_COMPLEX_PRIVATE_HH */