[CSS Font Loading] FontFaceSet.load() promises don't always fire
[WebKit-https.git] / Source / WebCore / css / FontFaceSet.cpp
1 /*
2  * Copyright (C) 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 #include "config.h"
27 #include "FontFaceSet.h"
28
29 #include "Document.h"
30 #include "ExceptionCodeDescription.h"
31 #include "FontFace.h"
32 #include "JSDOMBinding.h"
33 #include "JSDOMCoreException.h"
34 #include "JSFontFace.h"
35 #include "JSFontFaceSet.h"
36
37 namespace WebCore {
38
39 Ref<FontFaceSet> FontFaceSet::create(Document& document, const Vector<RefPtr<FontFace>>& initialFaces)
40 {
41     Ref<FontFaceSet> result = adoptRef(*new FontFaceSet(document, initialFaces));
42     result->suspendIfNeeded();
43     return result;
44 }
45
46 Ref<FontFaceSet> FontFaceSet::create(Document& document, CSSFontFaceSet& backing)
47 {
48     Ref<FontFaceSet> result = adoptRef(*new FontFaceSet(document, backing));
49     result->suspendIfNeeded();
50     return result;
51 }
52
53 FontFaceSet::FontFaceSet(Document& document, const Vector<RefPtr<FontFace>>& initialFaces)
54     : ActiveDOMObject(&document)
55     , m_backing(CSSFontFaceSet::create())
56 {
57     m_backing->addClient(*this);
58     for (auto& face : initialFaces)
59         add(*face);
60 }
61
62 FontFaceSet::FontFaceSet(Document& document, CSSFontFaceSet& backing)
63     : ActiveDOMObject(&document)
64     , m_backing(backing)
65 {
66     m_backing->addClient(*this);
67 }
68
69 FontFaceSet::~FontFaceSet()
70 {
71     m_backing->removeClient(*this);
72 }
73
74 FontFaceSet::Iterator::Iterator(FontFaceSet& set)
75     : m_target(set)
76 {
77 }
78
79 RefPtr<FontFace> FontFaceSet::Iterator::next()
80 {
81     if (m_index == m_target->size())
82         return nullptr;
83     return m_target->backing()[m_index++].wrapper();
84 }
85
86 FontFaceSet::PendingPromise::PendingPromise(LoadPromise&& promise)
87     : promise(WTFMove(promise))
88 {
89 }
90
91 FontFaceSet::PendingPromise::~PendingPromise()
92 {
93 }
94
95 bool FontFaceSet::has(FontFace& face) const
96 {
97     return m_backing->hasFace(face.backing());
98 }
99
100 size_t FontFaceSet::size() const
101 {
102     return m_backing->faceCount();
103 }
104
105 FontFaceSet& FontFaceSet::add(FontFace& face)
106 {
107     if (!m_backing->hasFace(face.backing()))
108         m_backing->add(face.backing());
109     return *this;
110 }
111
112 bool FontFaceSet::remove(FontFace& face)
113 {
114     bool result = m_backing->hasFace(face.backing());
115     if (result)
116         m_backing->remove(face.backing());
117     return result;
118 }
119
120 void FontFaceSet::clear()
121 {
122     while (m_backing->faceCount())
123         m_backing->remove(m_backing.get()[0]);
124 }
125
126 void FontFaceSet::load(const String& font, const String& text, LoadPromise&& promise)
127 {
128     auto matchingFacesResult = m_backing->matchingFaces(font, text);
129     if (matchingFacesResult.hasException()) {
130         promise.reject(matchingFacesResult.releaseException());
131         return;
132     }
133     auto matchingFaces = matchingFacesResult.releaseReturnValue();
134
135     if (matchingFaces.isEmpty()) {
136         promise.resolve(Vector<RefPtr<FontFace>>());
137         return;
138     }
139
140     for (auto& face : matchingFaces)
141         face.get().load();
142
143     for (auto& face : matchingFaces) {
144         if (face.get().status() == CSSFontFace::Status::Failure) {
145             promise.reject(NETWORK_ERR);
146             return;
147         }
148     }
149
150     auto pendingPromise = PendingPromise::create(WTFMove(promise));
151     bool waiting = false;
152
153     for (auto& face : matchingFaces) {
154         pendingPromise->faces.append(face.get().wrapper());
155         if (face.get().status() == CSSFontFace::Status::Success)
156             continue;
157         waiting = true;
158         ASSERT(face.get().existingWrapper());
159         m_pendingPromises.add(face.get().existingWrapper(), Vector<Ref<PendingPromise>>()).iterator->value.append(pendingPromise.copyRef());
160     }
161
162     if (!waiting)
163         pendingPromise->promise.resolve(pendingPromise->faces);
164 }
165
166 ExceptionOr<bool> FontFaceSet::check(const String& family, const String& text)
167 {
168     return m_backing->check(family, text);
169 }
170
171 void FontFaceSet::registerReady(ReadyPromise&& promise)
172 {
173     ASSERT(!m_promise);
174     if (m_isReady) {
175         promise.resolve(*this);
176         return;
177     }
178     m_promise = WTFMove(promise);
179 }
180     
181 auto FontFaceSet::status() const -> LoadStatus
182 {
183     switch (m_backing->status()) {
184     case CSSFontFaceSet::Status::Loading:
185         return LoadStatus::Loading;
186     case CSSFontFaceSet::Status::Loaded:
187         return LoadStatus::Loaded;
188     }
189     ASSERT_NOT_REACHED();
190     return LoadStatus::Loaded;
191 }
192
193 bool FontFaceSet::canSuspendForDocumentSuspension() const
194 {
195     return m_backing->status() == CSSFontFaceSet::Status::Loaded;
196 }
197
198 void FontFaceSet::startedLoading()
199 {
200     // FIXME: Fire a "loading" event asynchronously.
201     m_isReady = false;
202 }
203
204 void FontFaceSet::completedLoading()
205 {
206     if (m_promise)
207         std::exchange(m_promise, Nullopt)->resolve(*this);
208     m_isReady = true;
209 }
210
211 void FontFaceSet::faceFinished(CSSFontFace& face, CSSFontFace::Status newStatus)
212 {
213     if (!face.existingWrapper())
214         return;
215
216     auto iterator = m_pendingPromises.find(face.existingWrapper());
217     if (iterator == m_pendingPromises.end())
218         return;
219
220     for (auto& pendingPromise : iterator->value) {
221         if (pendingPromise->hasReachedTerminalState)
222             continue;
223         if (newStatus == CSSFontFace::Status::Success) {
224             if (pendingPromise->hasOneRef()) {
225                 pendingPromise->promise.resolve(pendingPromise->faces);
226                 pendingPromise->hasReachedTerminalState = true;
227             }
228         } else {
229             ASSERT(newStatus == CSSFontFace::Status::Failure);
230             pendingPromise->promise.reject(NETWORK_ERR);
231             pendingPromise->hasReachedTerminalState = true;
232         }
233     }
234
235     m_pendingPromises.remove(iterator);
236 }
237
238 }