hb-aat-layout-kerx-table.hh 21.7 KB
Newer Older
1 2
/*
 * Copyright © 2018  Ebrahim Byagowi
3
 * Copyright © 2018  Google, Inc.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 *
 *  This is part of HarfBuzz, a text shaping library.
 *
 * 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.
 *
 * Google Author(s): Behdad Esfahbod
 */

#ifndef HB_AAT_LAYOUT_KERX_TABLE_HH
#define HB_AAT_LAYOUT_KERX_TABLE_HH

31 32
#include "hb-open-type.hh"
#include "hb-aat-layout-common.hh"
33
#include "hb-ot-layout-gpos-table.hh"
B
Behdad Esfahbod 已提交
34
#include "hb-ot-kern-table.hh"
35

36 37 38 39
/*
 * kerx -- Extended Kerning
 * https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6kerx.html
 */
40
#define HB_AAT_TAG_kerx HB_TAG('k','e','r','x')
41 42


43
namespace AAT {
44

45
using namespace OT;
46 47


48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
static inline int
kerxTupleKern (int value,
	       unsigned int tupleCount,
	       const void *base,
	       hb_aat_apply_context_t *c)
{
  if (likely (!tupleCount)) return value;

  unsigned int offset = value;
  const FWORD *pv = &StructAtOffset<FWORD> (base, offset);
  if (unlikely (!pv->sanitize (&c->sanitizer))) return 0;
  return *pv;
}


B
Behdad Esfahbod 已提交
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
struct KerxSubTableHeader
{
  inline bool sanitize (hb_sanitize_context_t *c) const
  {
    TRACE_SANITIZE (this);
    return_trace (likely (c->check_struct (this)));
  }

  public:
  HBUINT32	length;
  HBUINT32	coverage;
  HBUINT32	tupleCount;
  public:
  DEFINE_SIZE_STATIC (12);
};

B
Behdad Esfahbod 已提交
79
struct KerxSubTableFormat0
80
{
81 82
  inline int get_kerning (hb_codepoint_t left, hb_codepoint_t right,
			  hb_aat_apply_context_t *c) const
83
  {
B
Behdad Esfahbod 已提交
84 85
    hb_glyph_pair_t pair = {left, right};
    int i = pairs.bsearch (pair);
86 87 88
    if (i == -1) return 0;
    int v = pairs[i].get_kerning ();
    return kerxTupleKern (v, header.tupleCount, this, c);
89 90
  }

91 92 93 94
  inline bool apply (hb_aat_apply_context_t *c) const
  {
    TRACE_APPLY (this);

95 96 97
    if (!c->plan->requested_kerning)
      return false;

98 99
    accelerator_t accel (*this, c);
    hb_kern_machine_t<accelerator_t> machine (accel);
B
Behdad Esfahbod 已提交
100
    machine.kern (c->font, c->buffer, c->plan->kern_mask);
101 102 103

    return_trace (true);
  }
104

105 106 107 108 109 110 111 112 113 114 115 116 117 118
  struct accelerator_t
  {
    const KerxSubTableFormat0 &table;
    hb_aat_apply_context_t *c;

    inline accelerator_t (const KerxSubTableFormat0 &table_,
			  hb_aat_apply_context_t *c_) :
			    table (table_), c (c_) {}

    inline int get_kerning (hb_codepoint_t left, hb_codepoint_t right) const
    { return table.get_kerning (left, right, c); }
  };


119 120 121
  inline bool sanitize (hb_sanitize_context_t *c) const
  {
    TRACE_SANITIZE (this);
122 123
    return_trace (likely (c->check_struct (this) &&
			  pairs.sanitize (c)));
124 125 126
  }

  protected:
B
Behdad Esfahbod 已提交
127
  KerxSubTableHeader	header;
B
Behdad Esfahbod 已提交
128
  BinSearchArrayOf<KernPair, HBUINT32>
B
Behdad Esfahbod 已提交
129
			pairs;	/* Sorted kern records. */
130
  public:
B
Behdad Esfahbod 已提交
131
  DEFINE_SIZE_ARRAY (28, pairs);
132 133 134 135
};

struct KerxSubTableFormat1
{
136 137
  struct EntryData
  {
B
Behdad Esfahbod 已提交
138 139 140
    HBUINT16	kernActionIndex;/* Index into the kerning value array. If
				 * this index is 0xFFFF, then no kerning
				 * is to be performed. */
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
    public:
    DEFINE_SIZE_STATIC (2);
  };

  struct driver_context_t
  {
    static const bool in_place = true;
    enum Flags
    {
      Push		= 0x8000,	/* If set, push this glyph on the kerning stack. */
      DontAdvance	= 0x4000,	/* If set, don't advance to the next glyph
					 * before going to the new state. */
      Reset		= 0x2000,	/* If set, reset the kerning data (clear the stack) */
      Reserved		= 0x1FFF,	/* Not used; set to 0. */
    };

B
Behdad Esfahbod 已提交
157 158 159
    inline driver_context_t (const KerxSubTableFormat1 *table,
			     hb_aat_apply_context_t *c_) :
	c (c_),
B
Behdad Esfahbod 已提交
160 161 162
	/* Apparently the offset kernAction is from the beginning of the state-machine,
	 * similar to offsets in morx table, NOT from beginning of this table, like
	 * other subtables in kerx.  Discovered via testing. */
B
Behdad Esfahbod 已提交
163
	kernAction (&table->machine + table->kernAction),
B
Behdad Esfahbod 已提交
164
	depth (0) {}
165

166
    inline bool is_actionable (StateTableDriver<MorxTypes, EntryData> *driver HB_UNUSED,
167 168
			       const Entry<EntryData> *entry)
    {
B
Behdad Esfahbod 已提交
169
      return entry->data.kernActionIndex != 0xFFFF;
170
    }
171
    inline bool transition (StateTableDriver<MorxTypes, EntryData> *driver,
172 173
			    const Entry<EntryData> *entry)
    {
B
Behdad Esfahbod 已提交
174 175 176 177 178
      hb_buffer_t *buffer = driver->buffer;
      unsigned int flags = entry->flags;

      if (flags & Reset)
      {
B
Behdad Esfahbod 已提交
179
	depth = 0;
B
Behdad Esfahbod 已提交
180 181 182 183
      }

      if (flags & Push)
      {
B
Behdad Esfahbod 已提交
184
	if (likely (depth < ARRAY_LENGTH (stack)))
B
Behdad Esfahbod 已提交
185 186 187 188 189 190 191 192
	  stack[depth++] = buffer->idx;
	else
	  depth = 0; /* Probably not what CoreText does, but better? */
      }

      if (entry->data.kernActionIndex != 0xFFFF)
      {
	const FWORD *actions = &kernAction[entry->data.kernActionIndex];
B
Behdad Esfahbod 已提交
193
	if (!c->sanitizer.check_array (actions, depth))
B
Behdad Esfahbod 已提交
194 195 196 197 198
	{
	  depth = 0;
	  return false;
	}

199
	hb_mask_t kern_mask = c->plan->kern_mask;
B
Behdad Esfahbod 已提交
200
	for (unsigned int i = 0; i < depth; i++)
B
Behdad Esfahbod 已提交
201
	{
B
Behdad Esfahbod 已提交
202 203 204 205 206
	  /* Apparently, when spec says "Each pops one glyph from the kerning stack
	   * and applies the kerning value to it.", it doesn't mean it in that order.
	   * The deepest item in the stack corresponds to the first item in the action
	   * list.  Discovered by testing. */
	  unsigned int idx = stack[i];
B
Behdad Esfahbod 已提交
207
	  int v = *actions++;
208
	  if (idx < buffer->len && buffer->info[idx].mask & kern_mask)
209 210
	  {
	    if (HB_DIRECTION_IS_HORIZONTAL (buffer->props.direction))
B
Behdad Esfahbod 已提交
211
	    {
212
	      buffer->pos[idx].x_advance += c->font->em_scale_x (v);
B
Behdad Esfahbod 已提交
213 214 215
	      if (HB_DIRECTION_IS_BACKWARD (buffer->props.direction))
		buffer->pos[idx].x_offset += c->font->em_scale_x (v);
	    }
216
	    else
B
Behdad Esfahbod 已提交
217
	    {
218
	      buffer->pos[idx].y_advance += c->font->em_scale_y (v);
B
Behdad Esfahbod 已提交
219 220 221
	      if (HB_DIRECTION_IS_BACKWARD (buffer->props.direction))
		buffer->pos[idx].y_offset += c->font->em_scale_y (v);
	    }
222
	  }
B
Behdad Esfahbod 已提交
223
	}
B
Behdad Esfahbod 已提交
224
	depth = 0;
B
Behdad Esfahbod 已提交
225
      }
226 227 228 229 230

      return true;
    }

    private:
B
Behdad Esfahbod 已提交
231 232 233 234
    hb_aat_apply_context_t *c;
    const UnsizedArrayOf<FWORD> &kernAction;
    unsigned int stack[8];
    unsigned int depth;
235 236
  };

237 238 239 240
  inline bool apply (hb_aat_apply_context_t *c) const
  {
    TRACE_APPLY (this);

241 242 243
    if (!c->plan->requested_kerning)
      return false;

244 245 246
    if (header.tupleCount)
      return_trace (false); /* TODO kerxTupleKern */

B
Behdad Esfahbod 已提交
247
    driver_context_t dc (this, c);
248

249
    StateTableDriver<MorxTypes, EntryData> driver (machine, c->buffer, c->font->face);
250
    driver.drive (&dc);
251 252 253 254

    return_trace (true);
  }

255 256
  inline bool sanitize (hb_sanitize_context_t *c) const
  {
257
    TRACE_SANITIZE (this);
B
Behdad Esfahbod 已提交
258 259 260
    /* The rest of array sanitizations are done at run-time. */
    return_trace (likely (c->check_struct (this) &&
			  machine.sanitize (c)));
261 262 263
  }

  protected:
264
  KerxSubTableHeader				header;
B
Behdad Esfahbod 已提交
265
  StateTable<MorxTypes, EntryData>		machine;
B
Behdad Esfahbod 已提交
266
  LOffsetTo<UnsizedArrayOf<FWORD>, false>	kernAction;
267
  public:
B
Behdad Esfahbod 已提交
268
  DEFINE_SIZE_STATIC (32);
269 270 271 272
};

struct KerxSubTableFormat2
{
B
Behdad Esfahbod 已提交
273
  inline int get_kerning (hb_codepoint_t left, hb_codepoint_t right,
274
			  hb_aat_apply_context_t *c) const
275
  {
276
    unsigned int num_glyphs = c->sanitizer.get_num_glyphs ();
277 278
    unsigned int l = (this+leftClassTable).get_value_or_null (left, num_glyphs);
    unsigned int r = (this+rightClassTable).get_value_or_null (right, num_glyphs);
279
    unsigned int offset = l + r;
B
Behdad Esfahbod 已提交
280 281
    const FWORD *v = &StructAtOffset<FWORD> (&(this+array), offset);
    if (unlikely (!v->sanitize (&c->sanitizer))) return 0;
282
    return kerxTupleKern (*v, header.tupleCount, this, c);
283 284
  }

285 286 287 288
  inline bool apply (hb_aat_apply_context_t *c) const
  {
    TRACE_APPLY (this);

289 290 291
    if (!c->plan->requested_kerning)
      return false;

292
    accelerator_t accel (*this, c);
B
Behdad Esfahbod 已提交
293 294
    hb_kern_machine_t<accelerator_t> machine (accel);
    machine.kern (c->font, c->buffer, c->plan->kern_mask);
295 296 297 298

    return_trace (true);
  }

B
Behdad Esfahbod 已提交
299 300 301
  struct accelerator_t
  {
    const KerxSubTableFormat2 &table;
302
    hb_aat_apply_context_t *c;
B
Behdad Esfahbod 已提交
303 304

    inline accelerator_t (const KerxSubTableFormat2 &table_,
305 306
			  hb_aat_apply_context_t *c_) :
			    table (table_), c (c_) {}
B
Behdad Esfahbod 已提交
307 308

    inline int get_kerning (hb_codepoint_t left, hb_codepoint_t right) const
309
    { return table.get_kerning (left, right, c); }
B
Behdad Esfahbod 已提交
310 311
  };

312 313 314 315 316 317 318 319 320
  inline bool sanitize (hb_sanitize_context_t *c) const
  {
    TRACE_SANITIZE (this);
    return_trace (likely (c->check_struct (this) &&
			  leftClassTable.sanitize (c, this) &&
			  rightClassTable.sanitize (c, this) &&
			  c->check_range (this, array)));
  }

321
  protected:
B
Behdad Esfahbod 已提交
322 323
  KerxSubTableHeader	header;
  HBUINT32		rowWidth;	/* The width, in bytes, of a row in the table. */
324
  LOffsetTo<Lookup<HBUINT16>, false>
B
Behdad Esfahbod 已提交
325 326
			leftClassTable;	/* Offset from beginning of this subtable to
					 * left-hand class table. */
327
  LOffsetTo<Lookup<HBUINT16>, false>
B
Behdad Esfahbod 已提交
328 329
			rightClassTable;/* Offset from beginning of this subtable to
					 * right-hand class table. */
B
Behdad Esfahbod 已提交
330 331
  LOffsetTo<UnsizedArrayOf<FWORD>, false>
			 array;		/* Offset from beginning of this subtable to
B
Behdad Esfahbod 已提交
332
					 * the start of the kerning array. */
333
  public:
B
Behdad Esfahbod 已提交
334
  DEFINE_SIZE_STATIC (28);
335 336 337 338
};

struct KerxSubTableFormat4
{
B
Behdad Esfahbod 已提交
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
  struct EntryData
  {
    HBUINT16	ankrActionIndex;/* Either 0xFFFF (for no action) or the index of
				 * the action to perform. */
    public:
    DEFINE_SIZE_STATIC (2);
  };

  struct driver_context_t
  {
    static const bool in_place = true;
    enum Flags
    {
      Mark		= 0x8000,	/* If set, remember this glyph as the marked glyph. */
      DontAdvance	= 0x4000,	/* If set, don't advance to the next glyph before
					 * going to the new state. */
      Reserved		= 0x3FFF,	/* Not used; set to 0. */
    };

    enum SubTableFlags
    {
      ActionType	= 0xC0000000,	/* A two-bit field containing the action type. */
      Unused		= 0x3F000000,	/* Unused - must be zero. */
      Offset		= 0x00FFFFFF,	/* Masks the offset in bytes from the beginning
					 * of the subtable to the beginning of the control
					 * point table. */
    };

    inline driver_context_t (const KerxSubTableFormat4 *table,
			     hb_aat_apply_context_t *c_) :
	c (c_),
	action_type ((table->flags & ActionType) >> 30),
	ankrData ((HBUINT16 *) ((const char *) &table->machine + (table->flags & Offset))),
	mark_set (false),
	mark (0) {}

375
    inline bool is_actionable (StateTableDriver<MorxTypes, EntryData> *driver HB_UNUSED,
B
Behdad Esfahbod 已提交
376 377 378 379
			       const Entry<EntryData> *entry)
    {
      return entry->data.ankrActionIndex != 0xFFFF;
    }
380
    inline bool transition (StateTableDriver<MorxTypes, EntryData> *driver,
B
Behdad Esfahbod 已提交
381 382 383 384 385
			    const Entry<EntryData> *entry)
    {
      hb_buffer_t *buffer = driver->buffer;
      unsigned int flags = entry->flags;

386
      if (mark_set && entry->data.ankrActionIndex != 0xFFFF && buffer->idx < buffer->len)
B
Behdad Esfahbod 已提交
387
      {
388
	hb_glyph_position_t &o = buffer->cur_pos();
B
Behdad Esfahbod 已提交
389 390 391 392 393 394 395 396 397 398
	switch (action_type)
	{
	  case 0: /* Control Point Actions.*/
	  {
	    /* indexed into glyph outline. */
	    const HBUINT16 *data = &ankrData[entry->data.ankrActionIndex];
	    if (!c->sanitizer.check_array (data, 2))
	      return false;
	    HB_UNUSED unsigned int markControlPoint = *data++;
	    HB_UNUSED unsigned int currControlPoint = *data++;
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
	    hb_position_t markX = 0;
	    hb_position_t markY = 0;
	    hb_position_t currX = 0;
	    hb_position_t currY = 0;
	    if (!c->font->get_glyph_contour_point_for_origin (c->buffer->info[mark].codepoint,
							      markControlPoint,
							      HB_DIRECTION_LTR /*XXX*/,
							      &markX, &markY) ||
		!c->font->get_glyph_contour_point_for_origin (c->buffer->cur ().codepoint,
							      currControlPoint,
							      HB_DIRECTION_LTR /*XXX*/,
							      &currX, &currY))
	      return true; /* True, such that the machine continues. */

	    o.x_offset = markX - currX;
	    o.y_offset = markY - currY;
B
Behdad Esfahbod 已提交
415 416 417 418 419 420 421 422 423
	  }
	  break;

	  case 1: /* Anchor Point Actions. */
	  {
	   /* Indexed into 'ankr' table. */
	    const HBUINT16 *data = &ankrData[entry->data.ankrActionIndex];
	    if (!c->sanitizer.check_array (data, 2))
	      return false;
424 425
	    unsigned int markAnchorPoint = *data++;
	    unsigned int currAnchorPoint = *data++;
426 427 428 429 430 431 432 433
	    const Anchor markAnchor = c->ankr_table->get_anchor (c->buffer->info[mark].codepoint,
								 markAnchorPoint,
								 c->sanitizer.get_num_glyphs (),
								 c->ankr_end);
	    const Anchor currAnchor = c->ankr_table->get_anchor (c->buffer->cur ().codepoint,
								 currAnchorPoint,
								 c->sanitizer.get_num_glyphs (),
								 c->ankr_end);
434

435 436
	    o.x_offset = c->font->em_scale_x (markAnchor.xCoordinate) - c->font->em_scale_x (currAnchor.xCoordinate);
	    o.y_offset = c->font->em_scale_y (markAnchor.yCoordinate) - c->font->em_scale_y (currAnchor.yCoordinate);
B
Behdad Esfahbod 已提交
437 438 439 440 441 442 443 444
	  }
	  break;

	  case 2: /* Control Point Coordinate Actions. */
	  {
	    const FWORD *data = (const FWORD *) &ankrData[entry->data.ankrActionIndex];
	    if (!c->sanitizer.check_array (data, 4))
	      return false;
445 446 447 448 449 450 451
	    int markX = *data++;
	    int markY = *data++;
	    int currX = *data++;
	    int currY = *data++;

	    o.x_offset = c->font->em_scale_x (markX) - c->font->em_scale_x (currX);
	    o.y_offset = c->font->em_scale_y (markY) - c->font->em_scale_y (currY);
B
Behdad Esfahbod 已提交
452 453 454
	  }
	  break;
	}
455 456 457
	o.attach_type() = ATTACH_TYPE_MARK;
	o.attach_chain() = (int) mark - (int) buffer->idx;
	buffer->scratch_flags |= HB_BUFFER_SCRATCH_FLAG_HAS_GPOS_ATTACHMENT;
B
Behdad Esfahbod 已提交
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
      }

      if (flags & Mark)
      {
	mark_set = true;
	mark = buffer->idx;
      }

      return true;
    }

    private:
    hb_aat_apply_context_t *c;
    unsigned int action_type;
    const HBUINT16 *ankrData;
    bool mark_set;
    unsigned int mark;
  };

477 478 479 480
  inline bool apply (hb_aat_apply_context_t *c) const
  {
    TRACE_APPLY (this);

B
Behdad Esfahbod 已提交
481 482
    driver_context_t dc (this, c);

483
    StateTableDriver<MorxTypes, EntryData> driver (machine, c->buffer, c->font->face);
B
Behdad Esfahbod 已提交
484
    driver.drive (&dc);
485 486 487 488

    return_trace (true);
  }

489 490 491
  inline bool sanitize (hb_sanitize_context_t *c) const
  {
    TRACE_SANITIZE (this);
B
Behdad Esfahbod 已提交
492
    /* The rest of array sanitizations are done at run-time. */
B
Behdad Esfahbod 已提交
493 494
    return_trace (likely (c->check_struct (this) &&
			  machine.sanitize (c)));
495 496 497
  }

  protected:
B
Behdad Esfahbod 已提交
498
  KerxSubTableHeader	header;
499 500
  StateTable<MorxTypes, EntryData>
			machine;
B
Behdad Esfahbod 已提交
501
  HBUINT32		flags;
502
  public:
B
Behdad Esfahbod 已提交
503
  DEFINE_SIZE_STATIC (32);
504 505 506 507
};

struct KerxSubTableFormat6
{
508 509 510 511 512 513 514
  enum Flags
  {
    ValuesAreLong	= 0x00000001,
  };

  inline bool is_long (void) const { return flags & ValuesAreLong; }

B
Behdad Esfahbod 已提交
515
  inline int get_kerning (hb_codepoint_t left, hb_codepoint_t right,
516
			  hb_aat_apply_context_t *c) const
B
Behdad Esfahbod 已提交
517
  {
518
    unsigned int num_glyphs = c->sanitizer.get_num_glyphs ();
B
Behdad Esfahbod 已提交
519 520 521 522 523 524
    if (is_long ())
    {
      const U::Long &t = u.l;
      unsigned int l = (this+t.rowIndexTable).get_value_or_null (left, num_glyphs);
      unsigned int r = (this+t.columnIndexTable).get_value_or_null (right, num_glyphs);
      unsigned int offset = l + r;
B
Behdad Esfahbod 已提交
525 526
      if (unlikely (offset < l)) return 0; /* Addition overflow. */
      if (unlikely (hb_unsigned_mul_overflows (offset, sizeof (FWORD32)))) return 0;
B
Behdad Esfahbod 已提交
527 528
      const FWORD32 *v = &StructAtOffset<FWORD32> (&(this+t.array), offset * sizeof (FWORD32));
      if (unlikely (!v->sanitize (&c->sanitizer))) return 0;
529
      return kerxTupleKern (*v, header.tupleCount, &(this+vector), c);
B
Behdad Esfahbod 已提交
530 531 532 533 534 535 536
    }
    else
    {
      const U::Short &t = u.s;
      unsigned int l = (this+t.rowIndexTable).get_value_or_null (left, num_glyphs);
      unsigned int r = (this+t.columnIndexTable).get_value_or_null (right, num_glyphs);
      unsigned int offset = l + r;
B
Behdad Esfahbod 已提交
537 538
      const FWORD *v = &StructAtOffset<FWORD> (&(this+t.array), offset * sizeof (FWORD));
      if (unlikely (!v->sanitize (&c->sanitizer))) return 0;
539
      return kerxTupleKern (*v, header.tupleCount, &(this+vector), c);
B
Behdad Esfahbod 已提交
540 541 542
    }
  }

543 544 545 546
  inline bool apply (hb_aat_apply_context_t *c) const
  {
    TRACE_APPLY (this);

547 548 549
    if (!c->plan->requested_kerning)
      return false;

550
    accelerator_t accel (*this, c);
B
Behdad Esfahbod 已提交
551 552
    hb_kern_machine_t<accelerator_t> machine (accel);
    machine.kern (c->font, c->buffer, c->plan->kern_mask);
553 554 555 556

    return_trace (true);
  }

557 558
  inline bool sanitize (hb_sanitize_context_t *c) const
  {
559
    TRACE_SANITIZE (this);
E
Ebrahim Byagowi 已提交
560
    return_trace (likely (c->check_struct (this) &&
B
Behdad Esfahbod 已提交
561 562 563 564 565 566 567 568 569
			  (is_long () ?
			   (
			     u.l.rowIndexTable.sanitize (c, this) &&
			     u.l.columnIndexTable.sanitize (c, this) &&
			     c->check_range (this, u.l.array)
			   ) : (
			     u.s.rowIndexTable.sanitize (c, this) &&
			     u.s.columnIndexTable.sanitize (c, this) &&
			     c->check_range (this, u.s.array)
570 571 572
			   )) &&
			  (header.tupleCount == 0 ||
			   c->check_range (this, vector))));
573 574
  }

B
Behdad Esfahbod 已提交
575 576 577
  struct accelerator_t
  {
    const KerxSubTableFormat6 &table;
578
    hb_aat_apply_context_t *c;
B
Behdad Esfahbod 已提交
579 580

    inline accelerator_t (const KerxSubTableFormat6 &table_,
581 582
			  hb_aat_apply_context_t *c_) :
			    table (table_), c (c_) {}
B
Behdad Esfahbod 已提交
583 584

    inline int get_kerning (hb_codepoint_t left, hb_codepoint_t right) const
585
    { return table.get_kerning (left, right, c); }
B
Behdad Esfahbod 已提交
586 587
  };

588
  protected:
B
Behdad Esfahbod 已提交
589 590 591 592
  KerxSubTableHeader		header;
  HBUINT32			flags;
  HBUINT16			rowCount;
  HBUINT16			columnCount;
B
Behdad Esfahbod 已提交
593
  union U
594
  {
B
Behdad Esfahbod 已提交
595
    struct Long
596
    {
597 598 599
      LOffsetTo<Lookup<HBUINT32>, false>	rowIndexTable;
      LOffsetTo<Lookup<HBUINT32>, false>	columnIndexTable;
      LOffsetTo<UnsizedArrayOf<FWORD32>, false>	array;
600
    } l;
B
Behdad Esfahbod 已提交
601 602
    struct Short
    {
603 604 605
      LOffsetTo<Lookup<HBUINT16>, false>	rowIndexTable;
      LOffsetTo<Lookup<HBUINT16>, false>	columnIndexTable;
      LOffsetTo<UnsizedArrayOf<FWORD>, false>	array;
B
Behdad Esfahbod 已提交
606
    } s;
607
  } u;
608
  LOffsetTo<UnsizedArrayOf<FWORD>, false>	vector;
609
  public:
610
  DEFINE_SIZE_STATIC (36);
611 612
};

613 614
struct KerxTable
{
B
Behdad Esfahbod 已提交
615
  friend struct kerx;
B
Behdad Esfahbod 已提交
616

B
Behdad Esfahbod 已提交
617 618
  inline unsigned int get_size (void) const { return u.header.length; }
  inline unsigned int get_type (void) const { return u.header.coverage & SubtableType; }
619 620

  enum Coverage
621
  {
622 623 624
    Vertical		= 0x80000000,	/* Set if table has vertical kerning values. */
    CrossStream		= 0x40000000,	/* Set if table has cross-stream kerning values. */
    Variation		= 0x20000000,	/* Set if table has variation kerning values. */
B
Behdad Esfahbod 已提交
625
    Backwards		= 0x10000000,	/* If clear, process the glyphs forwards, that
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
					 * is, from first to last in the glyph stream.
					 * If we, process them from last to first.
					 * This flag only applies to state-table based
					 * 'kerx' subtables (types 1 and 4). */
    Reserved		= 0x0FFFFF00,	/* Reserved, set to zero. */
    SubtableType	= 0x000000FF,	/* Subtable type. */
  };

  template <typename context_t>
  inline typename context_t::return_t dispatch (context_t *c) const
  {
    unsigned int subtable_type = get_type ();
    TRACE_DISPATCH (this, subtable_type);
    switch (subtable_type) {
    case 0	:		return_trace (c->dispatch (u.format0));
    case 1	:		return_trace (c->dispatch (u.format1));
    case 2	:		return_trace (c->dispatch (u.format2));
    case 4	:		return_trace (c->dispatch (u.format4));
    case 6	:		return_trace (c->dispatch (u.format6));
    default:			return_trace (c->default_return_value ());
    }
647 648
  }

649
  inline bool sanitize (hb_sanitize_context_t *c) const
650 651
  {
    TRACE_SANITIZE (this);
B
Behdad Esfahbod 已提交
652 653
    if (!u.header.sanitize (c) ||
	!c->check_range (this, u.header.length))
654 655
      return_trace (false);

656
    return_trace (dispatch (c));
657 658
  }

659
protected:
660
  union {
B
Behdad Esfahbod 已提交
661
  KerxSubTableHeader	header;
662
  KerxSubTableFormat0	format0;
663
  KerxSubTableFormat1	format1;
664 665 666 667
  KerxSubTableFormat2	format2;
  KerxSubTableFormat4	format4;
  KerxSubTableFormat6	format6;
  } u;
668 669
public:
  DEFINE_SIZE_MIN (12);
670 671
};

672 673 674 675 676

/*
 * The 'kerx' Table
 */

677 678
struct kerx
{
679
  static const hb_tag_t tableTag = HB_AAT_TAG_kerx;
680

681 682 683
  inline bool has_data (void) const { return version != 0; }

  inline void apply (hb_aat_apply_context_t *c) const
684
  {
685 686 687 688 689
    c->set_lookup_index (0);
    const KerxTable *table = &firstTable;
    unsigned int count = tableCount;
    for (unsigned int i = 0; i < count; i++)
    {
B
Behdad Esfahbod 已提交
690 691
      bool reverse;

692 693
      if (table->u.header.coverage & (KerxTable::CrossStream))
	goto skip; /* We do NOT handle cross-stream. */
B
Behdad Esfahbod 已提交
694

B
Behdad Esfahbod 已提交
695
      if (HB_DIRECTION_IS_VERTICAL (c->buffer->props.direction) !=
B
Behdad Esfahbod 已提交
696
	  bool (table->u.header.coverage & KerxTable::Vertical))
B
Behdad Esfahbod 已提交
697
	goto skip;
B
Behdad Esfahbod 已提交
698

B
Behdad Esfahbod 已提交
699
      reverse = bool (table->u.header.coverage & KerxTable::Backwards) !=
B
Behdad Esfahbod 已提交
700 701 702
		HB_DIRECTION_IS_BACKWARD (c->buffer->props.direction);

      if (!c->buffer->message (c->font, "start kerx subtable %d", c->lookup_index))
B
Behdad Esfahbod 已提交
703
	goto skip;
B
Behdad Esfahbod 已提交
704 705

      if (reverse)
B
Behdad Esfahbod 已提交
706
	c->buffer->reverse ();
B
Behdad Esfahbod 已提交
707

708 709
      c->sanitizer.set_object (*table);

B
Behdad Esfahbod 已提交
710 711 712 713
      /* XXX Reverse-kern is not working yet...
       * hb_kern_machine_t would need to know that it's reverse-kerning.
       * Or better yet, make it work in reverse as well, so we don't have
       * to reverse and reverse back? */
714
      table->dispatch (c);
B
Behdad Esfahbod 已提交
715 716

      if (reverse)
B
Behdad Esfahbod 已提交
717
	c->buffer->reverse ();
B
Behdad Esfahbod 已提交
718 719 720 721

      (void) c->buffer->message (c->font, "end kerx subtable %d", c->lookup_index);

    skip:
722 723
      table = &StructAfter<KerxTable> (*table);
    }
724 725
  }

726
  inline bool sanitize (hb_sanitize_context_t *c) const
727
  {
728
    TRACE_SANITIZE (this);
729 730
    if (!version.sanitize (c) || version < 2 ||
	!tableCount.sanitize (c))
731
      return_trace (false);
732

733 734 735
    const KerxTable *table = &firstTable;
    unsigned int count = tableCount;
    for (unsigned int i = 0; i < count; i++)
736
    {
737 738
      if (!table->sanitize (c))
	return_trace (false);
739
      table = &StructAfter<KerxTable> (*table);
740 741 742 743 744 745
    }

    return_trace (true);
  }

  protected:
746 747 748 749 750 751 752 753
  HBUINT16	version;	/* The version number of the extended kerning table
				 * (currently 2, 3, or 4). */
  HBUINT16	unused;		/* Set to 0. */
  HBUINT32	tableCount;	/* The number of subtables included in the extended kerning
				 * table. */
  KerxTable	firstTable;	/* Subtables. */
/*subtableGlyphCoverageArray*/	/* Only if version >= 3. We don't use. */

754
  public:
755
  DEFINE_SIZE_MIN (8);
756 757 758 759 760 761
};

} /* namespace AAT */


#endif /* HB_AAT_LAYOUT_KERX_TABLE_HH */