Merge pull request #141 from madsmtm/more-stable-sys-crates

Improve stability of `objc-sys` and `block-sys` crates

Author: madsmtm

block-sys/CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased - YYYY-MM-DD
 
+### Changed
+* **BREAKING**: Changed `links` key from `block` to `block_0_0` for better
+  future compatibility, until we reach 1.0 (so `DEP_BLOCK_X` in build scripts
+  becomes `DEP_BLOCK_0_0_X`).
+
 
 ## 0.0.3 - 2022-01-03
 

block-sys/Cargo.toml

@@ -19,7 +19,7 @@ readme = "README.md"
 
 # Downstream users can customize the linking!
 # See https://doc.rust-lang.org/cargo/reference/build-scripts.html#overriding-build-scripts
-links = "block"
+links = "block_0_0"
 build = "build.rs"
 
 [features]

block-sys/README.md

@@ -94,8 +94,8 @@ TODO.
 
 To our knowledge, currently only `clang` supports the [Language Specification
 for Blocks][block-lang]. To assist in compiling C (or Objective-C) sources
-using these features, this crate's build script expose the `DEP_BLOCK_CC_ARGS`
-environment variable to downstream build scripts.
+using these features, this crate's build script expose the
+`DEP_BLOCK_0_0_CC_ARGS` environment variable to downstream build scripts.
 
 Example usage in your `build.rs` (using the `cc` crate) would be as follows:
 
@@ -105,7 +105,7 @@ fn main() {
     builder.compiler("clang");
     builder.file("my_script_using_blocks.c");
 
-    for flag in std::env::var("DEP_BLOCK_CC_ARGS").unwrap().split(' ') {
+    for flag in std::env::var("DEP_BLOCK_0_0_CC_ARGS").unwrap().split(' ') {
         builder.flag(flag);
     }
 

block-sys/build.rs

@@ -47,17 +47,24 @@ fn main() {
             // work (on newer GNUStep versions these headers are present)
             if env::var_os("CARGO_FEATURE_GNUSTEP_2_0").is_none() {
                 let compat_headers =
-                    Path::new(env!("CARGO_MANIFEST_DIR")).join("gnustep-compat-headers");
+                    Path::new(env!("CARGO_MANIFEST_DIR")).join("compat-headers/gnustep");
                 cc_args.push_str(" -I");
                 cc_args.push_str(compat_headers.to_str().unwrap());
             }
         }
-        (false, false, false, true) => unimplemented!(),
+        (false, false, false, true) => {
+            // Add compability headers to make `#include <Block.h>` work.
+            let compat_headers = Path::new(env!("CARGO_MANIFEST_DIR")).join("compat-headers/objfw");
+            cc_args.push_str(" -I");
+            cc_args.push_str(compat_headers.to_str().unwrap());
+            println!("cargo:rustc-link-lib=dylib=objfw");
+            unimplemented!("ObjFW is not yet supported")
+        }
         // Checked in if-let above
         (false, false, false, false) => unreachable!(),
         (_, _, _, _) => panic!("Invalid feature combination; only one runtime may be selected!"),
     }
 
-    // Add DEP_BLOCK_CC_ARGS
+    // Add DEP_BLOCK_[version]_CC_ARGS
     println!("cargo:cc_args={}", cc_args);
 }

block-sys/gnustep-compat-headers/Block.h renamed to block-sys/compat-headers/gnustep/Block.h

@@ -0,0 +1 @@
+#include <ObjFW/block.h>

block-sys/gnustep-compat-headers/Block_private.h renamed to block-sys/compat-headers/gnustep/Block_private.h

@@ -9,9 +9,12 @@
 //!
 //! [ABI]: https://clang.llvm.org/docs/Block-ABI-Apple.html
 
+#![no_std]
 // Update in Cargo.toml as well.
 #![doc(html_root_url = "https://docs.rs/block-sys/0.0.3")]
 
+extern crate std;
+
 // Ensure linkage actually happens
 #[cfg(feature = "gnustep-1-7")]
 extern crate objc_sys as _;
@@ -298,7 +301,6 @@ pub struct Block_descriptor {
 ///
 /// Requires BLOCK_HAS_SIGNATURE
 #[repr(C)]
-#[cfg(not(feature = "objfw"))]
 pub struct Block_descriptor_basic {
     pub header: Block_descriptor_header,
 
@@ -388,3 +390,50 @@ pub struct Block_byref_extended {
     pub inner: Block_byref,
     pub layout: *const c_char,
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use core::ptr;
+    use std::println;
+
+    #[test]
+    fn smoke() {
+        assert_eq!(unsafe { _Block_copy(ptr::null()) }, ptr::null_mut());
+    }
+
+    #[test]
+    fn test_linkable() {
+        println!("{:p}", unsafe { &_NSConcreteGlobalBlock });
+        println!("{:p}", unsafe { &_NSConcreteStackBlock });
+        println!("{:p}", unsafe { &_NSConcreteMallocBlock });
+        println!(
+            "{:p}",
+            _Block_copy as unsafe extern "C" fn(*const c_void) -> *mut c_void
+        );
+        println!(
+            "{:p}",
+            _Block_object_assign
+                as unsafe extern "C" fn(*mut c_void, *const c_void, block_assign_dispose_flags)
+        );
+        println!(
+            "{:p}",
+            _Block_object_dispose
+                as unsafe extern "C" fn(*const c_void, block_assign_dispose_flags)
+        );
+        println!(
+            "{:p}",
+            _Block_release as unsafe extern "C" fn(*const c_void)
+        );
+        #[cfg(any(feature = "apple", feature = "compiler-rt"))]
+        {
+            println!("{:p}", unsafe { &_NSConcreteAutoBlock });
+            println!("{:p}", unsafe { &_NSConcreteFinalizingBlock });
+            println!("{:p}", unsafe { &_NSConcreteWeakBlockVariable });
+            println!(
+                "{:p}",
+                Block_size as unsafe extern "C" fn(*mut c_void) -> c_ulong
+            );
+        }
+    }
+}

block-sys/compat-headers/objfw/Block.h

@@ -6,6 +6,19 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased - YYYY-MM-DD
 
+### Changed
+* **BREAKING**: Changed `links` key from `objc` to `objc_0_2` for better
+  future compatibility, until we reach 1.0 (so `DEP_OBJC_X` in build scripts
+  becomes `DEP_OBJC_0_2_X`).
+
+### Removed
+* **BREAKING**: Removed type aliases `Class`, `Ivar`, `Method` and `Protocol`
+  since they could easily be mistaken for the `objc2::runtime` structs with
+  the same name.
+* **BREAKING**: Removed `objc_property_t`.
+* **BREAKING**: Removed `objc_hook_getClass` and `objc_hook_lazyClassNamer`
+  type aliases (for now).
+
 
 ## 0.2.0-alpha.1 - 2022-01-03
 

block-sys/src/lib.rs

@@ -19,7 +19,7 @@ readme = "README.md"
 
 # Downstream users can customize the linking to libobjc!
 # See https://doc.rust-lang.org/cargo/reference/build-scripts.html#overriding-build-scripts
-links = "objc"
+links = "objc_0_2"
 build = "build.rs"
 
 # The default is `apple` on Apple platforms; all other platforms will error