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