Not reviewed, build fix.
[WebKit.git] / WebCore / bindings / v8 / ScriptController.h
1 /*
2  * Copyright (C) 2008, 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef ScriptController_h
32 #define ScriptController_h
33
34 #include "ScriptInstance.h"
35 #include "ScriptValue.h"
36
37 #include "V8Proxy.h"
38
39 #include <v8.h>
40
41 #include <wtf/HashMap.h>
42 #include <wtf/RefCounted.h>
43 #include <wtf/Vector.h>
44
45 struct NPObject;
46
47 namespace WebCore {
48
49 class DOMWrapperWorld;
50 class Event;
51 class Frame;
52 class HTMLPlugInElement;
53 class ScriptSourceCode;
54 class String;
55 class Widget;
56 class XSSAuditor;
57
58 enum ReasonForCallingCanExecuteScripts {
59     AboutToExecuteScript,
60     NotAboutToExecuteScript
61 };
62
63 class ScriptController {
64 public:
65     ScriptController(Frame*);
66     ~ScriptController();
67
68     // FIXME: V8Proxy should either be folded into ScriptController
69     // or this accessor should be made JSProxy*
70     V8Proxy* proxy() { return m_proxy.get(); }
71
72     ScriptValue executeScript(const ScriptSourceCode&);
73     ScriptValue executeScript(const String& script, bool forceUserGesture = false);
74
75     // Returns true if argument is a JavaScript URL.
76     bool executeIfJavaScriptURL(const KURL&, bool userGesture = false, ShouldReplaceDocumentIfJavaScriptURL shouldReplaceDocumentIfJavaScriptURL = ReplaceDocumentIfJavaScriptURL);
77
78     // This function must be called from the main thread. It is safe to call it repeatedly.
79     static void initializeThreading();
80
81     // Evaluate a script file in the environment of this proxy.
82     // If succeeded, 'succ' is set to true and result is returned
83     // as a string.
84     ScriptValue evaluate(const ScriptSourceCode&);
85
86     void evaluateInIsolatedWorld(unsigned worldID, const Vector<ScriptSourceCode>&);
87
88     // Executes JavaScript in an isolated world. The script gets its own global scope,
89     // its own prototypes for intrinsic JavaScript objects (String, Array, and so-on),
90     // and its own wrappers for all DOM nodes and DOM constructors.
91     //
92     // If an isolated world with the specified ID already exists, it is reused.
93     // Otherwise, a new world is created.
94     //
95     // If the worldID is 0, a new world is always created.
96     //
97     // FIXME: Get rid of extensionGroup here.
98     void evaluateInIsolatedWorld(unsigned worldID, const Vector<ScriptSourceCode>&, int extensionGroup);
99
100     // Masquerade 'this' as the windowShell.
101     // This is a bit of a hack, but provides reasonable compatibility
102     // with what JSC does as well.
103     ScriptController* windowShell(DOMWrapperWorld*) { return this; }
104     ScriptController* existingWindowShell(DOMWrapperWorld*) { return this; }
105
106     XSSAuditor* xssAuditor() { return m_XSSAuditor.get(); }
107
108     void collectGarbage();
109
110     // Notify V8 that the system is running low on memory.
111     void lowMemoryNotification();
112
113     // Creates a property of the global object of a frame.
114     void bindToWindowObject(Frame*, const String& key, NPObject*);
115
116     PassScriptInstance createScriptInstanceForWidget(Widget*);
117
118     // Check if the javascript engine has been initialized.
119     bool haveInterpreter() const;
120
121     bool canExecuteScripts(ReasonForCallingCanExecuteScripts);
122
123     // FIXME: void* is a compile hack.
124     void attachDebugger(void*);
125
126     // --- Static methods assume we are running VM in single thread, ---
127     // --- and there is only one VM instance.                        ---
128
129     // Returns the frame for the entered context. See comments in
130     // V8Proxy::retrieveFrameForEnteredContext() for more information.
131     static Frame* retrieveFrameForEnteredContext();
132
133     // Returns the frame for the current context. See comments in
134     // V8Proxy::retrieveFrameForEnteredContext() for more information.
135     static Frame* retrieveFrameForCurrentContext();
136
137     // Check whether it is safe to access a frame in another domain.
138     static bool isSafeScript(Frame*);
139
140     // Pass command-line flags to the JS engine.
141     static void setFlags(const char* string, int length);
142
143     // Protect and unprotect the JS wrapper from garbage collected.
144     static void gcProtectJSWrapper(void*);
145     static void gcUnprotectJSWrapper(void*);
146
147     void finishedWithEvent(Event*);
148     void setEventHandlerLineNumber(int lineNumber);
149
150     void setProcessingTimerCallback(bool processingTimerCallback) { m_processingTimerCallback = processingTimerCallback; }
151     // FIXME: Currently we don't use the parameter world at all.
152     // See http://trac.webkit.org/changeset/54182
153     bool processingUserGesture(DOMWrapperWorld* world = 0) const;
154     bool anyPageIsProcessingUserGesture() const;
155
156     void setPaused(bool paused) { m_paused = paused; }
157     bool isPaused() const { return m_paused; }
158
159     const String* sourceURL() const { return m_sourceURL; } // 0 if we are not evaluating any script.
160
161     void clearWindowShell(bool = false);
162     void updateDocument();
163
164     void updateSecurityOrigin();
165     void clearScriptObjects();
166     void updatePlatformScriptObjects();
167     void cleanupScriptObjectsForPlugin(Widget*);
168
169 #if ENABLE(NETSCAPE_PLUGIN_API)
170     NPObject* createScriptObjectForPluginElement(HTMLPlugInElement*);
171     NPObject* windowScriptNPObject();
172 #endif
173
174     // Dummy method to avoid a bunch of ifdef's in WebCore.
175     void evaluateInWorld(const ScriptSourceCode&, DOMWrapperWorld*);
176     static void getAllWorlds(Vector<DOMWrapperWorld*>& worlds);
177
178 private:
179     Frame* m_frame;
180     const String* m_sourceURL;
181
182     bool m_inExecuteScript;
183
184     bool m_processingTimerCallback;
185     bool m_paused;
186
187     OwnPtr<V8Proxy> m_proxy;
188     typedef HashMap<Widget*, NPObject*> PluginObjectMap;
189
190     // A mapping between Widgets and their corresponding script object.
191     // This list is used so that when the plugin dies, we can immediately
192     // invalidate all sub-objects which are associated with that plugin.
193     // The frame keeps a NPObject reference for each item on the list.
194     PluginObjectMap m_pluginObjects;
195 #if ENABLE(NETSCAPE_PLUGIN_API)
196     NPObject* m_windowScriptNPObject;
197 #endif
198     // The XSSAuditor associated with this ScriptController.
199     OwnPtr<XSSAuditor> m_XSSAuditor;
200 };
201
202 } // namespace WebCore
203
204 #endif // ScriptController_h