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};
11use webrender_api::ExternalScrollId;
12
13use crate::WebViewPoint;
14
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    #[derive(Clone, Copy, Default, Deserialize, PartialEq, Serialize)]
28    pub struct InputEventResult: u8 {
29        /// Whether or not this input event's default behavior was prevented via script.
30        const DefaultPrevented = 1 << 0;
31        /// Whether or not the WebView handled this event. Some events have default handlers in
32        /// Servo, such as keyboard events that insert characters in `<input>` areas. When these
33        /// handlers are triggered, this flag is included. This can be used to prevent triggering
34        /// behavior (such as keybindings) when the WebView has already consumed the event for its
35        /// own purpose.
36        const Consumed = 1 << 1;
37    }
38}
39
40/// An input event that is sent from the embedder to Servo.
41#[derive(Clone, Debug, Deserialize, Serialize)]
42pub enum InputEvent {
43    EditingAction(EditingActionEvent),
44    Gamepad(GamepadEvent),
45    Ime(ImeEvent),
46    Keyboard(KeyboardEvent),
47    MouseButton(MouseButtonEvent),
48    MouseLeftViewport(MouseLeftViewportEvent),
49    MouseMove(MouseMoveEvent),
50    Scroll(ScrollEvent),
51    Touch(TouchEvent),
52    Wheel(WheelEvent),
53}
54
55#[derive(Clone, Debug, Deserialize, Serialize)]
56pub struct InputEventAndId {
57    pub event: InputEvent,
58    pub id: InputEventId,
59}
60
61impl From<InputEvent> for InputEventAndId {
62    fn from(event: InputEvent) -> Self {
63        Self {
64            event,
65            id: InputEventId::new(),
66        }
67    }
68}
69
70/// An editing action that should be performed on a `WebView`.
71#[derive(Clone, Debug, Deserialize, Serialize)]
72pub enum EditingActionEvent {
73    Copy,
74    Cut,
75    Paste,
76}
77
78impl InputEvent {
79    pub fn point(&self) -> Option<WebViewPoint> {
80        match self {
81            InputEvent::EditingAction(..) => None,
82            InputEvent::Gamepad(..) => None,
83            InputEvent::Ime(..) => None,
84            InputEvent::Keyboard(..) => None,
85            InputEvent::MouseButton(event) => Some(event.point),
86            InputEvent::MouseMove(event) => Some(event.point),
87            InputEvent::MouseLeftViewport(_) => None,
88            InputEvent::Touch(event) => Some(event.point),
89            InputEvent::Wheel(event) => Some(event.point),
90            InputEvent::Scroll(..) => None,
91        }
92    }
93}
94
95#[derive(Clone, Debug, Default, Deserialize, Serialize)]
96pub struct KeyboardEvent {
97    pub event: ::keyboard_types::KeyboardEvent,
98}
99
100impl KeyboardEvent {
101    pub fn new(keyboard_event: ::keyboard_types::KeyboardEvent) -> Self {
102        Self {
103            event: keyboard_event,
104        }
105    }
106
107    pub fn new_without_event(
108        state: KeyState,
109        key: Key,
110        code: Code,
111        location: Location,
112        modifiers: Modifiers,
113        repeat: bool,
114        is_composing: bool,
115    ) -> Self {
116        Self::new(::keyboard_types::KeyboardEvent {
117            state,
118            key,
119            code,
120            location,
121            modifiers,
122            repeat,
123            is_composing,
124        })
125    }
126
127    pub fn from_state_and_key(state: KeyState, key: Key) -> Self {
128        Self::new(::keyboard_types::KeyboardEvent {
129            state,
130            key,
131            ..::keyboard_types::KeyboardEvent::default()
132        })
133    }
134}
135
136#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
137pub struct MouseButtonEvent {
138    pub action: MouseButtonAction,
139    pub button: MouseButton,
140    pub point: WebViewPoint,
141}
142
143impl MouseButtonEvent {
144    pub fn new(action: MouseButtonAction, button: MouseButton, point: WebViewPoint) -> Self {
145        Self {
146            action,
147            button,
148            point,
149        }
150    }
151}
152
153#[derive(Clone, Copy, Debug, Deserialize, PartialEq, Serialize)]
154pub enum MouseButton {
155    Left,
156    Middle,
157    Right,
158    Back,
159    Forward,
160    Other(u16),
161}
162
163impl<T: Into<u64>> From<T> for MouseButton {
164    fn from(value: T) -> Self {
165        let value = value.into();
166        match value {
167            0 => MouseButton::Left,
168            1 => MouseButton::Middle,
169            2 => MouseButton::Right,
170            3 => MouseButton::Back,
171            4 => MouseButton::Forward,
172            _ => MouseButton::Other(value as u16),
173        }
174    }
175}
176
177impl From<MouseButton> for i16 {
178    fn from(value: MouseButton) -> Self {
179        match value {
180            MouseButton::Left => 0,
181            MouseButton::Middle => 1,
182            MouseButton::Right => 2,
183            MouseButton::Back => 3,
184            MouseButton::Forward => 4,
185            MouseButton::Other(value) => value as i16,
186        }
187    }
188}
189
190/// The types of mouse events
191#[derive(Clone, Copy, Debug, Deserialize, MallocSizeOf, PartialEq, Serialize)]
192pub enum MouseButtonAction {
193    /// Mouse button down
194    Down,
195    /// Mouse button up
196    Up,
197}
198
199#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
200pub struct MouseMoveEvent {
201    pub point: WebViewPoint,
202}
203
204impl MouseMoveEvent {
205    pub fn new(point: WebViewPoint) -> Self {
206        Self { point }
207    }
208}
209
210#[derive(Clone, Copy, Debug, Default, Deserialize, Serialize)]
211pub struct MouseLeftViewportEvent {
212    pub focus_moving_to_another_iframe: bool,
213}
214
215/// The type of input represented by a multi-touch event.
216#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
217pub enum TouchEventType {
218    /// A new touch point came in contact with the screen.
219    Down,
220    /// An existing touch point changed location.
221    Move,
222    /// A touch point was removed from the screen.
223    Up,
224    /// The system stopped tracking a touch point.
225    Cancel,
226}
227
228/// An opaque identifier for a touch point.
229///
230/// <http://w3c.github.io/touch-events/#widl-Touch-identifier>
231#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
232pub struct TouchId(pub i32);
233
234#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
235pub struct TouchEvent {
236    pub event_type: TouchEventType,
237    pub id: TouchId,
238    pub point: WebViewPoint,
239    /// cancelable default value is true, once the first move has been processed by script disable it.
240    cancelable: bool,
241}
242
243impl TouchEvent {
244    pub fn new(event_type: TouchEventType, id: TouchId, point: WebViewPoint) -> Self {
245        TouchEvent {
246            event_type,
247            id,
248            point,
249            cancelable: true,
250        }
251    }
252
253    #[doc(hidden)]
254    pub fn disable_cancelable(&mut self) {
255        self.cancelable = false;
256    }
257
258    #[doc(hidden)]
259    pub fn is_cancelable(&self) -> bool {
260        self.cancelable
261    }
262}
263
264/// Mode to measure WheelDelta floats in
265#[derive(Clone, Copy, Debug, Deserialize, PartialEq, Serialize)]
266pub enum WheelMode {
267    /// Delta values are specified in pixels
268    DeltaPixel = 0x00,
269    /// Delta values are specified in lines
270    DeltaLine = 0x01,
271    /// Delta values are specified in pages
272    DeltaPage = 0x02,
273}
274
275/// The Wheel event deltas in every direction
276#[derive(Clone, Copy, Debug, Deserialize, PartialEq, Serialize)]
277pub struct WheelDelta {
278    /// Delta in the left/right direction
279    pub x: f64,
280    /// Delta in the up/down direction
281    pub y: f64,
282    /// Delta in the direction going into/out of the screen
283    pub z: f64,
284    /// Mode to measure the floats in
285    pub mode: WheelMode,
286}
287
288#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
289pub struct WheelEvent {
290    pub delta: WheelDelta,
291    pub point: WebViewPoint,
292}
293
294impl WheelEvent {
295    pub fn new(delta: WheelDelta, point: WebViewPoint) -> Self {
296        WheelEvent { delta, point }
297    }
298}
299
300#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
301pub struct ScrollEvent {
302    pub external_id: ExternalScrollId,
303}
304
305#[derive(Clone, Debug, Deserialize, Serialize)]
306pub enum ImeEvent {
307    Composition(CompositionEvent),
308    Dismissed,
309}
310
311#[derive(
312    Clone, Copy, Debug, Deserialize, Eq, Hash, MallocSizeOf, Ord, PartialEq, PartialOrd, Serialize,
313)]
314/// Index of gamepad in list of system's connected gamepads
315pub struct GamepadIndex(pub usize);
316
317#[derive(Clone, Debug, Deserialize, Serialize)]
318/// The minimum and maximum values that can be reported for axis or button input from this gamepad
319pub struct GamepadInputBounds {
320    /// Minimum and maximum axis values
321    pub axis_bounds: (f64, f64),
322    /// Minimum and maximum button values
323    pub button_bounds: (f64, f64),
324}
325
326#[derive(Clone, Debug, Deserialize, Serialize)]
327/// The haptic effects supported by this gamepad
328pub struct GamepadSupportedHapticEffects {
329    /// Gamepad support for dual rumble effects
330    pub supports_dual_rumble: bool,
331    /// Gamepad support for trigger rumble effects
332    pub supports_trigger_rumble: bool,
333}
334
335#[derive(Clone, Debug, Deserialize, Serialize)]
336/// The type of Gamepad event
337pub enum GamepadEvent {
338    /// A new gamepad has been connected
339    /// <https://www.w3.org/TR/gamepad/#event-gamepadconnected>
340    Connected(
341        GamepadIndex,
342        String,
343        GamepadInputBounds,
344        GamepadSupportedHapticEffects,
345    ),
346    /// An existing gamepad has been disconnected
347    /// <https://www.w3.org/TR/gamepad/#event-gamepaddisconnected>
348    Disconnected(GamepadIndex),
349    /// An existing gamepad has been updated
350    /// <https://www.w3.org/TR/gamepad/#receiving-inputs>
351    Updated(GamepadIndex, GamepadUpdateType),
352}
353
354#[derive(Clone, Debug, Deserialize, Serialize)]
355/// The type of Gamepad input being updated
356pub enum GamepadUpdateType {
357    /// Axis index and input value
358    /// <https://www.w3.org/TR/gamepad/#dfn-represents-a-standard-gamepad-axis>
359    Axis(usize, f64),
360    /// Button index and input value
361    /// <https://www.w3.org/TR/gamepad/#dfn-represents-a-standard-gamepad-button>
362    Button(usize, f64),
363}
embedder_traits/input_events.rs

embedder_traits/
input_events.rs
