Merge pull request #476 from godot-rust/qol/rename-virtual-traits

Rename all virtual traits: `*Virtual` -> `I*`

Author: Bromeon

examples/dodge-the-creeps/rust/src/hud.rs

@@ -1,4 +1,4 @@
-use godot::engine::{Button, CanvasLayer, CanvasLayerVirtual, Label, Timer};
+use godot::engine::{Button, CanvasLayer, ICanvasLayer, Label, Timer};
 use godot::prelude::*;
 
 #[derive(GodotClass)]
@@ -61,7 +61,7 @@ impl Hud {
 }
 
 #[godot_api]
-impl CanvasLayerVirtual for Hud {
+impl ICanvasLayer for Hud {
     fn init(base: Base<Self::Base>) -> Self {
         Self { base }
     }

examples/dodge-the-creeps/rust/src/main_scene.rs

@@ -121,7 +121,7 @@ impl Main {
 }
 
 #[godot_api]
-impl NodeVirtual for Main {
+impl INode for Main {
     fn init(base: Base<Node>) -> Self {
         Main {
             mob_scene: PackedScene::new(),

examples/dodge-the-creeps/rust/src/mob.rs

@@ -1,4 +1,4 @@
-use godot::engine::{AnimatedSprite2D, RigidBody2D, RigidBody2DVirtual};
+use godot::engine::{AnimatedSprite2D, IRigidBody2D, RigidBody2D};
 use godot::prelude::*;
 use rand::seq::SliceRandom;
 
@@ -26,7 +26,7 @@ impl Mob {
 }
 
 #[godot_api]
-impl RigidBody2DVirtual for Mob {
+impl IRigidBody2D for Mob {
     fn init(base: Base<RigidBody2D>) -> Self {
         Mob {
             min_speed: 150.0,

examples/dodge-the-creeps/rust/src/player.rs

@@ -1,4 +1,4 @@
-use godot::engine::{AnimatedSprite2D, Area2D, Area2DVirtual, CollisionShape2D, PhysicsBody2D};
+use godot::engine::{AnimatedSprite2D, Area2D, CollisionShape2D, IArea2D, PhysicsBody2D};
 use godot::prelude::*;
 
 #[derive(GodotClass)]
@@ -42,7 +42,7 @@ impl Player {
 }
 
 #[godot_api]
-impl Area2DVirtual for Player {
+impl IArea2D for Player {
     fn init(base: Base<Area2D>) -> Self {
         Player {
             speed: 400.0,

godot-codegen/src/class_generator.rs

@@ -391,14 +391,16 @@ fn make_class_doc(
         godot_ty.to_ascii_lowercase()
     );
 
+    let trait_name = class_name.virtual_trait_name();
+
     format!(
         "Godot class `{godot_ty}.`\n\n\
         \
         {inherits_line}\n\n\
         \
         Related symbols:\n\n\
         {sidecar_line}\
-        * [`{rust_ty}Virtual`][crate::engine::{rust_ty}Virtual]: virtual methods\n\
+        * [`{trait_name}`][crate::engine::{trait_name}]: virtual methods\n\
         {notify_line}\
         \n\n\
         See also [Godot docs for `{godot_ty}`]({online_link}).\n\n",

godot-codegen/src/lib.rs

@@ -250,7 +250,7 @@ impl TyName {
     }
 
     fn virtual_trait_name(&self) -> String {
-        format!("{}Virtual", self.rust_ty)
+        format!("I{}", self.rust_ty)
     }
 }
 

godot-core/src/lib.rs

@@ -23,7 +23,7 @@ pub use registry::*;
 ///
 /// This module contains the following symbols:
 /// * Classes: `CanvasItem`, etc.
-/// * Virtual traits: `CanvasItemVirtual`, etc.
+/// * Virtual traits: `ICanvasItem`, etc.
 /// * Enum/flag modules: `canvas_item`, etc.
 ///
 /// Noteworthy sub-modules are:

godot-core/src/registry.rs

@@ -353,8 +353,8 @@ fn fill_class_info(component: PluginComponent, c: &mut ClassRegistrationInfo) {
         } => {
             c.user_register_fn = user_register_fn;
 
-            // following unwraps of fill_into shouldn't panic since rustc will error if there's
-            // multiple `impl {Class}Virtual for Thing` definitions
+            // The following unwraps of fill_into() shouldn't panic, since rustc will error if there are
+            // multiple `impl I{Class} for Thing` definitions.
 
             fill_into(&mut c.godot_params.create_instance_func, user_create_fn).unwrap();
 

godot-macros/src/lib.rs

@@ -376,11 +376,11 @@ pub fn derive_godot_class(input: TokenStream) -> TokenStream {
 ///
 /// // 2) trait impl block: implement Godot-specific APIs
 /// #[godot_api]
-/// impl NodeVirtual for MyClass { /* ... */ }
+/// impl INode for MyClass { /* ... */ }
 /// ```
 ///
-/// The second case works by implementing the corresponding trait `<Base>Virtual` for the base class of your class
-/// (for example `RefCountedVirtual` or `Node3DVirtual`). Then, you can add functionality such as:
+/// The second case works by implementing the corresponding trait `I<Base>` for the base class of your class
+/// (for example `IRefCounted` or `INode3D`). Then, you can add functionality such as:
 /// * `init` constructors
 /// * lifecycle methods like `ready` or `process`
 /// * `on_notification` method
@@ -408,7 +408,7 @@ pub fn derive_godot_class(input: TokenStream) -> TokenStream {
 /// }
 ///
 /// #[godot_api]
-/// impl RefCountedVirtual for MyStruct {
+/// impl IRefCounted for MyStruct {
 ///     fn init(_base: Base<RefCounted>) -> Self {
 ///         MyStruct
 ///     }
@@ -431,7 +431,7 @@ pub fn derive_godot_class(input: TokenStream) -> TokenStream {
 /// }
 ///
 /// #[godot_api]
-/// impl NodeVirtual for MyNode {
+/// impl INode for MyNode {
 ///     fn ready(&mut self) {
 ///         godot_print!("Hello World!");
 ///     }

godot-macros/src/util/mod.rs

@@ -173,11 +173,11 @@ pub(crate) fn validate_trait_impl_virtual(
     // Validate trait
     if !typename
         .as_ref()
-        .map_or(false, |seg| seg.ident.to_string().ends_with("Virtual"))
+        .map_or(false, |seg| seg.ident.to_string().starts_with('I'))
     {
         return bail!(
             original_impl,
-            "#[{attr}] for trait impls requires a virtual method trait (trait name should end in 'Virtual')",
+            "#[{attr}] for trait impls requires a virtual method trait (trait name should start with 'I')",
         );
     }