#![cfg(any( target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd", target_os = "openbsd" ))] use std::os::raw; #[cfg(feature = "x11")] use std::{ptr, sync::Arc}; use crate::{ event_loop::{EventLoopBuilder, EventLoopWindowTarget}, monitor::MonitorHandle, window::{Window, WindowBuilder}, }; #[cfg(feature = "x11")] use crate::dpi::Size; #[cfg(feature = "x11")] use crate::platform_impl::{x11::ffi::XVisualInfo, x11::XConnection, XLIB_ERROR_HOOKS}; use crate::platform_impl::{ ApplicationName, Backend, EventLoopWindowTarget as LinuxEventLoopWindowTarget, Window as LinuxWindow, }; // TODO: stupid hack so that glutin can do its work #[doc(hidden)] #[cfg(feature = "x11")] pub use crate::platform_impl::x11; #[cfg(feature = "x11")] pub use crate::platform_impl::{x11::util::WindowType as XWindowType, XNotSupported}; #[cfg(feature = "wayland")] pub use crate::window::Theme; /// The first argument in the provided hook will be the pointer to `XDisplay` /// and the second one the pointer to [`XErrorEvent`]. The returned `bool` is an /// indicator whether the error was handled by the callback. /// /// [`XErrorEvent`]: https://linux.die.net/man/3/xerrorevent #[cfg(feature = "x11")] pub type XlibErrorHook = Box bool + Send + Sync>; /// Hook to winit's xlib error handling callback. /// /// This method is provided as a safe way to handle the errors comming from X11 when using xlib /// in external crates, like glutin for GLX access. Trying to handle errors by speculating with /// `XSetErrorHandler` is [`unsafe`]. /// /// [`unsafe`]: https://www.remlab.net/op/xlib.shtml #[inline] #[cfg(feature = "x11")] pub fn register_xlib_error_hook(hook: XlibErrorHook) { // Append new hook. unsafe { XLIB_ERROR_HOOKS.lock().push(hook); } } /// Additional methods on [`EventLoopWindowTarget`] that are specific to Unix. pub trait EventLoopWindowTargetExtUnix { /// True if the [`EventLoopWindowTarget`] uses Wayland. #[cfg(feature = "wayland")] fn is_wayland(&self) -> bool; /// True if the [`EventLoopWindowTarget`] uses X11. #[cfg(feature = "x11")] fn is_x11(&self) -> bool; #[doc(hidden)] #[cfg(feature = "x11")] fn xlib_xconnection(&self) -> Option>; /// Returns a pointer to the `wl_display` object of wayland that is used by this /// [`EventLoopWindowTarget`]. /// /// Returns `None` if the [`EventLoop`] doesn't use wayland (if it uses xlib for example). /// /// The pointer will become invalid when the winit [`EventLoop`] is destroyed. /// /// [`EventLoop`]: crate::event_loop::EventLoop #[cfg(feature = "wayland")] fn wayland_display(&self) -> Option<*mut raw::c_void>; } impl EventLoopWindowTargetExtUnix for EventLoopWindowTarget { #[inline] #[cfg(feature = "wayland")] fn is_wayland(&self) -> bool { self.p.is_wayland() } #[inline] #[cfg(feature = "x11")] fn is_x11(&self) -> bool { !self.p.is_wayland() } #[inline] #[cfg(feature = "x11")] fn xlib_xconnection(&self) -> Option> { match self.p { LinuxEventLoopWindowTarget::X(ref e) => Some(e.x_connection().clone()), #[cfg(feature = "wayland")] _ => None, } } #[inline] #[cfg(feature = "wayland")] fn wayland_display(&self) -> Option<*mut raw::c_void> { match self.p { LinuxEventLoopWindowTarget::Wayland(ref p) => { Some(p.display().get_display_ptr() as *mut _) } #[cfg(feature = "x11")] _ => None, } } } /// Additional methods on [`EventLoopBuilder`] that are specific to Unix. pub trait EventLoopBuilderExtUnix { /// Force using X11. #[cfg(feature = "x11")] fn with_x11(&mut self) -> &mut Self; /// Force using Wayland. #[cfg(feature = "wayland")] fn with_wayland(&mut self) -> &mut Self; /// Whether to allow the event loop to be created off of the main thread. /// /// By default, the window is only allowed to be created on the main /// thread, to make platform compatibility easier. fn with_any_thread(&mut self, any_thread: bool) -> &mut Self; } impl EventLoopBuilderExtUnix for EventLoopBuilder { #[inline] #[cfg(feature = "x11")] fn with_x11(&mut self) -> &mut Self { self.platform_specific.forced_backend = Some(Backend::X); self } #[inline] #[cfg(feature = "wayland")] fn with_wayland(&mut self) -> &mut Self { self.platform_specific.forced_backend = Some(Backend::Wayland); self } #[inline] fn with_any_thread(&mut self, any_thread: bool) -> &mut Self { self.platform_specific.any_thread = any_thread; self } } /// Additional methods on [`Window`] that are specific to Unix. pub trait WindowExtUnix { /// Returns the ID of the [`Window`] xlib object that is used by this window. /// /// Returns `None` if the window doesn't use xlib (if it uses wayland for example). #[cfg(feature = "x11")] fn xlib_window(&self) -> Option; /// Returns a pointer to the `Display` object of xlib that is used by this window. /// /// Returns `None` if the window doesn't use xlib (if it uses wayland for example). /// /// The pointer will become invalid when the [`Window`] is destroyed. #[cfg(feature = "x11")] fn xlib_display(&self) -> Option<*mut raw::c_void>; #[cfg(feature = "x11")] fn xlib_screen_id(&self) -> Option; #[doc(hidden)] #[cfg(feature = "x11")] fn xlib_xconnection(&self) -> Option>; /// This function returns the underlying `xcb_connection_t` of an xlib `Display`. /// /// Returns `None` if the window doesn't use xlib (if it uses wayland for example). /// /// The pointer will become invalid when the [`Window`] is destroyed. #[cfg(feature = "x11")] fn xcb_connection(&self) -> Option<*mut raw::c_void>; /// Returns a pointer to the `wl_surface` object of wayland that is used by this window. /// /// Returns `None` if the window doesn't use wayland (if it uses xlib for example). /// /// The pointer will become invalid when the [`Window`] is destroyed. #[cfg(feature = "wayland")] fn wayland_surface(&self) -> Option<*mut raw::c_void>; /// Returns a pointer to the `wl_display` object of wayland that is used by this window. /// /// Returns `None` if the window doesn't use wayland (if it uses xlib for example). /// /// The pointer will become invalid when the [`Window`] is destroyed. #[cfg(feature = "wayland")] fn wayland_display(&self) -> Option<*mut raw::c_void>; /// Updates [`Theme`] of window decorations. /// /// You can also use `WINIT_WAYLAND_CSD_THEME` env variable to set the theme. /// Possible values for env variable are: "dark" and light" #[cfg(feature = "wayland")] fn wayland_set_csd_theme(&self, config: Theme); /// Check if the window is ready for drawing /// /// It is a remnant of a previous implementation detail for the /// wayland backend, and is no longer relevant. /// /// Always return `true`. #[deprecated] fn is_ready(&self) -> bool; } impl WindowExtUnix for Window { #[inline] #[cfg(feature = "x11")] fn xlib_window(&self) -> Option { match self.window { LinuxWindow::X(ref w) => Some(w.xlib_window()), #[cfg(feature = "wayland")] _ => None, } } #[inline] #[cfg(feature = "x11")] fn xlib_display(&self) -> Option<*mut raw::c_void> { match self.window { LinuxWindow::X(ref w) => Some(w.xlib_display()), #[cfg(feature = "wayland")] _ => None, } } #[inline] #[cfg(feature = "x11")] fn xlib_screen_id(&self) -> Option { match self.window { LinuxWindow::X(ref w) => Some(w.xlib_screen_id()), #[cfg(feature = "wayland")] _ => None, } } #[inline] #[cfg(feature = "x11")] fn xlib_xconnection(&self) -> Option> { match self.window { LinuxWindow::X(ref w) => Some(w.xlib_xconnection()), #[cfg(feature = "wayland")] _ => None, } } #[inline] #[cfg(feature = "x11")] fn xcb_connection(&self) -> Option<*mut raw::c_void> { match self.window { LinuxWindow::X(ref w) => Some(w.xcb_connection()), #[cfg(feature = "wayland")] _ => None, } } #[inline] #[cfg(feature = "wayland")] fn wayland_surface(&self) -> Option<*mut raw::c_void> { match self.window { LinuxWindow::Wayland(ref w) => Some(w.surface().as_ref().c_ptr() as *mut _), #[cfg(feature = "x11")] _ => None, } } #[inline] #[cfg(feature = "wayland")] fn wayland_display(&self) -> Option<*mut raw::c_void> { match self.window { LinuxWindow::Wayland(ref w) => Some(w.display().get_display_ptr() as *mut _), #[cfg(feature = "x11")] _ => None, } } #[inline] #[cfg(feature = "wayland")] fn wayland_set_csd_theme(&self, theme: Theme) { match self.window { LinuxWindow::Wayland(ref w) => w.set_csd_theme(theme), #[cfg(feature = "x11")] _ => {} } } #[inline] fn is_ready(&self) -> bool { true } } /// Additional methods on [`WindowBuilder`] that are specific to Unix. pub trait WindowBuilderExtUnix { #[cfg(feature = "x11")] fn with_x11_visual(self, visual_infos: *const T) -> Self; #[cfg(feature = "x11")] fn with_x11_screen(self, screen_id: i32) -> Self; /// Build window with the given `general` and `instance` names. /// /// On Wayland, the `general` name sets an application ID, which should match the `.desktop` /// file destributed with your program. The `instance` is a `no-op`. /// /// On X11, the `general` sets general class of `WM_CLASS(STRING)`, while `instance` set the /// instance part of it. The resulted property looks like `WM_CLASS(STRING) = "general", "instance"`. /// /// For details about application ID conventions, see the /// [Desktop Entry Spec](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#desktop-file-id) fn with_name(self, general: impl Into, instance: impl Into) -> Self; /// Build window with override-redirect flag; defaults to false. Only relevant on X11. #[cfg(feature = "x11")] fn with_override_redirect(self, override_redirect: bool) -> Self; /// Build window with `_NET_WM_WINDOW_TYPE` hints; defaults to `Normal`. Only relevant on X11. #[cfg(feature = "x11")] fn with_x11_window_type(self, x11_window_type: Vec) -> Self; /// Build window with `_GTK_THEME_VARIANT` hint set to the specified value. Currently only relevant on X11. #[cfg(feature = "x11")] fn with_gtk_theme_variant(self, variant: String) -> Self; /// Build window with certain decoration [`Theme`] /// /// You can also use `WINIT_WAYLAND_CSD_THEME` env variable to set the theme. /// Possible values for env variable are: "dark" and light" #[cfg(feature = "wayland")] fn with_wayland_csd_theme(self, theme: Theme) -> Self; /// Build window with resize increment hint. Only implemented on X11. /// /// ``` /// # use winit::dpi::{LogicalSize, PhysicalSize}; /// # use winit::window::WindowBuilder; /// # use winit::platform::unix::WindowBuilderExtUnix; /// // Specify the size in logical dimensions like this: /// WindowBuilder::new().with_resize_increments(LogicalSize::new(400.0, 200.0)); /// /// // Or specify the size in physical dimensions like this: /// WindowBuilder::new().with_resize_increments(PhysicalSize::new(400, 200)); /// ``` #[cfg(feature = "x11")] fn with_resize_increments>(self, increments: S) -> Self; /// Build window with base size hint. Only implemented on X11. /// /// ``` /// # use winit::dpi::{LogicalSize, PhysicalSize}; /// # use winit::window::WindowBuilder; /// # use winit::platform::unix::WindowBuilderExtUnix; /// // Specify the size in logical dimensions like this: /// WindowBuilder::new().with_base_size(LogicalSize::new(400.0, 200.0)); /// /// // Or specify the size in physical dimensions like this: /// WindowBuilder::new().with_base_size(PhysicalSize::new(400, 200)); /// ``` #[cfg(feature = "x11")] fn with_base_size>(self, base_size: S) -> Self; } impl WindowBuilderExtUnix for WindowBuilder { #[inline] #[cfg(feature = "x11")] fn with_x11_visual(mut self, visual_infos: *const T) -> Self { { self.platform_specific.visual_infos = Some(unsafe { ptr::read(visual_infos as *const XVisualInfo) }); } self } #[inline] #[cfg(feature = "x11")] fn with_x11_screen(mut self, screen_id: i32) -> Self { self.platform_specific.screen_id = Some(screen_id); self } #[inline] fn with_name(mut self, general: impl Into, instance: impl Into) -> Self { self.platform_specific.name = Some(ApplicationName::new(general.into(), instance.into())); self } #[inline] #[cfg(feature = "x11")] fn with_override_redirect(mut self, override_redirect: bool) -> Self { self.platform_specific.override_redirect = override_redirect; self } #[inline] #[cfg(feature = "x11")] fn with_x11_window_type(mut self, x11_window_types: Vec) -> Self { self.platform_specific.x11_window_types = x11_window_types; self } #[inline] #[cfg(feature = "x11")] fn with_gtk_theme_variant(mut self, variant: String) -> Self { self.platform_specific.gtk_theme_variant = Some(variant); self } #[inline] #[cfg(feature = "wayland")] fn with_wayland_csd_theme(mut self, theme: Theme) -> Self { self.platform_specific.csd_theme = Some(theme); self } #[inline] #[cfg(feature = "x11")] fn with_resize_increments>(mut self, increments: S) -> Self { self.platform_specific.resize_increments = Some(increments.into()); self } #[inline] #[cfg(feature = "x11")] fn with_base_size>(mut self, base_size: S) -> Self { self.platform_specific.base_size = Some(base_size.into()); self } } /// Additional methods on `MonitorHandle` that are specific to Linux. pub trait MonitorHandleExtUnix { /// Returns the inner identifier of the monitor. fn native_id(&self) -> u32; } impl MonitorHandleExtUnix for MonitorHandle { #[inline] fn native_id(&self) -> u32 { self.inner.native_identifier() } }