From b53967b49d222170cdc4711fa7414cbc0da6607a Mon Sep 17 00:00:00 2001
From: Mack <86566939+Macksaur@users.noreply.github.com>
Date: Thu, 26 Sep 2024 17:31:42 +0100
Subject: [PATCH] Draft: Use PROPERTY_HINT_TOOL_BUTTON as backing instead of a
 Callable type.

---
 core/core_constants.cpp                      |  1 +
 core/object/object.h                         |  2 ++
 doc/classes/@GlobalScope.xml                 |  4 +++-
 editor/plugins/tool_button_editor_plugin.cpp | 17 +++++++++--------
 editor/plugins/tool_button_editor_plugin.h   |  4 ++--
 modules/gdscript/gdscript_compiler.cpp       |  1 +
 modules/gdscript/gdscript_parser.cpp         |  2 +-
 7 files changed, 19 insertions(+), 12 deletions(-)

diff --git a/core/core_constants.cpp b/core/core_constants.cpp
index 68af5abf66a3..25da49fa5c3e 100644
--- a/core/core_constants.cpp
+++ b/core/core_constants.cpp
@@ -677,6 +677,7 @@ void register_global_constants() {
 	BIND_CORE_ENUM_CONSTANT(PROPERTY_HINT_NODE_TYPE);
 	BIND_CORE_ENUM_CONSTANT(PROPERTY_HINT_HIDE_QUATERNION_EDIT);
 	BIND_CORE_ENUM_CONSTANT(PROPERTY_HINT_PASSWORD);
+	BIND_CORE_ENUM_CONSTANT(PROPERTY_HINT_TOOL_BUTTON);
 	BIND_CORE_ENUM_CONSTANT(PROPERTY_HINT_MAX);
 
 	BIND_CORE_BITFIELD_FLAG(PROPERTY_USAGE_NONE);
diff --git a/core/object/object.h b/core/object/object.h
index 1274247d716b..bbdcefcbac19 100644
--- a/core/object/object.h
+++ b/core/object/object.h
@@ -87,6 +87,7 @@ enum PropertyHint {
 	PROPERTY_HINT_PASSWORD,
 	PROPERTY_HINT_LAYERS_AVOIDANCE,
 	PROPERTY_HINT_DICTIONARY_TYPE,
+	PROPERTY_HINT_TOOL_BUTTON,
 	PROPERTY_HINT_MAX,
 };
 
@@ -135,6 +136,7 @@ enum PropertyUsageFlags {
 #define ADD_SUBGROUP(m_name, m_prefix) ::ClassDB::add_property_subgroup(get_class_static(), m_name, m_prefix)
 #define ADD_SUBGROUP_INDENT(m_name, m_prefix, m_depth) ::ClassDB::add_property_subgroup(get_class_static(), m_name, m_prefix, m_depth)
 #define ADD_LINKED_PROPERTY(m_property, m_linked_property) ::ClassDB::add_linked_property(get_class_static(), m_property, m_linked_property)
+#define ADD_TOOL_BUTTON(m_method, m_label, m_icon) ::ClassDB::add_property(get_class_static(), PropertyInfo(Variant::NIL, "@tool_button_" + String(m_method), PROPERTY_HINT_TOOL_BUTTON, String(m_method) + "," + String(m_label) + "," + String(m_icon), PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_INTERNAL), StringName(), StringName())
 
 #define ADD_ARRAY_COUNT(m_label, m_count_property, m_count_property_setter, m_count_property_getter, m_prefix) ClassDB::add_property_array_count(get_class_static(), m_label, m_count_property, _scs_create(m_count_property_setter), _scs_create(m_count_property_getter), m_prefix)
 #define ADD_ARRAY_COUNT_WITH_USAGE_FLAGS(m_label, m_count_property, m_count_property_setter, m_count_property_getter, m_prefix, m_property_usage_flags) ClassDB::add_property_array_count(get_class_static(), m_label, m_count_property, _scs_create(m_count_property_setter), _scs_create(m_count_property_getter), m_prefix, m_property_usage_flags)
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml
index f222cbc96953..31efab40aad2 100644
--- a/doc/classes/@GlobalScope.xml
+++ b/doc/classes/@GlobalScope.xml
@@ -2933,7 +2933,9 @@
 		<constant name="PROPERTY_HINT_PASSWORD" value="36" enum="PropertyHint">
 			Hints that a string property is a password, and every character is replaced with the secret character.
 		</constant>
-		<constant name="PROPERTY_HINT_MAX" value="39" enum="PropertyHint">
+		<constant name="PROPERTY_HINT_TOOL_BUTTON" value="39" enum="PropertyHint">
+		</constant>
+		<constant name="PROPERTY_HINT_MAX" value="40" enum="PropertyHint">
 			Represents the size of the [enum PropertyHint] enum.
 		</constant>
 		<constant name="PROPERTY_USAGE_NONE" value="0" enum="PropertyUsageFlags" is_bitfield="true">
diff --git a/editor/plugins/tool_button_editor_plugin.cpp b/editor/plugins/tool_button_editor_plugin.cpp
index e091e518eddf..ce0860a2f18c 100644
--- a/editor/plugins/tool_button_editor_plugin.cpp
+++ b/editor/plugins/tool_button_editor_plugin.cpp
@@ -34,16 +34,16 @@
 #include "editor/editor_undo_redo_manager.h"
 #include "scene/gui/button.h"
 
-bool ToolButtonInspectorPlugin::can_handle(Object *p_object) {
+bool EditorInspectorToolButtonPlugin::can_handle(Object *p_object) {
 	Ref<Script> scr = p_object->get_script();
 	return scr.is_valid() && scr->is_tool();
 }
 
-void ToolButtonInspectorPlugin::update_action_icon(Button *p_action_button) {
+void EditorInspectorToolButtonPlugin::update_action_icon(Button *p_action_button) {
 	p_action_button->set_icon(p_action_button->get_editor_theme_icon(action_icon));
 }
 
-void ToolButtonInspectorPlugin::call_action(Object *p_object, const StringName &p_method_name) {
+void EditorInspectorToolButtonPlugin::call_action(Object *p_object, const StringName &p_method_name) {
 	bool method_is_valid = false;
 	int method_arg_count = p_object->get_method_argument_count(p_method_name, &method_is_valid);
 
@@ -65,8 +65,8 @@ void ToolButtonInspectorPlugin::call_action(Object *p_object, const StringName &
 	ERR_FAIL_COND_MSG(ce.error != Callable::CallError::CALL_OK, vformat("Error calling tool button method on %s: %s.", p_object->get_class_name(), Variant::get_call_error_text(p_method_name, &args, argc, ce)));
 }
 
-bool ToolButtonInspectorPlugin::parse_property(Object *p_object, const Variant::Type p_type, const String &p_path, const PropertyHint p_hint, const String &p_hint_text, const BitField<PropertyUsageFlags> p_usage, const bool p_wide) {
-	if (p_type != Variant::CALLABLE || !p_usage.has_flag(PROPERTY_USAGE_EDITOR)) {
+bool EditorInspectorToolButtonPlugin::parse_property(Object *p_object, const Variant::Type p_type, const String &p_path, const PropertyHint p_hint, const String &p_hint_text, const BitField<PropertyUsageFlags> p_usage, const bool p_wide) {
+	if (p_hint != PROPERTY_HINT_TOOL_BUTTON || !p_usage.has_flag(PROPERTY_USAGE_EDITOR)) {
 		return false;
 	}
 
@@ -85,15 +85,16 @@ bool ToolButtonInspectorPlugin::parse_property(Object *p_object, const Variant::
 
 	Button *action_button = EditorInspector::create_inspector_action_button(action_text);
 	action_button->set_auto_translate_mode(Node::AUTO_TRANSLATE_MODE_DISABLED);
-	action_button->connect(SceneStringName(theme_changed), callable_mp(this, &ToolButtonInspectorPlugin::update_action_icon).bind(action_button));
-	action_button->connect(SceneStringName(pressed), callable_mp(this, &ToolButtonInspectorPlugin::call_action).bind(p_object, method));
+	action_button->set_disabled(p_usage & PROPERTY_USAGE_READ_ONLY);
+	action_button->connect(SceneStringName(theme_changed), callable_mp(this, &EditorInspectorToolButtonPlugin::update_action_icon).bind(action_button));
+	action_button->connect(SceneStringName(pressed), callable_mp(this, &EditorInspectorToolButtonPlugin::call_action).bind(p_object, method));
 
 	add_custom_control(action_button);
 	return true;
 }
 
 ToolButtonEditorPlugin::ToolButtonEditorPlugin() {
-	Ref<ToolButtonInspectorPlugin> plugin;
+	Ref<EditorInspectorToolButtonPlugin> plugin;
 	plugin.instantiate();
 	add_inspector_plugin(plugin);
 }
diff --git a/editor/plugins/tool_button_editor_plugin.h b/editor/plugins/tool_button_editor_plugin.h
index 027885df374a..2e1ac55ebd4a 100644
--- a/editor/plugins/tool_button_editor_plugin.h
+++ b/editor/plugins/tool_button_editor_plugin.h
@@ -34,8 +34,8 @@
 #include "editor/editor_inspector.h"
 #include "editor/plugins/editor_plugin.h"
 
-class ToolButtonInspectorPlugin : public EditorInspectorPlugin {
-	GDCLASS(ToolButtonInspectorPlugin, EditorInspectorPlugin);
+class EditorInspectorToolButtonPlugin : public EditorInspectorPlugin {
+	GDCLASS(EditorInspectorToolButtonPlugin, EditorInspectorPlugin);
 
 public:
 	StringName action_icon;
diff --git a/modules/gdscript/gdscript_compiler.cpp b/modules/gdscript/gdscript_compiler.cpp
index 9d152dd194b6..5e8dc67e9f47 100644
--- a/modules/gdscript/gdscript_compiler.cpp
+++ b/modules/gdscript/gdscript_compiler.cpp
@@ -2872,6 +2872,7 @@ Error GDScriptCompiler::_prepare_compilation(GDScript *p_script, const GDScriptP
 				prop_info.name = annotation->export_info.name;
 				prop_info.usage = annotation->export_info.usage;
 				prop_info.type = annotation->export_info.type;
+				prop_info.hint = annotation->export_info.hint;
 				prop_info.hint_string = annotation->export_info.hint_string;
 				minfo.property_info = prop_info;
 
diff --git a/modules/gdscript/gdscript_parser.cpp b/modules/gdscript/gdscript_parser.cpp
index 8452012cea05..45ca4946b178 100644
--- a/modules/gdscript/gdscript_parser.cpp
+++ b/modules/gdscript/gdscript_parser.cpp
@@ -4701,7 +4701,7 @@ bool GDScriptParser::export_tool_button_annotation(AnnotationNode *p_annotation,
 	const FunctionNode *func = member.function;
 
 	p_annotation->export_info.name = "@tool_button_" + func->identifier->name;
-	p_annotation->export_info.type = Variant::Type::CALLABLE;
+	p_annotation->export_info.hint = PROPERTY_HINT_TOOL_BUTTON;
 	p_annotation->export_info.usage = PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_INTERNAL;
 
 	if (!func->parameters.is_empty() && func->parameters[0]->datatype_specifier != nullptr) {