asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add a menu action to open C++ source on GitHub in the editor debugger

Browse source 
This helps user find back the source code where the error/warning
was emitted from.

(cherry picked from commit 5bc746e60a)
This commit is contained in:
Hugo Locurcio 2021-04-18 02:07:05 +02:00 committed by Rémi Verschelde
parent 79f48642a8
commit 7cb77a859a
No known key found for this signature in database
GPG key ID: C3336907360768E1
2 changed files with 33 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
editor/script_editor_debugger.cpp
View file

@ -33,6 +33,8 @@
#include "core/io/marshalls.h"
#include "core/project_settings.h"
#include "core/ustring.h"
#include "core/version.h"
#include "core/version_hash.gen.h"
#include "editor/editor_log.h"
#include "editor/plugins/canvas_item_editor_plugin.h"
#include "editor/plugins/spatial_editor_plugin.h"
@ -2251,6 +2253,7 @@ void ScriptEditorDebugger::_error_tree_item_rmb_selected(const Vector2 &p_pos) {
if (error_tree->is_anything_selected()) {
item_menu->add_icon_item(get_icon("ActionCopy", "EditorIcons"), TTR("Copy Error"), ITEM_MENU_COPY_ERROR);
item_menu->add_icon_item(get_icon("Instance", "EditorIcons"), TTR("Open C++ Source on GitHub"), ITEM_MENU_OPEN_SOURCE);
}
if (item_menu->get_item_count() > 0) {
@ -2323,6 +2326,35 @@ void ScriptEditorDebugger::_item_menu_id_pressed(int p_option) {
OS::get_singleton()->set_clipboard(text);
} break;
case ITEM_MENU_OPEN_SOURCE: {
TreeItem *ti = error_tree->get_selected();
while (ti->get_parent() != error_tree->get_root()) {
ti = ti->get_parent();
}
// We only need the first child here (C++ source stack trace).
TreeItem *ci = ti->get_children();
// Parse back the `file:line @ method()` string.
const Vector<String> file_line_number = ci->get_text(1).split("@")[0].strip_edges().split(":");
ERR_FAIL_COND_MSG(file_line_number.size() < 2, "Incorrect C++ source stack trace file:line format (please report).");
const String file = file_line_number[0];
const int line_number = file_line_number[1].to_int();
// Construct a GitHub repository URL and open it in the user's default web browser.
if (String(VERSION_HASH).length() >= 1) {
// Git commit hash information available; use it for greater accuracy, including for development versions.
OS::get_singleton()->shell_open(vformat("https://github.com/godotengine/godot/blob/%s/%s#L%d",
VERSION_HASH,
file,
line_number));
} else {
// Git commit hash information unavailable; fall back to tagged releases.
OS::get_singleton()->shell_open(vformat("https://github.com/godotengine/godot/blob/%s-stable/%s#L%d",
VERSION_NUMBER,
file,
line_number));
}
} break;
}
}

1
editor/script_editor_debugger.h
View file

@ -80,6 +80,7 @@ private:
ITEM_MENU_COPY_ERROR,
ITEM_MENU_SAVE_REMOTE_NODE,
ITEM_MENU_COPY_NODE_PATH,
ITEM_MENU_OPEN_SOURCE,
};
AcceptDialog *msgdialog;