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