|
| 1 | +use core::mem::ManuallyDrop; |
| 2 | +use core::ptr; |
| 3 | + |
| 4 | +use crate::encode::RefEncode; |
| 5 | +use crate::mutability::IsMutable; |
| 6 | +use crate::rc::Id; |
| 7 | +use crate::runtime::{AnyClass, AnyObject, MessageReceiver, Sel}; |
| 8 | +use crate::{ClassType, Encode, Message}; |
| 9 | + |
| 10 | +use super::{ConvertArguments, ConvertReturn, TupleExtender}; |
| 11 | + |
| 12 | +pub trait MsgSend: Sized { |
| 13 | + type Inner: ?Sized + RefEncode; |
| 14 | + |
| 15 | + fn into_raw_receiver(self) -> *mut AnyObject; |
| 16 | + |
| 17 | + #[inline] |
| 18 | + #[track_caller] |
| 19 | + unsafe fn send_message<A, R>(self, sel: Sel, args: A) -> R |
| 20 | + where |
| 21 | + A: ConvertArguments, |
| 22 | + R: ConvertReturn, |
| 23 | + { |
| 24 | + let (args, stored) = A::__into_arguments(args); |
| 25 | + |
| 26 | + // SAFETY: Upheld by caller |
| 27 | + let result = unsafe { MessageReceiver::send_message(self.into_raw_receiver(), sel, args) }; |
| 28 | + |
| 29 | + // TODO: If we want `objc_retainAutoreleasedReturnValue` to |
| 30 | + // work, we must not do any work before it has been run; so |
| 31 | + // somehow, we should do that _before_ this call! |
| 32 | + // |
| 33 | + // SAFETY: The argument was passed to the message sending |
| 34 | + // function, and the stored values are only processed this |
| 35 | + // once. See `src/__macro_helpers/writeback.rs` for |
| 36 | + // details. |
| 37 | + unsafe { A::__process_after_message_send(stored) }; |
| 38 | + |
| 39 | + R::__from_return(result) |
| 40 | + } |
| 41 | + |
| 42 | + #[inline] |
| 43 | + #[track_caller] |
| 44 | + unsafe fn send_super_message<A, R>(self, superclass: &AnyClass, sel: Sel, args: A) -> R |
| 45 | + where |
| 46 | + A: ConvertArguments, |
| 47 | + R: ConvertReturn, |
| 48 | + { |
| 49 | + let (args, stored) = A::__into_arguments(args); |
| 50 | + |
| 51 | + // SAFETY: Upheld by caller |
| 52 | + let result = unsafe { |
| 53 | + MessageReceiver::send_super_message(self.into_raw_receiver(), superclass, sel, args) |
| 54 | + }; |
| 55 | + |
| 56 | + // SAFETY: Same as in send_message above. |
| 57 | + unsafe { A::__process_after_message_send(stored) }; |
| 58 | + |
| 59 | + R::__from_return(result) |
| 60 | + } |
| 61 | + |
| 62 | + #[inline] |
| 63 | + #[track_caller] |
| 64 | + unsafe fn send_super_message_static<A, R>(self, sel: Sel, args: A) -> R |
| 65 | + where |
| 66 | + Self::Inner: ClassType, |
| 67 | + <Self::Inner as ClassType>::Super: ClassType, |
| 68 | + A: ConvertArguments, |
| 69 | + R: ConvertReturn, |
| 70 | + { |
| 71 | + unsafe { self.send_super_message(<Self::Inner as ClassType>::Super::class(), sel, args) } |
| 72 | + } |
| 73 | + |
| 74 | + // Error functions below. See MsgSendId::send_message_id_error for further |
| 75 | + // details. |
| 76 | + // |
| 77 | + // Some of this could be abstracted away using closures, but that would |
| 78 | + // interfere with `#[track_caller]`, so we avoid doing that. |
| 79 | + |
| 80 | + #[inline] |
| 81 | + #[track_caller] |
| 82 | + unsafe fn send_message_error<A, E>(self, sel: Sel, args: A) -> Result<(), Id<E>> |
| 83 | + where |
| 84 | + *mut *mut E: Encode, |
| 85 | + A: TupleExtender<*mut *mut E>, |
| 86 | + <A as TupleExtender<*mut *mut E>>::PlusOneArgument: ConvertArguments, |
| 87 | + E: Message, |
| 88 | + { |
| 89 | + let mut err: *mut E = ptr::null_mut(); |
| 90 | + let args = args.add_argument(&mut err); |
| 91 | + let res: bool = unsafe { self.send_message(sel, args) }; |
| 92 | + if res { |
| 93 | + Ok(()) |
| 94 | + } else { |
| 95 | + Err(unsafe { encountered_error(err) }) |
| 96 | + } |
| 97 | + } |
| 98 | + |
| 99 | + #[inline] |
| 100 | + #[track_caller] |
| 101 | + unsafe fn send_super_message_error<A, E>( |
| 102 | + self, |
| 103 | + superclass: &AnyClass, |
| 104 | + sel: Sel, |
| 105 | + args: A, |
| 106 | + ) -> Result<(), Id<E>> |
| 107 | + where |
| 108 | + *mut *mut E: Encode, |
| 109 | + A: TupleExtender<*mut *mut E>, |
| 110 | + <A as TupleExtender<*mut *mut E>>::PlusOneArgument: ConvertArguments, |
| 111 | + E: Message, |
| 112 | + { |
| 113 | + let mut err: *mut E = ptr::null_mut(); |
| 114 | + let args = args.add_argument(&mut err); |
| 115 | + let res: bool = unsafe { self.send_super_message(superclass, sel, args) }; |
| 116 | + if res { |
| 117 | + Ok(()) |
| 118 | + } else { |
| 119 | + Err(unsafe { encountered_error(err) }) |
| 120 | + } |
| 121 | + } |
| 122 | + |
| 123 | + #[inline] |
| 124 | + #[track_caller] |
| 125 | + unsafe fn send_super_message_static_error<A, E>(self, sel: Sel, args: A) -> Result<(), Id<E>> |
| 126 | + where |
| 127 | + Self::Inner: ClassType, |
| 128 | + <Self::Inner as ClassType>::Super: ClassType, |
| 129 | + *mut *mut E: Encode, |
| 130 | + A: TupleExtender<*mut *mut E>, |
| 131 | + <A as TupleExtender<*mut *mut E>>::PlusOneArgument: ConvertArguments, |
| 132 | + E: Message, |
| 133 | + { |
| 134 | + let mut err: *mut E = ptr::null_mut(); |
| 135 | + let args = args.add_argument(&mut err); |
| 136 | + let res: bool = unsafe { self.send_super_message_static(sel, args) }; |
| 137 | + if res { |
| 138 | + Ok(()) |
| 139 | + } else { |
| 140 | + Err(unsafe { encountered_error(err) }) |
| 141 | + } |
| 142 | + } |
| 143 | +} |
| 144 | + |
| 145 | +#[cold] |
| 146 | +#[track_caller] |
| 147 | +unsafe fn encountered_error<E: Message>(err: *mut E) -> Id<E> { |
| 148 | + // SAFETY: Ensured by caller |
| 149 | + unsafe { Id::retain(err) }.expect("error parameter should be set if the method returns NO") |
| 150 | +} |
| 151 | + |
| 152 | +impl<T: ?Sized + MessageReceiver> MsgSend for T { |
| 153 | + type Inner = T::__Inner; |
| 154 | + |
| 155 | + #[inline] |
| 156 | + fn into_raw_receiver(self) -> *mut AnyObject { |
| 157 | + MessageReceiver::__as_raw_receiver(self) |
| 158 | + } |
| 159 | +} |
| 160 | + |
| 161 | +impl<'a, T: ?Sized + Message> MsgSend for &'a Id<T> { |
| 162 | + type Inner = T; |
| 163 | + |
| 164 | + #[inline] |
| 165 | + fn into_raw_receiver(self) -> *mut AnyObject { |
| 166 | + (Id::as_ptr(self) as *mut T).cast() |
| 167 | + } |
| 168 | +} |
| 169 | + |
| 170 | +impl<'a, T: ?Sized + Message + IsMutable> MsgSend for &'a mut Id<T> { |
| 171 | + type Inner = T; |
| 172 | + |
| 173 | + #[inline] |
| 174 | + fn into_raw_receiver(self) -> *mut AnyObject { |
| 175 | + Id::as_mut_ptr(self).cast() |
| 176 | + } |
| 177 | +} |
| 178 | + |
| 179 | +impl<T: ?Sized + Message> MsgSend for ManuallyDrop<Id<T>> { |
| 180 | + type Inner = T; |
| 181 | + |
| 182 | + #[inline] |
| 183 | + fn into_raw_receiver(self) -> *mut AnyObject { |
| 184 | + Id::consume_as_ptr(ManuallyDrop::into_inner(self)).cast() |
| 185 | + } |
| 186 | +} |
| 187 | + |
| 188 | +#[cfg(test)] |
| 189 | +mod tests { |
| 190 | + use crate::msg_send; |
| 191 | + use crate::test_utils; |
| 192 | + |
| 193 | + use super::*; |
| 194 | + |
| 195 | + #[test] |
| 196 | + fn test_send_message_manuallydrop() { |
| 197 | + let obj = ManuallyDrop::new(test_utils::custom_object()); |
| 198 | + unsafe { |
| 199 | + let _: () = msg_send![obj, release]; |
| 200 | + }; |
| 201 | + // `obj` is consumed, can't use here |
| 202 | + } |
| 203 | +} |
0 commit comments