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