Remove std::chrono completely
[WebKit-https.git] / Source / WebKit / 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 <stdint.h>
37 #include <wtf/Noncopyable.h>
38 #include <wtf/RunLoop.h>
39 #include <wtf/TypeCasts.h>
40
41 #if PLATFORM(COCOA)
42 namespace WebCore {
43 class MachSendRight;
44 }
45 #endif
46
47 namespace WebKit {
48
49 class LayerTreeContext;
50 class UpdateInfo;
51 class WebPageProxy;
52
53 class DrawingAreaProxy : public IPC::MessageReceiver {
54     WTF_MAKE_NONCOPYABLE(DrawingAreaProxy);
55
56 public:
57     virtual ~DrawingAreaProxy();
58
59     DrawingAreaType type() const { return m_type; }
60
61     virtual void deviceScaleFactorDidChange() = 0;
62
63     // FIXME: These should be pure virtual.
64     virtual void setBackingStoreIsDiscardable(bool) { }
65
66     virtual void waitForBackingStoreUpdateOnNextPaint() { }
67
68     const WebCore::IntSize& size() const { return m_size; }
69     bool setSize(const WebCore::IntSize&, const WebCore::IntSize&, const WebCore::IntSize& scrollOffset);
70
71     // The timeout we use when waiting for a DidUpdateGeometry message.
72     static constexpr Seconds didUpdateBackingStoreStateTimeout() { return Seconds::fromMilliseconds(500); }
73
74     virtual void colorSpaceDidChange() { }
75     virtual void minimumLayoutSizeDidChange() { }
76
77     virtual void adjustTransientZoom(double, WebCore::FloatPoint) { }
78     virtual void commitTransientZoom(double, WebCore::FloatPoint) { }
79
80 #if PLATFORM(MAC)
81     virtual void setViewExposedRect(std::optional<WebCore::FloatRect>);
82     std::optional<WebCore::FloatRect> viewExposedRect() const { return m_viewExposedRect; }
83     void viewExposedRectChangedTimerFired();
84 #endif
85
86     virtual void updateDebugIndicator() { }
87
88     virtual void waitForDidUpdateActivityState() { }
89     
90     virtual void dispatchAfterEnsuringDrawing(WTF::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     virtual void prepareForAppSuspension() { }
103
104 #if PLATFORM(COCOA)
105     virtual WebCore::MachSendRight createFence();
106 #endif
107
108     virtual void dispatchPresentationCallbacksAfterFlushingLayers(const Vector<CallbackID>&) { }
109
110 protected:
111     explicit DrawingAreaProxy(DrawingAreaType, WebPageProxy&);
112
113     DrawingAreaType m_type;
114     WebPageProxy& m_webPageProxy;
115
116     WebCore::IntSize m_size;
117     WebCore::IntSize m_layerPosition;
118     WebCore::IntSize m_scrollOffset;
119
120     // IPC::MessageReceiver
121     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
122
123 private:
124     virtual void sizeDidChange() = 0;
125
126     // Message handlers.
127     // FIXME: These should be pure virtual.
128     virtual void update(uint64_t /* backingStoreStateID */, const UpdateInfo&) { }
129     virtual void didUpdateBackingStoreState(uint64_t /* backingStoreStateID */, const UpdateInfo&, const LayerTreeContext&) { }
130     virtual void enterAcceleratedCompositingMode(uint64_t /* backingStoreStateID */, const LayerTreeContext&) { }
131     virtual void exitAcceleratedCompositingMode(uint64_t /* backingStoreStateID */, const UpdateInfo&) { }
132     virtual void updateAcceleratedCompositingMode(uint64_t /* backingStoreStateID */, const LayerTreeContext&) { }
133 #if PLATFORM(COCOA)
134     virtual void didUpdateGeometry() { }
135     virtual void intrinsicContentSizeDidChange(const WebCore::IntSize&) { }
136
137 #if PLATFORM(MAC)
138     RunLoop::Timer<DrawingAreaProxy> m_viewExposedRectChangedTimer;
139     std::optional<WebCore::FloatRect> m_viewExposedRect;
140     std::optional<WebCore::FloatRect> m_lastSentViewExposedRect;
141 #endif // PLATFORM(MAC)
142 #endif
143 };
144
145 } // namespace WebKit
146
147 #define SPECIALIZE_TYPE_TRAITS_DRAWING_AREA_PROXY(ToValueTypeName, ProxyType) \
148 SPECIALIZE_TYPE_TRAITS_BEGIN(WebKit::ToValueTypeName) \
149     static bool isType(const WebKit::DrawingAreaProxy& proxy) { return proxy.type() == WebKit::ProxyType; } \
150 SPECIALIZE_TYPE_TRAITS_END()
151
152 #endif // DrawingAreaProxy_h