Move engine::global, engine::utilities, log -> global

Bromeon · Bromeon · commit 27007af0cb7a · 2024-05-26T13:10:21.000+02:00
diff --git a/godot-codegen/src/generator/central_files.rs b/godot-codegen/src/generator/central_files.rs
@@ -113,7 +113,7 @@ pub fn make_core_central_code(api: &ExtensionApi, ctx: &mut Context) -> TokenStr
         /// For global built-in functions, check out the [`utilities` module][crate::engine::utilities].
         ///
         /// See also [Godot docs for `@GlobalScope`](https://docs.godotengine.org/en/stable/classes/class_@globalscope.html#enumerations).
-        pub mod global {
+        pub mod global_enums {
             use crate::sys;
             #( #global_enum_defs )*
         }
diff --git a/godot-codegen/src/generator/utility_functions.rs b/godot-codegen/src/generator/utility_functions.rs
@@ -27,13 +27,6 @@ pub(crate) fn generate_utilities_file(
     let imports = util::make_imports();
 
     let tokens = quote! {
-        //! Global utility functions.
-        //!
-        //! A list of global-scope built-in functions.
-        //! For global enums and constants, check out the [`global` module][crate::engine::global].
-        //!
-        //! See also [Godot docs for `@GlobalScope`](https://docs.godotengine.org/en/stable/classes/class_@globalscope.html#methods).
-
         #imports
 
         #(#utility_fn_defs)*
diff --git a/godot-codegen/src/special_cases/special_cases.rs b/godot-codegen/src/special_cases/special_cases.rs
@@ -37,7 +37,7 @@ pub fn is_class_method_deleted(class_name: &TyName, method: &JsonClassMethod, ct
     }
     
     match (class_name.godot_ty.as_str(), method.name.as_str()) {
-        // Already covered by manual APIs
+        // Already covered by manual APIs.
         //| ("Object", "to_string")
         | ("Object", "get_instance_id")
         
@@ -280,8 +280,19 @@ pub fn is_builtin_type_scalar(name: &str) -> bool {
     name.chars().next().unwrap().is_ascii_lowercase()
 }
 
+#[rustfmt::skip]
 pub fn is_utility_function_deleted(function: &JsonUtilityFunction, ctx: &mut Context) -> bool {
-    codegen_special_cases::is_utility_function_excluded(function, ctx)
+    let hardcoded = match function.name.as_str() {
+        // We have prints manually defined, with (&[Variant]) instead of (Variant, &[Variant]) signature.
+        | "print"
+        | "print_rich"
+        // Should we map str, printt, prints, printerr, printraw manually as well?
+
+        => true, _ => false
+    };
+
+
+    hardcoded || codegen_special_cases::is_utility_function_excluded(function, ctx)
 }
 
 pub fn maybe_rename_class_method<'m>(class_name: &TyName, godot_method_name: &'m str) -> &'m str {
diff --git a/godot-core/src/builtin/meta/mod.rs b/godot-core/src/builtin/meta/mod.rs
@@ -21,7 +21,7 @@ pub use signature::*;
 pub(crate) use godot_convert::convert_error::*;
 
 use crate::builtin::*;
-use crate::engine::global::{self, PropertyHint, PropertyUsageFlags};
+use crate::global::{self, PropertyHint, PropertyUsageFlags};
 use crate::property::Var;
 use crate::property::{Export, PropertyHintInfo};
 use godot_ffi as sys;
diff --git a/godot-core/src/builtin/variant/impls.rs b/godot-core/src/builtin/variant/impls.rs
@@ -10,7 +10,7 @@ use crate::builtin::meta::{
     ArrayElement, FromVariantError, GodotFfiVariant, GodotType, PropertyInfo,
 };
 use crate::builtin::*;
-use crate::engine::global;
+use crate::global;
 use godot_ffi as sys;
 
 // For godot-cpp, see https://github.com/godotengine/godot-cpp/blob/master/include/godot_cpp/core/type_info.hpp.
diff --git a/godot-core/src/engine/io/gfile.rs b/godot-core/src/engine/io/gfile.rs
@@ -7,8 +7,8 @@
 
 use crate::builtin::{real, GString, PackedByteArray, PackedStringArray, Variant};
 use crate::engine::file_access::{CompressionMode, ModeFlags};
-use crate::gen::central::global::Error;
 use crate::gen::classes::FileAccess;
+use crate::global::Error;
 use crate::obj::Gd;
 
 use crate::engine::io::IoError;
diff --git a/godot-core/src/engine/mod.rs b/godot-core/src/engine/mod.rs
@@ -11,9 +11,18 @@ use crate::builtin::GString;
 use crate::obj::{bounds, Bounds, Gd, GodotClass, InstanceId};
 
 // Re-exports of generated symbols
-pub use crate::gen::central::global;
+
+#[deprecated = "Enums have been moved to `godot::global`."]
+pub mod global {
+    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 crate::gen::utilities;
 pub use io::*;
 pub use script_instance::{create_script_instance, ScriptInstance, SiMut};
 
diff --git a/godot-core/src/global/mod.rs b/godot-core/src/global/mod.rs
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) godot-rust; Bromeon and contributors.
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+//! Godot global enums, constants and utility functions.
+//!
+//! See also [Godot docs for `@GlobalScope`](https://docs.godotengine.org/en/stable/classes/class_@globalscope.html#methods).
+
+pub(crate) mod print;
+
+pub use crate::gen::central::global_enums::*;
+pub use crate::gen::utilities::*;
+
+pub use print::*;
diff --git a/godot-core/src/global/print.rs b/godot-core/src/global/print.rs
@@ -82,7 +82,7 @@ macro_rules! godot_script_error {
 #[macro_export]
 macro_rules! godot_print {
     ($fmt:literal $(, $args:expr)* $(,)?) => {
-        $crate::log::print(&[
+        $crate::global::print(&[
             $crate::builtin::Variant::from(
                 format!($fmt $(, $args)*)
             )
@@ -98,7 +98,7 @@ macro_rules! godot_print {
 #[macro_export]
 macro_rules! godot_print_rich {
     ($fmt:literal $(, $args:expr)* $(,)?) => {
-        $crate::log::print_rich(&[
+        $crate::global::print_rich(&[
             $crate::builtin::Variant::from(
                 format!($fmt $(, $args)*)
             )
@@ -111,8 +111,9 @@ pub use crate::{godot_error, godot_print, godot_print_rich, godot_script_error,
 use crate::builtin::{StringName, Variant};
 use crate::sys::{self, GodotFfi};
 
-#[doc(hidden)]
-/// Prints to the Godot console, used by the [`godot_print!`] macro.
+/// Prints to the Godot console (raw variant args).
+///
+/// Typically, you'd want to use the [`godot_print!`] macro instead, which uses this function internally.
 pub fn print(varargs: &[Variant]) {
     unsafe {
         let method_name = StringName::from("print");
@@ -135,8 +136,9 @@ pub fn print(varargs: &[Variant]) {
     // crate::engine::utilities::print(head, rest);
 }
 
-#[doc(hidden)]
-/// Prints to the Godot console, used by the [`godot_print_rich!`] macro.
+/// Prints rich text to the Godot console (raw variant args).
+///
+/// Typically, you'd want to use the [`godot_print_rich!`] macro instead, which uses this function internally.
 pub fn print_rich(varargs: &[Variant]) {
     unsafe {
         let method_name = StringName::from("print_rich");
diff --git a/godot-core/src/lib.rs b/godot-core/src/lib.rs
@@ -10,10 +10,15 @@ mod storage;
 
 pub mod builder;
 pub mod builtin;
+pub mod global;
 pub mod init;
-pub mod log;
 pub mod obj;
 
+#[deprecated = "Print macros have been moved to `godot::global`."]
+pub mod log {
+    pub use crate::global::print::*;
+}
+
 #[doc(hidden)]
 #[path = "deprecated.rs"]
 pub mod __deprecated;
diff --git a/godot-core/src/private.rs b/godot-core/src/private.rs
@@ -5,20 +5,20 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-use std::collections::HashMap;
-use std::sync::{atomic, Arc, Mutex};
-
-use godot_ffi::Global;
-pub use sys::out;
-
 #[cfg(feature = "trace")]
 pub use crate::builtin::meta::trace;
-use crate::builtin::meta::{CallContext, CallError};
 pub use crate::gen::classes::class_macros;
 pub use crate::obj::rtti::ObjectRtti;
 pub use crate::registry::{callbacks, ClassPlugin, ErasedRegisterFn, PluginItem};
 pub use crate::storage::{as_storage, Storage};
-use crate::{log, sys};
+pub use sys::out;
+
+use crate::builtin::meta::{CallContext, CallError};
+use crate::global::godot_error;
+use crate::sys;
+use std::collections::HashMap;
+use std::sync::{atomic, Arc, Mutex};
+use sys::Global;
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Global variables
@@ -72,14 +72,14 @@ pub(crate) fn call_error_remove(in_error: &sys::GDExtensionCallError) -> Option<
     // Error checks are just quality-of-life diagnostic; do not throw panics if they fail.
 
     if in_error.error != sys::GODOT_RUST_CUSTOM_CALL_ERROR {
-        log::godot_error!("Tried to remove non-godot-rust call error {in_error:?}");
+        godot_error!("Tried to remove non-godot-rust call error {in_error:?}");
         return None;
     }
 
     let call_error = CALL_ERRORS.lock().remove(in_error.argument);
     if call_error.is_none() {
         // Just a quality-of-life diagnostic; do not throw panics if something like this fails.
-        log::godot_error!("Failed to remove call error {in_error:?}");
+        godot_error!("Failed to remove call error {in_error:?}");
     }
 
     call_error
@@ -243,7 +243,7 @@ pub fn handle_varcall_panic<F, R>(
     // TODO Level 1 is not yet set, so this will always print if level != 0. Needs better logic to recognize try_* calls and avoid printing.
     // But a bit tricky with multiple threads and re-entrancy; maybe pass in info in error struct.
     if has_error_print_level(2) {
-        log::godot_error!("{call_error}");
+        godot_error!("{call_error}");
     }
 
     out_err.error = sys::GODOT_RUST_CUSTOM_CALL_ERROR;
@@ -292,7 +292,7 @@ where
             let info = guard.as_ref().expect("no panic info available");
 
             if print {
-                log::godot_error!(
+                godot_error!(
                     "Rust function panicked at {}:{}.\n  Context: {}",
                     info.file,
                     info.line,
@@ -305,7 +305,7 @@ where
             let msg = format_panic_message(msg);
 
             if print {
-                log::godot_error!("{msg}");
+                godot_error!("{msg}");
             }
 
             Err(msg)
diff --git a/godot/src/lib.rs b/godot/src/lib.rs
@@ -223,7 +223,10 @@ const _: () = _validate_features();
 // Modules
 
 #[doc(inline)]
-pub use godot_core::{builtin, engine, log, obj};
+pub use godot_core::{builtin, engine, global, obj};
+
+#[allow(deprecated)]
+pub use godot_core::log;
 
 #[doc(hidden)]
 pub use godot_core::sys;
diff --git a/godot/src/prelude.rs b/godot/src/prelude.rs
@@ -15,12 +15,17 @@ pub use super::builtin::math::FloatExt as _;
 pub use super::builtin::meta::{FromGodot, ToGodot};
 
 pub use super::engine::{
-    load, try_load, utilities, AudioStreamPlayer, Camera2D, Camera3D, GFile, IAudioStreamPlayer,
-    ICamera2D, ICamera3D, INode, INode2D, INode3D, IObject, IPackedScene, IRefCounted, IResource,
-    ISceneTree, Input, Node, Node2D, Node3D, Object, PackedScene, RefCounted, Resource, SceneTree,
+    load, try_load, AudioStreamPlayer, Camera2D, Camera3D, GFile, IAudioStreamPlayer, ICamera2D,
+    ICamera3D, INode, INode2D, INode3D, IObject, IPackedScene, IRefCounted, IResource, ISceneTree,
+    Input, Node, Node2D, Node3D, Object, PackedScene, RefCounted, Resource, SceneTree,
 };
+pub use super::global::{
+    godot_error, godot_print, godot_print_rich, godot_script_error, godot_warn, EulerOrder, Side,
+    VariantOperator,
+};
+/* ProjectionEye etc */
+
 pub use super::init::{gdextension, ExtensionLibrary, InitLevel};
-pub use super::log::*;
 pub use super::obj::{Base, Gd, GdMut, GdRef, GodotClass, Inherits, InstanceId, OnReady};
 
 // Make trait methods available.
diff --git a/itest/rust/src/engine_tests/node_test.rs b/itest/rust/src/engine_tests/node_test.rs
@@ -8,7 +8,8 @@
 use std::str::FromStr;
 
 use godot::builtin::{NodePath, Variant};
-use godot::engine::{global, Node, Node3D, PackedScene, SceneTree};
+use godot::engine::{Node, Node3D, PackedScene, SceneTree};
+use godot::global;
 use godot::obj::{NewAlloc, NewGd};
 
 use crate::framework::{itest, TestContext};
diff --git a/itest/rust/src/engine_tests/utilities_test.rs b/itest/rust/src/engine_tests/utilities_test.rs
@@ -8,7 +8,7 @@
 use crate::framework::itest;
 
 use godot::builtin::Variant;
-use godot::engine::utilities::*;
+use godot::global::*;
 
 #[itest]
 fn utilities_abs() {

Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ pub fn make_core_central_code(api: &ExtensionApi, ctx: &mut Context) -> TokenStr`
`113`	`113`	/// For global built-in functions, check out the [`utilities` module][crate::engine::utilities].
`114`	`114`	`///`
`115`	`115`	/// See also [Godot docs for `@GlobalScope`](https://docs.godotengine.org/en/stable/classes/class_@globalscope.html#enumerations).
`116`		`- pub mod global {`
	`116`	`+ pub mod global_enums {`
`117`	`117`	`use crate::sys;`
`118`	`118`	`#( #global_enum_defs )*`
`119`	`119`	`}`