Merge branch 'master' of https://github.com/godot-rust/gdextension into feature/godot-compat

Author: lilizoey

.github/workflows/full-ci.yml

@@ -15,6 +15,7 @@ on:
 
 env:
   GDEXT_FEATURES: ''
+#  GDEXT_FEATURES: '--features godot/serde'
   RETRY: ${{ github.workspace }}/.github/other/retry.sh
 
   # LSan options: https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer
@@ -217,7 +218,7 @@ jobs:
             os: ubuntu-20.04
             artifact-name: linux-nightly
             godot-binary: godot.linuxbsd.editor.dev.x86_64
-            rust-extra-args: --features godot/custom-godot,godot/threads,godot/serde
+            rust-extra-args: --features godot/custom-godot,godot/experimental-threads,godot/serde
 
           # Linux compat
 

.github/workflows/minimal-ci.yml

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

godot-bindings/Cargo.toml

@@ -25,3 +25,7 @@ godot4-prebuilt = { optional = true, git = "https://github.com/godot-rust/godot4
 bindgen = { optional = true, version = "0.65", default-features = false, features = ["runtime"] }
 regex = { optional = true, version = "1.5.5", default-features = false, features = ["std", "unicode-gencat"] }
 which = { optional = true, version = "4" }
+
+[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"] }

godot-bindings/src/godot_version.rs

@@ -16,7 +16,7 @@ pub fn parse_godot_version(version_str: &str) -> Result<GodotVersion, Box<dyn Er
     // https://github.com/godot-rust/gdext/issues/118#issuecomment-1465748123
     // We assume that it's on a line of its own, but it may be surrounded by other lines.
     let regex = Regex::new(
-        r#"(?xm)
+        r"(?xm)
         # x: ignore whitespace and allow line comments (starting with `#`)
         # m: multi-line mode, ^ and $ match start and end of line
         ^
@@ -32,15 +32,17 @@ pub fn parse_godot_version(version_str: &str) -> Result<GodotVersion, Box<dyn Er
         (\.[^.]+)+?
         # Git commit SHA1, currently truncated to 9 chars, but accept the full thing
         (?:\.(?P<custom_rev>[a-f0-9]{9,40}))?
+        # Optional newline printed in some systems (e.g. Arch Linux, see #416)
+        (?:\\n)?
         $
-    "#,
+        ",
     )?;
 
     let fail = || format!("Version substring cannot be parsed: `{version_str}`");
     let caps = regex.captures(version_str).ok_or_else(fail)?;
 
     Ok(GodotVersion {
-        full_string: caps.get(0).unwrap().as_str().to_string(),
+        full_string: caps.get(0).unwrap().as_str().trim().to_string(),
         major: cap(&caps, "major")?.unwrap(),
         minor: cap(&caps, "minor")?.unwrap(),
         patch: cap(&caps, "patch")?.unwrap_or(0),
@@ -86,6 +88,7 @@ fn test_godot_versions() {
         ("4.0.beta8.mono.custom_build.b28ddd918", 4, 0, 0, "beta8", s("b28ddd918")),
         ("4.0.rc1.official.8843d9ad3", 4, 0, 0, "rc1", s("8843d9ad3")),
         ("4.0.stable.arch_linux", 4, 0, 0, "stable", None),
+        ("4.1.1.stable.arch_linux\n", 4, 1, 1, "stable", None),
         // Output from 4.0.stable on MacOS in debug mode:
         // https://github.com/godotengine/godot/issues/74906
         ("arguments
@@ -104,7 +107,7 @@ Current path: /Users/runner/work/gdext/gdext/godot-core
     for (full, major, minor, patch, status, custom_rev) in good_versions {
         let expected = GodotVersion {
             // Version line is last in every test at the moment.
-            full_string: full.lines().last().unwrap().to_owned(),
+            full_string: full.lines().last().unwrap().trim().to_owned(),
             major,
             minor,
             patch,

godot-bindings/src/lib.rs

@@ -40,6 +40,10 @@ pub struct GodotVersion {
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Regenerate all files
 
+// This file is explicitly included in unit tests. Needs regex dependency.
+#[cfg(test)]
+mod godot_version;
+
 #[cfg(feature = "custom-godot")]
 #[path = ""]
 mod custom {

godot-codegen/Cargo.toml

@@ -13,6 +13,7 @@ codegen-fmt = []
 codegen-full = []
 double-precision = []
 custom-godot = ["godot-bindings/custom-godot"]
+experimental-godot-api = []
 
 [dependencies]
 godot-bindings = { path = "../godot-bindings" }

godot-codegen/src/class_generator.rs

@@ -506,6 +506,7 @@ fn make_class(class: &Class, class_name: &TyName, ctx: &mut Context) -> Generate
 
     let constructor = make_constructor(class, ctx);
     let api_level = util::get_api_level(class);
+    let init_level = api_level.to_init_level();
 
     let FnDefinitions {
         functions: methods,
@@ -618,6 +619,7 @@ fn make_class(class: &Class, class_name: &TyName, ctx: &mut Context) -> Generate
                 type Base = #base_ty;
                 type Declarer = crate::obj::dom::EngineDomain;
                 type Mem = crate::obj::mem::#memory;
+                const INIT_LEVEL: Option<crate::init::InitLevel> = #init_level;
 
                 fn class_name() -> ClassName {
                     ClassName::from_ascii_cstr(#class_name_cstr)

godot-codegen/src/codegen_special_cases.rs

@@ -127,6 +127,7 @@ const SELECTED_CLASSES: &[&str] = &[
     "CollisionObject2D",
     "CollisionShape2D",
     "Control",
+    "EditorPlugin",
     "Engine",
     "FileAccess",
     "HTTPRequest",

godot-codegen/src/special_cases.rs

@@ -44,14 +44,12 @@ pub(crate) fn is_deleted(class_name: &TyName, method: &ClassMethod, ctx: &mut Co
 
 #[rustfmt::skip]
 pub(crate) fn is_class_deleted(class_name: &TyName) -> bool {
-    let class_name = class_name.godot_ty.as_str();
-
-    // TODO feature-gate experimental classes.
-    /*
+    // Exclude experimental APIs unless opted-in.
     if !cfg!(feature = "experimental-godot-api") && is_class_experimental(class_name) {
         return true;
     }
-    */
+
+    let class_name = class_name.godot_ty.as_str();
 
     // OpenXR has not been available for macOS before 4.2.
     // See e.g. https://github.com/GodotVR/godot-xr-tools/issues/479.
@@ -71,9 +69,15 @@ pub(crate) fn is_class_deleted(class_name: &TyName) -> bool {
 
     match class_name {
         // Hardcoded cases that are not accessible.
-        | "JavaClassWrapper" // only on Android.
-        | "JavaScriptBridge" // only on WASM.
-        | "ThemeDB" // lazily loaded; TODO enable this.
+        // Only on Android.
+        | "JavaClassWrapper"
+        | "JNISingleton"
+        | "JavaClass"
+        // Only on WASM.
+        | "JavaScriptBridge"
+        | "JavaScriptObject"
+        // lazily loaded; TODO enable this.
+        | "ThemeDB" 
 
         // Thread APIs.
         | "Thread"
@@ -99,7 +103,6 @@ pub(crate) fn is_class_deleted(class_name: &TyName) -> bool {
 }
 
 #[rustfmt::skip]
-#[allow(dead_code)] // remove once used.
 fn is_class_experimental(class_name: &TyName) -> bool {
     // These classes are currently hardcoded, but the information is available in Godot's doc/classes directory.
     // The XML file contains a property <class name="NavigationMesh" ... is_experimental="true">.
@@ -124,7 +127,6 @@ fn is_class_experimental(class_name: &TyName) -> bool {
         | "NavigationRegion3D"
         | "NavigationServer2D"
         | "NavigationServer3D"
-        | "ProjectSettings"
         | "SkeletonModification2D"
         | "SkeletonModification2DCCDIK"
         | "SkeletonModification2DFABRIK"

godot-codegen/src/util.rs

@@ -66,6 +66,15 @@ impl ClassCodegenLevel {
             Self::Lazy => unreachable!("lazy classes should be deleted at the moment"),
         }
     }
+
+    pub fn to_init_level(self) -> TokenStream {
+        match self {
+            Self::Servers => quote! { Some(crate::init::InitLevel::Servers) },
+            Self::Scene => quote! { Some(crate::init::InitLevel::Scene) },
+            Self::Editor => quote! { Some(crate::init::InitLevel::Editor) },
+            Self::Lazy => quote! { None },
+        }
+    }
 }
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
@@ -172,13 +181,20 @@ pub(crate) fn make_utility_function_ptr_name(function: &UtilityFunction) -> Iden
     safe_ident(&function.name)
 }
 
-// TODO should eventually be removed, as all StringNames are cached
+#[cfg(since_api = "4.2")]
 pub fn make_string_name(identifier: &str) -> TokenStream {
+    let lit = proc_macro2::Literal::byte_string(format!("{identifier}\0").as_bytes());
     quote! {
-        StringName::from(#identifier)
+        StringName::from_latin1_with_nul(#lit)
     }
 }
 
+#[cfg(before_api = "4.2")]
+pub fn make_string_name(identifier: &str) -> TokenStream {
+    quote! {
+        StringName::from(#identifier)
+    }
+}
 pub fn make_sname_ptr(identifier: &str) -> TokenStream {
     quote! {
         string_names.fetch(#identifier)

godot-core/Cargo.toml

@@ -14,7 +14,8 @@ codegen-fmt = ["godot-ffi/codegen-fmt", "godot-codegen/codegen-fmt"]
 codegen-full = ["godot-codegen/codegen-full"]
 double-precision = ["godot-codegen/double-precision"]
 custom-godot = ["godot-ffi/custom-godot", "godot-codegen/custom-godot"]
-threads = []
+experimental-godot-api = ["godot-codegen/experimental-godot-api"]
+experimental-threads = []
 
 [dependencies]
 godot-ffi = { path = "../godot-ffi" }

godot-core/src/builtin/array.rs

@@ -179,6 +179,8 @@ impl<T: GodotType> Array<T> {
             interface_fn!(array_operator_index_const)(self.sys(), index)
         };
 
+        // Signature is wrong in GDExtension, semantically this is a const ptr
+        let variant_ptr = sys::to_const_ptr(variant_ptr);
         Variant::ptr_from_sys(variant_ptr)
     }