objc2-foundation 0.3.0

Bindings to the Foundation framework
Documentation
#![cfg(feature = "NSArray")]
#![cfg(feature = "NSValue")]
#![cfg(feature = "NSRange")]
use alloc::format;
use alloc::vec::Vec;
use core::ptr;

use crate::{NSArray, NSNumber, NSObject};
use objc2::extern_protocol;
use objc2::rc::Retained;
use objc2::runtime::{AnyObject, ProtocolObject};

fn sample_array(len: usize) -> Retained<NSArray<NSObject>> {
    let mut vec = Vec::with_capacity(len);
    for _ in 0..len {
        vec.push(NSObject::new());
    }
    NSArray::from_retained_slice(&vec)
}

fn sample_number_array(len: u8) -> Retained<NSArray<NSNumber>> {
    let mut vec = Vec::with_capacity(len as usize);
    for i in 0..len {
        vec.push(NSNumber::new_u8(i));
    }
    NSArray::from_retained_slice(&vec)
}

#[test]
fn test_two_empty() {
    let _empty_array1 = NSArray::<NSObject>::new();
    let _empty_array2 = NSArray::<NSObject>::new();
}

#[test]
fn test_creation() {
    let _ = <NSArray<NSNumber>>::from_retained_slice(&[]);
    let _ = NSArray::from_retained_slice(&[NSNumber::new_u8(4), NSNumber::new_u8(2)]);

    let _ = <NSArray<NSNumber>>::from_slice(&[]);
    let _ = NSArray::from_slice(&[&*NSNumber::new_u8(4), &*NSNumber::new_u8(2)]);
}

#[test]
fn test_len() {
    let empty_array = NSArray::<NSObject>::new();
    assert_eq!(empty_array.len(), 0);

    let array = sample_array(4);
    assert_eq!(array.len(), 4);
}

#[test]
fn test_equality() {
    let array1 = sample_array(3);
    let array2 = sample_array(3);
    assert_ne!(array1, array2);

    let array1 = sample_number_array(3);
    let array2 = sample_number_array(3);
    assert_eq!(array1, array2);

    let array1 = sample_number_array(3);
    let array2 = sample_number_array(4);
    assert_ne!(array1, array2);
}

#[test]
fn test_debug() {
    let obj = sample_number_array(0);
    assert_eq!(format!("{obj:?}"), "[]");
    let obj = sample_number_array(3);
    assert_eq!(format!("{obj:?}"), "[0, 1, 2]");
}

#[test]
fn test_get() {
    let array = sample_array(4);
    assert_ne!(array.objectAtIndex(0), array.objectAtIndex(3));
    assert_eq!(array.firstObject().unwrap(), array.objectAtIndex(0));
    assert_eq!(array.lastObject().unwrap(), array.objectAtIndex(3));

    let empty_array = <NSArray<NSObject>>::new();
    assert!(empty_array.firstObject().is_none());
    assert!(empty_array.lastObject().is_none());
}

#[test]
fn test_iter() {
    let array = sample_number_array(4);

    let vec1 = array.to_vec();
    let vec2: Vec<_> = array.iter().collect();
    assert_eq!(vec1, vec2);

    let mut iterations = 0;
    for _ in &array {
        iterations += 1;
    }
    for _ in array.iter() {
        iterations += 1;
    }
    for _ in unsafe { array.iter_unchecked() } {
        iterations += 1;
    }
    for _ in array {
        iterations += 1;
    }
    assert_eq!(iterations, 4 * 4);
}

#[test]
fn test_iter_fused() {
    // Not actually documented, nor is FusedIterator implemented for the
    // array iterators; but it it still important to test that iterating past
    // the end still works.

    let array = sample_number_array(2);

    let mut iter = array.iter();
    assert_eq!(iter.next(), Some(NSNumber::new_u8(0)));
    assert_eq!(iter.next(), Some(NSNumber::new_u8(1)));
    assert_eq!(iter.next(), None);
    assert_eq!(iter.next(), None);
    assert_eq!(iter.next(), None);
    assert_eq!(iter.next(), None);
    assert_eq!(iter.next(), None);
    assert_eq!(iter.next(), None);
    assert_eq!(iter.next(), None);
}

#[test]
fn test_two_iters() {
    let array = sample_number_array(4);

    let iter1 = array.iter();
    let iter2 = array.iter();
    for (_, _) in iter1.zip(iter2) {}
}

#[test]
fn test_objects_in_range() {
    let array = sample_array(4);

    let middle_objs = array.objects_in_range(1..3);
    assert_eq!(middle_objs.len(), 2);
    assert_eq!(middle_objs[0], array.objectAtIndex(1));
    assert_eq!(middle_objs[1], array.objectAtIndex(2));

    let empty_objs = array.objects_in_range(1..1);
    assert!(empty_objs.is_empty());

    let all_objs = array.objects_in_range(0..4);
    assert_eq!(all_objs.len(), 4);
}

#[test]
fn test_generic_ownership_traits() {
    fn assert_partialeq<T: PartialEq>() {}

    assert_partialeq::<NSArray<NSObject>>();
}

#[test]
fn test_trait_retainable() {
    extern_protocol!(
        #[allow(clippy::missing_safety_doc)]
        #[name = "NSObject"]
        unsafe trait TestProtocol {}
    );

    unsafe impl TestProtocol for NSNumber {}

    let obj: Retained<ProtocolObject<dyn TestProtocol>> =
        ProtocolObject::from_retained(NSNumber::new_i32(42));
    let _ = NSArray::from_slice(&[&*obj, &*obj]);
    let _ = NSArray::from_retained_slice(&[obj.clone(), obj.clone()]);
}

#[test]
fn test_access_anyobject() {
    let obj: Retained<AnyObject> = NSObject::new().into_super();
    let array = NSArray::from_retained_slice(&[obj.clone(), obj.clone()]);
    assert!(ptr::eq(&*array.objectAtIndex(0), &*obj));
    assert!(ptr::eq(unsafe { array.objectAtIndex_unchecked(0) }, &*obj));
    for _ in array.iter() {}
    for _ in unsafe { array.iter_unchecked() } {}
    for _ in array {}
}