2009-07-21 Jian Li <jianli@chromium.org>
[WebKit-https.git] / WebCore / workers / WorkerContext.h
1 /*
2  * Copyright (C) 2008, 2009 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 COMPUTER, 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 COMPUTER, 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
27 #ifndef WorkerContext_h
28 #define WorkerContext_h
29
30 #if ENABLE(WORKERS)
31
32 #include "AtomicStringHash.h"
33 #include "EventListener.h"
34 #include "EventTarget.h"
35 #include "ScriptExecutionContext.h"
36 #include "WorkerScriptController.h"
37 #include <wtf/OwnPtr.h>
38 #include <wtf/PassRefPtr.h>
39 #include <wtf/RefCounted.h>
40 #include <wtf/RefPtr.h>
41
42 namespace WebCore {
43
44     class ScheduledAction;
45     class WorkerLocation;
46     class WorkerNavigator;
47     class WorkerThread;
48
49     class WorkerContext : public RefCounted<WorkerContext>, public ScriptExecutionContext, public EventTarget {
50     public:
51         static PassRefPtr<WorkerContext> create(const KURL& url, const String& userAgent, WorkerThread* thread)
52         {
53             return adoptRef(new WorkerContext(url, userAgent, thread));
54         }
55
56         virtual ~WorkerContext();
57
58         virtual bool isWorkerContext() const { return true; }
59
60         virtual WorkerContext* toWorkerContext() { return this; }
61
62         virtual ScriptExecutionContext* scriptExecutionContext() const;
63
64         const KURL& url() const { return m_url; }
65         KURL completeURL(const String&) const;
66
67         virtual String userAgent(const KURL&) const;
68
69         WorkerScriptController* script() { return m_script.get(); }
70         void clearScript() { return m_script.clear(); }
71
72         WorkerThread* thread() { return m_thread; }
73
74         bool hasPendingActivity() const;
75
76         virtual void reportException(const String& errorMessage, int lineNumber, const String& sourceURL);
77         virtual void addMessage(MessageDestination, MessageSource, MessageType, MessageLevel, const String& message, unsigned lineNumber, const String& sourceURL);
78         virtual void resourceRetrievedByXMLHttpRequest(unsigned long identifier, const ScriptString& sourceString);
79         virtual void scriptImported(unsigned long identifier, const String& sourceString);
80
81         virtual void postTask(PassRefPtr<Task>); // Executes the task on context's thread asynchronously.
82
83         // WorkerGlobalScope
84         WorkerContext* self() { return this; }
85         WorkerLocation* location() const;
86         void close();
87         void setOnerror(PassRefPtr<EventListener> eventListener) { m_onerrorListener = eventListener; }
88         EventListener* onerror() const { return m_onerrorListener.get(); }
89
90         // WorkerUtils
91         void importScripts(const Vector<String>& urls, const String& callerURL, int callerLine, ExceptionCode&);
92         WorkerNavigator* navigator() const;
93
94         // DedicatedWorkerGlobalScope
95         void postMessage(const String&, ExceptionCode&);
96         void postMessage(const String&, MessagePort*, ExceptionCode&);
97         void setOnmessage(PassRefPtr<EventListener> eventListener) { m_onmessageListener = eventListener; }
98         EventListener* onmessage() const { return m_onmessageListener.get(); }
99
100         // Timers
101         int setTimeout(ScheduledAction*, int timeout);
102         void clearTimeout(int timeoutId);
103         int setInterval(ScheduledAction*, int timeout);
104         void clearInterval(int timeoutId);
105
106         // EventTarget
107         virtual void addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
108         virtual void removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
109         virtual bool dispatchEvent(PassRefPtr<Event>, ExceptionCode&);
110
111         typedef Vector<RefPtr<EventListener> > ListenerVector;
112         typedef HashMap<AtomicString, ListenerVector> EventListenersMap;
113         EventListenersMap& eventListeners() { return m_eventListeners; }
114
115         void dispatchMessage(const String&, PassRefPtr<MessagePort>);
116
117         // These methods are used for GC marking. See JSWorkerContext::mark() in
118         // JSWorkerContextCustom.cpp.
119         WorkerNavigator* optionalNavigator() const { return m_navigator.get(); }
120         WorkerLocation* optionalLocation() const { return m_location.get(); }
121
122         using RefCounted<WorkerContext>::ref;
123         using RefCounted<WorkerContext>::deref;
124
125     private:
126         WorkerContext(const KURL&, const String&, WorkerThread*);
127
128         virtual void refScriptExecutionContext() { ref(); }
129         virtual void derefScriptExecutionContext() { deref(); }
130         virtual void refEventTarget() { ref(); }
131         virtual void derefEventTarget() { deref(); }
132
133         virtual const KURL& virtualURL() const;
134         virtual KURL virtualCompleteURL(const String&) const;
135
136         KURL m_url;
137         String m_userAgent;
138
139         mutable RefPtr<WorkerLocation> m_location;
140         mutable RefPtr<WorkerNavigator> m_navigator;
141
142         OwnPtr<WorkerScriptController> m_script;
143         WorkerThread* m_thread;
144
145         RefPtr<EventListener> m_onerrorListener;
146         RefPtr<EventListener> m_onmessageListener;
147         EventListenersMap m_eventListeners;
148
149         bool m_closing;
150     };
151
152 } // namespace WebCore
153
154 #endif // ENABLE(WORKERS)
155
156 #endif // WorkerContext_h