harfbuzz/src/hb-open-type.hh

878 lines
26 KiB
C++
Raw Normal View History

2008-01-23 22:14:38 +01:00
/*
2011-04-21 23:14:28 +02:00
* Copyright © 2007,2008,2009,2010 Red Hat, Inc.
* Copyright © 2012 Google, Inc.
2008-01-23 22:14:38 +01:00
*
2010-04-22 06:11:43 +02:00
* This is part of HarfBuzz, a text shaping library.
2008-01-23 22:14:38 +01:00
*
* Permission is hereby granted, without written agreement and without
* license or royalty fees, to use, copy, modify, and distribute this
* software and its documentation for any purpose, provided that the
* above copyright notice and the following two paragraphs appear in
* all copies of this software.
*
* IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
* DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
* ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
* IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
* THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
* ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
* PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
*
* Red Hat Author(s): Behdad Esfahbod
* Google Author(s): Behdad Esfahbod
2008-01-23 22:14:38 +01:00
*/
#ifndef HB_OPEN_TYPE_HH
#define HB_OPEN_TYPE_HH
#include "hb.hh"
#include "hb-blob.hh"
#include "hb-face.hh"
#include "hb-machinery.hh"
2018-09-01 01:31:00 +02:00
#include "hb-subset.hh"
2008-01-23 23:01:55 +01:00
namespace OT {
2006-12-22 08:21:55 +01:00
/*
*
* The OpenType Font File: Data Types
2006-12-22 08:21:55 +01:00
*/
/* "The following data types are used in the OpenType font file.
* All OpenType fonts use Motorola-style byte ordering (Big Endian):" */
2009-05-17 06:54:25 +02:00
/*
* Int types
*/
2010-04-22 05:11:45 +02:00
/* Integer types in big-endian order and no alignment requirement */
2012-12-11 22:00:43 +01:00
template <typename Type, unsigned int Size>
2010-04-21 09:11:46 +02:00
struct IntType
{
2018-10-20 00:23:49 +02:00
typedef Type type;
inline void set (Type i) { v.set (i); }
2010-04-22 04:49:56 +02:00
inline operator Type(void) const { return v; }
2015-02-19 15:03:02 +01:00
inline bool operator == (const IntType<Type,Size> &o) const { return (Type) v == (Type) o.v; }
inline bool operator != (const IntType<Type,Size> &o) const { return !(*this == o); }
2012-12-11 22:00:43 +01:00
static inline int cmp (const IntType<Type,Size> *a, const IntType<Type,Size> *b) { return b->cmp (*a); }
template <typename Type2>
inline int cmp (Type2 a) const
{
Type b = v;
if (sizeof (Type) < sizeof (int) && sizeof (Type2) < sizeof (int))
return (int) a - (int) b;
else
return a < b ? -1 : a == b ? 0 : +1;
}
inline bool sanitize (hb_sanitize_context_t *c) const
{
2012-11-23 21:32:14 +01:00
TRACE_SANITIZE (this);
return_trace (likely (c->check_struct (this)));
2010-04-21 09:11:46 +02:00
}
2010-05-10 23:55:03 +02:00
protected:
2012-12-11 22:00:43 +01:00
BEInt<Type, Size> v;
2010-05-10 22:38:32 +02:00
public:
2012-12-11 22:00:43 +01:00
DEFINE_SIZE_STATIC (Size);
2010-04-21 09:11:46 +02:00
};
typedef IntType<uint8_t, 1> HBUINT8; /* 8-bit unsigned integer. */
typedef IntType<int8_t, 1> HBINT8; /* 8-bit signed integer. */
typedef IntType<uint16_t, 2> HBUINT16; /* 16-bit unsigned integer. */
typedef IntType<int16_t, 2> HBINT16; /* 16-bit signed integer. */
typedef IntType<uint32_t, 4> HBUINT32; /* 32-bit unsigned integer. */
typedef IntType<int32_t, 4> HBINT32; /* 32-bit signed integer. */
typedef IntType<uint32_t, 3> HBUINT24; /* 24-bit unsigned integer. */
2010-04-21 09:11:46 +02:00
/* 16-bit signed integer (HBINT16) that describes a quantity in FUnits. */
typedef HBINT16 FWORD;
2011-08-17 14:43:45 +02:00
2018-10-11 01:58:20 +02:00
/* 32-bit signed integer (HBINT32) that describes a quantity in FUnits. */
typedef HBINT32 FWORD32;
/* 16-bit unsigned integer (HBUINT16) that describes a quantity in FUnits. */
typedef HBUINT16 UFWORD;
2011-08-17 14:43:45 +02:00
2016-03-01 08:41:53 +01:00
/* 16-bit signed fixed number with the low 14 bits of fraction (2.14). */
struct F2DOT14 : HBINT16
2016-03-01 08:41:53 +01:00
{
// 16384 means 1<<14
inline float to_float (void) const { return ((int32_t) v) / 16384.f; }
inline void set_float (float f) { v.set (round (f * 16384.f)); }
2016-03-01 08:41:53 +01:00
public:
DEFINE_SIZE_STATIC (2);
};
/* 32-bit signed fixed-point number (16.16). */
struct Fixed : HBINT32
{
// 65536 means 1<<16
inline float to_float (void) const { return ((int32_t) v) / 65536.f; }
inline void set_float (float f) { v.set (round (f * 65536.f)); }
public:
DEFINE_SIZE_STATIC (4);
};
2010-05-19 17:47:17 +02:00
/* Date represented in number of seconds since 12:00 midnight, January 1,
* 1904. The value is represented as a signed 64-bit integer. */
struct LONGDATETIME
{
inline bool sanitize (hb_sanitize_context_t *c) const
{
2012-11-23 21:32:14 +01:00
TRACE_SANITIZE (this);
return_trace (likely (c->check_struct (this)));
2010-05-19 17:47:17 +02:00
}
protected:
HBINT32 major;
HBUINT32 minor;
2010-05-19 17:47:17 +02:00
public:
DEFINE_SIZE_STATIC (8);
};
/* Array of four uint8s (length = 32 bits) used to identify a script, language
* system, feature, or baseline */
struct Tag : HBUINT32
2009-05-20 05:58:54 +02:00
{
2006-12-25 15:14:52 +01:00
/* What the char* converters return is NOT nul-terminated. Print using "%.4s" */
2010-05-10 23:55:03 +02:00
inline operator const char* (void) const { return reinterpret_cast<const char *> (&this->v); }
inline operator char* (void) { return reinterpret_cast<char *> (&this->v); }
public:
DEFINE_SIZE_STATIC (4);
};
/* Glyph index number, same as uint16 (length = 16 bits) */
typedef HBUINT16 GlyphID;
2010-05-11 04:22:22 +02:00
/* Script/language-system/feature index */
struct Index : HBUINT16 {
enum { NOT_FOUND_INDEX = 0xFFFFu };
2010-05-11 04:22:22 +02:00
};
DECLARE_NULL_NAMESPACE_BYTES (OT, Index);
2010-05-11 04:22:22 +02:00
typedef Index NameID;
2014-06-27 21:12:52 +02:00
/* Offset, Null offset = 0 */
2018-09-13 18:45:35 +02:00
template <typename Type, bool has_null=true>
2014-06-27 21:12:52 +02:00
struct Offset : Type
{
2018-10-20 00:23:49 +02:00
typedef Type type;
2018-09-13 18:45:35 +02:00
inline bool is_null (void) const { return has_null && 0 == *this; }
2018-02-08 04:13:10 +01:00
inline void *serialize (hb_serialize_context_t *c, const void *base)
{
void *t = c->start_embed<void> ();
this->set ((char *) t - (char *) base); /* TODO(serialize) Overflow? */
return t;
}
2018-02-26 04:06:25 +01:00
public:
DEFINE_SIZE_STATIC (sizeof(Type));
};
2009-05-25 08:27:29 +02:00
typedef Offset<HBUINT16> Offset16;
typedef Offset<HBUINT32> Offset32;
2017-11-15 06:09:03 +01:00
/* CheckSum */
struct CheckSum : HBUINT32
2009-05-20 05:58:54 +02:00
{
2013-07-21 23:05:02 +02:00
/* This is reference implementation from the spec. */
static inline uint32_t CalcTableChecksum (const HBUINT32 *Table, uint32_t Length)
2009-05-20 05:58:54 +02:00
{
uint32_t Sum = 0L;
assert (0 == (Length & 3));
const HBUINT32 *EndPtr = Table + Length / HBUINT32::static_size;
while (Table < EndPtr)
Sum += *Table++;
return Sum;
}
2013-07-21 23:05:02 +02:00
/* Note: data should be 4byte aligned and have 4byte padding at the end. */
inline void set_for_data (const void *data, unsigned int length)
{ set (CalcTableChecksum ((const HBUINT32 *) data, length)); }
2013-07-21 23:05:02 +02:00
public:
DEFINE_SIZE_STATIC (4);
};
/*
* Version Numbers
*/
template <typename FixedType=HBUINT16>
2009-05-24 07:03:24 +02:00
struct FixedVersion
2009-05-20 05:58:54 +02:00
{
inline uint32_t to_int (void) const { return (major << (sizeof(FixedType) * 8)) + minor; }
2009-05-24 18:30:40 +02:00
inline bool sanitize (hb_sanitize_context_t *c) const
{
2012-11-23 21:32:14 +01:00
TRACE_SANITIZE (this);
return_trace (c->check_struct (this));
2009-08-04 08:09:34 +02:00
}
2016-02-22 03:44:45 +01:00
FixedType major;
FixedType minor;
public:
2016-02-22 03:44:45 +01:00
DEFINE_SIZE_STATIC (2 * sizeof(FixedType));
};
2009-08-04 16:41:32 +02:00
2009-05-17 06:54:25 +02:00
/*
2014-06-27 21:12:52 +02:00
* Template subclasses of Offset that do the dereferencing.
2010-05-03 00:14:25 +02:00
* Use: (base+offset)
2009-05-17 06:54:25 +02:00
*/
template <typename Type, bool has_null_> struct assert_has_min_size { static_assert (Type::min_size > 0, ""); };
template <typename Type> struct assert_has_min_size<Type, false> {};
2018-09-13 18:45:35 +02:00
template <typename Type, typename OffsetType=HBUINT16, bool has_null=true>
struct OffsetTo : Offset<OffsetType, has_null>
2009-08-04 16:41:32 +02:00
{
static_assert (sizeof (assert_has_min_size<Type, has_null>) || true, "");
2010-04-21 05:50:45 +02:00
inline const Type& operator () (const void *base) const
2009-08-04 16:41:32 +02:00
{
2018-09-13 18:45:35 +02:00
if (unlikely (this->is_null ())) return Null(Type);
return StructAtOffset<const Type> (base, *this);
}
inline Type& operator () (void *base) const
{
2018-09-13 18:45:35 +02:00
if (unlikely (this->is_null ())) return Crap(Type);
return StructAtOffset<Type> (base, *this);
2009-08-04 16:41:32 +02:00
}
2012-09-02 02:48:22 +02:00
inline Type& serialize (hb_serialize_context_t *c, const void *base)
2012-09-02 02:48:22 +02:00
{
2018-02-08 04:13:10 +01:00
return * (Type *) Offset<OffsetType>::serialize (c, base);
2012-09-02 02:48:22 +02:00
}
2009-08-04 16:41:32 +02:00
template <typename T>
inline void serialize_subset (hb_subset_context_t *c, const T &src, const void *base)
{
if (&src == &Null(T))
{
this->set (0);
return;
}
serialize (c->serializer, base);
if (!src.subset (c))
this->set (0);
}
2018-09-13 16:29:49 +02:00
inline bool sanitize_shallow (hb_sanitize_context_t *c, const void *base) const
{
2012-11-23 21:32:14 +01:00
TRACE_SANITIZE (this);
if (unlikely (!c->check_struct (this))) return_trace (false);
2018-09-13 18:45:35 +02:00
if (unlikely (this->is_null ())) return_trace (true);
if (unlikely (!c->check_range (base, *this))) return_trace (false);
2018-09-13 16:29:49 +02:00
return_trace (true);
}
inline bool sanitize (hb_sanitize_context_t *c, const void *base) const
{
TRACE_SANITIZE (this);
2018-09-13 16:31:31 +02:00
return_trace (sanitize_shallow (c, base) &&
2018-09-13 18:45:35 +02:00
(this->is_null () ||
StructAtOffset<Type> (base, *this).sanitize (c) ||
2018-09-13 16:31:31 +02:00
neuter (c)));
2009-08-04 16:41:32 +02:00
}
template <typename T1>
inline bool sanitize (hb_sanitize_context_t *c, const void *base, T1 d1) const
{
2012-11-23 21:32:14 +01:00
TRACE_SANITIZE (this);
2018-09-13 16:31:31 +02:00
return_trace (sanitize_shallow (c, base) &&
2018-09-13 18:45:35 +02:00
(this->is_null () ||
StructAtOffset<Type> (base, *this).sanitize (c, d1) ||
2018-09-13 16:31:31 +02:00
neuter (c)));
}
2018-09-13 16:29:49 +02:00
template <typename T1, typename T2>
inline bool sanitize (hb_sanitize_context_t *c, const void *base, T1 d1, T2 d2) const
{
TRACE_SANITIZE (this);
return_trace (sanitize_shallow (c, base) &&
2018-09-13 18:45:35 +02:00
(this->is_null () ||
StructAtOffset<Type> (base, *this).sanitize (c, d1, d2) ||
neuter (c)));
}
template <typename T1, typename T2, typename T3>
inline bool sanitize (hb_sanitize_context_t *c, const void *base, T1 d1, T2 d2, T3 d3) const
2018-09-13 16:29:49 +02:00
{
TRACE_SANITIZE (this);
2018-09-13 16:31:31 +02:00
return_trace (sanitize_shallow (c, base) &&
2018-09-13 18:45:35 +02:00
(this->is_null () ||
StructAtOffset<Type> (base, *this).sanitize (c, d1, d2, d3) ||
2018-09-13 16:31:31 +02:00
neuter (c)));
2018-09-13 16:29:49 +02:00
}
/* Set the offset to Null */
2018-09-13 18:45:35 +02:00
inline bool neuter (hb_sanitize_context_t *c) const
{
if (!has_null) return false;
2014-06-05 00:42:32 +02:00
return c->try_set (this, 0);
2009-08-04 19:30:49 +02:00
}
2014-06-27 21:39:47 +02:00
DEFINE_SIZE_STATIC (sizeof(OffsetType));
2009-08-04 16:41:32 +02:00
};
template <typename Type, bool has_null=true> struct LOffsetTo : OffsetTo<Type, HBUINT32, has_null> {};
2018-09-13 18:45:35 +02:00
template <typename Base, typename OffsetType, bool has_null, typename Type>
static inline const Type& operator + (const Base &base, const OffsetTo<Type, OffsetType, has_null> &offset) { return offset (base); }
template <typename Base, typename OffsetType, bool has_null, typename Type>
static inline Type& operator + (Base &base, OffsetTo<Type, OffsetType, has_null> &offset) { return offset (base); }
2009-08-04 16:41:32 +02:00
2009-08-04 16:41:32 +02:00
/*
* Array Types
*/
2018-03-14 16:18:42 +01:00
template <typename Type>
struct UnsizedArrayOf
{
2018-10-30 00:00:23 +01:00
HB_NO_CREATE_COPY_ASSIGN_TEMPLATE (UnsizedArrayOf, Type);
2018-03-14 16:18:42 +01:00
inline const Type& operator [] (unsigned int i) const { return arrayZ[i]; }
inline Type& operator [] (unsigned int i) { return arrayZ[i]; }
2018-11-02 17:14:21 +01:00
template <typename T> inline operator T * (void) { return arrayZ; }
template <typename T> inline operator const T * (void) const { return arrayZ; }
2018-11-02 16:38:00 +01:00
inline unsigned int get_size (unsigned int len) const
{ return len * Type::static_size; }
inline hb_array_t<Type> as_array (unsigned int len) { return hb_array_t<Type> (arrayZ, len); }
inline hb_array_t<const Type> as_array (unsigned int len) const { return hb_array_t<const Type> (arrayZ, len); }
2018-03-14 16:18:42 +01:00
inline bool sanitize (hb_sanitize_context_t *c, unsigned int count) const
{
TRACE_SANITIZE (this);
if (unlikely (!sanitize_shallow (c, count))) return_trace (false);
/* Note: for structs that do not reference other structs,
* we do not need to call their sanitize() as we already did
* a bound check on the aggregate array size. We just include
* a small unreachable expression to make sure the structs
* pointed to do have a simple sanitize(), ie. they do not
* reference other structs via offsets.
*/
(void) (false && arrayZ[0].sanitize (c));
return_trace (true);
}
inline bool sanitize (hb_sanitize_context_t *c, unsigned int count, const void *base) const
{
TRACE_SANITIZE (this);
if (unlikely (!sanitize_shallow (c, count))) return_trace (false);
for (unsigned int i = 0; i < count; i++)
if (unlikely (!arrayZ[i].sanitize (c, base)))
return_trace (false);
return_trace (true);
}
template <typename T>
inline bool sanitize (hb_sanitize_context_t *c, unsigned int count, const void *base, T user_data) const
{
TRACE_SANITIZE (this);
if (unlikely (!sanitize_shallow (c, count))) return_trace (false);
for (unsigned int i = 0; i < count; i++)
if (unlikely (!arrayZ[i].sanitize (c, base, user_data)))
return_trace (false);
return_trace (true);
}
inline bool sanitize_shallow (hb_sanitize_context_t *c, unsigned int count) const
{
TRACE_SANITIZE (this);
return_trace (c->check_array (arrayZ, count));
2018-03-14 16:18:42 +01:00
}
public:
2018-09-10 23:29:26 +02:00
Type arrayZ[VAR];
2018-03-14 16:18:42 +01:00
public:
DEFINE_SIZE_ARRAY (0, arrayZ);
};
/* Unsized array of offset's */
template <typename Type, typename OffsetType, bool has_null=true>
struct UnsizedOffsetArrayOf : UnsizedArrayOf<OffsetTo<Type, OffsetType, has_null> > {};
2018-03-14 16:18:42 +01:00
/* Unsized array of offsets relative to the beginning of the array itself. */
template <typename Type, typename OffsetType, bool has_null=true>
struct UnsizedOffsetListOf : UnsizedOffsetArrayOf<Type, OffsetType, has_null>
2018-03-14 16:18:42 +01:00
{
inline const Type& operator [] (unsigned int i) const
{
return this+this->arrayZ[i];
}
inline bool sanitize (hb_sanitize_context_t *c, unsigned int count) const
{
TRACE_SANITIZE (this);
return_trace ((UnsizedOffsetArrayOf<Type, OffsetType, has_null>::sanitize (c, count, this)));
2018-03-14 16:18:42 +01:00
}
template <typename T>
inline bool sanitize (hb_sanitize_context_t *c, unsigned int count, T user_data) const
{
TRACE_SANITIZE (this);
return_trace ((UnsizedOffsetArrayOf<Type, OffsetType, has_null>::sanitize (c, count, this, user_data)));
2018-03-14 16:18:42 +01:00
}
};
/* An array with a number of elements. */
template <typename Type, typename LenType=HBUINT16>
struct ArrayOf
2009-05-20 05:58:54 +02:00
{
2018-10-30 00:00:23 +01:00
HB_NO_CREATE_COPY_ASSIGN_TEMPLATE2 (ArrayOf, Type, LenType);
inline const Type *sub_array (unsigned int start_offset, unsigned int *pcount /* IN/OUT */) const
2009-11-04 22:59:50 +01:00
{
unsigned int count = len;
if (unlikely (start_offset > count))
2009-11-04 22:59:50 +01:00
count = 0;
else
count -= start_offset;
count = MIN (count, *pcount);
*pcount = count;
2018-05-09 01:56:11 +02:00
return arrayZ + start_offset;
2009-11-04 22:59:50 +01:00
}
2009-05-20 05:58:54 +02:00
inline const Type& operator [] (unsigned int i) const
{
if (unlikely (i >= len)) return Null(Type);
2018-05-09 01:56:11 +02:00
return arrayZ[i];
2009-05-17 06:54:25 +02:00
}
2012-08-30 03:08:59 +02:00
inline Type& operator [] (unsigned int i)
{
if (unlikely (i >= len)) return Crap(Type);
2018-05-09 01:56:11 +02:00
return arrayZ[i];
2012-08-30 03:08:59 +02:00
}
2010-10-02 00:58:50 +02:00
inline unsigned int get_size (void) const
{ return len.static_size + len * Type::static_size; }
2009-05-18 08:03:58 +02:00
inline bool serialize (hb_serialize_context_t *c,
unsigned int items_len)
{
2012-11-23 21:32:14 +01:00
TRACE_SERIALIZE (this);
if (unlikely (!c->extend_min (*this))) return_trace (false);
len.set (items_len); /* TODO(serialize) Overflow? */
if (unlikely (!c->extend (*this))) return_trace (false);
return_trace (true);
}
2012-09-02 03:43:38 +02:00
inline bool serialize (hb_serialize_context_t *c,
Supplier<Type> &items,
2012-09-02 03:43:38 +02:00
unsigned int items_len)
{
2012-11-23 21:32:14 +01:00
TRACE_SERIALIZE (this);
if (unlikely (!serialize (c, items_len))) return_trace (false);
2012-09-05 02:10:17 +02:00
for (unsigned int i = 0; i < items_len; i++)
2018-05-09 01:56:11 +02:00
arrayZ[i] = items[i];
items += items_len;
return_trace (true);
2012-09-02 03:43:38 +02:00
}
inline bool sanitize (hb_sanitize_context_t *c) const
{
2012-11-23 21:32:14 +01:00
TRACE_SANITIZE (this);
if (unlikely (!sanitize_shallow (c))) return_trace (false);
2010-04-21 06:49:40 +02:00
/* Note: for structs that do not reference other structs,
* we do not need to call their sanitize() as we already did
* a bound check on the aggregate array size. We just include
* a small unreachable expression to make sure the structs
* pointed to do have a simple sanitize(), ie. they do not
* reference other structs via offsets.
2010-04-21 06:49:40 +02:00
*/
2018-05-09 01:56:11 +02:00
(void) (false && arrayZ[0].sanitize (c));
return_trace (true);
2009-08-04 06:58:28 +02:00
}
inline bool sanitize (hb_sanitize_context_t *c, const void *base) const
{
2012-11-23 21:32:14 +01:00
TRACE_SANITIZE (this);
if (unlikely (!sanitize_shallow (c))) return_trace (false);
2009-08-04 16:23:01 +02:00
unsigned int count = len;
for (unsigned int i = 0; i < count; i++)
2018-05-09 01:56:11 +02:00
if (unlikely (!arrayZ[i].sanitize (c, base)))
return_trace (false);
return_trace (true);
2009-08-04 16:23:01 +02:00
}
template <typename T>
inline bool sanitize (hb_sanitize_context_t *c, const void *base, T user_data) const
{
2012-11-23 21:32:14 +01:00
TRACE_SANITIZE (this);
if (unlikely (!sanitize_shallow (c))) return_trace (false);
2009-08-04 19:30:49 +02:00
unsigned int count = len;
for (unsigned int i = 0; i < count; i++)
2018-05-09 01:56:11 +02:00
if (unlikely (!arrayZ[i].sanitize (c, base, user_data)))
return_trace (false);
return_trace (true);
2009-08-04 19:30:49 +02:00
}
2009-08-04 06:58:28 +02:00
template <typename SearchType>
inline int lsearch (const SearchType &x) const
{
unsigned int count = len;
for (unsigned int i = 0; i < count; i++)
2018-05-09 01:56:11 +02:00
if (!this->arrayZ[i].cmp (x))
return i;
return -1;
}
2018-02-08 04:13:10 +01:00
inline void qsort (void)
{
2018-05-09 01:56:11 +02:00
::qsort (arrayZ, len, sizeof (Type), Type::cmp);
2018-02-08 04:13:10 +01:00
}
inline bool sanitize_shallow (hb_sanitize_context_t *c) const
{
2012-11-23 21:32:14 +01:00
TRACE_SANITIZE (this);
return_trace (len.sanitize (c) && c->check_array (arrayZ, len));
2010-05-04 20:28:18 +02:00
}
public:
2018-09-10 23:29:26 +02:00
LenType len;
Type arrayZ[VAR];
public:
2018-05-09 01:56:11 +02:00
DEFINE_SIZE_ARRAY (sizeof (LenType), arrayZ);
2009-05-18 08:03:58 +02:00
};
template <typename Type> struct LArrayOf : ArrayOf<Type, HBUINT32> {};
2018-07-01 12:02:00 +02:00
typedef ArrayOf<HBUINT8, HBUINT8> PString;
2009-05-18 08:03:58 +02:00
2009-08-04 16:41:32 +02:00
/* Array of Offset's */
2018-10-29 00:29:09 +01:00
template <typename Type>
struct OffsetArrayOf : ArrayOf<OffsetTo<Type, HBUINT16> > {};
template <typename Type>
struct LOffsetArrayOf : ArrayOf<OffsetTo<Type, HBUINT32> > {};
2018-10-29 00:27:18 +01:00
template <typename Type>
struct LOffsetLArrayOf : ArrayOf<OffsetTo<Type, HBUINT32>, HBUINT32> {};
2009-08-04 16:41:32 +02:00
2009-08-15 00:40:56 +02:00
/* Array of offsets relative to the beginning of the array itself. */
template <typename Type>
struct OffsetListOf : OffsetArrayOf<Type>
{
inline const Type& operator [] (unsigned int i) const
{
if (unlikely (i >= this->len)) return Null(Type);
2018-05-09 01:56:11 +02:00
return this+this->arrayZ[i];
2009-08-15 00:40:56 +02:00
}
inline const Type& operator [] (unsigned int i)
{
if (unlikely (i >= this->len)) return Crap(Type);
return this+this->arrayZ[i];
}
2009-08-15 00:40:56 +02:00
inline bool subset (hb_subset_context_t *c) const
{
TRACE_SUBSET (this);
struct OffsetListOf<Type> *out = c->serializer->embed (*this);
if (unlikely (!out)) return_trace (false);
unsigned int count = this->len;
for (unsigned int i = 0; i < count; i++)
out->arrayZ[i].serialize_subset (c, (*this)[i], out);
return_trace (true);
}
inline bool sanitize (hb_sanitize_context_t *c) const
{
2012-11-23 21:32:14 +01:00
TRACE_SANITIZE (this);
return_trace (OffsetArrayOf<Type>::sanitize (c, this));
2009-08-15 00:40:56 +02:00
}
template <typename T>
inline bool sanitize (hb_sanitize_context_t *c, T user_data) const
{
2012-11-23 21:32:14 +01:00
TRACE_SANITIZE (this);
return_trace (OffsetArrayOf<Type>::sanitize (c, this, user_data));
2009-08-15 00:40:56 +02:00
}
};
2014-06-27 21:27:15 +02:00
/* An array starting at second element. */
template <typename Type, typename LenType=HBUINT16>
2009-05-20 05:58:54 +02:00
struct HeadlessArrayOf
{
2018-10-30 00:00:23 +01:00
HB_NO_CREATE_COPY_ASSIGN_TEMPLATE2 (HeadlessArrayOf, Type, LenType);
2009-05-20 05:58:54 +02:00
inline const Type& operator [] (unsigned int i) const
{
if (unlikely (i >= lenP1 || !i)) return Null(Type);
2018-05-09 01:56:11 +02:00
return arrayZ[i-1];
2009-05-18 08:03:58 +02:00
}
inline Type& operator [] (unsigned int i)
{
if (unlikely (i >= lenP1 || !i)) return Crap(Type);
return arrayZ[i-1];
}
2010-10-02 00:58:50 +02:00
inline unsigned int get_size (void) const
{ return lenP1.static_size + (lenP1 ? lenP1 - 1 : 0) * Type::static_size; }
2009-05-17 06:54:25 +02:00
inline bool serialize (hb_serialize_context_t *c,
Supplier<Type> &items,
unsigned int items_len)
{
2012-11-23 21:32:14 +01:00
TRACE_SERIALIZE (this);
if (unlikely (!c->extend_min (*this))) return_trace (false);
lenP1.set (items_len); /* TODO(serialize) Overflow? */
if (unlikely (!items_len)) return_trace (true);
if (unlikely (!c->extend (*this))) return_trace (false);
for (unsigned int i = 0; i < items_len - 1; i++)
2018-05-09 01:56:11 +02:00
arrayZ[i] = items[i];
items += items_len - 1;
return_trace (true);
}
inline bool sanitize (hb_sanitize_context_t *c) const
{
2012-11-23 21:32:14 +01:00
TRACE_SANITIZE (this);
if (unlikely (!sanitize_shallow (c))) return_trace (false);
2010-04-21 06:49:40 +02:00
/* Note: for structs that do not reference other structs,
* we do not need to call their sanitize() as we already did
* a bound check on the aggregate array size. We just include
* a small unreachable expression to make sure the structs
* pointed to do have a simple sanitize(), ie. they do not
* reference other structs via offsets.
2010-04-21 06:49:40 +02:00
*/
2018-05-09 01:56:11 +02:00
(void) (false && arrayZ[0].sanitize (c));
return_trace (true);
2009-08-04 06:58:28 +02:00
}
private:
inline bool sanitize_shallow (hb_sanitize_context_t *c) const
{
TRACE_SANITIZE (this);
return_trace (lenP1.sanitize (c) &&
(!lenP1 || c->check_array (arrayZ, lenP1 - 1)));
}
public:
LenType lenP1;
2018-09-10 23:29:26 +02:00
Type arrayZ[VAR];
2010-05-11 00:08:46 +02:00
public:
2018-05-09 01:56:11 +02:00
DEFINE_SIZE_ARRAY (sizeof (LenType), arrayZ);
2009-05-17 06:54:25 +02:00
};
/* An array storing length-1. */
template <typename Type, typename LenType=HBUINT16>
struct ArrayOfM1
{
2018-10-30 00:00:23 +01:00
HB_NO_CREATE_COPY_ASSIGN_TEMPLATE2 (ArrayOfM1, Type, LenType);
inline const Type& operator [] (unsigned int i) const
{
if (unlikely (i > lenM1)) return Null(Type);
return arrayZ[i];
}
inline Type& operator [] (unsigned int i)
{
if (unlikely (i > lenM1)) return Crap(Type);
return arrayZ[i];
}
inline unsigned int get_size (void) const
{ return lenM1.static_size + (lenM1 + 1) * Type::static_size; }
template <typename T>
inline bool sanitize (hb_sanitize_context_t *c, const void *base, T user_data) const
{
TRACE_SANITIZE (this);
if (unlikely (!sanitize_shallow (c))) return_trace (false);
unsigned int count = lenM1 + 1;
for (unsigned int i = 0; i < count; i++)
if (unlikely (!arrayZ[i].sanitize (c, base, user_data)))
return_trace (false);
return_trace (true);
}
private:
inline bool sanitize_shallow (hb_sanitize_context_t *c) const
{
TRACE_SANITIZE (this);
return_trace (lenM1.sanitize (c) &&
(c->check_array (arrayZ, lenM1 + 1)));
}
public:
LenType lenM1;
Type arrayZ[VAR];
public:
DEFINE_SIZE_ARRAY (sizeof (LenType), arrayZ);
};
/* An array with sorted elements. Supports binary searching. */
template <typename Type, typename LenType=HBUINT16>
struct SortedArrayOf : ArrayOf<Type, LenType>
2014-05-09 00:21:04 +02:00
{
2010-07-08 06:40:04 +02:00
template <typename SearchType>
inline int bsearch (const SearchType &x) const
{
/* Hand-coded bsearch here since this is in the hot inner loop. */
2018-05-09 01:56:11 +02:00
const Type *arr = this->arrayZ;
int min = 0, max = (int) this->len - 1;
while (min <= max)
{
int mid = ((unsigned int) min + (unsigned int) max) / 2;
2018-01-11 18:19:42 +01:00
int c = arr[mid].cmp (x);
if (c < 0)
max = mid - 1;
else if (c > 0)
min = mid + 1;
else
return mid;
}
return -1;
2010-07-08 06:40:04 +02:00
}
};
2018-10-08 04:28:45 +02:00
/*
* Binary-search arrays
*/
2018-10-08 04:30:42 +02:00
template <typename LenType=HBUINT16>
2017-11-01 03:05:37 +01:00
struct BinSearchHeader
{
inline operator uint32_t (void) const { return len; }
inline bool sanitize (hb_sanitize_context_t *c) const
{
TRACE_SANITIZE (this);
return_trace (c->check_struct (this));
}
2018-02-08 04:13:10 +01:00
inline void set (unsigned int v)
{
len.set (v);
assert (len == v);
entrySelector.set (MAX (1u, hb_bit_storage (v)) - 1);
searchRange.set (16 * (1u << entrySelector));
rangeShift.set (v * 16 > searchRange
? 16 * v - searchRange
: 0);
2018-02-08 04:13:10 +01:00
}
2017-11-01 03:05:37 +01:00
protected:
2018-10-08 04:30:42 +02:00
LenType len;
LenType searchRange;
LenType entrySelector;
LenType rangeShift;
2017-11-01 03:05:37 +01:00
public:
DEFINE_SIZE_STATIC (8);
};
2018-10-08 04:30:42 +02:00
template <typename Type, typename LenType=HBUINT16>
struct BinSearchArrayOf : SortedArrayOf<Type, BinSearchHeader<LenType> > {};
2017-11-01 03:05:37 +01:00
2018-10-08 04:28:45 +02:00
struct VarSizedBinSearchHeader
{
inline bool sanitize (hb_sanitize_context_t *c) const
{
TRACE_SANITIZE (this);
return_trace (c->check_struct (this));
}
HBUINT16 unitSize; /* Size of a lookup unit for this search in bytes. */
HBUINT16 nUnits; /* Number of units of the preceding size to be searched. */
HBUINT16 searchRange; /* The value of unitSize times the largest power of 2
* that is less than or equal to the value of nUnits. */
HBUINT16 entrySelector; /* The log base 2 of the largest power of 2 less than
* or equal to the value of nUnits. */
HBUINT16 rangeShift; /* The value of unitSize times the difference of the
* value of nUnits minus the largest power of 2 less
* than or equal to the value of nUnits. */
public:
DEFINE_SIZE_STATIC (10);
};
template <typename Type>
struct VarSizedBinSearchArrayOf
{
2018-10-30 00:00:23 +01:00
HB_NO_CREATE_COPY_ASSIGN_TEMPLATE (VarSizedBinSearchArrayOf, Type);
2018-10-08 04:28:45 +02:00
inline const Type& operator [] (unsigned int i) const
{
if (unlikely (i >= header.nUnits)) return Null(Type);
return StructAtOffset<Type> (&bytesZ, i * header.unitSize);
}
inline Type& operator [] (unsigned int i)
{
return StructAtOffset<Type> (&bytesZ, i * header.unitSize);
}
inline unsigned int get_size (void) const
{ return header.static_size + header.nUnits * header.unitSize; }
inline bool sanitize (hb_sanitize_context_t *c) const
{
TRACE_SANITIZE (this);
if (unlikely (!sanitize_shallow (c))) return_trace (false);
/* Note: for structs that do not reference other structs,
* we do not need to call their sanitize() as we already did
* a bound check on the aggregate array size. We just include
* a small unreachable expression to make sure the structs
* pointed to do have a simple sanitize(), ie. they do not
* reference other structs via offsets.
*/
(void) (false && StructAtOffset<Type> (&bytesZ, 0).sanitize (c));
return_trace (true);
}
inline bool sanitize (hb_sanitize_context_t *c, const void *base) const
{
TRACE_SANITIZE (this);
if (unlikely (!sanitize_shallow (c))) return_trace (false);
unsigned int count = header.nUnits;
for (unsigned int i = 0; i < count; i++)
if (unlikely (!(*this)[i].sanitize (c, base)))
return_trace (false);
return_trace (true);
}
template <typename T>
inline const Type *bsearch (const T &key) const
{
unsigned int size = header.unitSize;
int min = 0, max = (int) header.nUnits - 1;
while (min <= max)
{
int mid = ((unsigned int) min + (unsigned int) max) / 2;
2018-10-08 04:28:45 +02:00
const Type *p = (const Type *) (((const char *) &bytesZ) + (mid * size));
int c = p->cmp (key);
if (c < 0)
max = mid - 1;
else if (c > 0)
min = mid + 1;
else
return p;
}
return nullptr;
}
private:
inline bool sanitize_shallow (hb_sanitize_context_t *c) const
{
TRACE_SANITIZE (this);
return_trace (header.sanitize (c) &&
Type::static_size <= header.unitSize &&
2018-10-08 04:28:45 +02:00
c->check_array (bytesZ.arrayZ, header.nUnits, header.unitSize));
}
protected:
VarSizedBinSearchHeader header;
UnsizedArrayOf<HBUINT8> bytesZ;
public:
DEFINE_SIZE_ARRAY (10, bytesZ);
};
2010-07-08 06:40:04 +02:00
2012-11-17 03:49:54 +01:00
} /* namespace OT */
2010-07-23 21:11:18 +02:00
#endif /* HB_OPEN_TYPE_HH */