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
|
/*
* Copyright (C) 2012 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
#if ENABLE(ASYNC_SCROLLING)
#include "IntRect.h"
#include "ScrollSnapOffsetsInfo.h"
#include "ScrollableArea.h"
#include "ScrollingTree.h"
#include "ScrollingTreeNode.h"
namespace WebCore {
class ScrollingTree;
class ScrollingStateScrollingNode;
class ScrollingTreeScrollingNodeDelegate;
struct WheelEventHandlingResult;
struct ScrollPropagationInfo {
bool shouldBlockScrollPropagation { false };
bool isHandled { false };
};
class WEBCORE_EXPORT ScrollingTreeScrollingNode : public ScrollingTreeNode {
friend class ScrollingTreeScrollingNodeDelegate;
#if PLATFORM(MAC)
friend class ScrollingTreeScrollingNodeDelegateMac;
#endif
#if ENABLE(SCROLLING_THREAD)
friend class ThreadedScrollingTreeScrollingNodeDelegate;
#endif
friend class ScrollingTree;
friend class ThreadedScrollingTree;
public:
virtual ~ScrollingTreeScrollingNode();
bool commitStateBeforeChildren(const ScrollingStateNode&) override;
bool commitStateAfterChildren(const ScrollingStateNode&) override;
void didCompleteCommitForNode() final;
virtual bool canHandleWheelEvent(const PlatformWheelEvent&, EventTargeting) const;
virtual WheelEventHandlingResult handleWheelEvent(const PlatformWheelEvent&, EventTargeting = EventTargeting::Propagate);
virtual void handleWheelEventPhase(const PlatformWheelEventPhase) { }
FloatPoint currentScrollPosition() const { return m_currentScrollPosition; }
FloatPoint currentScrollOffset() const { return ScrollableArea::scrollOffsetFromPosition(m_currentScrollPosition, toFloatSize(m_scrollOrigin)); }
FloatPoint lastCommittedScrollPosition() const { return m_lastCommittedScrollPosition; }
FloatSize scrollDeltaSinceLastCommit() const { return m_currentScrollPosition - m_lastCommittedScrollPosition; }
const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
RectEdges<bool> edgePinnedState() const;
bool isUserScrollInProgress() const;
void setUserScrollInProgress(bool);
bool isScrollSnapInProgress() const;
void setScrollSnapInProgress(bool);
virtual bool startAnimatedScrollToPosition(FloatPoint);
virtual void stopAnimatedScroll();
virtual void serviceScrollAnimation(MonotonicTime);
// These are imperative; they adjust the scrolling layers.
void scrollTo(const FloatPoint&, ScrollType = ScrollType::User, ScrollClamping = ScrollClamping::Clamped);
void scrollBy(const FloatSize&, ScrollClamping = ScrollClamping::Clamped);
void handleScrollPositionRequest(const RequestedScrollData&);
void handleKeyboardScrollRequest(const RequestedKeyboardScrollData&);
void requestKeyboardScroll(const RequestedKeyboardScrollData&);
void wasScrolledByDelegatedScrolling(const FloatPoint& position, std::optional<FloatRect> overrideLayoutViewport = { }, ScrollingLayerPositionAction = ScrollingLayerPositionAction::Sync);
#if ENABLE(SCROLLING_THREAD)
OptionSet<SynchronousScrollingReason> synchronousScrollingReasons() const { return m_synchronousScrollingReasons; }
void addSynchronousScrollingReason(SynchronousScrollingReason reason) { m_synchronousScrollingReasons.add(reason); }
bool hasSynchronousScrollingReasons() const { return !m_synchronousScrollingReasons.isEmpty(); }
#endif
const FloatSize& scrollableAreaSize() const { return m_scrollableAreaSize; }
const FloatSize& totalContentsSize() const { return m_totalContentsSize; }
NativeScrollbarVisibility horizontalNativeScrollbarVisibility() const { return m_scrollableAreaParameters.horizontalNativeScrollbarVisibility; }
NativeScrollbarVisibility verticalNativeScrollbarVisibility() const { return m_scrollableAreaParameters.verticalNativeScrollbarVisibility; }
bool canHaveHorizontalScrollbar() const { return m_scrollableAreaParameters.horizontalScrollbarMode != ScrollbarMode::AlwaysOff; }
bool canHaveVerticalScrollbar() const { return m_scrollableAreaParameters.verticalScrollbarMode != ScrollbarMode::AlwaysOff; }
bool canHaveScrollbars() const { return m_scrollableAreaParameters.horizontalScrollbarMode != ScrollbarMode::AlwaysOff || m_scrollableAreaParameters.verticalScrollbarMode != ScrollbarMode::AlwaysOff; }
const FloatScrollSnapOffsetsInfo& snapOffsetsInfo() const;
std::optional<unsigned> currentHorizontalSnapPointIndex() const;
std::optional<unsigned> currentVerticalSnapPointIndex() const;
void setCurrentHorizontalSnapPointIndex(std::optional<unsigned>);
void setCurrentVerticalSnapPointIndex(std::optional<unsigned>);
bool useDarkAppearanceForScrollbars() const { return m_scrollableAreaParameters.useDarkAppearanceForScrollbars; }
bool eventCanScrollContents(const PlatformWheelEvent&) const;
bool scrolledSinceLastCommit() const { return m_scrolledSinceLastCommit; }
const LayerRepresentation& scrollContainerLayer() const { return m_scrollContainerLayer; }
const LayerRepresentation& scrolledContentsLayer() const { return m_scrolledContentsLayer; }
OverscrollBehavior horizontalOverscrollBehavior() const { return m_scrollableAreaParameters.horizontalOverscrollBehavior; }
OverscrollBehavior verticalOverscrollBehavior() const { return m_scrollableAreaParameters.verticalOverscrollBehavior; }
ScrollbarWidth scrollbarWidthStyle() const { return m_scrollableAreaParameters.scrollbarWidthStyle; }
virtual String scrollbarStateForOrientation(ScrollbarOrientation) const { return ""_s; }
void scrollbarVisibilityDidChange(ScrollbarOrientation, bool);
void scrollbarMinimumThumbLengthDidChange(ScrollbarOrientation, int);
protected:
ScrollingTreeScrollingNode(ScrollingTree&, ScrollingNodeType, ScrollingNodeID);
virtual FloatPoint minimumScrollPosition() const;
virtual FloatPoint maximumScrollPosition() const;
FloatPoint clampScrollPosition(const FloatPoint&) const;
virtual void willDoProgrammaticScroll(const FloatPoint&) { }
FloatPoint adjustedScrollPosition(const FloatPoint&, ScrollClamping = ScrollClamping::Clamped) const;
void willStartAnimatedScroll();
void didStopAnimatedScroll();
void willStartWheelEventScroll();
void didStopWheelEventScroll();
void setScrollAnimationInProgress(bool);
virtual void currentScrollPositionChanged(ScrollType, ScrollingLayerPositionAction = ScrollingLayerPositionAction::Sync);
virtual void updateViewportForCurrentScrollPosition(std::optional<FloatRect> = { }) { }
virtual bool scrollPositionAndLayoutViewportMatch(const FloatPoint& position, std::optional<FloatRect> overrideLayoutViewport);
virtual void repositionScrollingLayers() { }
virtual void repositionRelatedLayers() { }
void applyLayerPositions() override;
const FloatSize& reachableContentsSize() const { return m_reachableContentsSize; }
bool isLatchedNode() const;
// If the totalContentsSize changes in the middle of a rubber-band, we still want to use the old totalContentsSize for the sake of
// computing the stretchAmount(). Using the old value will keep the animation smooth. When there is no rubber-band in progress at
// all, m_totalContentsSizeForRubberBand should be equivalent to m_totalContentsSize.
const FloatSize& totalContentsSizeForRubberBand() const { return m_totalContentsSizeForRubberBand; }
void setTotalContentsSizeForRubberBand(const FloatSize& totalContentsSizeForRubberBand) { m_totalContentsSizeForRubberBand = totalContentsSizeForRubberBand; }
ScrollElasticity horizontalScrollElasticity() const { return m_scrollableAreaParameters.horizontalScrollElasticity; }
ScrollElasticity verticalScrollElasticity() const { return m_scrollableAreaParameters.verticalScrollElasticity; }
bool allowsHorizontalScrolling() const { return m_scrollableAreaParameters.allowsHorizontalScrolling; }
bool allowsVerticalScrolling() const { return m_scrollableAreaParameters.allowsVerticalScrolling; }
bool horizontalOverscrollBehaviorPreventsPropagation() const { return m_scrollableAreaParameters.horizontalOverscrollBehavior != OverscrollBehavior::Auto; }
bool verticalOverscrollBehaviorPreventsPropagation() const { return m_scrollableAreaParameters.verticalOverscrollBehavior != OverscrollBehavior::Auto; }
PlatformWheelEvent eventForPropagation(const PlatformWheelEvent&) const;
ScrollPropagationInfo computeScrollPropagation(const FloatSize&) const;
bool overscrollBehaviorAllowsRubberBand() const { return m_scrollableAreaParameters.horizontalOverscrollBehavior != OverscrollBehavior::None || m_scrollableAreaParameters.verticalOverscrollBehavior != OverscrollBehavior::None; }
bool shouldRubberBand(const PlatformWheelEvent&, EventTargeting) const;
void dumpProperties(WTF::TextStream&, OptionSet<ScrollingStateTreeAsTextBehavior>) const override;
std::unique_ptr<ScrollingTreeScrollingNodeDelegate> m_delegate;
private:
FloatSize m_scrollableAreaSize;
FloatSize m_totalContentsSize;
FloatSize m_totalContentsSizeForRubberBand;
FloatSize m_reachableContentsSize;
FloatPoint m_lastCommittedScrollPosition;
FloatPoint m_currentScrollPosition;
IntPoint m_scrollOrigin;
FloatScrollSnapOffsetsInfo m_snapOffsetsInfo;
std::optional<unsigned> m_currentHorizontalSnapPointIndex;
std::optional<unsigned> m_currentVerticalSnapPointIndex;
ScrollableAreaParameters m_scrollableAreaParameters;
#if ENABLE(SCROLLING_THREAD)
OptionSet<SynchronousScrollingReason> m_synchronousScrollingReasons;
#endif
bool m_isFirstCommit { true };
bool m_scrolledSinceLastCommit { false };
LayerRepresentation m_scrollContainerLayer;
LayerRepresentation m_scrolledContentsLayer;
};
} // namespace WebCore
SPECIALIZE_TYPE_TRAITS_SCROLLING_NODE(ScrollingTreeScrollingNode, isScrollingNode())
#endif // ENABLE(ASYNC_SCROLLING)
|
