Adding upstream version 110.0.1.upstream/110.0.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 296 insertions, 0 deletions

diff --git a/third_party/rust/objc/src/message/mod.rs b/third_party/rust/objc/src/message/mod.rs
new file mode 100644
index 0000000000..cb11e993a8
--- /dev/null
+++ b/third_party/rust/objc/src/message/mod.rs
@@ -0,0 +1,296 @@
+use std::any::Any;
+use std::error::Error;
+use std::fmt;
+use std::mem;
+
+use runtime::{Class, Imp, Object, Sel};
+use {Encode, EncodeArguments};
+
+#[cfg(feature = "exception")]
+macro_rules! objc_try {
+    ($b:block) => (
+        $crate::exception::try(|| $b).map_err(|exception|
+            if exception.is_null() {
+                MessageError("Uncaught exception nil".to_owned())
+            } else {
+                MessageError(format!("Uncaught exception {:?}", &**exception))
+            }
+        )
+    )
+}
+
+#[cfg(not(feature = "exception"))]
+macro_rules! objc_try {
+    ($b:block) => (Ok($b))
+}
+
+mod verify;
+
+#[cfg(any(target_os = "macos", target_os = "ios"))]
+#[path = "apple/mod.rs"]
+mod platform;
+#[cfg(not(any(target_os = "macos", target_os = "ios")))]
+#[path = "gnustep.rs"]
+mod platform;
+
+use self::platform::{send_unverified, send_super_unverified};
+use self::verify::verify_message_signature;
+
+/// Specifies the superclass of an instance.
+#[repr(C)]
+pub struct Super {
+    /// Specifies an instance of a class.
+    pub receiver: *mut Object,
+    /// Specifies the particular superclass of the instance to message.
+    pub superclass: *const Class,
+}
+
+/// Types that may be sent Objective-C messages.
+/// For example: objects, classes, and blocks.
+pub unsafe trait Message {
+    /**
+    Sends a message to self with the given selector and arguments.
+
+    The correct version of `objc_msgSend` will be chosen based on the
+    return type. For more information, see Apple's documentation:
+    <https://developer.apple.com/library/mac/documentation/Cocoa/Reference/ObjCRuntimeRef/index.html#//apple_ref/doc/uid/TP40001418-CH1g-88778>
+
+    If the selector is known at compile-time, it is recommended to use the
+    `msg_send!` macro rather than this method.
+    */
+    #[cfg(not(feature = "verify_message"))]
+    unsafe fn send_message<A, R>(&self, sel: Sel, args: A)
+            -> Result<R, MessageError>
+            where Self: Sized, A: MessageArguments, R: Any {
+        send_message(self, sel, args)
+    }
+
+    #[cfg(feature = "verify_message")]
+    unsafe fn send_message<A, R>(&self, sel: Sel, args: A)
+            -> Result<R, MessageError>
+            where Self: Sized, A: MessageArguments + EncodeArguments,
+            R: Any + Encode {
+        send_message(self, sel, args)
+    }
+
+    /**
+    Verifies that the argument and return types match the encoding of the
+    method for the given selector.
+
+    This will look up the encoding of the method for the given selector, `sel`,
+    and return a `MessageError` if any encodings differ for the arguments `A`
+    and return type `R`.
+
+    # Example
+    ``` no_run
+    # #[macro_use] extern crate objc;
+    # use objc::runtime::{BOOL, Class, Object};
+    # use objc::Message;
+    # fn main() {
+    let obj: &Object;
+    # obj = unsafe { msg_send![class!(NSObject), new] };
+    let sel = sel!(isKindOfClass:);
+    // Verify isKindOfClass: takes one Class and returns a BOOL
+    let result = obj.verify_message::<(&Class,), BOOL>(sel);
+    assert!(result.is_ok());
+    # }
+    ```
+    */
+    fn verify_message<A, R>(&self, sel: Sel) -> Result<(), MessageError>
+            where Self: Sized, A: EncodeArguments, R: Encode {
+        let obj = unsafe { &*(self as *const _ as *const Object) };
+        verify_message_signature::<A, R>(obj.class(), sel)
+    }
+}
+
+unsafe impl Message for Object { }
+
+unsafe impl Message for Class { }
+
+/// Types that may be used as the arguments of an Objective-C message.
+pub trait MessageArguments: Sized {
+    /// Invoke an `Imp` with the given object, selector, and arguments.
+    ///
+    /// This method is the primitive used when sending messages and should not
+    /// be called directly; instead, use the `msg_send!` macro or, in cases
+    /// with a dynamic selector, the `Message::send_message` method.
+    unsafe fn invoke<R>(imp: Imp, obj: *mut Object, sel: Sel, args: Self) -> R
+            where R: Any;
+}
+
+macro_rules! message_args_impl {
+    ($($a:ident : $t:ident),*) => (
+        impl<$($t),*> MessageArguments for ($($t,)*) {
+            unsafe fn invoke<R>(imp: Imp, obj: *mut Object, sel: Sel, ($($a,)*): Self) -> R
+                    where R: Any {
+                let imp: unsafe extern fn(*mut Object, Sel $(, $t)*) -> R =
+                    mem::transmute(imp);
+                imp(obj, sel $(, $a)*)
+            }
+        }
+    );
+}
+
+message_args_impl!();
+message_args_impl!(a: A);
+message_args_impl!(a: A, b: B);
+message_args_impl!(a: A, b: B, c: C);
+message_args_impl!(a: A, b: B, c: C, d: D);
+message_args_impl!(a: A, b: B, c: C, d: D, e: E);
+message_args_impl!(a: A, b: B, c: C, d: D, e: E, f: F);
+message_args_impl!(a: A, b: B, c: C, d: D, e: E, f: F, g: G);
+message_args_impl!(a: A, b: B, c: C, d: D, e: E, f: F, g: G, h: H);
+message_args_impl!(a: A, b: B, c: C, d: D, e: E, f: F, g: G, h: H, i: I);
+message_args_impl!(a: A, b: B, c: C, d: D, e: E, f: F, g: G, h: H, i: I, j: J);
+message_args_impl!(a: A, b: B, c: C, d: D, e: E, f: F, g: G, h: H, i: I, j: J, k: K);
+message_args_impl!(a: A, b: B, c: C, d: D, e: E, f: F, g: G, h: H, i: I, j: J, k: K, l: L);
+
+/**
+An error encountered while attempting to send a message.
+
+Currently, an error may be returned in two cases:
+
+* an Objective-C exception is thrown and the `exception` feature is enabled
+* the encodings of the arguments do not match the encoding of the method
+  and the `verify_message` feature is enabled
+*/
+#[derive(Debug)]
+pub struct MessageError(String);
+
+impl fmt::Display for MessageError {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        fmt::Display::fmt(&self.0, f)
+    }
+}
+
+impl Error for MessageError {
+    fn description(&self) -> &str {
+        &self.0
+    }
+}
+
+#[doc(hidden)]
+#[inline(always)]
+#[cfg(not(feature = "verify_message"))]
+pub unsafe fn send_message<T, A, R>(obj: *const T, sel: Sel, args: A)
+        -> Result<R, MessageError>
+        where T: Message, A: MessageArguments, R: Any {
+    send_unverified(obj, sel, args)
+}
+
+#[doc(hidden)]
+#[inline(always)]
+#[cfg(feature = "verify_message")]
+pub unsafe fn send_message<T, A, R>(obj: *const T, sel: Sel, args: A)
+        -> Result<R, MessageError>
+        where T: Message, A: MessageArguments + EncodeArguments,
+        R: Any + Encode {
+    let cls = if obj.is_null() {
+        return Err(MessageError(format!("Messaging {:?} to nil", sel)));
+    } else {
+        (*(obj as *const Object)).class()
+    };
+
+    verify_message_signature::<A, R>(cls, sel).and_then(|_| {
+        send_unverified(obj, sel, args)
+    })
+}
+
+#[doc(hidden)]
+#[inline(always)]
+#[cfg(not(feature = "verify_message"))]
+pub unsafe fn send_super_message<T, A, R>(obj: *const T, superclass: &Class,
+        sel: Sel, args: A) -> Result<R, MessageError>
+        where T: Message, A: MessageArguments, R: Any {
+    send_super_unverified(obj, superclass, sel, args)
+}
+
+#[doc(hidden)]
+#[inline(always)]
+#[cfg(feature = "verify_message")]
+pub unsafe fn send_super_message<T, A, R>(obj: *const T, superclass: &Class,
+        sel: Sel, args: A) -> Result<R, MessageError>
+        where T: Message, A: MessageArguments + EncodeArguments,
+        R: Any + Encode {
+    if obj.is_null() {
+        return Err(MessageError(format!("Messaging {:?} to nil", sel)));
+    }
+
+    verify_message_signature::<A, R>(superclass, sel).and_then(|_| {
+        send_super_unverified(obj, superclass, sel, args)
+    })
+}
+
+#[cfg(test)]
+mod tests {
+    use test_utils;
+    use runtime::Object;
+    use super::Message;
+
+    #[test]
+    fn test_send_message() {
+        let obj = test_utils::custom_object();
+        let result: u32 = unsafe {
+            let _: () = msg_send![obj, setFoo:4u32];
+            msg_send![obj, foo]
+        };
+        assert!(result == 4);
+    }
+
+    #[test]
+    fn test_send_message_stret() {
+        let obj = test_utils::custom_object();
+        let result: test_utils::CustomStruct = unsafe {
+            msg_send![obj, customStruct]
+        };
+        let expected = test_utils::CustomStruct { a: 1, b:2, c: 3, d: 4 };
+        assert!(result == expected);
+    }
+
+    #[cfg(not(feature = "verify_message"))]
+    #[test]
+    fn test_send_message_nil() {
+        let nil: *mut Object = ::std::ptr::null_mut();
+        let result: usize = unsafe {
+            msg_send![nil, hash]
+        };
+        assert!(result == 0);
+
+        let result: *mut Object = unsafe {
+            msg_send![nil, description]
+        };
+        assert!(result.is_null());
+
+        let result: f64 = unsafe {
+            msg_send![nil, doubleValue]
+        };
+        assert!(result == 0.0);
+    }
+
+    #[test]
+    fn test_send_message_super() {
+        let obj = test_utils::custom_subclass_object();
+        let superclass = test_utils::custom_class();
+        unsafe {
+            let _: () = msg_send![obj, setFoo:4u32];
+            let foo: u32 = msg_send![super(obj, superclass), foo];
+            assert!(foo == 4);
+
+            // The subclass is overriden to return foo + 2
+            let foo: u32 = msg_send![obj, foo];
+            assert!(foo == 6);
+        }
+    }
+
+    #[test]
+    fn test_verify_message() {
+        let obj = test_utils::custom_object();
+        assert!(obj.verify_message::<(), u32>(sel!(foo)).is_ok());
+        assert!(obj.verify_message::<(u32,), ()>(sel!(setFoo:)).is_ok());
+
+        // Incorrect types
+        assert!(obj.verify_message::<(), u64>(sel!(setFoo:)).is_err());
+        // Unimplemented selector
+        assert!(obj.verify_message::<(u32,), ()>(sel!(setFoo)).is_err());
+    }
+}