Merge pull request #687 from godot-rust/feature/output-dir

Migrate crate-local `/gen` directories to `OUT_DIR`

Author: Bromeon

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

@@ -162,34 +162,6 @@ runs:
         fi
       shell: bash
 
-    # This step no longer fails if there's a diff, as we expect header to be forward-compatible; instead issues a warning
-    # However, still fails if patch cannot be applied (conflict).
-    # Step is only run in latest, not for compat 4.0.1 etc. -> no need to take into account different header versions.
-    - name: "Copy and compare GDExtension header"
-      if: inputs.godot-check-header == 'true'
-      run: |
-        mv godot-ffi/src/gen/gdextension_interface.h godot-ffi/src/gen/gdextension_interface_prebuilt.h
-        mv $RUNNER_DIR/godot_bin/gdextension_interface.h godot-ffi/src/gen/gdextension_interface.h
-        git apply godot-bindings/res/tweak.patch
-        cd godot-ffi/src/gen
-        git diff --no-index --exit-code --quiet gdextension_interface_prebuilt.h gdextension_interface.h || {
-            echo "OUTCOME=header-diff" >> $GITHUB_ENV
-            echo "::warning::gdextension_interface.h is not up-to-date."
-            echo ""
-        
-            echo "### :warning: Outdated GDExtension API header" >> $GITHUB_STEP_SUMMARY
-            echo "gdextension_interface.h contains the following differences:" >> $GITHUB_STEP_SUMMARY
-            echo "\`\`\`diff" >> $GITHUB_STEP_SUMMARY
-            git diff --no-index gdextension_interface_prebuilt.h gdextension_interface.h >> $GITHUB_STEP_SUMMARY || true
-            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
-            echo "After manually updating file, run:   \`git diff -R > tweak2.patch && mv tweak2.patch tweak.patch\`." >> $GITHUB_STEP_SUMMARY
-
-            # Undo modifications
-            mv gdextension_interface_prebuilt.h gdextension_interface.h
-        	#exit 1
-        }
-      shell: bash
-
     - name: "Run Godot integration tests"
       # Aborts immediately if Godot outputs certain keywords (would otherwise stall until CI runner times out).
       # Explanation:

Cargo.toml

@@ -19,4 +19,4 @@ members = [
 ]
 
 #[patch."https://github.com/godot-rust/godot4-prebuilt"]
-#godot4-prebuilt = { git = "https://github.com//godot-rust/godot4-prebuilt", branch = "4.1"}
+#godot4-prebuilt = { git = "https://github.com//godot-rust/godot4-prebuilt", branch = "4.1" }

godot-bindings/res/tweak.patch

@@ -20,10 +20,10 @@ use std::process::{Command, Output};
 // Note: CARGO_BUILD_TARGET_DIR and CARGO_TARGET_DIR are not set.
 // OUT_DIR would be standing to reason, but it's an unspecified path that cannot be referenced by CI.
 // const GODOT_VERSION_PATH: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/src/gen/godot_version.txt");
-const JSON_PATH: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/src/gen/extension_api.json");
 
 pub fn load_gdextension_json(watch: &mut StopWatch) -> String {
-    let json_path = Path::new(JSON_PATH);
+    let path = format!("{}/extension_api.json", std::env::var("OUT_DIR").unwrap());
+    let json_path = Path::new(&path);
 
     // 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 -> ...

godot-bindings/src/godot_exe.rs

@@ -170,7 +170,7 @@ pub fn emit_godot_version_cfg() {
 
 // Function for safely removal of build directory. Workaround for errors happening during CI builds:
 // https://github.com/godot-rust/gdext/issues/616
-pub fn remove_dir_all_reliable(path: &std::path::Path) {
+pub fn remove_dir_all_reliable(path: &Path) {
     let mut retry_count = 0;
 
     while path.exists() {
@@ -189,3 +189,18 @@ pub fn remove_dir_all_reliable(path: &std::path::Path) {
         }
     }
 }
+//
+// pub fn write_module_file(path: &Path) {
+//     let code = quote! {
+//         pub mod table_builtins;
+//         pub mod table_builtins_lifecycle;
+//         pub mod table_servers_classes;
+//         pub mod table_scene_classes;
+//         pub mod table_editor_classes;
+//         pub mod table_utilities;
+//
+//         pub mod central;
+//         pub mod gdextension_interface;
+//         pub mod interface;
+//     };
+// }

godot-bindings/src/lib.rs

@@ -22,12 +22,8 @@ pub fn generate_sys_interface_file(
     let code = if is_godot_4_0 {
         // Compat for 4.0.x
         // Most polyfills are in godot_exe.rs, fn polyfill_legacy_header()
-        quote! {
-            #[path = "../compat/compat_4_0.rs"]
-            mod compat_4_0;
-
-            pub use compat_4_0::*;
-        }
+        // Module `compat_4_0` is directly imported in Rust code, behind #[cfg].
+        TokenStream::new()
     } else {
         generate_proc_address_funcs(h_path)
     };
@@ -80,10 +76,8 @@ fn generate_proc_address_funcs(h_path: &Path) -> TokenStream {
 
     // Do not derive Copy -- even though the struct is bitwise-copyable, this is rarely needed and may point to an error.
     let code = quote! {
-        #[path = "../compat/compat_4_1plus.rs"]
-        mod compat_4_1plus;
-
-        pub use compat_4_1plus::InitCompat;
+        pub use crate::compat::InitCompat;
+        // pub use crate::compat::compat_4_1plus::InitCompat;
 
         pub struct GDExtensionInterface {
             #( #fptr_decls )*
@@ -101,6 +95,7 @@ fn generate_proc_address_funcs(h_path: &Path) -> TokenStream {
             }
         }
     };
+
     code
 }
 

godot-codegen/src/generator/extension_interface.rs

@@ -36,6 +36,23 @@ pub mod virtual_traits;
 // - utility_functions
 // - native_structures
 
+pub fn generate_sys_module_file(sys_gen_path: &Path, submit_fn: &mut SubmitFn) {
+    let code = quote! {
+        pub mod table_builtins;
+        pub mod table_builtins_lifecycle;
+        pub mod table_servers_classes;
+        pub mod table_scene_classes;
+        pub mod table_editor_classes;
+        pub mod table_utilities;
+
+        pub mod central;
+        pub mod gdextension_interface;
+        pub mod interface;
+    };
+
+    submit_fn(sys_gen_path.join("mod.rs"), code);
+}
+
 pub fn generate_sys_central_file(
     api: &ExtensionApi,
     ctx: &mut Context,

godot-codegen/src/generator/mod.rs

@@ -27,7 +27,7 @@ use crate::generator::utility_functions::generate_utilities_file;
 use crate::generator::{
     generate_core_central_file, generate_core_mod_file, generate_sys_builtin_lifecycle_file,
     generate_sys_builtin_methods_file, generate_sys_central_file, generate_sys_classes_file,
-    generate_sys_utilities_file,
+    generate_sys_module_file, generate_sys_utilities_file,
 };
 use crate::models::domain::{ApiView, ExtensionApi};
 use crate::models::json::{load_extension_api, JsonExtensionApi};
@@ -90,6 +90,9 @@ pub fn generate_sys_files(
     let is_godot_4_0 = api.godot_version.major == 4 && api.godot_version.minor == 0;
     generate_sys_interface_file(h_path, sys_gen_path, is_godot_4_0, &mut submit_fn);
     watch.record("generate_interface_file");
+
+    generate_sys_module_file(sys_gen_path, &mut submit_fn);
+    watch.record("generate_module_file");
 }
 
 pub fn generate_core_files(core_gen_path: &Path) {

godot-codegen/src/lib.rs

@@ -8,9 +8,8 @@
 use std::path::Path;
 
 fn main() {
-    // It would be better to generate this in /.generated or /target/godot-gen, however IDEs currently
-    // struggle with static analysis when symbols are outside the crate directory (April 2023).
-    let gen_path = Path::new(concat!(env!("CARGO_MANIFEST_DIR"), "/src/gen"));
+    let out_dir = std::env::var("OUT_DIR").unwrap();
+    let gen_path = Path::new(&out_dir);
 
     godot_bindings::remove_dir_all_reliable(gen_path);
 

godot-core/build.rs

@@ -48,9 +48,9 @@ pub mod engine;
 #[allow(clippy::wrong_self_convention)] // to_string() is const
 #[allow(clippy::upper_case_acronyms)] // TODO remove this line once we transform names
 #[allow(unreachable_code, clippy::unimplemented)] // TODO remove once #153 is implemented
-mod gen;
-
-
+mod gen {
+    include!(concat!(env!("OUT_DIR"), "/mod.rs"));
+}
 
 macro_rules! generate_gdextension_api_version {
     (