Web Inspector: Keep Web Inspector window alive across process swaps (PSON) (Local...
[WebKit-https.git] / Source / WebKit / WebProcess / WebPage / WebInspectorUI.h
1 /*
2  * Copyright (C) 2014-2016 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "Connection.h"
29 #include "WebInspectorFrontendAPIDispatcher.h"
30 #include <WebCore/InspectorFrontendClient.h>
31 #include <WebCore/InspectorFrontendHost.h>
32
33 namespace WebCore {
34 class InspectorController;
35 }
36
37 namespace WebKit {
38
39 class WebPage;
40
41 class WebInspectorUI : public RefCounted<WebInspectorUI>, private IPC::Connection::Client, public WebCore::InspectorFrontendClient {
42 public:
43     static Ref<WebInspectorUI> create(WebPage&);
44
45     // Implemented in generated WebInspectorUIMessageReceiver.cpp
46     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
47
48     // IPC::Connection::Client
49     void didClose(IPC::Connection&) override { /* Do nothing, the inspected page process may have crashed and may be getting replaced. */ }
50     void didReceiveInvalidMessage(IPC::Connection&, IPC::StringReference, IPC::StringReference) override { closeWindow(); }
51
52     // Called by WebInspectorUI messages
53     void establishConnection(uint64_t inspectedPageIdentifier, bool underTest, unsigned inspectionLevel);
54     void updateConnection();
55
56     void showConsole();
57     void showResources();
58     void showTimelines();
59
60     void showMainResourceForFrame(const String& frameIdentifier);
61
62     void startPageProfiling();
63     void stopPageProfiling();
64
65     void startElementSelection();
66     void stopElementSelection();
67
68     void attachedBottom() { setDockSide(DockSide::Bottom); }
69     void attachedRight() { setDockSide(DockSide::Right); }
70     void attachedLeft() { setDockSide(DockSide::Left); }
71     void detached() { setDockSide(DockSide::Undocked); }
72
73     void setDockSide(DockSide);
74     void setDockingUnavailable(bool);
75
76     void setIsVisible(bool);
77
78     void didSave(const String& url);
79     void didAppend(const String& url);
80
81     void sendMessageToFrontend(const String&);
82
83     // WebCore::InspectorFrontendClient
84     void windowObjectCleared() override;
85     void frontendLoaded() override;
86
87     void startWindowDrag() override;
88     void moveWindowBy(float x, float y) override;
89
90     String localizedStringsURL() override;
91
92     void bringToFront() override;
93     void closeWindow() override;
94
95     WebCore::UserInterfaceLayoutDirection userInterfaceLayoutDirection() const override;
96
97     void requestSetDockSide(DockSide) override;
98     void changeAttachedWindowHeight(unsigned) override;
99     void changeAttachedWindowWidth(unsigned) override;
100
101     void openInNewTab(const String& url) override;
102
103     bool canSave() override;
104     void save(const WTF::String& url, const WTF::String& content, bool base64Encoded, bool forceSaveAs) override;
105     void append(const WTF::String& url, const WTF::String& content) override;
106
107     void inspectedURLChanged(const String&) override;
108
109     void sendMessageToBackend(const String&) override;
110
111     void pagePaused() override;
112     void pageUnpaused() override;
113
114     bool isUnderTest() override { return m_underTest; }
115     unsigned inspectionLevel() const override { return m_inspectionLevel; }
116
117 private:
118     explicit WebInspectorUI(WebPage&);
119
120     WebPage& m_page;
121     WebInspectorFrontendAPIDispatcher m_frontendAPIDispatcher;
122     RefPtr<WebCore::InspectorFrontendHost> m_frontendHost;
123     RefPtr<IPC::Connection> m_backendConnection;
124
125     // Keep a pointer to the frontend's inspector controller rather than going through
126     // corePage(), since we may need it after the frontend's page has started destruction.
127     WebCore::InspectorController* m_frontendController { nullptr };
128
129     uint64_t m_inspectedPageIdentifier { 0 };
130     bool m_underTest { false };
131     bool m_dockingUnavailable { false };
132     bool m_isVisible { false };
133     DockSide m_dockSide { DockSide::Undocked };
134     unsigned m_inspectionLevel { 1 };
135 };
136
137 } // namespace WebKit