Enable generation of init and new methods

Author: madsmtm

crates/header-translator/src/data/Foundation.rs

@@ -3,10 +3,12 @@ data! {
     // and returning mutable references to those would be unsound - hence
     // `NSArray` cannot be mutable.
     class NSArray: ImmutableWithMutableSubclass<Foundation::NSMutableArray> {
+        unsafe -init;
         unsafe -count;
     }
 
     class NSMutableArray: MutableWithImmutableSuperclass<Foundation::NSArray> {
+        unsafe -init;
         unsafe -removeAllObjects;
     }
 
@@ -28,6 +30,7 @@ data! {
     }
 
     class NSMutableString: MutableWithImmutableSuperclass<Foundation::NSString> {
+        unsafe -init;
         unsafe -initWithCapacity;
         unsafe +stringWithCapacity;
         unsafe -initWithString;
@@ -43,13 +46,15 @@ data! {
     class NSConstantString: Immutable {}
 
     class NSAttributedString: ImmutableWithMutableSubclass<Foundation::NSMutableAttributedString> {
+        unsafe -init;
         unsafe -initWithString;
         unsafe -initWithAttributedString;
         unsafe -string;
         unsafe -length;
     }
 
     class NSMutableAttributedString: MutableWithImmutableSuperclass<Foundation::NSAttributedString> {
+        unsafe -init;
         unsafe -initWithString;
         unsafe -initWithAttributedString;
         unsafe -setAttributedString;
@@ -61,13 +66,15 @@ data! {
     }
 
     class NSData: ImmutableWithMutableSubclass<Foundation::NSMutableData> {
+        unsafe -init;
         unsafe -initWithData;
         unsafe +dataWithData;
         unsafe -length;
         unsafe -bytes;
     }
 
     class NSMutableData: MutableWithImmutableSuperclass<Foundation::NSData> {
+        unsafe -init;
         unsafe +dataWithData;
         unsafe -initWithCapacity;
         unsafe +dataWithCapacity;
@@ -81,10 +88,12 @@ data! {
     class NSPurgeableData: Mutable {}
 
     class NSDictionary: ImmutableWithMutableSubclass<Foundation::NSMutableDictionary> {
+        unsafe -init;
         unsafe -count;
     }
 
     class NSMutableDictionary: MutableWithImmutableSuperclass<Foundation::NSDictionary> {
+        unsafe -init;
         unsafe -removeObjectForKey;
         unsafe -removeAllObjects;
     }
@@ -103,6 +112,7 @@ data! {
     }
 
     class NSLock {
+        unsafe -init;
         unsafe -name;
         unsafe -setName;
     }
@@ -120,6 +130,7 @@ data! {
     }
 
     class NSThread {
+        unsafe -init;
         unsafe +currentThread;
         unsafe +mainThread;
         unsafe -name;
@@ -135,10 +146,12 @@ data! {
     }
 
     class NSSet: ImmutableWithMutableSubclass<Foundation::NSMutableSet> {
+        unsafe -init;
         unsafe -count;
     }
 
     class NSMutableSet: MutableWithImmutableSuperclass<Foundation::NSSet> {
+        unsafe -init;
         unsafe -removeAllObjects;
     }
 

crates/header-translator/src/data/macros.rs

@@ -152,6 +152,41 @@ macro_rules! __data_methods {
     (
         @($data:expr)
     ) => {};
+    // Mark init (and by extension, `new`) method as safe
+    (
+        @($data:expr)
+
+        unsafe -init;
+
+        $($rest:tt)*
+    ) => {
+        let mut method_data = $data.methods.entry("init".to_string()).or_default();
+        method_data.unsafe_ = false;
+
+        let mut method_data = $data.methods.entry("new".to_string()).or_default();
+        method_data.unsafe_ = false;
+
+        __data_methods! {
+            @($data)
+            $($rest)*
+        }
+    };
+    // Mark new (and by extension, `init`) method as safe
+    (
+        @($data:expr)
+
+        unsafe +new;
+
+        $($rest:tt)*
+    ) => {
+        __data_methods! {
+            @($data)
+
+            unsafe -init;
+
+            $($rest)*
+        }
+    };
     // Mark method as safe
     (
         @($data:expr)

crates/header-translator/src/method.rs

@@ -580,10 +580,9 @@ impl Method {
             return false;
         }
         if self.is_class {
-            !matches!(&*self.selector, "new" | "supportsSecureCoding")
+            true
         } else {
             self.memory_management == MemoryManagement::IdInit
-                && !matches!(&*self.selector, "init" | "initWithCoder:")
         }
     }
 }

crates/header-translator/translation-config.toml

@@ -1319,6 +1319,24 @@ derives = "Debug, PartialEq, Hash"
 skipped = true
 [class.NSValue.methods.new]
 skipped = true
+[class.NSNumber.methods.init]
+skipped = true
+[class.NSNumber.methods.new]
+skipped = true
+
+# Marked as API_UNAVAILABLE in a category, so we hit the duplicate checking
+[class.NSLocale.methods.init]
+skipped = true
+[class.NSLocale.methods.new]
+skipped = true
+[class.NSNotification.methods.init]
+skipped = true
+[class.NSNotification.methods.new]
+skipped = true
+[class.GKLeaderboard.methods.init]
+skipped = true
+[class.GKLeaderboard.methods.new]
+skipped = true
 
 # Manual definitions
 [class.NSException.methods.raise]
@@ -1327,6 +1345,10 @@ skipped = true
 skipped = true
 [class.NSMutableData.methods.length]
 skipped = true
+[class.NSError.methods.new]
+skipped = true
+[class.NSException.methods.new]
+skipped = true
 
 # Wrong type on GNUStep
 [class.NSMutableData.methods.mutableBytes]

crates/icrate/CHANGELOG.md

@@ -30,6 +30,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
   - `NSDictionary::values_retained`
 * Added `MainThreadMarker::alloc` for allocating objects that need to be so on
   the main thread.
+* Added automatically generated `new`/`init` methods for all types.
 
 ### Changed
 * **BREAKING**: Renamed the `from_slice` method on `NSArray`, `NSSet`,

crates/icrate/src/Foundation/additions/array.rs

@@ -16,10 +16,6 @@ use crate::Foundation::{self, NSArray};
 extern_methods!(
     /// Creation methods.
     unsafe impl<T: Message> NSArray<T> {
-        /// Get an empty array.
-        #[method_id(new)]
-        pub fn new() -> Id<Self>;
-
         pub fn from_vec(mut vec: Vec<Id<T>>) -> Id<Self> {
             // We intentionally extract the length before we access the
             // pointer as mutable, to not invalidate that mutable pointer.

crates/icrate/src/Foundation/additions/attributed_string.rs

@@ -19,10 +19,6 @@ impl RefUnwindSafe for NSAttributedString {}
 extern_methods!(
     /// Creating attributed strings.
     unsafe impl NSAttributedString {
-        /// Construct an empty attributed string.
-        #[method_id(new)]
-        pub fn new() -> Id<Self>;
-
         /// Creates a new attributed string from the given string and attributes.
         ///
         /// The attributes are associated with every UTF-16 code unit in the

crates/icrate/src/Foundation/additions/data.rs

@@ -19,60 +19,52 @@ unsafe impl Send for NSData {}
 impl UnwindSafe for NSData {}
 impl RefUnwindSafe for NSData {}
 
-extern_methods!(
-    /// Creation methods.
-    unsafe impl NSData {
-        #[method_id(new)]
-        pub fn new() -> Id<Self>;
-
-        pub fn with_bytes(bytes: &[u8]) -> Id<Self> {
-            let bytes_ptr = bytes.as_ptr() as *mut c_void;
-            unsafe { Self::initWithBytes_length(Self::alloc(), bytes_ptr, bytes.len()) }
-        }
+/// Creation methods.
+impl NSData {
+    pub fn with_bytes(bytes: &[u8]) -> Id<Self> {
+        let bytes_ptr = bytes.as_ptr() as *mut c_void;
+        unsafe { Self::initWithBytes_length(Self::alloc(), bytes_ptr, bytes.len()) }
+    }
 
-        #[cfg(feature = "block")]
-        pub fn from_vec(bytes: Vec<u8>) -> Id<Self> {
-            // GNUStep's NSData `initWithBytesNoCopy:length:deallocator:` has a
-            // bug; it forgets to assign the input buffer and length to the
-            // instance before it swizzles to NSDataWithDeallocatorBlock.
-            // See https://github.com/gnustep/libs-base/pull/213
-            // So we just use NSDataWithDeallocatorBlock directly.
-            //
-            // NSMutableData does not have this problem.
-            #[cfg(feature = "gnustep-1-7")]
-            let cls = objc2::class!(NSDataWithDeallocatorBlock);
-            #[cfg(not(feature = "gnustep-1-7"))]
-            let cls = Self::class();
-
-            unsafe { Id::cast(with_vec(cls, bytes)) }
-        }
+    #[cfg(feature = "block")]
+    pub fn from_vec(bytes: Vec<u8>) -> Id<Self> {
+        // GNUStep's NSData `initWithBytesNoCopy:length:deallocator:` has a
+        // bug; it forgets to assign the input buffer and length to the
+        // instance before it swizzles to NSDataWithDeallocatorBlock.
+        // See https://github.com/gnustep/libs-base/pull/213
+        // So we just use NSDataWithDeallocatorBlock directly.
+        //
+        // NSMutableData does not have this problem.
+        #[cfg(feature = "gnustep-1-7")]
+        let cls = objc2::class!(NSDataWithDeallocatorBlock);
+        #[cfg(not(feature = "gnustep-1-7"))]
+        let cls = Self::class();
+
+        unsafe { Id::cast(with_vec(cls, bytes)) }
     }
+}
 
-    /// Accessor methods.
-    unsafe impl NSData {
-        pub fn len(&self) -> usize {
-            self.length()
-        }
+/// Accessor methods.
+impl NSData {
+    pub fn len(&self) -> usize {
+        self.length()
+    }
 
-        pub fn is_empty(&self) -> bool {
-            self.len() == 0
-        }
+    pub fn is_empty(&self) -> bool {
+        self.len() == 0
+    }
 
-        #[method(bytes)]
-        fn bytes_raw(&self) -> *const c_void;
-
-        pub fn bytes(&self) -> &[u8] {
-            let ptr = self.bytes_raw();
-            let ptr: *const u8 = ptr.cast();
-            // The bytes pointer may be null for length zero
-            if ptr.is_null() {
-                &[]
-            } else {
-                unsafe { slice::from_raw_parts(ptr, self.len()) }
-            }
+    pub fn bytes(&self) -> &[u8] {
+        let ptr = self.bytes_raw();
+        let ptr: *const u8 = ptr.cast();
+        // The bytes pointer may be null for length zero
+        if ptr.is_null() {
+            &[]
+        } else {
+            unsafe { slice::from_raw_parts(ptr, self.len()) }
         }
     }
-);
+}
 
 impl AsRef<[u8]> for NSData {
     fn as_ref(&self) -> &[u8] {

crates/icrate/src/Foundation/additions/dictionary.rs

@@ -18,9 +18,6 @@ use crate::Foundation::{self, Copyhelper, NSDictionary};
 
 extern_methods!(
     unsafe impl<K: Message, V: Message> NSDictionary<K, V> {
-        #[method_id(new)]
-        pub fn new() -> Id<Self>;
-
         pub fn from_keys_and_objects<T>(keys: &[&T], mut vals: Vec<Id<V>>) -> Id<Self>
         where
             T: ClassType + Foundation::NSCopying,