Remove "virtual" from all lines that have both "virtual" and "override".
[WebKit-https.git] / Source / WebKit2 / UIProcess / DrawingAreaProxy.h
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  * Portions Copyright (c) 2010 Motorola Mobility, 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
7  * are met:
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  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24  * THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef DrawingAreaProxy_h
28 #define DrawingAreaProxy_h
29
30 #include "DrawingAreaInfo.h"
31 #include "GenericCallback.h"
32 #include "MessageReceiver.h"
33 #include <WebCore/FloatRect.h>
34 #include <WebCore/IntRect.h>
35 #include <WebCore/IntSize.h>
36 #include <chrono>
37 #include <stdint.h>
38 #include <wtf/Noncopyable.h>
39 #include <wtf/RunLoop.h>
40 #include <wtf/TypeCasts.h>
41
42 namespace WebKit {
43
44 class LayerTreeContext;
45 class CoordinatedLayerTreeHostProxy;
46 class UpdateInfo;
47 class WebPageProxy;
48
49 class DrawingAreaProxy : public IPC::MessageReceiver {
50     WTF_MAKE_NONCOPYABLE(DrawingAreaProxy);
51
52 public:
53     virtual ~DrawingAreaProxy();
54
55     DrawingAreaType type() const { return m_type; }
56
57     virtual void deviceScaleFactorDidChange() = 0;
58
59     // FIXME: These should be pure virtual.
60     virtual void setBackingStoreIsDiscardable(bool) { }
61
62     virtual void waitForBackingStoreUpdateOnNextPaint() { }
63
64     const WebCore::IntSize& size() const { return m_size; }
65     void setSize(const WebCore::IntSize&, const WebCore::IntSize&, const WebCore::IntSize& scrollOffset);
66
67     // The timeout we use when waiting for a DidUpdateGeometry message.
68     static constexpr std::chrono::milliseconds didUpdateBackingStoreStateTimeout() { return std::chrono::milliseconds(500); }
69
70     virtual void waitForPossibleGeometryUpdate(std::chrono::milliseconds = didUpdateBackingStoreStateTimeout()) { }
71
72     virtual void colorSpaceDidChange() { }
73     virtual void minimumLayoutSizeDidChange() { }
74
75     virtual void adjustTransientZoom(double, WebCore::FloatPoint) { }
76     virtual void commitTransientZoom(double, WebCore::FloatPoint) { }
77
78 #if PLATFORM(MAC)
79     virtual void setExposedRect(const WebCore::FloatRect&);
80     WebCore::FloatRect exposedRect() const { return m_exposedRect; }
81 #endif
82 #if PLATFORM(COCOA)
83     void exposedRectChangedTimerFired();
84 #endif
85
86     virtual void updateDebugIndicator() { }
87
88     virtual void waitForDidUpdateViewState() { }
89     
90     virtual void dispatchAfterEnsuringDrawing(std::function<void (CallbackBase::Error)>) { ASSERT_NOT_REACHED(); }
91
92     // Hide the content until the currently pending update arrives.
93     virtual void hideContentUntilPendingUpdate() { ASSERT_NOT_REACHED(); }
94
95     // Hide the content until any update arrives.
96     virtual void hideContentUntilAnyUpdate() { ASSERT_NOT_REACHED(); }
97
98     virtual bool hasVisibleContent() const { return true; }
99
100     virtual void willSendUpdateGeometry() { }
101
102 protected:
103     explicit DrawingAreaProxy(DrawingAreaType, WebPageProxy&);
104
105     DrawingAreaType m_type;
106     WebPageProxy& m_webPageProxy;
107
108     WebCore::IntSize m_size;
109     WebCore::IntSize m_layerPosition;
110     WebCore::IntSize m_scrollOffset;
111
112     // IPC::MessageReceiver
113     void didReceiveMessage(IPC::Connection&, IPC::MessageDecoder&) override;
114
115 private:
116     virtual void sizeDidChange() = 0;
117
118     // Message handlers.
119     // FIXME: These should be pure virtual.
120     virtual void update(uint64_t /* backingStoreStateID */, const UpdateInfo&) { }
121     virtual void didUpdateBackingStoreState(uint64_t /* backingStoreStateID */, const UpdateInfo&, const LayerTreeContext&) { }
122     virtual void enterAcceleratedCompositingMode(uint64_t /* backingStoreStateID */, const LayerTreeContext&) { }
123     virtual void exitAcceleratedCompositingMode(uint64_t /* backingStoreStateID */, const UpdateInfo&) { }
124     virtual void updateAcceleratedCompositingMode(uint64_t /* backingStoreStateID */, const LayerTreeContext&) { }
125     virtual void willEnterAcceleratedCompositingMode(uint64_t /* backingStoreStateID */) { }
126 #if PLATFORM(COCOA)
127     virtual void didUpdateGeometry() { }
128     virtual void intrinsicContentSizeDidChange(const WebCore::IntSize&) { }
129
130 #if PLATFORM(MAC)
131     RunLoop::Timer<DrawingAreaProxy> m_exposedRectChangedTimer;
132     WebCore::FloatRect m_exposedRect;
133     WebCore::FloatRect m_lastSentExposedRect;
134 #endif // PLATFORM(MAC)
135 #endif
136 };
137
138 } // namespace WebKit
139
140 #define SPECIALIZE_TYPE_TRAITS_DRAWING_AREA_PROXY(ToValueTypeName, ProxyType) \
141 SPECIALIZE_TYPE_TRAITS_BEGIN(WebKit::ToValueTypeName) \
142     static bool isType(const WebKit::DrawingAreaProxy& proxy) { return proxy.type() == WebKit::ProxyType; } \
143 SPECIALIZE_TYPE_TRAITS_END()
144
145 #endif // DrawingAreaProxy_h