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
|
/*
* Copyright (C) 2014, 2016 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 "BoxExtents.h"
#include "EventTrackingRegions.h"
#include "ScrollTypes.h"
#include "ScrollbarThemeComposite.h"
#include "ScrollingCoordinator.h"
#include "ScrollingStateScrollingNode.h"
#include <wtf/TZoneMallocInlines.h>
namespace WebCore {
class Scrollbar;
class ScrollingStateFrameScrollingNode final : public ScrollingStateScrollingNode {
WTF_MAKE_TZONE_ALLOCATED_EXPORT(ScrollingStateFrameScrollingNode, WEBCORE_EXPORT);
public:
template<typename... Args> static Ref<ScrollingStateFrameScrollingNode> create(Args&&... args) { return adoptRef(*new ScrollingStateFrameScrollingNode(std::forward<Args>(args)...)); }
Ref<ScrollingStateNode> clone(ScrollingStateTree&) override;
virtual ~ScrollingStateFrameScrollingNode();
float frameScaleFactor() const { return m_frameScaleFactor; }
WEBCORE_EXPORT void setFrameScaleFactor(float);
const EventTrackingRegions& eventTrackingRegions() const { return m_eventTrackingRegions; }
WEBCORE_EXPORT void setEventTrackingRegions(const EventTrackingRegions&);
ScrollBehaviorForFixedElements scrollBehaviorForFixedElements() const { return m_behaviorForFixed; }
WEBCORE_EXPORT void setScrollBehaviorForFixedElements(ScrollBehaviorForFixedElements);
FloatRect layoutViewport() const { return m_layoutViewport; };
WEBCORE_EXPORT void setLayoutViewport(const FloatRect&);
FloatPoint minLayoutViewportOrigin() const { return m_minLayoutViewportOrigin; }
WEBCORE_EXPORT void setMinLayoutViewportOrigin(const FloatPoint&);
FloatPoint maxLayoutViewportOrigin() const { return m_maxLayoutViewportOrigin; }
WEBCORE_EXPORT void setMaxLayoutViewportOrigin(const FloatPoint&);
std::optional<FloatSize> overrideVisualViewportSize() const { return m_overrideVisualViewportSize; };
WEBCORE_EXPORT void setOverrideVisualViewportSize(std::optional<FloatSize>);
int headerHeight() const { return m_headerHeight; }
WEBCORE_EXPORT void setHeaderHeight(int);
int footerHeight() const { return m_footerHeight; }
WEBCORE_EXPORT void setFooterHeight(int);
FloatBoxExtent obscuredContentInsets() const { return m_obscuredContentInsets; }
WEBCORE_EXPORT void setObscuredContentInsets(const FloatBoxExtent&);
const LayerRepresentation& rootContentsLayer() const { return m_rootContentsLayer; }
WEBCORE_EXPORT void setRootContentsLayer(const LayerRepresentation&);
// This is a layer moved in the opposite direction to scrolling, for example for background-attachment:fixed
const LayerRepresentation& counterScrollingLayer() const { return m_counterScrollingLayer; }
WEBCORE_EXPORT void setCounterScrollingLayer(const LayerRepresentation&);
// This is a clipping layer that will scroll with the page for all y-delta scroll values between 0
// and obscuredInset().top. Once the y-deltas get beyond the content inset point, this layer no longer
// needs to move. If the obscuredInset().top is 0, this layer does not need to move at all. This is
// only used on the Mac.
const LayerRepresentation& insetClipLayer() const { return m_insetClipLayer; }
WEBCORE_EXPORT void setInsetClipLayer(const LayerRepresentation&);
const LayerRepresentation& contentShadowLayer() const { return m_contentShadowLayer; }
WEBCORE_EXPORT void setContentShadowLayer(const LayerRepresentation&);
// The header and footer layers scroll vertically with the page, they should remain fixed when scrolling horizontally.
const LayerRepresentation& headerLayer() const { return m_headerLayer; }
WEBCORE_EXPORT void setHeaderLayer(const LayerRepresentation&);
// The header and footer layers scroll vertically with the page, they should remain fixed when scrolling horizontally.
const LayerRepresentation& footerLayer() const { return m_footerLayer; }
WEBCORE_EXPORT void setFooterLayer(const LayerRepresentation&);
// True when the visual viewport is smaller than the layout viewport, indicating that panning should be possible.
bool visualViewportIsSmallerThanLayoutViewport() const { return m_visualViewportIsSmallerThanLayoutViewport; }
WEBCORE_EXPORT void setVisualViewportIsSmallerThanLayoutViewport(bool);
bool asyncFrameOrOverflowScrollingEnabled() const { return m_asyncFrameOrOverflowScrollingEnabled; }
WEBCORE_EXPORT void setAsyncFrameOrOverflowScrollingEnabled(bool);
bool scrollingPerformanceTestingEnabled() const { return m_scrollingPerformanceTestingEnabled; }
WEBCORE_EXPORT void setScrollingPerformanceTestingEnabled(bool);
bool wheelEventGesturesBecomeNonBlocking() const { return m_wheelEventGesturesBecomeNonBlocking; }
WEBCORE_EXPORT void setWheelEventGesturesBecomeNonBlocking(bool);
bool overlayScrollbarsEnabled() const { return m_overlayScrollbarsEnabled; }
WEBCORE_EXPORT void setOverlayScrollbarsEnabled(bool);
WEBCORE_EXPORT bool isMainFrame() const;
void dumpProperties(WTF::TextStream&, OptionSet<ScrollingStateTreeAsTextBehavior>) const override;
private:
WEBCORE_EXPORT ScrollingStateFrameScrollingNode(
bool isMainFrame,
ScrollingNodeID,
Vector<Ref<WebCore::ScrollingStateNode>>&& children,
OptionSet<ScrollingStateNodeProperty> changedProperties,
std::optional<WebCore::PlatformLayerIdentifier>,
FloatSize scrollableAreaSize,
FloatSize totalContentsSize,
FloatSize reachableContentsSize,
FloatPoint scrollPosition,
IntPoint scrollOrigin,
ScrollableAreaParameters&&,
#if ENABLE(SCROLLING_THREAD)
OptionSet<SynchronousScrollingReason> synchronousScrollingReasons,
#endif
RequestedScrollData&&,
FloatScrollSnapOffsetsInfo&&,
std::optional<unsigned> currentHorizontalSnapPointIndex,
std::optional<unsigned> currentVerticalSnapPointIndex,
bool isMonitoringWheelEvents,
std::optional<PlatformLayerIdentifier> scrollContainerLayer,
std::optional<PlatformLayerIdentifier> scrolledContentsLayer,
std::optional<PlatformLayerIdentifier> horizontalScrollbarLayer,
std::optional<PlatformLayerIdentifier> verticalScrollbarLayer,
bool mouseIsOverContentArea,
MouseLocationState&&,
ScrollbarHoverState&&,
ScrollbarEnabledState&&,
UserInterfaceLayoutDirection,
ScrollbarWidth,
bool useDarkAppearanceForScrollbars,
RequestedKeyboardScrollData&&,
float frameScaleFactor,
EventTrackingRegions&&,
std::optional<PlatformLayerIdentifier> rootContentsLayer,
std::optional<PlatformLayerIdentifier> counterScrollingLayer,
std::optional<PlatformLayerIdentifier> insetClipLayer,
std::optional<PlatformLayerIdentifier> contentShadowLayer,
int headerHeight,
int footerHeight,
ScrollBehaviorForFixedElements&&,
FloatBoxExtent&& obscuredContentInsets,
bool visualViewportIsSmallerThanLayoutViewport,
bool asyncFrameOrOverflowScrollingEnabled,
bool wheelEventGesturesBecomeNonBlocking,
bool scrollingPerformanceTestingEnabled,
FloatRect layoutViewport,
FloatPoint minLayoutViewportOrigin,
FloatPoint maxLayoutViewportOrigin,
std::optional<FloatSize> overrideVisualViewportSize,
bool overlayScrollbarsEnabled
);
ScrollingStateFrameScrollingNode(ScrollingStateTree&, ScrollingNodeType, ScrollingNodeID);
ScrollingStateFrameScrollingNode(const ScrollingStateFrameScrollingNode&, ScrollingStateTree&);
OptionSet<ScrollingStateNode::Property> applicableProperties() const final;
LayerRepresentation m_rootContentsLayer;
LayerRepresentation m_counterScrollingLayer;
LayerRepresentation m_insetClipLayer;
LayerRepresentation m_contentShadowLayer;
LayerRepresentation m_headerLayer;
LayerRepresentation m_footerLayer;
EventTrackingRegions m_eventTrackingRegions;
FloatRect m_layoutViewport;
FloatPoint m_minLayoutViewportOrigin;
FloatPoint m_maxLayoutViewportOrigin;
std::optional<FloatSize> m_overrideVisualViewportSize;
float m_frameScaleFactor { 1 };
FloatBoxExtent m_obscuredContentInsets;
int m_headerHeight { 0 };
int m_footerHeight { 0 };
ScrollBehaviorForFixedElements m_behaviorForFixed { ScrollBehaviorForFixedElements::StickToDocumentBounds };
bool m_visualViewportIsSmallerThanLayoutViewport { false };
bool m_asyncFrameOrOverflowScrollingEnabled { false };
bool m_wheelEventGesturesBecomeNonBlocking { false };
bool m_scrollingPerformanceTestingEnabled { false };
bool m_overlayScrollbarsEnabled { false };
};
} // namespace WebCore
SPECIALIZE_TYPE_TRAITS_SCROLLING_STATE_NODE(ScrollingStateFrameScrollingNode, isFrameScrollingNode())
#endif // ENABLE(ASYNC_SCROLLING)
|
