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#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
262pub struct TouchEvent {
263    pub event_type: TouchEventType,
264    pub touch_id: TouchId,
265    pub point: WebViewPoint,
266    /// cancelable default value is true, once the first move has been processed by script disable it.
267    cancelable: bool,
268}
269
270impl TouchEvent {
271    pub fn new(event_type: TouchEventType, touch_id: TouchId, point: WebViewPoint) -> Self {
272        TouchEvent {
273            event_type,
274            touch_id,
275            point,
276            cancelable: true,
277        }
278    }
279
280    #[doc(hidden)]
281    pub fn disable_cancelable(&mut self) {
282        self.cancelable = false;
283    }
284
285    #[doc(hidden)]
286    pub fn is_cancelable(&self) -> bool {
287        self.cancelable
288    }
289}
290
291/// Unit of a [`WheelDelta`].
292#[derive(Clone, Copy, Debug, Deserialize, PartialEq, Serialize)]
293pub enum WheelMode {
294    /// Delta values are specified in pixels.
295    DeltaPixel = 0x00,
296    /// Delta values are specified in lines.
297    DeltaLine = 0x01,
298    /// Delta values are specified in pages.
299    DeltaPage = 0x02,
300}
301
302/// The wheel event deltas for every direction.
303#[derive(Clone, Copy, Debug, Deserialize, PartialEq, Serialize)]
304pub struct WheelDelta {
305    /// Delta in the left/right direction. A positive value means that the view scrolls left,
306    /// revealing more content to the left of the current viewport.
307    pub x: f64,
308    /// Delta in the up/down direction. A positive value means that the view scrolls up, revealing
309    /// more content above the current viewport.
310    pub y: f64,
311    /// Delta in the direction going into/out of the screen
312    pub z: f64,
313    /// Mode to measure the floats in
314    pub mode: WheelMode,
315}
316
317#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
318pub struct WheelEvent {
319    pub delta: WheelDelta,
320    pub point: WebViewPoint,
321}
322
323impl WheelEvent {
324    pub fn new(delta: WheelDelta, point: WebViewPoint) -> Self {
325        WheelEvent { delta, point }
326    }
327}
328
329/// The types of an input method event.
330#[derive(Clone, Debug, Deserialize, Serialize)]
331pub enum ImeEvent {
332    Composition(CompositionEvent),
333    Dismissed,
334}
335
336#[cfg(feature = "gamepad")]
337#[derive(
338    Clone, Copy, Debug, Deserialize, Eq, Hash, MallocSizeOf, Ord, PartialEq, PartialOrd, Serialize,
339)]
340/// Index of gamepad in list of system's connected gamepads.
341pub struct GamepadIndex(pub usize);
342
343#[cfg(feature = "gamepad")]
344#[derive(Clone, Debug, Deserialize, Serialize)]
345/// The minimum and maximum values that can be reported for axis or button input from this gamepad.
346pub struct GamepadInputBounds {
347    /// Minimum and maximum axis values.
348    pub axis_bounds: (f64, f64),
349    /// Minimum and maximum button values.
350    pub button_bounds: (f64, f64),
351}
352
353#[cfg(feature = "gamepad")]
354#[derive(Clone, Debug, Deserialize, Serialize)]
355/// The haptic effects supported by this gamepad.
356pub struct GamepadSupportedHapticEffects {
357    /// Whether gamepad has support for dual rumble effects.
358    pub supports_dual_rumble: bool,
359    /// Whether gamepad has support for trigger rumble effects.
360    pub supports_trigger_rumble: bool,
361}
362
363#[cfg(feature = "gamepad")]
364#[derive(Clone, Debug, Deserialize, Serialize)]
365/// The types of Gamepad event.
366pub enum GamepadEvent {
367    /// A new gamepad has been connected.
368    ///
369    /// <https://www.w3.org/TR/gamepad/#event-gamepadconnected>
370    Connected(
371        GamepadIndex,
372        String,
373        GamepadInputBounds,
374        GamepadSupportedHapticEffects,
375    ),
376    /// An existing gamepad has been disconnected.
377    ///
378    /// <https://www.w3.org/TR/gamepad/#event-gamepaddisconnected>
379    Disconnected(GamepadIndex),
380    /// An existing gamepad has been updated.
381    ///
382    /// <https://www.w3.org/TR/gamepad/#receiving-inputs>
383    Updated(GamepadIndex, GamepadUpdateType),
384}
385
386#[cfg(feature = "gamepad")]
387#[derive(Clone, Debug, Deserialize, Serialize)]
388/// The type of Gamepad input being updated.
389pub enum GamepadUpdateType {
390    /// Axis index and input value.
391    ///
392    /// <https://www.w3.org/TR/gamepad/#dfn-represents-a-standard-gamepad-axis>
393    Axis(usize, f64),
394    /// Button index and input value.
395    ///
396    /// <https://www.w3.org/TR/gamepad/#dfn-represents-a-standard-gamepad-button>
397    Button(usize, f64),
398}
embedder_traits/input_events.rs

embedder_traits/
input_events.rs
