Remove "virtual" from all lines that have both "virtual" and "override".
[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 #ifndef InspectorFrontendClientLocal_h
33 #define InspectorFrontendClientLocal_h
34
35 #include "InspectorFrontendClient.h"
36 #include <wtf/Forward.h>
37 #include <wtf/Noncopyable.h>
38 #include <wtf/text/WTFString.h>
39
40 namespace WebCore {
41
42 class Frame;
43 class InspectorController;
44 class InspectorBackendDispatchTask;
45 class InspectorFrontendHost;
46 class Page;
47
48 class InspectorFrontendClientLocal : public InspectorFrontendClient {
49     WTF_MAKE_NONCOPYABLE(InspectorFrontendClientLocal); WTF_MAKE_FAST_ALLOCATED;
50 public:
51     class WEBCORE_EXPORT Settings {
52     public:
53         Settings() { }
54         virtual ~Settings() { }
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() override final;
63     WEBCORE_EXPORT void frontendLoaded() override;
64
65     void startWindowDrag() override { }
66     WEBCORE_EXPORT void moveWindowBy(float x, float y) override final;
67
68     WEBCORE_EXPORT void requestSetDockSide(DockSide) override final;
69     WEBCORE_EXPORT void changeAttachedWindowHeight(unsigned) override final;
70     WEBCORE_EXPORT void changeAttachedWindowWidth(unsigned) override final;
71     WEBCORE_EXPORT void openInNewTab(const String& url) override final;
72     bool canSave()  override { return false; }
73     void save(const String&, const String&, bool, bool) override { }
74     void append(const String&, const String&) override { }
75
76     virtual void attachWindow(DockSide) = 0;
77     virtual void detachWindow() = 0;
78
79     WEBCORE_EXPORT void sendMessageToBackend(const String& message) override final;
80
81     WEBCORE_EXPORT bool isUnderTest() override final;
82     WEBCORE_EXPORT unsigned inspectionLevel() const override final;
83
84     WEBCORE_EXPORT bool canAttachWindow();
85     WEBCORE_EXPORT void setDockingUnavailable(bool);
86
87     WEBCORE_EXPORT static unsigned constrainedAttachedWindowHeight(unsigned preferredHeight, unsigned totalWindowHeight);
88     WEBCORE_EXPORT static unsigned constrainedAttachedWindowWidth(unsigned preferredWidth, unsigned totalWindowWidth);
89
90     // Direct Frontend API
91     WEBCORE_EXPORT bool isDebuggingEnabled();
92     WEBCORE_EXPORT void setDebuggingEnabled(bool);
93
94     WEBCORE_EXPORT bool isTimelineProfilingEnabled();
95     WEBCORE_EXPORT void setTimelineProfilingEnabled(bool);
96
97     WEBCORE_EXPORT bool isProfilingJavaScript();
98     WEBCORE_EXPORT void startProfilingJavaScript();
99     WEBCORE_EXPORT void stopProfilingJavaScript();
100
101     WEBCORE_EXPORT void showConsole();
102
103     WEBCORE_EXPORT void showMainResourceForFrame(Frame*);
104
105     WEBCORE_EXPORT void showResources();
106
107     WEBCORE_EXPORT void setAttachedWindow(DockSide);
108
109     WEBCORE_EXPORT Page* inspectedPage() const;
110     Page* frontendPage() const { return m_frontendPage; }
111 protected:
112     virtual void setAttachedWindowHeight(unsigned) = 0;
113     virtual void setAttachedWindowWidth(unsigned) = 0;
114     WEBCORE_EXPORT void restoreAttachedWindowHeight();
115
116 private:
117     bool evaluateAsBoolean(const String& expression);
118     void evaluateOnLoad(const String& expression);
119
120     friend class FrontendMenuProvider;
121     InspectorController* m_inspectedPageController { nullptr };
122     Page* m_frontendPage { nullptr };
123     // TODO(yurys): this ref shouldn't be needed.
124     RefPtr<InspectorFrontendHost> m_frontendHost;
125     std::unique_ptr<InspectorFrontendClientLocal::Settings> m_settings;
126     bool m_frontendLoaded { false };
127     DockSide m_dockSide;
128     Vector<String> m_evaluateOnLoad;
129     Ref<InspectorBackendDispatchTask> m_dispatchTask;
130 };
131
132 } // namespace WebCore
133
134 #endif