Part 2 of removing PlatformString.h, remove PlatformString.h
[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 "ScopedPersistent.h"
37 #include "ScriptBreakpoint.h"
38 #include "Timer.h"
39 #include <v8-debug.h>
40 #include <wtf/HashMap.h>
41 #include <wtf/Noncopyable.h>
42 #include <wtf/PassOwnPtr.h>
43 #include <wtf/Vector.h>
44 #include <wtf/text/StringHash.h>
45 #include <wtf/text/WTFString.h>
46
47 namespace WebCore {
48
49 class ScriptDebugListener;
50 class ScriptObject;
51 class ScriptState;
52 class ScriptValue;
53
54 class ScriptDebugServer {
55     WTF_MAKE_NONCOPYABLE(ScriptDebugServer);
56 public:
57     String setBreakpoint(const String& sourceID, const ScriptBreakpoint&, int* actualLineNumber, int* actualColumnNumber);
58     void removeBreakpoint(const String& breakpointId);
59     void clearBreakpoints();
60     void setBreakpointsActivated(bool activated);
61     void activateBreakpoints() { setBreakpointsActivated(true); }
62     void deactivateBreakpoints() { setBreakpointsActivated(false); }
63
64     enum PauseOnExceptionsState {
65         DontPauseOnExceptions,
66         PauseOnAllExceptions,
67         PauseOnUncaughtExceptions
68     };
69     PauseOnExceptionsState pauseOnExceptionsState();
70     void setPauseOnExceptionsState(PauseOnExceptionsState pauseOnExceptionsState);
71
72     void setPauseOnNextStatement(bool pause);
73     void breakProgram();
74     void continueProgram();
75     void stepIntoStatement();
76     void stepOverStatement();
77     void stepOutOfFunction();
78
79     bool canSetScriptSource();
80     bool setScriptSource(const String& sourceID, const String& newContent, bool preview, String* error, ScriptValue* newCallFrames, ScriptObject* result);
81     void updateCallStack(ScriptValue* callFrame);
82
83     bool causesRecompilation() { return false; }
84     bool supportsSeparateScriptCompilationAndExecution() { return true; }
85
86     void recompileAllJSFunctionsSoon() { }
87     void recompileAllJSFunctions(Timer<ScriptDebugServer>* = 0) { }
88
89     class Task {
90     public:
91         virtual ~Task() { }
92         virtual void run() = 0;
93     };
94     static void interruptAndRun(PassOwnPtr<Task>, v8::Isolate* = 0);
95     void runPendingTasks();
96
97     bool isPaused();
98
99     v8::Local<v8::Value> functionScopes(v8::Handle<v8::Function>);
100
101     virtual void compileScript(ScriptState*, const String& expression, const String& sourceURL, String* scriptId, String* exceptionMessage);
102     virtual void clearCompiledScripts();
103     virtual void runScript(ScriptState*, const String& scriptId, ScriptValue* result, bool* wasThrown, String* exceptionMessage);
104
105 protected:
106     ScriptDebugServer();
107     ~ScriptDebugServer() { }
108     
109     ScriptValue currentCallFrame();
110
111     virtual ScriptDebugListener* getDebugListenerForContext(v8::Handle<v8::Context>) = 0;
112     virtual void runMessageLoopOnPause(v8::Handle<v8::Context>) = 0;
113     virtual void quitMessageLoopOnPause() = 0;
114
115     static v8::Handle<v8::Value> breakProgramCallback(const v8::Arguments& args);
116     void breakProgram(v8::Handle<v8::Object> executionState, v8::Handle<v8::Value> exception);
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
125     v8::Local<v8::Value> callDebuggerMethod(const char* functionName, int argc, v8::Handle<v8::Value> argv[]);
126
127     PauseOnExceptionsState m_pauseOnExceptionsState;
128     ScopedPersistent<v8::Object> m_debuggerScript;
129     ScopedPersistent<v8::Object> m_executionState;
130     v8::Local<v8::Context> m_pausedContext;
131
132     bool m_breakpointsActivated;
133     ScopedPersistent<v8::FunctionTemplate> m_breakProgramCallbackTemplate;
134     HashMap<String, OwnPtr<ScopedPersistent<v8::Script> > > m_compiledScripts;
135 };
136
137 } // namespace WebCore
138
139 #endif // ENABLE(JAVASCRIPT_DEBUGGER)
140
141 #endif // ScriptDebugServer_h