[Cleanup] Remove ScriptGlobalObject
[WebKit-https.git] / Source / WebCore / inspector / InspectorFrontendHost.h
1 /*
2  * Copyright (C) 2007-2017 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #pragma once
30
31 #include "ContextMenu.h"
32 #include "ContextMenuProvider.h"
33 #include <wtf/RefCounted.h>
34 #include <wtf/Vector.h>
35 #include <wtf/text/WTFString.h>
36
37 namespace WebCore {
38
39 class DOMWrapperWorld;
40 class Event;
41 class FrontendMenuProvider;
42 class InspectorFrontendClient;
43 class Page;
44
45 class InspectorFrontendHost : public RefCounted<InspectorFrontendHost> {
46 public:
47     static Ref<InspectorFrontendHost> create(InspectorFrontendClient* client, Page* frontendPage)
48     {
49         return adoptRef(*new InspectorFrontendHost(client, frontendPage));
50     }
51
52     WEBCORE_EXPORT ~InspectorFrontendHost();
53     WEBCORE_EXPORT void disconnectClient();
54
55     WEBCORE_EXPORT void addSelfToGlobalObjectInWorld(DOMWrapperWorld&);
56
57     void loaded();
58     void requestSetDockSide(const String&);
59     void closeWindow();
60     void bringToFront();
61     void inspectedURLChanged(const String&);
62
63     void setZoomFactor(float);
64     float zoomFactor();
65
66     String userInterfaceLayoutDirection();
67
68     void setAttachedWindowHeight(unsigned);
69     void setAttachedWindowWidth(unsigned);
70
71     void startWindowDrag();
72     void moveWindowBy(float x, float y) const;
73
74     String localizedStringsURL();
75     String backendCommandsURL();
76     String debuggableType();
77     unsigned inspectionLevel();
78
79     String platform();
80     String port();
81
82     void copyText(const String& text);
83     void killText(const String& text, bool shouldPrependToKillRing, bool shouldStartNewSequence);
84     void openInNewTab(const String& url);
85     bool canSave();
86     void save(const String& url, const String& content, bool base64Encoded, bool forceSaveAs);
87     void append(const String& url, const String& content);
88     void close(const String& url);
89
90     struct ContextMenuItem {
91         String type;
92         String label;
93         std::optional<int> id;
94         std::optional<bool> enabled;
95         std::optional<bool> checked;
96         std::optional<Vector<ContextMenuItem>> subItems;
97     };
98     void showContextMenu(Event&, Vector<ContextMenuItem>&&);
99
100     void sendMessageToBackend(const String& message);
101     void dispatchEventAsContextMenuEvent(Event&);
102
103     bool isUnderTest();
104     void unbufferedLog(const String& message);
105
106     void beep();
107     void inspectInspector();
108
109 private:
110 #if ENABLE(CONTEXT_MENUS)
111     friend class FrontendMenuProvider;
112 #endif
113     WEBCORE_EXPORT InspectorFrontendHost(InspectorFrontendClient*, Page* frontendPage);
114
115     InspectorFrontendClient* m_client;
116     Page* m_frontendPage;
117 #if ENABLE(CONTEXT_MENUS)
118     FrontendMenuProvider* m_menuProvider;
119 #endif
120 };
121
122 } // namespace WebCore