Web Inspector: consolidate code that hosts the Inspector page inside a WKWebView
[WebKit-https.git] / Source / WebKit / UIProcess / RemoteWebInspectorProxy.h
1 /*
2  * Copyright (C) 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 "APIObject.h"
29 #include "MessageReceiver.h"
30 #include <wtf/Forward.h>
31 #include <wtf/HashMap.h>
32 #include <wtf/RetainPtr.h>
33 #include <wtf/text/WTFString.h>
34
35 #if PLATFORM(MAC)
36 OBJC_CLASS NSURL;
37 OBJC_CLASS NSWindow;
38 OBJC_CLASS WKInspectorViewController;
39 OBJC_CLASS WKRemoteWebInspectorProxyObjCAdapter;
40 OBJC_CLASS WKWebView;
41 #endif
42
43 namespace WebKit {
44
45 class WebPageProxy;
46
47 class RemoteWebInspectorProxyClient {
48 public:
49     virtual ~RemoteWebInspectorProxyClient() { }
50     virtual void sendMessageToBackend(const String& message) = 0;
51     virtual void closeFromFrontend() = 0;
52 };
53
54 class RemoteWebInspectorProxy : public RefCounted<RemoteWebInspectorProxy>, public IPC::MessageReceiver {
55 public:
56     static Ref<RemoteWebInspectorProxy> create()
57     {
58         return adoptRef(*new RemoteWebInspectorProxy());
59     }
60
61     ~RemoteWebInspectorProxy();
62
63     void setClient(RemoteWebInspectorProxyClient* client) { m_client = client; }
64
65     bool isUnderTest() const { return false; }
66
67     void invalidate();
68
69     void load(const String& debuggableType, const String& backendCommandsURL);
70     void closeFromBackend();
71     void show();
72
73     void sendMessageToFrontend(const String& message);
74
75 #if PLATFORM(MAC)
76     NSWindow *window() const { return m_window.get(); }
77     WKWebView *webView() const;
78 #endif
79
80 #if PLATFORM(GTK)
81     void updateWindowTitle(const CString&);
82 #endif
83
84     void closeFromCrash();
85
86 private:
87     RemoteWebInspectorProxy();
88
89     // IPC::MessageReceiver
90     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
91
92     // RemoteWebInspectorProxy messages.
93     void frontendDidClose();
94     void bringToFront();
95     void save(const String& filename, const String& content, bool base64Encoded, bool forceSaveAs);
96     void append(const String& filename, const String& content);
97     void startWindowDrag();
98     void openInNewTab(const String& url);
99     void sendMessageToBackend(const String& message);
100
101     void createFrontendPageAndWindow();
102     void closeFrontendPageAndWindow();
103
104     // Platform implementations.
105     WebPageProxy* platformCreateFrontendPageAndWindow();
106     void platformCloseFrontendPageAndWindow();
107     void platformBringToFront();
108     void platformSave(const String& filename, const String& content, bool base64Encoded, bool forceSaveAs);
109     void platformAppend(const String& filename, const String& content);
110     void platformStartWindowDrag();
111     void platformOpenInNewTab(const String& url);
112
113     RemoteWebInspectorProxyClient* m_client { nullptr };
114     WebPageProxy* m_inspectorPage { nullptr };
115
116 #if PLATFORM(MAC)
117     RetainPtr<WKInspectorViewController> m_inspectorView;
118     RetainPtr<NSWindow> m_window;
119     RetainPtr<WKRemoteWebInspectorProxyObjCAdapter> m_objCAdapter;
120     HashMap<String, RetainPtr<NSURL>> m_suggestedToActualURLMap;
121 #endif
122 #if PLATFORM(GTK)
123     GtkWidget* m_webView { nullptr };
124     GtkWidget* m_window { nullptr };
125 #endif
126 };
127
128 } // namespace WebKit