From c2ec4943369e4837fea8402e042b2ef9ff8bb136 Mon Sep 17 00:00:00 2001 From: John Nunley <dev@notgull.net> Date: Wed, 1 Nov 2023 22:26:10 -0700 Subject: [PATCH] feat: Enable creating an X11 display without connection For pure-Rust connections, there is no XCB connection that can be passed into the display constructor. Thus, this PR enables the display to be created without needing an XCB or Xlib handle, by providing `None` in the constructor. cc rust-windowing/raw-window-handle#120 Signed-off-by: John Nunley <dev@notgull.net> --- examples/libxcb.rs | 8 ++++++-- src/x11.rs | 45 +++++++++++++++++++++++---------------------- 2 files changed, 29 insertions(+), 24 deletions(-) diff --git a/examples/libxcb.rs b/examples/libxcb.rs index 88ef5f2..53efc5d 100644 --- a/examples/libxcb.rs +++ b/examples/libxcb.rs @@ -6,7 +6,7 @@ mod example { DisplayHandle, RawDisplayHandle, RawWindowHandle, WindowHandle, XcbDisplayHandle, XcbWindowHandle, }; - use std::{num::NonZeroU32, ptr::NonNull}; + use std::{env, num::NonZeroU32, ptr::NonNull}; use x11rb::{ connection::Connection, protocol::{ @@ -24,7 +24,11 @@ mod example { // x11rb doesn't use raw-window-handle yet, so just create our own. let display_handle = XcbDisplayHandle::new( - NonNull::new(conn.get_raw_xcb_connection() as *mut _), + if env::var_os("SOFTBUFFER_NO_DISPLAY").is_some() { + None + } else { + NonNull::new(conn.get_raw_xcb_connection() as *mut _) + }, screen as _, ); diff --git a/src/x11.rs b/src/x11.rs index 0711d34..d3d399a 100644 --- a/src/x11.rs +++ b/src/x11.rs @@ -61,37 +61,38 @@ impl<D: HasDisplayHandle + ?Sized> X11DisplayImpl<D> { RawDisplayHandle::Xcb(xcb_handle) => xcb_handle, RawDisplayHandle::Xlib(xlib) => { // Convert to an XCB handle. - let display = match xlib.display { - Some(display) => display, - None => return Err(SoftBufferError::IncompleteDisplayHandle.into()), - }; - - // Get the underlying XCB connection. - // SAFETY: The user has asserted that the display handle is valid. - let connection = unsafe { - let display = tiny_xlib::Display::from_ptr(display.as_ptr()); - NonNull::new_unchecked(display.as_raw_xcb_connection()) - }; + let connection = xlib.display.map(|display| { + // Get the underlying XCB connection. + // SAFETY: The user has asserted that the display handle is valid. + unsafe { + let display = tiny_xlib::Display::from_ptr(display.as_ptr()); + NonNull::new_unchecked(display.as_raw_xcb_connection()).cast() + } + }); // Construct the equivalent XCB display and window handles. - XcbDisplayHandle::new(Some(connection.cast()), xlib.screen) + XcbDisplayHandle::new(connection, xlib.screen) } _ => return Err(InitError::Unsupported(display)), }; // Validate the display handle to ensure we can use it. let connection = match xcb_handle.connection { - Some(conn) => conn, - None => return Err(SoftBufferError::IncompleteDisplayHandle.into()), - }; + Some(connection) => { + // Wrap the display handle in an x11rb connection. + // SAFETY: We don't own the connection, so don't drop it. We also assert that the connection is valid. + let result = + unsafe { XCBConnection::from_raw_xcb_connection(connection.as_ptr(), false) }; - // Wrap the display handle in an x11rb connection. - // SAFETY: We don't own the connection, so don't drop it. We also assert that the connection is valid. - let connection = { - let result = - unsafe { XCBConnection::from_raw_xcb_connection(connection.as_ptr(), false) }; - - result.swbuf_err("Failed to wrap XCB connection")? + result.swbuf_err("Failed to wrap XCB connection")? + } + None => { + // The user didn't provide an XCB connection, so create our own. + log::info!("no XCB connection provided by the user, so spawning our own"); + XCBConnection::connect(None) + .swbuf_err("Failed to spawn XCB connection")? + .0 + } }; let is_shm_available = is_shm_available(&connection);