Add more NSUUID functionality

Author: madsmtm

.github/workflows/ci.yml

@@ -153,7 +153,7 @@ jobs:
       # Use --no-fail-fast, except with dinghy
       TESTARGS: ${{ matrix.dinghy && ' ' || '--no-fail-fast' }} ${{ matrix.test-args }}
       SOME_FEATURES: ${{ matrix.features || 'malloc,block,exception' }}
-      FEATURES: ${{ matrix.features || 'malloc,block,exception,catch-all,verify_message' }}
+      FEATURES: ${{ matrix.features || 'malloc,block,exception,catch-all,verify_message,uuid' }}
       UNSTABLE_FEATURES: ${{ matrix.unstable-features || 'unstable-autoreleasesafe,unstable-c-unwind' }}
 
     runs-on: ${{ matrix.os }}

objc2-foundation/Cargo.toml

@@ -40,9 +40,12 @@ gnustep-2-1 = ["gnustep-2-0", "objc2/gnustep-2-1", "block2?/gnustep-2-1"]
 block2 = { path = "../block2", version = "=0.2.0-alpha.5", default-features = false, optional = true }
 objc2 = { path = "../objc2", version = "=0.3.0-beta.1", default-features = false }
 
+# Provides methods to convert between `uuid::Uuid` and `NSUUID`
+uuid = { version = "1.1.2", optional = true, default-features = false }
+
 [package.metadata.docs.rs]
 default-target = "x86_64-apple-darwin"
-features = ["block", "unstable-docsrs"]
+features = ["block", "uuid", "unstable-docsrs"]
 
 targets = [
     # MacOS

objc2-foundation/src/uuid.rs

@@ -1,5 +1,6 @@
 use core::panic::{RefUnwindSafe, UnwindSafe};
 
+use objc2::rc::DefaultId;
 use objc2::rc::{Id, Shared};
 use objc2::{msg_send, msg_send_id, Encode, Encoding, RefEncode};
 
@@ -10,6 +11,9 @@ extern_class! {
     ///
     /// Can be used to identify types, interfaces, and other items.
     ///
+    /// Conversion methods to/from UUIDs from the `uuid` crate can be
+    /// enabled with the `uuid` crate feature.
+    ///
     /// See [Apple's documentation](https://developer.apple.com/documentation/foundation/nsuuid?language=objc).
     #[derive(Debug, PartialEq, Eq, Hash)]
     unsafe pub struct NSUUID: NSObject;
@@ -35,12 +39,15 @@ impl UnwindSafe for NSUUID {}
 impl RefUnwindSafe for NSUUID {}
 
 impl NSUUID {
-    // TODO: `nil` method?
-
     pub fn new_v4() -> Id<Self, Shared> {
         unsafe { msg_send_id![Self::class(), new].unwrap() }
     }
 
+    /// The 'nil UUID'.
+    pub fn nil() -> Id<Self, Shared> {
+        Self::from_bytes([0; 16])
+    }
+
     pub fn from_bytes(bytes: [u8; 16]) -> Id<Self, Shared> {
         let bytes = UuidBytes(bytes);
         unsafe {
@@ -49,7 +56,12 @@ impl NSUUID {
         }
     }
 
-    // TODO: `parse_str` using initWithUUIDString:
+    pub fn from_string(string: &NSString) -> Option<Id<Self, Shared>> {
+        unsafe {
+            let obj = msg_send_id![Self::class(), alloc];
+            msg_send_id![obj, initWithUUIDString: string]
+        }
+    }
 
     pub fn as_bytes(&self) -> [u8; 16] {
         let mut bytes = UuidBytes([0; 16]);
@@ -58,11 +70,40 @@ impl NSUUID {
     }
 }
 
+// UUID `compare:` is broken for some reason?
+
+// impl PartialOrd for NSUUID {
+//     #[inline]
+//     fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
+//         Some(self.cmp(other))
+//     }
+// }
+
+// impl Ord for NSUUID {
+//     fn cmp(&self, other: &Self) -> cmp::Ordering {
+//         let res: NSComparisonResult = unsafe { msg_send![self, compare: other] };
+//         res.into()
+//     }
+// }
+
 /// Conversion methods to/from `uuid` crate.
 #[cfg(feature = "uuid")]
-// TODO: Research how stable the `uuid` crate is (or if we'll have to update
-// it constantly).
-impl NSUUID {}
+impl NSUUID {
+    pub fn from_uuid(uuid: uuid::Uuid) -> Id<Self, Shared> {
+        Self::from_bytes(uuid.into_bytes())
+    }
+
+    pub fn as_uuid(&self) -> uuid::Uuid {
+        uuid::Uuid::from_bytes(self.as_bytes())
+    }
+}
+
+impl DefaultId for NSUUID {
+    type Ownership = Shared;
+    fn default_id() -> Id<Self, Self::Ownership> {
+        Self::nil()
+    }
+}
 
 unsafe impl NSCopying for NSUUID {
     type Ownership = Shared;
@@ -92,4 +133,20 @@ mod tests {
         let uuid = NSUUID::from_bytes([10; 16]);
         assert_eq!(uuid.as_bytes(), [10; 16]);
     }
+
+    // #[test]
+    // fn test_compare() {
+    //     let uuid1 = NSUUID::from_bytes([10; 16]);
+    //     let uuid2 = NSUUID::from_bytes([9; 16]);
+    //     assert!(uuid1 > uuid2);
+    // }
+
+    #[cfg(feature = "uuid")]
+    #[test]
+    fn test_convert_roundtrip() {
+        let nsuuid1 = NSUUID::new_v4();
+        let uuid = nsuuid1.as_uuid();
+        let nsuuid2 = NSUUID::from_uuid(uuid);
+        assert_eq!(nsuuid1, nsuuid2);
+    }
 }