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
32 #include "hb-buffer-private.h"
34 #include "hb-ot-layout.h"
35 #include "hb-ot-layout-private.h"
37 #include "hb-ot-layout-open-private.h"
38 #include "hb-ot-layout-gdef-private.h"
39 #include "hb-ot-layout-gsub-private.h"
40 #include "hb-ot-layout-gpos-private.h"
48 hb_ot_layout_create (void)
50 hb_ot_layout_t *layout = (hb_ot_layout_t *) calloc (1, sizeof (hb_ot_layout_t));
52 layout->gdef = &Null(GDEF);
53 layout->gsub = &Null(GSUB);
54 layout->gpos = &Null(GPOS);
60 hb_ot_layout_create_for_data (const char *font_data,
63 hb_ot_layout_t *layout;
65 if (HB_UNLIKELY (font_data == NULL))
66 return hb_ot_layout_create ();
68 layout = (hb_ot_layout_t *) calloc (1, sizeof (hb_ot_layout_t));
70 const OpenTypeFontFile &font = OpenTypeFontFile::get_for_data (font_data);
71 const OpenTypeFontFace &face = font.get_face (face_index);
73 layout->gdef = &GDEF::get_for_data (font.get_table_data (face.get_table_by_tag (GDEF::Tag)));
74 layout->gsub = &GSUB::get_for_data (font.get_table_data (face.get_table_by_tag (GSUB::Tag)));
75 layout->gpos = &GPOS::get_for_data (font.get_table_data (face.get_table_by_tag (GPOS::Tag)));
81 hb_ot_layout_destroy (hb_ot_layout_t *layout)
87 hb_ot_layout_set_direction (hb_ot_layout_t *layout,
90 layout->gpos_info.r2l = !!r2l;
94 hb_ot_layout_set_hinting (hb_ot_layout_t *layout,
97 layout->gpos_info.dvi = !hinted;
101 hb_ot_layout_set_scale (hb_ot_layout_t *layout,
102 hb_16dot16_t x_scale, hb_16dot16_t y_scale)
104 layout->gpos_info.x_scale = x_scale;
105 layout->gpos_info.y_scale = y_scale;
109 hb_ot_layout_set_ppem (hb_ot_layout_t *layout,
110 unsigned int x_ppem, unsigned int y_ppem)
112 layout->gpos_info.x_ppem = x_ppem;
113 layout->gpos_info.y_ppem = y_ppem;
121 /* TODO the public class_t is a mess */
124 hb_ot_layout_has_font_glyph_classes (hb_ot_layout_t *layout)
126 return layout->gdef->has_glyph_classes ();
129 HB_INTERNAL hb_bool_t
130 _hb_ot_layout_has_new_glyph_classes (hb_ot_layout_t *layout)
132 return layout->new_gdef.len > 0;
135 HB_INTERNAL unsigned int
136 _hb_ot_layout_get_glyph_property (hb_ot_layout_t *layout,
137 hb_codepoint_t glyph)
139 hb_ot_layout_class_t klass;
141 klass = layout->gdef->get_glyph_class (glyph);
143 if (!klass && glyph < layout->new_gdef.len)
144 klass = layout->new_gdef.klasses[glyph];
148 case GDEF::UnclassifiedGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED;
149 case GDEF::BaseGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH;
150 case GDEF::LigatureGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE;
151 case GDEF::ComponentGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT;
152 case GDEF::MarkGlyph:
153 /* TODO old harfbuzz doesn't always parse mark attachments as it says it was
154 * introduced without a version bump, so it may not be safe */
155 klass = layout->gdef->get_mark_attachment_type (glyph);
156 return HB_OT_LAYOUT_GLYPH_CLASS_MARK + klass << 8;
160 HB_INTERNAL hb_bool_t
161 _hb_ot_layout_check_glyph_property (hb_ot_layout_t *layout,
162 hb_glyph_info_t *ginfo,
163 unsigned int lookup_flags,
164 unsigned int *property)
166 hb_ot_layout_glyph_class_t basic_glyph_class;
167 unsigned int desired_attachment_class;
169 if (ginfo->gproperty == HB_BUFFER_GLYPH_PROPERTIES_UNKNOWN)
171 ginfo->gproperty = *property = _hb_ot_layout_get_glyph_property (layout, ginfo->gindex);
172 if (ginfo->gproperty == HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED)
176 *property = ginfo->gproperty;
178 /* If the glyph was found in the MarkAttachmentClass table,
179 * then that class value is stored in the high byte of the result.
180 * The low byte contains the basic type of the glyph as defined by
181 * the GlyphClassDef table.
183 if (*property & LookupFlag::MarkAttachmentType)
184 basic_glyph_class = HB_OT_LAYOUT_GLYPH_CLASS_MARK;
186 basic_glyph_class = (hb_ot_layout_glyph_class_t) *property;
188 /* Not covered, if, for example, basic_glyph_class
189 * is HB_GDEF_LIGATURE and lookup_flags includes LookupFlags::IgnoreLigatures
191 if (lookup_flags & basic_glyph_class)
194 /* The high byte of lookup_flags has the meaning
195 * "ignore marks of attachment type different than
196 * the attachment type specified."
198 desired_attachment_class = lookup_flags & LookupFlag::MarkAttachmentType;
199 if (desired_attachment_class)
201 if (basic_glyph_class == HB_OT_LAYOUT_GLYPH_CLASS_MARK &&
202 *property != desired_attachment_class)
210 _hb_ot_layout_set_glyph_property (hb_ot_layout_t *layout,
211 hb_codepoint_t glyph,
212 unsigned int property)
214 hb_ot_layout_glyph_class_t klass;
216 if (property & LookupFlag::MarkAttachmentType)
217 klass = HB_OT_LAYOUT_GLYPH_CLASS_MARK;
219 klass = (hb_ot_layout_glyph_class_t) property;
221 hb_ot_layout_set_glyph_class (layout, glyph, klass);
225 hb_ot_layout_glyph_class_t
226 hb_ot_layout_get_glyph_class (hb_ot_layout_t *layout,
227 hb_codepoint_t glyph)
229 unsigned int property;
230 hb_ot_layout_class_t klass;
232 property = _hb_ot_layout_get_glyph_property (layout, glyph);
234 if (property & LookupFlag::MarkAttachmentType)
235 return HB_OT_LAYOUT_GLYPH_CLASS_MARK;
237 return (hb_ot_layout_glyph_class_t) property;
241 hb_ot_layout_set_glyph_class (hb_ot_layout_t *layout,
242 hb_codepoint_t glyph,
243 hb_ot_layout_glyph_class_t klass)
245 /* TODO optimize this, similar to old harfbuzz code for example */
247 hb_ot_layout_class_t gdef_klass;
248 int len = layout->new_gdef.len;
250 if (HB_UNLIKELY (glyph > 65535))
255 unsigned char *new_klasses;
257 new_len = len == 0 ? 120 : 2 * len;
260 new_klasses = (unsigned char *) realloc (layout->new_gdef.klasses, new_len * sizeof (unsigned char));
262 if (HB_UNLIKELY (!new_klasses))
265 memset (new_klasses + len, 0, new_len - len);
267 layout->new_gdef.klasses = new_klasses;
268 layout->new_gdef.len = new_len;
273 case HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED: gdef_klass = GDEF::UnclassifiedGlyph; break;
274 case HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH: gdef_klass = GDEF::BaseGlyph; break;
275 case HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE: gdef_klass = GDEF::LigatureGlyph; break;
276 case HB_OT_LAYOUT_GLYPH_CLASS_MARK: gdef_klass = GDEF::MarkGlyph; break;
277 case HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT: gdef_klass = GDEF::ComponentGlyph; break;
280 layout->new_gdef.klasses[glyph] = gdef_klass;
285 hb_ot_layout_build_glyph_classes (hb_ot_layout_t *layout,
286 uint16_t num_total_glyphs,
287 hb_codepoint_t *glyphs,
288 unsigned char *klasses,
291 if (HB_UNLIKELY (!count || !glyphs || !klasses))
294 if (layout->new_gdef.len == 0) {
295 layout->new_gdef.klasses = (unsigned char *) calloc (num_total_glyphs, sizeof (unsigned char));
296 layout->new_gdef.len = count;
299 for (unsigned int i = 0; i < count; i++)
300 hb_ot_layout_set_glyph_class (layout, glyphs[i], (hb_ot_layout_glyph_class_t) klasses[i]);
304 hb_ot_layout_get_attach_points (hb_ot_layout_t *layout,
305 hb_codepoint_t glyph,
306 unsigned int *point_count /* IN/OUT */,
307 unsigned int *point_array /* OUT */)
309 return layout->gdef->get_attach_points (glyph, point_count, point_array);
313 hb_ot_layout_get_lig_carets (hb_ot_layout_t *layout,
314 hb_codepoint_t glyph,
315 unsigned int *caret_count /* IN/OUT */,
316 int *caret_array /* OUT */)
318 return layout->gdef->get_lig_carets (layout, glyph, caret_count, caret_array);
325 static const GSUBGPOS&
326 get_gsubgpos_table (hb_ot_layout_t *layout,
327 hb_ot_layout_table_type_t table_type)
329 switch (table_type) {
330 case HB_OT_LAYOUT_TABLE_TYPE_GSUB: return *(layout->gsub);
331 case HB_OT_LAYOUT_TABLE_TYPE_GPOS: return *(layout->gpos);
332 default: return Null(GSUBGPOS);
338 hb_ot_layout_table_get_script_count (hb_ot_layout_t *layout,
339 hb_ot_layout_table_type_t table_type)
341 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
343 return g.get_script_count ();
347 hb_ot_layout_table_get_script_tag (hb_ot_layout_t *layout,
348 hb_ot_layout_table_type_t table_type,
349 unsigned int script_index)
351 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
353 return g.get_script_tag (script_index);
357 hb_ot_layout_table_find_script (hb_ot_layout_t *layout,
358 hb_ot_layout_table_type_t table_type,
360 unsigned int *script_index)
362 ASSERT_STATIC (NO_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
363 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
365 if (g.find_script_index (script_tag, script_index))
368 /* try finding 'DFLT' */
369 if (g.find_script_index (HB_OT_LAYOUT_TAG_DEFAULT_SCRIPT, script_index))
372 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
373 if (g.find_script_index (HB_OT_LAYOUT_TAG_DEFAULT_LANGUAGE, script_index))
376 if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
381 hb_ot_layout_table_get_feature_count (hb_ot_layout_t *layout,
382 hb_ot_layout_table_type_t table_type)
384 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
386 return g.get_feature_count ();
390 hb_ot_layout_table_get_feature_tag (hb_ot_layout_t *layout,
391 hb_ot_layout_table_type_t table_type,
392 unsigned int feature_index)
394 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
396 return g.get_feature_tag (feature_index);
400 hb_ot_layout_table_find_feature (hb_ot_layout_t *layout,
401 hb_ot_layout_table_type_t table_type,
402 hb_tag_t feature_tag,
403 unsigned int *feature_index)
405 ASSERT_STATIC (NO_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
406 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
408 if (g.find_feature_index (feature_tag, feature_index))
411 if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
416 hb_ot_layout_table_get_lookup_count (hb_ot_layout_t *layout,
417 hb_ot_layout_table_type_t table_type)
419 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
421 return g.get_lookup_count ();
426 hb_ot_layout_script_get_language_count (hb_ot_layout_t *layout,
427 hb_ot_layout_table_type_t table_type,
428 unsigned int script_index)
430 const Script &s = get_gsubgpos_table (layout, table_type).get_script (script_index);
432 return s.get_lang_sys_count ();
436 hb_ot_layout_script_get_language_tag (hb_ot_layout_t *layout,
437 hb_ot_layout_table_type_t table_type,
438 unsigned int script_index,
439 unsigned int language_index)
441 const Script &s = get_gsubgpos_table (layout, table_type).get_script (script_index);
443 return s.get_lang_sys_tag (language_index);
447 hb_ot_layout_script_find_language (hb_ot_layout_t *layout,
448 hb_ot_layout_table_type_t table_type,
449 unsigned int script_index,
450 hb_tag_t language_tag,
451 unsigned int *language_index)
453 ASSERT_STATIC (NO_INDEX == HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX);
454 const Script &s = get_gsubgpos_table (layout, table_type).get_script (script_index);
456 if (s.find_lang_sys_index (language_tag, language_index))
459 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
460 if (s.find_lang_sys_index (HB_OT_LAYOUT_TAG_DEFAULT_LANGUAGE, language_index))
463 if (language_index) *language_index = HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX;
468 hb_ot_layout_language_get_required_feature_index (hb_ot_layout_t *layout,
469 hb_ot_layout_table_type_t table_type,
470 unsigned int script_index,
471 unsigned int language_index,
472 unsigned int *feature_index)
474 const LangSys &l = get_gsubgpos_table (layout, table_type).get_script (script_index).get_lang_sys (language_index);
476 if (feature_index) *feature_index = l.get_required_feature_index ();
478 return l.has_required_feature ();
482 hb_ot_layout_language_get_feature_count (hb_ot_layout_t *layout,
483 hb_ot_layout_table_type_t table_type,
484 unsigned int script_index,
485 unsigned int language_index)
487 const LangSys &l = get_gsubgpos_table (layout, table_type).get_script (script_index).get_lang_sys (language_index);
489 return l.get_feature_count ();
493 hb_ot_layout_language_get_feature_index (hb_ot_layout_t *layout,
494 hb_ot_layout_table_type_t table_type,
495 unsigned int script_index,
496 unsigned int language_index,
497 unsigned int num_feature)
499 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
500 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
502 return l.get_feature_index (num_feature);
506 hb_ot_layout_language_get_feature_tag (hb_ot_layout_t *layout,
507 hb_ot_layout_table_type_t table_type,
508 unsigned int script_index,
509 unsigned int language_index,
510 unsigned int num_feature)
512 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
513 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
514 unsigned int feature_index = l.get_feature_index (num_feature);
516 return g.get_feature_tag (feature_index);
521 hb_ot_layout_language_find_feature (hb_ot_layout_t *layout,
522 hb_ot_layout_table_type_t table_type,
523 unsigned int script_index,
524 unsigned int language_index,
525 hb_tag_t feature_tag,
526 unsigned int *feature_index)
528 ASSERT_STATIC (NO_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
529 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
530 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
532 unsigned int num_features = l.get_feature_count ();
533 for (unsigned int i = 0; i < num_features; i++) {
534 unsigned int f_index = l.get_feature_index (i);
536 if (feature_tag == g.get_feature_tag (f_index)) {
537 if (feature_index) *feature_index = f_index;
542 if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
547 hb_ot_layout_feature_get_lookup_count (hb_ot_layout_t *layout,
548 hb_ot_layout_table_type_t table_type,
549 unsigned int feature_index)
551 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
552 const Feature &f = g.get_feature (feature_index);
554 return f.get_lookup_count ();
558 hb_ot_layout_feature_get_lookup_index (hb_ot_layout_t *layout,
559 hb_ot_layout_table_type_t table_type,
560 unsigned int feature_index,
561 unsigned int num_lookup)
563 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
564 const Feature &f = g.get_feature (feature_index);
566 return f.get_lookup_index (num_lookup);
574 hb_ot_layout_substitute_lookup (hb_ot_layout_t *layout,
576 unsigned int lookup_index,
577 hb_ot_layout_feature_mask_t mask)
579 return layout->gsub->substitute_lookup (layout, buffer, lookup_index, mask);
587 hb_ot_layout_position_lookup (hb_ot_layout_t *layout,
589 unsigned int lookup_index,
590 hb_ot_layout_feature_mask_t mask)
592 return layout->gpos->position_lookup (layout, buffer, lookup_index, mask);