Next batch of conversions to use C++ enum class instead of strings for enumerations
[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 "EventTarget.h"
32 #include "JSDOMPromise.h"
33
34 namespace WebCore {
35
36 class DOMCoreException;
37
38 enum class FontFaceSetLoadStatus { Loading, Loaded };
39
40 class FontFaceSet final : public RefCounted<FontFaceSet>, private CSSFontFaceSetClient, public EventTargetWithInlineData, private ActiveDOMObject {
41 public:
42     static Ref<FontFaceSet> create(Document&, const Vector<RefPtr<FontFace>>& initialFaces);
43     static Ref<FontFaceSet> create(Document&, CSSFontFaceSet& backing);
44     virtual ~FontFaceSet();
45
46     bool has(FontFace&) const;
47     size_t size() const;
48     FontFaceSet& add(FontFace&);
49     bool remove(FontFace&);
50     void clear();
51
52     void load(JSC::ExecState&, const String& font, const String& text, DeferredWrapper&& promise, ExceptionCode&);
53     bool check(const String& font, const String& text, ExceptionCode&);
54
55     FontFaceSetLoadStatus status() const;
56
57     typedef DOMPromise<FontFaceSet&, DOMCoreException&> Promise;
58     Promise& promise(JSC::ExecState&);
59
60     CSSFontFaceSet& backing() { return m_backing; }
61
62     class Iterator {
63     public:
64         explicit Iterator(FontFaceSet&);
65         Optional<WTF::KeyValuePair<RefPtr<FontFace>, RefPtr<FontFace>>> next(JSC::ExecState&);
66
67     private:
68         Ref<FontFaceSet> m_target;
69         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.
70     };
71     Iterator createIterator() { return Iterator(*this); }
72
73     using RefCounted::ref;
74     using RefCounted::deref;
75
76 private:
77     struct PendingPromise : RefCounted<PendingPromise> {
78         typedef DOMPromise<Vector<RefPtr<FontFace>>&, DOMCoreException&> Promise;
79         static Ref<PendingPromise> create(Promise&& promise)
80         {
81             return adoptRef(*new PendingPromise(WTFMove(promise)));
82         }
83         ~PendingPromise();
84
85     private:
86         PendingPromise(Promise&&);
87
88     public:
89         Vector<RefPtr<FontFace>> faces;
90         Promise promise;
91         bool hasReachedTerminalState { false };
92     };
93
94     FontFaceSet(Document&, const Vector<RefPtr<FontFace>>&);
95     FontFaceSet(Document&, CSSFontFaceSet&);
96
97     void fulfillPromise();
98
99     // CSSFontFaceSetClient
100     void startedLoading() final;
101     void completedLoading() final;
102     void faceFinished(CSSFontFace&, CSSFontFace::Status) final;
103
104     // ActiveDOMObject
105     const char* activeDOMObjectName() const final { return "FontFaceSet"; }
106     bool canSuspendForDocumentSuspension() const final;
107
108     // EventTarget
109     EventTargetInterface eventTargetInterface() const final { return FontFaceSetEventTargetInterfaceType; }
110     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
111     void refEventTarget() final { ref(); }
112     void derefEventTarget() final { deref(); }
113
114     Ref<CSSFontFaceSet> m_backing;
115     HashMap<RefPtr<CSSFontFace>, Vector<Ref<PendingPromise>>> m_pendingPromises;
116     Optional<Promise> m_promise;
117 };
118
119 }
120
121 #endif