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

src/platform_impl/android/ffi.rs

@@ -0,0 +1,108 @@
+#![allow(dead_code)]
+#![allow(non_snake_case)]
+#![allow(non_camel_case_types)]
+#![allow(non_upper_case_globals)]
+
+use libc;
+use std::os::raw;
+
+#[link(name = "android")]
+#[link(name = "EGL")]
+#[link(name = "GLESv2")]
+extern {}
+
+/**
+ * asset_manager.h
+ */
+pub type AAssetManager = raw::c_void;
+
+/**
+ * native_window.h
+ */
+pub type ANativeWindow = raw::c_void;
+
+extern {
+    pub fn ANativeWindow_getHeight(window: *const ANativeWindow) -> libc::int32_t;
+    pub fn ANativeWindow_getWidth(window: *const ANativeWindow) -> libc::int32_t;
+}
+
+/**
+ * native_activity.h
+ */
+pub type JavaVM = ();
+pub type JNIEnv = ();
+pub type jobject = *const libc::c_void;
+
+pub type AInputQueue = ();  // FIXME: wrong
+pub type ARect = ();  // FIXME: wrong
+
+#[repr(C)]
+pub struct ANativeActivity {
+    pub callbacks: *mut ANativeActivityCallbacks,
+    pub vm: *mut JavaVM,
+    pub env: *mut JNIEnv,
+    pub clazz: jobject,
+    pub internalDataPath: *const libc::c_char,
+    pub externalDataPath: *const libc::c_char,
+    pub sdkVersion: libc::int32_t,
+    pub instance: *mut libc::c_void,
+    pub assetManager: *mut AAssetManager,
+    pub obbPath: *const libc::c_char,
+}
+
+#[repr(C)]
+pub struct ANativeActivityCallbacks {
+    pub onStart: extern fn(*mut ANativeActivity),
+    pub onResume: extern fn(*mut ANativeActivity),
+    pub onSaveInstanceState: extern fn(*mut ANativeActivity, *mut libc::size_t),
+    pub onPause: extern fn(*mut ANativeActivity),
+    pub onStop: extern fn(*mut ANativeActivity),
+    pub onDestroy: extern fn(*mut ANativeActivity),
+    pub onWindowFocusChanged: extern fn(*mut ANativeActivity, libc::c_int),
+    pub onNativeWindowCreated: extern fn(*mut ANativeActivity, *const ANativeWindow),
+    pub onNativeWindowResized: extern fn(*mut ANativeActivity, *const ANativeWindow),
+    pub onNativeWindowRedrawNeeded: extern fn(*mut ANativeActivity, *const ANativeWindow),
+    pub onNativeWindowDestroyed: extern fn(*mut ANativeActivity, *const ANativeWindow),
+    pub onInputQueueCreated: extern fn(*mut ANativeActivity, *mut AInputQueue),
+    pub onInputQueueDestroyed: extern fn(*mut ANativeActivity, *mut AInputQueue),
+    pub onContentRectChanged: extern fn(*mut ANativeActivity, *const ARect),
+    pub onConfigurationChanged: extern fn(*mut ANativeActivity),
+    pub onLowMemory: extern fn(*mut ANativeActivity),
+}
+
+/**
+ * looper.h
+ */
+pub type ALooper = ();
+
+#[link(name = "android")]
+extern {
+    pub fn ALooper_forThread() -> *const ALooper;
+    pub fn ALooper_acquire(looper: *const ALooper);
+    pub fn ALooper_release(looper: *const ALooper);
+    pub fn ALooper_prepare(opts: libc::c_int) -> *const ALooper;
+    pub fn ALooper_pollOnce(timeoutMillis: libc::c_int, outFd: *mut libc::c_int,
+        outEvents: *mut libc::c_int, outData: *mut *mut libc::c_void) -> libc::c_int;
+    pub fn ALooper_pollAll(timeoutMillis: libc::c_int, outFd: *mut libc::c_int,
+        outEvents: *mut libc::c_int, outData: *mut *mut libc::c_void) -> libc::c_int;
+    pub fn ALooper_wake(looper: *const ALooper);
+    pub fn ALooper_addFd(looper: *const ALooper, fd: libc::c_int, ident: libc::c_int,
+        events: libc::c_int, callback: ALooper_callbackFunc, data: *mut libc::c_void)
+        -> libc::c_int;
+    pub fn ALooper_removeFd(looper: *const ALooper, fd: libc::c_int) -> libc::c_int;
+}
+
+pub const ALOOPER_PREPARE_ALLOW_NON_CALLBACKS: libc::c_int = 1 << 0;
+
+pub const ALOOPER_POLL_WAKE: libc::c_int = -1;
+pub const ALOOPER_POLL_CALLBACK: libc::c_int = -2;
+pub const ALOOPER_POLL_TIMEOUT: libc::c_int = -3;
+pub const ALOOPER_POLL_ERROR: libc::c_int = -4;
+
+pub const ALOOPER_EVENT_INPUT: libc::c_int = 1 << 0;
+pub const ALOOPER_EVENT_OUTPUT: libc::c_int = 1 << 1;
+pub const ALOOPER_EVENT_ERROR: libc::c_int = 1 << 2;
+pub const ALOOPER_EVENT_HANGUP: libc::c_int = 1 << 3;
+pub const ALOOPER_EVENT_INVALID: libc::c_int = 1 << 4;
+
+pub type ALooper_callbackFunc = extern fn(libc::c_int, libc::c_int, *mut libc::c_void) -> libc::c_int;

src/platform_impl/android/mod.rs

@@ -0,0 +1,424 @@
+#![cfg(target_os = "android")]
+
+extern crate android_glue;
+
+mod ffi;
+
+use std::cell::RefCell;
+use std::collections::VecDeque;
+use std::fmt;
+use std::os::raw::c_void;
+use std::sync::mpsc::{Receiver, channel};
+
+use {
+    CreationError,
+    Event,
+    LogicalPosition,
+    LogicalSize,
+    MouseCursor,
+    PhysicalPosition,
+    PhysicalSize,
+    WindowAttributes,
+    WindowEvent,
+    WindowId as RootWindowId,
+};
+use CreationError::OsError;
+use events::{Touch, TouchPhase};
+use window::MonitorHandle as RootMonitorHandle;
+
+pub struct EventLoop {
+    event_rx: Receiver<android_glue::Event>,
+    suspend_callback: RefCell<Option<Box<Fn(bool) -> ()>>>,
+}
+
+#[derive(Clone)]
+pub struct EventLoopProxy;
+
+impl EventLoop {
+    pub fn new() -> EventLoop {
+        let (tx, rx) = channel();
+        android_glue::add_sender(tx);
+        EventLoop {
+            event_rx: rx,
+            suspend_callback: Default::default(),
+        }
+    }
+
+    #[inline]
+    pub fn get_available_monitors(&self) -> VecDeque<MonitorHandle> {
+        let mut rb = VecDeque::with_capacity(1);
+        rb.push_back(MonitorHandle);
+        rb
+    }
+
+    #[inline]
+    pub fn get_primary_monitor(&self) -> MonitorHandle {
+        MonitorHandle
+    }
+
+    pub fn poll_events<F>(&mut self, mut callback: F)
+        where F: FnMut(::Event)
+    {
+        while let Ok(event) = self.event_rx.try_recv() {
+            let e = match event{
+                android_glue::Event::EventMotion(motion) => {
+                    let dpi_factor = MonitorHandle.get_hidpi_factor();
+                    let location = LogicalPosition::from_physical(
+                        (motion.x as f64, motion.y as f64),
+                        dpi_factor,
+                    );
+                    Some(Event::WindowEvent {
+                        window_id: RootWindowId(WindowId),
+                        event: WindowEvent::Touch(Touch {
+                            phase: match motion.action {
+                                android_glue::MotionAction::Down => TouchPhase::Started,
+                                android_glue::MotionAction::Move => TouchPhase::Moved,
+                                android_glue::MotionAction::Up => TouchPhase::Ended,
+                                android_glue::MotionAction::Cancel => TouchPhase::Cancelled,
+                            },
+                            location,
+                            id: motion.pointer_id as u64,
+                            device_id: DEVICE_ID,
+                        }),
+                    })
+                },
+                android_glue::Event::InitWindow => {
+                    // The activity went to foreground.
+                    if let Some(cb) = self.suspend_callback.borrow().as_ref() {
+                        (*cb)(false);
+                    }
+                    Some(Event::Suspended(false))
+                },
+                android_glue::Event::TermWindow => {
+                    // The activity went to background.
+                    if let Some(cb) = self.suspend_callback.borrow().as_ref() {
+                        (*cb)(true);
+                    }
+                    Some(Event::Suspended(true))
+                },
+                android_glue::Event::WindowResized |
+                android_glue::Event::ConfigChanged => {
+                    // Activity Orientation changed or resized.
+                    let native_window = unsafe { android_glue::get_native_window() };
+                    if native_window.is_null() {
+                        None
+                    } else {
+                        let dpi_factor = MonitorHandle.get_hidpi_factor();
+                        let physical_size = MonitorHandle.get_dimensions();
+                        let size = LogicalSize::from_physical(physical_size, dpi_factor);
+                        Some(Event::WindowEvent {
+                            window_id: RootWindowId(WindowId),
+                            event: WindowEvent::Resized(size),
+                        })
+                    }
+                },
+                android_glue::Event::WindowRedrawNeeded => {
+                    // The activity needs to be redrawn.
+                    Some(Event::WindowEvent {
+                        window_id: RootWindowId(WindowId),
+                        event: WindowEvent::Redraw,
+                    })
+                }
+                android_glue::Event::Wake => {
+                    Some(Event::Awakened)
+                }
+                _ => {
+                    None
+                }
+            };
+
+            if let Some(event) = e {
+                callback(event);
+            }
+        };
+    }
+
+    pub fn set_suspend_callback(&self, cb: Option<Box<Fn(bool) -> ()>>) {
+        *self.suspend_callback.borrow_mut() = cb;
+    }
+
+    pub fn run_forever<F>(&mut self, mut callback: F)
+        where F: FnMut(::Event) -> ::ControlFlow,
+    {
+        // Yeah that's a very bad implementation.
+        loop {
+            let mut control_flow = ::ControlFlow::Continue;
+            self.poll_events(|e| {
+                if let ::ControlFlow::Break = callback(e) {
+                    control_flow = ::ControlFlow::Break;
+                }
+            });
+            if let ::ControlFlow::Break = control_flow {
+                break;
+            }
+            ::std::thread::sleep(::std::time::Duration::from_millis(5));
+        }
+    }
+
+    pub fn create_proxy(&self) -> EventLoopProxy {
+        EventLoopProxy
+    }
+}
+
+impl EventLoopProxy {
+    pub fn wakeup(&self) -> Result<(), ::EventLoopClosed> {
+        android_glue::wake_event_loop();
+        Ok(())
+    }
+}
+
+#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
+pub struct WindowId;
+
+impl WindowId {
+    pub unsafe fn dummy() -> Self {
+        WindowId
+    }
+}
+
+#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
+pub struct DeviceId;
+
+impl DeviceId {
+    pub unsafe fn dummy() -> Self {
+        DeviceId
+    }
+}
+
+pub struct Window {
+    native_window: *const c_void,
+}
+
+#[derive(Clone)]
+pub struct MonitorHandle;
+
+impl fmt::Debug for MonitorHandle {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        #[derive(Debug)]
+        struct MonitorHandle {
+            name: Option<String>,
+            dimensions: PhysicalSize,
+            position: PhysicalPosition,
+            hidpi_factor: f64,
+        }
+
+        let monitor_id_proxy = MonitorHandle {
+            name: self.get_name(),
+            dimensions: self.get_dimensions(),
+            position: self.get_position(),
+            hidpi_factor: self.get_hidpi_factor(),
+        };
+
+        monitor_id_proxy.fmt(f)
+    }
+}
+
+impl MonitorHandle {
+    #[inline]
+    pub fn get_name(&self) -> Option<String> {
+        Some("Primary".to_string())
+    }
+
+    #[inline]
+    pub fn get_dimensions(&self) -> PhysicalSize {
+        unsafe {
+            let window = android_glue::get_native_window();
+            (
+                ffi::ANativeWindow_getWidth(window) as f64,
+                ffi::ANativeWindow_getHeight(window) as f64,
+            ).into()
+        }
+    }
+
+    #[inline]
+    pub fn get_position(&self) -> PhysicalPosition {
+        // Android assumes single screen
+        (0, 0).into()
+    }
+
+    #[inline]
+    pub fn get_hidpi_factor(&self) -> f64 {
+        1.0
+    }
+}
+
+#[derive(Clone, Default)]
+pub struct PlatformSpecificWindowBuilderAttributes;
+#[derive(Clone, Default)]
+pub struct PlatformSpecificHeadlessBuilderAttributes;
+
+impl Window {
+    pub fn new(_: &EventLoop, win_attribs: WindowAttributes,
+               _: PlatformSpecificWindowBuilderAttributes)
+               -> Result<Window, CreationError>
+    {
+        let native_window = unsafe { android_glue::get_native_window() };
+        if native_window.is_null() {
+            return Err(OsError(format!("Android's native window is null")));
+        }
+
+        android_glue::set_multitouch(win_attribs.multitouch);
+
+        Ok(Window {
+            native_window: native_window as *const _,
+        })
+    }
+
+    #[inline]
+    pub fn get_native_window(&self) -> *const c_void {
+        self.native_window
+    }
+
+    #[inline]
+    pub fn set_title(&self, _: &str) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn show(&self) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn hide(&self) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn get_position(&self) -> Option<LogicalPosition> {
+        // N/A
+        None
+    }
+
+    #[inline]
+    pub fn get_inner_position(&self) -> Option<LogicalPosition> {
+        // N/A
+        None
+    }
+
+    #[inline]
+    pub fn set_position(&self, _position: LogicalPosition) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn set_min_dimensions(&self, _dimensions: Option<LogicalSize>) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn set_max_dimensions(&self, _dimensions: Option<LogicalSize>) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn set_resizable(&self, _resizable: bool) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn get_inner_size(&self) -> Option<LogicalSize> {
+        if self.native_window.is_null() {
+            None
+        } else {
+            let dpi_factor = self.get_hidpi_factor();
+            let physical_size = self.get_current_monitor().get_dimensions();
+            Some(LogicalSize::from_physical(physical_size, dpi_factor))
+        }
+    }
+
+    #[inline]
+    pub fn get_outer_size(&self) -> Option<LogicalSize> {
+        self.get_inner_size()
+    }
+
+    #[inline]
+    pub fn set_inner_size(&self, _size: LogicalSize) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn get_hidpi_factor(&self) -> f64 {
+        self.get_current_monitor().get_hidpi_factor()
+    }
+
+    #[inline]
+    pub fn set_cursor(&self, _: MouseCursor) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn grab_cursor(&self, _grab: bool) -> Result<(), String> {
+        Err("Cursor grabbing is not possible on Android.".to_owned())
+    }
+
+    #[inline]
+    pub fn hide_cursor(&self, _hide: bool) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn set_cursor_position(&self, _position: LogicalPosition) -> Result<(), String> {
+        Err("Setting cursor position is not possible on Android.".to_owned())
+    }
+
+    #[inline]
+    pub fn set_maximized(&self, _maximized: bool) {
+        // N/A
+        // Android has single screen maximized apps so nothing to do
+    }
+
+    #[inline]
+    pub fn set_fullscreen(&self, _monitor: Option<RootMonitorHandle>) {
+        // N/A
+        // Android has single screen maximized apps so nothing to do
+    }
+
+    #[inline]
+    pub fn set_decorations(&self, _decorations: bool) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn set_always_on_top(&self, _always_on_top: bool) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn set_window_icon(&self, _icon: Option<::Icon>) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn set_ime_spot(&self, _spot: LogicalPosition) {
+        // N/A
+    }
+
+    #[inline]
+    pub fn get_current_monitor(&self) -> RootMonitorHandle {
+        RootMonitorHandle { inner: MonitorHandle }
+    }
+
+    #[inline]
+    pub fn get_available_monitors(&self) -> VecDeque<MonitorHandle> {
+        let mut rb = VecDeque::with_capacity(1);
+        rb.push_back(MonitorHandle);
+        rb
+    }
+
+    #[inline]
+    pub fn get_primary_monitor(&self) -> MonitorHandle {
+        MonitorHandle
+    }
+
+    #[inline]
+    pub fn id(&self) -> WindowId {
+        WindowId
+    }
+}
+
+unsafe impl Send for Window {}
+unsafe impl Sync for Window {}
+
+// Constant device ID, to be removed when this backend is updated to report real device IDs.
+const DEVICE_ID: ::DeviceId = ::DeviceId(DeviceId);