embedder_traits/
input_events.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use std::sync::atomic::{AtomicUsize, Ordering};
6
7use bitflags::bitflags;
8use keyboard_types::{Code, CompositionEvent, Key, KeyState, Location, Modifiers};
9use malloc_size_of_derive::MallocSizeOf;
10use serde::{Deserialize, Serialize};
11
12use crate::WebViewPoint;
13
14/// An opaque id for an [`InputEvent`].
15#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
16pub struct InputEventId(usize);
17
18static INPUT_EVENT_ID: AtomicUsize = AtomicUsize::new(0);
19
20impl InputEventId {
21    fn new() -> Self {
22        Self(INPUT_EVENT_ID.fetch_add(1, Ordering::Relaxed))
23    }
24}
25
26bitflags! {
27    /// Flags representing the state of an [`InputEvent`] after Servo has handled it.
28    #[derive(Clone, Copy, Default, Deserialize, PartialEq, Serialize)]
29    pub struct InputEventResult: u8 {
30        /// Whether or not this input event's default behavior was prevented via script.
31        const DefaultPrevented = 1 << 0;
32        /// Whether or not the WebView handled this event. Some events have default handlers in
33        /// Servo, such as keyboard events that insert characters in `<input>` areas. When these
34        /// handlers are triggered, this flag is included. This can be used to prevent triggering
35        /// behavior (such as keybindings) when the WebView has already consumed the event for its
36        /// own purpose.
37        const Consumed = 1 << 1;
38        /// Whether or not the input event failed to dispatch. This can happen when an event
39        /// is sent while Servo is shutting down or when it is in an intermediate state.
40        /// Typically these events should be considered to be consumed.
41        const DispatchFailed = 1 << 2;
42    }
43}
44
45#[derive(Deserialize, Serialize)]
46pub struct InputEventOutcome {
47    pub id: InputEventId,
48    pub result: InputEventResult,
49}
50
51/// An input event that is sent from the embedder to Servo.
52#[derive(Clone, Debug, Deserialize, Serialize)]
53pub enum InputEvent {
54    EditingAction(EditingActionEvent),
55    #[cfg(feature = "gamepad")]
56    Gamepad(GamepadEvent),
57    Ime(ImeEvent),
58    Keyboard(KeyboardEvent),
59    MouseButton(MouseButtonEvent),
60    MouseLeftViewport(MouseLeftViewportEvent),
61    MouseMove(MouseMoveEvent),
62    Touch(TouchEvent),
63    Wheel(WheelEvent),
64}
65
66#[derive(Clone, Debug, Deserialize, Serialize)]
67pub struct InputEventAndId {
68    pub event: InputEvent,
69    pub id: InputEventId,
70}
71
72impl From<InputEvent> for InputEventAndId {
73    fn from(event: InputEvent) -> Self {
74        Self {
75            event,
76            id: InputEventId::new(),
77        }
78    }
79}
80
81/// An editing action that should be performed on a `WebView`.
82#[derive(Clone, Debug, Deserialize, Serialize)]
83pub enum EditingActionEvent {
84    Copy,
85    Cut,
86    Paste,
87}
88
89impl InputEvent {
90    pub fn point(&self) -> Option<WebViewPoint> {
91        match self {
92            InputEvent::EditingAction(..) => None,
93            #[cfg(feature = "gamepad")]
94            InputEvent::Gamepad(..) => None,
95            InputEvent::Ime(..) => None,
96            InputEvent::Keyboard(..) => None,
97            InputEvent::MouseButton(event) => Some(event.point),
98            InputEvent::MouseMove(event) => Some(event.point),
99            InputEvent::MouseLeftViewport(_) => None,
100            InputEvent::Touch(event) => Some(event.point),
101            InputEvent::Wheel(event) => Some(event.point),
102        }
103    }
104}
105
106#[derive(Clone, Debug, Default, Deserialize, Serialize)]
107pub struct KeyboardEvent {
108    pub event: ::keyboard_types::KeyboardEvent,
109}
110
111impl KeyboardEvent {
112    pub fn new(keyboard_event: ::keyboard_types::KeyboardEvent) -> Self {
113        Self {
114            event: keyboard_event,
115        }
116    }
117
118    pub fn new_without_event(
119        state: KeyState,
120        key: Key,
121        code: Code,
122        location: Location,
123        modifiers: Modifiers,
124        repeat: bool,
125        is_composing: bool,
126    ) -> Self {
127        Self::new(::keyboard_types::KeyboardEvent {
128            state,
129            key,
130            code,
131            location,
132            modifiers,
133            repeat,
134            is_composing,
135        })
136    }
137
138    pub fn from_state_and_key(state: KeyState, key: Key) -> Self {
139        Self::new(::keyboard_types::KeyboardEvent {
140            state,
141            key,
142            ..::keyboard_types::KeyboardEvent::default()
143        })
144    }
145}
146
147#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
148pub struct MouseButtonEvent {
149    pub action: MouseButtonAction,
150    pub button: MouseButton,
151    pub point: WebViewPoint,
152}
153
154impl MouseButtonEvent {
155    pub fn new(action: MouseButtonAction, button: MouseButton, point: WebViewPoint) -> Self {
156        Self {
157            action,
158            button,
159            point,
160        }
161    }
162}
163
164/// The types of mouse buttons.
165#[derive(Clone, Copy, Debug, Deserialize, MallocSizeOf, PartialEq, Serialize)]
166pub enum MouseButton {
167    Left,
168    Middle,
169    Right,
170    Back,
171    Forward,
172    Other(u16),
173}
174
175impl<T: Into<u64>> From<T> for MouseButton {
176    fn from(value: T) -> Self {
177        let value = value.into();
178        match value {
179            0 => MouseButton::Left,
180            1 => MouseButton::Middle,
181            2 => MouseButton::Right,
182            3 => MouseButton::Back,
183            4 => MouseButton::Forward,
184            _ => MouseButton::Other(value as u16),
185        }
186    }
187}
188
189impl From<MouseButton> for i16 {
190    fn from(value: MouseButton) -> Self {
191        match value {
192            MouseButton::Left => 0,
193            MouseButton::Middle => 1,
194            MouseButton::Right => 2,
195            MouseButton::Back => 3,
196            MouseButton::Forward => 4,
197            MouseButton::Other(value) => value as i16,
198        }
199    }
200}
201
202/// The types of mouse events.
203#[derive(Clone, Copy, Debug, Deserialize, MallocSizeOf, PartialEq, Serialize)]
204pub enum MouseButtonAction {
205    /// Mouse button down.
206    Down,
207    /// Mouse button up.
208    Up,
209}
210
211#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
212pub struct MouseMoveEvent {
213    pub point: WebViewPoint,
214    #[doc(hidden)]
215    // An internal flag used to avoid refreshing the cursor in response to move
216    // events for touch devices since they are simulated in Servo using mouse events.
217    pub is_compatibility_event_for_touch: bool,
218}
219
220impl MouseMoveEvent {
221    pub fn new(point: WebViewPoint) -> Self {
222        Self {
223            point,
224            is_compatibility_event_for_touch: false,
225        }
226    }
227
228    #[doc(hidden)]
229    pub fn new_compatibility_for_touch(point: WebViewPoint) -> Self {
230        Self {
231            point,
232            is_compatibility_event_for_touch: true,
233        }
234    }
235}
236
237#[derive(Clone, Copy, Debug, Default, Deserialize, Serialize)]
238pub struct MouseLeftViewportEvent {
239    pub focus_moving_to_another_iframe: bool,
240}
241
242/// The type of input represented by a multi-touch event.
243#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
244pub enum TouchEventType {
245    /// A new touch point came in contact with the screen.
246    Down,
247    /// An existing touch point changed location.
248    Move,
249    /// A touch point was removed from the screen.
250    Up,
251    /// The system stopped tracking a touch point.
252    Cancel,
253}
254
255/// An opaque identifier for a touch point.
256///
257/// <http://w3c.github.io/touch-events/#widl-Touch-identifier>
258#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
259pub struct TouchId(pub i32);
260
261/// Distinguishes the kind of physical input that produced a [`TouchEvent`].
262/// Servo routes both pen and finger-touch input through the touch event path,
263/// but the originating subtype determines the `pointerType` reported to script.
264#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
265pub enum TouchPointerType {
266    Pen,
267    Touch,
268}
269
270#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
271pub struct TouchEvent {
272    pub event_type: TouchEventType,
273    pub touch_id: TouchId,
274    pub point: WebViewPoint,
275    pub pointer_type: TouchPointerType,
276    /// cancelable default value is true, once the first move has been processed by script disable it.
277    cancelable: bool,
278}
279
280impl TouchEvent {
281    pub fn new(
282        event_type: TouchEventType,
283        touch_id: TouchId,
284        point: WebViewPoint,
285        pointer_type: TouchPointerType,
286    ) -> Self {
287        TouchEvent {
288            event_type,
289            touch_id,
290            point,
291            pointer_type,
292            cancelable: true,
293        }
294    }
295
296    #[doc(hidden)]
297    pub fn disable_cancelable(&mut self) {
298        self.cancelable = false;
299    }
300
301    #[doc(hidden)]
302    pub fn is_cancelable(&self) -> bool {
303        self.cancelable
304    }
305}
306
307/// Unit of a [`WheelDelta`].
308#[derive(Clone, Copy, Debug, Deserialize, PartialEq, Serialize)]
309pub enum WheelMode {
310    /// Delta values are specified in pixels.
311    DeltaPixel = 0x00,
312    /// Delta values are specified in lines.
313    DeltaLine = 0x01,
314    /// Delta values are specified in pages.
315    DeltaPage = 0x02,
316}
317
318/// The wheel event deltas for every direction.
319#[derive(Clone, Copy, Debug, Deserialize, PartialEq, Serialize)]
320pub struct WheelDelta {
321    /// Delta in the left/right direction. A positive value means that the view scrolls left,
322    /// revealing more content to the left of the current viewport.
323    pub x: f64,
324    /// Delta in the up/down direction. A positive value means that the view scrolls up, revealing
325    /// more content above the current viewport.
326    pub y: f64,
327    /// Delta in the direction going into/out of the screen
328    pub z: f64,
329    /// Mode to measure the floats in
330    pub mode: WheelMode,
331}
332
333#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
334pub struct WheelEvent {
335    pub delta: WheelDelta,
336    pub point: WebViewPoint,
337}
338
339impl WheelEvent {
340    pub fn new(delta: WheelDelta, point: WebViewPoint) -> Self {
341        WheelEvent { delta, point }
342    }
343}
344
345/// The types of an input method event.
346#[derive(Clone, Debug, Deserialize, Serialize)]
347pub enum ImeEvent {
348    Composition(CompositionEvent),
349    Dismissed,
350}
351
352#[cfg(feature = "gamepad")]
353#[derive(
354    Clone, Copy, Debug, Deserialize, Eq, Hash, MallocSizeOf, Ord, PartialEq, PartialOrd, Serialize,
355)]
356/// Index of gamepad in list of system's connected gamepads.
357pub struct GamepadIndex(pub usize);
358
359#[cfg(feature = "gamepad")]
360#[derive(Clone, Debug, Deserialize, Serialize)]
361/// The minimum and maximum values that can be reported for axis or button input from this gamepad.
362pub struct GamepadInputBounds {
363    /// Minimum and maximum axis values.
364    pub axis_bounds: (f64, f64),
365    /// Minimum and maximum button values.
366    pub button_bounds: (f64, f64),
367}
368
369#[cfg(feature = "gamepad")]
370#[derive(Clone, Debug, Deserialize, Serialize)]
371/// The haptic effects supported by this gamepad.
372pub struct GamepadSupportedHapticEffects {
373    /// Whether gamepad has support for dual rumble effects.
374    pub supports_dual_rumble: bool,
375    /// Whether gamepad has support for trigger rumble effects.
376    pub supports_trigger_rumble: bool,
377}
378
379#[cfg(feature = "gamepad")]
380#[derive(Clone, Debug, Deserialize, Serialize)]
381/// The types of Gamepad event.
382pub enum GamepadEvent {
383    /// A new gamepad has been connected.
384    ///
385    /// <https://www.w3.org/TR/gamepad/#event-gamepadconnected>
386    Connected(
387        GamepadIndex,
388        String,
389        GamepadInputBounds,
390        GamepadSupportedHapticEffects,
391    ),
392    /// An existing gamepad has been disconnected.
393    ///
394    /// <https://www.w3.org/TR/gamepad/#event-gamepaddisconnected>
395    Disconnected(GamepadIndex),
396    /// An existing gamepad has been updated.
397    ///
398    /// <https://www.w3.org/TR/gamepad/#receiving-inputs>
399    Updated(GamepadIndex, GamepadUpdateType),
400}
401
402#[cfg(feature = "gamepad")]
403#[derive(Clone, Debug, Deserialize, Serialize)]
404/// The type of Gamepad input being updated.
405pub enum GamepadUpdateType {
406    /// Axis index and input value.
407    ///
408    /// <https://www.w3.org/TR/gamepad/#dfn-represents-a-standard-gamepad-axis>
409    Axis(usize, f64),
410    /// Button index and input value.
411    ///
412    /// <https://www.w3.org/TR/gamepad/#dfn-represents-a-standard-gamepad-button>
413    Button(usize, f64),
414}
embedder_traits/input_events.rs

embedder_traits/
input_events.rs
