2 * Copyright (C) 1998-2004 David Turner and Werner Lemberg
3 * Copyright (C) 2006 Behdad Esfahbod
4 * Copyright (C) 2007,2008,2009 Red Hat, Inc.
6 * This is part of HarfBuzz, a text shaping library.
8 * Permission is hereby granted, without written agreement and without
9 * license or royalty fees, to use, copy, modify, and distribute this
10 * software and its documentation for any purpose, provided that the
11 * above copyright notice and the following two paragraphs appear in
12 * all copies of this software.
14 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
15 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
16 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
17 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
20 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
21 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
22 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
23 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
24 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
26 * Red Hat Author(s): Behdad Esfahbod
29 #define HB_OT_LAYOUT_CC
31 #include "hb-ot-layout-private.hh"
33 #include "hb-ot-layout-gdef-private.hh"
34 #include "hb-ot-layout-gsub-private.hh"
35 #include "hb-ot-layout-gpos-private.hh"
45 _hb_ot_layout_new (hb_face_t *face)
47 /* Remove this object altogether */
48 hb_ot_layout_t *layout = (hb_ot_layout_t *) calloc (1, sizeof (hb_ot_layout_t));
50 layout->gdef_blob = Sanitizer<GDEF>::sanitize (hb_face_get_table (face, HB_OT_TAG_GDEF));
51 layout->gdef = Sanitizer<GDEF>::lock_instance (layout->gdef_blob);
53 layout->gsub_blob = Sanitizer<GSUB>::sanitize (hb_face_get_table (face, HB_OT_TAG_GSUB));
54 layout->gsub = Sanitizer<GSUB>::lock_instance (layout->gsub_blob);
56 layout->gpos_blob = Sanitizer<GPOS>::sanitize (hb_face_get_table (face, HB_OT_TAG_GPOS));
57 layout->gpos = Sanitizer<GPOS>::lock_instance (layout->gpos_blob);
63 _hb_ot_layout_free (hb_ot_layout_t *layout)
65 hb_blob_unlock (layout->gdef_blob);
66 hb_blob_unlock (layout->gsub_blob);
67 hb_blob_unlock (layout->gpos_blob);
69 hb_blob_destroy (layout->gdef_blob);
70 hb_blob_destroy (layout->gsub_blob);
71 hb_blob_destroy (layout->gpos_blob);
76 static inline const GDEF&
77 _get_gdef (hb_face_t *face)
79 return likely (face->ot_layout && face->ot_layout->gdef) ? *face->ot_layout->gdef : Null(GDEF);
82 static inline const GSUB&
83 _get_gsub (hb_face_t *face)
85 return likely (face->ot_layout && face->ot_layout->gsub) ? *face->ot_layout->gsub : Null(GSUB);
88 static inline const GPOS&
89 _get_gpos (hb_face_t *face)
91 return likely (face->ot_layout && face->ot_layout->gpos) ? *face->ot_layout->gpos : Null(GPOS);
100 hb_ot_layout_has_glyph_classes (hb_face_t *face)
102 return _get_gdef (face).has_glyph_classes ();
106 _hb_ot_layout_get_glyph_property (hb_face_t *face,
107 hb_glyph_info_t *info)
109 if (!info->props_cache())
111 const GDEF &gdef = _get_gdef (face);
112 info->props_cache() = gdef.get_glyph_props (info->codepoint);
115 return info->props_cache();
119 _hb_ot_layout_match_properties (hb_face_t *face,
120 hb_codepoint_t codepoint,
121 unsigned int glyph_props,
122 unsigned int lookup_props)
124 /* Not covered, if, for example, glyph class is ligature and
125 * lookup_props includes LookupFlags::IgnoreLigatures
127 if (glyph_props & lookup_props & LookupFlag::IgnoreFlags)
130 if (glyph_props & HB_OT_LAYOUT_GLYPH_CLASS_MARK)
132 /* If using mark filtering sets, the high short of
133 * lookup_props has the set index.
135 if (lookup_props & LookupFlag::UseMarkFilteringSet)
136 return _get_gdef (face).mark_set_covers (lookup_props >> 16, codepoint);
138 /* The second byte of lookup_props has the meaning
139 * "ignore marks of attachment type different than
140 * the attachment type specified."
142 if (lookup_props & LookupFlag::MarkAttachmentType && glyph_props & LookupFlag::MarkAttachmentType)
143 return (lookup_props & LookupFlag::MarkAttachmentType) == (glyph_props & LookupFlag::MarkAttachmentType);
150 _hb_ot_layout_check_glyph_property (hb_face_t *face,
151 hb_glyph_info_t *ginfo,
152 unsigned int lookup_props,
153 unsigned int *property_out)
155 unsigned int property;
157 property = _hb_ot_layout_get_glyph_property (face, ginfo);
158 (void) (property_out && (*property_out = property));
160 return _hb_ot_layout_match_properties (face, ginfo->codepoint, property, lookup_props);
164 _hb_ot_layout_skip_mark (hb_face_t *face,
165 hb_glyph_info_t *ginfo,
166 unsigned int lookup_props,
167 unsigned int *property_out)
169 unsigned int property;
171 property = _hb_ot_layout_get_glyph_property (face, ginfo);
172 (void) (property_out && (*property_out = property));
174 /* If it's a mark, skip it we don't accept it. */
175 if (unlikely (property & HB_OT_LAYOUT_GLYPH_CLASS_MARK))
176 return !_hb_ot_layout_match_properties (face, ginfo->codepoint, property, lookup_props);
178 /* If not a mark, don't skip. */
185 hb_ot_layout_get_attach_points (hb_face_t *face,
186 hb_codepoint_t glyph,
187 unsigned int start_offset,
188 unsigned int *point_count /* IN/OUT */,
189 unsigned int *point_array /* OUT */)
191 return _get_gdef (face).get_attach_points (glyph, start_offset, point_count, point_array);
195 hb_ot_layout_get_ligature_carets (hb_font_t *font,
197 hb_direction_t direction,
198 hb_codepoint_t glyph,
199 unsigned int start_offset,
200 unsigned int *caret_count /* IN/OUT */,
201 int *caret_array /* OUT */)
203 hb_ot_layout_context_t c;
206 return _get_gdef (face).get_lig_carets (&c, direction, glyph, start_offset, caret_count, caret_array);
213 static const GSUBGPOS&
214 get_gsubgpos_table (hb_face_t *face,
218 case HB_OT_TAG_GSUB: return _get_gsub (face);
219 case HB_OT_TAG_GPOS: return _get_gpos (face);
220 default: return Null(GSUBGPOS);
226 hb_ot_layout_table_get_script_tags (hb_face_t *face,
228 unsigned int start_offset,
229 unsigned int *script_count /* IN/OUT */,
230 hb_tag_t *script_tags /* OUT */)
232 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
234 return g.get_script_tags (start_offset, script_count, script_tags);
238 hb_ot_layout_table_find_script (hb_face_t *face,
241 unsigned int *script_index)
243 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
244 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
246 if (g.find_script_index (script_tag, script_index))
249 /* try finding 'DFLT' */
250 if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
253 /* try with 'dflt'; MS site has had typos and many fonts use it now :(.
254 * including many versions of DejaVu Sans Mono! */
255 if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
258 if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
263 hb_ot_layout_table_choose_script (hb_face_t *face,
265 const hb_tag_t *script_tags,
266 unsigned int *script_index)
268 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
269 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
273 if (g.find_script_index (*script_tags, script_index))
278 /* try finding 'DFLT' */
279 if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
282 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
283 if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
286 if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
291 hb_ot_layout_table_get_feature_tags (hb_face_t *face,
293 unsigned int start_offset,
294 unsigned int *feature_count /* IN/OUT */,
295 hb_tag_t *feature_tags /* OUT */)
297 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
299 return g.get_feature_tags (start_offset, feature_count, feature_tags);
304 hb_ot_layout_script_get_language_tags (hb_face_t *face,
306 unsigned int script_index,
307 unsigned int start_offset,
308 unsigned int *language_count /* IN/OUT */,
309 hb_tag_t *language_tags /* OUT */)
311 const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
313 return s.get_lang_sys_tags (start_offset, language_count, language_tags);
317 hb_ot_layout_script_find_language (hb_face_t *face,
319 unsigned int script_index,
320 hb_tag_t language_tag,
321 unsigned int *language_index)
323 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX);
324 const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
326 if (s.find_lang_sys_index (language_tag, language_index))
329 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
330 if (s.find_lang_sys_index (HB_OT_TAG_DEFAULT_LANGUAGE, language_index))
333 if (language_index) *language_index = HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX;
338 hb_ot_layout_language_get_required_feature_index (hb_face_t *face,
340 unsigned int script_index,
341 unsigned int language_index,
342 unsigned int *feature_index)
344 const LangSys &l = get_gsubgpos_table (face, table_tag).get_script (script_index).get_lang_sys (language_index);
346 if (feature_index) *feature_index = l.get_required_feature_index ();
348 return l.has_required_feature ();
352 hb_ot_layout_language_get_feature_indexes (hb_face_t *face,
354 unsigned int script_index,
355 unsigned int language_index,
356 unsigned int start_offset,
357 unsigned int *feature_count /* IN/OUT */,
358 unsigned int *feature_indexes /* OUT */)
360 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
361 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
363 return l.get_feature_indexes (start_offset, feature_count, feature_indexes);
367 hb_ot_layout_language_get_feature_tags (hb_face_t *face,
369 unsigned int script_index,
370 unsigned int language_index,
371 unsigned int start_offset,
372 unsigned int *feature_count /* IN/OUT */,
373 hb_tag_t *feature_tags /* OUT */)
375 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
376 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
378 ASSERT_STATIC (sizeof (unsigned int) == sizeof (hb_tag_t));
379 unsigned int ret = l.get_feature_indexes (start_offset, feature_count, (unsigned int *) feature_tags);
382 unsigned int count = *feature_count;
383 for (unsigned int i = 0; i < count; i++)
384 feature_tags[i] = g.get_feature_tag ((unsigned int) feature_tags[i]);
392 hb_ot_layout_language_find_feature (hb_face_t *face,
394 unsigned int script_index,
395 unsigned int language_index,
396 hb_tag_t feature_tag,
397 unsigned int *feature_index)
399 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
400 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
401 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
403 unsigned int num_features = l.get_feature_count ();
404 for (unsigned int i = 0; i < num_features; i++) {
405 unsigned int f_index = l.get_feature_index (i);
407 if (feature_tag == g.get_feature_tag (f_index)) {
408 if (feature_index) *feature_index = f_index;
413 if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
418 hb_ot_layout_feature_get_lookup_indexes (hb_face_t *face,
420 unsigned int feature_index,
421 unsigned int start_offset,
422 unsigned int *lookup_count /* IN/OUT */,
423 unsigned int *lookup_indexes /* OUT */)
425 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
426 const Feature &f = g.get_feature (feature_index);
428 return f.get_lookup_indexes (start_offset, lookup_count, lookup_indexes);
437 hb_ot_layout_has_substitution (hb_face_t *face)
439 return &_get_gsub (face) != &Null(GSUB);
443 hb_ot_layout_substitute_lookup (hb_face_t *face,
445 unsigned int lookup_index,
448 hb_ot_layout_context_t c;
451 return _get_gsub (face).substitute_lookup (&c, buffer, lookup_index, mask);
460 hb_ot_layout_has_positioning (hb_face_t *face)
462 return &_get_gpos (face) != &Null(GPOS);
466 hb_ot_layout_position_lookup (hb_font_t *font,
469 unsigned int lookup_index,
472 hb_ot_layout_context_t c;
475 return _get_gpos (face).position_lookup (&c, buffer, lookup_index, mask);
479 hb_ot_layout_position_finish (hb_buffer_t *buffer)
481 GPOS::position_finish (buffer);