Web Inspector: use single method for retrieving evaluation context in the runtime...
[WebKit-https.git] / Source / WebCore / inspector / InspectorRuntimeAgent.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef InspectorRuntimeAgent_h
32 #define InspectorRuntimeAgent_h
33
34 #if ENABLE(INSPECTOR)
35
36 #include "InspectorBaseAgent.h"
37 #include "ScriptState.h"
38 #include <wtf/Forward.h>
39 #include <wtf/Noncopyable.h>
40
41 namespace WebCore {
42
43 class InjectedScriptManager;
44 class InspectorArray;
45 class InspectorFrontend;
46 class InspectorObject;
47 class InspectorValue;
48 class InstrumentingAgents;
49 class ScriptDebugServer;
50 class WorkerContext;
51
52 typedef String ErrorString;
53
54 class InspectorRuntimeAgent : public InspectorBaseAgent<InspectorRuntimeAgent>, public InspectorBackendDispatcher::RuntimeCommandHandler {
55     WTF_MAKE_NONCOPYABLE(InspectorRuntimeAgent);
56 public:
57     virtual ~InspectorRuntimeAgent();
58
59     // Part of the protocol.
60     virtual void evaluate(ErrorString*,
61                   const String& expression,
62                   const String* objectGroup,
63                   const bool* includeCommandLineAPI,
64                   const bool* doNotPauseOnExceptionsAndMuteConsole,
65                   const String* frameId,
66                   const bool* returnByValue,
67                   RefPtr<TypeBuilder::Runtime::RemoteObject>& result,
68                   TypeBuilder::OptOutput<bool>* wasThrown);
69     virtual void callFunctionOn(ErrorString*,
70                         const String& objectId,
71                         const String& expression,
72                         const RefPtr<InspectorArray>* optionalArguments,
73                         const bool* doNotPauseOnExceptionsAndMuteConsole,
74                         const bool* returnByValue,
75                         RefPtr<TypeBuilder::Runtime::RemoteObject>& result,
76                         TypeBuilder::OptOutput<bool>* wasThrown);
77     virtual void releaseObject(ErrorString*, const String& objectId);
78     virtual void getProperties(ErrorString*, const String& objectId, const bool* ownProperties, RefPtr<TypeBuilder::Array<TypeBuilder::Runtime::PropertyDescriptor> >& result);
79     virtual void releaseObjectGroup(ErrorString*, const String& objectGroup);
80     virtual void run(ErrorString*);
81
82 #if ENABLE(JAVASCRIPT_DEBUGGER)
83     void setScriptDebugServer(ScriptDebugServer*);
84 #if ENABLE(WORKERS)
85     void pauseWorkerContext(WorkerContext*);
86 #endif
87 #endif
88
89 protected:
90     InspectorRuntimeAgent(InstrumentingAgents*, InspectorState*, InjectedScriptManager*);
91     virtual ScriptState* scriptStateForEval(ErrorString*, const String* frameId) = 0;
92
93     virtual void muteConsole() = 0;
94     virtual void unmuteConsole() = 0;
95
96 private:
97     InjectedScriptManager* m_injectedScriptManager;
98 #if ENABLE(JAVASCRIPT_DEBUGGER)
99     ScriptDebugServer* m_scriptDebugServer;
100 #endif
101     bool m_paused;
102 };
103
104 } // namespace WebCore
105
106 #endif // ENABLE(INSPECTOR)
107 #endif // InspectorRuntimeAgent_h