915118b88d52c37281b89e2db3325f65a1ab1cb8
[WebKit-https.git] / Source / JavaScriptCore / inspector / agents / InspectorRuntimeAgent.h
1 /*
2  * Copyright (C) 2013, 2015 Apple Inc. All rights reserved.
3  * Copyright (C) 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 are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #pragma once
33
34 #include "InspectorBackendDispatchers.h"
35 #include "InspectorFrontendDispatchers.h"
36 #include "inspector/InspectorAgentBase.h"
37 #include <wtf/Forward.h>
38 #include <wtf/Noncopyable.h>
39
40 namespace JSC {
41 class VM;
42 }
43
44 namespace Inspector {
45
46 class InjectedScript;
47 class InjectedScriptManager;
48 class InspectorArray;
49 class ScriptDebugServer;
50 typedef String ErrorString;
51
52 class JS_EXPORT_PRIVATE InspectorRuntimeAgent : public InspectorAgentBase, public RuntimeBackendDispatcherHandler {
53     WTF_MAKE_NONCOPYABLE(InspectorRuntimeAgent);
54 public:
55     virtual ~InspectorRuntimeAgent();
56
57     void willDestroyFrontendAndBackend(DisconnectReason) override;
58
59     void enable(ErrorString&) override { m_enabled = true; }
60     void disable(ErrorString&) override { m_enabled = false; }
61     void parse(ErrorString&, const String& expression, Inspector::Protocol::Runtime::SyntaxErrorType* result, Inspector::Protocol::OptOutput<String>* message, RefPtr<Inspector::Protocol::Runtime::ErrorRange>&) final;
62     void evaluate(ErrorString&, const String& expression, const String* objectGroup, const bool* includeCommandLineAPI, const bool* doNotPauseOnExceptionsAndMuteConsole, const int* executionContextId, const bool* returnByValue, const bool* generatePreview, const bool* saveResult, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result, Inspector::Protocol::OptOutput<bool>* wasThrown, Inspector::Protocol::OptOutput<int>* savedResultIndex) final;
63     void callFunctionOn(ErrorString&, const String& objectId, const String& expression, const Inspector::InspectorArray* optionalArguments, const bool* doNotPauseOnExceptionsAndMuteConsole, const bool* returnByValue, const bool* generatePreview, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result, Inspector::Protocol::OptOutput<bool>* wasThrown) final;
64     void releaseObject(ErrorString&, const ErrorString& objectId) final;
65     void getProperties(ErrorString&, const String& objectId, const bool* ownProperties, const bool* generatePreview, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Runtime::PropertyDescriptor>>& result, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Runtime::InternalPropertyDescriptor>>& internalProperties) final;
66     void getDisplayableProperties(ErrorString&, const String& objectId, const bool* generatePreview, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Runtime::PropertyDescriptor>>& result, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Runtime::InternalPropertyDescriptor>>& internalProperties) final;
67     void getCollectionEntries(ErrorString&, const String& objectId, const String* objectGroup, const int* startIndex, const int* numberToFetch, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Runtime::CollectionEntry>>& entries) final;
68     void saveResult(ErrorString&, const Inspector::InspectorObject& callArgument, const int* executionContextId, Inspector::Protocol::OptOutput<int>* savedResultIndex) final;
69     void releaseObjectGroup(ErrorString&, const String& objectGroup) final;
70     void getRuntimeTypesForVariablesAtOffsets(ErrorString&, const Inspector::InspectorArray& locations, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Runtime::TypeDescription>>&) override;
71     void enableTypeProfiler(ErrorString&) override;
72     void disableTypeProfiler(ErrorString&) override;
73     void enableControlFlowProfiler(ErrorString&) override;
74     void disableControlFlowProfiler(ErrorString&) override;
75     void getBasicBlocks(ErrorString&, const String& in_sourceID, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Runtime::BasicBlock>>& out_basicBlocks) override;
76
77     bool enabled() const { return m_enabled; }
78
79 protected:
80     InspectorRuntimeAgent(AgentContext&);
81
82     InjectedScriptManager& injectedScriptManager() { return m_injectedScriptManager; }
83
84     virtual InjectedScript injectedScriptForEval(ErrorString&, const int* executionContextId) = 0;
85
86     virtual void muteConsole() = 0;
87     virtual void unmuteConsole() = 0;
88
89 private:
90     void setTypeProfilerEnabledState(bool);
91     void setControlFlowProfilerEnabledState(bool);
92
93     InjectedScriptManager& m_injectedScriptManager;
94     ScriptDebugServer& m_scriptDebugServer;
95     JSC::VM& m_vm;
96     bool m_enabled {false};
97     bool m_isTypeProfilingEnabled {false};
98     bool m_isControlFlowProfilingEnabled {false};
99 };
100
101 } // namespace Inspector