Implement EditorExtensionSourceCodePlugin

This plugin can provide source-code editing capabilities for GDExtension classes, such as:

- Providing the path to source code files so they can be opened by the editor.
- Opening source code files in external editors.
- Creating class source code files.
- Providing templates to use when creating source code files.
- Editing class source code files to add callback methods when connecting signals to a non-existent method.

Author: raulsntos

core/object/object.h

@@ -874,6 +874,22 @@ class Object {
 
 	StringName get_class_name_for_extension(const GDExtension *p_library) const;
 
+#ifdef TOOLS_ENABLED
+	const StringName get_extension_class_name() const {
+		if (_extension != nullptr) {
+			return _extension->class_name;
+		}
+		return StringName();
+	}
+
+	const GDExtension *get_extension_library() const {
+		if (_extension != nullptr) {
+			return _extension->library;
+		}
+		return nullptr;
+	}
+#endif
+
 	/* IAPI */
 
 	void set(const StringName &p_name, const Variant &p_value, bool *r_valid = nullptr);

doc/classes/EditorExtensionSourceCodePlugin.xml

@@ -487,6 +487,13 @@
 				See [method add_inspector_plugin] for an example of how to register a plugin.
 			</description>
 		</method>
+		<method name="add_extension_source_code_plugin">
+			<return type="void" />
+			<param index="0" name="plugin" type="EditorExtensionSourceCodePlugin" />
+			<description>
+				Registers a new [EditorExtensionSourceCodePlugin]. Source code plugins are used to provide source code editing capabilities to GDExtension classes.
+			</description>
+		</method>
 		<method name="add_import_plugin">
 			<return type="void" />
 			<param index="0" name="importer" type="EditorImportPlugin" />
@@ -705,6 +712,13 @@
 				Removes an export plugin registered by [method add_export_plugin].
 			</description>
 		</method>
+		<method name="remove_extension_source_code_plugin">
+			<return type="void" />
+			<param index="0" name="plugin" type="EditorExtensionSourceCodePlugin" />
+			<description>
+				Removes a source code plugin registered by [method add_extension_source_code_plugin].
+			</description>
+		</method>
 		<method name="remove_import_plugin">
 			<return type="void" />
 			<param index="0" name="importer" type="EditorImportPlugin" />

doc/classes/EditorPlugin.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="ValidationContext" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<methods>
+		<method name="add_validation">
+			<return type="void" />
+			<param index="0" name="severity" type="int" enum="ValidationContext.ValidationSeverity" />
+			<param index="1" name="message" type="String" />
+			<description>
+				Report a validation issue with the given [param message] at the specified [param severity] level. If any of the messages are reported at the error level, the validation context will be marked as invalid.
+			</description>
+		</method>
+	</methods>
+	<constants>
+		<constant name="VALIDATION_SEVERITY_INFO" value="0" enum="ValidationSeverity">
+			The message contains informational content that needs to be displayed to the user but does not indicate a problem.
+		</constant>
+		<constant name="VALIDATION_SEVERITY_WARNING" value="1" enum="ValidationSeverity">
+			The message contains a warning about a potential issue that should be looked at, but is not necessarily an error.
+		</constant>
+		<constant name="VALIDATION_SEVERITY_ERROR" value="2" enum="ValidationSeverity">
+			The message indicates an error that needs to be addressed.
+		</constant>
+	</constants>
+</class>

doc/classes/ValidationContext.xml

@@ -80,6 +80,7 @@ if env.editor_build:
     SConscript("debugger/SCsub")
     SConscript("doc/SCsub")
     SConscript("docks/SCsub")
+    SConscript("extension/SCsub")
     SConscript("export/SCsub")
     SConscript("file_system/SCsub")
     SConscript("gui/SCsub")

editor/SCsub

@@ -43,6 +43,7 @@
 #include "editor/editor_node.h"
 #include "editor/editor_string_names.h"
 #include "editor/editor_undo_redo_manager.h"
+#include "editor/extension/extension_source_code_manager.h"
 #include "editor/gui/create_dialog.h"
 #include "editor/gui/directory_create_dialog.h"
 #include "editor/gui/editor_dir_dialog.h"
@@ -2572,6 +2573,15 @@ void FileSystemDock::_file_option(int p_option, const Vector<String> &p_selected
 			make_script_dialog->popup_centered();
 		} break;
 
+		case FILE_MENU_NEW_EXTENSION_CLASS: {
+			String fpath = current_path;
+			if (!fpath.ends_with("/")) {
+				fpath = fpath.get_base_dir();
+			}
+			make_extension_class_dialog->config("Node", fpath);
+			make_extension_class_dialog->popup_centered();
+		} break;
+
 		case FILE_MENU_COPY_PATH: {
 			if (!p_selected.is_empty()) {
 				const String &fpath = p_selected[0];
@@ -3336,6 +3346,12 @@ void FileSystemDock::_file_and_folders_fill_popup(PopupMenu *p_popup, const Vect
 		new_menu->add_icon_item(get_editor_theme_icon(SNAME("Folder")), TTRC("Folder..."), FILE_MENU_NEW_FOLDER);
 		new_menu->add_icon_item(get_editor_theme_icon(SNAME("PackedScene")), TTRC("Scene..."), FILE_MENU_NEW_SCENE);
 		new_menu->add_icon_item(get_editor_theme_icon(SNAME("Script")), TTRC("Script..."), FILE_MENU_NEW_SCRIPT);
+		new_menu->add_icon_item(get_editor_theme_icon(SNAME("ExtensionClass")), TTRC("Extension class..."), FILE_MENU_NEW_EXTENSION_CLASS);
+		if (!ExtensionSourceCodeManager::get_singleton()->has_plugins_that_can_create_class_source()) {
+			int item_idx = new_menu->get_item_count() - 1;
+			new_menu->set_item_disabled(item_idx, true);
+			new_menu->set_item_tooltip(item_idx, "No extension source code plugins available.");
+		}
 		new_menu->add_icon_item(get_editor_theme_icon(SNAME("Object")), TTRC("Resource..."), FILE_MENU_NEW_RESOURCE);
 		new_menu->add_icon_item(get_editor_theme_icon(SNAME("TextFile")), TTRC("TextFile..."), FILE_MENU_NEW_TEXTFILE);
 
@@ -3560,6 +3576,12 @@ void FileSystemDock::_tree_empty_click(const Vector2 &p_pos, MouseButton p_butto
 	tree_popup->add_icon_item(get_editor_theme_icon(SNAME("Folder")), TTRC("New Folder..."), FILE_MENU_NEW_FOLDER);
 	tree_popup->add_icon_item(get_editor_theme_icon(SNAME("PackedScene")), TTRC("New Scene..."), FILE_MENU_NEW_SCENE);
 	tree_popup->add_icon_item(get_editor_theme_icon(SNAME("Script")), TTRC("New Script..."), FILE_MENU_NEW_SCRIPT);
+	tree_popup->add_icon_item(get_editor_theme_icon(SNAME("ExtensionClass")), TTRC("Extension class..."), FILE_MENU_NEW_EXTENSION_CLASS);
+	if (!ExtensionSourceCodeManager::get_singleton()->has_plugins_that_can_create_class_source()) {
+		int item_idx = tree_popup->get_item_count() - 1;
+		tree_popup->set_item_disabled(item_idx, true);
+		tree_popup->set_item_tooltip(item_idx, "No extension source code plugins available.");
+	}
 	tree_popup->add_icon_item(get_editor_theme_icon(SNAME("Object")), TTRC("New Resource..."), FILE_MENU_NEW_RESOURCE);
 	tree_popup->add_icon_item(get_editor_theme_icon(SNAME("TextFile")), TTRC("New TextFile..."), FILE_MENU_NEW_TEXTFILE);
 	// To keep consistency with options added to "Create New..." menu (for plugin which has slot as CONTEXT_SLOT_FILESYSTEM_CREATE).
@@ -3637,6 +3659,12 @@ void FileSystemDock::_file_list_empty_clicked(const Vector2 &p_pos, MouseButton
 	file_list_popup->add_icon_item(get_editor_theme_icon(SNAME("Folder")), TTRC("New Folder..."), FILE_MENU_NEW_FOLDER);
 	file_list_popup->add_icon_item(get_editor_theme_icon(SNAME("PackedScene")), TTRC("New Scene..."), FILE_MENU_NEW_SCENE);
 	file_list_popup->add_icon_item(get_editor_theme_icon(SNAME("Script")), TTRC("New Script..."), FILE_MENU_NEW_SCRIPT);
+	file_list_popup->add_icon_item(get_editor_theme_icon(SNAME("ExtensionClass")), TTRC("Extension class..."), FILE_MENU_NEW_EXTENSION_CLASS);
+	if (!ExtensionSourceCodeManager::get_singleton()->has_plugins_that_can_create_class_source()) {
+		int item_idx = file_list_popup->get_item_count() - 1;
+		file_list_popup->set_item_disabled(item_idx, true);
+		file_list_popup->set_item_tooltip(item_idx, "No extension source code plugins available.");
+	}
 	file_list_popup->add_icon_item(get_editor_theme_icon(SNAME("Object")), TTRC("New Resource..."), FILE_MENU_NEW_RESOURCE);
 	file_list_popup->add_icon_item(get_editor_theme_icon(SNAME("TextFile")), TTRC("New TextFile..."), FILE_MENU_NEW_TEXTFILE);
 	// To keep consistency with options added to "Create New..." menu (for plugin which has slot as CONTEXT_SLOT_FILESYSTEM_CREATE).
@@ -4371,6 +4399,10 @@ FileSystemDock::FileSystemDock() {
 	make_script_dialog->set_title(TTRC("Create Script"));
 	add_child(make_script_dialog);
 
+	make_extension_class_dialog = memnew(ExtensionClassCreateDialog);
+	make_extension_class_dialog->set_title(TTRC("Create Extension Class"));
+	add_child(make_extension_class_dialog);
+
 	make_shader_dialog = memnew(ShaderCreateDialog);
 	add_child(make_shader_dialog);
 

editor/docks/filesystem_dock.cpp

@@ -31,6 +31,7 @@
 #pragma once
 
 #include "editor/docks/editor_dock.h"
+#include "editor/extension/extension_class_create_dialog.h"
 #include "editor/file_system/dependency_editor.h"
 #include "editor/file_system/editor_file_system.h"
 #include "editor/file_system/file_info.h"
@@ -131,6 +132,7 @@ class FileSystemDock : public EditorDock {
 		FILE_MENU_NEW_TEXTFILE,
 		FILE_MENU_NEW_FOLDER,
 		FILE_MENU_NEW_SCRIPT,
+		FILE_MENU_NEW_EXTENSION_CLASS,
 		FILE_MENU_NEW_SCENE,
 		FILE_MENU_RUN_SCRIPT,
 		FILE_MENU_MAX,
@@ -202,6 +204,7 @@ class FileSystemDock : public EditorDock {
 
 	SceneCreateDialog *make_scene_dialog = nullptr;
 	ScriptCreateDialog *make_script_dialog = nullptr;
+	ExtensionClassCreateDialog *make_extension_class_dialog = nullptr;
 	ShaderCreateDialog *make_shader_dialog = nullptr;
 	CreateDialog *new_resource_dialog = nullptr;
 

editor/docks/filesystem_dock.h

@@ -100,6 +100,7 @@
 #include "editor/export/project_zip_packer.h"
 #include "editor/export/register_exporters.h"
 #include "editor/export/shader_baker_export_plugin.h"
+#include "editor/extension/extension_source_code_manager.h"
 #include "editor/file_system/dependency_editor.h"
 #include "editor/file_system/editor_paths.h"
 #include "editor/gui/editor_about.h"
@@ -7842,6 +7843,8 @@ EditorNode::EditorNode() {
 
 	EditorContextMenuPluginManager::create();
 
+	ExtensionSourceCodeManager::create();
+
 	// Used for previews.
 	FileDialog::set_get_icon_callback(callable_mp_static(_file_dialog_get_icon));
 	FileDialog::set_get_thumbnail_callback(callable_mp_static(_file_dialog_get_thumbnail));
@@ -8916,6 +8919,7 @@ EditorNode::~EditorNode() {
 	EditorTranslationParser::get_singleton()->clean_parsers();
 	ResourceImporterScene::clean_up_importer_plugins();
 	EditorContextMenuPluginManager::cleanup();
+	ExtensionSourceCodeManager::cleanup();
 
 	remove_print_handler(&print_handler);
 	EditorHelp::cleanup_doc();

editor/editor_node.cpp

@@ -0,0 +1,6 @@
+#!/usr/bin/env python
+from misc.utility.scons_hints import *
+
+Import("env")
+
+env.add_source_files(env.editor_sources, "*.cpp")