ea3c3977b581d870eec23186ef046a3ef6253a5f
[WebKit-https.git] / Source / WebCore / platform / ScrollAnimator.cpp
1 /*
2  * Copyright (C) 2014 Apple Inc.  All rights reserved.
3  * Copyright (c) 2010, Google 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 are
7  * met:
8  * 
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  * 
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33 #include "ScrollAnimator.h"
34
35 #include "FloatPoint.h"
36 #include "PlatformWheelEvent.h"
37 #include "ScrollableArea.h"
38 #include <algorithm>
39 #include <wtf/PassOwnPtr.h>
40
41 namespace WebCore {
42
43 #if !ENABLE(SMOOTH_SCROLLING) && !PLATFORM(IOS)
44 PassOwnPtr<ScrollAnimator> ScrollAnimator::create(ScrollableArea* scrollableArea)
45 {
46     return adoptPtr(new ScrollAnimator(scrollableArea));
47 }
48 #endif
49
50 ScrollAnimator::ScrollAnimator(ScrollableArea* scrollableArea)
51     : m_scrollableArea(scrollableArea)
52     , m_currentPosX(0)
53     , m_currentPosY(0)
54 {
55 }
56
57 ScrollAnimator::~ScrollAnimator()
58 {
59 }
60
61 bool ScrollAnimator::scroll(ScrollbarOrientation orientation, ScrollGranularity, float step, float multiplier)
62 {
63     float* currentPos = (orientation == HorizontalScrollbar) ? &m_currentPosX : &m_currentPosY;
64     float newPos = std::max(std::min(*currentPos + (step * multiplier), static_cast<float>(m_scrollableArea->scrollSize(orientation))), 0.0f);
65     float delta = *currentPos - newPos;
66     if (*currentPos == newPos)
67         return false;
68     *currentPos = newPos;
69
70     notifyPositionChanged(orientation == HorizontalScrollbar ? FloatSize(delta, 0) : FloatSize(0, delta));
71
72     return true;
73 }
74
75 void ScrollAnimator::scrollToOffsetWithoutAnimation(const FloatPoint& offset)
76 {
77     FloatSize delta = FloatSize(offset.x() - m_currentPosX, offset.y() - m_currentPosY);
78     m_currentPosX = offset.x();
79     m_currentPosY = offset.y();
80     notifyPositionChanged(delta);
81 }
82
83 bool ScrollAnimator::handleWheelEvent(const PlatformWheelEvent& e)
84 {
85 #if ENABLE(CSS_SCROLL_SNAP) && PLATFORM(MAC)
86     if (m_verticalScrollSnapAnimator) {
87         m_verticalScrollSnapAnimator->handleWheelEvent(e);
88         if (m_verticalScrollSnapAnimator->shouldOverrideWheelEvent(e))
89             return false;
90     }
91     if (m_horizontalScrollSnapAnimator) {
92         m_horizontalScrollSnapAnimator->handleWheelEvent(e);
93         if (m_horizontalScrollSnapAnimator->shouldOverrideWheelEvent(e))
94             return false;
95     }
96 #endif
97 #if PLATFORM(COCOA)
98     // Events in the PlatformWheelEventPhaseMayBegin phase have no deltas, and therefore never passes through the scroll handling logic below.
99     // This causes us to return with an 'unhandled' return state, even though this event was successfully processed.
100     //
101     // We receive at least one PlatformWheelEventPhaseMayBegin when starting main-thread scrolling (see FrameView::wheelEvent), which can
102     // fool the scrolling thread into attempting to handle the scroll, unless we treat the event as handled here.
103     if (e.phase() == PlatformWheelEventPhaseMayBegin)
104         return true;
105 #endif
106
107     Scrollbar* horizontalScrollbar = m_scrollableArea->horizontalScrollbar();
108     Scrollbar* verticalScrollbar = m_scrollableArea->verticalScrollbar();
109
110     // Accept the event if we have a scrollbar in that direction and can still
111     // scroll any further.
112     float deltaX = horizontalScrollbar ? e.deltaX() : 0;
113     float deltaY = verticalScrollbar ? e.deltaY() : 0;
114
115     bool handled = false;
116
117     ScrollGranularity granularity = ScrollByPixel;
118     IntSize maxForwardScrollDelta = m_scrollableArea->maximumScrollPosition() - m_scrollableArea->scrollPosition();
119     IntSize maxBackwardScrollDelta = m_scrollableArea->scrollPosition() - m_scrollableArea->minimumScrollPosition();
120     if ((deltaX < 0 && maxForwardScrollDelta.width() > 0)
121         || (deltaX > 0 && maxBackwardScrollDelta.width() > 0)
122         || (deltaY < 0 && maxForwardScrollDelta.height() > 0)
123         || (deltaY > 0 && maxBackwardScrollDelta.height() > 0)) {
124         handled = true;
125
126         if (deltaY) {
127             if (e.granularity() == ScrollByPageWheelEvent) {
128                 bool negative = deltaY < 0;
129                 deltaY = Scrollbar::pageStepDelta(m_scrollableArea->visibleHeight());
130                 if (negative)
131                     deltaY = -deltaY;
132             }
133             scroll(VerticalScrollbar, granularity, verticalScrollbar->pixelStep(), -deltaY);
134         }
135
136         if (deltaX) {
137             if (e.granularity() == ScrollByPageWheelEvent) {
138                 bool negative = deltaX < 0;
139                 deltaX = Scrollbar::pageStepDelta(m_scrollableArea->visibleWidth());
140                 if (negative)
141                     deltaX = -deltaX;
142             }
143             scroll(HorizontalScrollbar, granularity, horizontalScrollbar->pixelStep(), -deltaX);
144         }
145     }
146     return handled;
147 }
148
149 #if ENABLE(TOUCH_EVENTS)
150 bool ScrollAnimator::handleTouchEvent(const PlatformTouchEvent&)
151 {
152     return false;
153 }
154 #endif
155
156 void ScrollAnimator::setCurrentPosition(const FloatPoint& position)
157 {
158     m_currentPosX = position.x();
159     m_currentPosY = position.y();
160 }
161
162 FloatPoint ScrollAnimator::currentPosition() const
163 {
164     return FloatPoint(m_currentPosX, m_currentPosY);
165 }
166
167 void ScrollAnimator::notifyPositionChanged(const FloatSize& delta)
168 {
169     UNUSED_PARAM(delta);
170     m_scrollableArea->setScrollOffsetFromAnimation(IntPoint(m_currentPosX, m_currentPosY));
171 }
172
173 #if ENABLE(CSS_SCROLL_SNAP) && PLATFORM(MAC)
174 void ScrollAnimator::updateScrollAnimatorsAndTimers()
175 {
176     // FIXME: Currently, scroll snap animators are recreated even though the snap offsets alone can be updated.
177     if (m_scrollableArea->horizontalSnapOffsets()) {
178         m_horizontalScrollSnapAnimator = std::make_unique<AxisScrollSnapAnimator>(this, m_scrollableArea->horizontalSnapOffsets(), ScrollEventAxis::Horizontal);
179         m_horizontalScrollSnapTimer = std::make_unique<Timer>(this, &ScrollAnimator::horizontalScrollSnapTimerFired);
180     } else if (m_horizontalScrollSnapAnimator) {
181         m_horizontalScrollSnapAnimator = nullptr;
182         m_horizontalScrollSnapTimer = nullptr;
183     }
184     if (m_scrollableArea->verticalSnapOffsets()) {
185         m_verticalScrollSnapAnimator = std::make_unique<AxisScrollSnapAnimator>(this, m_scrollableArea->verticalSnapOffsets(), ScrollEventAxis::Vertical);
186         m_verticalScrollSnapTimer = std::make_unique<Timer>(this, &ScrollAnimator::verticalScrollSnapTimerFired);
187     } else if (m_verticalScrollSnapAnimator) {
188         m_verticalScrollSnapAnimator = nullptr;
189         m_verticalScrollSnapTimer = nullptr;
190     }
191 }
192
193 LayoutUnit ScrollAnimator::scrollOffsetInAxis(ScrollEventAxis axis)
194 {
195     FloatPoint currentPosition = this->currentPosition();
196     return axis == ScrollEventAxis::Horizontal ? currentPosition.x() : currentPosition.y();
197 }
198
199 void ScrollAnimator::immediateScrollInAxis(ScrollEventAxis axis, float delta)
200 {
201     FloatPoint currentPosition = this->currentPosition();
202     if (axis == ScrollEventAxis::Horizontal)
203         scrollToOffsetWithoutAnimation(FloatPoint(currentPosition.x() + delta, currentPosition.y()));
204     else
205         scrollToOffsetWithoutAnimation(FloatPoint(currentPosition.x(), currentPosition.y() + delta));
206 }
207
208 void ScrollAnimator::startScrollSnapTimer(ScrollEventAxis axis)
209 {
210     Timer* scrollSnapTimer = axis == ScrollEventAxis::Horizontal ? m_horizontalScrollSnapTimer.get() : m_verticalScrollSnapTimer.get();
211     if (!scrollSnapTimer->isActive())
212         scrollSnapTimer->startRepeating(1.0 / 60.0);
213 }
214
215 void ScrollAnimator::stopScrollSnapTimer(ScrollEventAxis axis)
216 {
217     Timer* scrollSnapTimer = axis == ScrollEventAxis::Horizontal ? m_horizontalScrollSnapTimer.get() : m_verticalScrollSnapTimer.get();
218     if (scrollSnapTimer->isActive())
219         scrollSnapTimer->stop();
220 }
221
222 void ScrollAnimator::horizontalScrollSnapTimerFired(Timer&)
223 {
224     m_horizontalScrollSnapAnimator->scrollSnapAnimationUpdate();
225 }
226
227 void ScrollAnimator::verticalScrollSnapTimerFired(Timer&)
228 {
229     m_verticalScrollSnapAnimator->scrollSnapAnimationUpdate();
230 }
231 #endif
232
233 } // namespace WebCore