Package up some data about scrollability into a struct for use in the scrolling tree
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingCoordinator.h
1 /*
2  * Copyright (C) 2011 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 ScrollingCoordinator_h
27 #define ScrollingCoordinator_h
28
29 #include "IntRect.h"
30 #include "LayoutRect.h"
31 #include "PlatformWheelEvent.h"
32 #include "RenderObject.h"
33 #include "ScrollTypes.h"
34 #include "Timer.h"
35 #include <wtf/Forward.h>
36
37 #if ENABLE(THREADED_SCROLLING)
38 #include <wtf/HashMap.h>
39 #include <wtf/ThreadSafeRefCounted.h>
40 #include <wtf/Threading.h>
41 #endif
42
43 #if PLATFORM(MAC)
44 #include <wtf/RetainPtr.h>
45 #endif
46
47 namespace WebCore {
48
49 typedef unsigned MainThreadScrollingReasons;
50 typedef uint64_t ScrollingNodeID;
51
52 enum ScrollingNodeType { ScrollingNode, FixedNode, StickyNode };
53
54 class Document;
55 class Frame;
56 class FrameView;
57 class GraphicsLayer;
58 class Page;
59 class Region;
60 class ScrollableArea;
61 class ViewportConstraints;
62
63 #if ENABLE(THREADED_SCROLLING)
64 class ScrollingTree;
65 #endif
66
67 enum SetOrSyncScrollingLayerPosition {
68     SetScrollingLayerPosition,
69     SyncScrollingLayerPosition
70 };
71
72 struct ScrollableAreaParameters {
73     ScrollElasticity horizontalScrollElasticity;
74     ScrollElasticity verticalScrollElasticity;
75
76     ScrollbarMode horizontalScrollbarMode;
77     ScrollbarMode verticalScrollbarMode;
78
79     bool hasEnabledHorizontalScrollbar;
80     bool hasEnabledVerticalScrollbar;
81     
82     ScrollableAreaParameters()
83         : horizontalScrollElasticity(ScrollElasticityNone)
84         , verticalScrollElasticity(ScrollElasticityNone)
85         , horizontalScrollbarMode(ScrollbarAuto)
86         , verticalScrollbarMode(ScrollbarAuto)
87         , hasEnabledHorizontalScrollbar(false)
88         , hasEnabledVerticalScrollbar(false)
89     {
90     }
91
92     bool operator==(const ScrollableAreaParameters& other) const
93     {
94         return horizontalScrollElasticity == other.horizontalScrollElasticity
95             && verticalScrollElasticity == other.verticalScrollElasticity
96             && horizontalScrollbarMode == other.horizontalScrollbarMode
97             && verticalScrollbarMode == other.verticalScrollbarMode
98             && hasEnabledHorizontalScrollbar == other.hasEnabledHorizontalScrollbar
99             && hasEnabledVerticalScrollbar == other.hasEnabledVerticalScrollbar;
100     }
101 };
102
103 class ScrollingCoordinator : public ThreadSafeRefCounted<ScrollingCoordinator> {
104 public:
105     static PassRefPtr<ScrollingCoordinator> create(Page*);
106     virtual ~ScrollingCoordinator();
107
108     virtual void pageDestroyed();
109
110 #if ENABLE(THREADED_SCROLLING)
111     virtual ScrollingTree* scrollingTree() const { return 0; }
112 #endif
113
114     // Return whether this scrolling coordinator handles scrolling for the given frame view.
115     bool coordinatesScrollingForFrameView(FrameView*) const;
116
117     // Should be called whenever the given frame view has been laid out.
118     virtual void frameViewLayoutUpdated(FrameView*) { }
119
120     // Should be called whenever a wheel event handler is added or removed in the 
121     // frame view's underlying document.
122     void frameViewWheelEventHandlerCountChanged(FrameView*);
123
124     // Should be called whenever the slow repaint objects counter changes between zero and one.
125     void frameViewHasSlowRepaintObjectsDidChange(FrameView*);
126
127     // Should be called whenever the set of fixed objects changes.
128     void frameViewFixedObjectsDidChange(FrameView*);
129
130     // Should be called whenever the root layer for the given frame view changes.
131     virtual void frameViewRootLayerDidChange(FrameView*);
132
133     // Return whether this scrolling coordinator can keep fixed position layers fixed to their
134     // containers while scrolling.
135     virtual bool supportsFixedPositionLayers() const { return false; }
136
137 #if PLATFORM(MAC)
138     // Dispatched by the scrolling tree during handleWheelEvent. This is required as long as scrollbars are painted on the main thread.
139     void handleWheelEventPhase(PlatformWheelEventPhase);
140 #endif
141
142     // Force all scroll layer position updates to happen on the main thread.
143     void setForceMainThreadScrollLayerPositionUpdates(bool);
144
145     // These virtual functions are currently unique to the threaded scrolling architecture. 
146     // Their meaningful implementations are in ScrollingCoordinatorMac.
147     virtual void commitTreeStateIfNeeded() { }
148     virtual bool requestScrollPositionUpdate(FrameView*, const IntPoint&) { return false; }
149     virtual bool handleWheelEvent(FrameView*, const PlatformWheelEvent&) { return true; }
150     virtual ScrollingNodeID attachToStateTree(ScrollingNodeType, ScrollingNodeID newNodeID, ScrollingNodeID /*parentID*/) { return newNodeID; }
151     virtual void detachFromStateTree(ScrollingNodeID) { }
152     virtual void clearStateTree() { }
153     virtual void updateViewportConstrainedNode(ScrollingNodeID, const ViewportConstraints&, GraphicsLayer*) { }
154     virtual void updateScrollingNode(ScrollingNodeID, GraphicsLayer* /*scrollLayer*/, GraphicsLayer* /*counterScrollingLayer*/) { }
155     virtual void syncChildPositions(const LayoutRect&) { }
156     virtual String scrollingStateTreeAsText() const;
157     virtual bool isRubberBandInProgress() const { return false; }
158     virtual void setScrollPinningBehavior(ScrollPinningBehavior) { }
159
160     // Generated a unique id for scroll layers.
161     ScrollingNodeID uniqueScrollLayerID();
162
163     // Dispatched by the scrolling tree whenever the main frame scroll position changes.
164     void scheduleUpdateMainFrameScrollPosition(const IntPoint&, bool programmaticScroll, SetOrSyncScrollingLayerPosition);
165     void updateMainFrameScrollPosition(const IntPoint&, bool programmaticScroll, SetOrSyncScrollingLayerPosition);
166
167     enum MainThreadScrollingReasonFlags {
168         ForcedOnMainThread = 1 << 0,
169         HasSlowRepaintObjects = 1 << 1,
170         HasViewportConstrainedObjectsWithoutSupportingFixedLayers = 1 << 2,
171         HasNonLayerViewportConstrainedObjects = 1 << 3,
172         IsImageDocument = 1 << 4
173     };
174
175     MainThreadScrollingReasons mainThreadScrollingReasons() const;
176     bool shouldUpdateScrollLayerPositionOnMainThread() const { return mainThreadScrollingReasons() != 0; }
177
178     virtual void willDestroyScrollableArea(ScrollableArea*) { }
179     virtual void scrollableAreaScrollLayerDidChange(ScrollableArea*) { }
180     virtual void scrollableAreaScrollbarLayerDidChange(ScrollableArea*, ScrollbarOrientation) { }
181     virtual void setLayerIsContainerForFixedPositionLayers(GraphicsLayer*, bool) { }
182
183     static String mainThreadScrollingReasonsAsText(MainThreadScrollingReasons);
184     String mainThreadScrollingReasonsAsText() const;
185
186     Region computeNonFastScrollableRegion(const Frame*, const IntPoint& frameLocation) const;
187
188 protected:
189     explicit ScrollingCoordinator(Page*);
190
191 #if USE(ACCELERATED_COMPOSITING)
192     static GraphicsLayer* scrollLayerForScrollableArea(ScrollableArea*);
193     static GraphicsLayer* horizontalScrollbarLayerForScrollableArea(ScrollableArea*);
194     static GraphicsLayer* verticalScrollbarLayerForScrollableArea(ScrollableArea*);
195 #endif
196
197     unsigned computeCurrentWheelEventHandlerCount();
198     GraphicsLayer* scrollLayerForFrameView(FrameView*);
199     GraphicsLayer* counterScrollingLayerForFrameView(FrameView*);
200     GraphicsLayer* headerLayerForFrameView(FrameView*);
201     GraphicsLayer* footerLayerForFrameView(FrameView*);
202
203     Page* m_page;
204
205 private:
206     virtual void recomputeWheelEventHandlerCountForFrameView(FrameView*) { }
207     virtual void setShouldUpdateScrollLayerPositionOnMainThread(MainThreadScrollingReasons) { }
208
209     virtual bool hasVisibleSlowRepaintViewportConstrainedObjects(FrameView*) const;
210     void updateShouldUpdateScrollLayerPositionOnMainThread();
211     
212     void updateMainFrameScrollPositionTimerFired(Timer<ScrollingCoordinator>*);
213
214     Timer<ScrollingCoordinator> m_updateMainFrameScrollPositionTimer;
215     IntPoint m_scheduledUpdateScrollPosition;
216     bool m_scheduledUpdateIsProgrammaticScroll;
217     SetOrSyncScrollingLayerPosition m_scheduledScrollingLayerPositionAction;
218
219     bool m_forceMainThreadScrollLayerPositionUpdates;
220 };
221
222 } // namespace WebCore
223
224 #endif // ScrollingCoordinator_h