cfg-guard objc_sys symbols not available in ObjFW

Author: madsmtm

objc-sys/src/class.rs

@@ -27,6 +27,7 @@ extern_c! {
     pub fn objc_getClass(name: *const c_char) -> *const objc_class;
     pub fn objc_getRequiredClass(name: *const c_char) -> *const objc_class;
     pub fn objc_lookUpClass(name: *const c_char) -> *const objc_class;
+    #[cfg(not(objfw))]
     pub fn objc_getMetaClass(name: *const c_char) -> *const objc_class;
     pub fn objc_copyClassList(out_len: *mut c_uint) -> *mut *const objc_class;
     pub fn objc_getClassList(buffer: *mut *const objc_class, buffer_len: c_int) -> c_int;
@@ -42,9 +43,11 @@ extern_c! {
         name: *const c_char,
         extra_bytes: usize,
     ) -> *mut objc_class;
+    #[cfg(not(objfw))]
     pub fn objc_disposeClassPair(cls: *mut objc_class);
     pub fn objc_registerClassPair(cls: *mut objc_class);
 
+    #[cfg(not(objfw))]
     pub fn class_addIvar(
         cls: *mut objc_class,
         name: *const c_char,
@@ -58,53 +61,68 @@ extern_c! {
         imp: IMP,
         types: *const c_char,
     ) -> BOOL;
+    #[cfg(not(objfw))]
     pub fn class_addProperty(
         cls: *mut objc_class,
         name: *const c_char,
         attributes: *const objc_property_attribute_t,
         attributes_count: c_uint,
     ) -> BOOL;
+    #[cfg(not(objfw))]
     pub fn class_addProtocol(cls: *mut objc_class, protocol: *const objc_protocol) -> BOOL;
     pub fn class_conformsToProtocol(cls: *const objc_class, protocol: *const objc_protocol)
         -> BOOL;
+
+    #[cfg(not(objfw))] // Available in newer versions
     pub fn class_copyIvarList(
         cls: *const objc_class,
         out_len: *mut c_uint,
     ) -> *mut *const objc_ivar;
+    #[cfg(not(objfw))] // Available in newer versions
     pub fn class_copyMethodList(
         cls: *const objc_class,
         out_len: *mut c_uint,
     ) -> *mut *const objc_method;
+    #[cfg(not(objfw))] // Available in newer versions
     pub fn class_copyPropertyList(
         cls: *const objc_class,
         out_len: *mut c_uint,
     ) -> *mut *const objc_property;
+    #[cfg(not(objfw))]
     pub fn class_copyProtocolList(
         cls: *const objc_class,
         out_len: *mut c_uint,
     ) -> *mut *const objc_protocol;
 
+    #[cfg(not(objfw))]
     pub fn class_createInstance(cls: *const objc_class, extra_bytes: usize) -> *mut objc_object;
+    #[cfg(not(objfw))]
     pub fn class_getClassMethod(
         cls: *const objc_class,
         name: *const objc_selector,
     ) -> *const objc_method;
+    #[cfg(not(objfw))]
     pub fn class_getClassVariable(cls: *const objc_class, name: *const c_char) -> *const objc_ivar;
     #[cfg(apple)]
     pub fn class_getImageName(cls: *const objc_class) -> *const c_char;
+    #[cfg(not(objfw))] // Available in newer versions
     pub fn class_getInstanceMethod(
         cls: *const objc_class,
         name: *const objc_selector,
     ) -> *const objc_method;
     pub fn class_getInstanceSize(cls: *const objc_class) -> usize;
+    #[cfg(not(objfw))]
     pub fn class_getInstanceVariable(
         cls: *const objc_class,
         name: *const c_char,
     ) -> *const objc_ivar;
+    #[cfg(not(objfw))]
     pub fn class_getIvarLayout(cls: *const objc_class) -> *const ivar_layout_type;
     pub fn class_getName(cls: *const objc_class) -> *const c_char;
+    #[cfg(not(objfw))]
     pub fn class_getProperty(cls: *const objc_class, name: *const c_char) -> *const objc_property;
     pub fn class_getSuperclass(cls: *const objc_class) -> *const objc_class;
+    #[cfg(not(objfw))]
     pub fn class_getVersion(cls: *const objc_class) -> c_int;
     #[cfg(apple)]
     pub fn class_getWeakIvarLayout(cls: *const objc_class) -> *const ivar_layout_type;
@@ -115,14 +133,17 @@ extern_c! {
         imp: IMP,
         types: *const c_char,
     ) -> IMP;
+    #[cfg(not(objfw))]
     pub fn class_replaceProperty(
         cls: *mut objc_class,
         name: *const c_char,
         attributes: *const objc_property_attribute_t,
         attributes_len: c_uint,
     );
     pub fn class_respondsToSelector(cls: *const objc_class, sel: *const objc_selector) -> BOOL;
+    #[cfg(not(objfw))]
     pub fn class_setIvarLayout(cls: *mut objc_class, layout: *const ivar_layout_type);
+    #[cfg(not(objfw))]
     pub fn class_setVersion(cls: *mut objc_class, version: c_int);
     #[cfg(apple)]
     pub fn class_setWeakIvarLayout(cls: *mut objc_class, layout: *const ivar_layout_type);

objc-sys/src/exception.rs

@@ -24,6 +24,10 @@ pub type objc_exception_preprocessor =
 #[cfg(apple)]
 pub type objc_uncaught_exception_handler = unsafe extern "C" fn(exception: *mut objc_object);
 
+#[cfg(objfw)]
+pub type objc_uncaught_exception_handler =
+    Option<unsafe extern "C" fn(exception: *mut objc_object)>;
+
 /// Only available on macOS.
 ///
 /// Remember that this is non-null!
@@ -32,7 +36,9 @@ pub type objc_exception_handler =
     unsafe extern "C" fn(unused: *mut objc_object, context: *mut c_void);
 
 extern_c! {
+    #[cfg(not(objfw))]
     pub fn objc_begin_catch(exc_buf: *mut c_void) -> *mut objc_object;
+    #[cfg(not(objfw))]
     pub fn objc_end_catch();
     /// See [`objc-exception.h`].
     ///
@@ -49,7 +55,7 @@ extern_c! {
     pub fn objc_setExceptionPreprocessor(
         f: objc_exception_preprocessor,
     ) -> objc_exception_preprocessor;
-    #[cfg(apple)]
+    #[cfg(any(apple, objfw))]
     pub fn objc_setUncaughtExceptionHandler(
         f: objc_uncaught_exception_handler,
     ) -> objc_uncaught_exception_handler;

objc-sys/src/message.rs

@@ -68,8 +68,8 @@ extern_c! {
     /// Not available on `target_arch = "aarch64"`
     #[cfg(all(apple, not(target_arch = "aarch64")))]
     pub fn _objc_msgForward_stret();
-    /// Not available on `target_arch = "aarch64"`
-    #[cfg(not(target_arch = "aarch64"))]
+    /// Not available on `target_arch = "aarch64"`, always available on ObjFW
+    #[cfg(any(objfw, not(target_arch = "aarch64")))]
     pub fn class_getMethodImplementation_stret();
 
     // __x86_64__ and __i386__

objc-sys/src/method.rs

@@ -1,6 +1,10 @@
-use std::os::raw::{c_char, c_uint};
+use std::os::raw::c_char;
+#[cfg(objfw)]
+use std::os::raw::c_uint;
 
-use crate::{objc_selector, OpaqueData, IMP};
+#[cfg(objfw)]
+use crate::IMP;
+use crate::{objc_selector, OpaqueData};
 
 /// A type that represents a method in a class definition.
 #[repr(C)]
@@ -20,6 +24,8 @@ pub struct objc_method_description {
 }
 
 extern_c! {
+    #![cfg(objfw)]
+
     pub fn method_copyArgumentType(method: *const objc_method, index: c_uint) -> *mut c_char;
     pub fn method_copyReturnType(method: *const objc_method) -> *mut c_char;
     pub fn method_exchangeImplementations(method1: *mut objc_method, method2: *mut objc_method);

objc-sys/src/object.rs

@@ -1,3 +1,4 @@
+#[cfg(not(objfw))]
 use core::ffi::c_void;
 use std::os::raw::c_char;
 
@@ -15,23 +16,31 @@ pub struct objc_object {
 extern_c! {
     pub fn object_getClass(obj: *const objc_object) -> *const objc_class;
     pub fn object_getClassName(obj: *const objc_object) -> *const c_char;
+    pub fn object_setClass(obj: *mut objc_object, cls: *const objc_class) -> *const objc_class;
+
+    #[cfg(not(objfw))]
     pub fn object_getIndexedIvars(obj: *const objc_object) -> *const c_void;
+    #[cfg(not(objfw))]
     pub fn object_getIvar(obj: *const objc_object, ivar: *const objc_ivar) -> *const objc_object;
-
-    pub fn object_setClass(obj: *mut objc_object, cls: *const objc_class) -> *const objc_class;
+    #[cfg(not(objfw))]
     pub fn object_setIvar(obj: *mut objc_object, ivar: *const objc_ivar, value: *mut objc_object);
 
     #[deprecated = "Not needed since ARC"]
     #[cfg(apple)]
     pub fn object_copy(obj: *const objc_object, size: usize) -> *mut objc_object;
+
     #[deprecated = "Not needed since ARC"]
+    #[cfg(not(objfw))]
     pub fn object_dispose(obj: *mut objc_object) -> *mut objc_object;
+
     #[deprecated = "Not needed since ARC"]
+    #[cfg(not(objfw))]
     pub fn object_setInstanceVariable(
         obj: *mut objc_object,
         name: *const c_char,
         value: *mut c_void,
     ) -> *const objc_ivar;
+
     // Available in macOS 10.12
     // #[deprecated = "Not needed since ARC"]
     // #[cfg(apple)]
@@ -40,12 +49,15 @@ extern_c! {
     //     name: *const c_char,
     //     value: *mut c_void,
     // ) -> *const objc_ivar;
+
     #[deprecated = "Not needed since ARC"]
+    #[cfg(not(objfw))]
     pub fn object_getInstanceVariable(
         obj: *const objc_object,
         name: *const c_char,
         out_value: *mut *const c_void,
     ) -> *const objc_ivar;
+
     #[deprecated = "Not needed since ARC"]
     #[cfg(apple)]
     pub fn objc_getFutureClass(name: *const c_char) -> *const objc_class;

objc-sys/src/property.rs

@@ -22,6 +22,8 @@ pub struct objc_property_attribute_t {
 }
 
 extern_c! {
+    #![cfg(not(objfw))]
+
     pub fn property_copyAttributeList(
         property: *const objc_property,
         out_len: *mut c_uint,

objc-sys/src/protocol.rs

@@ -19,19 +19,32 @@ pub struct objc_protocol {
 }
 
 extern_c! {
+    #[cfg(not(objfw))]
     pub fn objc_getProtocol(name: *const c_char) -> *const objc_protocol;
+    #[cfg(not(objfw))]
     pub fn objc_copyProtocolList(out_len: *mut c_uint) -> *mut *const objc_protocol;
 
+    #[cfg(not(objfw))]
     pub fn objc_allocateProtocol(name: *const c_char) -> *mut objc_protocol;
+    #[cfg(not(objfw))]
     pub fn objc_registerProtocol(proto: *mut objc_protocol);
 
+    pub fn protocol_conformsToProtocol(
+        proto: *const objc_protocol,
+        other: *const objc_protocol,
+    ) -> BOOL;
+    pub fn protocol_isEqual(proto: *const objc_protocol, other: *const objc_protocol) -> BOOL;
+    pub fn protocol_getName(proto: *const objc_protocol) -> *const c_char;
+
+    #[cfg(not(objfw))]
     pub fn protocol_addMethodDescription(
         proto: *mut objc_protocol,
         name: *const objc_selector,
         types: *const c_char,
         is_required_method: BOOL,
         is_instance_method: BOOL,
     );
+    #[cfg(not(objfw))]
     pub fn protocol_addProperty(
         proto: *mut objc_protocol,
         name: *const c_char,
@@ -40,39 +53,39 @@ extern_c! {
         is_required_property: BOOL,
         is_instance_property: BOOL,
     );
+    #[cfg(not(objfw))]
     pub fn protocol_addProtocol(proto: *mut objc_protocol, addition: *const objc_protocol);
-    pub fn protocol_conformsToProtocol(
-        proto: *const objc_protocol,
-        other: *const objc_protocol,
-    ) -> BOOL;
+    #[cfg(not(objfw))]
     pub fn protocol_copyMethodDescriptionList(
         proto: *const objc_protocol,
         is_required_method: BOOL,
         is_instance_method: BOOL,
         out_len: *mut c_uint,
     ) -> *mut objc_method_description;
+    #[cfg(not(objfw))]
     pub fn protocol_copyPropertyList(
         proto: *const objc_protocol,
         out_len: *mut c_uint,
     ) -> *mut *const objc_property;
+    #[cfg(not(objfw))]
     pub fn protocol_copyProtocolList(
         proto: *const objc_protocol,
         out_len: *mut c_uint,
     ) -> *mut *const objc_protocol;
+    #[cfg(not(objfw))]
     pub fn protocol_getMethodDescription(
         proto: *const objc_protocol,
         sel: *const objc_selector,
         is_required_method: BOOL,
         is_instance_method: BOOL,
     ) -> objc_method_description;
-    pub fn protocol_getName(proto: *const objc_protocol) -> *const c_char;
+    #[cfg(not(objfw))]
     pub fn protocol_getProperty(
         proto: *const objc_protocol,
         name: *const c_char,
         is_required_property: BOOL,
         is_instance_property: BOOL,
     ) -> *const objc_property;
-    pub fn protocol_isEqual(proto: *const objc_protocol, other: *const objc_protocol) -> BOOL;
 
     // #[cfg(macos >= 10.12)]
     // protocol_copyPropertyList2

objc-sys/src/rc.rs

@@ -1,23 +1,29 @@
 //! ARC functions.
 //!
-//! All available since macOS `10.7`.
+//! Is available in Clang's [documentation][ARC] so these are safe to rely on.
 //!
-//! Defined in `objc-internal.h`, but is available in Clang's
-//! [documentation][ARC] so these are safe to rely on.
+//! All available since macOS `10.7`.
 //!
-//! On GNUStep these are defined in `objc-arc.h`.
+//! Defined in:
+//! - Apple: `objc-internal.h`
+//! - GNUStep: `objc-arc.h`
+//! - ObjFW: `runtime/arc.m`
 //!
 //! [ARC]: https://clang.llvm.org/docs/AutomaticReferenceCounting.html#runtime-support>
 use core::ffi::c_void;
 
 use crate::objc_object;
 
 extern_c! {
-    // Autorelease
+    // Autoreleasepool
+    // ObjFW: Defined in `autorelease.h`
 
-    pub fn objc_autorelease(value: *mut objc_object) -> *mut objc_object;
     pub fn objc_autoreleasePoolPop(pool: *mut c_void);
     pub fn objc_autoreleasePoolPush() -> *mut c_void;
+
+    // Autorelease
+
+    pub fn objc_autorelease(value: *mut objc_object) -> *mut objc_object;
     pub fn objc_autoreleaseReturnValue(value: *mut objc_object) -> *mut objc_object;
 
     // Weak pointers

objc-sys/src/selector.rs

@@ -13,9 +13,12 @@ pub struct objc_selector {
 
 extern_c! {
     pub fn sel_getName(sel: *const objc_selector) -> *const c_char;
-    pub fn sel_getUid(name: *const c_char) -> *const objc_selector;
     pub fn sel_isEqual(lhs: *const objc_selector, rhs: *const objc_selector) -> BOOL;
+    pub fn sel_registerName(name: *const c_char) -> *const objc_selector;
+
+    #[cfg(not(objfw))]
+    pub fn sel_getUid(name: *const c_char) -> *const objc_selector;
+
     #[cfg(apple)]
     pub fn sel_isMapped(sel: *const objc_selector) -> BOOL;
-    pub fn sel_registerName(name: *const c_char) -> *const objc_selector;
 }