Fixed deadlocks

francesca64 · francesca64 · commit 3c7a52ff4df6 · 2018-12-11T15:45:45.000-05:00
diff --git a/src/event.rs b/src/event.rs
@@ -80,7 +80,7 @@ pub enum StartCause {
     Poll,
 
     /// Sent once, immediately after `run` is called. Indicates that the loop was just initialized.
-    Init
+    Init,
 }
 
 /// Describes an event from a `Window`.
diff --git a/src/platform/macos.rs b/src/platform/macos.rs
@@ -138,7 +138,7 @@ impl WindowBuilderExtMacOS for WindowBuilder {
     }
 }
 
-/// Additional methods on `MonitorHandle` that are specific to MacOS.
+/// Additional methods on `MonitorHandle` that are specific to macOS.
 pub trait MonitorHandleExtMacOS {
     /// Returns the identifier of the monitor for Cocoa.
     fn native_id(&self) -> u32;
diff --git a/src/platform_impl/macos/event_loop.rs b/src/platform_impl/macos/event_loop.rs
@@ -1,6 +1,6 @@
 use std::{
-    collections::VecDeque, hint::unreachable_unchecked,
-    marker::PhantomData, os::raw::*, process::exit, sync::{Arc, Mutex, Weak},
+    collections::VecDeque, hint::unreachable_unchecked, marker::PhantomData,
+    mem, os::raw::*, process::exit, sync::{Arc, Mutex, Weak},
 };
 
 use cocoa::{
@@ -15,7 +15,7 @@ use cocoa::{
 use {
     event::{
         self, DeviceEvent, ElementState, Event, KeyboardInput,
-        ModifiersState, TouchPhase, WindowEvent,
+        ModifiersState, StartCause, TouchPhase, WindowEvent,
     },
     event_loop::{ControlFlow, EventLoopClosed, EventLoopWindowTarget as RootELW},
     window,
@@ -59,10 +59,8 @@ impl PendingEvents {
         self.pending.append(&mut events);
     }
 
-    fn process_events<F: FnMut(Event<T>), T: 'static>(&mut self, mut callback: F) {
-        for event in self.pending.drain(0..) {
-            callback(event.userify());
-        }
+    fn take(&mut self) -> VecDeque<Event<Never>> {
+        mem::replace(&mut self.pending, Default::default())
     }
 }
 
@@ -148,17 +146,27 @@ impl<T> EventLoop<T> {
         }
 
         let mut control_flow = Default::default();
+        let mut cause = StartCause::Init;
 
         loop {
-            self.elw_target.inner.pending_events
-                .lock()
-                .unwrap()
-                .process_events(|event| {
-                    callback(event, self.window_target(), &mut control_flow);
-                });
+            callback(Event::NewEvents(cause), self.window_target(), &mut control_flow);
 
-            if let ControlFlow::Exit = control_flow {
-                exit(0);
+            {
+                trace!("Locked pending events in `run`");
+                let mut pending = self.elw_target
+                    .inner
+                    .pending_events
+                    .lock()
+                    .unwrap()
+                    .take();
+                trace!("Unlocked pending events in `run`");
+                for event in pending.drain(0..) {
+                    callback(
+                        event.userify(),
+                        self.window_target(),
+                        &mut control_flow,
+                    );
+                }
             }
 
             let maybe_event = unsafe {
@@ -183,10 +191,16 @@ impl<T> EventLoop<T> {
 
             if let Some(event) = maybe_event {
                 callback(event.userify(), self.window_target(), &mut control_flow);
-                if let ControlFlow::Exit = control_flow {
-                    exit(0);
-                }
             }
+
+            callback(Event::EventsCleared, self.window_target(), &mut control_flow);
+
+            if let ControlFlow::Exit = control_flow {
+                callback(Event::LoopDestroyed, self.window_target(), &mut control_flow);
+                exit(0);
+            }
+
+            cause = StartCause::Poll;
         }
     }
 
@@ -304,10 +318,12 @@ impl<T> EventLoop<T> {
                 }
 
                 let event = events.pop_front();
+                trace!("Locked pending events in `translate_event`");
                 self.elw_target.inner.pending_events
                     .lock()
                     .unwrap()
                     .queue_events(events);
+                trace!("Unlocked pending events in `translate_event`");
                 event
             },
 
@@ -336,10 +352,12 @@ impl<T> EventLoop<T> {
                     modifiers: event_mods(ns_event),
                 };
                 let event = Event::WindowEvent { window_id: window::WindowId(window.id()), event: window_event };
+                trace!("Locked pending events in `translate_event`");
                 self.elw_target.inner.pending_events
                     .lock()
                     .unwrap()
                     .queue_event(event);
+                trace!("Unlocked pending events in `translate_event`");
                 Some(into_event(WindowEvent::CursorEntered { device_id: DEVICE_ID }))
             },
             appkit::NSMouseExited => { Some(into_event(WindowEvent::CursorLeft { device_id: DEVICE_ID })) },
@@ -379,10 +397,12 @@ impl<T> EventLoop<T> {
                 }
 
                 let event = events.pop_front();
+                trace!("Locked pending events in `translate_event`");
                 self.elw_target.inner.pending_events
                     .lock()
                     .unwrap()
                     .queue_events(events);
+                trace!("Unlocked pending events in `translate_event`");
                 event
             },
 
@@ -410,6 +430,7 @@ impl<T> EventLoop<T> {
                     NSEventPhase::NSEventPhaseEnded => TouchPhase::Ended,
                     _ => TouchPhase::Moved,
                 };
+                trace!("Locked pending events in `translate_event`");
                 self.elw_target.inner.pending_events.lock().unwrap().queue_event(Event::DeviceEvent {
                     device_id: DEVICE_ID,
                     event: DeviceEvent::MouseWheel {
@@ -426,6 +447,7 @@ impl<T> EventLoop<T> {
                         },
                     }
                 });
+                trace!("Unlocked pending events in `translate_event`");
                 let window_event = WindowEvent::MouseWheel {
                     device_id: DEVICE_ID,
                     delta,
diff --git a/src/platform_impl/macos/util.rs b/src/platform_impl/macos/util.rs
@@ -89,11 +89,12 @@ pub fn bottom_left_to_top_left(rect: NSRect) -> f64 {
     CGDisplay::main().pixels_high() as f64 - (rect.origin.y + rect.size.height)
 }
 
-pub unsafe fn set_style_mask(window: id, view: id, mask: NSWindowStyleMask) {
+pub unsafe fn set_style_mask(nswindow: id, nsview: id, mask: NSWindowStyleMask) {
+    trace!("`set_style_mask` {:?} {:?} {:?}", nswindow, nsview, mask);
     use cocoa::appkit::NSWindow;
-    window.setStyleMask_(mask);
+    nswindow.setStyleMask_(mask);
     // If we don't do this, key handling will break. Therefore, never call `setStyleMask` directly!
-    window.makeFirstResponder_(view);
+    nswindow.makeFirstResponder_(nsview);
 }
 
 pub unsafe fn create_input_context(view: id) -> IdRef {
diff --git a/src/platform_impl/macos/view.rs b/src/platform_impl/macos/view.rs
@@ -216,15 +216,15 @@ extern fn init_with_winit(this: &Object, _sel: Sel, state: *mut c_void) -> id {
 }
 
 extern fn has_marked_text(this: &Object, _sel: Sel) -> BOOL {
-    debug!("hasMarkedText");
+    trace!("Triggered `hasMarkedText`");
     unsafe {
         let marked_text: id = *this.get_ivar("markedText");
         (marked_text.length() > 0) as i8
     }
 }
 
 extern fn marked_range(this: &Object, _sel: Sel) -> NSRange {
-    debug!("markedRange");
+    trace!("Triggered `markedRange`");
     unsafe {
         let marked_text: id = *this.get_ivar("markedText");
         let length = marked_text.length();
@@ -237,7 +237,7 @@ extern fn marked_range(this: &Object, _sel: Sel) -> NSRange {
 }
 
 extern fn selected_range(_this: &Object, _sel: Sel) -> NSRange {
-    debug!("selectedRange");
+    trace!("Triggered `selectedRange`");
     util::EMPTY_RANGE
 }
 
@@ -248,7 +248,7 @@ extern fn set_marked_text(
     _selected_range: NSRange,
     _replacement_range: NSRange,
 ) {
-    debug!("setMarkedText");
+    trace!("Triggered `setMarkedText`");
     unsafe {
         let marked_text_ref: &mut id = this.get_mut_ivar("markedText");
         let _: () = msg_send![(*marked_text_ref), release];
@@ -264,7 +264,7 @@ extern fn set_marked_text(
 }
 
 extern fn unmark_text(this: &Object, _sel: Sel) {
-    debug!("unmarkText");
+    trace!("Triggered `unmarkText`");
     unsafe {
         let marked_text: id = *this.get_ivar("markedText");
         let mutable_string = marked_text.mutableString();
@@ -275,7 +275,7 @@ extern fn unmark_text(this: &Object, _sel: Sel) {
 }
 
 extern fn valid_attributes_for_marked_text(_this: &Object, _sel: Sel) -> id {
-    debug!("validAttributesForMarkedText");
+    trace!("Triggered `validAttributesForMarkedText`");
     unsafe { msg_send![class!(NSArray), array] }
 }
 
@@ -285,12 +285,12 @@ extern fn attributed_substring_for_proposed_range(
     _range: NSRange,
     _actual_range: *mut c_void, // *mut NSRange
 ) -> id {
-    debug!("attributedSubstringForProposedRange");
+    trace!("Triggered `attributedSubstringForProposedRange`");
     nil
 }
 
 extern fn character_index_for_point(_this: &Object, _sel: Sel, _point: NSPoint) -> NSUInteger {
-    debug!("characterIndexForPoint");
+    trace!("Triggered `characterIndexForPoint`");
     0
 }
 
@@ -300,7 +300,7 @@ extern fn first_rect_for_character_range(
     _range: NSRange,
     _actual_range: *mut c_void, // *mut NSRange
 ) -> NSRect {
-    debug!("firstRectForCharacterRange");
+    trace!("Triggered `firstRectForCharacterRange`");
     unsafe {
         let state_ptr: *mut c_void = *this.get_ivar("winitState");
         let state = &mut *(state_ptr as *mut ViewState);
@@ -322,7 +322,7 @@ extern fn first_rect_for_character_range(
 }
 
 extern fn insert_text(this: &Object, _sel: Sel, string: id, _replacement_range: NSRange) {
-    debug!("insertText");
+    trace!("Triggered `insertText`");
     unsafe {
         let state_ptr: *mut c_void = *this.get_ivar("winitState");
         let state = &mut *(state_ptr as *mut ViewState);
@@ -359,7 +359,7 @@ extern fn insert_text(this: &Object, _sel: Sel, string: id, _replacement_range:
 }
 
 extern fn do_command_by_selector(this: &Object, _sel: Sel, command: Sel) {
-    debug!("doCommandBySelector");
+    trace!("Triggered `doCommandBySelector`");
     // Basically, we're sent this message whenever a keyboard event that doesn't generate a "human readable" character
     // happens, i.e. newlines, tabs, and Ctrl+C.
     unsafe {
@@ -404,7 +404,7 @@ fn get_characters(event: id) -> Option<String> {
 }
 
 extern fn key_down(this: &Object, _sel: Sel, event: id) {
-    debug!("keyDown");
+    trace!("Triggered `keyDown`");
     unsafe {
         let state_ptr: *mut c_void = *this.get_ivar("winitState");
         let state = &mut *(state_ptr as *mut ViewState);
@@ -440,7 +440,7 @@ extern fn key_down(this: &Object, _sel: Sel, event: id) {
         let slice = slice::from_raw_parts(
             characters.UTF8String() as *const c_uchar,
             characters.len(),
-            );
+        );
         let string = str::from_utf8_unchecked(slice);
 
         state.raw_characters = {
@@ -475,7 +475,7 @@ extern fn key_down(this: &Object, _sel: Sel, event: id) {
 }
 
 extern fn key_up(this: &Object, _sel: Sel, event: id) {
-    debug!("keyUp");
+    trace!("Triggered `keyUp`");
     unsafe {
         let state_ptr: *mut c_void = *this.get_ivar("winitState");
         let state = &mut *(state_ptr as *mut ViewState);
diff --git a/src/platform_impl/macos/window.rs b/src/platform_impl/macos/window.rs
diff --git a/src/platform_impl/macos/window_delegate.rs b/src/platform_impl/macos/window_delegate.rs

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ pub enum StartCause {`
`80`	`80`	`Poll,`
`81`	`81`
`82`	`82`	/// Sent once, immediately after `run` is called. Indicates that the loop was just initialized.
`83`		`- Init`
	`83`	`+ Init,`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	/// Describes an event from a `Window`.
Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ impl WindowBuilderExtMacOS for WindowBuilder {`
`138`	`138`	`}`
`139`	`139`	`}`
`140`	`140`
`141`		-/// Additional methods on `MonitorHandle` that are specific to MacOS.
	`141`	+/// Additional methods on `MonitorHandle` that are specific to macOS.
`142`	`142`	`pub trait MonitorHandleExtMacOS {`
`143`	`143`	`/// Returns the identifier of the monitor for Cocoa.`
`144`	`144`	`fn native_id(&self) -> u32;`
Original file line number	Diff line number	Diff line change
`@@ -89,11 +89,12 @@ pub fn bottom_left_to_top_left(rect: NSRect) -> f64 {`
`89`	`89`	`CGDisplay::main().pixels_high() as f64 - (rect.origin.y + rect.size.height)`
`90`	`90`	`}`
`91`	`91`
`92`		`-pub unsafe fn set_style_mask(window: id, view: id, mask: NSWindowStyleMask) {`
	`92`	`+pub unsafe fn set_style_mask(nswindow: id, nsview: id, mask: NSWindowStyleMask) {`
	`93`	+ trace!("`set_style_mask` {:?} {:?} {:?}", nswindow, nsview, mask);
`93`	`94`	`use cocoa::appkit::NSWindow;`
`94`		`- window.setStyleMask_(mask);`
	`95`	`+ nswindow.setStyleMask_(mask);`
`95`	`96`	// If we don't do this, key handling will break. Therefore, never call `setStyleMask` directly!
`96`		`- window.makeFirstResponder_(view);`
	`97`	`+ nswindow.makeFirstResponder_(nsview);`
`97`	`98`	`}`
`98`	`99`
`99`	`100`	`pub unsafe fn create_input_context(view: id) -> IdRef {`