hb-ot-layout.cc 43.0 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"
33
#include "hb-ot-map-private.hh"
34

35 36 37
#include "hb-ot-layout-gdef-table.hh"
#include "hb-ot-layout-gsub-table.hh"
#include "hb-ot-layout-gpos-table.hh"
38 39 40 41

// Just so we compile them; unused otherwise:
#include "hb-ot-layout-base-table.hh"
#include "hb-ot-layout-jstf-table.hh"
42 43
#include "hb-ot-color-colr-table.hh"
#include "hb-ot-color-cpal-table.hh"
44 45 46
#include "hb-ot-color-sbix-table.hh"
#include "hb-ot-color-svg-table.hh"
#include "hb-ot-name-table.hh"
47
#include "hb-map-private.hh"
B
Behdad Esfahbod 已提交
48

B
Behdad Esfahbod 已提交
49

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

57
  layout->gdef_blob = hb_sanitize_context_t ().reference_table<OT::GDEF> (face);
58
  layout->gdef = layout->gdef_blob->as<OT::GDEF> ();
B
Behdad Esfahbod 已提交
59

60
  layout->gsub_blob = hb_sanitize_context_t ().reference_table<OT::GSUB> (face);
61
  layout->gsub = layout->gsub_blob->as<OT::GSUB> ();
B
Behdad Esfahbod 已提交
62

63
  layout->gpos_blob = hb_sanitize_context_t ().reference_table<OT::GPOS> (face);
64
  layout->gpos = layout->gpos_blob->as<OT::GPOS> ();
B
Behdad Esfahbod 已提交
65

E
Ebrahim Byagowi 已提交
66
  layout->math.init (face);
67 68
  layout->fvar.init (face);
  layout->avar.init (face);
B
Behdad Esfahbod 已提交
69
  layout->morx.init (face);
S
Sascha Brawer 已提交
70

71 72 73 74 75 76
  {
    /*
     * 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
     */
B
Minor  
Behdad Esfahbod 已提交
77 78 79
    unsigned int gdef_len = layout->gdef_blob->length;
    unsigned int gsub_len = layout->gsub_blob->length;
    unsigned int gpos_len = layout->gpos_blob->length;
80
    if (0
81 82 83 84 85 86 87 88 89 90 91 92
      /* 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)
93 94 95 96 97 98 99 100 101
    )
    {
      /* 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))
B
Behdad Esfahbod 已提交
102
       layout->gdef = &Null(OT::GDEF);
103
    }
J
jfkthame 已提交
104 105 106 107 108 109 110 111 112
    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)
113 114 115 116
      /* tahoma.ttf v6.04 from Windows 8.1 x64, see https://bugzilla.mozilla.org/show_bug.cgi?id=1279925 */
      || (964 == gdef_len && 60072 == gpos_len && 23836 == gsub_len)
      /* tahomabd.ttf v6.04 from Windows 8.1 x64, see https://bugzilla.mozilla.org/show_bug.cgi?id=1279925 */
      || (976 == gdef_len && 61456 == gpos_len && 23832 == gsub_len)
J
jfkthame 已提交
117 118 119 120
      /* 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)
121 122 123 124
      /* tahoma.ttf v6.91 from Windows 10 x64, see https://bugzilla.mozilla.org/show_bug.cgi?id=1279925 */
      || (1006 == gdef_len && 61346 == gpos_len && 24576 == gsub_len)
      /* tahomabd.ttf v6.91 from Windows 10 x64, see https://bugzilla.mozilla.org/show_bug.cgi?id=1279925 */
      || (1018 == gdef_len && 62828 == gpos_len && 24572 == gsub_len)
125 126 127 128
      /* sha1sum:b9c84d820c49850d3d27ec498be93955b82772b5  tahoma.ttf from Windows 10 AU */
      || (1006 == gdef_len && 61352 == gpos_len && 24576 == gsub_len)
      /* sha1sum:2bdfaab28174bdadd2f3d4200a30a7ae31db79d2  tahomabd.ttf from Windows 10 AU */
      || (1018 == gdef_len && 62834 == gpos_len && 24572 == gsub_len)
J
jfkthame 已提交
129 130 131 132
      /* 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)
133 134
      /* sha1sum:eb8afadd28e9cf963e886b23a30b44ab4fd83acc  himalaya.ttf from Windows 7 */
      || (180 == gdef_len && 7254 == gpos_len && 13054 == gsub_len)
J
jfkthame 已提交
135 136 137 138 139 140 141 142 143 144
      /* 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)
145 146 147 148 149 150 151 152
      /* d125afa82a77a6475ac0e74e7c207914af84b37a padauk-2.80/Padauk.ttf RHEL 7.2 */
      || (1058 == gdef_len && 11818 == gpos_len && 47032 == gsub_len)
      /* 0f7b80437227b90a577cc078c0216160ae61b031 padauk-2.80/Padauk-Bold.ttf RHEL 7.2*/
      || (1046 == gdef_len && 12600 == gpos_len && 47030 == gsub_len)
      /* d3dde9aa0a6b7f8f6a89ef1002e9aaa11b882290 padauk-2.80/Padauk.ttf Ubuntu 16.04 */
      || (1058 == gdef_len && 16770 == gpos_len && 71796 == gsub_len)
      /* 5f3c98ccccae8a953be2d122c1b3a77fd805093f padauk-2.80/Padauk-Bold.ttf Ubuntu 16.04 */
      || (1046 == gdef_len && 17862 == gpos_len && 71790 == gsub_len)
153 154 155 156 157 158 159 160
      /* 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)
161 162 163
      /* sha1sum: c26e41d567ed821bed997e937bc0c41435689e85  Padauk.ttf
       *  "Padauk Regular" "Version 2.5", see https://crbug.com/681813 */
      || (1004 == gdef_len && 14836 == gpos_len && 59092 == gsub_len)
J
jfkthame 已提交
164 165 166 167 168 169 170 171 172 173
    )
    {
      /* 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
       */
B
Behdad Esfahbod 已提交
174
      layout->gdef = &Null(OT::GDEF);
J
jfkthame 已提交
175
    }
176 177
  }

178 179 180
  layout->gsub_lookup_count = layout->gsub->get_lookup_count ();
  layout->gpos_lookup_count = layout->gpos->get_lookup_count ();

181 182
  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));
183

184 185
  if (unlikely ((layout->gsub_lookup_count && !layout->gsub_accels) ||
		(layout->gpos_lookup_count && !layout->gpos_accels)))
186 187
  {
    _hb_ot_layout_destroy (layout);
B
Behdad Esfahbod 已提交
188
    return nullptr;
189 190
  }

191
  for (unsigned int i = 0; i < layout->gsub_lookup_count; i++)
192
    layout->gsub_accels[i].init (layout->gsub->get_lookup (i));
193
  for (unsigned int i = 0; i < layout->gpos_lookup_count; i++)
194
    layout->gpos_accels[i].init (layout->gpos->get_lookup (i));
195

B
Behdad Esfahbod 已提交
196
  return layout;
B
Behdad Esfahbod 已提交
197 198
}

199
void
200
_hb_ot_layout_destroy (hb_ot_layout_t *layout)
B
Behdad Esfahbod 已提交
201
{
202 203 204 205 206 207
  if (layout->gsub_accels)
    for (unsigned int i = 0; i < layout->gsub_lookup_count; i++)
      layout->gsub_accels[i].fini ();
  if (layout->gpos_accels)
    for (unsigned int i = 0; i < layout->gpos_lookup_count; i++)
      layout->gpos_accels[i].fini ();
208 209 210

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

B
Bradley Grainger 已提交
212 213 214 215
  hb_blob_destroy (layout->gdef_blob);
  hb_blob_destroy (layout->gsub_blob);
  hb_blob_destroy (layout->gpos_blob);

E
Ebrahim Byagowi 已提交
216
  layout->math.fini ();
217 218
  layout->fvar.fini ();
  layout->avar.fini ();
B
Behdad Esfahbod 已提交
219
  layout->morx.fini ();
S
Sascha Brawer 已提交
220

B
Behdad Esfahbod 已提交
221
  free (layout);
222
}
B
Behdad Esfahbod 已提交
223

224 225 226
// static inline const OT::BASE&
// _get_base (hb_face_t *face)
// {
B
Behdad Esfahbod 已提交
227
//   if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return Null(OT::BASE);
228 229 230
//   hb_ot_layout_t * layout = hb_ot_layout_from_face (face);
//   return *(layout->base.get ());
// }
B
Behdad Esfahbod 已提交
231

232
static inline const OT::GDEF&
233 234
_get_gdef (hb_face_t *face)
{
B
Behdad Esfahbod 已提交
235
  if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return Null(OT::GDEF);
236
  return *hb_ot_layout_from_face (face)->gdef;
237
}
238
static inline const OT::GSUB&
239
_get_gsub (hb_face_t *face)
B
Behdad Esfahbod 已提交
240
{
B
Behdad Esfahbod 已提交
241
  if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return Null(OT::GSUB);
242
  return *hb_ot_layout_from_face (face)->gsub;
B
Behdad Esfahbod 已提交
243
}
244
static inline const OT::GPOS&
245
_get_gpos (hb_face_t *face)
B
Behdad Esfahbod 已提交
246
{
B
Behdad Esfahbod 已提交
247
  if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return Null(OT::GPOS);
248
  return *hb_ot_layout_from_face (face)->gpos;
B
Behdad Esfahbod 已提交
249 250
}

B
Behdad Esfahbod 已提交
251 252 253 254 255
/*
 * GDEF
 */

hb_bool_t
256
hb_ot_layout_has_glyph_classes (hb_face_t *face)
B
Behdad Esfahbod 已提交
257
{
258
  return _get_gdef (face).has_glyph_classes ();
B
Behdad Esfahbod 已提交
259 260
}

S
Sascha Brawer 已提交
261
/**
B
Behdad Esfahbod 已提交
262 263
 * hb_ot_layout_get_glyph_class:
 *
S
Sascha Brawer 已提交
264 265
 * Since: 0.9.7
 **/
266 267 268 269 270 271
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 已提交
272

S
Sascha Brawer 已提交
273
/**
B
Behdad Esfahbod 已提交
274 275
 * hb_ot_layout_get_glyphs_in_class:
 *
S
Sascha Brawer 已提交
276 277
 * Since: 0.9.7
 **/
278 279 280 281 282 283 284 285
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 已提交
286
unsigned int
287
hb_ot_layout_get_attach_points (hb_face_t      *face,
B
Behdad Esfahbod 已提交
288
				hb_codepoint_t  glyph,
B
Behdad Esfahbod 已提交
289
				unsigned int    start_offset,
B
Behdad Esfahbod 已提交
290 291 292
				unsigned int   *point_count /* IN/OUT */,
				unsigned int   *point_array /* OUT */)
{
B
Behdad Esfahbod 已提交
293
  return _get_gdef (face).get_attach_points (glyph, start_offset, point_count, point_array);
B
Behdad Esfahbod 已提交
294 295
}

B
Behdad Esfahbod 已提交
296
unsigned int
297 298 299 300 301
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 */,
302
				  hb_position_t  *caret_array /* OUT */)
B
Behdad Esfahbod 已提交
303
{
304
  return _get_gdef (font->face).get_lig_carets (font, direction, glyph, start_offset, caret_count, caret_array);
B
Behdad Esfahbod 已提交
305 306
}

307

308 309 310 311
/*
 * GSUB/GPOS
 */

312
static const OT::GSUBGPOS&
313 314
get_gsubgpos_table (hb_face_t *face,
		    hb_tag_t   table_tag)
315
{
316
  switch (table_tag) {
317 318
    case HB_OT_TAG_GSUB: return _get_gsub (face);
    case HB_OT_TAG_GPOS: return _get_gpos (face);
B
Behdad Esfahbod 已提交
319
    default:             return Null(OT::GSUBGPOS);
320 321 322 323
  }
}


B
Behdad Esfahbod 已提交
324
unsigned int
325 326
hb_ot_layout_table_get_script_tags (hb_face_t    *face,
				    hb_tag_t      table_tag,
B
Behdad Esfahbod 已提交
327
				    unsigned int  start_offset,
328 329
				    unsigned int *script_count /* IN/OUT */,
				    hb_tag_t     *script_tags /* OUT */)
330
{
331
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
332

B
Behdad Esfahbod 已提交
333
  return g.get_script_tags (start_offset, script_count, script_tags);
334 335
}

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

338
hb_bool_t
339 340 341 342
hb_ot_layout_table_find_script (hb_face_t    *face,
				hb_tag_t      table_tag,
				hb_tag_t      script_tag,
				unsigned int *script_index)
343
{
344
  static_assert ((OT::Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX), "");
345
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
346 347

  if (g.find_script_index (script_tag, script_index))
348
    return true;
349 350

  /* try finding 'DFLT' */
351
  if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index))
352
    return false;
353

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

B
Minor  
Behdad Esfahbod 已提交
359 360 361 362 363
  /* 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 已提交
364
  if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
365
  return false;
B
Behdad Esfahbod 已提交
366 367 368 369 370 371
}

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 已提交
372 373
				  unsigned int   *script_index,
				  hb_tag_t       *chosen_script)
B
Behdad Esfahbod 已提交
374
{
375
  static_assert ((OT::Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_SCRIPT_INDEX), "");
376
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
B
Behdad Esfahbod 已提交
377 378 379

  while (*script_tags)
  {
B
Behdad Esfahbod 已提交
380 381 382
    if (g.find_script_index (*script_tags, script_index)) {
      if (chosen_script)
        *chosen_script = *script_tags;
383
      return true;
B
Behdad Esfahbod 已提交
384
    }
B
Behdad Esfahbod 已提交
385 386 387 388
    script_tags++;
  }

  /* try finding 'DFLT' */
B
Behdad Esfahbod 已提交
389 390 391
  if (g.find_script_index (HB_OT_TAG_DEFAULT_SCRIPT, script_index)) {
    if (chosen_script)
      *chosen_script = HB_OT_TAG_DEFAULT_SCRIPT;
392
    return false;
B
Behdad Esfahbod 已提交
393
  }
B
Behdad Esfahbod 已提交
394 395

  /* try with 'dflt'; MS site has had typos and many fonts use it now :( */
B
Behdad Esfahbod 已提交
396 397 398
  if (g.find_script_index (HB_OT_TAG_DEFAULT_LANGUAGE, script_index)) {
    if (chosen_script)
      *chosen_script = HB_OT_TAG_DEFAULT_LANGUAGE;
399
    return false;
B
Behdad Esfahbod 已提交
400
  }
401

402 403 404 405 406
  /* 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;
407
    return false;
408 409
  }

410
  if (script_index) *script_index = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
B
Behdad Esfahbod 已提交
411 412
  if (chosen_script)
    *chosen_script = HB_OT_LAYOUT_NO_SCRIPT_INDEX;
413
  return false;
414 415
}

B
Behdad Esfahbod 已提交
416
unsigned int
417 418
hb_ot_layout_table_get_feature_tags (hb_face_t    *face,
				     hb_tag_t      table_tag,
B
Behdad Esfahbod 已提交
419
				     unsigned int  start_offset,
420 421
				     unsigned int *feature_count /* IN/OUT */,
				     hb_tag_t     *feature_tags /* OUT */)
422
{
423
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
424

B
Behdad Esfahbod 已提交
425
  return g.get_feature_tags (start_offset, feature_count, feature_tags);
426 427
}

428 429 430 431 432 433
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)
{
434
  static_assert ((OT::Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX), "");
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
  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;
}

450

B
Behdad Esfahbod 已提交
451
unsigned int
452 453 454
hb_ot_layout_script_get_language_tags (hb_face_t    *face,
				       hb_tag_t      table_tag,
				       unsigned int  script_index,
B
Behdad Esfahbod 已提交
455
				       unsigned int  start_offset,
456 457
				       unsigned int *language_count /* IN/OUT */,
				       hb_tag_t     *language_tags /* OUT */)
458
{
459
  const OT::Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
460

B
Behdad Esfahbod 已提交
461
  return s.get_lang_sys_tags (start_offset, language_count, language_tags);
462 463 464
}

hb_bool_t
465 466 467 468 469
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)
470
{
471
  static_assert ((OT::Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX), "");
472
  const OT::Script &s = get_gsubgpos_table (face, table_tag).get_script (script_index);
473

474
  if (s.find_lang_sys_index (language_tag, language_index))
475
    return true;
476 477

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

481
  if (language_index) *language_index = HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX;
482
  return false;
483
}
484

B
Behdad Esfahbod 已提交
485 486 487 488 489 490 491 492 493 494 495 496
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,
B
Behdad Esfahbod 已提交
497
						     nullptr);
B
Behdad Esfahbod 已提交
498 499
}

S
Sascha Brawer 已提交
500
/**
B
Behdad Esfahbod 已提交
501 502
 * hb_ot_layout_language_get_required_feature:
 *
S
Sascha Brawer 已提交
503 504
 * Since: 0.9.30
 **/
505
hb_bool_t
506 507 508 509 510 511
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)
512
{
513 514
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
  const OT::LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
515

516 517 518
  unsigned int index = l.get_required_feature_index ();
  if (feature_index) *feature_index = index;
  if (feature_tag) *feature_tag = g.get_feature_tag (index);
519

520 521
  return l.has_required_feature ();
}
522

523 524 525 526 527 528 529 530 531 532 533 534 535
static void
_hb_ot_layout_language_add_feature_indexes_to (hb_face_t    *face,
                                               hb_tag_t      table_tag,
                                               unsigned int  script_index,
                                               unsigned int  language_index,
                                               hb_set_t     *feature_indexes /* OUT */)
{
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
  const OT::LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
  l.add_feature_indexes_to (feature_indexes);
}


B
Behdad Esfahbod 已提交
536
unsigned int
537 538 539 540
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 已提交
541
					   unsigned int  start_offset,
542 543
					   unsigned int *feature_count /* IN/OUT */,
					   unsigned int *feature_indexes /* OUT */)
544
{
545 546
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
  const OT::LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
547

B
Behdad Esfahbod 已提交
548
  return l.get_feature_indexes (start_offset, feature_count, feature_indexes);
549 550
}

B
Behdad Esfahbod 已提交
551
unsigned int
552 553 554 555
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 已提交
556
					unsigned int  start_offset,
557 558
					unsigned int *feature_count /* IN/OUT */,
					hb_tag_t     *feature_tags /* OUT */)
559
{
560 561
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
  const OT::LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
562

563
  static_assert ((sizeof (unsigned int) == sizeof (hb_tag_t)), "");
B
Behdad Esfahbod 已提交
564
  unsigned int ret = l.get_feature_indexes (start_offset, feature_count, (unsigned int *) feature_tags);
565

B
Behdad Esfahbod 已提交
566 567 568 569 570
  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]);
  }
571 572

  return ret;
573 574 575 576
}


hb_bool_t
577 578 579 580 581 582
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)
583
{
584
  static_assert ((OT::Index::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_FEATURE_INDEX), "");
585 586
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);
  const OT::LangSys &l = g.get_script (script_index).get_lang_sys (language_index);
587

B
Behdad Esfahbod 已提交
588 589
  unsigned int num_features = l.get_feature_count ();
  for (unsigned int i = 0; i < num_features; i++) {
590 591 592 593
    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;
594
      return true;
595 596
    }
  }
597

598
  if (feature_index) *feature_index = HB_OT_LAYOUT_NO_FEATURE_INDEX;
599
  return false;
600
}
601

S
Sascha Brawer 已提交
602
/**
K
Khaled Hosny 已提交
603 604
 * hb_ot_layout_feature_get_lookups:
 *
S
Sascha Brawer 已提交
605 606
 * Since: 0.9.7
 **/
B
Behdad Esfahbod 已提交
607
unsigned int
608 609 610 611 612 613
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 */)
614
{
615 616 617 618 619 620 621
  return hb_ot_layout_feature_with_variations_get_lookups (face,
							   table_tag,
							   feature_index,
							   HB_OT_LAYOUT_NO_VARIATIONS_INDEX,
							   start_offset,
							   lookup_count,
							   lookup_indexes);
622 623
}

S
Sascha Brawer 已提交
624
/**
K
Khaled Hosny 已提交
625 626
 * hb_ot_layout_table_get_lookup_count:
 *
S
Sascha Brawer 已提交
627 628
 * Since: 0.9.22
 **/
629 630 631 632
unsigned int
hb_ot_layout_table_get_lookup_count (hb_face_t    *face,
				     hb_tag_t      table_tag)
{
633
  if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return 0;
634 635 636 637 638 639 640 641 642 643 644
  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 已提交
645
  return 0;
646 647
}

648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
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
674 675 676 677 678 679
_hb_ot_layout_collect_features_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       *feature_indexes /* OUT */)
680 681 682
{
  if (!features)
  {
683
    unsigned int required_feature_index;
684 685 686 687 688
    if (hb_ot_layout_language_get_required_feature (face,
						    table_tag,
						    script_index,
						    language_index,
						    &required_feature_index,
689 690
						    nullptr))
      feature_indexes->add (required_feature_index);
691

692
    /* All features */
693 694 695 696 697
    _hb_ot_layout_language_add_feature_indexes_to (face,
                                                   table_tag,
                                                   script_index,
                                                   language_index,
                                                   feature_indexes);
698 699 700
  }
  else
  {
701 702 703
    for (; *features; features++)
    {
      unsigned int feature_index;
B
Behdad Esfahbod 已提交
704 705 706 707 708 709
      if (hb_ot_layout_language_find_feature (face,
					      table_tag,
					      script_index,
					      language_index,
					      *features,
					      &feature_index))
710
        feature_indexes->add (feature_index);
711 712 713 714 715
    }
  }
}

static void
716 717 718 719 720 721
_hb_ot_layout_collect_features_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       *feature_indexes /* OUT */)
722
{
723 724 725 726 727 728
  _hb_ot_layout_collect_features_features (face,
                                           table_tag,
                                           script_index,
                                           HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX,
                                           features,
                                           feature_indexes);
729

730 731 732
  if (!languages)
  {
    /* All languages */
B
Behdad Esfahbod 已提交
733 734 735
    unsigned int count = hb_ot_layout_script_get_language_tags (face,
								table_tag,
								script_index,
B
Behdad Esfahbod 已提交
736
								0, nullptr, nullptr);
737
    for (unsigned int language_index = 0; language_index < count; language_index++)
738 739 740 741 742 743
      _hb_ot_layout_collect_features_features (face,
                                               table_tag,
                                               script_index,
                                               language_index,
                                               features,
                                               feature_indexes);
744 745 746
  }
  else
  {
747 748 749
    for (; *languages; languages++)
    {
      unsigned int language_index;
B
Behdad Esfahbod 已提交
750 751 752 753 754
      if (hb_ot_layout_script_find_language (face,
					     table_tag,
					     script_index,
					     *languages,
					     &language_index))
755 756 757 758 759 760
        _hb_ot_layout_collect_features_features (face,
                                                 table_tag,
                                                 script_index,
                                                 language_index,
                                                 features,
                                                 feature_indexes);
761 762 763 764
    }
  }
}

S
Sascha Brawer 已提交
765
/**
766
 * hb_ot_layout_collect_features:
K
Khaled Hosny 已提交
767
 *
B
1.8.5  
Behdad Esfahbod 已提交
768
 * Since: 1.8.5
S
Sascha Brawer 已提交
769
 **/
770
void
771 772 773 774 775 776
hb_ot_layout_collect_features (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       *feature_indexes /* OUT */)
777 778 779 780
{
  if (!scripts)
  {
    /* All scripts */
B
Behdad Esfahbod 已提交
781 782
    unsigned int count = hb_ot_layout_table_get_script_tags (face,
							     table_tag,
B
Behdad Esfahbod 已提交
783
							     0, nullptr, nullptr);
784
    for (unsigned int script_index = 0; script_index < count; script_index++)
785 786 787 788 789 790
      _hb_ot_layout_collect_features_languages (face,
                                                table_tag,
                                                script_index,
                                                languages,
                                                features,
                                                feature_indexes);
791 792 793
  }
  else
  {
794 795 796
    for (; *scripts; scripts++)
    {
      unsigned int script_index;
B
Behdad Esfahbod 已提交
797 798 799 800
      if (hb_ot_layout_table_find_script (face,
					  table_tag,
					  *scripts,
					  &script_index))
801 802 803 804 805 806
        _hb_ot_layout_collect_features_languages (face,
                                                  table_tag,
                                                  script_index,
                                                  languages,
                                                  features,
                                                  feature_indexes);
807 808 809 810
    }
  }
}

811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
/**
 * hb_ot_layout_collect_lookups:
 *
 * Since: 0.9.8
 **/
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 */)
{
  hb_auto_t<hb_set_t> feature_indexes;
  hb_ot_layout_collect_features (face, table_tag, scripts, languages, features, &feature_indexes);
  for (hb_codepoint_t feature_index = HB_SET_VALUE_INVALID; hb_set_next (&feature_indexes, &feature_index);)
    _hb_ot_layout_collect_lookups_lookups (face, table_tag, feature_index, lookup_indexes);
}

S
Sascha Brawer 已提交
830
/**
K
Khaled Hosny 已提交
831 832
 * hb_ot_layout_lookup_collect_glyphs:
 *
S
Sascha Brawer 已提交
833 834
 * Since: 0.9.7
 **/
835 836 837 838
void
hb_ot_layout_lookup_collect_glyphs (hb_face_t    *face,
				    hb_tag_t      table_tag,
				    unsigned int  lookup_index,
B
Behdad Esfahbod 已提交
839 840 841 842
				    hb_set_t     *glyphs_before, /* OUT. May be nullptr */
				    hb_set_t     *glyphs_input,  /* OUT. May be nullptr */
				    hb_set_t     *glyphs_after,  /* OUT. May be nullptr */
				    hb_set_t     *glyphs_output  /* OUT. May be nullptr */)
843 844 845
{
  if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return;

B
Behdad Esfahbod 已提交
846 847 848 849 850
  OT::hb_collect_glyphs_context_t c (face,
				     glyphs_before,
				     glyphs_input,
				     glyphs_after,
				     glyphs_output);
851

852 853
  switch (table_tag)
  {
854 855
    case HB_OT_TAG_GSUB:
    {
856
      const OT::SubstLookup& l = hb_ot_layout_from_face (face)->gsub->get_lookup (lookup_index);
B
Behdad Esfahbod 已提交
857
      l.collect_glyphs (&c);
858 859 860 861
      return;
    }
    case HB_OT_TAG_GPOS:
    {
862
      const OT::PosLookup& l = hb_ot_layout_from_face (face)->gpos->get_lookup (lookup_index);
B
Behdad Esfahbod 已提交
863
      l.collect_glyphs (&c);
864 865 866 867 868
      return;
    }
  }
}

B
Behdad Esfahbod 已提交
869

870 871 872 873 874 875 876 877 878 879 880 881 882 883
/* Variations support */

hb_bool_t
hb_ot_layout_table_find_feature_variations (hb_face_t    *face,
					    hb_tag_t      table_tag,
					    const int    *coords,
					    unsigned int  num_coords,
					    unsigned int *variations_index /* out */)
{
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);

  return g.find_variations_index (coords, num_coords, variations_index);
}

884 885 886 887 888 889 890 891 892
unsigned int
hb_ot_layout_feature_with_variations_get_lookups (hb_face_t    *face,
						  hb_tag_t      table_tag,
						  unsigned int  feature_index,
						  unsigned int  variations_index,
						  unsigned int  start_offset,
						  unsigned int *lookup_count /* IN/OUT */,
						  unsigned int *lookup_indexes /* OUT */)
{
893
  static_assert ((OT::FeatureVariations::NOT_FOUND_INDEX == HB_OT_LAYOUT_NO_VARIATIONS_INDEX), "");
894 895 896 897 898 899 900
  const OT::GSUBGPOS &g = get_gsubgpos_table (face, table_tag);

  const OT::Feature &f = g.get_feature_variation (feature_index, variations_index);

  return f.get_lookup_indexes (start_offset, lookup_count, lookup_indexes);
}

901

B
Behdad Esfahbod 已提交
902
/*
903
 * OT::GSUB
B
Behdad Esfahbod 已提交
904 905 906
 */

hb_bool_t
907 908
hb_ot_layout_has_substitution (hb_face_t *face)
{
B
Behdad Esfahbod 已提交
909
  return &_get_gsub (face) != &Null(OT::GSUB);
910 911
}

S
Sascha Brawer 已提交
912
/**
K
Khaled Hosny 已提交
913 914
 * hb_ot_layout_lookup_would_substitute:
 *
S
Sascha Brawer 已提交
915 916
 * Since: 0.9.7
 **/
917
hb_bool_t
918
hb_ot_layout_lookup_would_substitute (hb_face_t            *face,
919
				      unsigned int          lookup_index,
920 921
				      const hb_codepoint_t *glyphs,
				      unsigned int          glyphs_length,
922
				      hb_bool_t             zero_context)
923
{
924
  if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return false;
925
  return hb_ot_layout_lookup_would_substitute_fast (face, lookup_index, glyphs, glyphs_length, zero_context);
926 927
}

B
Behdad Esfahbod 已提交
928
hb_bool_t
929
hb_ot_layout_lookup_would_substitute_fast (hb_face_t            *face,
930
					   unsigned int          lookup_index,
B
Behdad Esfahbod 已提交
931 932
					   const hb_codepoint_t *glyphs,
					   unsigned int          glyphs_length,
933
					   hb_bool_t             zero_context)
B
Behdad Esfahbod 已提交
934
{
935
  if (unlikely (lookup_index >= hb_ot_layout_from_face (face)->gsub_lookup_count)) return false;
936
  OT::hb_would_apply_context_t c (face, glyphs, glyphs_length, (bool) zero_context);
B
Behdad Esfahbod 已提交
937 938 939

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

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

943
void
944
hb_ot_layout_substitute_start (hb_font_t *font, hb_buffer_t *buffer)
945
{
946
  OT::GSUB::substitute_start (font, buffer);
947 948
}

S
Sascha Brawer 已提交
949
/**
K
Khaled Hosny 已提交
950 951
 * hb_ot_layout_lookup_substitute_closure:
 *
S
Sascha Brawer 已提交
952 953
 * Since: 0.9.7
 **/
B
Behdad Esfahbod 已提交
954
void
955
hb_ot_layout_lookup_substitute_closure (hb_face_t    *face,
956 957
				        unsigned int  lookup_index,
				        hb_set_t     *glyphs)
958
{
959 960
  hb_auto_t<hb_map_t> done_lookups;
  OT::hb_closure_context_t c (face, glyphs, &done_lookups);
961 962 963

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

964
  l.closure (&c, lookup_index);
965
}
966

967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
/**
 * hb_ot_layout_lookups_substitute_closure:
 *
 * Compute the transitive closure of glyphs needed for all of the
 * provided lookups.
 *
 * Since: 1.8.1
 **/
void
hb_ot_layout_lookups_substitute_closure (hb_face_t      *face,
                                         const hb_set_t *lookups,
                                         hb_set_t       *glyphs)
{
  hb_auto_t<hb_map_t> done_lookups;
  OT::hb_closure_context_t c (face, glyphs, &done_lookups);
  const OT::GSUB& gsub = _get_gsub (face);

984
  unsigned int iteration_count = 0;
985 986 987 988
  unsigned int glyphs_length;
  do
  {
    glyphs_length = glyphs->get_population ();
989 990 991 992
    if (lookups != nullptr)
    {
      for (hb_codepoint_t lookup_index = HB_SET_VALUE_INVALID; hb_set_next (lookups, &lookup_index);)
        gsub.get_lookup (lookup_index).closure (&c, lookup_index);
B
Style  
Behdad Esfahbod 已提交
993 994 995
    }
    else
    {
996 997 998
      for (unsigned int i = 0; i < gsub.get_lookup_count (); i++)
        gsub.get_lookup (i).closure (&c, i);
    }
999 1000 1001
    iteration_count++;
  } while (iteration_count <= HB_CLOSURE_MAX_STAGES
           && glyphs_length != glyphs->get_population ());
1002 1003
}

1004
/*
1005
 * OT::GPOS
1006 1007 1008
 */

hb_bool_t
1009 1010
hb_ot_layout_has_positioning (hb_face_t *face)
{
B
Behdad Esfahbod 已提交
1011
  return &_get_gpos (face) != &Null(OT::GPOS);
1012 1013
}

1014
void
1015
hb_ot_layout_position_start (hb_font_t *font, hb_buffer_t *buffer)
1016
{
1017
  OT::GPOS::position_start (font, buffer);
1018 1019
}

1020
void
1021 1022 1023 1024 1025 1026 1027
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)
1028
{
1029
  OT::GPOS::position_finish_offsets (font, buffer);
1030
}
1031

S
Sascha Brawer 已提交
1032
/**
K
Khaled Hosny 已提交
1033 1034
 * hb_ot_layout_get_size_params:
 *
B
Behdad Esfahbod 已提交
1035
 * Since: 0.9.10
S
Sascha Brawer 已提交
1036
 **/
1037
hb_bool_t
1038
hb_ot_layout_get_size_params (hb_face_t    *face,
B
Behdad Esfahbod 已提交
1039 1040 1041 1042 1043
			      unsigned int *design_size,       /* OUT.  May be nullptr */
			      unsigned int *subfamily_id,      /* OUT.  May be nullptr */
			      unsigned int *subfamily_name_id, /* OUT.  May be nullptr */
			      unsigned int *range_start,       /* OUT.  May be nullptr */
			      unsigned int *range_end          /* OUT.  May be nullptr */)
1044 1045
{
  const OT::GPOS &gpos = _get_gpos (face);
1046
  const hb_tag_t tag = HB_TAG ('s','i','z','e');
1047

1048 1049 1050
  unsigned int num_features = gpos.get_feature_count ();
  for (unsigned int i = 0; i < num_features; i++)
  {
1051
    if (tag == gpos.get_feature_tag (i))
1052
    {
1053
      const OT::Feature &f = gpos.get_feature (i);
1054
      const OT::FeatureParamsSize &params = f.get_feature_params ().get_size_params (tag);
1055

1056
      if (params.designSize)
1057
      {
1058
#define PARAM(a, A) if (a) *a = params.A
1059 1060 1061 1062 1063 1064
	PARAM (design_size, designSize);
	PARAM (subfamily_id, subfamilyID);
	PARAM (subfamily_name_id, subfamilyNameID);
	PARAM (range_start, rangeStart);
	PARAM (range_end, rangeEnd);
#undef PARAM
1065 1066 1067

	return true;
      }
1068 1069 1070
    }
  }

1071
#define PARAM(a, A) if (a) *a = 0
1072 1073 1074 1075 1076
  PARAM (design_size, designSize);
  PARAM (subfamily_id, subfamilyID);
  PARAM (subfamily_name_id, subfamilyNameID);
  PARAM (range_start, rangeStart);
  PARAM (range_end, rangeEnd);
1077
#undef PARAM
1078

1079
  return false;
1080
}
B
Behdad Esfahbod 已提交
1081 1082 1083


/*
B
Behdad Esfahbod 已提交
1084
 * Parts of different types are implemented here such that they have direct
B
Behdad Esfahbod 已提交
1085 1086 1087 1088
 * access to GSUB/GPOS lookups.
 */


B
Behdad Esfahbod 已提交
1089 1090 1091
struct GSUBProxy
{
  static const unsigned int table_index = 0;
B
Behdad Esfahbod 已提交
1092
  static const bool inplace = false;
B
Behdad Esfahbod 已提交
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
  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 已提交
1106
  static const bool inplace = true;
B
Behdad Esfahbod 已提交
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
  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;
};


1118
struct hb_get_subtables_context_t :
1119
       hb_dispatch_context_t<hb_get_subtables_context_t, hb_void_t, HB_DEBUG_APPLY>
1120 1121
{
  template <typename Type>
1122
  static inline bool apply_to (const void *obj, OT::hb_ot_apply_context_t *c)
1123 1124 1125 1126 1127
  {
    const Type *typed_obj = (const Type *) obj;
    return typed_obj->apply (c);
  }

1128
  typedef bool (*hb_apply_func_t) (const void *obj, OT::hb_ot_apply_context_t *c);
1129 1130 1131 1132 1133 1134 1135 1136 1137

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

1138
    inline bool apply (OT::hb_ot_apply_context_t *c) const { return apply_func (obj, c); }
1139 1140 1141 1142 1143 1144

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

B
Behdad Esfahbod 已提交
1145
  typedef hb_auto_t<hb_vector_t<hb_applicable_t> > array_t;
1146 1147 1148 1149 1150 1151 1152

  /* 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();
1153
    entry->init (&obj, apply_to<T>);
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
    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;
};

1167
static inline bool
1168
apply_forward (OT::hb_ot_apply_context_t *c,
1169 1170
	       const hb_ot_layout_lookup_accelerator_t &accel,
	       const hb_get_subtables_context_t::array_t &subtables)
1171 1172 1173
{
  bool ret = false;
  hb_buffer_t *buffer = c->buffer;
B
Behdad Esfahbod 已提交
1174
  while (buffer->idx < buffer->len && buffer->successful)
1175
  {
1176
    bool applied = false;
1177 1178
    if (accel.may_have (buffer->cur().codepoint) &&
	(buffer->cur().mask & c->lookup_mask) &&
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
	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)
1190 1191 1192 1193 1194 1195 1196 1197
      ret = true;
    else
      buffer->next_glyph ();
  }
  return ret;
}

static inline bool
1198
apply_backward (OT::hb_ot_apply_context_t *c,
1199 1200
	       const hb_ot_layout_lookup_accelerator_t &accel,
	       const hb_get_subtables_context_t::array_t &subtables)
1201 1202 1203 1204 1205 1206 1207
{
  bool ret = false;
  hb_buffer_t *buffer = c->buffer;
  do
  {
    if (accel.may_have (buffer->cur().codepoint) &&
	(buffer->cur().mask & c->lookup_mask) &&
1208 1209 1210 1211 1212 1213 1214 1215 1216
	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;
       }
    }
1217 1218 1219 1220 1221 1222 1223 1224
    /* The reverse lookup doesn't "advance" cursor (for good reason). */
    buffer->idx--;

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

1225
template <typename Proxy>
1226
static inline void
1227
apply_string (OT::hb_ot_apply_context_t *c,
1228 1229 1230
	      const typename Proxy::Lookup &lookup,
	      const hb_ot_layout_lookup_accelerator_t &accel)
{
B
Behdad Esfahbod 已提交
1231
  hb_buffer_t *buffer = c->buffer;
1232

1233
  if (unlikely (!buffer->len || !c->lookup_mask))
1234
    return;
1235

1236
  c->set_lookup_props (lookup.get_props ());
1237

1238 1239 1240 1241
  hb_get_subtables_context_t::array_t subtables;
  hb_get_subtables_context_t c_get_subtables (subtables);
  lookup.dispatch (&c_get_subtables);

1242 1243 1244 1245
  if (likely (!lookup.is_reverse ()))
  {
    /* in/out forward substitution/positioning */
    if (Proxy::table_index == 0)
B
Behdad Esfahbod 已提交
1246 1247
      buffer->clear_output ();
    buffer->idx = 0;
1248

1249
    bool ret;
1250
    ret = apply_forward (c, accel, subtables);
1251
    if (ret)
1252
    {
B
Behdad Esfahbod 已提交
1253
      if (!Proxy::inplace)
B
Behdad Esfahbod 已提交
1254
	buffer->swap_buffers ();
1255
      else
1256
	assert (!buffer->has_separate_output ());
1257
    }
1258 1259 1260 1261 1262
  }
  else
  {
    /* in-place backward substitution/positioning */
    if (Proxy::table_index == 0)
B
Behdad Esfahbod 已提交
1263 1264
      buffer->remove_output ();
    buffer->idx = buffer->len - 1;
1265

1266
    apply_backward (c, accel, subtables);
1267 1268 1269
  }
}

B
Behdad Esfahbod 已提交
1270 1271
template <typename Proxy>
inline void hb_ot_map_t::apply (const Proxy &proxy,
B
Behdad Esfahbod 已提交
1272 1273 1274 1275
				const hb_ot_shape_plan_t *plan,
				hb_font_t *font,
				hb_buffer_t *buffer) const
{
B
Behdad Esfahbod 已提交
1276
  const unsigned int table_index = proxy.table_index;
B
Behdad Esfahbod 已提交
1277
  unsigned int i = 0;
1278
  OT::hb_ot_apply_context_t c (table_index, font, buffer);
1279
  c.set_recurse_func (Proxy::Lookup::apply_recurse_func);
B
Behdad Esfahbod 已提交
1280 1281 1282 1283

  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 已提交
1284 1285
    {
      unsigned int lookup_index = lookups[table_index][i].index;
1286
      if (!buffer->message (font, "start lookup %d", lookup_index)) continue;
1287
      c.set_lookup_index (lookup_index);
B
Behdad Esfahbod 已提交
1288 1289
      c.set_lookup_mask (lookups[table_index][i].mask);
      c.set_auto_zwj (lookups[table_index][i].auto_zwj);
1290
      c.set_auto_zwnj (lookups[table_index][i].auto_zwnj);
1291 1292 1293
      apply_string<Proxy> (&c,
			   proxy.table.get_lookup (lookup_index),
			   proxy.accels[lookup_index]);
1294
      (void) buffer->message (font, "end lookup %d", lookup_index);
B
Behdad Esfahbod 已提交
1295
    }
B
Behdad Esfahbod 已提交
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306

    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 已提交
1307 1308
  GSUBProxy proxy (font->face);
  apply (proxy, plan, font, buffer);
B
Behdad Esfahbod 已提交
1309 1310 1311 1312
}

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 已提交
1313 1314 1315 1316
  GPOSProxy proxy (font->face);
  apply (proxy, plan, font, buffer);
}

B
Minor  
Behdad Esfahbod 已提交
1317
void
1318
hb_ot_layout_substitute_lookup (OT::hb_ot_apply_context_t *c,
B
Behdad Esfahbod 已提交
1319 1320 1321
				const OT::SubstLookup &lookup,
				const hb_ot_layout_lookup_accelerator_t &accel)
{
1322
  apply_string<GSUBProxy> (c, lookup, accel);
B
Behdad Esfahbod 已提交
1323
}
B
Behdad Esfahbod 已提交
1324 1325 1326 1327 1328 1329 1330 1331




/*
 * OT::BASE
 */

1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
// /**
//  * hb_ot_base_has_data:
//  * @face: #hb_face_t to test
//  *
//  * This function allows to verify the presence of an OpenType BASE table on the
//  * face.
//  *
//  * Return value: true if face has a BASE table, false otherwise
//  *
//  * Since: XXX
//  **/
// hb_bool_t
// hb_ot_base_has_data (hb_face_t *face)
// {
B
Behdad Esfahbod 已提交
1346
//   return &_get_base (face) != &Null(OT::BASE);
1347
// }