Source/WebCore/platform/graphics/FontMetrics.h

   1 /*
   2  * Copyright (C) Research In Motion Limited 2010-2011. All rights reserved.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public License
  15  * along with this library; see the file COPYING.LIB.  If not, write to
  16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef FontMetrics_h
  21 #define FontMetrics_h
  22
  23 #include "FontBaseline.h"
  24 #include <wtf/MathExtras.h>
  25
  26 namespace WebCore {
  27
  28 const unsigned gDefaultUnitsPerEm = 1000;
  29
  30 class FontMetrics {
  31 public:
  32     FontMetrics()
  33         : m_unitsPerEm(gDefaultUnitsPerEm)
  34         , m_ascent(0)
  35         , m_descent(0)
  36         , m_lineGap(0)
  37         , m_lineSpacing(0)
  38         , m_xHeight(0)
  39         , m_hasXHeight(false)
  40     {
  41     }
  42
  43     unsigned unitsPerEm() const { return m_unitsPerEm; }
  44     void setUnitsPerEm(unsigned unitsPerEm) { m_unitsPerEm = unitsPerEm; }
  45
  46     float floatAscent(FontBaseline baselineType = AlphabeticBaseline) const
  47     {
  48         if (baselineType == AlphabeticBaseline)
  49             return m_ascent;
  50         return floatHeight() / 2;
  51     }
  52
  53     void setAscent(float ascent) { m_ascent = ascent; }
  54
  55     float floatDescent(FontBaseline baselineType = AlphabeticBaseline) const
  56     {
  57         if (baselineType == AlphabeticBaseline)
  58             return m_descent;
  59         return floatHeight() / 2;
  60     }
  61
  62     void setDescent(float descent) { m_descent = descent; }
  63
  64     float floatHeight(FontBaseline baselineType = AlphabeticBaseline) const
  65     {
  66         return floatAscent(baselineType) + floatDescent(baselineType);
  67     }
  68
  69     float floatLineGap() const { return m_lineGap; }
  70     void setLineGap(float lineGap) { m_lineGap = lineGap; }
  71
  72     float floatLineSpacing() const { return m_lineSpacing; }
  73     void setLineSpacing(float lineSpacing) { m_lineSpacing = lineSpacing; }
  74
  75     float xHeight() const { return m_xHeight; }
  76     void setXHeight(float xHeight)
  77     {
  78         m_xHeight = xHeight;
  79         m_hasXHeight = true;
  80     }
  81
  82     bool hasXHeight() const { return m_hasXHeight && m_xHeight > 0; }
  83     void setHasXHeight(bool hasXHeight) { m_hasXHeight = hasXHeight; }
  84
  85     // Integer variants of certain metrics, used for HTML rendering.
  86     int ascent(FontBaseline baselineType = AlphabeticBaseline) const
  87     {
  88         if (baselineType == AlphabeticBaseline)
  89             return lroundf(m_ascent);
  90         return height() - height() / 2;
  91     }
  92
  93     int descent(FontBaseline baselineType = AlphabeticBaseline) const
  94     {
  95         if (baselineType == AlphabeticBaseline)
  96             return lroundf(m_descent);
  97         return height() / 2;
  98     }
  99
 100     int height(FontBaseline baselineType = AlphabeticBaseline) const
 101     {
 102         return ascent(baselineType) + descent(baselineType);
 103     }
 104
 105     int lineGap() const { return lroundf(m_lineGap); }
 106     int lineSpacing() const { return lroundf(m_lineSpacing); }
 107
 108     bool hasIdenticalAscentDescentAndLineGap(const FontMetrics& other) const
 109     {
 110         return ascent() == other.ascent() && descent() == other.descent() && lineGap() == other.lineGap();
 111     }
 112
 113 private:
 114     friend class SimpleFontData;
 115
 116     void reset()
 117     {
 118         m_unitsPerEm = gDefaultUnitsPerEm;
 119         m_ascent = 0;
 120         m_descent = 0;
 121         m_lineGap = 0;
 122         m_lineSpacing = 0;
 123         m_xHeight = 0;
 124         m_hasXHeight = false;
 125     }
 126
 127     unsigned m_unitsPerEm;
 128     float m_ascent;
 129     float m_descent;
 130     float m_lineGap;
 131     float m_lineSpacing;
 132     float m_xHeight;
 133     bool m_hasXHeight;
 134 };
 135
 136 static inline float scaleEmToUnits(float x, unsigned unitsPerEm)
 137 {
 138     return unitsPerEm ? x / unitsPerEm : x;
 139 }
 140
 141 } // namespace WebCore
 142
 143 #endif // FontMetrics_h