New module extras to combine GFile and other engine functionality

Author: Bromeon

godot-codegen/src/generator/notifications.rs

@@ -97,6 +97,8 @@ pub fn make_notification_enum(
         ///
         /// Makes it easier to keep an overview all possible notification variants for a given class, including
         /// notifications defined in base classes.
+        ///
+        /// Contains the [`Unknown`] variant for forward compatibility.
         #[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
         #[repr(i32)]
         #cfg_attributes

godot-core/src/engine/mod.rs

@@ -12,25 +12,12 @@ use crate::obj::{bounds, Bounds, Gd, GodotClass, InstanceId};
 
 // Re-exports of generated symbols
 
-#[deprecated = "Enums have been moved to `godot::global`."]
-pub mod global {
-    pub use crate::builtin::{Corner, EulerOrder, Side};
-    pub use crate::global::*;
-}
-
-#[deprecated = "Utility functions have been moved to `godot::global`."]
-pub mod utilities {
-    pub use crate::global::*;
-}
-
 pub use crate::gen::classes::*;
-pub use io::*;
 pub use script_instance::{create_script_instance, ScriptInstance, SiMut};
 
 use crate::builtin::meta::CallContext;
 use crate::sys;
 
-mod io;
 mod manual_extensions;
 mod script_instance;
 pub mod translate;
@@ -49,6 +36,38 @@ pub mod native {
     pub use crate::gen::native::*;
 }
 
+// ----------------------------------------------------------------------------------------------------------------------------------------------
+// Deprecations
+
+// #[deprecated = "Enums have been moved to `godot::global`."]
+// pub mod global {
+//     pub use crate::builtin::{Corner, EulerOrder, Side};
+//     pub use crate::global::*;
+// }
+//
+// #[deprecated = "Utility functions have been moved to `godot::global`."]
+// pub mod utilities {
+//     pub use crate::global::*;
+// }
+//
+// #[deprecated = "`GFile` has been moved to `godot::extras`."]
+// pub use crate::extras::GFile;
+//
+// #[deprecated = "`IoError` has been moved to `godot::extras`."]
+// pub use crate::extras::IoError;
+//
+// #[deprecated = "`save` has been moved to `godot::global`."]
+// pub use crate::global::save;
+//
+// #[deprecated = "`try_save` has been moved to `godot::global`."]
+// pub use crate::global::try_save;
+//
+// #[deprecated = "`load` has been moved to `godot::global`."]
+// pub use crate::global::load;
+//
+// #[deprecated = "`try_load` has been moved to `godot::global`."]
+// pub use crate::global::try_load;
+
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Utilities for crate
 

godot-core/src/engine/io/gfile.rs renamed to godot-core/src/extras/gfile.rs

@@ -7,12 +7,11 @@
 
 use crate::builtin::{real, GString, PackedByteArray, PackedStringArray, Variant};
 use crate::engine::file_access::{CompressionMode, ModeFlags};
-use crate::gen::classes::FileAccess;
+use crate::engine::FileAccess;
+use crate::extras::IoError;
 use crate::global::Error;
 use crate::obj::Gd;
 
-use crate::engine::io::IoError;
-
 use std::cmp;
 use std::io::{BufRead, ErrorKind, Read, Seek, SeekFrom, Write};
 
@@ -49,9 +48,9 @@ use std::io::{BufRead, ErrorKind, Read, Seek, SeekFrom, Write};
 /// ## Examples
 ///
 /// ```no_run
-/// use godot::engine::GFile;
+/// use godot::builtin::GString;
 /// use godot::engine::file_access::ModeFlags;
-/// use godot::builtin::{GString};
+/// use godot::extras::GFile;
 ///
 /// fn save_game() -> Result<(), std::io::Error> {
 ///

godot-core/src/engine/io/io_error.rs renamed to godot-core/src/extras/io_error.rs

@@ -7,8 +7,8 @@
 
 use std::error::Error;
 
-use crate::engine::global::Error as GodotError;
 use crate::gen::classes::FileAccess;
+use crate::global::Error as GodotError;
 use crate::obj::{Gd, NotUniqueError};
 
 /// Error that can occur while using `gdext` IO utilities.

godot-core/src/engine/io/mod.rs renamed to godot-core/src/extras/mod.rs

@@ -7,8 +7,6 @@
 
 mod gfile;
 mod io_error;
-mod resources;
 
-pub use gfile::GFile;
+pub use gfile::*;
 pub use io_error::*;
-pub use resources::{load, save, try_load, try_save};

godot-core/src/global/mod.rs

@@ -19,13 +19,16 @@
 //! - Rectangle: [`Side`][crate::builtin::Side], [`Corner`][crate::builtin::Corner] <sub>(godot-generated)</sub>
 //! - Rotation: [`EulerOrder`][crate::builtin::EulerOrder] <sub>(godot-generated)</sub>
 //! - Variant: [`VariantType`][crate::builtin::VariantType], [`VariantOperator`][crate::builtin::VariantOperator]
-//! - Vector: [`Vector2Axis`](crate::builtin::Vector2Axis), [`Vector3Axis`](crate::builtin::Vector3Axis), [`Vector4Axis`](crate::builtin::Vector4Axis)
+//! - Vector: [`Vector2Axis`][crate::builtin::Vector2Axis], [`Vector3Axis`][crate::builtin::Vector3Axis], [`Vector4Axis`][crate::builtin::Vector4Axis]
 //!
 
 mod print;
+mod save_load;
 
 pub use crate::{godot_error, godot_print, godot_print_rich, godot_script_error, godot_warn};
 
 // Some enums are directly re-exported from crate::builtin.
 pub use crate::gen::central::global_enums::*;
 pub use crate::gen::utilities::*;
+
+pub use save_load::*;

godot-core/src/engine/io/resources.rs renamed to godot-core/src/global/save_load.rs

@@ -6,12 +6,11 @@
  */
 
 use crate::builtin::GString;
-use crate::engine::global::Error as GodotError;
-use crate::gen::classes::{Resource, ResourceLoader, ResourceSaver};
+use crate::engine::{Resource, ResourceLoader, ResourceSaver};
+use crate::extras::IoError;
+use crate::global::Error as GodotError;
 use crate::obj::{Gd, Inherits};
 
-use super::IoError;
-
 /// ⚠️ Loads a resource from the filesystem located at `path`, panicking on error.
 ///
 /// See [`try_load`] for more information.

godot-core/src/lib.rs

@@ -40,12 +40,16 @@ pub use registry::*;
 /// * Enum/flag modules: `canvas_item`, etc.
 ///
 /// Noteworthy sub-modules are:
-/// * [`notify`][crate::engine::notify]: all notification types, used when working with the virtual callback to handle lifecycle notifications.
-/// * [`global`][crate::engine::global]: global enums not belonging to a specific class.
-/// * [`utilities`][crate::engine::utilities]: utility methods that are global in Godot.
-/// * [`translate`][crate::engine::translate]: convenience macros for translation.
+/// * [`notify`][crate::engine::notify]: all notification enums, used when working with the virtual callback to handle lifecycle notifications.
+/// * [`native`][crate::engine::native]: definition of _native structure_ types.
 pub mod engine;
 
+/// Higher-level additions to the Godot engine API.
+///
+/// Contains functionality that extends existing Godot classes and functions, to make them more versatile
+/// or better integrated with Rust.
+pub mod extras;
+
 // Output of generated code. Mimics the file structure, symbols are re-exported.
 #[rustfmt::skip]
 #[allow(unused_imports, dead_code, non_upper_case_globals, non_snake_case)]

godot-core/src/registry/property.rs

@@ -11,7 +11,7 @@ use godot_ffi as sys;
 
 use crate::builtin::meta::{FromGodot, GodotConvert, GodotType, ToGodot};
 use crate::builtin::GString;
-use crate::engine::global::PropertyHint;
+use crate::global::PropertyHint;
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Trait definitions
@@ -142,7 +142,7 @@ impl PropertyHintInfo {
 /// Each function is named the same as the equivalent Godot annotation. For instance `@export_range` in Godot is `fn export_range` here.
 pub mod export_info_functions {
     use crate::builtin::GString;
-    use crate::engine::global::PropertyHint;
+    use crate::global::PropertyHint;
 
     use super::PropertyHintInfo;
 

godot/src/lib.rs

@@ -223,7 +223,7 @@ const _: () = _validate_features();
 // Modules
 
 #[doc(inline)]
-pub use godot_core::{builtin, engine, global, obj};
+pub use godot_core::{builtin, engine, extras, global, obj};
 
 #[allow(deprecated)]
 pub use godot_core::log;