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, an OpenType Layout engine 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_ot_layout_t *layout)
51 _hb_ot_layout_fini (hb_ot_layout_t *layout)
55 static hb_ot_layout_t *
56 _hb_ot_face_get_layout (hb_face_t *face)
58 return &face->ot_layout;
62 _get_gdef (hb_face_t *face)
65 if (HB_UNLIKELY (!layout->face))
68 if (HB_UNLIKELY (!layout->gdef)) {
69 hb_blob_t *blob = hb_face_get_table (face, HB_OT_TAG_GDEF);
71 const char *data = hb_blob_get_data (blob,
72 layout->gdef = &GDEF::get_for_data (font.get_table_data (face.get_table_by_tag (GDEF::Tag)));
73 layout->gdef = &Null(GDEF);
81 _get_gsub (hb_face_t *face)
87 _get_gpos (hb_face_t *face)
97 /* TODO the public class_t is a mess */
100 hb_ot_layout_has_font_glyph_classes (hb_face_t *face)
102 return _get_gdef (face).has_glyph_classes ();
105 HB_INTERNAL hb_bool_t
106 _hb_ot_layout_has_new_glyph_classes (hb_face_t *face)
108 return face->ot_layout.new_gdef.len > 0;
112 _hb_ot_layout_get_glyph_property (hb_face_t *face,
113 hb_codepoint_t glyph)
115 hb_ot_layout_class_t klass;
116 const GDEF &gdef = _get_gdef (face);
118 klass = gdef.get_glyph_class (glyph);
120 if (!klass && glyph < face->ot_layout.new_gdef.len)
121 klass = face->ot_layout.new_gdef.klasses[glyph];
125 case GDEF::UnclassifiedGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED;
126 case GDEF::BaseGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH;
127 case GDEF::LigatureGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE;
128 case GDEF::ComponentGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT;
129 case GDEF::MarkGlyph:
130 /* TODO old harfbuzz doesn't always parse mark attachments as it says it was
131 * introduced without a version bump, so it may not be safe */
132 klass = gdef.get_mark_attachment_type (glyph);
133 return HB_OT_LAYOUT_GLYPH_CLASS_MARK + (klass << 8);
137 HB_INTERNAL hb_bool_t
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)
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);
176 HB_INTERNAL hb_bool_t
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 int len = layout->new_gdef.len;
223 if (HB_UNLIKELY (glyph > 65535))
226 /* XXX this is not threadsafe */
229 unsigned char *new_klasses;
231 new_len = len == 0 ? 120 : 2 * len;
234 new_klasses = (unsigned char *) realloc (layout->new_gdef.klasses, new_len * sizeof (unsigned char));
236 if (HB_UNLIKELY (!new_klasses))
239 memset (new_klasses + len, 0, new_len - len);
241 layout->new_gdef.klasses = new_klasses;
242 layout->new_gdef.len = new_len;
247 case HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED: gdef_klass = GDEF::UnclassifiedGlyph; break;
248 case HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH: gdef_klass = GDEF::BaseGlyph; break;
249 case HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE: gdef_klass = GDEF::LigatureGlyph; break;
250 case HB_OT_LAYOUT_GLYPH_CLASS_MARK: gdef_klass = GDEF::MarkGlyph; break;
251 case HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT: gdef_klass = GDEF::ComponentGlyph; break;
254 layout->new_gdef.klasses[glyph] = gdef_klass;
259 _hb_ot_layout_set_glyph_property (hb_face_t *face,
260 hb_codepoint_t glyph,
261 unsigned int property)
262 { _hb_ot_layout_set_glyph_class (face, glyph, (hb_ot_layout_glyph_class_t) (property & 0xff)); }
265 hb_ot_layout_glyph_class_t
266 hb_ot_layout_get_glyph_class (hb_face_t *face,
267 hb_codepoint_t glyph)
269 return (hb_ot_layout_glyph_class_t) (_hb_ot_layout_get_glyph_property (face, glyph) & 0xff);
273 hb_ot_layout_set_glyph_class (hb_face_t *face,
274 hb_codepoint_t glyph,
275 hb_ot_layout_glyph_class_t klass)
277 _hb_ot_layout_set_glyph_class (face, glyph, klass);
281 hb_ot_layout_build_glyph_classes (hb_face_t *face,
282 uint16_t num_total_glyphs,
283 hb_codepoint_t *glyphs,
284 unsigned char *klasses,
287 if (HB_OBJECT_IS_INERT (face))
290 hb_ot_layout_t *layout = &face->ot_layout;
292 if (HB_UNLIKELY (!count || !glyphs || !klasses))
295 if (layout->new_gdef.len == 0) {
296 layout->new_gdef.klasses = (unsigned char *) calloc (num_total_glyphs, sizeof (unsigned char));
297 layout->new_gdef.len = count;
300 for (unsigned int i = 0; i < count; i++)
301 _hb_ot_layout_set_glyph_class (face, glyphs[i], (hb_ot_layout_glyph_class_t) klasses[i]);
305 hb_ot_layout_get_attach_points (hb_face_t *face,
306 hb_codepoint_t glyph,
307 unsigned int *point_count /* IN/OUT */,
308 unsigned int *point_array /* OUT */)
310 return _get_gdef (face).get_attach_points (glyph, point_count, point_array);
314 hb_ot_layout_get_lig_carets (hb_face_t *face,
316 hb_codepoint_t glyph,
317 unsigned int *caret_count /* IN/OUT */,
318 int *caret_array /* OUT */)
320 hb_ot_layout_context_t context;
323 return _get_gdef (face).get_lig_carets (&context, glyph, caret_count, caret_array);
330 static const GSUBGPOS&
331 get_gsubgpos_table (hb_face_t *face,
335 case HB_OT_TAG_GSUB: return _get_gsub (face);
336 case HB_OT_TAG_GPOS: return _get_gpos (face);
337 default: return Null(GSUBGPOS);
343 hb_ot_layout_table_get_script_count (hb_face_t *face,
346 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
348 return g.get_script_count ();
352 hb_ot_layout_table_get_script_tag (hb_face_t *face,
354 unsigned int script_index)
356 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
358 return g.get_script_tag (script_index);
362 hb_ot_layout_table_find_script (hb_face_t *face,
365 unsigned int *script_index)
367 ASSERT_STATIC (NO_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
368 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
370 if (g.find_script_index (script_tag, script_index))
373 /* try finding 'DFLT' */
374 if (g.find_script_index (HB_OT_LAYOUT_TAG_DEFAULT_SCRIPT, script_index))
377 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
378 if (g.find_script_index (HB_OT_LAYOUT_TAG_DEFAULT_LANGUAGE, script_index))
381 if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
386 hb_ot_layout_table_get_feature_count (hb_face_t *face,
389 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
391 return g.get_feature_count ();
395 hb_ot_layout_table_get_feature_tag (hb_face_t *face,
397 unsigned int feature_index)
399 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
401 return g.get_feature_tag (feature_index);
405 hb_ot_layout_table_find_feature (hb_face_t *face,
407 hb_tag_t feature_tag,
408 unsigned int *feature_index)
410 ASSERT_STATIC (NO_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
411 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
413 if (g.find_feature_index (feature_tag, feature_index))
416 if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
421 hb_ot_layout_table_get_lookup_count (hb_face_t *face,
424 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
426 return g.get_lookup_count ();
431 hb_ot_layout_script_get_language_count (hb_face_t *face,
433 unsigned int script_index)
435 const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
437 return s.get_lang_sys_count ();
441 hb_ot_layout_script_get_language_tag (hb_face_t *face,
443 unsigned int script_index,
444 unsigned int language_index)
446 const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
448 return s.get_lang_sys_tag (language_index);
452 hb_ot_layout_script_find_language (hb_face_t *face,
454 unsigned int script_index,
455 hb_tag_t language_tag,
456 unsigned int *language_index)
458 ASSERT_STATIC (NO_INDEX == HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX);
459 const Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
461 if (s.find_lang_sys_index (language_tag, language_index))
464 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
465 if (s.find_lang_sys_index (HB_OT_LAYOUT_TAG_DEFAULT_LANGUAGE, language_index))
468 if (language_index) *language_index = HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX;
473 hb_ot_layout_language_get_required_feature_index (hb_face_t *face,
475 unsigned int script_index,
476 unsigned int language_index,
477 unsigned int *feature_index)
479 const LangSys &l = get_gsubgpos_table (face, table_tag).get_script (script_index).get_lang_sys (language_index);
481 if (feature_index) *feature_index = l.get_required_feature_index ();
483 return l.has_required_feature ();
487 hb_ot_layout_language_get_feature_count (hb_face_t *face,
489 unsigned int script_index,
490 unsigned int language_index)
492 const LangSys &l = get_gsubgpos_table (face, table_tag).get_script (script_index).get_lang_sys (language_index);
494 return l.get_feature_count ();
498 hb_ot_layout_language_get_feature_index (hb_face_t *face,
500 unsigned int script_index,
501 unsigned int language_index,
502 unsigned int num_feature)
504 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
505 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
507 return l.get_feature_index (num_feature);
511 hb_ot_layout_language_get_feature_tag (hb_face_t *face,
513 unsigned int script_index,
514 unsigned int language_index,
515 unsigned int num_feature)
517 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
518 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
519 unsigned int feature_index = l.get_feature_index (num_feature);
521 return g.get_feature_tag (feature_index);
526 hb_ot_layout_language_find_feature (hb_face_t *face,
528 unsigned int script_index,
529 unsigned int language_index,
530 hb_tag_t feature_tag,
531 unsigned int *feature_index)
533 ASSERT_STATIC (NO_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
534 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
535 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
537 unsigned int num_features = l.get_feature_count ();
538 for (unsigned int i = 0; i < num_features; i++) {
539 unsigned int f_index = l.get_feature_index (i);
541 if (feature_tag == g.get_feature_tag (f_index)) {
542 if (feature_index) *feature_index = f_index;
547 if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
552 hb_ot_layout_feature_get_lookup_count (hb_face_t *face,
554 unsigned int feature_index)
556 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
557 const Feature &f = g.get_feature (feature_index);
559 return f.get_lookup_count ();
563 hb_ot_layout_feature_get_lookup_index (hb_face_t *face,
565 unsigned int feature_index,
566 unsigned int num_lookup)
568 const GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
569 const Feature &f = g.get_feature (feature_index);
571 return f.get_lookup_index (num_lookup);
579 hb_ot_layout_has_substitution (hb_face_t *face)
581 return &_get_gsub (face) != &Null(GSUB);
585 hb_ot_layout_substitute_lookup (hb_face_t *face,
587 unsigned int lookup_index,
588 hb_ot_layout_feature_mask_t mask)
590 hb_ot_layout_context_t context;
593 return _get_gsub (face).substitute_lookup (&context, buffer, lookup_index, mask);
601 hb_ot_layout_has_positioning (hb_face_t *face)
603 return &_get_gpos (face) != &Null(GPOS);
607 hb_ot_layout_position_lookup (hb_face_t *face,
610 unsigned int lookup_index,
611 hb_ot_layout_feature_mask_t mask)
613 hb_ot_layout_context_t context;
616 return _get_gpos (face).position_lookup (&context, buffer, lookup_index, mask);