macOS RAII trace guards (#2150)

* Add TraceGuard to make tracing simpler

* Add SharedStateMutexGuard to make tracing simpler

* Add trace_scope macro

* Add missing let binding in trace_scope!

src/platform_impl/macos/util/async.rs

@@ -14,7 +14,11 @@ use objc::runtime::{BOOL, NO};
 
 use crate::{
     dpi::LogicalSize,
-    platform_impl::platform::{ffi, util::IdRef, window::SharedState},
+    platform_impl::platform::{
+        ffi,
+        util::IdRef,
+        window::{SharedState, SharedStateMutexGuard},
+    },
 };
 
 // Unsafe wrapper type that allows us to dispatch things that aren't Send.
@@ -111,10 +115,11 @@ pub unsafe fn toggle_full_screen_async(
             if !curr_mask.contains(required) {
                 set_style_mask(*ns_window, *ns_view, required);
                 if let Some(shared_state) = shared_state.upgrade() {
-                    trace!("Locked shared state in `toggle_full_screen_callback`");
-                    let mut shared_state_lock = shared_state.lock().unwrap();
+                    let mut shared_state_lock = SharedStateMutexGuard::new(
+                        shared_state.lock().unwrap(),
+                        "toggle_full_screen_callback",
+                    );
                     (*shared_state_lock).saved_style = Some(curr_mask);
-                    trace!("Unlocked shared state in `toggle_full_screen_callback`");
                 }
             }
         }
@@ -144,8 +149,8 @@ pub unsafe fn set_maximized_async(
     let shared_state = MainThreadSafe(shared_state);
     Queue::main().exec_async(move || {
         if let Some(shared_state) = shared_state.upgrade() {
-            trace!("Locked shared state in `set_maximized`");
-            let mut shared_state_lock = shared_state.lock().unwrap();
+            let mut shared_state_lock =
+                SharedStateMutexGuard::new(shared_state.lock().unwrap(), "set_maximized");
 
             // Save the standard frame sized if it is not zoomed
             if !is_zoomed {
@@ -171,8 +176,6 @@ pub unsafe fn set_maximized_async(
                 };
                 ns_window.setFrame_display_(new_rect, NO);
             }
-
-            trace!("Unlocked shared state in `set_maximized`");
         }
     });
 }

src/platform_impl/macos/util/mod.rs

@@ -11,7 +11,7 @@ use cocoa::{
     foundation::{NSPoint, NSRect, NSString, NSUInteger},
 };
 use core_graphics::display::CGDisplay;
-use objc::runtime::{Class, Object, Sel, BOOL, YES};
+use objc::runtime::{Class, Object};
 
 use crate::dpi::LogicalPosition;
 use crate::platform_impl::platform::ffi;
@@ -79,6 +79,35 @@ impl Clone for IdRef {
     }
 }
 
+macro_rules! trace_scope {
+    ($s:literal) => {
+        let _crate = $crate::platform_impl::platform::util::TraceGuard::new(module_path!(), $s);
+    };
+}
+
+pub(crate) struct TraceGuard {
+    module_path: &'static str,
+    called_from_fn: &'static str,
+}
+
+impl TraceGuard {
+    #[inline]
+    pub(crate) fn new(module_path: &'static str, called_from_fn: &'static str) -> Self {
+        trace!(target: module_path, "Triggered `{}`", called_from_fn);
+        Self {
+            module_path,
+            called_from_fn,
+        }
+    }
+}
+
+impl Drop for TraceGuard {
+    #[inline]
+    fn drop(&mut self) {
+        trace!(target: self.module_path, "Completed `{}`", self.called_from_fn);
+    }
+}
+
 // For consistency with other platforms, this will...
 // 1. translate the bottom-left window corner into the top-left window corner
 // 2. translate the coordinate from a bottom-left origin coordinate system to a top-left one
@@ -129,10 +158,6 @@ pub unsafe fn open_emoji_picker() {
     let () = msg_send![NSApp(), orderFrontCharacterPalette: nil];
 }
 
-pub extern "C" fn yes(_: &Object, _: Sel) -> BOOL {
-    YES
-}
-
 pub unsafe fn toggle_style_mask(window: id, view: id, mask: NSWindowStyleMask, on: bool) {
     use cocoa::appkit::NSWindow;