Rename godot::extras -> godot::tools

Bromeon · Bromeon · commit a5cf41130fcd · 2024-05-27T21:37:23.000+02:00
diff --git a/godot-codegen/src/special_cases/special_cases.rs b/godot-codegen/src/special_cases/special_cases.rs
@@ -312,10 +312,10 @@ pub fn maybe_rename_virtual_method(rust_method_name: &str) -> &str {
 pub fn get_class_extra_docs(class_name: &TyName) -> Option<&'static str> {
     match class_name.godot_ty.as_str() {
         "FileAccess" => {
-            Some("The gdext library provides a higher-level abstraction, which should be preferred: [`GFile`][crate::extras::GFile].")
+            Some("The gdext library provides a higher-level abstraction, which should be preferred: [`GFile`][crate::tools::GFile].")
         }
         "ScriptExtension" => {
-            Some("Use this in combination with [`ScriptInstance`][crate::extras::ScriptInstance].")
+            Some("Use this in combination with [`ScriptInstance`][crate::tools::ScriptInstance].")
         }
 
         _ => None,
@@ -325,7 +325,7 @@ pub fn get_class_extra_docs(class_name: &TyName) -> Option<&'static str> {
 pub fn get_interface_extra_docs(trait_name: &str) -> Option<&'static str> {
     match trait_name {
         "IScriptExtension" => {
-            Some("Use this in combination with [`ScriptInstance`][crate::extras::ScriptInstance].")
+            Some("Use this in combination with [`ScriptInstance`][crate::tools::ScriptInstance].")
         }
 
         _ => None,
diff --git a/godot-core/src/engine/mod.rs b/godot-core/src/engine/mod.rs
@@ -5,7 +5,7 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-#![deprecated = "Module has been split into `godot::classes`, `godot::global` and `godot::extras`."]
+#![deprecated = "Module has been split into `godot::classes`, `godot::global` and `godot::tools`."]
 
 #[deprecated = "Classes have been moved to `godot::classes`."]
 pub use crate::classes::*;
@@ -26,34 +26,34 @@ pub mod native {
     pub use crate::gen::native::*;
 }
 
-#[deprecated = "`godot::classes::translate` has been moved to `godot::extras`."]
+#[deprecated = "`godot::classes::translate` has been moved to `godot::tools`."]
 pub mod translate {
-    pub use crate::extras::{tr, tr_n};
+    pub use crate::tools::{tr, tr_n};
 }
 
-#[deprecated = "`create_script_instance` has been moved to `godot::extras`."]
-pub use crate::extras::create_script_instance;
+#[deprecated = "`create_script_instance` has been moved to `godot::tools`."]
+pub use crate::tools::create_script_instance;
 
-#[deprecated = "`ScriptInstance` has been moved to `godot::extras`."]
-pub use crate::extras::ScriptInstance;
+#[deprecated = "`ScriptInstance` has been moved to `godot::tools`."]
+pub use crate::tools::ScriptInstance;
 
-#[deprecated = "`SiMut` has been moved to `godot::extras`."]
-pub use crate::extras::SiMut;
+#[deprecated = "`SiMut` has been moved to `godot::tools`."]
+pub use crate::tools::SiMut;
 
-#[deprecated = "`GFile` has been moved to `godot::extras`."]
-pub use crate::extras::GFile;
+#[deprecated = "`GFile` has been moved to `godot::tools`."]
+pub use crate::tools::GFile;
 
-#[deprecated = "`IoError` has been moved to `godot::extras`."]
-pub use crate::extras::IoError;
+#[deprecated = "`IoError` has been moved to `godot::tools`."]
+pub use crate::tools::IoError;
 
 #[deprecated = "`save` has been moved to `godot::global`."]
-pub use crate::extras::save;
+pub use crate::tools::save;
 
 #[deprecated = "`try_save` has been moved to `godot::global`."]
-pub use crate::extras::try_save;
+pub use crate::tools::try_save;
 
 #[deprecated = "`load` has been moved to `godot::global`."]
-pub use crate::extras::load;
+pub use crate::tools::load;
 
 #[deprecated = "`try_load` has been moved to `godot::global`."]
-pub use crate::extras::try_load;
+pub use crate::tools::try_load;
diff --git a/godot-core/src/lib.rs b/godot-core/src/lib.rs
@@ -38,7 +38,7 @@ pub mod engine;
 ///
 /// Contains functionality that extends existing Godot classes and functions, to make them more versatile
 /// or better integrated with Rust.
-pub mod extras;
+pub mod tools;
 
 // Output of generated code. Mimics the file structure, symbols are re-exported.
 #[rustfmt::skip]
diff --git a/godot-core/src/obj/guards.rs b/godot-core/src/obj/guards.rs
@@ -11,8 +11,8 @@ use godot_ffi::out;
 use std::fmt::Debug;
 use std::ops::{Deref, DerefMut};
 
-use crate::extras::ScriptInstance;
 use crate::obj::{Gd, GodotClass};
+use crate::tools::ScriptInstance;
 
 /// Immutably/shared bound reference guard for a [`Gd`][crate::obj::Gd] smart pointer.
 ///
diff --git a/godot-core/src/tools/gfile.rs b/godot-core/src/tools/gfile.rs
@@ -8,9 +8,9 @@
 use crate::builtin::{real, GString, PackedByteArray, PackedStringArray, Variant};
 use crate::classes::file_access::{CompressionMode, ModeFlags};
 use crate::classes::FileAccess;
-use crate::extras::IoError;
 use crate::global::Error;
 use crate::obj::Gd;
+use crate::tools::IoError;
 
 use std::cmp;
 use std::io::{BufRead, ErrorKind, Read, Seek, SeekFrom, Write};
@@ -50,7 +50,7 @@ use std::io::{BufRead, ErrorKind, Read, Seek, SeekFrom, Write};
 /// ```no_run
 /// use godot::builtin::GString;
 /// use godot::classes::file_access::ModeFlags;
-/// use godot::extras::GFile;
+/// use godot::tools::GFile;
 ///
 /// fn save_game() -> Result<(), std::io::Error> {
 ///
diff --git a/godot-core/src/tools/io_error.rs b/godot-core/src/tools/io_error.rs
diff --git a/godot-core/src/tools/mod.rs b/godot-core/src/tools/mod.rs
diff --git a/godot-core/src/tools/save_load.rs b/godot-core/src/tools/save_load.rs
@@ -7,9 +7,9 @@
 
 use crate::builtin::GString;
 use crate::classes::{Resource, ResourceLoader, ResourceSaver};
-use crate::extras::IoError;
 use crate::global::Error as GodotError;
 use crate::obj::{Gd, Inherits};
+use crate::tools::IoError;
 
 /// ⚠️ Loads a resource from the filesystem located at `path`, panicking on error.
 ///
diff --git a/godot-core/src/tools/script_instance.rs b/godot-core/src/tools/script_instance.rs
@@ -294,7 +294,7 @@ impl<'a, T: ScriptInstance> SiMut<'a, T> {
     /// ```no_run
     /// # use godot::prelude::*;
     /// # use godot::classes::{ScriptLanguage, Script};
-    /// # use godot::extras::{ScriptInstance, SiMut};
+    /// # use godot::tools::{ScriptInstance, SiMut};
     /// # use godot::builtin::meta::{MethodInfo, PropertyInfo};
     /// # use godot::sys;
     /// struct ExampleScriptInstance;
@@ -342,7 +342,7 @@ impl<'a, T: ScriptInstance> SiMut<'a, T> {
     /// ```no_run
     /// # use godot::prelude::*;
     /// # use godot::classes::{ScriptLanguage, Script};
-    /// # use godot::extras::{ScriptInstance, SiMut};
+    /// # use godot::tools::{ScriptInstance, SiMut};
     /// # use godot::builtin::meta::{MethodInfo, PropertyInfo};
     /// # use godot::sys;
     /// struct ExampleScriptInstance;
diff --git a/godot-core/src/tools/translate.rs b/godot-core/src/tools/translate.rs
@@ -22,7 +22,7 @@ pub use crate::{tr, tr_n};
 /// # let a = Vector2i { x: 0, y: 0 };
 /// # let b = Vector2i { x: 0, y: 0 };
 /// # let context = "context";
-/// use godot::extras::tr;
+/// use godot::tools::tr;
 ///
 /// // Good.
 /// tr!(context; "{a} is a {b}"); // inlined, with context
@@ -65,7 +65,7 @@ macro_rules! tr {
 /// # let b = Vector2i { x: 0, y: 0 };
 /// # let context = "context";
 /// # let n = 2;
-/// use godot::extras::tr_n;
+/// use godot::tools::tr_n;
 ///
 /// // Good.
 /// tr_n!(n, context; "{a} is a {b}", "{a}s are {b}s"); // inlined, with context
diff --git a/godot/src/lib.rs b/godot/src/lib.rs
@@ -223,7 +223,7 @@ const _: () = _validate_features();
 // Modules
 
 #[doc(inline)]
-pub use godot_core::{builtin, classes, extras, global, obj};
+pub use godot_core::{builtin, classes, global, obj, tools};
 
 #[allow(deprecated)]
 pub use godot_core::{engine, log};
diff --git a/godot/src/prelude.rs b/godot/src/prelude.rs
@@ -19,10 +19,10 @@ pub use super::classes::{
     INode2D, INode3D, IObject, IPackedScene, IRefCounted, IResource, ISceneTree, Input, Node,
     Node2D, Node3D, Object, PackedScene, RefCounted, Resource, SceneTree,
 };
-pub use super::extras::{load, save, try_load, try_save, GFile, IoError};
 pub use super::global::{
     godot_error, godot_print, godot_print_rich, godot_script_error, godot_warn,
 };
+pub use super::tools::{load, save, try_load, try_save, GFile, IoError};
 
 pub use super::init::{gdextension, ExtensionLibrary, InitLevel};
 pub use super::obj::{Base, Gd, GdMut, GdRef, GodotClass, Inherits, InstanceId, OnReady};
diff --git a/itest/rust/src/builtin_tests/script/script_instance_tests.rs b/itest/rust/src/builtin_tests/script/script_instance_tests.rs
@@ -10,11 +10,11 @@ use std::ffi::c_void;
 use godot::builtin::meta::{ClassName, FromGodot, MethodInfo, PropertyInfo, ToGodot};
 use godot::builtin::{GString, StringName, Variant, VariantType};
 use godot::classes::{IScriptExtension, Object, Script, ScriptExtension, ScriptLanguage};
-use godot::extras::{create_script_instance, ScriptInstance, SiMut};
 use godot::global::{MethodFlags, PropertyHint, PropertyUsageFlags};
 use godot::obj::{Base, Gd, WithBaseField};
 use godot::register::{godot_api, GodotClass};
 use godot::sys;
+use godot::tools::{create_script_instance, ScriptInstance, SiMut};
 
 #[derive(GodotClass)]
 #[class(base = ScriptExtension, init)]
diff --git a/itest/rust/src/engine_tests/gfile_test.rs b/itest/rust/src/engine_tests/gfile_test.rs
@@ -10,7 +10,7 @@ use std::io::{BufRead, BufReader, BufWriter, Read, Seek, SeekFrom, Write};
 use crate::framework::itest;
 use godot::builtin::GString;
 use godot::classes::file_access::ModeFlags;
-use godot::extras::GFile;
+use godot::tools::GFile;
 
 const TEST_FULL_PATH: &str = "res://file_tests";
 
diff --git a/itest/rust/src/engine_tests/save_load_test.rs b/itest/rust/src/engine_tests/save_load_test.rs
@@ -5,9 +5,9 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-use godot::extras::{load, save, try_load, try_save};
 use godot::obj::NewGd;
 use godot::register::GodotClass;
+use godot::tools::{load, save, try_load, try_save};
 
 use crate::framework::itest;
 
diff --git a/itest/rust/src/engine_tests/translate_test.rs b/itest/rust/src/engine_tests/translate_test.rs
@@ -7,7 +7,7 @@
 
 use crate::framework::itest;
 use godot::builtin::Vector2;
-use godot::extras::{tr, tr_n};
+use godot::tools::{tr, tr_n};
 
 #[itest]
 fn tr_macro_format() {

Original file line number	Diff line number	Diff line change
`@@ -312,10 +312,10 @@ pub fn maybe_rename_virtual_method(rust_method_name: &str) -> &str {`
`312`	`312`	`pub fn get_class_extra_docs(class_name: &TyName) -> Option<&'static str> {`
`313`	`313`	`match class_name.godot_ty.as_str() {`
`314`	`314`	`"FileAccess" => {`
`315`		- Some("The gdext library provides a higher-level abstraction, which should be preferred: [`GFile`][crate::extras::GFile].")
	`315`	+ Some("The gdext library provides a higher-level abstraction, which should be preferred: [`GFile`][crate::tools::GFile].")
`316`	`316`	`}`
`317`	`317`	`"ScriptExtension" => {`
`318`		- Some("Use this in combination with [`ScriptInstance`][crate::extras::ScriptInstance].")
	`318`	+ Some("Use this in combination with [`ScriptInstance`][crate::tools::ScriptInstance].")
`319`	`319`	`}`
`320`	`320`
`321`	`321`	`_ => None,`
`@@ -325,7 +325,7 @@ pub fn get_class_extra_docs(class_name: &TyName) -> Option<&'static str> {`
`325`	`325`	`pub fn get_interface_extra_docs(trait_name: &str) -> Option<&'static str> {`
`326`	`326`	`match trait_name {`
`327`	`327`	`"IScriptExtension" => {`
`328`		- Some("Use this in combination with [`ScriptInstance`][crate::extras::ScriptInstance].")
	`328`	+ Some("Use this in combination with [`ScriptInstance`][crate::tools::ScriptInstance].")
`329`	`329`	`}`
`330`	`330`
`331`	`331`	`_ => None,`