script/dom/touch/
touch.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::f64::consts::PI;
6
7use dom_struct::dom_struct;
8use euclid::Point2D;
9use js::context::JSContext;
10use script_bindings::inheritance::Castable;
11use script_bindings::reflector::{Reflector, reflect_dom_object_with_cx};
12
13use crate::dom::bindings::codegen::Bindings::TouchBinding::TouchMethods;
14use crate::dom::bindings::num::Finite;
15use crate::dom::bindings::root::{DomRoot, MutDom};
16use crate::dom::event::{Event, EventBubbles, EventCancelable};
17use crate::dom::eventtarget::EventTarget;
18use crate::dom::pointerevent::PointerEvent;
19use crate::dom::window::Window;
20
21#[dom_struct]
22pub(crate) struct Touch {
23    reflector_: Reflector,
24    identifier: i32,
25    target: MutDom<EventTarget>,
26    screen_x: f64,
27    screen_y: f64,
28    client_x: f64,
29    client_y: f64,
30    page_x: f64,
31    page_y: f64,
32}
33
34impl Touch {
35    #[allow(clippy::too_many_arguments)]
36    fn new_inherited(
37        identifier: i32,
38        target: &EventTarget,
39        screen_x: Finite<f64>,
40        screen_y: Finite<f64>,
41        client_x: Finite<f64>,
42        client_y: Finite<f64>,
43        page_x: Finite<f64>,
44        page_y: Finite<f64>,
45    ) -> Touch {
46        Touch {
47            reflector_: Reflector::new(),
48            identifier,
49            target: MutDom::new(target),
50            screen_x: *screen_x,
51            screen_y: *screen_y,
52            client_x: *client_x,
53            client_y: *client_y,
54            page_x: *page_x,
55            page_y: *page_y,
56        }
57    }
58
59    #[allow(clippy::too_many_arguments)]
60    pub(crate) fn new(
61        cx: &mut JSContext,
62        window: &Window,
63        identifier: i32,
64        target: &EventTarget,
65        screen_x: Finite<f64>,
66        screen_y: Finite<f64>,
67        client_x: Finite<f64>,
68        client_y: Finite<f64>,
69        page_x: Finite<f64>,
70        page_y: Finite<f64>,
71    ) -> DomRoot<Touch> {
72        reflect_dom_object_with_cx(
73            Box::new(Touch::new_inherited(
74                identifier, target, screen_x, screen_y, client_x, client_y, page_x, page_y,
75            )),
76            window,
77            cx,
78        )
79    }
80
81    /// Create a PointerEvent from this Touch.
82    /// <https://w3c.github.io/pointerevents/#the-primary-pointer>
83    #[allow(clippy::too_many_arguments)]
84    pub(crate) fn to_pointer_event(
85        &self,
86        cx: &mut JSContext,
87        window: &Window,
88        event_type: &str,
89        pointer_id: i32,
90        is_primary: bool,
91        pointer_type: &str,
92        modifiers: keyboard_types::Modifiers,
93        is_cancelable: bool,
94        point_in_node: Option<euclid::Point2D<f32, style_traits::CSSPixel>>,
95    ) -> DomRoot<PointerEvent> {
96        // Pressure is 0.5 for active touches, 0.0 for up/cancel/out/leave
97        // <https://w3c.github.io/pointerevents/#dom-pointerevent-pressure>
98        // TODO: add proper force support.
99        let pressure = if event_type == "pointerup" ||
100            event_type == "pointercancel" ||
101            event_type == "pointerout" ||
102            event_type == "pointerleave"
103        {
104            0.0
105        } else {
106            0.5
107        };
108
109        // <https://w3c.github.io/pointerevents/#the-button-property>
110        // For pointermove, pointerover, pointerenter, pointerout, pointerleave: button is -1
111        // For pointerdown, pointerup, pointercancel: button is 0 (primary button)
112        let button = if event_type == "pointermove" ||
113            event_type == "pointerover" ||
114            event_type == "pointerenter" ||
115            event_type == "pointerout" ||
116            event_type == "pointerleave"
117        {
118            -1
119        } else {
120            0
121        };
122
123        // Buttons: 1 if a button is pressed during the event, 0 otherwise
124        // For touch: button is pressed during over/enter/down/move, not during up/cancel/out/leave
125        let buttons = if event_type == "pointermove" ||
126            event_type == "pointerover" ||
127            event_type == "pointerenter" ||
128            event_type == "pointerdown"
129        {
130            1
131        } else {
132            0
133        };
134
135        // For enter/leave events, they don't bubble and are not cancelable
136        let (bubbles, cancelable) = match event_type {
137            "pointerenter" | "pointerleave" => {
138                (EventBubbles::DoesNotBubble, EventCancelable::NotCancelable)
139            },
140            _ => (EventBubbles::Bubbles, EventCancelable::from(is_cancelable)),
141        };
142
143        let pointer_event = PointerEvent::new(
144            cx,
145            window,
146            event_type.into(),
147            bubbles,
148            cancelable,
149            Some(window),
150            0, // detail
151            Point2D::new(*self.ScreenX() as i32, *self.ScreenY() as i32),
152            Point2D::new(*self.ClientX() as i32, *self.ClientY() as i32),
153            Point2D::new(*self.PageX() as i32, *self.PageY() as i32),
154            modifiers,
155            button,
156            buttons,
157            None, // related_target
158            point_in_node,
159            pointer_id,
160            1, // width (TODO: could get from touch if available)
161            1, // height (TODO: could get from touch if available)
162            pressure,
163            0.0,      // tangential_pressure
164            0,        // tilt_x
165            0,        // tilt_y
166            0,        // twist
167            PI / 2.0, // altitude_angle (perpendicular to surface)
168            0.0,      // azimuth_angle
169            pointer_type.into(),
170            is_primary,
171            vec![], // coalesced_events
172            vec![], // predicted_events
173        );
174
175        // https://w3c.github.io/pointerevents/#dfn-attributes-and-default-actions
176        // For pointerenter and pointerleave events, the composed [DOM] attribute SHOULD be false;
177        // for all other pointer events in the table above, the attribute SHOULD be true.
178        let composed = !matches!(event_type, "pointerenter" | "pointerleave");
179        pointer_event.upcast::<Event>().set_composed(composed);
180
181        pointer_event
182    }
183}
184
185impl TouchMethods<crate::DomTypeHolder> for Touch {
186    /// <https://w3c.github.io/touch-events/#widl-Touch-identifier>
187    fn Identifier(&self) -> i32 {
188        self.identifier
189    }
190
191    /// <https://w3c.github.io/touch-events/#widl-Touch-target>
192    fn Target(&self) -> DomRoot<EventTarget> {
193        self.target.get()
194    }
195
196    /// <https://w3c.github.io/touch-events/#widl-Touch-screenX>
197    fn ScreenX(&self) -> Finite<f64> {
198        Finite::wrap(self.screen_x)
199    }
200
201    /// <https://w3c.github.io/touch-events/#widl-Touch-screenY>
202    fn ScreenY(&self) -> Finite<f64> {
203        Finite::wrap(self.screen_y)
204    }
205
206    /// <https://w3c.github.io/touch-events/#widl-Touch-clientX>
207    fn ClientX(&self) -> Finite<f64> {
208        Finite::wrap(self.client_x)
209    }
210
211    /// <https://w3c.github.io/touch-events/#widl-Touch-clientY>
212    fn ClientY(&self) -> Finite<f64> {
213        Finite::wrap(self.client_y)
214    }
215
216    /// <https://w3c.github.io/touch-events/#widl-Touch-clientX>
217    fn PageX(&self) -> Finite<f64> {
218        Finite::wrap(self.page_x)
219    }
220
221    /// <https://w3c.github.io/touch-events/#widl-Touch-clientY>
222    fn PageY(&self) -> Finite<f64> {
223        Finite::wrap(self.page_y)
224    }
225}
script/dom/touch/touch.rs

script/dom/touch/
touch.rs
