fa0ee5d1db6e444368e6326d03fc3b59a06c2f3e
[WebKit-https.git] / Source / WebCore / bindings / js / ScriptDebugServer.h
1 /*
2  * Copyright (C) 2008, 2013 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 "ScriptBreakpoint.h"
36 #include "ScriptDebugListener.h"
37 #include "Timer.h"
38 #include <bindings/ScriptObject.h>
39 #include <debugger/Debugger.h>
40 #include <wtf/HashMap.h>
41 #include <wtf/HashSet.h>
42 #include <wtf/RefPtr.h>
43 #include <wtf/Vector.h>
44 #include <wtf/text/TextPosition.h>
45 #include <wtf/text/WTFString.h>
46
47 namespace JSC {
48 class DebuggerCallFrame;
49 class JSGlobalObject;
50 class ExecState;
51 }
52
53 namespace WebCore {
54
55 class ScriptDebugServer : public JSC::Debugger {
56     WTF_MAKE_NONCOPYABLE(ScriptDebugServer); WTF_MAKE_FAST_ALLOCATED;
57 public:
58     JSC::BreakpointID setBreakpoint(JSC::SourceID, const ScriptBreakpoint&, unsigned* actualLineNumber, unsigned* actualColumnNumber);
59     void removeBreakpoint(JSC::BreakpointID);
60     void clearBreakpoints();
61
62     void recompileAllJSFunctionsSoon();
63     virtual void recompileAllJSFunctions() = 0;
64
65     const Vector<ScriptBreakpointAction>& getActionsForBreakpoint(JSC::BreakpointID);
66
67     class Task {
68         WTF_MAKE_FAST_ALLOCATED;
69     public:
70         virtual ~Task() { }
71         virtual void run() = 0;
72     };
73
74 protected:
75     typedef HashSet<ScriptDebugListener*> ListenerSet;
76     typedef void (ScriptDebugServer::*JavaScriptExecutionCallback)(ScriptDebugListener*);
77
78     ScriptDebugServer(bool isInWorkerThread = false);
79     ~ScriptDebugServer();
80
81     virtual ListenerSet* getListenersForGlobalObject(JSC::JSGlobalObject*) = 0;
82     virtual void didPause(JSC::JSGlobalObject*) = 0;
83     virtual void didContinue(JSC::JSGlobalObject*) = 0;
84
85     virtual void runEventLoopWhilePaused() = 0;
86
87     virtual bool isContentScript(JSC::ExecState*);
88
89     bool evaluateBreakpointAction(const ScriptBreakpointAction&);
90
91     void dispatchFunctionToListeners(JavaScriptExecutionCallback, JSC::JSGlobalObject*);
92     void dispatchFunctionToListeners(const ListenerSet& listeners, JavaScriptExecutionCallback callback);
93     void dispatchDidPause(ScriptDebugListener*);
94     void dispatchDidContinue(ScriptDebugListener*);
95     void dispatchDidParseSource(const ListenerSet& listeners, JSC::SourceProvider*, bool isContentScript);
96     void dispatchFailedToParseSource(const ListenerSet& listeners, JSC::SourceProvider*, int errorLine, const String& errorMessage);
97     void dispatchDidSampleProbe(JSC::ExecState*, int probeIdentifier, const Deprecated::ScriptValue& sample);
98
99     bool m_doneProcessingDebuggerEvents;
100
101 private:
102     typedef Vector<ScriptBreakpointAction> BreakpointActions;
103     typedef HashMap<JSC::BreakpointID, BreakpointActions> BreakpointIDToActionsMap;
104
105     virtual void sourceParsed(JSC::ExecState*, JSC::SourceProvider*, int errorLine, const String& errorMsg) override final;
106     virtual bool needPauseHandling(JSC::JSGlobalObject*) override final;
107     virtual void handleBreakpointHit(const JSC::Breakpoint&) override final;
108     virtual void handleExceptionInBreakpointCondition(JSC::ExecState*, JSC::JSValue exception) const override final;
109     virtual void handlePause(JSC::Debugger::ReasonForPause, JSC::JSGlobalObject*) override final;
110     virtual void notifyDoneProcessingDebuggerEvents() override final;
111
112     void recompileAllJSFunctionsTimerFired(Timer<ScriptDebugServer>&);
113
114     unsigned m_hitCount;
115     bool m_callingListeners;
116     BreakpointIDToActionsMap m_breakpointIDToActions;
117     Timer<ScriptDebugServer> m_recompileTimer;
118
119     friend class DebuggerCallFrameScope;
120 };
121
122 } // namespace WebCore
123
124 #endif // ENABLE(JAVASCRIPT_DEBUGGER)
125
126 #endif // ScriptDebugServer_h