src/hb-ot-head-table.hh

   1 /*
   2  * Copyright © 2010  Red Hat, Inc.
   3  * Copyright © 2012  Google, Inc.
   4  *
   5  *  This is part of HarfBuzz, a text shaping library.
   6  *
   7  * Permission is hereby granted, without written agreement and without
   8  * license or royalty fees, to use, copy, modify, and distribute this
   9  * software and its documentation for any purpose, provided that the
  10  * above copyright notice and the following two paragraphs appear in
  11  * all copies of this software.
  12  *
  13  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  15  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  16  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  17  * DAMAGE.
  18  *
  19  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  20  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  21  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  22  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  23  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  24  *
  25  * Red Hat Author(s): Behdad Esfahbod
  26  * Google Author(s): Behdad Esfahbod
  27  */
  28
  29 #ifndef HB_OT_HEAD_TABLE_HH
  30 #define HB_OT_HEAD_TABLE_HH
  31
  32 #include "hb-open-type.hh"
  33
  34 /*
  35  * head -- Font Header
  36  * https://docs.microsoft.com/en-us/typography/opentype/spec/head
  37  */
  38 #define HB_OT_TAG_head HB_TAG('h','e','a','d')
  39
  40
  41 namespace OT {
  42
  43
  44 struct head
  45 {
  46   friend struct OffsetTable;
  47
  48   static constexpr hb_tag_t tableTag = HB_OT_TAG_head;
  49
  50   unsigned int get_upem () const
  51   {
  52     unsigned int upem = unitsPerEm;
  53     /* If no valid head table found, assume 1000, which matches typical Type1 usage. */
  54     return 16 <= upem && upem <= 16384 ? upem : 1000;
  55   }
  56
  57   bool serialize (hb_serialize_context_t *c) const
  58   {
  59     TRACE_SERIALIZE (this);
  60     return_trace ((bool) c->embed (this));
  61   }
  62
  63   bool subset (hb_subset_context_t *c) const
  64   {
  65     TRACE_SUBSET (this);
  66     return_trace (serialize (c->serializer));
  67   }
  68
  69   enum mac_style_flag_t {
  70     BOLD        = 1u<<0,
  71     ITALIC      = 1u<<1,
  72     UNDERLINE   = 1u<<2,
  73     OUTLINE     = 1u<<3,
  74     SHADOW      = 1u<<4,
  75     CONDENSED   = 1u<<5
  76   };
  77
  78   bool is_bold () const      { return macStyle & BOLD; }
  79   bool is_italic () const    { return macStyle & ITALIC; }
  80   bool is_condensed () const { return macStyle & CONDENSED; }
  81
  82   bool sanitize (hb_sanitize_context_t *c) const
  83   {
  84     TRACE_SANITIZE (this);
  85     return_trace (c->check_struct (this) &&
  86                   version.major == 1 &&
  87                   magicNumber == 0x5F0F3CF5u);
  88   }
  89
  90   protected:
  91   FixedVersion<>version;                /* Version of the head table--currently
  92                                          * 0x00010000u for version 1.0. */
  93   FixedVersion<>fontRevision;           /* Set by font manufacturer. */
  94   HBUINT32      checkSumAdjustment;     /* To compute: set it to 0, sum the
  95                                          * entire font as HBUINT32, then store
  96                                          * 0xB1B0AFBAu - sum. */
  97   HBUINT32      magicNumber;            /* Set to 0x5F0F3CF5u. */
  98   HBUINT16      flags;                  /* Bit 0: Baseline for font at y=0;
  99                                          * Bit 1: Left sidebearing point at x=0;
 100                                          * Bit 2: Instructions may depend on point size;
 101                                          * Bit 3: Force ppem to integer values for all
 102                                          *   internal scaler math; may use fractional
 103                                          *   ppem sizes if this bit is clear;
 104                                          * Bit 4: Instructions may alter advance width
 105                                          *   (the advance widths might not scale linearly);
 106                                          * Bits 5-10: These should be set according to
 107                                          *   Apple's specification. However, they are not
 108                                          *   implemented in OpenType.
 109                                          * Bit 5: This bit should be set in fonts that are
 110                                          *   intended to e laid out vertically, and in
 111                                          *   which the glyphs have been drawn such that an
 112                                          *   x-coordinate of 0 corresponds to the desired
 113                                          *   vertical baseline.
 114                                          * Bit 6: This bit must be set to zero.
 115                                          * Bit 7: This bit should be set if the font
 116                                          *   requires layout for correct linguistic
 117                                          *   rendering (e.g. Arabic fonts).
 118                                          * Bit 8: This bit should be set for a GX font
 119                                          *   which has one or more metamorphosis effects
 120                                          *   designated as happening by default.
 121                                          * Bit 9: This bit should be set if the font
 122                                          *   contains any strong right-to-left glyphs.
 123                                          * Bit 10: This bit should be set if the font
 124                                          *   contains Indic-style rearrangement effects.
 125                                          * Bit 11: Font data is 'lossless,' as a result
 126                                          *   of having been compressed and decompressed
 127                                          *   with the Agfa MicroType Express engine.
 128                                          * Bit 12: Font converted (produce compatible metrics)
 129                                          * Bit 13: Font optimized for ClearType™.
 130                                          *   Note, fonts that rely on embedded bitmaps (EBDT)
 131                                          *   for rendering should not be considered optimized
 132                                          *   for ClearType, and therefore should keep this bit
 133                                          *   cleared.
 134                                          * Bit 14: Last Resort font. If set, indicates that
 135                                          * the glyphs encoded in the cmap subtables are simply
 136                                          * generic symbolic representations of code point
 137                                          * ranges and don’t truly represent support for those
 138                                          * code points. If unset, indicates that the glyphs
 139                                          * encoded in the cmap subtables represent proper
 140                                          * support for those code points.
 141                                          * Bit 15: Reserved, set to 0. */
 142   HBUINT16      unitsPerEm;             /* Valid range is from 16 to 16384. This value
 143                                          * should be a power of 2 for fonts that have
 144                                          * TrueType outlines. */
 145   LONGDATETIME  created;                /* Number of seconds since 12:00 midnight,
 146                                            January 1, 1904. 64-bit integer */
 147   LONGDATETIME  modified;               /* Number of seconds since 12:00 midnight,
 148                                            January 1, 1904. 64-bit integer */
 149   HBINT16       xMin;                   /* For all glyph bounding boxes. */
 150   HBINT16       yMin;                   /* For all glyph bounding boxes. */
 151   HBINT16       xMax;                   /* For all glyph bounding boxes. */
 152   HBINT16       yMax;                   /* For all glyph bounding boxes. */
 153   HBUINT16      macStyle;               /* Bit 0: Bold (if set to 1);
 154                                          * Bit 1: Italic (if set to 1)
 155                                          * Bit 2: Underline (if set to 1)
 156                                          * Bit 3: Outline (if set to 1)
 157                                          * Bit 4: Shadow (if set to 1)
 158                                          * Bit 5: Condensed (if set to 1)
 159                                          * Bit 6: Extended (if set to 1)
 160                                          * Bits 7-15: Reserved (set to 0). */
 161   HBUINT16      lowestRecPPEM;          /* Smallest readable size in pixels. */
 162   HBINT16       fontDirectionHint;      /* Deprecated (Set to 2).
 163                                          * 0: Fully mixed directional glyphs;
 164                                          * 1: Only strongly left to right;
 165                                          * 2: Like 1 but also contains neutrals;
 166                                          * -1: Only strongly right to left;
 167                                          * -2: Like -1 but also contains neutrals. */
 168   public:
 169   HBUINT16      indexToLocFormat;       /* 0 for short offsets, 1 for long. */
 170   HBUINT16      glyphDataFormat;        /* 0 for current format. */
 171
 172   DEFINE_SIZE_STATIC (54);
 173 };
 174
 175
 176 } /* namespace OT */
 177
 178
 179 #endif /* HB_OT_HEAD_TABLE_HH */