Web Inspector: use more C++ keywords for defining agents
[WebKit-https.git] / Source / JavaScriptCore / inspector / agents / InspectorRuntimeAgent.h
1 /*
2  * Copyright (C) 2013, 2015-2016 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 "InspectorAgentBase.h"
35 #include "InspectorBackendDispatchers.h"
36 #include <wtf/Forward.h>
37 #include <wtf/Noncopyable.h>
38
39 namespace JSC {
40 class VM;
41 }
42
43 namespace Inspector {
44
45 class InjectedScript;
46 class InjectedScriptManager;
47 class ScriptDebugServer;
48 typedef String ErrorString;
49
50 class JS_EXPORT_PRIVATE InspectorRuntimeAgent : public InspectorAgentBase, public RuntimeBackendDispatcherHandler {
51     WTF_MAKE_NONCOPYABLE(InspectorRuntimeAgent);
52     WTF_MAKE_FAST_ALLOCATED;
53 public:
54     ~InspectorRuntimeAgent() override;
55
56     // InspectorAgentBase
57     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) final;
58     void willDestroyFrontendAndBackend(DisconnectReason) final;
59
60     // RuntimeBackendDispatcherHandler
61     void enable(ErrorString&) override { m_enabled = true; }
62     void disable(ErrorString&) override { m_enabled = false; }
63     void parse(ErrorString&, const String& expression, Protocol::Runtime::SyntaxErrorType* result, Optional<String>& message, RefPtr<Protocol::Runtime::ErrorRange>&) final;
64     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, const bool* emulateUserGesture, RefPtr<Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown, Optional<int>& savedResultIndex) override;
65     void awaitPromise(const String& promiseObjectId, const bool* returnByValue, const bool* generatePreview, const bool* saveResult, Ref<AwaitPromiseCallback>&&) final;
66     void callFunctionOn(ErrorString&, const String& objectId, const String& expression, const JSON::Array* optionalArguments, const bool* doNotPauseOnExceptionsAndMuteConsole, const bool* returnByValue, const bool* generatePreview, RefPtr<Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown) final;
67     void releaseObject(ErrorString&, const ErrorString& objectId) final;
68     void getPreview(ErrorString&, const String& objectId, RefPtr<Protocol::Runtime::ObjectPreview>&) final;
69     void getProperties(ErrorString&, const String& objectId, const bool* ownProperties, const int* fetchStart, const int* fetchCount, const bool* generatePreview, RefPtr<JSON::ArrayOf<Protocol::Runtime::PropertyDescriptor>>& properties, RefPtr<JSON::ArrayOf<Protocol::Runtime::InternalPropertyDescriptor>>& internalProperties) final;
70     void getDisplayableProperties(ErrorString&, const String& objectId, const int* fetchStart, const int* fetchCount, const bool* generatePreview, RefPtr<JSON::ArrayOf<Protocol::Runtime::PropertyDescriptor>>& properties, RefPtr<JSON::ArrayOf<Protocol::Runtime::InternalPropertyDescriptor>>& internalProperties) final;
71     void getCollectionEntries(ErrorString&, const String& objectId, const String* objectGroup, const int* fetchStart, const int* fetchCount, RefPtr<JSON::ArrayOf<Protocol::Runtime::CollectionEntry>>& entries) final;
72     void saveResult(ErrorString&, const JSON::Object& callArgument, const int* executionContextId, Optional<int>& savedResultIndex) final;
73     void setSavedResultAlias(ErrorString&, const String* alias) final;
74     void releaseObjectGroup(ErrorString&, const String& objectGroup) final;
75     void getRuntimeTypesForVariablesAtOffsets(ErrorString&, const JSON::Array& locations, RefPtr<JSON::ArrayOf<Protocol::Runtime::TypeDescription>>&) final;
76     void enableTypeProfiler(ErrorString&) final;
77     void disableTypeProfiler(ErrorString&) final;
78     void enableControlFlowProfiler(ErrorString&) final;
79     void disableControlFlowProfiler(ErrorString&) final;
80     void getBasicBlocks(ErrorString&, const String& in_sourceID, RefPtr<JSON::ArrayOf<Protocol::Runtime::BasicBlock>>& out_basicBlocks) final;
81
82 protected:
83     InspectorRuntimeAgent(AgentContext&);
84
85     InjectedScriptManager& injectedScriptManager() { return m_injectedScriptManager; }
86
87     virtual InjectedScript injectedScriptForEval(ErrorString&, const int* executionContextId) = 0;
88
89     virtual void muteConsole() = 0;
90     virtual void unmuteConsole() = 0;
91
92 private:
93     void setTypeProfilerEnabledState(bool);
94     void setControlFlowProfilerEnabledState(bool);
95
96     InjectedScriptManager& m_injectedScriptManager;
97     ScriptDebugServer& m_scriptDebugServer;
98     JSC::VM& m_vm;
99     bool m_enabled {false};
100     bool m_isTypeProfilingEnabled {false};
101     bool m_isControlFlowProfilingEnabled {false};
102 };
103
104 } // namespace Inspector