ScrollingTree should have the final say on where layers go
[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     // Traverses the scrolling tree, setting layer positions to represent the current scrolled state.
104     virtual void applyScrollingTreeLayerPositions() { }
105
106 #if PLATFORM(COCOA)
107     // Dispatched by the scrolling tree during handleWheelEvent. This is required as long as scrollbars are painted on the main thread.
108     void handleWheelEventPhase(PlatformWheelEventPhase);
109 #endif
110
111     // Force all scroll layer position updates to happen on the main thread.
112     WEBCORE_EXPORT void setForceSynchronousScrollLayerPositionUpdates(bool);
113
114     // These virtual functions are currently unique to the threaded scrolling architecture. 
115     virtual void commitTreeStateIfNeeded() { }
116     virtual bool requestScrollPositionUpdate(FrameView&, const IntPoint&) { return false; }
117     virtual ScrollingEventResult handleWheelEvent(FrameView&, const PlatformWheelEvent&) { return ScrollingEventResult::DidNotHandleEvent; }
118
119     // Create an unparented node.
120     virtual ScrollingNodeID createNode(ScrollingNodeType, ScrollingNodeID newNodeID) { return newNodeID; }
121     // Parent a node in the scrolling tree. This may return a new nodeID if the node type changed. parentID = 0 sets the root node.
122     virtual ScrollingNodeID insertNode(ScrollingNodeType, ScrollingNodeID newNodeID, ScrollingNodeID /*parentID*/, size_t /*childIndex*/ = notFound) { return newNodeID; }
123     // Node will be unparented, but not destroyed. It's the client's responsibility to either re-parent or destroy this node.
124     virtual void unparentNode(ScrollingNodeID) { }
125     // Node will be destroyed, and its children left unparented.
126     virtual void unparentChildrenAndDestroyNode(ScrollingNodeID) { }
127     // Node will be unparented, and it and its children destroyed.
128     virtual void detachAndDestroySubtree(ScrollingNodeID) { }
129     // Destroy the tree, including both parented and unparented nodes.
130     virtual void clearAllNodes() { }
131
132     virtual ScrollingNodeID parentOfNode(ScrollingNodeID) const { return 0; }
133     virtual Vector<ScrollingNodeID> childrenOfNode(ScrollingNodeID) const { return { }; }
134
135     struct NodeLayers {
136         GraphicsLayer* layer { nullptr };
137         GraphicsLayer* scrollContainerLayer { nullptr };
138         GraphicsLayer* scrolledContentsLayer { nullptr };
139         GraphicsLayer* counterScrollingLayer { nullptr };
140         GraphicsLayer* insetClipLayer { nullptr };
141         GraphicsLayer* rootContentsLayer { nullptr };
142         GraphicsLayer* horizontalScrollbarLayer { nullptr };
143         GraphicsLayer* verticalScrollbarLayer { nullptr };
144     };
145     virtual void setNodeLayers(ScrollingNodeID, const NodeLayers&) { }
146
147     virtual void setRectRelativeToParentNode(ScrollingNodeID, const LayoutRect&) { }
148     virtual void setScrollingNodeScrollableAreaGeometry(ScrollingNodeID, ScrollableArea&) { }
149     virtual void setFrameScrollingNodeState(ScrollingNodeID, const FrameView&) { }
150     virtual void setViewportConstraintedNodeConstraints(ScrollingNodeID, const ViewportConstraints&) { }
151
152     virtual void reconcileViewportConstrainedLayerPositions(ScrollingNodeID, const LayoutRect&, ScrollingLayerPositionAction) { }
153     virtual String scrollingStateTreeAsText(ScrollingStateTreeAsTextBehavior = ScrollingStateTreeAsTextBehaviorNormal) const;
154     virtual bool isRubberBandInProgress() const { return false; }
155     virtual bool isScrollSnapInProgress() const { return false; }
156     virtual void updateScrollSnapPropertiesWithFrameView(const FrameView&) { }
157     virtual void setScrollPinningBehavior(ScrollPinningBehavior) { }
158
159     // Generated a unique id for scrolling nodes.
160     ScrollingNodeID uniqueScrollingNodeID();
161
162     enum MainThreadScrollingReasonFlags {
163         ForcedOnMainThread                                          = 1 << 0,
164         HasSlowRepaintObjects                                       = 1 << 1,
165         HasViewportConstrainedObjectsWithoutSupportingFixedLayers   = 1 << 2,
166         HasNonLayerViewportConstrainedObjects                       = 1 << 3,
167         IsImageDocument                                             = 1 << 4
168     };
169
170     SynchronousScrollingReasons synchronousScrollingReasons(const FrameView&) const;
171     bool shouldUpdateScrollLayerPositionSynchronously(const FrameView&) const;
172
173     virtual void willDestroyScrollableArea(ScrollableArea&) { }
174     virtual void scrollableAreaScrollbarLayerDidChange(ScrollableArea&, ScrollbarOrientation) { }
175
176     static String synchronousScrollingReasonsAsText(SynchronousScrollingReasons);
177     String synchronousScrollingReasonsAsText() const;
178
179     EventTrackingRegions absoluteEventTrackingRegions() const;
180     virtual void updateExpectsWheelEventTestTriggerWithFrameView(const FrameView&) { }
181
182 protected:
183     explicit ScrollingCoordinator(Page*);
184
185     GraphicsLayer* scrollContainerLayerForFrameView(FrameView&);
186     GraphicsLayer* scrolledContentsLayerForFrameView(FrameView&);
187     GraphicsLayer* counterScrollingLayerForFrameView(FrameView&);
188     GraphicsLayer* insetClipLayerForFrameView(FrameView&);
189     GraphicsLayer* rootContentsLayerForFrameView(FrameView&);
190     GraphicsLayer* contentShadowLayerForFrameView(FrameView&);
191     GraphicsLayer* headerLayerForFrameView(FrameView&);
192     GraphicsLayer* footerLayerForFrameView(FrameView&);
193
194     virtual void willCommitTree() { }
195
196     Page* m_page; // FIXME: ideally this would be a reference but it gets nulled on async teardown.
197
198 private:
199     virtual void setSynchronousScrollingReasons(FrameView&, SynchronousScrollingReasons) { }
200
201     virtual bool hasVisibleSlowRepaintViewportConstrainedObjects(const FrameView&) const;
202     void updateSynchronousScrollingReasons(FrameView&);
203     void updateSynchronousScrollingReasonsForAllFrames();
204
205     EventTrackingRegions absoluteEventTrackingRegionsForFrame(const Frame&) const;
206
207     bool m_forceSynchronousScrollLayerPositionUpdates { false };
208 };
209
210 WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, ScrollableAreaParameters);
211 WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, ScrollingNodeType);
212 WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, ScrollingLayerPositionAction);
213 WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, ViewportRectStability);
214
215 } // namespace WebCore
216
217 #define SPECIALIZE_TYPE_TRAITS_SCROLLING_COORDINATOR(ToValueTypeName, predicate) \
218 SPECIALIZE_TYPE_TRAITS_BEGIN(ToValueTypeName) \
219     static bool isType(const WebCore::ScrollingCoordinator& value) { return value.predicate; } \
220 SPECIALIZE_TYPE_TRAITS_END()