blob: a3392ef2ecaef1cc47cf909b5390c800fe219e19 [file] [log] [blame]
/*
* Copyright (C) 2014 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/PlatformKeyboardEvent.h>
#include <WebCore/Scrollbar.h>
#include <cmath>
#include <wpe/wpe.h>
namespace WebKit {
static inline bool isWPEKeyCodeFromKeyPad(unsigned keyCode)
{
return keyCode >= WPE_KEY_KP_Space && keyCode <= WPE_KEY_KP_9;
}
static OptionSet<WebEvent::Modifier> modifiersForEventModifiers(unsigned eventModifiers)
{
OptionSet<WebEvent::Modifier> modifiers;
if (eventModifiers & wpe_input_keyboard_modifier_control)
modifiers.add(WebEvent::Modifier::ControlKey);
if (eventModifiers & wpe_input_keyboard_modifier_shift)
modifiers.add(WebEvent::Modifier::ShiftKey);
if (eventModifiers & wpe_input_keyboard_modifier_alt)
modifiers.add(WebEvent::Modifier::AltKey);
if (eventModifiers & wpe_input_keyboard_modifier_meta)
modifiers.add(WebEvent::Modifier::MetaKey);
return modifiers;
}
static OptionSet<WebEvent::Modifier> modifiersForKeyboardEvent(struct wpe_input_keyboard_event* event)
{
OptionSet<WebEvent::Modifier> modifiers = modifiersForEventModifiers(event->modifiers);
if (!event->pressed)
return modifiers;
// Handling of modifier masks in WPE is modelled after X. This code makes WPE to behave similar
// to other platforms and other browsers under X (see http://crbug.com/127142#c8).
switch (event->key_code) {
case WPE_KEY_Control_L:
case WPE_KEY_Control_R:
modifiers.add(WebEvent::Modifier::ControlKey);
break;
case WPE_KEY_Shift_L:
case WPE_KEY_Shift_R:
modifiers.add(WebEvent::Modifier::ShiftKey);
break;
case WPE_KEY_Alt_L:
case WPE_KEY_Alt_R:
modifiers.add(WebEvent::Modifier::AltKey);
break;
case WPE_KEY_Meta_L:
case WPE_KEY_Meta_R:
modifiers.add(WebEvent::Modifier::MetaKey);
break;
case WPE_KEY_Caps_Lock:
modifiers.add(WebEvent::Modifier::CapsLockKey);
break;
}
return modifiers;
}
WallTime wallTimeForEventTime(uint64_t msTimeStamp)
{
// WPE event time field is an uint32_t, too small for full ms timestamps since
// the epoch, and are expected to be just timestamps with monotonic behavior
// to be compared among themselves, not against WallTime-like measurements.
// Thus the need to define a reference origin based on the first event received.
static uint64_t firstEventTimeStamp;
static WallTime firstEventWallTime;
static std::once_flag once;
// Fallback for zero timestamps.
if (!msTimeStamp)
return WallTime::now();
std::call_once(once, [msTimeStamp]() {
firstEventTimeStamp = msTimeStamp;
firstEventWallTime = WallTime::now();
});
uint64_t delta = msTimeStamp - firstEventTimeStamp;
return firstEventWallTime + Seconds(delta / 1000.);
}
WebKeyboardEvent WebEventFactory::createWebKeyboardEvent(struct wpe_input_keyboard_event* event, const String& text, bool handledByInputMethod, std::optional<Vector<WebCore::CompositionUnderline>>&& preeditUnderlines, std::optional<EditingRange>&& preeditSelectionRange)
{
return WebKeyboardEvent(event->pressed ? WebEvent::KeyDown : WebEvent::KeyUp,
text.isNull() ? WebCore::PlatformKeyboardEvent::singleCharacterString(event->key_code) : text,
WebCore::PlatformKeyboardEvent::keyValueForWPEKeyCode(event->key_code),
WebCore::PlatformKeyboardEvent::keyCodeForHardwareKeyCode(event->hardware_key_code),
WebCore::PlatformKeyboardEvent::keyIdentifierForWPEKeyCode(event->key_code),
WebCore::PlatformKeyboardEvent::windowsKeyCodeForWPEKeyCode(event->key_code),
event->key_code,
handledByInputMethod,
WTFMove(preeditUnderlines),
WTFMove(preeditSelectionRange),
isWPEKeyCodeFromKeyPad(event->key_code),
modifiersForKeyboardEvent(event),
wallTimeForEventTime(event->time));
}
static inline short pressedMouseButtons(uint32_t modifiers)
{
// 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 (modifiers & wpe_input_pointer_modifier_button1)
buttons |= 1;
// 2 MUST indicate the secondary button (in general, the right button, often used to display a context menu),
// if present.
if (modifiers & wpe_input_pointer_modifier_button2)
buttons |= 2;
// 4 MUST indicate the auxiliary button (in general, the middle button, often combined with a mouse wheel).
if (modifiers & wpe_input_pointer_modifier_button3)
buttons |= 4;
return buttons;
}
WebMouseEvent WebEventFactory::createWebMouseEvent(struct wpe_input_pointer_event* event, float deviceScaleFactor)
{
WebEvent::Type type = WebEvent::NoType;
switch (event->type) {
case wpe_input_pointer_event_type_motion:
type = WebEvent::MouseMove;
break;
case wpe_input_pointer_event_type_button:
type = event->state ? WebEvent::MouseDown : WebEvent::MouseUp;
break;
case wpe_input_pointer_event_type_null:
ASSERT_NOT_REACHED();
}
WebMouseEvent::Button button = WebMouseEvent::NoButton;
switch (event->type) {
case wpe_input_pointer_event_type_motion:
case wpe_input_pointer_event_type_button:
if (event->button == 1)
button = WebMouseEvent::LeftButton;
else if (event->button == 2)
button = WebMouseEvent::RightButton;
else if (event->button == 3)
button = WebMouseEvent::MiddleButton;
break;
case wpe_input_pointer_event_type_null:
ASSERT_NOT_REACHED();
}
unsigned clickCount = (type == WebEvent::MouseDown) ? 1 : 0;
// FIXME: Proper button support. deltaX/Y/Z. Click count.
WebCore::IntPoint position(event->x, event->y);
position.scale(1 / deviceScaleFactor);
return WebMouseEvent(type, button, pressedMouseButtons(event->modifiers), position, position,
0, 0, 0, clickCount, modifiersForEventModifiers(event->modifiers), wallTimeForEventTime(event->time));
}
WebWheelEvent WebEventFactory::createWebWheelEvent(struct wpe_input_axis_event* event, float deviceScaleFactor, WebWheelEvent::Phase phase, WebWheelEvent::Phase momentumPhase)
{
WebCore::IntPoint position(event->x, event->y);
position.scale(1 / deviceScaleFactor);
WebCore::FloatSize wheelTicks;
WebCore::FloatSize delta;
bool hasPreciseScrollingDeltas = false;
#if WPE_CHECK_VERSION(1, 5, 0)
if (event->type & wpe_input_axis_event_type_mask_2d) {
auto* event2D = reinterpret_cast<struct wpe_input_axis_2d_event*>(event);
switch (event->type & (wpe_input_axis_event_type_mask_2d - 1)) {
case wpe_input_axis_event_type_motion:
wheelTicks = WebCore::FloatSize(std::copysign(1, event2D->x_axis), std::copysign(1, event2D->y_axis));
delta = wheelTicks;
delta.scale(WebCore::Scrollbar::pixelsPerLineStep());
break;
case wpe_input_axis_event_type_motion_smooth:
wheelTicks = WebCore::FloatSize(event2D->x_axis / deviceScaleFactor, event2D->y_axis / deviceScaleFactor);
delta = wheelTicks;
hasPreciseScrollingDeltas = true;
break;
default:
return WebWheelEvent();
}
return WebWheelEvent(WebEvent::Wheel, position, position,
delta, wheelTicks, phase, momentumPhase,
WebWheelEvent::ScrollByPixelWheelEvent, hasPreciseScrollingDeltas,
OptionSet<WebEvent::Modifier> { }, wallTimeForEventTime(event->time));
}
#endif
// FIXME: We shouldn't hard-code this.
enum Axis {
Vertical,
Horizontal,
Smooth
};
switch (event->axis) {
case Vertical:
wheelTicks = WebCore::FloatSize(0, std::copysign(1, event->value));
delta = wheelTicks;
delta.scale(WebCore::Scrollbar::pixelsPerLineStep());
break;
case Horizontal:
wheelTicks = WebCore::FloatSize(std::copysign(1, event->value), 0);
delta = wheelTicks;
delta.scale(WebCore::Scrollbar::pixelsPerLineStep());
break;
case Smooth:
wheelTicks = WebCore::FloatSize(0, event->value / deviceScaleFactor);
delta = wheelTicks;
hasPreciseScrollingDeltas = true;
break;
default:
return WebWheelEvent();
};
return WebWheelEvent(WebEvent::Wheel, position, position,
delta, wheelTicks, phase, momentumPhase,
WebWheelEvent::ScrollByPixelWheelEvent, hasPreciseScrollingDeltas,
OptionSet<WebEvent::Modifier> { }, wallTimeForEventTime(event->time));
}
#if ENABLE(TOUCH_EVENTS)
static WebKit::WebPlatformTouchPoint::TouchPointState stateForTouchPoint(int mainEventId, const struct wpe_input_touch_event_raw* point)
{
if (point->id != mainEventId)
return WebKit::WebPlatformTouchPoint::TouchStationary;
switch (point->type) {
case wpe_input_touch_event_type_down:
return WebKit::WebPlatformTouchPoint::TouchPressed;
case wpe_input_touch_event_type_motion:
return WebKit::WebPlatformTouchPoint::TouchMoved;
case wpe_input_touch_event_type_up:
return WebKit::WebPlatformTouchPoint::TouchReleased;
case wpe_input_touch_event_type_null:
ASSERT_NOT_REACHED();
break;
};
return WebKit::WebPlatformTouchPoint::TouchStationary;
}
WebTouchEvent WebEventFactory::createWebTouchEvent(struct wpe_input_touch_event* event, float deviceScaleFactor)
{
WebEvent::Type type = WebEvent::NoType;
switch (event->type) {
case wpe_input_touch_event_type_down:
type = WebEvent::TouchStart;
break;
case wpe_input_touch_event_type_motion:
type = WebEvent::TouchMove;
break;
case wpe_input_touch_event_type_up:
type = WebEvent::TouchEnd;
break;
case wpe_input_touch_event_type_null:
ASSERT_NOT_REACHED();
}
Vector<WebKit::WebPlatformTouchPoint> touchPoints;
touchPoints.reserveCapacity(event->touchpoints_length);
for (unsigned i = 0; i < event->touchpoints_length; ++i) {
auto& point = event->touchpoints[i];
if (point.type == wpe_input_touch_event_type_null)
continue;
WebCore::IntPoint pointCoordinates(point.x, point.y);
pointCoordinates.scale(1 / deviceScaleFactor);
touchPoints.uncheckedAppend(
WebKit::WebPlatformTouchPoint(point.id, stateForTouchPoint(event->id, &point),
pointCoordinates, pointCoordinates));
}
return WebTouchEvent(type, WTFMove(touchPoints), OptionSet<WebEvent::Modifier> { }, wallTimeForEventTime(event->time));
}
#endif // ENABLE(TOUCH_EVENTS)
} // namespace WebKit