5139eee16b569de1298f9dba9ddc07a5c66e8c30
[WebKit-https.git] / Source / WebCore / inspector / InspectorFrontendClientLocal.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2015 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #pragma once
33
34 #include "InspectorFrontendClient.h"
35 #include <wtf/Forward.h>
36 #include <wtf/Noncopyable.h>
37 #include <wtf/text/WTFString.h>
38
39 namespace WebCore {
40
41 class Frame;
42 class InspectorController;
43 class InspectorBackendDispatchTask;
44 class InspectorFrontendHost;
45 class Page;
46
47 class InspectorFrontendClientLocal : public InspectorFrontendClient {
48     WTF_MAKE_NONCOPYABLE(InspectorFrontendClientLocal);
49     WTF_MAKE_FAST_ALLOCATED;
50 public:
51     class WEBCORE_EXPORT Settings {
52     public:
53         Settings() = default;
54         virtual ~Settings() = default;
55         virtual String getProperty(const String& name);
56         virtual void setProperty(const String& name, const String& value);
57     };
58
59     WEBCORE_EXPORT InspectorFrontendClientLocal(InspectorController* inspectedPageController, Page* frontendPage, std::unique_ptr<Settings>);
60     WEBCORE_EXPORT virtual ~InspectorFrontendClientLocal();
61
62     WEBCORE_EXPORT void windowObjectCleared() final;
63     WEBCORE_EXPORT void frontendLoaded() override;
64
65     void startWindowDrag() override { }
66     WEBCORE_EXPORT void moveWindowBy(float x, float y) final;
67
68     WEBCORE_EXPORT UserInterfaceLayoutDirection userInterfaceLayoutDirection() const final;
69
70     WEBCORE_EXPORT void requestSetDockSide(DockSide) final;
71     WEBCORE_EXPORT void changeAttachedWindowHeight(unsigned) final;
72     WEBCORE_EXPORT void changeAttachedWindowWidth(unsigned) final;
73     WEBCORE_EXPORT void openInNewTab(const String& url) final;
74     bool canSave()  override { return false; }
75     void save(const String&, const String&, bool, bool) override { }
76     void append(const String&, const String&) override { }
77
78     virtual void attachWindow(DockSide) = 0;
79     virtual void detachWindow() = 0;
80
81     WEBCORE_EXPORT void sendMessageToBackend(const String& message) final;
82
83     WEBCORE_EXPORT bool isUnderTest() final;
84     bool isRemote() const final { return false; }
85     WEBCORE_EXPORT unsigned inspectionLevel() const final;
86
87     WEBCORE_EXPORT bool canAttachWindow();
88     WEBCORE_EXPORT void setDockingUnavailable(bool);
89
90     WEBCORE_EXPORT static unsigned constrainedAttachedWindowHeight(unsigned preferredHeight, unsigned totalWindowHeight);
91     WEBCORE_EXPORT static unsigned constrainedAttachedWindowWidth(unsigned preferredWidth, unsigned totalWindowWidth);
92
93     // Direct Frontend API
94     WEBCORE_EXPORT bool isDebuggingEnabled();
95     WEBCORE_EXPORT void setDebuggingEnabled(bool);
96
97     WEBCORE_EXPORT bool isTimelineProfilingEnabled();
98     WEBCORE_EXPORT void setTimelineProfilingEnabled(bool);
99
100     WEBCORE_EXPORT bool isProfilingJavaScript();
101     WEBCORE_EXPORT void startProfilingJavaScript();
102     WEBCORE_EXPORT void stopProfilingJavaScript();
103
104     WEBCORE_EXPORT void showConsole();
105
106     WEBCORE_EXPORT void showMainResourceForFrame(Frame*);
107
108     WEBCORE_EXPORT void showResources();
109
110     WEBCORE_EXPORT void setAttachedWindow(DockSide);
111
112     WEBCORE_EXPORT Page* inspectedPage() const;
113     Page* frontendPage() const { return m_frontendPage; }
114 protected:
115     virtual void setAttachedWindowHeight(unsigned) = 0;
116     virtual void setAttachedWindowWidth(unsigned) = 0;
117     WEBCORE_EXPORT void restoreAttachedWindowHeight();
118
119 private:
120     bool evaluateAsBoolean(const String& expression);
121     void evaluateOnLoad(const String& expression);
122
123     friend class FrontendMenuProvider;
124     InspectorController* m_inspectedPageController { nullptr };
125     Page* m_frontendPage { nullptr };
126     // TODO(yurys): this ref shouldn't be needed.
127     RefPtr<InspectorFrontendHost> m_frontendHost;
128     std::unique_ptr<InspectorFrontendClientLocal::Settings> m_settings;
129     bool m_frontendLoaded { false };
130     DockSide m_dockSide;
131     Vector<String> m_evaluateOnLoad;
132     Ref<InspectorBackendDispatchTask> m_dispatchTask;
133 };
134
135 } // namespace WebCore