src/hb-ot-layout-common-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_COMMON_PRIVATE_HH
  28 #define HB_OT_LAYOUT_COMMON_PRIVATE_HH
  29
  30 #include "hb-ot-layout-private.h"
  31
  32 #include "hb-open-type-private.hh"
  33
  34
  35 #define NO_CONTEXT              ((unsigned int) 0x110000)
  36 #define NOT_COVERED             ((unsigned int) 0x110000)
  37 #define MAX_NESTING_LEVEL       8
  38
  39
  40 /*
  41  *
  42  * OpenType Layout Common Table Formats
  43  *
  44  */
  45
  46
  47 /*
  48  * Script, ScriptList, LangSys, Feature, FeatureList, Lookup, LookupList
  49  */
  50
  51 template <typename Type>
  52 struct Record
  53 {
  54   static inline unsigned int get_size () { return sizeof (Record<Type>); }
  55
  56   inline bool sanitize (SANITIZE_ARG_DEF, void *base) {
  57     TRACE_SANITIZE ();
  58     return SANITIZE_SELF () && SANITIZE_BASE (offset, base);
  59   }
  60
  61   Tag           tag;            /* 4-byte Tag identifier */
  62   OffsetTo<Type>
  63                 offset;         /* Offset from beginning of object holding
  64                                  * the Record */
  65 };
  66
  67 template <typename Type>
  68 struct RecordArrayOf : ArrayOf<Record<Type> > {
  69   inline const Tag& get_tag (unsigned int i) const
  70   {
  71     if (unlikely (i >= this->len)) return Null(Tag);
  72     return (*this)[i].tag;
  73   }
  74   inline unsigned int get_tags (unsigned int start_offset,
  75                                 unsigned int *record_count /* IN/OUT */,
  76                                 hb_tag_t     *record_tags /* OUT */) const
  77   {
  78     if (record_count) {
  79       const Record<Type> *array = this->sub_array (start_offset, record_count);
  80       unsigned int count = *record_count;
  81       for (unsigned int i = 0; i < count; i++)
  82         record_tags[i] = array[i].tag;
  83     }
  84     return this->len;
  85   }
  86   inline bool find_index (hb_tag_t tag, unsigned int *index) const
  87   {
  88     Tag t;
  89     t.set (tag);
  90     /* TODO: bsearch (need to sort in sanitize) */
  91     const Record<Type> *a = this->array();
  92     unsigned int count = this->len;
  93     for (unsigned int i = 0; i < count; i++)
  94     {
  95       if (t == a[i].tag)
  96       {
  97         if (index) *index = i;
  98         return true;
  99       }
 100     }
 101     if (index) *index = NO_INDEX;
 102     return false;
 103   }
 104 };
 105
 106 template <typename Type>
 107 struct RecordListOf : RecordArrayOf<Type>
 108 {
 109   inline const Type& operator [] (unsigned int i) const
 110   { return this+RecordArrayOf<Type>::operator [](i).offset; }
 111
 112   inline bool sanitize (SANITIZE_ARG_DEF) {
 113     TRACE_SANITIZE ();
 114     return RecordArrayOf<Type>::sanitize (SANITIZE_ARG, CharP(this));
 115   }
 116 };
 117
 118
 119 struct IndexArray : ArrayOf<USHORT>
 120 {
 121   inline unsigned int operator [] (unsigned int i) const
 122   {
 123     if (unlikely (i >= this->len))
 124       return NO_INDEX;
 125     return this->array()[i];
 126   }
 127   inline unsigned int get_indexes (unsigned int start_offset,
 128                                    unsigned int *_count /* IN/OUT */,
 129                                    unsigned int *_indexes /* OUT */) const
 130   {
 131     if (_count) {
 132       const USHORT *array = this->sub_array (start_offset, _count);
 133       unsigned int count = *_count;
 134       for (unsigned int i = 0; i < count; i++)
 135         _indexes[i] = array[i];
 136     }
 137     return this->len;
 138   }
 139 };
 140
 141
 142 struct Script;
 143 struct LangSys;
 144 struct Feature;
 145
 146
 147 struct LangSys
 148 {
 149   inline unsigned int get_feature_count (void) const
 150   { return featureIndex.len; }
 151   inline hb_tag_t get_feature_index (unsigned int i) const
 152   { return featureIndex[i]; }
 153   inline unsigned int get_feature_indexes (unsigned int start_offset,
 154                                            unsigned int *feature_count /* IN/OUT */,
 155                                            unsigned int *feature_indexes /* OUT */) const
 156   { return featureIndex.get_indexes (start_offset, feature_count, feature_indexes); }
 157
 158   inline bool has_required_feature (void) const { return reqFeatureIndex != 0xffff; }
 159   inline int get_required_feature_index (void) const
 160   {
 161     if (reqFeatureIndex == 0xffff)
 162       return NO_INDEX;
 163    return reqFeatureIndex;;
 164   }
 165
 166   inline bool sanitize (SANITIZE_ARG_DEF) {
 167     TRACE_SANITIZE ();
 168     return SANITIZE_SELF () && SANITIZE (featureIndex);
 169   }
 170
 171   Offset        lookupOrder;    /* = Null (reserved for an offset to a
 172                                  * reordering table) */
 173   USHORT        reqFeatureIndex;/* Index of a feature required for this
 174                                  * language system--if no required features
 175                                  * = 0xFFFF */
 176   IndexArray    featureIndex;   /* Array of indices into the FeatureList */
 177 };
 178 ASSERT_SIZE (LangSys, 6);
 179 DEFINE_NULL_DATA (LangSys, 6, "\0\0\xFF\xFF");
 180
 181
 182 struct Script
 183 {
 184   inline unsigned int get_lang_sys_count (void) const
 185   { return langSys.len; }
 186   inline const Tag& get_lang_sys_tag (unsigned int i) const
 187   { return langSys.get_tag (i); }
 188   inline unsigned int get_lang_sys_tags (unsigned int start_offset,
 189                                          unsigned int *lang_sys_count /* IN/OUT */,
 190                                          hb_tag_t     *lang_sys_tags /* OUT */) const
 191   { return langSys.get_tags (start_offset, lang_sys_count, lang_sys_tags); }
 192   inline const LangSys& get_lang_sys (unsigned int i) const
 193   {
 194     if (i == NO_INDEX) return get_default_lang_sys ();
 195     return this+langSys[i].offset;
 196   }
 197   inline bool find_lang_sys_index (hb_tag_t tag, unsigned int *index) const
 198   { return langSys.find_index (tag, index); }
 199
 200   inline bool has_default_lang_sys (void) const { return defaultLangSys != 0; }
 201   inline const LangSys& get_default_lang_sys (void) const { return this+defaultLangSys; }
 202
 203   inline bool sanitize (SANITIZE_ARG_DEF) {
 204     TRACE_SANITIZE ();
 205     return SANITIZE_THIS (defaultLangSys)
 206         && SANITIZE_THIS (langSys);
 207   }
 208
 209   private:
 210   OffsetTo<LangSys>
 211                 defaultLangSys; /* Offset to DefaultLangSys table--from
 212                                  * beginning of Script table--may be Null */
 213   RecordArrayOf<LangSys>
 214                 langSys;        /* Array of LangSysRecords--listed
 215                                  * alphabetically by LangSysTag */
 216 };
 217 ASSERT_SIZE (Script, 4);
 218
 219 typedef RecordListOf<Script> ScriptList;
 220 ASSERT_SIZE (ScriptList, 2);
 221
 222
 223 struct Feature
 224 {
 225   inline unsigned int get_lookup_count (void) const
 226   { return lookupIndex.len; }
 227   inline hb_tag_t get_lookup_index (unsigned int i) const
 228   { return lookupIndex[i]; }
 229   inline unsigned int get_lookup_indexes (unsigned int start_index,
 230                                           unsigned int *lookup_count /* IN/OUT */,
 231                                           unsigned int *lookup_tags /* OUT */) const
 232   { return lookupIndex.get_indexes (start_index, lookup_count, lookup_tags); }
 233
 234   inline bool sanitize (SANITIZE_ARG_DEF) {
 235     TRACE_SANITIZE ();
 236     return SANITIZE_SELF () && SANITIZE (lookupIndex);
 237   }
 238
 239   /* LONGTERMTODO: implement get_feature_parameters() */
 240   /* LONGTERMTODO: implement FeatureSize and other special features? */
 241   Offset        featureParams;  /* Offset to Feature Parameters table (if one
 242                                  * has been defined for the feature), relative
 243                                  * to the beginning of the Feature Table; = Null
 244                                  * if not required */
 245   IndexArray     lookupIndex;   /* Array of LookupList indices */
 246 };
 247 ASSERT_SIZE (Feature, 4);
 248
 249 typedef RecordListOf<Feature> FeatureList;
 250 ASSERT_SIZE (FeatureList, 2);
 251
 252
 253 struct LookupFlag : USHORT
 254 {
 255   enum {
 256     RightToLeft         = 0x0001u,
 257     IgnoreBaseGlyphs    = 0x0002u,
 258     IgnoreLigatures     = 0x0004u,
 259     IgnoreMarks         = 0x0008u,
 260     IgnoreFlags         = 0x000Eu,
 261     UseMarkFilteringSet = 0x0010u,
 262     Reserved            = 0x00E0u,
 263     MarkAttachmentType  = 0xFF00u
 264   };
 265 };
 266 ASSERT_SIZE (LookupFlag, 2);
 267
 268 struct Lookup
 269 {
 270   inline unsigned int get_subtable_count (void) const { return subTable.len; }
 271
 272   inline unsigned int get_type (void) const { return lookupType; }
 273   inline unsigned int get_flag (void) const
 274   {
 275     unsigned int flag = lookupFlag;
 276     if (unlikely (flag & LookupFlag::UseMarkFilteringSet))
 277     {
 278       const USHORT &markFilteringSet = StructAfter<USHORT> (subTable);
 279       flag += (markFilteringSet << 16);
 280     }
 281     return flag;
 282   }
 283
 284   inline bool sanitize (SANITIZE_ARG_DEF) {
 285     TRACE_SANITIZE ();
 286     /* Real sanitize of the subtables is done by GSUB/GPOS/... */
 287     if (!(SANITIZE_SELF () && likely (subTable.sanitize (SANITIZE_ARG)))) return false;
 288     if (unlikely (lookupFlag & LookupFlag::UseMarkFilteringSet))
 289     {
 290       USHORT &markFilteringSet = StructAfter<USHORT> (subTable);
 291       if (!SANITIZE (markFilteringSet)) return false;
 292     }
 293     return true;
 294   }
 295
 296   USHORT        lookupType;             /* Different enumerations for GSUB and GPOS */
 297   USHORT        lookupFlag;             /* Lookup qualifiers */
 298   ArrayOf<Offset>
 299                 subTable;               /* Array of SubTables */
 300   USHORT        markFilteringSetX[VAR]; /* Index (base 0) into GDEF mark glyph sets
 301                                          * structure. This field is only present if bit
 302                                          * UseMarkFilteringSet of lookup flags is set. */
 303 };
 304 ASSERT_SIZE_VAR (Lookup, 6, USHORT);
 305
 306 typedef OffsetListOf<Lookup> LookupList;
 307 ASSERT_SIZE (LookupList, 2);
 308
 309
 310 /*
 311  * Coverage Table
 312  */
 313
 314 struct CoverageFormat1
 315 {
 316   friend struct Coverage;
 317
 318   private:
 319   inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
 320   {
 321     if (unlikely (glyph_id > 0xFFFF))
 322       return NOT_COVERED;
 323     GlyphID gid;
 324     gid.set (glyph_id);
 325     /* TODO: bsearch (need to sort in sanitize) */
 326     unsigned int num_glyphs = glyphArray.len;
 327     for (unsigned int i = 0; i < num_glyphs; i++)
 328       if (gid == glyphArray[i])
 329         return i;
 330     return NOT_COVERED;
 331   }
 332
 333   inline bool sanitize (SANITIZE_ARG_DEF) {
 334     TRACE_SANITIZE ();
 335     return SANITIZE (glyphArray);
 336   }
 337
 338   private:
 339   USHORT        coverageFormat; /* Format identifier--format = 1 */
 340   ArrayOf<GlyphID>
 341                 glyphArray;     /* Array of GlyphIDs--in numerical order */
 342 };
 343 ASSERT_SIZE (CoverageFormat1, 4);
 344
 345 struct CoverageRangeRecord
 346 {
 347   friend struct CoverageFormat2;
 348
 349   static inline unsigned int get_size () { return sizeof (CoverageRangeRecord); }
 350
 351   private:
 352   inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
 353   {
 354     if (glyph_id >= start && glyph_id <= end)
 355       return (unsigned int) startCoverageIndex + (glyph_id - start);
 356     return NOT_COVERED;
 357   }
 358
 359   public:
 360   inline bool sanitize (SANITIZE_ARG_DEF) {
 361     TRACE_SANITIZE ();
 362     return SANITIZE_SELF ();
 363   }
 364
 365   private:
 366   GlyphID       start;                  /* First GlyphID in the range */
 367   GlyphID       end;                    /* Last GlyphID in the range */
 368   USHORT        startCoverageIndex;     /* Coverage Index of first GlyphID in
 369                                          * range */
 370 };
 371 ASSERT_SIZE (CoverageRangeRecord, 6);
 372 DEFINE_NULL_DATA (CoverageRangeRecord, 6, "\000\001");
 373
 374 struct CoverageFormat2
 375 {
 376   friend struct Coverage;
 377
 378   private:
 379   inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
 380   {
 381     /* TODO: bsearch (need to sort in sanitize) */
 382     unsigned int count = rangeRecord.len;
 383     for (unsigned int i = 0; i < count; i++)
 384     {
 385       unsigned int coverage = rangeRecord[i].get_coverage (glyph_id);
 386       if (coverage != NOT_COVERED)
 387         return coverage;
 388     }
 389     return NOT_COVERED;
 390   }
 391
 392   inline bool sanitize (SANITIZE_ARG_DEF) {
 393     TRACE_SANITIZE ();
 394     return SANITIZE (rangeRecord);
 395   }
 396
 397   private:
 398   USHORT        coverageFormat; /* Format identifier--format = 2 */
 399   ArrayOf<CoverageRangeRecord>
 400                 rangeRecord;    /* Array of glyph ranges--ordered by
 401                                  * Start GlyphID. rangeCount entries
 402                                  * long */
 403 };
 404 ASSERT_SIZE (CoverageFormat2, 4);
 405
 406 struct Coverage
 407 {
 408   inline unsigned int operator () (hb_codepoint_t glyph_id) const { return get_coverage (glyph_id); }
 409
 410   inline unsigned int get_coverage (hb_codepoint_t glyph_id) const
 411   {
 412     switch (u.format) {
 413     case 1: return u.format1->get_coverage(glyph_id);
 414     case 2: return u.format2->get_coverage(glyph_id);
 415     default:return NOT_COVERED;
 416     }
 417   }
 418
 419   inline bool sanitize (SANITIZE_ARG_DEF) {
 420     TRACE_SANITIZE ();
 421     if (!SANITIZE (u.format)) return false;
 422     switch (u.format) {
 423     case 1: return u.format1->sanitize (SANITIZE_ARG);
 424     case 2: return u.format2->sanitize (SANITIZE_ARG);
 425     default:return true;
 426     }
 427   }
 428
 429   private:
 430   union {
 431   USHORT                format;         /* Format identifier */
 432   CoverageFormat1       format1[VAR];
 433   CoverageFormat2       format2[VAR];
 434   } u;
 435 };
 436
 437
 438 /*
 439  * Class Definition Table
 440  */
 441
 442 struct ClassDefFormat1
 443 {
 444   friend struct ClassDef;
 445
 446   private:
 447   inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
 448   {
 449     if ((unsigned int) (glyph_id - startGlyph) < classValue.len)
 450       return classValue[glyph_id - startGlyph];
 451     return 0;
 452   }
 453
 454   inline bool sanitize (SANITIZE_ARG_DEF) {
 455     TRACE_SANITIZE ();
 456     return SANITIZE_SELF () && SANITIZE (classValue);
 457   }
 458
 459   USHORT        classFormat;            /* Format identifier--format = 1 */
 460   GlyphID       startGlyph;             /* First GlyphID of the classValueArray */
 461   ArrayOf<USHORT>
 462                 classValue;             /* Array of Class Values--one per GlyphID */
 463 };
 464 ASSERT_SIZE (ClassDefFormat1, 6);
 465
 466 struct ClassRangeRecord
 467 {
 468   friend struct ClassDefFormat2;
 469
 470   static inline unsigned int get_size () { return sizeof (ClassRangeRecord); }
 471
 472   private:
 473   inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
 474   {
 475     if (glyph_id >= start && glyph_id <= end)
 476       return classValue;
 477     return 0;
 478   }
 479
 480   public:
 481   inline bool sanitize (SANITIZE_ARG_DEF) {
 482     TRACE_SANITIZE ();
 483     return SANITIZE_SELF ();
 484   }
 485
 486   private:
 487   GlyphID       start;          /* First GlyphID in the range */
 488   GlyphID       end;            /* Last GlyphID in the range */
 489   USHORT        classValue;     /* Applied to all glyphs in the range */
 490 };
 491 ASSERT_SIZE (ClassRangeRecord, 6);
 492 DEFINE_NULL_DATA (ClassRangeRecord, 6, "\000\001");
 493
 494 struct ClassDefFormat2
 495 {
 496   friend struct ClassDef;
 497
 498   private:
 499   inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
 500   {
 501     /* TODO: bsearch (need to sort in sanitize) */
 502     unsigned int count = rangeRecord.len;
 503     for (unsigned int i = 0; i < count; i++)
 504     {
 505       int classValue = rangeRecord[i].get_class (glyph_id);
 506       if (classValue > 0)
 507         return classValue;
 508     }
 509     return 0;
 510   }
 511
 512   inline bool sanitize (SANITIZE_ARG_DEF) {
 513     TRACE_SANITIZE ();
 514     return SANITIZE (rangeRecord);
 515   }
 516
 517   USHORT        classFormat;    /* Format identifier--format = 2 */
 518   ArrayOf<ClassRangeRecord>
 519                 rangeRecord;    /* Array of glyph ranges--ordered by
 520                                  * Start GlyphID */
 521 };
 522 ASSERT_SIZE (ClassDefFormat2, 4);
 523
 524 struct ClassDef
 525 {
 526   inline hb_ot_layout_class_t operator () (hb_codepoint_t glyph_id) const { return get_class (glyph_id); }
 527
 528   inline hb_ot_layout_class_t get_class (hb_codepoint_t glyph_id) const
 529   {
 530     switch (u.format) {
 531     case 1: return u.format1->get_class(glyph_id);
 532     case 2: return u.format2->get_class(glyph_id);
 533     default:return 0;
 534     }
 535   }
 536
 537   inline bool sanitize (SANITIZE_ARG_DEF) {
 538     TRACE_SANITIZE ();
 539     if (!SANITIZE (u.format)) return false;
 540     switch (u.format) {
 541     case 1: return u.format1->sanitize (SANITIZE_ARG);
 542     case 2: return u.format2->sanitize (SANITIZE_ARG);
 543     default:return true;
 544     }
 545   }
 546
 547   private:
 548   union {
 549   USHORT                format;         /* Format identifier */
 550   ClassDefFormat1       format1[VAR];
 551   ClassDefFormat2       format2[VAR];
 552   } u;
 553 };
 554
 555
 556 /*
 557  * Device Tables
 558  */
 559
 560 struct Device
 561 {
 562   inline int operator () (unsigned int ppem_size) const { return get_delta (ppem_size); }
 563
 564   inline int get_delta (unsigned int ppem_size) const
 565   {
 566     unsigned int f = deltaFormat;
 567     if (unlikely (f < 1 || f > 3))
 568       return 0;
 569
 570     if (ppem_size < startSize || ppem_size > endSize)
 571       return 0;
 572
 573     unsigned int s = ppem_size - startSize;
 574
 575     unsigned int byte = deltaValue[s >> (4 - f)];
 576     unsigned int bits = (byte >> (16 - (((s & ((1 << (4 - f)) - 1)) + 1) << f)));
 577     unsigned int mask = (0xFFFF >> (16 - (1 << f)));
 578
 579     int delta = bits & mask;
 580
 581     if ((unsigned int) delta >= ((mask + 1) >> 1))
 582       delta -= mask + 1;
 583
 584     return delta;
 585   }
 586
 587   inline unsigned int get_size () const
 588   {
 589     unsigned int f = deltaFormat;
 590     if (unlikely (f < 1 || f > 3 || startSize > endSize)) return 3 * USHORT::get_size ();
 591     return USHORT::get_size () * (4 + ((endSize - startSize) >> (4 - f)));
 592   }
 593
 594   inline bool sanitize (SANITIZE_ARG_DEF) {
 595     TRACE_SANITIZE ();
 596     return SANITIZE_SELF() && SANITIZE_MEM (this, this->get_size ());
 597   }
 598
 599   private:
 600   USHORT        startSize;              /* Smallest size to correct--in ppem */
 601   USHORT        endSize;                /* Largest size to correct--in ppem */
 602   USHORT        deltaFormat;            /* Format of DeltaValue array data: 1, 2, or 3
 603                                          * 1    Signed 2-bit value, 8 values per uint16
 604                                          * 2    Signed 4-bit value, 4 values per uint16
 605                                          * 3    Signed 8-bit value, 2 values per uint16
 606                                          */
 607   USHORT        deltaValue[VAR];        /* Array of compressed data */
 608 };
 609 ASSERT_SIZE_VAR (Device, 6, USHORT);
 610
 611
 612 #endif /* HB_OT_LAYOUT_COMMON_PRIVATE_HH */