1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * This code is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 only, as
6 * published by the Free Software Foundation. Oracle designates this
7 * particular file as subject to the "Classpath" exception as provided
8 * by Oracle in the LICENSE file that accompanied this code.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 */
24
25 // This file is available under and governed by the GNU General Public
26 // License version 2 only, as published by the Free Software Foundation.
27 // However, the following notice accompanied the original version of this
28 // file:
29 //
30 /*
31 * Copyright © 2011,2012 Google, Inc.
32 *
33 * This is part of HarfBuzz, a text shaping library.
34 *
35 * Permission is hereby granted, without written agreement and without
36 * license or royalty fees, to use, copy, modify, and distribute this
37 * software and its documentation for any purpose, provided that the
38 * above copyright notice and the following two paragraphs appear in
39 * all copies of this software.
40 *
41 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
42 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
43 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
44 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
45 * DAMAGE.
46 *
47 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
48 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
49 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
50 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
51 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
52 *
53 * Google Author(s): Behdad Esfahbod
54 */
55
56 #ifndef HB_OT_HMTX_TABLE_HH
57 #define HB_OT_HMTX_TABLE_HH
58
59 #include "hb-open-type-private.hh"
60
61
62 namespace OT {
63
64
65 /*
66 * hmtx -- The Horizontal Metrics Table
67 * vmtx -- The Vertical Metrics Table
68 */
69
70 #define HB_OT_TAG_hmtx HB_TAG('h','m','t','x')
71 #define HB_OT_TAG_vmtx HB_TAG('v','m','t','x')
72
73
74 struct LongMetric
75 {
76 USHORT advance; /* Advance width/height. */
77 SHORT lsb; /* Leading (left/top) side bearing. */
78 public:
79 DEFINE_SIZE_STATIC (4);
80 };
81
82 struct _mtx
83 {
84 static const hb_tag_t tableTag = HB_TAG('_','m','t','x');
85
86 static const hb_tag_t hmtxTag = HB_OT_TAG_hmtx;
87 static const hb_tag_t vmtxTag = HB_OT_TAG_vmtx;
88
89 inline bool sanitize (hb_sanitize_context_t *c) const
90 {
91 TRACE_SANITIZE (this);
92 /* We don't check for anything specific here. The users of the
93 * struct do all the hard work... */
94 return_trace (true);
95 }
96
97 public:
98 LongMetric longMetric[VAR]; /* Paired advance width and leading
99 * bearing values for each glyph. The
100 * value numOfHMetrics comes from
101 * the 'hhea' table. If the font is
102 * monospaced, only one entry need
103 * be in the array, but that entry is
104 * required. The last entry applies to
105 * all subsequent glyphs. */
106 SHORT leadingBearingX[VAR]; /* Here the advance is assumed
107 * to be the same as the advance
108 * for the last entry above. The
109 * number of entries in this array is
110 * derived from numGlyphs (from 'maxp'
111 * table) minus numberOfLongMetrics.
112 * This generally is used with a run
113 * of monospaced glyphs (e.g., Kanji
114 * fonts or Courier fonts). Only one
115 * run is allowed and it must be at
116 * the end. This allows a monospaced
117 * font to vary the side bearing
118 * values for each glyph. */
119 public:
120 DEFINE_SIZE_ARRAY2 (0, longMetric, leadingBearingX);
121 };
122
123 struct hmtx : _mtx {
124 static const hb_tag_t tableTag = HB_OT_TAG_hmtx;
125 };
126 struct vmtx : _mtx {
127 static const hb_tag_t tableTag = HB_OT_TAG_vmtx;
128 };
129
130 } /* namespace OT */
131
132
133 #endif /* HB_OT_HMTX_TABLE_HH */