Merge pull request #521 from madsmtm/redo-ivars

Redo instance variables

Author: madsmtm

Cargo.lock

@@ -1,5 +1,5 @@
 #![deny(unsafe_op_in_unsafe_fn)]
-use core::{cell::OnceCell, ptr::NonNull};
+use core::cell::OnceCell;
 
 #[allow(deprecated)]
 use icrate::{
@@ -19,26 +19,23 @@ use icrate::{
     WebKit::{WKNavigation, WKNavigationDelegate, WKWebView},
 };
 use objc2::{
-    declare::{Ivar, IvarDrop},
-    declare_class, msg_send, msg_send_id,
+    declare_class, msg_send_id,
     mutability::MainThreadOnly,
     rc::Id,
     runtime::{AnyObject, ProtocolObject, Sel},
-    sel, ClassType,
+    sel, ClassType, DeclaredClass,
 };
 
-type IdCell<T> = Box<OnceCell<Id<T>>>;
-
 macro_rules! idcell {
     ($name:ident => $this:expr) => {
-        $this.$name.set($name).expect(&format!(
+        $this.ivars().$name.set($name).expect(&format!(
             "ivar should not already be initialized: `{}`",
             stringify!($name)
         ));
     };
     ($name:ident <= $this:expr) => {
         #[rustfmt::skip]
-        let Some($name) = $this.$name.get() else {
+        let Some($name) = $this.ivars().$name.get() else {
             unreachable!(
                 "ivar should be initialized: `{}`",
                 stringify!($name)
@@ -47,31 +44,28 @@ macro_rules! idcell {
     };
 }
 
+#[derive(Default)]
+struct Ivars {
+    nav_url: OnceCell<Id<NSTextField>>,
+    web_view: OnceCell<Id<WKWebView>>,
+    window: OnceCell<Id<NSWindow>>,
+}
+
 declare_class!(
-    struct Delegate {
-        nav_url: IvarDrop<IdCell<NSTextField>, "_nav_url">,
-        web_view: IvarDrop<IdCell<WKWebView>, "_web_view">,
-        window: IvarDrop<IdCell<NSWindow>, "_window">,
-    }
-    mod ivars;
+    struct Delegate;
 
+    // SAFETY:
+    // - The superclass NSObject does not have any subclassing requirements.
+    // - Main thread only mutability is correct, since this is an application delegate.
+    // - `Delegate` does not implement `Drop`.
     unsafe impl ClassType for Delegate {
         type Super = NSObject;
         type Mutability = MainThreadOnly;
         const NAME: &'static str = "Delegate";
     }
 
-    unsafe impl Delegate {
-        #[method(init)]
-        unsafe fn init(this: *mut Self) -> Option<NonNull<Self>> {
-            let this: Option<&mut Self> = msg_send![super(this), init];
-            this.map(|this| {
-                Ivar::write(&mut this.nav_url, IdCell::default());
-                Ivar::write(&mut this.web_view, IdCell::default());
-                Ivar::write(&mut this.window, IdCell::default());
-                NonNull::from(this)
-            })
-        }
+    impl DeclaredClass for Delegate {
+        type Ivars = Ivars;
     }
 
     unsafe impl NSObjectProtocol for Delegate {}
@@ -298,7 +292,9 @@ declare_class!(
 
 impl Delegate {
     pub fn new(mtm: MainThreadMarker) -> Id<Self> {
-        unsafe { msg_send_id![mtm.alloc(), init] }
+        let this = mtm.alloc();
+        let this = this.set_ivars(Ivars::default());
+        unsafe { msg_send_id![super(this), init] }
     }
 }
 
@@ -307,10 +303,8 @@ fn main() {
     let app = NSApplication::sharedApplication(mtm);
     app.setActivationPolicy(NSApplicationActivationPolicyRegular);
 
-    // initialize the delegate
-    let delegate = Delegate::new(mtm);
-
     // configure the application delegate
+    let delegate = Delegate::new(mtm);
     let object = ProtocolObject::from_ref(&*delegate);
     app.setDelegate(Some(object));
 

crates/icrate/examples/browser.rs

@@ -1,53 +1,38 @@
 #![deny(unsafe_op_in_unsafe_fn)]
-use std::ptr::NonNull;
-
 use icrate::AppKit::{NSApplication, NSApplicationActivationPolicyRegular, NSApplicationDelegate};
 use icrate::Foundation::{
     ns_string, MainThreadMarker, NSCopying, NSNotification, NSObject, NSObjectProtocol, NSString,
 };
-use objc2::declare::{Ivar, IvarBool, IvarDrop, IvarEncode};
 use objc2::rc::Id;
 use objc2::runtime::ProtocolObject;
-use objc2::{declare_class, msg_send, msg_send_id, mutability, ClassType};
+use objc2::{declare_class, msg_send_id, mutability, ClassType, DeclaredClass};
+
+#[derive(Debug)]
+#[allow(unused)]
+struct Ivars {
+    ivar: u8,
+    another_ivar: bool,
+    box_ivar: Box<i32>,
+    maybe_box_ivar: Option<Box<i32>>,
+    id_ivar: Id<NSString>,
+    maybe_id_ivar: Option<Id<NSString>>,
+}
 
 declare_class!(
-    #[derive(Debug)]
-    struct AppDelegate {
-        ivar: IvarEncode<u8, "_ivar">,
-        another_ivar: IvarBool<"_another_ivar">,
-        box_ivar: IvarDrop<Box<i32>, "_box_ivar">,
-        maybe_box_ivar: IvarDrop<Option<Box<i32>>, "_maybe_box_ivar">,
-        id_ivar: IvarDrop<Id<NSString>, "_id_ivar">,
-        maybe_id_ivar: IvarDrop<Option<Id<NSString>>, "_maybe_id_ivar">,
-    }
-
-    mod ivars;
+    struct AppDelegate;
 
+    // SAFETY:
+    // - The superclass NSObject does not have any subclassing requirements.
+    // - Main thread only mutability is correct, since this is an application delegate.
+    // - `AppDelegate` does not implement `Drop`.
     unsafe impl ClassType for AppDelegate {
         type Super = NSObject;
         type Mutability = mutability::MainThreadOnly;
         const NAME: &'static str = "MyAppDelegate";
     }
 
-    unsafe impl AppDelegate {
-        #[method(initWith:another:)]
-        unsafe fn init_with(
-            this: *mut Self,
-            ivar: u8,
-            another_ivar: bool,
-        ) -> Option<NonNull<Self>> {
-            let this: Option<&mut Self> = unsafe { msg_send![super(this), init] };
-
-            this.map(|this| {
-                Ivar::write(&mut this.ivar, ivar);
-                Ivar::write(&mut this.another_ivar, another_ivar);
-                Ivar::write(&mut this.maybe_box_ivar, None);
-                Ivar::write(&mut this.maybe_id_ivar, Some(ns_string!("def").copy()));
-                Ivar::write(&mut this.box_ivar, Box::new(2));
-                Ivar::write(&mut this.id_ivar, NSString::from_str("abc"));
-                NonNull::from(this)
-            })
-        }
+    impl DeclaredClass for AppDelegate {
+        type Ivars = Ivars;
     }
 
     unsafe impl NSObjectProtocol for AppDelegate {}
@@ -69,7 +54,16 @@ declare_class!(
 
 impl AppDelegate {
     pub fn new(ivar: u8, another_ivar: bool, mtm: MainThreadMarker) -> Id<Self> {
-        unsafe { msg_send_id![mtm.alloc(), initWith: ivar, another: another_ivar] }
+        let this = mtm.alloc();
+        let this = this.set_ivars(Ivars {
+            ivar,
+            another_ivar,
+            box_ivar: Box::new(2),
+            maybe_box_ivar: None,
+            id_ivar: NSString::from_str("abc"),
+            maybe_id_ivar: Some(ns_string!("def").copy()),
+        });
+        unsafe { msg_send_id![super(this), init] }
     }
 }
 
@@ -79,12 +73,8 @@ fn main() {
     let app = NSApplication::sharedApplication(mtm);
     app.setActivationPolicy(NSApplicationActivationPolicyRegular);
 
-    // initialize the delegate
-    let delegate = AppDelegate::new(42, true, mtm);
-
-    println!("{delegate:?}");
-
     // configure the application delegate
+    let delegate = AppDelegate::new(42, true, mtm);
     let object = ProtocolObject::from_ref(&*delegate);
     app.setDelegate(Some(object));
 

crates/icrate/examples/delegate.rs

@@ -20,12 +20,8 @@ use icrate::{
     MetalKit::{MTKView, MTKViewDelegate},
 };
 use objc2::{
-    declare::{Ivar, IvarDrop},
-    declare_class, msg_send, msg_send_id,
-    mutability::MainThreadOnly,
-    rc::Id,
-    runtime::ProtocolObject,
-    ClassType,
+    declare_class, msg_send_id, mutability::MainThreadOnly, rc::Id, runtime::ProtocolObject,
+    ClassType, DeclaredClass,
 };
 
 #[rustfmt::skip]
@@ -101,18 +97,16 @@ pub struct Color {
     pub b: f32,
 }
 
-type IdCell<T> = Box<OnceCell<Id<T>>>;
-
 macro_rules! idcell {
     ($name:ident => $this:expr) => {
-        $this.$name.set($name).expect(&format!(
+        $this.ivars().$name.set($name).expect(&format!(
             "ivar should not already be initialized: `{}`",
             stringify!($name)
         ));
     };
     ($name:ident <= $this:expr) => {
         #[rustfmt::skip]
-        let Some($name) = $this.$name.get() else {
+        let Some($name) = $this.ivars().$name.get() else {
             unreachable!(
                 "ivar should be initialized: `{}`",
                 stringify!($name)
@@ -121,38 +115,30 @@ macro_rules! idcell {
     };
 }
 
+// declare the desired instance variables
+struct Ivars {
+    start_date: Id<NSDate>,
+    command_queue: OnceCell<Id<ProtocolObject<dyn MTLCommandQueue>>>,
+    pipeline_state: OnceCell<Id<ProtocolObject<dyn MTLRenderPipelineState>>>,
+    window: OnceCell<Id<NSWindow>>,
+}
+
 // declare the Objective-C class machinery
 declare_class!(
-    // declare the delegate class with our instance variables
-    #[rustfmt::skip] // FIXME: rustfmt breaks the macro parsing apparently
-    struct Delegate {
-        start_date: IvarDrop<Id<NSDate>, "_start_date">,
-        command_queue: IvarDrop<IdCell<ProtocolObject<dyn MTLCommandQueue>>, "_command_queue">,
-        pipeline_state: IvarDrop<IdCell<ProtocolObject<dyn MTLRenderPipelineState>>, "_pipeline_state">,
-        window: IvarDrop<IdCell<NSWindow>, "_window">,
-    }
-    mod ivars;
+    struct Delegate;
 
-    // declare the class type
+    // SAFETY:
+    // - The superclass NSObject does not have any subclassing requirements.
+    // - Main thread only mutability is correct, since this is an application delegate.
+    // - `Delegate` does not implement `Drop`.
     unsafe impl ClassType for Delegate {
         type Super = NSObject;
         type Mutability = MainThreadOnly;
         const NAME: &'static str = "Delegate";
     }
 
-    // define the Delegate methods (e.g., initializer)
-    unsafe impl Delegate {
-        #[method(init)]
-        unsafe fn init(this: *mut Self) -> Option<NonNull<Self>> {
-            let this: Option<&mut Self> = msg_send![super(this), init];
-            this.map(|this| {
-                Ivar::write(&mut this.start_date, unsafe { NSDate::now() });
-                Ivar::write(&mut this.command_queue, IdCell::default());
-                Ivar::write(&mut this.pipeline_state, IdCell::default());
-                Ivar::write(&mut this.window, IdCell::default());
-                NonNull::from(this)
-            })
-        }
+    impl DeclaredClass for Delegate {
+        type Ivars = Ivars;
     }
 
     unsafe impl NSObjectProtocol for Delegate {}
@@ -277,7 +263,7 @@ declare_class!(
 
             // compute the scene properties
             let scene_properties_data = &SceneProperties {
-                time: unsafe { self.start_date.timeIntervalSinceNow() } as f32,
+                time: unsafe { self.ivars().start_date.timeIntervalSinceNow() } as f32,
             };
             // write the scene properties to the vertex shader argument buffer at index 0
             let scene_properties_bytes = NonNull::from(scene_properties_data);
@@ -360,7 +346,14 @@ declare_class!(
 
 impl Delegate {
     pub fn new(mtm: MainThreadMarker) -> Id<Self> {
-        unsafe { msg_send_id![mtm.alloc(), init] }
+        let this = mtm.alloc();
+        let this = this.set_ivars(Ivars {
+            start_date: unsafe { NSDate::now() },
+            command_queue: OnceCell::default(),
+            pipeline_state: OnceCell::default(),
+            window: OnceCell::default(),
+        });
+        unsafe { msg_send_id![super(this), init] }
     }
 }
 
@@ -370,10 +363,8 @@ fn main() {
     let app = NSApplication::sharedApplication(mtm);
     app.setActivationPolicy(NSApplicationActivationPolicyRegular);
 
-    // initialize the delegate
-    let delegate = Delegate::new(mtm);
-
     // configure the application delegate
+    let delegate = Delegate::new(mtm);
     let object = ProtocolObject::from_ref(&*delegate);
     app.setDelegate(Some(object));
 

crates/icrate/examples/metal.rs

@@ -122,7 +122,7 @@ fn test_retains_stored() {
 
     drop(obj);
     expected.release += 1;
-    expected.dealloc += 1;
+    expected.drop += 1;
     expected.assert_current();
 }
 
@@ -187,7 +187,7 @@ fn test_iter_minimal_retains() {
 
     assert_eq!(iter.count(), 0);
     expected.release += 1;
-    expected.dealloc += 1;
+    expected.drop += 1;
     expected.assert_current();
 }