Merge pull request #733 from godot-rust/qol/streamline-modules-3

Streamline modules - part III: `godot::classes`, `godot::tools`, `godot::obj::script`

Author: Bromeon

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

@@ -1,4 +1,4 @@
-use godot::engine::{Button, CanvasLayer, ICanvasLayer, Label, Timer};
+use godot::classes::{Button, CanvasLayer, ICanvasLayer, Label, Timer};
 use godot::prelude::*;
 
 #[derive(GodotClass)]

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

@@ -2,7 +2,7 @@ use crate::hud::Hud;
 use crate::mob;
 use crate::player;
 
-use godot::engine::{Marker2D, PathFollow2D, RigidBody2D, Timer};
+use godot::classes::{Marker2D, PathFollow2D, RigidBody2D, Timer};
 use godot::prelude::*;
 
 use rand::Rng as _;

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

@@ -1,4 +1,4 @@
-use godot::engine::{AnimatedSprite2D, IRigidBody2D, RigidBody2D};
+use godot::classes::{AnimatedSprite2D, IRigidBody2D, RigidBody2D};
 use godot::prelude::*;
 use rand::seq::SliceRandom;
 

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

@@ -1,4 +1,4 @@
-use godot::engine::{AnimatedSprite2D, Area2D, CollisionShape2D, IArea2D, PhysicsBody2D};
+use godot::classes::{AnimatedSprite2D, Area2D, CollisionShape2D, IArea2D, PhysicsBody2D};
 use godot::prelude::*;
 
 #[derive(GodotClass)]

godot-codegen/src/conv/type_conversions.rs

@@ -164,7 +164,7 @@ fn to_rust_type_uncached(full_ty: &GodotTy, ctx: &mut Context) -> RustTy {
             let bitfield_ty = conv::make_enum_name(enum_);
 
             RustTy::EngineBitfield {
-                tokens: quote! { crate::engine::#module::#bitfield_ty},
+                tokens: quote! { crate::classes::#module::#bitfield_ty},
                 surrounding_class: Some(class.to_string()),
             }
         } else {
@@ -185,7 +185,7 @@ fn to_rust_type_uncached(full_ty: &GodotTy, ctx: &mut Context) -> RustTy {
             let enum_ty = conv::make_enum_name(enum_);
 
             RustTy::EngineEnum {
-                tokens: quote! { crate::engine::#module::#enum_ty },
+                tokens: quote! { crate::classes::#module::#enum_ty },
                 surrounding_class: Some(class.to_string()),
             }
         } else {
@@ -221,7 +221,7 @@ fn to_rust_type_uncached(full_ty: &GodotTy, ctx: &mut Context) -> RustTy {
     } else {
         let ty = rustify_ty(ty);
         RustTy::EngineClass {
-            tokens: quote! { Gd<crate::engine::#ty> },
+            tokens: quote! { Gd<crate::classes::#ty> },
             inner_class: ty,
         }
     }

godot-codegen/src/generator/central_files.rs

@@ -67,7 +67,7 @@ pub fn make_core_central_code(api: &ExtensionApi, ctx: &mut Context) -> TokenStr
     // But this requires that all the variant types support this.
     quote! {
         use crate::builtin::*;
-        use crate::engine::Object;
+        use crate::classes::Object;
         use crate::obj::Gd;
 
         // Remaining trait impls for sys::VariantType (traits only defined in godot-core).

godot-codegen/src/generator/classes.rs

@@ -84,7 +84,7 @@ fn make_class(class: &Class, ctx: &mut Context, view: &ApiView) -> GeneratedClas
     let (base_ty, base_ident_opt) = match class.inherits.as_ref() {
         Some(base) => {
             let base = ident(&conv::to_pascal_case(base));
-            (quote! { crate::engine::#base }, Some(base))
+            (quote! { crate::classes::#base }, Some(base))
         }
         None => (quote! { crate::obj::NoBase }, None),
     };
@@ -132,7 +132,7 @@ fn make_class(class: &Class, ctx: &mut Context, view: &ApiView) -> GeneratedClas
         notifications::make_notification_enum(class_name, &all_bases, &cfg_attributes, ctx);
 
     // Associated "sidecar" module is made public if there are other symbols related to the class, which are not
-    // in top-level godot::engine module (notification enums are not in the sidecar, but in godot::engine::notify).
+    // in top-level godot::classes module (notification enums are not in the sidecar, but in godot::classes::notify).
     // This checks if token streams (i.e. code) is empty.
     let has_sidecar_module = !enums.is_empty() || !builders.is_empty();
 
@@ -184,7 +184,7 @@ fn make_class(class: &Class, ctx: &mut Context, view: &ApiView) -> GeneratedClas
         #cfg_inner_attributes
 
         #imports
-        use crate::engine::notify::*;
+        use crate::classes::notify::*;
         use std::ffi::c_void;
 
         pub(super) mod re_export {
@@ -228,7 +228,7 @@ fn make_class(class: &Class, ctx: &mut Context, view: &ApiView) -> GeneratedClas
 
             #(
                 // SAFETY: #all_bases is a list of classes provided by Godot such that #class_name is guaranteed a subclass of all of them.
-                unsafe impl crate::obj::Inherits<crate::engine::#all_bases> for #class_name {}
+                unsafe impl crate::obj::Inherits<crate::classes::#all_bases> for #class_name {}
             )*
 
             #godot_default_impl
@@ -241,9 +241,9 @@ fn make_class(class: &Class, ctx: &mut Context, view: &ApiView) -> GeneratedClas
             #[allow(non_snake_case)]
             macro_rules! #inherits_macro {
                 ($Class:ident) => {
-                    unsafe impl ::godot::obj::Inherits<::godot::engine::#class_name> for $Class {}
+                    unsafe impl ::godot::obj::Inherits<::godot::classes::#class_name> for $Class {}
                     #(
-                        unsafe impl ::godot::obj::Inherits<::godot::engine::#all_bases> for $Class {}
+                        unsafe impl ::godot::obj::Inherits<::godot::classes::#all_bases> for $Class {}
                     )*
                 }
             }
@@ -313,6 +313,7 @@ fn make_class_module_file(classes_and_modules: Vec<GeneratedClassModule>) -> Tok
     quote! {
         #( #class_decls )*
 
+        /// Notification enums for all classes.
         pub mod notify {
             #( #notify_decls )*
         }
@@ -380,7 +381,7 @@ fn make_constructor_and_default(
         quote! {
             impl crate::obj::cap::GodotDefault for #class_name {
                 fn __godot_default() -> crate::obj::Gd<Self> {
-                    crate::engine::construct_engine_object::<Self>()
+                    crate::classes::construct_engine_object::<Self>()
                 }
             }
         }

godot-codegen/src/generator/docs.rs

@@ -22,22 +22,22 @@ pub fn make_class_doc(
     let TyName { rust_ty, godot_ty } = class_name;
 
     let inherits_line = if let Some(base) = base_ident_opt {
-        format!("Inherits [`{base}`][crate::engine::{base}].")
+        format!("Inherits [`{base}`][crate::classes::{base}].")
     } else {
         "This is the base class for all other classes at the root of the hierarchy. \
         Every instance of `Object` can be stored in a [`Gd`][crate::obj::Gd] smart pointer."
             .to_string()
     };
 
     let notify_line = if has_notification_enum {
-        format!("* [`{rust_ty}Notification`][crate::engine::notify::{rust_ty}Notification]: notification type\n")
+        format!("* [`{rust_ty}Notification`][crate::classes::notify::{rust_ty}Notification]: notification type\n")
     } else {
         String::new()
     };
 
     let sidecar_line = if has_sidecar_module {
         let module_name = ModName::from_godot(&class_name.godot_ty).rust_mod;
-        format!("* [`{module_name}`][crate::engine::{module_name}]: sidecar module with related enum/flag types\n")
+        format!("* [`{module_name}`][crate::classes::{module_name}]: sidecar module with related enum/flag types\n")
     } else {
         String::new()
     };
@@ -60,7 +60,7 @@ pub fn make_class_doc(
         \
         Related symbols:\n\n\
         {sidecar_line}\
-        * [`{trait_name}`][crate::engine::{trait_name}]: virtual methods\n\
+        * [`{trait_name}`][crate::classes::{trait_name}]: virtual methods\n\
         {notify_line}\
         \n\n\
         See also [Godot docs for `{godot_ty}`]({online_link}).\n\n{notes}",
@@ -80,7 +80,7 @@ pub fn make_virtual_trait_doc(trait_name_str: &str, class_name: &TyName) -> Stri
         .unwrap_or_default();
 
     format!(
-        "Virtual methods for class [`{rust_ty}`][crate::engine::{rust_ty}].\
+        "Virtual methods for class [`{rust_ty}`][crate::classes::{rust_ty}].\
         \n\n\
         These methods represent constructors (`init`) or callbacks invoked by the engine.\
         \n\n\
@@ -97,7 +97,7 @@ pub fn make_module_doc(class_name: &TyName) -> String {
     );
 
     format!(
-        "Sidecar module for class [`{rust_ty}`][crate::engine::{rust_ty}].\
+        "Sidecar module for class [`{rust_ty}`][crate::classes::{rust_ty}].\
         \n\n\
         Defines related flag and enum types. In GDScript, those are nested under the class scope.\
         \n\n\

godot-codegen/src/generator/gdext_build_struct.rs

@@ -53,7 +53,7 @@ pub fn make_gdext_build_struct(header: &GodotApiVersion) -> TokenStream {
                 (version.major as u8, version.minor as u8, version.patch as u8)
             }
 
-            /// For a string "4.x", returns `true` if the current Godot version is strictly less than 4.x.
+            /// For a string `"4.x"`, returns `true` if the current Godot version is strictly less than 4.x.
             ///
             /// Runtime equivalent of `#[cfg(before_api = "4.x")]`.
             ///
@@ -69,7 +69,7 @@ pub fn make_gdext_build_struct(header: &GodotApiVersion) -> TokenStream {
                 minor < queried_minor
             }
 
-            /// For a string "4.x", returns `true` if the current Godot version is equal or greater to 4.x.
+            /// For a string `"4.x"`, returns `true` if the current Godot version is equal or greater to 4.x.
             ///
             /// Runtime equivalent of `#[cfg(since_api = "4.x")]`.
             ///

godot-codegen/src/generator/notifications.rs

@@ -81,7 +81,7 @@ pub fn make_notification_enum(
 
     let enum_name = ctx.notification_enum_name(class_name).name;
     let doc_str = format!(
-        "Notification type for class [`{c}`][crate::engine::{c}].",
+        "Notification type for class [`{c}`][crate::classes::{c}].",
         c = class_name.rust_ty
     );