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 js::context::JSContext;
13use js::jsval::JSVal;
14use profile_traits::generic_callback::GenericCallback as ProfileGenericCallback;
15use script_bindings::cell::DomRefCell;
16use script_bindings::reflector::{Reflector, reflect_dom_object};
17use servo_base::generic_channel::GenericSender;
18use webxr_api::{self, Error as XRError, MockDeviceInit, MockDeviceMsg};
19
20use crate::ScriptThread;
21use crate::dom::bindings::callback::ExceptionHandling;
22use crate::dom::bindings::codegen::Bindings::FunctionBinding::Function;
23use crate::dom::bindings::codegen::Bindings::XRSystemBinding::XRSessionMode;
24use crate::dom::bindings::codegen::Bindings::XRTestBinding::{FakeXRDeviceInit, XRTestMethods};
25use crate::dom::bindings::refcounted::{Trusted, TrustedPromise};
26use crate::dom::bindings::reflector::DomGlobal;
27use crate::dom::bindings::root::{Dom, DomRoot};
28use crate::dom::fakexrdevice::{FakeXRDevice, get_origin, get_views, get_world};
29use crate::dom::globalscope::GlobalScope;
30use crate::dom::promise::Promise;
31use crate::script_runtime::CanGc;
32
33#[dom_struct]
34pub(crate) struct XRTest {
35    reflector: Reflector,
36    devices_connected: DomRefCell<Vec<Dom<FakeXRDevice>>>,
37}
38
39impl XRTest {
40    pub(crate) fn new_inherited() -> XRTest {
41        XRTest {
42            reflector: Reflector::new(),
43            devices_connected: DomRefCell::new(vec![]),
44        }
45    }
46
47    pub(crate) fn new(global: &GlobalScope, can_gc: CanGc) -> DomRoot<XRTest> {
48        reflect_dom_object(Box::new(XRTest::new_inherited()), global, can_gc)
49    }
50
51    fn device_obtained(
52        &self,
53        response: Result<GenericSender<MockDeviceMsg>, XRError>,
54        trusted: TrustedPromise,
55        can_gc: CanGc,
56    ) {
57        let promise = trusted.root();
58        if let Ok(sender) = response {
59            let device = FakeXRDevice::new(&self.global(), sender, CanGc::deprecated_note());
60            self.devices_connected
61                .borrow_mut()
62                .push(Dom::from_ref(&device));
63            promise.resolve_native(&device, can_gc);
64        } else {
65            promise.reject_native(&(), can_gc);
66        }
67    }
68}
69
70impl XRTestMethods<crate::DomTypeHolder> for XRTest {
71    /// <https://github.com/immersive-web/webxr-test-api/blob/master/explainer.md>
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
159        let callback =
160            ProfileGenericCallback::new(global.time_profiler_chan().clone(), move |message| {
161                let trusted = trusted
162                    .take()
163                    .expect("SimulateDeviceConnection callback called twice");
164                let this = this.clone();
165                let message =
166                    message.expect("SimulateDeviceConnection callback given incorrect payload");
167
168                task_source.queue(task!(request_session: move || {
169                    this.root().device_obtained(message, trusted, CanGc::deprecated_note());
170                }));
171            })
172            .expect("Could not create callback");
173        if let Some(mut r) = global.as_window().webxr_registry() {
174            r.simulate_device_connection(init, callback);
175        }
176
177        p
178    }
179
180    /// <https://github.com/immersive-web/webxr-test-api/blob/master/explainer.md>
181    fn SimulateUserActivation(&self, cx: &mut JSContext, f: Rc<Function>) {
182        let _guard = ScriptThread::user_interacting_guard();
183        rooted!(&in(cx) let mut value: JSVal);
184        let _ = f.Call__(cx, vec![], value.handle_mut(), ExceptionHandling::Rethrow);
185    }
186
187    /// <https://github.com/immersive-web/webxr-test-api/blob/master/explainer.md>
188    fn DisconnectAllDevices(&self, can_gc: CanGc) -> Rc<Promise> {
189        // XXXManishearth implement device disconnection and session ending
190        let global = self.global();
191        let p = Promise::new(&global, can_gc);
192        let mut devices = self.devices_connected.borrow_mut();
193        if devices.is_empty() {
194            p.resolve_native(&(), can_gc);
195        } else {
196            let mut len = devices.len();
197
198            let rooted_devices: Vec<_> = devices.iter().map(|x| DomRoot::from_ref(&**x)).collect();
199            devices.clear();
200
201            let mut trusted = Some(TrustedPromise::new(p.clone()));
202            let task_source = global
203                .task_manager()
204                .dom_manipulation_task_source()
205                .to_sendable();
206
207            let callback =
208                ProfileGenericCallback::new(global.time_profiler_chan().clone(), move |_| {
209                    len -= 1;
210                    if len == 0 {
211                        let trusted = trusted
212                            .take()
213                            .expect("DisconnectAllDevices disconnected more devices than expected");
214                        task_source.queue(trusted.resolve_task(()));
215                    }
216                })
217                .expect("Could not create callback");
218
219            for device in rooted_devices {
220                device.disconnect(callback.clone());
221            }
222        };
223        p
224    }
225}
script/dom/webxr/xrtest.rs

script/dom/webxr/
xrtest.rs
