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

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