Replace WTF::move with WTFMove
[WebKit-https.git] / Source / WebCore / dom / ScriptExecutionContext.h
1 /*
2  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
3  * Copyright (C) 2012 Google Inc. All Rights Reserved.
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
28 #ifndef ScriptExecutionContext_h
29 #define ScriptExecutionContext_h
30
31 #include "ActiveDOMObject.h"
32 #include "DOMTimer.h"
33 #include "ResourceRequest.h"
34 #include "SecurityContext.h"
35 #include "Supplementable.h"
36 #include <runtime/ConsoleTypes.h>
37 #include <wtf/HashSet.h>
38
39 namespace JSC {
40 class ExecState;
41 class VM;
42 }
43
44 namespace Inspector {
45 class ScriptCallStack;
46 }
47
48 namespace WebCore {
49
50 class CachedScript;
51 class DatabaseContext;
52 class EventQueue;
53 class EventTarget;
54 class MessagePort;
55 class PublicURLManager;
56 class SecurityOrigin;
57 class URL;
58
59 class ScriptExecutionContext : public SecurityContext, public Supplementable<ScriptExecutionContext> {
60 public:
61     ScriptExecutionContext();
62     virtual ~ScriptExecutionContext();
63
64     virtual bool isDocument() const { return false; }
65     virtual bool isWorkerGlobalScope() const { return false; }
66
67     virtual bool isContextThread() const { return true; }
68     virtual bool isJSExecutionForbidden() const = 0;
69
70     virtual const URL& url() const = 0;
71     virtual URL completeURL(const String& url) const = 0;
72
73     virtual String userAgent(const URL&) const = 0;
74
75     virtual void disableEval(const String& errorMessage) = 0;
76
77     bool sanitizeScriptError(String& errorMessage, int& lineNumber, int& columnNumber, String& sourceURL, CachedScript* = nullptr);
78     void reportException(const String& errorMessage, int lineNumber, int columnNumber, const String& sourceURL, RefPtr<Inspector::ScriptCallStack>&&, CachedScript* = nullptr);
79
80     void addConsoleMessage(MessageSource, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, unsigned columnNumber, JSC::ExecState* = nullptr, unsigned long requestIdentifier = 0);
81     virtual void addConsoleMessage(MessageSource, MessageLevel, const String& message, unsigned long requestIdentifier = 0) = 0;
82
83     virtual SecurityOrigin* topOrigin() const = 0;
84
85     PublicURLManager& publicURLManager();
86
87     // Active objects are not garbage collected even if inaccessible, e.g. because their activity may result in callbacks being invoked.
88     WEBCORE_EXPORT bool canSuspendActiveDOMObjectsForDocumentSuspension(Vector<ActiveDOMObject*>* unsuspendableObjects = nullptr);
89
90     // Active objects can be asked to suspend even if canSuspendActiveDOMObjectsForDocumentSuspension() returns 'false' -
91     // step-by-step JS debugging is one example.
92     virtual void suspendActiveDOMObjects(ActiveDOMObject::ReasonForSuspension);
93     virtual void resumeActiveDOMObjects(ActiveDOMObject::ReasonForSuspension);
94     virtual void stopActiveDOMObjects();
95
96     bool activeDOMObjectsAreSuspended() const { return m_activeDOMObjectsAreSuspended; }
97     bool activeDOMObjectsAreStopped() const { return m_activeDOMObjectsAreStopped; }
98
99     // Called from the constructor and destructors of ActiveDOMObject.
100     void didCreateActiveDOMObject(ActiveDOMObject&);
101     void willDestroyActiveDOMObject(ActiveDOMObject&);
102
103     // Called after the construction of an ActiveDOMObject to synchronize suspend state.
104     void suspendActiveDOMObjectIfNeeded(ActiveDOMObject&);
105
106     void didCreateDestructionObserver(ContextDestructionObserver&);
107     void willDestroyDestructionObserver(ContextDestructionObserver&);
108
109     // MessagePort is conceptually a kind of ActiveDOMObject, but it needs to be tracked separately for message dispatch.
110     void processMessagePortMessagesSoon();
111     void dispatchMessagePortEvents();
112     void createdMessagePort(MessagePort&);
113     void destroyedMessagePort(MessagePort&);
114
115     virtual void didLoadResourceSynchronously(const ResourceRequest&);
116
117     void ref() { refScriptExecutionContext(); }
118     void deref() { derefScriptExecutionContext(); }
119
120     class Task {
121         WTF_MAKE_FAST_ALLOCATED;
122     public:
123         enum CleanupTaskTag { CleanupTask };
124
125         template<typename T, typename = typename std::enable_if<!std::is_base_of<Task, T>::value && std::is_convertible<T, std::function<void (ScriptExecutionContext&)>>::value>::type>
126         Task(T task)
127             : m_task(WTFMove(task))
128             , m_isCleanupTask(false)
129         {
130         }
131
132         Task(std::function<void()> task)
133             : m_task([task](ScriptExecutionContext&) { task(); })
134             , m_isCleanupTask(false)
135         {
136         }
137
138         template<typename T, typename = typename std::enable_if<std::is_convertible<T, std::function<void (ScriptExecutionContext&)>>::value>::type>
139         Task(CleanupTaskTag, T task)
140             : m_task(WTFMove(task))
141             , m_isCleanupTask(true)
142         {
143         }
144
145         Task(Task&& other)
146             : m_task(WTFMove(other.m_task))
147             , m_isCleanupTask(other.m_isCleanupTask)
148         {
149         }
150
151         void performTask(ScriptExecutionContext& context) { m_task(context); }
152         bool isCleanupTask() const { return m_isCleanupTask; }
153
154     protected:
155         std::function<void (ScriptExecutionContext&)> m_task;
156         bool m_isCleanupTask;
157     };
158
159     virtual void postTask(Task) = 0; // Executes the task on context's thread asynchronously.
160
161     // Gets the next id in a circular sequence from 1 to 2^31-1.
162     int circularSequentialID();
163
164     bool addTimeout(int timeoutId, PassRefPtr<DOMTimer> timer) { return m_timeouts.add(timeoutId, timer).isNewEntry; }
165     void removeTimeout(int timeoutId) { m_timeouts.remove(timeoutId); }
166     DOMTimer* findTimeout(int timeoutId) { return m_timeouts.get(timeoutId); }
167
168     WEBCORE_EXPORT JSC::VM& vm();
169
170     // Interval is in seconds.
171     void adjustMinimumTimerInterval(double oldMinimumTimerInterval);
172     virtual double minimumTimerInterval() const;
173
174     void didChangeTimerAlignmentInterval();
175     virtual double timerAlignmentInterval(bool hasReachedMaxNestingLevel) const;
176
177     virtual EventQueue& eventQueue() const = 0;
178
179     void setDatabaseContext(DatabaseContext*);
180
181 #if ENABLE(SUBTLE_CRYPTO)
182     virtual bool wrapCryptoKey(const Vector<uint8_t>& key, Vector<uint8_t>& wrappedKey) = 0;
183     virtual bool unwrapCryptoKey(const Vector<uint8_t>& wrappedKey, Vector<uint8_t>& key) = 0;
184 #endif
185
186     int timerNestingLevel() const { return m_timerNestingLevel; }
187     void setTimerNestingLevel(int timerNestingLevel) { m_timerNestingLevel = timerNestingLevel; }
188
189 protected:
190     class AddConsoleMessageTask : public Task {
191     public:
192         AddConsoleMessageTask(MessageSource source, MessageLevel level, const StringCapture& message)
193             : Task([source, level, message](ScriptExecutionContext& context) {
194                 context.addConsoleMessage(source, level, message.string());
195             })
196         {
197         }
198     };
199
200     ActiveDOMObject::ReasonForSuspension reasonForSuspendingActiveDOMObjects() const { return m_reasonForSuspendingActiveDOMObjects; }
201
202     bool hasPendingActivity() const;
203
204 private:
205     virtual void addMessage(MessageSource, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, unsigned columnNumber, RefPtr<Inspector::ScriptCallStack>&&, JSC::ExecState* = nullptr, unsigned long requestIdentifier = 0) = 0;
206     virtual EventTarget* errorEventTarget() = 0;
207     virtual void logExceptionToConsole(const String& errorMessage, const String& sourceURL, int lineNumber, int columnNumber, RefPtr<Inspector::ScriptCallStack>&&) = 0;
208     bool dispatchErrorEvent(const String& errorMessage, int lineNumber, int columnNumber, const String& sourceURL, CachedScript*);
209
210     virtual void refScriptExecutionContext() = 0;
211     virtual void derefScriptExecutionContext() = 0;
212
213     void checkConsistency() const;
214
215     HashSet<MessagePort*> m_messagePorts;
216     HashSet<ContextDestructionObserver*> m_destructionObservers;
217     HashSet<ActiveDOMObject*> m_activeDOMObjects;
218
219     int m_circularSequentialID;
220     HashMap<int, RefPtr<DOMTimer>> m_timeouts;
221
222     bool m_inDispatchErrorEvent;
223     class PendingException;
224     std::unique_ptr<Vector<std::unique_ptr<PendingException>>> m_pendingExceptions;
225
226     bool m_activeDOMObjectsAreSuspended;
227     ActiveDOMObject::ReasonForSuspension m_reasonForSuspendingActiveDOMObjects;
228     bool m_activeDOMObjectsAreStopped;
229
230     std::unique_ptr<PublicURLManager> m_publicURLManager;
231
232     RefPtr<DatabaseContext> m_databaseContext;
233
234     bool m_activeDOMObjectAdditionForbidden;
235     int m_timerNestingLevel;
236
237 #if !ASSERT_DISABLED
238     bool m_inScriptExecutionContextDestructor;
239 #endif
240 #if !ASSERT_DISABLED || ENABLE(SECURITY_ASSERTIONS)
241     bool m_activeDOMObjectRemovalForbidden;
242 #endif
243 };
244
245 } // namespace WebCore
246
247 #endif // ScriptExecutionContext_h