[Font Loading] Split CSSFontSelector into a FontFaceSet implementation and the rest...
[WebKit-https.git] / Source / WebCore / css / CSSFontSelector.cpp
1 /*
2  * Copyright (C) 2007, 2008, 2011, 2013 Apple Inc. All rights reserved.
3  *           (C) 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #include "config.h"
28 #include "CSSFontSelector.h"
29
30 #include "CachedFont.h"
31 #include "CSSFontFace.h"
32 #include "CSSFontFaceRule.h"
33 #include "CSSFontFaceSource.h"
34 #include "CSSFontFamily.h"
35 #include "CSSFontFeatureValue.h"
36 #include "CSSPrimitiveValue.h"
37 #include "CSSPrimitiveValueMappings.h"
38 #include "CSSPropertyNames.h"
39 #include "CSSSegmentedFontFace.h"
40 #include "CSSUnicodeRangeValue.h"
41 #include "CSSValueKeywords.h"
42 #include "CSSValueList.h"
43 #include "CSSValuePool.h"
44 #include "CachedResourceLoader.h"
45 #include "Document.h"
46 #include "Font.h"
47 #include "FontCache.h"
48 #include "FontFaceSet.h"
49 #include "FontVariantBuilder.h"
50 #include "Frame.h"
51 #include "FrameLoader.h"
52 #include "SVGFontFaceElement.h"
53 #include "SVGNames.h"
54 #include "Settings.h"
55 #include "StyleProperties.h"
56 #include "StyleResolver.h"
57 #include "StyleRule.h"
58 #include "WebKitFontFamilyNames.h"
59 #include <wtf/Ref.h>
60 #include <wtf/text/AtomicString.h>
61
62 namespace WebCore {
63
64 static unsigned fontSelectorId;
65
66 CSSFontSelector::CSSFontSelector(Document& document)
67     : m_document(&document)
68     , m_cssFontFaceSet(CSSFontFaceSet::create())
69     , m_beginLoadingTimer(*this, &CSSFontSelector::beginLoadTimerFired)
70     , m_uniqueId(++fontSelectorId)
71     , m_version(0)
72 {
73     // FIXME: An old comment used to say there was no need to hold a reference to m_document
74     // because "we are guaranteed to be destroyed before the document". But there does not
75     // seem to be any such guarantee.
76
77     ASSERT(m_document);
78     FontCache::singleton().addClient(*this);
79     m_cssFontFaceSet->addClient(*this);
80 }
81
82 CSSFontSelector::~CSSFontSelector()
83 {
84     clearDocument();
85     m_cssFontFaceSet->removeClient(*this);
86     FontCache::singleton().removeClient(*this);
87 }
88
89 FontFaceSet& CSSFontSelector::fontFaceSet()
90 {
91     if (!m_fontFaceSet) {
92         ASSERT(m_document);
93         m_fontFaceSet = FontFaceSet::create(*m_document, m_cssFontFaceSet.get());
94     }
95
96     return *m_fontFaceSet;
97 }
98
99 bool CSSFontSelector::isEmpty() const
100 {
101     return !m_cssFontFaceSet->faceCount();
102 }
103
104 void CSSFontSelector::addFontFaceRule(StyleRuleFontFace& fontFaceRule, bool isInitiatingElementInUserAgentShadowTree)
105 {
106     const StyleProperties& style = fontFaceRule.properties();
107     RefPtr<CSSValue> fontFamily = style.getPropertyCSSValue(CSSPropertyFontFamily);
108     RefPtr<CSSValue> fontStyle = style.getPropertyCSSValue(CSSPropertyFontStyle);
109     RefPtr<CSSValue> fontWeight = style.getPropertyCSSValue(CSSPropertyFontWeight);
110     RefPtr<CSSValue> src = style.getPropertyCSSValue(CSSPropertySrc);
111     RefPtr<CSSValue> unicodeRange = style.getPropertyCSSValue(CSSPropertyUnicodeRange);
112     RefPtr<CSSValue> featureSettings = style.getPropertyCSSValue(CSSPropertyFontFeatureSettings);
113     RefPtr<CSSValue> variantLigatures = style.getPropertyCSSValue(CSSPropertyFontVariantLigatures);
114     RefPtr<CSSValue> variantPosition = style.getPropertyCSSValue(CSSPropertyFontVariantPosition);
115     RefPtr<CSSValue> variantCaps = style.getPropertyCSSValue(CSSPropertyFontVariantCaps);
116     RefPtr<CSSValue> variantNumeric = style.getPropertyCSSValue(CSSPropertyFontVariantNumeric);
117     RefPtr<CSSValue> variantAlternates = style.getPropertyCSSValue(CSSPropertyFontVariantAlternates);
118     RefPtr<CSSValue> variantEastAsian = style.getPropertyCSSValue(CSSPropertyFontVariantEastAsian);
119     if (!is<CSSValueList>(fontFamily.get()) || !is<CSSValueList>(src.get()) || (unicodeRange && !is<CSSValueList>(*unicodeRange)))
120         return;
121
122     CSSValueList& familyList = downcast<CSSValueList>(*fontFamily);
123     if (!familyList.length())
124         return;
125
126     if (!fontStyle)
127         fontStyle = CSSValuePool::singleton().createIdentifierValue(CSSValueNormal).ptr();
128
129     if (!fontWeight)
130         fontWeight = CSSValuePool::singleton().createIdentifierValue(CSSValueNormal);
131
132     CSSValueList* rangeList = downcast<CSSValueList>(unicodeRange.get());
133
134     CSSValueList& srcList = downcast<CSSValueList>(*src);
135     if (!srcList.length())
136         return;
137
138     m_creatingFont = true;
139     Ref<CSSFontFace> fontFace = CSSFontFace::create(this, &fontFaceRule);
140
141     if (!fontFace->setFamilies(*fontFamily))
142         return;
143     if (!fontFace->setStyle(*fontStyle))
144         return;
145     if (!fontFace->setWeight(*fontWeight))
146         return;
147     if (rangeList && !fontFace->setUnicodeRange(*rangeList))
148         return;
149     if (variantLigatures && !fontFace->setVariantLigatures(*variantLigatures))
150         return;
151     if (variantPosition && !fontFace->setVariantPosition(*variantPosition))
152         return;
153     if (variantCaps && !fontFace->setVariantCaps(*variantCaps))
154         return;
155     if (variantNumeric && !fontFace->setVariantNumeric(*variantNumeric))
156         return;
157     if (variantAlternates && !fontFace->setVariantAlternates(*variantAlternates))
158         return;
159     if (variantEastAsian && !fontFace->setVariantEastAsian(*variantEastAsian))
160         return;
161     if (featureSettings && !fontFace->setFeatureSettings(*featureSettings))
162         return;
163
164     CSSFontFace::appendSources(fontFace, srcList, m_document, isInitiatingElementInUserAgentShadowTree);
165     if (fontFace->allSourcesFailed())
166         return;
167
168     m_cssFontFaceSet->add(fontFace.get());
169     m_creatingFont = false;
170     ++m_version;
171 }
172
173 void CSSFontSelector::registerForInvalidationCallbacks(FontSelectorClient& client)
174 {
175     m_clients.add(&client);
176 }
177
178 void CSSFontSelector::unregisterForInvalidationCallbacks(FontSelectorClient& client)
179 {
180     m_clients.remove(&client);
181 }
182
183 void CSSFontSelector::dispatchInvalidationCallbacks()
184 {
185     ++m_version;
186
187     Vector<FontSelectorClient*> clients;
188     copyToVector(m_clients, clients);
189     for (size_t i = 0; i < clients.size(); ++i)
190         clients[i]->fontsNeedUpdate(*this);
191 }
192
193 void CSSFontSelector::fontLoaded()
194 {
195     dispatchInvalidationCallbacks();
196 }
197
198 void CSSFontSelector::fontModified()
199 {
200     if (!m_creatingFont)
201         dispatchInvalidationCallbacks();
202 }
203
204 void CSSFontSelector::fontCacheInvalidated()
205 {
206     dispatchInvalidationCallbacks();
207 }
208
209 static const AtomicString& resolveGenericFamily(Document* document, const FontDescription& fontDescription, const AtomicString& familyName)
210 {
211     if (!document || !document->frame())
212         return familyName;
213
214     const Settings& settings = document->frame()->settings();
215
216     UScriptCode script = fontDescription.script();
217     if (familyName == serifFamily)
218         return settings.serifFontFamily(script);
219     if (familyName == sansSerifFamily)
220         return settings.sansSerifFontFamily(script);
221     if (familyName == cursiveFamily)
222         return settings.cursiveFontFamily(script);
223     if (familyName == fantasyFamily)
224         return settings.fantasyFontFamily(script);
225     if (familyName == monospaceFamily)
226         return settings.fixedFontFamily(script);
227     if (familyName == pictographFamily)
228         return settings.pictographFontFamily(script);
229     if (familyName == standardFamily)
230         return settings.standardFontFamily(script);
231
232     return familyName;
233 }
234
235 FontRanges CSSFontSelector::fontRangesForFamily(const FontDescription& fontDescription, const AtomicString& familyName)
236 {
237     // FIXME: The spec (and Firefox) says user specified generic families (sans-serif etc.) should be resolved before the @font-face lookup too.
238     bool resolveGenericFamilyFirst = familyName == standardFamily;
239
240     AtomicString familyForLookup = resolveGenericFamilyFirst ? resolveGenericFamily(m_document, fontDescription, familyName) : familyName;
241     CSSSegmentedFontFace* face = m_cssFontFaceSet->getFontFace(fontDescription.traitsMask(), familyForLookup);
242     if (!face) {
243         if (!resolveGenericFamilyFirst)
244             familyForLookup = resolveGenericFamily(m_document, fontDescription, familyName);
245         return FontRanges(FontCache::singleton().fontForFamily(fontDescription, familyForLookup));
246     }
247
248     return face->fontRanges(fontDescription);
249 }
250
251 void CSSFontSelector::clearDocument()
252 {
253     if (!m_document) {
254         ASSERT(!m_beginLoadingTimer.isActive());
255         ASSERT(m_fontsToBeginLoading.isEmpty());
256         return;
257     }
258
259     m_beginLoadingTimer.stop();
260
261     CachedResourceLoader& cachedResourceLoader = m_document->cachedResourceLoader();
262     for (auto& fontHandle : m_fontsToBeginLoading) {
263         // Balances incrementRequestCount() in beginLoadingFontSoon().
264         cachedResourceLoader.decrementRequestCount(fontHandle.get());
265     }
266     m_fontsToBeginLoading.clear();
267
268     m_document = nullptr;
269
270     // FIXME: This object should outlive the Document.
271     m_cssFontFaceSet->clear();
272     m_clients.clear();
273 }
274
275 void CSSFontSelector::beginLoadingFontSoon(CachedFont* font)
276 {
277     if (!m_document)
278         return;
279
280     m_fontsToBeginLoading.append(font);
281     // Increment the request count now, in order to prevent didFinishLoad from being dispatched
282     // after this font has been requested but before it began loading. Balanced by
283     // decrementRequestCount() in beginLoadTimerFired() and in clearDocument().
284     m_document->cachedResourceLoader().incrementRequestCount(font);
285     m_beginLoadingTimer.startOneShot(0);
286 }
287
288 void CSSFontSelector::beginLoadTimerFired()
289 {
290     Vector<CachedResourceHandle<CachedFont>> fontsToBeginLoading;
291     fontsToBeginLoading.swap(m_fontsToBeginLoading);
292
293     // CSSFontSelector could get deleted via beginLoadIfNeeded() or loadDone() unless protected.
294     Ref<CSSFontSelector> protect(*this);
295
296     CachedResourceLoader& cachedResourceLoader = m_document->cachedResourceLoader();
297     for (auto& fontHandle : fontsToBeginLoading) {
298         fontHandle->beginLoadIfNeeded(cachedResourceLoader);
299         // Balances incrementRequestCount() in beginLoadingFontSoon().
300         cachedResourceLoader.decrementRequestCount(fontHandle.get());
301     }
302     // Ensure that if the request count reaches zero, the frame loader will know about it.
303     cachedResourceLoader.loadDone(nullptr);
304     // New font loads may be triggered by layout after the document load is complete but before we have dispatched
305     // didFinishLoading for the frame. Make sure the delegate is always dispatched by checking explicitly.
306     if (m_document && m_document->frame())
307         m_document->frame()->loader().checkLoadComplete();
308 }
309
310
311 size_t CSSFontSelector::fallbackFontCount()
312 {
313     if (!m_document)
314         return 0;
315
316     if (Settings* settings = m_document->settings())
317         return settings->fontFallbackPrefersPictographs() ? 1 : 0;
318
319     return 0;
320 }
321
322 RefPtr<Font> CSSFontSelector::fallbackFontAt(const FontDescription& fontDescription, size_t index)
323 {
324     ASSERT_UNUSED(index, !index);
325
326     if (!m_document)
327         return nullptr;
328
329     Settings* settings = m_document->settings();
330     if (!settings || !settings->fontFallbackPrefersPictographs())
331         return nullptr;
332
333     return FontCache::singleton().fontForFamily(fontDescription, settings->pictographFontFamily());
334 }
335
336 }