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
|
/*
* Copyright (C) 2014-2015 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 "pal/HysteresisActivity.h"
#if ENABLE(ASYNC_SCROLLING)
#include "ScrollingCoordinator.h"
#include "ScrollingTree.h"
#include "Timer.h"
#include <wtf/RefPtr.h>
namespace WebCore {
class Page;
class Scrollbar;
class ScrollingStateNode;
class ScrollingStateScrollingNode;
class ScrollingStateTree;
// ScrollingCoordinator subclass that maintains a ScrollingStateTree and a ScrollingTree,
// allowing asynchronous scrolling (in another thread or process).
class AsyncScrollingCoordinator : public ScrollingCoordinator {
public:
static Ref<AsyncScrollingCoordinator> create(Page*);
WEBCORE_EXPORT virtual ~AsyncScrollingCoordinator();
ScrollingTree* scrollingTree() const { return m_scrollingTree.get(); }
void scrollingStateTreePropertiesChanged();
void scrollingThreadAddedPendingUpdate();
void applyPendingScrollUpdates();
WEBCORE_EXPORT void applyScrollUpdate(ScrollUpdate&&, ScrollType = ScrollType::User);
#if PLATFORM(COCOA)
WEBCORE_EXPORT void handleWheelEventPhase(ScrollingNodeID, PlatformWheelEventPhase) final;
#endif
WEBCORE_EXPORT void setActiveScrollSnapIndices(ScrollingNodeID, std::optional<unsigned> horizontalIndex, std::optional<unsigned> verticalIndex);
WEBCORE_EXPORT void updateScrollSnapPropertiesWithFrameView(const LocalFrameView&) override;
WEBCORE_EXPORT void updateIsMonitoringWheelEventsForFrameView(const LocalFrameView&) override;
void reportExposedUnfilledArea(MonotonicTime, unsigned unfilledArea);
void reportSynchronousScrollingReasonsChanged(MonotonicTime, OptionSet<SynchronousScrollingReason>);
bool scrollAnimatorEnabled() const;
virtual void hasNodeWithAnimatedScrollChanged(bool) { };
WEBCORE_EXPORT void setMouseIsOverContentArea(ScrollableArea&, bool) override;
WEBCORE_EXPORT void setMouseMovedInContentArea(ScrollableArea&) override;
protected:
WEBCORE_EXPORT AsyncScrollingCoordinator(Page*);
void setScrollingTree(Ref<ScrollingTree>&& scrollingTree) { m_scrollingTree = WTFMove(scrollingTree); }
ScrollingStateTree* scrollingStateTree() { return m_scrollingStateTree.get(); }
RefPtr<ScrollingTree> releaseScrollingTree() { return WTFMove(m_scrollingTree); }
WEBCORE_EXPORT String scrollingStateTreeAsText(OptionSet<ScrollingStateTreeAsTextBehavior> = { }) const override;
WEBCORE_EXPORT String scrollingTreeAsText(OptionSet<ScrollingStateTreeAsTextBehavior> = { }) const override;
WEBCORE_EXPORT bool haveScrollingTree() const override;
WEBCORE_EXPORT void willCommitTree() override;
void synchronizeStateFromScrollingTree();
void scheduleRenderingUpdate();
bool eventTrackingRegionsDirty() const { return m_eventTrackingRegionsDirty; }
WEBCORE_EXPORT LocalFrameView* frameViewForScrollingNode(ScrollingNodeID) const;
private:
bool isAsyncScrollingCoordinator() const override { return true; }
bool hasVisibleSlowRepaintViewportConstrainedObjects(const LocalFrameView&) const override { return false; }
WEBCORE_EXPORT ScrollingNodeID scrollableContainerNodeID(const RenderObject&) const override;
WEBCORE_EXPORT void frameViewLayoutUpdated(LocalFrameView&) override;
WEBCORE_EXPORT void frameViewRootLayerDidChange(LocalFrameView&) override;
WEBCORE_EXPORT void frameViewVisualViewportChanged(LocalFrameView&) override;
WEBCORE_EXPORT void frameViewEventTrackingRegionsChanged(LocalFrameView&) override;
WEBCORE_EXPORT void frameViewWillBeDetached(LocalFrameView&) override;
WEBCORE_EXPORT bool requestStartKeyboardScrollAnimation(ScrollableArea&, const KeyboardScroll&) final;
WEBCORE_EXPORT bool requestStopKeyboardScrollAnimation(ScrollableArea&, bool) final;
WEBCORE_EXPORT bool requestScrollToPosition(ScrollableArea&, const ScrollPosition&, const ScrollPositionChangeOptions& options) final;
WEBCORE_EXPORT void stopAnimatedScroll(ScrollableArea&) final;
WEBCORE_EXPORT void applyScrollingTreeLayerPositions() override;
WEBCORE_EXPORT ScrollingNodeID createNode(ScrollingNodeType, ScrollingNodeID newNodeID) override;
WEBCORE_EXPORT ScrollingNodeID insertNode(ScrollingNodeType, ScrollingNodeID newNodeID, ScrollingNodeID parentID, size_t childIndex) override;
WEBCORE_EXPORT void unparentNode(ScrollingNodeID) override;
WEBCORE_EXPORT void unparentChildrenAndDestroyNode(ScrollingNodeID) override;
WEBCORE_EXPORT void detachAndDestroySubtree(ScrollingNodeID) override;
WEBCORE_EXPORT void clearAllNodes() override;
WEBCORE_EXPORT ScrollingNodeID parentOfNode(ScrollingNodeID) const override;
WEBCORE_EXPORT Vector<ScrollingNodeID> childrenOfNode(ScrollingNodeID) const override;
WEBCORE_EXPORT void setNodeLayers(ScrollingNodeID, const NodeLayers&) override;
WEBCORE_EXPORT void setScrollingNodeScrollableAreaGeometry(ScrollingNodeID, ScrollableArea&) override;
WEBCORE_EXPORT void setFrameScrollingNodeState(ScrollingNodeID, const LocalFrameView&) override;
WEBCORE_EXPORT void setViewportConstraintedNodeConstraints(ScrollingNodeID, const ViewportConstraints&) override;
WEBCORE_EXPORT void setPositionedNodeConstraints(ScrollingNodeID, const AbsolutePositionConstraints&) override;
WEBCORE_EXPORT void setRelatedOverflowScrollingNodes(ScrollingNodeID, Vector<ScrollingNodeID>&&) override;
WEBCORE_EXPORT void reconcileScrollingState(LocalFrameView&, const FloatPoint&, const LayoutViewportOriginOrOverrideRect&, ScrollType, ViewportRectStability, ScrollingLayerPositionAction) override;
void reconcileScrollPosition(LocalFrameView&, ScrollingLayerPositionAction);
WEBCORE_EXPORT void scrollBySimulatingWheelEventForTesting(ScrollingNodeID, FloatSize) final;
WEBCORE_EXPORT bool isUserScrollInProgress(ScrollingNodeID) const override;
WEBCORE_EXPORT bool isRubberBandInProgress(ScrollingNodeID) const override;
WEBCORE_EXPORT bool isScrollSnapInProgress(ScrollingNodeID) const override;
WEBCORE_EXPORT void setScrollPinningBehavior(ScrollPinningBehavior) override;
WEBCORE_EXPORT void reconcileViewportConstrainedLayerPositions(ScrollingNodeID, const LayoutRect& viewportRect, ScrollingLayerPositionAction) override;
WEBCORE_EXPORT void scrollableAreaScrollbarLayerDidChange(ScrollableArea&, ScrollbarOrientation) override;
WEBCORE_EXPORT void setSynchronousScrollingReasons(ScrollingNodeID, OptionSet<SynchronousScrollingReason>) final;
WEBCORE_EXPORT OptionSet<SynchronousScrollingReason> synchronousScrollingReasons(ScrollingNodeID) const final;
WEBCORE_EXPORT void windowScreenDidChange(PlatformDisplayID, std::optional<FramesPerSecond> nominalFramesPerSecond) final;
WEBCORE_EXPORT bool hasSubscrollers() const final;
virtual void scheduleTreeStateCommit() = 0;
void ensureRootStateNodeForFrameView(LocalFrameView&);
void setEventTrackingRegionsDirty();
void updateEventTrackingRegions();
void applyScrollPositionUpdate(ScrollUpdate&&, ScrollType);
void updateScrollPositionAfterAsyncScroll(ScrollingNodeID, const FloatPoint&, std::optional<FloatPoint> layoutViewportOrigin, ScrollingLayerPositionAction, ScrollType);
void animatedScrollWillStartForNode(ScrollingNodeID);
void animatedScrollDidEndForNode(ScrollingNodeID);
void wheelEventScrollWillStartForNode(ScrollingNodeID);
void wheelEventScrollDidEndForNode(ScrollingNodeID);
WEBCORE_EXPORT void setMouseIsOverScrollbar(Scrollbar*, bool isOverScrollbar) override;
WEBCORE_EXPORT void setScrollbarEnabled(Scrollbar&) override;
void hysterisisTimerFired(PAL::HysteresisState);
std::unique_ptr<ScrollingStateTree> m_scrollingStateTree;
RefPtr<ScrollingTree> m_scrollingTree;
bool m_eventTrackingRegionsDirty { false };
PAL::HysteresisActivity m_hysterisisActivity;
};
#if ENABLE(SCROLLING_THREAD)
class LayerTreeHitTestLocker {
public:
LayerTreeHitTestLocker(ScrollingCoordinator* scrollingCoordinator)
{
if (is<AsyncScrollingCoordinator>(scrollingCoordinator)) {
m_scrollingTree = downcast<AsyncScrollingCoordinator>(*scrollingCoordinator).scrollingTree();
if (m_scrollingTree)
m_scrollingTree->lockLayersForHitTesting();
}
}
~LayerTreeHitTestLocker()
{
if (m_scrollingTree)
m_scrollingTree->unlockLayersForHitTesting();
}
private:
RefPtr<ScrollingTree> m_scrollingTree;
};
#endif
} // namespace WebCore
SPECIALIZE_TYPE_TRAITS_SCROLLING_COORDINATOR(WebCore::AsyncScrollingCoordinator, isAsyncScrollingCoordinator());
#endif // ENABLE(ASYNC_SCROLLING)
|
