1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
use alloc::vec::Vec;
use core::fmt;
use core::marker::PhantomData;
use core::ops::{Index, IndexMut};
use core::panic::{RefUnwindSafe, UnwindSafe};
use core::ptr;
use super::{NSArray, NSCopying, NSDictionary, NSFastEnumeration, NSObject};
use crate::rc::{DefaultId, Id, Owned, Shared};
use crate::{ClassType, __inner_extern_class, extern_methods, msg_send_id, Message};
__inner_extern_class!(
/// A mutable collection of objects associated with unique keys.
///
/// See the documentation for [`NSDictionary`] and/or [Apple's
/// documentation][apple-doc] for more information.
///
/// [apple-doc]: https://developer.apple.com/documentation/foundation/nsmutabledictionary?language=objc
#[derive(PartialEq, Eq, Hash)]
pub struct NSMutableDictionary<K: Message, V: Message> {
key: PhantomData<Id<K, Shared>>,
obj: PhantomData<Id<V, Owned>>,
}
unsafe impl<K: Message, V: Message> ClassType for NSMutableDictionary<K, V> {
#[inherits(NSObject)]
type Super = NSDictionary<K, V>;
}
);
// Same as `NSDictionary<K, V>`
unsafe impl<K: Message + Sync + Send, V: Message + Sync> Sync for NSMutableDictionary<K, V> {}
unsafe impl<K: Message + Sync + Send, V: Message + Send> Send for NSMutableDictionary<K, V> {}
// Same as `NSDictionary<K, V>`
impl<K: Message + UnwindSafe, V: Message + UnwindSafe> UnwindSafe for NSMutableDictionary<K, V> {}
impl<K: Message + RefUnwindSafe, V: Message + RefUnwindSafe> RefUnwindSafe
for NSMutableDictionary<K, V>
{
}
extern_methods!(
unsafe impl<K: Message, V: Message> NSMutableDictionary<K, V> {
/// Creates an empty [`NSMutableDictionary`].
///
/// # Examples
///
/// ```
/// use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
/// # #[cfg(feature = "gnustep-1-7")]
/// # unsafe { objc2::__gnustep_hack::get_class_to_force_linkage() };
///
/// let dict = NSMutableDictionary::<NSString, NSObject>::new();
/// ```
pub fn new() -> Id<Self, Owned> {
// SAFETY:
// Mutable dictionaries are always unique, so it's safe to return
// `Id<Self, Owned>`
unsafe { msg_send_id![Self::class(), new] }
}
#[sel(setDictionary:)]
fn set_dictionary(&mut self, dict: &NSDictionary<K, V>);
/// Creates an [`NSMutableDictionary`] from a slice of keys and a
/// vector of values.
///
/// # Examples
///
/// ```
/// use objc2::foundation::{NSMutableDictionary, NSNumber, NSObject};
/// # #[cfg(feature = "gnustep-1-7")]
/// # unsafe { objc2::__gnustep_hack::get_class_to_force_linkage() };
/// let dict = NSMutableDictionary::from_keys_and_objects(
/// &[
/// &*NSNumber::new_i32(1),
/// &*NSNumber::new_i32(2),
/// &*NSNumber::new_i32(3),
/// ],
/// vec![NSObject::new(), NSObject::new(), NSObject::new()],
/// );
/// ```
pub fn from_keys_and_objects<T>(keys: &[&T], vals: Vec<Id<V, Owned>>) -> Id<Self, Owned>
where
T: NSCopying<Output = K>,
{
let mut dict = NSMutableDictionary::new();
dict.set_dictionary(&*NSDictionary::from_keys_and_objects(keys, vals));
dict
}
/// Returns a mutable reference to the value corresponding to the key.
///
/// # Examples
///
/// ```
/// use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
/// use objc2::ns_string;
/// # #[cfg(feature = "gnustep-1-7")]
/// # unsafe { objc2::__gnustep_hack::get_class_to_force_linkage() };
///
/// let mut dict = NSMutableDictionary::new();
/// dict.insert(NSString::from_str("one"), NSObject::new());
/// println!("{:?}", dict.get_mut(ns_string!("one")));
/// ```
#[doc(alias = "objectForKey:")]
#[sel(objectForKey:)]
pub fn get_mut(&mut self, key: &K) -> Option<&mut V>;
#[sel(getObjects:andKeys:)]
unsafe fn get_objects_and_keys(&self, objects: *mut &mut V, keys: *mut &K);
/// Returns a vector of mutable references to the values in the dictionary.
///
/// # Examples
///
/// ```
/// use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
/// # #[cfg(feature = "gnustep-1-7")]
/// # unsafe { objc2::__gnustep_hack::get_class_to_force_linkage() };
///
/// let mut dict = NSMutableDictionary::new();
/// dict.insert(NSString::from_str("one"), NSObject::new());
/// for val in dict.values_mut() {
/// println!("{:?}", val);
/// }
/// ```
#[doc(alias = "getObjects:andKeys:")]
pub fn values_mut(&mut self) -> Vec<&mut V> {
let len = self.len();
let mut vals: Vec<&mut V> = Vec::with_capacity(len);
// SAFETY: `vals` is not null
unsafe {
self.get_objects_and_keys(vals.as_mut_ptr(), ptr::null_mut());
vals.set_len(len);
}
vals
}
#[sel(setObject:forKey:)]
fn set_object_for_key(&mut self, object: &V, key: &K);
/// Inserts a key-value pair into the dictionary.
///
/// If the dictionary did not have this key present, None is returned.
/// If the dictionary did have this key present, the value is updated,
/// and the old value is returned.
///
/// # Examples
///
/// ```
/// use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
/// # #[cfg(feature = "gnustep-1-7")]
/// # unsafe { objc2::__gnustep_hack::get_class_to_force_linkage() };
///
/// let mut dict = NSMutableDictionary::new();
/// dict.insert(NSString::from_str("one"), NSObject::new());
/// ```
#[doc(alias = "setObject:forKey:")]
pub fn insert(&mut self, key: Id<K, Shared>, value: Id<V, Owned>) -> Option<Id<V, Owned>> {
// SAFETY:
// `obj` is a reference to a value in the dictionary so it's safe
// to cast it to a pointer and pass it to `Id::retain_autoreleased`
let obj = self.get(&*key).map(|obj| unsafe {
Id::retain_autoreleased(obj as *const V as *mut V).unwrap_unchecked()
});
self.set_object_for_key(&*value, &*key);
obj
}
#[sel(removeObjectForKey:)]
fn remove_object_for_key(&mut self, key: &K);
/// Removes a key from the dictionary, returning the value at the key
/// if the key was previously in the dictionary.
///
/// # Examples
///
/// ```
/// use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
/// use objc2::ns_string;
/// # #[cfg(feature = "gnustep-1-7")]
/// # unsafe { objc2::__gnustep_hack::get_class_to_force_linkage() };
///
/// let mut dict = NSMutableDictionary::new();
/// dict.insert(NSString::from_str("one"), NSObject::new());
/// dict.remove(ns_string!("one"));
/// assert!(dict.is_empty());
/// ```
#[doc(alias = "removeObjectForKey:")]
pub fn remove(&mut self, key: &K) -> Option<Id<V, Owned>> {
// SAFETY:
// `obj` is a reference to a value in the dictionary so it's safe
// to cast it to a pointer and pass it to `Id::retain_autoreleased`
let obj = self.get(key).map(|obj| unsafe {
Id::retain_autoreleased(obj as *const V as *mut V).unwrap_unchecked()
});
self.remove_object_for_key(key);
obj
}
/// Clears the dictionary, removing all key-value pairs.
///
/// # Examples
///
/// ```
/// use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
/// # #[cfg(feature = "gnustep-1-7")]
/// # unsafe { objc2::__gnustep_hack::get_class_to_force_linkage() };
///
/// let mut dict = NSMutableDictionary::new();
/// dict.insert(NSString::from_str("one"), NSObject::new());
/// dict.clear();
/// assert!(dict.is_empty());
/// ```
#[doc(alias = "removeAllObjects")]
#[sel(removeAllObjects)]
pub fn clear(&mut self);
/// Returns an [`NSArray`] containing the dictionary's values,
/// consuming the dictionary.
///
/// # Examples
///
/// ```
/// use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
/// # #[cfg(feature = "gnustep-1-7")]
/// # unsafe { objc2::__gnustep_hack::get_class_to_force_linkage() };
///
/// let mut dict = NSMutableDictionary::new();
/// dict.insert(NSString::from_str("one"), NSObject::new());
/// let array = NSMutableDictionary::into_values_array(dict);
/// println!("{:?}", array);
/// ```
pub fn into_values_array(dict: Id<Self, Owned>) -> Id<NSArray<V, Owned>, Shared> {
unsafe { msg_send_id![&dict, allValues] }
}
}
);
unsafe impl<K: Message, V: Message> NSFastEnumeration for NSMutableDictionary<K, V> {
type Item = K;
}
impl<'a, K: Message, V: Message> Index<&'a K> for NSMutableDictionary<K, V> {
type Output = V;
fn index<'s>(&'s self, index: &'a K) -> &'s V {
self.get(index).unwrap()
}
}
impl<'a, K: Message, V: Message> IndexMut<&'a K> for NSMutableDictionary<K, V> {
fn index_mut<'s>(&'s mut self, index: &'a K) -> &'s mut V {
self.get_mut(index).unwrap()
}
}
impl<K: Message, V: Message> DefaultId for NSMutableDictionary<K, V> {
type Ownership = Owned;
#[inline]
fn default_id() -> Id<Self, Self::Ownership> {
Self::new()
}
}
impl<K: fmt::Debug + Message, V: fmt::Debug + Message> fmt::Debug for NSMutableDictionary<K, V> {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Debug::fmt(&**self, f)
}
}
#[cfg(test)]
mod tests {
use super::*;
use alloc::vec;
use crate::{
foundation::{NSNumber, NSString},
rc::{RcTestObject, ThreadTestData},
};
fn sample_dict() -> Id<NSMutableDictionary<NSNumber, NSObject>, Owned> {
NSMutableDictionary::from_keys_and_objects(
&[
&*NSNumber::new_i32(1),
&*NSNumber::new_i32(2),
&*NSNumber::new_i32(3),
],
vec![NSObject::new(), NSObject::new(), NSObject::new()],
)
}
#[test]
fn test_new() {
let dict = NSMutableDictionary::<NSString, NSObject>::new();
assert!(dict.is_empty());
}
#[test]
fn test_get_mut() {
let mut dict = sample_dict();
assert!(dict.get_mut(&NSNumber::new_i32(1)).is_some());
assert!(dict.get_mut(&NSNumber::new_i32(2)).is_some());
assert!(dict.get_mut(&NSNumber::new_i32(4)).is_none());
}
#[test]
fn test_values_mut() {
let mut dict = sample_dict();
let vec = dict.values_mut();
assert_eq!(vec.len(), 3);
}
#[test]
fn test_insert() {
let mut dict = NSMutableDictionary::new();
assert!(dict.insert(NSNumber::new_i32(1), NSObject::new()).is_none());
assert!(dict.insert(NSNumber::new_i32(2), NSObject::new()).is_none());
assert!(dict.insert(NSNumber::new_i32(3), NSObject::new()).is_none());
assert!(dict.insert(NSNumber::new_i32(1), NSObject::new()).is_some());
assert_eq!(dict.len(), 3);
}
#[test]
fn test_insert_retain_release() {
let mut dict = NSMutableDictionary::new();
dict.insert(NSNumber::new_i32(1), RcTestObject::new());
let mut expected = ThreadTestData::current();
let old = dict.insert(NSNumber::new_i32(1), RcTestObject::new());
expected.alloc += 1;
expected.init += 1;
expected.retain += 2;
expected.release += 2;
expected.assert_current();
drop(old);
expected.release += 1;
expected.dealloc += 1;
expected.assert_current();
}
#[test]
fn test_remove() {
let mut dict = sample_dict();
assert_eq!(dict.len(), 3);
assert!(dict.remove(&NSNumber::new_i32(1)).is_some());
assert!(dict.remove(&NSNumber::new_i32(2)).is_some());
assert!(dict.remove(&NSNumber::new_i32(1)).is_none());
assert!(dict.remove(&NSNumber::new_i32(4)).is_none());
assert_eq!(dict.len(), 1);
}
#[test]
fn test_clear() {
let mut dict = sample_dict();
assert_eq!(dict.len(), 3);
dict.clear();
assert!(dict.is_empty());
}
#[test]
fn test_remove_clear_release_dealloc() {
let mut dict = NSMutableDictionary::new();
for i in 0..4 {
dict.insert(NSNumber::new_i32(i), RcTestObject::new());
}
let mut expected = ThreadTestData::current();
let _obj = dict.remove(&NSNumber::new_i32(1));
expected.retain += 1;
expected.release += 1;
expected.assert_current();
assert_eq!(dict.len(), 3);
let _obj = dict.remove(&NSNumber::new_i32(2));
expected.retain += 1;
expected.release += 1;
expected.assert_current();
assert_eq!(dict.len(), 2);
dict.clear();
expected.release += 2;
expected.dealloc += 2;
expected.assert_current();
assert_eq!(dict.len(), 0);
}
#[test]
fn test_into_values_array() {
let dict = sample_dict();
let array = NSMutableDictionary::into_values_array(dict);
assert_eq!(array.len(), 3);
}
}