src/hb-ot-layout-gsubgpos-private.hh

   1 /*
   2  * Copyright (C) 2007,2008,2009  Red Hat, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Red Hat Author(s): Behdad Esfahbod
  25  */
  26
  27 #ifndef HB_OT_LAYOUT_GSUBGPOS_PRIVATE_HH
  28 #define HB_OT_LAYOUT_GSUBGPOS_PRIVATE_HH
  29
  30 #include "hb-buffer-private.h"
  31 #include "hb-ot-layout-gdef-private.hh"
  32
  33
  34 #ifndef HB_DEBUG_APPLY
  35 #define HB_DEBUG_APPLY HB_DEBUG+0
  36 #endif
  37
  38 #define TRACE_APPLY() \
  39         HB_STMT_START { \
  40           if (HB_DEBUG_APPLY) \
  41                   _hb_trace ("APPLY", HB_FUNC, this, apply_depth, HB_DEBUG_APPLY); \
  42         } HB_STMT_END
  43
  44
  45 #define APPLY_ARG_DEF \
  46         hb_apply_context_t *context, \
  47         hb_ot_layout_context_t *layout_context, \
  48         hb_buffer_t *buffer, \
  49         unsigned int context_length HB_UNUSED, \
  50         unsigned int apply_depth HB_UNUSED
  51 #define APPLY_ARG \
  52         context, \
  53         layout_context, \
  54         buffer, \
  55         context_length, \
  56         (HB_DEBUG_APPLY ? apply_depth + 1 : 0)
  57
  58 struct hb_apply_context_t
  59 {
  60   unsigned int nesting_level_left;
  61   unsigned int lookup_flag;
  62   unsigned int property; /* propety of first glyph (TODO remove) */
  63 };
  64
  65
  66 typedef bool (*match_func_t) (hb_codepoint_t glyph_id, const USHORT &value, const char *data);
  67 typedef bool (*apply_lookup_func_t) (APPLY_ARG_DEF, unsigned int lookup_index);
  68
  69 struct ContextFuncs
  70 {
  71   match_func_t match;
  72   apply_lookup_func_t apply;
  73 };
  74
  75
  76 static inline bool match_glyph (hb_codepoint_t glyph_id, const USHORT &value, const char *data HB_UNUSED)
  77 {
  78   return glyph_id == value;
  79 }
  80
  81 static inline bool match_class (hb_codepoint_t glyph_id, const USHORT &value, const char *data)
  82 {
  83   const ClassDef &class_def = *reinterpret_cast<const ClassDef *>(data);
  84   return class_def.get_class (glyph_id) == value;
  85 }
  86
  87 static inline bool match_coverage (hb_codepoint_t glyph_id, const USHORT &value, const char *data)
  88 {
  89   const OffsetTo<Coverage> &coverage = (const OffsetTo<Coverage>&)value;
  90   return (data+coverage) (glyph_id) != NOT_COVERED;
  91 }
  92
  93
  94 static inline bool match_input (APPLY_ARG_DEF,
  95                                 unsigned int count, /* Including the first glyph (not matched) */
  96                                 const USHORT input[], /* Array of input values--start with second glyph */
  97                                 match_func_t match_func,
  98                                 const char *match_data,
  99                                 unsigned int *context_length_out)
 100 {
 101   unsigned int i, j;
 102   unsigned int end = MIN (buffer->in_length, buffer->in_pos + context_length);
 103   if (unlikely (buffer->in_pos + count > end))
 104     return false;
 105
 106   for (i = 1, j = buffer->in_pos + 1; i < count; i++, j++)
 107   {
 108     while (_hb_ot_layout_skip_mark (layout_context->face, IN_INFO (j), context->lookup_flag, NULL))
 109     {
 110       if (unlikely (j + count - i == end))
 111         return false;
 112       j++;
 113     }
 114
 115     if (likely (!match_func (IN_GLYPH (j), input[i - 1], match_data)))
 116       return false;
 117   }
 118
 119   *context_length_out = j - buffer->in_pos;
 120
 121   return true;
 122 }
 123
 124 static inline bool match_backtrack (APPLY_ARG_DEF,
 125                                     unsigned int count,
 126                                     const USHORT backtrack[],
 127                                     match_func_t match_func,
 128                                     const char *match_data)
 129 {
 130   if (unlikely (buffer->out_pos < count))
 131     return false;
 132
 133   for (unsigned int i = 0, j = buffer->out_pos - 1; i < count; i++, j--)
 134   {
 135     while (_hb_ot_layout_skip_mark (layout_context->face, OUT_INFO (j), context->lookup_flag, NULL))
 136     {
 137       if (unlikely (j + 1 == count - i))
 138         return false;
 139       j--;
 140     }
 141
 142     if (likely (!match_func (OUT_GLYPH (j), backtrack[i], match_data)))
 143       return false;
 144   }
 145
 146   return true;
 147 }
 148
 149 static inline bool match_lookahead (APPLY_ARG_DEF,
 150                                     unsigned int count,
 151                                     const USHORT lookahead[],
 152                                     match_func_t match_func,
 153                                     const char *match_data,
 154                                     unsigned int offset)
 155 {
 156   unsigned int i, j;
 157   unsigned int end = MIN (buffer->in_length, buffer->in_pos + context_length);
 158   if (unlikely (buffer->in_pos + offset + count > end))
 159     return false;
 160
 161   for (i = 0, j = buffer->in_pos + offset; i < count; i++, j++)
 162   {
 163     while (_hb_ot_layout_skip_mark (layout_context->face, OUT_INFO (j), context->lookup_flag, NULL))
 164     {
 165       if (unlikely (j + count - i == end))
 166         return false;
 167       j++;
 168     }
 169
 170     if (likely (!match_func (IN_GLYPH (j), lookahead[i], match_data)))
 171       return false;
 172   }
 173
 174   return true;
 175 }
 176
 177
 178 struct LookupRecord
 179 {
 180   static inline unsigned int get_size () { return sizeof (LookupRecord); }
 181
 182   inline bool sanitize (SANITIZE_ARG_DEF) {
 183     TRACE_SANITIZE ();
 184     return SANITIZE_SELF ();
 185   }
 186
 187   USHORT        sequenceIndex;          /* Index into current glyph
 188                                          * sequence--first glyph = 0 */
 189   USHORT        lookupListIndex;        /* Lookup to apply to that
 190                                          * position--zero--based */
 191 };
 192 ASSERT_SIZE (LookupRecord, 4);
 193
 194 static inline bool apply_lookup (APPLY_ARG_DEF,
 195                                  unsigned int count, /* Including the first glyph */
 196                                  unsigned int lookupCount,
 197                                  const LookupRecord lookupRecord[], /* Array of LookupRecords--in design order */
 198                                  apply_lookup_func_t apply_func)
 199 {
 200   unsigned int end = MIN (buffer->in_length, buffer->in_pos + context_length);
 201   if (unlikely (buffer->in_pos + count > end))
 202     return false;
 203
 204   /* TODO We don't support lookupRecord arrays that are not increasing:
 205    *      Should be easy for in_place ones at least. */
 206
 207   /* Note: If sublookup is reverse, i will underflow after the first loop
 208    * and we jump out of it.  Not entirely disastrous.  So we don't check
 209    * for reverse lookup here.
 210    */
 211   for (unsigned int i = 0; i < count; /* NOP */)
 212   {
 213     while (_hb_ot_layout_skip_mark (layout_context->face, IN_CURINFO (), context->lookup_flag, NULL))
 214     {
 215       if (unlikely (buffer->in_pos == end))
 216         return true;
 217       /* No lookup applied for this index */
 218       _hb_buffer_next_glyph (buffer);
 219     }
 220
 221     if (lookupCount && i == lookupRecord->sequenceIndex)
 222     {
 223       unsigned int old_pos = buffer->in_pos;
 224
 225       /* Apply a lookup */
 226       bool done = apply_func (APPLY_ARG, lookupRecord->lookupListIndex);
 227
 228       lookupRecord++;
 229       lookupCount--;
 230       /* Err, this is wrong if the lookup jumped over some glyphs */
 231       i += buffer->in_pos - old_pos;
 232       if (unlikely (buffer->in_pos == end))
 233         return true;
 234
 235       if (!done)
 236         goto not_applied;
 237     }
 238     else
 239     {
 240     not_applied:
 241       /* No lookup applied for this index */
 242       _hb_buffer_next_glyph (buffer);
 243       i++;
 244     }
 245   }
 246
 247   return true;
 248 }
 249
 250
 251 /* Contextual lookups */
 252
 253 struct ContextLookupContext
 254 {
 255   ContextFuncs funcs;
 256   const char *match_data;
 257 };
 258
 259 static inline bool context_lookup (APPLY_ARG_DEF,
 260                                    unsigned int inputCount, /* Including the first glyph (not matched) */
 261                                    const USHORT input[], /* Array of input values--start with second glyph */
 262                                    unsigned int lookupCount,
 263                                    const LookupRecord lookupRecord[],
 264                                    ContextLookupContext &lookup_context)
 265 {
 266   return match_input (APPLY_ARG,
 267                       inputCount, input,
 268                       lookup_context.funcs.match, lookup_context.match_data,
 269                       &context_length) &&
 270          apply_lookup (APPLY_ARG,
 271                        inputCount,
 272                        lookupCount, lookupRecord,
 273                        lookup_context.funcs.apply);
 274 }
 275
 276 struct Rule
 277 {
 278   friend struct RuleSet;
 279
 280   private:
 281   inline bool apply (APPLY_ARG_DEF, ContextLookupContext &lookup_context) const
 282   {
 283     TRACE_APPLY ();
 284     const LookupRecord &lookupRecord = StructAtOffset<LookupRecord> (input, input[0].get_size () * (inputCount ? inputCount - 1 : 0));
 285     return context_lookup (APPLY_ARG,
 286                            inputCount, input,
 287                            lookupCount, &lookupRecord,
 288                            lookup_context);
 289   }
 290
 291   public:
 292   inline bool sanitize (SANITIZE_ARG_DEF) {
 293     TRACE_SANITIZE ();
 294     if (!(SANITIZE (inputCount) && SANITIZE (lookupCount))) return false;
 295     return SANITIZE_MEM (input,
 296                          input[0].get_size () * inputCount +
 297                          lookupRecordX[0].get_size () * lookupCount);
 298   }
 299
 300   private:
 301   USHORT        inputCount;             /* Total number of glyphs in input
 302                                          * glyph sequence--includes the  first
 303                                          * glyph */
 304   USHORT        lookupCount;            /* Number of LookupRecords */
 305   USHORT        input[VAR];             /* Array of match inputs--start with
 306                                          * second glyph */
 307   LookupRecord  lookupRecordX[VAR];     /* Array of LookupRecords--in
 308                                          * design order */
 309 };
 310 ASSERT_SIZE_VAR2 (Rule, 4, USHORT, LookupRecord);
 311
 312 struct RuleSet
 313 {
 314   inline bool apply (APPLY_ARG_DEF, ContextLookupContext &lookup_context) const
 315   {
 316     TRACE_APPLY ();
 317     unsigned int num_rules = rule.len;
 318     for (unsigned int i = 0; i < num_rules; i++)
 319     {
 320       if ((this+rule[i]).apply (APPLY_ARG, lookup_context))
 321         return true;
 322     }
 323
 324     return false;
 325   }
 326
 327   inline bool sanitize (SANITIZE_ARG_DEF) {
 328     TRACE_SANITIZE ();
 329     return SANITIZE_THIS (rule);
 330   }
 331
 332   private:
 333   OffsetArrayOf<Rule>
 334                 rule;                   /* Array of Rule tables
 335                                          * ordered by preference */
 336 };
 337
 338
 339 struct ContextFormat1
 340 {
 341   friend struct Context;
 342
 343   private:
 344   inline bool apply (APPLY_ARG_DEF, apply_lookup_func_t apply_func) const
 345   {
 346     TRACE_APPLY ();
 347     unsigned int index = (this+coverage) (IN_CURGLYPH ());
 348     if (likely (index == NOT_COVERED))
 349       return false;
 350
 351     const RuleSet &rule_set = this+ruleSet[index];
 352     struct ContextLookupContext lookup_context = {
 353       {match_glyph, apply_func},
 354       NULL
 355     };
 356     return rule_set.apply (APPLY_ARG, lookup_context);
 357   }
 358
 359   inline bool sanitize (SANITIZE_ARG_DEF) {
 360     TRACE_SANITIZE ();
 361     return SANITIZE_THIS2 (coverage, ruleSet);
 362   }
 363
 364   private:
 365   USHORT        format;                 /* Format identifier--format = 1 */
 366   OffsetTo<Coverage>
 367                 coverage;               /* Offset to Coverage table--from
 368                                          * beginning of table */
 369   OffsetArrayOf<RuleSet>
 370                 ruleSet;                /* Array of RuleSet tables
 371                                          * ordered by Coverage Index */
 372 };
 373 ASSERT_SIZE (ContextFormat1, 6);
 374
 375
 376 struct ContextFormat2
 377 {
 378   friend struct Context;
 379
 380   private:
 381   inline bool apply (APPLY_ARG_DEF, apply_lookup_func_t apply_func) const
 382   {
 383     TRACE_APPLY ();
 384     unsigned int index = (this+coverage) (IN_CURGLYPH ());
 385     if (likely (index == NOT_COVERED))
 386       return false;
 387
 388     const ClassDef &class_def = this+classDef;
 389     index = class_def (IN_CURGLYPH ());
 390     const RuleSet &rule_set = this+ruleSet[index];
 391     /* LONGTERMTODO: Old code fetches glyph classes at most once and caches
 392      * them across subrule lookups.  Not sure it's worth it.
 393      */
 394     struct ContextLookupContext lookup_context = {
 395      {match_class, apply_func},
 396       CharP(&class_def)
 397     };
 398     return rule_set.apply (APPLY_ARG, lookup_context);
 399   }
 400
 401   inline bool sanitize (SANITIZE_ARG_DEF) {
 402     TRACE_SANITIZE ();
 403     return SANITIZE_THIS (coverage)
 404         && SANITIZE_THIS (classDef)
 405         && SANITIZE_THIS (ruleSet);
 406   }
 407
 408   private:
 409   USHORT        format;                 /* Format identifier--format = 2 */
 410   OffsetTo<Coverage>
 411                 coverage;               /* Offset to Coverage table--from
 412                                          * beginning of table */
 413   OffsetTo<ClassDef>
 414                 classDef;               /* Offset to glyph ClassDef table--from
 415                                          * beginning of table */
 416   OffsetArrayOf<RuleSet>
 417                 ruleSet;                /* Array of RuleSet tables
 418                                          * ordered by class */
 419 };
 420 ASSERT_SIZE (ContextFormat2, 8);
 421
 422
 423 struct ContextFormat3
 424 {
 425   friend struct Context;
 426
 427   private:
 428   inline bool apply (APPLY_ARG_DEF, apply_lookup_func_t apply_func) const
 429   {
 430     TRACE_APPLY ();
 431     unsigned int index = (this+coverage[0]) (IN_CURGLYPH ());
 432     if (likely (index == NOT_COVERED))
 433       return false;
 434
 435     const LookupRecord &lookupRecord = StructAtOffset<LookupRecord> (coverage, coverage[0].get_size () * glyphCount);
 436     struct ContextLookupContext lookup_context = {
 437       {match_coverage, apply_func},
 438        CharP(this)
 439     };
 440     return context_lookup (APPLY_ARG,
 441                            glyphCount, (const USHORT *) (coverage + 1),
 442                            lookupCount, &lookupRecord,
 443                            lookup_context);
 444   }
 445
 446   inline bool sanitize (SANITIZE_ARG_DEF) {
 447     TRACE_SANITIZE ();
 448     if (!SANITIZE_SELF ()) return false;
 449     unsigned int count = glyphCount;
 450     if (!SANITIZE_ARRAY (coverage, OffsetTo<Coverage>::get_size (), glyphCount)) return false;
 451     for (unsigned int i = 0; i < count; i++)
 452       if (!SANITIZE_THIS (coverage[i])) return false;
 453     LookupRecord &lookupRecord = StructAtOffset<LookupRecord> (coverage, OffsetTo<Coverage>::get_size () * glyphCount);
 454     return SANITIZE_ARRAY (&lookupRecord, LookupRecord::get_size (), lookupCount);
 455   }
 456
 457   private:
 458   USHORT        format;                 /* Format identifier--format = 3 */
 459   USHORT        glyphCount;             /* Number of glyphs in the input glyph
 460                                          * sequence */
 461   USHORT        lookupCount;            /* Number of LookupRecords */
 462   OffsetTo<Coverage>
 463                 coverage[VAR];          /* Array of offsets to Coverage
 464                                          * table in glyph sequence order */
 465   LookupRecord  lookupRecordX[VAR];     /* Array of LookupRecords--in
 466                                          * design order */
 467 };
 468 ASSERT_SIZE_VAR2 (ContextFormat3, 6, OffsetTo<Coverage>, LookupRecord);
 469
 470 struct Context
 471 {
 472   protected:
 473   inline bool apply (APPLY_ARG_DEF, apply_lookup_func_t apply_func) const
 474   {
 475     TRACE_APPLY ();
 476     switch (u.format) {
 477     case 1: return u.format1->apply (APPLY_ARG, apply_func);
 478     case 2: return u.format2->apply (APPLY_ARG, apply_func);
 479     case 3: return u.format3->apply (APPLY_ARG, apply_func);
 480     default:return false;
 481     }
 482   }
 483
 484   inline bool sanitize (SANITIZE_ARG_DEF) {
 485     TRACE_SANITIZE ();
 486     if (!SANITIZE (u.format)) return false;
 487     switch (u.format) {
 488     case 1: return u.format1->sanitize (SANITIZE_ARG);
 489     case 2: return u.format2->sanitize (SANITIZE_ARG);
 490     case 3: return u.format3->sanitize (SANITIZE_ARG);
 491     default:return true;
 492     }
 493   }
 494
 495   private:
 496   union {
 497   USHORT                format;         /* Format identifier */
 498   ContextFormat1        format1[VAR];
 499   ContextFormat2        format2[VAR];
 500   ContextFormat3        format3[VAR];
 501   } u;
 502 };
 503
 504
 505 /* Chaining Contextual lookups */
 506
 507 struct ChainContextLookupContext
 508 {
 509   ContextFuncs funcs;
 510   const char *match_data[3];
 511 };
 512
 513 static inline bool chain_context_lookup (APPLY_ARG_DEF,
 514                                          unsigned int backtrackCount,
 515                                          const USHORT backtrack[],
 516                                          unsigned int inputCount, /* Including the first glyph (not matched) */
 517                                          const USHORT input[], /* Array of input values--start with second glyph */
 518                                          unsigned int lookaheadCount,
 519                                          const USHORT lookahead[],
 520                                          unsigned int lookupCount,
 521                                          const LookupRecord lookupRecord[],
 522                                          ChainContextLookupContext &lookup_context)
 523 {
 524   /* First guess */
 525   if (unlikely (buffer->out_pos < backtrackCount ||
 526                    buffer->in_pos + inputCount + lookaheadCount > buffer->in_length ||
 527                    inputCount + lookaheadCount > context_length))
 528     return false;
 529
 530   unsigned int offset;
 531   return match_backtrack (APPLY_ARG,
 532                           backtrackCount, backtrack,
 533                           lookup_context.funcs.match, lookup_context.match_data[0]) &&
 534          match_input (APPLY_ARG,
 535                       inputCount, input,
 536                       lookup_context.funcs.match, lookup_context.match_data[1],
 537                       &offset) &&
 538          match_lookahead (APPLY_ARG,
 539                           lookaheadCount, lookahead,
 540                           lookup_context.funcs.match, lookup_context.match_data[2],
 541                           offset) &&
 542          (context_length = offset, true) &&
 543          apply_lookup (APPLY_ARG,
 544                        inputCount,
 545                        lookupCount, lookupRecord,
 546                        lookup_context.funcs.apply);
 547 }
 548
 549 struct ChainRule
 550 {
 551   friend struct ChainRuleSet;
 552
 553   private:
 554   inline bool apply (APPLY_ARG_DEF, ChainContextLookupContext &lookup_context) const
 555   {
 556     TRACE_APPLY ();
 557     const HeadlessArrayOf<USHORT> &input = StructAfter<HeadlessArrayOf<USHORT> > (backtrack);
 558     const ArrayOf<USHORT> &lookahead = StructAfter<ArrayOf<USHORT> > (input);
 559     const ArrayOf<LookupRecord> &lookup = StructAfter<ArrayOf<LookupRecord> > (lookahead);
 560     return chain_context_lookup (APPLY_ARG,
 561                                  backtrack.len, backtrack.array(),
 562                                  input.len, input.array(),
 563                                  lookahead.len, lookahead.array(),
 564                                  lookup.len, lookup.array(),
 565                                  lookup_context);
 566     return false;
 567   }
 568
 569   public:
 570   inline bool sanitize (SANITIZE_ARG_DEF) {
 571     TRACE_SANITIZE ();
 572     if (!SANITIZE (backtrack)) return false;
 573     HeadlessArrayOf<USHORT> &input = StructAfter<HeadlessArrayOf<USHORT> > (backtrack);
 574     if (!SANITIZE (input)) return false;
 575     ArrayOf<USHORT> &lookahead = StructAfter<ArrayOf<USHORT> > (input);
 576     if (!SANITIZE (lookahead)) return false;
 577     ArrayOf<LookupRecord> &lookup = StructAfter<ArrayOf<LookupRecord> > (lookahead);
 578     return SANITIZE (lookup);
 579   }
 580
 581   private:
 582   ArrayOf<USHORT>
 583                 backtrack;              /* Array of backtracking values
 584                                          * (to be matched before the input
 585                                          * sequence) */
 586   HeadlessArrayOf<USHORT>
 587                 inputX;                 /* Array of input values (start with
 588                                          * second glyph) */
 589   ArrayOf<USHORT>
 590                 lookaheadX;             /* Array of lookahead values's (to be
 591                                          * matched after the input sequence) */
 592   ArrayOf<LookupRecord>
 593                 lookupX;                /* Array of LookupRecords--in
 594                                          * design order) */
 595 };
 596 ASSERT_SIZE (ChainRule, 8);
 597
 598 struct ChainRuleSet
 599 {
 600   inline bool apply (APPLY_ARG_DEF, ChainContextLookupContext &lookup_context) const
 601   {
 602     TRACE_APPLY ();
 603     unsigned int num_rules = rule.len;
 604     for (unsigned int i = 0; i < num_rules; i++)
 605     {
 606       if ((this+rule[i]).apply (APPLY_ARG, lookup_context))
 607         return true;
 608     }
 609
 610     return false;
 611   }
 612
 613   inline bool sanitize (SANITIZE_ARG_DEF) {
 614     TRACE_SANITIZE ();
 615     return SANITIZE_THIS (rule);
 616   }
 617
 618   private:
 619   OffsetArrayOf<ChainRule>
 620                 rule;                   /* Array of ChainRule tables
 621                                          * ordered by preference */
 622 };
 623 ASSERT_SIZE (ChainRuleSet, 2);
 624
 625 struct ChainContextFormat1
 626 {
 627   friend struct ChainContext;
 628
 629   private:
 630   inline bool apply (APPLY_ARG_DEF, apply_lookup_func_t apply_func) const
 631   {
 632     TRACE_APPLY ();
 633     unsigned int index = (this+coverage) (IN_CURGLYPH ());
 634     if (likely (index == NOT_COVERED))
 635       return false;
 636
 637     const ChainRuleSet &rule_set = this+ruleSet[index];
 638     struct ChainContextLookupContext lookup_context = {
 639       {match_glyph, apply_func},
 640       {NULL, NULL, NULL}
 641     };
 642     return rule_set.apply (APPLY_ARG, lookup_context);
 643   }
 644
 645   inline bool sanitize (SANITIZE_ARG_DEF) {
 646     TRACE_SANITIZE ();
 647     return SANITIZE_THIS2 (coverage, ruleSet);
 648   }
 649
 650   private:
 651   USHORT        format;                 /* Format identifier--format = 1 */
 652   OffsetTo<Coverage>
 653                 coverage;               /* Offset to Coverage table--from
 654                                          * beginning of table */
 655   OffsetArrayOf<ChainRuleSet>
 656                 ruleSet;                /* Array of ChainRuleSet tables
 657                                          * ordered by Coverage Index */
 658 };
 659 ASSERT_SIZE (ChainContextFormat1, 6);
 660
 661 struct ChainContextFormat2
 662 {
 663   friend struct ChainContext;
 664
 665   private:
 666   inline bool apply (APPLY_ARG_DEF, apply_lookup_func_t apply_func) const
 667   {
 668     TRACE_APPLY ();
 669     unsigned int index = (this+coverage) (IN_CURGLYPH ());
 670     if (likely (index == NOT_COVERED))
 671       return false;
 672
 673     const ClassDef &backtrack_class_def = this+backtrackClassDef;
 674     const ClassDef &input_class_def = this+inputClassDef;
 675     const ClassDef &lookahead_class_def = this+lookaheadClassDef;
 676
 677     index = input_class_def (IN_CURGLYPH ());
 678     const ChainRuleSet &rule_set = this+ruleSet[index];
 679     /* LONGTERMTODO: Old code fetches glyph classes at most once and caches
 680      * them across subrule lookups.  Not sure it's worth it.
 681      */
 682     struct ChainContextLookupContext lookup_context = {
 683      {match_class, apply_func},
 684      {CharP(&backtrack_class_def),
 685       CharP(&input_class_def),
 686       CharP(&lookahead_class_def)}
 687     };
 688     return rule_set.apply (APPLY_ARG, lookup_context);
 689   }
 690
 691   inline bool sanitize (SANITIZE_ARG_DEF) {
 692     TRACE_SANITIZE ();
 693     return SANITIZE_THIS2 (coverage, backtrackClassDef) &&
 694            SANITIZE_THIS2 (inputClassDef, lookaheadClassDef) &&
 695            SANITIZE_THIS (ruleSet);
 696   }
 697
 698   private:
 699   USHORT        format;                 /* Format identifier--format = 2 */
 700   OffsetTo<Coverage>
 701                 coverage;               /* Offset to Coverage table--from
 702                                          * beginning of table */
 703   OffsetTo<ClassDef>
 704                 backtrackClassDef;      /* Offset to glyph ClassDef table
 705                                          * containing backtrack sequence
 706                                          * data--from beginning of table */
 707   OffsetTo<ClassDef>
 708                 inputClassDef;          /* Offset to glyph ClassDef
 709                                          * table containing input sequence
 710                                          * data--from beginning of table */
 711   OffsetTo<ClassDef>
 712                 lookaheadClassDef;      /* Offset to glyph ClassDef table
 713                                          * containing lookahead sequence
 714                                          * data--from beginning of table */
 715   OffsetArrayOf<ChainRuleSet>
 716                 ruleSet;                /* Array of ChainRuleSet tables
 717                                          * ordered by class */
 718 };
 719 ASSERT_SIZE (ChainContextFormat2, 12);
 720
 721 struct ChainContextFormat3
 722 {
 723   friend struct ChainContext;
 724
 725   private:
 726
 727   inline bool apply (APPLY_ARG_DEF, apply_lookup_func_t apply_func) const
 728   {
 729     TRACE_APPLY ();
 730     const OffsetArrayOf<Coverage> &input = StructAfter<OffsetArrayOf<Coverage> > (backtrack);
 731
 732     unsigned int index = (this+input[0]) (IN_CURGLYPH ());
 733     if (likely (index == NOT_COVERED))
 734       return false;
 735
 736     const OffsetArrayOf<Coverage> &lookahead = StructAfter<OffsetArrayOf<Coverage> > (input);
 737     const ArrayOf<LookupRecord> &lookup = StructAfter<ArrayOf<LookupRecord> > (lookahead);
 738     struct ChainContextLookupContext lookup_context = {
 739       {match_coverage, apply_func},
 740       {CharP(this), CharP(this), CharP(this)}
 741     };
 742     return chain_context_lookup (APPLY_ARG,
 743                                  backtrack.len, (const USHORT *) backtrack.array(),
 744                                  input.len, (const USHORT *) input.array() + 1,
 745                                  lookahead.len, (const USHORT *) lookahead.array(),
 746                                  lookup.len, lookup.array(),
 747                                  lookup_context);
 748     return false;
 749   }
 750
 751   inline bool sanitize (SANITIZE_ARG_DEF) {
 752     TRACE_SANITIZE ();
 753     if (!SANITIZE_THIS (backtrack)) return false;
 754     OffsetArrayOf<Coverage> &input = StructAfter<OffsetArrayOf<Coverage> > (backtrack);
 755     if (!SANITIZE_THIS (input)) return false;
 756     OffsetArrayOf<Coverage> &lookahead = StructAfter<OffsetArrayOf<Coverage> > (input);
 757     if (!SANITIZE_THIS (lookahead)) return false;
 758     ArrayOf<LookupRecord> &lookup = StructAfter<ArrayOf<LookupRecord> > (lookahead);
 759     return SANITIZE (lookup);
 760   }
 761
 762   private:
 763   USHORT        format;                 /* Format identifier--format = 3 */
 764   OffsetArrayOf<Coverage>
 765                 backtrack;              /* Array of coverage tables
 766                                          * in backtracking sequence, in  glyph
 767                                          * sequence order */
 768   OffsetArrayOf<Coverage>
 769                 inputX          ;       /* Array of coverage
 770                                          * tables in input sequence, in glyph
 771                                          * sequence order */
 772   OffsetArrayOf<Coverage>
 773                 lookaheadX;             /* Array of coverage tables
 774                                          * in lookahead sequence, in glyph
 775                                          * sequence order */
 776   ArrayOf<LookupRecord>
 777                 lookupX;                /* Array of LookupRecords--in
 778                                          * design order) */
 779 };
 780 ASSERT_SIZE (ChainContextFormat3, 10);
 781
 782 struct ChainContext
 783 {
 784   protected:
 785   inline bool apply (APPLY_ARG_DEF, apply_lookup_func_t apply_func) const
 786   {
 787     TRACE_APPLY ();
 788     switch (u.format) {
 789     case 1: return u.format1->apply (APPLY_ARG, apply_func);
 790     case 2: return u.format2->apply (APPLY_ARG, apply_func);
 791     case 3: return u.format3->apply (APPLY_ARG, apply_func);
 792     default:return false;
 793     }
 794   }
 795
 796   inline bool sanitize (SANITIZE_ARG_DEF) {
 797     TRACE_SANITIZE ();
 798     if (!SANITIZE (u.format)) return false;
 799     switch (u.format) {
 800     case 1: return u.format1->sanitize (SANITIZE_ARG);
 801     case 2: return u.format2->sanitize (SANITIZE_ARG);
 802     case 3: return u.format3->sanitize (SANITIZE_ARG);
 803     default:return true;
 804     }
 805   }
 806
 807   private:
 808   union {
 809   USHORT                format; /* Format identifier */
 810   ChainContextFormat1   format1[VAR];
 811   ChainContextFormat2   format2[VAR];
 812   ChainContextFormat3   format3[VAR];
 813   } u;
 814 };
 815
 816
 817 struct ExtensionFormat1
 818 {
 819   friend struct Extension;
 820
 821   protected:
 822   inline unsigned int get_type (void) const { return extensionLookupType; }
 823   inline unsigned int get_offset (void) const { return extensionOffset; }
 824
 825   inline bool sanitize (SANITIZE_ARG_DEF) {
 826     TRACE_SANITIZE ();
 827     return SANITIZE_SELF ();
 828   }
 829
 830   private:
 831   USHORT        format;                 /* Format identifier. Set to 1. */
 832   USHORT        extensionLookupType;    /* Lookup type of subtable referenced
 833                                          * by ExtensionOffset (i.e. the
 834                                          * extension subtable). */
 835   ULONG         extensionOffset;        /* Offset to the extension subtable,
 836                                          * of lookup type subtable. */
 837 };
 838 ASSERT_SIZE (ExtensionFormat1, 8);
 839
 840 struct Extension
 841 {
 842   inline unsigned int get_type (void) const
 843   {
 844     switch (u.format) {
 845     case 1: return u.format1->get_type ();
 846     default:return 0;
 847     }
 848   }
 849   inline unsigned int get_offset (void) const
 850   {
 851     switch (u.format) {
 852     case 1: return u.format1->get_offset ();
 853     default:return 0;
 854     }
 855   }
 856
 857   inline bool sanitize (SANITIZE_ARG_DEF) {
 858     TRACE_SANITIZE ();
 859     if (!SANITIZE (u.format)) return false;
 860     switch (u.format) {
 861     case 1: return u.format1->sanitize (SANITIZE_ARG);
 862     default:return true;
 863     }
 864   }
 865
 866   private:
 867   union {
 868   USHORT                format;         /* Format identifier */
 869   ExtensionFormat1      format1[VAR];
 870   } u;
 871 };
 872
 873
 874 /*
 875  * GSUB/GPOS Common
 876  */
 877
 878 struct GSUBGPOS
 879 {
 880   static const hb_tag_t GSUBTag = HB_OT_TAG_GSUB;
 881   static const hb_tag_t GPOSTag = HB_OT_TAG_GPOS;
 882
 883   inline unsigned int get_script_count (void) const
 884   { return (this+scriptList).len; }
 885   inline const Tag& get_script_tag (unsigned int i) const
 886   { return (this+scriptList).get_tag (i); }
 887   inline unsigned int get_script_tags (unsigned int start_offset,
 888                                        unsigned int *script_count /* IN/OUT */,
 889                                        hb_tag_t     *script_tags /* OUT */) const
 890   { return (this+scriptList).get_tags (start_offset, script_count, script_tags); }
 891   inline const Script& get_script (unsigned int i) const
 892   { return (this+scriptList)[i]; }
 893   inline bool find_script_index (hb_tag_t tag, unsigned int *index) const
 894   { return (this+scriptList).find_index (tag, index); }
 895
 896   inline unsigned int get_feature_count (void) const
 897   { return (this+featureList).len; }
 898   inline const Tag& get_feature_tag (unsigned int i) const
 899   { return (this+featureList).get_tag (i); }
 900   inline unsigned int get_feature_tags (unsigned int start_offset,
 901                                         unsigned int *feature_count /* IN/OUT */,
 902                                         hb_tag_t     *feature_tags /* OUT */) const
 903   { return (this+featureList).get_tags (start_offset, feature_count, feature_tags); }
 904   inline const Feature& get_feature (unsigned int i) const
 905   { return (this+featureList)[i]; }
 906   inline bool find_feature_index (hb_tag_t tag, unsigned int *index) const
 907   { return (this+featureList).find_index (tag, index); }
 908
 909   inline unsigned int get_lookup_count (void) const
 910   { return (this+lookupList).len; }
 911   inline const Lookup& get_lookup (unsigned int i) const
 912   { return (this+lookupList)[i]; }
 913
 914   inline bool sanitize (SANITIZE_ARG_DEF) {
 915     TRACE_SANITIZE ();
 916     return SANITIZE (version) && likely (version.major == 1)
 917         && SANITIZE_THIS (scriptList)
 918         && SANITIZE_THIS (featureList)
 919         && SANITIZE_THIS (lookupList);
 920   }
 921
 922   protected:
 923   FixedVersion  version;        /* Version of the GSUB/GPOS table--initially set
 924                                  * to 0x00010000 */
 925   OffsetTo<ScriptList>
 926                 scriptList;     /* ScriptList table */
 927   OffsetTo<FeatureList>
 928                 featureList;    /* FeatureList table */
 929   OffsetTo<LookupList>
 930                 lookupList;     /* LookupList table */
 931 };
 932 ASSERT_SIZE (GSUBGPOS, 10);
 933
 934
 935 #endif /* HB_OT_LAYOUT_GSUBGPOS_PRIVATE_HH */