[3.x] Add editor keyboard shortcut for Mono Build solution button

[lewiji]

Related issue: #39633

This adds a keyboard shortcut for the Build button in Godot Mono 3.x. Default is Alt+B (since other suggestions from the issue were taken by the script editor bookmark shortcuts).

This exposes the ED_GET_SHORTCUT function from modules\mono\editor\editor_internal_calls.cpp to the GodotTools C# solution, via a new GodotTools.Internals.Globals function: GodotTools.Internals.Globals::internal_EditorShortcut - allowing the GodotSharpEditor.cs EditorPlugin to retrieve editor shortcuts, which it does to attach a new script_editor/build_mono_solution mono/build_solution shortcut definition to the mono Build button.

I couldn't get these changes to compile against master; firstly I got an error because ShortCut is now Shortcut, but then I got errors related to the mono/editor/code_completion.cpp file (unchanged):

modules\mono\editor\code_completion.cpp(126): error C3536: '<begin>$L1': cannot be used before it is initialized
modules\mono\editor\code_completion.cpp(126): error C3536: '<end>$L1': cannot be used before it is initialized
[Initial build] modules\mono\editor\code_completion.cpp(126): error C2100: illegal indirection
[Initial build] modules\mono\editor\code_completion.cpp(126): error C2440: 'initializing': cannot convert from 'int' to 'const KeyValue<StringName,ProjectSettings::AutoloadInfo> &'
[Initial build] modules\mono\editor\code_completion.cpp(126): note: Reason: cannot convert from 'int' to 'const KeyValue<StringName,ProjectSettings::AutoloadInfo>'
modules\mono\editor\code_completion.cpp(126): note: No constructor could take the source type, or constructor overload resolution was ambiguous

I'm unsure what the status of Mono is in Godot 4? So, I made these changes against 3.x since that's what I'm using, let me know if this needs to be moved to master, and if I need to change anything to do so.

Additionally, I've added the keyboard shortcut under the script_editor shortcut setting group, since that seemed most relevant, however this shortcut will be available even in non-Mono builds; is there a way to conditionally add the shortcut only in a Mono build? Shortcut is now under mono/build_solution settings key.

Cheers.

Bugsquad edit: This closes godotengine/godot-proposals#3197.

[raulsntos]

Additionally, I've added the keyboard shortcut under the script_editor shortcut setting group, since that seemed most relevant, however this shortcut will be available even in non-Mono builds; is there a way to conditionally add the shortcut only in a Mono build?

I think the ED_SHORTCUT should be inside the mono module but I'm not sure where exactly.

[lewiji]

For the implementation of passing ED_SHORTCUT I followed the style of the other methods for getting editor settings, however I only wrote a getter. I assume the function can also set editor shortcuts, allowing the Mono project to add it from C#, though I haven't tried, so I'll look into that; that would indeed solve it.

[raulsntos]

I didn't mean to set the editor shortcut from C#, just to have the ED_SHORTCUT macro inside the modules/mono directory since the shortcut only applies to the mono module.

[lewiji]

I see, for clarity's sake, you mean to move the call to register the shortcut i.e.:

	ED_SHORTCUT("script_editor/build_mono_solution", TTR("Build Mono Solution"), KEY_MASK_ALT | KEY_B);

Into one of the cpp files in modules/mono? And probably it'd be good to change the script_editor category to something more appropriate like mono as well.

[raulsntos]

I see, for clarity's sake, you mean to move the call to register the shortcut into one of the cpp files in modules/mono?

Yes, but I'm not sure where exactly.

And probably it'd be good to change the script_editor category to something more appropriate like mono as well.

I guess that would make sense.

[lewiji]

After a bit of trial and error, I think this is about the right place for it:

https://github.com/godotengine/godot/blob/6841c89e1374c87e857a4da6820194f2ce803ffc/modules/mono/csharp_script.cpp#L1183

At this point the checks for Mono being enabled are done, and the cs editor plugin is about to be enabled. Any later than this in the process, and the plugin will try and lookup the shortcut before it's been registered. I have tested on a non-mono build, and the shortcut doesn't get registered as expected.

I fixed the shortcut hint label:

And the shortcut now sits in a new "mono" category of shortcuts:

I haven't got round to testing it with Godot 4 yet, but I will pull down your fix, @raulsntos, and see what happens, when I get a chance later. Thanks.

[lewiji]

Btw, with my initial PR a review was auto requested from the @godotengine/script-editor group, as the original commit registered the editor shortcut in the script_editor_plugin.cpp file. I've since amended the PR so that the shortcut is added in the mono module - so I think that review request can be removed/dismissed.

[akien-mga]

Thanks!