92c81c5cc115ce5cb9c31e686713c8d42b2a8dd4
[WebKit-https.git] / Source / JavaScriptCore / inspector / agents / InspectorAgent.h
1 /*
2  * Copyright (C) 2007-2010, 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
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 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 #pragma once
31
32 #include "InspectorBackendDispatchers.h"
33 #include "InspectorFrontendDispatchers.h"
34 #include "inspector/InspectorAgentBase.h"
35 #include <wtf/Forward.h>
36 #include <wtf/Vector.h>
37
38 namespace Inspector {
39
40 class BackendDispatcher;
41 class InspectorEnvironment;
42
43 typedef String ErrorString;
44
45 class JS_EXPORT_PRIVATE InspectorAgent final : public InspectorAgentBase, public InspectorBackendDispatcherHandler {
46     WTF_MAKE_NONCOPYABLE(InspectorAgent);
47     WTF_MAKE_FAST_ALLOCATED;
48 public:
49     InspectorAgent(AgentContext&);
50     virtual ~InspectorAgent();
51
52     void didCreateFrontendAndBackend(FrontendRouter*, BackendDispatcher*) override;
53     void willDestroyFrontendAndBackend(DisconnectReason) override;
54
55     void enable(ErrorString&) override;
56     void disable(ErrorString&) override;
57     void initialized(ErrorString&) override;
58
59     void inspect(RefPtr<Protocol::Runtime::RemoteObject>&& objectToInspect, RefPtr<JSON::Object>&& hints);
60     void evaluateForTestInFrontend(const String& script);
61
62 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
63     void activateExtraDomain(const String&);
64     void activateExtraDomains(const Vector<String>&);
65 #endif
66
67 private:
68     InspectorEnvironment& m_environment;
69     std::unique_ptr<InspectorFrontendDispatcher> m_frontendDispatcher;
70     Ref<InspectorBackendDispatcher> m_backendDispatcher;
71
72     Vector<String> m_pendingEvaluateTestCommands;
73     std::pair<RefPtr<Protocol::Runtime::RemoteObject>, RefPtr<JSON::Object>> m_pendingInspectData;
74 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
75     RefPtr<JSON::ArrayOf<String>> m_pendingExtraDomainsData;
76 #endif
77     bool m_enabled { false };
78 };
79
80 } // namespace Inspector