/src/mozilla-central/gfx/harfbuzz/src/hb-ot-head-table.hh

Source (jump to first uncovered line)
/*
 * Copyright © 2010  Red Hat, Inc.
 * Copyright © 2012  Google, Inc.
 *
 *  This is part of HarfBuzz, a text shaping library.
 *
 * 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
 */

#ifndef HB_OT_HEAD_TABLE_HH
#define HB_OT_HEAD_TABLE_HH

#include "hb-open-type.hh"

/*
 * head -- Font Header
 * https://docs.microsoft.com/en-us/typography/opentype/spec/head
 */
#define HB_OT_TAG_head HB_TAG('h','e','a','d')


namespace OT {


struct head
{
  friend struct OffsetTable;

  static const hb_tag_t tableTag  = HB_OT_TAG_head;

  inline unsigned int get_upem (void) const
  {
    unsigned int upem = unitsPerEm;
    /* If no valid head table found, assume 1000, which matches typical Type1 usage. */
    return 16 <= upem && upem <= 16384 ? upem : 1000;
  }

  inline bool sanitize (hb_sanitize_context_t *c) const
  {
    TRACE_SANITIZE (this);
    return_trace (c->check_struct (this) &&
      version.major == 1 &&
      magicNumber == 0x5F0F3CF5u);
  }

  protected:
  FixedVersion<>version;    /* Version of the head table--currently
           * 0x00010000u for version 1.0. */
  FixedVersion<>fontRevision;   /* Set by font manufacturer. */
  HBUINT32  checkSumAdjustment; /* To compute: set it to 0, sum the
           * entire font as HBUINT32, then store
           * 0xB1B0AFBAu - sum. */
  HBUINT32  magicNumber;    /* Set to 0x5F0F3CF5u. */
  HBUINT16  flags;      /* Bit 0: Baseline for font at y=0;
           * Bit 1: Left sidebearing point at x=0;
           * Bit 2: Instructions may depend on point size;
           * Bit 3: Force ppem to integer values for all
           *   internal scaler math; may use fractional
           *   ppem sizes if this bit is clear;
           * Bit 4: Instructions may alter advance width
           *   (the advance widths might not scale linearly);
           * Bits 5-10: These should be set according to
           *   Apple's specification. However, they are not
           *   implemented in OpenType.
           * Bit 5: This bit should be set in fonts that are
           *   intended to e laid out vertically, and in
           *   which the glyphs have been drawn such that an
           *   x-coordinate of 0 corresponds to the desired
           *   vertical baseline.
           * Bit 6: This bit must be set to zero.
           * Bit 7: This bit should be set if the font
           *   requires layout for correct linguistic
           *   rendering (e.g. Arabic fonts).
           * Bit 8: This bit should be set for a GX font
           *   which has one or more metamorphosis effects
           *   designated as happening by default.
           * Bit 9: This bit should be set if the font
           *   contains any strong right-to-left glyphs.
           * Bit 10: This bit should be set if the font
           *   contains Indic-style rearrangement effects.
           * Bit 11: Font data is 'lossless,' as a result
           *   of having been compressed and decompressed
           *   with the Agfa MicroType Express engine.
           * Bit 12: Font converted (produce compatible metrics)
           * Bit 13: Font optimized for ClearType™.
           *   Note, fonts that rely on embedded bitmaps (EBDT)
           *   for rendering should not be considered optimized
           *   for ClearType, and therefore should keep this bit
           *   cleared.
           * Bit 14: Last Resort font. If set, indicates that
           * the glyphs encoded in the cmap subtables are simply
           * generic symbolic representations of code point
           * ranges and don’t truly represent support for those
           * code points. If unset, indicates that the glyphs
           * encoded in the cmap subtables represent proper
           * support for those code points.
           * Bit 15: Reserved, set to 0. */
  HBUINT16  unitsPerEm;   /* Valid range is from 16 to 16384. This value
           * should be a power of 2 for fonts that have
           * TrueType outlines. */
  LONGDATETIME  created;    /* Number of seconds since 12:00 midnight,
             January 1, 1904. 64-bit integer */
  LONGDATETIME  modified;   /* Number of seconds since 12:00 midnight,
             January 1, 1904. 64-bit integer */
  HBINT16 xMin;     /* For all glyph bounding boxes. */
  HBINT16 yMin;     /* For all glyph bounding boxes. */
  HBINT16 xMax;     /* For all glyph bounding boxes. */
  HBINT16 yMax;     /* For all glyph bounding boxes. */
  HBUINT16  macStyle;   /* Bit 0: Bold (if set to 1);
           * Bit 1: Italic (if set to 1)
           * Bit 2: Underline (if set to 1)
           * Bit 3: Outline (if set to 1)
           * Bit 4: Shadow (if set to 1)
           * Bit 5: Condensed (if set to 1)
           * Bit 6: Extended (if set to 1)
           * Bits 7-15: Reserved (set to 0). */
  HBUINT16  lowestRecPPEM;    /* Smallest readable size in pixels. */
  HBINT16 fontDirectionHint;  /* Deprecated (Set to 2).
           * 0: Fully mixed directional glyphs;
           * 1: Only strongly left to right;
           * 2: Like 1 but also contains neutrals;
           * -1: Only strongly right to left;
           * -2: Like -1 but also contains neutrals. */
  public:
  HBUINT16  indexToLocFormat; /* 0 for short offsets, 1 for long. */
  HBUINT16  glyphDataFormat;  /* 0 for current format. */

  DEFINE_SIZE_STATIC (54);
};


} /* namespace OT */


#endif /* HB_OT_HEAD_TABLE_HH */

Coverage Report

Created: 2018-09-25 14:53

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright © 2010 Red Hat, Inc.
3		* Copyright © 2012 Google, Inc.
4		*
5		* This is part of HarfBuzz, a text shaping library.
6		*
7		* Permission is hereby granted, without written agreement and without
8		* license or royalty fees, to use, copy, modify, and distribute this
9		* software and its documentation for any purpose, provided that the
10		* above copyright notice and the following two paragraphs appear in
11		* all copies of this software.
12		*
13		* IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
14		* DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
15		* ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
16		* IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
17		* DAMAGE.
18		*
19		* THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
20		* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
21		* FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
22		* ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
23		* PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
24		*
25		* Red Hat Author(s): Behdad Esfahbod
26		* Google Author(s): Behdad Esfahbod
27		*/
28
29		#ifndef HB_OT_HEAD_TABLE_HH
30		#define HB_OT_HEAD_TABLE_HH
31
32		#include "hb-open-type.hh"
33
34		/*
35		* head -- Font Header
36		* https://docs.microsoft.com/en-us/typography/opentype/spec/head
37		*/
38	0	#define HB_OT_TAG_head HB_TAG('h','e','a','d')
39
40
41		namespace OT {
42
43
44		struct head
45		{
46		friend struct OffsetTable;
47
48		static const hb_tag_t tableTag = HB_OT_TAG_head;
49
50		inline unsigned int get_upem (void) const
51	0	{
52	0	unsigned int upem = unitsPerEm;
53	0	/* If no valid head table found, assume 1000, which matches typical Type1 usage. */
54	0	return 16 <= upem && upem <= 16384 ? upem : 1000;
55	0	}
56
57		inline bool sanitize (hb_sanitize_context_t *c) const
58	0	{
59	0	TRACE_SANITIZE (this);
60	0	return_trace (c->check_struct (this) &&
61	0	version.major == 1 &&
62	0	magicNumber == 0x5F0F3CF5u);
63	0	}
64
65		protected:
66		FixedVersion<>version; /* Version of the head table--currently
67		* 0x00010000u for version 1.0. */
68		FixedVersion<>fontRevision; /* Set by font manufacturer. */
69		HBUINT32 checkSumAdjustment; /* To compute: set it to 0, sum the
70		* entire font as HBUINT32, then store
71		* 0xB1B0AFBAu - sum. */
72		HBUINT32 magicNumber; /* Set to 0x5F0F3CF5u. */
73		HBUINT16 flags; /* Bit 0: Baseline for font at y=0;
74		* Bit 1: Left sidebearing point at x=0;
75		* Bit 2: Instructions may depend on point size;
76		* Bit 3: Force ppem to integer values for all
77		* internal scaler math; may use fractional
78		* ppem sizes if this bit is clear;
79		* Bit 4: Instructions may alter advance width
80		* (the advance widths might not scale linearly);
81		* Bits 5-10: These should be set according to
82		* Apple's specification. However, they are not
83		* implemented in OpenType.
84		* Bit 5: This bit should be set in fonts that are
85		* intended to e laid out vertically, and in
86		* which the glyphs have been drawn such that an
87		* x-coordinate of 0 corresponds to the desired
88		* vertical baseline.
89		* Bit 6: This bit must be set to zero.
90		* Bit 7: This bit should be set if the font
91		* requires layout for correct linguistic
92		* rendering (e.g. Arabic fonts).
93		* Bit 8: This bit should be set for a GX font
94		* which has one or more metamorphosis effects
95		* designated as happening by default.
96		* Bit 9: This bit should be set if the font
97		* contains any strong right-to-left glyphs.
98		* Bit 10: This bit should be set if the font
99		* contains Indic-style rearrangement effects.
100		* Bit 11: Font data is 'lossless,' as a result
101		* of having been compressed and decompressed
102		* with the Agfa MicroType Express engine.
103		* Bit 12: Font converted (produce compatible metrics)
104		* Bit 13: Font optimized for ClearType™.
105		* Note, fonts that rely on embedded bitmaps (EBDT)
106		* for rendering should not be considered optimized
107		* for ClearType, and therefore should keep this bit
108		* cleared.
109		* Bit 14: Last Resort font. If set, indicates that
110		* the glyphs encoded in the cmap subtables are simply
111		* generic symbolic representations of code point
112		* ranges and don’t truly represent support for those
113		* code points. If unset, indicates that the glyphs
114		* encoded in the cmap subtables represent proper
115		* support for those code points.
116		* Bit 15: Reserved, set to 0. */
117		HBUINT16 unitsPerEm; /* Valid range is from 16 to 16384. This value
118		* should be a power of 2 for fonts that have
119		* TrueType outlines. */
120		LONGDATETIME created; /* Number of seconds since 12:00 midnight,
121		January 1, 1904. 64-bit integer */
122		LONGDATETIME modified; /* Number of seconds since 12:00 midnight,
123		January 1, 1904. 64-bit integer */
124		HBINT16 xMin; /* For all glyph bounding boxes. */
125		HBINT16 yMin; /* For all glyph bounding boxes. */
126		HBINT16 xMax; /* For all glyph bounding boxes. */
127		HBINT16 yMax; /* For all glyph bounding boxes. */
128		HBUINT16 macStyle; /* Bit 0: Bold (if set to 1);
129		* Bit 1: Italic (if set to 1)
130		* Bit 2: Underline (if set to 1)
131		* Bit 3: Outline (if set to 1)
132		* Bit 4: Shadow (if set to 1)
133		* Bit 5: Condensed (if set to 1)
134		* Bit 6: Extended (if set to 1)
135		* Bits 7-15: Reserved (set to 0). */
136		HBUINT16 lowestRecPPEM; /* Smallest readable size in pixels. */
137		HBINT16 fontDirectionHint; /* Deprecated (Set to 2).
138		* 0: Fully mixed directional glyphs;
139		* 1: Only strongly left to right;
140		* 2: Like 1 but also contains neutrals;
141		* -1: Only strongly right to left;
142		* -2: Like -1 but also contains neutrals. */
143		public:
144		HBUINT16 indexToLocFormat; /* 0 for short offsets, 1 for long. */
145		HBUINT16 glyphDataFormat; /* 0 for current format. */
146
147		DEFINE_SIZE_STATIC (54);
148		};
149
150
151		} /* namespace OT */
152
153
154		#endif /* HB_OT_HEAD_TABLE_HH */