Comcast website displays bottom of page when loaded
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingTree.h
1 /*
2  * Copyright (C) 2012 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 ScrollingTree_h
27 #define ScrollingTree_h
28
29 #if ENABLE(THREADED_SCROLLING)
30
31 #include "PlatformWheelEvent.h"
32 #include "Region.h"
33 #include <wtf/Functional.h>
34 #include <wtf/OwnPtr.h>
35 #include <wtf/PassOwnPtr.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefPtr.h>
38 #include <wtf/ThreadSafeRefCounted.h>
39
40 #if PLATFORM(MAC)
41 #include <wtf/RetainPtr.h>
42 OBJC_CLASS CALayer;
43 #endif
44
45 namespace WebCore {
46
47 class IntPoint;
48 class ScrollingCoordinator;
49 class ScrollingTreeNode;
50 class ScrollingTreeState;
51
52 // The ScrollingTree class lives almost exclusively on the scrolling thread and manages the
53 // hierarchy of scrollable regions on the page. It's also responsible for dispatching events
54 // to the correct scrolling tree nodes or dispatching events back to the ScrollingCoordinator
55 // object on the main thread if they can't be handled on the scrolling thread for various reasons.
56 class ScrollingTree : public ThreadSafeRefCounted<ScrollingTree> {
57 public:
58     static PassRefPtr<ScrollingTree> create(ScrollingCoordinator*);
59     ~ScrollingTree();
60
61     enum EventResult {
62         DidNotHandleEvent,
63         DidHandleEvent,
64         SendToMainThread
65     };
66
67     // Can be called from any thread. Will try to handle the wheel event on the scrolling thread.
68     // Returns true if the wheel event can be handled on the scrolling thread and false if the
69     // event must be sent again to the WebCore event handler.
70     EventResult tryToHandleWheelEvent(const PlatformWheelEvent&);
71
72     // Can be called from any thread. Will update the back forward state of the page, used for rubber-banding.
73     void updateBackForwardState(bool canGoBack, bool canGoForward);
74
75     // Must be called from the scrolling thread. Handles the wheel event.
76     void handleWheelEvent(const PlatformWheelEvent&);
77
78     void invalidate();
79     void commitNewTreeState(PassOwnPtr<ScrollingTreeState>);
80
81     void setMainFramePinState(bool pinnedToTheLeft, bool pinnedToTheRight);
82
83     void updateMainFrameScrollPosition(const IntPoint& scrollPosition);
84     void updateMainFrameScrollPositionAndScrollLayerPosition(const IntPoint& scrollPosition);
85     IntPoint mainFrameScrollPosition();
86
87 #if PLATFORM(MAC) || (PLATFORM(CHROMIUM) && OS(DARWIN))
88     void handleWheelEventPhase(PlatformWheelEventPhase);
89 #endif
90
91     bool canGoBack();
92     bool canGoForward();
93
94     bool willWheelEventStartSwipeGesture(const PlatformWheelEvent&);
95
96 #if PLATFORM(MAC)
97     void setDebugRootLayer(CALayer *);
98 #endif
99
100 private:
101     explicit ScrollingTree(ScrollingCoordinator*);
102
103     void updateDebugRootLayer();
104
105     RefPtr<ScrollingCoordinator> m_scrollingCoordinator;
106     OwnPtr<ScrollingTreeNode> m_rootNode;
107
108     Mutex m_mutex;
109     Region m_nonFastScrollableRegion;
110     IntPoint m_mainFrameScrollPosition;
111     bool m_hasWheelEventHandlers;
112
113     Mutex m_swipeStateMutex;
114     bool m_canGoBack;
115     bool m_canGoForward;
116     bool m_mainFramePinnedToTheLeft;
117     bool m_mainFramePinnedToTheRight;
118
119 #if PLATFORM(MAC)
120     RetainPtr<CALayer> m_debugInfoLayer;
121 #endif
122 };
123
124 } // namespace WebCore
125
126 #endif // ENABLE(THREADED_SCROLLING)
127
128 #endif // ScrollingTree_h