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_impl/linux/x11/util/wm.rs
+++ b/src/platform_impl/linux/x11/util/wm.rs
@ -0,0 +1,141 @@
+use parking_lot::Mutex;
+
+use super::*;
+
+// This info is global to the window manager.
+lazy_static! {
+    static ref SUPPORTED_HINTS: Mutex<Vec<ffi::Atom>> = Mutex::new(Vec::with_capacity(0));
+    static ref WM_NAME: Mutex<Option<String>> = Mutex::new(None);
+}
+
+pub fn hint_is_supported(hint: ffi::Atom) -> bool {
+    (*SUPPORTED_HINTS.lock()).contains(&hint)
+}
+
+pub fn wm_name_is_one_of(names: &[&str]) -> bool {
+    if let Some(ref name) = *WM_NAME.lock() {
+        names.contains(&name.as_str())
+    } else {
+        false
+    }
+}
+
+impl XConnection {
+    pub fn update_cached_wm_info(&self, root: ffi::Window) {
+        *SUPPORTED_HINTS.lock() = self.get_supported_hints(root);
+        *WM_NAME.lock() = self.get_wm_name(root);
+    }
+
+    fn get_supported_hints(&self, root: ffi::Window) -> Vec<ffi::Atom> {
+        let supported_atom = unsafe { self.get_atom_unchecked(b"_NET_SUPPORTED\0") };
+        self.get_property(
+            root,
+            supported_atom,
+            ffi::XA_ATOM,
+        ).unwrap_or_else(|_| Vec::with_capacity(0))
+    }
+
+    fn get_wm_name(&self, root: ffi::Window) -> Option<String> {
+        let check_atom = unsafe { self.get_atom_unchecked(b"_NET_SUPPORTING_WM_CHECK\0") };
+        let wm_name_atom = unsafe { self.get_atom_unchecked(b"_NET_WM_NAME\0") };
+
+        // Mutter/Muffin/Budgie doesn't have _NET_SUPPORTING_WM_CHECK in its _NET_SUPPORTED, despite
+        // it working and being supported. This has been reported upstream, but due to the
+        // inavailability of time machines, we'll just try to get _NET_SUPPORTING_WM_CHECK
+        // regardless of whether or not the WM claims to support it.
+        //
+        // Blackbox 0.70 also incorrectly reports not supporting this, though that appears to be fixed
+        // in 0.72.
+        /*if !supported_hints.contains(&check_atom) {
+            return None;
+        }*/
+
+        // IceWM (1.3.x and earlier) doesn't report supporting _NET_WM_NAME, but will nonetheless
+        // provide us with a value for it. Note that the unofficial 1.4 fork of IceWM works fine.
+        /*if !supported_hints.contains(&wm_name_atom) {
+            return None;
+        }*/
+
+        // Of the WMs tested, only xmonad and dwm fail to provide a WM name.
+
+        // Querying this property on the root window will give us the ID of a child window created by
+        // the WM.
+        let root_window_wm_check = {
+            let result = self.get_property(
+                root,
+                check_atom,
+                ffi::XA_WINDOW,
+            );
+
+            let wm_check = result
+                .ok()
+                .and_then(|wm_check| wm_check.get(0).cloned());
+
+            if let Some(wm_check) = wm_check {
+                wm_check
+            } else {
+                return None;
+            }
+        };
+
+        // Querying the same property on the child window we were given, we should get this child
+        // window's ID again.
+        let child_window_wm_check = {
+            let result = self.get_property(
+                root_window_wm_check,
+                check_atom,
+                ffi::XA_WINDOW,
+            );
+
+            let wm_check = result
+                .ok()
+                .and_then(|wm_check| wm_check.get(0).cloned());
+
+            if let Some(wm_check) = wm_check {
+                wm_check
+            } else {
+                return None;
+            }
+        };
+
+        // These values should be the same.
+        if root_window_wm_check != child_window_wm_check {
+            return None;
+        }
+
+        // All of that work gives us a window ID that we can get the WM name from.
+        let wm_name = {
+            let utf8_string_atom = unsafe { self.get_atom_unchecked(b"UTF8_STRING\0") };
+
+            let result = self.get_property(
+                root_window_wm_check,
+                wm_name_atom,
+                utf8_string_atom,
+            );
+
+            // IceWM requires this. IceWM was also the only WM tested that returns a null-terminated
+            // string. For more fun trivia, IceWM is also unique in including version and uname
+            // information in this string (this means you'll have to be careful if you want to match
+            // against it, though).
+            // The unofficial 1.4 fork of IceWM still includes the extra details, but properly
+            // returns a UTF8 string that isn't null-terminated.
+            let no_utf8 = if let Err(ref err) = result {
+                err.is_actual_property_type(ffi::XA_STRING)
+            } else {
+                false
+            };
+
+            if no_utf8 {
+                self.get_property(
+                    root_window_wm_check,
+                    wm_name_atom,
+                    ffi::XA_STRING,
+                )
+            } else {
+                result
+            }
+        }.ok();
+
+        wm_name.and_then(|wm_name| String::from_utf8(wm_name).ok())
+    }
+}