Don't use base layer() as the scroll layer in scrolling tree.
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingCoordinator.h
1 /*
2  * Copyright (C) 2011, 2015 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "EventTrackingRegions.h"
29 #include "LayoutRect.h"
30 #include "PlatformWheelEvent.h"
31 #include "ScrollSnapOffsetsInfo.h"
32 #include "ScrollTypes.h"
33 #include "ScrollingCoordinatorTypes.h"
34 #include <wtf/Forward.h>
35 #include <wtf/ThreadSafeRefCounted.h>
36 #include <wtf/TypeCasts.h>
37 #include <wtf/Variant.h>
38
39 #if ENABLE(ASYNC_SCROLLING)
40 #include <wtf/HashMap.h>
41 #include <wtf/ThreadSafeRefCounted.h>
42 #include <wtf/Threading.h>
43 #endif
44
45 #if ENABLE(CSS_SCROLL_SNAP)
46 #include "AxisScrollSnapOffsets.h"
47 #endif
48
49 namespace WTF {
50 class TextStream;
51 }
52
53 namespace WebCore {
54
55 class Document;
56 class Frame;
57 class FrameView;
58 class GraphicsLayer;
59 class Page;
60 class Region;
61 class RenderLayer;
62 class ScrollableArea;
63 class ViewportConstraints;
64
65 #if ENABLE(ASYNC_SCROLLING)
66 class ScrollingTree;
67 #endif
68
69 class ScrollingCoordinator : public ThreadSafeRefCounted<ScrollingCoordinator> {
70 public:
71     static Ref<ScrollingCoordinator> create(Page*);
72     virtual ~ScrollingCoordinator();
73
74     WEBCORE_EXPORT virtual void pageDestroyed();
75     
76     virtual bool isAsyncScrollingCoordinator() const { return false; }
77     virtual bool isRemoteScrollingCoordinator() const { return false; }
78
79     // Return whether this scrolling coordinator handles scrolling for the given frame view.
80     WEBCORE_EXPORT virtual bool coordinatesScrollingForFrameView(const FrameView&) const;
81
82     // Return whether this scrolling coordinator handles scrolling for the given overflow scroll layer.
83     WEBCORE_EXPORT virtual bool coordinatesScrollingForOverflowLayer(const RenderLayer&) const;
84
85     // Should be called whenever the given frame view has been laid out.
86     virtual void frameViewLayoutUpdated(FrameView&) { }
87
88     using LayoutViewportOriginOrOverrideRect = WTF::Variant<Optional<FloatPoint>, Optional<FloatRect>>;
89     virtual void reconcileScrollingState(FrameView&, const FloatPoint&, const LayoutViewportOriginOrOverrideRect&, bool /* programmaticScroll */, ViewportRectStability, ScrollingLayerPositionAction) { }
90
91     // Should be called whenever the slow repaint objects counter changes between zero and one.
92     void frameViewHasSlowRepaintObjectsDidChange(FrameView&);
93
94     // Should be called whenever the set of fixed objects changes.
95     void frameViewFixedObjectsDidChange(FrameView&);
96
97     // Called whenever the non-fast scrollable region changes for reasons other than layout.
98     virtual void frameViewEventTrackingRegionsChanged(FrameView&) { }
99
100     // Should be called whenever the root layer for the given frame view changes.
101     virtual void frameViewRootLayerDidChange(FrameView&);
102
103 #if PLATFORM(COCOA)
104     // Dispatched by the scrolling tree during handleWheelEvent. This is required as long as scrollbars are painted on the main thread.
105     void handleWheelEventPhase(PlatformWheelEventPhase);
106 #endif
107
108     // Force all scroll layer position updates to happen on the main thread.
109     WEBCORE_EXPORT void setForceSynchronousScrollLayerPositionUpdates(bool);
110
111     // These virtual functions are currently unique to the threaded scrolling architecture. 
112     virtual void commitTreeStateIfNeeded() { }
113     virtual bool requestScrollPositionUpdate(FrameView&, const IntPoint&) { return false; }
114     virtual ScrollingEventResult handleWheelEvent(FrameView&, const PlatformWheelEvent&) { return ScrollingEventResult::DidNotHandleEvent; }
115
116     // Create an unparented node.
117     virtual ScrollingNodeID createNode(ScrollingNodeType, ScrollingNodeID newNodeID) { return newNodeID; }
118     // Parent a node in the scrolling tree. This may return a new nodeID if the node type changed. parentID = 0 sets the root node.
119     virtual ScrollingNodeID insertNode(ScrollingNodeType, ScrollingNodeID newNodeID, ScrollingNodeID /*parentID*/, size_t /*childIndex*/ = notFound) { return newNodeID; }
120     // Node will be unparented, but not destroyed. It's the client's responsibility to either re-parent or destroy this node.
121     virtual void unparentNode(ScrollingNodeID) { }
122     // Node will be destroyed, and its children left unparented.
123     virtual void unparentChildrenAndDestroyNode(ScrollingNodeID) { }
124     // Node will be unparented, and it and its children destroyed.
125     virtual void detachAndDestroySubtree(ScrollingNodeID) { }
126     // Destroy the tree, including both parented and unparented nodes.
127     virtual void clearAllNodes() { }
128
129     virtual ScrollingNodeID parentOfNode(ScrollingNodeID) const { return 0; }
130     virtual Vector<ScrollingNodeID> childrenOfNode(ScrollingNodeID) const { return { }; }
131
132     struct NodeLayers {
133         GraphicsLayer* layer { nullptr };
134         GraphicsLayer* scrollContainerLayer { nullptr };
135         GraphicsLayer* scrolledContentsLayer { nullptr };
136         GraphicsLayer* counterScrollingLayer { nullptr };
137         GraphicsLayer* insetClipLayer { nullptr };
138         GraphicsLayer* rootContentsLayer { nullptr };
139     };
140     virtual void setNodeLayers(ScrollingNodeID, const NodeLayers&) { }
141
142     struct ScrollingGeometry {
143         LayoutRect parentRelativeScrollableRect;
144         FloatSize scrollableAreaSize;
145         FloatSize contentSize;
146         FloatSize reachableContentSize; // Smaller than contentSize when overflow is hidden on one axis.
147         FloatPoint scrollPosition;
148         IntPoint scrollOrigin;
149 #if ENABLE(CSS_SCROLL_SNAP)
150         Vector<LayoutUnit> horizontalSnapOffsets;
151         Vector<LayoutUnit> verticalSnapOffsets;
152         Vector<ScrollOffsetRange<LayoutUnit>> horizontalSnapOffsetRanges;
153         Vector<ScrollOffsetRange<LayoutUnit>> verticalSnapOffsetRanges;
154         unsigned currentHorizontalSnapPointIndex;
155         unsigned currentVerticalSnapPointIndex;
156 #endif
157     };
158
159     virtual void setScrollingNodeGeometry(ScrollingNodeID, const ScrollingGeometry&) { }
160     virtual void setViewportConstraintedNodeGeometry(ScrollingNodeID, const ViewportConstraints&) { }
161
162     virtual void reconcileViewportConstrainedLayerPositions(ScrollingNodeID, const LayoutRect&, ScrollingLayerPositionAction) { }
163     virtual String scrollingStateTreeAsText(ScrollingStateTreeAsTextBehavior = ScrollingStateTreeAsTextBehaviorNormal) const;
164     virtual bool isRubberBandInProgress() const { return false; }
165     virtual bool isScrollSnapInProgress() const { return false; }
166     virtual void updateScrollSnapPropertiesWithFrameView(const FrameView&) { }
167     virtual void setScrollPinningBehavior(ScrollPinningBehavior) { }
168
169     // Generated a unique id for scrolling nodes.
170     ScrollingNodeID uniqueScrollingNodeID();
171
172     enum MainThreadScrollingReasonFlags {
173         ForcedOnMainThread                                          = 1 << 0,
174         HasSlowRepaintObjects                                       = 1 << 1,
175         HasViewportConstrainedObjectsWithoutSupportingFixedLayers   = 1 << 2,
176         HasNonLayerViewportConstrainedObjects                       = 1 << 3,
177         IsImageDocument                                             = 1 << 4
178     };
179
180     SynchronousScrollingReasons synchronousScrollingReasons(const FrameView&) const;
181     bool shouldUpdateScrollLayerPositionSynchronously(const FrameView&) const;
182
183     virtual void willDestroyScrollableArea(ScrollableArea&) { }
184     virtual void scrollableAreaScrollbarLayerDidChange(ScrollableArea&, ScrollbarOrientation) { }
185
186     static String synchronousScrollingReasonsAsText(SynchronousScrollingReasons);
187     String synchronousScrollingReasonsAsText() const;
188
189     EventTrackingRegions absoluteEventTrackingRegions() const;
190     virtual void updateExpectsWheelEventTestTriggerWithFrameView(const FrameView&) { }
191
192 protected:
193     explicit ScrollingCoordinator(Page*);
194
195     static GraphicsLayer* scrollLayerForScrollableArea(ScrollableArea&);
196
197     GraphicsLayer* scrollLayerForFrameView(FrameView&);
198     GraphicsLayer* counterScrollingLayerForFrameView(FrameView&);
199     GraphicsLayer* insetClipLayerForFrameView(FrameView&);
200     GraphicsLayer* rootContentsLayerForFrameView(FrameView&);
201     GraphicsLayer* contentShadowLayerForFrameView(FrameView&);
202     GraphicsLayer* headerLayerForFrameView(FrameView&);
203     GraphicsLayer* footerLayerForFrameView(FrameView&);
204
205     virtual void willCommitTree() { }
206
207     Page* m_page; // FIXME: ideally this would be a reference but it gets nulled on async teardown.
208
209 private:
210     virtual void setSynchronousScrollingReasons(FrameView&, SynchronousScrollingReasons) { }
211
212     virtual bool hasVisibleSlowRepaintViewportConstrainedObjects(const FrameView&) const;
213     void updateSynchronousScrollingReasons(FrameView&);
214     void updateSynchronousScrollingReasonsForAllFrames();
215
216     EventTrackingRegions absoluteEventTrackingRegionsForFrame(const Frame&) const;
217
218     bool m_forceSynchronousScrollLayerPositionUpdates { false };
219 };
220
221 WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, ScrollableAreaParameters);
222 WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, ScrollingNodeType);
223 WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, ScrollingLayerPositionAction);
224 WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, ViewportRectStability);
225
226 } // namespace WebCore
227
228 #define SPECIALIZE_TYPE_TRAITS_SCROLLING_COORDINATOR(ToValueTypeName, predicate) \
229 SPECIALIZE_TYPE_TRAITS_BEGIN(ToValueTypeName) \
230     static bool isType(const WebCore::ScrollingCoordinator& value) { return value.predicate; } \
231 SPECIALIZE_TYPE_TRAITS_END()