src/hb-open-type-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_OPEN_TYPES_PRIVATE_HH
  28 #define HB_OPEN_TYPES_PRIVATE_HH
  29
  30 #include "hb-private.h"
  31
  32 #include "hb-blob.h"
  33
  34
  35
  36 /*
  37  * Casts
  38  */
  39
  40 /* Cast to struct T, reference to reference */
  41 template<typename Type, typename TObject>
  42 inline const Type& CastR(const TObject &X)
  43 { return reinterpret_cast<const Type&> (X); }
  44 template<typename Type, typename TObject>
  45 inline Type& CastR(TObject &X)
  46 { return reinterpret_cast<Type&> (X); }
  47
  48 /* Cast to struct T, pointer to pointer */
  49 template<typename Type, typename TObject>
  50 inline const Type* CastP(const TObject *X)
  51 { return reinterpret_cast<const Type*> (X); }
  52 template<typename Type, typename TObject>
  53 inline Type* CastP(TObject *X)
  54 { return reinterpret_cast<Type*> (X); }
  55
  56 /* StructAtOffset<T>(P,Ofs) returns the struct T& that is placed at memory
  57  * location pointed to by P plus Ofs bytes. */
  58 template<typename Type>
  59 inline const Type& StructAtOffset(const void *P, unsigned int offset)
  60 { return * reinterpret_cast<const Type*> ((const char *) P + offset); }
  61 template<typename Type>
  62 inline Type& StructAtOffset(void *P, unsigned int offset)
  63 { return * reinterpret_cast<Type*> ((char *) P + offset); }
  64
  65 /* StructAfter<T>(X) returns the struct T& that is placed after X.
  66  * Works with X of variable size also.  X must implement get_size() */
  67 template<typename Type, typename TObject>
  68 inline const Type& StructAfter(const TObject &X)
  69 { return StructAtOffset<Type>(&X, X.get_size()); }
  70 template<typename Type, typename TObject>
  71 inline Type& StructAfter(TObject &X)
  72 { return StructAtOffset<Type>(&X, X.get_size()); }
  73
  74
  75
  76 /*
  77  * Size checking
  78  */
  79
  80 /* Check _assertion in a method environment */
  81 #define _DEFINE_SIZE_ASSERTION(_assertion) \
  82   inline void _size_assertion (void) const \
  83   { ASSERT_STATIC (_assertion); }
  84 /* Check that _code compiles in a method environment */
  85 #define _DEFINE_COMPILES_ASSERTION(_code) \
  86   inline void _compiles_assertion (void) const \
  87   { _code; }
  88
  89
  90 #define DEFINE_SIZE_STATIC(size) \
  91   _DEFINE_SIZE_ASSERTION (sizeof (*this) == (size)); \
  92   static const unsigned int static_size = (size); \
  93   static const unsigned int min_size = (size)
  94
  95 /* Size signifying variable-sized array */
  96 #define VAR 1
  97
  98 #define DEFINE_SIZE_UNION(size, _member) \
  99   _DEFINE_SIZE_ASSERTION (this->u._member.static_size == (size)); \
 100   static const unsigned int min_size = (size)
 101
 102 #define DEFINE_SIZE_MIN(size) \
 103   _DEFINE_SIZE_ASSERTION (sizeof (*this) >= (size)); \
 104   static const unsigned int min_size = (size)
 105
 106 #define DEFINE_SIZE_ARRAY(size, array) \
 107   _DEFINE_SIZE_ASSERTION (sizeof (*this) == (size) + sizeof (array[0])); \
 108   _DEFINE_COMPILES_ASSERTION ((void) array[0].static_size) \
 109   static const unsigned int min_size = (size)
 110
 111 #define DEFINE_SIZE_ARRAY2(size, array1, array2) \
 112   _DEFINE_SIZE_ASSERTION (sizeof (*this) == (size) + sizeof (this->array1[0]) + sizeof (this->array2[0])); \
 113   _DEFINE_COMPILES_ASSERTION ((void) array1[0].static_size; (void) array2[0].static_size) \
 114   static const unsigned int min_size = (size)
 115
 116
 117
 118 /*
 119  * Null objects
 120  */
 121
 122 /* Global nul-content Null pool.  Enlarge as necessary. */
 123 static const void *_NullPool[64 / sizeof (void *)];
 124
 125 /* Generic nul-content Null objects. */
 126 template <typename Type>
 127 static inline const Type& Null () {
 128   ASSERT_STATIC (Type::min_size <= sizeof (_NullPool));
 129   return *CastP<Type> (_NullPool);
 130 }
 131
 132 /* Specializaiton for arbitrary-content arbitrary-sized Null objects. */
 133 #define DEFINE_NULL_DATA(Type, data) \
 134 static const char _Null##Type[Type::min_size + 1] = data; /* +1 is for nul-termination in data */ \
 135 template <> \
 136 inline const Type& Null<Type> () { \
 137   return *CastP<Type> (_Null##Type); \
 138 } /* The following line really exists such that we end in a place needing semicolon */ \
 139 ASSERT_STATIC (Type::min_size + 1 <= sizeof (_Null##Type))
 140
 141 /* Accessor macro. */
 142 #define Null(Type) Null<Type>()
 143
 144
 145 /*
 146  * Trace
 147  */
 148
 149
 150 template <int max_depth>
 151 struct hb_trace_t {
 152   explicit hb_trace_t (unsigned int *pdepth, const char *what, const char *function, const void *obj) : pdepth(pdepth) {
 153     if (*pdepth < max_depth)
 154       fprintf (stderr, "%s(%p) %-*d-> %s\n", what, obj, *pdepth, *pdepth, function);
 155     if (max_depth) ++*pdepth;
 156   }
 157   ~hb_trace_t (void) { if (max_depth) --*pdepth; }
 158
 159   private:
 160   unsigned int *pdepth;
 161 };
 162 template <> /* Optimize when tracing is disabled */
 163 struct hb_trace_t<0> {
 164   explicit hb_trace_t (unsigned int *pdepth HB_UNUSED, const char *what HB_UNUSED, const char *function HB_UNUSED, const void *obj HB_UNUSED) {}
 165 };
 166
 167
 168
 169 /*
 170  * Sanitize
 171  */
 172
 173 #ifndef HB_DEBUG_SANITIZE
 174 #define HB_DEBUG_SANITIZE HB_DEBUG+0
 175 #endif
 176
 177
 178 #define TRACE_SANITIZE() \
 179         hb_trace_t<HB_DEBUG_SANITIZE> trace (&c->debug_depth, "SANITIZE", HB_FUNC, this); \
 180
 181
 182 struct hb_sanitize_context_t
 183 {
 184   inline void init (hb_blob_t *blob)
 185   {
 186     this->blob = hb_blob_reference (blob);
 187     this->start = hb_blob_lock (blob);
 188     this->end = this->start + hb_blob_get_length (blob);
 189     this->writable = hb_blob_is_writable (blob);
 190     this->edit_count = 0;
 191     this->debug_depth = 0;
 192
 193     if (HB_DEBUG_SANITIZE)
 194       fprintf (stderr, "sanitize %p init [%p..%p] (%u bytes)\n",
 195                this->blob, this->start, this->end, this->end - this->start);
 196   }
 197
 198   inline void finish (void)
 199   {
 200     if (HB_DEBUG_SANITIZE)
 201       fprintf (stderr, "sanitize %p fini [%p..%p] %u edit requests\n",
 202                this->blob, this->start, this->end, this->edit_count);
 203
 204     hb_blob_unlock (this->blob);
 205     hb_blob_destroy (this->blob);
 206     this->blob = NULL;
 207     this->start = this->end = NULL;
 208   }
 209
 210   inline bool check_range (const void *base, unsigned int len) const
 211   {
 212     const char *p = (const char *) base;
 213     bool ret = this->start <= p &&
 214                p <= this->end &&
 215                (unsigned int) (this->end - p) >= len;
 216
 217     if (HB_DEBUG_SANITIZE && (int) this->debug_depth < (int) HB_DEBUG_SANITIZE) \
 218       fprintf (stderr, "SANITIZE(%p) %-*d-> range [%p..%p] (%d bytes) in [%p..%p] -> %s\n", \
 219                p,
 220                this->debug_depth, this->debug_depth,
 221                p, p + len, len,
 222                this->start, this->end,
 223                ret ? "pass" : "FAIL");
 224
 225     return likely (ret);
 226   }
 227
 228   inline bool check_array (const void *base, unsigned int record_size, unsigned int len) const
 229   {
 230     const char *p = (const char *) base;
 231     bool overflows = len >= ((unsigned int) -1) / record_size;
 232
 233     if (HB_DEBUG_SANITIZE && (int) this->debug_depth < (int) HB_DEBUG_SANITIZE)
 234       fprintf (stderr, "SANITIZE(%p) %-*d-> array [%p..%p] (%d*%d=%ld bytes) in [%p..%p] -> %s\n", \
 235                p,
 236                this->debug_depth, this->debug_depth,
 237                p, p + (record_size * len), record_size, len, (unsigned long) record_size * len,
 238                this->start, this->end,
 239                !overflows ? "does not overflow" : "OVERFLOWS FAIL");
 240
 241     return likely (!overflows && this->check_range (base, record_size * len));
 242   }
 243
 244   template <typename Type>
 245   inline bool check_struct (const Type *obj) const
 246   {
 247     return likely (this->check_range (obj, obj->min_size));
 248   }
 249
 250   inline bool can_edit (const void *base HB_UNUSED, unsigned int len HB_UNUSED)
 251   {
 252     const char *p = (const char *) base;
 253     this->edit_count++;
 254
 255     if (HB_DEBUG_SANITIZE && (int) this->debug_depth < (int) HB_DEBUG_SANITIZE)
 256       fprintf (stderr, "SANITIZE(%p) %-*d-> edit(%u) [%p..%p] (%d bytes) in [%p..%p] -> %s\n", \
 257                p,
 258                this->debug_depth, this->debug_depth,
 259                this->edit_count,
 260                p, p + len, len,
 261                this->start, this->end,
 262                this->writable ? "granted" : "REJECTED");
 263
 264     return this->writable;
 265   }
 266
 267   unsigned int debug_depth;
 268   const char *start, *end;
 269   bool writable;
 270   unsigned int edit_count;
 271   hb_blob_t *blob;
 272 };
 273
 274
 275
 276 /* Template to sanitize an object. */
 277 template <typename Type>
 278 struct Sanitizer
 279 {
 280   static hb_blob_t *sanitize (hb_blob_t *blob) {
 281     hb_sanitize_context_t c[1] = {{0}};
 282     bool sane;
 283
 284     /* TODO is_sane() stuff */
 285
 286   retry:
 287     if (HB_DEBUG_SANITIZE)
 288       fprintf (stderr, "Sanitizer %p start %s\n", blob, HB_FUNC);
 289
 290     c->init (blob);
 291
 292     if (unlikely (!c->start)) {
 293       c->finish ();
 294       return blob;
 295     }
 296
 297     Type *t = CastP<Type> (const_cast<char *> (c->start));
 298
 299     sane = t->sanitize (c);
 300     if (sane) {
 301       if (c->edit_count) {
 302         if (HB_DEBUG_SANITIZE)
 303           fprintf (stderr, "Sanitizer %p passed first round with %d edits; doing a second round %s\n",
 304                    blob, c->edit_count, HB_FUNC);
 305
 306         /* sanitize again to ensure no toe-stepping */
 307         c->edit_count = 0;
 308         sane = t->sanitize (c);
 309         if (c->edit_count) {
 310           if (HB_DEBUG_SANITIZE)
 311             fprintf (stderr, "Sanitizer %p requested %d edits in second round; FAILLING %s\n",
 312                      blob, c->edit_count, HB_FUNC);
 313           sane = false;
 314         }
 315       }
 316       c->finish ();
 317     } else {
 318       unsigned int edit_count = c->edit_count;
 319       c->finish ();
 320       if (edit_count && !hb_blob_is_writable (blob) && hb_blob_try_writable (blob)) {
 321         /* ok, we made it writable by relocating.  try again */
 322         if (HB_DEBUG_SANITIZE)
 323           fprintf (stderr, "Sanitizer %p retry %s\n", blob, HB_FUNC);
 324         goto retry;
 325       }
 326     }
 327
 328     if (HB_DEBUG_SANITIZE)
 329       fprintf (stderr, "Sanitizer %p %s %s\n", blob, sane ? "passed" : "FAILED", HB_FUNC);
 330     if (sane)
 331       return blob;
 332     else {
 333       hb_blob_destroy (blob);
 334       return hb_blob_create_empty ();
 335     }
 336   }
 337
 338   static const Type* lock_instance (hb_blob_t *blob) {
 339     const char *base = hb_blob_lock (blob);
 340     return unlikely (!base) ? &Null(Type) : CastP<Type> (base);
 341   }
 342 };
 343
 344
 345
 346
 347 /*
 348  *
 349  * The OpenType Font File: Data Types
 350  */
 351
 352
 353 /* "The following data types are used in the OpenType font file.
 354  *  All OpenType fonts use Motorola-style byte ordering (Big Endian):" */
 355
 356 /*
 357  * Int types
 358  */
 359
 360
 361 template <typename Type, int Bytes> class BEInt;
 362
 363 /* LONGTERMTODO: On machines allowing unaligned access, we can make the
 364  * following tighter by using byteswap instructions on ints directly. */
 365 template <typename Type>
 366 class BEInt<Type, 2>
 367 {
 368   public:
 369   inline class BEInt<Type,2>& operator = (Type i) { hb_be_uint16_put (v,i); return *this; }
 370   inline operator Type () const { return hb_be_uint16_get (v); }
 371   inline bool operator == (const BEInt<Type, 2>& o) const { return hb_be_uint16_cmp (v, o.v); }
 372   inline bool operator != (const BEInt<Type, 2>& o) const { return !(*this == o); }
 373   private: uint8_t v[2];
 374 };
 375 template <typename Type>
 376 class BEInt<Type, 4>
 377 {
 378   public:
 379   inline class BEInt<Type,4>& operator = (Type i) { hb_be_uint32_put (v,i); return *this; }
 380   inline operator Type () const { return hb_be_uint32_get (v); }
 381   inline bool operator == (const BEInt<Type, 4>& o) const { return hb_be_uint32_cmp (v, o.v); }
 382   inline bool operator != (const BEInt<Type, 4>& o) const { return !(*this == o); }
 383   private: uint8_t v[4];
 384 };
 385
 386 /* Integer types in big-endian order and no alignment requirement */
 387 template <typename Type>
 388 struct IntType
 389 {
 390   inline void set (Type i) { v = i; }
 391   inline operator Type(void) const { return v; }
 392   inline bool operator == (const IntType<Type> &o) const { return v == o.v; }
 393   inline bool operator != (const IntType<Type> &o) const { return v != o.v; }
 394   inline bool sanitize (hb_sanitize_context_t *c) {
 395     TRACE_SANITIZE ();
 396     return likely (c->check_struct (this));
 397   }
 398   protected:
 399   BEInt<Type, sizeof (Type)> v;
 400   public:
 401   DEFINE_SIZE_STATIC (sizeof (Type));
 402 };
 403
 404 typedef IntType<uint16_t> USHORT;       /* 16-bit unsigned integer. */
 405 typedef IntType<int16_t>  SHORT;        /* 16-bit signed integer. */
 406 typedef IntType<uint32_t> ULONG;        /* 32-bit unsigned integer. */
 407 typedef IntType<int32_t>  LONG;         /* 32-bit signed integer. */
 408
 409 /* Date represented in number of seconds since 12:00 midnight, January 1,
 410  * 1904. The value is represented as a signed 64-bit integer. */
 411 struct LONGDATETIME
 412 {
 413   inline bool sanitize (hb_sanitize_context_t *c) {
 414     TRACE_SANITIZE ();
 415     return likely (c->check_struct (this));
 416   }
 417   private:
 418   LONG major;
 419   ULONG minor;
 420   public:
 421   DEFINE_SIZE_STATIC (8);
 422 };
 423
 424 /* Array of four uint8s (length = 32 bits) used to identify a script, language
 425  * system, feature, or baseline */
 426 struct Tag : ULONG
 427 {
 428   /* What the char* converters return is NOT nul-terminated.  Print using "%.4s" */
 429   inline operator const char* (void) const { return reinterpret_cast<const char *> (&this->v); }
 430   inline operator char* (void) { return reinterpret_cast<char *> (&this->v); }
 431   public:
 432   DEFINE_SIZE_STATIC (4);
 433 };
 434 DEFINE_NULL_DATA (Tag, "    ");
 435
 436 /* Glyph index number, same as uint16 (length = 16 bits) */
 437 typedef USHORT GlyphID;
 438
 439 /* Script/language-system/feature index */
 440 struct Index : USHORT {
 441   static const unsigned int NOT_FOUND_INDEX = 0xFFFF;
 442 };
 443 DEFINE_NULL_DATA (Index, "\xff\xff");
 444
 445 /* Offset to a table, same as uint16 (length = 16 bits), Null offset = 0x0000 */
 446 typedef USHORT Offset;
 447
 448 /* LongOffset to a table, same as uint32 (length = 32 bits), Null offset = 0x00000000 */
 449 typedef ULONG LongOffset;
 450
 451
 452 /* CheckSum */
 453 struct CheckSum : ULONG
 454 {
 455   static uint32_t CalcTableChecksum (ULONG *Table, uint32_t Length)
 456   {
 457     uint32_t Sum = 0L;
 458     ULONG *EndPtr = Table+((Length+3) & ~3) / ULONG::static_size;
 459
 460     while (Table < EndPtr)
 461       Sum += *Table++;
 462     return Sum;
 463   }
 464   public:
 465   DEFINE_SIZE_STATIC (4);
 466 };
 467
 468
 469 /*
 470  * Version Numbers
 471  */
 472
 473 struct FixedVersion
 474 {
 475   inline operator uint32_t (void) const { return (major << 16) + minor; }
 476
 477   inline bool sanitize (hb_sanitize_context_t *c) {
 478     TRACE_SANITIZE ();
 479     return c->check_struct (this);
 480   }
 481
 482   USHORT major;
 483   USHORT minor;
 484   public:
 485   DEFINE_SIZE_STATIC (4);
 486 };
 487
 488
 489
 490 /*
 491  * Template subclasses of Offset and LongOffset that do the dereferencing.
 492  * Use: (base+offset)
 493  */
 494
 495 template <typename OffsetType, typename Type>
 496 struct GenericOffsetTo : OffsetType
 497 {
 498   inline const Type& operator () (const void *base) const
 499   {
 500     unsigned int offset = *this;
 501     if (unlikely (!offset)) return Null(Type);
 502     return StructAtOffset<Type> (base, offset);
 503   }
 504
 505   inline bool sanitize (hb_sanitize_context_t *c, void *base) {
 506     TRACE_SANITIZE ();
 507     if (unlikely (!c->check_struct (this))) return false;
 508     unsigned int offset = *this;
 509     if (unlikely (!offset)) return true;
 510     Type &obj = StructAtOffset<Type> (base, offset);
 511     return likely (obj.sanitize (c)) || neuter (c);
 512   }
 513   template <typename T>
 514   inline bool sanitize (hb_sanitize_context_t *c, void *base, T user_data) {
 515     TRACE_SANITIZE ();
 516     if (unlikely (!c->check_struct (this))) return false;
 517     unsigned int offset = *this;
 518     if (unlikely (!offset)) return true;
 519     Type &obj = StructAtOffset<Type> (base, offset);
 520     return likely (obj.sanitize (c, user_data)) || neuter (c);
 521   }
 522
 523   private:
 524   /* Set the offset to Null */
 525   inline bool neuter (hb_sanitize_context_t *c) {
 526     if (c->can_edit (this, this->static_size)) {
 527       this->set (0); /* 0 is Null offset */
 528       return true;
 529     }
 530     return false;
 531   }
 532 };
 533 template <typename Base, typename OffsetType, typename Type>
 534 inline const Type& operator + (const Base &base, GenericOffsetTo<OffsetType, Type> offset) { return offset (base); }
 535
 536 template <typename Type>
 537 struct OffsetTo : GenericOffsetTo<Offset, Type> {};
 538
 539 template <typename Type>
 540 struct LongOffsetTo : GenericOffsetTo<LongOffset, Type> {};
 541
 542
 543 /*
 544  * Array Types
 545  */
 546
 547 template <typename LenType, typename Type>
 548 struct GenericArrayOf
 549 {
 550   const Type *sub_array (unsigned int start_offset, unsigned int *pcount /* IN/OUT */) const
 551   {
 552     unsigned int count = len;
 553     if (unlikely (start_offset > count))
 554       count = 0;
 555     else
 556       count -= start_offset;
 557     count = MIN (count, *pcount);
 558     *pcount = count;
 559     return array + start_offset;
 560   }
 561
 562   inline const Type& operator [] (unsigned int i) const
 563   {
 564     if (unlikely (i >= len)) return Null(Type);
 565     return array[i];
 566   }
 567   inline unsigned int get_size () const
 568   { return len.static_size + len * Type::static_size; }
 569
 570   inline bool sanitize (hb_sanitize_context_t *c) {
 571     TRACE_SANITIZE ();
 572     if (unlikely (!sanitize_shallow (c))) return false;
 573     /* Note: for structs that do not reference other structs,
 574      * we do not need to call their sanitize() as we already did
 575      * a bound check on the aggregate array size, hence the return.
 576      */
 577     return true;
 578     /* We do keep this code though to make sure the structs pointed
 579      * to do have a simple sanitize(), ie. they do not reference
 580      * other structs. */
 581     unsigned int count = len;
 582     for (unsigned int i = 0; i < count; i++)
 583       if (array[i].sanitize (c))
 584         return false;
 585     return true;
 586   }
 587   inline bool sanitize (hb_sanitize_context_t *c, void *base) {
 588     TRACE_SANITIZE ();
 589     if (unlikely (!sanitize_shallow (c))) return false;
 590     unsigned int count = len;
 591     for (unsigned int i = 0; i < count; i++)
 592       if (unlikely (!array[i].sanitize (c, base)))
 593         return false;
 594     return true;
 595   }
 596   template <typename T>
 597   inline bool sanitize (hb_sanitize_context_t *c, void *base, T user_data) {
 598     TRACE_SANITIZE ();
 599     if (unlikely (!sanitize_shallow (c))) return false;
 600     unsigned int count = len;
 601     for (unsigned int i = 0; i < count; i++)
 602       if (unlikely (!array[i].sanitize (c, base, user_data)))
 603         return false;
 604     return true;
 605   }
 606
 607   private:
 608   inline bool sanitize_shallow (hb_sanitize_context_t *c) {
 609     TRACE_SANITIZE ();
 610     return c->check_struct (this)
 611         && c->check_array (this, Type::static_size, len);
 612   }
 613
 614   public:
 615   LenType len;
 616   Type array[VAR];
 617   public:
 618   DEFINE_SIZE_ARRAY (sizeof (LenType), array);
 619 };
 620
 621 /* An array with a USHORT number of elements. */
 622 template <typename Type>
 623 struct ArrayOf : GenericArrayOf<USHORT, Type> {};
 624
 625 /* An array with a ULONG number of elements. */
 626 template <typename Type>
 627 struct LongArrayOf : GenericArrayOf<ULONG, Type> {};
 628
 629 /* Array of Offset's */
 630 template <typename Type>
 631 struct OffsetArrayOf : ArrayOf<OffsetTo<Type> > {};
 632
 633 /* Array of LongOffset's */
 634 template <typename Type>
 635 struct LongOffsetArrayOf : ArrayOf<LongOffsetTo<Type> > {};
 636
 637 /* LongArray of LongOffset's */
 638 template <typename Type>
 639 struct LongOffsetLongArrayOf : LongArrayOf<LongOffsetTo<Type> > {};
 640
 641 /* Array of offsets relative to the beginning of the array itself. */
 642 template <typename Type>
 643 struct OffsetListOf : OffsetArrayOf<Type>
 644 {
 645   inline const Type& operator [] (unsigned int i) const
 646   {
 647     if (unlikely (i >= this->len)) return Null(Type);
 648     return this+this->array[i];
 649   }
 650
 651   inline bool sanitize (hb_sanitize_context_t *c) {
 652     TRACE_SANITIZE ();
 653     return OffsetArrayOf<Type>::sanitize (c, this);
 654   }
 655   template <typename T>
 656   inline bool sanitize (hb_sanitize_context_t *c, T user_data) {
 657     TRACE_SANITIZE ();
 658     return OffsetArrayOf<Type>::sanitize (c, this, user_data);
 659   }
 660 };
 661
 662
 663 /* An array with a USHORT number of elements,
 664  * starting at second element. */
 665 template <typename Type>
 666 struct HeadlessArrayOf
 667 {
 668   inline const Type& operator [] (unsigned int i) const
 669   {
 670     if (unlikely (i >= len || !i)) return Null(Type);
 671     return array[i-1];
 672   }
 673   inline unsigned int get_size () const
 674   { return len.static_size + (len ? len - 1 : 0) * Type::static_size; }
 675
 676   inline bool sanitize_shallow (hb_sanitize_context_t *c) {
 677     return c->check_struct (this)
 678         && c->check_array (this, Type::static_size, len);
 679   }
 680
 681   inline bool sanitize (hb_sanitize_context_t *c) {
 682     TRACE_SANITIZE ();
 683     if (unlikely (!sanitize_shallow (c))) return false;
 684     /* Note: for structs that do not reference other structs,
 685      * we do not need to call their sanitize() as we already did
 686      * a bound check on the aggregate array size, hence the return.
 687      */
 688     return true;
 689     /* We do keep this code though to make sure the structs pointed
 690      * to do have a simple sanitize(), ie. they do not reference
 691      * other structs. */
 692     unsigned int count = len ? len - 1 : 0;
 693     Type *a = array;
 694     for (unsigned int i = 0; i < count; i++)
 695       if (unlikely (!a[i].sanitize (c)))
 696         return false;
 697     return true;
 698   }
 699
 700   USHORT len;
 701   Type array[VAR];
 702   public:
 703   DEFINE_SIZE_ARRAY (sizeof (USHORT), array);
 704 };
 705
 706
 707 #endif /* HB_OPEN_TYPE_PRIVATE_HH */