hb-ot-layout.cc 43.3 KB
Newer Older
B
Behdad Esfahbod 已提交
1
/*
B
Behdad Esfahbod 已提交
2 3 4
 * Copyright © 1998-2004  David Turner and Werner Lemberg
 * Copyright © 2006  Behdad Esfahbod
 * Copyright © 2007,2008,2009  Red Hat, Inc.
5
 * Copyright © 2012,2013  Google, Inc.
B
Behdad Esfahbod 已提交
6
 *
B
Behdad Esfahbod 已提交
7
 *  This is part of HarfBuzz, a text shaping library.
B
Behdad Esfahbod 已提交
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *
 * Permission is hereby granted, without written agreement and without
 * license or royalty fees, to use, copy, modify, and distribute this
 * software and its documentation for any purpose, provided that the
 * above copyright notice and the following two paragraphs appear in
 * all copies of this software.
 *
 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 *
 * Red Hat Author(s): Behdad Esfahbod
B
Behdad Esfahbod 已提交
28
 * Google Author(s): Behdad Esfahbod
B
Behdad Esfahbod 已提交
29 30
 */

B
Behdad Esfahbod 已提交
31
#include "hb-open-type-private.hh"
32
#include "hb-ot-layout-private.hh"
B
Behdad Esfahbod 已提交
33

34 35 36
#include "hb-ot-layout-gdef-table.hh"
#include "hb-ot-layout-gsub-table.hh"
#include "hb-ot-layout-gpos-table.hh"
37
#include "hb-ot-layout-jstf-table.hh"
38
#include "hb-ot-layout-math-table.hh"
B
Behdad Esfahbod 已提交
39

B
Behdad Esfahbod 已提交
40 41
#include "hb-ot-map-private.hh"

B
Behdad Esfahbod 已提交
42
#include <stdlib.h>
B
Behdad Esfahbod 已提交
43 44
#include <string.h>

B
Behdad Esfahbod 已提交
45

46
HB_SHAPER_DATA_ENSURE_DECLARE(ot, face)
47

B
Behdad Esfahbod 已提交
48
hb_ot_layout_t *
49
_hb_ot_layout_create (hb_face_t *face)
50
{
B
Behdad Esfahbod 已提交
51
  hb_ot_layout_t *layout = (hb_ot_layout_t *) calloc (1, sizeof (hb_ot_layout_t));
B
Minor  
Behdad Esfahbod 已提交
52 53
  if (unlikely (!layout))
    return NULL;
54

55 56
  layout->gdef_blob = OT::Sanitizer<OT::GDEF>::sanitize (face->reference_table (HB_OT_TAG_GDEF));
  layout->gdef = OT::Sanitizer<OT::GDEF>::lock_instance (layout->gdef_blob);
B
Behdad Esfahbod 已提交
57

58 59
  layout->gsub_blob = OT::Sanitizer<OT::GSUB>::sanitize (face->reference_table (HB_OT_TAG_GSUB));
  layout->gsub = OT::Sanitizer<OT::GSUB>::lock_instance (layout->gsub_blob);
B
Behdad Esfahbod 已提交
60

61 62
  layout->gpos_blob = OT::Sanitizer<OT::GPOS>::sanitize (face->reference_table (HB_OT_TAG_GPOS));
  layout->gpos = OT::Sanitizer<OT::GPOS>::lock_instance (layout->gpos_blob);
B
Behdad Esfahbod 已提交
63

64
  /* The MATH table is rarely used, so only try and load it in _get_math. */
65 66 67
  layout->math_blob = NULL;
  layout->math = NULL;

68 69 70 71 72 73 74 75 76 77
  {
    /*
     * The ugly business of blacklisting individual fonts' tables happen here!
     * See this thread for why we finally had to bend in and do this:
     * https://lists.freedesktop.org/archives/harfbuzz/2016-February/005489.html
     */
    unsigned int gdef_len = hb_blob_get_length (layout->gdef_blob);
    unsigned int gsub_len = hb_blob_get_length (layout->gsub_blob);
    unsigned int gpos_len = hb_blob_get_length (layout->gpos_blob);
    if (0
78 79 80 81 82 83 84 85 86 87 88 89
      /* sha1sum:c5ee92f0bca4bfb7d06c4d03e8cf9f9cf75d2e8a Windows 7? timesi.ttf */
      || (442 == gdef_len && 42038 == gpos_len && 2874 == gsub_len)
      /* sha1sum:37fc8c16a0894ab7b749e35579856c73c840867b Windows 7? timesbi.ttf */
      || (430 == gdef_len && 40662 == gpos_len && 2874 == gsub_len)
      /* sha1sum:19fc45110ea6cd3cdd0a5faca256a3797a069a80 Windows 7 timesi.ttf */
      || (442 == gdef_len && 39116 == gpos_len && 2874 == gsub_len)
      /* sha1sum:6d2d3c9ed5b7de87bc84eae0df95ee5232ecde26 Windows 7 timesbi.ttf */
      || (430 == gdef_len && 39374 == gpos_len && 2874 == gsub_len)
      /* sha1sum:8583225a8b49667c077b3525333f84af08c6bcd8 OS X 10.11.3 Times New Roman Italic.ttf */
      || (490 == gdef_len && 41638 == gpos_len && 3046 == gsub_len)
      /* sha1sum:ec0f5a8751845355b7c3271d11f9918a966cb8c9 OS X 10.11.3 Times New Roman Bold Italic.ttf */
      || (478 == gdef_len && 41902 == gpos_len && 3046 == gsub_len)
90 91 92 93 94 95 96 97 98 99 100
    )
    {
      /* In certain versions of Times New Roman Italic and Bold Italic,
       * ASCII double quotation mark U+0022, mapped to glyph 5, has wrong
       * glyph class 3 (mark) in GDEF.  Nuke the GDEF to avoid zero-width
       * double-quote.  See:
       * https://lists.freedesktop.org/archives/harfbuzz/2016-February/005489.html
       */
     if (3 == layout->gdef->get_glyph_class (5))
       layout->gdef = &OT::Null(OT::GDEF);
    }
J
jfkthame 已提交
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
    else if (0
      /* sha1sum:96eda93f7d33e79962451c6c39a6b51ee893ce8c  tahoma.ttf from Windows 8 */
      || (898 == gdef_len && 46470 == gpos_len && 12554 == gsub_len)
      /* sha1sum:20928dc06014e0cd120b6fc942d0c3b1a46ac2bc  tahomabd.ttf from Windows 8 */
      || (910 == gdef_len && 47732 == gpos_len && 12566 == gsub_len)
      /* sha1sum:4f95b7e4878f60fa3a39ca269618dfde9721a79e  tahoma.ttf from Windows 8.1 */
      || (928 == gdef_len && 59332 == gpos_len && 23298 == gsub_len)
      /* sha1sum:6d400781948517c3c0441ba42acb309584b73033  tahomabd.ttf from Windows 8.1 */
      || (940 == gdef_len && 60732 == gpos_len && 23310 == gsub_len)
      /* sha1sum:e55fa2dfe957a9f7ec26be516a0e30b0c925f846  tahoma.ttf from Windows 10 */
      || (994 == gdef_len && 60336 == gpos_len && 24474 == gsub_len)
      /* sha1sum:7199385abb4c2cc81c83a151a7599b6368e92343  tahomabd.ttf from Windows 10 */
      || (1006 == gdef_len && 61740 == gpos_len && 24470 == gsub_len)
      /* sha1sum:b0d36cf5a2fbe746a3dd277bffc6756a820807a7  Tahoma.ttf from Mac OS X 10.9 */
      || (832 == gdef_len && 47162 == gpos_len && 7324 == gsub_len)
      /* sha1sum:12fc4538e84d461771b30c18b5eb6bd434e30fba  Tahoma Bold.ttf from Mac OS X 10.9 */
      || (844 == gdef_len && 45474 == gpos_len && 7302 == gsub_len)
      /* sha1sum:73da7f025b238a3f737aa1fde22577a6370f77b0  himalaya.ttf from Windows 8 */
      || (192 == gdef_len && 7254 == gpos_len && 12638 == gsub_len)
      /* sha1sum:6e80fd1c0b059bbee49272401583160dc1e6a427  himalaya.ttf from Windows 8.1 */
      || (192 == gdef_len && 7254 == gpos_len && 12690 == gsub_len)
      /* 8d9267aea9cd2c852ecfb9f12a6e834bfaeafe44  cantarell-fonts-0.0.21/otf/Cantarell-Regular.otf */
      /* 983988ff7b47439ab79aeaf9a45bd4a2c5b9d371  cantarell-fonts-0.0.21/otf/Cantarell-Oblique.otf */
      || (188 == gdef_len && 3852 == gpos_len && 248 == gsub_len)
      /* 2c0c90c6f6087ffbfea76589c93113a9cbb0e75f  cantarell-fonts-0.0.21/otf/Cantarell-Bold.otf */
      /* 55461f5b853c6da88069ffcdf7f4dd3f8d7e3e6b  cantarell-fonts-0.0.21/otf/Cantarell-Bold-Oblique.otf */
      || (188 == gdef_len && 3426 == gpos_len && 264 == gsub_len)
128 129 130 131 132 133 134 135
      /* 6c93b63b64e8b2c93f5e824e78caca555dc887c7 padauk-2.80/Padauk-book.ttf */
      || (1046 == gdef_len && 17112 == gpos_len && 71788 == gsub_len)
      /* d89b1664058359b8ec82e35d3531931125991fb9 padauk-2.80/Padauk-bookbold.ttf */
      || (1058 == gdef_len && 17514 == gpos_len && 71794 == gsub_len)
      /* 824cfd193aaf6234b2b4dc0cf3c6ef576c0d00ef padauk-3.0/Padauk-book.ttf */
      || (1330 == gdef_len && 57938 == gpos_len && 109904 == gsub_len)
      /* 91fcc10cf15e012d27571e075b3b4dfe31754a8a padauk-3.0/Padauk-bookbold.ttf */
      || (1330 == gdef_len && 58972 == gpos_len && 109904 == gsub_len)
J
jfkthame 已提交
136 137 138 139 140 141 142 143 144 145 146 147
    )
    {
      /* Many versions of Tahoma have bad GDEF tables that incorrectly classify some spacing marks
       * such as certain IPA symbols as glyph class 3. So do older versions of Microsoft Himalaya,
       * and the version of Cantarell shipped by Ubuntu 16.04.
       * Nuke the GDEF tables of these fonts to avoid unwanted width-zeroing.
       * See https://bugzilla.mozilla.org/show_bug.cgi?id=1279925
       *     https://bugzilla.mozilla.org/show_bug.cgi?id=1279693
       *     https://bugzilla.mozilla.org/show_bug.cgi?id=1279875
       */
      layout->gdef = &OT::Null(OT::GDEF);
    }
148 149
  }

150 151 152
  layout->gsub_lookup_count = layout->gsub->get_lookup_count ();
  layout->gpos_lookup_count = layout->gpos->get_lookup_count ();

153 154
  layout->gsub_accels = (hb_ot_layout_lookup_accelerator_t *) calloc (layout->gsub->get_lookup_count (), sizeof (hb_ot_layout_lookup_accelerator_t));
  layout->gpos_accels = (hb_ot_layout_lookup_accelerator_t *) calloc (layout->gpos->get_lookup_count (), sizeof (hb_ot_layout_lookup_accelerator_t));
155

156 157
  if (unlikely ((layout->gsub_lookup_count && !layout->gsub_accels) ||
		(layout->gpos_lookup_count && !layout->gpos_accels)))
158 159 160 161 162
  {
    _hb_ot_layout_destroy (layout);
    return NULL;
  }

163
  for (unsigned int i = 0; i < layout->gsub_lookup_count; i++)
164
    layout->gsub_accels[i].init (layout->gsub->get_lookup (i));
165
  for (unsigned int i = 0; i < layout->gpos_lookup_count; i++)
166
    layout->gpos_accels[i].init (layout->gpos->get_lookup (i));
167

B
Behdad Esfahbod 已提交
168
  return layout;
B
Behdad Esfahbod 已提交
169 170
}

171
void
172
_hb_ot_layout_destroy (hb_ot_layout_t *layout)
B
Behdad Esfahbod 已提交
173
{
174
  for (unsigned int i = 0; i < layout->gsub_lookup_count; i++)
175
    layout->gsub_accels[i].fini ();
176
  for (unsigned int i = 0; i < layout->gpos_lookup_count; i++)
177
    layout->gpos_accels[i].fini ();
178 179 180

  free (layout->gsub_accels);
  free (layout->gpos_accels);
181

B
Bradley Grainger 已提交
182 183 184
  hb_blob_destroy (layout->gdef_blob);
  hb_blob_destroy (layout->gsub_blob);
  hb_blob_destroy (layout->gpos_blob);
185
  hb_blob_destroy (layout->math_blob);
186

B
Behdad Esfahbod 已提交
187
  free (layout);
188
}
B
Behdad Esfahbod 已提交
189

190
static inline const OT::GDEF&
191 192
_get_gdef (hb_face_t *face)
{
193
  if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return OT::Null(OT::GDEF);
194
  return *hb_ot_layout_from_face (face)->gdef;
195
}
196
static inline const OT::GSUB&
197
_get_gsub (hb_face_t *face)
B
Behdad Esfahbod 已提交
198
{
199
  if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return OT::Null(OT::GSUB);
200
  return *hb_ot_layout_from_face (face)->gsub;
B
Behdad Esfahbod 已提交
201
}
202
static inline const OT::GPOS&
203
_get_gpos (hb_face_t *face)
B
Behdad Esfahbod 已提交
204
{
205
  if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return OT::Null(OT::GPOS);
206
  return *hb_ot_layout_from_face (face)->gpos;
B
Behdad Esfahbod 已提交
207
}
208 209 210 211 212 213 214
static inline const OT::MATH&
_get_math (hb_face_t *face)
{
  if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return OT::Null(OT::MATH);

  hb_ot_layout_t * layout = hb_ot_layout_from_face (face);

215 216 217 218 219 220 221 222 223 224 225 226 227
retry:
  const OT::MATH *math = (const OT::MATH *) hb_atomic_ptr_get (&layout->math);

  if (unlikely (!math))
  {
    hb_blob_t *blob = OT::Sanitizer<OT::MATH>::sanitize (face->reference_table (HB_OT_TAG_MATH));
    math = OT::Sanitizer<OT::MATH>::lock_instance (blob);
    if (!hb_atomic_ptr_cmpexch (&layout->math, NULL, math))
    {
      hb_blob_destroy (blob);
      goto retry;
    }
    layout->math_blob = blob;
228 229
  }

230
  return *math;
231
}
B
Behdad Esfahbod 已提交
232

233

B
Behdad Esfahbod 已提交
234 235 236 237 238
/*
 * GDEF
 */

hb_bool_t
239
hb_ot_layout_has_glyph_classes (hb_face_t *face)
B
Behdad Esfahbod 已提交
240
{
241
  return _get_gdef (face).has_glyph_classes ();
B
Behdad Esfahbod 已提交
242 243
}

S
Sascha Brawer 已提交
244
/**
B
Behdad Esfahbod 已提交
245 246
 * hb_ot_layout_get_glyph_class:
 *
S
Sascha Brawer 已提交
247 248
 * Since: 0.9.7
 **/
249 250 251 252 253 254
hb_ot_layout_glyph_class_t
hb_ot_layout_get_glyph_class (hb_face_t      *face,
			      hb_codepoint_t  glyph)
{
  return (hb_ot_layout_glyph_class_t) _get_gdef (face).get_glyph_class (glyph);
}
B
Behdad Esfahbod 已提交
255

S
Sascha Brawer 已提交
256
/**
B
Behdad Esfahbod 已提交
257 258
 * hb_ot_layout_get_glyphs_in_class:
 *
S
Sascha Brawer 已提交
259 260
 * Since: 0.9.7
 **/
261 262 263 264 265 266 267 268
void
hb_ot_layout_get_glyphs_in_class (hb_face_t                  *face,
				  hb_ot_layout_glyph_class_t  klass,
				  hb_set_t                   *glyphs /* OUT */)
{
  return _get_gdef (face).get_glyphs_in_class (klass, glyphs);
}

B
Behdad Esfahbod 已提交
269
unsigned int
270
hb_ot_layout_get_attach_points (hb_face_t      *face,
B
Behdad Esfahbod 已提交
271
				hb_codepoint_t  glyph,
B
Behdad Esfahbod 已提交
272
				unsigned int    start_offset,
B
Behdad Esfahbod 已提交
273 274 275
				unsigned int   *point_count /* IN/OUT */,
				unsigned int   *point_array /* OUT */)
{
B
Behdad Esfahbod 已提交
276
  return _get_gdef (face).get_attach_points (glyph, start_offset, point_count, point_array);
B
Behdad Esfahbod 已提交
277 278
}

B
Behdad Esfahbod 已提交
279
unsigned int
280 281 282 283 284 285
hb_ot_layout_get_ligature_carets (hb_font_t      *font,
				  hb_direction_t  direction,
				  hb_codepoint_t  glyph,
				  unsigned int    start_offset,
				  unsigned int   *caret_count /* IN/OUT */,
				  int            *caret_array /* OUT */)
B
Behdad Esfahbod 已提交
286
{
287
  return _get_gdef (font->face).get_lig_carets (font, direction, glyph, start_offset, caret_count, caret_array);
B
Behdad Esfahbod 已提交
288 289
}

290

291 292 293 294
/*
 * GSUB/GPOS
 */

295
static const OT::GSUBGPOS&
296 297
get_gsubgpos_table (hb_face_t *face,
		    hb_tag_t   table_tag)
298
{
299
  switch (table_tag) {
300 301
    case HB_OT_TAG_GSUB: return _get_gsub (face);
    case HB_OT_TAG_GPOS: return _get_gpos (face);
302
    default:             return OT::Null(OT::GSUBGPOS);
303 304 305 306
  }
}


B
Behdad Esfahbod 已提交
307
unsigned int
308 309
hb_ot_layout_table_get_script_tags (hb_face_t    *face,
				    hb_tag_t      table_tag,
B
Behdad Esfahbod 已提交
310
				    unsigned int  start_offset,
311 312
				    unsigned int *script_count /* IN/OUT */,
				    hb_tag_t     *script_tags /* OUT */)
313
{
314
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
315

B
Behdad Esfahbod 已提交
316
  return g.get_script_tags (start_offset, script_count, script_tags);
317 318
}

B
Minor  
Behdad Esfahbod 已提交
319 320
#define HB_OT_TAG_LATIN_SCRIPT		HB_TAG ('l', 'a', 't', 'n')

321
hb_bool_t
322 323 324 325
hb_ot_layout_table_find_script (hb_face_t    *face,
				hb_tag_t      table_tag,
				hb_tag_t      script_tag,
				unsigned int *script_index)
326
{
327 328
  ASSERT_STATIC (OT::Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
329 330

  if (g.find_script_index (script_tag, script_index))
331
    return true;
332 333

  /* try finding 'DFLT' */
334
  if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
335
    return false;
336

337 338
  /* try with 'dflt'; MS site has had typos and many fonts use it now :(.
   * including many versions of DejaVu Sans Mono! */
339
  if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index))
340
    return false;
B
Behdad Esfahbod 已提交
341

B
Minor  
Behdad Esfahbod 已提交
342 343 344 345 346
  /* try with 'latn'; some old fonts put their features there even though
     they're really trying to support Thai, for example :( */
  if (g.find_script_index (HB_OT_TAG_LATIN_SCRIPT, script_index))
    return false;

B
Behdad Esfahbod 已提交
347
  if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
348
  return false;
B
Behdad Esfahbod 已提交
349 350 351 352 353 354
}

hb_bool_t
hb_ot_layout_table_choose_script (hb_face_t      *face,
				  hb_tag_t        table_tag,
				  const hb_tag_t *script_tags,
B
Behdad Esfahbod 已提交
355 356
				  unsigned int   *script_index,
				  hb_tag_t       *chosen_script)
B
Behdad Esfahbod 已提交
357
{
358 359
  ASSERT_STATIC (OT::Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX);
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
B
Behdad Esfahbod 已提交
360 361 362

  while (*script_tags)
  {
B
Behdad Esfahbod 已提交
363 364 365
    if (g.find_script_index (*script_tags, script_index)) {
      if (chosen_script)
        *chosen_script = *script_tags;
366
      return true;
B
Behdad Esfahbod 已提交
367
    }
B
Behdad Esfahbod 已提交
368 369 370 371
    script_tags++;
  }

  /* try finding 'DFLT' */
B
Behdad Esfahbod 已提交
372 373 374
  if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index)) {
    if (chosen_script)
      *chosen_script = HB_OT_TAG_DEFAULT_SCRIPT;
375
    return false;
B
Behdad Esfahbod 已提交
376
  }
B
Behdad Esfahbod 已提交
377 378

  /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
B
Behdad Esfahbod 已提交
379 380 381
  if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index)) {
    if (chosen_script)
      *chosen_script = HB_OT_TAG_DEFAULT_LANGUAGE;
382
    return false;
B
Behdad Esfahbod 已提交
383
  }
384

385 386 387 388 389
  /* try with 'latn'; some old fonts put their features there even though
     they're really trying to support Thai, for example :( */
  if (g.find_script_index (HB_OT_TAG_LATIN_SCRIPT, script_index)) {
    if (chosen_script)
      *chosen_script = HB_OT_TAG_LATIN_SCRIPT;
390
    return false;
391 392
  }

393
  if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
B
Behdad Esfahbod 已提交
394 395
  if (chosen_script)
    *chosen_script = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
396
  return false;
397 398
}

B
Behdad Esfahbod 已提交
399
unsigned int
400 401
hb_ot_layout_table_get_feature_tags (hb_face_t    *face,
				     hb_tag_t      table_tag,
B
Behdad Esfahbod 已提交
402
				     unsigned int  start_offset,
403 404
				     unsigned int *feature_count /* IN/OUT */,
				     hb_tag_t     *feature_tags /* OUT */)
405
{
406
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
407

B
Behdad Esfahbod 已提交
408
  return g.get_feature_tags (start_offset, feature_count, feature_tags);
409 410
}

411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
hb_bool_t
hb_ot_layout_table_find_feature (hb_face_t    *face,
				 hb_tag_t      table_tag,
				 hb_tag_t      feature_tag,
				 unsigned int *feature_index)
{
  ASSERT_STATIC (OT::Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);

  unsigned int num_features = g.get_feature_count ();
  for (unsigned int i = 0; i < num_features; i++)
  {
    if (feature_tag == g.get_feature_tag (i)) {
      if (feature_index) *feature_index = i;
      return true;
    }
  }

  if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
  return false;
}

433

B
Behdad Esfahbod 已提交
434
unsigned int
435 436 437
hb_ot_layout_script_get_language_tags (hb_face_t    *face,
				       hb_tag_t      table_tag,
				       unsigned int  script_index,
B
Behdad Esfahbod 已提交
438
				       unsigned int  start_offset,
439 440
				       unsigned int *language_count /* IN/OUT */,
				       hb_tag_t     *language_tags /* OUT */)
441
{
442
  const OT::Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
443

B
Behdad Esfahbod 已提交
444
  return s.get_lang_sys_tags (start_offset, language_count, language_tags);
445 446 447
}

hb_bool_t
448 449 450 451 452
hb_ot_layout_script_find_language (hb_face_t    *face,
				   hb_tag_t      table_tag,
				   unsigned int  script_index,
				   hb_tag_t      language_tag,
				   unsigned int *language_index)
453
{
454 455
  ASSERT_STATIC (OT::Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX);
  const OT::Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
456

457
  if (s.find_lang_sys_index (language_tag, language_index))
458
    return true;
459 460

  /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
461
  if (s.find_lang_sys_index (HB_OT_TAG_DEFAULT_LANGUAGE, language_index))
462
    return false;
463

464
  if (language_index) *language_index = HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX;
465
  return false;
466
}
467

B
Behdad Esfahbod 已提交
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
hb_bool_t
hb_ot_layout_language_get_required_feature_index (hb_face_t    *face,
						  hb_tag_t      table_tag,
						  unsigned int  script_index,
						  unsigned int  language_index,
						  unsigned int *feature_index)
{
  return hb_ot_layout_language_get_required_feature (face,
						     table_tag,
						     script_index,
						     language_index,
						     feature_index,
						     NULL);
}

S
Sascha Brawer 已提交
483
/**
B
Behdad Esfahbod 已提交
484 485
 * hb_ot_layout_language_get_required_feature:
 *
S
Sascha Brawer 已提交
486 487
 * Since: 0.9.30
 **/
488
hb_bool_t
489 490 491 492 493 494
hb_ot_layout_language_get_required_feature (hb_face_t    *face,
					    hb_tag_t      table_tag,
					    unsigned int  script_index,
					    unsigned int  language_index,
					    unsigned int *feature_index,
					    hb_tag_t     *feature_tag)
495
{
496 497
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
  const OT::LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
498

499 500 501
  unsigned int index = l.get_required_feature_index ();
  if (feature_index) *feature_index = index;
  if (feature_tag) *feature_tag = g.get_feature_tag (index);
502

503 504
  return l.has_required_feature ();
}
505

B
Behdad Esfahbod 已提交
506
unsigned int
507 508 509 510
hb_ot_layout_language_get_feature_indexes (hb_face_t    *face,
					   hb_tag_t      table_tag,
					   unsigned int  script_index,
					   unsigned int  language_index,
B
Behdad Esfahbod 已提交
511
					   unsigned int  start_offset,
512 513
					   unsigned int *feature_count /* IN/OUT */,
					   unsigned int *feature_indexes /* OUT */)
514
{
515 516
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
  const OT::LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
517

B
Behdad Esfahbod 已提交
518
  return l.get_feature_indexes (start_offset, feature_count, feature_indexes);
519 520
}

B
Behdad Esfahbod 已提交
521
unsigned int
522 523 524 525
hb_ot_layout_language_get_feature_tags (hb_face_t    *face,
					hb_tag_t      table_tag,
					unsigned int  script_index,
					unsigned int  language_index,
B
Behdad Esfahbod 已提交
526
					unsigned int  start_offset,
527 528
					unsigned int *feature_count /* IN/OUT */,
					hb_tag_t     *feature_tags /* OUT */)
529
{
530 531
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
  const OT::LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
532

533
  ASSERT_STATIC (sizeof (unsigned int) == sizeof (hb_tag_t));
B
Behdad Esfahbod 已提交
534
  unsigned int ret = l.get_feature_indexes (start_offset, feature_count, (unsigned int *) feature_tags);
535

B
Behdad Esfahbod 已提交
536 537 538 539 540
  if (feature_tags) {
    unsigned int count = *feature_count;
    for (unsigned int i = 0; i < count; i++)
      feature_tags[i] = g.get_feature_tag ((unsigned int) feature_tags[i]);
  }
541 542

  return ret;
543 544 545 546
}


hb_bool_t
547 548 549 550 551 552
hb_ot_layout_language_find_feature (hb_face_t    *face,
				    hb_tag_t      table_tag,
				    unsigned int  script_index,
				    unsigned int  language_index,
				    hb_tag_t      feature_tag,
				    unsigned int *feature_index)
553
{
554 555 556
  ASSERT_STATIC (OT::Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX);
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
  const OT::LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
557

B
Behdad Esfahbod 已提交
558 559
  unsigned int num_features = l.get_feature_count ();
  for (unsigned int i = 0; i < num_features; i++) {
560 561 562 563
    unsigned int f_index = l.get_feature_index (i);

    if (feature_tag == g.get_feature_tag (f_index)) {
      if (feature_index) *feature_index = f_index;
564
      return true;
565 566
    }
  }
567

568
  if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
569
  return false;
570
}
571

S
Sascha Brawer 已提交
572
/**
K
Khaled Hosny 已提交
573 574
 * hb_ot_layout_feature_get_lookups:
 *
S
Sascha Brawer 已提交
575 576
 * Since: 0.9.7
 **/
B
Behdad Esfahbod 已提交
577
unsigned int
578 579 580 581 582 583
hb_ot_layout_feature_get_lookups (hb_face_t    *face,
				  hb_tag_t      table_tag,
				  unsigned int  feature_index,
				  unsigned int  start_offset,
				  unsigned int *lookup_count /* IN/OUT */,
				  unsigned int *lookup_indexes /* OUT */)
584
{
585 586
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
  const OT::Feature &f = g.get_feature (feature_index);
587

B
Behdad Esfahbod 已提交
588
  return f.get_lookup_indexes (start_offset, lookup_count, lookup_indexes);
589 590
}

S
Sascha Brawer 已提交
591
/**
K
Khaled Hosny 已提交
592 593
 * hb_ot_layout_table_get_lookup_count:
 *
S
Sascha Brawer 已提交
594 595
 * Since: 0.9.22
 **/
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
unsigned int
hb_ot_layout_table_get_lookup_count (hb_face_t    *face,
				     hb_tag_t      table_tag)
{
  switch (table_tag)
  {
    case HB_OT_TAG_GSUB:
    {
      return hb_ot_layout_from_face (face)->gsub_lookup_count;
    }
    case HB_OT_TAG_GPOS:
    {
      return hb_ot_layout_from_face (face)->gpos_lookup_count;
    }
  }
B
Behdad Esfahbod 已提交
611
  return 0;
612 613
}

614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
static void
_hb_ot_layout_collect_lookups_lookups (hb_face_t      *face,
				       hb_tag_t        table_tag,
				       unsigned int    feature_index,
				       hb_set_t       *lookup_indexes /* OUT */)
{
  unsigned int lookup_indices[32];
  unsigned int offset, len;

  offset = 0;
  do {
    len = ARRAY_LENGTH (lookup_indices);
    hb_ot_layout_feature_get_lookups (face,
				      table_tag,
				      feature_index,
				      offset, &len,
				      lookup_indices);

    for (unsigned int i = 0; i < len; i++)
      lookup_indexes->add (lookup_indices[i]);

    offset += len;
  } while (len == ARRAY_LENGTH (lookup_indices));
}

static void
_hb_ot_layout_collect_lookups_features (hb_face_t      *face,
					hb_tag_t        table_tag,
					unsigned int    script_index,
					unsigned int    language_index,
					const hb_tag_t *features,
					hb_set_t       *lookup_indexes /* OUT */)
{
  if (!features)
  {
649
    unsigned int required_feature_index;
650 651 652 653 654 655
    if (hb_ot_layout_language_get_required_feature (face,
						    table_tag,
						    script_index,
						    language_index,
						    &required_feature_index,
						    NULL))
656 657 658 659 660
      _hb_ot_layout_collect_lookups_lookups (face,
					     table_tag,
					     required_feature_index,
					     lookup_indexes);

661
    /* All features */
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
    unsigned int feature_indices[32];
    unsigned int offset, len;

    offset = 0;
    do {
      len = ARRAY_LENGTH (feature_indices);
      hb_ot_layout_language_get_feature_indexes (face,
						 table_tag,
						 script_index,
						 language_index,
						 offset, &len,
						 feature_indices);

      for (unsigned int i = 0; i < len; i++)
	_hb_ot_layout_collect_lookups_lookups (face,
					       table_tag,
					       feature_indices[i],
					       lookup_indexes);

      offset += len;
    } while (len == ARRAY_LENGTH (feature_indices));
  }
  else
  {
686 687 688
    for (; *features; features++)
    {
      unsigned int feature_index;
B
Behdad Esfahbod 已提交
689 690 691 692 693 694 695 696 697 698
      if (hb_ot_layout_language_find_feature (face,
					      table_tag,
					      script_index,
					      language_index,
					      *features,
					      &feature_index))
        _hb_ot_layout_collect_lookups_lookups (face,
					       table_tag,
					       feature_index,
					       lookup_indexes);
699 700 701 702 703 704 705 706 707 708 709 710
    }
  }
}

static void
_hb_ot_layout_collect_lookups_languages (hb_face_t      *face,
					 hb_tag_t        table_tag,
					 unsigned int    script_index,
					 const hb_tag_t *languages,
					 const hb_tag_t *features,
					 hb_set_t       *lookup_indexes /* OUT */)
{
711 712 713 714 715 716 717
  _hb_ot_layout_collect_lookups_features (face,
					  table_tag,
					  script_index,
					  HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX,
					  features,
					  lookup_indexes);

718 719 720
  if (!languages)
  {
    /* All languages */
B
Behdad Esfahbod 已提交
721 722 723 724
    unsigned int count = hb_ot_layout_script_get_language_tags (face,
								table_tag,
								script_index,
								0, NULL, NULL);
725
    for (unsigned int language_index = 0; language_index < count; language_index++)
B
Behdad Esfahbod 已提交
726 727 728 729 730 731
      _hb_ot_layout_collect_lookups_features (face,
					      table_tag,
					      script_index,
					      language_index,
					      features,
					      lookup_indexes);
732 733 734
  }
  else
  {
735 736 737
    for (; *languages; languages++)
    {
      unsigned int language_index;
B
Behdad Esfahbod 已提交
738 739 740 741 742 743 744 745 746 747 748
      if (hb_ot_layout_script_find_language (face,
					     table_tag,
					     script_index,
					     *languages,
					     &language_index))
        _hb_ot_layout_collect_lookups_features (face,
						table_tag,
						script_index,
						language_index,
						features,
						lookup_indexes);
749 750 751 752
    }
  }
}

S
Sascha Brawer 已提交
753
/**
K
Khaled Hosny 已提交
754 755
 * hb_ot_layout_collect_lookups:
 *
S
Sascha Brawer 已提交
756 757
 * Since: 0.9.8
 **/
758 759 760 761 762 763 764 765 766 767 768
void
hb_ot_layout_collect_lookups (hb_face_t      *face,
			      hb_tag_t        table_tag,
			      const hb_tag_t *scripts,
			      const hb_tag_t *languages,
			      const hb_tag_t *features,
			      hb_set_t       *lookup_indexes /* OUT */)
{
  if (!scripts)
  {
    /* All scripts */
B
Behdad Esfahbod 已提交
769 770 771
    unsigned int count = hb_ot_layout_table_get_script_tags (face,
							     table_tag,
							     0, NULL, NULL);
772
    for (unsigned int script_index = 0; script_index < count; script_index++)
B
Behdad Esfahbod 已提交
773 774 775 776 777 778
      _hb_ot_layout_collect_lookups_languages (face,
					       table_tag,
					       script_index,
					       languages,
					       features,
					       lookup_indexes);
779 780 781
  }
  else
  {
782 783 784
    for (; *scripts; scripts++)
    {
      unsigned int script_index;
B
Behdad Esfahbod 已提交
785 786 787 788 789 790 791 792 793 794
      if (hb_ot_layout_table_find_script (face,
					  table_tag,
					  *scripts,
					  &script_index))
        _hb_ot_layout_collect_lookups_languages (face,
						 table_tag,
						 script_index,
						 languages,
						 features,
						 lookup_indexes);
795 796 797 798
    }
  }
}

S
Sascha Brawer 已提交
799
/**
K
Khaled Hosny 已提交
800 801
 * hb_ot_layout_lookup_collect_glyphs:
 *
S
Sascha Brawer 已提交
802 803
 * Since: 0.9.7
 **/
804 805 806 807 808 809 810 811 812 813 814
void
hb_ot_layout_lookup_collect_glyphs (hb_face_t    *face,
				    hb_tag_t      table_tag,
				    unsigned int  lookup_index,
				    hb_set_t     *glyphs_before, /* OUT. May be NULL */
				    hb_set_t     *glyphs_input,  /* OUT. May be NULL */
				    hb_set_t     *glyphs_after,  /* OUT. May be NULL */
				    hb_set_t     *glyphs_output  /* OUT. May be NULL */)
{
  if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return;

B
Behdad Esfahbod 已提交
815 816 817 818 819
  OT::hb_collect_glyphs_context_t c (face,
				     glyphs_before,
				     glyphs_input,
				     glyphs_after,
				     glyphs_output);
820

821 822
  switch (table_tag)
  {
823 824
    case HB_OT_TAG_GSUB:
    {
825
      const OT::SubstLookup& l = hb_ot_layout_from_face (face)->gsub->get_lookup (lookup_index);
B
Behdad Esfahbod 已提交
826
      l.collect_glyphs (&c);
827 828 829 830
      return;
    }
    case HB_OT_TAG_GPOS:
    {
831
      const OT::PosLookup& l = hb_ot_layout_from_face (face)->gpos->get_lookup (lookup_index);
B
Behdad Esfahbod 已提交
832
      l.collect_glyphs (&c);
833 834 835 836 837
      return;
    }
  }
}

B
Behdad Esfahbod 已提交
838 839

/*
840
 * OT::GSUB
B
Behdad Esfahbod 已提交
841 842 843
 */

hb_bool_t
844 845
hb_ot_layout_has_substitution (hb_face_t *face)
{
846
  return &_get_gsub (face) != &OT::Null(OT::GSUB);
847 848
}

S
Sascha Brawer 已提交
849
/**
K
Khaled Hosny 已提交
850 851
 * hb_ot_layout_lookup_would_substitute:
 *
S
Sascha Brawer 已提交
852 853
 * Since: 0.9.7
 **/
854
hb_bool_t
855
hb_ot_layout_lookup_would_substitute (hb_face_t            *face,
856
				      unsigned int          lookup_index,
857 858
				      const hb_codepoint_t *glyphs,
				      unsigned int          glyphs_length,
859
				      hb_bool_t             zero_context)
860
{
861
  if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return false;
862
  return hb_ot_layout_lookup_would_substitute_fast (face, lookup_index, glyphs, glyphs_length, zero_context);
863 864
}

B
Behdad Esfahbod 已提交
865
hb_bool_t
866
hb_ot_layout_lookup_would_substitute_fast (hb_face_t            *face,
867
					   unsigned int          lookup_index,
B
Behdad Esfahbod 已提交
868 869
					   const hb_codepoint_t *glyphs,
					   unsigned int          glyphs_length,
870
					   hb_bool_t             zero_context)
B
Behdad Esfahbod 已提交
871
{
872
  if (unlikely (lookup_index >= hb_ot_layout_from_face (face)->gsub_lookup_count)) return false;
873
  OT::hb_would_apply_context_t c (face, glyphs, glyphs_length, (bool) zero_context);
B
Behdad Esfahbod 已提交
874 875 876

  const OT::SubstLookup& l = hb_ot_layout_from_face (face)->gsub->get_lookup (lookup_index);

877
  return l.would_apply (&c, &hb_ot_layout_from_face (face)->gsub_accels[lookup_index]);
B
Behdad Esfahbod 已提交
878 879
}

880
void
881
hb_ot_layout_substitute_start (hb_font_t *font, hb_buffer_t *buffer)
882
{
883
  OT::GSUB::substitute_start (font, buffer);
884 885
}

S
Sascha Brawer 已提交
886
/**
K
Khaled Hosny 已提交
887 888
 * hb_ot_layout_lookup_substitute_closure:
 *
S
Sascha Brawer 已提交
889 890
 * Since: 0.9.7
 **/
B
Behdad Esfahbod 已提交
891
void
892
hb_ot_layout_lookup_substitute_closure (hb_face_t    *face,
893 894
				        unsigned int  lookup_index,
				        hb_set_t     *glyphs)
895
{
896 897 898 899 900
  OT::hb_closure_context_t c (face, glyphs);

  const OT::SubstLookup& l = _get_gsub (face).get_lookup (lookup_index);

  l.closure (&c);
901
}
902

903
/*
904
 * OT::GPOS
905 906 907
 */

hb_bool_t
908 909
hb_ot_layout_has_positioning (hb_face_t *face)
{
910
  return &_get_gpos (face) != &OT::Null(OT::GPOS);
911 912
}

913
void
914
hb_ot_layout_position_start (hb_font_t *font, hb_buffer_t *buffer)
915
{
916
  OT::GPOS::position_start (font, buffer);
917 918
}

919
void
920 921 922 923 924 925 926
hb_ot_layout_position_finish_advances (hb_font_t *font, hb_buffer_t *buffer)
{
  OT::GPOS::position_finish_advances (font, buffer);
}

void
hb_ot_layout_position_finish_offsets (hb_font_t *font, hb_buffer_t *buffer)
927
{
928
  OT::GPOS::position_finish_offsets (font, buffer);
929
}
930

S
Sascha Brawer 已提交
931
/**
K
Khaled Hosny 已提交
932 933
 * hb_ot_layout_get_size_params:
 *
B
Behdad Esfahbod 已提交
934
 * Since: 0.9.10
S
Sascha Brawer 已提交
935
 **/
936
hb_bool_t
937 938 939 940 941 942
hb_ot_layout_get_size_params (hb_face_t    *face,
			      unsigned int *design_size,       /* OUT.  May be NULL */
			      unsigned int *subfamily_id,      /* OUT.  May be NULL */
			      unsigned int *subfamily_name_id, /* OUT.  May be NULL */
			      unsigned int *range_start,       /* OUT.  May be NULL */
			      unsigned int *range_end          /* OUT.  May be NULL */)
943 944
{
  const OT::GPOS &gpos = _get_gpos (face);
945
  const hb_tag_t tag = HB_TAG ('s','i','z','e');
946

947 948 949
  unsigned int num_features = gpos.get_feature_count ();
  for (unsigned int i = 0; i < num_features; i++)
  {
950
    if (tag == gpos.get_feature_tag (i))
951
    {
952
      const OT::Feature &f = gpos.get_feature (i);
953
      const OT::FeatureParamsSize &params = f.get_feature_params ().get_size_params (tag);
954

955
      if (params.designSize)
956
      {
957
#define PARAM(a, A) if (a) *a = params.A
958 959 960 961 962 963
	PARAM (design_size, designSize);
	PARAM (subfamily_id, subfamilyID);
	PARAM (subfamily_name_id, subfamilyNameID);
	PARAM (range_start, rangeStart);
	PARAM (range_end, rangeEnd);
#undef PARAM
964 965 966

	return true;
      }
967 968 969
    }
  }

970
#define PARAM(a, A) if (a) *a = 0
971 972 973 974 975
  PARAM (design_size, designSize);
  PARAM (subfamily_id, subfamilyID);
  PARAM (subfamily_name_id, subfamilyNameID);
  PARAM (range_start, rangeStart);
  PARAM (range_end, rangeEnd);
976
#undef PARAM
977

978
  return false;
979
}
B
Behdad Esfahbod 已提交
980 981 982


/*
B
Behdad Esfahbod 已提交
983
 * Parts of different types are implemented here such that they have direct
B
Behdad Esfahbod 已提交
984 985 986 987
 * access to GSUB/GPOS lookups.
 */


B
Behdad Esfahbod 已提交
988 989 990
struct GSUBProxy
{
  static const unsigned int table_index = 0;
B
Behdad Esfahbod 已提交
991
  static const bool inplace = false;
B
Behdad Esfahbod 已提交
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
  typedef OT::SubstLookup Lookup;

  GSUBProxy (hb_face_t *face) :
    table (*hb_ot_layout_from_face (face)->gsub),
    accels (hb_ot_layout_from_face (face)->gsub_accels) {}

  const OT::GSUB &table;
  const hb_ot_layout_lookup_accelerator_t *accels;
};

struct GPOSProxy
{
  static const unsigned int table_index = 1;
B
Behdad Esfahbod 已提交
1005
  static const bool inplace = true;
B
Behdad Esfahbod 已提交
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
  typedef OT::PosLookup Lookup;

  GPOSProxy (hb_face_t *face) :
    table (*hb_ot_layout_from_face (face)->gpos),
    accels (hb_ot_layout_from_face (face)->gpos_accels) {}

  const OT::GPOS &table;
  const hb_ot_layout_lookup_accelerator_t *accels;
};


1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
struct hb_get_subtables_context_t :
       OT::hb_dispatch_context_t<hb_get_subtables_context_t, hb_void_t, HB_DEBUG_APPLY>
{
  template <typename Type>
  static inline bool apply_to (const void *obj, OT::hb_apply_context_t *c)
  {
    const Type *typed_obj = (const Type *) obj;
    return typed_obj->apply (c);
  }

  typedef bool (*hb_apply_func_t) (const void *obj, OT::hb_apply_context_t *c);

  struct hb_applicable_t
  {
    inline void init (const void *obj_, hb_apply_func_t apply_func_)
    {
      obj = obj_;
      apply_func = apply_func_;
    }

    inline bool apply (OT::hb_apply_context_t *c) const { return apply_func (obj, c); }

    private:
    const void *obj;
    hb_apply_func_t apply_func;
  };

  typedef hb_auto_array_t<hb_applicable_t> array_t;

  /* Dispatch interface. */
  inline const char *get_name (void) { return "GET_SUBTABLES"; }
  template <typename T>
  inline return_t dispatch (const T &obj)
  {
    hb_applicable_t *entry = array.push();
    if (likely (entry))
      entry->init (&obj, apply_to<T>);
    return HB_VOID;
  }
  static return_t default_return_value (void) { return HB_VOID; }
  bool stop_sublookup_iteration (return_t r HB_UNUSED) const { return false; }

  hb_get_subtables_context_t (array_t &array_) :
			      array (array_),
			      debug_depth (0) {}

  array_t &array;
  unsigned int debug_depth;
};

1067 1068
static inline bool
apply_forward (OT::hb_apply_context_t *c,
1069 1070
	       const hb_ot_layout_lookup_accelerator_t &accel,
	       const hb_get_subtables_context_t::array_t &subtables)
1071 1072 1073
{
  bool ret = false;
  hb_buffer_t *buffer = c->buffer;
1074
  while (buffer->idx < buffer->len && !buffer->in_error)
1075
  {
1076
    bool applied = false;
1077 1078
    if (accel.may_have (buffer->cur().codepoint) &&
	(buffer->cur().mask & c->lookup_mask) &&
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
	c->check_glyph_property (&buffer->cur(), c->lookup_props))
     {
       for (unsigned int i = 0; i < subtables.len; i++)
         if (subtables[i].apply (c))
	 {
	   applied = true;
	   break;
	 }
     }

    if (applied)
1090 1091 1092 1093 1094 1095 1096 1097 1098
      ret = true;
    else
      buffer->next_glyph ();
  }
  return ret;
}

static inline bool
apply_backward (OT::hb_apply_context_t *c,
1099 1100
	       const hb_ot_layout_lookup_accelerator_t &accel,
	       const hb_get_subtables_context_t::array_t &subtables)
1101 1102 1103 1104 1105 1106 1107
{
  bool ret = false;
  hb_buffer_t *buffer = c->buffer;
  do
  {
    if (accel.may_have (buffer->cur().codepoint) &&
	(buffer->cur().mask & c->lookup_mask) &&
1108 1109 1110 1111 1112 1113 1114 1115 1116
	c->check_glyph_property (&buffer->cur(), c->lookup_props))
    {
     for (unsigned int i = 0; i < subtables.len; i++)
       if (subtables[i].apply (c))
       {
	 ret = true;
	 break;
       }
    }
1117 1118 1119 1120 1121 1122 1123 1124
    /* The reverse lookup doesn't "advance" cursor (for good reason). */
    buffer->idx--;

  }
  while ((int) buffer->idx >= 0);
  return ret;
}

1125
template <typename Proxy>
1126
static inline void
1127 1128 1129 1130
apply_string (OT::hb_apply_context_t *c,
	      const typename Proxy::Lookup &lookup,
	      const hb_ot_layout_lookup_accelerator_t &accel)
{
B
Behdad Esfahbod 已提交
1131
  hb_buffer_t *buffer = c->buffer;
1132

1133
  if (unlikely (!buffer->len || !c->lookup_mask))
1134
    return;
1135

1136
  c->set_lookup_props (lookup.get_props ());
1137

1138 1139 1140 1141
  hb_get_subtables_context_t::array_t subtables;
  hb_get_subtables_context_t c_get_subtables (subtables);
  lookup.dispatch (&c_get_subtables);

1142 1143 1144 1145
  if (likely (!lookup.is_reverse ()))
  {
    /* in/out forward substitution/positioning */
    if (Proxy::table_index == 0)
B
Behdad Esfahbod 已提交
1146 1147
      buffer->clear_output ();
    buffer->idx = 0;
1148

1149
    bool ret;
1150
    ret = apply_forward (c, accel, subtables);
1151
    if (ret)
1152
    {
B
Behdad Esfahbod 已提交
1153
      if (!Proxy::inplace)
B
Behdad Esfahbod 已提交
1154
	buffer->swap_buffers ();
1155
      else
1156
	assert (!buffer->has_separate_output ());
1157
    }
1158 1159 1160 1161 1162
  }
  else
  {
    /* in-place backward substitution/positioning */
    if (Proxy::table_index == 0)
B
Behdad Esfahbod 已提交
1163 1164
      buffer->remove_output ();
    buffer->idx = buffer->len - 1;
1165

1166
    apply_backward (c, accel, subtables);
1167 1168 1169
  }
}

B
Behdad Esfahbod 已提交
1170 1171
template <typename Proxy>
inline void hb_ot_map_t::apply (const Proxy &proxy,
B
Behdad Esfahbod 已提交
1172 1173 1174 1175
				const hb_ot_shape_plan_t *plan,
				hb_font_t *font,
				hb_buffer_t *buffer) const
{
B
Behdad Esfahbod 已提交
1176
  const unsigned int table_index = proxy.table_index;
B
Behdad Esfahbod 已提交
1177
  unsigned int i = 0;
B
Behdad Esfahbod 已提交
1178
  OT::hb_apply_context_t c (table_index, font, buffer);
1179
  c.set_recurse_func (Proxy::Lookup::apply_recurse_func);
B
Behdad Esfahbod 已提交
1180 1181 1182 1183

  for (unsigned int stage_index = 0; stage_index < stages[table_index].len; stage_index++) {
    const stage_map_t *stage = &stages[table_index][stage_index];
    for (; i < stage->last_lookup; i++)
B
Behdad Esfahbod 已提交
1184 1185
    {
      unsigned int lookup_index = lookups[table_index][i].index;
1186
      if (!buffer->message (font, "start lookup %d", lookup_index)) continue;
1187
      c.set_lookup_index (lookup_index);
B
Behdad Esfahbod 已提交
1188 1189
      c.set_lookup_mask (lookups[table_index][i].mask);
      c.set_auto_zwj (lookups[table_index][i].auto_zwj);
1190 1191 1192
      apply_string<Proxy> (&c,
			   proxy.table.get_lookup (lookup_index),
			   proxy.accels[lookup_index]);
1193
      (void) buffer->message (font, "end lookup %d", lookup_index);
B
Behdad Esfahbod 已提交
1194
    }
B
Behdad Esfahbod 已提交
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205

    if (stage->pause_func)
    {
      buffer->clear_output ();
      stage->pause_func (plan, font, buffer);
    }
  }
}

void hb_ot_map_t::substitute (const hb_ot_shape_plan_t *plan, hb_font_t *font, hb_buffer_t *buffer) const
{
B
Behdad Esfahbod 已提交
1206 1207
  GSUBProxy proxy (font->face);
  apply (proxy, plan, font, buffer);
B
Behdad Esfahbod 已提交
1208 1209 1210 1211
}

void hb_ot_map_t::position (const hb_ot_shape_plan_t *plan, hb_font_t *font, hb_buffer_t *buffer) const
{
B
Behdad Esfahbod 已提交
1212 1213 1214 1215 1216 1217 1218 1219 1220
  GPOSProxy proxy (font->face);
  apply (proxy, plan, font, buffer);
}

HB_INTERNAL void
hb_ot_layout_substitute_lookup (OT::hb_apply_context_t *c,
				const OT::SubstLookup &lookup,
				const hb_ot_layout_lookup_accelerator_t &accel)
{
1221
  apply_string<GSUBProxy> (c, lookup, accel);
B
Behdad Esfahbod 已提交
1222
}
1223

1224

1225
/*
1226
 * MATH
1227
 */
1228
/* TODO Move this to hb-ot-math.cc and separate it from hb_ot_layout_t. */
1229 1230

/**
1231
 * hb_ot_math_has_data:
1232 1233 1234 1235 1236 1237 1238 1239
 * @face: #hb_face_t to test
 *
 * This function allows to verify the presence of an OpenType MATH table on the
 * face. If so, such a table will be loaded into memory and sanitized. You can
 * then safely call other functions for math layout and shaping.
 *
 * Return value: #TRUE if face has a MATH table and #FALSE otherwise
 *
1240
 * Since: 1.3.3
1241 1242
 **/
hb_bool_t
1243
hb_ot_math_has_data (hb_face_t *face)
1244 1245 1246
{
  return &_get_math (face) != &OT::Null(OT::MATH);
}
1247 1248

/**
1249
 * hb_ot_math_get_constant:
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
 * @font: #hb_font_t from which to retrieve the value
 * @constant: #hb_ot_math_constant_t the constant to retrieve
 *
 * This function returns the requested math constants as a #hb_position_t.
 * If the request constant is HB_OT_MATH_CONSTANT_SCRIPT_PERCENT_SCALE_DOWN,
 * HB_OT_MATH_CONSTANT_SCRIPT_SCRIPT_PERCENT_SCALE_DOWN or
 * HB_OT_MATH_CONSTANT_SCRIPT_PERCENT_SCALE_DOWN then the return value is
 * actually an integer between 0 and 100 representing that percentage.
 *
 * Return value: the requested constant or 0
 *
1261
 * Since: 1.3.3
1262 1263
 **/
hb_position_t
1264 1265
hb_ot_math_get_constant (hb_font_t *font,
			 hb_ot_math_constant_t constant)
1266 1267
{
  const OT::MATH &math = _get_math (font->face);
1268
  return math.get_constant(constant, font);
1269
}
1270 1271

/**
1272
 * hb_ot_math_get_glyph_italics_correction:
1273 1274 1275
 * @font: #hb_font_t from which to retrieve the value
 * @glyph: glyph index from which to retrieve the value
 *
1276
 * Return value: the italics correction of the glyph or 0
1277
 *
1278
 * Since: 1.3.3
1279
 **/
1280
hb_position_t
1281 1282
hb_ot_math_get_glyph_italics_correction (hb_font_t *font,
					 hb_codepoint_t glyph)
1283 1284
{
  const OT::MATH &math = _get_math (font->face);
1285
  return math.get_math_glyph_info().get_italics_correction (glyph, font);
1286 1287 1288
}

/**
1289
 * hb_ot_math_get_glyph_top_accent_attachment:
1290 1291 1292 1293 1294
 * @font: #hb_font_t from which to retrieve the value
 * @glyph: glyph index from which to retrieve the value
 *
 * Return value: the top accent attachment of the glyph or 0
 *
1295
 * Since: 1.3.3
1296
 **/
1297
hb_position_t
1298 1299
hb_ot_math_get_glyph_top_accent_attachment (hb_font_t *font,
					    hb_codepoint_t glyph)
1300 1301
{
  const OT::MATH &math = _get_math (font->face);
1302
  return math.get_math_glyph_info().get_top_accent_attachment (glyph, font);
1303 1304 1305
}

/**
1306
 * hb_ot_math_is_glyph_extended_shape:
1307 1308 1309 1310 1311
 * @font: a #hb_font_t to test
 * @glyph: a glyph index to test
 *
 * Return value: #TRUE if the glyph is an extended shape and #FALSE otherwise
 *
1312
 * Since: 1.3.3
1313
 **/
1314
hb_bool_t
1315 1316
hb_ot_math_is_glyph_extended_shape (hb_face_t *face,
				    hb_codepoint_t glyph)
1317 1318
{
  const OT::MATH &math = _get_math (face);
1319
  return math.get_math_glyph_info().is_extended_shape (glyph);
1320 1321 1322
}

/**
1323
 * hb_ot_math_get_glyph_kerning:
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
 * @font: #hb_font_t from which to retrieve the value
 * @glyph: glyph index from which to retrieve the value
 * @kern: the #hb_ot_math_kern_t from which to retrieve the value
 * @correction_height: the correction height to use to determine the kerning.
 *
 * This function tries to retrieve the MathKern table for the specified font,
 * glyph and #hb_ot_math_kern_t. Then it browses the list of heights from the
 * MathKern table to find one value that is greater or equal to specified
 * correction_height. If one is found the corresponding value from the list of
 * kerns is returned and otherwise the last kern value is returned.
 *
 * Return value: requested kerning or 0
 *
1337
 * Since: 1.3.3
1338
 **/
1339
hb_position_t
1340 1341 1342 1343
hb_ot_math_get_glyph_kerning (hb_font_t *font,
			      hb_codepoint_t glyph,
			      hb_ot_math_kern_t kern,
			      hb_position_t correction_height)
1344 1345
{
  const OT::MATH &math = _get_math (font->face);
B
Behdad Esfahbod 已提交
1346
  return math.get_math_glyph_info().get_kerning (glyph, kern, correction_height, font);
1347
}
1348

1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
/**
 * hb_ot_math_get_glyph_variants:
 * @font: #hb_font_t from which to retrieve the values
 * @glyph: index of the glyph to stretch
 * @direction: direction of the stretching
 * @start_offset: offset of the first variant to retrieve
 * @variants_count: maximum number of variants to retrieve after start_offset
 * (IN) and actual number of variants retrieved (OUT)
 * @variants: array of size at least @variants_count to store the result
 *
 * This function tries to retrieve the MathGlyphConstruction for the specified
 * font, glyph and direction. Note that only the value of
 * #HB_DIRECTION_IS_HORIZONTAL is considered. It provides the corresponding list
1362
 * of size variants as an array of hb_ot_math_glyph_variant_t structs.
1363 1364 1365
 *
 * Return value: the total number of size variants available or 0
 *
1366
 * Since: 1.3.3
1367
 **/
1368
unsigned int
1369 1370 1371 1372 1373
hb_ot_math_get_glyph_variants (hb_font_t *font,
			       hb_codepoint_t glyph,
			       hb_direction_t direction,
			       unsigned int start_offset,
			       unsigned int *variants_count, /* IN/OUT */
1374
			       hb_ot_math_glyph_variant_t *variants /* OUT */)
1375 1376
{
  const OT::MATH &math = _get_math (font->face);
1377 1378 1379 1380
  return math.get_math_variants().get_glyph_variants (glyph, direction, font,
						      start_offset,
						      variants_count,
						      variants);
1381 1382
}

1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
/**
 * hb_ot_math_get_min_connector_overlap:
 * @font: #hb_font_t from which to retrieve the value
 * @direction: direction of the stretching
 *
 * This function tries to retrieve the MathVariants table for the specified
 * font and returns the minimum overlap of connecting glyphs to draw a glyph
 * assembly in the specified direction. Note that only the value of
 * #HB_DIRECTION_IS_HORIZONTAL is considered.
 *
 * Return value: requested min connector overlap or 0
 *
1395
 * Since: 1.3.3
1396
 **/
1397
hb_position_t
1398 1399
hb_ot_math_get_min_connector_overlap (hb_font_t *font,
				      hb_direction_t direction)
1400 1401
{
  const OT::MATH &math = _get_math (font->face);
1402 1403
  return math.get_math_variants().get_min_connector_overlap (direction, font);
}
1404

1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418
/**
 * hb_ot_math_get_glyph_assembly:
 * @font: #hb_font_t from which to retrieve the values
 * @glyph: index of the glyph to stretch
 * @direction: direction of the stretching
 * @start_offset: offset of the first glyph part to retrieve
 * @parts_count: maximum number of glyph parts to retrieve after start_offset
 * (IN) and actual number of parts retrieved (OUT)
 * @parts: array of size at least @parts_count to store the result
 * @italics_correction: italic correction of the glyph assembly
 *
 * This function tries to retrieve the GlyphAssembly for the specified font,
 * glyph and direction. Note that only the value of #HB_DIRECTION_IS_HORIZONTAL
 * is considered. It provides the information necessary to draw the glyph
1419
 * assembly as an array of #hb_ot_math_glyph_part_t.
1420 1421 1422
 *
 * Return value: the total number of parts in the glyph assembly
 *
1423
 * Since: 1.3.3
1424
 **/
1425
unsigned int
1426 1427 1428 1429 1430
hb_ot_math_get_glyph_assembly (hb_font_t *font,
			       hb_codepoint_t glyph,
			       hb_direction_t direction,
			       unsigned int start_offset,
			       unsigned int *parts_count, /* IN/OUT */
1431
			       hb_ot_math_glyph_part_t *parts, /* OUT */
1432
			       hb_position_t *italics_correction /* OUT */)
1433 1434
{
  const OT::MATH &math = _get_math (font->face);
1435 1436 1437 1438 1439
  return math.get_math_variants().get_glyph_parts (glyph, direction, font,
						   start_offset,
						   parts_count,
						   parts,
						   italics_correction);
1440
}