51a257b41f6f3b4363b8580337ccfe475e1c2baf
[WebKit-https.git] / Source / WebCore / platform / graphics / FontDescription.h
1 /*
2  * Copyright (C) 2000 Lars Knoll (knoll@kde.org)
3  *           (C) 2000 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
6  * Copyright (C) 2007 Nicholas Shanks <webkit@nickshanks.com>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIother.m_  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USm_
22  *
23  */
24
25 #ifndef FontDescription_h
26 #define FontDescription_h
27
28 #include "FontFamily.h"
29 #include "FontFeatureSettings.h"
30 #include "FontOrientation.h"
31 #include "FontRenderingMode.h"
32 #include "FontSmoothingMode.h"
33 #include "FontTraitsMask.h"
34 #include "FontWidthVariant.h"
35 #include "TextOrientation.h"
36 #include "TextRenderingMode.h"
37 #include "WebKitFontFamilyNames.h"
38 #include <wtf/MathExtras.h>
39
40 #include <wtf/RefPtr.h>
41
42 namespace WebCore {
43
44 using namespace WebKitFontFamilyNames;
45
46 enum FontWeight {
47     FontWeight100,
48     FontWeight200,
49     FontWeight300,
50     FontWeight400,
51     FontWeight500,
52     FontWeight600,
53     FontWeight700,
54     FontWeight800,
55     FontWeight900,
56     FontWeightNormal = FontWeight400,
57     FontWeightBold = FontWeight700
58 };
59
60 enum FontItalic {
61     FontItalicOff = 0,
62     FontItalicOn = 1
63 };
64
65 enum FontSmallCaps {
66     FontSmallCapsOff = 0,
67     FontSmallCapsOn = 1
68 };
69
70 class FontDescription {
71 public:
72     enum GenericFamilyType { NoFamily, StandardFamily, SerifFamily, SansSerifFamily, 
73                              MonospaceFamily, CursiveFamily, FantasyFamily, PictographFamily };
74
75     enum Kerning { AutoKerning, NormalKerning, NoneKerning };
76
77     FontDescription()
78         : m_specifiedSize(0)
79         , m_computedSize(0)
80         , m_orientation(Horizontal)
81         , m_textOrientation(TextOrientationVerticalRight)
82         , m_widthVariant(RegularWidth)
83         , m_italic(FontItalicOff)
84         , m_smallCaps(FontSmallCapsOff)
85         , m_isAbsoluteSize(false)
86         , m_weight(FontWeightNormal)
87         , m_genericFamily(NoFamily)
88         , m_usePrinterFont(false)
89         , m_renderingMode(NormalRenderingMode)
90         , m_kerning(AutoKerning)
91         , m_keywordSize(0)
92         , m_fontSmoothing(AutoSmoothing)
93         , m_textRendering(AutoTextRendering)
94         , m_isSpecifiedFont(false)
95         , m_script(USCRIPT_COMMON)
96     {
97     }
98
99     bool operator==(const FontDescription&) const;
100     bool operator!=(const FontDescription& other) const { return !(*this == other); }
101     
102     const FontFamily& family() const { return m_familyList; }
103     FontFamily& firstFamily() { return m_familyList; }
104     float specifiedSize() const { return m_specifiedSize; }
105     float computedSize() const { return m_computedSize; }
106     FontItalic italic() const { return static_cast<FontItalic>(m_italic); }
107     int computedPixelSize() const { return int(m_computedSize + 0.5f); }
108     FontSmallCaps smallCaps() const { return static_cast<FontSmallCaps>(m_smallCaps); }
109     bool isAbsoluteSize() const { return m_isAbsoluteSize; }
110     FontWeight weight() const { return static_cast<FontWeight>(m_weight); }
111     FontWeight lighterWeight() const;
112     FontWeight bolderWeight() const;
113     GenericFamilyType genericFamily() const { return static_cast<GenericFamilyType>(m_genericFamily); }
114     bool usePrinterFont() const { return m_usePrinterFont; }
115     // only use fixed default size when there is only one font family, and that family is "monospace"
116     bool useFixedDefaultSize() const { return genericFamily() == MonospaceFamily && !family().next() && family().family() == monospaceFamily; }
117     FontRenderingMode renderingMode() const { return static_cast<FontRenderingMode>(m_renderingMode); }
118     Kerning kerning() const { return static_cast<Kerning>(m_kerning); }
119     unsigned keywordSize() const { return m_keywordSize; }
120     FontSmoothingMode fontSmoothing() const { return static_cast<FontSmoothingMode>(m_fontSmoothing); }
121     TextRenderingMode textRenderingMode() const { return static_cast<TextRenderingMode>(m_textRendering); }
122     UScriptCode script() const { return m_script; }
123
124     FontTraitsMask traitsMask() const;
125     bool isSpecifiedFont() const { return m_isSpecifiedFont; }
126     FontOrientation orientation() const { return static_cast<FontOrientation>(m_orientation); }
127     TextOrientation textOrientation() const { return static_cast<TextOrientation>(m_textOrientation); }
128     FontWidthVariant widthVariant() const { return static_cast<FontWidthVariant>(m_widthVariant); }
129     FontFeatureSettings* featureSettings() const { return m_featureSettings.get(); }
130     FontDescription makeNormalFeatureSettings() const;
131
132     void setFamily(const FontFamily& family) { m_familyList = family; }
133     void setComputedSize(float s) { ASSERT(isfinite(s)); m_computedSize = s; }
134     void setSpecifiedSize(float s) { ASSERT(isfinite(s)); m_specifiedSize = s; }
135     void setItalic(FontItalic i) { m_italic = i; }
136     void setItalic(bool i) { setItalic(i ? FontItalicOn : FontItalicOff); }
137     void setSmallCaps(FontSmallCaps c) { m_smallCaps = c; }
138     void setSmallCaps(bool c) { setSmallCaps(c ? FontSmallCapsOn : FontSmallCapsOff); }
139     void setIsAbsoluteSize(bool s) { m_isAbsoluteSize = s; }
140     void setWeight(FontWeight w) { m_weight = w; }
141     void setGenericFamily(GenericFamilyType genericFamily) { m_genericFamily = genericFamily; }
142 #if PLATFORM(CHROMIUM) && OS(DARWIN)
143     void setUsePrinterFont(bool) { }
144 #else
145     void setUsePrinterFont(bool p) { m_usePrinterFont = p; }
146 #endif
147     void setRenderingMode(FontRenderingMode mode) { m_renderingMode = mode; }
148     void setKerning(Kerning kerning) { m_kerning = kerning; }
149     void setKeywordSize(unsigned s) { m_keywordSize = s; }
150     void setFontSmoothing(FontSmoothingMode smoothing) { m_fontSmoothing = smoothing; }
151     void setTextRenderingMode(TextRenderingMode rendering) { m_textRendering = rendering; }
152     void setIsSpecifiedFont(bool isSpecifiedFont) { m_isSpecifiedFont = isSpecifiedFont; }
153     void setOrientation(FontOrientation orientation) { m_orientation = orientation; }
154     void setTextOrientation(TextOrientation textOrientation) { m_textOrientation = textOrientation; }
155     void setWidthVariant(FontWidthVariant widthVariant) { m_widthVariant = widthVariant; }
156     void setScript(UScriptCode s) { m_script = s; }
157     void setFeatureSettings(PassRefPtr<FontFeatureSettings> settings) { m_featureSettings = settings; }
158
159 private:
160     FontFamily m_familyList; // The list of font families to be used.
161     RefPtr<FontFeatureSettings> m_featureSettings;
162
163     float m_specifiedSize;   // Specified CSS value. Independent of rendering issues such as integer
164                              // rounding, minimum font sizes, and zooming.
165     float m_computedSize;    // Computed size adjusted for the minimum font size and the zoom factor.  
166
167     unsigned m_orientation : 1; // FontOrientation - Whether the font is rendering on a horizontal line or a vertical line.
168     unsigned m_textOrientation : 1; // TextOrientation - Only used by vertical text. Determines the default orientation for non-ideograph glyphs.
169
170     unsigned m_widthVariant : 2; // FontWidthVariant
171
172     unsigned m_italic : 1; // FontItalic
173     unsigned m_smallCaps : 1; // FontSmallCaps
174     bool m_isAbsoluteSize : 1;   // Whether or not CSS specified an explicit size
175                                  // (logical sizes like "medium" don't count).
176     unsigned m_weight : 8; // FontWeight
177     unsigned m_genericFamily : 3; // GenericFamilyType
178     bool m_usePrinterFont : 1;
179
180     unsigned m_renderingMode : 1;  // Used to switch between CG and GDI text on Windows.
181     unsigned m_kerning : 2; // Kerning
182
183     unsigned m_keywordSize : 4; // We cache whether or not a font is currently represented by a CSS keyword (e.g., medium).  If so,
184                            // then we can accurately translate across different generic families to adjust for different preference settings
185                            // (e.g., 13px monospace vs. 16px everything else).  Sizes are 1-8 (like the HTML size values for <font>).
186
187     unsigned m_fontSmoothing : 2; // FontSmoothingMode
188     unsigned m_textRendering : 2; // TextRenderingMode
189     bool m_isSpecifiedFont : 1; // True if a web page specifies a non-generic font family as the first font family.
190     UScriptCode m_script; // Used to help choose an appropriate font for generic font families.
191 };
192
193 inline bool FontDescription::operator==(const FontDescription& other) const
194 {
195     return m_familyList == other.m_familyList
196         && m_specifiedSize == other.m_specifiedSize
197         && m_computedSize == other.m_computedSize
198         && m_italic == other.m_italic
199         && m_smallCaps == other.m_smallCaps
200         && m_isAbsoluteSize == other.m_isAbsoluteSize
201         && m_weight == other.m_weight
202         && m_genericFamily == other.m_genericFamily
203         && m_usePrinterFont == other.m_usePrinterFont
204         && m_renderingMode == other.m_renderingMode
205         && m_kerning == other.m_kerning
206         && m_keywordSize == other.m_keywordSize
207         && m_fontSmoothing == other.m_fontSmoothing
208         && m_textRendering == other.m_textRendering
209         && m_isSpecifiedFont == other.m_isSpecifiedFont
210         && m_orientation == other.m_orientation
211         && m_textOrientation == other.m_textOrientation
212         && m_widthVariant == other.m_widthVariant
213         && m_script == other.m_script
214         && m_featureSettings == other.m_featureSettings;
215 }
216
217 }
218
219 #endif