Source/WebKit/Shared/gtk/WebEventFactory.cpp - WebKit - Git at Google

 /*
  * Copyright (C) 2010 Apple Inc. All rights reserved.
  * Portions Copyright (c) 2010 Motorola Mobility, Inc.  All rights reserved.
  * Copyright (C) 2011 Igalia S.L.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  * THE POSSIBILITY OF SUCH DAMAGE.
  */

 #include "config.h"
 #include "WebEventFactory.h"

 #include <WebCore/GtkUtilities.h>
 #include <WebCore/GtkVersioning.h>
 #include <WebCore/PlatformKeyboardEvent.h>
 #include <WebCore/Scrollbar.h>
 #include <WebCore/WindowsKeyboardCodes.h>
 #include <gdk/gdk.h>
 #include <gdk/gdkkeysyms.h>
 #include <gtk/gtk.h>
 #include <wtf/ASCIICType.h>

 namespace WebKit {

 using namespace WebCore;

 static inline bool isGdkKeyCodeFromKeyPad(unsigned keyval)
 {
     return keyval >= GDK_KP_Space && keyval <= GDK_KP_9;
 }

 static inline OptionSet<WebEvent::Modifier> modifiersForEvent(const GdkEvent* event)
 {
     OptionSet<WebEvent::Modifier> modifiers;
     GdkModifierType state;

     // Check for a valid state in GdkEvent.
     if (!gdk_event_get_state(event, &state))
         return modifiers;

     if (state & GDK_CONTROL_MASK)
         modifiers.add(WebEvent::Modifier::ControlKey);
     if (state & GDK_SHIFT_MASK)
         modifiers.add(WebEvent::Modifier::ShiftKey);
     if (state & GDK_MOD1_MASK)
         modifiers.add(WebEvent::Modifier::AltKey);
     if (state & GDK_META_MASK)
         modifiers.add(WebEvent::Modifier::MetaKey);
     if (PlatformKeyboardEvent::modifiersContainCapsLock(state))
         modifiers.add(WebEvent::Modifier::CapsLockKey);

     return modifiers;
 }

 static inline WebMouseEvent::Button buttonForEvent(const GdkEvent* event)
 {
     unsigned button = 0;

     switch (event->type) {
     case GDK_ENTER_NOTIFY:
     case GDK_LEAVE_NOTIFY:
     case GDK_MOTION_NOTIFY: {
         button = WebMouseEvent::NoButton;
         GdkModifierType state;
         gdk_event_get_state(event, &state);
         if (state & GDK_BUTTON1_MASK)
             button = WebMouseEvent::LeftButton;
         else if (state & GDK_BUTTON2_MASK)
             button = WebMouseEvent::MiddleButton;
         else if (state & GDK_BUTTON3_MASK)
             button = WebMouseEvent::RightButton;
         break;
     }
     case GDK_BUTTON_PRESS:
     case GDK_2BUTTON_PRESS:
     case GDK_3BUTTON_PRESS:
     case GDK_BUTTON_RELEASE:
         if (event->button.button == 1)
             button = WebMouseEvent::LeftButton;
         else if (event->button.button == 2)
             button = WebMouseEvent::MiddleButton;
         else if (event->button.button == 3)
             button = WebMouseEvent::RightButton;
         break;
     default:
         ASSERT_NOT_REACHED();
     }

     return static_cast<WebMouseEvent::Button>(button);
 }

 static inline short pressedMouseButtons(GdkModifierType state)
 {
     // MouseEvent.buttons
     // https://www.w3.org/TR/uievents/#ref-for-dom-mouseevent-buttons-1

     // 0 MUST indicate no button is currently active.
     short buttons = 0;

     // 1 MUST indicate the primary button of the device (in general, the left button or the only button on
     // single-button devices, used to activate a user interface control or select text).
     if (state & GDK_BUTTON1_MASK)
         buttons |= 1;

     // 4 MUST indicate the auxiliary button (in general, the middle button, often combined with a mouse wheel).
     if (state & GDK_BUTTON2_MASK)
         buttons |= 4;

     // 2 MUST indicate the secondary button (in general, the right button, often used to display a context menu),
     // if present.
     if (state & GDK_BUTTON3_MASK)
         buttons |= 2;

     return buttons;
 }

 WebMouseEvent WebEventFactory::createWebMouseEvent(const GdkEvent* event, int currentClickCount)
 {
     double x, y, xRoot, yRoot;
     gdk_event_get_coords(event, &x, &y);
     gdk_event_get_root_coords(event, &xRoot, &yRoot);

     GdkModifierType state = static_cast<GdkModifierType>(0);
     gdk_event_get_state(event, &state);

     WebEvent::Type type = static_cast<WebEvent::Type>(0);
     switch (event->type) {
     case GDK_MOTION_NOTIFY:
     case GDK_ENTER_NOTIFY:
     case GDK_LEAVE_NOTIFY:
         type = WebEvent::MouseMove;
         break;
     case GDK_BUTTON_PRESS:
     case GDK_2BUTTON_PRESS:
     case GDK_3BUTTON_PRESS: {
         type = WebEvent::MouseDown;
         auto modifier = stateModifierForGdkButton(event->button.button);
         state = static_cast<GdkModifierType>(state | modifier);
         break;
     }
     case GDK_BUTTON_RELEASE: {
         type = WebEvent::MouseUp;
         auto modifier = stateModifierForGdkButton(event->button.button);
         state = static_cast<GdkModifierType>(state & ~modifier);
         break;
     }
     default :
         ASSERT_NOT_REACHED();
     }

     return WebMouseEvent(type,
         buttonForEvent(event),
         pressedMouseButtons(state),
         IntPoint(x, y),
         IntPoint(xRoot, yRoot),
         0 /* deltaX */,
         0 /* deltaY */,
         0 /* deltaZ */,
         currentClickCount,
         modifiersForEvent(event),
         wallTimeForEvent(event));
 }

 WebWheelEvent WebEventFactory::createWebWheelEvent(const GdkEvent* event)
 {
 #ifndef GTK_API_VERSION_2
 #if GTK_CHECK_VERSION(3, 20, 0)
     WebWheelEvent::Phase phase = gdk_event_is_scroll_stop_event(event) ?
         WebWheelEvent::Phase::PhaseEnded :
         WebWheelEvent::Phase::PhaseChanged;
 #else
     double deltaX, deltaY;
     gdk_event_get_scroll_deltas(event, &deltaX, &deltaY);
     WebWheelEvent::Phase phase = event->scroll.direction == GDK_SCROLL_SMOOTH && !deltaX && !deltaY ?
         WebWheelEvent::Phase::PhaseEnded :
         WebWheelEvent::Phase::PhaseChanged;
 #endif
 #else
     WebWheelEvent::Phase phase = WebWheelEvent::Phase::PhaseChanged;
 #endif // GTK_API_VERSION_2

     return createWebWheelEvent(event, phase, WebWheelEvent::Phase::PhaseNone);
 }

 WebWheelEvent WebEventFactory::createWebWheelEvent(const GdkEvent* event, WebWheelEvent::Phase phase, WebWheelEvent::Phase momentumPhase)
 {
     double x, y, xRoot, yRoot;
     gdk_event_get_coords(event, &x, &y);
     gdk_event_get_root_coords(event, &xRoot, &yRoot);

     FloatSize wheelTicks;
     switch (event->scroll.direction) {
     case GDK_SCROLL_UP:
         wheelTicks = FloatSize(0, 1);
         break;
     case GDK_SCROLL_DOWN:
         wheelTicks = FloatSize(0, -1);
         break;
     case GDK_SCROLL_LEFT:
         wheelTicks = FloatSize(1, 0);
         break;
     case GDK_SCROLL_RIGHT:
         wheelTicks = FloatSize(-1, 0);
         break;
 #if GTK_CHECK_VERSION(3, 3, 18)
     case GDK_SCROLL_SMOOTH: {
             double deltaX, deltaY;
             gdk_event_get_scroll_deltas(event, &deltaX, &deltaY);
             wheelTicks = FloatSize(-deltaX, -deltaY);
         }
         break;
 #endif
     default:
         ASSERT_NOT_REACHED();
     }

     // FIXME: [GTK] Add a setting to change the pixels per line used for scrolling
     // https://bugs.webkit.org/show_bug.cgi?id=54826
     float step = static_cast<float>(Scrollbar::pixelsPerLineStep());
     FloatSize delta(wheelTicks.width() * step, wheelTicks.height() * step);

     return WebWheelEvent(WebEvent::Wheel,
         IntPoint(x, y),
         IntPoint(xRoot, yRoot),
         delta,
         wheelTicks,
         phase,
         momentumPhase,
         WebWheelEvent::ScrollByPixelWheelEvent,
         modifiersForEvent(event),
         wallTimeForEvent(event));
 }

 WebKeyboardEvent WebEventFactory::createWebKeyboardEvent(const GdkEvent* event, const WebCore::CompositionResults& compositionResults, Vector<String>&& commands)
 {
     return WebKeyboardEvent(
         event->type == GDK_KEY_RELEASE ? WebEvent::KeyUp : WebEvent::KeyDown,
         compositionResults.simpleString.length() ? compositionResults.simpleString : PlatformKeyboardEvent::singleCharacterString(event->key.keyval),
         PlatformKeyboardEvent::keyValueForGdkKeyCode(event->key.keyval),
         PlatformKeyboardEvent::keyCodeForHardwareKeyCode(event->key.hardware_keycode),
         PlatformKeyboardEvent::keyIdentifierForGdkKeyCode(event->key.keyval),
         PlatformKeyboardEvent::windowsKeyCodeForGdkKeyCode(event->key.keyval),
         static_cast<int>(event->key.keyval),
         compositionResults.compositionUpdated(),
         WTFMove(commands),
         isGdkKeyCodeFromKeyPad(event->key.keyval),
         modifiersForEvent(event),
         wallTimeForEvent(event));
 }

 #if ENABLE(TOUCH_EVENTS)
 WebTouchEvent WebEventFactory::createWebTouchEvent(const GdkEvent* event, Vector<WebPlatformTouchPoint>&& touchPoints)
 {
 #ifndef GTK_API_VERSION_2
     WebEvent::Type type = WebEvent::NoType;
     switch (event->type) {
     case GDK_TOUCH_BEGIN:
         type = WebEvent::TouchStart;
         break;
     case GDK_TOUCH_UPDATE:
         type = WebEvent::TouchMove;
         break;
     case GDK_TOUCH_END:
         type = WebEvent::TouchEnd;
         break;
     case GDK_TOUCH_CANCEL:
         type = WebEvent::TouchCancel;
         break;
     default:
         ASSERT_NOT_REACHED();
     }

     return WebTouchEvent(type, WTFMove(touchPoints), modifiersForEvent(event), wallTimeForEvent(event));
 #else
     return WebTouchEvent();
 #endif // GTK_API_VERSION_2
 }
 #endif

 } // namespace WebKit
	/*
	* Copyright (C) 2010 Apple Inc. All rights reserved.
	* Portions Copyright (c) 2010 Motorola Mobility, Inc. All rights reserved.
	* Copyright (C) 2011 Igalia S.L.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in the
	* documentation and/or other materials provided with the distribution.
	*
	* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
	* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
	* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
	* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
	* THE POSSIBILITY OF SUCH DAMAGE.
	*/

	#include "config.h"
	#include "WebEventFactory.h"

	#include <WebCore/GtkUtilities.h>
	#include <WebCore/GtkVersioning.h>
	#include <WebCore/PlatformKeyboardEvent.h>
	#include <WebCore/Scrollbar.h>
	#include <WebCore/WindowsKeyboardCodes.h>
	#include <gdk/gdk.h>
	#include <gdk/gdkkeysyms.h>
	#include <gtk/gtk.h>
	#include <wtf/ASCIICType.h>

	namespace WebKit {

	using namespace WebCore;

	static inline bool isGdkKeyCodeFromKeyPad(unsigned keyval)
	{
	return keyval >= GDK_KP_Space && keyval <= GDK_KP_9;
	}

	static inline OptionSet<WebEvent::Modifier> modifiersForEvent(const GdkEvent* event)
	{
	OptionSet<WebEvent::Modifier> modifiers;
	GdkModifierType state;

	// Check for a valid state in GdkEvent.
	if (!gdk_event_get_state(event, &state))
	return modifiers;

	if (state & GDK_CONTROL_MASK)
	modifiers.add(WebEvent::Modifier::ControlKey);
	if (state & GDK_SHIFT_MASK)
	modifiers.add(WebEvent::Modifier::ShiftKey);
	if (state & GDK_MOD1_MASK)
	modifiers.add(WebEvent::Modifier::AltKey);
	if (state & GDK_META_MASK)
	modifiers.add(WebEvent::Modifier::MetaKey);
	if (PlatformKeyboardEvent::modifiersContainCapsLock(state))
	modifiers.add(WebEvent::Modifier::CapsLockKey);

	return modifiers;
	}

	static inline WebMouseEvent::Button buttonForEvent(const GdkEvent* event)
	{
	unsigned button = 0;

	switch (event->type) {
	case GDK_ENTER_NOTIFY:
	case GDK_LEAVE_NOTIFY:
	case GDK_MOTION_NOTIFY: {
	button = WebMouseEvent::NoButton;
	GdkModifierType state;
	gdk_event_get_state(event, &state);
	if (state & GDK_BUTTON1_MASK)
	button = WebMouseEvent::LeftButton;
	else if (state & GDK_BUTTON2_MASK)
	button = WebMouseEvent::MiddleButton;
	else if (state & GDK_BUTTON3_MASK)
	button = WebMouseEvent::RightButton;
	break;
	}
	case GDK_BUTTON_PRESS:
	case GDK_2BUTTON_PRESS:
	case GDK_3BUTTON_PRESS:
	case GDK_BUTTON_RELEASE:
	if (event->button.button == 1)
	button = WebMouseEvent::LeftButton;
	else if (event->button.button == 2)
	button = WebMouseEvent::MiddleButton;
	else if (event->button.button == 3)
	button = WebMouseEvent::RightButton;
	break;
	default:
	ASSERT_NOT_REACHED();
	}

	return static_cast<WebMouseEvent::Button>(button);
	}

	static inline short pressedMouseButtons(GdkModifierType state)
	{
	// MouseEvent.buttons
	// https://www.w3.org/TR/uievents/#ref-for-dom-mouseevent-buttons-1

	// 0 MUST indicate no button is currently active.
	short buttons = 0;

	// 1 MUST indicate the primary button of the device (in general, the left button or the only button on
	// single-button devices, used to activate a user interface control or select text).
	if (state & GDK_BUTTON1_MASK)
	buttons \|= 1;

	// 4 MUST indicate the auxiliary button (in general, the middle button, often combined with a mouse wheel).
	if (state & GDK_BUTTON2_MASK)
	buttons \|= 4;

	// 2 MUST indicate the secondary button (in general, the right button, often used to display a context menu),
	// if present.
	if (state & GDK_BUTTON3_MASK)
	buttons \|= 2;

	return buttons;
	}

	WebMouseEvent WebEventFactory::createWebMouseEvent(const GdkEvent* event, int currentClickCount)
	{
	double x, y, xRoot, yRoot;
	gdk_event_get_coords(event, &x, &y);
	gdk_event_get_root_coords(event, &xRoot, &yRoot);

	GdkModifierType state = static_cast<GdkModifierType>(0);
	gdk_event_get_state(event, &state);

	WebEvent::Type type = static_cast<WebEvent::Type>(0);
	switch (event->type) {
	case GDK_MOTION_NOTIFY:
	case GDK_ENTER_NOTIFY:
	case GDK_LEAVE_NOTIFY:
	type = WebEvent::MouseMove;
	break;
	case GDK_BUTTON_PRESS:
	case GDK_2BUTTON_PRESS:
	case GDK_3BUTTON_PRESS: {
	type = WebEvent::MouseDown;
	auto modifier = stateModifierForGdkButton(event->button.button);
	state = static_cast<GdkModifierType>(state \| modifier);
	break;
	}
	case GDK_BUTTON_RELEASE: {
	type = WebEvent::MouseUp;
	auto modifier = stateModifierForGdkButton(event->button.button);
	state = static_cast<GdkModifierType>(state & ~modifier);
	break;
	}
	default :
	ASSERT_NOT_REACHED();
	}

	return WebMouseEvent(type,
	buttonForEvent(event),
	pressedMouseButtons(state),
	IntPoint(x, y),
	IntPoint(xRoot, yRoot),
	0 /* deltaX */,
	0 /* deltaY */,
	0 /* deltaZ */,
	currentClickCount,
	modifiersForEvent(event),
	wallTimeForEvent(event));
	}

	WebWheelEvent WebEventFactory::createWebWheelEvent(const GdkEvent* event)
	{
	#ifndef GTK_API_VERSION_2
	#if GTK_CHECK_VERSION(3, 20, 0)
	WebWheelEvent::Phase phase = gdk_event_is_scroll_stop_event(event) ?
	WebWheelEvent::Phase::PhaseEnded :
	WebWheelEvent::Phase::PhaseChanged;
	#else
	double deltaX, deltaY;
	gdk_event_get_scroll_deltas(event, &deltaX, &deltaY);
	WebWheelEvent::Phase phase = event->scroll.direction == GDK_SCROLL_SMOOTH && !deltaX && !deltaY ?
	WebWheelEvent::Phase::PhaseEnded :
	WebWheelEvent::Phase::PhaseChanged;
	#endif
	#else
	WebWheelEvent::Phase phase = WebWheelEvent::Phase::PhaseChanged;
	#endif // GTK_API_VERSION_2

	return createWebWheelEvent(event, phase, WebWheelEvent::Phase::PhaseNone);
	}

	WebWheelEvent WebEventFactory::createWebWheelEvent(const GdkEvent* event, WebWheelEvent::Phase phase, WebWheelEvent::Phase momentumPhase)
	{
	double x, y, xRoot, yRoot;
	gdk_event_get_coords(event, &x, &y);
	gdk_event_get_root_coords(event, &xRoot, &yRoot);

	FloatSize wheelTicks;
	switch (event->scroll.direction) {
	case GDK_SCROLL_UP:
	wheelTicks = FloatSize(0, 1);
	break;
	case GDK_SCROLL_DOWN:
	wheelTicks = FloatSize(0, -1);
	break;
	case GDK_SCROLL_LEFT:
	wheelTicks = FloatSize(1, 0);
	break;
	case GDK_SCROLL_RIGHT:
	wheelTicks = FloatSize(-1, 0);
	break;
	#if GTK_CHECK_VERSION(3, 3, 18)
	case GDK_SCROLL_SMOOTH: {
	double deltaX, deltaY;
	gdk_event_get_scroll_deltas(event, &deltaX, &deltaY);
	wheelTicks = FloatSize(-deltaX, -deltaY);
	}
	break;
	#endif
	default:
	ASSERT_NOT_REACHED();
	}

	// FIXME: [GTK] Add a setting to change the pixels per line used for scrolling
	// https://bugs.webkit.org/show_bug.cgi?id=54826
	float step = static_cast<float>(Scrollbar::pixelsPerLineStep());
	FloatSize delta(wheelTicks.width() * step, wheelTicks.height() * step);

	return WebWheelEvent(WebEvent::Wheel,
	IntPoint(x, y),
	IntPoint(xRoot, yRoot),
	delta,
	wheelTicks,
	phase,
	momentumPhase,
	WebWheelEvent::ScrollByPixelWheelEvent,
	modifiersForEvent(event),
	wallTimeForEvent(event));
	}

	WebKeyboardEvent WebEventFactory::createWebKeyboardEvent(const GdkEvent* event, const WebCore::CompositionResults& compositionResults, Vector<String>&& commands)
	{
	return WebKeyboardEvent(
	event->type == GDK_KEY_RELEASE ? WebEvent::KeyUp : WebEvent::KeyDown,
	compositionResults.simpleString.length() ? compositionResults.simpleString : PlatformKeyboardEvent::singleCharacterString(event->key.keyval),
	PlatformKeyboardEvent::keyValueForGdkKeyCode(event->key.keyval),
	PlatformKeyboardEvent::keyCodeForHardwareKeyCode(event->key.hardware_keycode),
	PlatformKeyboardEvent::keyIdentifierForGdkKeyCode(event->key.keyval),
	PlatformKeyboardEvent::windowsKeyCodeForGdkKeyCode(event->key.keyval),
	static_cast<int>(event->key.keyval),
	compositionResults.compositionUpdated(),
	WTFMove(commands),
	isGdkKeyCodeFromKeyPad(event->key.keyval),
	modifiersForEvent(event),
	wallTimeForEvent(event));
	}

	#if ENABLE(TOUCH_EVENTS)
	WebTouchEvent WebEventFactory::createWebTouchEvent(const GdkEvent* event, Vector<WebPlatformTouchPoint>&& touchPoints)
	{
	#ifndef GTK_API_VERSION_2
	WebEvent::Type type = WebEvent::NoType;
	switch (event->type) {
	case GDK_TOUCH_BEGIN:
	type = WebEvent::TouchStart;
	break;
	case GDK_TOUCH_UPDATE:
	type = WebEvent::TouchMove;
	break;
	case GDK_TOUCH_END:
	type = WebEvent::TouchEnd;
	break;
	case GDK_TOUCH_CANCEL:
	type = WebEvent::TouchCancel;
	break;
	default:
	ASSERT_NOT_REACHED();
	}

	return WebTouchEvent(type, WTFMove(touchPoints), modifiersForEvent(event), wallTimeForEvent(event));
	#else
	return WebTouchEvent();
	#endif // GTK_API_VERSION_2
	}
	#endif

	} // namespace WebKit