10f3928290351b02cae13a40b0b1fcf986f6f269
[WebKit-https.git] / Source / WebCore / dom / MouseEvent.cpp
1 /*
2  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
3  * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
4  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
5  * Copyright (C) 2003, 2005, 2006, 2008 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #include "config.h"
24 #include "MouseEvent.h"
25
26 #include "Clipboard.h"
27 #include "EventDispatcher.h"
28 #include "EventNames.h"
29 #include "EventRetargeter.h"
30 #include "Frame.h"
31 #include "FrameView.h"
32 #include "HTMLIFrameElement.h"
33 #include "PlatformMouseEvent.h"
34
35 namespace WebCore {
36
37 MouseEventInit::MouseEventInit()
38     : screenX(0)
39     , screenY(0)
40     , clientX(0)
41     , clientY(0)
42     , ctrlKey(false)
43     , altKey(false)
44     , shiftKey(false)
45     , metaKey(false)
46     , button(0)
47     , relatedTarget(0)
48 {
49 }
50
51 PassRefPtr<MouseEvent> MouseEvent::create(const AtomicString& type, const MouseEventInit& initializer)
52 {
53     return adoptRef(new MouseEvent(type, initializer));
54 }
55
56 PassRefPtr<MouseEvent> MouseEvent::create(const AtomicString& eventType, PassRefPtr<AbstractView> view, const PlatformMouseEvent& event, int detail, PassRefPtr<Node> relatedTarget)
57 {
58     ASSERT(event.type() == PlatformEvent::MouseMoved || event.button() != NoButton);
59
60     bool isCancelable = eventType != eventNames().mousemoveEvent;
61
62     return MouseEvent::create(eventType, true, isCancelable, view,
63         detail, event.globalPosition().x(), event.globalPosition().y(), event.position().x(), event.position().y(),
64 #if ENABLE(POINTER_LOCK)
65         event.movementDelta().x(), event.movementDelta().y(),
66 #endif
67         event.ctrlKey(), event.altKey(), event.shiftKey(), event.metaKey(), event.button(),
68         relatedTarget, 0, false);
69 }
70
71 PassRefPtr<MouseEvent> MouseEvent::create(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView> view,
72     int detail, int screenX, int screenY, int pageX, int pageY,
73 #if ENABLE(POINTER_LOCK)
74     int movementX, int movementY,
75 #endif
76     bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,
77     PassRefPtr<EventTarget> relatedTarget)
78
79 {
80     return MouseEvent::create(type, canBubble, cancelable, view,
81         detail, screenX, screenY, pageX, pageY,
82 #if ENABLE(POINTER_LOCK)
83         movementX, movementY,
84 #endif
85         ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget, 0, false);
86 }
87
88 PassRefPtr<MouseEvent> MouseEvent::create(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView> view,
89     int detail, int screenX, int screenY, int pageX, int pageY,
90 #if ENABLE(POINTER_LOCK)
91     int movementX, int movementY,
92 #endif
93     bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,
94     PassRefPtr<EventTarget> relatedTarget, PassRefPtr<Clipboard> clipboard, bool isSimulated)
95 {
96     return adoptRef(new MouseEvent(type, canBubble, cancelable, view,
97         detail, screenX, screenY, pageX, pageY,
98 #if ENABLE(POINTER_LOCK)
99         movementX, movementY,
100 #endif
101         ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget, clipboard, isSimulated));
102 }
103
104 MouseEvent::MouseEvent()
105     : m_button(0)
106     , m_buttonDown(false)
107 {
108 }
109
110 MouseEvent::MouseEvent(const AtomicString& eventType, bool canBubble, bool cancelable, PassRefPtr<AbstractView> view,
111                        int detail, int screenX, int screenY, int pageX, int pageY,
112 #if ENABLE(POINTER_LOCK)
113                        int movementX, int movementY,
114 #endif
115                        bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,
116                        unsigned short button, PassRefPtr<EventTarget> relatedTarget,
117                        PassRefPtr<Clipboard> clipboard, bool isSimulated)
118     : MouseRelatedEvent(eventType, canBubble, cancelable, view, detail, IntPoint(screenX, screenY),
119                         IntPoint(pageX, pageY),
120 #if ENABLE(POINTER_LOCK)
121                         IntPoint(movementX, movementY),
122 #endif
123                         ctrlKey, altKey, shiftKey, metaKey, isSimulated)
124     , m_button(button == (unsigned short)-1 ? 0 : button)
125     , m_buttonDown(button != (unsigned short)-1)
126     , m_relatedTarget(relatedTarget)
127     , m_clipboard(clipboard)
128 {
129 }
130
131 MouseEvent::MouseEvent(const AtomicString& eventType, const MouseEventInit& initializer)
132     : MouseRelatedEvent(eventType, initializer.bubbles, initializer.cancelable, initializer.view, initializer.detail, IntPoint(initializer.screenX, initializer.screenY),
133         IntPoint(0 /* pageX */, 0 /* pageY */),
134 #if ENABLE(POINTER_LOCK)
135         IntPoint(0 /* movementX */, 0 /* movementY */),
136 #endif
137         initializer.ctrlKey, initializer.altKey, initializer.shiftKey, initializer.metaKey, false /* isSimulated */)
138     , m_button(initializer.button == (unsigned short)-1 ? 0 : initializer.button)
139     , m_buttonDown(initializer.button != (unsigned short)-1)
140     , m_relatedTarget(initializer.relatedTarget)
141     , m_clipboard(0 /* clipboard */)
142 {
143     initCoordinates(IntPoint(initializer.clientX, initializer.clientY));
144 }
145
146 MouseEvent::~MouseEvent()
147 {
148 }
149
150 void MouseEvent::initMouseEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView> view,
151                                 int detail, int screenX, int screenY, int clientX, int clientY,
152                                 bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,
153                                 unsigned short button, PassRefPtr<EventTarget> relatedTarget)
154 {
155     if (dispatched())
156         return;
157
158     initUIEvent(type, canBubble, cancelable, view, detail);
159
160     m_screenLocation = IntPoint(screenX, screenY);
161     m_ctrlKey = ctrlKey;
162     m_altKey = altKey;
163     m_shiftKey = shiftKey;
164     m_metaKey = metaKey;
165     m_button = button == (unsigned short)-1 ? 0 : button;
166     m_buttonDown = button != (unsigned short)-1;
167     m_relatedTarget = relatedTarget;
168
169     initCoordinates(IntPoint(clientX, clientY));
170
171     // FIXME: m_isSimulated is not set to false here.
172     // FIXME: m_clipboard is not set to 0 here.
173 }
174
175 const AtomicString& MouseEvent::interfaceName() const
176 {
177     return eventNames().interfaceForMouseEvent;
178 }
179
180 bool MouseEvent::isMouseEvent() const
181 {
182     return true;
183 }
184
185 bool MouseEvent::isDragEvent() const
186 {
187     const AtomicString& t = type();
188     return t == eventNames().dragenterEvent || t == eventNames().dragoverEvent || t == eventNames().dragleaveEvent || t == eventNames().dropEvent
189                || t == eventNames().dragstartEvent|| t == eventNames().dragEvent || t == eventNames().dragendEvent;
190 }
191
192 int MouseEvent::which() const
193 {
194     // For the DOM, the return values for left, middle and right mouse buttons are 0, 1, 2, respectively.
195     // For the Netscape "which" property, the return values for left, middle and right mouse buttons are 1, 2, 3, respectively. 
196     // So we must add 1.
197     if (!m_buttonDown)
198         return 0;
199     return m_button + 1;
200 }
201
202 Node* MouseEvent::toElement() const
203 {
204     // MSIE extension - "the object toward which the user is moving the mouse pointer"
205     if (type() == eventNames().mouseoutEvent) 
206         return relatedTarget() ? relatedTarget()->toNode() : 0;
207     
208     return target() ? target()->toNode() : 0;
209 }
210
211 Node* MouseEvent::fromElement() const
212 {
213     // MSIE extension - "object from which activation or the mouse pointer is exiting during the event" (huh?)
214     if (type() != eventNames().mouseoutEvent)
215         return relatedTarget() ? relatedTarget()->toNode() : 0;
216     
217     return target() ? target()->toNode() : 0;
218 }
219
220 // FIXME: Fix positioning. e.g. We need to consider border/padding.
221 // https://bugs.webkit.org/show_bug.cgi?id=93696
222 inline static int adjustedClientX(int innerClientX, HTMLIFrameElement* iframe, FrameView* frameView)
223 {
224     return iframe->offsetLeft() - frameView->scrollX() + innerClientX;
225 }
226
227 inline static int adjustedClientY(int innerClientY, HTMLIFrameElement* iframe, FrameView* frameView)
228 {
229     return iframe->offsetTop() - frameView->scrollY() + innerClientY;
230 }
231
232 PassRefPtr<Event> MouseEvent::cloneFor(HTMLIFrameElement* iframe) const
233 {
234     ASSERT(iframe);
235     RefPtr<MouseEvent> clonedMouseEvent = MouseEvent::create();
236     Frame* frame = iframe->document()->frame();
237     FrameView* frameView = frame ? frame->view() : 0;
238     clonedMouseEvent->initMouseEvent(type(), bubbles(), cancelable(),
239             iframe->document()->defaultView(),
240             detail(), screenX(), screenY(),
241             frameView ? adjustedClientX(clientX(), iframe, frameView) : 0,
242             frameView ? adjustedClientY(clientY(), iframe, frameView) : 0,
243             ctrlKey(), altKey(), shiftKey(), metaKey(),
244             button(),
245             // Nullifies relatedTarget.
246             0);
247     return clonedMouseEvent.release();
248 }
249
250 PassRefPtr<SimulatedMouseEvent> SimulatedMouseEvent::create(const AtomicString& eventType, PassRefPtr<AbstractView> view, PassRefPtr<Event> underlyingEvent)
251 {
252     return adoptRef(new SimulatedMouseEvent(eventType, view, underlyingEvent));
253 }
254
255 SimulatedMouseEvent::~SimulatedMouseEvent()
256 {
257 }
258
259 SimulatedMouseEvent::SimulatedMouseEvent(const AtomicString& eventType, PassRefPtr<AbstractView> view, PassRefPtr<Event> underlyingEvent)
260     : MouseEvent(eventType, true, true, view, 0, 0, 0, 0, 0,
261 #if ENABLE(POINTER_LOCK)
262                  0, 0,
263 #endif
264                  false, false, false, false, 0, 0, 0, true)
265 {
266     if (UIEventWithKeyState* keyStateEvent = findEventWithKeyState(underlyingEvent.get())) {
267         m_ctrlKey = keyStateEvent->ctrlKey();
268         m_altKey = keyStateEvent->altKey();
269         m_shiftKey = keyStateEvent->shiftKey();
270         m_metaKey = keyStateEvent->metaKey();
271     }
272     setUnderlyingEvent(underlyingEvent);
273
274     if (this->underlyingEvent() && this->underlyingEvent()->isMouseEvent()) {
275         MouseEvent* mouseEvent = static_cast<MouseEvent*>(this->underlyingEvent());
276         m_screenLocation = mouseEvent->screenLocation();
277         initCoordinates(mouseEvent->clientLocation());
278     }
279 }
280
281 PassRefPtr<MouseEventDispatchMediator> MouseEventDispatchMediator::create(PassRefPtr<MouseEvent> mouseEvent, MouseEventType mouseEventType)
282 {
283     return adoptRef(new MouseEventDispatchMediator(mouseEvent, mouseEventType));
284 }
285
286 MouseEventDispatchMediator::MouseEventDispatchMediator(PassRefPtr<MouseEvent> mouseEvent, MouseEventType mouseEventType)
287     : EventDispatchMediator(mouseEvent), m_mouseEventType(mouseEventType)
288 {
289 }
290
291 MouseEvent* MouseEventDispatchMediator::event() const
292 {
293     return static_cast<MouseEvent*>(EventDispatchMediator::event());
294 }
295
296 bool MouseEventDispatchMediator::dispatchEvent(EventDispatcher* dispatcher) const
297 {
298     if (isSyntheticMouseEvent()) {
299         EventRetargeter::adjustForMouseEvent(dispatcher->node(), *event(),  dispatcher->eventPath());
300         return dispatcher->dispatch();
301     }
302
303     if (dispatcher->node()->isElementNode() && toElement(dispatcher->node())->disabled()) // Don't even send DOM events for disabled controls..
304         return false;
305
306     if (event()->type().isEmpty())
307         return true; // Shouldn't happen.
308
309     ASSERT(!event()->target() || event()->target() != event()->relatedTarget());
310
311     EventTarget* relatedTarget = event()->relatedTarget();
312     EventRetargeter::adjustForMouseEvent(dispatcher->node(), *event(),  dispatcher->eventPath());
313
314     dispatcher->dispatch();
315     bool swallowEvent = event()->defaultHandled() || event()->defaultPrevented();
316
317     if (event()->type() != eventNames().clickEvent || event()->detail() != 2)
318         return !swallowEvent;
319
320     // Special case: If it's a double click event, we also send the dblclick event. This is not part
321     // of the DOM specs, but is used for compatibility with the ondblclick="" attribute. This is treated
322     // as a separate event in other DOM-compliant browsers like Firefox, and so we do the same.
323     RefPtr<MouseEvent> doubleClickEvent = MouseEvent::create();
324     doubleClickEvent->initMouseEvent(eventNames().dblclickEvent, event()->bubbles(), event()->cancelable(), event()->view(),
325                                      event()->detail(), event()->screenX(), event()->screenY(), event()->clientX(), event()->clientY(),
326                                      event()->ctrlKey(), event()->altKey(), event()->shiftKey(), event()->metaKey(),
327                                      event()->button(), relatedTarget);
328     if (event()->defaultHandled())
329         doubleClickEvent->setDefaultHandled();
330     EventDispatcher::dispatchEvent(dispatcher->node(), MouseEventDispatchMediator::create(doubleClickEvent));
331     if (doubleClickEvent->defaultHandled() || doubleClickEvent->defaultPrevented())
332         return false;
333     return !swallowEvent;
334 }
335
336 } // namespace WebCore