Consolidate logic for calculating scrollbar page step size
[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 PLATFORM(COCOA)
86     // Events in the PlatformWheelEventPhaseMayBegin phase have no deltas, and therefore never passes through the scroll handling logic below.
87     // This causes us to return with an 'unhandled' return state, even though this event was successfully processed.
88     //
89     // We receive at least one PlatformWheelEventPhaseMayBegin when starting main-thread scrolling (see FrameView::wheelEvent), which can
90     // fool the scrolling thread into attempting to handle the scroll, unless we treat the event as handled here.
91     if (e.phase() == PlatformWheelEventPhaseMayBegin)
92         return true;
93 #endif
94
95     Scrollbar* horizontalScrollbar = m_scrollableArea->horizontalScrollbar();
96     Scrollbar* verticalScrollbar = m_scrollableArea->verticalScrollbar();
97
98     // Accept the event if we have a scrollbar in that direction and can still
99     // scroll any further.
100     float deltaX = horizontalScrollbar ? e.deltaX() : 0;
101     float deltaY = verticalScrollbar ? e.deltaY() : 0;
102
103     bool handled = false;
104
105     ScrollGranularity granularity = ScrollByPixel;
106     IntSize maxForwardScrollDelta = m_scrollableArea->maximumScrollPosition() - m_scrollableArea->scrollPosition();
107     IntSize maxBackwardScrollDelta = m_scrollableArea->scrollPosition() - m_scrollableArea->minimumScrollPosition();
108     if ((deltaX < 0 && maxForwardScrollDelta.width() > 0)
109         || (deltaX > 0 && maxBackwardScrollDelta.width() > 0)
110         || (deltaY < 0 && maxForwardScrollDelta.height() > 0)
111         || (deltaY > 0 && maxBackwardScrollDelta.height() > 0)) {
112         handled = true;
113
114         if (deltaY) {
115             if (e.granularity() == ScrollByPageWheelEvent) {
116                 bool negative = deltaY < 0;
117                 deltaY = Scrollbar::pageStepDelta(m_scrollableArea->visibleHeight());
118                 if (negative)
119                     deltaY = -deltaY;
120             }
121             scroll(VerticalScrollbar, granularity, verticalScrollbar->pixelStep(), -deltaY);
122         }
123
124         if (deltaX) {
125             if (e.granularity() == ScrollByPageWheelEvent) {
126                 bool negative = deltaX < 0;
127                 deltaX = Scrollbar::pageStepDelta(m_scrollableArea->visibleWidth());
128                 if (negative)
129                     deltaX = -deltaX;
130             }
131             scroll(HorizontalScrollbar, granularity, horizontalScrollbar->pixelStep(), -deltaX);
132         }
133     }
134     return handled;
135 }
136
137 #if ENABLE(TOUCH_EVENTS)
138 bool ScrollAnimator::handleTouchEvent(const PlatformTouchEvent&)
139 {
140     return false;
141 }
142 #endif
143
144 void ScrollAnimator::setCurrentPosition(const FloatPoint& position)
145 {
146     m_currentPosX = position.x();
147     m_currentPosY = position.y();
148 }
149
150 FloatPoint ScrollAnimator::currentPosition() const
151 {
152     return FloatPoint(m_currentPosX, m_currentPosY);
153 }
154
155 void ScrollAnimator::notifyPositionChanged(const FloatSize& delta)
156 {
157     UNUSED_PARAM(delta);
158     m_scrollableArea->setScrollOffsetFromAnimation(IntPoint(m_currentPosX, m_currentPosY));
159 }
160
161 } // namespace WebCore