Move locale information into FontDescription
[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, 2013 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 "CSSValueKeywords.h"
29 #include "FontFeatureSettings.h"
30 #include "TextFlags.h"
31 #include "WebKitFontFamilyNames.h"
32 #include <unicode/uscript.h>
33 #include <wtf/MathExtras.h>
34 #include <wtf/RefCountedArray.h>
35 #include <wtf/RefPtr.h>
36
37 namespace WebCore {
38
39 using namespace WebKitFontFamilyNames;
40
41 class FontDescription {
42 public:
43     WEBCORE_EXPORT FontDescription();
44
45     bool operator==(const FontDescription&) const;
46     bool operator!=(const FontDescription& other) const { return !(*this == other); }
47
48     float computedSize() const { return m_computedSize; }
49     FontItalic italic() const { return static_cast<FontItalic>(m_italic); }
50     int computedPixelSize() const { return int(m_computedSize + 0.5f); }
51     FontSmallCaps smallCaps() const { return static_cast<FontSmallCaps>(m_smallCaps); }
52     FontWeight weight() const { return static_cast<FontWeight>(m_weight); }
53     FontWeight lighterWeight() const;
54     FontWeight bolderWeight() const;
55     FontRenderingMode renderingMode() const { return static_cast<FontRenderingMode>(m_renderingMode); }
56     TextRenderingMode textRenderingMode() const { return static_cast<TextRenderingMode>(m_textRendering); }
57     UScriptCode script() const { return static_cast<UScriptCode>(m_script); }
58     const AtomicString& locale() const { return m_locale; }
59
60     FontOrientation orientation() const { return static_cast<FontOrientation>(m_orientation); }
61     NonCJKGlyphOrientation nonCJKGlyphOrientation() const { return static_cast<NonCJKGlyphOrientation>(m_nonCJKGlyphOrientation); }
62     FontWidthVariant widthVariant() const { return static_cast<FontWidthVariant>(m_widthVariant); }
63     const FontFeatureSettings& featureSettings() const { return m_featureSettings; }
64     FontSynthesis fontSynthesis() const { return static_cast<FontSynthesis>(m_fontSynthesis); }
65     FontVariantLigatures variantCommonLigatures() const { return static_cast<FontVariantLigatures>(m_variantCommonLigatures); }
66     FontVariantLigatures variantDiscretionaryLigatures() const { return static_cast<FontVariantLigatures>(m_variantDiscretionaryLigatures); }
67     FontVariantLigatures variantHistoricalLigatures() const { return static_cast<FontVariantLigatures>(m_variantHistoricalLigatures); }
68     FontVariantLigatures variantContextualAlternates() const { return static_cast<FontVariantLigatures>(m_variantContextualAlternates); }
69     FontVariantPosition variantPosition() const { return static_cast<FontVariantPosition>(m_variantPosition); }
70     FontVariantCaps variantCaps() const { return static_cast<FontVariantCaps>(m_variantCaps); }
71     FontVariantNumericFigure variantNumericFigure() const { return static_cast<FontVariantNumericFigure>(m_variantNumericFigure); }
72     FontVariantNumericSpacing variantNumericSpacing() const { return static_cast<FontVariantNumericSpacing>(m_variantNumericSpacing); }
73     FontVariantNumericFraction variantNumericFraction() const { return static_cast<FontVariantNumericFraction>(m_variantNumericFraction); }
74     FontVariantNumericOrdinal variantNumericOrdinal() const { return static_cast<FontVariantNumericOrdinal>(m_variantNumericOrdinal); }
75     FontVariantNumericSlashedZero variantNumericSlashedZero() const { return static_cast<FontVariantNumericSlashedZero>(m_variantNumericSlashedZero); }
76     FontVariantAlternates variantAlternates() const { return static_cast<FontVariantAlternates>(m_variantAlternates); }
77     FontVariantEastAsianVariant variantEastAsianVariant() const { return static_cast<FontVariantEastAsianVariant>(m_variantEastAsianVariant); }
78     FontVariantEastAsianWidth variantEastAsianWidth() const { return static_cast<FontVariantEastAsianWidth>(m_variantEastAsianWidth); }
79     FontVariantEastAsianRuby variantEastAsianRuby() const { return static_cast<FontVariantEastAsianRuby>(m_variantEastAsianRuby); }
80     FontVariantSettings variantSettings() const
81     {
82         return { variantCommonLigatures(),
83             variantDiscretionaryLigatures(),
84             variantHistoricalLigatures(),
85             variantContextualAlternates(),
86             variantPosition(),
87             variantCaps(),
88             variantNumericFigure(),
89             variantNumericSpacing(),
90             variantNumericFraction(),
91             variantNumericOrdinal(),
92             variantNumericSlashedZero(),
93             variantAlternates(),
94             variantEastAsianVariant(),
95             variantEastAsianWidth(),
96             variantEastAsianRuby() };
97     }
98
99     void setComputedSize(float s) { m_computedSize = clampToFloat(s); }
100     void setItalic(FontItalic i) { m_italic = i; }
101     void setIsItalic(bool i) { setItalic(i ? FontItalicOn : FontItalicOff); }
102     void setSmallCaps(FontSmallCaps c) { m_smallCaps = c; }
103     void setIsSmallCaps(bool c) { setSmallCaps(c ? FontSmallCapsOn : FontSmallCapsOff); }
104     void setWeight(FontWeight w) { m_weight = w; }
105     void setRenderingMode(FontRenderingMode mode) { m_renderingMode = static_cast<unsigned>(mode); }
106     void setTextRenderingMode(TextRenderingMode rendering) { m_textRendering = rendering; }
107     void setOrientation(FontOrientation orientation) { m_orientation = orientation; }
108     void setNonCJKGlyphOrientation(NonCJKGlyphOrientation orientation) { m_nonCJKGlyphOrientation = static_cast<unsigned>(orientation); }
109     void setWidthVariant(FontWidthVariant widthVariant) { m_widthVariant = widthVariant; } // Make sure new callers of this sync with FontPlatformData::isForTextCombine()!
110     void setLocale(const AtomicString&);
111     void setFeatureSettings(FontFeatureSettings&& settings) { m_featureSettings = WTF::move(settings); }
112     void setFontSynthesis(FontSynthesis fontSynthesis) { m_fontSynthesis = fontSynthesis; }
113     void setVariantCommonLigatures(FontVariantLigatures variant) { m_variantCommonLigatures = static_cast<unsigned>(variant); }
114     void setVariantDiscretionaryLigatures(FontVariantLigatures variant) { m_variantDiscretionaryLigatures = static_cast<unsigned>(variant); }
115     void setVariantHistoricalLigatures(FontVariantLigatures variant) { m_variantHistoricalLigatures = static_cast<unsigned>(variant); }
116     void setVariantContextualAlternates(FontVariantLigatures variant) { m_variantContextualAlternates = static_cast<unsigned>(variant); }
117     void setVariantPosition(FontVariantPosition variant) { m_variantPosition = static_cast<unsigned>(variant); }
118     void setVariantCaps(FontVariantCaps variant) { m_variantCaps = static_cast<unsigned>(variant); }
119     void setVariantNumericFigure(FontVariantNumericFigure variant) { m_variantNumericFigure = static_cast<unsigned>(variant); }
120     void setVariantNumericSpacing(FontVariantNumericSpacing variant) { m_variantNumericSpacing = static_cast<unsigned>(variant); }
121     void setVariantNumericFraction(FontVariantNumericFraction variant) { m_variantNumericFraction = static_cast<unsigned>(variant); }
122     void setVariantNumericOrdinal(FontVariantNumericOrdinal variant) { m_variantNumericOrdinal = static_cast<unsigned>(variant); }
123     void setVariantNumericSlashedZero(FontVariantNumericSlashedZero variant) { m_variantNumericSlashedZero = static_cast<unsigned>(variant); }
124     void setVariantAlternates(FontVariantAlternates variant) { m_variantAlternates = static_cast<unsigned>(variant); }
125     void setVariantEastAsianVariant(FontVariantEastAsianVariant variant) { m_variantEastAsianVariant = static_cast<unsigned>(variant); }
126     void setVariantEastAsianWidth(FontVariantEastAsianWidth variant) { m_variantEastAsianWidth = static_cast<unsigned>(variant); }
127     void setVariantEastAsianRuby(FontVariantEastAsianRuby variant) { m_variantEastAsianRuby = static_cast<unsigned>(variant); }
128
129     FontTraitsMask traitsMask() const;
130
131 private:
132     FontFeatureSettings m_featureSettings;
133     AtomicString m_locale;
134
135     float m_computedSize { 0 }; // Computed size adjusted for the minimum font size and the zoom factor.
136     unsigned m_orientation : 1; // FontOrientation - Whether the font is rendering on a horizontal line or a vertical line.
137     unsigned m_nonCJKGlyphOrientation : 1; // NonCJKGlyphOrientation - Only used by vertical text. Determines the default orientation for non-ideograph glyphs.
138     unsigned m_widthVariant : 2; // FontWidthVariant
139     unsigned m_italic : 1; // FontItalic
140     unsigned m_smallCaps : 1; // FontSmallCaps
141     unsigned m_weight : 8; // FontWeight
142     unsigned m_renderingMode : 1; // Used to switch between CG and GDI text on Windows.
143     unsigned m_textRendering : 2; // TextRenderingMode
144     unsigned m_script : 7; // Used to help choose an appropriate font for generic font families.
145     unsigned m_fontSynthesis : 2; // FontSynthesis type
146     unsigned m_variantCommonLigatures : 2; // FontVariantLigatures
147     unsigned m_variantDiscretionaryLigatures : 2; // FontVariantLigatures
148     unsigned m_variantHistoricalLigatures : 2; // FontVariantLigatures
149     unsigned m_variantContextualAlternates : 2; // FontVariantLigatures
150     unsigned m_variantPosition : 2; // FontVariantPosition
151     unsigned m_variantCaps : 3; // FontVariantCaps
152     unsigned m_variantNumericFigure : 2; // FontVariantNumericFigure
153     unsigned m_variantNumericSpacing : 2; // FontVariantNumericSpacing
154     unsigned m_variantNumericFraction : 2; // FontVariantNumericFraction
155     unsigned m_variantNumericOrdinal : 1; // FontVariantNumericOrdinal
156     unsigned m_variantNumericSlashedZero : 1; // FontVariantNumericSlashedZero
157     unsigned m_variantAlternates : 1; // FontVariantAlternates
158     unsigned m_variantEastAsianVariant : 3; // FontVariantEastAsianVariant
159     unsigned m_variantEastAsianWidth : 2; // FontVariantEastAsianWidth
160     unsigned m_variantEastAsianRuby : 1; // FontVariantEastAsianRuby
161 };
162
163 inline bool FontDescription::operator==(const FontDescription& other) const
164 {
165     return m_computedSize == other.m_computedSize
166         && m_italic == other.m_italic
167         && m_smallCaps == other.m_smallCaps
168         && m_weight == other.m_weight
169         && m_renderingMode == other.m_renderingMode
170         && m_textRendering == other.m_textRendering
171         && m_orientation == other.m_orientation
172         && m_nonCJKGlyphOrientation == other.m_nonCJKGlyphOrientation
173         && m_widthVariant == other.m_widthVariant
174         && m_locale == other.m_locale
175         && m_featureSettings == other.m_featureSettings
176         && m_fontSynthesis == other.m_fontSynthesis
177         && m_variantCommonLigatures == other.m_variantCommonLigatures
178         && m_variantDiscretionaryLigatures == other.m_variantDiscretionaryLigatures
179         && m_variantHistoricalLigatures == other.m_variantHistoricalLigatures
180         && m_variantContextualAlternates == other.m_variantContextualAlternates
181         && m_variantPosition == other.m_variantPosition
182         && m_variantCaps == other.m_variantCaps
183         && m_variantNumericFigure == other.m_variantNumericFigure
184         && m_variantNumericSpacing == other.m_variantNumericSpacing
185         && m_variantNumericFraction == other.m_variantNumericFraction
186         && m_variantNumericOrdinal == other.m_variantNumericOrdinal
187         && m_variantNumericSlashedZero == other.m_variantNumericSlashedZero
188         && m_variantAlternates == other.m_variantAlternates
189         && m_variantEastAsianVariant == other.m_variantEastAsianVariant
190         && m_variantEastAsianWidth == other.m_variantEastAsianWidth
191         && m_variantEastAsianRuby == other.m_variantEastAsianRuby;
192 }
193
194 // FIXME: Move to a file of its own.
195 class FontCascadeDescription : public FontDescription {
196 public:
197     FontCascadeDescription();
198
199     bool operator==(const FontCascadeDescription&) const;
200     bool operator!=(const FontCascadeDescription& other) const { return !(*this == other); }
201
202     unsigned familyCount() const { return m_families.size(); }
203     const AtomicString& firstFamily() const { return familyAt(0); }
204     const AtomicString& familyAt(unsigned i) const { return m_families[i]; }
205     const RefCountedArray<AtomicString>& families() const { return m_families; }
206
207     float specifiedSize() const { return m_specifiedSize; }
208     bool isAbsoluteSize() const { return m_isAbsoluteSize; }
209     FontWeight lighterWeight() const;
210     FontWeight bolderWeight() const;
211
212     // only use fixed default size when there is only one font family, and that family is "monospace"
213     bool useFixedDefaultSize() const { return familyCount() == 1 && firstFamily() == monospaceFamily; }
214
215     Kerning kerning() const { return static_cast<Kerning>(m_kerning); }
216     unsigned keywordSize() const { return m_keywordSize; }
217     CSSValueID keywordSizeAsIdentifier() const
218     {
219         CSSValueID identifier = m_keywordSize ? static_cast<CSSValueID>(CSSValueXxSmall + m_keywordSize - 1) : CSSValueInvalid;
220         ASSERT(identifier == CSSValueInvalid || (identifier >= CSSValueXxSmall && identifier <= CSSValueWebkitXxxLarge));
221         return identifier;
222     }
223     FontSmoothingMode fontSmoothing() const { return static_cast<FontSmoothingMode>(m_fontSmoothing); }
224     bool isSpecifiedFont() const { return m_isSpecifiedFont; }
225
226     void setOneFamily(const AtomicString& family) { ASSERT(m_families.size() == 1); m_families[0] = family; }
227     void setFamilies(const Vector<AtomicString>& families) { m_families = RefCountedArray<AtomicString>(families); }
228     void setFamilies(const RefCountedArray<AtomicString>& families) { m_families = families; }
229     void setSpecifiedSize(float s) { m_specifiedSize = clampToFloat(s); }
230     void setIsAbsoluteSize(bool s) { m_isAbsoluteSize = s; }
231     void setKerning(Kerning kerning) { m_kerning = static_cast<unsigned>(kerning); }
232     void setKeywordSize(unsigned size)
233     {
234         ASSERT(size <= 8);
235         m_keywordSize = size;
236         ASSERT(m_keywordSize == size); // Make sure it fits in the bitfield.
237     }
238     void setKeywordSizeFromIdentifier(CSSValueID identifier)
239     {
240         ASSERT(!identifier || (identifier >= CSSValueXxSmall && identifier <= CSSValueWebkitXxxLarge));
241         static_assert(CSSValueWebkitXxxLarge - CSSValueXxSmall + 1 == 8, "Maximum keyword size should be 8.");
242         setKeywordSize(identifier ? identifier - CSSValueXxSmall + 1 : 0);
243     }
244     void setFontSmoothing(FontSmoothingMode smoothing) { m_fontSmoothing = smoothing; }
245     void setIsSpecifiedFont(bool isSpecifiedFont) { m_isSpecifiedFont = isSpecifiedFont; }
246
247 #if ENABLE(IOS_TEXT_AUTOSIZING)
248     bool familiesEqualForTextAutoSizing(const FontCascadeDescription& other) const;
249
250     bool equalForTextAutoSizing(const FontCascadeDescription& other) const
251     {
252         return familiesEqualForTextAutoSizing(other)
253             && m_specifiedSize == other.m_specifiedSize
254             && smallCaps() == other.smallCaps()
255             && m_isAbsoluteSize == other.m_isAbsoluteSize;
256     }
257 #endif
258
259     // Initial values for font properties.
260     static FontItalic initialItalic() { return FontItalicOff; }
261     static FontSmallCaps initialSmallCaps() { return FontSmallCapsOff; }
262     static Kerning initialKerning() { return Kerning::Auto; }
263     static FontSmoothingMode initialFontSmoothing() { return AutoSmoothing; }
264     static TextRenderingMode initialTextRenderingMode() { return AutoTextRendering; }
265     static FontSynthesis initialFontSynthesis() { return FontSynthesisWeight | FontSynthesisStyle; }
266     static FontVariantPosition initialVariantPosition() { return FontVariantPosition::Normal; }
267     static FontVariantCaps initialVariantCaps() { return FontVariantCaps::Normal; }
268     static FontVariantAlternates initialVariantAlternates() { return FontVariantAlternates::Normal; }
269     static const AtomicString& initialLocale() { return nullAtom; }
270
271 private:
272     RefCountedArray<AtomicString> m_families { 1 };
273
274     float m_specifiedSize { 0 };   // Specified CSS value. Independent of rendering issues such as integer
275                              // rounding, minimum font sizes, and zooming.
276     unsigned m_isAbsoluteSize : 1; // Whether or not CSS specified an explicit size
277                                   // (logical sizes like "medium" don't count).
278     unsigned m_kerning : 2; // Kerning
279
280     unsigned m_keywordSize : 4; // We cache whether or not a font is currently represented by a CSS keyword (e.g., medium).  If so,
281                            // then we can accurately translate across different generic families to adjust for different preference settings
282                            // (e.g., 13px monospace vs. 16px everything else).  Sizes are 1-8 (like the HTML size values for <font>).
283
284     unsigned m_fontSmoothing : 2; // FontSmoothingMode
285     unsigned m_isSpecifiedFont : 1; // True if a web page specifies a non-generic font family as the first font family.
286 };
287
288 inline bool FontCascadeDescription::operator==(const FontCascadeDescription& other) const
289 {
290     return FontDescription::operator==(other)
291         && m_families == other.m_families
292         && m_specifiedSize == other.m_specifiedSize
293         && m_isAbsoluteSize == other.m_isAbsoluteSize
294         && m_kerning == other.m_kerning
295         && m_keywordSize == other.m_keywordSize
296         && m_fontSmoothing == other.m_fontSmoothing
297         && m_isSpecifiedFont == other.m_isSpecifiedFont;
298 }
299
300 }
301
302 #endif