Unreviewed, rolling out r176263 and r176273.
[WebKit-https.git] / 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_zeroWidth(0)
40         , m_hasXHeight(false)
41         , m_hasZeroWidth(false)
42     {
43     }
44
45     unsigned unitsPerEm() const { return m_unitsPerEm; }
46     void setUnitsPerEm(unsigned unitsPerEm) { m_unitsPerEm = unitsPerEm; }
47
48     float floatAscent(FontBaseline baselineType = AlphabeticBaseline) const
49     {
50         if (baselineType == AlphabeticBaseline)
51             return m_ascent;
52         return floatHeight() / 2;
53     }
54
55     void setAscent(float ascent) { m_ascent = ascent; }
56
57     float floatDescent(FontBaseline baselineType = AlphabeticBaseline) const
58     {
59         if (baselineType == AlphabeticBaseline)
60             return m_descent;
61         return floatHeight() / 2;
62     }
63
64     void setDescent(float descent) { m_descent = descent; }
65
66     float floatHeight(FontBaseline baselineType = AlphabeticBaseline) const
67     {
68         return floatAscent(baselineType) + floatDescent(baselineType);
69     }
70
71     float floatLineGap() const { return m_lineGap; }
72     void setLineGap(float lineGap) { m_lineGap = lineGap; }
73
74     float floatLineSpacing() const { return m_lineSpacing; }
75     void setLineSpacing(float lineSpacing) { m_lineSpacing = lineSpacing; }
76
77     float xHeight() const { return m_xHeight; }
78     void setXHeight(float xHeight) 
79     { 
80         m_xHeight = xHeight;
81         m_hasXHeight = true;
82     }
83
84     bool hasXHeight() const { return m_hasXHeight && m_xHeight > 0; }
85     void setHasXHeight(bool hasXHeight) { m_hasXHeight = hasXHeight; }
86     
87     bool hasCapHeight() const { return m_hasCapHeight && m_capHeight > 0; }
88     float floatCapHeight() const { return m_capHeight; }
89     void setCapHeight(float capHeight)
90     { 
91         m_capHeight = capHeight;
92         m_hasCapHeight = true;
93     }
94     
95     // Integer variants of certain metrics, used for HTML rendering.
96     int ascent(FontBaseline baselineType = AlphabeticBaseline) const
97     {
98         if (baselineType == AlphabeticBaseline)
99             return lroundf(m_ascent);
100         return height() - height() / 2;
101     }
102     
103     int descent(FontBaseline baselineType = AlphabeticBaseline) const
104     {
105         if (baselineType == AlphabeticBaseline)
106             return lroundf(m_descent);
107         return height() / 2;
108     }
109
110     int height(FontBaseline baselineType = AlphabeticBaseline) const
111     {
112         return ascent(baselineType) + descent(baselineType);
113     }
114
115     int lineGap() const { return lroundf(m_lineGap); }
116     int lineSpacing() const { return lroundf(m_lineSpacing); }
117     
118     int capHeight() const { return lroundf(m_capHeight); }
119     
120     bool hasIdenticalAscentDescentAndLineGap(const FontMetrics& other) const
121     {
122         return ascent() == other.ascent() && descent() == other.descent() && lineGap() == other.lineGap();
123     }
124
125     float zeroWidth() const { return m_zeroWidth; }
126     void setZeroWidth(float zeroWidth)
127     {
128         m_zeroWidth = zeroWidth;
129         m_hasZeroWidth = true;
130     }
131
132     bool hasZeroWidth() const { return m_hasZeroWidth; }
133     void setHasZeroWidth(bool hasZeroWidth) { m_hasZeroWidth = hasZeroWidth; }
134
135 private:
136     friend class SimpleFontData;
137
138     void reset()
139     {
140         m_unitsPerEm = gDefaultUnitsPerEm;
141         m_ascent = 0;
142         m_descent = 0;
143         m_lineGap = 0;
144         m_lineSpacing = 0;
145         m_xHeight = 0;
146         m_hasXHeight = false;
147     }
148
149     unsigned m_unitsPerEm;
150     float m_ascent;
151     float m_descent;
152     float m_lineGap;
153     float m_lineSpacing;
154     float m_xHeight;
155     float m_capHeight;
156     float m_zeroWidth;
157     bool m_hasXHeight;
158     bool m_hasCapHeight;
159     bool m_hasZeroWidth;
160 };
161
162 static inline float scaleEmToUnits(float x, unsigned unitsPerEm)
163 {
164     return unitsPerEm ? x / unitsPerEm : x;
165 }
166
167 } // namespace WebCore
168
169 #endif // FontMetrics_h