Fix cause of viewport-related flakiness in iOS tests
[WebKit.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 #if PLATFORM(COCOA)
43 namespace WebCore {
44 class MachSendRight;
45 }
46 #endif
47
48 namespace WebKit {
49
50 class LayerTreeContext;
51 class CoordinatedLayerTreeHostProxy;
52 class UpdateInfo;
53 class WebPageProxy;
54
55 class DrawingAreaProxy : public IPC::MessageReceiver {
56     WTF_MAKE_NONCOPYABLE(DrawingAreaProxy);
57
58 public:
59     virtual ~DrawingAreaProxy();
60
61     DrawingAreaType type() const { return m_type; }
62
63     virtual void deviceScaleFactorDidChange() = 0;
64
65     // FIXME: These should be pure virtual.
66     virtual void setBackingStoreIsDiscardable(bool) { }
67
68     virtual void waitForBackingStoreUpdateOnNextPaint() { }
69
70     const WebCore::IntSize& size() const { return m_size; }
71     bool setSize(const WebCore::IntSize&, const WebCore::IntSize&, const WebCore::IntSize& scrollOffset);
72
73     // The timeout we use when waiting for a DidUpdateGeometry message.
74     static constexpr Seconds didUpdateBackingStoreStateTimeout() { return Seconds::fromMilliseconds(500); }
75
76     virtual void waitForPossibleGeometryUpdate(Seconds = didUpdateBackingStoreStateTimeout()) { }
77
78     virtual void colorSpaceDidChange() { }
79     virtual void minimumLayoutSizeDidChange() { }
80
81     virtual void adjustTransientZoom(double, WebCore::FloatPoint) { }
82     virtual void commitTransientZoom(double, WebCore::FloatPoint) { }
83
84 #if PLATFORM(MAC)
85     virtual void setViewExposedRect(std::optional<WebCore::FloatRect>);
86     std::optional<WebCore::FloatRect> viewExposedRect() const { return m_viewExposedRect; }
87     void viewExposedRectChangedTimerFired();
88 #endif
89
90     virtual void updateDebugIndicator() { }
91
92     virtual void waitForDidUpdateActivityState() { }
93     
94     virtual void dispatchAfterEnsuringDrawing(std::function<void (CallbackBase::Error)>) { ASSERT_NOT_REACHED(); }
95
96     // Hide the content until the currently pending update arrives.
97     virtual void hideContentUntilPendingUpdate() { ASSERT_NOT_REACHED(); }
98
99     // Hide the content until any update arrives.
100     virtual void hideContentUntilAnyUpdate() { ASSERT_NOT_REACHED(); }
101
102     virtual bool hasVisibleContent() const { return true; }
103
104     virtual void willSendUpdateGeometry() { }
105
106     virtual void prepareForAppSuspension() { }
107
108 #if PLATFORM(COCOA)
109     virtual WebCore::MachSendRight createFence();
110 #endif
111
112 protected:
113     explicit DrawingAreaProxy(DrawingAreaType, WebPageProxy&);
114
115     DrawingAreaType m_type;
116     WebPageProxy& m_webPageProxy;
117
118     WebCore::IntSize m_size;
119     WebCore::IntSize m_layerPosition;
120     WebCore::IntSize m_scrollOffset;
121
122     // IPC::MessageReceiver
123     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
124
125 private:
126     virtual void sizeDidChange() = 0;
127
128     // Message handlers.
129     // FIXME: These should be pure virtual.
130     virtual void update(uint64_t /* backingStoreStateID */, const UpdateInfo&) { }
131     virtual void didUpdateBackingStoreState(uint64_t /* backingStoreStateID */, const UpdateInfo&, const LayerTreeContext&) { }
132     virtual void enterAcceleratedCompositingMode(uint64_t /* backingStoreStateID */, const LayerTreeContext&) { }
133     virtual void exitAcceleratedCompositingMode(uint64_t /* backingStoreStateID */, const UpdateInfo&) { }
134     virtual void updateAcceleratedCompositingMode(uint64_t /* backingStoreStateID */, const LayerTreeContext&) { }
135 #if PLATFORM(COCOA)
136     virtual void didUpdateGeometry() { }
137     virtual void intrinsicContentSizeDidChange(const WebCore::IntSize&) { }
138
139 #if PLATFORM(MAC)
140     RunLoop::Timer<DrawingAreaProxy> m_viewExposedRectChangedTimer;
141     std::optional<WebCore::FloatRect> m_viewExposedRect;
142     std::optional<WebCore::FloatRect> m_lastSentViewExposedRect;
143 #endif // PLATFORM(MAC)
144 #endif
145 };
146
147 } // namespace WebKit
148
149 #define SPECIALIZE_TYPE_TRAITS_DRAWING_AREA_PROXY(ToValueTypeName, ProxyType) \
150 SPECIALIZE_TYPE_TRAITS_BEGIN(WebKit::ToValueTypeName) \
151     static bool isType(const WebKit::DrawingAreaProxy& proxy) { return proxy.type() == WebKit::ProxyType; } \
152 SPECIALIZE_TYPE_TRAITS_END()
153
154 #endif // DrawingAreaProxy_h