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