a6e77aea3b9b3d6ed8c7f6a0bbe04a196d56f497
[WebKit-https.git] / Source / WebCore / page / scrolling / AsyncScrollingCoordinator.h
1 /*
2  * Copyright (C) 2014 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 #ifndef AsyncScrollingCoordinator_h
27 #define AsyncScrollingCoordinator_h
28
29 #if ENABLE(ASYNC_SCROLLING)
30
31 #include "ScrollingCoordinator.h"
32
33 #include "ScrollingTree.h"
34 #include "Timer.h"
35 #include <wtf/OwnPtr.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefPtr.h>
38
39 namespace WebCore {
40
41 class Page;
42 class Scrollbar;
43 class ScrollingStateNode;
44 class ScrollingStateScrollingNode;
45 class ScrollingStateTree;
46
47 // ScrollingCoordinator subclass that maintains a ScrollingStateTree and a ScrollingTree,
48 // allowing asynchronous scrolling (in another thread or process).
49 class AsyncScrollingCoordinator : public ScrollingCoordinator {
50 public:
51     static PassRefPtr<AsyncScrollingCoordinator> create(Page*);
52     virtual ~AsyncScrollingCoordinator();
53
54     ScrollingTree* scrollingTree() const { return m_scrollingTree.get(); }
55
56     virtual PassOwnPtr<ScrollingTreeNode> createScrollingTreeNode(ScrollingNodeType, ScrollingNodeID) = 0;
57
58     void scrollingStateTreePropertiesChanged();
59
60     void scheduleUpdateScrollPositionAfterAsyncScroll(ScrollingNodeID, const FloatPoint&, bool programmaticScroll, SetOrSyncScrollingLayerPosition);
61
62 protected:
63     AsyncScrollingCoordinator(Page*);
64
65     void setScrollingTree(PassRefPtr<ScrollingTree> scrollingTree) { m_scrollingTree = scrollingTree; }
66
67     ScrollingStateTree* scrollingStateTree() { return m_scrollingStateTree.get(); }
68
69     PassRefPtr<ScrollingTree> releaseScrollingTree() { return m_scrollingTree.release(); }
70
71     void updateScrollPositionAfterAsyncScroll(ScrollingNodeID, const FloatPoint&, bool programmaticScroll, SetOrSyncScrollingLayerPosition);
72
73 private:
74     virtual bool isAsyncScrollingCoordinator() const override { return true; }
75
76     virtual bool supportsFixedPositionLayers() const override { return true; }
77     virtual bool hasVisibleSlowRepaintViewportConstrainedObjects(FrameView*) const override { return false; }
78
79     virtual void frameViewLayoutUpdated(FrameView*) override;
80     virtual void frameViewRootLayerDidChange(FrameView*) override;
81     virtual void frameViewNonFastScrollableRegionChanged(FrameView*) override;
82
83     virtual bool requestScrollPositionUpdate(FrameView*, const IntPoint&) override;
84
85     virtual ScrollingNodeID attachToStateTree(ScrollingNodeType, ScrollingNodeID newNodeID, ScrollingNodeID parentID) override;
86     virtual void detachFromStateTree(ScrollingNodeID) override;
87     virtual void clearStateTree() override;
88     
89     virtual void updateViewportConstrainedNode(ScrollingNodeID, const ViewportConstraints&, GraphicsLayer*) override;
90     
91     virtual void updateFrameScrollingNode(ScrollingNodeID, GraphicsLayer* scrollLayer, GraphicsLayer* scrolledContentsLayer, GraphicsLayer* counterScrollingLayer, GraphicsLayer* insetClipLayer, const ScrollingGeometry* = nullptr);
92     virtual void updateOverflowScrollingNode(ScrollingNodeID, GraphicsLayer* scrollLayer, GraphicsLayer* scrolledContentsLayer, const ScrollingGeometry* = nullptr);
93     
94     virtual String scrollingStateTreeAsText() const override;
95     virtual bool isRubberBandInProgress() const override;
96     virtual void setScrollPinningBehavior(ScrollPinningBehavior) override;
97
98     virtual void syncChildPositions(const LayoutRect& viewportRect) override;
99     virtual void scrollableAreaScrollbarLayerDidChange(ScrollableArea*, ScrollbarOrientation) override;
100
101     virtual void recomputeWheelEventHandlerCountForFrameView(FrameView*) override;
102     virtual void setSynchronousScrollingReasons(SynchronousScrollingReasons) override;
103
104     virtual void scheduleTreeStateCommit() = 0;
105
106     void ensureRootStateNodeForFrameView(FrameView*);
107     void updateMainFrameScrollLayerPosition();
108
109     void updateScrollPositionAfterAsyncScrollTimerFired(Timer<AsyncScrollingCoordinator>*);
110
111     Timer<AsyncScrollingCoordinator> m_updateNodeScrollPositionTimer;
112
113     struct ScheduledScrollUpdate {
114         ScheduledScrollUpdate()
115             : nodeID(0)
116             , isProgrammaticScroll(false)
117             , updateLayerPositionAction(SyncScrollingLayerPosition)
118         { }
119
120         ScheduledScrollUpdate(ScrollingNodeID scrollingNodeID, FloatPoint point, bool isProgrammatic, SetOrSyncScrollingLayerPosition udpateAction)
121             : nodeID(scrollingNodeID)
122             , scrollPosition(point)
123             , isProgrammaticScroll(isProgrammatic)
124             , updateLayerPositionAction(udpateAction)
125         { }
126
127         ScrollingNodeID nodeID;
128         FloatPoint scrollPosition;
129         bool isProgrammaticScroll;
130         SetOrSyncScrollingLayerPosition updateLayerPositionAction;
131         
132         bool matchesUpdateType(const ScheduledScrollUpdate& other) const
133         {
134             return nodeID == other.nodeID
135                 && isProgrammaticScroll == other.isProgrammaticScroll
136                 && updateLayerPositionAction == other.updateLayerPositionAction;
137         }
138     };
139
140     ScheduledScrollUpdate m_scheduledScrollUpdate;
141
142     OwnPtr<ScrollingStateTree> m_scrollingStateTree;
143     RefPtr<ScrollingTree> m_scrollingTree;
144 };
145
146 SCROLLING_COORDINATOR_TYPE_CASTS(AsyncScrollingCoordinator, isAsyncScrollingCoordinator());
147
148 } // namespace WebCore
149
150 #endif // ENABLE(ASYNC_SCROLLING)
151
152 #endif // AsyncScrollingCoordinator_h