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