Use "= default" to denote default constructor or destructor
[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), m_currentLoop(0)
61     , m_totalLoops(0)
62     , m_timer(*this, &RenderMarquee::timerFired)
63     , m_start(0), m_end(0), m_speed(0), m_reset(false)
64     , m_suspended(false), m_stopped(false), m_direction(MAUTO)
65 {
66     l->setConstrainsScrollingToContentEdge(false);
67 }
68
69 RenderMarquee::~RenderMarquee() = default;
70
71 int RenderMarquee::marqueeSpeed() const
72 {
73     int result = m_layer->renderer().style().marqueeSpeed();
74     Element* element = m_layer->renderer().element();
75     if (is<HTMLMarqueeElement>(element))
76         result = std::max(result, downcast<HTMLMarqueeElement>(*element).minimumDelay());
77     return result;
78 }
79
80 EMarqueeDirection RenderMarquee::direction() const
81 {
82     // FIXME: Support the CSS3 "auto" value for determining the direction of the marquee.
83     // For now just map MAUTO to MBACKWARD
84     EMarqueeDirection result = m_layer->renderer().style().marqueeDirection();
85     TextDirection dir = m_layer->renderer().style().direction();
86     if (result == MAUTO)
87         result = MBACKWARD;
88     if (result == MFORWARD)
89         result = (dir == LTR) ? MRIGHT : MLEFT;
90     if (result == MBACKWARD)
91         result = (dir == LTR) ? MLEFT : MRIGHT;
92     
93     // Now we have the real direction.  Next we check to see if the increment is negative.
94     // If so, then we reverse the direction.
95     Length increment = m_layer->renderer().style().marqueeIncrement();
96     if (increment.isNegative())
97         result = static_cast<EMarqueeDirection>(-result);
98     
99     return result;
100 }
101
102 bool RenderMarquee::isHorizontal() const
103 {
104     return direction() == MLEFT || direction() == MRIGHT;
105 }
106
107 int RenderMarquee::computePosition(EMarqueeDirection dir, bool stopAtContentEdge)
108 {
109     RenderBox* box = m_layer->renderBox();
110     ASSERT(box);
111     auto& boxStyle = box->style();
112     if (isHorizontal()) {
113         bool ltr = boxStyle.isLeftToRightDirection();
114         LayoutUnit clientWidth = box->clientWidth();
115         LayoutUnit contentWidth = ltr ? box->maxPreferredLogicalWidth() : box->minPreferredLogicalWidth();
116         if (ltr)
117             contentWidth += (box->paddingRight() - box->borderLeft());
118         else {
119             contentWidth = box->width() - contentWidth;
120             contentWidth += (box->paddingLeft() - box->borderRight());
121         }
122         if (dir == MRIGHT) {
123             if (stopAtContentEdge)
124                 return std::max<LayoutUnit>(0, ltr ? (contentWidth - clientWidth) : (clientWidth - contentWidth));
125             else
126                 return ltr ? contentWidth : clientWidth;
127         }
128         else {
129             if (stopAtContentEdge)
130                 return std::min<LayoutUnit>(0, ltr ? (contentWidth - clientWidth) : (clientWidth - contentWidth));
131             else
132                 return ltr ? -clientWidth : -contentWidth;
133         }
134     }
135     else {
136         int contentHeight = box->layoutOverflowRect().maxY() - box->borderTop() + box->paddingBottom();
137         int clientHeight = roundToInt(box->clientHeight());
138         if (dir == MUP) {
139             if (stopAtContentEdge)
140                  return std::min(contentHeight - clientHeight, 0);
141             else
142                 return -clientHeight;
143         }
144         else {
145             if (stopAtContentEdge)
146                 return std::max(contentHeight - clientHeight, 0);
147             else 
148                 return contentHeight;
149         }
150     }    
151 }
152
153 void RenderMarquee::start()
154 {
155     if (m_timer.isActive() || m_layer->renderer().style().marqueeIncrement().isZero())
156         return;
157
158     if (!m_suspended && !m_stopped) {
159         if (isHorizontal())
160             m_layer->scrollToOffset(ScrollOffset(m_start, 0));
161         else
162             m_layer->scrollToOffset(ScrollOffset(0, m_start));
163     }
164     else {
165         m_suspended = false;
166         m_stopped = false;
167     }
168
169     m_timer.startRepeating(1_ms * speed());
170 }
171
172 void RenderMarquee::suspend()
173 {
174     m_timer.stop();
175     m_suspended = true;
176 }
177
178 void RenderMarquee::stop()
179 {
180     m_timer.stop();
181     m_stopped = true;
182 }
183
184 void RenderMarquee::updateMarqueePosition()
185 {
186     bool activate = (m_totalLoops <= 0 || m_currentLoop < m_totalLoops);
187     if (activate) {
188         EMarqueeBehavior behavior = m_layer->renderer().style().marqueeBehavior();
189         m_start = computePosition(direction(), behavior == MALTERNATE);
190         m_end = computePosition(reverseDirection(), behavior == MALTERNATE || behavior == MSLIDE);
191         if (!m_stopped)
192             start();
193     }
194 }
195
196 void RenderMarquee::updateMarqueeStyle()
197 {
198     auto& style = m_layer->renderer().style();
199     
200     if (m_direction != style.marqueeDirection() || (m_totalLoops != style.marqueeLoopCount() && m_currentLoop >= m_totalLoops))
201         m_currentLoop = 0; // When direction changes or our loopCount is a smaller number than our current loop, reset our loop.
202     
203     m_totalLoops = style.marqueeLoopCount();
204     m_direction = style.marqueeDirection();
205     
206     if (m_layer->renderer().isHTMLMarquee()) {
207         // Hack for WinIE.  In WinIE, a value of 0 or lower for the loop count for SLIDE means to only do
208         // one loop.
209         if (m_totalLoops <= 0 && style.marqueeBehavior() == MSLIDE)
210             m_totalLoops = 1;
211     }
212     
213     if (speed() != marqueeSpeed()) {
214         m_speed = marqueeSpeed();
215         if (m_timer.isActive())
216             m_timer.startRepeating(1_ms * speed());
217     }
218     
219     // Check the loop count to see if we should now stop.
220     bool activate = (m_totalLoops <= 0 || m_currentLoop < m_totalLoops);
221     if (activate && !m_timer.isActive())
222         m_layer->renderer().setNeedsLayout();
223     else if (!activate && m_timer.isActive())
224         m_timer.stop();
225 }
226
227 void RenderMarquee::timerFired()
228 {
229     if (m_layer->renderer().view().needsLayout())
230         return;
231     
232     if (m_reset) {
233         m_reset = false;
234         if (isHorizontal())
235             m_layer->scrollToXOffset(m_start);
236         else
237             m_layer->scrollToYOffset(m_start);
238         return;
239     }
240     
241     const RenderStyle& style = m_layer->renderer().style();
242     
243     int endPoint = m_end;
244     int range = m_end - m_start;
245     int newPos;
246     if (range == 0)
247         newPos = m_end;
248     else {  
249         bool addIncrement = direction() == MUP || direction() == MLEFT;
250         bool isReversed = style.marqueeBehavior() == MALTERNATE && m_currentLoop % 2;
251         if (isReversed) {
252             // We're going in the reverse direction.
253             endPoint = m_start;
254             range = -range;
255             addIncrement = !addIncrement;
256         }
257         bool positive = range > 0;
258         int clientSize = (isHorizontal() ? roundToInt(m_layer->renderBox()->clientWidth()) : roundToInt(m_layer->renderBox()->clientHeight()));
259         int increment = abs(intValueForLength(m_layer->renderer().style().marqueeIncrement(), clientSize));
260         int currentPos = (isHorizontal() ? m_layer->scrollOffset().x() : m_layer->scrollOffset().y());
261         newPos =  currentPos + (addIncrement ? increment : -increment);
262         if (positive)
263             newPos = std::min(newPos, endPoint);
264         else
265             newPos = std::max(newPos, endPoint);
266     }
267
268     if (newPos == endPoint) {
269         m_currentLoop++;
270         if (m_totalLoops > 0 && m_currentLoop >= m_totalLoops)
271             m_timer.stop();
272         else if (style.marqueeBehavior() != MALTERNATE)
273             m_reset = true;
274     }
275     
276     if (isHorizontal())
277         m_layer->scrollToXOffset(newPos);
278     else
279         m_layer->scrollToYOffset(newPos);
280 }
281
282 } // namespace WebCore