Merge #888

888: NativeClass: mark internal methods with potential naming conflicts for renaming r=Bromeon a=Bromeon

Fixes #885.

Co-authored-by: Jan Haller <[email protected]>

Author: bors[bot]

examples/spinning-cube/src/lib.rs

@@ -5,15 +5,15 @@ use gdnative::export::hint::{EnumHint, IntHint, StringHint};
 
 #[derive(gdnative::derive::NativeClass)]
 #[inherit(MeshInstance)]
-#[register_with(register_properties)]
+#[register_with(register_members)]
 struct RustTest {
     start: Vector3,
     time: f32,
     #[property(path = "base/rotate_speed")]
     rotate_speed: f64,
 }
 
-fn register_properties(builder: &ClassBuilder<RustTest>) {
+fn register_members(builder: &ClassBuilder<RustTest>) {
     builder
         .property::<String>("test/test_enum")
         .with_hint(StringHint::Enum(EnumHint::new(vec![

gdnative-bindings/build.rs

@@ -144,7 +144,7 @@ fn format_file_if_needed(output_rs: &Path) {
         .arg("run")
         .arg("stable")
         .arg("rustfmt")
-        .arg("--edition=2018")
+        .arg("--edition=2021")
         .arg(output_rs)
         .output();
 

gdnative-core/src/core_types/variant/serialize.rs

@@ -111,7 +111,7 @@ struct DictionaryDispatchEntry {
     value: VariantDispatch,
 }
 
-impl<'d> Serialize for DictionaryDispatch {
+impl Serialize for DictionaryDispatch {
     fn serialize<S>(&self, serializer: S) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
     where
         S: Serializer,

gdnative-core/src/export/class.rs

@@ -43,6 +43,11 @@ pub trait NativeClass: Sized + 'static {
     /// See module-level documentation on `user_data` for more info.
     type UserData: UserData<Target = Self>;
 
+    // TODO(0.11) bugfix for https://github.com/godot-rust/godot-rust/issues/885
+    // * Rename init, register_properties, register by prefixing them with "nativeclass_"
+    // * Mark them as #[doc(hidden)]
+    // * Discourage manual NativeClass and NativeClassMethod impls
+
     /// Function that creates a value of `Self`, used for the script-instance. The default
     /// implementation simply panics.
     ///
@@ -53,6 +58,7 @@ pub trait NativeClass: Sized + 'static {
     /// of such scripts can only be created from Rust using `Instance::emplace`. See
     /// documentation on `Instance::emplace` for an example.
     #[inline]
+    #[deprecated = "This method will be removed from the public API."]
     fn init(_owner: TRef<'_, Self::Base, Shared>) -> Self {
         panic!(
             "{} does not have a zero-argument constructor",
@@ -62,6 +68,7 @@ pub trait NativeClass: Sized + 'static {
 
     /// Register any exported properties to Godot.
     #[inline]
+    #[deprecated = "This method will be removed from the public API."]
     fn register_properties(_builder: &ClassBuilder<Self>) {}
 
     /// Convenience method to create an `Instance<Self, Unique>`. This is a new `Self::Base`
@@ -111,6 +118,9 @@ pub trait StaticallyNamed: NativeClass {
 /// Trait used to provide information of Godot-exposed methods of a script class.
 pub trait NativeClassMethods: NativeClass {
     /// Function that registers all exposed methods to Godot.
+    ///
+    // TODO see comment in NativeClass
+    #[deprecated = "This method will be removed from the public API."]
     fn register(builder: &ClassBuilder<Self>);
 }
 

gdnative-core/src/init/init_handle.rs

@@ -18,6 +18,7 @@ pub struct InitHandle {
     handle: *mut libc::c_void,
 }
 
+#[allow(deprecated)] // Remove once init(), register_properties() and register() have been renamed
 impl InitHandle {
     #[doc(hidden)]
     #[inline]

gdnative-core/src/object/as_arg.rs

@@ -44,7 +44,7 @@ mod private {
 }
 
 // Null
-impl<'a, T> private::Sealed for Null<T> {}
+impl<T> private::Sealed for Null<T> {}
 
 // Temporary references (shared ownership)
 impl<'a, T: GodotObject> private::Sealed for TRef<'a, T, Shared> {}
@@ -59,14 +59,14 @@ impl<T: NativeClass, Own: Ownership> private::Sealed for Instance<T, Own> {}
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Null
 
-impl<'a, T: GodotObject> AsArg<T> for Null<T> {
+impl<T: GodotObject> AsArg<T> for Null<T> {
     #[inline]
     fn as_arg_ptr(&self) -> *mut sys::godot_object {
         std::ptr::null_mut()
     }
 }
 
-impl<'a, T: GodotObject> AsVariant for Null<T> {
+impl<T: GodotObject> AsVariant for Null<T> {
     type Target = T;
 }