WebCore:
[WebKit-https.git] / WebCore / workers / WorkerContext.h
1 /*
2  * Copyright (C) 2008 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, const String& encoding, WorkerThread* thread)
52         {
53             return adoptRef(new WorkerContext(url, userAgent, encoding, thread));
54         }
55
56         virtual ~WorkerContext();
57
58         virtual bool isWorkerContext() const { return true; }
59
60         virtual ScriptExecutionContext* scriptExecutionContext() const;
61
62         const KURL& url() const { return m_url; }
63         KURL completeURL(const String&) const;
64
65         virtual String userAgent(const KURL&) const;
66         virtual String encoding() const;
67
68         WorkerLocation* location() const { return m_location.get(); }
69         WorkerNavigator* navigator() const;
70
71         WorkerScriptController* script() { return m_script.get(); }
72         void clearScript() { return m_script.clear(); }
73         WorkerThread* thread() { return m_thread; }
74
75         bool hasPendingActivity() const;
76
77         virtual void reportException(const String& errorMessage, int lineNumber, const String& sourceURL);
78         virtual void addMessage(MessageDestination, MessageSource, MessageLevel, const String& message, unsigned lineNumber, const String& sourceURL);
79         virtual void resourceRetrievedByXMLHttpRequest(unsigned long identifier, const ScriptString& sourceString);
80
81         virtual WorkerContext* toWorkerContext() { return this; }
82
83         void postMessage(const String& message);
84         virtual void postTask(PassRefPtr<Task>); // Executes the task on context's thread asynchronously.
85
86         int installTimeout(ScheduledAction*, int timeout, bool singleShot);
87         void removeTimeout(int timeoutId);
88
89         void dispatchMessage(const String&);
90
91         virtual void addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
92         virtual void removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
93         virtual bool dispatchEvent(PassRefPtr<Event>, ExceptionCode&);
94
95         void setOnmessage(PassRefPtr<EventListener> eventListener) { m_onmessageListener = eventListener; }
96         EventListener* onmessage() const { return m_onmessageListener.get(); }
97
98         typedef Vector<RefPtr<EventListener> > ListenerVector;
99         typedef HashMap<AtomicString, ListenerVector> EventListenersMap;
100         EventListenersMap& eventListeners() { return m_eventListeners; }
101
102         using RefCounted<WorkerContext>::ref;
103         using RefCounted<WorkerContext>::deref;
104
105     private:
106         virtual void refScriptExecutionContext() { ref(); }
107         virtual void derefScriptExecutionContext() { deref(); }
108         virtual void refEventTarget() { ref(); }
109         virtual void derefEventTarget() { deref(); }
110
111         WorkerContext(const KURL&, const String&, const String& encoding, WorkerThread*);
112
113         virtual const KURL& virtualURL() const;
114         virtual KURL virtualCompleteURL(const String&) const;
115
116         KURL m_url;
117         String m_userAgent;
118         String m_encoding;
119         RefPtr<WorkerLocation> m_location;
120         mutable RefPtr<WorkerNavigator> m_navigator;
121
122         OwnPtr<WorkerScriptController> m_script;
123         WorkerThread* m_thread;
124
125         RefPtr<EventListener> m_onmessageListener;
126         EventListenersMap m_eventListeners;
127     };
128
129 } // namespace WebCore
130
131 #endif // ENABLE(WORKERS)
132
133 #endif // WorkerContext_h