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);
73 free (layout->new_gdef.klasses);
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);
99 /* TODO the public class_t is a mess */
102 hb_ot_layout_has_glyph_classes (hb_face_t *face)
104 return _get_gdef (face).has_glyph_classes ();
108 _hb_ot_layout_has_new_glyph_classes (hb_face_t *face)
110 return face->ot_layout->new_gdef.len > 0;
114 _hb_ot_layout_get_glyph_property (hb_face_t *face,
115 hb_codepoint_t glyph)
117 hb_ot_layout_class_t klass;
118 const GDEF &gdef = _get_gdef (face);
120 klass = gdef.get_glyph_class (glyph);
122 if (!klass && glyph < face->ot_layout->new_gdef.len)
123 klass = face->ot_layout->new_gdef.klasses[glyph];
127 case GDEF::UnclassifiedGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED;
128 case GDEF::BaseGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH;
129 case GDEF::LigatureGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE;
130 case GDEF::ComponentGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT;
131 case GDEF::MarkGlyph:
132 klass = gdef.get_mark_attachment_type (glyph);
133 return HB_OT_LAYOUT_GLYPH_CLASS_MARK + (klass << 8);
138 _hb_ot_layout_check_glyph_property (hb_face_t *face,
139 hb_internal_glyph_info_t *ginfo,
140 unsigned int lookup_flags,
141 unsigned int *property_out)
143 unsigned int property;
145 if (ginfo->gproperty == HB_BUFFER_GLYPH_PROPERTIES_UNKNOWN)
146 ginfo->gproperty = _hb_ot_layout_get_glyph_property (face, ginfo->codepoint);
147 property = ginfo->gproperty;
149 *property_out = property;
151 /* Not covered, if, for example, glyph class is ligature and
152 * lookup_flags includes LookupFlags::IgnoreLigatures
154 if (property & lookup_flags & LookupFlag::IgnoreFlags)
157 if (property & HB_OT_LAYOUT_GLYPH_CLASS_MARK)
159 /* If using mark filtering sets, the high short of
160 * lookup_flags has the set index.
162 if (lookup_flags & LookupFlag::UseMarkFilteringSet)
163 return _get_gdef (face).mark_set_covers (lookup_flags >> 16, ginfo->codepoint);
165 /* The second byte of lookup_flags has the meaning
166 * "ignore marks of attachment type different than
167 * the attachment type specified."
169 if (lookup_flags & LookupFlag::MarkAttachmentType && property & LookupFlag::MarkAttachmentType)
170 return (lookup_flags & LookupFlag::MarkAttachmentType) == (property & LookupFlag::MarkAttachmentType);
177 _hb_ot_layout_skip_mark (hb_face_t *face,
178 hb_internal_glyph_info_t *ginfo,
179 unsigned int lookup_flags,
180 unsigned int *property_out)
182 unsigned int property;
184 if (ginfo->gproperty == HB_BUFFER_GLYPH_PROPERTIES_UNKNOWN)
185 ginfo->gproperty = _hb_ot_layout_get_glyph_property (face, ginfo->codepoint);
186 property = ginfo->gproperty;
188 *property_out = property;
190 if (property & HB_OT_LAYOUT_GLYPH_CLASS_MARK)
192 /* Skip mark if lookup_flags includes LookupFlags::IgnoreMarks */
193 if (lookup_flags & LookupFlag::IgnoreMarks)
196 /* If using mark filtering sets, the high short of lookup_flags has the set index. */
197 if (lookup_flags & LookupFlag::UseMarkFilteringSet)
198 return !_get_gdef (face).mark_set_covers (lookup_flags >> 16, ginfo->codepoint);
200 /* The second byte of lookup_flags has the meaning "ignore marks of attachment type
201 * different than the attachment type specified." */
202 if (lookup_flags & LookupFlag::MarkAttachmentType && property & LookupFlag::MarkAttachmentType)
203 return (lookup_flags & LookupFlag::MarkAttachmentType) != (property & LookupFlag::MarkAttachmentType);
210 _hb_ot_layout_set_glyph_class (hb_face_t *face,
211 hb_codepoint_t glyph,
212 hb_ot_layout_glyph_class_t klass)
214 if (HB_OBJECT_IS_INERT (face))
217 /* TODO optimize this? similar to old harfbuzz code for example */
219 hb_ot_layout_t *layout = face->ot_layout;
220 hb_ot_layout_class_t gdef_klass;
221 unsigned int len = layout->new_gdef.len;
223 if (unlikely (glyph > 65535))
226 /* XXX this is not threadsafe */
228 unsigned int new_len;
229 unsigned char *new_klasses;
231 new_len = len == 0 ? 120 : 2 * len;
232 while (new_len <= glyph)
237 new_klasses = (unsigned char *) realloc (layout->new_gdef.klasses, new_len * sizeof (unsigned char));
239 if (unlikely (!new_klasses))
242 memset (new_klasses + len, 0, new_len - len);
244 layout->new_gdef.klasses = new_klasses;
245 layout->new_gdef.len = new_len;
250 case HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED: gdef_klass = GDEF::UnclassifiedGlyph; break;
251 case HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH: gdef_klass = GDEF::BaseGlyph; break;
252 case HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE: gdef_klass = GDEF::LigatureGlyph; break;
253 case HB_OT_LAYOUT_GLYPH_CLASS_MARK: gdef_klass = GDEF::MarkGlyph; break;
254 case HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT: gdef_klass = GDEF::ComponentGlyph; break;
257 layout->new_gdef.klasses[glyph] = gdef_klass;
262 _hb_ot_layout_set_glyph_property (hb_face_t *face,
263 hb_codepoint_t glyph,
264 unsigned int property)
265 { _hb_ot_layout_set_glyph_class (face, glyph, (hb_ot_layout_glyph_class_t) (property & 0xff)); }
268 hb_ot_layout_glyph_class_t
269 hb_ot_layout_get_glyph_class (hb_face_t *face,
270 hb_codepoint_t glyph)
272 return (hb_ot_layout_glyph_class_t) (_hb_ot_layout_get_glyph_property (face, glyph) & 0xff);
276 hb_ot_layout_set_glyph_class (hb_face_t *face,
277 hb_codepoint_t glyph,
278 hb_ot_layout_glyph_class_t klass)
280 _hb_ot_layout_set_glyph_class (face, glyph, klass);
284 hb_ot_layout_build_glyph_classes (hb_face_t *face,
285 hb_codepoint_t *glyphs,
286 unsigned char *klasses,
289 if (HB_OBJECT_IS_INERT (face))
292 hb_ot_layout_t *layout = face->ot_layout;
294 if (unlikely (!count || !glyphs || !klasses))
297 if (layout->new_gdef.len == 0) {
298 layout->new_gdef.klasses = (unsigned char *) calloc (count, sizeof (unsigned char));
299 layout->new_gdef.len = count;
302 for (unsigned int i = 0; i < count; i++)
303 _hb_ot_layout_set_glyph_class (face, glyphs[i], (hb_ot_layout_glyph_class_t) klasses[i]);
307 hb_ot_layout_get_attach_points (hb_face_t *face,
308 hb_codepoint_t glyph,
309 unsigned int start_offset,
310 unsigned int *point_count /* IN/OUT */,
311 unsigned int *point_array /* OUT */)
313 return _get_gdef (face).get_attach_points (glyph, start_offset, point_count, point_array);
317 hb_ot_layout_get_lig_carets (hb_font_t *font,
319 hb_codepoint_t glyph,
320 unsigned int start_offset,
321 unsigned int *caret_count /* IN/OUT */,
322 int *caret_array /* OUT */)
324 hb_ot_layout_context_t c;
327 return _get_gdef (face).get_lig_carets (&c, glyph, start_offset, caret_count, caret_array);
334 static const GSUBGPOS&
335 get_gsubgpos_table (hb_face_t *face,
339 case HB_OT_TAG_GSUB: return _get_gsub (face);
340 case HB_OT_TAG_GPOS: return _get_gpos (face);
341 default: return Null(GSUBGPOS);
347 hb_ot_layout_table_get_script_tags (hb_face_t *face,
349 unsigned int start_offset,
350 unsigned int *script_count /* IN/OUT */,
351 hb_tag_t *script_tags /* OUT */)
353 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
355 return g.get_script_tags (start_offset, script_count, script_tags);
359 hb_ot_layout_table_find_script (hb_face_t *face,
362 unsigned int *script_index)
364 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
365 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
367 if (g.find_script_index (script_tag, script_index))
370 /* try finding 'DFLT' */
371 if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
374 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
375 if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
378 if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
383 hb_ot_layout_table_choose_script (hb_face_t *face,
385 const hb_tag_t *script_tags,
386 unsigned int *script_index)
388 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
389 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
393 if (g.find_script_index (*script_tags, script_index))
398 /* try finding 'DFLT' */
399 if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
402 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
403 if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
406 if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
411 hb_ot_layout_table_get_feature_tags (hb_face_t *face,
413 unsigned int start_offset,
414 unsigned int *feature_count /* IN/OUT */,
415 hb_tag_t *feature_tags /* OUT */)
417 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
419 return g.get_feature_tags (start_offset, feature_count, feature_tags);
424 hb_ot_layout_script_get_language_tags (hb_face_t *face,
426 unsigned int script_index,
427 unsigned int start_offset,
428 unsigned int *language_count /* IN/OUT */,
429 hb_tag_t *language_tags /* OUT */)
431 const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
433 return s.get_lang_sys_tags (start_offset, language_count, language_tags);
437 hb_ot_layout_script_find_language (hb_face_t *face,
439 unsigned int script_index,
440 hb_tag_t language_tag,
441 unsigned int *language_index)
443 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX);
444 const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
446 if (s.find_lang_sys_index (language_tag, language_index))
449 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
450 if (s.find_lang_sys_index (HB_OT_TAG_DEFAULT_LANGUAGE, language_index))
453 if (language_index) *language_index = HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX;
458 hb_ot_layout_language_get_required_feature_index (hb_face_t *face,
460 unsigned int script_index,
461 unsigned int language_index,
462 unsigned int *feature_index)
464 const LangSys &l = get_gsubgpos_table (face, table_tag).get_script (script_index).get_lang_sys (language_index);
466 if (feature_index) *feature_index = l.get_required_feature_index ();
468 return l.has_required_feature ();
472 hb_ot_layout_language_get_feature_indexes (hb_face_t *face,
474 unsigned int script_index,
475 unsigned int language_index,
476 unsigned int start_offset,
477 unsigned int *feature_count /* IN/OUT */,
478 unsigned int *feature_indexes /* OUT */)
480 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
481 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
483 return l.get_feature_indexes (start_offset, feature_count, feature_indexes);
487 hb_ot_layout_language_get_feature_tags (hb_face_t *face,
489 unsigned int script_index,
490 unsigned int language_index,
491 unsigned int start_offset,
492 unsigned int *feature_count /* IN/OUT */,
493 hb_tag_t *feature_tags /* OUT */)
495 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
496 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
498 ASSERT_STATIC (sizeof (unsigned int) == sizeof (hb_tag_t));
499 unsigned int ret = l.get_feature_indexes (start_offset, feature_count, (unsigned int *) feature_tags);
502 unsigned int count = *feature_count;
503 for (unsigned int i = 0; i < count; i++)
504 feature_tags[i] = g.get_feature_tag ((unsigned int) feature_tags[i]);
512 hb_ot_layout_language_find_feature (hb_face_t *face,
514 unsigned int script_index,
515 unsigned int language_index,
516 hb_tag_t feature_tag,
517 unsigned int *feature_index)
519 ASSERT_STATIC (Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
520 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
521 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
523 unsigned int num_features = l.get_feature_count ();
524 for (unsigned int i = 0; i < num_features; i++) {
525 unsigned int f_index = l.get_feature_index (i);
527 if (feature_tag == g.get_feature_tag (f_index)) {
528 if (feature_index) *feature_index = f_index;
533 if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
538 hb_ot_layout_feature_get_lookup_indexes (hb_face_t *face,
540 unsigned int feature_index,
541 unsigned int start_offset,
542 unsigned int *lookup_count /* IN/OUT */,
543 unsigned int *lookup_indexes /* OUT */)
545 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
546 const Feature &f = g.get_feature (feature_index);
548 return f.get_lookup_indexes (start_offset, lookup_count, lookup_indexes);
557 hb_ot_layout_has_substitution (hb_face_t *face)
559 return &_get_gsub (face) != &Null(GSUB);
563 hb_ot_layout_substitute_lookup (hb_face_t *face,
565 unsigned int lookup_index,
568 hb_ot_layout_context_t c;
571 return _get_gsub (face).substitute_lookup (&c, buffer, lookup_index, mask);
580 hb_ot_layout_has_positioning (hb_face_t *face)
582 return &_get_gpos (face) != &Null(GPOS);
586 hb_ot_layout_position_lookup (hb_font_t *font,
589 unsigned int lookup_index,
592 hb_ot_layout_context_t c;
595 return _get_gpos (face).position_lookup (&c, buffer, lookup_index, mask);
599 hb_ot_layout_position_finish (hb_font_t *font HB_UNUSED,
600 hb_face_t *face HB_UNUSED,
604 unsigned int len = hb_buffer_get_length (buffer);
605 hb_internal_glyph_position_t *pos = (hb_internal_glyph_position_t *) hb_buffer_get_glyph_positions (buffer);
609 /* Handle cursive connections */
610 /* First handle all left-to-right connections */
611 for (j = 0; j < len; j++) {
612 if (pos[j].cursive_chain > 0)
614 pos[j].y_offset += pos[j - pos[j].cursive_chain].y_offset;
615 pos[j].cursive_chain = 0;
618 /* Then handle all right-to-left connections */
619 for (i = len; i > 0; i--) {
621 if (pos[j].cursive_chain < 0)
623 pos[j].y_offset += pos[j - pos[j].cursive_chain].y_offset;
624 pos[j].cursive_chain = 0;
628 /* Handle attachments */
629 for (i = 0; i < len; i++)
632 unsigned int back = i - pos[i].back;
634 pos[i].x_offset += pos[back].x_offset;
635 pos[i].y_offset += pos[back].y_offset;
637 if (buffer->props.direction == HB_DIRECTION_RTL)
638 for (j = back + 1; j < i + 1; j++) {
639 pos[i].x_offset += pos[j].x_advance;
640 pos[i].y_offset += pos[j].y_advance;
643 for (j = back; j < i; j++) {
644 pos[i].x_offset -= pos[j].x_advance;
645 pos[i].y_offset -= pos[j].y_advance;