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 
33 namespace 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 
45 struct _hea
46 {
sanitizeOT::_hea47   inline bool sanitize (hb_sanitize_context_t *c) const
48   {
49     TRACE_SANITIZE (this);
50     return_trace (c->check_struct (this) && likely (version.major == 1));
51   }
52 
53   public:
54   FixedVersion<>version;		/* 0x00010000u for version 1.0. */
55   FWORD		ascender;		/* Typographic ascent. */
56   FWORD		descender;		/* Typographic descent. */
57   FWORD		lineGap;		/* Typographic line gap. */
58   UFWORD	advanceMax;		/* Maximum advance width/height value in
59 					 * metrics table. */
60   FWORD		minLeadingBearing;	/* Minimum left/top sidebearing value in
61 					 * metrics table. */
62   FWORD		minTrailingBearing;	/* Minimum right/bottom sidebearing value;
63 					 * calculated as Min(aw - lsb -
64 					 * (xMax - xMin)) for horizontal. */
65   FWORD		maxExtent;		/* horizontal: Max(lsb + (xMax - xMin)),
66 					 * vertical: minLeadingBearing+(yMax-yMin). */
67   INT16		caretSlopeRise;		/* Used to calculate the slope of the
68 					 * cursor (rise/run); 1 for vertical caret,
69 					 * 0 for horizontal.*/
70   INT16		caretSlopeRun;		/* 0 for vertical caret, 1 for horizontal. */
71   INT16		caretOffset;		/* The amount by which a slanted
72 					 * highlight on a glyph needs
73 					 * to be shifted to produce the
74 					 * best appearance. Set to 0 for
75 					 * non-slanted fonts. */
76   INT16		reserved1;		/* Set to 0. */
77   INT16		reserved2;		/* Set to 0. */
78   INT16		reserved3;		/* Set to 0. */
79   INT16		reserved4;		/* Set to 0. */
80   INT16		metricDataFormat;	/* 0 for current format. */
81   UINT16	numberOfLongMetrics;	/* Number of LongMetric entries in metric
82 					 * table. */
83   public:
84   DEFINE_SIZE_STATIC (36);
85 };
86 
87 struct hhea : _hea {
88   static const hb_tag_t tableTag	= HB_OT_TAG_hhea;
89 };
90 struct vhea : _hea {
91   static const hb_tag_t tableTag	= HB_OT_TAG_vhea;
92 };
93 
94 
95 } /* namespace OT */
96 
97 
98 #endif /* HB_OT_HHEA_TABLE_HH */
99