Merge remote-tracking branch '0fork/crate-runtime-features'

Author: madsmtm

.github/workflows/ci.yml

@@ -79,15 +79,13 @@ jobs:
           - name: Test GNUStep
             os: ubuntu-latest
             target: x86_64-unknown-linux-gnu
-            host-args: --features block-sys/gnustep-1-9,objc-sys/gnustep-1-9
-            args: --features block-sys/gnustep-1-9,objc-sys/gnustep-1-9
+            runtime: gnustep-1-9
           - name: Test GNUStep 32bit
             os: ubuntu-latest
             target: i686-unknown-linux-gnu
             cflags: -m32
             configureflags: --target=x86-pc-linux-gnu
-            host-args: --features block-sys/gnustep-1-9,objc-sys/gnustep-1-9
-            args: --features block-sys/gnustep-1-9,objc-sys/gnustep-1-9
+            runtime: gnustep-1-9
           - name: Test iOS simulator x86 64bit
             os: macos-11
             target: x86_64-apple-ios
@@ -134,8 +132,10 @@ jobs:
       CXXFLAGS: ${{ matrix.cflags }}
       ASMFLAGS: ${{ matrix.cflags }}
       LDFLAGS: ${{ matrix.cflags }}
+      HOSTARGS: --no-default-features --features ${{ matrix.runtime || 'apple' }}
+      ARGS: --no-default-features --features ${{ matrix.runtime || 'apple' }} ${{ matrix.args }}
       # Use --no-fail-fast, except with dinghy
-      TESTARGS: ${{ matrix.dinghy && ' ' || '--no-fail-fast' }} ${{ matrix.args }} ${{ matrix.test-args }}
+      TESTARGS: ${{ matrix.dinghy && ' ' || '--no-fail-fast' }} ${{ matrix.test-args }}
 
     runs-on: ${{ matrix.os }}
 
@@ -169,7 +169,7 @@ jobs:
           ~/extern/include
           ~/extern/sdk
         # Change this key if we start caching more things
-        key: ${{ matrix.name }}-extern-v1
+        key: ${{ matrix.name }}-extern-v2
 
     - name: Setup environment
       # These add to PATH-like variables, so they can always be set
@@ -273,49 +273,51 @@ jobs:
 
     - name: Install Cargo Dinghy
       if: matrix.dinghy && steps.extern-cache.outputs.cache-hit != 'true'
-      run: cargo install cargo-dinghy --version=^0.4 --root=$HOME/extern --target=x86_64-apple-darwin
+      # TODO: Replace once cargo dinghy gets updated
+      # cargo install cargo-dinghy --version=^0.4 --root=$HOME/extern --target=x86_64-apple-darwin
+      run: cargo install --git https://github.com/madsmtm/dinghy.git --branch update-cargo --bin cargo-dinghy --root=$HOME/extern --target=x86_64-apple-darwin
 
     - name: Build
       if: ${{ !matrix.dinghy }}
       uses: actions-rs/cargo@v1
       with:
         command: build
-        args: ${{ matrix.args }}
+        args: ${{ env.ARGS }}
 
     - name: Check documentation
       if: ${{ !matrix.dinghy }}
       uses: actions-rs/cargo@v1
       with:
         command: doc
-        args: --no-deps --document-private-items ${{ matrix.args }}
+        args: ${{ env.ARGS }} --no-deps --document-private-items
 
     - name: Test without features
       if: ${{ !matrix.dinghy }}
       uses: actions-rs/cargo@v1
       with:
         command: test
-        args: --no-default-features ${{ env.TESTARGS }}
+        args: ${{ env.ARGS }} ${{ env.TESTARGS }}
 
     - name: Test with features
       if: ${{ !matrix.dinghy }}
       uses: actions-rs/cargo@v1
       with:
         command: test
-        args: --features ${{ env.FEATURES }} ${{ env.TESTARGS }}
+        args: ${{ env.ARGS }} ${{ env.TESTARGS }} --features ${{ env.FEATURES }}
 
-    - name: Test in release mode
+    - name: Test in release mode without features
       if: ${{ !matrix.dinghy }}
       uses: actions-rs/cargo@v1
       with:
         command: test
-        args: --no-default-features ${{ env.TESTARGS }} --release
+        args: ${{ env.ARGS }} ${{ env.TESTARGS }} --release
 
     - name: Test in release mode with features
       if: ${{ !matrix.dinghy }}
       uses: actions-rs/cargo@v1
       with:
         command: test
-        args: --features ${{ env.FEATURES }} ${{ env.TESTARGS }} --release
+        args: ${{ env.ARGS }} ${{ env.TESTARGS }} --features ${{ env.FEATURES }} --release
 
     - name: Run benchmarks
       # Difficult to install Valgrind on macOS
@@ -324,15 +326,15 @@ jobs:
       uses: actions-rs/cargo@v1
       with:
         command: bench
-        args: --bench autorelease ${{ env.TESTARGS }}
+        args: ${{ env.ARGS }} ${{ env.TESTARGS }} --bench autorelease
 
     - name: Test with unstable features
       if: ${{ !matrix.dinghy && matrix.rust.toolchain == 'nightly' }}
       uses: actions-rs/cargo@v1
       with:
         command: test
         # Not using --all-features because that would enable e.g. gnustep
-        args: --features ${{ env.FEATURES }},${{ env.UNSTABLE_FEATURES }} ${{ env.TESTARGS }}
+        args: ${{ env.ARGS }} ${{ env.TESTARGS }} --features ${{ env.FEATURES }},${{ env.UNSTABLE_FEATURES }}
 
     - name: Run assembly tests
       # Not run on GNUStep yet since a lot of function labels are mangled and
@@ -343,28 +345,26 @@ jobs:
       run:
         export HOST_TARGET=$(rustc -vV | grep host | cut -f2 -d' ')
 
-        cargo run ${{ matrix.host-args }} --features assembly --target=$HOST_TARGET test_assembly ${{ matrix.args }}
+        cargo run ${{ env.HOSTARGS }} --features assembly --target=$HOST_TARGET test_assembly ${{ env.ARGS }}
 
-    - name: Run Cargo Dinghy
+    - name: Launch XCode Simulator
       if: matrix.dinghy
       run: |
-        # Launch the simulator
+        # Get system info
         xcrun simctl list runtimes
+
+        # Launch the simulator
         RUNTIME_ID=$(xcrun simctl list runtimes | grep iOS | cut -d ' ' -f 7 | tail -1)
         export SIM_ID=$(xcrun simctl create My-iphone7 com.apple.CoreSimulator.SimDeviceType.iPhone-7 $RUNTIME_ID)
         xcrun simctl boot $SIM_ID
 
-        # Build
-        cargo dinghy --device=$SIM_ID build
-
-        # Run tests
-        cargo dinghy --device=$SIM_ID test --no-default-features
-        cargo dinghy --device=$SIM_ID test --release
+    - name: Build w. Cargo Dinghy
+      if: matrix.dinghy
+      run: cargo dinghy --device=$SIM_ID build ${{ matrix.args }}
 
-        # Enable a few features. We're doing it this way because cargo dingy
-        # doesn't support specifying features from a workspace.
-        sed -i -e '/\[features\]/a\
-        default = ["exception", "verify_message", "catch_all"]
-        ' objc2/Cargo.toml
-        cargo dinghy --device=$SIM_ID test
-        cargo dinghy --device=$SIM_ID test --release
+    - name: Test w. Cargo Dinghy
+      if: matrix.dinghy
+      # Note that we're not testing more complex configurations, since that
+      # takes a very long time to run in CI, and that impedes general
+      # development work.
+      run: cargo dinghy --device=$SIM_ID test ${{ matrix.args }}

block-sys/CHANGELOG.md

@@ -8,8 +8,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### 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`).
+  future compatibility, until we reach 1.0 (so `DEP_BLOCK_CC_ARGS` in build
+  scripts becomes `DEP_BLOCK_0_0_CC_ARGS`).
+* **BREAKING**: Apple's runtime is now always the default.
 
 
 ## 0.0.3 - 2022-01-03

block-sys/Cargo.toml

@@ -23,18 +23,18 @@ links = "block_0_0"
 build = "build.rs"
 
 [features]
+# The default runtime is Apple's. Other platforms will probably error if the
+# correct feature flag is not specified.
+default = ["apple"]
+
 # Link to Apple's libclosure (exists in libSystem)
-#
-# This is the default on Apple platforms
 apple = []
 
 # Link to libBlocksRuntime from compiler-rt
-#
-# This is the default on non-Apple platforms
 compiler-rt = []
 
 # Link to GNUStep's libobjc2 (which contains the block implementation)
-gnustep-1-7 = ["objc-sys/gnustep-1-7"]
+gnustep-1-7 = ["objc-sys", "objc-sys/gnustep-1-7"]
 gnustep-1-8 = ["objc-sys/gnustep-1-8", "gnustep-1-7"]
 gnustep-1-9 = ["objc-sys/gnustep-1-9", "gnustep-1-8"]
 gnustep-2-0 = ["objc-sys/gnustep-2-0", "gnustep-1-9"]
@@ -47,7 +47,8 @@ winobjc = ["objc-sys/winobjc", "gnustep-1-8"]
 objfw = []
 
 [dependencies]
-objc-sys = { path = "../objc-sys", version = "=0.2.0-alpha.1", optional = true }
+objc-sys = { path = "../objc-sys", version = "=0.2.0-alpha.1", default-features = false, optional = true }
 
 [package.metadata.docs.rs]
 default-target = "x86_64-apple-darwin"
+no-default-features = true

block-sys/README.md

@@ -20,18 +20,17 @@ several different helper functions), the most important aspect being that the
 libraries are named differently, so the linking must take that into account.
 
 The user can choose the desired runtime by using the relevant cargo feature
-flags, see the following sections. Note that if the `objc-sys` crate is
-present in the module tree, this should have the same feature flag enabled as
-that.
+flags, see the following sections (might have to disable the default `apple`
+feature first). Note that if the `objc-sys` crate is present in the module
+tree, this should have the same feature flag enabled as that.
 
 
 ### Apple's [`libclosure`](https://github.com/apple-oss-distributions/libclosure)
 
 - Feature flag: `apple`.
 
 This is naturally the most sophisticated runtime, and it has quite a lot more
-features than the specification mandates. This is used by default on Apple
-platforms when no feature flags are specified.
+features than the specification mandates. This is used by default.
 
 The minimum required operating system versions are as follows:
 - macOS: `10.6`
@@ -46,9 +45,6 @@ Though in practice Rust itself requires higher versions than this.
 
 - Feature flag: `compiler-rt`.
 
-This is the default runtime on all non-Apple platforms when no feature flags
-are specified.
-
 This is effectively just a copy of Apple's older (around macOS 10.6) runtime,
 and is now used in [Swift's `libdispatch`] and [Swift's Foundation] as well.
 

block-sys/build.rs

@@ -5,21 +5,23 @@ fn main() {
     // Only rerun if this file changes; the script doesn't depend on our code
     println!("cargo:rerun-if-changed=build.rs");
 
+    let target_os = env::var("CARGO_CFG_TARGET_OS").unwrap();
+
     let mut apple = env::var_os("CARGO_FEATURE_APPLE").is_some();
-    let mut compiler_rt = env::var_os("CARGO_FEATURE_COMPILER_RT").is_some();
-    let gnustep = env::var_os("CARGO_FEATURE_GNUSTEP_1_7").is_some();
+    let compiler_rt = env::var_os("CARGO_FEATURE_COMPILER_RT").is_some();
+    let mut gnustep = env::var_os("CARGO_FEATURE_GNUSTEP_1_7").is_some();
     let objfw = env::var_os("CARGO_FEATURE_OBJFW").is_some();
 
-    if let (false, false, false, false) = (apple, compiler_rt, gnustep, objfw) {
-        let target_os = env::var("CARGO_CFG_TARGET_OS").unwrap();
+    if std::env::var("DOCS_RS").is_ok() {
         if let "macos" | "ios" | "tvos" | "watchos" = &*target_os {
             apple = true;
             // Add cheaty #[cfg(feature = "apple")] directive
             println!("cargo:rustc-cfg=feature=\"apple\"");
         } else {
-            compiler_rt = true;
-            // Add cheaty #[cfg(feature = "compiler-rt")] directive
-            println!("cargo:rustc-cfg=feature=\"compiler-rt\"");
+            // Also winobjc
+            gnustep = true;
+            // Add cheaty #[cfg(feature = "gnustep-1-7")] directive
+            println!("cargo:rustc-cfg=feature=\"gnustep-1-7\"");
         }
     }
 
@@ -61,7 +63,9 @@ fn main() {
             unimplemented!("ObjFW is not yet supported")
         }
         // Checked in if-let above
-        (false, false, false, false) => unreachable!(),
+        (false, false, false, false) => {
+            panic!("Invalid feature combination; at least one runtime must be selected!")
+        }
         (_, _, _, _) => panic!("Invalid feature combination; only one runtime may be selected!"),
     }
 

block2/Cargo.toml

@@ -17,9 +17,22 @@ repository = "https://github.com/madsmtm/objc2"
 documentation = "https://docs.rs/block2/"
 license = "MIT"
 
+[features]
+default = ["apple"]
+
+# Runtime selection. Default is `apple`. See `block-sys` for details.
+apple = ["block-sys/apple"]
+compiler-rt = ["block-sys/compiler-rt"]
+gnustep-1-7 = ["block-sys/gnustep-1-7"]
+gnustep-1-8 = ["gnustep-1-7", "block-sys/gnustep-1-8"]
+gnustep-1-9 = ["gnustep-1-8", "block-sys/gnustep-1-9"]
+gnustep-2-0 = ["gnustep-1-9", "block-sys/gnustep-2-0"]
+gnustep-2-1 = ["gnustep-2-0", "block-sys/gnustep-2-1"]
+winobjc = ["gnustep-1-8", "block-sys/winobjc"]
+
 [dependencies]
-objc2-encode = { path = "../objc2-encode", version = "=2.0.0-beta.2" }
-block-sys = { path = "../block-sys", version = "0.0.3" }
+objc2-encode = { path = "../objc2-encode", version = "=2.0.0-beta.2", default-features = false }
+block-sys = { path = "../block-sys", version = "0.0.3", default-features = false }
 
 [package.metadata.docs.rs]
 default-target = "x86_64-apple-darwin"

objc-sys/CHANGELOG.md

@@ -8,8 +8,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### 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`).
+  future compatibility, until we reach 1.0 (so `DEP_OBJC_CC_ARGS` in build
+  scripts becomes `DEP_OBJC_0_2_CC_ARGS`).
+* **BREAKING**: Apple's runtime is now always the default.
 
 ### Removed
 * **BREAKING**: Removed type aliases `Class`, `Ivar`, `Method` and `Protocol`
@@ -18,6 +19,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * **BREAKING**: Removed `objc_property_t`.
 * **BREAKING**: Removed `objc_hook_getClass` and `objc_hook_lazyClassNamer`
   type aliases (for now).
+* **BREAKING**: Removed `DEP_OBJC_RUNTIME` build script output.
 
 
 ## 0.2.0-alpha.1 - 2022-01-03

objc-sys/Cargo.toml

@@ -22,9 +22,11 @@ readme = "README.md"
 links = "objc_0_2"
 build = "build.rs"
 
-# The default is `apple` on Apple platforms; all other platforms will error
-# if no feature flag is specified.
 [features]
+# The default runtime is Apple's. Other platforms will probably error if the
+# correct feature flag is not specified.
+default = ["apple"]
+
 # Link to Apple's objc4
 apple = []
 
@@ -43,6 +45,7 @@ objfw = []
 
 [package.metadata.docs.rs]
 default-target = "x86_64-apple-darwin"
+no-default-features = true
 
 targets = [
     # MacOS

objc-sys/README.md

@@ -16,7 +16,8 @@ see that for related crates.
 Objective-C has a runtime, different implementations of said runtime exist,
 and they act in slightly different ways. By default, Apple platforms link to
 Apple's runtime, but if you're using another runtime you must tell it to this
-library using feature flags.
+library using feature flags (you might have to disable the default `apple`
+feature first).
 
 One could ask, why even bother supporting other runtimes? To that, there's a
 simple answer: _Robustness_. By testing with these alternative runtimes in CI,
@@ -29,8 +30,7 @@ iOS versions.
 
 - Feature flag: `apple`.
 
-This is used by default on Apple platforms when no other feature flags are
-specified.
+This is used by default.
 
 The supported runtime version (higher versions lets the compiler enable newer
 optimizations, at the cost of not supporting older operating systems) can be