mirror of
https://github.com/italicsjenga/winit-sonoma-fix.git
synced 2024-12-26 23:21:30 +11:00
a52f755ce8
* Add exit code to control flow and impl on linux * Fix examples to have an exit code * Fix doc examples to use an exit code * Improve documentation wording on the exit code * Add exit code example * Add exit code on windows * Change i32 as exit code to u8 This avoids nasty surprises with negative numbers on some unix-alikes due to two's complement. * Fix android usages of ControlFlow::Exit * Fix ios usages of ControlFlow::Exit * Fix web usages of ControlFlow::Exit * Add macos exit code * Add changelog note * Document exit code on display server disconnection * Revert "Change i32 as exit code to u8" This reverts commit f88fba0253b45de6a2ac0c3cbcf01f50503c9396. * Change Exit to ExitWithCode and make an Exit const * Revert "Add exit code example" This reverts commit fbd3d03de9c2d7516c7a63da489c99f498b710df. * Revert "Fix doc examples to use an exit code" This reverts commit daabcdf9ef9e16acad715c094ae442529e39fcbc. * Revert "Fix examples to have an exit code" This reverts commit 0df486896b8d106acf65ba83c45cc88d60d228e1. * Fix unix-alike to use ExitWithCode instead of Exit * Fix windows to use ExitWithCode rather than Exit * Silence warning about non-uppercase Exit const * Refactor exit code handling * Fix macos Exit usage and recover original semantic * Fix ios to use ExitWithCode instead of Exit * Update documentation to reflect ExitWithCode * Fix web to use ExitWithCode when needed, not Exit * Fix android to use ExitWithCode, not Exit * Apply documenation nits * Apply even more documentation nits * Move change in CHANGELOG.md under "Unreleased" * Try to use OS error code as exit code on wayland
782 lines
24 KiB
Rust
782 lines
24 KiB
Rust
#![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<XVisualInfo>,
|
|
#[cfg(feature = "x11")]
|
|
pub screen_id: Option<i32>,
|
|
#[cfg(feature = "x11")]
|
|
pub resize_increments: Option<Size>,
|
|
#[cfg(feature = "x11")]
|
|
pub base_size: Option<Size>,
|
|
#[cfg(feature = "x11")]
|
|
pub class: Option<(String, String)>,
|
|
#[cfg(feature = "x11")]
|
|
pub override_redirect: bool,
|
|
#[cfg(feature = "x11")]
|
|
pub x11_window_types: Vec<XWindowType>,
|
|
#[cfg(feature = "x11")]
|
|
pub gtk_theme_variant: Option<String>,
|
|
#[cfg(feature = "wayland")]
|
|
pub app_id: Option<String>,
|
|
}
|
|
|
|
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<Result<Arc<XConnection>, 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(e) => _f.pad(e),
|
|
#[cfg(feature = "wayland")]
|
|
OsError::WaylandMisc(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 const 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 const 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<String> {
|
|
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<u32> {
|
|
x11_or_wayland!(match self; MonitorHandle(m) => m.size())
|
|
}
|
|
|
|
#[inline]
|
|
pub fn position(&self) -> PhysicalPosition<i32> {
|
|
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<dyn Iterator<Item = RootVideoMode>> {
|
|
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<u32> {
|
|
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<T>(
|
|
window_target: &EventLoopWindowTarget<T>,
|
|
attribs: WindowAttributes,
|
|
pl_attribs: PlatformSpecificWindowBuilderAttributes,
|
|
) -> Result<Self, RootOsError> {
|
|
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<PhysicalPosition<i32>, NotSupportedError> {
|
|
x11_or_wayland!(match self; Window(w) => w.outer_position())
|
|
}
|
|
|
|
#[inline]
|
|
pub fn inner_position(&self) -> Result<PhysicalPosition<i32>, 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<u32> {
|
|
x11_or_wayland!(match self; Window(w) => w.inner_size())
|
|
}
|
|
|
|
#[inline]
|
|
pub fn outer_size(&self) -> PhysicalSize<u32> {
|
|
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<Size>) {
|
|
x11_or_wayland!(match self; Window(w) => w.set_min_inner_size(dimensions))
|
|
}
|
|
|
|
#[inline]
|
|
pub fn set_max_inner_size(&self, dimensions: Option<Size>) {
|
|
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<Fullscreen> {
|
|
x11_or_wayland!(match self; Window(w) => w.fullscreen())
|
|
}
|
|
|
|
#[inline]
|
|
pub fn set_fullscreen(&self, monitor: Option<Fullscreen>) {
|
|
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")]
|
|
Window::Wayland(_) => (),
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
pub fn set_window_icon(&self, _window_icon: Option<Icon>) {
|
|
match self {
|
|
#[cfg(feature = "x11")]
|
|
Window::X(ref w) => w.set_window_icon(_window_icon),
|
|
#[cfg(feature = "wayland")]
|
|
Window::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")]
|
|
Window::Wayland(_) => (),
|
|
}
|
|
}
|
|
pub fn request_user_attention(&self, request_type: Option<UserAttentionType>) {
|
|
match self {
|
|
#[cfg(feature = "x11")]
|
|
Window::X(ref w) => w.request_user_attention(request_type),
|
|
#[cfg(feature = "wayland")]
|
|
Window::Wayland(ref w) => w.request_user_attention(request_type),
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
pub fn request_redraw(&self) {
|
|
x11_or_wayland!(match self; Window(w) => w.request_redraw())
|
|
}
|
|
|
|
#[inline]
|
|
pub fn current_monitor(&self) -> Option<RootMonitorHandle> {
|
|
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<MonitorHandle> {
|
|
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<RootMonitorHandle> {
|
|
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<c_char>; 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<T: 'static> {
|
|
#[cfg(feature = "wayland")]
|
|
Wayland(wayland::EventLoop<T>),
|
|
#[cfg(feature = "x11")]
|
|
X(x11::EventLoop<T>),
|
|
}
|
|
|
|
pub enum EventLoopProxy<T: 'static> {
|
|
#[cfg(feature = "x11")]
|
|
X(x11::EventLoopProxy<T>),
|
|
#[cfg(feature = "wayland")]
|
|
Wayland(wayland::EventLoopProxy<T>),
|
|
}
|
|
|
|
impl<T: 'static> Clone for EventLoopProxy<T> {
|
|
fn clone(&self) -> Self {
|
|
x11_or_wayland!(match self; EventLoopProxy(proxy) => proxy.clone(); as EventLoopProxy)
|
|
}
|
|
}
|
|
|
|
impl<T: 'static> EventLoop<T> {
|
|
pub fn new() -> EventLoop<T> {
|
|
assert_is_main_thread("new_any_thread");
|
|
|
|
EventLoop::new_any_thread()
|
|
}
|
|
|
|
pub fn new_any_thread() -> EventLoop<T> {
|
|
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<EventLoop<T>, Box<dyn Error>> {
|
|
assert_is_main_thread("new_wayland_any_thread");
|
|
|
|
EventLoop::new_wayland_any_thread()
|
|
}
|
|
|
|
#[cfg(feature = "wayland")]
|
|
pub fn new_wayland_any_thread() -> Result<EventLoop<T>, Box<dyn Error>> {
|
|
wayland::EventLoop::new().map(EventLoop::Wayland)
|
|
}
|
|
|
|
#[cfg(feature = "x11")]
|
|
pub fn new_x11() -> Result<EventLoop<T>, XNotSupported> {
|
|
assert_is_main_thread("new_x11_any_thread");
|
|
|
|
EventLoop::new_x11_any_thread()
|
|
}
|
|
|
|
#[cfg(feature = "x11")]
|
|
pub fn new_x11_any_thread() -> Result<EventLoop<T>, 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<T> {
|
|
x11_or_wayland!(match self; EventLoop(evlp) => evlp.create_proxy(); as EventLoopProxy)
|
|
}
|
|
|
|
pub fn run_return<F>(&mut self, callback: F) -> i32
|
|
where
|
|
F: FnMut(crate::event::Event<'_, T>, &RootELW<T>, &mut ControlFlow),
|
|
{
|
|
x11_or_wayland!(match self; EventLoop(evlp) => evlp.run_return(callback))
|
|
}
|
|
|
|
pub fn run<F>(self, callback: F) -> !
|
|
where
|
|
F: 'static + FnMut(crate::event::Event<'_, T>, &RootELW<T>, &mut ControlFlow),
|
|
{
|
|
x11_or_wayland!(match self; EventLoop(evlp) => evlp.run(callback))
|
|
}
|
|
|
|
pub fn window_target(&self) -> &crate::event_loop::EventLoopWindowTarget<T> {
|
|
x11_or_wayland!(match self; EventLoop(evl) => evl.window_target())
|
|
}
|
|
}
|
|
|
|
impl<T: 'static> EventLoopProxy<T> {
|
|
pub fn send_event(&self, event: T) -> Result<(), EventLoopClosed<T>> {
|
|
x11_or_wayland!(match self; EventLoopProxy(proxy) => proxy.send_event(event))
|
|
}
|
|
}
|
|
|
|
pub enum EventLoopWindowTarget<T> {
|
|
#[cfg(feature = "wayland")]
|
|
Wayland(wayland::EventLoopWindowTarget<T>),
|
|
#[cfg(feature = "x11")]
|
|
X(x11::EventLoopWindowTarget<T>),
|
|
}
|
|
|
|
impl<T> EventLoopWindowTarget<T> {
|
|
#[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<MonitorHandle> {
|
|
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<RootMonitorHandle> {
|
|
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<T, F>(
|
|
evt: Event<'_, T>,
|
|
target: &RootELW<T>,
|
|
control_flow: &mut ControlFlow,
|
|
callback: &mut F,
|
|
) where
|
|
F: FnMut(Event<'_, T>, &RootELW<T>, &mut ControlFlow),
|
|
{
|
|
// make ControlFlow::ExitWithCode sticky by providing a dummy
|
|
// control flow reference if it is already ExitWithCode.
|
|
if let ControlFlow::ExitWithCode(code) = *control_flow {
|
|
callback(evt, target, &mut ControlFlow::ExitWithCode(code))
|
|
} else {
|
|
callback(evt, target, control_flow)
|
|
}
|
|
}
|
|
|
|
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")
|
|
}
|