src/hb-ot-hmtx-table.hh

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