2 * Copyright © 2010,2011 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-map-private.hh"
37 /* buffer var allocations, used by all shapers */
38 #define general_category() var1.u8[0] /* unicode general_category (hb_unicode_general_category_t) */
39 #define combining_class() var1.u8[1] /* unicode combining_class (uint8_t) */
42 #define HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS \
43 HB_COMPLEX_SHAPER_IMPLEMENT (default) /* should be first */ \
44 HB_COMPLEX_SHAPER_IMPLEMENT (arabic) \
45 HB_COMPLEX_SHAPER_IMPLEMENT (indic) \
46 /* ^--- Add new shapers here */
48 enum hb_ot_complex_shaper_t {
49 #define HB_COMPLEX_SHAPER_IMPLEMENT(name) hb_ot_complex_shaper_##name,
50 HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS
51 #undef HB_COMPLEX_SHAPER_IMPLEMENT
54 static inline hb_ot_complex_shaper_t
55 hb_ot_shape_complex_categorize (const hb_segment_properties_t *props)
57 switch ((int) props->script)
60 return hb_ot_complex_shaper_default;
62 case HB_SCRIPT_ARABIC:
63 case HB_SCRIPT_MANDAIC:
64 case HB_SCRIPT_MONGOLIAN:
66 case HB_SCRIPT_SYRIAC:
67 return hb_ot_complex_shaper_arabic;
69 /* TODO: These are all the scripts that the ucd/IndicSyllabicCategory.txt covers.
70 * Quite possibly many of these need no shaping, and some other are encoded visually.
71 * Needs to be refined.
73 case HB_SCRIPT_BALINESE:
75 case HB_SCRIPT_BENGALI:
76 case HB_SCRIPT_BRAHMI:
77 case HB_SCRIPT_BUGINESE:
80 case HB_SCRIPT_DEVANAGARI:
81 case HB_SCRIPT_GUJARATI:
82 case HB_SCRIPT_GURMUKHI:
83 case HB_SCRIPT_HANUNOO:
84 case HB_SCRIPT_JAVANESE:
85 case HB_SCRIPT_KAITHI:
86 case HB_SCRIPT_KANNADA:
87 case HB_SCRIPT_KAYAH_LI:
88 case HB_SCRIPT_KHAROSHTHI:
91 case HB_SCRIPT_LEPCHA:
93 case HB_SCRIPT_MALAYALAM:
94 case HB_SCRIPT_MEETEI_MAYEK:
95 case HB_SCRIPT_MYANMAR:
96 case HB_SCRIPT_NEW_TAI_LUE:
98 case HB_SCRIPT_PHAGS_PA:
99 case HB_SCRIPT_REJANG:
100 case HB_SCRIPT_SAURASHTRA:
101 case HB_SCRIPT_SINHALA:
102 case HB_SCRIPT_SUNDANESE:
103 case HB_SCRIPT_SYLOTI_NAGRI:
104 case HB_SCRIPT_TAGALOG:
105 case HB_SCRIPT_TAGBANWA:
106 case HB_SCRIPT_TAI_LE:
107 case HB_SCRIPT_TAI_THAM:
108 case HB_SCRIPT_TAI_VIET:
109 case HB_SCRIPT_TAMIL:
110 case HB_SCRIPT_TELUGU:
112 case HB_SCRIPT_TIBETAN:
113 return hb_ot_complex_shaper_indic;
115 /* ^--- Add new shapers here */
124 * Called during shape_plan().
126 * Shapers should use map to add their features and callbacks.
129 typedef void hb_ot_shape_complex_collect_features_func_t (hb_ot_map_builder_t *map, const hb_segment_properties_t *props);
130 #define HB_COMPLEX_SHAPER_IMPLEMENT(name) \
131 HB_INTERNAL hb_ot_shape_complex_collect_features_func_t _hb_ot_shape_complex_collect_features_##name;
132 HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS
133 #undef HB_COMPLEX_SHAPER_IMPLEMENT
136 hb_ot_shape_complex_collect_features (hb_ot_complex_shaper_t shaper,
137 hb_ot_map_builder_t *map,
138 const hb_segment_properties_t *props)
142 #define HB_COMPLEX_SHAPER_IMPLEMENT(name) \
143 case hb_ot_complex_shaper_##name: _hb_ot_shape_complex_collect_features_##name (map, props); return;
144 HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS
145 #undef HB_COMPLEX_SHAPER_IMPLEMENT
151 * prefer_decomposed()
153 * Called during shape_execute().
155 * Shapers should return TRUE if it prefers decomposed (NFD) input rather than precomposed (NFC).
158 typedef bool hb_ot_shape_complex_prefer_decomposed_func_t (void);
159 #define HB_COMPLEX_SHAPER_IMPLEMENT(name) \
160 HB_INTERNAL hb_ot_shape_complex_prefer_decomposed_func_t _hb_ot_shape_complex_prefer_decomposed_##name;
161 HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS
162 #undef HB_COMPLEX_SHAPER_IMPLEMENT
165 hb_ot_shape_complex_prefer_decomposed (hb_ot_complex_shaper_t shaper)
169 #define HB_COMPLEX_SHAPER_IMPLEMENT(name) \
170 case hb_ot_complex_shaper_##name: return _hb_ot_shape_complex_prefer_decomposed_##name ();
171 HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS
172 #undef HB_COMPLEX_SHAPER_IMPLEMENT
179 * Called during shape_execute().
181 * Shapers should use map to get feature masks and set on buffer.
184 typedef void hb_ot_shape_complex_setup_masks_func_t (hb_ot_map_t *map, hb_buffer_t *buffer);
185 #define HB_COMPLEX_SHAPER_IMPLEMENT(name) \
186 HB_INTERNAL hb_ot_shape_complex_setup_masks_func_t _hb_ot_shape_complex_setup_masks_##name;
187 HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS
188 #undef HB_COMPLEX_SHAPER_IMPLEMENT
191 hb_ot_shape_complex_setup_masks (hb_ot_complex_shaper_t shaper,
197 #define HB_COMPLEX_SHAPER_IMPLEMENT(name) \
198 case hb_ot_complex_shaper_##name: _hb_ot_shape_complex_setup_masks_##name (map, buffer); return;
199 HB_COMPLEX_SHAPERS_IMPLEMENT_SHAPERS
200 #undef HB_COMPLEX_SHAPER_IMPLEMENT
207 #endif /* HB_OT_SHAPE_COMPLEX_PRIVATE_HH */