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);
77 _get_gdef (hb_face_t *face)
79 return likely (face->ot_layout && face->ot_layout->gdef) ? *face->ot_layout->gdef : Null(GDEF);
83 _get_gsub (hb_face_t *face)
85 return likely (face->ot_layout && face->ot_layout->gsub) ? *face->ot_layout->gsub : Null(GSUB);
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_from_gdef (hb_face_t *face,
107 hb_glyph_info_t *info)
109 hb_codepoint_t glyph = info->codepoint;
112 const GDEF &gdef = _get_gdef (face);
114 klass = gdef.get_glyph_class (glyph);
118 case GDEF::UnclassifiedGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED;
119 case GDEF::BaseGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH;
120 case GDEF::LigatureGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE;
121 case GDEF::ComponentGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT;
122 case GDEF::MarkGlyph:
123 klass = gdef.get_mark_attachment_type (glyph);
124 return HB_OT_LAYOUT_GLYPH_CLASS_MARK | (klass << 8);
128 static inline unsigned int
129 _hb_ot_layout_get_glyph_property (hb_face_t *face,
130 hb_glyph_info_t *info)
132 if (!info->gproperty())
133 info->gproperty() = _hb_ot_layout_get_glyph_property_from_gdef (face, info);
135 return info->gproperty();
139 _hb_ot_layout_check_glyph_property (hb_face_t *face,
140 hb_glyph_info_t *ginfo,
141 unsigned int lookup_props,
142 unsigned int *property_out)
144 unsigned int property;
146 property = _hb_ot_layout_get_glyph_property (face, ginfo);
148 *property_out = property;
150 /* Not covered, if, for example, glyph class is ligature and
151 * lookup_props includes LookupFlags::IgnoreLigatures
153 if (property & lookup_props & LookupFlag::IgnoreFlags)
156 if (property & HB_OT_LAYOUT_GLYPH_CLASS_MARK)
158 /* If using mark filtering sets, the high short of
159 * lookup_props has the set index.
161 if (lookup_props & LookupFlag::UseMarkFilteringSet)
162 return _get_gdef (face).mark_set_covers (lookup_props >> 16, ginfo->codepoint);
164 /* The second byte of lookup_props has the meaning
165 * "ignore marks of attachment type different than
166 * the attachment type specified."
168 if (lookup_props & LookupFlag::MarkAttachmentType && property & LookupFlag::MarkAttachmentType)
169 return (lookup_props & LookupFlag::MarkAttachmentType) == (property & LookupFlag::MarkAttachmentType);
176 _hb_ot_layout_skip_mark (hb_face_t *face,
177 hb_glyph_info_t *ginfo,
178 unsigned int lookup_props,
179 unsigned int *property_out)
181 unsigned int property;
183 property = _hb_ot_layout_get_glyph_property (face, ginfo);
185 *property_out = property;
187 if (property & HB_OT_LAYOUT_GLYPH_CLASS_MARK)
189 /* Skip mark if lookup_props includes LookupFlags::IgnoreMarks */
190 if (lookup_props & LookupFlag::IgnoreMarks)
193 /* If using mark filtering sets, the high short of lookup_props has the set index. */
194 if (lookup_props & LookupFlag::UseMarkFilteringSet)
195 return !_get_gdef (face).mark_set_covers (lookup_props >> 16, ginfo->codepoint);
197 /* The second byte of lookup_props has the meaning "ignore marks of attachment type
198 * different than the attachment type specified." */
199 if (lookup_props & LookupFlag::MarkAttachmentType && property & LookupFlag::MarkAttachmentType)
200 return (lookup_props & LookupFlag::MarkAttachmentType) != (property & LookupFlag::MarkAttachmentType);
207 hb_ot_layout_get_attach_points (hb_face_t *face,
208 hb_codepoint_t glyph,
209 unsigned int start_offset,
210 unsigned int *point_count /* IN/OUT */,
211 unsigned int *point_array /* OUT */)
213 return _get_gdef (face).get_attach_points (glyph, start_offset, point_count, point_array);
217 hb_ot_layout_get_ligature_carets (hb_font_t *font,
219 hb_direction_t direction,
220 hb_codepoint_t glyph,
221 unsigned int start_offset,
222 unsigned int *caret_count /* IN/OUT */,
223 int *caret_array /* OUT */)
225 hb_ot_layout_context_t c;
228 return _get_gdef (face).get_lig_carets (&c, direction, glyph, start_offset, caret_count, caret_array);
235 static const GSUBGPOS&
236 get_gsubgpos_table (hb_face_t *face,
240 case HB_OT_TAG_GSUB: return _get_gsub (face);
241 case HB_OT_TAG_GPOS: return _get_gpos (face);
242 default: return Null(GSUBGPOS);
248 hb_ot_layout_table_get_script_tags (hb_face_t *face,
250 unsigned int start_offset,
251 unsigned int *script_count /* IN/OUT */,
252 hb_tag_t *script_tags /* OUT */)
254 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
256 return g.get_script_tags (start_offset, script_count, script_tags);
260 hb_ot_layout_table_find_script (hb_face_t *face,
263 unsigned int *script_index)
265 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
266 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
268 if (g.find_script_index (script_tag, script_index))
271 /* try finding 'DFLT' */
272 if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
275 /* try with 'dflt'; MS site has had typos and many fonts use it now :(.
276 * including many versions of DejaVu Sans Mono! */
277 if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
280 if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
285 hb_ot_layout_table_choose_script (hb_face_t *face,
287 const hb_tag_t *script_tags,
288 unsigned int *script_index)
290 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
291 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
295 if (g.find_script_index (*script_tags, script_index))
300 /* try finding 'DFLT' */
301 if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
304 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
305 if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
308 if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
313 hb_ot_layout_table_get_feature_tags (hb_face_t *face,
315 unsigned int start_offset,
316 unsigned int *feature_count /* IN/OUT */,
317 hb_tag_t *feature_tags /* OUT */)
319 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
321 return g.get_feature_tags (start_offset, feature_count, feature_tags);
326 hb_ot_layout_script_get_language_tags (hb_face_t *face,
328 unsigned int script_index,
329 unsigned int start_offset,
330 unsigned int *language_count /* IN/OUT */,
331 hb_tag_t *language_tags /* OUT */)
333 const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
335 return s.get_lang_sys_tags (start_offset, language_count, language_tags);
339 hb_ot_layout_script_find_language (hb_face_t *face,
341 unsigned int script_index,
342 hb_tag_t language_tag,
343 unsigned int *language_index)
345 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX);
346 const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
348 if (s.find_lang_sys_index (language_tag, language_index))
351 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
352 if (s.find_lang_sys_index (HB_OT_TAG_DEFAULT_LANGUAGE, language_index))
355 if (language_index) *language_index = HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX;
360 hb_ot_layout_language_get_required_feature_index (hb_face_t *face,
362 unsigned int script_index,
363 unsigned int language_index,
364 unsigned int *feature_index)
366 const LangSys &l = get_gsubgpos_table (face, table_tag).get_script (script_index).get_lang_sys (language_index);
368 if (feature_index) *feature_index = l.get_required_feature_index ();
370 return l.has_required_feature ();
374 hb_ot_layout_language_get_feature_indexes (hb_face_t *face,
376 unsigned int script_index,
377 unsigned int language_index,
378 unsigned int start_offset,
379 unsigned int *feature_count /* IN/OUT */,
380 unsigned int *feature_indexes /* OUT */)
382 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
383 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
385 return l.get_feature_indexes (start_offset, feature_count, feature_indexes);
389 hb_ot_layout_language_get_feature_tags (hb_face_t *face,
391 unsigned int script_index,
392 unsigned int language_index,
393 unsigned int start_offset,
394 unsigned int *feature_count /* IN/OUT */,
395 hb_tag_t *feature_tags /* OUT */)
397 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
398 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
400 ASSERT_STATIC (sizeof (unsigned int) == sizeof (hb_tag_t));
401 unsigned int ret = l.get_feature_indexes (start_offset, feature_count, (unsigned int *) feature_tags);
404 unsigned int count = *feature_count;
405 for (unsigned int i = 0; i < count; i++)
406 feature_tags[i] = g.get_feature_tag ((unsigned int) feature_tags[i]);
414 hb_ot_layout_language_find_feature (hb_face_t *face,
416 unsigned int script_index,
417 unsigned int language_index,
418 hb_tag_t feature_tag,
419 unsigned int *feature_index)
421 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
422 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
423 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
425 unsigned int num_features = l.get_feature_count ();
426 for (unsigned int i = 0; i < num_features; i++) {
427 unsigned int f_index = l.get_feature_index (i);
429 if (feature_tag == g.get_feature_tag (f_index)) {
430 if (feature_index) *feature_index = f_index;
435 if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
440 hb_ot_layout_feature_get_lookup_indexes (hb_face_t *face,
442 unsigned int feature_index,
443 unsigned int start_offset,
444 unsigned int *lookup_count /* IN/OUT */,
445 unsigned int *lookup_indexes /* OUT */)
447 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
448 const Feature &f = g.get_feature (feature_index);
450 return f.get_lookup_indexes (start_offset, lookup_count, lookup_indexes);
459 hb_ot_layout_has_substitution (hb_face_t *face)
461 return &_get_gsub (face) != &Null(GSUB);
465 hb_ot_layout_substitute_lookup (hb_face_t *face,
467 unsigned int lookup_index,
470 hb_ot_layout_context_t c;
473 return _get_gsub (face).substitute_lookup (&c, buffer, lookup_index, mask);
482 hb_ot_layout_has_positioning (hb_face_t *face)
484 return &_get_gpos (face) != &Null(GPOS);
488 hb_ot_layout_position_lookup (hb_font_t *font,
491 unsigned int lookup_index,
494 hb_ot_layout_context_t c;
497 return _get_gpos (face).position_lookup (&c, buffer, lookup_index, mask);
501 hb_ot_layout_position_finish (hb_font_t *font HB_UNUSED,
502 hb_face_t *face HB_UNUSED,
506 unsigned int len = hb_buffer_get_length (buffer);
507 hb_glyph_position_t *pos = hb_buffer_get_glyph_positions (buffer);
508 hb_direction_t direction = buffer->props.direction;
512 /* Handle cursive connections:
513 * First handle all chain-back connections, then handle all chain-forward connections. */
514 if (likely (HB_DIRECTION_IS_HORIZONTAL (direction)))
516 for (j = 0; j < len; j++) {
517 if (pos[j].cursive_chain() < 0)
518 pos[j].y_offset += pos[j + pos[j].cursive_chain()].y_offset;
520 for (i = len; i > 0; i--) {
522 if (pos[j].cursive_chain() > 0)
523 pos[j].y_offset += pos[j + pos[j].cursive_chain()].y_offset;
528 for (j = 0; j < len; j++) {
529 if (pos[j].cursive_chain() < 0)
530 pos[j].x_offset += pos[j + pos[j].cursive_chain()].x_offset;
532 for (i = len; i > 0; i--) {
534 if (pos[j].cursive_chain() > 0)
535 pos[j].x_offset += pos[j + pos[j].cursive_chain()].x_offset;
540 /* Handle attachments */
541 for (i = 0; i < len; i++)
544 unsigned int back = i - pos[i].back();
545 pos[i].x_offset += pos[back].x_offset;
546 pos[i].y_offset += pos[back].y_offset;
548 if (HB_DIRECTION_IS_BACKWARD (buffer->props.direction))
549 for (j = back + 1; j < i + 1; j++) {
550 pos[i].x_offset += pos[j].x_advance;
551 pos[i].y_offset += pos[j].y_advance;
554 for (j = back; j < i; j++) {
555 pos[i].x_offset -= pos[j].x_advance;
556 pos[i].y_offset -= pos[j].y_advance;