1/*
2 * Copyright © 2011,2012  Google, 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 * Google Author(s): Behdad Esfahbod
25 */
26
27#ifndef HB_OT_HHEA_TABLE_HH
28#define HB_OT_HHEA_TABLE_HH
29
30#include "hb-open-type-private.hh"
31
32
33namespace OT {
34
35
36/*
37 * hhea -- The Horizontal Header Table
38 * vhea -- The Vertical Header Table
39 */
40
41#define HB_OT_TAG_hhea HB_TAG('h','h','e','a')
42#define HB_OT_TAG_vhea HB_TAG('v','h','e','a')
43
44
45struct _hea
46{
47  static const hb_tag_t tableTag = HB_TAG('_','h','e','a');
48
49  static const hb_tag_t hheaTag	= HB_OT_TAG_hhea;
50  static const hb_tag_t vheaTag	= HB_OT_TAG_vhea;
51
52  inline bool sanitize (hb_sanitize_context_t *c) {
53    TRACE_SANITIZE (this);
54    return TRACE_RETURN (c->check_struct (this) && likely (version.major == 1));
55  }
56
57  public:
58  FixedVersion	version;		/* 0x00010000u for version 1.0. */
59  FWORD		ascender;		/* Typographic ascent. */
60  FWORD		descender;		/* Typographic descent. */
61  FWORD		lineGap;		/* Typographic line gap. */
62  UFWORD	advanceMax;		/* Maximum advance width/height value in
63					 * metrics table. */
64  FWORD		minLeadingBearing;	/* Minimum left/top sidebearing value in
65					 * metrics table. */
66  FWORD		minTrailingBearing;	/* Minimum right/bottom sidebearing value;
67					 * calculated as Min(aw - lsb -
68					 * (xMax - xMin)) for horizontal. */
69  FWORD		maxExtent;		/* horizontal: Max(lsb + (xMax - xMin)),
70					 * vertical: minLeadingBearing+(yMax-yMin). */
71  SHORT		caretSlopeRise;		/* Used to calculate the slope of the
72					 * cursor (rise/run); 1 for vertical caret,
73					 * 0 for horizontal.*/
74  SHORT		caretSlopeRun;		/* 0 for vertical caret, 1 for horizontal. */
75  SHORT		caretOffset;		/* The amount by which a slanted
76					 * highlight on a glyph needs
77					 * to be shifted to produce the
78					 * best appearance. Set to 0 for
79					 * non-slanted fonts. */
80  SHORT		reserved1;		/* Set to 0. */
81  SHORT		reserved2;		/* Set to 0. */
82  SHORT		reserved3;		/* Set to 0. */
83  SHORT		reserved4;		/* Set to 0. */
84  SHORT		metricDataFormat;	/* 0 for current format. */
85  USHORT	numberOfLongMetrics;	/* Number of LongMetric entries in metric
86					 * table. */
87  public:
88  DEFINE_SIZE_STATIC (36);
89};
90
91struct hhea : _hea {
92  static const hb_tag_t tableTag	= HB_OT_TAG_hhea;
93};
94struct vhea : _hea {
95  static const hb_tag_t tableTag	= HB_OT_TAG_vhea;
96};
97
98
99} /* namespace OT */
100
101
102#endif /* HB_OT_HHEA_TABLE_HH */
103