Event Loop 2.0 API and Windows implementation (#638)

* Rename EventsLoop and associated types to EventLoop * Rename WindowEvent::Refresh to WindowEvent::Redraw * Remove second thread from win32 backend * Update run_forever to hijack thread * Replace windows Mutex with parking_lot Mutex * Implement new ControlFlow and associated events * Add StartCause::Init support, timer example * Add ability to send custom user events * Fully invert windows control flow so win32 calls into winit's callback * Add request_redraw * Rename platform to platform_impl * Rename os to platform, add Ext trait postfixes * Add platform::desktop module with EventLoopExt::run_return * Re-organize into module structure * Improve documentation * Small changes to examples * Improve docs for run and run_return * Change instances of "events_loop" to "event_loop" * Rename MonitorId to MonitorHandle * Add CHANGELOG entry * Improve WaitUntil timer precision * When SendEvent is called during event closure, buffer events * Fix resize lag when waiting in some situations * Update send test and errors that broke some examples/APIs * Improve clarity/fix typos in docs * Fix unreachable panic after setting ControlFlow to Poll during some RedrawRequested events. * Fix crash when running in release mode * Remove crossbeam dependency and make drop events work again * Remove serde implementations from ControlFlow * Fix 1.24.1 build * Fix freeze when setting decorations * Replace &EventLoop in callback with &EventLoopWindowTarget * Document and implement Debug for EventLoopWindowTarget * Fix some deadlocks that could occur when changing window state * Fix thread executor not executing closure when called from non-loop thread * Fix buffered events not getting dispatched * Fix crash with runner refcell not getting dropped * Address review feedback * Fix CHANGELOG typo * Catch panics in user callback
2019-02-05 10:30:33 -05:00 · 2019-02-05 10:30:33 -05:00 · 9602716ed2
commit 9602716ed2
parent 7be1d16263
92 changed files with 3467 additions and 1260 deletions
--- a/src/platform/unix.rs
+++ b/src/platform/unix.rs
@ -0,0 +1,387 @@
+#![cfg(any(target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd", target_os = "openbsd"))]
+
+use std::os::raw;
+use std::ptr;
+use std::sync::Arc;
+
+use sctk::window::{ButtonState, Theme};
+
+use {
+    EventLoop,
+    LogicalSize,
+    MonitorHandle,
+    Window,
+    WindowBuilder,
+};
+use platform_impl::{
+    EventLoop as LinuxEventLoop,
+    Window as LinuxWindow,
+};
+use platform_impl::x11::XConnection;
+use platform_impl::x11::ffi::XVisualInfo;
+
+// TODO: stupid hack so that glutin can do its work
+#[doc(hidden)]
+pub use platform_impl::x11;
+
+pub use platform_impl::XNotSupported;
+pub use platform_impl::x11::util::WindowType as XWindowType;
+
+/// Theme for wayland client side decorations
+///
+/// Colors must be in ARGB8888 format
+pub struct WaylandTheme {
+    /// Primary color when the window is focused
+    pub primary_active: [u8; 4],
+    /// Primary color when the window is unfocused
+    pub primary_inactive: [u8; 4],
+    /// Secondary color when the window is focused
+    pub secondary_active: [u8; 4],
+    /// Secondary color when the window is unfocused
+    pub secondary_inactive: [u8; 4],
+    /// Close button color when hovered over
+    pub close_button_hovered: [u8; 4],
+    /// Close button color
+    pub close_button: [u8; 4],
+    /// Close button color when hovered over
+    pub maximize_button_hovered: [u8; 4],
+    /// Maximize button color
+    pub maximize_button: [u8; 4],
+    /// Minimize button color when hovered over
+    pub minimize_button_hovered: [u8; 4],
+    /// Minimize button color
+    pub minimize_button: [u8; 4],
+}
+
+struct WaylandThemeObject(WaylandTheme);
+
+impl Theme for WaylandThemeObject {
+    fn get_primary_color(&self, active: bool) -> [u8; 4] {
+        if active {
+            self.0.primary_active
+        } else {
+            self.0.primary_inactive
+        }
+    }
+
+    // Used for division line
+    fn get_secondary_color(&self, active: bool) -> [u8; 4] {
+        if active {
+            self.0.secondary_active
+        } else {
+            self.0.secondary_inactive
+        }
+    }
+
+    fn get_close_button_color(&self, state: ButtonState) -> [u8; 4] {
+        match state {
+            ButtonState::Hovered => self.0.close_button_hovered,
+            _ => self.0.close_button,
+        }
+    }
+
+    fn get_maximize_button_color(&self, state: ButtonState) -> [u8; 4] {
+        match state {
+            ButtonState::Hovered => self.0.maximize_button_hovered,
+            _ => self.0.maximize_button,
+        }
+    }
+
+    fn get_minimize_button_color(&self, state: ButtonState) -> [u8; 4] {
+        match state {
+            ButtonState::Hovered => self.0.minimize_button_hovered,
+            _ => self.0.minimize_button,
+        }
+    }
+}
+
+/// Additional methods on `EventLoop` that are specific to Unix.
+pub trait EventLoopExtUnix {
+    /// Builds a new `EventsLoop` that is forced to use X11.
+    fn new_x11() -> Result<Self, XNotSupported>
+        where Self: Sized;
+
+    /// Builds a new `EventLoop` that is forced to use Wayland.
+    fn new_wayland() -> Self
+        where Self: Sized;
+
+    /// True if the `EventLoop` uses Wayland.
+    fn is_wayland(&self) -> bool;
+
+    /// True if the `EventLoop` uses X11.
+    fn is_x11(&self) -> bool;
+
+    #[doc(hidden)]
+    fn get_xlib_xconnection(&self) -> Option<Arc<XConnection>>;
+}
+
+impl EventLoopExtUnix for EventLoop {
+    #[inline]
+    fn new_x11() -> Result<Self, XNotSupported> {
+        LinuxEventLoop::new_x11().map(|ev|
+            EventLoop {
+                event_loop: ev,
+                _marker: ::std::marker::PhantomData,
+            }
+        )
+    }
+
+    #[inline]
+    fn new_wayland() -> Self {
+        EventLoop {
+            event_loop: match LinuxEventLoop::new_wayland() {
+                Ok(e) => e,
+                Err(_) => panic!()      // TODO: propagate
+            },
+            _marker: ::std::marker::PhantomData,
+        }
+    }
+
+    #[inline]
+    fn is_wayland(&self) -> bool {
+        self.event_loop.is_wayland()
+    }
+
+    #[inline]
+    fn is_x11(&self) -> bool {
+        !self.event_loop.is_wayland()
+    }
+
+    #[inline]
+    #[doc(hidden)]
+    fn get_xlib_xconnection(&self) -> Option<Arc<XConnection>> {
+        self.event_loop.x_connection().cloned()
+    }
+}
+
+/// 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).
+    fn get_xlib_window(&self) -> Option<raw::c_ulong>;
+
+    /// 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 glutin `Window` is destroyed.
+    fn get_xlib_display(&self) -> Option<*mut raw::c_void>;
+
+    fn get_xlib_screen_id(&self) -> Option<raw::c_int>;
+
+    #[doc(hidden)]
+    fn get_xlib_xconnection(&self) -> Option<Arc<XConnection>>;
+
+    /// Set window urgency hint (`XUrgencyHint`). Only relevant on X.
+    fn set_urgent(&self, is_urgent: bool);
+
+    /// 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 glutin `Window` is destroyed.
+    fn get_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 glutin `Window` is destroyed.
+    fn get_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 glutin `Window` is destroyed.
+    fn get_wayland_display(&self) -> Option<*mut raw::c_void>;
+
+    /// Sets the color theme of the client side window decorations on wayland
+    fn set_wayland_theme(&self, theme: WaylandTheme);
+
+    /// 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]
+    fn get_xlib_window(&self) -> Option<raw::c_ulong> {
+        match self.window {
+            LinuxWindow::X(ref w) => Some(w.get_xlib_window()),
+            _ => None
+        }
+    }
+
+    #[inline]
+    fn get_xlib_display(&self) -> Option<*mut raw::c_void> {
+        match self.window {
+            LinuxWindow::X(ref w) => Some(w.get_xlib_display()),
+            _ => None
+        }
+    }
+
+    #[inline]
+    fn get_xlib_screen_id(&self) -> Option<raw::c_int> {
+        match self.window {
+            LinuxWindow::X(ref w) => Some(w.get_xlib_screen_id()),
+            _ => None
+        }
+    }
+
+    #[inline]
+    #[doc(hidden)]
+    fn get_xlib_xconnection(&self) -> Option<Arc<XConnection>> {
+        match self.window {
+            LinuxWindow::X(ref w) => Some(w.get_xlib_xconnection()),
+            _ => None
+        }
+    }
+
+    #[inline]
+    fn get_xcb_connection(&self) -> Option<*mut raw::c_void> {
+        match self.window {
+            LinuxWindow::X(ref w) => Some(w.get_xcb_connection()),
+            _ => None
+        }
+    }
+
+    #[inline]
+    fn set_urgent(&self, is_urgent: bool) {
+        if let LinuxWindow::X(ref w) = self.window {
+            w.set_urgent(is_urgent);
+        }
+    }
+
+    #[inline]
+    fn get_wayland_surface(&self) -> Option<*mut raw::c_void> {
+        match self.window {
+            LinuxWindow::Wayland(ref w) => Some(w.get_surface().c_ptr() as *mut _),
+            _ => None
+        }
+    }
+
+    #[inline]
+    fn get_wayland_display(&self) -> Option<*mut raw::c_void> {
+        match self.window {
+            LinuxWindow::Wayland(ref w) => Some(w.get_display().c_ptr() as *mut _),
+            _ => None
+        }
+    }
+
+    #[inline]
+    fn set_wayland_theme(&self, theme: WaylandTheme) {
+        match self.window {
+            LinuxWindow::Wayland(ref w) => w.set_theme(WaylandThemeObject(theme)),
+            _ => {}
+        }
+    }
+
+    #[inline]
+    fn is_ready(&self) -> bool {
+        true
+    }
+}
+
+/// Additional methods on `WindowBuilder` that are specific to Unix.
+pub trait WindowBuilderExtUnix {
+    fn with_x11_visual<T>(self, visual_infos: *const T) -> WindowBuilder;
+    fn with_x11_screen(self, screen_id: i32) -> WindowBuilder;
+
+    /// Build window with `WM_CLASS` hint; defaults to the name of the binary. Only relevant on X11.
+    fn with_class(self, class: String, instance: String) -> WindowBuilder;
+    /// Build window with override-redirect flag; defaults to false. Only relevant on X11.
+    fn with_override_redirect(self, override_redirect: bool) -> WindowBuilder;
+    /// Build window with `_NET_WM_WINDOW_TYPE` hint; defaults to `Normal`. Only relevant on X11.
+    fn with_x11_window_type(self, x11_window_type: XWindowType) -> WindowBuilder;
+    /// Build window with `_GTK_THEME_VARIANT` hint set to the specified value. Currently only relevant on X11.
+    fn with_gtk_theme_variant(self, variant: String) -> WindowBuilder;
+    /// Build window with resize increment hint. Only implemented on X11.
+    fn with_resize_increments(self, increments: LogicalSize) -> WindowBuilder;
+    /// Build window with base size hint. Only implemented on X11.
+    fn with_base_size(self, base_size: LogicalSize) -> WindowBuilder;
+
+    /// Build window with a given application ID. It should match the `.desktop` file distributed with
+    /// your program. Only relevant on Wayland.
+    ///
+    /// 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_app_id(self, app_id: String) -> WindowBuilder;
+}
+
+impl WindowBuilderExtUnix for WindowBuilder {
+    #[inline]
+    fn with_x11_visual<T>(mut self, visual_infos: *const T) -> WindowBuilder {
+        self.platform_specific.visual_infos = Some(
+            unsafe { ptr::read(visual_infos as *const XVisualInfo) }
+        );
+        self
+    }
+
+    #[inline]
+    fn with_x11_screen(mut self, screen_id: i32) -> WindowBuilder {
+        self.platform_specific.screen_id = Some(screen_id);
+        self
+    }
+
+    #[inline]
+    fn with_class(mut self, instance: String, class: String) -> WindowBuilder {
+        self.platform_specific.class = Some((instance, class));
+        self
+    }
+
+    #[inline]
+    fn with_override_redirect(mut self, override_redirect: bool) -> WindowBuilder {
+        self.platform_specific.override_redirect = override_redirect;
+        self
+    }
+
+    #[inline]
+    fn with_x11_window_type(mut self, x11_window_type: XWindowType) -> WindowBuilder {
+        self.platform_specific.x11_window_type = x11_window_type;
+        self
+    }
+
+    #[inline]
+    fn with_resize_increments(mut self, increments: LogicalSize) -> WindowBuilder {
+        self.platform_specific.resize_increments = Some(increments.into());
+        self
+    }
+
+    #[inline]
+    fn with_base_size(mut self, base_size: LogicalSize) -> WindowBuilder {
+        self.platform_specific.base_size = Some(base_size.into());
+        self
+    }
+
+    #[inline]
+    fn with_gtk_theme_variant(mut self, variant: String) -> WindowBuilder {
+        self.platform_specific.gtk_theme_variant = Some(variant);
+        self
+    }
+
+    #[inline]
+    fn with_app_id(mut self, app_id: String) -> WindowBuilder {
+        self.platform_specific.app_id = Some(app_id);
+        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.get_native_identifier()
+    }
+}