summaryrefslogtreecommitdiff
path: root/Source/WebCore/dom/ScriptExecutionContext.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/WebCore/dom/ScriptExecutionContext.h')
-rw-r--r--Source/WebCore/dom/ScriptExecutionContext.h220
1 files changed, 220 insertions, 0 deletions
diff --git a/Source/WebCore/dom/ScriptExecutionContext.h b/Source/WebCore/dom/ScriptExecutionContext.h
new file mode 100644
index 000000000..24a17f599
--- /dev/null
+++ b/Source/WebCore/dom/ScriptExecutionContext.h
@@ -0,0 +1,220 @@
+/*
+ * Copyright (C) 2008 Apple Inc. All Rights Reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+#ifndef ScriptExecutionContext_h
+#define ScriptExecutionContext_h
+
+#include "ActiveDOMObject.h"
+#include "ConsoleTypes.h"
+#include "KURL.h"
+#include "SecurityContext.h"
+#include <wtf/Forward.h>
+#include <wtf/HashMap.h>
+#include <wtf/HashSet.h>
+#include <wtf/Noncopyable.h>
+#include <wtf/OwnPtr.h>
+#include <wtf/PassOwnPtr.h>
+#include <wtf/Threading.h>
+#include <wtf/text/StringHash.h>
+
+#if USE(JSC)
+#include <runtime/JSGlobalData.h>
+#endif
+
+namespace WebCore {
+
+class DOMTimer;
+class EventListener;
+class EventQueue;
+class EventTarget;
+class MessagePort;
+class ScriptCallStack;
+
+#if ENABLE(SQL_DATABASE)
+class Database;
+class DatabaseTaskSynchronizer;
+class DatabaseThread;
+#endif
+
+#if ENABLE(BLOB) || ENABLE(FILE_SYSTEM)
+class FileThread;
+#endif
+
+class ScriptExecutionContext : public SecurityContext {
+public:
+ ScriptExecutionContext();
+ virtual ~ScriptExecutionContext();
+
+ virtual bool isDocument() const { return false; }
+ virtual bool isWorkerContext() const { return false; }
+
+#if ENABLE(SQL_DATABASE)
+ virtual bool allowDatabaseAccess() const = 0;
+ virtual void databaseExceededQuota(const String& name) = 0;
+ DatabaseThread* databaseThread();
+ void setHasOpenDatabases() { m_hasOpenDatabases = true; }
+ bool hasOpenDatabases() const { return m_hasOpenDatabases; }
+ // When the database cleanup is done, cleanupSync will be signalled.
+ void stopDatabases(DatabaseTaskSynchronizer*);
+#endif
+ virtual bool isContextThread() const = 0;
+ virtual bool isJSExecutionForbidden() const = 0;
+
+ const KURL& url() const { return virtualURL(); }
+ KURL completeURL(const String& url) const { return virtualCompleteURL(url); }
+
+ virtual String userAgent(const KURL&) const = 0;
+
+ virtual void disableEval() = 0;
+
+ bool sanitizeScriptError(String& errorMessage, int& lineNumber, String& sourceURL);
+ void reportException(const String& errorMessage, int lineNumber, const String& sourceURL, PassRefPtr<ScriptCallStack>);
+ virtual void addMessage(MessageSource, MessageType, MessageLevel, const String& message, unsigned lineNumber, const String& sourceURL, PassRefPtr<ScriptCallStack>) = 0;
+ void addConsoleMessage(MessageSource, MessageType, MessageLevel, const String& message);
+
+ // Active objects are not garbage collected even if inaccessible, e.g. because their activity may result in callbacks being invoked.
+ bool canSuspendActiveDOMObjects();
+ // Active objects can be asked to suspend even if canSuspendActiveDOMObjects() returns 'false' -
+ // step-by-step JS debugging is one example.
+ virtual void suspendActiveDOMObjects(ActiveDOMObject::ReasonForSuspension);
+ virtual void resumeActiveDOMObjects();
+ virtual void stopActiveDOMObjects();
+
+ void didCreateActiveDOMObject(ActiveDOMObject*, void* upcastPointer);
+ void willDestroyActiveDOMObject(ActiveDOMObject*);
+
+ typedef const HashMap<ActiveDOMObject*, void*> ActiveDOMObjectsMap;
+ ActiveDOMObjectsMap& activeDOMObjects() const { return m_activeDOMObjects; }
+
+ void didCreateDestructionObserver(ContextDestructionObserver*);
+ void willDestroyDestructionObserver(ContextDestructionObserver*);
+
+ virtual void suspendScriptedAnimationControllerCallbacks() { }
+ virtual void resumeScriptedAnimationControllerCallbacks() { }
+
+ // MessagePort is conceptually a kind of ActiveDOMObject, but it needs to be tracked separately for message dispatch.
+ void processMessagePortMessagesSoon();
+ void dispatchMessagePortEvents();
+ void createdMessagePort(MessagePort*);
+ void destroyedMessagePort(MessagePort*);
+ const HashSet<MessagePort*>& messagePorts() const { return m_messagePorts; }
+
+ void ref() { refScriptExecutionContext(); }
+ void deref() { derefScriptExecutionContext(); }
+
+ class Task {
+ WTF_MAKE_NONCOPYABLE(Task);
+ WTF_MAKE_FAST_ALLOCATED;
+ public:
+ Task() { }
+ virtual ~Task();
+ virtual void performTask(ScriptExecutionContext*) = 0;
+ // Certain tasks get marked specially so that they aren't discarded, and are executed, when the context is shutting down its message queue.
+ virtual bool isCleanupTask() const { return false; }
+ };
+
+ virtual void postTask(PassOwnPtr<Task>) = 0; // Executes the task on context's thread asynchronously.
+
+ void addTimeout(int timeoutId, DOMTimer*);
+ void removeTimeout(int timeoutId);
+ DOMTimer* findTimeout(int timeoutId);
+
+#if USE(JSC)
+ JSC::JSGlobalData* globalData();
+#endif
+
+#if ENABLE(BLOB) || ENABLE(FILE_SYSTEM)
+ FileThread* fileThread();
+ void stopFileThread();
+#endif
+
+ // Interval is in seconds.
+ void adjustMinimumTimerInterval(double oldMinimumTimerInterval);
+ virtual double minimumTimerInterval() const;
+
+ virtual EventQueue* eventQueue() const = 0;
+
+protected:
+ class AddConsoleMessageTask : public Task {
+ public:
+ static PassOwnPtr<AddConsoleMessageTask> create(MessageSource source, MessageType type, MessageLevel level, const String& message)
+ {
+ return adoptPtr(new AddConsoleMessageTask(source, type, level, message));
+ }
+ virtual void performTask(ScriptExecutionContext*);
+ private:
+ AddConsoleMessageTask(MessageSource source, MessageType type, MessageLevel level, const String& message)
+ : m_source(source)
+ , m_type(type)
+ , m_level(level)
+ , m_message(message.isolatedCopy())
+ {
+ }
+ MessageSource m_source;
+ MessageType m_type;
+ MessageLevel m_level;
+ String m_message;
+ };
+
+private:
+ virtual const KURL& virtualURL() const = 0;
+ virtual KURL virtualCompleteURL(const String&) const = 0;
+
+ virtual EventTarget* errorEventTarget() = 0;
+ virtual void logExceptionToConsole(const String& errorMessage, int lineNumber, const String& sourceURL, PassRefPtr<ScriptCallStack>) = 0;
+ bool dispatchErrorEvent(const String& errorMessage, int lineNumber, const String& sourceURL);
+
+ void closeMessagePorts();
+
+ HashSet<MessagePort*> m_messagePorts;
+ HashSet<ContextDestructionObserver*> m_destructionObservers;
+ HashMap<ActiveDOMObject*, void*> m_activeDOMObjects;
+ bool m_iteratingActiveDOMObjects;
+ bool m_inDestructor;
+
+ typedef HashMap<int, DOMTimer*> TimeoutMap;
+ TimeoutMap m_timeouts;
+
+ virtual void refScriptExecutionContext() = 0;
+ virtual void derefScriptExecutionContext() = 0;
+
+ bool m_inDispatchErrorEvent;
+ class PendingException;
+ OwnPtr<Vector<OwnPtr<PendingException> > > m_pendingExceptions;
+
+#if ENABLE(SQL_DATABASE)
+ RefPtr<DatabaseThread> m_databaseThread;
+ bool m_hasOpenDatabases; // This never changes back to false, even after the database thread is closed.
+#endif
+
+#if ENABLE(BLOB) || ENABLE(FILE_SYSTEM)
+ RefPtr<FileThread> m_fileThread;
+#endif
+};
+
+} // namespace WebCore
+
+#endif // ScriptExecutionContext_h