Update CSSFontSelector's matching algorithm to understand ranges
[WebKit.git] / Source / WebCore / css / CSSFontFace.h
1 /*
2  * Copyright (C) 2007, 2008, 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "CSSFontFaceRule.h"
29 #include "FontSelectionAlgorithm.h"
30 #include "FontTaggedSettings.h"
31 #include "TextFlags.h"
32 #include "Timer.h"
33 #include <memory>
34 #include <wtf/Forward.h>
35 #include <wtf/HashSet.h>
36 #include <wtf/RefCounted.h>
37 #include <wtf/Vector.h>
38 #include <wtf/WeakPtr.h>
39
40 namespace JSC {
41 class ExecState;
42 }
43
44 namespace WebCore {
45
46 class CSSFontFaceSource;
47 class CSSFontSelector;
48 class CSSSegmentedFontFace;
49 class CSSValue;
50 class CSSValueList;
51 class Document;
52 class FontDescription;
53 class Font;
54 class FontFace;
55
56 class CSSFontFace final : public RefCounted<CSSFontFace> {
57 public:
58     static Ref<CSSFontFace> create(CSSFontSelector* fontSelector, StyleRuleFontFace* cssConnection = nullptr, FontFace* wrapper = nullptr, bool isLocalFallback = false)
59     {
60         return adoptRef(*new CSSFontFace(fontSelector, cssConnection, wrapper, isLocalFallback));
61     }
62     virtual ~CSSFontFace();
63
64     // FIXME: These functions don't need to have boolean return values.
65     // Callers only call this with known-valid CSS values.
66     bool setFamilies(CSSValue&);
67     bool setStyle(CSSValue&);
68     bool setWeight(CSSValue&);
69     bool setStretch(CSSValue&);
70     bool setUnicodeRange(CSSValue&);
71     bool setVariantLigatures(CSSValue&);
72     bool setVariantPosition(CSSValue&);
73     bool setVariantCaps(CSSValue&);
74     bool setVariantNumeric(CSSValue&);
75     bool setVariantAlternates(CSSValue&);
76     bool setVariantEastAsian(CSSValue&);
77     void setFeatureSettings(CSSValue&);
78
79     enum class Status;
80     struct UnicodeRange;
81     const CSSValueList* families() const { return m_families.get(); }
82     FontTraitsMask traitsMask() const { return m_traitsMask; }
83     FontSelectionRange stretch() const { return m_stretch; }
84     const Vector<UnicodeRange>& ranges() const { return m_ranges; }
85     const FontFeatureSettings& featureSettings() const { return m_featureSettings; }
86     const FontVariantSettings& variantSettings() const { return m_variantSettings; }
87     void setVariantSettings(const FontVariantSettings& variantSettings) { m_variantSettings = variantSettings; }
88     void setTraitsMask(FontTraitsMask traitsMask) { m_traitsMask = traitsMask; }
89     void setStretch(FontSelectionRange stretch) { m_stretch = stretch; }
90     bool isLocalFallback() const { return m_isLocalFallback; }
91     Status status() const { return m_status; }
92     StyleRuleFontFace* cssConnection() const { return m_cssConnection.get(); }
93     FontSelectionCapabilities fontSelectionCapabilities() const { return fontSelectionCapabilitiesForTraitsMask(m_traitsMask, m_stretch); }
94
95     static std::optional<FontTraitsMask> calculateStyleMask(CSSValue& style);
96     static std::optional<FontTraitsMask> calculateWeightMask(CSSValue& weight);
97     static std::optional<FontSelectionValue> calculateStretch(CSSValue& stretch);
98
99     class Client;
100     void addClient(Client&);
101     void removeClient(Client&);
102
103     bool allSourcesFailed() const;
104
105     void adoptSource(std::unique_ptr<CSSFontFaceSource>&&);
106     void sourcesPopulated() { m_sourcesPopulated = true; }
107
108     void fontLoaded(CSSFontFaceSource&);
109
110     void load();
111     RefPtr<Font> font(const FontDescription&, bool syntheticBold, bool syntheticItalic);
112
113     static void appendSources(CSSFontFace&, CSSValueList&, Document*, bool isInitiatingElementInUserAgentShadowTree);
114
115     class Client {
116     public:
117         virtual ~Client() { }
118         virtual void fontLoaded(CSSFontFace&) { }
119         virtual void fontStateChanged(CSSFontFace&, Status /*oldState*/, Status /*newState*/) { }
120         virtual void fontPropertyChanged(CSSFontFace&, CSSValueList* /*oldFamilies*/ = nullptr) { }
121         virtual void ref() = 0;
122         virtual void deref() = 0;
123     };
124
125     // Pending => Loading  => TimedOut
126     //              ||  \\    //  ||
127     //              ||   \\  //   ||
128     //              ||    \\//    ||
129     //              ||     //     ||
130     //              ||    //\\    ||
131     //              ||   //  \\   ||
132     //              \/  \/    \/  \/
133     //             Success    Failure
134     enum class Status { Pending, Loading, TimedOut, Success, Failure };
135
136     struct UnicodeRange {
137         UChar32 from;
138         UChar32 to;
139     };
140
141     bool rangesMatchCodePoint(UChar32) const;
142
143     // We don't guarantee that the FontFace wrapper will be the same every time you ask for it.
144     Ref<FontFace> wrapper();
145     void setWrapper(FontFace&);
146     FontFace* existingWrapper() { return m_wrapper.get(); }
147
148     bool webFontsShouldAlwaysFallBack() const;
149
150     bool purgeable() const;
151
152     void updateStyleIfNeeded();
153
154 #if ENABLE(SVG_FONTS)
155     bool hasSVGFontFaceSource() const;
156 #endif
157
158 private:
159     CSSFontFace(CSSFontSelector*, StyleRuleFontFace*, FontFace*, bool isLocalFallback);
160
161     size_t pump();
162     void setStatus(Status);
163     void notifyClientsOfFontPropertyChange();
164
165     void initializeWrapper();
166
167     void fontLoadEventOccurred();
168     void timeoutFired();
169
170     RefPtr<CSSValueList> m_families;
171     FontTraitsMask m_traitsMask { static_cast<FontTraitsMask>(FontStyleNormalMask | FontWeight400Mask) };
172     Vector<UnicodeRange> m_ranges;
173     FontFeatureSettings m_featureSettings;
174     FontVariantSettings m_variantSettings;
175     Timer m_timeoutTimer;
176     Vector<std::unique_ptr<CSSFontFaceSource>> m_sources;
177     RefPtr<CSSFontSelector> m_fontSelector;
178     RefPtr<StyleRuleFontFace> m_cssConnection;
179     HashSet<Client*> m_clients;
180     WeakPtr<FontFace> m_wrapper;
181     Status m_status { Status::Pending };
182     FontSelectionRange m_stretch { FontSelectionValue(100), FontSelectionValue(100) };
183     bool m_isLocalFallback { false };
184     bool m_sourcesPopulated { false };
185     bool m_mayBePurged { true };
186 };
187
188 }