Move WebCore into Source
[WebKit-https.git] / Source / WebCore / bindings / v8 / ScriptDebugServer.h
1 /*
2  * Copyright (c) 2010, 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 ScriptDebugServer_h
32 #define ScriptDebugServer_h
33
34 #if ENABLE(JAVASCRIPT_DEBUGGER)
35
36 #include "JavaScriptCallFrame.h"
37 #include "PlatformString.h"
38 #include "ScriptBreakpoint.h"
39 #include "Timer.h"
40 #include <v8-debug.h>
41 #include <wtf/HashMap.h>
42 #include <wtf/Noncopyable.h>
43 #include <wtf/PassOwnPtr.h>
44 #include <wtf/text/StringHash.h>
45
46 namespace WebCore {
47
48 class Page;
49 class ScriptDebugListener;
50
51 class ScriptDebugServer : public Noncopyable {
52 public:
53     static ScriptDebugServer& shared();
54
55     void addListener(ScriptDebugListener*, Page*);
56     void removeListener(ScriptDebugListener*, Page*);
57
58     String setBreakpoint(const String& sourceID, unsigned lineNumber, const String& condition, bool enabled, unsigned* actualLineNumber);
59     void removeBreakpoint(const String& breakpointId);
60     void clearBreakpoints();
61     void setBreakpointsActivated(bool activated);
62     void activateBreakpoints() { setBreakpointsActivated(true); }
63     void deactivateBreakpoints() { setBreakpointsActivated(false); }
64
65     enum PauseOnExceptionsState {
66         DontPauseOnExceptions,
67         PauseOnAllExceptions,
68         PauseOnUncaughtExceptions
69     };
70     PauseOnExceptionsState pauseOnExceptionsState();
71     void setPauseOnExceptionsState(PauseOnExceptionsState pauseOnExceptionsState);
72
73     void setPauseOnNextStatement(bool pause);
74     void breakProgram();
75     void continueProgram();
76     void stepIntoStatement();
77     void stepOverStatement();
78     void stepOutOfFunction();
79
80     bool editScriptSource(const String& sourceID, const String& newContent, String& newSourceOrErrorMessage);
81
82     void recompileAllJSFunctionsSoon() { }
83     void recompileAllJSFunctions(Timer<ScriptDebugServer>* = 0) { }
84
85     void pageCreated(Page*) { }
86
87     // v8-specific methods.
88     void setDebuggerScriptSource(const String& scriptSource);
89
90     class ClientMessageLoop {
91     public:
92         virtual ~ClientMessageLoop() { }
93         virtual void run(Page*) = 0;
94         virtual void quitNow() = 0;
95     };
96     void setClientMessageLoop(PassOwnPtr<ClientMessageLoop> clientMessageLoop) { m_clientMessageLoop = clientMessageLoop; }
97
98     PassRefPtr<JavaScriptCallFrame> currentCallFrame();
99
100     void setEnabled(bool);
101     bool isDebuggerAlwaysEnabled();
102
103     class Task {
104     public:
105         virtual ~Task() { }
106         virtual void run() = 0;
107     };
108     static void interruptAndRun(PassOwnPtr<Task>);
109     void runPendingTasks();
110
111 private:
112     ScriptDebugServer();
113     ~ScriptDebugServer() { }
114
115     static v8::Handle<v8::Value> breakProgramCallback(const v8::Arguments& args);
116     void breakProgram(v8::Handle<v8::Object> executionState);
117
118     static void v8DebugEventCallback(const v8::Debug::EventDetails& eventDetails);
119     void handleV8DebugEvent(const v8::Debug::EventDetails& eventDetails);
120
121     void dispatchDidParseSource(ScriptDebugListener* listener, v8::Handle<v8::Object> sourceObject);
122
123     void ensureDebuggerScriptCompiled();
124     void didResume();
125
126     typedef HashMap<Page*, ScriptDebugListener*> ListenersMap;
127     ListenersMap m_listenersMap;
128     String m_debuggerScriptSource;
129     PauseOnExceptionsState m_pauseOnExceptionsState;
130     OwnHandle<v8::Object> m_debuggerScript;
131     RefPtr<JavaScriptCallFrame> m_currentCallFrame;
132     OwnHandle<v8::Object> m_executionState;
133     OwnPtr<ClientMessageLoop> m_clientMessageLoop;
134     Page* m_pausedPage;
135     v8::Local<v8::Context> m_pausedPageContext;
136     bool m_enabled;
137
138     bool m_breakpointsActivated;
139 };
140
141 } // namespace WebCore
142
143 #endif // ENABLE(JAVASCRIPT_DEBUGGER)
144
145 #endif // ScriptDebugServer_h