Make it possible to test rubber-banding in overflow scroll
[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 #pragma once
28
29 #if ENABLE(SMOOTH_SCROLLING)
30
31 #include "IntRect.h"
32 #include "FloatPoint.h"
33 #include "FloatSize.h"
34 #include "ScrollAnimator.h"
35 #include "Timer.h"
36 #include <wtf/RetainPtr.h>
37
38 OBJC_CLASS WebScrollAnimationHelperDelegate;
39 OBJC_CLASS WebScrollerImpPairDelegate;
40 OBJC_CLASS WebScrollerImpDelegate;
41
42 typedef id ScrollerImpPair;
43
44 namespace WebCore {
45
46 class Scrollbar;
47
48 class ScrollAnimatorMac : public ScrollAnimator {
49
50 public:
51     ScrollAnimatorMac(ScrollableArea&);
52     virtual ~ScrollAnimatorMac();
53
54     void immediateScrollToPositionForScrollAnimation(const FloatPoint& newPosition);
55     bool haveScrolledSincePageLoad() const { return m_haveScrolledSincePageLoad; }
56
57     void updateScrollerStyle();
58
59     bool scrollbarPaintTimerIsActive() const;
60     void startScrollbarPaintTimer();
61     void stopScrollbarPaintTimer();
62
63     void setVisibleScrollerThumbRect(const IntRect&);
64
65     bool scrollbarsCanBeActive() const final;
66
67 private:
68     RetainPtr<id> m_scrollAnimationHelper;
69     RetainPtr<WebScrollAnimationHelperDelegate> m_scrollAnimationHelperDelegate;
70
71     RetainPtr<ScrollerImpPair> m_scrollerImpPair;
72     RetainPtr<WebScrollerImpPairDelegate> m_scrollerImpPairDelegate;
73     RetainPtr<WebScrollerImpDelegate> m_horizontalScrollerImpDelegate;
74     RetainPtr<WebScrollerImpDelegate> m_verticalScrollerImpDelegate;
75
76     void initialScrollbarPaintTimerFired();
77     Timer m_initialScrollbarPaintTimer;
78
79     void sendContentAreaScrolledTimerFired();
80     Timer m_sendContentAreaScrolledTimer;
81     FloatSize m_contentAreaScrolledTimerScrollDelta;
82
83     bool scroll(ScrollbarOrientation, ScrollGranularity, float step, float multiplier) override;
84     void scrollToOffsetWithoutAnimation(const FloatPoint&, ScrollClamping) override;
85
86 #if ENABLE(RUBBER_BANDING)
87     bool shouldForwardWheelEventsToParent(const PlatformWheelEvent&);
88     bool handleWheelEvent(const PlatformWheelEvent&) override;
89 #endif
90
91     void handleWheelEventPhase(PlatformWheelEventPhase) override;
92
93     void cancelAnimations() override;
94     
95     void notifyPositionChanged(const FloatSize& delta) override;
96     void contentAreaWillPaint() const override;
97     void mouseEnteredContentArea() override;
98     void mouseExitedContentArea() override;
99     void mouseMovedInContentArea() override;
100     void mouseEnteredScrollbar(Scrollbar*) const override;
101     void mouseExitedScrollbar(Scrollbar*) const override;
102     void mouseIsDownInScrollbar(Scrollbar*, bool) const override;
103     void willStartLiveResize() override;
104     void contentsResized() const override;
105     void willEndLiveResize() override;
106     void contentAreaDidShow() override;
107     void contentAreaDidHide() override;
108     void didBeginScrollGesture() const;
109     void didEndScrollGesture() const;
110     void mayBeginScrollGesture() const;
111
112     void lockOverlayScrollbarStateToHidden(bool shouldLockState) final;
113
114     void didAddVerticalScrollbar(Scrollbar*) override;
115     void willRemoveVerticalScrollbar(Scrollbar*) override;
116     void didAddHorizontalScrollbar(Scrollbar*) override;
117     void willRemoveHorizontalScrollbar(Scrollbar*) override;
118
119     void invalidateScrollbarPartLayers(Scrollbar*) override;
120
121     void verticalScrollbarLayerDidChange() override;
122     void horizontalScrollbarLayerDidChange() override;
123
124     bool shouldScrollbarParticipateInHitTesting(Scrollbar*) override;
125
126     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 immediateScrollToPosition(const FloatPoint&, ScrollClamping = ScrollClamping::Clamped);
137
138     bool isRubberBandInProgress() const override;
139     bool isScrollSnapInProgress() const override;
140
141 #if ENABLE(RUBBER_BANDING)
142     /// ScrollControllerClient member functions.
143     IntSize stretchAmount() override;
144     bool allowsHorizontalStretching(const PlatformWheelEvent&) override;
145     bool allowsVerticalStretching(const PlatformWheelEvent&) override;
146     bool pinnedInDirection(const FloatSize&) override;
147     bool canScrollHorizontally() override;
148     bool canScrollVertically() override;
149     bool shouldRubberBandInDirection(ScrollDirection) override;
150     void immediateScrollByWithoutContentEdgeConstraints(const FloatSize&) override;
151     void immediateScrollBy(const FloatSize&) override;
152     void adjustScrollPositionToBoundsIfNecessary() override;
153
154     bool isAlreadyPinnedInDirectionOfGesture(const PlatformWheelEvent&, ScrollEventAxis);
155 #endif
156
157     bool m_haveScrolledSincePageLoad;
158     bool m_needsScrollerStyleUpdate;
159     IntRect m_visibleScrollerThumbRect;
160 };
161
162 } // namespace WebCore
163
164 #endif // ENABLE(SMOOTH_SCROLLING)
165