Merge branch 'master' into plb/gstring-concatenation

Author: PierceLBrooks

.github/composite/godot-install/action.yml

@@ -41,17 +41,17 @@ runs:
       env:
         ARTIFACT_NAME: ${{ inputs.artifact-name }}
 #      if: steps.cache-godot.outputs.cache-hit != 'true'
-      # If a specific Godot revision should be used, rather than latest, use this:
-      # curl https://nightly.link/Bromeon/godot4-nightly/actions/runs/4910907653/${{ inputs.artifact-name }}.zip \
       run: |
         if [[ $ARTIFACT_NAME == *"nightly"* ]]; then
           url="https://nightly.link/Bromeon/godot4-nightly/workflows/compile-godot-nightly/master/$ARTIFACT_NAME.zip"
+          # If a specific Godot revision should be used, rather than latest, use this:
+          # url="https://nightly.link/Bromeon/godot4-nightly/actions/runs/<WORKFLOW_RUN_ID>/$ARTIFACT_NAME.zip"
         else
           url="https://nightly.link/Bromeon/godot4-nightly/workflows/compile-godot-stable/master/$ARTIFACT_NAME.zip"
         fi
         
         curl "$url" -Lo artifact.zip --retry 3
-        unzip artifact.zip -d $RUNNER_DIR/godot_bin
+        unzip -q artifact.zip -d $RUNNER_DIR/godot_bin
       shell: bash
 
     - name: "Prepare Godot executable"

.github/workflows/full-ci.yml

@@ -104,7 +104,6 @@ jobs:
 
       # Note: could use `-- --no-deps` to not lint dependencies, however it doesn't really speed up and also skips deps in workspace.
       - name: "Check clippy"
-        # TODO(Rust 1.86): remove -A clippy::precedence; see https://github.com/godot-rust/gdext/pull/1055.
         run: |
           cargo clippy --all-targets $CLIPPY_FEATURES -- \
           -D clippy::suspicious \
@@ -114,8 +113,7 @@ jobs:
           -D clippy::dbg_macro \
           -D clippy::todo \
           -D clippy::unimplemented \
-          -D warnings \
-          -A clippy::precedence
+          -D warnings
 
   unit-test:
     name: unit-test (${{ matrix.name }}${{ matrix.rust-special }})

.github/workflows/minimal-ci.yml

@@ -96,7 +96,6 @@ jobs:
           components: clippy
 
       - name: "Check clippy"
-        # TODO(Rust 1.86): remove -A clippy::precedence; see https://github.com/godot-rust/gdext/pull/1055.
         run: |
           cargo clippy --all-targets $CLIPPY_FEATURES -- \
           -D clippy::suspicious \
@@ -106,8 +105,7 @@ jobs:
           -D clippy::dbg_macro \
           -D clippy::todo \
           -D clippy::unimplemented \
-          -D warnings \
-          -A clippy::precedence
+          -D warnings
           
 
   unit-test:
@@ -169,6 +167,15 @@ jobs:
             godot-binary: godot.linuxbsd.editor.dev.x86_64
             rust-extra-args: --features itest/experimental-threads,itest/codegen-full-experimental,godot/api-custom,godot/serde,itest/register-docs
 
+          - name: linux-release
+            os: ubuntu-22.04
+            artifact-name: linux-release-nightly
+            godot-binary: godot.linuxbsd.template_release.x86_64
+            # Use `codegen-full-experimental` to make sure that all function tables can be loaded in Godot release builds.
+            # If the experimental part causes problems, downgrade to `codegen-full`.
+            rust-extra-args: --release --features itest/codegen-full-experimental
+            rust-cache-key: release
+
           # Linux compat
 
           - name: linux-4.4

.github/workflows/release-version.yml

@@ -133,8 +133,7 @@ jobs:
           -D clippy::dbg_macro \
           -D clippy::todo \
           -D clippy::unimplemented \
-          -D warnings \
-          -A clippy::precedence
+          -D warnings
 
   rustfmt:
     runs-on: ubuntu-latest

Cargo.toml

@@ -15,6 +15,41 @@ members = [
     "itest/hot-reload/rust",
 ]
 
+# All dependencies except own crates of this project should be specified here, independently of whether they're dev, build or
+# regular dependencies. Sort alphabetically within each section; comments about a dependency come on the section header.
+[workspace.dependencies]
+# Related to godot-rust.
+gdextension-api = { version = "0.2.2", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "releases" }
+
+# Main library features.
+glam = { version = "0.30", features = ["debug-glam-assert"] }
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"
+
+# Related to tooling/build setup.
+# * regex: not used for unicode parsing -> features unicode-bool + unicode-gencat are enabled instead of unicode-perl.
+#          'unicode-gencat' needed for \d, see https://docs.rs/regex/latest/regex/#unicode-features.
+bindgen = { version = "0.71", default-features = false, features = ["runtime"] }
+libc = "0.2.172"
+regex = { version = "1.11", default-features = false, features = ["std", "unicode-bool", "unicode-gencat"] }
+which = "7"
+
+# Macros and codegen. Minimal versions compatible with -Zminimal-versions.
+# * proc_macro2: Literal::c_string() added in 1.0.80.
+# * quote: 1.0.37 allows tokenizing CStr.
+# * venial: 0.6.1 contains some bugfixes.
+heck = "0.5"
+litrs = "0.4"
+markdown = "=1.0.0-alpha.23"
+nanoserde = "0.2"
+proc-macro2 = "1.0.80"
+quote = "1.0.37"
+venial = "0.6.1"
+
+# Testing (godot-cell, itest).
+proptest = "1.6.0"
+pin-project-lite = { version = "0.2" }
+
 # Note about Jetbrains IDEs: "IDE Sync" (Refresh Cargo projects) may cause static analysis errors such as
 # "at most one `api-*` feature can be enabled". This is because by default, all Cargo features are enabled,
 # which isn't a setup we support. To address this, individual features can be enabled in the various

check.sh

@@ -146,12 +146,6 @@ function cmd_fmt() {
 }
 
 function cmd_clippy() {
-    # TODO(Rust 1.86): remove `-A clippy::precedence`.
-    # In Rust 1.85, `clippy::precedence` includes bitmasking and shift operations. Rigid adherence to this rule results in more noisy code, with
-    # little benefits (being aware of bit operator precedence is something we can expect + bit manipulations are common in Godot).
-    # This behavior will be reverted in 1.86 and moved into new lint `precedence_bits` included in `restriction` category.
-    # See https://github.com/godot-rust/gdext/pull/1055 and https://github.com/rust-lang/rust-clippy/pull/14115.
-
     run cargo clippy --all-targets "${extraCargoArgs[@]}" -- \
         -D clippy::suspicious \
         -D clippy::style \
@@ -160,13 +154,10 @@ function cmd_clippy() {
         -D clippy::dbg_macro \
         -D clippy::todo \
         -D clippy::unimplemented \
-        -D warnings \
-        -A clippy::precedence
+        -D warnings
 }
 
 function cmd_klippy() {
-    # TODO(Rust 1.86): remove `-A clippy::precedence`.
-
     run cargo clippy --fix --all-targets "${extraCargoArgs[@]}" -- \
         -D clippy::suspicious \
         -D clippy::style \
@@ -175,8 +166,7 @@ function cmd_klippy() {
         -D clippy::dbg_macro \
         -D clippy::todo \
         -D clippy::unimplemented \
-        -D warnings \
-        -A clippy::precedence
+        -D warnings
 }
 
 function cmd_test() {

godot-bindings/Cargo.toml

@@ -37,18 +37,15 @@ api-custom = ["dep:bindgen", "dep:regex", "dep:which"]
 api-custom-extheader = []
 
 [dependencies]
-gdextension-api = { version = "0.2.2", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "releases" }
+gdextension-api = { workspace = true }
 
-# Do not use bindgen 0.69, it contains regression that forces recompilation of code.
-bindgen = { optional = true, version = "0.68", default-features = false, features = ["runtime"] }
-# regex >= 1.5.5 for security: https://blog.rust-lang.org/2022/03/08/cve-2022-24713.html
-# 'unicode-gencat' needed for \d, see: https://docs.rs/regex/1.5.5/regex/#unicode-features
-regex = { optional = true, version = "1.5.5", default-features = false, features = ["std", "unicode-gencat"] }
-which = { optional = true, version = "6" }
+bindgen = { workspace = true, optional = true }
+regex = { workspace = true, optional = true }
+which = { workspace = true, optional = true }
 
 [dev-dependencies]
-# For tests, we need regex unconditionally. Keep this in sync with above dependency.
-regex = { version = "1.5.5", default-features = false, features = ["std", "unicode-gencat"] }
+# For tests, we need regex unconditionally.
+regex = { workspace = true }
 
 # https://docs.rs/about/metadata
 [package.metadata.docs.rs]

godot-bindings/src/header_gen.rs

@@ -11,15 +11,21 @@ use std::path::Path;
 pub(crate) fn generate_rust_binding(in_h_path: &Path, out_rs_path: &Path) {
     let c_header_path = in_h_path.display().to_string();
 
-    // Listening to changes on files that are generated by this build step cause an infinite loop with cargo watch of
-    // build -> detect change -> rebuild -> detect change -> ...
+    // Default behavior of bindgen is to invalidate the built crate whenever any of the included header files changed. This is sensible,
+    // but in our case, listening to changes on files that are generated by this build step cause an infinite loop with cargo watch of:
+    //     build -> detect change -> rebuild -> detect change -> ...
     // println!("cargo:rerun-if-changed={}", c_header_path);
+    //
+    // Without `rerun_on_header_files(false)`, the following command causes repeated recompilation of godot-ffi onward:
+    //     cargo build -p itest --features godot/api-custom
+    //
+    // This is non-trivial to fix and isn't planned at the moment, see https://github.com/godot-rust/gdext/issues/281.
+    // If you have an idea to address this without too invasive changes, please comment on that issue.
+    let cargo_cfg = bindgen::CargoCallbacks::new().rerun_on_header_files(false);
 
     let builder = bindgen::Builder::default()
         .header(c_header_path)
-        // Tell cargo to invalidate the built crate whenever any of the
-        // included header files changed.
-        .parse_callbacks(Box::new(bindgen::CargoCallbacks))
+        .parse_callbacks(Box::new(cargo_cfg))
         .prepend_enum_name(false);
 
     std::fs::create_dir_all(

godot-bindings/src/import.rs

@@ -83,7 +83,6 @@ pub use gdextension_api::version_4_4 as prebuilt;
     feature = "api-custom",
 )))]
 // ]]
-
 // [version-sync] [[
 //  [include] current.minor
 //  [line] pub use gdextension_api::version_$snakeVersion as prebuilt;

godot-cell/Cargo.toml

@@ -14,7 +14,7 @@ homepage = "https://godot-rust.github.io"
 proptest = ["dep:proptest"]
 
 [dependencies]
-proptest = { version = "1.4.0", optional = true }
+proptest = { workspace = true, optional = true }
 
 # https://docs.rs/about/metadata
 [package.metadata.docs.rs]

godot-codegen/Cargo.toml

@@ -23,16 +23,11 @@ experimental-threads = []
 [dependencies]
 godot-bindings = { path = "../godot-bindings", version = "=0.2.4" }
 
-heck = "0.5"
-nanoserde = "0.1.35"
-
-# Minimum versions compatible with -Zminimal-versions
-proc-macro2 = "1.0.80" # Literal::c_string() added in 1.0.80.
-quote = "1.0.29"
-
-# Since we don't use Regex for unicode parsing, the features unicode-bool/unicode-gencat are used instead of unicode-perl.
-# See also https://docs.rs/regex/latest/regex/#unicode-features.
-regex = { version = "1.5.5", default-features = false, features = ["std", "unicode-bool", "unicode-gencat"] }
+heck = { workspace = true }
+nanoserde = { workspace = true }
+proc-macro2 = { workspace = true }
+quote = { workspace = true }
+regex = { workspace = true }
 
 [build-dependencies]
 godot-bindings = { path = "../godot-bindings", version = "=0.2.4" } # emit_godot_version_cfg

godot-codegen/src/context.rs

@@ -25,6 +25,7 @@ pub struct Context<'a> {
     inheritance_tree: InheritanceTree,
     cached_rust_types: HashMap<GodotTy, RustTy>,
     notifications_by_class: HashMap<TyName, Vec<(Ident, i32)>>,
+    classes_with_signals: HashSet<TyName>,
     notification_enum_names_by_class: HashMap<TyName, NotificationEnum>,
     method_table_indices: HashMap<MethodTableKey, usize>,
     method_table_next_index: HashMap<String, usize>,
@@ -66,6 +67,10 @@ impl<'a> Context<'a> {
             // Populate class lookup by name
             engine_classes.insert(class_name.clone(), class);
 
+            if !option_as_slice(&class.signals).is_empty() {
+                ctx.classes_with_signals.insert(class_name.clone());
+            }
+
             // Populate derived-to-base relations
             if let Some(base) = class.inherits.as_ref() {
                 let base_name = TyName::from_godot(base);
@@ -278,6 +283,24 @@ impl<'a> Context<'a> {
         self.cached_rust_types.get(ty)
     }
 
+    /// Walks up in the hierarchy, and returns the first (nearest) base class which declares at least 1 signal.
+    ///
+    /// Always returns a result, as `Object` (the root) itself declares signals.
+    pub fn find_nearest_base_with_signals(&self, class_name: &TyName) -> TyName {
+        let tree = self.inheritance_tree();
+
+        let mut class = class_name.clone();
+        while let Some(base) = tree.direct_base(&class) {
+            if self.classes_with_signals.contains(&base) {
+                return base;
+            } else {
+                class = base;
+            }
+        }
+
+        panic!("Object (root) should always have signals")
+    }
+
     pub fn notification_constants(&'a self, class_name: &TyName) -> Option<&'a Vec<(Ident, i32)>> {
         self.notifications_by_class.get(class_name)
     }

godot-codegen/src/generator/builtins.rs

@@ -253,7 +253,8 @@ fn make_builtin_method_definition(
     let ptrcall_invocation = quote! {
         let method_bind = sys::builtin_method_table().#fptr_access;
 
-        <CallSig as PtrcallSignatureTuple>::out_builtin_ptrcall(
+
+        Signature::<CallParams, CallRet>::out_builtin_ptrcall(
             method_bind,
             #builtin_name_str,
             #method_name_str,
@@ -265,7 +266,7 @@ fn make_builtin_method_definition(
     let varcall_invocation = quote! {
         let method_bind = sys::builtin_method_table().#fptr_access;
 
-        <CallSig as VarcallSignatureTuple>::out_builtin_ptrcall_varargs(
+        Signature::<CallParams, CallRet>::out_builtin_ptrcall_varargs(
             method_bind,
             #builtin_name_str,
             #method_name_str,

godot-codegen/src/generator/classes.rs

@@ -123,7 +123,10 @@ fn make_class(class: &Class, ctx: &mut Context, view: &ApiView) -> GeneratedClas
         builders,
     } = make_class_methods(class, &class.methods, &cfg_attributes, ctx);
 
-    let signal_types = signals::make_class_signals(class, &class.signals, ctx);
+    let signals::SignalCodegen {
+        signal_code,
+        has_own_signals,
+    } = signals::make_class_signals(class, &class.signals, ctx);
 
     let enums = enums::make_enums(&class.enums, &cfg_attributes);
     let constants = constants::make_constants(&class.constants);
@@ -137,14 +140,14 @@ fn make_class(class: &Class, ctx: &mut Context, view: &ApiView) -> GeneratedClas
     // Associated "sidecar" module is made public if there are other symbols related to the class, which are not
     // in top-level godot::classes module (notification enums are not in the sidecar, but in godot::classes::notify).
     // This checks if token streams (i.e. code) is empty.
-    let has_sidecar_module = !enums.is_empty() || !builders.is_empty() || signal_types.is_some();
+    let has_sidecar_module = !enums.is_empty() || !builders.is_empty() || has_own_signals;
 
     let class_doc = docs::make_class_doc(
         class_name,
         base_ident_opt,
         notification_enum.is_some(),
         has_sidecar_module,
-        signal_types.is_some(),
+        has_own_signals,
     );
 
     let module_doc = docs::make_module_doc(class_name);
@@ -262,7 +265,7 @@ fn make_class(class: &Class, ctx: &mut Context, view: &ApiView) -> GeneratedClas
 
         #builders
         #enums
-        #signal_types
+        #signal_code
     };
     // note: TypePtr -> ObjectPtr conversion OK?
 
@@ -512,7 +515,7 @@ fn make_class_method_definition(
     let ptrcall_invocation = quote! {
         let method_bind = sys::#get_method_table().#fptr_access;
 
-        <CallSig as PtrcallSignatureTuple>::out_class_ptrcall(
+        Signature::<CallParams, CallRet>::out_class_ptrcall(
             method_bind,
             #rust_class_name,
             #rust_method_name,
@@ -525,7 +528,7 @@ fn make_class_method_definition(
     let varcall_invocation = quote! {
         let method_bind = sys::#get_method_table().#fptr_access;
 
-        <CallSig as VarcallSignatureTuple>::out_class_varcall(
+        Signature::<CallParams, CallRet>::out_class_varcall(
             method_bind,
             #rust_class_name,
             #rust_method_name,

godot-codegen/src/generator/functions_common.rs

@@ -177,9 +177,9 @@ pub fn make_function_definition(
     let call_sig_decl = {
         let return_ty = &sig.return_value().type_tokens();
 
-        // Build <'a0, 'a1, ...> for lifetimes.
         quote! {
-            type CallSig #callsig_lifetime_args = ( #return_ty, #(#param_types),* );
+            type CallRet = #return_ty;
+            type CallParams #callsig_lifetime_args = (#(#param_types,)*);
         }
     };