efc68415c39430df7f27043fe982332775567632
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingTree.h
1 /*
2  * Copyright (C) 2012-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 #if ENABLE(ASYNC_SCROLLING)
29
30 #include "PlatformWheelEvent.h"
31 #include "Region.h"
32 #include "ScrollingCoordinator.h"
33 #include "WheelEventTestTrigger.h"
34 #include <wtf/HashMap.h>
35 #include <wtf/Lock.h>
36 #include <wtf/ThreadSafeRefCounted.h>
37 #include <wtf/TypeCasts.h>
38
39 namespace WebCore {
40
41 class IntPoint;
42 class ScrollingStateTree;
43 class ScrollingStateNode;
44 class ScrollingTreeNode;
45 class ScrollingTreeScrollingNode;
46
47 class ScrollingTree : public ThreadSafeRefCounted<ScrollingTree> {
48 public:
49     WEBCORE_EXPORT ScrollingTree();
50     WEBCORE_EXPORT virtual ~ScrollingTree();
51
52     enum EventResult {
53         DidNotHandleEvent,
54         DidHandleEvent,
55         SendToMainThread
56     };
57     
58     virtual bool isThreadedScrollingTree() const { return false; }
59     virtual bool isRemoteScrollingTree() const { return false; }
60     virtual bool isScrollingTreeIOS() const { return false; }
61
62     bool visualViewportEnabled() const { return m_visualViewportEnabled; }
63
64     virtual EventResult tryToHandleWheelEvent(const PlatformWheelEvent&) = 0;
65     WEBCORE_EXPORT bool shouldHandleWheelEventSynchronously(const PlatformWheelEvent&);
66     
67     void setMainFrameIsRubberBanding(bool);
68     bool isRubberBandInProgress();
69     void setMainFrameIsScrollSnapping(bool);
70     bool isScrollSnapInProgress();
71
72     virtual void invalidate() { }
73     WEBCORE_EXPORT virtual void commitTreeState(std::unique_ptr<ScrollingStateTree>);
74
75     void setMainFramePinState(bool pinnedToTheLeft, bool pinnedToTheRight, bool pinnedToTheTop, bool pinnedToTheBottom);
76
77     virtual Ref<ScrollingTreeNode> createScrollingTreeNode(ScrollingNodeType, ScrollingNodeID) = 0;
78
79     // Called after a scrolling tree node has handled a scroll and updated its layers.
80     // Updates FrameView/RenderLayer scrolling state and GraphicsLayers.
81     virtual void scrollingTreeNodeDidScroll(ScrollingNodeID, const FloatPoint& scrollPosition, const Optional<FloatPoint>& layoutViewportOrigin, ScrollingLayerPositionAction = ScrollingLayerPositionAction::Sync) = 0;
82
83     // Called for requested scroll position updates.
84     virtual void scrollingTreeNodeRequestsScroll(ScrollingNodeID, const FloatPoint& /*scrollPosition*/, bool /*representsProgrammaticScroll*/) { }
85
86     // Delegated scrolling/zooming has caused the viewport to change, so update viewport-constrained layers
87     // (but don't cause scroll events to be fired).
88     WEBCORE_EXPORT virtual void viewportChangedViaDelegatedScrolling(ScrollingNodeID, const WebCore::FloatRect& fixedPositionRect, double scale);
89
90     // Delegated scrolling has scrolled a node. Update layer positions on descendant tree nodes,
91     // and call scrollingTreeNodeDidScroll().
92     WEBCORE_EXPORT virtual void scrollPositionChangedViaDelegatedScrolling(ScrollingNodeID, const WebCore::FloatPoint& scrollPosition, bool inUserInteraction);
93
94     virtual void reportSynchronousScrollingReasonsChanged(MonotonicTime, SynchronousScrollingReasons) { }
95     virtual void reportExposedUnfilledArea(MonotonicTime, unsigned /* unfilledArea */) { }
96
97     FloatPoint mainFrameScrollPosition();
98     
99 #if PLATFORM(IOS_FAMILY)
100     virtual FloatRect fixedPositionRect() = 0;
101     virtual void scrollingTreeNodeWillStartPanGesture() { }
102     virtual void scrollingTreeNodeWillStartScroll() { }
103     virtual void scrollingTreeNodeDidEndScroll() { }
104 #endif
105
106     WEBCORE_EXPORT TrackingType eventTrackingTypeForPoint(const AtomicString& eventName, IntPoint);
107     
108 #if PLATFORM(MAC)
109     virtual void handleWheelEventPhase(PlatformWheelEventPhase) = 0;
110     virtual void setActiveScrollSnapIndices(ScrollingNodeID, unsigned /*horizontalIndex*/, unsigned /*verticalIndex*/) { }
111     virtual void deferTestsForReason(WheelEventTestTrigger::ScrollableAreaIdentifier, WheelEventTestTrigger::DeferTestTriggerReason) { }
112     virtual void removeTestDeferralForReason(WheelEventTestTrigger::ScrollableAreaIdentifier, WheelEventTestTrigger::DeferTestTriggerReason) { }
113 #endif
114
115 #if PLATFORM(COCOA)
116     WEBCORE_EXPORT virtual void currentSnapPointIndicesDidChange(ScrollingNodeID, unsigned horizontal, unsigned vertical) = 0;
117 #endif
118
119     // Can be called from any thread. Will update what edges allow rubber-banding.
120     WEBCORE_EXPORT void setCanRubberBandState(bool canRubberBandAtLeft, bool canRubberBandAtRight, bool canRubberBandAtTop, bool canRubberBandAtBottom);
121
122     bool rubberBandsAtLeft();
123     bool rubberBandsAtRight();
124     bool rubberBandsAtTop();
125     bool rubberBandsAtBottom();
126     bool isHandlingProgrammaticScroll();
127     
128     void setScrollPinningBehavior(ScrollPinningBehavior);
129     ScrollPinningBehavior scrollPinningBehavior();
130
131     WEBCORE_EXPORT bool willWheelEventStartSwipeGesture(const PlatformWheelEvent&);
132
133     WEBCORE_EXPORT void setScrollingPerformanceLoggingEnabled(bool flag);
134     bool scrollingPerformanceLoggingEnabled();
135
136     ScrollingTreeNode* rootNode() const { return m_rootNode.get(); }
137
138     ScrollingNodeID latchedNode();
139     void setLatchedNode(ScrollingNodeID);
140     void clearLatchedNode();
141
142     bool hasLatchedNode() const { return m_latchedNode; }
143     void setOrClearLatchedNode(const PlatformWheelEvent&, ScrollingNodeID);
144
145     bool hasFixedOrSticky() const { return !!m_fixedOrStickyNodeCount; }
146     void fixedOrStickyNodeAdded() { ++m_fixedOrStickyNodeCount; }
147     void fixedOrStickyNodeRemoved()
148     {
149         ASSERT(m_fixedOrStickyNodeCount);
150         --m_fixedOrStickyNodeCount;
151     }
152     
153     WEBCORE_EXPORT String scrollingTreeAsText();
154     
155 protected:
156     void setMainFrameScrollPosition(FloatPoint);
157     void setVisualViewportEnabled(bool b) { m_visualViewportEnabled = b; }
158
159     WEBCORE_EXPORT virtual void handleWheelEvent(const PlatformWheelEvent&);
160
161 private:
162     void removeDestroyedNodes(const ScrollingStateTree&);
163     
164     typedef HashMap<ScrollingNodeID, RefPtr<ScrollingTreeNode>> OrphanScrollingNodeMap;
165     void updateTreeFromStateNode(const ScrollingStateNode*, OrphanScrollingNodeMap&);
166
167     ScrollingTreeNode* nodeForID(ScrollingNodeID) const;
168
169     RefPtr<ScrollingTreeNode> m_rootNode;
170
171     typedef HashMap<ScrollingNodeID, ScrollingTreeNode*> ScrollingTreeNodeMap;
172     ScrollingTreeNodeMap m_nodeMap;
173
174     Lock m_mutex;
175     EventTrackingRegions m_eventTrackingRegions;
176     FloatPoint m_mainFrameScrollPosition;
177
178     Lock m_swipeStateMutex;
179     ScrollPinningBehavior m_scrollPinningBehavior { DoNotPin };
180     ScrollingNodeID m_latchedNode { 0 };
181
182     unsigned m_fixedOrStickyNodeCount { 0 };
183
184     bool m_rubberBandsAtLeft { true };
185     bool m_rubberBandsAtRight { true };
186     bool m_rubberBandsAtTop { true };
187     bool m_rubberBandsAtBottom { true };
188     bool m_mainFramePinnedToTheLeft { true };
189     bool m_mainFramePinnedToTheRight { true };
190     bool m_mainFramePinnedToTheTop { true };
191     bool m_mainFramePinnedToTheBottom { true };
192     bool m_mainFrameIsRubberBanding { false };
193     bool m_mainFrameIsScrollSnapping { false };
194     bool m_scrollingPerformanceLoggingEnabled { false };
195     bool m_isHandlingProgrammaticScroll { false };
196     bool m_visualViewportEnabled { false };
197 };
198     
199 } // namespace WebCore
200
201 #define SPECIALIZE_TYPE_TRAITS_SCROLLING_TREE(ToValueTypeName, predicate) \
202 SPECIALIZE_TYPE_TRAITS_BEGIN(ToValueTypeName) \
203     static bool isType(const WebCore::ScrollingTree& tree) { return tree.predicate; } \
204 SPECIALIZE_TYPE_TRAITS_END()
205 #endif // ENABLE(ASYNC_SCROLLING)