Make it possible to test rubber-banding in overflow scroll
[WebKit-https.git] / Source / WebCore / rendering / RenderMarquee.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
4  *
5  * Portions are Copyright (C) 1998 Netscape Communications Corporation.
6  *
7  * Other contributors:
8  *   Robert O'Callahan <roc+@cs.cmu.edu>
9  *   David Baron <dbaron@fas.harvard.edu>
10  *   Christian Biesinger <cbiesinger@web.de>
11  *   Randall Jesup <rjesup@wgate.com>
12  *   Roland Mainz <roland.mainz@informatik.med.uni-giessen.de>
13  *   Josh Soref <timeless@mac.com>
14  *   Boris Zbarsky <bzbarsky@mit.edu>
15  *
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  *
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  *
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
29  *
30  * Alternatively, the contents of this file may be used under the terms
31  * of either the Mozilla Public License Version 1.1, found at
32  * http://www.mozilla.org/MPL/ (the "MPL") or the GNU General Public
33  * License Version 2.0, found at http://www.fsf.org/copyleft/gpl.html
34  * (the "GPL"), in which case the provisions of the MPL or the GPL are
35  * applicable instead of those above.  If you wish to allow use of your
36  * version of this file only under the terms of one of those two
37  * licenses (the MPL or the GPL) and not to allow others to use your
38  * version of this file under the LGPL, indicate your decision by
39  * deletingthe provisions above and replace them with the notice and
40  * other provisions required by the MPL or the GPL, as the case may be.
41  * If you do not delete the provisions above, a recipient may use your
42  * version of this file under any of the LGPL, the MPL or the GPL.
43  */
44
45 #include "config.h"
46
47 #include "RenderMarquee.h"
48
49 #include "FrameView.h"
50 #include "HTMLMarqueeElement.h"
51 #include "HTMLNames.h"
52 #include "RenderLayer.h"
53 #include "RenderView.h"
54
55 namespace WebCore {
56
57 using namespace HTMLNames;
58
59 RenderMarquee::RenderMarquee(RenderLayer* l)
60     : m_layer(l)
61     , m_timer(*this, &RenderMarquee::timerFired)
62     , m_reset(false)
63     , m_suspended(false)
64     , m_stopped(false)
65     , m_direction(MAUTO)
66 {
67     l->setConstrainsScrollingToContentEdge(false);
68 }
69
70 RenderMarquee::~RenderMarquee() = default;
71
72 int RenderMarquee::marqueeSpeed() const
73 {
74     int result = m_layer->renderer().style().marqueeSpeed();
75     Element* element = m_layer->renderer().element();
76     if (is<HTMLMarqueeElement>(element))
77         result = std::max(result, downcast<HTMLMarqueeElement>(*element).minimumDelay());
78     return result;
79 }
80
81 EMarqueeDirection RenderMarquee::direction() const
82 {
83     // FIXME: Support the CSS3 "auto" value for determining the direction of the marquee.
84     // For now just map MAUTO to MBACKWARD
85     EMarqueeDirection result = m_layer->renderer().style().marqueeDirection();
86     TextDirection dir = m_layer->renderer().style().direction();
87     if (result == MAUTO)
88         result = MBACKWARD;
89     if (result == MFORWARD)
90         result = (dir == LTR) ? MRIGHT : MLEFT;
91     if (result == MBACKWARD)
92         result = (dir == LTR) ? MLEFT : MRIGHT;
93     
94     // Now we have the real direction.  Next we check to see if the increment is negative.
95     // If so, then we reverse the direction.
96     Length increment = m_layer->renderer().style().marqueeIncrement();
97     if (increment.isNegative())
98         result = static_cast<EMarqueeDirection>(-result);
99     
100     return result;
101 }
102
103 bool RenderMarquee::isHorizontal() const
104 {
105     return direction() == MLEFT || direction() == MRIGHT;
106 }
107
108 int RenderMarquee::computePosition(EMarqueeDirection dir, bool stopAtContentEdge)
109 {
110     RenderBox* box = m_layer->renderBox();
111     ASSERT(box);
112     auto& boxStyle = box->style();
113     if (isHorizontal()) {
114         bool ltr = boxStyle.isLeftToRightDirection();
115         LayoutUnit clientWidth = box->clientWidth();
116         LayoutUnit contentWidth = ltr ? box->maxPreferredLogicalWidth() : box->minPreferredLogicalWidth();
117         if (ltr)
118             contentWidth += (box->paddingRight() - box->borderLeft());
119         else {
120             contentWidth = box->width() - contentWidth;
121             contentWidth += (box->paddingLeft() - box->borderRight());
122         }
123         if (dir == MRIGHT) {
124             if (stopAtContentEdge)
125                 return std::max<LayoutUnit>(0, ltr ? (contentWidth - clientWidth) : (clientWidth - contentWidth));
126             else
127                 return ltr ? contentWidth : clientWidth;
128         }
129         else {
130             if (stopAtContentEdge)
131                 return std::min<LayoutUnit>(0, ltr ? (contentWidth - clientWidth) : (clientWidth - contentWidth));
132             else
133                 return ltr ? -clientWidth : -contentWidth;
134         }
135     }
136     else {
137         int contentHeight = box->layoutOverflowRect().maxY() - box->borderTop() + box->paddingBottom();
138         int clientHeight = roundToInt(box->clientHeight());
139         if (dir == MUP) {
140             if (stopAtContentEdge)
141                  return std::min(contentHeight - clientHeight, 0);
142             else
143                 return -clientHeight;
144         }
145         else {
146             if (stopAtContentEdge)
147                 return std::max(contentHeight - clientHeight, 0);
148             else 
149                 return contentHeight;
150         }
151     }    
152 }
153
154 void RenderMarquee::start()
155 {
156     if (m_timer.isActive() || m_layer->renderer().style().marqueeIncrement().isZero())
157         return;
158
159     if (!m_suspended && !m_stopped) {
160         if (isHorizontal())
161             m_layer->scrollToOffset(ScrollOffset(m_start, 0), ScrollClamping::Unclamped);
162         else
163             m_layer->scrollToOffset(ScrollOffset(0, m_start), ScrollClamping::Unclamped);
164     }
165     else {
166         m_suspended = false;
167         m_stopped = false;
168     }
169
170     m_timer.startRepeating(1_ms * speed());
171 }
172
173 void RenderMarquee::suspend()
174 {
175     m_timer.stop();
176     m_suspended = true;
177 }
178
179 void RenderMarquee::stop()
180 {
181     m_timer.stop();
182     m_stopped = true;
183 }
184
185 void RenderMarquee::updateMarqueePosition()
186 {
187     bool activate = (m_totalLoops <= 0 || m_currentLoop < m_totalLoops);
188     if (activate) {
189         EMarqueeBehavior behavior = m_layer->renderer().style().marqueeBehavior();
190         m_start = computePosition(direction(), behavior == MALTERNATE);
191         m_end = computePosition(reverseDirection(), behavior == MALTERNATE || behavior == MSLIDE);
192         if (!m_stopped)
193             start();
194     }
195 }
196
197 void RenderMarquee::updateMarqueeStyle()
198 {
199     auto& style = m_layer->renderer().style();
200     
201     if (m_direction != style.marqueeDirection() || (m_totalLoops != style.marqueeLoopCount() && m_currentLoop >= m_totalLoops))
202         m_currentLoop = 0; // When direction changes or our loopCount is a smaller number than our current loop, reset our loop.
203     
204     m_totalLoops = style.marqueeLoopCount();
205     m_direction = style.marqueeDirection();
206     
207     if (m_layer->renderer().isHTMLMarquee()) {
208         // Hack for WinIE.  In WinIE, a value of 0 or lower for the loop count for SLIDE means to only do
209         // one loop.
210         if (m_totalLoops <= 0 && style.marqueeBehavior() == MSLIDE)
211             m_totalLoops = 1;
212     }
213     
214     if (speed() != marqueeSpeed()) {
215         m_speed = marqueeSpeed();
216         if (m_timer.isActive())
217             m_timer.startRepeating(1_ms * speed());
218     }
219     
220     // Check the loop count to see if we should now stop.
221     bool activate = (m_totalLoops <= 0 || m_currentLoop < m_totalLoops);
222     if (activate && !m_timer.isActive())
223         m_layer->renderer().setNeedsLayout();
224     else if (!activate && m_timer.isActive())
225         m_timer.stop();
226 }
227
228 void RenderMarquee::timerFired()
229 {
230     if (m_layer->renderer().view().needsLayout())
231         return;
232     
233     if (m_reset) {
234         m_reset = false;
235         if (isHorizontal())
236             m_layer->scrollToXOffset(m_start, ScrollClamping::Unclamped);
237         else
238             m_layer->scrollToYOffset(m_start, ScrollClamping::Unclamped);
239         return;
240     }
241     
242     const RenderStyle& style = m_layer->renderer().style();
243     
244     int endPoint = m_end;
245     int range = m_end - m_start;
246     int newPos;
247     if (range == 0)
248         newPos = m_end;
249     else {  
250         bool addIncrement = direction() == MUP || direction() == MLEFT;
251         bool isReversed = style.marqueeBehavior() == MALTERNATE && m_currentLoop % 2;
252         if (isReversed) {
253             // We're going in the reverse direction.
254             endPoint = m_start;
255             range = -range;
256             addIncrement = !addIncrement;
257         }
258         bool positive = range > 0;
259         int clientSize = (isHorizontal() ? roundToInt(m_layer->renderBox()->clientWidth()) : roundToInt(m_layer->renderBox()->clientHeight()));
260         int increment = abs(intValueForLength(m_layer->renderer().style().marqueeIncrement(), clientSize));
261         int currentPos = (isHorizontal() ? m_layer->scrollOffset().x() : m_layer->scrollOffset().y());
262         newPos =  currentPos + (addIncrement ? increment : -increment);
263         if (positive)
264             newPos = std::min(newPos, endPoint);
265         else
266             newPos = std::max(newPos, endPoint);
267     }
268
269     if (newPos == endPoint) {
270         m_currentLoop++;
271         if (m_totalLoops > 0 && m_currentLoop >= m_totalLoops)
272             m_timer.stop();
273         else if (style.marqueeBehavior() != MALTERNATE)
274             m_reset = true;
275     }
276     
277     if (isHorizontal())
278         m_layer->scrollToXOffset(newPos, ScrollClamping::Unclamped);
279     else
280         m_layer->scrollToYOffset(newPos, ScrollClamping::Unclamped);
281 }
282
283 } // namespace WebCore