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