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_HMTX_TABLE_HH
28#define HB_OT_HMTX_TABLE_HH
29
30#include "hb-open-type-private.hh"
31
32
33namespace OT {
34
35
36/*
37 * hmtx -- The Horizontal Metrics Table
38 */
39
40#define HB_OT_TAG_hmtx HB_TAG('h','m','t','x')
41
42
43struct LongHorMetric
44{
45  USHORT	advanceWidth;
46  SHORT		lsb;
47  public:
48  DEFINE_SIZE_STATIC (4);
49};
50
51struct hmtx
52{
53  static const hb_tag_t tableTag	= HB_OT_TAG_hmtx;
54
55  inline bool sanitize (hb_sanitize_context_t *c) {
56    TRACE_SANITIZE (this);
57    /* We don't check for anything specific here.  The users of the
58     * struct do all the hard work... */
59    return TRACE_RETURN (true);
60  }
61
62  public:
63  LongHorMetric	longHorMetric[VAR];	/* Paired advance width and left side
64					 * bearing values for each glyph. The
65					 * value numOfHMetrics comes from
66					 * the 'hhea' table. If the font is
67					 * monospaced, only one entry need
68					 * be in the array, but that entry is
69					 * required. The last entry applies to
70					 * all subsequent glyphs. */
71  SHORT		leftSideBearingX[VAR];	/* Here the advanceWidth is assumed
72					 * to be the same as the advanceWidth
73					 * for the last entry above. The
74					 * number of entries in this array is
75					 * derived from numGlyphs (from 'maxp'
76					 * table) minus numberOfHMetrics. This
77					 * generally is used with a run of
78					 * monospaced glyphs (e.g., Kanji
79					 * fonts or Courier fonts). Only one
80					 * run is allowed and it must be at
81					 * the end. This allows a monospaced
82					 * font to vary the left side bearing
83					 * values for each glyph. */
84  public:
85  DEFINE_SIZE_ARRAY2 (0, longHorMetric, leftSideBearingX);
86};
87
88
89} /* namespace OT */
90
91
92#endif /* HB_OT_HMTX_TABLE_HH */
93