-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make MessageReceiver simpler, and add internal trait MsgSend
There is value in having a simpler `MessageReceiver` which is understandable by end users, and that doesn't possibly incur extra costs depending on which arguments/return type you pass it.
- Loading branch information
Showing
33 changed files
with
500 additions
and
379 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,203 @@ | ||
| use core::mem::ManuallyDrop; | ||
| use core::ptr; | ||
|
|
||
| use crate::encode::RefEncode; | ||
| use crate::mutability::IsMutable; | ||
| use crate::rc::Id; | ||
| use crate::runtime::{AnyClass, AnyObject, MessageReceiver, Sel}; | ||
| use crate::{ClassType, Encode, Message}; | ||
|
|
||
| use super::{ConvertArguments, ConvertReturn, TupleExtender}; | ||
|
|
||
| pub trait MsgSend: Sized { | ||
| type Inner: ?Sized + RefEncode; | ||
|
|
||
| fn into_raw_receiver(self) -> *mut AnyObject; | ||
|
|
||
| #[inline] | ||
| #[track_caller] | ||
| unsafe fn send_message<A, R>(self, sel: Sel, args: A) -> R | ||
| where | ||
| A: ConvertArguments, | ||
| R: ConvertReturn, | ||
| { | ||
| let (args, stored) = A::__into_arguments(args); | ||
|
|
||
| // SAFETY: Upheld by caller | ||
| let result = unsafe { MessageReceiver::send_message(self.into_raw_receiver(), sel, args) }; | ||
|
|
||
| // TODO: If we want `objc_retainAutoreleasedReturnValue` to | ||
| // work, we must not do any work before it has been run; so | ||
| // somehow, we should do that _before_ this call! | ||
| // | ||
| // SAFETY: The argument was passed to the message sending | ||
| // function, and the stored values are only processed this | ||
| // once. See `src/__macro_helpers/writeback.rs` for | ||
| // details. | ||
| unsafe { A::__process_after_message_send(stored) }; | ||
|
|
||
| R::__from_return(result) | ||
| } | ||
|
|
||
| #[inline] | ||
| #[track_caller] | ||
| unsafe fn send_super_message<A, R>(self, superclass: &AnyClass, sel: Sel, args: A) -> R | ||
| where | ||
| A: ConvertArguments, | ||
| R: ConvertReturn, | ||
| { | ||
| let (args, stored) = A::__into_arguments(args); | ||
|
|
||
| // SAFETY: Upheld by caller | ||
| let result = unsafe { | ||
| MessageReceiver::send_super_message(self.into_raw_receiver(), superclass, sel, args) | ||
| }; | ||
|
|
||
| // SAFETY: Same as in send_message above. | ||
| unsafe { A::__process_after_message_send(stored) }; | ||
|
|
||
| R::__from_return(result) | ||
| } | ||
|
|
||
| #[inline] | ||
| #[track_caller] | ||
| unsafe fn send_super_message_static<A, R>(self, sel: Sel, args: A) -> R | ||
| where | ||
| Self::Inner: ClassType, | ||
| <Self::Inner as ClassType>::Super: ClassType, | ||
| A: ConvertArguments, | ||
| R: ConvertReturn, | ||
| { | ||
| unsafe { self.send_super_message(<Self::Inner as ClassType>::Super::class(), sel, args) } | ||
| } | ||
|
|
||
| // Error functions below. See MsgSendId::send_message_id_error for further | ||
| // details. | ||
| // | ||
| // Some of this could be abstracted away using closures, but that would | ||
| // interfere with `#[track_caller]`, so we avoid doing that. | ||
|
|
||
| #[inline] | ||
| #[track_caller] | ||
| unsafe fn send_message_error<A, E>(self, sel: Sel, args: A) -> Result<(), Id<E>> | ||
| where | ||
| *mut *mut E: Encode, | ||
| A: TupleExtender<*mut *mut E>, | ||
| <A as TupleExtender<*mut *mut E>>::PlusOneArgument: ConvertArguments, | ||
| E: Message, | ||
| { | ||
| let mut err: *mut E = ptr::null_mut(); | ||
| let args = args.add_argument(&mut err); | ||
| let res: bool = unsafe { self.send_message(sel, args) }; | ||
| if res { | ||
| Ok(()) | ||
| } else { | ||
| Err(unsafe { encountered_error(err) }) | ||
| } | ||
| } | ||
|
|
||
| #[inline] | ||
| #[track_caller] | ||
| unsafe fn send_super_message_error<A, E>( | ||
| self, | ||
| superclass: &AnyClass, | ||
| sel: Sel, | ||
| args: A, | ||
| ) -> Result<(), Id<E>> | ||
| where | ||
| *mut *mut E: Encode, | ||
| A: TupleExtender<*mut *mut E>, | ||
| <A as TupleExtender<*mut *mut E>>::PlusOneArgument: ConvertArguments, | ||
| E: Message, | ||
| { | ||
| let mut err: *mut E = ptr::null_mut(); | ||
| let args = args.add_argument(&mut err); | ||
| let res: bool = unsafe { self.send_super_message(superclass, sel, args) }; | ||
| if res { | ||
| Ok(()) | ||
| } else { | ||
| Err(unsafe { encountered_error(err) }) | ||
| } | ||
| } | ||
|
|
||
| #[inline] | ||
| #[track_caller] | ||
| unsafe fn send_super_message_static_error<A, E>(self, sel: Sel, args: A) -> Result<(), Id<E>> | ||
| where | ||
| Self::Inner: ClassType, | ||
| <Self::Inner as ClassType>::Super: ClassType, | ||
| *mut *mut E: Encode, | ||
| A: TupleExtender<*mut *mut E>, | ||
| <A as TupleExtender<*mut *mut E>>::PlusOneArgument: ConvertArguments, | ||
| E: Message, | ||
| { | ||
| let mut err: *mut E = ptr::null_mut(); | ||
| let args = args.add_argument(&mut err); | ||
| let res: bool = unsafe { self.send_super_message_static(sel, args) }; | ||
| if res { | ||
| Ok(()) | ||
| } else { | ||
| Err(unsafe { encountered_error(err) }) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[cold] | ||
| #[track_caller] | ||
| unsafe fn encountered_error<E: Message>(err: *mut E) -> Id<E> { | ||
| // SAFETY: Ensured by caller | ||
| unsafe { Id::retain(err) }.expect("error parameter should be set if the method returns NO") | ||
| } | ||
|
|
||
| impl<T: ?Sized + MessageReceiver> MsgSend for T { | ||
| type Inner = T::__Inner; | ||
|
|
||
| #[inline] | ||
| fn into_raw_receiver(self) -> *mut AnyObject { | ||
| MessageReceiver::__as_raw_receiver(self) | ||
| } | ||
| } | ||
|
|
||
| impl<'a, T: ?Sized + Message> MsgSend for &'a Id<T> { | ||
| type Inner = T; | ||
|
|
||
| #[inline] | ||
| fn into_raw_receiver(self) -> *mut AnyObject { | ||
| (Id::as_ptr(self) as *mut T).cast() | ||
| } | ||
| } | ||
|
|
||
| impl<'a, T: ?Sized + Message + IsMutable> MsgSend for &'a mut Id<T> { | ||
| type Inner = T; | ||
|
|
||
| #[inline] | ||
| fn into_raw_receiver(self) -> *mut AnyObject { | ||
| Id::as_mut_ptr(self).cast() | ||
| } | ||
| } | ||
|
|
||
| impl<T: ?Sized + Message> MsgSend for ManuallyDrop<Id<T>> { | ||
| type Inner = T; | ||
|
|
||
| #[inline] | ||
| fn into_raw_receiver(self) -> *mut AnyObject { | ||
| Id::consume_as_ptr(ManuallyDrop::into_inner(self)).cast() | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use crate::msg_send; | ||
| use crate::test_utils; | ||
|
|
||
| use super::*; | ||
|
|
||
| #[test] | ||
| fn test_send_message_manuallydrop() { | ||
| let obj = ManuallyDrop::new(test_utils::custom_object()); | ||
| unsafe { | ||
| let _: () = msg_send![obj, release]; | ||
| }; | ||
| // `obj` is consumed, can't use here | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.