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.h"
33 #include "hb-ot-layout-gdef-private.hh"
34 #include "hb-ot-layout-gsub-private.hh"
35 #include "hb-ot-layout-gpos-private.hh"
43 _hb_ot_layout_init (hb_face_t *face)
45 hb_ot_layout_t *layout = &face->ot_layout;
47 memset (layout, 0, sizeof (*layout));
49 layout->gdef_blob = Sanitizer<GDEF>::sanitize (hb_face_get_table (face, HB_OT_TAG_GDEF));
50 layout->gdef = Sanitizer<GDEF>::lock_instance (layout->gdef_blob);
52 layout->gsub_blob = Sanitizer<GSUB>::sanitize (hb_face_get_table (face, HB_OT_TAG_GSUB));
53 layout->gsub = Sanitizer<GSUB>::lock_instance (layout->gsub_blob);
55 layout->gpos_blob = Sanitizer<GPOS>::sanitize (hb_face_get_table (face, HB_OT_TAG_GPOS));
56 layout->gpos = Sanitizer<GPOS>::lock_instance (layout->gpos_blob);
60 _hb_ot_layout_fini (hb_face_t *face)
62 hb_ot_layout_t *layout = &face->ot_layout;
64 hb_blob_unlock (layout->gdef_blob);
65 hb_blob_unlock (layout->gsub_blob);
66 hb_blob_unlock (layout->gpos_blob);
68 hb_blob_destroy (layout->gdef_blob);
69 hb_blob_destroy (layout->gsub_blob);
70 hb_blob_destroy (layout->gpos_blob);
72 free (layout->new_gdef.klasses);
76 _get_gdef (hb_face_t *face)
78 return likely (face->ot_layout.gdef) ? *face->ot_layout.gdef : Null(GDEF);
82 _get_gsub (hb_face_t *face)
84 return likely (face->ot_layout.gsub) ? *face->ot_layout.gsub : Null(GSUB);
88 _get_gpos (hb_face_t *face)
90 return likely (face->ot_layout.gpos) ? *face->ot_layout.gpos : Null(GPOS);
98 /* TODO the public class_t is a mess */
101 hb_ot_layout_has_glyph_classes (hb_face_t *face)
103 return _get_gdef (face).has_glyph_classes ();
107 _hb_ot_layout_has_new_glyph_classes (hb_face_t *face)
109 return face->ot_layout.new_gdef.len > 0;
113 _hb_ot_layout_get_glyph_property (hb_face_t *face,
114 hb_codepoint_t glyph)
116 hb_ot_layout_class_t klass;
117 const GDEF &gdef = _get_gdef (face);
119 klass = gdef.get_glyph_class (glyph);
121 if (!klass && glyph < face->ot_layout.new_gdef.len)
122 klass = face->ot_layout.new_gdef.klasses[glyph];
126 case GDEF::UnclassifiedGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED;
127 case GDEF::BaseGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH;
128 case GDEF::LigatureGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE;
129 case GDEF::ComponentGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT;
130 case GDEF::MarkGlyph:
131 klass = gdef.get_mark_attachment_type (glyph);
132 return HB_OT_LAYOUT_GLYPH_CLASS_MARK + (klass << 8);
137 _hb_ot_layout_check_glyph_property (hb_face_t *face,
138 hb_internal_glyph_info_t *ginfo,
139 unsigned int lookup_flags,
140 unsigned int *property_out)
142 unsigned int property;
144 if (ginfo->gproperty == HB_BUFFER_GLYPH_PROPERTIES_UNKNOWN)
145 ginfo->gproperty = _hb_ot_layout_get_glyph_property (face, ginfo->codepoint);
146 property = ginfo->gproperty;
148 *property_out = property;
150 /* Not covered, if, for example, glyph class is ligature and
151 * lookup_flags includes LookupFlags::IgnoreLigatures
153 if (property & lookup_flags & LookupFlag::IgnoreFlags)
156 if (property & HB_OT_LAYOUT_GLYPH_CLASS_MARK)
158 /* If using mark filtering sets, the high short of
159 * lookup_flags has the set index.
161 if (lookup_flags & LookupFlag::UseMarkFilteringSet)
162 return _get_gdef (face).mark_set_covers (lookup_flags >> 16, ginfo->codepoint);
164 /* The second byte of lookup_flags has the meaning
165 * "ignore marks of attachment type different than
166 * the attachment type specified."
168 if (lookup_flags & LookupFlag::MarkAttachmentType && property & LookupFlag::MarkAttachmentType)
169 return (lookup_flags & LookupFlag::MarkAttachmentType) == (property & LookupFlag::MarkAttachmentType);
176 _hb_ot_layout_skip_mark (hb_face_t *face,
177 hb_internal_glyph_info_t *ginfo,
178 unsigned int lookup_flags,
179 unsigned int *property_out)
181 unsigned int property;
183 if (ginfo->gproperty == HB_BUFFER_GLYPH_PROPERTIES_UNKNOWN)
184 ginfo->gproperty = _hb_ot_layout_get_glyph_property (face, ginfo->codepoint);
185 property = ginfo->gproperty;
187 *property_out = property;
189 if (property & HB_OT_LAYOUT_GLYPH_CLASS_MARK)
191 /* Skip mark if lookup_flags includes LookupFlags::IgnoreMarks */
192 if (lookup_flags & LookupFlag::IgnoreMarks)
195 /* If using mark filtering sets, the high short of lookup_flags has the set index. */
196 if (lookup_flags & LookupFlag::UseMarkFilteringSet)
197 return !_get_gdef (face).mark_set_covers (lookup_flags >> 16, ginfo->codepoint);
199 /* The second byte of lookup_flags has the meaning "ignore marks of attachment type
200 * different than the attachment type specified." */
201 if (lookup_flags & LookupFlag::MarkAttachmentType && property & LookupFlag::MarkAttachmentType)
202 return (lookup_flags & LookupFlag::MarkAttachmentType) != (property & LookupFlag::MarkAttachmentType);
209 _hb_ot_layout_set_glyph_class (hb_face_t *face,
210 hb_codepoint_t glyph,
211 hb_ot_layout_glyph_class_t klass)
213 if (HB_OBJECT_IS_INERT (face))
216 /* TODO optimize this? similar to old harfbuzz code for example */
218 hb_ot_layout_t *layout = &face->ot_layout;
219 hb_ot_layout_class_t gdef_klass;
220 unsigned int len = layout->new_gdef.len;
222 if (unlikely (glyph > 65535))
225 /* XXX this is not threadsafe */
227 unsigned int new_len;
228 unsigned char *new_klasses;
230 new_len = len == 0 ? 120 : 2 * len;
231 while (new_len <= glyph)
236 new_klasses = (unsigned char *) realloc (layout->new_gdef.klasses, new_len * sizeof (unsigned char));
238 if (unlikely (!new_klasses))
241 memset (new_klasses + len, 0, new_len - len);
243 layout->new_gdef.klasses = new_klasses;
244 layout->new_gdef.len = new_len;
249 case HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED: gdef_klass = GDEF::UnclassifiedGlyph; break;
250 case HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH: gdef_klass = GDEF::BaseGlyph; break;
251 case HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE: gdef_klass = GDEF::LigatureGlyph; break;
252 case HB_OT_LAYOUT_GLYPH_CLASS_MARK: gdef_klass = GDEF::MarkGlyph; break;
253 case HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT: gdef_klass = GDEF::ComponentGlyph; break;
256 layout->new_gdef.klasses[glyph] = gdef_klass;
261 _hb_ot_layout_set_glyph_property (hb_face_t *face,
262 hb_codepoint_t glyph,
263 unsigned int property)
264 { _hb_ot_layout_set_glyph_class (face, glyph, (hb_ot_layout_glyph_class_t) (property & 0xff)); }
267 hb_ot_layout_glyph_class_t
268 hb_ot_layout_get_glyph_class (hb_face_t *face,
269 hb_codepoint_t glyph)
271 return (hb_ot_layout_glyph_class_t) (_hb_ot_layout_get_glyph_property (face, glyph) & 0xff);
275 hb_ot_layout_set_glyph_class (hb_face_t *face,
276 hb_codepoint_t glyph,
277 hb_ot_layout_glyph_class_t klass)
279 _hb_ot_layout_set_glyph_class (face, glyph, klass);
283 hb_ot_layout_build_glyph_classes (hb_face_t *face,
284 hb_codepoint_t *glyphs,
285 unsigned char *klasses,
288 if (HB_OBJECT_IS_INERT (face))
291 hb_ot_layout_t *layout = &face->ot_layout;
293 if (unlikely (!count || !glyphs || !klasses))
296 if (layout->new_gdef.len == 0) {
297 layout->new_gdef.klasses = (unsigned char *) calloc (count, sizeof (unsigned char));
298 layout->new_gdef.len = count;
301 for (unsigned int i = 0; i < count; i++)
302 _hb_ot_layout_set_glyph_class (face, glyphs[i], (hb_ot_layout_glyph_class_t) klasses[i]);
306 hb_ot_layout_get_attach_points (hb_face_t *face,
307 hb_codepoint_t glyph,
308 unsigned int start_offset,
309 unsigned int *point_count /* IN/OUT */,
310 unsigned int *point_array /* OUT */)
312 return _get_gdef (face).get_attach_points (glyph, start_offset, point_count, point_array);
316 hb_ot_layout_get_lig_carets (hb_font_t *font,
318 hb_codepoint_t glyph,
319 unsigned int start_offset,
320 unsigned int *caret_count /* IN/OUT */,
321 int *caret_array /* OUT */)
323 hb_ot_layout_context_t context;
326 return _get_gdef (face).get_lig_carets (&context, glyph, start_offset, caret_count, caret_array);
333 static const GSUBGPOS&
334 get_gsubgpos_table (hb_face_t *face,
338 case HB_OT_TAG_GSUB: return _get_gsub (face);
339 case HB_OT_TAG_GPOS: return _get_gpos (face);
340 default: return Null(GSUBGPOS);
346 hb_ot_layout_table_get_script_tags (hb_face_t *face,
348 unsigned int start_offset,
349 unsigned int *script_count /* IN/OUT */,
350 hb_tag_t *script_tags /* OUT */)
352 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
354 return g.get_script_tags (start_offset, script_count, script_tags);
358 hb_ot_layout_table_find_script (hb_face_t *face,
361 unsigned int *script_index)
363 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
364 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
366 if (g.find_script_index (script_tag, script_index))
369 /* try finding 'DFLT' */
370 if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
373 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
374 if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
377 if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
382 hb_ot_layout_table_choose_script (hb_face_t *face,
384 const hb_tag_t *script_tags,
385 unsigned int *script_index)
387 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
388 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
392 if (g.find_script_index (*script_tags, script_index))
397 /* try finding 'DFLT' */
398 if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
401 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
402 if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
405 if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
410 hb_ot_layout_table_get_feature_tags (hb_face_t *face,
412 unsigned int start_offset,
413 unsigned int *feature_count /* IN/OUT */,
414 hb_tag_t *feature_tags /* OUT */)
416 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
418 return g.get_feature_tags (start_offset, feature_count, feature_tags);
423 hb_ot_layout_script_get_language_tags (hb_face_t *face,
425 unsigned int script_index,
426 unsigned int start_offset,
427 unsigned int *language_count /* IN/OUT */,
428 hb_tag_t *language_tags /* OUT */)
430 const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
432 return s.get_lang_sys_tags (start_offset, language_count, language_tags);
436 hb_ot_layout_script_find_language (hb_face_t *face,
438 unsigned int script_index,
439 hb_tag_t language_tag,
440 unsigned int *language_index)
442 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX);
443 const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
445 if (s.find_lang_sys_index (language_tag, language_index))
448 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
449 if (s.find_lang_sys_index (HB_OT_TAG_DEFAULT_LANGUAGE, language_index))
452 if (language_index) *language_index = HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX;
457 hb_ot_layout_language_get_required_feature_index (hb_face_t *face,
459 unsigned int script_index,
460 unsigned int language_index,
461 unsigned int *feature_index)
463 const LangSys &l = get_gsubgpos_table (face, table_tag).get_script (script_index).get_lang_sys (language_index);
465 if (feature_index) *feature_index = l.get_required_feature_index ();
467 return l.has_required_feature ();
471 hb_ot_layout_language_get_feature_indexes (hb_face_t *face,
473 unsigned int script_index,
474 unsigned int language_index,
475 unsigned int start_offset,
476 unsigned int *feature_count /* IN/OUT */,
477 unsigned int *feature_indexes /* OUT */)
479 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
480 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
482 return l.get_feature_indexes (start_offset, feature_count, feature_indexes);
486 hb_ot_layout_language_get_feature_tags (hb_face_t *face,
488 unsigned int script_index,
489 unsigned int language_index,
490 unsigned int start_offset,
491 unsigned int *feature_count /* IN/OUT */,
492 hb_tag_t *feature_tags /* OUT */)
494 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
495 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
497 ASSERT_STATIC (sizeof (unsigned int) == sizeof (hb_tag_t));
498 unsigned int ret = l.get_feature_indexes (start_offset, feature_count, (unsigned int *) feature_tags);
501 unsigned int count = *feature_count;
502 for (unsigned int i = 0; i < count; i++)
503 feature_tags[i] = g.get_feature_tag ((unsigned int) feature_tags[i]);
511 hb_ot_layout_language_find_feature (hb_face_t *face,
513 unsigned int script_index,
514 unsigned int language_index,
515 hb_tag_t feature_tag,
516 unsigned int *feature_index)
518 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
519 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
520 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
522 unsigned int num_features = l.get_feature_count ();
523 for (unsigned int i = 0; i < num_features; i++) {
524 unsigned int f_index = l.get_feature_index (i);
526 if (feature_tag == g.get_feature_tag (f_index)) {
527 if (feature_index) *feature_index = f_index;
532 if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
537 hb_ot_layout_feature_get_lookup_indexes (hb_face_t *face,
539 unsigned int feature_index,
540 unsigned int start_offset,
541 unsigned int *lookup_count /* IN/OUT */,
542 unsigned int *lookup_indexes /* OUT */)
544 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
545 const Feature &f = g.get_feature (feature_index);
547 return f.get_lookup_indexes (start_offset, lookup_count, lookup_indexes);
556 hb_ot_layout_has_substitution (hb_face_t *face)
558 return &_get_gsub (face) != &Null(GSUB);
562 hb_ot_layout_substitute_lookup (hb_face_t *face,
564 unsigned int lookup_index,
567 hb_ot_layout_context_t context;
570 return _get_gsub (face).substitute_lookup (&context, buffer, lookup_index, mask);
579 hb_ot_layout_has_positioning (hb_face_t *face)
581 return &_get_gpos (face) != &Null(GPOS);
585 hb_ot_layout_position_lookup (hb_font_t *font,
588 unsigned int lookup_index,
591 hb_ot_layout_context_t context;
594 return _get_gpos (face).position_lookup (&context, buffer, lookup_index, mask);
598 hb_ot_layout_position_finish (hb_font_t *font HB_UNUSED,
599 hb_face_t *face HB_UNUSED,
603 unsigned int len = hb_buffer_get_length (buffer);
604 hb_internal_glyph_position_t *positions = (hb_internal_glyph_position_t *) hb_buffer_get_glyph_positions (buffer);
608 /* Handle cursive connections */
609 /* First handle all left-to-right connections */
610 for (j = 0; j < len; j++) {
611 if (positions[j].cursive_chain > 0) {
612 positions[j].y_offset += positions[j - positions[j].cursive_chain].y_offset;
613 positions[j].cursive_chain = 0;
616 /* Then handle all right-to-left connections */
617 for (i = len; i > 0; i--) {
619 if (positions[j].cursive_chain < 0) {
620 positions[j].y_offset += positions[j - positions[j].cursive_chain].y_offset;
621 positions[j].cursive_chain = 0;
625 /* Handle attachments */
626 for (i = 0; i < len; i++)
627 if (positions[i].back)
629 unsigned int back = i - positions[i].back;
630 positions[i].back = 0;
631 positions[i].x_offset += positions[back].x_offset;
632 positions[i].y_offset += positions[back].y_offset;
634 if (buffer->direction == HB_DIRECTION_RTL)
635 for (j = back + 1; j < i + 1; j++) {
636 positions[i].x_offset += positions[j].x_advance;
637 positions[i].y_offset += positions[j].y_advance;
640 for (j = back; j < i; j++) {
641 positions[i].x_offset -= positions[j].x_advance;
642 positions[i].y_offset -= positions[j].y_advance;