Merge pull request #730 from lilizoey/fix/rustc-check-cfg

Emit `rustc-check-cfg`

Author: Bromeon

.github/workflows/full-ci.yml

@@ -311,7 +311,7 @@ jobs:
             os: ubuntu-20.04
             artifact-name: linux-nightly
             godot-binary: godot.linuxbsd.editor.dev.x86_64
-            rust-extra-args: --features godot/api-custom,godot/experimental-threads,godot/serde,codegen-full-experimental
+            rust-extra-args: --features itest/experimental-threads,itest/codegen-full-experimental,godot/api-custom,godot/serde
 
           - name: linux-release
             os: ubuntu-20.04

.github/workflows/minimal-ci.yml

@@ -154,7 +154,7 @@ jobs:
             os: ubuntu-20.04
             artifact-name: linux-nightly
             godot-binary: godot.linuxbsd.editor.dev.x86_64
-            rust-extra-args: --features godot/api-custom,godot/experimental-threads,godot/serde,codegen-full-experimental
+            rust-extra-args: --features itest/experimental-threads,itest/codegen-full-experimental,godot/api-custom,godot/serde
 
           # Linux compat
 

godot-bindings/Cargo.toml

@@ -39,3 +39,6 @@ regex = { version = "1.5.5", default-features = false, features = ["std", "unico
 [package.metadata.docs.rs]
 features = ["experimental-godot-api"]
 rustdoc-args = ["--cfg", "published_docs"]
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(published_docs)'] }

godot-bindings/src/lib.rs

@@ -130,7 +130,13 @@ pub use prebuilt::*;
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Common
 
-const NEXT_MINOR_VERSION: u8 = 3;
+// List of minor versions with the highest known patch number for each.
+//
+// We could have this just be a list of patch numbers, letting the index be the minor version. However it's more readable to include the
+// minor versions as well.
+//
+// Note that when the patch version is `0`, then the patch number is not included in Godot versioning, i.e. `4.1.0` is displayed as `4.1`.
+const HIGHEST_PATCH_VERSIONS: &[(u8, u8)] = &[(0, 4), (1, 4), (2, 2), (3, 0)];
 
 pub fn clear_dir(dir: &Path, watch: &mut StopWatch) {
     if dir.exists() {
@@ -148,8 +154,10 @@ pub fn emit_godot_version_cfg() {
         ..
     } = get_godot_version();
 
+    // This could also be done as `KNOWN_API_VERSIONS.len() - 1`, but this is more explicit.
+    let max = HIGHEST_PATCH_VERSIONS.last().unwrap().0;
+
     // Start at 1; checking for "since/before 4.0" makes no sense
-    let max = NEXT_MINOR_VERSION;
     for m in 1..=minor {
         println!(r#"cargo:rustc-cfg=since_api="{major}.{m}""#);
     }
@@ -166,6 +174,28 @@ pub fn emit_godot_version_cfg() {
     } else {
         println!(r#"cargo:rustc-cfg=gdextension_exact_api="{major}.{minor}""#);
     }
+
+    // Emit `rustc-check-cfg` so cargo doesn't complain when we use the cfgs.
+    for (minor, highest_patch) in HIGHEST_PATCH_VERSIONS {
+        if *minor > 0 {
+            println!(r#"cargo::rustc-check-cfg=cfg(since_api, values("4.{minor}"))"#);
+            println!(r#"cargo::rustc-check-cfg=cfg(before_api, values("4.{minor}"))"#);
+        }
+
+        println!(r#"cargo::rustc-check-cfg=cfg(gdextension_minor_api, values("4.{minor}"))"#);
+
+        for patch in 0..=*highest_patch {
+            if patch == 0 {
+                println!(
+                    r#"cargo::rustc-check-cfg=cfg(gdextension_exact_api, values("4.{minor}"))"#
+                );
+            } else {
+                println!(
+                    r#"cargo::rustc-check-cfg=cfg(gdextension_exact_api, values("4.{minor}.{patch}"))"#
+                );
+            }
+        }
+    }
 }
 
 // Function for safely removal of build directory. Workaround for errors happening during CI builds:
@@ -189,6 +219,29 @@ pub fn remove_dir_all_reliable(path: &Path) {
         }
     }
 }
+
+// Duplicates code from `make_gdext_build_struct` in `godot-codegen/generator/gdext_build_struct.rs`.
+pub fn before_api(major_minor: &str) -> bool {
+    let mut parts = major_minor.split('.');
+    let queried_major = parts
+        .next()
+        .unwrap()
+        .parse::<u8>()
+        .expect("invalid major version");
+    let queried_minor = parts
+        .next()
+        .unwrap()
+        .parse::<u8>()
+        .expect("invalid minor version");
+    assert_eq!(queried_major, 4, "major version must be 4");
+    let godot_version = get_godot_version();
+    godot_version.minor < queried_minor
+}
+
+pub fn since_api(major_minor: &str) -> bool {
+    !before_api(major_minor)
+}
+
 //
 // pub fn write_module_file(path: &Path) {
 //     let code = quote! {

godot-cell/Cargo.toml

@@ -17,3 +17,6 @@ proptest = { version = "1.4.0", optional = true }
 [package.metadata.docs.rs]
 features = ["experimental-godot-api"]
 rustdoc-args = ["--cfg", "published_docs"]
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(published_docs)'] }

godot-codegen/Cargo.toml

@@ -38,6 +38,8 @@ godot-bindings = { path = "../godot-bindings" } # emit_godot_version_cfg
 features = ["experimental-godot-api"]
 rustdoc-args = ["--cfg", "published_docs"]
 
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(published_docs)'] }
 
 # To check formatter: Disabled below, since it pulls in too many dependencies during `cargo test` but is not really used.
 # Dev-dependencies cannot be optional and feature-gated. Enable manually when needed.
@@ -48,3 +50,4 @@ rustdoc-args = ["--cfg", "published_docs"]
 #
 #[dev-dependencies]
 #criterion = "0.5"
+

godot-codegen/src/generator/gdext_build_struct.rs

@@ -53,6 +53,8 @@ pub fn make_gdext_build_struct(header: &GodotApiVersion) -> TokenStream {
                 (version.major as u8, version.minor as u8, version.patch as u8)
             }
 
+            // Duplicates code from `before_api` in `godot-bindings/lib.rs`.
+
             /// For a string `"4.x"`, returns `true` if the current Godot version is strictly less than 4.x.
             ///
             /// Runtime equivalent of `#[cfg(before_api = "4.x")]`.

godot-core/Cargo.toml

@@ -45,3 +45,6 @@ godot-codegen = { path = "../godot-codegen" }
 [package.metadata.docs.rs]
 features = ["experimental-godot-api"]
 rustdoc-args = ["--cfg", "published_docs"]
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(published_docs)'] }

godot-ffi/Cargo.toml

@@ -37,3 +37,6 @@ godot-codegen = { path = "../godot-codegen" }
 [package.metadata.docs.rs]
 features = ["experimental-godot-api"]
 rustdoc-args = ["--cfg", "published_docs"]
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(published_docs)'] }

godot-macros/Cargo.toml

@@ -31,3 +31,6 @@ godot-bindings = { path = "../godot-bindings" } # emit_godot_version_cfg
 [package.metadata.docs.rs]
 features = ["experimental-godot-api"]
 rustdoc-args = ["--cfg", "published_docs"]
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(published_docs)'] }

godot/Cargo.toml

@@ -34,3 +34,6 @@ godot-macros = { path = "../godot-macros" }
 [package.metadata.docs.rs]
 features = ["experimental-godot-api"]
 rustdoc-args = ["--cfg", "published_docs"]
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(published_docs)'] }

itest/rust/Cargo.toml

@@ -12,6 +12,7 @@ crate-type = ["cdylib"]
 [features]
 default = []
 codegen-full-experimental = ["godot/codegen-full", "godot/experimental-godot-api"]
+experimental-threads = ["godot/experimental-threads"]
 serde = ["dep:serde", "dep:serde_json", "godot/serde"]
 
 # Do not add features here that are 1:1 forwarded to the `godot` crate, unless they are needed by itest itself.

itest/rust/build.rs

@@ -148,8 +148,11 @@ fn collect_inputs() -> Vec<Input> {
     push!(inputs; PackedStringArray, PackedStringArray, PackedStringArray(), PackedStringArray::new());
     push!(inputs; PackedVector2Array, PackedVector2Array, PackedVector2Array(), PackedVector2Array::new());
     push!(inputs; PackedVector3Array, PackedVector3Array, PackedVector3Array(), PackedVector3Array::new());
-    #[cfg(since_api = "4.3")]
-    push!(inputs; PackedVector4Array, PackedVector4Array, PackedVector4Array(), PackedVector4Array::new());
+    // This is being run in a build script at the same time as other build-scripts, so the `rustc-cfg` directives haven't been run for this
+    // build-script. This means that `#[cfg(since_api = "4.3")]` wouldn't do anything.
+    if godot_bindings::since_api("4.3") {
+        push!(inputs; PackedVector4Array, PackedVector4Array, PackedVector4Array(), PackedVector4Array::new());
+    }
     push!(inputs; PackedColorArray, PackedColorArray, PackedColorArray(), PackedColorArray::new());
 
     push_newtype!(inputs; int, NewI64(i64), -922337203685477580);