1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*
* Copyright (C) 2014-2020 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "Connection.h"
#include "DebuggableInfoData.h"
#include "WebPageProxyIdentifier.h"
#include <WebCore/Color.h>
#include <WebCore/FrameIdentifier.h>
#include <WebCore/InspectorDebuggableType.h>
#include <WebCore/InspectorFrontendAPIDispatcher.h>
#include <WebCore/InspectorFrontendClient.h>
#if ENABLE(INSPECTOR_EXTENSIONS)
#include "InspectorExtensionTypes.h"
#endif
namespace WebCore {
class InspectorController;
class InspectorFrontendHost;
class CertificateInfo;
class FloatRect;
}
namespace WebKit {
class WebPage;
#if ENABLE(INSPECTOR_EXTENSIONS)
class WebInspectorUIExtensionController;
#endif
class WebInspectorUI final
: public RefCounted<WebInspectorUI>
, private IPC::Connection::Client
, public WebCore::InspectorFrontendClient {
public:
static Ref<WebInspectorUI> create(WebPage&);
virtual ~WebInspectorUI();
static void enableFrontendFeatures(WebPage&);
// Implemented in generated WebInspectorUIMessageReceiver.cpp
void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
// IPC::Connection::Client
void didClose(IPC::Connection&) override { /* Do nothing, the inspected page process may have crashed and may be getting replaced. */ }
void didReceiveInvalidMessage(IPC::Connection&, IPC::MessageName) override { closeWindow(); }
// Called by WebInspectorUI messages
void establishConnection(WebPageProxyIdentifier inspectedPageIdentifier, const DebuggableInfoData&, bool underTest, unsigned inspectionLevel);
void updateConnection();
void showConsole();
void showResources();
void showMainResourceForFrame(const String& frameIdentifier);
void startPageProfiling();
void stopPageProfiling();
void startElementSelection();
void stopElementSelection();
void attachedBottom() { setDockSide(DockSide::Bottom); }
void attachedRight() { setDockSide(DockSide::Right); }
void attachedLeft() { setDockSide(DockSide::Left); }
void detached() { setDockSide(DockSide::Undocked); }
void setDockSide(DockSide);
void setDockingUnavailable(bool);
void setIsVisible(bool);
void updateFindString(const String&);
void sendMessageToFrontend(const String& message);
void evaluateInFrontendForTesting(const String& expression);
#if ENABLE(INSPECTOR_TELEMETRY)
void setDiagnosticLoggingAvailable(bool);
#endif
// WebCore::InspectorFrontendClient
void windowObjectCleared() override;
void frontendLoaded() override;
void startWindowDrag() override;
void moveWindowBy(float x, float y) override;
bool isRemote() const final { return false; }
String localizedStringsURL() const override;
String backendCommandsURL() const final { return String(); }
Inspector::DebuggableType debuggableType() const final { return Inspector::DebuggableType::WebPage; }
String targetPlatformName() const override;
String targetBuildVersion() const override;
String targetProductVersion() const override;
bool targetIsSimulator() const final { return false; }
unsigned inspectionLevel() const override { return m_inspectionLevel; }
void bringToFront() override;
void closeWindow() override;
void reopen() override;
void resetState() override;
void setForcedAppearance(WebCore::InspectorFrontendClient::Appearance) override;
WebCore::UserInterfaceLayoutDirection userInterfaceLayoutDirection() const override;
bool supportsDockSide(DockSide) override;
void requestSetDockSide(DockSide) override;
void changeAttachedWindowHeight(unsigned) override;
void changeAttachedWindowWidth(unsigned) override;
void changeSheetRect(const WebCore::FloatRect&) override;
void openURLExternally(const String& url) override;
void revealFileExternally(const String& path) override;
bool canSave(WebCore::InspectorFrontendClient::SaveMode) override;
void save(Vector<WebCore::InspectorFrontendClient::SaveData>&&, bool forceSaveAs) override;
bool canLoad() override;
void load(const WTF::String& path, WTF::CompletionHandler<void(const WTF::String&)>&&) override;
bool canPickColorFromScreen() override;
void pickColorFromScreen(WTF::CompletionHandler<void(const std::optional<WebCore::Color>&)>&&) override;
void inspectedURLChanged(const String&) override;
void showCertificate(const WebCore::CertificateInfo&) override;
void setInspectorPageDeveloperExtrasEnabled(bool) override;
#if ENABLE(INSPECTOR_TELEMETRY)
bool supportsDiagnosticLogging() override;
bool diagnosticLoggingAvailable() override { return m_diagnosticLoggingAvailable; }
void logDiagnosticEvent(const WTF::String& eventName, const WebCore::DiagnosticLoggingClient::ValueDictionary&) override;
#endif
#if ENABLE(INSPECTOR_EXTENSIONS)
bool supportsWebExtensions() override;
void didShowExtensionTab(const Inspector::ExtensionID&, const Inspector::ExtensionTabID&, const WebCore::FrameIdentifier&) override;
void didHideExtensionTab(const Inspector::ExtensionID&, const Inspector::ExtensionTabID&) override;
void didNavigateExtensionTab(const Inspector::ExtensionID&, const Inspector::ExtensionTabID&, const URL&) override;
void inspectedPageDidNavigate(const URL&) override;
#endif
void sendMessageToBackend(const String&) override;
WebCore::InspectorFrontendAPIDispatcher& frontendAPIDispatcher() final { return m_frontendAPIDispatcher; }
WebCore::Page* frontendPage() final;
void pagePaused() override;
void pageUnpaused() override;
bool isUnderTest() override { return m_underTest; }
private:
explicit WebInspectorUI(WebPage&);
WebPage& m_page;
Ref<WebCore::InspectorFrontendAPIDispatcher> m_frontendAPIDispatcher;
RefPtr<WebCore::InspectorFrontendHost> m_frontendHost;
// Keep a pointer to the frontend's inspector controller rather than going through
// corePage(), since we may need it after the frontend's page has started destruction.
WebCore::InspectorController* m_frontendController { nullptr };
#if ENABLE(INSPECTOR_EXTENSIONS)
std::unique_ptr<WebInspectorUIExtensionController> m_extensionController;
#endif
RefPtr<IPC::Connection> m_backendConnection;
WebPageProxyIdentifier m_inspectedPageIdentifier;
bool m_underTest { false };
DebuggableInfoData m_debuggableInfo;
bool m_dockingUnavailable { false };
bool m_isVisible { false };
#if ENABLE(INSPECTOR_TELEMETRY)
bool m_diagnosticLoggingAvailable { false };
#endif
DockSide m_dockSide { DockSide::Undocked };
unsigned m_inspectionLevel { 1 };
};
} // namespace WebKit
|
