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