Add initial NSMutableAttributedString

Author: madsmtm

objc2-foundation/CHANGELOG.md

@@ -22,6 +22,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added `NSUUID` object.
 * Added `NSMutableString` object.
 * Added basic `NSAttributedString` object.
+* Added basic `NSMutableAttributedString` object.
 
 ### Changed
 * **BREAKING**: Removed the following helper traits in favor of inherent

objc2-foundation/src/attributed_string.rs

@@ -4,7 +4,9 @@ use objc2::msg_send;
 use objc2::rc::{DefaultId, Id, Shared};
 use objc2::runtime::Object;
 
-use crate::{NSCopying, NSDictionary, NSObject, NSString};
+use crate::{
+    NSCopying, NSDictionary, NSMutableAttributedString, NSMutableCopying, NSObject, NSString,
+};
 
 object! {
     /// A string that has associated attributes for portions of its text.
@@ -114,6 +116,10 @@ unsafe impl NSCopying for NSAttributedString {
     type Output = NSAttributedString;
 }
 
+unsafe impl NSMutableCopying for NSAttributedString {
+    type Output = NSMutableAttributedString;
+}
+
 #[cfg(test)]
 mod tests {
     use alloc::string::ToString;

objc2-foundation/src/lib.rs

@@ -47,6 +47,7 @@ pub use self::copying::{NSCopying, NSMutableCopying};
 pub use self::data::{NSData, NSMutableData};
 pub use self::dictionary::NSDictionary;
 pub use self::enumerator::{NSEnumerator, NSFastEnumeration, NSFastEnumerator};
+pub use self::mutable_attributed_string::NSMutableAttributedString;
 pub use self::mutable_string::NSMutableString;
 pub use self::object::NSObject;
 pub use self::process_info::NSProcessInfo;
@@ -74,6 +75,7 @@ mod copying;
 mod data;
 mod dictionary;
 mod enumerator;
+mod mutable_attributed_string;
 mod mutable_string;
 mod object;
 mod process_info;

objc2-foundation/src/mutable_attributed_string.rs

@@ -0,0 +1,120 @@
+use core::ptr::NonNull;
+
+use objc2::msg_send;
+use objc2::rc::{DefaultId, Id, Owned, Shared};
+
+use crate::{NSAttributedString, NSCopying, NSMutableCopying, NSString};
+
+object! {
+    /// A mutable string that has associated attributes.
+    ///
+    /// See [Apple's documentation](https://developer.apple.com/documentation/foundation/nsmutableattributedstring?language=objc).
+    unsafe pub struct NSMutableAttributedString: NSAttributedString;
+}
+
+// TODO: SAFETY
+unsafe impl Sync for NSMutableAttributedString {}
+unsafe impl Send for NSMutableAttributedString {}
+
+/// Creating mutable attributed strings.
+impl NSMutableAttributedString {
+    unsafe_def_fn! {
+        /// Construct an empty mutable attributed string.
+        pub fn new -> Owned;
+    }
+
+    // TODO: new_with_attributes
+
+    #[doc(alias = "initWithString:")]
+    pub fn from_nsstring(string: &NSString) -> Id<Self, Owned> {
+        unsafe {
+            let obj: *mut Self = msg_send![Self::class(), alloc];
+            let obj: *mut Self = msg_send![obj, initWithString: string];
+            Id::new(NonNull::new_unchecked(obj))
+        }
+    }
+
+    #[doc(alias = "initWithAttributedString:")]
+    pub fn from_attributed_nsstring(attributed_string: &NSAttributedString) -> Id<Self, Owned> {
+        unsafe {
+            let obj: *mut Self = msg_send![Self::class(), alloc];
+            let obj: *mut Self = msg_send![obj, initWithAttributedString: attributed_string];
+            Id::new(NonNull::new_unchecked(obj))
+        }
+    }
+}
+
+/// Modifying the attributed string.
+impl NSMutableAttributedString {
+    // TODO
+    // - mutableString
+    // - replaceCharactersInRange:withString:
+    // - setAttributes:range:
+
+    /// Replaces the entire attributed string.
+    #[doc(alias = "setAttributedString:")]
+    pub fn replace(&mut self, attributed_string: &NSAttributedString) {
+        unsafe { msg_send![self, setAttributedString: attributed_string] }
+    }
+}
+
+impl DefaultId for NSMutableAttributedString {
+    type Ownership = Owned;
+
+    #[inline]
+    fn default_id() -> Id<Self, Self::Ownership> {
+        Self::new()
+    }
+}
+
+unsafe impl NSCopying for NSMutableAttributedString {
+    type Ownership = Shared;
+    type Output = NSAttributedString;
+}
+
+unsafe impl NSMutableCopying for NSMutableAttributedString {
+    type Output = NSMutableAttributedString;
+}
+
+#[cfg(test)]
+mod tests {
+    use alloc::string::ToString;
+    use objc2::rc::autoreleasepool;
+
+    use super::*;
+
+    #[test]
+    fn test_new() {
+        let s = NSAttributedString::new();
+        assert_eq!(&s.string().to_string(), "");
+    }
+
+    #[test]
+    fn test_string_bound_to_attributed() {
+        let attr_s = {
+            let source = NSString::from_str("Hello world!");
+            NSAttributedString::from_nsstring(&source)
+        };
+        let s = autoreleasepool(|_| attr_s.string());
+        assert_eq!(s.len(), 12);
+    }
+
+    #[test]
+    fn test_from_nsstring() {
+        let s = NSAttributedString::from_nsstring(&NSString::from_str("abc"));
+        assert_eq!(&s.string().to_string(), "abc");
+    }
+
+    #[test]
+    fn test_copy() {
+        let s1 = NSAttributedString::from_nsstring(&NSString::from_str("abc"));
+        let s2 = s1.copy();
+        // NSAttributedString also performs this optimization
+        assert_eq!(s1.as_ptr(), s2.as_ptr());
+        assert!(s2.is_kind_of(NSAttributedString::class()));
+
+        // let s3 = s1.mutable_copy();
+        // assert_ne!(s1.as_ptr(), s3.as_ptr() as *mut NSAttributedString);
+        // assert!(s3.is_kind_of(NSMutableAttributedString::class()));
+    }
+}