Upgrade gdext (#24)

Author: TitanNano

Cargo.lock

@@ -10,7 +10,7 @@ version = "0.1.0"
 edition = "2021"
 
 [workspace.dependencies]
-godot = { git = "https://github.com/titannano/gdext", rev = "4ce4714" }
+godot = { git = "https://github.com/titannano/gdext", rev = "e3644a0348b4d6fe952007cebd94d1d3f5ddfd86" }
 itertools = "0.10.3"
 abi_stable = { version = "0.11.2", default-features = false }
 rand = "0.8.5"

Cargo.toml

@@ -0,0 +1,38 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+use std::ops::Deref;
+
+use godot::{
+    builtin::meta::ToGodot,
+    obj::{Gd, GodotClass, Inherits, WithBaseField},
+};
+
+pub trait DowngradeSelf: GodotClass {
+    fn downgrade<F: FnOnce(&Self) -> R, R>(&mut self, closure: F) -> R;
+    fn downgrade_gd<F: FnOnce(Gd<Self>) -> R, R>(&mut self, closure: F) -> R;
+}
+
+impl<T> DowngradeSelf for T
+where
+    T: WithBaseField + GodotClass,
+    T: Inherits<<T as GodotClass>::Base>,
+{
+    fn downgrade<F: FnOnce(&Self) -> R, R>(&mut self, closure: F) -> R {
+        let mut_base = self.base_mut();
+        let self_gd: Gd<T> = mut_base.to_godot().cast();
+        let slf = self_gd.bind();
+
+        closure(slf.deref())
+    }
+
+    fn downgrade_gd<F: FnOnce(Gd<Self>) -> R, R>(&mut self, closure: F) -> R {
+        let mut_base = self.base_mut();
+        let self_gd = mut_base.to_godot().cast();
+
+        closure(self_gd)
+    }
+}

rust-script/src/runtime/downgrade_self.rs

@@ -4,6 +4,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
+mod downgrade_self;
 mod metadata;
 mod resource_loader;
 mod resource_saver;

rust-script/src/runtime/mod.rs

@@ -4,7 +4,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-use std::{cell::RefCell, collections::HashSet, ffi::c_void, ops::Deref};
+use std::{cell::RefCell, collections::HashSet, ffi::c_void};
 
 use abi_stable::std_types::RBox;
 use godot::{
@@ -14,7 +14,7 @@ use godot::{
         Script, ScriptExtension, ScriptInstance, ScriptLanguage, WeakRef,
     },
     log::{godot_error, godot_print, godot_warn},
-    obj::{InstanceId, UserClass},
+    obj::{InstanceId, WithBaseField},
     prelude::{
         godot_api, Array, Base, Dictionary, GString, Gd, GodotClass, Object, StringName, Variant,
         VariantArray,
@@ -25,6 +25,7 @@ use RemoteGodotScript_trait::RemoteGodotScript_TO;
 use crate::{apply::Apply, script_registry::RemoteGodotScript_trait};
 
 use super::{
+    downgrade_self::DowngradeSelf,
     metadata::{Documented, ToDictionary, ToMethodDoc, ToPropertyDoc},
     rust_script_instance::{RustScriptInstance, RustScriptPlaceholder},
     rust_script_language::RustScriptLanguage,
@@ -47,6 +48,7 @@ pub(super) struct RustScript {
     owner_ids: Array<i64>,
 
     owners: RefCell<Vec<Gd<WeakRef>>>,
+    #[base]
     base: Base<ScriptExtension>,
 }
 
@@ -174,7 +176,7 @@ impl IScriptExtension for RustScript {
     }
 
     fn get_language(&self) -> Option<Gd<ScriptLanguage>> {
-        Some(RustScriptLanguage::alloc_gd().upcast())
+        RustScriptLanguage::singleton().map(Gd::upcast)
     }
 
     fn can_instantiate(&self) -> bool {
@@ -203,8 +205,7 @@ impl IScriptExtension for RustScript {
             .push(godot::engine::utilities::weakref(for_object.to_variant()).to());
 
         let data = self.create_remote_instance(for_object.clone());
-        let mut instance =
-            RustScriptInstance::new(data, for_object, self.base.deref().clone().cast());
+        let mut instance = RustScriptInstance::new(data, for_object, self.to_gd());
 
         Self::init_script_instance(&mut instance);
         create_script_instance(instance)
@@ -215,7 +216,7 @@ impl IScriptExtension for RustScript {
             .borrow_mut()
             .push(godot::engine::utilities::weakref(for_object.to_variant()).to());
 
-        let placeholder = RustScriptPlaceholder::new(self.base.deref().clone().cast());
+        let placeholder = RustScriptPlaceholder::new(self.to_gd());
 
         create_script_instance(placeholder)
     }
@@ -338,7 +339,7 @@ impl IScriptExtension for RustScript {
             dict.set(GString::from("is_deprecated"), false);
             dict.set(GString::from("is_experimental"), false);
             dict.set(GString::from("is_script_doc"), true);
-            dict.set(GString::from("script_path"), self.base.get_path());
+            dict.set(GString::from("script_path"), self.base().get_path());
         });
 
         Array::from(&[class_doc])
@@ -350,7 +351,9 @@ impl IScriptExtension for RustScript {
 
     // godot script reload hook
     fn reload(&mut self, _keep_state: bool) -> godot::engine::global::Error {
-        self.owners.borrow().iter().for_each(|owner| {
+        let owners = self.owners.borrow().clone();
+
+        owners.iter().for_each(|owner| {
             let mut object: Gd<Object> = match owner.get_ref().try_to() {
                 Ok(owner) => owner,
                 Err(err) => {
@@ -359,14 +362,13 @@ impl IScriptExtension for RustScript {
                 }
             };
 
-            let script = object.get_script();
-
             // clear script to destroy script instance.
             object.set_script(Variant::nil());
 
-            // re-assign script to create new instance.
-            // call is defered because this will call back into can_instantiate.
-            object.call_deferred(StringName::from("set_script"), &[script]);
+            self.downgrade_gd(|self_gd| {
+                // re-assign script to create new instance.
+                object.set_script(self_gd.to_variant());
+            })
         });
 
         godot::engine::global::Error::OK

rust-script/src/runtime/rust_script.rs

@@ -11,7 +11,6 @@ use std::{collections::HashMap, rc::Rc};
 use abi_stable::std_types::{RBox, RString};
 use godot::{
     engine::{Script, ScriptInstance},
-    obj::UserClass,
     prelude::{
         meta::{MethodInfo, PropertyInfo},
         GString, Gd, Object, StringName, Variant, VariantType,
@@ -192,7 +191,9 @@ impl ScriptInstance for RustScriptInstance {
     }
 
     fn get_language(&self) -> Gd<godot::engine::ScriptLanguage> {
-        RustScriptLanguage::alloc_gd().upcast()
+        RustScriptLanguage::singleton()
+            .map(Gd::upcast)
+            .expect("RustScriptLanguage singleton is not initialized")
     }
 
     fn on_refcount_decremented(&self) -> bool {
@@ -303,7 +304,9 @@ impl ScriptInstance for RustScriptPlaceholder {
     }
 
     fn get_language(&self) -> Gd<godot::engine::ScriptLanguage> {
-        RustScriptLanguage::alloc_gd().upcast()
+        RustScriptLanguage::singleton()
+            .map(Gd::upcast)
+            .expect("RustScriptLanguage singleton is not initialized")
     }
 
     fn on_refcount_decremented(&self) -> bool {

rust-script/src/runtime/rust_script_instance.rs

@@ -7,7 +7,7 @@
 use std::ffi::OsStr;
 
 use godot::{
-    engine::{FileAccess, IScriptLanguageExtension, ProjectSettings, Script},
+    engine::{Engine, FileAccess, IScriptLanguageExtension, ProjectSettings, Script},
     obj::Base,
     prelude::{
         godot_api, Array, Dictionary, GString, Gd, GodotClass, Object, PackedStringArray,
@@ -51,6 +51,12 @@ impl RustScriptLanguage {
             })
             .join("")
     }
+
+    pub fn singleton() -> Option<Gd<Self>> {
+        Engine::singleton()
+            .get_singleton(RustScriptLanguage::class_name().to_string_name())
+            .map(|gd| gd.cast())
+    }
 }
 
 #[godot_api]
@@ -90,7 +96,7 @@ impl IScriptLanguageExtension for RustScriptLanguage {
     }
 
     /// frame hook will be called for each reandered frame
-    fn frame(&mut self) {}
+    /// fn frame(&mut self) {}
 
     fn handles_global_class_type(&self, type_: GString) -> bool {
         type_ == self.get_type()