REGRESSION (r184296): View keeps scrolling upward
[WebKit-https.git] / Source / WebCore / platform / mac / ScrollAnimatorMac.h
1
2 /*
3  * Copyright (C) 2010, 2011, 2014-2015 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24  * THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef ScrollAnimatorMac_h
28 #define ScrollAnimatorMac_h
29
30 #if ENABLE(SMOOTH_SCROLLING)
31
32 #include "IntRect.h"
33 #include "FloatPoint.h"
34 #include "FloatSize.h"
35 #include "ScrollAnimator.h"
36 #include "Timer.h"
37 #include <wtf/RetainPtr.h>
38
39 OBJC_CLASS WebScrollAnimationHelperDelegate;
40 OBJC_CLASS WebScrollbarPainterControllerDelegate;
41 OBJC_CLASS WebScrollbarPainterDelegate;
42
43 typedef id ScrollbarPainterController;
44
45 namespace WebCore {
46
47 class Scrollbar;
48
49 class ScrollAnimatorMac : public ScrollAnimator {
50
51 public:
52     ScrollAnimatorMac(ScrollableArea&);
53     virtual ~ScrollAnimatorMac();
54
55     void immediateScrollToPointForScrollAnimation(const FloatPoint& newPosition);
56     bool haveScrolledSincePageLoad() const { return m_haveScrolledSincePageLoad; }
57
58     void updateScrollerStyle();
59
60     bool scrollbarPaintTimerIsActive() const;
61     void startScrollbarPaintTimer();
62     void stopScrollbarPaintTimer();
63
64     void setVisibleScrollerThumbRect(const IntRect&);
65
66     virtual bool scrollbarsCanBeActive() const override final;
67
68 private:
69     RetainPtr<id> m_scrollAnimationHelper;
70     RetainPtr<WebScrollAnimationHelperDelegate> m_scrollAnimationHelperDelegate;
71
72     RetainPtr<ScrollbarPainterController> m_scrollbarPainterController;
73     RetainPtr<WebScrollbarPainterControllerDelegate> m_scrollbarPainterControllerDelegate;
74     RetainPtr<WebScrollbarPainterDelegate> m_horizontalScrollbarPainterDelegate;
75     RetainPtr<WebScrollbarPainterDelegate> m_verticalScrollbarPainterDelegate;
76
77     void initialScrollbarPaintTimerFired();
78     Timer m_initialScrollbarPaintTimer;
79
80     void sendContentAreaScrolledTimerFired();
81     Timer m_sendContentAreaScrolledTimer;
82     FloatSize m_contentAreaScrolledTimerScrollDelta;
83
84     virtual bool scroll(ScrollbarOrientation, ScrollGranularity, float step, float multiplier) override;
85     virtual void scrollToOffsetWithoutAnimation(const FloatPoint&) override;
86
87 #if ENABLE(RUBBER_BANDING)
88     bool shouldForwardWheelEventsToParent(const PlatformWheelEvent&);
89     virtual bool handleWheelEvent(const PlatformWheelEvent&) override;
90 #endif
91
92     virtual void handleWheelEventPhase(PlatformWheelEventPhase) override;
93
94     virtual void cancelAnimations() override;
95     
96     virtual void notifyPositionChanged(const FloatSize& delta) override;
97     virtual void contentAreaWillPaint() const override;
98     virtual void mouseEnteredContentArea() const override;
99     virtual void mouseExitedContentArea() const override;
100     virtual void mouseMovedInContentArea() const override;
101     virtual void mouseEnteredScrollbar(Scrollbar*) const override;
102     virtual void mouseExitedScrollbar(Scrollbar*) const override;
103     virtual void willStartLiveResize() override;
104     virtual void contentsResized() const override;
105     virtual void willEndLiveResize() override;
106     virtual void contentAreaDidShow() const override;
107     virtual void contentAreaDidHide() const override;
108     void didBeginScrollGesture() const;
109     void didEndScrollGesture() const;
110     void mayBeginScrollGesture() const;
111
112     virtual void lockOverlayScrollbarStateToHidden(bool shouldLockState) override final;
113
114     virtual void didAddVerticalScrollbar(Scrollbar*) override;
115     virtual void willRemoveVerticalScrollbar(Scrollbar*) override;
116     virtual void didAddHorizontalScrollbar(Scrollbar*) override;
117     virtual void willRemoveHorizontalScrollbar(Scrollbar*) override;
118
119     void invalidateScrollbarPartLayers(Scrollbar*) override;
120
121     virtual void verticalScrollbarLayerDidChange() override;
122     virtual void horizontalScrollbarLayerDidChange() override;
123
124     virtual bool shouldScrollbarParticipateInHitTesting(Scrollbar*) override;
125
126     virtual void notifyContentAreaScrolled(const FloatSize& delta) override;
127
128     // sendContentAreaScrolledSoon() will do the same work that sendContentAreaScrolled() does except
129     // it does it after a zero-delay timer fires. This will prevent us from updating overlay scrollbar 
130     // information during layout.
131     void sendContentAreaScrolled(const FloatSize& scrollDelta);
132     void sendContentAreaScrolledSoon(const FloatSize& scrollDelta);
133
134     FloatPoint adjustScrollPositionIfNecessary(const FloatPoint&) const;
135
136     void immediateScrollTo(const FloatPoint&);
137
138     bool isRubberBandInProgress() const override;
139     bool isScrollSnapInProgress() const override;
140
141 #if ENABLE(RUBBER_BANDING)
142     /// ScrollControllerClient member functions.
143     virtual IntSize stretchAmount() override;
144     virtual bool allowsHorizontalStretching(const PlatformWheelEvent&) override;
145     virtual bool allowsVerticalStretching(const PlatformWheelEvent&) override;
146     virtual bool pinnedInDirection(const FloatSize&) override;
147     virtual bool canScrollHorizontally() override;
148     virtual bool canScrollVertically() override;
149     virtual bool shouldRubberBandInDirection(ScrollDirection) override;
150     virtual WebCore::IntPoint absoluteScrollPosition() override;
151     virtual void immediateScrollByWithoutContentEdgeConstraints(const FloatSize&) override;
152     virtual void immediateScrollBy(const FloatSize&) override;
153     virtual void adjustScrollPositionToBoundsIfNecessary() override;
154
155     bool isAlreadyPinnedInDirectionOfGesture(const PlatformWheelEvent&, ScrollEventAxis);
156 #endif
157
158     bool m_haveScrolledSincePageLoad;
159     bool m_needsScrollerStyleUpdate;
160     IntRect m_visibleScrollerThumbRect;
161 };
162
163 } // namespace WebCore
164
165 #endif // ENABLE(SMOOTH_SCROLLING)
166
167 #endif // ScrollAnimatorMac_h