Make use of _UIRemoteView instead of CALayerHost if possible for WKRemoteView
[WebKit-https.git] / Source / WebKit / UIProcess / DrawingAreaProxy.h
1 /*
2  * Copyright (C) 2010-2018 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 #pragma once
28
29 #include "DrawingAreaInfo.h"
30 #include "GenericCallback.h"
31 #include "MessageReceiver.h"
32 #include <WebCore/FloatRect.h>
33 #include <WebCore/IntRect.h>
34 #include <WebCore/IntSize.h>
35 #include <stdint.h>
36 #include <wtf/Noncopyable.h>
37 #include <wtf/RunLoop.h>
38 #include <wtf/TypeCasts.h>
39
40 #if PLATFORM(COCOA)
41 namespace WTF {
42 class MachSendRight;
43 }
44 #endif
45
46 namespace WebKit {
47
48 class LayerTreeContext;
49 class UpdateInfo;
50 class WebPageProxy;
51
52 class DrawingAreaProxy : public IPC::MessageReceiver {
53     WTF_MAKE_NONCOPYABLE(DrawingAreaProxy);
54
55 public:
56     virtual ~DrawingAreaProxy();
57
58     DrawingAreaType type() const { return m_type; }
59
60     virtual void deviceScaleFactorDidChange() = 0;
61
62     // FIXME: These should be pure virtual.
63     virtual void setBackingStoreIsDiscardable(bool) { }
64
65     virtual void waitForBackingStoreUpdateOnNextPaint() { }
66
67     const WebCore::IntSize& size() const { return m_size; }
68     bool setSize(const WebCore::IntSize&, const WebCore::IntSize& scrollOffset = { });
69
70     // The timeout we use when waiting for a DidUpdateGeometry message.
71     static constexpr Seconds didUpdateBackingStoreStateTimeout() { return Seconds::fromMilliseconds(500); }
72
73     virtual void colorSpaceDidChange() { }
74     virtual void viewLayoutSizeDidChange() { }
75
76     virtual void adjustTransientZoom(double, WebCore::FloatPoint) { }
77     virtual void commitTransientZoom(double, WebCore::FloatPoint) { }
78
79 #if PLATFORM(MAC)
80     virtual void setViewExposedRect(std::optional<WebCore::FloatRect>);
81     std::optional<WebCore::FloatRect> viewExposedRect() const { return m_viewExposedRect; }
82     void viewExposedRectChangedTimerFired();
83 #endif
84
85     virtual void updateDebugIndicator() { }
86
87     virtual void waitForDidUpdateActivityState(ActivityStateChangeID) { }
88     
89     virtual void dispatchAfterEnsuringDrawing(WTF::Function<void (CallbackBase::Error)>&&) { ASSERT_NOT_REACHED(); }
90
91     // Hide the content until the currently pending update arrives.
92     virtual void hideContentUntilPendingUpdate() { ASSERT_NOT_REACHED(); }
93
94     // Hide the content until any update arrives.
95     virtual void hideContentUntilAnyUpdate() { ASSERT_NOT_REACHED(); }
96
97     virtual bool hasVisibleContent() const { return true; }
98
99     virtual void willSendUpdateGeometry() { }
100
101     virtual void prepareForAppSuspension() { }
102
103 #if PLATFORM(COCOA)
104     virtual WTF::MachSendRight createFence();
105 #endif
106
107     virtual void dispatchPresentationCallbacksAfterFlushingLayers(const Vector<CallbackID>&) { }
108
109     WebPageProxy& page() const { return m_webPageProxy; }
110
111 protected:
112     explicit DrawingAreaProxy(DrawingAreaType, WebPageProxy&);
113
114     DrawingAreaType m_type;
115     WebPageProxy& m_webPageProxy;
116
117     WebCore::IntSize m_size;
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