From bc0c1c472bdffaa636ad8d436f2fbc390861d9ea Mon Sep 17 00:00:00 2001 From: Schmarni Date: Sat, 30 Nov 2024 01:16:17 +0100 Subject: [PATCH] make OxrEvent less unsound Signed-off-by: Schmarni --- .../src/openxr/features/overlay.rs | 3 ++- crates/bevy_openxr/src/openxr/init.rs | 5 ++-- crates/bevy_openxr/src/openxr/mod.rs | 4 ++-- crates/bevy_openxr/src/openxr/poll_events.rs | 24 ++++++++++++------- 4 files changed, 22 insertions(+), 14 deletions(-) diff --git a/crates/bevy_openxr/src/openxr/features/overlay.rs b/crates/bevy_openxr/src/openxr/features/overlay.rs index 3d5ea63..dfca5d3 100644 --- a/crates/bevy_openxr/src/openxr/features/overlay.rs +++ b/crates/bevy_openxr/src/openxr/features/overlay.rs @@ -26,7 +26,8 @@ impl Plugin for OxrOverlayPlugin { } fn handle_overlay_event(event: In, mut writer: EventWriter) { - if let Event::MainSessionVisibilityChangedEXTX(event) = unsafe { event.get() } { + // this unwrap will never panic since we are in a valid scope + if let Event::MainSessionVisibilityChangedEXTX(event) = unsafe { event.get() }.unwrap() { writer.send(OxrOverlaySessionEvent::MainSessionVisibilityChanged { visible: event.visible(), flags: event.flags(), diff --git a/crates/bevy_openxr/src/openxr/init.rs b/crates/bevy_openxr/src/openxr/init.rs index e0a8912..5567746 100644 --- a/crates/bevy_openxr/src/openxr/init.rs +++ b/crates/bevy_openxr/src/openxr/init.rs @@ -18,10 +18,8 @@ use bevy::winit::UpdateMode; use bevy::winit::WinitSettings; use bevy_mod_xr::session::*; use openxr::Event; -use openxr::EventDataBuffer; use crate::error::OxrError; -use crate::features::overlay::OxrOverlaySessionEvent; use crate::graphics::*; use crate::resources::*; use crate::session::OxrSession; @@ -287,7 +285,8 @@ pub fn handle_events( mut interaction_profile_changed_event: EventWriter, ) { use openxr::Event::*; - match unsafe { event.get() } { + // this unwrap will never panic since we are in a valid scope + match unsafe { event.get() }.unwrap() { SessionStateChanged(state) => { use openxr::SessionState; diff --git a/crates/bevy_openxr/src/openxr/mod.rs b/crates/bevy_openxr/src/openxr/mod.rs index a9f225e..85c5c81 100644 --- a/crates/bevy_openxr/src/openxr/mod.rs +++ b/crates/bevy_openxr/src/openxr/mod.rs @@ -9,7 +9,7 @@ use bevy::{ use bevy_mod_xr::session::XrSessionPlugin; use bevy_mod_xr::{camera::XrCameraPlugin, session::XrState}; use init::OxrInitPlugin; -use poll_events::{OxrEventHandlers, OxrEventsPlugin}; +use poll_events::OxrEventsPlugin; use render::OxrRenderPlugin; use resources::OxrInstance; use session::OxrSession; @@ -30,13 +30,13 @@ pub mod helper_traits; pub mod init; pub mod layer_builder; pub mod next_chain; +pub mod poll_events; pub mod reference_space; pub mod render; pub mod resources; pub mod session; pub mod spaces; pub mod types; -pub mod poll_events; /// A [`Condition`](bevy::ecs::schedule::Condition) system that says if the OpenXR session is available. pub fn openxr_session_available( diff --git a/crates/bevy_openxr/src/openxr/poll_events.rs b/crates/bevy_openxr/src/openxr/poll_events.rs index 029bd6b..4b4d696 100644 --- a/crates/bevy_openxr/src/openxr/poll_events.rs +++ b/crates/bevy_openxr/src/openxr/poll_events.rs @@ -1,4 +1,4 @@ -use std::mem; +use std::{cell::RefCell, mem, ops::Deref, rc::Rc}; use bevy::{ecs::system::SystemId, prelude::*}; use bevy_mod_xr::session::{XrFirst, XrHandleEvents}; @@ -27,11 +27,15 @@ pub fn poll_events(world: &mut World) { .poll_event(&mut buffer) .expect("Failed to poll event") { + let event = Rc::new(RefCell::new(Some(event))); for handler in handlers.handlers.iter() { - if let Err(err) = world.run_system_with_input::<_, ()>(*handler, OxrEvent::new(event)) { + if let Err(err) = + world.run_system_with_input::<_, ()>(*handler, OxrEvent::new(event.clone())) + { error!("error when running oxr event handler: {err}"); }; } + event.deref().take(); } world.insert_resource(handlers); } @@ -44,21 +48,22 @@ pub struct OxrEventHandlers { pub type OxrEventHandler = SystemId; pub struct OxrEvent { - event: Event<'static>, + event: Rc>>>, } impl OxrEvent { - pub(crate) fn new<'a>(event: Event<'a>) -> Self { + pub(crate) fn new<'a>(event: Rc>>>) -> Self { Self { - event: unsafe { mem::transmute::, Event<'static>>(event) }, + event: unsafe { mem::transmute(event) }, } } + /// always returns [Some] if called in a valid scope /// # Safety /// The event is only valid for the duration of the poll event callback, /// don't Store the [Event] anywhere!! #[allow(clippy::needless_lifetimes)] - pub unsafe fn get<'a>(&'a self) -> Event<'a> { - self.event + pub unsafe fn get<'a>(&'a self) -> Option> { + self.event.borrow().clone() } } pub trait OxrEventHandlerExt { @@ -68,7 +73,10 @@ pub trait OxrEventHandlerExt { ) -> &mut Self; } impl OxrEventHandlerExt for App { - fn add_oxr_event_handler(&mut self, system: impl IntoSystem + 'static) -> &mut Self { + fn add_oxr_event_handler( + &mut self, + system: impl IntoSystem + 'static, + ) -> &mut Self { self.init_resource::(); let id = self.register_system(system); self.world_mut()