Merge pull request #1138 from dsnopek/editor-plugins-deinitialize

Automatically remove editor plugins when deinitializing GDExtension

Author: akien-mga

binding_generator.py

@@ -1236,6 +1236,9 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
         else:
             result.append(f"#include <godot_cpp/{get_include_path(included)}>")
 
+    if class_name == "EditorPlugin":
+        result.append("#include <godot_cpp/templates/vector.hpp>")
+
     if len(fully_used_classes) > 0:
         result.append("")
 
@@ -1385,17 +1388,23 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
 
     if class_name == "EditorPlugin":
         result.append("class EditorPlugins {")
+        result.append("private:")
+        result.append("\tstatic Vector<StringName> plugin_classes;")
+        result.append("")
         result.append("public:")
+        result.append("\tstatic void add_plugin_class(const StringName &p_class_name);")
+        result.append("\tstatic void remove_plugin_class(const StringName &p_class_name);")
+        result.append("\tstatic void deinitialize(GDExtensionInitializationLevel p_level);")
         result.append("")
 
         result.append("\ttemplate <class T>")
         result.append("\tstatic void add_by_type() {")
-        result.append("\t\tinternal::gdextension_interface_editor_add_plugin(T::get_class_static()._native_ptr());")
+        result.append("\t\tadd_plugin_class(T::get_class_static());")
         result.append("\t}")
 
         result.append("\ttemplate <class T>")
         result.append("\tstatic void remove_by_type() {")
-        result.append("\t\tinternal::gdextension_interface_editor_remove_plugin(T::get_class_static()._native_ptr());")
+        result.append("\t\tremove_plugin_class(T::get_class_static());")
         result.append("\t}")
 
         result.append("};")

src/classes/editor_plugin.cpp

@@ -0,0 +1,61 @@
+/**************************************************************************/
+/*  editor_plugin.cpp                                                     */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* Permission is hereby granted, free of charge, to any person obtaining  */
+/* a copy of this software and associated documentation files (the        */
+/* "Software"), to deal in the Software without restriction, including    */
+/* without limitation the rights to use, copy, modify, merge, publish,    */
+/* distribute, sublicense, and/or sell copies of the Software, and to     */
+/* permit persons to whom the Software is furnished to do so, subject to  */
+/* the following conditions:                                              */
+/*                                                                        */
+/* The above copyright notice and this permission notice shall be         */
+/* included in all copies or substantial portions of the Software.        */
+/*                                                                        */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
+/**************************************************************************/
+
+#include <godot_cpp/classes/editor_plugin.hpp>
+
+#include <godot_cpp/variant/string_name.hpp>
+
+namespace godot {
+
+Vector<StringName> EditorPlugins::plugin_classes;
+
+void EditorPlugins::add_plugin_class(const StringName &p_class_name) {
+	ERR_FAIL_COND_MSG(plugin_classes.find(p_class_name) != -1, vformat("Editor plugin already registered: %s", p_class_name));
+	plugin_classes.push_back(p_class_name);
+	internal::gdextension_interface_editor_add_plugin(p_class_name._native_ptr());
+}
+
+void EditorPlugins::remove_plugin_class(const StringName &p_class_name) {
+	int index = plugin_classes.find(p_class_name);
+	ERR_FAIL_COND_MSG(index == -1, vformat("Editor plugin is not registered: %s", p_class_name));
+	plugin_classes.remove_at(index);
+	internal::gdextension_interface_editor_remove_plugin(p_class_name._native_ptr());
+}
+
+void EditorPlugins::deinitialize(GDExtensionInitializationLevel p_level) {
+	if (p_level == GDEXTENSION_INITIALIZATION_EDITOR) {
+		for (const StringName &class_name : plugin_classes) {
+			internal::gdextension_interface_editor_remove_plugin(class_name._native_ptr());
+		}
+		plugin_classes.clear();
+	}
+}
+
+} // namespace godot

src/godot.cpp

@@ -30,6 +30,7 @@
 
 #include <godot_cpp/godot.hpp>
 
+#include <godot_cpp/classes/editor_plugin.hpp>
 #include <godot_cpp/classes/wrapped.hpp>
 #include <godot_cpp/core/class_db.hpp>
 #include <godot_cpp/core/memory.hpp>
@@ -401,6 +402,7 @@ void GDExtensionBinding::deinitialize_level(void *userdata, GDExtensionInitializ
 		terminate_callback(static_cast<ModuleInitializationLevel>(p_level));
 	}
 
+	EditorPlugins::deinitialize(p_level);
 	ClassDB::deinitialize(p_level);
 }
 GDExtensionBinding::InitObject::InitObject(GDExtensionInterfaceGetProcAddress p_get_proc_address, GDExtensionClassLibraryPtr p_library, GDExtensionInitialization *r_initialization) {