#![cfg(any( target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd", target_os = "openbsd" ))] #[cfg(all(not(feature = "x11"), not(feature = "wayland")))] compile_error!("Please select a feature to build for unix: `x11`, `wayland`"); #[cfg(feature = "wayland")] use std::error::Error; use std::{collections::VecDeque, env, fmt}; #[cfg(feature = "x11")] use std::{ffi::CStr, mem::MaybeUninit, os::raw::*, sync::Arc}; #[cfg(feature = "x11")] use parking_lot::Mutex; use raw_window_handle::RawWindowHandle; #[cfg(feature = "x11")] pub use self::x11::XNotSupported; #[cfg(feature = "x11")] use self::x11::{ffi::XVisualInfo, util::WindowType as XWindowType, XConnection, XError}; use crate::{ dpi::{PhysicalPosition, PhysicalSize, Position, Size}, error::{ExternalError, NotSupportedError, OsError as RootOsError}, event::Event, event_loop::{ControlFlow, EventLoopClosed, EventLoopWindowTarget as RootELW}, icon::Icon, monitor::{MonitorHandle as RootMonitorHandle, VideoMode as RootVideoMode}, window::{CursorIcon, Fullscreen, UserAttentionType, WindowAttributes}, }; pub(crate) use crate::icon::RgbaIcon as PlatformIcon; #[cfg(feature = "wayland")] pub mod wayland; #[cfg(feature = "x11")] pub mod x11; /// Environment variable specifying which backend should be used on unix platform. /// /// Legal values are x11 and wayland. If this variable is set only the named backend /// will be tried by winit. If it is not set, winit will try to connect to a wayland connection, /// and if it fails will fallback on x11. /// /// If this variable is set with any other value, winit will panic. const BACKEND_PREFERENCE_ENV_VAR: &str = "WINIT_UNIX_BACKEND"; #[derive(Clone)] pub struct PlatformSpecificWindowBuilderAttributes { #[cfg(feature = "x11")] pub visual_infos: Option, #[cfg(feature = "x11")] pub screen_id: Option, #[cfg(feature = "x11")] pub resize_increments: Option, #[cfg(feature = "x11")] pub base_size: Option, #[cfg(feature = "x11")] pub class: Option<(String, String)>, #[cfg(feature = "x11")] pub override_redirect: bool, #[cfg(feature = "x11")] pub x11_window_types: Vec, #[cfg(feature = "x11")] pub gtk_theme_variant: Option, #[cfg(feature = "wayland")] pub app_id: Option, } impl Default for PlatformSpecificWindowBuilderAttributes { fn default() -> Self { Self { #[cfg(feature = "x11")] visual_infos: None, #[cfg(feature = "x11")] screen_id: None, #[cfg(feature = "x11")] resize_increments: None, #[cfg(feature = "x11")] base_size: None, #[cfg(feature = "x11")] class: None, #[cfg(feature = "x11")] override_redirect: false, #[cfg(feature = "x11")] x11_window_types: vec![XWindowType::Normal], #[cfg(feature = "x11")] gtk_theme_variant: None, #[cfg(feature = "wayland")] app_id: None, } } } #[cfg(feature = "x11")] lazy_static! { pub static ref X11_BACKEND: Mutex, XNotSupported>> = Mutex::new(XConnection::new(Some(x_error_callback)).map(Arc::new)); } #[derive(Debug, Clone)] pub enum OsError { #[cfg(feature = "x11")] XError(XError), #[cfg(feature = "x11")] XMisc(&'static str), #[cfg(feature = "wayland")] WaylandMisc(&'static str), } impl fmt::Display for OsError { fn fmt(&self, _f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> { match *self { #[cfg(feature = "x11")] OsError::XError(ref e) => _f.pad(&e.description), #[cfg(feature = "x11")] OsError::XMisc(ref e) => _f.pad(e), #[cfg(feature = "wayland")] OsError::WaylandMisc(ref e) => _f.pad(e), } } } pub enum Window { #[cfg(feature = "x11")] X(x11::Window), #[cfg(feature = "wayland")] Wayland(wayland::Window), } #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)] pub enum WindowId { #[cfg(feature = "x11")] X(x11::WindowId), #[cfg(feature = "wayland")] Wayland(wayland::WindowId), } impl WindowId { pub unsafe fn dummy() -> Self { #[cfg(feature = "wayland")] return WindowId::Wayland(wayland::WindowId::dummy()); #[cfg(all(not(feature = "wayland"), feature = "x11"))] return WindowId::X(x11::WindowId::dummy()); } } #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)] pub enum DeviceId { #[cfg(feature = "x11")] X(x11::DeviceId), #[cfg(feature = "wayland")] Wayland(wayland::DeviceId), } impl DeviceId { pub unsafe fn dummy() -> Self { #[cfg(feature = "wayland")] return DeviceId::Wayland(wayland::DeviceId::dummy()); #[cfg(all(not(feature = "wayland"), feature = "x11"))] return DeviceId::X(x11::DeviceId::dummy()); } } #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)] pub enum MonitorHandle { #[cfg(feature = "x11")] X(x11::MonitorHandle), #[cfg(feature = "wayland")] Wayland(wayland::MonitorHandle), } /// `x11_or_wayland!(match expr; Enum(foo) => foo.something())` /// expands to the equivalent of /// ```ignore /// match self { /// Enum::X(foo) => foo.something(), /// Enum::Wayland(foo) => foo.something(), /// } /// ``` /// The result can be converted to another enum by adding `; as AnotherEnum` macro_rules! x11_or_wayland { (match $what:expr; $enum:ident ( $($c1:tt)* ) => $x:expr; as $enum2:ident ) => { match $what { #[cfg(feature = "x11")] $enum::X($($c1)*) => $enum2::X($x), #[cfg(feature = "wayland")] $enum::Wayland($($c1)*) => $enum2::Wayland($x), } }; (match $what:expr; $enum:ident ( $($c1:tt)* ) => $x:expr) => { match $what { #[cfg(feature = "x11")] $enum::X($($c1)*) => $x, #[cfg(feature = "wayland")] $enum::Wayland($($c1)*) => $x, } }; } impl MonitorHandle { #[inline] pub fn name(&self) -> Option { x11_or_wayland!(match self; MonitorHandle(m) => m.name()) } #[inline] pub fn native_identifier(&self) -> u32 { x11_or_wayland!(match self; MonitorHandle(m) => m.native_identifier()) } #[inline] pub fn size(&self) -> PhysicalSize { x11_or_wayland!(match self; MonitorHandle(m) => m.size()) } #[inline] pub fn position(&self) -> PhysicalPosition { x11_or_wayland!(match self; MonitorHandle(m) => m.position()) } #[inline] pub fn scale_factor(&self) -> f64 { x11_or_wayland!(match self; MonitorHandle(m) => m.scale_factor() as f64) } #[inline] pub fn video_modes(&self) -> Box> { x11_or_wayland!(match self; MonitorHandle(m) => Box::new(m.video_modes())) } } #[derive(Debug, Clone, PartialEq, Eq, Hash)] pub enum VideoMode { #[cfg(feature = "x11")] X(x11::VideoMode), #[cfg(feature = "wayland")] Wayland(wayland::VideoMode), } impl VideoMode { #[inline] pub fn size(&self) -> PhysicalSize { x11_or_wayland!(match self; VideoMode(m) => m.size()) } #[inline] pub fn bit_depth(&self) -> u16 { x11_or_wayland!(match self; VideoMode(m) => m.bit_depth()) } #[inline] pub fn refresh_rate(&self) -> u16 { x11_or_wayland!(match self; VideoMode(m) => m.refresh_rate()) } #[inline] pub fn monitor(&self) -> RootMonitorHandle { x11_or_wayland!(match self; VideoMode(m) => m.monitor()) } } impl Window { #[inline] pub fn new( window_target: &EventLoopWindowTarget, attribs: WindowAttributes, pl_attribs: PlatformSpecificWindowBuilderAttributes, ) -> Result { match *window_target { #[cfg(feature = "wayland")] EventLoopWindowTarget::Wayland(ref window_target) => { wayland::Window::new(window_target, attribs, pl_attribs).map(Window::Wayland) } #[cfg(feature = "x11")] EventLoopWindowTarget::X(ref window_target) => { x11::Window::new(window_target, attribs, pl_attribs).map(Window::X) } } } #[inline] pub fn id(&self) -> WindowId { x11_or_wayland!(match self; Window(w) => w.id(); as WindowId) } #[inline] pub fn set_title(&self, title: &str) { x11_or_wayland!(match self; Window(w) => w.set_title(title)); } #[inline] pub fn set_visible(&self, visible: bool) { x11_or_wayland!(match self; Window(w) => w.set_visible(visible)) } #[inline] pub fn outer_position(&self) -> Result, NotSupportedError> { x11_or_wayland!(match self; Window(w) => w.outer_position()) } #[inline] pub fn inner_position(&self) -> Result, NotSupportedError> { x11_or_wayland!(match self; Window(w) => w.inner_position()) } #[inline] pub fn set_outer_position(&self, position: Position) { x11_or_wayland!(match self; Window(w) => w.set_outer_position(position)) } #[inline] pub fn inner_size(&self) -> PhysicalSize { x11_or_wayland!(match self; Window(w) => w.inner_size()) } #[inline] pub fn outer_size(&self) -> PhysicalSize { x11_or_wayland!(match self; Window(w) => w.outer_size()) } #[inline] pub fn set_inner_size(&self, size: Size) { x11_or_wayland!(match self; Window(w) => w.set_inner_size(size)) } #[inline] pub fn set_min_inner_size(&self, dimensions: Option) { x11_or_wayland!(match self; Window(w) => w.set_min_inner_size(dimensions)) } #[inline] pub fn set_max_inner_size(&self, dimensions: Option) { x11_or_wayland!(match self; Window(w) => w.set_max_inner_size(dimensions)) } #[inline] pub fn set_resizable(&self, resizable: bool) { x11_or_wayland!(match self; Window(w) => w.set_resizable(resizable)) } #[inline] pub fn set_cursor_icon(&self, cursor: CursorIcon) { x11_or_wayland!(match self; Window(w) => w.set_cursor_icon(cursor)) } #[inline] pub fn set_cursor_grab(&self, grab: bool) -> Result<(), ExternalError> { x11_or_wayland!(match self; Window(window) => window.set_cursor_grab(grab)) } #[inline] pub fn set_cursor_visible(&self, visible: bool) { x11_or_wayland!(match self; Window(window) => window.set_cursor_visible(visible)) } #[inline] pub fn drag_window(&self) -> Result<(), ExternalError> { x11_or_wayland!(match self; Window(window) => window.drag_window()) } #[inline] pub fn scale_factor(&self) -> f64 { x11_or_wayland!(match self; Window(w) => w.scale_factor() as f64) } #[inline] pub fn set_cursor_position(&self, position: Position) -> Result<(), ExternalError> { x11_or_wayland!(match self; Window(w) => w.set_cursor_position(position)) } #[inline] pub fn set_maximized(&self, maximized: bool) { x11_or_wayland!(match self; Window(w) => w.set_maximized(maximized)) } #[inline] pub fn is_maximized(&self) -> bool { x11_or_wayland!(match self; Window(w) => w.is_maximized()) } #[inline] pub fn set_minimized(&self, minimized: bool) { x11_or_wayland!(match self; Window(w) => w.set_minimized(minimized)) } #[inline] pub fn fullscreen(&self) -> Option { x11_or_wayland!(match self; Window(w) => w.fullscreen()) } #[inline] pub fn set_fullscreen(&self, monitor: Option) { x11_or_wayland!(match self; Window(w) => w.set_fullscreen(monitor)) } #[inline] pub fn set_decorations(&self, decorations: bool) { x11_or_wayland!(match self; Window(w) => w.set_decorations(decorations)) } #[inline] pub fn set_always_on_top(&self, _always_on_top: bool) { match self { #[cfg(feature = "x11")] &Window::X(ref w) => w.set_always_on_top(_always_on_top), #[cfg(feature = "wayland")] _ => (), } } #[inline] pub fn set_window_icon(&self, _window_icon: Option) { match self { #[cfg(feature = "x11")] &Window::X(ref w) => w.set_window_icon(_window_icon), #[cfg(feature = "wayland")] _ => (), } } #[inline] pub fn set_ime_position(&self, position: Position) { x11_or_wayland!(match self; Window(w) => w.set_ime_position(position)) } #[inline] pub fn focus_window(&self) { match self { #[cfg(feature = "x11")] &Window::X(ref w) => w.focus_window(), #[cfg(feature = "wayland")] _ => (), } } pub fn request_user_attention(&self, _request_type: Option) { match self { #[cfg(feature = "x11")] &Window::X(ref w) => w.request_user_attention(_request_type), #[cfg(feature = "wayland")] _ => (), } } #[inline] pub fn request_redraw(&self) { x11_or_wayland!(match self; Window(w) => w.request_redraw()) } #[inline] pub fn current_monitor(&self) -> Option { match self { #[cfg(feature = "x11")] &Window::X(ref window) => { let current_monitor = MonitorHandle::X(window.current_monitor()); Some(RootMonitorHandle { inner: current_monitor, }) } #[cfg(feature = "wayland")] &Window::Wayland(ref window) => { let current_monitor = MonitorHandle::Wayland(window.current_monitor()?); Some(RootMonitorHandle { inner: current_monitor, }) } } } #[inline] pub fn available_monitors(&self) -> VecDeque { match self { #[cfg(feature = "x11")] &Window::X(ref window) => window .available_monitors() .into_iter() .map(MonitorHandle::X) .collect(), #[cfg(feature = "wayland")] &Window::Wayland(ref window) => window .available_monitors() .into_iter() .map(MonitorHandle::Wayland) .collect(), } } #[inline] pub fn primary_monitor(&self) -> Option { match self { #[cfg(feature = "x11")] &Window::X(ref window) => { let primary_monitor = MonitorHandle::X(window.primary_monitor()); Some(RootMonitorHandle { inner: primary_monitor, }) } #[cfg(feature = "wayland")] &Window::Wayland(ref window) => window.primary_monitor(), } } pub fn raw_window_handle(&self) -> RawWindowHandle { match self { #[cfg(feature = "x11")] &Window::X(ref window) => RawWindowHandle::Xlib(window.raw_window_handle()), #[cfg(feature = "wayland")] &Window::Wayland(ref window) => RawWindowHandle::Wayland(window.raw_window_handle()), } } } #[cfg(feature = "x11")] unsafe extern "C" fn x_error_callback( display: *mut x11::ffi::Display, event: *mut x11::ffi::XErrorEvent, ) -> c_int { let xconn_lock = X11_BACKEND.lock(); if let Ok(ref xconn) = *xconn_lock { // `assume_init` is safe here because the array consists of `MaybeUninit` values, // which do not require initialization. let mut buf: [MaybeUninit; 1024] = MaybeUninit::uninit().assume_init(); (xconn.xlib.XGetErrorText)( display, (*event).error_code as c_int, buf.as_mut_ptr() as *mut c_char, buf.len() as c_int, ); let description = CStr::from_ptr(buf.as_ptr() as *const c_char).to_string_lossy(); let error = XError { description: description.into_owned(), error_code: (*event).error_code, request_code: (*event).request_code, minor_code: (*event).minor_code, }; error!("X11 error: {:#?}", error); *xconn.latest_error.lock() = Some(error); } // Fun fact: this return value is completely ignored. 0 } pub enum EventLoop { #[cfg(feature = "wayland")] Wayland(wayland::EventLoop), #[cfg(feature = "x11")] X(x11::EventLoop), } pub enum EventLoopProxy { #[cfg(feature = "x11")] X(x11::EventLoopProxy), #[cfg(feature = "wayland")] Wayland(wayland::EventLoopProxy), } impl Clone for EventLoopProxy { fn clone(&self) -> Self { x11_or_wayland!(match self; EventLoopProxy(proxy) => proxy.clone(); as EventLoopProxy) } } impl EventLoop { pub fn new() -> EventLoop { assert_is_main_thread("new_any_thread"); EventLoop::new_any_thread() } pub fn new_any_thread() -> EventLoop { if let Ok(env_var) = env::var(BACKEND_PREFERENCE_ENV_VAR) { match env_var.as_str() { "x11" => { // TODO: propagate #[cfg(feature = "x11")] return EventLoop::new_x11_any_thread() .expect("Failed to initialize X11 backend"); #[cfg(not(feature = "x11"))] panic!("x11 feature is not enabled") } "wayland" => { #[cfg(feature = "wayland")] return EventLoop::new_wayland_any_thread() .expect("Failed to initialize Wayland backend"); #[cfg(not(feature = "wayland"))] panic!("wayland feature is not enabled"); } _ => panic!( "Unknown environment variable value for {}, try one of `x11`,`wayland`", BACKEND_PREFERENCE_ENV_VAR, ), } } #[cfg(feature = "wayland")] let wayland_err = match EventLoop::new_wayland_any_thread() { Ok(event_loop) => return event_loop, Err(err) => err, }; #[cfg(feature = "x11")] let x11_err = match EventLoop::new_x11_any_thread() { Ok(event_loop) => return event_loop, Err(err) => err, }; #[cfg(not(feature = "wayland"))] let wayland_err = "backend disabled"; #[cfg(not(feature = "x11"))] let x11_err = "backend disabled"; panic!( "Failed to initialize any backend! Wayland status: {:?} X11 status: {:?}", wayland_err, x11_err, ); } #[cfg(feature = "wayland")] pub fn new_wayland() -> Result, Box> { assert_is_main_thread("new_wayland_any_thread"); EventLoop::new_wayland_any_thread() } #[cfg(feature = "wayland")] pub fn new_wayland_any_thread() -> Result, Box> { wayland::EventLoop::new().map(EventLoop::Wayland) } #[cfg(feature = "x11")] pub fn new_x11() -> Result, XNotSupported> { assert_is_main_thread("new_x11_any_thread"); EventLoop::new_x11_any_thread() } #[cfg(feature = "x11")] pub fn new_x11_any_thread() -> Result, XNotSupported> { let xconn = match X11_BACKEND.lock().as_ref() { Ok(xconn) => xconn.clone(), Err(err) => return Err(err.clone()), }; Ok(EventLoop::X(x11::EventLoop::new(xconn))) } pub fn create_proxy(&self) -> EventLoopProxy { x11_or_wayland!(match self; EventLoop(evlp) => evlp.create_proxy(); as EventLoopProxy) } pub fn run_return(&mut self, callback: F) where F: FnMut(crate::event::Event<'_, T>, &RootELW, &mut ControlFlow), { x11_or_wayland!(match self; EventLoop(evlp) => evlp.run_return(callback)) } pub fn run(self, callback: F) -> ! where F: 'static + FnMut(crate::event::Event<'_, T>, &RootELW, &mut ControlFlow), { x11_or_wayland!(match self; EventLoop(evlp) => evlp.run(callback)) } pub fn window_target(&self) -> &crate::event_loop::EventLoopWindowTarget { x11_or_wayland!(match self; EventLoop(evl) => evl.window_target()) } } impl EventLoopProxy { pub fn send_event(&self, event: T) -> Result<(), EventLoopClosed> { x11_or_wayland!(match self; EventLoopProxy(proxy) => proxy.send_event(event)) } } pub enum EventLoopWindowTarget { #[cfg(feature = "wayland")] Wayland(wayland::EventLoopWindowTarget), #[cfg(feature = "x11")] X(x11::EventLoopWindowTarget), } impl EventLoopWindowTarget { #[inline] pub fn is_wayland(&self) -> bool { match *self { #[cfg(feature = "wayland")] EventLoopWindowTarget::Wayland(_) => true, #[cfg(feature = "x11")] _ => false, } } #[inline] pub fn available_monitors(&self) -> VecDeque { match *self { #[cfg(feature = "wayland")] EventLoopWindowTarget::Wayland(ref evlp) => evlp .available_monitors() .into_iter() .map(MonitorHandle::Wayland) .collect(), #[cfg(feature = "x11")] EventLoopWindowTarget::X(ref evlp) => evlp .x_connection() .available_monitors() .into_iter() .map(MonitorHandle::X) .collect(), } } #[inline] pub fn primary_monitor(&self) -> Option { match *self { #[cfg(feature = "wayland")] EventLoopWindowTarget::Wayland(ref evlp) => evlp.primary_monitor(), #[cfg(feature = "x11")] EventLoopWindowTarget::X(ref evlp) => { let primary_monitor = MonitorHandle::X(evlp.x_connection().primary_monitor()); Some(RootMonitorHandle { inner: primary_monitor, }) } } } } fn sticky_exit_callback( evt: Event<'_, T>, target: &RootELW, control_flow: &mut ControlFlow, callback: &mut F, ) where F: FnMut(Event<'_, T>, &RootELW, &mut ControlFlow), { // make ControlFlow::Exit sticky by providing a dummy // control flow reference if it is already Exit. let mut dummy = ControlFlow::Exit; let cf = if *control_flow == ControlFlow::Exit { &mut dummy } else { control_flow }; // user callback callback(evt, target, cf) } fn assert_is_main_thread(suggested_method: &str) { if !is_main_thread() { panic!( "Initializing the event loop outside of the main thread is a significant \ cross-platform compatibility hazard. If you really, absolutely need to create an \ EventLoop on a different thread, please use the `EventLoopExtUnix::{}` function.", suggested_method ); } } #[cfg(target_os = "linux")] fn is_main_thread() -> bool { use libc::{c_long, getpid, syscall, SYS_gettid}; unsafe { syscall(SYS_gettid) == getpid() as c_long } } #[cfg(any(target_os = "dragonfly", target_os = "freebsd", target_os = "openbsd"))] fn is_main_thread() -> bool { use libc::pthread_main_np; unsafe { pthread_main_np() == 1 } } #[cfg(target_os = "netbsd")] fn is_main_thread() -> bool { std::thread::current().name() == Some("main") }