e28cbbc168ce3f80f31922b7f16f87cf3c33fb84
[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 "FontSelectionAlgorithm.h"
30 #include "FontTaggedSettings.h"
31 #include "TextFlags.h"
32 #include "WebKitFontFamilyNames.h"
33 #include <unicode/uscript.h>
34 #include <wtf/MathExtras.h>
35 #include <wtf/RefCountedArray.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     FontSelectionValue italic() const { return m_fontSelectionRequest.slope; }
50     FontSelectionValue stretch() const { return m_fontSelectionRequest.width; }
51     FontSelectionValue weight() const { return m_fontSelectionRequest.weight; }
52     FontSelectionRequest fontSelectionRequest() const { return m_fontSelectionRequest; }
53     int computedPixelSize() const { return int(m_computedSize + 0.5f); }
54     FontRenderingMode renderingMode() const { return static_cast<FontRenderingMode>(m_renderingMode); }
55     TextRenderingMode textRenderingMode() const { return static_cast<TextRenderingMode>(m_textRendering); }
56     UScriptCode script() const { return static_cast<UScriptCode>(m_script); }
57     const AtomicString& locale() const { return m_locale; }
58
59     FontOrientation orientation() const { return static_cast<FontOrientation>(m_orientation); }
60     NonCJKGlyphOrientation nonCJKGlyphOrientation() const { return static_cast<NonCJKGlyphOrientation>(m_nonCJKGlyphOrientation); }
61     FontWidthVariant widthVariant() const { return static_cast<FontWidthVariant>(m_widthVariant); }
62     const FontFeatureSettings& featureSettings() const { return m_featureSettings; }
63     const FontVariationSettings& variationSettings() const { return m_variationSettings; }
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     FontOpticalSizing opticalSizing() const { return static_cast<FontOpticalSizing>(m_opticalSizing); }
99     FontStyleAxis fontStyleAxis() const { return m_fontStyleAxis ? FontStyleAxis::ital : FontStyleAxis::slnt; }
100
101     void setComputedSize(float s) { m_computedSize = clampToFloat(s); }
102     void setItalic(FontSelectionValue italic) { m_fontSelectionRequest.slope = italic; }
103     void setStretch(FontSelectionValue stretch) { m_fontSelectionRequest.width = stretch; }
104     void setIsItalic(bool i) { setItalic(i ? italicValue() : normalItalicValue()); }
105     void setWeight(FontSelectionValue weight) { m_fontSelectionRequest.weight = weight; }
106     void setRenderingMode(FontRenderingMode mode) { m_renderingMode = static_cast<unsigned>(mode); }
107     void setTextRenderingMode(TextRenderingMode rendering) { m_textRendering = rendering; }
108     void setOrientation(FontOrientation orientation) { m_orientation = orientation; }
109     void setNonCJKGlyphOrientation(NonCJKGlyphOrientation orientation) { m_nonCJKGlyphOrientation = static_cast<unsigned>(orientation); }
110     void setWidthVariant(FontWidthVariant widthVariant) { m_widthVariant = widthVariant; } // Make sure new callers of this sync with FontPlatformData::isForTextCombine()!
111     void setLocale(const AtomicString&);
112     void setFeatureSettings(FontFeatureSettings&& settings) { m_featureSettings = WTFMove(settings); }
113 #if ENABLE(VARIATION_FONTS)
114     void setVariationSettings(FontVariationSettings&& settings) { m_variationSettings = WTFMove(settings); }
115 #endif
116     void setFontSynthesis(FontSynthesis fontSynthesis) { m_fontSynthesis = fontSynthesis; }
117     void setVariantCommonLigatures(FontVariantLigatures variant) { m_variantCommonLigatures = static_cast<unsigned>(variant); }
118     void setVariantDiscretionaryLigatures(FontVariantLigatures variant) { m_variantDiscretionaryLigatures = static_cast<unsigned>(variant); }
119     void setVariantHistoricalLigatures(FontVariantLigatures variant) { m_variantHistoricalLigatures = static_cast<unsigned>(variant); }
120     void setVariantContextualAlternates(FontVariantLigatures variant) { m_variantContextualAlternates = static_cast<unsigned>(variant); }
121     void setVariantPosition(FontVariantPosition variant) { m_variantPosition = static_cast<unsigned>(variant); }
122     void setVariantCaps(FontVariantCaps variant) { m_variantCaps = static_cast<unsigned>(variant); }
123     void setVariantNumericFigure(FontVariantNumericFigure variant) { m_variantNumericFigure = static_cast<unsigned>(variant); }
124     void setVariantNumericSpacing(FontVariantNumericSpacing variant) { m_variantNumericSpacing = static_cast<unsigned>(variant); }
125     void setVariantNumericFraction(FontVariantNumericFraction variant) { m_variantNumericFraction = static_cast<unsigned>(variant); }
126     void setVariantNumericOrdinal(FontVariantNumericOrdinal variant) { m_variantNumericOrdinal = static_cast<unsigned>(variant); }
127     void setVariantNumericSlashedZero(FontVariantNumericSlashedZero variant) { m_variantNumericSlashedZero = static_cast<unsigned>(variant); }
128     void setVariantAlternates(FontVariantAlternates variant) { m_variantAlternates = static_cast<unsigned>(variant); }
129     void setVariantEastAsianVariant(FontVariantEastAsianVariant variant) { m_variantEastAsianVariant = static_cast<unsigned>(variant); }
130     void setVariantEastAsianWidth(FontVariantEastAsianWidth variant) { m_variantEastAsianWidth = static_cast<unsigned>(variant); }
131     void setVariantEastAsianRuby(FontVariantEastAsianRuby variant) { m_variantEastAsianRuby = static_cast<unsigned>(variant); }
132     void setOpticalSizing(FontOpticalSizing sizing) { m_opticalSizing = static_cast<unsigned>(sizing); }
133     void setFontStyleAxis(FontStyleAxis axis) { m_fontStyleAxis = axis == FontStyleAxis::ital; }
134
135 private:
136     // FIXME: Investigate moving these into their own object on the heap (to save memory).
137     FontFeatureSettings m_featureSettings;
138     FontVariationSettings m_variationSettings;
139     AtomicString m_locale;
140
141     FontSelectionRequest m_fontSelectionRequest;
142     float m_computedSize { 0 }; // Computed size adjusted for the minimum font size and the zoom factor.
143     unsigned m_orientation : 1; // FontOrientation - Whether the font is rendering on a horizontal line or a vertical line.
144     unsigned m_nonCJKGlyphOrientation : 1; // NonCJKGlyphOrientation - Only used by vertical text. Determines the default orientation for non-ideograph glyphs.
145     unsigned m_widthVariant : 2; // FontWidthVariant
146     unsigned m_renderingMode : 1; // Used to switch between CG and GDI text on Windows.
147     unsigned m_textRendering : 2; // TextRenderingMode
148     unsigned m_script : 7; // Used to help choose an appropriate font for generic font families.
149     unsigned m_fontSynthesis : 3; // FontSynthesis type
150     unsigned m_variantCommonLigatures : 2; // FontVariantLigatures
151     unsigned m_variantDiscretionaryLigatures : 2; // FontVariantLigatures
152     unsigned m_variantHistoricalLigatures : 2; // FontVariantLigatures
153     unsigned m_variantContextualAlternates : 2; // FontVariantLigatures
154     unsigned m_variantPosition : 2; // FontVariantPosition
155     unsigned m_variantCaps : 3; // FontVariantCaps
156     unsigned m_variantNumericFigure : 2; // FontVariantNumericFigure
157     unsigned m_variantNumericSpacing : 2; // FontVariantNumericSpacing
158     unsigned m_variantNumericFraction : 2; // FontVariantNumericFraction
159     unsigned m_variantNumericOrdinal : 1; // FontVariantNumericOrdinal
160     unsigned m_variantNumericSlashedZero : 1; // FontVariantNumericSlashedZero
161     unsigned m_variantAlternates : 1; // FontVariantAlternates
162     unsigned m_variantEastAsianVariant : 3; // FontVariantEastAsianVariant
163     unsigned m_variantEastAsianWidth : 2; // FontVariantEastAsianWidth
164     unsigned m_variantEastAsianRuby : 1; // FontVariantEastAsianRuby
165     unsigned m_opticalSizing : 1; // FontOpticalSizing
166     unsigned m_fontStyleAxis : 1; // Whether "font-style: italic" or "font-style: oblique 20deg" was specified
167 };
168
169 inline bool FontDescription::operator==(const FontDescription& other) const
170 {
171     return m_computedSize == other.m_computedSize
172         && m_fontSelectionRequest == other.m_fontSelectionRequest
173         && m_renderingMode == other.m_renderingMode
174         && m_textRendering == other.m_textRendering
175         && m_orientation == other.m_orientation
176         && m_nonCJKGlyphOrientation == other.m_nonCJKGlyphOrientation
177         && m_widthVariant == other.m_widthVariant
178         && m_locale == other.m_locale
179         && m_featureSettings == other.m_featureSettings
180 #if ENABLE(VARIATION_FONTS)
181         && m_variationSettings == other.m_variationSettings
182 #endif
183         && m_fontSynthesis == other.m_fontSynthesis
184         && m_variantCommonLigatures == other.m_variantCommonLigatures
185         && m_variantDiscretionaryLigatures == other.m_variantDiscretionaryLigatures
186         && m_variantHistoricalLigatures == other.m_variantHistoricalLigatures
187         && m_variantContextualAlternates == other.m_variantContextualAlternates
188         && m_variantPosition == other.m_variantPosition
189         && m_variantCaps == other.m_variantCaps
190         && m_variantNumericFigure == other.m_variantNumericFigure
191         && m_variantNumericSpacing == other.m_variantNumericSpacing
192         && m_variantNumericFraction == other.m_variantNumericFraction
193         && m_variantNumericOrdinal == other.m_variantNumericOrdinal
194         && m_variantNumericSlashedZero == other.m_variantNumericSlashedZero
195         && m_variantAlternates == other.m_variantAlternates
196         && m_variantEastAsianVariant == other.m_variantEastAsianVariant
197         && m_variantEastAsianWidth == other.m_variantEastAsianWidth
198         && m_variantEastAsianRuby == other.m_variantEastAsianRuby
199         && m_opticalSizing == other.m_opticalSizing
200         && m_fontStyleAxis == other.m_fontStyleAxis;
201 }
202
203 // FIXME: Move to a file of its own.
204 class FontCascadeDescription : public FontDescription {
205 public:
206     WEBCORE_EXPORT FontCascadeDescription();
207
208     bool operator==(const FontCascadeDescription&) const;
209     bool operator!=(const FontCascadeDescription& other) const { return !(*this == other); }
210
211     unsigned familyCount() const { return m_families.size(); }
212     const AtomicString& firstFamily() const { return familyAt(0); }
213     const AtomicString& familyAt(unsigned i) const { return m_families[i]; }
214     const RefCountedArray<AtomicString>& families() const { return m_families; }
215
216     float specifiedSize() const { return m_specifiedSize; }
217     bool isAbsoluteSize() const { return m_isAbsoluteSize; }
218     FontSelectionValue lighterWeight() const { return lighterWeight(weight()); }
219     FontSelectionValue bolderWeight() const { return bolderWeight(weight()); }
220     static FontSelectionValue lighterWeight(FontSelectionValue);
221     static FontSelectionValue bolderWeight(FontSelectionValue);
222
223     // only use fixed default size when there is only one font family, and that family is "monospace"
224     bool useFixedDefaultSize() const { return familyCount() == 1 && firstFamily() == monospaceFamily; }
225
226     Kerning kerning() const { return static_cast<Kerning>(m_kerning); }
227     unsigned keywordSize() const { return m_keywordSize; }
228     CSSValueID keywordSizeAsIdentifier() const
229     {
230         CSSValueID identifier = m_keywordSize ? static_cast<CSSValueID>(CSSValueXxSmall + m_keywordSize - 1) : CSSValueInvalid;
231         ASSERT(identifier == CSSValueInvalid || (identifier >= CSSValueXxSmall && identifier <= CSSValueWebkitXxxLarge));
232         return identifier;
233     }
234     FontSmoothingMode fontSmoothing() const { return static_cast<FontSmoothingMode>(m_fontSmoothing); }
235     bool isSpecifiedFont() const { return m_isSpecifiedFont; }
236
237     void setOneFamily(const AtomicString& family) { ASSERT(m_families.size() == 1); m_families[0] = family; }
238     void setFamilies(const Vector<AtomicString>& families) { m_families = RefCountedArray<AtomicString>(families); }
239     void setFamilies(const RefCountedArray<AtomicString>& families) { m_families = families; }
240     void setSpecifiedSize(float s) { m_specifiedSize = clampToFloat(s); }
241     void setIsAbsoluteSize(bool s) { m_isAbsoluteSize = s; }
242     void setKerning(Kerning kerning) { m_kerning = static_cast<unsigned>(kerning); }
243     void setKeywordSize(unsigned size)
244     {
245         ASSERT(size <= 8);
246         m_keywordSize = size;
247         ASSERT(m_keywordSize == size); // Make sure it fits in the bitfield.
248     }
249     void setKeywordSizeFromIdentifier(CSSValueID identifier)
250     {
251         ASSERT(!identifier || (identifier >= CSSValueXxSmall && identifier <= CSSValueWebkitXxxLarge));
252         static_assert(CSSValueWebkitXxxLarge - CSSValueXxSmall + 1 == 8, "Maximum keyword size should be 8.");
253         setKeywordSize(identifier ? identifier - CSSValueXxSmall + 1 : 0);
254     }
255     void setFontSmoothing(FontSmoothingMode smoothing) { m_fontSmoothing = smoothing; }
256     void setIsSpecifiedFont(bool isSpecifiedFont) { m_isSpecifiedFont = isSpecifiedFont; }
257
258 #if ENABLE(TEXT_AUTOSIZING)
259     bool familiesEqualForTextAutoSizing(const FontCascadeDescription& other) const;
260
261     bool equalForTextAutoSizing(const FontCascadeDescription& other) const
262     {
263         return familiesEqualForTextAutoSizing(other)
264             && m_specifiedSize == other.m_specifiedSize
265             && variantSettings() == other.variantSettings()
266             && m_isAbsoluteSize == other.m_isAbsoluteSize;
267     }
268 #endif
269
270     // Initial values for font properties.
271     static FontSelectionValue initialItalic() { return normalItalicValue(); }
272     static FontStyleAxis initialFontStyleAxis() { return FontStyleAxis::slnt; }
273     static FontSelectionValue initialWeight() { return normalWeightValue(); }
274     static FontSelectionValue initialStretch() { return normalStretchValue(); }
275     static FontSmallCaps initialSmallCaps() { return FontSmallCapsOff; }
276     static Kerning initialKerning() { return Kerning::Auto; }
277     static FontSmoothingMode initialFontSmoothing() { return AutoSmoothing; }
278     static TextRenderingMode initialTextRenderingMode() { return AutoTextRendering; }
279     static FontSynthesis initialFontSynthesis() { return FontSynthesisWeight | FontSynthesisStyle | FontSynthesisSmallCaps; }
280     static FontVariantPosition initialVariantPosition() { return FontVariantPosition::Normal; }
281     static FontVariantCaps initialVariantCaps() { return FontVariantCaps::Normal; }
282     static FontVariantAlternates initialVariantAlternates() { return FontVariantAlternates::Normal; }
283     static FontOpticalSizing initialOpticalSizing() { return FontOpticalSizing::Enabled; }
284     static const AtomicString& initialLocale() { return nullAtom; }
285
286 private:
287     RefCountedArray<AtomicString> m_families { 1 };
288
289     float m_specifiedSize { 0 };   // Specified CSS value. Independent of rendering issues such as integer
290                              // rounding, minimum font sizes, and zooming.
291     unsigned m_isAbsoluteSize : 1; // Whether or not CSS specified an explicit size
292                                   // (logical sizes like "medium" don't count).
293     unsigned m_kerning : 2; // Kerning
294
295     unsigned m_keywordSize : 4; // We cache whether or not a font is currently represented by a CSS keyword (e.g., medium).  If so,
296                            // then we can accurately translate across different generic families to adjust for different preference settings
297                            // (e.g., 13px monospace vs. 16px everything else).  Sizes are 1-8 (like the HTML size values for <font>).
298
299     unsigned m_fontSmoothing : 2; // FontSmoothingMode
300     unsigned m_isSpecifiedFont : 1; // True if a web page specifies a non-generic font family as the first font family.
301 };
302
303 inline bool FontCascadeDescription::operator==(const FontCascadeDescription& other) const
304 {
305     return FontDescription::operator==(other)
306         && m_families == other.m_families
307         && m_specifiedSize == other.m_specifiedSize
308         && m_isAbsoluteSize == other.m_isAbsoluteSize
309         && m_kerning == other.m_kerning
310         && m_keywordSize == other.m_keywordSize
311         && m_fontSmoothing == other.m_fontSmoothing
312         && m_isSpecifiedFont == other.m_isSpecifiedFont;
313 }
314
315 }
316
317 #endif