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_OT_LAYOUT_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_OT_LAYOUT_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 /* TODO old harfbuzz doesn't always parse mark attachments as it says it was
142 * introduced without a version bump, so it may not be safe */
143 klass = layout->gdef->get_mark_attachment_type (glyph);
147 klass = layout->gdef->get_glyph_class (glyph);
149 if (!klass && glyph < layout->new_gdef.len)
150 klass = layout->new_gdef.klasses[glyph];
154 case GDEF::UnclassifiedGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED;
155 case GDEF::BaseGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH;
156 case GDEF::LigatureGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE;
157 case GDEF::MarkGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_MARK;
158 case GDEF::ComponentGlyph: return HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT;
162 HB_OT_LAYOUT_INTERNAL hb_bool_t
163 _hb_ot_layout_check_glyph_property (hb_ot_layout_t *layout,
165 unsigned int lookup_flags,
166 unsigned int *property)
168 hb_ot_layout_glyph_class_t basic_glyph_class;
169 unsigned int desired_attachment_class;
171 if (gitem->gproperty == HB_BUFFER_GLYPH_PROPERTIES_UNKNOWN)
173 gitem->gproperty = *property = _hb_ot_layout_get_glyph_property (layout, gitem->gindex);
174 if (gitem->gproperty == HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED)
178 *property = gitem->gproperty;
180 /* If the glyph was found in the MarkAttachmentClass table,
181 * then that class value is the high byte of the result,
182 * otherwise the low byte contains the basic type of the glyph
183 * as defined by the GlyphClassDef table.
185 if (*property & LookupFlag::MarkAttachmentType)
186 basic_glyph_class = HB_OT_LAYOUT_GLYPH_CLASS_MARK;
188 basic_glyph_class = (hb_ot_layout_glyph_class_t) *property;
190 /* Not covered, if, for example, basic_glyph_class
191 * is HB_GDEF_LIGATURE and lookup_flags includes LookupFlags::IgnoreLigatures
193 if (lookup_flags & basic_glyph_class)
196 /* The high byte of lookup_flags has the meaning
197 * "ignore marks of attachment type different than
198 * the attachment type specified."
200 desired_attachment_class = lookup_flags & LookupFlag::MarkAttachmentType;
201 if (desired_attachment_class)
203 if (basic_glyph_class == HB_OT_LAYOUT_GLYPH_CLASS_MARK &&
204 *property != desired_attachment_class)
211 HB_OT_LAYOUT_INTERNAL void
212 _hb_ot_layout_set_glyph_property (hb_ot_layout_t *layout,
213 hb_codepoint_t glyph,
214 unsigned int property)
216 hb_ot_layout_glyph_class_t klass;
218 if (property & LookupFlag::MarkAttachmentType)
219 klass = HB_OT_LAYOUT_GLYPH_CLASS_MARK;
221 klass = (hb_ot_layout_glyph_class_t) property;
223 hb_ot_layout_set_glyph_class (layout, glyph, klass);
227 hb_ot_layout_glyph_class_t
228 hb_ot_layout_get_glyph_class (hb_ot_layout_t *layout,
229 hb_codepoint_t glyph)
231 unsigned int property;
232 hb_ot_layout_class_t klass;
234 property = _hb_ot_layout_get_glyph_property (layout, glyph);
236 if (property & LookupFlag::MarkAttachmentType)
237 return HB_OT_LAYOUT_GLYPH_CLASS_MARK;
239 return (hb_ot_layout_glyph_class_t) property;
243 hb_ot_layout_set_glyph_class (hb_ot_layout_t *layout,
244 hb_codepoint_t glyph,
245 hb_ot_layout_glyph_class_t klass)
247 /* TODO optimize this, similar to old harfbuzz code for example */
249 hb_ot_layout_class_t gdef_klass;
250 int len = layout->new_gdef.len;
252 if (HB_UNLIKELY (glyph > 65535))
257 unsigned char *new_klasses;
259 new_len = len == 0 ? 120 : 2 * len;
262 new_klasses = (unsigned char *) realloc (layout->new_gdef.klasses, new_len * sizeof (unsigned char));
264 if (HB_UNLIKELY (!new_klasses))
267 memset (new_klasses + len, 0, new_len - len);
269 layout->new_gdef.klasses = new_klasses;
270 layout->new_gdef.len = new_len;
275 case HB_OT_LAYOUT_GLYPH_CLASS_UNCLASSIFIED: gdef_klass = GDEF::UnclassifiedGlyph; break;
276 case HB_OT_LAYOUT_GLYPH_CLASS_BASE_GLYPH: gdef_klass = GDEF::BaseGlyph; break;
277 case HB_OT_LAYOUT_GLYPH_CLASS_LIGATURE: gdef_klass = GDEF::LigatureGlyph; break;
278 case HB_OT_LAYOUT_GLYPH_CLASS_MARK: gdef_klass = GDEF::MarkGlyph; break;
279 case HB_OT_LAYOUT_GLYPH_CLASS_COMPONENT: gdef_klass = GDEF::ComponentGlyph; break;
282 layout->new_gdef.klasses[glyph] = gdef_klass;
287 hb_ot_layout_build_glyph_classes (hb_ot_layout_t *layout,
288 uint16_t num_total_glyphs,
289 hb_codepoint_t *glyphs,
290 unsigned char *klasses,
293 if (HB_UNLIKELY (!count || !glyphs || !klasses))
296 if (layout->new_gdef.len == 0) {
297 layout->new_gdef.klasses = (unsigned char *) calloc (num_total_glyphs, 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 (layout, glyphs[i], (hb_ot_layout_glyph_class_t) klasses[i]);
309 static const GSUBGPOS&
310 get_gsubgpos_table (hb_ot_layout_t *layout,
311 hb_ot_layout_table_type_t table_type)
313 switch (table_type) {
314 case HB_OT_LAYOUT_TABLE_TYPE_GSUB: return *(layout->gsub);
315 case HB_OT_LAYOUT_TABLE_TYPE_GPOS: return *(layout->gpos);
316 default: return Null(GSUBGPOS);
322 hb_ot_layout_table_get_script_count (hb_ot_layout_t *layout,
323 hb_ot_layout_table_type_t table_type)
325 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
327 return g.get_script_count ();
331 hb_ot_layout_table_get_script_tag (hb_ot_layout_t *layout,
332 hb_ot_layout_table_type_t table_type,
333 unsigned int script_index)
335 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
337 return g.get_script_tag (script_index);
341 hb_ot_layout_table_find_script (hb_ot_layout_t *layout,
342 hb_ot_layout_table_type_t table_type,
344 unsigned int *script_index)
346 ASSERT_STATIC (NO_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
347 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
349 if (g.find_script_index (script_tag, script_index))
352 /* try finding 'DFLT' */
353 if (g.find_script_index (HB_OT_LAYOUT_TAG_DEFAULT_SCRIPT, script_index))
356 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
357 if (g.find_script_index (HB_OT_LAYOUT_TAG_DEFAULT_LANGUAGE, script_index))
360 if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
365 hb_ot_layout_table_get_feature_count (hb_ot_layout_t *layout,
366 hb_ot_layout_table_type_t table_type)
368 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
370 return g.get_feature_count ();
374 hb_ot_layout_table_get_feature_tag (hb_ot_layout_t *layout,
375 hb_ot_layout_table_type_t table_type,
376 unsigned int feature_index)
378 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
380 return g.get_feature_tag (feature_index);
384 hb_ot_layout_table_find_feature (hb_ot_layout_t *layout,
385 hb_ot_layout_table_type_t table_type,
386 hb_tag_t feature_tag,
387 unsigned int *feature_index)
389 ASSERT_STATIC (NO_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
390 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
392 if (g.find_feature_index (feature_tag, feature_index))
395 if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
400 hb_ot_layout_table_get_lookup_count (hb_ot_layout_t *layout,
401 hb_ot_layout_table_type_t table_type)
403 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
405 return g.get_lookup_count ();
410 hb_ot_layout_script_get_language_count (hb_ot_layout_t *layout,
411 hb_ot_layout_table_type_t table_type,
412 unsigned int script_index)
414 const Script &s = get_gsubgpos_table (layout, table_type).get_script (script_index);
416 return s.get_lang_sys_count ();
420 hb_ot_layout_script_get_language_tag (hb_ot_layout_t *layout,
421 hb_ot_layout_table_type_t table_type,
422 unsigned int script_index,
423 unsigned int language_index)
425 const Script &s = get_gsubgpos_table (layout, table_type).get_script (script_index);
427 return s.get_lang_sys_tag (language_index);
431 hb_ot_layout_script_find_language (hb_ot_layout_t *layout,
432 hb_ot_layout_table_type_t table_type,
433 unsigned int script_index,
434 hb_tag_t language_tag,
435 unsigned int *language_index)
437 ASSERT_STATIC (NO_INDEX == HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX);
438 const Script &s = get_gsubgpos_table (layout, table_type).get_script (script_index);
440 if (s.find_lang_sys_index (language_tag, language_index))
443 /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
444 if (s.find_lang_sys_index (HB_OT_LAYOUT_TAG_DEFAULT_LANGUAGE, language_index))
447 if (language_index) *language_index = HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX;
452 hb_ot_layout_language_get_required_feature_index (hb_ot_layout_t *layout,
453 hb_ot_layout_table_type_t table_type,
454 unsigned int script_index,
455 unsigned int language_index,
456 unsigned int *feature_index)
458 const LangSys &l = get_gsubgpos_table (layout, table_type).get_script (script_index).get_lang_sys (language_index);
460 if (feature_index) *feature_index = l.get_required_feature_index ();
462 return l.has_required_feature ();
466 hb_ot_layout_language_get_feature_count (hb_ot_layout_t *layout,
467 hb_ot_layout_table_type_t table_type,
468 unsigned int script_index,
469 unsigned int language_index)
471 const LangSys &l = get_gsubgpos_table (layout, table_type).get_script (script_index).get_lang_sys (language_index);
473 return l.get_feature_count ();
477 hb_ot_layout_language_get_feature_index (hb_ot_layout_t *layout,
478 hb_ot_layout_table_type_t table_type,
479 unsigned int script_index,
480 unsigned int language_index,
481 unsigned int num_feature)
483 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
484 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
486 return l.get_feature_index (num_feature);
490 hb_ot_layout_language_get_feature_tag (hb_ot_layout_t *layout,
491 hb_ot_layout_table_type_t table_type,
492 unsigned int script_index,
493 unsigned int language_index,
494 unsigned int num_feature)
496 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
497 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
498 unsigned int feature_index = l.get_feature_index (num_feature);
500 return g.get_feature_tag (feature_index);
505 hb_ot_layout_language_find_feature (hb_ot_layout_t *layout,
506 hb_ot_layout_table_type_t table_type,
507 unsigned int script_index,
508 unsigned int language_index,
509 hb_tag_t feature_tag,
510 unsigned int *feature_index)
512 ASSERT_STATIC (NO_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
513 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
514 const LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
516 unsigned int num_features = l.get_feature_count ();
517 for (unsigned int i = 0; i < num_features; i++) {
518 unsigned int f_index = l.get_feature_index (i);
520 if (feature_tag == g.get_feature_tag (f_index)) {
521 if (feature_index) *feature_index = f_index;
526 if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
531 hb_ot_layout_feature_get_lookup_count (hb_ot_layout_t *layout,
532 hb_ot_layout_table_type_t table_type,
533 unsigned int feature_index)
535 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
536 const Feature &f = g.get_feature (feature_index);
538 return f.get_lookup_count ();
542 hb_ot_layout_feature_get_lookup_index (hb_ot_layout_t *layout,
543 hb_ot_layout_table_type_t table_type,
544 unsigned int feature_index,
545 unsigned int num_lookup)
547 const GSUBGPOS &g = get_gsubgpos_table (layout, table_type);
548 const Feature &f = g.get_feature (feature_index);
550 return f.get_lookup_index (num_lookup);
558 hb_ot_layout_substitute_lookup (hb_ot_layout_t *layout,
560 unsigned int lookup_index,
561 hb_ot_layout_feature_mask_t mask)
563 return layout->gsub->substitute_lookup (layout, buffer, lookup_index, mask);
571 hb_ot_layout_position_lookup (hb_ot_layout_t *layout,
573 unsigned int lookup_index,
574 hb_ot_layout_feature_mask_t mask)
576 return layout->gpos->position_lookup (layout, buffer, lookup_index, mask);
581 /* TODO dupped, until he old code can be removed */
584 hb_buffer_duplicate_out_buffer( HB_Buffer buffer )
586 if (!buffer->alt_string)
587 buffer->alt_string = (HB_GlyphItemRec_ *) malloc (buffer->allocated * sizeof (buffer->out_string[0]));
589 buffer->out_string = buffer->alt_string;
590 memcpy (buffer->out_string, buffer->in_string, buffer->out_length * sizeof (buffer->out_string[0]));
591 buffer->separate_out = TRUE;
600 _hb_buffer_add_output_glyph_ids (hb_buffer_t *buffer,
602 unsigned int num_out,
603 const GlyphID *glyph_data,
604 unsigned short component,
605 unsigned short ligID)
609 unsigned int properties;
610 unsigned int cluster;
612 hb_buffer_ensure( buffer, buffer->out_pos + num_out );
615 if ( !buffer->separate_out )
617 error = hb_buffer_duplicate_out_buffer( buffer );
622 properties = buffer->in_string[buffer->in_pos].properties;
623 cluster = buffer->in_string[buffer->in_pos].cluster;
624 if ( component == 0xFFFF )
625 component = buffer->in_string[buffer->in_pos].component;
626 if ( ligID == 0xFFFF )
627 ligID = buffer->in_string[buffer->in_pos].ligID;
629 for ( i = 0; i < num_out; i++ )
631 HB_GlyphItem item = &buffer->out_string[buffer->out_pos + i];
633 item->gindex = glyph_data[i];
634 item->properties = properties;
635 item->cluster = cluster;
636 item->component = component;
638 item->gproperty = HB_GLYPH_PROPERTY_UNKNOWN;
641 buffer->in_pos += num_in;
642 buffer->out_pos += num_out;
644 buffer->out_length = buffer->out_pos;