script/dom/webxr/
xrtest.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
5/* This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
8
9use std::rc::Rc;
10
11use dom_struct::dom_struct;
12use ipc_channel::ipc::IpcSender;
13use ipc_channel::router::ROUTER;
14use js::jsval::JSVal;
15use profile_traits::ipc;
16use webxr_api::{self, Error as XRError, MockDeviceInit, MockDeviceMsg};
17
18use crate::dom::bindings::callback::ExceptionHandling;
19use crate::dom::bindings::cell::DomRefCell;
20use crate::dom::bindings::codegen::Bindings::FunctionBinding::Function;
21use crate::dom::bindings::codegen::Bindings::XRSystemBinding::XRSessionMode;
22use crate::dom::bindings::codegen::Bindings::XRTestBinding::{FakeXRDeviceInit, XRTestMethods};
23use crate::dom::bindings::refcounted::{Trusted, TrustedPromise};
24use crate::dom::bindings::reflector::{DomGlobal, Reflector, reflect_dom_object};
25use crate::dom::bindings::root::{Dom, DomRoot};
26use crate::dom::fakexrdevice::{FakeXRDevice, get_origin, get_views, get_world};
27use crate::dom::globalscope::GlobalScope;
28use crate::dom::promise::Promise;
29use crate::script_runtime::CanGc;
30use crate::script_thread::ScriptThread;
31
32#[dom_struct]
33pub(crate) struct XRTest {
34    reflector: Reflector,
35    devices_connected: DomRefCell<Vec<Dom<FakeXRDevice>>>,
36}
37
38impl XRTest {
39    pub(crate) fn new_inherited() -> XRTest {
40        XRTest {
41            reflector: Reflector::new(),
42            devices_connected: DomRefCell::new(vec![]),
43        }
44    }
45
46    pub(crate) fn new(global: &GlobalScope, can_gc: CanGc) -> DomRoot<XRTest> {
47        reflect_dom_object(Box::new(XRTest::new_inherited()), global, can_gc)
48    }
49
50    fn device_obtained(
51        &self,
52        response: Result<IpcSender<MockDeviceMsg>, XRError>,
53        trusted: TrustedPromise,
54        can_gc: CanGc,
55    ) {
56        let promise = trusted.root();
57        if let Ok(sender) = response {
58            let device = FakeXRDevice::new(&self.global(), sender, CanGc::note());
59            self.devices_connected
60                .borrow_mut()
61                .push(Dom::from_ref(&device));
62            promise.resolve_native(&device, can_gc);
63        } else {
64            promise.reject_native(&(), can_gc);
65        }
66    }
67}
68
69impl XRTestMethods<crate::DomTypeHolder> for XRTest {
70    /// <https://github.com/immersive-web/webxr-test-api/blob/master/explainer.md>
71    #[allow(unsafe_code)]
72    fn SimulateDeviceConnection(&self, init: &FakeXRDeviceInit, can_gc: CanGc) -> Rc<Promise> {
73        let global = self.global();
74        let p = Promise::new(&global, can_gc);
75
76        let origin = if let Some(ref o) = init.viewerOrigin {
77            match get_origin(o) {
78                Ok(origin) => Some(origin),
79                Err(e) => {
80                    p.reject_error(e, can_gc);
81                    return p;
82                },
83            }
84        } else {
85            None
86        };
87
88        let floor_origin = if let Some(ref o) = init.floorOrigin {
89            match get_origin(o) {
90                Ok(origin) => Some(origin),
91                Err(e) => {
92                    p.reject_error(e, can_gc);
93                    return p;
94                },
95            }
96        } else {
97            None
98        };
99
100        let views = match get_views(&init.views) {
101            Ok(views) => views,
102            Err(e) => {
103                p.reject_error(e, can_gc);
104                return p;
105            },
106        };
107
108        let supported_features = if let Some(ref s) = init.supportedFeatures {
109            s.iter().cloned().map(String::from).collect()
110        } else {
111            vec![]
112        };
113
114        let world = if let Some(ref w) = init.world {
115            let w = match get_world(w) {
116                Ok(w) => w,
117                Err(e) => {
118                    p.reject_error(e, can_gc);
119                    return p;
120                },
121            };
122            Some(w)
123        } else {
124            None
125        };
126
127        let (mut supports_inline, mut supports_vr, mut supports_ar) = (false, false, false);
128
129        if let Some(ref modes) = init.supportedModes {
130            for mode in modes {
131                match mode {
132                    XRSessionMode::Immersive_vr => supports_vr = true,
133                    XRSessionMode::Immersive_ar => supports_ar = true,
134                    XRSessionMode::Inline => supports_inline = true,
135                }
136            }
137        }
138
139        let init = MockDeviceInit {
140            viewer_origin: origin,
141            views,
142            supports_inline,
143            supports_vr,
144            supports_ar,
145            floor_origin,
146            supported_features,
147            world,
148        };
149
150        let global = self.global();
151        let this = Trusted::new(self);
152        let mut trusted = Some(TrustedPromise::new(p.clone()));
153
154        let task_source = global
155            .task_manager()
156            .dom_manipulation_task_source()
157            .to_sendable();
158        let (sender, receiver) = ipc::channel(global.time_profiler_chan().clone()).unwrap();
159
160        ROUTER.add_typed_route(
161            receiver.to_ipc_receiver(),
162            Box::new(move |message| {
163                let trusted = trusted
164                    .take()
165                    .expect("SimulateDeviceConnection callback called twice");
166                let this = this.clone();
167                let message =
168                    message.expect("SimulateDeviceConnection callback given incorrect payload");
169
170                task_source.queue(task!(request_session: move || {
171                    this.root().device_obtained(message, trusted, CanGc::note());
172                }));
173            }),
174        );
175        if let Some(mut r) = global.as_window().webxr_registry() {
176            r.simulate_device_connection(init, sender);
177        }
178
179        p
180    }
181
182    /// <https://github.com/immersive-web/webxr-test-api/blob/master/explainer.md>
183    fn SimulateUserActivation(&self, f: Rc<Function>, can_gc: CanGc) {
184        ScriptThread::set_user_interacting(true);
185        rooted!(in(*GlobalScope::get_cx()) let mut value: JSVal);
186        let _ = f.Call__(
187            vec![],
188            value.handle_mut(),
189            ExceptionHandling::Rethrow,
190            can_gc,
191        );
192        ScriptThread::set_user_interacting(false);
193    }
194
195    /// <https://github.com/immersive-web/webxr-test-api/blob/master/explainer.md>
196    fn DisconnectAllDevices(&self, can_gc: CanGc) -> Rc<Promise> {
197        // XXXManishearth implement device disconnection and session ending
198        let global = self.global();
199        let p = Promise::new(&global, can_gc);
200        let mut devices = self.devices_connected.borrow_mut();
201        if devices.is_empty() {
202            p.resolve_native(&(), can_gc);
203        } else {
204            let mut len = devices.len();
205
206            let (sender, receiver) = ipc::channel(global.time_profiler_chan().clone()).unwrap();
207            let mut rooted_devices: Vec<_> =
208                devices.iter().map(|x| DomRoot::from_ref(&**x)).collect();
209            devices.clear();
210
211            let mut trusted = Some(TrustedPromise::new(p.clone()));
212            let task_source = global
213                .task_manager()
214                .dom_manipulation_task_source()
215                .to_sendable();
216
217            ROUTER.add_typed_route(
218                receiver.to_ipc_receiver(),
219                Box::new(move |_| {
220                    len -= 1;
221                    if len == 0 {
222                        let trusted = trusted
223                            .take()
224                            .expect("DisconnectAllDevices disconnected more devices than expected");
225                        task_source.queue(trusted.resolve_task(()));
226                    }
227                }),
228            );
229
230            for device in rooted_devices.drain(..) {
231                device.disconnect(sender.clone());
232            }
233        };
234        p
235    }
236}
script/dom/webxr/xrtest.rs

script/dom/webxr/
xrtest.rs
