2010-12-22 Sheriff Bot <webkit.review.bot@gmail.com>
[WebKit-https.git] / WebCore / inspector / InspectorDebuggerAgent.h
1 /*
2  * Copyright (C) 2010 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 InspectorDebuggerAgent_h
31 #define InspectorDebuggerAgent_h
32
33 #if ENABLE(JAVASCRIPT_DEBUGGER) && ENABLE(INSPECTOR)
34 #include "ScriptBreakpoint.h"
35 #include "ScriptDebugListener.h"
36 #include "ScriptState.h"
37 #include <wtf/Forward.h>
38 #include <wtf/HashMap.h>
39 #include <wtf/PassOwnPtr.h>
40 #include <wtf/text/StringHash.h>
41
42 namespace WebCore {
43 class InjectedScriptHost;
44 class InspectorController;
45 class InspectorFrontend;
46 class InspectorObject;
47 class InspectorValue;
48
49 enum DebuggerEventType {
50     JavaScriptPauseEventType,
51     JavaScriptBreakpointEventType,
52     NativeBreakpointDebuggerEventType
53 };
54
55 class InspectorDebuggerAgent : public ScriptDebugListener, public Noncopyable {
56 public:
57     static PassOwnPtr<InspectorDebuggerAgent> create(InspectorController*, InspectorFrontend*);
58     virtual ~InspectorDebuggerAgent();
59
60     static bool isDebuggerAlwaysEnabled();
61
62     void activateBreakpoints();
63     void deactivateBreakpoints();
64     void setBreakpoint(const String& sourceID, unsigned lineNumber, bool enabled, const String& condition, bool* success, unsigned int* actualLineNumber);
65     void removeBreakpoint(const String& sourceID, unsigned lineNumber);
66
67     void editScriptSource(const String& sourceID, const String& newContent, bool* success, String* result, RefPtr<InspectorValue>* newCallFrames);
68     void getScriptSource(const String& sourceID, String* scriptSource);
69
70     void schedulePauseOnNextStatement(DebuggerEventType type, PassRefPtr<InspectorValue> data);
71     void cancelPauseOnNextStatement();
72     void breakProgram(DebuggerEventType type, PassRefPtr<InspectorValue> data);
73     void pause();
74     void resume();
75     void stepOverStatement();
76     void stepIntoStatement();
77     void stepOutOfFunction();
78
79     void setPauseOnExceptionsState(long pauseState, long* newState);
80     long pauseOnExceptionsState();
81
82     void clearForPageNavigation();
83
84     static String md5Base16(const String& string);
85
86 private:
87     InspectorDebuggerAgent(InspectorController*, InspectorFrontend*);
88
89     PassRefPtr<InspectorValue> currentCallFrames();
90
91     void loadBreakpoints();
92     void saveBreakpoints();
93
94     virtual void didParseSource(const String& sourceID, const String& url, const String& data, int firstLine, ScriptWorldType);
95     virtual void failedToParseSource(const String& url, const String& data, int firstLine, int errorLine, const String& errorMessage);
96     virtual void didPause(ScriptState*);
97     virtual void didContinue();
98
99     InspectorController* m_inspectorController;
100     InspectorFrontend* m_frontend;
101     ScriptState* m_pausedScriptState;
102     HashMap<String, String> m_sourceIDToURL;
103     HashMap<String, String> m_scriptIDToContent;
104     HashMap<String, SourceBreakpoints> m_stickyBreakpoints;
105     HashMap<String, unsigned> m_breakpointsMapping;
106     bool m_breakpointsLoaded;
107     static InspectorDebuggerAgent* s_debuggerAgentOnBreakpoint;
108     RefPtr<InspectorObject> m_breakProgramDetails;
109     bool m_javaScriptPauseScheduled;
110 };
111
112 } // namespace WebCore
113
114 #endif // ENABLE(JAVASCRIPT_DEBUGGER) && ENABLE(INSPECTOR)
115
116 #endif // !defined(InspectorDebuggerAgent_h)