[Font Loading] Split CSSFontSelector into a FontFaceSet implementation and the rest...
[WebKit-https.git] / Source / WebCore / css / FontFaceSet.h
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 #ifndef FontFaceSet_h
27 #define FontFaceSet_h
28
29 #include "ActiveDOMObject.h"
30 #include "CSSFontFaceSet.h"
31 #include "DOMCoreException.h"
32 #include "EventTarget.h"
33 #include "JSDOMPromise.h"
34 #include <wtf/Optional.h>
35 #include <wtf/Ref.h>
36 #include <wtf/RefCounted.h>
37 #include <wtf/RefPtr.h>
38 #include <wtf/Vector.h>
39 #include <wtf/text/WTFString.h>
40
41 namespace JSC {
42 class ExecState;
43 }
44
45 namespace WebCore {
46
47 class Document;
48 class FontFace;
49
50 class FontFaceSet final : public RefCounted<FontFaceSet>, public CSSFontFaceSetClient, public EventTargetWithInlineData, public ActiveDOMObject {
51 public:
52     static Ref<FontFaceSet> create(Document&, const Vector<RefPtr<FontFace>>& initialFaces);
53     static Ref<FontFaceSet> create(Document&, CSSFontFaceSet& backing);
54     virtual ~FontFaceSet();
55
56     bool has(RefPtr<WebCore::FontFace>) const;
57     size_t size() const;
58     FontFaceSet& add(RefPtr<WebCore::FontFace>);
59     bool remove(RefPtr<WebCore::FontFace>);
60     void clear();
61
62     void load(JSC::ExecState& execState, const String& font, DeferredWrapper&& promise, ExceptionCode& ec) { load(execState, font, String(" ", String::ConstructFromLiteral), WTFMove(promise), ec); }
63     void load(JSC::ExecState&, const String& font, const String& text, DeferredWrapper&& promise, ExceptionCode&);
64     bool check(const String& font, ExceptionCode& ec) { return check(font, String(" ", String::ConstructFromLiteral), ec); }
65     bool check(const String& font, const String& text, ExceptionCode&);
66
67     String status() const;
68
69     typedef DOMPromise<FontFaceSet&, DOMCoreException&> Promise;
70     Promise& promise(JSC::ExecState&);
71
72     CSSFontFaceSet& backing() { return m_backing; }
73
74     class Iterator {
75     public:
76         explicit Iterator(FontFaceSet&);
77         bool next(JSC::ExecState&, RefPtr<FontFace>& nextKey, RefPtr<FontFace>& nextValue);
78
79     private:
80         Ref<FontFaceSet> m_target;
81         size_t m_index { 0 }; // FIXME: There needs to be a mechanism to handle when fonts are added or removed from the middle of the FontFaceSet.
82     };
83     Iterator createIterator() { return Iterator(*this); }
84
85     using RefCounted<FontFaceSet>::ref;
86     using RefCounted<FontFaceSet>::deref;
87
88 private:
89     struct PendingPromise : public RefCounted<PendingPromise> {
90         typedef DOMPromise<Vector<RefPtr<FontFace>>&, DOMCoreException&> Promise;
91         static Ref<PendingPromise> create(Promise&& promise)
92         {
93             return adoptRef(*new PendingPromise(WTFMove(promise)));
94         }
95         ~PendingPromise();
96
97     private:
98         PendingPromise(Promise&&);
99
100     public:
101         Vector<RefPtr<FontFace>> faces;
102         Promise promise;
103     };
104
105     FontFaceSet(Document&, const Vector<RefPtr<FontFace>>&);
106     FontFaceSet(Document&, CSSFontFaceSet&);
107
108     void fulfillPromise();
109
110     // CSSFontFaceSetClient
111     virtual void startedLoading() override;
112     virtual void completedLoading() override;
113     virtual void faceFinished(CSSFontFace&, CSSFontFace::Status) override;
114
115     // ActiveDOMObject
116     virtual const char* activeDOMObjectName() const override { return "FontFaceSet"; }
117     virtual bool canSuspendForDocumentSuspension() const override;
118
119     // EventTarget
120     virtual EventTargetInterface eventTargetInterface() const override { return FontFaceSetEventTargetInterfaceType; }
121     virtual ScriptExecutionContext* scriptExecutionContext() const override { return ActiveDOMObject::scriptExecutionContext(); }
122     virtual void refEventTarget() override { ref(); }
123     virtual void derefEventTarget() override { deref(); }
124
125     Ref<CSSFontFaceSet> m_backing;
126     HashMap<RefPtr<CSSFontFace>, Vector<Ref<PendingPromise>>> m_pendingPromises;
127     Optional<Promise> m_promise;
128 };
129
130 }
131
132 #endif