2011-06-24 Abhishek Arya <inferno@chromium.org>
[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 "FontOrientation.h"
30 #include "FontRenderingMode.h"
31 #include "FontSmoothingMode.h"
32 #include "FontTraitsMask.h"
33 #include "FontWidthVariant.h"
34 #include "TextOrientation.h"
35 #include "TextRenderingMode.h"
36 #include <wtf/MathExtras.h>
37
38 namespace WebCore {
39
40 enum FontWeight {
41     FontWeight100,
42     FontWeight200,
43     FontWeight300,
44     FontWeight400,
45     FontWeight500,
46     FontWeight600,
47     FontWeight700,
48     FontWeight800,
49     FontWeight900,
50     FontWeightNormal = FontWeight400,
51     FontWeightBold = FontWeight700
52 };
53
54 enum FontItalic {
55     FontItalicOff = 0,
56     FontItalicOn = 1
57 };
58
59 enum FontSmallCaps {
60     FontSmallCapsOff = 0,
61     FontSmallCapsOn = 1
62 };
63
64 class FontDescription {
65 public:
66     enum GenericFamilyType { NoFamily, StandardFamily, SerifFamily, SansSerifFamily, 
67                              MonospaceFamily, CursiveFamily, FantasyFamily };
68
69     FontDescription()
70         : m_specifiedSize(0)
71         , m_computedSize(0)
72         , m_orientation(Horizontal)
73         , m_textOrientation(TextOrientationVerticalRight)
74         , m_widthVariant(RegularWidth)
75         , m_italic(FontItalicOff)
76         , m_smallCaps(FontSmallCapsOff)
77         , m_isAbsoluteSize(false)
78         , m_weight(FontWeightNormal)
79         , m_genericFamily(NoFamily)
80         , m_usePrinterFont(false)
81         , m_renderingMode(NormalRenderingMode)
82         , m_keywordSize(0)
83         , m_fontSmoothing(AutoSmoothing)
84         , m_textRendering(AutoTextRendering)
85         , m_isSpecifiedFont(false)
86     {
87     }
88
89     bool operator==(const FontDescription&) const;
90     bool operator!=(const FontDescription& other) const { return !(*this == other); }
91     
92     const FontFamily& family() const { return m_familyList; }
93     FontFamily& firstFamily() { return m_familyList; }
94     float specifiedSize() const { return m_specifiedSize; }
95     float computedSize() const { return m_computedSize; }
96     FontItalic italic() const { return static_cast<FontItalic>(m_italic); }
97     int computedPixelSize() const { return int(m_computedSize + 0.5f); }
98     FontSmallCaps smallCaps() const { return static_cast<FontSmallCaps>(m_smallCaps); }
99     bool isAbsoluteSize() const { return m_isAbsoluteSize; }
100     FontWeight weight() const { return static_cast<FontWeight>(m_weight); }
101     FontWeight lighterWeight() const;
102     FontWeight bolderWeight() const;
103     GenericFamilyType genericFamily() const { return static_cast<GenericFamilyType>(m_genericFamily); }
104     bool usePrinterFont() const { return m_usePrinterFont; }
105     // only use fixed default size when there is only one font family, and that family is "monospace"
106     bool useFixedDefaultSize() const { return genericFamily() == MonospaceFamily && !family().next() && family().family() == "-webkit-monospace"; }
107     FontRenderingMode renderingMode() const { return static_cast<FontRenderingMode>(m_renderingMode); }
108     unsigned keywordSize() const { return m_keywordSize; }
109     FontSmoothingMode fontSmoothing() const { return static_cast<FontSmoothingMode>(m_fontSmoothing); }
110     TextRenderingMode textRenderingMode() const { return static_cast<TextRenderingMode>(m_textRendering); }
111
112     FontTraitsMask traitsMask() const;
113     bool isSpecifiedFont() const { return m_isSpecifiedFont; }
114     FontOrientation orientation() const { return m_orientation; }
115     TextOrientation textOrientation() const { return m_textOrientation; }
116     FontWidthVariant widthVariant() const { return m_widthVariant; }
117
118     void setFamily(const FontFamily& family) { m_familyList = family; }
119     void setComputedSize(float s) { ASSERT(isfinite(s)); m_computedSize = s; }
120     void setSpecifiedSize(float s) { ASSERT(isfinite(s)); m_specifiedSize = s; }
121     void setItalic(FontItalic i) { m_italic = i; }
122     void setItalic(bool i) { setItalic(i ? FontItalicOn : FontItalicOff); }
123     void setSmallCaps(FontSmallCaps c) { m_smallCaps = c; }
124     void setSmallCaps(bool c) { setSmallCaps(c ? FontSmallCapsOn : FontSmallCapsOff); }
125     void setIsAbsoluteSize(bool s) { m_isAbsoluteSize = s; }
126     void setWeight(FontWeight w) { m_weight = w; }
127     void setGenericFamily(GenericFamilyType genericFamily) { m_genericFamily = genericFamily; }
128 #if PLATFORM(CHROMIUM) && OS(DARWIN)
129     void setUsePrinterFont(bool) { }
130 #else
131     void setUsePrinterFont(bool p) { m_usePrinterFont = p; }
132 #endif
133     void setRenderingMode(FontRenderingMode mode) { m_renderingMode = mode; }
134     void setKeywordSize(unsigned s) { m_keywordSize = s; }
135     void setFontSmoothing(FontSmoothingMode smoothing) { m_fontSmoothing = smoothing; }
136     void setTextRenderingMode(TextRenderingMode rendering) { m_textRendering = rendering; }
137     void setIsSpecifiedFont(bool isSpecifiedFont) { m_isSpecifiedFont = isSpecifiedFont; }
138     void setOrientation(FontOrientation orientation) { m_orientation = orientation; }
139     void setTextOrientation(TextOrientation textOrientation) { m_textOrientation = textOrientation; }
140     void setWidthVariant(FontWidthVariant widthVariant) { m_widthVariant = widthVariant; }
141
142 private:
143     FontFamily m_familyList; // The list of font families to be used.
144
145     float m_specifiedSize;   // Specified CSS value. Independent of rendering issues such as integer
146                              // rounding, minimum font sizes, and zooming.
147     float m_computedSize;    // Computed size adjusted for the minimum font size and the zoom factor.  
148
149     FontOrientation m_orientation; // Whether the font is rendering on a horizontal line or a vertical line.
150     TextOrientation m_textOrientation; // Only used by vertical text. Determines the default orientation for non-ideograph glyphs.
151
152     FontWidthVariant m_widthVariant;
153
154     unsigned m_italic : 1; // FontItalic
155     unsigned m_smallCaps : 1; // FontSmallCaps
156     bool m_isAbsoluteSize : 1;   // Whether or not CSS specified an explicit size
157                                  // (logical sizes like "medium" don't count).
158     unsigned m_weight : 8; // FontWeight
159     unsigned m_genericFamily : 3; // GenericFamilyType
160     bool m_usePrinterFont : 1;
161
162     unsigned m_renderingMode : 1;  // Used to switch between CG and GDI text on Windows.
163
164     unsigned m_keywordSize : 4; // We cache whether or not a font is currently represented by a CSS keyword (e.g., medium).  If so,
165                            // then we can accurately translate across different generic families to adjust for different preference settings
166                            // (e.g., 13px monospace vs. 16px everything else).  Sizes are 1-8 (like the HTML size values for <font>).
167
168     unsigned m_fontSmoothing : 2; // FontSmoothingMode
169     unsigned m_textRendering : 2; // TextRenderingMode
170     bool m_isSpecifiedFont : 1; // True if a web page specifies a non-generic font family as the first font family.
171 };
172
173 inline bool FontDescription::operator==(const FontDescription& other) const
174 {
175     return m_familyList == other.m_familyList
176         && m_specifiedSize == other.m_specifiedSize
177         && m_computedSize == other.m_computedSize
178         && m_italic == other.m_italic
179         && m_smallCaps == other.m_smallCaps
180         && m_isAbsoluteSize == other.m_isAbsoluteSize
181         && m_weight == other.m_weight
182         && m_genericFamily == other.m_genericFamily
183         && m_usePrinterFont == other.m_usePrinterFont
184         && m_renderingMode == other.m_renderingMode
185         && m_keywordSize == other.m_keywordSize
186         && m_fontSmoothing == other.m_fontSmoothing
187         && m_textRendering == other.m_textRendering
188         && m_isSpecifiedFont == other.m_isSpecifiedFont
189         && m_orientation == other.m_orientation
190         && m_textOrientation == other.m_textOrientation
191         && m_widthVariant == other.m_widthVariant;
192 }
193
194 }
195
196 #endif