1 /*
2 * Copyright © 2010,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 #ifndef HB_OT_SHAPE_COMPLEX_PRIVATE_HH
28 #define HB_OT_SHAPE_COMPLEX_PRIVATE_HH
29
30 #include "hb-private.hh"
31
32 #include "hb-ot-shape-private.hh"
33 #include "hb-ot-shape-normalize-private.hh"
34
35
36
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]
40
41
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
46 };
47
48
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 */
62
63
64 struct hb_ot_complex_shaper_t
65 {
66 char name[8];
67
68 /* collect_features()
69 * Called during shape_plan().
70 * Shapers should use plan->map to add their features and callbacks.
71 * May be NULL.
72 */
73 void (*collect_features) (hb_ot_shape_planner_t *plan);
74
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.
79 * May be NULL.
80 */
81 void (*override_features) (hb_ot_shape_planner_t *plan);
82
83
84 /* data_create()
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.
88 */
89 void *(*data_create) (const hb_ot_shape_plan_t *plan);
90
91 /* data_destroy()
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.
95 * May be NULL.
96 */
97 void (*data_destroy) (void *data);
98
99
100 /* preprocess_text()
101 * Called during shape().
102 * Shapers can use to modify text before shaping starts.
103 * May be NULL.
104 */
105 void (*preprocess_text) (const hb_ot_shape_plan_t *plan,
106 hb_buffer_t *buffer,
107 hb_font_t *font);
108
109 /* postprocess_glyphs()
110 * Called during shape().
111 * Shapers can use to modify glyphs after shaping ends.
112 * May be NULL.
113 */
114 void (*postprocess_glyphs) (const hb_ot_shape_plan_t *plan,
115 hb_buffer_t *buffer,
116 hb_font_t *font);
117
118
119 hb_ot_shape_normalization_mode_t normalization_preference;
120
121 /* decompose()
122 * Called during shape()'s normalization.
123 * May be NULL.
124 */
125 bool (*decompose) (const hb_ot_shape_normalize_context_t *c,
126 hb_codepoint_t ab,
127 hb_codepoint_t *a,
128 hb_codepoint_t *b);
129
130 /* compose()
131 * Called during shape()'s normalization.
132 * May be NULL.
133 */
134 bool (*compose) (const hb_ot_shape_normalize_context_t *c,
135 hb_codepoint_t a,
136 hb_codepoint_t b,
137 hb_codepoint_t *ab);
138
139 /* setup_masks()
140 * Called during shape().
141 * Shapers should use map to get feature masks and set on buffer.
142 * Shapers may NOT modify characters.
143 * May be NULL.
144 */
145 void (*setup_masks) (const hb_ot_shape_plan_t *plan,
146 hb_buffer_t *buffer,
147 hb_font_t *font);
148
149 hb_ot_shape_zero_width_marks_type_t zero_width_marks;
150
151 bool fallback_position;
152 };
153
154 #define HB_COMPLEX_SHAPER_IMPLEMENT(name) extern HB_INTERNAL const hb_ot_complex_shaper_t _hb_ot_complex_shaper_##name;
155 HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS
156 #undef HB_COMPLEX_SHAPER_IMPLEMENT
157
158
159 static inline const hb_ot_complex_shaper_t *
160 hb_ot_shape_complex_categorize (const hb_ot_shape_planner_t *planner)
161 {
162 switch ((hb_tag_t) planner->props.script)
163 {
164 default:
165 return &_hb_ot_complex_shaper_default;
166
167
168 /* Unicode-1.1 additions */
169 case HB_SCRIPT_ARABIC:
170
171 /* Unicode-3.0 additions */
172 case HB_SCRIPT_MONGOLIAN:
173 case HB_SCRIPT_SYRIAC:
174
175 /* Unicode-5.0 additions */
176 case HB_SCRIPT_NKO:
177 case HB_SCRIPT_PHAGS_PA:
178
179 /* Unicode-6.0 additions */
180 case HB_SCRIPT_MANDAIC:
181
182 /* Unicode-7.0 additions */
183 case HB_SCRIPT_MANICHAEAN:
184 case HB_SCRIPT_PSALTER_PAHLAVI:
185
186 /* For Arabic script, use the Arabic shaper even if no OT script tag was found.
187 * This is because we do fallback shaping for Arabic script (and not others).
188 * But note that Arabic shaping is applicable only to horizontal layout; for
189 * vertical text, just use the generic shaper instead. */
190 if ((planner->map.chosen_script[0] != HB_OT_TAG_DEFAULT_SCRIPT ||
191 planner->props.script == HB_SCRIPT_ARABIC) &&
192 HB_DIRECTION_IS_HORIZONTAL(planner->props.direction))
193 return &_hb_ot_complex_shaper_arabic;
194 else
195 return &_hb_ot_complex_shaper_default;
196
197
198 /* Unicode-1.1 additions */
199 case HB_SCRIPT_THAI:
200 case HB_SCRIPT_LAO:
201
202 return &_hb_ot_complex_shaper_thai;
203
204
205 /* Unicode-1.1 additions */
206 case HB_SCRIPT_HANGUL:
207
208 return &_hb_ot_complex_shaper_hangul;
209
210
211 /* Unicode-2.0 additions */
212 case HB_SCRIPT_TIBETAN:
213
214 return &_hb_ot_complex_shaper_tibetan;
215
216
217 /* Unicode-1.1 additions */
218 case HB_SCRIPT_HEBREW:
219
220 return &_hb_ot_complex_shaper_hebrew;
221
222
223 /* ^--- Add new shapers here */
224
225 #if 0
226 /* Unicode-4.1 additions */
227 case HB_SCRIPT_NEW_TAI_LUE:
228 #endif
229
230 /* Unicode-1.1 additions */
231 case HB_SCRIPT_BENGALI:
232 case HB_SCRIPT_DEVANAGARI:
233 case HB_SCRIPT_GUJARATI:
234 case HB_SCRIPT_GURMUKHI:
235 case HB_SCRIPT_KANNADA:
236 case HB_SCRIPT_MALAYALAM:
237 case HB_SCRIPT_ORIYA:
238 case HB_SCRIPT_TAMIL:
239 case HB_SCRIPT_TELUGU:
240
241 /* Unicode-3.0 additions */
242 case HB_SCRIPT_SINHALA:
243
244 /* If the designer designed the font for the 'DFLT' script,
245 * use the default shaper. Otherwise, use the specific shaper.
246 * Note that for some simple scripts, there may not be *any*
247 * GSUB/GPOS needed, so there may be no scripts found! */
248 if (planner->map.chosen_script[0] == HB_TAG ('D','F','L','T'))
249 return &_hb_ot_complex_shaper_default;
250 else
251 return &_hb_ot_complex_shaper_indic;
252
253 case HB_SCRIPT_KHMER:
254 /* A number of Khmer fonts in the wild don't have a 'pref' feature,
255 * and as such won't shape properly via the Indic shaper;
256 * however, they typically have 'liga' / 'clig' features that implement
257 * the necessary "reordering" by means of ligature substitutions.
258 * So we send such pref-less fonts through the generic shaper instead. */
259 if (planner->map.found_script[0] &&
260 hb_ot_layout_language_find_feature (planner->face, HB_OT_TAG_GSUB,
261 planner->map.script_index[0],
262 planner->map.language_index[0],
263 HB_TAG ('p','r','e','f'),
264 NULL))
265 return &_hb_ot_complex_shaper_indic;
266 else
267 return &_hb_ot_complex_shaper_default;
268
269 case HB_SCRIPT_MYANMAR:
270 if (planner->map.chosen_script[0] == HB_TAG ('m','y','m','2'))
271 return &_hb_ot_complex_shaper_myanmar;
272 else if (planner->map.chosen_script[0] == HB_TAG ('m','y','m','r'))
273 return &_hb_ot_complex_shaper_myanmar_old;
274 else
275 return &_hb_ot_complex_shaper_default;
276
277
278 /* Unicode-2.0 additions */
279 //case HB_SCRIPT_TIBETAN:
280
281 /* Unicode-3.0 additions */
282 //case HB_SCRIPT_MONGOLIAN:
283 //case HB_SCRIPT_SINHALA:
284
285 /* Unicode-3.2 additions */
286 case HB_SCRIPT_BUHID:
287 case HB_SCRIPT_HANUNOO:
288 case HB_SCRIPT_TAGALOG:
289 case HB_SCRIPT_TAGBANWA:
290
291 /* Unicode-4.0 additions */
292 case HB_SCRIPT_LIMBU:
293 case HB_SCRIPT_TAI_LE:
294
295 /* Unicode-4.1 additions */
296 case HB_SCRIPT_BUGINESE:
297 case HB_SCRIPT_KHAROSHTHI:
298 case HB_SCRIPT_SYLOTI_NAGRI:
299 case HB_SCRIPT_TIFINAGH:
300
301 /* Unicode-5.0 additions */
302 case HB_SCRIPT_BALINESE:
303 //case HB_SCRIPT_NKO:
304 //case HB_SCRIPT_PHAGS_PA:
305
306 /* Unicode-5.1 additions */
307 case HB_SCRIPT_CHAM:
308 case HB_SCRIPT_KAYAH_LI:
309 case HB_SCRIPT_LEPCHA:
310 case HB_SCRIPT_REJANG:
311 case HB_SCRIPT_SAURASHTRA:
312 case HB_SCRIPT_SUNDANESE:
313
314 /* Unicode-5.2 additions */
315 case HB_SCRIPT_EGYPTIAN_HIEROGLYPHS:
316 case HB_SCRIPT_JAVANESE:
317 case HB_SCRIPT_KAITHI:
318 case HB_SCRIPT_MEETEI_MAYEK:
319 case HB_SCRIPT_TAI_THAM:
320 case HB_SCRIPT_TAI_VIET:
321
322 /* Unicode-6.0 additions */
323 case HB_SCRIPT_BATAK:
324 case HB_SCRIPT_BRAHMI:
325 //case HB_SCRIPT_MANDAIC:
326
327 /* Unicode-6.1 additions */
328 case HB_SCRIPT_CHAKMA:
329 case HB_SCRIPT_SHARADA:
330 case HB_SCRIPT_TAKRI:
331
332 /* Unicode-7.0 additions */
333 case HB_SCRIPT_DUPLOYAN:
334 case HB_SCRIPT_GRANTHA:
335 case HB_SCRIPT_KHOJKI:
336 case HB_SCRIPT_KHUDAWADI:
337 case HB_SCRIPT_MAHAJANI:
338 //case HB_SCRIPT_MANICHAEAN:
339 case HB_SCRIPT_MODI:
340 case HB_SCRIPT_PAHAWH_HMONG:
341 //case HB_SCRIPT_PSALTER_PAHLAVI:
342 case HB_SCRIPT_SIDDHAM:
343 case HB_SCRIPT_TIRHUTA:
344
345 /* Unicode-8.0 additions */
346 case HB_SCRIPT_AHOM:
347 //case HB_SCRIPT_MULTANI:
348
349 /* Unicode-9.0 additions */
350 case HB_SCRIPT_BHAIKSUKI:
351 case HB_SCRIPT_MARCHEN:
352 case HB_SCRIPT_NEWA:
353
354 /* If the designer designed the font for the 'DFLT' script,
355 * use the default shaper. Otherwise, use the specific shaper.
356 * Note that for some simple scripts, there may not be *any*
357 * GSUB/GPOS needed, so there may be no scripts found! */
358 if (planner->map.chosen_script[0] == HB_TAG ('D','F','L','T'))
359 return &_hb_ot_complex_shaper_default;
360 else
361 return &_hb_ot_complex_shaper_use;
362 }
363 }
364
365
366 #endif /* HB_OT_SHAPE_COMPLEX_PRIVATE_HH */