Part 2 of removing PlatformString.h, remove PlatformString.h
[WebKit-https.git] / Source / WebCore / bindings / js / ScriptDebugServer.h
1 /*
2  * Copyright (C) 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2010-2011 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef ScriptDebugServer_h
31 #define ScriptDebugServer_h
32
33 #if ENABLE(JAVASCRIPT_DEBUGGER)
34
35 #include "ScriptDebugListener.h"
36 #include "ScriptBreakpoint.h"
37 #include "Timer.h"
38 #include <debugger/Debugger.h>
39 #include <wtf/HashMap.h>
40 #include <wtf/HashSet.h>
41 #include <wtf/RefPtr.h>
42 #include <wtf/Vector.h>
43 #include <wtf/text/TextPosition.h>
44 #include <wtf/text/WTFString.h>
45
46 namespace JSC {
47 class DebuggerCallFrame;
48 class JSGlobalObject;
49 }
50 namespace WebCore {
51
52 class JavaScriptCallFrame;
53 class ScriptDebugListener;
54 class ScriptObject;
55 class ScriptValue;
56
57 class ScriptDebugServer : protected JSC::Debugger {
58     WTF_MAKE_NONCOPYABLE(ScriptDebugServer); WTF_MAKE_FAST_ALLOCATED;
59 public:
60     String setBreakpoint(const String& sourceID, const ScriptBreakpoint&, int* actualLineNumber, int* actualColumnNumber);
61     void removeBreakpoint(const String& breakpointId);
62     void clearBreakpoints();
63     void setBreakpointsActivated(bool activated);
64     void activateBreakpoints() { setBreakpointsActivated(true); }
65     void deactivateBreakpoints() { setBreakpointsActivated(false); }
66
67     enum PauseOnExceptionsState {
68         DontPauseOnExceptions,
69         PauseOnAllExceptions,
70         PauseOnUncaughtExceptions
71     };
72     PauseOnExceptionsState pauseOnExceptionsState() const { return m_pauseOnExceptionsState; }
73     void setPauseOnExceptionsState(PauseOnExceptionsState);
74
75     void setPauseOnNextStatement(bool pause);
76     void breakProgram();
77     void continueProgram();
78     void stepIntoStatement();
79     void stepOverStatement();
80     void stepOutOfFunction();
81
82     bool canSetScriptSource();
83     bool setScriptSource(const String& sourceID, const String& newContent, bool preview, String* error, ScriptValue* newCallFrames, ScriptObject* result);
84     void updateCallStack(ScriptValue* callFrame);
85
86     bool causesRecompilation() { return true; }
87     bool supportsSeparateScriptCompilationAndExecution() { return false; }
88
89     void recompileAllJSFunctionsSoon();
90     virtual void recompileAllJSFunctions(Timer<ScriptDebugServer>* = 0) = 0;
91
92     bool isPaused() { return m_paused; }
93
94     void compileScript(ScriptState*, const String& expression, const String& sourceURL, String* scriptId, String* exceptionMessage);
95     void clearCompiledScripts();
96     void runScript(ScriptState*, const String& scriptId, ScriptValue* result, bool* wasThrown, String* exceptionMessage);
97
98     class Task {
99     public:
100         virtual ~Task() { }
101         virtual void run() = 0;
102     };
103
104 protected:
105     typedef HashSet<ScriptDebugListener*> ListenerSet;
106     typedef void (ScriptDebugServer::*JavaScriptExecutionCallback)(ScriptDebugListener*);
107
108     ScriptDebugServer();
109     ~ScriptDebugServer();
110
111     virtual ListenerSet* getListenersForGlobalObject(JSC::JSGlobalObject*) = 0;
112     virtual void didPause(JSC::JSGlobalObject*) = 0;
113     virtual void didContinue(JSC::JSGlobalObject*) = 0;
114
115     bool hasBreakpoint(intptr_t sourceID, const TextPosition&) const;
116
117     void dispatchFunctionToListeners(JavaScriptExecutionCallback, JSC::JSGlobalObject*);
118     void dispatchFunctionToListeners(const ListenerSet& listeners, JavaScriptExecutionCallback callback);
119     void dispatchDidPause(ScriptDebugListener*);
120     void dispatchDidContinue(ScriptDebugListener*);
121     void dispatchDidParseSource(const ListenerSet& listeners, JSC::SourceProvider*, bool isContentScript);
122     void dispatchFailedToParseSource(const ListenerSet& listeners, JSC::SourceProvider*, int errorLine, const String& errorMessage);
123
124     void createCallFrameAndPauseIfNeeded(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineNumber, int columnNumber);
125     void updateCallFrameAndPauseIfNeeded(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineNumber, int columnNumber);
126     void pauseIfNeeded(JSC::JSGlobalObject* dynamicGlobalObject);
127
128     virtual void detach(JSC::JSGlobalObject*);
129
130     virtual void sourceParsed(JSC::ExecState*, JSC::SourceProvider*, int errorLine, const String& errorMsg);
131     virtual void callEvent(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineNumber, int columnNumber);
132     virtual void atStatement(const JSC::DebuggerCallFrame&, intptr_t sourceID, int firstLine, int columnNumber);
133     virtual void returnEvent(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineNumber, int columnNumber);
134     virtual void exception(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineNumber, int columnNumber, bool hasHandler);
135     virtual void willExecuteProgram(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineno, int columnNumber);
136     virtual void didExecuteProgram(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineno, int columnNumber);
137     virtual void didReachBreakpoint(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineno, int columnNumber);
138
139
140     void updateCurrentStatementPosition(intptr_t, int);
141
142     typedef Vector<ScriptBreakpoint> BreakpointsInLine;
143     typedef HashMap<long, BreakpointsInLine> LineToBreakpointMap;
144     typedef HashMap<intptr_t, LineToBreakpointMap> SourceIdToBreakpointsMap;
145
146     bool m_callingListeners;
147     PauseOnExceptionsState m_pauseOnExceptionsState;
148     bool m_pauseOnNextStatement;
149     bool m_paused;
150     bool m_doneProcessingDebuggerEvents;
151     bool m_breakpointsActivated;
152     JavaScriptCallFrame* m_pauseOnCallFrame;
153     RefPtr<JavaScriptCallFrame> m_currentCallFrame;
154     SourceIdToBreakpointsMap m_sourceIdToBreakpoints;
155     Timer<ScriptDebugServer> m_recompileTimer;
156
157     Vector<String> m_currentSourceCode;
158     intptr_t m_currentSourceID;
159     ScriptBreakpoint m_currentStatementPosition;
160 };
161
162 } // namespace WebCore
163
164 #endif // ENABLE(JAVASCRIPT_DEBUGGER)
165
166 #endif // ScriptDebugServer_h