Merge pull request #1099 from godot-rust/qol/reduce-minimal-classes

Reduce number of classes in minimal codegen

Author: Bromeon

.github/composite/godot-itest/action.yml

@@ -142,9 +142,10 @@ runs:
           targetArgs="--target $TARGET"
         fi
         
+        # Keep `--no-default-features` even if it's currently redundant. Features may change.
         cargo build -p itest --no-default-features ${{ inputs.rust-extra-args }} $targetArgs
         
-        # Instead of modifying .gdextension, rename the output directory
+        # Instead of modifying .gdextension, rename the output directory.
         if [[ -n "$TARGET" ]]; then
           rm -rf target/debug
           mv target/$TARGET/debug target

.github/workflows/full-ci.yml

@@ -332,6 +332,7 @@ jobs:
             os: ubuntu-22.04
             artifact-name: linux-nightly
             godot-binary: godot.linuxbsd.editor.dev.x86_64
+            # Important to keep both experimental-threads and codegen-full. Some itests (native_st_audio) require both.
             rust-extra-args: --features itest/experimental-threads,itest/codegen-full-experimental,godot/api-custom,godot/serde,itest/register-docs
 
           - name: linux-release

godot-codegen/src/context.rs

@@ -114,8 +114,12 @@ impl<'a> Context<'a> {
                     break;
                 }
             }
-            let (nearest_index, nearest_enum_name) =
-                nearest.expect("at least one base must have notifications");
+            let (nearest_index, nearest_enum_name) = nearest.unwrap_or_else(|| {
+                panic!(
+                    "class {}: at least one base must have notifications; possibly, its direct base has been removed from minimal codegen",
+                    class_name.godot_ty
+                )
+            });
 
             // For all bases inheriting most-derived base that has notification constants, reuse the type name.
             for i in (0..nearest_index).rev() {

godot-codegen/src/generator/native_structures.rs

@@ -9,7 +9,7 @@ use crate::context::Context;
 use crate::generator::builtins;
 use crate::models::domain::{ExtensionApi, ModName, NativeStructure, TyName};
 use crate::util::ident;
-use crate::{conv, util, SubmitFn};
+use crate::{conv, special_cases, util, SubmitFn};
 use proc_macro2::TokenStream;
 use quote::{format_ident, quote};
 use std::path::Path;
@@ -25,6 +25,11 @@ pub fn generate_native_structures_files(
 
     let mut modules = vec![];
     for native_structure in api.native_structures.iter() {
+        // Some may be excluded in minimal codegen, because they hold codegen-excluded classes as fields.
+        if special_cases::is_native_struct_excluded(&native_structure.name) {
+            continue;
+        }
+
         let module_name = ModName::from_godot(&native_structure.name);
         let class_name = TyName::from_godot(&native_structure.name);
 
@@ -232,10 +237,11 @@ fn make_native_structure_field_and_accessor(
     (field_def, accessor)
 }
 
+/// Native structures use a different format for enums than the rest of the JSON file.
+/// If we detect a scoped field, convert it to the enum format expected by to_rust_type().
+///
+/// Example: `TextServer::Direction` -> `enum::TextServer.Direction`.
 fn normalize_native_structure_field_type(field_type: &str) -> String {
-    // native_structures uses a different format for enums than the
-    // rest of the JSON file. If we detect a scoped field, convert it
-    // to the enum format expected by to_rust_type.
     if field_type.contains("::") {
         let with_dot = field_type.replace("::", ".");
         format!("enum::{}", with_dot)

godot-codegen/src/special_cases/codegen_special_cases.rs

@@ -34,6 +34,16 @@ pub(crate) fn is_class_excluded(_godot_class_name: &str) -> bool {
     false
 }
 
+#[cfg(not(feature = "codegen-full"))]
+pub(crate) fn is_native_struct_excluded(native_struct: &str) -> bool {
+    native_struct == "CaretInfo"
+}
+
+#[cfg(feature = "codegen-full")]
+pub(crate) fn is_native_struct_excluded(_native_struct: &str) -> bool {
+    false
+}
+
 #[cfg(not(feature = "codegen-full"))]
 fn is_type_excluded(ty: &str, ctx: &mut Context) -> bool {
     use crate::conv;
@@ -122,69 +132,62 @@ pub(crate) fn is_utility_function_excluded(
 // Classes for minimal config
 #[cfg(not(feature = "codegen-full"))]
 const SELECTED_CLASSES: &[&str] = &[
-    "AnimatedSprite2D",
-    "Area2D",
-    "ArrayMesh",
-    "AudioStreamPlayer",
-    "BaseButton",
-    "BoxMesh",
-    "Button",
-    "Camera2D",
-    "Camera3D",
-    "CanvasItem",
-    "CanvasLayer",
-    "ClassDB",
-    "CollisionObject2D",
-    "CollisionShape2D",
-    "Control",
-    "EditorPlugin",
-    "EditorExportPlugin",
-    "Engine",
-    "FileAccess",
-    "GDScript",
-    "HTTPRequest",
-    "Image",
-    "ImageTextureLayered",
-    "Input",
-    "InputEvent",
-    "InputEventAction",
-    "Label",
-    "MainLoop",
-    "Marker2D",
-    "Mesh",
+    // Core class hierarchy
+    "Object",
     "Node",
+    "CanvasItem", // base of Node2D
     "Node2D",
     "Node3D",
-    "Node3DGizmo",
-    "Object",
-    "OS",
-    "PackedScene",
-    "PathFollow2D",
-    "PhysicsBody2D",
-    "PrimitiveMesh",
     "RefCounted",
-    "RenderingServer",
     "Resource",
-    "ResourceFormatLoader",
+    //
+    // Runtime + reflection support
+    "ClassDB",
+    "Engine",
+    "OS",
+    //
+    // Editor plugins
+    "EditorPlugin",
+    "EditorExportPlugin",
+    //
+    // I/O and save/load
     "ResourceLoader",
     "ResourceSaver",
-    "RigidBody2D",
+    "FileAccess",
+    //
+    // Scene (node_test, rpc_test)
+    "MainLoop", // base of SceneTree
     "SceneTree",
-    "SceneTreeTimer",
+    //
+    // Script instances
     "Script",
     "ScriptExtension",
     "ScriptNameCasing",
     "ScriptLanguage",
     "ScriptLanguageExtension",
-    "Sprite2D",
-    "SpriteFrames",
-    "TextServer",
-    "TextServerExtension",
+    "GDScript",
+    //
+    // Example resources
+    "PackedScene", // manual_extensions
     "Texture",
-    "Texture2DArray",
-    "TextureLayered",
-    "Time",
-    "Timer",
+    //
+    // Meshes (virtual_methods_test)
+    "Mesh",
+    "ArrayMesh", // enum_test, 1 case, but small API
+    "PrimitiveMesh",
+    //
+    // Windowing + Input (virtual_methods_test)
     "Viewport",
     "Window",
+    "Input",
+    "InputEvent",
+    "InputEventAction",
+    //
+    // Godot servers (for RID support)
+    "RenderingServer",
+    //
+    // Misc
+    "Time", // usage: enum_test.enum_hash()
+    "HTTPRequest",
+    "ResourceFormatLoader", // TODO: replace?
 ];

godot-codegen/src/special_cases/special_cases.rs

@@ -89,6 +89,11 @@ pub fn is_class_deleted(class_name: &TyName) -> bool {
         || is_godot_type_deleted(&class_name.godot_ty)
 }
 
+/// Native-struct types excluded in minimal codegen, because they hold codegen-excluded classes as fields.
+pub fn is_native_struct_excluded(ty: &str) -> bool {
+    codegen_special_cases::is_native_struct_excluded(ty)
+}
+
 pub fn is_godot_type_deleted(godot_ty: &str) -> bool {
     // Note: parameter can be a class or builtin name, but also something like "enum::AESContext.Mode".
 

godot/src/prelude.rs

@@ -16,8 +16,7 @@ pub use super::meta::error::{ConvertError, IoError};
 pub use super::meta::{FromGodot, GodotConvert, ToGodot};
 
 pub use super::classes::{
-    AudioStreamPlayer, Camera2D, Camera3D, IAudioStreamPlayer, ICamera2D, ICamera3D, INode,
-    INode2D, INode3D, IObject, IPackedScene, IRefCounted, IResource, ISceneTree, Input, Node,
+    INode, INode2D, INode3D, IObject, IPackedScene, IRefCounted, IResource, ISceneTree, Node,
     Node2D, Node3D, Object, PackedScene, RefCounted, Resource, SceneTree,
 };
 pub use super::global::{

itest/godot/SpecialTests.gd

@@ -18,7 +18,12 @@ extends TestSuiteSpecial
 # testing this at the moment, since we don't have any way to let frames pass in between the start and end of 
 # an integration test. 
 func test_collision_object_2d_input_event():
-	var collision_object := CollisionObject2DTest.new()
+	if not IntegrationTests.is_full_codegen():
+		print("Skip in minimal codegen: test_collision_object_2d_input_event")
+		return
+
+	# Dynamic instantiation, to still parse if Rust class is disabled.
+	var collision_object: Variant = ClassDB.instantiate("CollisionObject2DTest")
 	collision_object.input_pickable = true
 
 	var collision_shape := CollisionShape2D.new()

itest/rust/src/builtin_tests/containers/array_test.rs

@@ -399,9 +399,11 @@ fn untyped_array_return_from_godot_func() {
     assert_eq!(result, varray![child, Variant::nil(), NodePath::default()]);
 }
 
-// TODO All API functions that take a `Array` are even more obscure and not included in
-// `SELECTED_CLASSES`. Decide if this test is worth having `Texture2DArray` and `Image` and their
-// ancestors in the list.
+// Conditional, so we don't need Texture2DArray > ImageTextureLayered > TextureLayered > Texture in minimal codegen.
+// Potential alternatives (search for "typedarray::" in extension_api.json):
+// - ClassDB::class_get_signal_list() -> Array<Dictionary>
+// - Compositor::set_compositor_effects( Array<Gd<Compositor>> )
+#[cfg(feature = "codegen-full-experimental")]
 #[itest]
 fn typed_array_pass_to_godot_func() {
     use godot::classes::image::Format;

itest/rust/src/builtin_tests/containers/callable_test.rs

@@ -586,8 +586,8 @@ pub mod custom_callable {
 
         let eq = match GdextBuild::godot_runtime_version_triple() {
             (4, 1..=3, _) => 1,
-            (4, 4, 0) => 2, // changed in https://github.com/godotengine/godot/pull/96797.
-            _ => 1,         // changed in https://github.com/godotengine/godot/pull/103647.
+            (4, 4, 0..=1) => 2, // changed in https://github.com/godotengine/godot/pull/96797.
+            _ => 1,             // changed in https://github.com/godotengine/godot/pull/103647.
         };
 
         assert_eq!(eq_count(&at), eq, "hash collision, eq for a needed");

itest/rust/src/engine_tests/codegen_test.rs

@@ -10,7 +10,7 @@
 
 use crate::framework::itest;
 use godot::builtin::inner::InnerColor;
-use godot::classes::{FileAccess, HttpRequest, IHttpRequest, Image};
+use godot::classes::{FileAccess, HttpRequest, IHttpRequest, RenderingServer};
 use godot::prelude::*;
 
 #[itest]
@@ -53,7 +53,8 @@ fn codegen_static_class_method() {
 
 #[itest]
 fn codegen_constants() {
-    assert_eq!(Image::MAX_WIDTH, 16777216);
+    assert_eq!(RenderingServer::CANVAS_ITEM_Z_MIN, -4096);
+    //assert_eq!(Image::MAX_WIDTH, 16777216);
     // assert_eq!(Material::RENDER_PRIORITY_MIN, -128);
 }
 

itest/rust/src/engine_tests/mod.rs

@@ -11,10 +11,8 @@ mod codegen_enums_test;
 mod codegen_test;
 mod engine_enum_test;
 mod gfile_test;
-/// Native audio structure tests are only enabled when both the `experimental-threads` and `codegen-full` features are active. The tests
-/// require these features to be able to execute.
-#[cfg(all(feature = "experimental-threads", feature = "codegen-full"))]
-mod native_audio_structures_test;
+mod native_st_niche_audio_test;
+mod native_st_niche_pointer_test;
 mod native_structures_test;
 mod node_test;
 mod save_load_test;

itest/rust/src/engine_tests/native_audio_structures_test.rs renamed to itest/rust/src/engine_tests/native_st_niche_audio_test.rs

@@ -5,6 +5,10 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
+// Requires BOTH full codegen and experimental-threads. The latter would compile without, but crash at runtime.
+// More tests on native structures are in native_structure_full_codegen_tests.rs.
+#![cfg(all(feature = "codegen-full", feature = "experimental-threads"))]
+
 use std::thread;
 use std::time::Duration;