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 enum hb_ot_shape_zero_width_marks_type_t {
43 HB_OT_SHAPE_ZERO_WIDTH_MARKS_NONE,
44 HB_OT_SHAPE_ZERO_WIDTH_MARKS_BY_GDEF_EARLY,
45 HB_OT_SHAPE_ZERO_WIDTH_MARKS_BY_GDEF_LATE
49 /* Master OT shaper list */
50 #define HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS \
51 HB_COMPLEX_SHAPER_IMPLEMENT (default) /* should be first */ \
52 HB_COMPLEX_SHAPER_IMPLEMENT (arabic) \
53 HB_COMPLEX_SHAPER_IMPLEMENT (hangul) \
54 HB_COMPLEX_SHAPER_IMPLEMENT (hebrew) \
55 HB_COMPLEX_SHAPER_IMPLEMENT (myanmar_old) \
56 HB_COMPLEX_SHAPER_IMPLEMENT (indic) \
57 HB_COMPLEX_SHAPER_IMPLEMENT (myanmar) \
58 HB_COMPLEX_SHAPER_IMPLEMENT (thai) \
59 HB_COMPLEX_SHAPER_IMPLEMENT (tibetan) \
60 HB_COMPLEX_SHAPER_IMPLEMENT (use) \
61 /* ^--- Add new shapers here */
64 struct hb_ot_complex_shaper_t
69 * Called during shape_plan().
70 * Shapers should use plan->map to add their features and callbacks.
73 void (*collect_features) (hb_ot_shape_planner_t *plan);
75 /* override_features()
76 * Called during shape_plan().
77 * Shapers should use plan->map to override features and add callbacks after
78 * common features are added.
81 void (*override_features) (hb_ot_shape_planner_t *plan);
85 * Called at the end of shape_plan().
86 * Whatever shapers return will be accessible through plan->data later.
87 * If NULL is returned, means a plan failure.
89 void *(*data_create) (const hb_ot_shape_plan_t *plan);
92 * Called when the shape_plan is being destroyed.
93 * plan->data is passed here for destruction.
94 * If NULL is returned, means a plan failure.
97 void (*data_destroy) (void *data);
101 * Called during shape().
102 * Shapers can use to modify text before shaping starts.
105 void (*preprocess_text) (const hb_ot_shape_plan_t *plan,
109 /* postprocess_glyphs()
110 * Called during shape().
111 * Shapers can use to modify glyphs after shaping ends.
114 void (*postprocess_glyphs) (const hb_ot_shape_plan_t *plan,
119 hb_ot_shape_normalization_mode_t normalization_preference;
122 * Called during shape()'s normalization.
125 bool (*decompose) (const hb_ot_shape_normalize_context_t *c,
131 * Called during shape()'s normalization.
134 bool (*compose) (const hb_ot_shape_normalize_context_t *c,
140 * Called during shape().
141 * Shapers should use map to get feature masks and set on buffer.
142 * Shapers may NOT modify characters.
145 void (*setup_masks) (const hb_ot_shape_plan_t *plan,
150 * Called during shape().
151 * If set and returns true, GDEF/GSUB/GPOS of the font are ignored
152 * and fallback operations used.
155 bool (*disable_otl) (const hb_ot_shape_plan_t *plan);
157 hb_ot_shape_zero_width_marks_type_t zero_width_marks;
159 bool fallback_position;
162 #define HB_COMPLEX_SHAPER_IMPLEMENT(name) extern HB_INTERNAL const hb_ot_complex_shaper_t _hb_ot_complex_shaper_##name;
163 HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS
164 #undef HB_COMPLEX_SHAPER_IMPLEMENT
167 static inline const hb_ot_complex_shaper_t *
168 hb_ot_shape_complex_categorize (const hb_ot_shape_planner_t *planner)
170 switch ((hb_tag_t) planner->props.script)
173 return &_hb_ot_complex_shaper_default;
176 /* Unicode-1.1 additions */
177 case HB_SCRIPT_ARABIC:
179 /* Unicode-3.0 additions */
180 case HB_SCRIPT_MONGOLIAN:
181 case HB_SCRIPT_SYRIAC:
183 /* Unicode-5.0 additions */
185 case HB_SCRIPT_PHAGS_PA:
187 /* Unicode-6.0 additions */
188 case HB_SCRIPT_MANDAIC:
190 /* Unicode-7.0 additions */
191 case HB_SCRIPT_MANICHAEAN:
192 case HB_SCRIPT_PSALTER_PAHLAVI:
194 /* Unicode-9.0 additions */
195 case HB_SCRIPT_ADLAM:
197 /* For Arabic script, use the Arabic shaper even if no OT script tag was found.
198 * This is because we do fallback shaping for Arabic script (and not others).
199 * But note that Arabic shaping is applicable only to horizontal layout; for
200 * vertical text, just use the generic shaper instead. */
201 if ((planner->map.chosen_script[0] != HB_OT_TAG_DEFAULT_SCRIPT ||
202 planner->props.script == HB_SCRIPT_ARABIC) &&
203 HB_DIRECTION_IS_HORIZONTAL(planner->props.direction))
204 return &_hb_ot_complex_shaper_arabic;
206 return &_hb_ot_complex_shaper_default;
209 /* Unicode-1.1 additions */
213 return &_hb_ot_complex_shaper_thai;
216 /* Unicode-1.1 additions */
217 case HB_SCRIPT_HANGUL:
219 return &_hb_ot_complex_shaper_hangul;
222 /* Unicode-2.0 additions */
223 case HB_SCRIPT_TIBETAN:
225 return &_hb_ot_complex_shaper_tibetan;
228 /* Unicode-1.1 additions */
229 case HB_SCRIPT_HEBREW:
231 return &_hb_ot_complex_shaper_hebrew;
234 /* ^--- Add new shapers here */
237 /* Unicode-4.1 additions */
238 case HB_SCRIPT_NEW_TAI_LUE:
241 /* Unicode-1.1 additions */
242 case HB_SCRIPT_BENGALI:
243 case HB_SCRIPT_DEVANAGARI:
244 case HB_SCRIPT_GUJARATI:
245 case HB_SCRIPT_GURMUKHI:
246 case HB_SCRIPT_KANNADA:
247 case HB_SCRIPT_MALAYALAM:
248 case HB_SCRIPT_ORIYA:
249 case HB_SCRIPT_TAMIL:
250 case HB_SCRIPT_TELUGU:
252 /* Unicode-3.0 additions */
253 case HB_SCRIPT_SINHALA:
255 /* If the designer designed the font for the 'DFLT' script,
256 * use the default shaper. Otherwise, use the specific shaper.
257 * Note that for some simple scripts, there may not be *any*
258 * GSUB/GPOS needed, so there may be no scripts found! */
259 if (planner->map.chosen_script[0] == HB_TAG ('D','F','L','T'))
260 return &_hb_ot_complex_shaper_default;
262 return &_hb_ot_complex_shaper_indic;
264 case HB_SCRIPT_KHMER:
265 /* A number of Khmer fonts in the wild don't have a 'pref' feature,
266 * and as such won't shape properly via the Indic shaper;
267 * however, they typically have 'liga' / 'clig' features that implement
268 * the necessary "reordering" by means of ligature substitutions.
269 * So we send such pref-less fonts through the generic shaper instead. */
270 if (planner->map.found_script[0] &&
271 hb_ot_layout_language_find_feature (planner->face, HB_OT_TAG_GSUB,
272 planner->map.script_index[0],
273 planner->map.language_index[0],
274 HB_TAG ('p','r','e','f'),
276 return &_hb_ot_complex_shaper_indic;
278 return &_hb_ot_complex_shaper_default;
280 case HB_SCRIPT_MYANMAR:
281 if (planner->map.chosen_script[0] == HB_TAG ('m','y','m','2'))
282 return &_hb_ot_complex_shaper_myanmar;
283 else if (planner->map.chosen_script[0] == HB_TAG ('m','y','m','r'))
284 return &_hb_ot_complex_shaper_myanmar_old;
286 return &_hb_ot_complex_shaper_default;
289 /* Unicode-2.0 additions */
290 //case HB_SCRIPT_TIBETAN:
292 /* Unicode-3.0 additions */
293 //case HB_SCRIPT_MONGOLIAN:
294 //case HB_SCRIPT_SINHALA:
296 /* Unicode-3.2 additions */
297 case HB_SCRIPT_BUHID:
298 case HB_SCRIPT_HANUNOO:
299 case HB_SCRIPT_TAGALOG:
300 case HB_SCRIPT_TAGBANWA:
302 /* Unicode-4.0 additions */
303 case HB_SCRIPT_LIMBU:
304 case HB_SCRIPT_TAI_LE:
306 /* Unicode-4.1 additions */
307 case HB_SCRIPT_BUGINESE:
308 case HB_SCRIPT_KHAROSHTHI:
309 case HB_SCRIPT_SYLOTI_NAGRI:
310 case HB_SCRIPT_TIFINAGH:
312 /* Unicode-5.0 additions */
313 case HB_SCRIPT_BALINESE:
314 //case HB_SCRIPT_NKO:
315 //case HB_SCRIPT_PHAGS_PA:
317 /* Unicode-5.1 additions */
319 case HB_SCRIPT_KAYAH_LI:
320 case HB_SCRIPT_LEPCHA:
321 case HB_SCRIPT_REJANG:
322 case HB_SCRIPT_SAURASHTRA:
323 case HB_SCRIPT_SUNDANESE:
325 /* Unicode-5.2 additions */
326 case HB_SCRIPT_EGYPTIAN_HIEROGLYPHS:
327 case HB_SCRIPT_JAVANESE:
328 case HB_SCRIPT_KAITHI:
329 case HB_SCRIPT_MEETEI_MAYEK:
330 case HB_SCRIPT_TAI_THAM:
331 case HB_SCRIPT_TAI_VIET:
333 /* Unicode-6.0 additions */
334 case HB_SCRIPT_BATAK:
335 case HB_SCRIPT_BRAHMI:
336 //case HB_SCRIPT_MANDAIC:
338 /* Unicode-6.1 additions */
339 case HB_SCRIPT_CHAKMA:
340 case HB_SCRIPT_SHARADA:
341 case HB_SCRIPT_TAKRI:
343 /* Unicode-7.0 additions */
344 case HB_SCRIPT_DUPLOYAN:
345 case HB_SCRIPT_GRANTHA:
346 case HB_SCRIPT_KHOJKI:
347 case HB_SCRIPT_KHUDAWADI:
348 case HB_SCRIPT_MAHAJANI:
349 //case HB_SCRIPT_MANICHAEAN:
351 case HB_SCRIPT_PAHAWH_HMONG:
352 //case HB_SCRIPT_PSALTER_PAHLAVI:
353 case HB_SCRIPT_SIDDHAM:
354 case HB_SCRIPT_TIRHUTA:
356 /* Unicode-8.0 additions */
358 //case HB_SCRIPT_MULTANI:
360 /* Unicode-9.0 additions */
361 case HB_SCRIPT_BHAIKSUKI:
362 case HB_SCRIPT_MARCHEN:
365 /* If the designer designed the font for the 'DFLT' script,
366 * use the default shaper. Otherwise, use the specific shaper.
367 * Note that for some simple scripts, there may not be *any*
368 * GSUB/GPOS needed, so there may be no scripts found! */
369 if (planner->map.chosen_script[0] == HB_TAG ('D','F','L','T'))
370 return &_hb_ot_complex_shaper_default;
372 return &_hb_ot_complex_shaper_use;
377 #endif /* HB_OT_SHAPE_COMPLEX_PRIVATE_HH */