Move WebCore into Source
[WebKit-https.git] / Source / WebCore / bindings / js / ScriptDebugServer.h
1 /*
2  * Copyright (C) 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2010 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 "PlatformString.h"
37 #include "ScriptBreakpoint.h"
38 #include "Timer.h"
39
40 #include <debugger/Debugger.h>
41 #include <runtime/UString.h>
42 #include <wtf/HashMap.h>
43 #include <wtf/HashSet.h>
44 #include <wtf/RefPtr.h>
45
46 namespace JSC {
47 class DebuggerCallFrame;
48 class JSGlobalObject;
49 }
50 namespace WebCore {
51
52 class Frame;
53 class FrameView;
54 class Page;
55 class PageGroup;
56 class ScriptDebugListener;
57 class JavaScriptCallFrame;
58
59 class ScriptDebugServer : JSC::Debugger, public Noncopyable {
60 public:
61     static ScriptDebugServer& shared();
62
63     void addListener(ScriptDebugListener*, Page*);
64     void removeListener(ScriptDebugListener*, Page*);
65
66     String setBreakpoint(const String& sourceID, unsigned lineNumber, const String& condition, bool enabled, unsigned* actualLineNumber);
67     void removeBreakpoint(const String& breakpointId);
68     void clearBreakpoints();
69     void setBreakpointsActivated(bool activated);
70     void activateBreakpoints() { setBreakpointsActivated(true); }
71     void deactivateBreakpoints() { setBreakpointsActivated(false); }
72
73     enum PauseOnExceptionsState {
74         DontPauseOnExceptions,
75         PauseOnAllExceptions,
76         PauseOnUncaughtExceptions
77     };
78     PauseOnExceptionsState pauseOnExceptionsState() const { return m_pauseOnExceptionsState; }
79     void setPauseOnExceptionsState(PauseOnExceptionsState);
80
81     void setPauseOnNextStatement(bool pause);
82     void breakProgram();
83     void continueProgram();
84     void stepIntoStatement();
85     void stepOverStatement();
86     void stepOutOfFunction();
87
88     bool editScriptSource(const String& sourceID, const String& newContent, String& newSourceOrErrorMessage);
89
90     void recompileAllJSFunctionsSoon();
91     void recompileAllJSFunctions(Timer<ScriptDebugServer>* = 0);
92
93     JavaScriptCallFrame* currentCallFrame();
94
95     void pageCreated(Page*);
96
97     bool isDebuggerAlwaysEnabled();
98
99 private:
100     typedef HashSet<ScriptDebugListener*> ListenerSet;
101     typedef void (ScriptDebugServer::*JavaScriptExecutionCallback)(ScriptDebugListener*);
102
103     ScriptDebugServer();
104     ~ScriptDebugServer();
105
106     bool hasBreakpoint(intptr_t sourceID, unsigned lineNumber) const;
107     bool hasListenersInterestedInPage(Page*);
108
109     void setJavaScriptPaused(const PageGroup&, bool paused);
110     void setJavaScriptPaused(Page*, bool paused);
111     void setJavaScriptPaused(Frame*, bool paused);
112     void setJavaScriptPaused(FrameView*, bool paused);
113
114     void dispatchFunctionToListeners(JavaScriptExecutionCallback, Page*);
115     void dispatchFunctionToListeners(const ListenerSet& listeners, JavaScriptExecutionCallback callback);
116     void dispatchDidPause(ScriptDebugListener*);
117     void dispatchDidContinue(ScriptDebugListener*);
118     void dispatchDidParseSource(const ListenerSet& listeners, const JSC::SourceCode& source, enum ScriptWorldType);
119     void dispatchFailedToParseSource(const ListenerSet& listeners, const JSC::SourceCode& source, int errorLine, const String& errorMessage);
120
121     void pauseIfNeeded(Page*);
122
123     virtual void detach(JSC::JSGlobalObject*);
124
125     virtual void sourceParsed(JSC::ExecState*, const JSC::SourceCode&, int errorLine, const JSC::UString& errorMsg);
126     virtual void callEvent(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineNumber);
127     virtual void atStatement(const JSC::DebuggerCallFrame&, intptr_t sourceID, int firstLine);
128     virtual void returnEvent(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineNumber);
129     virtual void exception(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineNumber, bool hasHandler);
130     virtual void willExecuteProgram(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineno);
131     virtual void didExecuteProgram(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineno);
132     virtual void didReachBreakpoint(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineno);
133
134     void didAddListener(Page*);
135     void didRemoveListener(Page*);
136
137     typedef HashMap<Page*, ListenerSet*> PageListenersMap;
138     typedef HashMap<intptr_t, SourceBreakpoints> BreakpointsMap;
139
140     PageListenersMap m_pageListenersMap;
141     bool m_callingListeners;
142     PauseOnExceptionsState m_pauseOnExceptionsState;
143     bool m_pauseOnNextStatement;
144     bool m_paused;
145     Page* m_pausedPage;
146     bool m_doneProcessingDebuggerEvents;
147     bool m_breakpointsActivated;
148     JavaScriptCallFrame* m_pauseOnCallFrame;
149     RefPtr<JavaScriptCallFrame> m_currentCallFrame;
150     BreakpointsMap m_breakpoints;
151     Timer<ScriptDebugServer> m_recompileTimer;
152 };
153
154 } // namespace WebCore
155
156 #endif // ENABLE(JAVASCRIPT_DEBUGGER)
157
158 #endif // ScriptDebugServer_h