44d84b04d84b73e93b9a18a1210703ab8ec4eb80
[WebKit.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 "FontFace.h"
49 #include "FontFaceSet.h"
50 #include "FontSelectorClient.h"
51 #include "FontVariantBuilder.h"
52 #include "Frame.h"
53 #include "FrameLoader.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     ASSERT(m_document);
74     FontCache::singleton().addClient(*this);
75     m_cssFontFaceSet->addClient(*this);
76 }
77
78 CSSFontSelector::~CSSFontSelector()
79 {
80     clearDocument();
81     m_cssFontFaceSet->removeClient(*this);
82     FontCache::singleton().removeClient(*this);
83 }
84
85 FontFaceSet& CSSFontSelector::fontFaceSet()
86 {
87     if (!m_fontFaceSet) {
88         ASSERT(m_document);
89         m_fontFaceSet = FontFaceSet::create(*m_document, m_cssFontFaceSet.get());
90     }
91
92     return *m_fontFaceSet;
93 }
94
95 bool CSSFontSelector::isEmpty() const
96 {
97     return !m_cssFontFaceSet->faceCount();
98 }
99
100 void CSSFontSelector::buildStarted()
101 {
102     m_buildIsUnderway = true;
103     m_stagingArea.clear();
104     m_cssFontFaceSet->purge();
105     ++m_version;
106
107     m_cssConnectionsPossiblyToRemove.clear();
108     m_cssConnectionsEncounteredDuringBuild.clear();
109     for (size_t i = 0; i < m_cssFontFaceSet->faceCount(); ++i) {
110         CSSFontFace& face = m_cssFontFaceSet.get()[i];
111         if (face.cssConnection())
112             m_cssConnectionsPossiblyToRemove.add(&face);
113     }
114 }
115
116 void CSSFontSelector::buildCompleted()
117 {
118     if (!m_buildIsUnderway)
119         return;
120
121     m_buildIsUnderway = false;
122
123     // Some font faces weren't re-added during the build process.
124     for (auto& face : m_cssConnectionsPossiblyToRemove) {
125         auto* connection = face->cssConnection();
126         ASSERT(connection);
127         if (!m_cssConnectionsEncounteredDuringBuild.contains(connection))
128             m_cssFontFaceSet->remove(*face);
129     }
130
131     for (auto& item : m_stagingArea)
132         addFontFaceRule(item.styleRuleFontFace, item.isInitiatingElementInUserAgentShadowTree);
133     m_stagingArea.clear();
134 }
135
136 void CSSFontSelector::addFontFaceRule(StyleRuleFontFace& fontFaceRule, bool isInitiatingElementInUserAgentShadowTree)
137 {
138     if (m_buildIsUnderway) {
139         m_cssConnectionsEncounteredDuringBuild.add(&fontFaceRule);
140         m_stagingArea.append({fontFaceRule, isInitiatingElementInUserAgentShadowTree});
141         return;
142     }
143
144     const StyleProperties& style = fontFaceRule.properties();
145     RefPtr<CSSValue> fontFamily = style.getPropertyCSSValue(CSSPropertyFontFamily);
146     RefPtr<CSSValue> fontStyle = style.getPropertyCSSValue(CSSPropertyFontStyle);
147     RefPtr<CSSValue> fontWeight = style.getPropertyCSSValue(CSSPropertyFontWeight);
148     RefPtr<CSSValue> src = style.getPropertyCSSValue(CSSPropertySrc);
149     RefPtr<CSSValue> unicodeRange = style.getPropertyCSSValue(CSSPropertyUnicodeRange);
150     RefPtr<CSSValue> featureSettings = style.getPropertyCSSValue(CSSPropertyFontFeatureSettings);
151     RefPtr<CSSValue> variantLigatures = style.getPropertyCSSValue(CSSPropertyFontVariantLigatures);
152     RefPtr<CSSValue> variantPosition = style.getPropertyCSSValue(CSSPropertyFontVariantPosition);
153     RefPtr<CSSValue> variantCaps = style.getPropertyCSSValue(CSSPropertyFontVariantCaps);
154     RefPtr<CSSValue> variantNumeric = style.getPropertyCSSValue(CSSPropertyFontVariantNumeric);
155     RefPtr<CSSValue> variantAlternates = style.getPropertyCSSValue(CSSPropertyFontVariantAlternates);
156     RefPtr<CSSValue> variantEastAsian = style.getPropertyCSSValue(CSSPropertyFontVariantEastAsian);
157     if (!is<CSSValueList>(fontFamily.get()) || !is<CSSValueList>(src.get()) || (unicodeRange && !is<CSSValueList>(*unicodeRange)))
158         return;
159
160     CSSValueList& familyList = downcast<CSSValueList>(*fontFamily);
161     if (!familyList.length())
162         return;
163
164     if (!fontStyle)
165         fontStyle = CSSValuePool::singleton().createIdentifierValue(CSSValueNormal).ptr();
166
167     if (!fontWeight)
168         fontWeight = CSSValuePool::singleton().createIdentifierValue(CSSValueNormal);
169
170     CSSValueList* rangeList = downcast<CSSValueList>(unicodeRange.get());
171
172     CSSValueList& srcList = downcast<CSSValueList>(*src);
173     if (!srcList.length())
174         return;
175
176     m_creatingFont = true;
177     Ref<CSSFontFace> fontFace = CSSFontFace::create(this, &fontFaceRule);
178
179     if (!fontFace->setFamilies(*fontFamily))
180         return;
181     if (!fontFace->setStyle(*fontStyle))
182         return;
183     if (!fontFace->setWeight(*fontWeight))
184         return;
185     if (rangeList && !fontFace->setUnicodeRange(*rangeList))
186         return;
187     if (variantLigatures && !fontFace->setVariantLigatures(*variantLigatures))
188         return;
189     if (variantPosition && !fontFace->setVariantPosition(*variantPosition))
190         return;
191     if (variantCaps && !fontFace->setVariantCaps(*variantCaps))
192         return;
193     if (variantNumeric && !fontFace->setVariantNumeric(*variantNumeric))
194         return;
195     if (variantAlternates && !fontFace->setVariantAlternates(*variantAlternates))
196         return;
197     if (variantEastAsian && !fontFace->setVariantEastAsian(*variantEastAsian))
198         return;
199     if (featureSettings)
200         fontFace->setFeatureSettings(*featureSettings);
201
202     CSSFontFace::appendSources(fontFace, srcList, m_document, isInitiatingElementInUserAgentShadowTree);
203     if (fontFace->allSourcesFailed())
204         return;
205
206     if (RefPtr<CSSFontFace> existingFace = m_cssFontFaceSet->lookUpByCSSConnection(fontFaceRule)) {
207         // This adoption is fairly subtle. Script can trigger a purge of m_cssFontFaceSet at any time,
208         // which will cause us to just rely on the memory cache to retain the bytes of the file the next
209         // time we build up the CSSFontFaceSet. However, when the CSS Font Loading API is involved,
210         // the FontFace and FontFaceSet objects need to retain state. We create the new CSSFontFace object
211         // while the old one is still in scope so that the memory cache will be forced to retain the bytes
212         // of the resource. This means that the CachedFont will temporarily have two clients (until the
213         // old CSSFontFace goes out of scope, which should happen at the end of this "if" block). Because
214         // the CSSFontFaceSource objects will inspect their CachedFonts, the new CSSFontFace is smart enough
215         // to enter the correct state() during the next pump(). This approach of making a new CSSFontFace is
216         // simpler than computing and applying a diff of the StyleProperties.
217         m_cssFontFaceSet->remove(*existingFace);
218         if (auto* existingWrapper = existingFace->existingWrapper())
219             existingWrapper->adopt(fontFace.get());
220     }
221
222     m_cssFontFaceSet->add(fontFace.get());
223     m_creatingFont = false;
224     ++m_version;
225 }
226
227 void CSSFontSelector::registerForInvalidationCallbacks(FontSelectorClient& client)
228 {
229     m_clients.add(&client);
230 }
231
232 void CSSFontSelector::unregisterForInvalidationCallbacks(FontSelectorClient& client)
233 {
234     m_clients.remove(&client);
235 }
236
237 void CSSFontSelector::dispatchInvalidationCallbacks()
238 {
239     ++m_version;
240
241     Vector<FontSelectorClient*> clients;
242     copyToVector(m_clients, clients);
243     for (size_t i = 0; i < clients.size(); ++i)
244         clients[i]->fontsNeedUpdate(*this);
245 }
246
247 void CSSFontSelector::fontLoaded()
248 {
249     dispatchInvalidationCallbacks();
250 }
251
252 void CSSFontSelector::fontModified()
253 {
254     if (!m_creatingFont)
255         dispatchInvalidationCallbacks();
256 }
257
258 void CSSFontSelector::fontCacheInvalidated()
259 {
260     dispatchInvalidationCallbacks();
261 }
262
263 static const AtomicString& resolveGenericFamily(Document* document, const FontDescription& fontDescription, const AtomicString& familyName)
264 {
265     if (!document)
266         return familyName;
267
268     const Settings& settings = document->settings();
269
270     UScriptCode script = fontDescription.script();
271     if (familyName == serifFamily)
272         return settings.serifFontFamily(script);
273     if (familyName == sansSerifFamily)
274         return settings.sansSerifFontFamily(script);
275     if (familyName == cursiveFamily)
276         return settings.cursiveFontFamily(script);
277     if (familyName == fantasyFamily)
278         return settings.fantasyFontFamily(script);
279     if (familyName == monospaceFamily)
280         return settings.fixedFontFamily(script);
281     if (familyName == pictographFamily)
282         return settings.pictographFontFamily(script);
283     if (familyName == standardFamily)
284         return settings.standardFontFamily(script);
285
286     return familyName;
287 }
288
289 FontRanges CSSFontSelector::fontRangesForFamily(const FontDescription& fontDescription, const AtomicString& familyName)
290 {
291     // If this ASSERT() fires, it usually means you forgot a document.updateStyleIfNeeded() somewhere.
292     ASSERT(!m_buildIsUnderway || m_isComputingRootStyleFont);
293
294     // FIXME: The spec (and Firefox) says user specified generic families (sans-serif etc.) should be resolved before the @font-face lookup too.
295     bool resolveGenericFamilyFirst = familyName == standardFamily;
296
297     AtomicString familyForLookup = resolveGenericFamilyFirst ? resolveGenericFamily(m_document, fontDescription, familyName) : familyName;
298     auto* face = m_cssFontFaceSet->fontFace(fontDescription.traitsMask(), familyForLookup);
299     if (!face) {
300         if (!resolveGenericFamilyFirst)
301             familyForLookup = resolveGenericFamily(m_document, fontDescription, familyName);
302         return FontRanges(FontCache::singleton().fontForFamily(fontDescription, familyForLookup));
303     }
304
305     return face->fontRanges(fontDescription);
306 }
307
308 void CSSFontSelector::clearDocument()
309 {
310     if (!m_document) {
311         ASSERT(!m_beginLoadingTimer.isActive());
312         ASSERT(m_fontsToBeginLoading.isEmpty());
313         return;
314     }
315
316     m_beginLoadingTimer.stop();
317
318     CachedResourceLoader& cachedResourceLoader = m_document->cachedResourceLoader();
319     for (auto& fontHandle : m_fontsToBeginLoading) {
320         // Balances incrementRequestCount() in beginLoadingFontSoon().
321         cachedResourceLoader.decrementRequestCount(*fontHandle);
322     }
323     m_fontsToBeginLoading.clear();
324
325     m_document = nullptr;
326
327     m_cssFontFaceSet->clear();
328     m_clients.clear();
329 }
330
331 void CSSFontSelector::beginLoadingFontSoon(CachedFont& font)
332 {
333     if (!m_document)
334         return;
335
336     m_fontsToBeginLoading.append(&font);
337     // Increment the request count now, in order to prevent didFinishLoad from being dispatched
338     // after this font has been requested but before it began loading. Balanced by
339     // decrementRequestCount() in beginLoadTimerFired() and in clearDocument().
340     m_document->cachedResourceLoader().incrementRequestCount(font);
341     m_beginLoadingTimer.startOneShot(0);
342 }
343
344 void CSSFontSelector::beginLoadTimerFired()
345 {
346     Vector<CachedResourceHandle<CachedFont>> fontsToBeginLoading;
347     fontsToBeginLoading.swap(m_fontsToBeginLoading);
348
349     // CSSFontSelector could get deleted via beginLoadIfNeeded() or loadDone() unless protected.
350     Ref<CSSFontSelector> protectedThis(*this);
351
352     CachedResourceLoader& cachedResourceLoader = m_document->cachedResourceLoader();
353     for (auto& fontHandle : fontsToBeginLoading) {
354         fontHandle->beginLoadIfNeeded(cachedResourceLoader);
355         // Balances incrementRequestCount() in beginLoadingFontSoon().
356         cachedResourceLoader.decrementRequestCount(*fontHandle);
357     }
358     // Ensure that if the request count reaches zero, the frame loader will know about it.
359     cachedResourceLoader.loadDone();
360     // New font loads may be triggered by layout after the document load is complete but before we have dispatched
361     // didFinishLoading for the frame. Make sure the delegate is always dispatched by checking explicitly.
362     if (m_document && m_document->frame())
363         m_document->frame()->loader().checkLoadComplete();
364 }
365
366
367 size_t CSSFontSelector::fallbackFontCount()
368 {
369     if (!m_document)
370         return 0;
371
372     return m_document->settings().fontFallbackPrefersPictographs() ? 1 : 0;
373 }
374
375 RefPtr<Font> CSSFontSelector::fallbackFontAt(const FontDescription& fontDescription, size_t index)
376 {
377     ASSERT_UNUSED(index, !index);
378
379     if (!m_document)
380         return nullptr;
381
382     if (!m_document->settings().fontFallbackPrefersPictographs())
383         return nullptr;
384
385     return FontCache::singleton().fontForFamily(fontDescription, m_document->settings().pictographFontFamily());
386 }
387
388 }