|
| 1 | +//! Defines types and macros for Objective-C interoperability. |
| 2 | +
|
| 3 | +#![unstable(feature = "darwin_objc", issue = "145496")] |
| 4 | +#![allow(nonstandard_style)] |
| 5 | + |
| 6 | +use crate::fmt; |
| 7 | + |
| 8 | +/// Equivalent to Objective-C’s `struct objc_class` type. |
| 9 | +#[cfg_attr(not(doc), repr(u8))] // An implementation detail we don't want to show up in rustdoc |
| 10 | +pub enum objc_class { |
| 11 | + #[unstable( |
| 12 | + feature = "objc_class_variant", |
| 13 | + reason = "temporary implementation detail", |
| 14 | + issue = "none" |
| 15 | + )] |
| 16 | + #[doc(hidden)] |
| 17 | + __variant1, |
| 18 | + #[unstable( |
| 19 | + feature = "objc_class_variant", |
| 20 | + reason = "temporary implementation detail", |
| 21 | + issue = "none" |
| 22 | + )] |
| 23 | + #[doc(hidden)] |
| 24 | + __variant2, |
| 25 | +} |
| 26 | + |
| 27 | +impl fmt::Debug for objc_class { |
| 28 | + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
| 29 | + f.debug_struct("objc_class").finish() |
| 30 | + } |
| 31 | +} |
| 32 | + |
| 33 | +/// Equivalent to Objective-C’s `struct objc_selector` type. |
| 34 | +#[cfg_attr(not(doc), repr(u8))] // An implementation detail we don't want to show up in rustdoc |
| 35 | +pub enum objc_selector { |
| 36 | + #[unstable( |
| 37 | + feature = "objc_selector_variant", |
| 38 | + reason = "temporary implementation detail", |
| 39 | + issue = "none" |
| 40 | + )] |
| 41 | + #[doc(hidden)] |
| 42 | + __variant1, |
| 43 | + #[unstable( |
| 44 | + feature = "objc_selector_variant", |
| 45 | + reason = "temporary implementation detail", |
| 46 | + issue = "none" |
| 47 | + )] |
| 48 | + #[doc(hidden)] |
| 49 | + __variant2, |
| 50 | +} |
| 51 | + |
| 52 | +impl fmt::Debug for objc_selector { |
| 53 | + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
| 54 | + f.debug_struct("objc_selector").finish() |
| 55 | + } |
| 56 | +} |
| 57 | + |
| 58 | +/// Equivalent to Objective-C’s `Class` type. |
| 59 | +pub type Class = *mut objc_class; |
| 60 | + |
| 61 | +/// Equivalent to Objective-C’s `SEL` type. |
| 62 | +pub type SEL = *mut objc_selector; |
| 63 | + |
| 64 | +/// Gets a reference to an Objective-C class. |
| 65 | +/// |
| 66 | +/// This macro will yield an expression of type [`Class`] for the given class name string literal. |
| 67 | +/// |
| 68 | +/// # Example |
| 69 | +/// |
| 70 | +/// ```no_run |
| 71 | +/// #![feature(darwin_objc)] |
| 72 | +/// use core::os::darwin::objc; |
| 73 | +/// |
| 74 | +/// let string_class = objc::class!("NSString"); |
| 75 | +/// ``` |
| 76 | +#[allow_internal_unstable(rustc_attrs)] |
| 77 | +pub macro class($classname:expr) {{ |
| 78 | + // Since static Objective-C class references actually end up with multiple definitions |
| 79 | + // across dylib boundaries, we only expose the value of the static and don't provide a way to |
| 80 | + // get the address of or a reference to the static. |
| 81 | + unsafe extern "C" { |
| 82 | + #[rustc_objc_class = $classname] |
| 83 | + safe static VAL: $crate::os::darwin::objc::Class; |
| 84 | + } |
| 85 | + VAL |
| 86 | +}} |
| 87 | + |
| 88 | +/// Gets a reference to an Objective-C selector. |
| 89 | +/// |
| 90 | +/// This macro will yield an expression of type [`SEL`] for the given method name string literal. |
| 91 | +/// |
| 92 | +/// It is similar to Objective-C’s `@selector` directive. |
| 93 | +/// |
| 94 | +/// # Examples |
| 95 | +/// |
| 96 | +/// ```no_run |
| 97 | +/// #![feature(darwin_objc)] |
| 98 | +/// use core::os::darwin::objc; |
| 99 | +/// |
| 100 | +/// let alloc_sel = objc::selector!("alloc"); |
| 101 | +/// let init_sel = objc::selector!("initWithCString:encoding:"); |
| 102 | +/// ``` |
| 103 | +#[allow_internal_unstable(rustc_attrs)] |
| 104 | +pub macro selector($methname:expr) {{ |
| 105 | + // Since static Objective-C selector references actually end up with multiple definitions |
| 106 | + // across dylib boundaries, we only expose the value of the static and don't provide a way to |
| 107 | + // get the address of or a reference to the static. |
| 108 | + unsafe extern "C" { |
| 109 | + #[rustc_objc_selector = $methname] |
| 110 | + safe static VAL: $crate::os::darwin::objc::SEL; |
| 111 | + } |
| 112 | + VAL |
| 113 | +}} |
0 commit comments