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