objc2 0.6.4

#[cfg(debug_assertions)]
use alloc::vec::Vec;
use core::ffi::CStr;
use core::marker::PhantomData;
use core::panic::{RefUnwindSafe, UnwindSafe};
#[cfg(debug_assertions)]
use std::collections::HashSet;

use crate::encode::{Encode, Encoding};
use crate::rc::{Allocated, Retained};
use crate::runtime::{
    AnyClass, AnyObject, ClassBuilder, MessageReceiver, MethodImplementation, Sel,
};
#[cfg(debug_assertions)]
use crate::runtime::{AnyProtocol, MethodDescription};
use crate::{AnyThread, ClassType, DefinedClass, Message, ProtocolType};

use super::defined_ivars::{
    drop_flag_offset, ivar_drop_flag_names, ivars_offset, register_drop_flag, register_ivars,
    setup_dealloc,
};
use super::{CopyFamily, InitFamily, MutableCopyFamily, NewFamily, NoneFamily};

/// Helper for determining auto traits of defined classes.
///
/// This will contain either `dyn AnyThread` or `dyn MainThreadOnly`, so it
/// will have no auto traits by default.
#[derive(Debug)]
pub struct ThreadKindAutoTraits<T: ?Sized>(T);

// SAFETY: `AnyThread` does not place restrictions on thread safety.
unsafe impl Send for ThreadKindAutoTraits<dyn AnyThread> {}
// SAFETY: Same as above.
unsafe impl Sync for ThreadKindAutoTraits<dyn AnyThread> {}

// NOTE: A similar implementation for `dyn MainThreadOnly` is explicitly not
// allowed, as that would enable users to pass something that is tied to the
// main thread to other threads. Remember that we can view `MainThreadOnly`
// classes as containing a `MainThreadMarker` (which is always accessible
// using `MainThreadOnly::mtm`).
//
// impl !Send for ThreadKindAutoTraits<dyn MainThreadOnly> {}
// impl !Sync for ThreadKindAutoTraits<dyn MainThreadOnly> {}

// Thread kind does not affect pinning or unwind safety
impl<T: ?Sized> Unpin for ThreadKindAutoTraits<T> {}
impl<T: ?Sized> UnwindSafe for ThreadKindAutoTraits<T> {}
impl<T: ?Sized> RefUnwindSafe for ThreadKindAutoTraits<T> {}

// Thread kind does not affect autorelease safety.
#[cfg(feature = "unstable-autoreleasesafe")]
unsafe impl<T: ?Sized> crate::rc::AutoreleaseSafe for ThreadKindAutoTraits<T> {}

/// Helper type for implementing `MethodImplementation` with a receiver of
/// `Allocated<T>`, without exposing that implementation to users.
//
// Must be private, soundness of MethodImplementation relies on this.
#[doc(hidden)]
#[repr(transparent)]
#[derive(Debug)]
#[allow(dead_code)]
pub struct RetainedReturnValue(pub(crate) *mut AnyObject);

// SAFETY: `RetainedReturnValue` is `#[repr(transparent)]`
unsafe impl Encode for RetainedReturnValue {
    const ENCODING: Encoding = <*mut AnyObject>::ENCODING;
}

// One could imagine a different design where we had a method like
// `fn convert_receiver()`, but that won't work in `define_class!` since we
// can't actually modify the `self` argument (e.g. `let self = foo(self)` is
// not allowed).
//
// See `MsgSendRetained` and `MethodFamily` for details on the retain
// semantics we're following here.
pub trait MessageReceiveRetained<Receiver, Ret> {
    fn into_return(obj: Ret) -> RetainedReturnValue;
}

// Receiver and return type have no correlation
impl<Receiver, Ret> MessageReceiveRetained<Receiver, Ret> for NewFamily
where
    Receiver: MessageReceiver,
    Ret: MaybeOptionRetained,
{
    #[inline]
    fn into_return(obj: Ret) -> RetainedReturnValue {
        obj.consumed_return()
    }
}

// Explicitly left unimplemented for now!
// impl MessageReceiveRetained<impl MessageReceiver, Allocated<T>> for Alloc {}

// Note: `MethodImplementation` allows for `Allocated` as the receiver, so we
// restrict it here to only be when the selector is `init`.
//
// Additionally, the receiver and return type must have the same generic
// parameter `T`.
impl<Ret, T> MessageReceiveRetained<Allocated<T>, Ret> for InitFamily
where
    T: Message,
    Ret: MaybeOptionRetained<Inner = T>,
{
    #[inline]
    fn into_return(obj: Ret) -> RetainedReturnValue {
        obj.consumed_return()
    }
}

// Receiver and return type have no correlation
impl<Receiver, Ret> MessageReceiveRetained<Receiver, Ret> for CopyFamily
where
    Receiver: MessageReceiver,
    Ret: MaybeOptionRetained,
{
    #[inline]
    fn into_return(obj: Ret) -> RetainedReturnValue {
        obj.consumed_return()
    }
}

// Receiver and return type have no correlation
impl<Receiver, Ret> MessageReceiveRetained<Receiver, Ret> for MutableCopyFamily
where
    Receiver: MessageReceiver,
    Ret: MaybeOptionRetained,
{
    #[inline]
    fn into_return(obj: Ret) -> RetainedReturnValue {
        obj.consumed_return()
    }
}

// Receiver and return type have no correlation
impl<Receiver, Ret> MessageReceiveRetained<Receiver, Ret> for NoneFamily
where
    Receiver: MessageReceiver,
    Ret: MaybeOptionRetained,
{
    #[inline]
    fn into_return(obj: Ret) -> RetainedReturnValue {
        obj.autorelease_return()
    }
}

/// Helper trait for specifying an `Retained<T>` or an `Option<Retained<T>>`.
///
/// (Both of those are valid return types from define_class!
/// `#[unsafe(method_id)]`).
pub trait MaybeOptionRetained {
    type Inner;

    fn consumed_return(self) -> RetainedReturnValue;
    fn autorelease_return(self) -> RetainedReturnValue;
}

impl<T: Message> MaybeOptionRetained for Retained<T> {
    type Inner = T;

    #[inline]
    fn consumed_return(self) -> RetainedReturnValue {
        let ptr: *mut T = Retained::into_raw(self);
        RetainedReturnValue(ptr.cast())
    }

    #[inline]
    fn autorelease_return(self) -> RetainedReturnValue {
        let ptr: *mut T = Retained::autorelease_return(self);
        RetainedReturnValue(ptr.cast())
    }
}

impl<T: Message> MaybeOptionRetained for Option<Retained<T>> {
    type Inner = T;

    #[inline]
    fn consumed_return(self) -> RetainedReturnValue {
        let ptr: *mut T = Retained::consume_as_ptr_option(self);
        RetainedReturnValue(ptr.cast())
    }

    #[inline]
    fn autorelease_return(self) -> RetainedReturnValue {
        let ptr: *mut T = Retained::autorelease_return_option(self);
        RetainedReturnValue(ptr.cast())
    }
}

/// Convert a class name with a trailing NUL byte to a `CStr`, at `const`.
#[track_caller]
pub const fn class_c_name(name: &str) -> &CStr {
    let bytes = name.as_bytes();
    // Workaround for `from_bytes_with_nul` not being `const` in MSRV.
    let mut i = 0;
    while i < bytes.len() - 1 {
        if bytes[i] == 0 {
            panic!("class name must not contain interior NUL bytes");
        }
        i += 1;
    }
    if let Ok(c_name) = CStr::from_bytes_until_nul(bytes) {
        c_name
    } else {
        unreachable!()
    }
}

// Kept separate for code size.
#[track_caller]
fn class_not_present(c_name: &CStr) -> ! {
    panic!("could not create new class {c_name:?}, though there was no other class with that name")
}

#[track_caller]
fn class_not_unique(c_name: &CStr) -> ! {
    panic!("could not create new class {c_name:?}, perhaps a class with that name already exists?")
}

#[inline]
#[track_caller]
#[allow(clippy::new_without_default)]
pub fn define_class<T: DefinedClass>(
    c_name: &CStr,
    name_is_auto_generated: bool,
    register_impls: impl FnOnce(&mut ClassBuilderHelper<T>),
) -> (&'static AnyClass, isize, isize)
where
    T::Super: ClassType,
{
    let (ivar_name, drop_flag_name) = ivar_drop_flag_names::<T>();

    let superclass = <T::Super as ClassType>::class();
    let cls = if let Some(builder) = ClassBuilder::new(c_name, superclass) {
        let mut this = ClassBuilderHelper {
            builder,
            p: PhantomData,
        };

        setup_dealloc::<T>(&mut this.builder);

        register_impls(&mut this);

        register_ivars::<T>(&mut this.builder, &ivar_name);
        register_drop_flag::<T>(&mut this.builder, &drop_flag_name);

        this.builder.register()
    } else {
        // When loading two dynamic libraries that both use a class from some
        // shared (static) Rust library, the dynamic linker will duplicate the
        // statics that `define_class!` defines.
        //
        // For most statics that people create, this is the desired behaviour.
        //
        // In our case though, there is only a single Objective-C runtime with
        // a single list of classes, and thus those two dynamic libraries end
        // up trying to register the same class multiple times.
        //
        // To support such use-cases, we assume that the existing class is the
        // one that we want, and don't try to declare it ourselves.
        //
        // This is **sound** within the context of a single linker invocation,
        // since we ensure in `define_class!` with `#[extern_name = ...]` that
        // the class name is unique.
        //
        // It is **unsound** in the case above of multiple dynamic libraries,
        // since we cannot guarantee that the name actually comes from the
        // same piece of code. The dynamic linker already does this same merge
        // operation though, so we will consider this a non-issue (i.e. the
        // same problem already exists in Objective-C w. dynamic libraries).
        //
        // See <https://github.com/rust-windowing/raw-window-metal/issues/29>
        // for more details on the use-case.
        //
        // NOTE: We _could_ also solve this by autogenerating a class name
        // based on the address of a static - but in the future, we would like
        // to generate fully static classes, and then such a solution wouldn't
        // be possible.
        //
        // ---
        //
        // We only do this by default when we've auto-generated the name,
        // since here we'll be reasonably sure that it's unique to that
        // specific piece of code.
        //
        // In the future, we might be able to relax this to also work with
        // user-specified names, though we'd have to somehow ensure that the
        // name isn't something crazy like "NSObject".
        //
        // We also have an (intentionally undocumented) workaround env var in
        // case this becomes a problem for users in the future.
        let overridden = option_env!("UNSAFE_OBJC2_ALLOW_CLASS_OVERRIDE") == Some("1");
        if name_is_auto_generated || overridden {
            AnyClass::get(c_name).unwrap_or_else(|| class_not_present(c_name))
        } else {
            class_not_unique(c_name)
        }
    };

    // Pass class and offsets back to allow storing them in statics for faster
    // subsequent access.
    (
        cls,
        ivars_offset::<T>(cls, &ivar_name),
        drop_flag_offset::<T>(cls, &drop_flag_name),
    )
}

#[derive(Debug)]
pub struct ClassBuilderHelper<T: ?Sized> {
    builder: ClassBuilder,
    p: PhantomData<T>,
}

impl<T: DefinedClass> ClassBuilderHelper<T> {
    #[inline]
    pub fn add_protocol_methods<P>(&mut self) -> ClassProtocolMethodsBuilder<'_, T>
    where
        P: ?Sized + ProtocolType,
    {
        let protocol = P::protocol();

        if let Some(protocol) = protocol {
            // Ignore the return value; whether the protocol is added is
            // inherently dependent on the order of the protocols.
            self.builder.add_protocol(protocol);
        }

        #[cfg(debug_assertions)]
        {
            ClassProtocolMethodsBuilder {
                builder: self,
                protocol,
                required_instance_methods: protocol
                    .map(|p| p.method_descriptions(true))
                    .unwrap_or_default(),
                optional_instance_methods: protocol
                    .map(|p| p.method_descriptions(false))
                    .unwrap_or_default(),
                registered_instance_methods: HashSet::new(),
                required_class_methods: protocol
                    .map(|p| p.class_method_descriptions(true))
                    .unwrap_or_default(),
                optional_class_methods: protocol
                    .map(|p| p.class_method_descriptions(false))
                    .unwrap_or_default(),
                registered_class_methods: HashSet::new(),
            }
        }

        #[cfg(not(debug_assertions))]
        {
            ClassProtocolMethodsBuilder { builder: self }
        }
    }

    // Addition: This restricts to callee `T`
    #[inline]
    pub unsafe fn add_method<F>(&mut self, sel: Sel, func: F)
    where
        F: MethodImplementation<Callee = T>,
    {
        // SAFETY: Checked by caller
        unsafe { self.builder.add_method(sel, func) }
    }

    #[inline]
    pub unsafe fn add_class_method<F>(&mut self, sel: Sel, func: F)
    where
        F: MethodImplementation<Callee = AnyClass>,
    {
        // SAFETY: Checked by caller
        unsafe { self.builder.add_class_method(sel, func) }
    }
}

/// Helper for ensuring that:
/// - Only methods on the protocol are overridden.
/// - TODO: The methods have the correct signature.
/// - All required methods are overridden.
#[derive(Debug)]
pub struct ClassProtocolMethodsBuilder<'a, T: ?Sized> {
    builder: &'a mut ClassBuilderHelper<T>,
    #[cfg(debug_assertions)]
    protocol: Option<&'static AnyProtocol>,
    #[cfg(debug_assertions)]
    required_instance_methods: Vec<MethodDescription>,
    #[cfg(debug_assertions)]
    optional_instance_methods: Vec<MethodDescription>,
    #[cfg(debug_assertions)]
    registered_instance_methods: HashSet<Sel>,
    #[cfg(debug_assertions)]
    required_class_methods: Vec<MethodDescription>,
    #[cfg(debug_assertions)]
    optional_class_methods: Vec<MethodDescription>,
    #[cfg(debug_assertions)]
    registered_class_methods: HashSet<Sel>,
}

impl<T: DefinedClass> ClassProtocolMethodsBuilder<'_, T> {
    // Addition: This restricts to callee `T`
    #[inline]
    pub unsafe fn add_method<F>(&mut self, sel: Sel, func: F)
    where
        F: MethodImplementation<Callee = T>,
    {
        #[cfg(debug_assertions)]
        if let Some(protocol) = self.protocol {
            let _types = self
                .required_instance_methods
                .iter()
                .chain(&self.optional_instance_methods)
                .find(|desc| desc.sel == sel)
                .map(|desc| desc.types)
                .unwrap_or_else(|| {
                    panic!(
                        "failed overriding protocol method -[{protocol} {sel}]: method not found"
                    )
                });
        }

        // SAFETY: Checked by caller
        unsafe { self.builder.add_method(sel, func) };

        #[cfg(debug_assertions)]
        if !self.registered_instance_methods.insert(sel) {
            unreachable!("already added")
        }
    }

    #[inline]
    pub unsafe fn add_class_method<F>(&mut self, sel: Sel, func: F)
    where
        F: MethodImplementation<Callee = AnyClass>,
    {
        #[cfg(debug_assertions)]
        if let Some(protocol) = self.protocol {
            let _types = self
                .required_class_methods
                .iter()
                .chain(&self.optional_class_methods)
                .find(|desc| desc.sel == sel)
                .map(|desc| desc.types)
                .unwrap_or_else(|| {
                    panic!(
                        "failed overriding protocol method +[{protocol} {sel}]: method not found"
                    )
                });
        }

        // SAFETY: Checked by caller
        unsafe { self.builder.add_class_method(sel, func) };

        #[cfg(debug_assertions)]
        if !self.registered_class_methods.insert(sel) {
            unreachable!("already added")
        }
    }

    #[cfg(debug_assertions)]
    pub fn finish(self) {
        let superclass = self.builder.builder.superclass();

        if let Some(protocol) = self.protocol {
            for desc in &self.required_instance_methods {
                if self.registered_instance_methods.contains(&desc.sel) {
                    continue;
                }

                // TODO: Don't do this when `NS_PROTOCOL_REQUIRES_EXPLICIT_IMPLEMENTATION`
                if superclass
                    .and_then(|superclass| superclass.instance_method(desc.sel))
                    .is_some()
                {
                    continue;
                }

                panic!(
                    "must implement required protocol method -[{protocol} {}]",
                    desc.sel
                )
            }
        }

        if let Some(protocol) = self.protocol {
            for desc in &self.required_class_methods {
                if self.registered_class_methods.contains(&desc.sel) {
                    continue;
                }

                // TODO: Don't do this when `NS_PROTOCOL_REQUIRES_EXPLICIT_IMPLEMENTATION`
                if superclass
                    .and_then(|superclass| superclass.class_method(desc.sel))
                    .is_some()
                {
                    continue;
                }

                panic!(
                    "must implement required protocol method +[{protocol} {}]",
                    desc.sel
                );
            }
        }
    }

    #[inline]
    #[cfg(not(debug_assertions))]
    pub fn finish(self) {}
}