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