Merge pull request #1556 from godot-rust/qol/non-null-error

Follow up Godot 4.7 nullability changes

Author: Bromeon

godot-core/src/obj/raw_gd.rs

@@ -126,7 +126,15 @@ impl<T: GodotClass> RawGd<T> {
         U: GodotClass,
     {
         self.is_null() // Null can be cast to anything.
-            || self.as_object_ref().is_class(&U::class_id().to_gstring())
+            || {
+                // is_class() parameter changed from GString to StringName in Godot 4.7.
+                #[cfg(since_api = "4.7")]
+                let class_name = U::class_id().to_string_name();
+                #[cfg(before_api = "4.7")]
+                let class_name = U::class_id().to_gstring();
+
+                self.as_object_ref().is_class(&class_name)
+            }
     }
 
     /// Returns `Ok(cast_obj)` on success, `Err(self)` on error

godot-core/src/tools/autoload.rs

@@ -106,9 +106,13 @@ where
 
     let autoload_path = NodePath::from(&format!("/root/{autoload_name}"));
 
+    // get_root() return type changed from Option<Gd<Window>> to Gd<Window> in Godot 4.7.
+    #[cfg(before_api = "4.7")]
     let root = scene_tree
         .get_root()
         .ok_or_else(|| ConvertError::new("scene tree root not available"))?;
+    #[cfg(since_api = "4.7")]
+    let root = scene_tree.get_root();
 
     let autoload_node = root
         .try_get_node_as::<Node>(&autoload_path)

itest/rust/src/engine_tests/native_st_niche_audio_test.rs

@@ -116,6 +116,9 @@ fn native_audio_structure_out_parameter() {
         .unwrap()
         .cast::<SceneTree>();
 
+    #[cfg(since_api = "4.7")]
+    tree.get_root().add_child(&player);
+    #[cfg(before_api = "4.7")]
     tree.get_root().unwrap().add_child(&player);
     player.set_stream(&generator);
 

itest/rust/src/object_tests/object_arg_test.rs

@@ -6,7 +6,7 @@
  */
 
 use godot::builtin::{Variant, vslice};
-use godot::classes::{ClassDb, Node, RefCounted, ResourceFormatLoader, ResourceLoader};
+use godot::classes::{ClassDb, Node, RefCounted, ResourceFormatLoader, ResourceLoader, Script};
 use godot::global;
 use godot::meta::ToGodot;
 use godot::obj::{Gd, NewAlloc, NewGd, Singleton};
@@ -65,12 +65,13 @@ fn object_arg_option_owned() {
 
 #[itest]
 fn object_arg_option_borrowed() {
-    with_objects(|manual, refc| {
-        let db = ClassDb::singleton();
-        let a = db.class_set_property(Some(&manual), "name", &Variant::from("hello"));
-        let b = db.class_set_property(Some(&refc), "value", &Variant::from(-123));
-        (a, b)
-    });
+    let mut node = Node::new_alloc();
+    let script = create_gdscript("extends Node");
+
+    node.set_script(Some(&script));
+    assert!(node.get_script().is_some());
+
+    node.free();
 }
 
 /*
@@ -88,42 +89,43 @@ fn object_arg_option_borrowed_outer() {
 #[itest]
 fn object_arg_option_borrowed_mut() {
     // If you have an Option<&mut Gd<T>>, you can use as_deref() to get Option<&Gd<T>>.
+    let mut node = Node::new_alloc();
+    let mut script = create_gdscript("extends Node").upcast();
+    let script_opt: Option<&mut Gd<Script>> = Some(&mut script);
 
-    with_objects(|mut manual, mut refc| {
-        let db = ClassDb::singleton();
-
-        let manual_opt: Option<&mut Gd<Node>> = Some(&mut manual);
-        let refc_opt: Option<&mut Gd<RefcPayload>> = Some(&mut refc);
+    node.set_script(script_opt.as_deref());
+    assert!(node.get_script().is_some());
 
-        let a = db.class_set_property(manual_opt.as_deref(), "name", &Variant::from("hello"));
-        let b = db.class_set_property(refc_opt.as_deref(), "value", &Variant::from(-123));
-        (a, b)
-    });
+    node.free();
 }
 
 #[itest]
 fn object_arg_option_none() {
-    let manual: Option<Gd<Node>> = None;
-    let refc: Option<Gd<RefcPayload>> = None;
+    let script = Some(create_gdscript("extends Node"));
+    let no_script = None::<Gd<Script>>;
+
+    // Pass Some first, to change internal state.
+    let mut node = Node::new_alloc();
+    node.set_script(script.as_ref());
+    assert_eq!(node.get_script(), script.map(|s| s.upcast()));
 
-    // Will emit errors but should not crash.
-    let db = ClassDb::singleton();
-    let error = db.class_set_property(manual.as_ref(), "name", &Variant::from("hello"));
-    assert_eq!(error, global::Error::ERR_UNAVAILABLE);
+    // Verify None option can be passed to an engine API accepting Option<Gd<T>>.
+    node.set_script(no_script.as_ref());
+    assert_eq!(node.get_script(), None);
 
-    let error = db.class_set_property(refc.as_ref(), "value", &Variant::from(-123));
-    assert_eq!(error, global::Error::ERR_UNAVAILABLE);
+    node.free();
 }
 
 #[itest]
 fn object_arg_null_arg() {
-    // Will emit errors but should not crash.
-    let db = ClassDb::singleton();
-    let error = db.class_set_property(Gd::null_arg(), "name", &Variant::from("hello"));
-    assert_eq!(error, global::Error::ERR_UNAVAILABLE);
-
-    let error = db.class_set_property(Gd::null_arg(), "value", &Variant::from(-123));
-    assert_eq!(error, global::Error::ERR_UNAVAILABLE);
+    // Verify null_arg() can be passed to an engine API accepting Option<Gd<T>>.
+    let mut node = Node::new_alloc();
+    node.set_script(&create_gdscript("extends Node"));
+    assert!(node.get_script().is_some());
+
+    node.set_script(Gd::<Script>::null_arg());
+    assert_eq!(node.get_script(), None);
+    node.free();
 }
 
 // Regression test for https://github.com/godot-rust/gdext/issues/835.

itest/rust/src/register_tests/rpc_test.rs

@@ -97,6 +97,9 @@ fn node_enters_tree() {
         .cast::<SceneTree>();
     scene_tree.set_multiplayer(MultiplayerApi::create_default_interface().as_ref());
 
+    #[cfg(since_api = "4.7")]
+    let mut root = scene_tree.get_root();
+    #[cfg(before_api = "4.7")]
     let mut root = scene_tree.get_root().unwrap();
     root.add_child(&node);
     root.remove_child(&node);