- add third_party src.
[platform/framework/web/crosswalk.git] / src / third_party / WebKit / Source / core / page / AutoscrollController.cpp
1 /*
2  * Copyright (C) 2013 Google Inc. All rights reserved.
3  * Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
4  * Copyright (C) 2006 Alexey Proskuryakov (ap@webkit.org)
5  * Copyright (C) 2012 Digia Plc. and/or its subsidiary(-ies)
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
24  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "core/page/AutoscrollController.h"
31
32 #include "core/page/EventHandler.h"
33 #include "core/frame/Frame.h"
34 #include "core/frame/FrameView.h"
35 #include "core/page/Chrome.h"
36 #include "core/page/Page.h"
37 #include "core/rendering/HitTestResult.h"
38 #include "core/rendering/RenderBox.h"
39 #include "wtf/CurrentTime.h"
40
41 namespace WebCore {
42
43 // Delay time in second for start autoscroll if pointer is in border edge of scrollable element.
44 static double autoscrollDelay = 0.2;
45
46 PassOwnPtr<AutoscrollController> AutoscrollController::create(Page& page)
47 {
48     return adoptPtr(new AutoscrollController(page));
49 }
50
51 AutoscrollController::AutoscrollController(Page& page)
52     : m_page(page)
53     , m_autoscrollRenderer(0)
54     , m_autoscrollType(NoAutoscroll)
55     , m_dragAndDropAutoscrollStartTime(0)
56 {
57 }
58
59 bool AutoscrollController::autoscrollInProgress() const
60 {
61     return m_autoscrollType == AutoscrollForSelection;
62 }
63
64 bool AutoscrollController::autoscrollInProgress(const RenderBox* renderer) const
65 {
66     return m_autoscrollRenderer == renderer;
67 }
68
69 void AutoscrollController::startAutoscrollForSelection(RenderObject* renderer)
70 {
71     // We don't want to trigger the autoscroll or the panScroll if it's already active
72     if (m_autoscrollType != NoAutoscroll)
73         return;
74     RenderBox* scrollable = RenderBox::findAutoscrollable(renderer);
75     if (!scrollable)
76         return;
77     m_autoscrollType = AutoscrollForSelection;
78     m_autoscrollRenderer = scrollable;
79     startAutoscroll();
80 }
81
82 void AutoscrollController::stopAutoscroll()
83 {
84     RenderBox* scrollable = m_autoscrollRenderer;
85     m_autoscrollRenderer = 0;
86
87     if (!scrollable)
88         return;
89
90     scrollable->stopAutoscroll();
91 #if OS(WIN)
92     if (panScrollInProgress()) {
93         if (FrameView* view = scrollable->frame()->view()) {
94             view->removePanScrollIcon();
95             view->setCursor(pointerCursor());
96         }
97     }
98 #endif
99
100     m_autoscrollType = NoAutoscroll;
101 }
102
103 void AutoscrollController::stopAutoscrollIfNeeded(RenderObject* renderer)
104 {
105     if (m_autoscrollRenderer != renderer)
106         return;
107     m_autoscrollRenderer = 0;
108     m_autoscrollType = NoAutoscroll;
109 }
110
111 void AutoscrollController::updateAutoscrollRenderer()
112 {
113     if (!m_autoscrollRenderer)
114         return;
115
116     RenderObject* renderer = m_autoscrollRenderer;
117
118 #if OS(WIN)
119     HitTestResult hitTest = renderer->frame()->eventHandler().hitTestResultAtPoint(m_panScrollStartPos, HitTestRequest::ReadOnly | HitTestRequest::Active | HitTestRequest::ConfusingAndOftenMisusedDisallowShadowContent);
120
121     if (Node* nodeAtPoint = hitTest.innerNode())
122         renderer = nodeAtPoint->renderer();
123 #endif
124
125     while (renderer && !(renderer->isBox() && toRenderBox(renderer)->canAutoscroll()))
126         renderer = renderer->parent();
127     m_autoscrollRenderer = renderer && renderer->isBox() ? toRenderBox(renderer) : 0;
128 }
129
130 void AutoscrollController::updateDragAndDrop(Node* dropTargetNode, const IntPoint& eventPosition, double eventTime)
131 {
132     if (!dropTargetNode || !dropTargetNode->renderer()) {
133         stopAutoscroll();
134         return;
135     }
136
137     if (m_autoscrollRenderer && m_autoscrollRenderer->frame() != dropTargetNode->renderer()->frame())
138         return;
139
140     RenderBox* scrollable = RenderBox::findAutoscrollable(dropTargetNode->renderer());
141     if (!scrollable) {
142         stopAutoscroll();
143         return;
144     }
145
146     Page* page = scrollable->frame() ? scrollable->frame()->page() : 0;
147     if (!page) {
148         stopAutoscroll();
149         return;
150     }
151
152     IntSize offset = scrollable->calculateAutoscrollDirection(eventPosition);
153     if (offset.isZero()) {
154         stopAutoscroll();
155         return;
156     }
157
158     m_dragAndDropAutoscrollReferencePosition = eventPosition + offset;
159
160     if (m_autoscrollType == NoAutoscroll) {
161         m_autoscrollType = AutoscrollForDragAndDrop;
162         m_autoscrollRenderer = scrollable;
163         m_dragAndDropAutoscrollStartTime = eventTime;
164         startAutoscroll();
165     } else if (m_autoscrollRenderer != scrollable) {
166         m_dragAndDropAutoscrollStartTime = eventTime;
167         m_autoscrollRenderer = scrollable;
168     }
169 }
170
171 #if OS(WIN)
172 void AutoscrollController::handleMouseReleaseForPanScrolling(Frame* frame, const PlatformMouseEvent& mouseEvent)
173 {
174     Page* page = frame->page();
175     if (!page || page->mainFrame() != frame)
176         return;
177     switch (m_autoscrollType) {
178     case AutoscrollForPan:
179         if (mouseEvent.button() == MiddleButton)
180             m_autoscrollType = AutoscrollForPanCanStop;
181         break;
182     case AutoscrollForPanCanStop:
183         stopAutoscroll();
184         break;
185     }
186 }
187
188 bool AutoscrollController::panScrollInProgress() const
189 {
190     return m_autoscrollType == AutoscrollForPanCanStop || m_autoscrollType == AutoscrollForPan;
191 }
192
193 void AutoscrollController::startPanScrolling(RenderBox* scrollable, const IntPoint& lastKnownMousePosition)
194 {
195     // We don't want to trigger the autoscroll or the panScroll if it's already active
196     if (m_autoscrollType != NoAutoscroll)
197         return;
198
199     m_autoscrollType = AutoscrollForPan;
200     m_autoscrollRenderer = scrollable;
201     m_panScrollStartPos = lastKnownMousePosition;
202
203     if (FrameView* view = scrollable->frame()->view())
204         view->addPanScrollIcon(lastKnownMousePosition);
205     startAutoscroll();
206 }
207 #else
208 bool AutoscrollController::panScrollInProgress() const
209 {
210     return false;
211 }
212 #endif
213
214 // FIXME: This would get get better animation fidelity if it used the monotonicFrameBeginTime instead
215 // of WTF::currentTime().
216 void AutoscrollController::animate(double)
217 {
218     if (!m_autoscrollRenderer) {
219         stopAutoscroll();
220         return;
221     }
222
223     EventHandler& eventHandler = m_autoscrollRenderer->frame()->eventHandler();
224     switch (m_autoscrollType) {
225     case AutoscrollForDragAndDrop:
226         if (WTF::currentTime() - m_dragAndDropAutoscrollStartTime > autoscrollDelay)
227             m_autoscrollRenderer->autoscroll(m_dragAndDropAutoscrollReferencePosition);
228         break;
229     case AutoscrollForSelection:
230         if (!eventHandler.mousePressed()) {
231             stopAutoscroll();
232             return;
233         }
234         eventHandler.updateSelectionForMouseDrag();
235         m_autoscrollRenderer->autoscroll(eventHandler.lastKnownMousePosition());
236         break;
237     case NoAutoscroll:
238         break;
239 #if OS(WIN)
240     case AutoscrollForPanCanStop:
241     case AutoscrollForPan:
242         if (!panScrollInProgress()) {
243             stopAutoscroll();
244             return;
245         }
246         if (FrameView* view = m_autoscrollRenderer->frame()->view())
247             updatePanScrollState(view, eventHandler.lastKnownMousePosition());
248         m_autoscrollRenderer->panScroll(m_panScrollStartPos);
249         break;
250 #endif
251     }
252     if (m_autoscrollType != NoAutoscroll)
253         m_page.chrome().scheduleAnimation();
254 }
255
256 void AutoscrollController::startAutoscroll()
257 {
258     m_page.chrome().scheduleAnimation();
259 }
260
261 #if OS(WIN)
262 void AutoscrollController::updatePanScrollState(FrameView* view, const IntPoint& lastKnownMousePosition)
263 {
264     // At the original click location we draw a 4 arrowed icon. Over this icon there won't be any scroll
265     // So we don't want to change the cursor over this area
266     bool east = m_panScrollStartPos.x() < (lastKnownMousePosition.x() - ScrollView::noPanScrollRadius);
267     bool west = m_panScrollStartPos.x() > (lastKnownMousePosition.x() + ScrollView::noPanScrollRadius);
268     bool north = m_panScrollStartPos.y() > (lastKnownMousePosition.y() + ScrollView::noPanScrollRadius);
269     bool south = m_panScrollStartPos.y() < (lastKnownMousePosition.y() - ScrollView::noPanScrollRadius);
270
271     if (m_autoscrollType == AutoscrollForPan && (east || west || north || south))
272         m_autoscrollType = AutoscrollForPanCanStop;
273
274     if (north) {
275         if (east)
276             view->setCursor(northEastPanningCursor());
277         else if (west)
278             view->setCursor(northWestPanningCursor());
279         else
280             view->setCursor(northPanningCursor());
281     } else if (south) {
282         if (east)
283             view->setCursor(southEastPanningCursor());
284         else if (west)
285             view->setCursor(southWestPanningCursor());
286         else
287             view->setCursor(southPanningCursor());
288     } else if (east)
289         view->setCursor(eastPanningCursor());
290     else if (west)
291         view->setCursor(westPanningCursor());
292     else
293         view->setCursor(middlePanningCursor());
294 }
295 #endif
296
297 } // namespace WebCore