pango/opentype/hb-ot-layout-gsubgpos-private.hh

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