Add editor plugins, and registration of classes at the proper initialization level #393

lilizoey · 2023-09-03T15:05:50Z

Editor Plugin

Adds editor_plugin as another attribute for classes. See here for usage.

The project will fail to compile if you try to make something an editor plugin that doesn't inherit from EditorPlugin. This is done by adding a doc-hidden constant to Inherits and trying to access it.

Attempting to register an editor plugin in Godot 4.0 will print an error, and not add the editor plugin. Since this feature was added in 4.1.

Class registration

This is needed for editor plugin registration to work, as editor plugins must be registered at the Editor level. GodotClass now has an INIT_LEVEL constant which states the level at which a class is registered, and thus which level its subclasses must also be registered.

If an engine class has an unknown init level, the library panics. Which should be fine since it means something has gone very wrong. However user-classes just do an godot_error and fail to register, since that might be user-error and making godot crash for that would probably be more frustrating than anything else.

Other smaller things

I found some more classes that only exist for WASM/Android so i added them to be excluded, you can't inherit from them anyway.

Unexcluded ProjectSettings, it seems to have been excluded by mistake. I also added a test just to ensure that it actually does work.

I didn't find a good way of testing editor plugins. They require the editor to be running, and we dont have any way to test stuff that only runs in the editor afaik.

GodotRust · 2023-09-03T15:12:41Z

API docs are being generated and will be shortly available at: https://godot-rust.github.io/docs/gdext/pr-393

Bromeon

Quite a few people have requested this, thanks a lot for coming up with a PR! 😊

Instead of a runtime check, could we create a compile error (aka bail) if the user specifies #[class(editor_plugin)] while under Godot < 4.1?

godot-core/src/registry.rs

godot-codegen/src/codegen_special_cases.rs

Bromeon · 2023-09-10T17:22:30Z

godot-codegen/src/special_cases.rs

+        // Only on Android.
+        | "JavaClassWrapper"
+        | "JNISingleton"
+        | "JavaClass"
+        // Only on WASM.
+        | "JavaScriptBridge"
+        | "JavaScriptObject"


Oh nice, how did you find those classes? It looks like their presence didn't trigger an error (even now with full-ci checking everything)?

I made a script to write a file that made a class inheriting from every single class in the gdextension api. some classes crashed on startup because i assume they're not meant to be extended (like AudioServer), but these threw an error because they werent available.

godot-core/src/obj/traits.rs

Bromeon · 2023-09-10T17:33:36Z

godot-macros/src/class/derive_godot_class.rs

+            impl #class_name {
+                #[doc(hidden)]
+                const __INHERITS_EDITOR_PLUGIN: () = <#class_name as ::godot::obj::Inherits<::godot::engine::EditorPlugin>>::INHERITS;
+            }


In another place, we have used a slightly different idiom to ensure a trait bound at compile time (although currently commented-out):

fn __static_type_check() { enforce_sync::<InstanceStorage<T>>(); } fn enforce_sync<T: Sync>() {}

Do you see any advantages of one vs. the other idiom?

Maybe it makes sense to do generalize this to something like static_assert_bounds!(Type : Bounds); or so? Although a macro might just put more load on the codegen 🤔

I don't really think there's a big difference either way. Though this one is more discoverable at least. I couldn't quite find a place this had been done before. I can change to doing it that way.

Would be nice, just so we use same technique to achieve the same thing 🙂 we can of course discuss/change that at any time, if we find one approach works better.

lilizoey · 2023-09-11T08:39:08Z

Instead of a runtime check, could we create a compile error (aka bail) if the user specifies #[class(editor_plugin)] while under Godot < 4.1?

Sure, i can also make the EditorPlugin class plugin only exist during godot 4.1+.

Bromeon · 2023-09-16T10:59:53Z

One minor thing + conflict, also this is still open:

Instead of a runtime check, could we create a compile error (aka bail) if the user specifies #[class(editor_plugin)] while under Godot < 4.1?

Would be nice to protect against non-functional attribute keys directly in the proc-macro API.

After that, should be ready 🙂

lilizoey · 2023-09-16T15:43:19Z

godot-macros/src/class/derive_godot_class.rs

+        if let Some(editor_plugin) = parser.handle_alone_ident("editor_plugin")? {
+            if cfg!(before_api = "4.1") {
+                return bail!(
+                    editor_plugin,
+                    "Editor plugins are not supported in Godot 4.0"
+                );
+            }
+
+            is_editor_plugin = true;
+        }


@Bromeon i did make it bail if you try to use it before godot 4.1

Ah, right, I was confused by this code:

#[cfg(before_api = "4.1")] assert!(!info.is_editor_plugin);

But that's then only to double-check that. Makes sense.

Require that editor plugins inherit from `EditorPlugin` Make classes get registered at the base class's init level Unexclude `ProjectSettings`, since it isn't experimental

Bromeon

Thanks a lot! Don't hesitate to split unrelated changes into separate commits, but that's definitely not a blocker now 😊

lilizoey force-pushed the feature/editor-plugin branch 5 times, most recently from dc6abca to 7c59a28 Compare September 8, 2023 14:08

lilizoey changed the title ~~Add a way to declare editor plugins~~ Add editor plugins, and registration of classes at the proper initialization level Sep 8, 2023

lilizoey marked this pull request as ready for review September 8, 2023 14:20

lilizoey force-pushed the feature/editor-plugin branch from 7c59a28 to c60afa6 Compare September 8, 2023 14:23

lilizoey requested a review from Bromeon September 8, 2023 14:27

Bromeon reviewed Sep 10, 2023

View reviewed changes

Bromeon added feature Adds functionality to the library c: register Register classes, functions and other symbols to GDScript labels Sep 10, 2023

lilizoey force-pushed the feature/editor-plugin branch 2 times, most recently from ee4b8eb to 5bd20d3 Compare September 11, 2023 09:35

Bromeon linked an issue Sep 11, 2023 that may be closed by this pull request

Allow creating editor plugins #333

Closed

lilizoey commented Sep 16, 2023

View reviewed changes

lilizoey force-pushed the feature/editor-plugin branch 3 times, most recently from fd3ccd6 to 06ba63f Compare September 23, 2023 13:40

Add editor_plugin as an option for godot classes

e05dc40

Require that editor plugins inherit from `EditorPlugin` Make classes get registered at the base class's init level Unexclude `ProjectSettings`, since it isn't experimental

lilizoey force-pushed the feature/editor-plugin branch from 06ba63f to e05dc40 Compare September 23, 2023 14:11

Bromeon approved these changes Sep 23, 2023

View reviewed changes

Bromeon added this pull request to the merge queue Sep 23, 2023

Merged via the queue into godot-rust:master with commit a538aca Sep 23, 2023
14 checks passed

Bromeon mentioned this pull request Sep 24, 2023

Allow different class names in rust and Godot #419

Merged

Bromeon mentioned this pull request Aug 11, 2024

Validate that editor plugin classes require #[class(tool)] #852

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add editor plugins, and registration of classes at the proper initialization level #393

Add editor plugins, and registration of classes at the proper initialization level #393

lilizoey commented Sep 3, 2023 •

edited

Loading

GodotRust commented Sep 3, 2023

Bromeon left a comment

Bromeon Sep 10, 2023

lilizoey Sep 11, 2023

Bromeon Sep 10, 2023

lilizoey Sep 11, 2023

Bromeon Sep 16, 2023

lilizoey commented Sep 11, 2023

Bromeon commented Sep 16, 2023

lilizoey Sep 16, 2023

Bromeon Sep 16, 2023

Bromeon left a comment

Add editor plugins, and registration of classes at the proper initialization level #393

Add editor plugins, and registration of classes at the proper initialization level #393

Conversation

lilizoey commented Sep 3, 2023 • edited Loading

Editor Plugin

Class registration

Other smaller things

GodotRust commented Sep 3, 2023

Bromeon left a comment

Choose a reason for hiding this comment

Bromeon Sep 10, 2023

Choose a reason for hiding this comment

lilizoey Sep 11, 2023

Choose a reason for hiding this comment

Bromeon Sep 10, 2023

Choose a reason for hiding this comment

lilizoey Sep 11, 2023

Choose a reason for hiding this comment

Bromeon Sep 16, 2023

Choose a reason for hiding this comment

lilizoey commented Sep 11, 2023

Bromeon commented Sep 16, 2023

lilizoey Sep 16, 2023

Choose a reason for hiding this comment

Bromeon Sep 16, 2023

Choose a reason for hiding this comment

Bromeon left a comment

Choose a reason for hiding this comment

lilizoey commented Sep 3, 2023 •

edited

Loading