1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
/*
* Copyright (C) 2010-2023 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "CallbackID.h"
#include "DrawingAreaInfo.h"
#include "LayerTreeContext.h"
#include "MessageReceiver.h"
#include "WebPage.h"
#include <WebCore/ActivityState.h>
#include <WebCore/DisplayRefreshMonitorFactory.h>
#include <WebCore/FloatRect.h>
#include <WebCore/FrameIdentifier.h>
#include <WebCore/IntRect.h>
#include <WebCore/LayoutMilestone.h>
#include <WebCore/PlatformScreen.h>
#include <wtf/Forward.h>
#include <wtf/Noncopyable.h>
#include <wtf/TZoneMalloc.h>
#include <wtf/TypeCasts.h>
namespace WTF {
class MachSendRight;
}
namespace IPC {
class Connection;
class Decoder;
}
namespace WebCore {
class DestinationColorSpace;
class DisplayRefreshMonitor;
class GraphicsLayer;
class GraphicsLayerFactory;
class LocalFrame;
class LocalFrameView;
class TiledBacking;
enum class DelegatedScrollingMode : uint8_t;
}
OBJC_CLASS CABasicAnimation;
namespace WebKit {
class LayerTreeHost;
struct WebPageCreationParameters;
struct WebPreferencesStore;
class DrawingArea : public RefCounted<DrawingArea>, public IPC::MessageReceiver, public WebCore::DisplayRefreshMonitorFactory {
WTF_MAKE_TZONE_ALLOCATED(DrawingArea);
WTF_MAKE_NONCOPYABLE(DrawingArea);
public:
static RefPtr<DrawingArea> create(WebPage&, const WebPageCreationParameters&);
virtual ~DrawingArea();
void ref() const final { RefCounted::ref(); }
void deref() const final { RefCounted::deref(); }
DrawingAreaType type() const { return m_type; }
DrawingAreaIdentifier identifier() const { return m_identifier; }
static bool supportsGPUProcessRendering(DrawingAreaType);
virtual void setNeedsDisplay() = 0;
virtual void setNeedsDisplayInRect(const WebCore::IntRect&) = 0;
virtual void scroll(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollDelta) = 0;
virtual void sendEnterAcceleratedCompositingModeIfNeeded() { }
// FIXME: These should be pure virtual.
virtual void updateRenderingWithForcedRepaint() { }
virtual void updateRenderingWithForcedRepaintAsync(WebPage&, CompletionHandler<void()>&&) = 0;
virtual void setLayerTreeStateIsFrozen(bool) { }
virtual bool layerTreeStateIsFrozen() const { return false; }
virtual void updatePreferences(const WebPreferencesStore&) { }
virtual void mainFrameContentSizeChanged(WebCore::FrameIdentifier, const WebCore::IntSize&) { }
#if PLATFORM(COCOA)
virtual void setViewExposedRect(std::optional<WebCore::FloatRect>) = 0;
virtual std::optional<WebCore::FloatRect> viewExposedRect() const = 0;
virtual void acceleratedAnimationDidStart(WebCore::PlatformLayerIdentifier, const String& /*key*/, MonotonicTime /*startTime*/) { }
virtual void acceleratedAnimationDidEnd(WebCore::PlatformLayerIdentifier, const String& /*key*/) { }
virtual void addFence(const WTF::MachSendRight&) { }
virtual WebCore::FloatRect exposedContentRect() const = 0;
virtual void setExposedContentRect(const WebCore::FloatRect&) = 0;
#endif
virtual void mainFrameScrollabilityChanged(bool) { }
virtual bool supportsAsyncScrolling() const { return false; }
virtual bool usesDelegatedPageScaling() const { return false; }
virtual WebCore::DelegatedScrollingMode delegatedScrollingMode() const;
virtual void registerScrollingTree() { }
virtual void unregisterScrollingTree() { }
virtual bool shouldUseTiledBackingForFrameView(const WebCore::LocalFrameView&) const { return false; }
virtual WebCore::GraphicsLayerFactory* graphicsLayerFactory() { return nullptr; }
virtual void setRootCompositingLayer(WebCore::Frame&, WebCore::GraphicsLayer*) = 0;
virtual void addRootFrame(WebCore::FrameIdentifier) { }
virtual void removeRootFrame(WebCore::FrameIdentifier) { }
// Cause a rendering update to happen as soon as possible.
virtual void triggerRenderingUpdate() = 0;
virtual bool scheduleRenderingUpdate() { return false; }
virtual void renderingUpdateFramesPerSecondChanged() { }
virtual void willStartRenderingUpdateDisplay();
virtual void didCompleteRenderingUpdateDisplay();
// Called after didCompleteRenderingUpdateDisplay, but in the same run loop iteration.
virtual void didCompleteRenderingFrame();
virtual void dispatchAfterEnsuringUpdatedScrollPosition(WTF::Function<void ()>&&);
virtual void activityStateDidChange(OptionSet<WebCore::ActivityState>, ActivityStateChangeID, CompletionHandler<void()>&& completionHandler) { completionHandler(); };
virtual void setLayerHostingMode(LayerHostingMode) { }
virtual void tryMarkLayersVolatile(CompletionHandler<void(bool)>&&);
virtual void attachViewOverlayGraphicsLayer(WebCore::FrameIdentifier, WebCore::GraphicsLayer*) { }
virtual std::optional<WebCore::DestinationColorSpace> displayColorSpace() const { return { }; }
virtual bool addMilestonesToDispatch(OptionSet<WebCore::LayoutMilestone>) { return false; }
#if PLATFORM(COCOA)
virtual void updateGeometry(const WebCore::IntSize& viewSize, bool flushSynchronously, const WTF::MachSendRight& fencePort, CompletionHandler<void()>&&) = 0;
#endif
#if USE(GRAPHICS_LAYER_WC) || USE(GRAPHICS_LAYER_TEXTURE_MAPPER)
virtual void setIntrinsicDeviceScaleFactor(float) { }
#endif
#if USE(GRAPHICS_LAYER_WC)
virtual void updateGeometryWC(uint64_t, WebCore::IntSize, float deviceScaleFactor, float intrinsicDeviceScaleFactor) { };
#endif
#if USE(COORDINATED_GRAPHICS) || USE(TEXTURE_MAPPER)
virtual void updateGeometry(const WebCore::IntSize&, CompletionHandler<void()>&&) = 0;
virtual bool enterAcceleratedCompositingModeIfNeeded() = 0;
virtual void backgroundColorDidChange() { };
#endif
#if PLATFORM(WPE) && USE(GBM) && ENABLE(WPE_PLATFORM)
virtual void preferredBufferFormatsDidChange() { }
#endif
#if PLATFORM(GTK) || PLATFORM(WPE)
virtual void dispatchPendingCallbacksAfterEnsuringDrawing() = 0;
#endif
virtual void adoptLayersFromDrawingArea(DrawingArea&) { }
virtual void adoptDisplayRefreshMonitorsFromDrawingArea(DrawingArea&) { }
virtual void setNextRenderingUpdateRequiresSynchronousImageDecoding() { }
void removeMessageReceiverIfNeeded();
WebCore::TiledBacking* mainFrameTiledBacking() const;
void prepopulateRectForZoom(double scale, WebCore::FloatPoint origin);
void setShouldScaleViewToFitDocument(bool);
void scaleViewToFitDocumentIfNeeded();
static RetainPtr<CABasicAnimation> transientZoomSnapAnimationForKeyPath(ASCIILiteral);
protected:
DrawingArea(DrawingAreaType, DrawingAreaIdentifier, WebPage&);
template<typename T> bool send(T&& message)
{
Ref webPage = m_webPage.get();
return webPage->send(std::forward<T>(message), m_identifier.toUInt64(), { });
}
Ref<WebPage> protectedWebPage() const { return m_webPage.get(); }
const DrawingAreaType m_type;
DrawingAreaIdentifier m_identifier;
WeakRef<WebPage> m_webPage;
WebCore::IntSize m_lastViewSizeForScaleToFit;
WebCore::IntSize m_lastDocumentSizeForScaleToFit;
bool m_isScalingViewToFitDocument { false };
bool m_shouldScaleViewToFitDocument { false };
private:
// IPC::MessageReceiver.
void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
// Message handlers.
// FIXME: These should be pure virtual.
#if USE(COORDINATED_GRAPHICS) || USE(TEXTURE_MAPPER)
virtual void updateBackingStoreState(uint64_t /*backingStoreStateID*/, bool /*respondImmediately*/, float /*deviceScaleFactor*/, const WebCore::IntSize& /*size*/,
const WebCore::IntSize& /*scrollOffset*/) { }
virtual void forceUpdate() { }
virtual void didDiscardBackingStore() { }
#endif
virtual void setDeviceScaleFactor(float, CompletionHandler<void()>&& completionHandler) { completionHandler(); }
virtual void displayDidRefresh() { }
// DisplayRefreshMonitorFactory.
RefPtr<WebCore::DisplayRefreshMonitor> createDisplayRefreshMonitor(WebCore::PlatformDisplayID) override;
#if PLATFORM(COCOA)
virtual void setColorSpace(std::optional<WebCore::DestinationColorSpace>) { }
#endif
#if PLATFORM(COCOA) || PLATFORM(GTK) || PLATFORM(WPE)
virtual void dispatchAfterEnsuringDrawing(IPC::AsyncReplyID) = 0;
#endif
#if PLATFORM(COCOA) || PLATFORM(GTK)
virtual void adjustTransientZoom(double scale, WebCore::FloatPoint origin) { }
virtual void commitTransientZoom(double scale, WebCore::FloatPoint origin, CompletionHandler<void()>&&) { }
#endif
bool m_hasRemovedMessageReceiver { false };
};
} // namespace WebKit
#define SPECIALIZE_TYPE_TRAITS_DRAWING_AREA(ToValueTypeName, AreaType) \
SPECIALIZE_TYPE_TRAITS_BEGIN(WebKit::ToValueTypeName) \
static bool isType(const WebKit::DrawingArea& area) { return area.type() == WebKit::AreaType; } \
SPECIALIZE_TYPE_TRAITS_END()
|
