Add option to filter errors from script side via EditorDebuggerPlugin

Author: Ryan-000

doc/classes/EditorDebuggerPlugin.xml

@@ -71,6 +71,13 @@
 				Override this method to process incoming messages. The [param session_id] is the ID of the [EditorDebuggerSession] that received the message (which you can retrieve via [method get_session]).
 			</description>
 		</method>
+		<method name="_filter_error" qualifiers="virtual const">
+			<return type="bool" />
+			<param index="0" name="error" type="Array" />
+			<param index="1" name="session_id" type="int" />
+			<description>
+			</description>
+		</method>
 		<method name="_goto_script_line" qualifiers="virtual">
 			<return type="void" />
 			<param index="0" name="script" type="Script" />

editor/debugger/editor_debugger_node.cpp

@@ -837,3 +837,16 @@ bool EditorDebuggerNode::plugins_capture(ScriptEditorDebugger *p_debugger, const
 	}
 	return parsed;
 }
+
+bool EditorDebuggerNode::plugins_filter_error(ScriptEditorDebugger *p_debugger, DebuggerMarshalls::OutputError &oe) {
+	int p_session_id = tabs->get_tab_idx_from_control(p_debugger);
+	ERR_FAIL_COND_V(p_session_id < 0, false);
+
+	bool filtered = false;
+	for (Ref<EditorDebuggerPlugin> plugin : debugger_plugins) {
+		if (plugin->filter_error(oe, p_session_id)) {
+			filtered = true;
+		}
+	}
+	return filtered;
+}

editor/debugger/editor_debugger_node.h

@@ -31,6 +31,7 @@
 #ifndef EDITOR_DEBUGGER_NODE_H
 #define EDITOR_DEBUGGER_NODE_H
 
+#include "core/debugger/debugger_marshalls.h"
 #include "core/object/script_language.h"
 #include "editor/debugger/editor_debugger_server.h"
 #include "scene/gui/margin_container.h"
@@ -217,6 +218,7 @@ class EditorDebuggerNode : public MarginContainer {
 	void stop(bool p_force = false);
 
 	bool plugins_capture(ScriptEditorDebugger *p_debugger, const String &p_message, const Array &p_data);
+	bool plugins_filter_error(ScriptEditorDebugger *p_debugger, DebuggerMarshalls::OutputError &oe);
 	void add_debugger_plugin(const Ref<EditorDebuggerPlugin> &p_plugin);
 	void remove_debugger_plugin(const Ref<EditorDebuggerPlugin> &p_plugin);
 };

editor/debugger/script_editor_debugger.cpp

@@ -536,6 +536,12 @@ void ScriptEditorDebugger::_parse_message(const String &p_msg, uint64_t p_thread
 		bool e;
 		String time = String("%d:%02d:%02d:%04d").sprintf(time_vals, &e);
 
+
+		bool filtered = EditorDebuggerNode::get_singleton()->plugins_filter_error(this, oe);
+		if (filtered) {
+			goto end;
+		}
+
 		// Rest of the error data.
 		bool source_is_project_file = oe.source_file.begins_with("res://");
 
@@ -820,6 +826,8 @@ void ScriptEditorDebugger::_parse_message(const String &p_msg, uint64_t p_thread
 			WARN_PRINT("unknown message " + p_msg);
 		}
 	}
+
+	end:;
 }
 
 void ScriptEditorDebugger::_set_reason_text(const String &p_reason, MessageType p_type) {

editor/plugins/editor_debugger_plugin.cpp

@@ -30,6 +30,7 @@
 
 #include "editor_debugger_plugin.h"
 
+#include "core/debugger/debugger_marshalls.h"
 #include "editor/debugger/script_editor_debugger.h"
 
 void EditorDebuggerSession::_breaked(bool p_really_did, bool p_can_debug, const String &p_message, bool p_has_stackdump) {
@@ -190,6 +191,17 @@ bool EditorDebuggerPlugin::capture(const String &p_message, const Array &p_data,
 	return false;
 }
 
+bool EditorDebuggerPlugin::filter_error(DebuggerMarshalls::OutputError &oe, int p_session_id) {
+	Array output_error_serialized = oe.serialize();
+
+	bool ret = false;
+	if (GDVIRTUAL_CALL(_filter_error, output_error_serialized, p_session_id, ret)) {
+		return ret;
+	}
+
+	return false;
+}
+
 void EditorDebuggerPlugin::goto_script_line(const Ref<Script> &p_script, int p_line) {
 	GDVIRTUAL_CALL(_goto_script_line, p_script, p_line);
 }
@@ -206,6 +218,7 @@ void EditorDebuggerPlugin::_bind_methods() {
 	GDVIRTUAL_BIND(_setup_session, "session_id");
 	GDVIRTUAL_BIND(_has_capture, "capture");
 	GDVIRTUAL_BIND(_capture, "message", "data", "session_id");
+	GDVIRTUAL_BIND(_filter_error, "error", "session_id");
 	GDVIRTUAL_BIND(_goto_script_line, "script", "line");
 	GDVIRTUAL_BIND(_breakpoints_cleared_in_tree);
 	GDVIRTUAL_BIND(_breakpoint_set_in_tree, "script", "line", "enabled");

editor/plugins/editor_debugger_plugin.h

@@ -31,6 +31,7 @@
 #ifndef EDITOR_DEBUGGER_PLUGIN_H
 #define EDITOR_DEBUGGER_PLUGIN_H
 
+#include "core/debugger/debugger_marshalls.h"
 #include "scene/gui/control.h"
 
 class ScriptEditorDebugger;
@@ -83,13 +84,15 @@ class EditorDebuggerPlugin : public RefCounted {
 
 	virtual void setup_session(int p_idx);
 	virtual bool capture(const String &p_message, const Array &p_data, int p_session);
+	virtual bool filter_error(DebuggerMarshalls::OutputError &oe, int p_session_id);
 	virtual bool has_capture(const String &p_capture) const;
 
 	Ref<EditorDebuggerSession> get_session(int p_session_id);
 	Array get_sessions();
 
 	GDVIRTUAL3R(bool, _capture, const String &, const Array &, int);
 	GDVIRTUAL1RC(bool, _has_capture, const String &);
+	GDVIRTUAL2RC(bool, _filter_error, const Array &, int);
 	GDVIRTUAL1(_setup_session, int);
 
 	virtual void goto_script_line(const Ref<Script> &p_script, int p_line);