Source/WebCore/dom/MouseEvent.cpp - WebKit - Git at Google

 /*
  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
  * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
  * Copyright (C) 2003, 2005, 2006, 2008, 2013 Apple Inc. All rights reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library General Public License
  * along with this library; see the file COPYING.LIB.  If not, write to
  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */

 #include "config.h"
 #include "MouseEvent.h"

 #include "DataTransfer.h"
 #include "EventNames.h"
 #include "Frame.h"
 #include "FrameView.h"
 #include "HTMLIFrameElement.h"
 #include "PlatformMouseEvent.h"
 #include <wtf/CurrentTime.h>

 namespace WebCore {

 Ref<MouseEvent> MouseEvent::create(const AtomicString& type, const MouseEventInit& initializer, IsTrusted isTrusted)
 {
     return adoptRef(*new MouseEvent(type, initializer, isTrusted));
 }

 Ref<MouseEvent> MouseEvent::create(const AtomicString& eventType, DOMWindow* view, const PlatformMouseEvent& event, int detail, PassRefPtr<Node> relatedTarget)
 {
     bool isMouseEnterOrLeave = eventType == eventNames().mouseenterEvent || eventType == eventNames().mouseleaveEvent;
     bool isCancelable = eventType != eventNames().mousemoveEvent && !isMouseEnterOrLeave;
     bool canBubble = !isMouseEnterOrLeave;

     return MouseEvent::create(eventType, canBubble, isCancelable, event.timestamp(), view,
         detail, event.globalPosition().x(), event.globalPosition().y(), event.position().x(), event.position().y(),
 #if ENABLE(POINTER_LOCK)
         event.movementDelta().x(), event.movementDelta().y(),
 #endif
         event.ctrlKey(), event.altKey(), event.shiftKey(), event.metaKey(), event.button(),
         relatedTarget, event.force(), event.syntheticClickType());
 }

 Ref<MouseEvent> MouseEvent::create(const AtomicString& type, bool canBubble, bool cancelable, double timestamp, DOMWindow* view, int detail, int screenX, int screenY, int pageX, int pageY,
 #if ENABLE(POINTER_LOCK)
     int movementX, int movementY,
 #endif
     bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button, PassRefPtr<EventTarget> relatedTarget, double force, unsigned short syntheticClickType)

 {
     return MouseEvent::create(type, canBubble, cancelable, timestamp, view,
         detail, screenX, screenY, pageX, pageY,
 #if ENABLE(POINTER_LOCK)
         movementX, movementY,
 #endif
         ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget, force, syntheticClickType, 0, false);
 }

 Ref<MouseEvent> MouseEvent::create(const AtomicString& type, bool canBubble, bool cancelable, double timestamp, DOMWindow* view, int detail, int screenX, int screenY, int pageX, int pageY,
 #if ENABLE(POINTER_LOCK)
     int movementX, int movementY,
 #endif
     bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button, PassRefPtr<EventTarget> relatedTarget, double force, unsigned short syntheticClickType, PassRefPtr<DataTransfer> dataTransfer, bool isSimulated)
 {
     return adoptRef(*new MouseEvent(type, canBubble, cancelable, timestamp, view,
         detail, screenX, screenY, pageX, pageY,
 #if ENABLE(POINTER_LOCK)
         movementX, movementY,
 #endif
         ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget, force, syntheticClickType, dataTransfer, isSimulated));
 }

 Ref<MouseEvent> MouseEvent::create(const AtomicString& eventType, bool canBubble, bool cancelable, DOMWindow* view, int detail, int screenX, int screenY, int clientX, int clientY, bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button, unsigned short syntheticClickType, PassRefPtr<EventTarget> relatedTarget)
 {
     return adoptRef(*new MouseEvent(eventType, canBubble, cancelable, view, detail, screenX, screenY, clientX, clientY, ctrlKey, altKey, shiftKey, metaKey, button, syntheticClickType, relatedTarget));
 }

 MouseEvent::MouseEvent()
     : m_button(0)
     , m_buttonDown(false)
 {
 }

 MouseEvent::MouseEvent(const AtomicString& eventType, bool canBubble, bool cancelable, double timestamp, DOMWindow* view,
                        int detail, int screenX, int screenY, int pageX, int pageY,
 #if ENABLE(POINTER_LOCK)
                        int movementX, int movementY,
 #endif
                        bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,
                        unsigned short button, PassRefPtr<EventTarget> relatedTarget, double force, unsigned short syntheticClickType,
                        PassRefPtr<DataTransfer> dataTransfer, bool isSimulated)
     : MouseRelatedEvent(eventType, canBubble, cancelable, timestamp, view, detail, IntPoint(screenX, screenY),
                         IntPoint(pageX, pageY),
 #if ENABLE(POINTER_LOCK)
                         IntPoint(movementX, movementY),
 #endif
                         ctrlKey, altKey, shiftKey, metaKey, isSimulated)
     , m_button(button == (unsigned short)-1 ? 0 : button)
     , m_syntheticClickType(button == (unsigned short)-1 ? 0 : syntheticClickType)
     , m_buttonDown(button != (unsigned short)-1)
     , m_relatedTarget(relatedTarget)
     , m_force(force)
     , m_dataTransfer(dataTransfer)
 {
 }

 MouseEvent::MouseEvent(const AtomicString& eventType, bool canBubble, bool cancelable, DOMWindow* view, int detail, int screenX, int screenY, int clientX, int clientY, bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button, unsigned short syntheticClickType, PassRefPtr<EventTarget> relatedTarget)
     : MouseRelatedEvent(eventType, canBubble, cancelable, WTF::currentTime(), view, detail, IntPoint(screenX, screenY), IntPoint(0, 0),
 #if ENABLE(POINTER_LOCK)
         IntPoint(0, 0),
 #endif
         ctrlKey, altKey, shiftKey, metaKey, false)
     , m_button(button == (unsigned short)-1 ? 0 : button)
     , m_syntheticClickType(button == (unsigned short)-1 ? 0 : syntheticClickType)
     , m_buttonDown(button != (unsigned short)-1)
     , m_relatedTarget(relatedTarget)
 {
     initCoordinates(IntPoint(clientX, clientY));
 }

 MouseEvent::MouseEvent(const AtomicString& eventType, const MouseEventInit& initializer, IsTrusted isTrusted)
     : MouseRelatedEvent(eventType, initializer, isTrusted)
     , m_button(initializer.button == (unsigned short)-1 ? 0 : initializer.button)
     , m_buttonDown(initializer.button != (unsigned short)-1)
     , m_relatedTarget(initializer.relatedTarget)
     , m_dataTransfer(0 /* dataTransfer */)
 {
     initCoordinates(IntPoint(initializer.clientX, initializer.clientY));
 }

 MouseEvent::~MouseEvent()
 {
 }

 void MouseEvent::initMouseEvent(const AtomicString& type, bool canBubble, bool cancelable, DOMWindow* view,
                                 int detail, int screenX, int screenY, int clientX, int clientY,
                                 bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,
                                 unsigned short button, PassRefPtr<EventTarget> relatedTarget)
 {
     if (dispatched())
         return;

     initUIEvent(type, canBubble, cancelable, view, detail);

     m_screenLocation = IntPoint(screenX, screenY);
     m_ctrlKey = ctrlKey;
     m_altKey = altKey;
     m_shiftKey = shiftKey;
     m_metaKey = metaKey;
     m_button = button == (unsigned short)-1 ? 0 : button;
     m_syntheticClickType = 0;
     m_buttonDown = button != (unsigned short)-1;
     m_relatedTarget = relatedTarget;

     initCoordinates(IntPoint(clientX, clientY));

     // FIXME: m_isSimulated is not set to false here.
     // FIXME: m_dataTransfer is not set to 0 here.
 }

 EventInterface MouseEvent::eventInterface() const
 {
     return MouseEventInterfaceType;
 }

 bool MouseEvent::isMouseEvent() const
 {
     return true;
 }

 bool MouseEvent::isDragEvent() const
 {
     const AtomicString& t = type();
     return t == eventNames().dragenterEvent || t == eventNames().dragoverEvent || t == eventNames().dragleaveEvent || t == eventNames().dropEvent
                || t == eventNames().dragstartEvent|| t == eventNames().dragEvent || t == eventNames().dragendEvent;
 }

 bool MouseEvent::canTriggerActivationBehavior(const Event& event)
 {
     return event.type() == eventNames().clickEvent && (!is<MouseEvent>(event) || downcast<MouseEvent>(event).button() != RightButton);
 }

 int MouseEvent::which() const
 {
     // For the DOM, the return values for left, middle and right mouse buttons are 0, 1, 2, respectively.
     // For the Netscape "which" property, the return values for left, middle and right mouse buttons are 1, 2, 3, respectively.
     // So we must add 1.
     if (!m_buttonDown)
         return 0;
     return m_button + 1;
 }

 Node* MouseEvent::toElement() const
 {
     // MSIE extension - "the object toward which the user is moving the mouse pointer"
     if (type() == eventNames().mouseoutEvent || type() == eventNames().mouseleaveEvent) {
         EventTarget* relatedTarget = this->relatedTarget();
         return relatedTarget ? relatedTarget->toNode() : nullptr;
     }

     return target() ? target()->toNode() : nullptr;
 }

 Node* MouseEvent::fromElement() const
 {
     // MSIE extension - "object from which activation or the mouse pointer is exiting during the event" (huh?)
     if (type() != eventNames().mouseoutEvent && type() != eventNames().mouseleaveEvent) {
         EventTarget* relatedTarget = this->relatedTarget();
         return relatedTarget ? relatedTarget->toNode() : nullptr;
     }

     return target() ? target()->toNode() : nullptr;
 }

 // FIXME: Fix positioning. e.g. We need to consider border/padding.
 // https://bugs.webkit.org/show_bug.cgi?id=93696
 inline static int adjustedClientX(int innerClientX, HTMLIFrameElement* iframe, FrameView* frameView)
 {
     return iframe->offsetLeft() - frameView->scrollX() + innerClientX;
 }

 inline static int adjustedClientY(int innerClientY, HTMLIFrameElement* iframe, FrameView* frameView)
 {
     return iframe->offsetTop() - frameView->scrollY() + innerClientY;
 }

 Ref<Event> MouseEvent::cloneFor(HTMLIFrameElement* iframe) const
 {
     ASSERT(iframe);
     Frame* frame = iframe->document().frame();
     FrameView* frameView = frame ? frame->view() : nullptr;
     Ref<MouseEvent> clonedMouseEvent = MouseEvent::create(type(), bubbles(), cancelable(),
         iframe->document().defaultView(),
         detail(), screenX(), screenY(),
         frameView ? adjustedClientX(clientX(), iframe, frameView) : 0,
         frameView ? adjustedClientY(clientY(), iframe, frameView) : 0,
         ctrlKey(), altKey(), shiftKey(), metaKey(),
         button(),
         syntheticClickType(),
         // Nullifies relatedTarget.
         0);
     clonedMouseEvent->setForce(force());
     return WTFMove(clonedMouseEvent);
 }

 } // namespace WebCore
	/*
	* Copyright (C) 2001 Peter Kelly (pmk@post.com)
	* Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
	* Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
	* Copyright (C) 2003, 2005, 2006, 2008, 2013 Apple Inc. All rights reserved.
	*
	* This library is free software; you can redistribute it and/or
	* modify it under the terms of the GNU Library General Public
	* License as published by the Free Software Foundation; either
	* version 2 of the License, or (at your option) any later version.
	*
	* This library is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	* Library General Public License for more details.
	*
	* You should have received a copy of the GNU Library General Public License
	* along with this library; see the file COPYING.LIB. If not, write to
	* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
	* Boston, MA 02110-1301, USA.
	*/

	#include "config.h"
	#include "MouseEvent.h"

	#include "DataTransfer.h"
	#include "EventNames.h"
	#include "Frame.h"
	#include "FrameView.h"
	#include "HTMLIFrameElement.h"
	#include "PlatformMouseEvent.h"
	#include <wtf/CurrentTime.h>

	namespace WebCore {

	Ref<MouseEvent> MouseEvent::create(const AtomicString& type, const MouseEventInit& initializer, IsTrusted isTrusted)
	{
	return adoptRef(*new MouseEvent(type, initializer, isTrusted));
	}

	Ref<MouseEvent> MouseEvent::create(const AtomicString& eventType, DOMWindow* view, const PlatformMouseEvent& event, int detail, PassRefPtr<Node> relatedTarget)
	{
	bool isMouseEnterOrLeave = eventType == eventNames().mouseenterEvent \|\| eventType == eventNames().mouseleaveEvent;
	bool isCancelable = eventType != eventNames().mousemoveEvent && !isMouseEnterOrLeave;
	bool canBubble = !isMouseEnterOrLeave;

	return MouseEvent::create(eventType, canBubble, isCancelable, event.timestamp(), view,
	detail, event.globalPosition().x(), event.globalPosition().y(), event.position().x(), event.position().y(),
	#if ENABLE(POINTER_LOCK)
	event.movementDelta().x(), event.movementDelta().y(),
	#endif
	event.ctrlKey(), event.altKey(), event.shiftKey(), event.metaKey(), event.button(),
	relatedTarget, event.force(), event.syntheticClickType());
	}

	Ref<MouseEvent> MouseEvent::create(const AtomicString& type, bool canBubble, bool cancelable, double timestamp, DOMWindow* view, int detail, int screenX, int screenY, int pageX, int pageY,
	#if ENABLE(POINTER_LOCK)
	int movementX, int movementY,
	#endif
	bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button, PassRefPtr<EventTarget> relatedTarget, double force, unsigned short syntheticClickType)

	{
	return MouseEvent::create(type, canBubble, cancelable, timestamp, view,
	detail, screenX, screenY, pageX, pageY,
	#if ENABLE(POINTER_LOCK)
	movementX, movementY,
	#endif
	ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget, force, syntheticClickType, 0, false);
	}

	Ref<MouseEvent> MouseEvent::create(const AtomicString& type, bool canBubble, bool cancelable, double timestamp, DOMWindow* view, int detail, int screenX, int screenY, int pageX, int pageY,
	#if ENABLE(POINTER_LOCK)
	int movementX, int movementY,
	#endif
	bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button, PassRefPtr<EventTarget> relatedTarget, double force, unsigned short syntheticClickType, PassRefPtr<DataTransfer> dataTransfer, bool isSimulated)
	{
	return adoptRef(*new MouseEvent(type, canBubble, cancelable, timestamp, view,
	detail, screenX, screenY, pageX, pageY,
	#if ENABLE(POINTER_LOCK)
	movementX, movementY,
	#endif
	ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget, force, syntheticClickType, dataTransfer, isSimulated));
	}

	Ref<MouseEvent> MouseEvent::create(const AtomicString& eventType, bool canBubble, bool cancelable, DOMWindow* view, int detail, int screenX, int screenY, int clientX, int clientY, bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button, unsigned short syntheticClickType, PassRefPtr<EventTarget> relatedTarget)
	{
	return adoptRef(*new MouseEvent(eventType, canBubble, cancelable, view, detail, screenX, screenY, clientX, clientY, ctrlKey, altKey, shiftKey, metaKey, button, syntheticClickType, relatedTarget));
	}

	MouseEvent::MouseEvent()
	: m_button(0)
	, m_buttonDown(false)
	{
	}

	MouseEvent::MouseEvent(const AtomicString& eventType, bool canBubble, bool cancelable, double timestamp, DOMWindow* view,
	int detail, int screenX, int screenY, int pageX, int pageY,
	#if ENABLE(POINTER_LOCK)
	int movementX, int movementY,
	#endif
	bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,
	unsigned short button, PassRefPtr<EventTarget> relatedTarget, double force, unsigned short syntheticClickType,
	PassRefPtr<DataTransfer> dataTransfer, bool isSimulated)
	: MouseRelatedEvent(eventType, canBubble, cancelable, timestamp, view, detail, IntPoint(screenX, screenY),
	IntPoint(pageX, pageY),
	#if ENABLE(POINTER_LOCK)
	IntPoint(movementX, movementY),
	#endif
	ctrlKey, altKey, shiftKey, metaKey, isSimulated)
	, m_button(button == (unsigned short)-1 ? 0 : button)
	, m_syntheticClickType(button == (unsigned short)-1 ? 0 : syntheticClickType)
	, m_buttonDown(button != (unsigned short)-1)
	, m_relatedTarget(relatedTarget)
	, m_force(force)
	, m_dataTransfer(dataTransfer)
	{
	}

	MouseEvent::MouseEvent(const AtomicString& eventType, bool canBubble, bool cancelable, DOMWindow* view, int detail, int screenX, int screenY, int clientX, int clientY, bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button, unsigned short syntheticClickType, PassRefPtr<EventTarget> relatedTarget)
	: MouseRelatedEvent(eventType, canBubble, cancelable, WTF::currentTime(), view, detail, IntPoint(screenX, screenY), IntPoint(0, 0),
	#if ENABLE(POINTER_LOCK)
	IntPoint(0, 0),
	#endif
	ctrlKey, altKey, shiftKey, metaKey, false)
	, m_button(button == (unsigned short)-1 ? 0 : button)
	, m_syntheticClickType(button == (unsigned short)-1 ? 0 : syntheticClickType)
	, m_buttonDown(button != (unsigned short)-1)
	, m_relatedTarget(relatedTarget)
	{
	initCoordinates(IntPoint(clientX, clientY));
	}

	MouseEvent::MouseEvent(const AtomicString& eventType, const MouseEventInit& initializer, IsTrusted isTrusted)
	: MouseRelatedEvent(eventType, initializer, isTrusted)
	, m_button(initializer.button == (unsigned short)-1 ? 0 : initializer.button)
	, m_buttonDown(initializer.button != (unsigned short)-1)
	, m_relatedTarget(initializer.relatedTarget)
	, m_dataTransfer(0 /* dataTransfer */)
	{
	initCoordinates(IntPoint(initializer.clientX, initializer.clientY));
	}

	MouseEvent::~MouseEvent()
	{
	}

	void MouseEvent::initMouseEvent(const AtomicString& type, bool canBubble, bool cancelable, DOMWindow* view,
	int detail, int screenX, int screenY, int clientX, int clientY,
	bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,
	unsigned short button, PassRefPtr<EventTarget> relatedTarget)
	{
	if (dispatched())
	return;

	initUIEvent(type, canBubble, cancelable, view, detail);

	m_screenLocation = IntPoint(screenX, screenY);
	m_ctrlKey = ctrlKey;
	m_altKey = altKey;
	m_shiftKey = shiftKey;
	m_metaKey = metaKey;
	m_button = button == (unsigned short)-1 ? 0 : button;
	m_syntheticClickType = 0;
	m_buttonDown = button != (unsigned short)-1;
	m_relatedTarget = relatedTarget;

	initCoordinates(IntPoint(clientX, clientY));

	// FIXME: m_isSimulated is not set to false here.
	// FIXME: m_dataTransfer is not set to 0 here.
	}

	EventInterface MouseEvent::eventInterface() const
	{
	return MouseEventInterfaceType;
	}

	bool MouseEvent::isMouseEvent() const
	{
	return true;
	}

	bool MouseEvent::isDragEvent() const
	{
	const AtomicString& t = type();
	return t == eventNames().dragenterEvent \|\| t == eventNames().dragoverEvent \|\| t == eventNames().dragleaveEvent \|\| t == eventNames().dropEvent
	\|\| t == eventNames().dragstartEvent\|\| t == eventNames().dragEvent \|\| t == eventNames().dragendEvent;
	}

	bool MouseEvent::canTriggerActivationBehavior(const Event& event)
	{
	return event.type() == eventNames().clickEvent && (!is<MouseEvent>(event) \|\| downcast<MouseEvent>(event).button() != RightButton);
	}

	int MouseEvent::which() const
	{
	// For the DOM, the return values for left, middle and right mouse buttons are 0, 1, 2, respectively.
	// For the Netscape "which" property, the return values for left, middle and right mouse buttons are 1, 2, 3, respectively.
	// So we must add 1.
	if (!m_buttonDown)
	return 0;
	return m_button + 1;
	}

	Node* MouseEvent::toElement() const
	{
	// MSIE extension - "the object toward which the user is moving the mouse pointer"
	if (type() == eventNames().mouseoutEvent \|\| type() == eventNames().mouseleaveEvent) {
	EventTarget* relatedTarget = this->relatedTarget();
	return relatedTarget ? relatedTarget->toNode() : nullptr;
	}

	return target() ? target()->toNode() : nullptr;
	}

	Node* MouseEvent::fromElement() const
	{
	// MSIE extension - "object from which activation or the mouse pointer is exiting during the event" (huh?)
	if (type() != eventNames().mouseoutEvent && type() != eventNames().mouseleaveEvent) {
	EventTarget* relatedTarget = this->relatedTarget();
	return relatedTarget ? relatedTarget->toNode() : nullptr;
	}

	return target() ? target()->toNode() : nullptr;
	}

	// FIXME: Fix positioning. e.g. We need to consider border/padding.
	// https://bugs.webkit.org/show_bug.cgi?id=93696
	inline static int adjustedClientX(int innerClientX, HTMLIFrameElement* iframe, FrameView* frameView)
	{
	return iframe->offsetLeft() - frameView->scrollX() + innerClientX;
	}

	inline static int adjustedClientY(int innerClientY, HTMLIFrameElement* iframe, FrameView* frameView)
	{
	return iframe->offsetTop() - frameView->scrollY() + innerClientY;
	}

	Ref<Event> MouseEvent::cloneFor(HTMLIFrameElement* iframe) const
	{
	ASSERT(iframe);
	Frame* frame = iframe->document().frame();
	FrameView* frameView = frame ? frame->view() : nullptr;
	Ref<MouseEvent> clonedMouseEvent = MouseEvent::create(type(), bubbles(), cancelable(),
	iframe->document().defaultView(),
	detail(), screenX(), screenY(),
	frameView ? adjustedClientX(clientX(), iframe, frameView) : 0,
	frameView ? adjustedClientY(clientY(), iframe, frameView) : 0,
	ctrlKey(), altKey(), shiftKey(), metaKey(),
	button(),
	syntheticClickType(),
	// Nullifies relatedTarget.
	0);
	clonedMouseEvent->setForce(force());
	return WTFMove(clonedMouseEvent);
	}

	} // namespace WebCore