Web Inspector: document Debugger.paused, introduce types for ids in Debugger domain.
[WebKit.git] / Source / WebCore / inspector / InspectorDebuggerAgent.h
1 /*
2  * Copyright (C) 2010 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 InspectorDebuggerAgent_h
31 #define InspectorDebuggerAgent_h
32
33 #if ENABLE(JAVASCRIPT_DEBUGGER) && ENABLE(INSPECTOR)
34 #include "InjectedScript.h"
35 #include "InspectorFrontend.h"
36 #include "ScriptBreakpoint.h"
37 #include "ScriptDebugListener.h"
38 #include "ScriptState.h"
39 #include <wtf/Forward.h>
40 #include <wtf/HashMap.h>
41 #include <wtf/PassOwnPtr.h>
42 #include <wtf/PassRefPtr.h>
43 #include <wtf/Vector.h>
44 #include <wtf/text/StringHash.h>
45
46 namespace WebCore {
47
48 class InjectedScriptManager;
49 class InspectorFrontend;
50 class InspectorArray;
51 class InspectorObject;
52 class InspectorState;
53 class InspectorValue;
54 class InstrumentingAgents;
55 class ScriptDebugServer;
56 class ScriptValue;
57
58 typedef String ErrorString;
59
60 class InspectorDebuggerAgent : public ScriptDebugListener {
61     WTF_MAKE_NONCOPYABLE(InspectorDebuggerAgent); WTF_MAKE_FAST_ALLOCATED;
62 public:
63     static const char* backtraceObjectGroup;
64
65     virtual ~InspectorDebuggerAgent();
66
67     void enable(ErrorString*);
68     void disable(ErrorString*);
69     bool enabled();
70     void restore();
71     void setFrontend(InspectorFrontend*);
72     void clearFrontend();
73
74     void inspectedURLChanged(const String& url);
75
76     // Part of the protocol.
77     void setBreakpointsActive(ErrorString*, bool active);
78
79     void setBreakpointByUrl(ErrorString*, int lineNumber, const String* const optionalURL, const String* const optionalURLRegex, const int* const optionalColumnNumber, const String* const optionalCondition, String* breakpointId, RefPtr<InspectorArray>* locations);
80     void setBreakpoint(ErrorString*, PassRefPtr<InspectorObject> location, const String* const optionalCondition, String* breakpointId, RefPtr<InspectorObject>* actualLocation);
81     void removeBreakpoint(ErrorString*, const String& breakpointId);
82     void continueToLocation(ErrorString*, PassRefPtr<InspectorObject> location);
83
84     void setScriptSource(ErrorString*, const String& scriptId, const String& newContent, const bool* const preview, RefPtr<InspectorArray>* newCallFrames, RefPtr<InspectorObject>* result);
85     void getScriptSource(ErrorString*, const String& scriptId, String* scriptSource);
86     void schedulePauseOnNextStatement(const String& breakReason, PassRefPtr<InspectorObject> data);
87     void cancelPauseOnNextStatement();
88     void breakProgram(const String& breakReason, PassRefPtr<InspectorObject> data);
89     void pause(ErrorString*);
90     void resume(ErrorString*);
91     void stepOver(ErrorString*);
92     void stepInto(ErrorString*);
93     void stepOut(ErrorString*);
94     void setPauseOnExceptions(ErrorString*, const String& pauseState);
95     void evaluateOnCallFrame(ErrorString*,
96                              const String& callFrameId,
97                              const String& expression,
98                              const String* const objectGroup,
99                              const bool* const includeCommandLineAPI,
100                              const bool* const returnByValue,
101                              RefPtr<InspectorObject>* result,
102                              bool* wasThrown);
103
104     class Listener {
105     public:
106         virtual ~Listener() { }
107         virtual void debuggerWasEnabled() = 0;
108         virtual void debuggerWasDisabled() = 0;
109     };
110     void setListener(Listener* listener) { m_listener = listener; }
111
112     virtual ScriptDebugServer& scriptDebugServer() = 0;
113
114 protected:
115     InspectorDebuggerAgent(InstrumentingAgents*, InspectorState*, InjectedScriptManager*);
116
117     virtual void startListeningScriptDebugServer() = 0;
118     virtual void stopListeningScriptDebugServer() = 0;
119
120 private:
121     void enable();
122     void disable();
123
124     PassRefPtr<InspectorArray> currentCallFrames();
125
126     virtual void didParseSource(const String& scriptId, const Script&);
127     virtual void failedToParseSource(const String& url, const String& data, int firstLine, int errorLine, const String& errorMessage);
128     virtual void didPause(ScriptState*, const ScriptValue& callFrames, const ScriptValue& exception);
129     virtual void didContinue();
130
131     PassRefPtr<InspectorObject> resolveBreakpoint(const String& breakpointId, const String& scriptId, const ScriptBreakpoint&);
132     void clear();
133     bool assertPaused(ErrorString*);
134     void clearBreakDetails();
135
136     typedef HashMap<String, Script> ScriptsMap;
137     typedef HashMap<String, Vector<String> > BreakpointIdToDebugServerBreakpointIdsMap;
138
139     InstrumentingAgents* m_instrumentingAgents;
140     InspectorState* m_inspectorState;
141     InjectedScriptManager* m_injectedScriptManager;
142     InspectorFrontend::Debugger* m_frontend;
143     ScriptState* m_pausedScriptState;
144     ScriptValue m_currentCallStack;
145     ScriptsMap m_scripts;
146     BreakpointIdToDebugServerBreakpointIdsMap m_breakpointIdToDebugServerBreakpointIds;
147     String m_continueToLocationBreakpointId;
148     String m_breakReason;
149     RefPtr<InspectorObject> m_breakAuxData;
150     bool m_javaScriptPauseScheduled;
151     Listener* m_listener;
152 };
153
154 } // namespace WebCore
155
156 #endif // ENABLE(JAVASCRIPT_DEBUGGER) && ENABLE(INSPECTOR)
157
158 #endif // !defined(InspectorDebuggerAgent_h)