2
0

editor_debugger_node.cpp 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722
  1. /*************************************************************************/
  2. /* editor_debugger_node.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "editor_debugger_node.h"
  31. #include "core/object/undo_redo.h"
  32. #include "editor/debugger/editor_debugger_tree.h"
  33. #include "editor/debugger/script_editor_debugger.h"
  34. #include "editor/editor_log.h"
  35. #include "editor/editor_node.h"
  36. #include "editor/plugins/editor_debugger_plugin.h"
  37. #include "editor/plugins/script_editor_plugin.h"
  38. #include "editor/scene_tree_dock.h"
  39. #include "scene/gui/menu_button.h"
  40. #include "scene/gui/tab_container.h"
  41. #include "scene/resources/packed_scene.h"
  42. template <typename Func>
  43. void _for_all(TabContainer *p_node, const Func &p_func) {
  44. for (int i = 0; i < p_node->get_tab_count(); i++) {
  45. ScriptEditorDebugger *dbg = Object::cast_to<ScriptEditorDebugger>(p_node->get_tab_control(i));
  46. ERR_FAIL_COND(!dbg);
  47. p_func(dbg);
  48. }
  49. }
  50. EditorDebuggerNode *EditorDebuggerNode::singleton = nullptr;
  51. EditorDebuggerNode::EditorDebuggerNode() {
  52. if (!singleton) {
  53. singleton = this;
  54. }
  55. add_theme_constant_override("margin_left", -EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("BottomPanelDebuggerOverride"), SNAME("EditorStyles"))->get_margin(SIDE_LEFT));
  56. add_theme_constant_override("margin_right", -EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("BottomPanelDebuggerOverride"), SNAME("EditorStyles"))->get_margin(SIDE_RIGHT));
  57. tabs = memnew(TabContainer);
  58. tabs->set_tabs_visible(false);
  59. tabs->connect("tab_changed", callable_mp(this, &EditorDebuggerNode::_debugger_changed));
  60. add_child(tabs);
  61. Ref<StyleBoxEmpty> empty;
  62. empty.instantiate();
  63. tabs->add_theme_style_override("panel", empty);
  64. auto_switch_remote_scene_tree = EDITOR_DEF("debugger/auto_switch_to_remote_scene_tree", false);
  65. _add_debugger();
  66. // Remote scene tree
  67. remote_scene_tree = memnew(EditorDebuggerTree);
  68. remote_scene_tree->connect("object_selected", callable_mp(this, &EditorDebuggerNode::_remote_object_requested));
  69. remote_scene_tree->connect("save_node", callable_mp(this, &EditorDebuggerNode::_save_node_requested));
  70. SceneTreeDock::get_singleton()->add_remote_tree_editor(remote_scene_tree);
  71. SceneTreeDock::get_singleton()->connect("remote_tree_selected", callable_mp(this, &EditorDebuggerNode::request_remote_tree));
  72. remote_scene_tree_timeout = EDITOR_DEF("debugger/remote_scene_tree_refresh_interval", 1.0);
  73. inspect_edited_object_timeout = EDITOR_DEF("debugger/remote_inspect_refresh_interval", 0.2);
  74. EditorNode *editor = EditorNode::get_singleton();
  75. editor->get_pause_button()->connect("pressed", callable_mp(this, &EditorDebuggerNode::_paused));
  76. }
  77. ScriptEditorDebugger *EditorDebuggerNode::_add_debugger() {
  78. ScriptEditorDebugger *node = memnew(ScriptEditorDebugger);
  79. int id = tabs->get_tab_count();
  80. node->connect("stop_requested", callable_mp(this, &EditorDebuggerNode::_debugger_wants_stop).bind(id));
  81. node->connect("stopped", callable_mp(this, &EditorDebuggerNode::_debugger_stopped).bind(id));
  82. node->connect("stack_frame_selected", callable_mp(this, &EditorDebuggerNode::_stack_frame_selected).bind(id));
  83. node->connect("error_selected", callable_mp(this, &EditorDebuggerNode::_error_selected).bind(id));
  84. node->connect("breakpoint_selected", callable_mp(this, &EditorDebuggerNode::_error_selected).bind(id));
  85. node->connect("clear_execution", callable_mp(this, &EditorDebuggerNode::_clear_execution));
  86. node->connect("breaked", callable_mp(this, &EditorDebuggerNode::_breaked).bind(id));
  87. node->connect("remote_tree_updated", callable_mp(this, &EditorDebuggerNode::_remote_tree_updated).bind(id));
  88. node->connect("remote_object_updated", callable_mp(this, &EditorDebuggerNode::_remote_object_updated).bind(id));
  89. node->connect("remote_object_property_updated", callable_mp(this, &EditorDebuggerNode::_remote_object_property_updated).bind(id));
  90. node->connect("remote_object_requested", callable_mp(this, &EditorDebuggerNode::_remote_object_requested).bind(id));
  91. node->connect("errors_cleared", callable_mp(this, &EditorDebuggerNode::_update_errors));
  92. if (tabs->get_tab_count() > 0) {
  93. get_debugger(0)->clear_style();
  94. }
  95. tabs->add_child(node);
  96. node->set_name("Session " + itos(tabs->get_tab_count()));
  97. if (tabs->get_tab_count() > 1) {
  98. node->clear_style();
  99. tabs->set_tabs_visible(true);
  100. tabs->add_theme_style_override("panel", EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("DebuggerPanel"), SNAME("EditorStyles")));
  101. }
  102. if (!debugger_plugins.is_empty()) {
  103. for (const Ref<Script> &i : debugger_plugins) {
  104. node->add_debugger_plugin(i);
  105. }
  106. }
  107. return node;
  108. }
  109. void EditorDebuggerNode::_stack_frame_selected(int p_debugger) {
  110. const ScriptEditorDebugger *dbg = get_debugger(p_debugger);
  111. ERR_FAIL_COND(!dbg);
  112. if (dbg != get_current_debugger()) {
  113. return;
  114. }
  115. _text_editor_stack_goto(dbg);
  116. }
  117. void EditorDebuggerNode::_error_selected(const String &p_file, int p_line, int p_debugger) {
  118. Ref<Script> s = ResourceLoader::load(p_file);
  119. emit_signal(SNAME("goto_script_line"), s, p_line - 1);
  120. }
  121. void EditorDebuggerNode::_text_editor_stack_goto(const ScriptEditorDebugger *p_debugger) {
  122. String file = p_debugger->get_stack_script_file();
  123. if (file.is_empty()) {
  124. return;
  125. }
  126. if (file.is_resource_file()) {
  127. stack_script = ResourceLoader::load(file);
  128. } else {
  129. // If the script is built-in, it can be opened only if the scene is loaded in memory.
  130. int i = file.find("::");
  131. int j = file.rfind("(", i);
  132. if (j > -1) { // If the script is named, the string is "name (file)", so we need to extract the path.
  133. file = file.substr(j + 1, file.find(")", i) - j - 1);
  134. }
  135. Ref<PackedScene> ps = ResourceLoader::load(file.get_slice("::", 0));
  136. stack_script = ResourceLoader::load(file);
  137. }
  138. const int line = p_debugger->get_stack_script_line() - 1;
  139. emit_signal(SNAME("goto_script_line"), stack_script, line);
  140. emit_signal(SNAME("set_execution"), stack_script, line);
  141. stack_script.unref(); // Why?!?
  142. }
  143. void EditorDebuggerNode::_bind_methods() {
  144. // LiveDebug.
  145. ClassDB::bind_method("live_debug_create_node", &EditorDebuggerNode::live_debug_create_node);
  146. ClassDB::bind_method("live_debug_instance_node", &EditorDebuggerNode::live_debug_instance_node);
  147. ClassDB::bind_method("live_debug_remove_node", &EditorDebuggerNode::live_debug_remove_node);
  148. ClassDB::bind_method("live_debug_remove_and_keep_node", &EditorDebuggerNode::live_debug_remove_and_keep_node);
  149. ClassDB::bind_method("live_debug_restore_node", &EditorDebuggerNode::live_debug_restore_node);
  150. ClassDB::bind_method("live_debug_duplicate_node", &EditorDebuggerNode::live_debug_duplicate_node);
  151. ClassDB::bind_method("live_debug_reparent_node", &EditorDebuggerNode::live_debug_reparent_node);
  152. ADD_SIGNAL(MethodInfo("goto_script_line"));
  153. ADD_SIGNAL(MethodInfo("set_execution", PropertyInfo("script"), PropertyInfo(Variant::INT, "line")));
  154. ADD_SIGNAL(MethodInfo("clear_execution", PropertyInfo("script")));
  155. ADD_SIGNAL(MethodInfo("breaked", PropertyInfo(Variant::BOOL, "reallydid"), PropertyInfo(Variant::BOOL, "can_debug")));
  156. ADD_SIGNAL(MethodInfo("breakpoint_toggled", PropertyInfo(Variant::STRING, "path"), PropertyInfo(Variant::INT, "line"), PropertyInfo(Variant::BOOL, "enabled")));
  157. }
  158. void EditorDebuggerNode::register_undo_redo(UndoRedo *p_undo_redo) {
  159. p_undo_redo->set_method_notify_callback(_method_changeds, this);
  160. p_undo_redo->set_property_notify_callback(_property_changeds, this);
  161. }
  162. EditorDebuggerRemoteObject *EditorDebuggerNode::get_inspected_remote_object() {
  163. return Object::cast_to<EditorDebuggerRemoteObject>(ObjectDB::get_instance(EditorNode::get_singleton()->get_editor_selection_history()->get_current()));
  164. }
  165. ScriptEditorDebugger *EditorDebuggerNode::get_debugger(int p_id) const {
  166. return Object::cast_to<ScriptEditorDebugger>(tabs->get_tab_control(p_id));
  167. }
  168. ScriptEditorDebugger *EditorDebuggerNode::get_current_debugger() const {
  169. return Object::cast_to<ScriptEditorDebugger>(tabs->get_tab_control(tabs->get_current_tab()));
  170. }
  171. ScriptEditorDebugger *EditorDebuggerNode::get_default_debugger() const {
  172. return Object::cast_to<ScriptEditorDebugger>(tabs->get_tab_control(0));
  173. }
  174. String EditorDebuggerNode::get_server_uri() const {
  175. ERR_FAIL_COND_V(server.is_null(), "");
  176. return server->get_uri();
  177. }
  178. Error EditorDebuggerNode::start(const String &p_uri) {
  179. stop();
  180. ERR_FAIL_COND_V(p_uri.find("://") < 0, ERR_INVALID_PARAMETER);
  181. if (EDITOR_GET("run/output/always_open_output_on_play")) {
  182. EditorNode::get_singleton()->make_bottom_panel_item_visible(EditorNode::get_log());
  183. } else {
  184. EditorNode::get_singleton()->make_bottom_panel_item_visible(this);
  185. }
  186. server = Ref<EditorDebuggerServer>(EditorDebuggerServer::create(p_uri.substr(0, p_uri.find("://") + 3)));
  187. const Error err = server->start(p_uri);
  188. if (err != OK) {
  189. return err;
  190. }
  191. set_process(true);
  192. EditorNode::get_log()->add_message("--- Debugging process started ---", EditorLog::MSG_TYPE_EDITOR);
  193. return OK;
  194. }
  195. void EditorDebuggerNode::stop() {
  196. if (server.is_valid()) {
  197. server->stop();
  198. EditorNode::get_log()->add_message("--- Debugging process stopped ---", EditorLog::MSG_TYPE_EDITOR);
  199. server.unref();
  200. }
  201. // Also close all debugging sessions.
  202. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  203. if (dbg->is_session_active()) {
  204. dbg->_stop_and_notify();
  205. }
  206. });
  207. _break_state_changed();
  208. if (hide_on_stop) {
  209. if (is_visible_in_tree()) {
  210. EditorNode::get_singleton()->hide_bottom_panel();
  211. }
  212. }
  213. breakpoints.clear();
  214. set_process(false);
  215. }
  216. void EditorDebuggerNode::_notification(int p_what) {
  217. switch (p_what) {
  218. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  219. if (tabs->get_tab_count() > 1) {
  220. add_theme_constant_override("margin_left", -EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("BottomPanelDebuggerOverride"), SNAME("EditorStyles"))->get_margin(SIDE_LEFT));
  221. add_theme_constant_override("margin_right", -EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("BottomPanelDebuggerOverride"), SNAME("EditorStyles"))->get_margin(SIDE_RIGHT));
  222. tabs->add_theme_style_override("panel", EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("DebuggerPanel"), SNAME("EditorStyles")));
  223. }
  224. } break;
  225. case NOTIFICATION_READY: {
  226. _update_debug_options();
  227. } break;
  228. case NOTIFICATION_PROCESS: {
  229. if (!server.is_valid()) {
  230. return;
  231. }
  232. if (!server->is_active()) {
  233. stop();
  234. return;
  235. }
  236. server->poll();
  237. _update_errors();
  238. // Remote scene tree update
  239. remote_scene_tree_timeout -= get_process_delta_time();
  240. if (remote_scene_tree_timeout < 0) {
  241. remote_scene_tree_timeout = EditorSettings::get_singleton()->get("debugger/remote_scene_tree_refresh_interval");
  242. if (remote_scene_tree->is_visible_in_tree()) {
  243. get_current_debugger()->request_remote_tree();
  244. }
  245. }
  246. // Remote inspector update
  247. inspect_edited_object_timeout -= get_process_delta_time();
  248. if (inspect_edited_object_timeout < 0) {
  249. inspect_edited_object_timeout = EditorSettings::get_singleton()->get("debugger/remote_inspect_refresh_interval");
  250. if (EditorDebuggerRemoteObject *obj = get_inspected_remote_object()) {
  251. get_current_debugger()->request_remote_object(obj->remote_object_id);
  252. }
  253. }
  254. // Take connections.
  255. if (server->is_connection_available()) {
  256. ScriptEditorDebugger *debugger = nullptr;
  257. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  258. if (debugger || dbg->is_session_active()) {
  259. return;
  260. }
  261. debugger = dbg;
  262. });
  263. if (debugger == nullptr) {
  264. if (tabs->get_tab_count() <= 4) { // Max 4 debugging sessions active.
  265. debugger = _add_debugger();
  266. } else {
  267. // We already have too many sessions, disconnecting new clients to prevent them from hanging.
  268. server->take_connection()->close();
  269. return; // Can't add, stop here.
  270. }
  271. }
  272. EditorNode::get_singleton()->get_pause_button()->set_disabled(false);
  273. // Switch to remote tree view if so desired.
  274. auto_switch_remote_scene_tree = (bool)EditorSettings::get_singleton()->get("debugger/auto_switch_to_remote_scene_tree");
  275. if (auto_switch_remote_scene_tree) {
  276. SceneTreeDock::get_singleton()->show_remote_tree();
  277. }
  278. // Good to go.
  279. SceneTreeDock::get_singleton()->show_tab_buttons();
  280. debugger->set_editor_remote_tree(remote_scene_tree);
  281. debugger->start(server->take_connection());
  282. // Send breakpoints.
  283. for (const KeyValue<Breakpoint, bool> &E : breakpoints) {
  284. const Breakpoint &bp = E.key;
  285. debugger->set_breakpoint(bp.source, bp.line, E.value);
  286. } // Will arrive too late, how does the regular run work?
  287. debugger->update_live_edit_root();
  288. }
  289. } break;
  290. }
  291. }
  292. void EditorDebuggerNode::_update_errors() {
  293. int error_count = 0;
  294. int warning_count = 0;
  295. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  296. error_count += dbg->get_error_count();
  297. warning_count += dbg->get_warning_count();
  298. });
  299. if (error_count != last_error_count || warning_count != last_warning_count) {
  300. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  301. dbg->update_tabs();
  302. });
  303. if (error_count == 0 && warning_count == 0) {
  304. debugger_button->set_text(TTR("Debugger"));
  305. debugger_button->remove_theme_color_override("font_color");
  306. debugger_button->set_icon(Ref<Texture2D>());
  307. } else {
  308. debugger_button->set_text(TTR("Debugger") + " (" + itos(error_count + warning_count) + ")");
  309. if (error_count >= 1 && warning_count >= 1) {
  310. debugger_button->set_icon(get_theme_icon(SNAME("ErrorWarning"), SNAME("EditorIcons")));
  311. // Use error color to represent the highest level of severity reported.
  312. debugger_button->add_theme_color_override("font_color", get_theme_color(SNAME("error_color"), SNAME("Editor")));
  313. } else if (error_count >= 1) {
  314. debugger_button->set_icon(get_theme_icon(SNAME("Error"), SNAME("EditorIcons")));
  315. debugger_button->add_theme_color_override("font_color", get_theme_color(SNAME("error_color"), SNAME("Editor")));
  316. } else {
  317. debugger_button->set_icon(get_theme_icon(SNAME("Warning"), SNAME("EditorIcons")));
  318. debugger_button->add_theme_color_override("font_color", get_theme_color(SNAME("warning_color"), SNAME("Editor")));
  319. }
  320. }
  321. last_error_count = error_count;
  322. last_warning_count = warning_count;
  323. }
  324. }
  325. void EditorDebuggerNode::_debugger_stopped(int p_id) {
  326. ScriptEditorDebugger *dbg = get_debugger(p_id);
  327. ERR_FAIL_COND(!dbg);
  328. bool found = false;
  329. _for_all(tabs, [&](ScriptEditorDebugger *p_debugger) {
  330. if (p_debugger->is_session_active()) {
  331. found = true;
  332. }
  333. });
  334. if (!found) {
  335. EditorNode::get_singleton()->get_pause_button()->set_pressed(false);
  336. EditorNode::get_singleton()->get_pause_button()->set_disabled(true);
  337. SceneTreeDock::get_singleton()->hide_remote_tree();
  338. SceneTreeDock::get_singleton()->hide_tab_buttons();
  339. EditorNode::get_singleton()->notify_all_debug_sessions_exited();
  340. }
  341. }
  342. void EditorDebuggerNode::_debugger_wants_stop(int p_id) {
  343. // Ask editor to kill PID.
  344. int pid = get_debugger(p_id)->get_remote_pid();
  345. if (pid) {
  346. EditorNode::get_singleton()->call_deferred(SNAME("stop_child_process"), pid);
  347. }
  348. }
  349. void EditorDebuggerNode::_debugger_changed(int p_tab) {
  350. if (get_inspected_remote_object()) {
  351. // Clear inspected object, you can only inspect objects in selected debugger.
  352. // Hopefully, in the future, we will have one inspector per debugger.
  353. EditorNode::get_singleton()->push_item(nullptr);
  354. }
  355. if (remote_scene_tree->is_visible_in_tree()) {
  356. get_current_debugger()->request_remote_tree();
  357. }
  358. if (get_current_debugger()->is_breaked()) {
  359. _text_editor_stack_goto(get_current_debugger());
  360. }
  361. }
  362. void EditorDebuggerNode::set_script_debug_button(MenuButton *p_button) {
  363. script_menu = p_button;
  364. script_menu->set_text(TTR("Debug"));
  365. script_menu->set_switch_on_hover(true);
  366. PopupMenu *p = script_menu->get_popup();
  367. p->add_shortcut(ED_GET_SHORTCUT("debugger/step_into"), DEBUG_STEP);
  368. p->add_shortcut(ED_GET_SHORTCUT("debugger/step_over"), DEBUG_NEXT);
  369. p->add_separator();
  370. p->add_shortcut(ED_GET_SHORTCUT("debugger/break"), DEBUG_BREAK);
  371. p->add_shortcut(ED_GET_SHORTCUT("debugger/continue"), DEBUG_CONTINUE);
  372. p->add_separator();
  373. p->add_check_shortcut(ED_GET_SHORTCUT("debugger/keep_debugger_open"), DEBUG_KEEP_DEBUGGER_OPEN);
  374. p->add_check_shortcut(ED_GET_SHORTCUT("debugger/debug_with_external_editor"), DEBUG_WITH_EXTERNAL_EDITOR);
  375. p->connect("id_pressed", callable_mp(this, &EditorDebuggerNode::_menu_option));
  376. _break_state_changed();
  377. script_menu->show();
  378. }
  379. void EditorDebuggerNode::_break_state_changed() {
  380. const bool breaked = get_current_debugger()->is_breaked();
  381. const bool can_debug = get_current_debugger()->is_debuggable();
  382. if (breaked) { // Show debugger.
  383. EditorNode::get_singleton()->make_bottom_panel_item_visible(this);
  384. }
  385. // Update script menu.
  386. if (!script_menu) {
  387. return;
  388. }
  389. PopupMenu *p = script_menu->get_popup();
  390. p->set_item_disabled(p->get_item_index(DEBUG_NEXT), !(breaked && can_debug));
  391. p->set_item_disabled(p->get_item_index(DEBUG_STEP), !(breaked && can_debug));
  392. p->set_item_disabled(p->get_item_index(DEBUG_BREAK), breaked);
  393. p->set_item_disabled(p->get_item_index(DEBUG_CONTINUE), !breaked);
  394. }
  395. void EditorDebuggerNode::_menu_option(int p_id) {
  396. switch (p_id) {
  397. case DEBUG_NEXT: {
  398. debug_next();
  399. } break;
  400. case DEBUG_STEP: {
  401. debug_step();
  402. } break;
  403. case DEBUG_BREAK: {
  404. debug_break();
  405. } break;
  406. case DEBUG_CONTINUE: {
  407. debug_continue();
  408. } break;
  409. case DEBUG_KEEP_DEBUGGER_OPEN: {
  410. bool ischecked = script_menu->get_popup()->is_item_checked(script_menu->get_popup()->get_item_index(DEBUG_KEEP_DEBUGGER_OPEN));
  411. hide_on_stop = ischecked;
  412. script_menu->get_popup()->set_item_checked(script_menu->get_popup()->get_item_index(DEBUG_KEEP_DEBUGGER_OPEN), !ischecked);
  413. EditorSettings::get_singleton()->set_project_metadata("debug_options", "keep_debugger_open", !ischecked);
  414. } break;
  415. case DEBUG_WITH_EXTERNAL_EDITOR: {
  416. bool ischecked = script_menu->get_popup()->is_item_checked(script_menu->get_popup()->get_item_index(DEBUG_WITH_EXTERNAL_EDITOR));
  417. debug_with_external_editor = !ischecked;
  418. script_menu->get_popup()->set_item_checked(script_menu->get_popup()->get_item_index(DEBUG_WITH_EXTERNAL_EDITOR), !ischecked);
  419. EditorSettings::get_singleton()->set_project_metadata("debug_options", "debug_with_external_editor", !ischecked);
  420. } break;
  421. }
  422. }
  423. void EditorDebuggerNode::_update_debug_options() {
  424. bool keep_debugger_open = EditorSettings::get_singleton()->get_project_metadata("debug_options", "keep_debugger_open", false);
  425. bool debug_with_external_editor = EditorSettings::get_singleton()->get_project_metadata("debug_options", "debug_with_external_editor", false);
  426. if (keep_debugger_open) {
  427. _menu_option(DEBUG_KEEP_DEBUGGER_OPEN);
  428. }
  429. if (debug_with_external_editor) {
  430. _menu_option(DEBUG_WITH_EXTERNAL_EDITOR);
  431. }
  432. }
  433. void EditorDebuggerNode::_paused() {
  434. const bool paused = EditorNode::get_singleton()->get_pause_button()->is_pressed();
  435. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  436. if (paused && !dbg->is_breaked()) {
  437. dbg->debug_break();
  438. } else if (!paused && dbg->is_breaked()) {
  439. dbg->debug_continue();
  440. }
  441. });
  442. }
  443. void EditorDebuggerNode::_breaked(bool p_breaked, bool p_can_debug, String p_message, bool p_has_stackdump, int p_debugger) {
  444. if (get_current_debugger() != get_debugger(p_debugger)) {
  445. if (!p_breaked) {
  446. return;
  447. }
  448. tabs->set_current_tab(p_debugger);
  449. }
  450. _break_state_changed();
  451. EditorNode::get_singleton()->get_pause_button()->set_pressed(p_breaked);
  452. emit_signal(SNAME("breaked"), p_breaked, p_can_debug);
  453. }
  454. bool EditorDebuggerNode::is_skip_breakpoints() const {
  455. return get_default_debugger()->is_skip_breakpoints();
  456. }
  457. void EditorDebuggerNode::set_breakpoint(const String &p_path, int p_line, bool p_enabled) {
  458. breakpoints[Breakpoint(p_path, p_line)] = p_enabled;
  459. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  460. dbg->set_breakpoint(p_path, p_line, p_enabled);
  461. });
  462. emit_signal(SNAME("breakpoint_toggled"), p_path, p_line, p_enabled);
  463. }
  464. void EditorDebuggerNode::set_breakpoints(const String &p_path, Array p_lines) {
  465. for (int i = 0; i < p_lines.size(); i++) {
  466. set_breakpoint(p_path, p_lines[i], true);
  467. }
  468. for (const KeyValue<Breakpoint, bool> &E : breakpoints) {
  469. Breakpoint b = E.key;
  470. if (b.source == p_path && !p_lines.has(b.line)) {
  471. set_breakpoint(p_path, b.line, false);
  472. }
  473. }
  474. }
  475. void EditorDebuggerNode::reload_scripts() {
  476. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  477. dbg->reload_scripts();
  478. });
  479. }
  480. void EditorDebuggerNode::debug_next() {
  481. get_default_debugger()->debug_next();
  482. }
  483. void EditorDebuggerNode::debug_step() {
  484. get_default_debugger()->debug_step();
  485. }
  486. void EditorDebuggerNode::debug_break() {
  487. get_default_debugger()->debug_break();
  488. }
  489. void EditorDebuggerNode::debug_continue() {
  490. get_default_debugger()->debug_continue();
  491. }
  492. String EditorDebuggerNode::get_var_value(const String &p_var) const {
  493. return get_default_debugger()->get_var_value(p_var);
  494. }
  495. // LiveEdit/Inspector
  496. void EditorDebuggerNode::request_remote_tree() {
  497. get_current_debugger()->request_remote_tree();
  498. }
  499. void EditorDebuggerNode::_remote_tree_updated(int p_debugger) {
  500. if (p_debugger != tabs->get_current_tab()) {
  501. return;
  502. }
  503. remote_scene_tree->clear();
  504. remote_scene_tree->update_scene_tree(get_current_debugger()->get_remote_tree(), p_debugger);
  505. }
  506. void EditorDebuggerNode::_remote_object_updated(ObjectID p_id, int p_debugger) {
  507. if (p_debugger != tabs->get_current_tab()) {
  508. return;
  509. }
  510. if (EditorDebuggerRemoteObject *obj = get_inspected_remote_object()) {
  511. if (obj->remote_object_id == p_id) {
  512. return; // Already being edited
  513. }
  514. }
  515. EditorNode::get_singleton()->push_item(get_current_debugger()->get_remote_object(p_id));
  516. }
  517. void EditorDebuggerNode::_remote_object_property_updated(ObjectID p_id, const String &p_property, int p_debugger) {
  518. if (p_debugger != tabs->get_current_tab()) {
  519. return;
  520. }
  521. if (EditorDebuggerRemoteObject *obj = get_inspected_remote_object()) {
  522. if (obj->remote_object_id != p_id) {
  523. return;
  524. }
  525. InspectorDock::get_inspector_singleton()->update_property(p_property);
  526. }
  527. }
  528. void EditorDebuggerNode::_remote_object_requested(ObjectID p_id, int p_debugger) {
  529. if (p_debugger != tabs->get_current_tab()) {
  530. return;
  531. }
  532. inspect_edited_object_timeout = 0.7; // Temporarily disable timeout to avoid multiple requests.
  533. get_current_debugger()->request_remote_object(p_id);
  534. }
  535. void EditorDebuggerNode::_save_node_requested(ObjectID p_id, const String &p_file, int p_debugger) {
  536. if (p_debugger != tabs->get_current_tab()) {
  537. return;
  538. }
  539. get_current_debugger()->save_node(p_id, p_file);
  540. }
  541. // Remote inspector/edit.
  542. void EditorDebuggerNode::_method_changeds(void *p_ud, Object *p_base, const StringName &p_name, const Variant **p_args, int p_argcount) {
  543. if (!singleton) {
  544. return;
  545. }
  546. _for_all(singleton->tabs, [&](ScriptEditorDebugger *dbg) {
  547. dbg->_method_changed(p_base, p_name, p_args, p_argcount);
  548. });
  549. }
  550. void EditorDebuggerNode::_property_changeds(void *p_ud, Object *p_base, const StringName &p_property, const Variant &p_value) {
  551. if (!singleton) {
  552. return;
  553. }
  554. _for_all(singleton->tabs, [&](ScriptEditorDebugger *dbg) {
  555. dbg->_property_changed(p_base, p_property, p_value);
  556. });
  557. }
  558. // LiveDebug
  559. void EditorDebuggerNode::set_live_debugging(bool p_enabled) {
  560. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  561. dbg->set_live_debugging(p_enabled);
  562. });
  563. }
  564. void EditorDebuggerNode::update_live_edit_root() {
  565. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  566. dbg->update_live_edit_root();
  567. });
  568. }
  569. void EditorDebuggerNode::live_debug_create_node(const NodePath &p_parent, const String &p_type, const String &p_name) {
  570. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  571. dbg->live_debug_create_node(p_parent, p_type, p_name);
  572. });
  573. }
  574. void EditorDebuggerNode::live_debug_instance_node(const NodePath &p_parent, const String &p_path, const String &p_name) {
  575. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  576. dbg->live_debug_instance_node(p_parent, p_path, p_name);
  577. });
  578. }
  579. void EditorDebuggerNode::live_debug_remove_node(const NodePath &p_at) {
  580. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  581. dbg->live_debug_remove_node(p_at);
  582. });
  583. }
  584. void EditorDebuggerNode::live_debug_remove_and_keep_node(const NodePath &p_at, ObjectID p_keep_id) {
  585. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  586. dbg->live_debug_remove_and_keep_node(p_at, p_keep_id);
  587. });
  588. }
  589. void EditorDebuggerNode::live_debug_restore_node(ObjectID p_id, const NodePath &p_at, int p_at_pos) {
  590. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  591. dbg->live_debug_restore_node(p_id, p_at, p_at_pos);
  592. });
  593. }
  594. void EditorDebuggerNode::live_debug_duplicate_node(const NodePath &p_at, const String &p_new_name) {
  595. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  596. dbg->live_debug_duplicate_node(p_at, p_new_name);
  597. });
  598. }
  599. void EditorDebuggerNode::live_debug_reparent_node(const NodePath &p_at, const NodePath &p_new_place, const String &p_new_name, int p_at_pos) {
  600. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  601. dbg->live_debug_reparent_node(p_at, p_new_place, p_new_name, p_at_pos);
  602. });
  603. }
  604. void EditorDebuggerNode::set_camera_override(CameraOverride p_override) {
  605. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  606. dbg->set_camera_override(p_override);
  607. });
  608. camera_override = p_override;
  609. }
  610. EditorDebuggerNode::CameraOverride EditorDebuggerNode::get_camera_override() {
  611. return camera_override;
  612. }
  613. void EditorDebuggerNode::add_debugger_plugin(const Ref<Script> &p_script) {
  614. ERR_FAIL_COND_MSG(debugger_plugins.has(p_script), "Debugger plugin already exists.");
  615. ERR_FAIL_COND_MSG(p_script.is_null(), "Debugger plugin script is null");
  616. ERR_FAIL_COND_MSG(p_script->get_instance_base_type() == StringName(), "Debugger plugin script has error.");
  617. ERR_FAIL_COND_MSG(String(p_script->get_instance_base_type()) != "EditorDebuggerPlugin", "Base type of debugger plugin is not 'EditorDebuggerPlugin'.");
  618. ERR_FAIL_COND_MSG(!p_script->is_tool(), "Debugger plugin script is not in tool mode.");
  619. debugger_plugins.insert(p_script);
  620. for (int i = 0; get_debugger(i); i++) {
  621. get_debugger(i)->add_debugger_plugin(p_script);
  622. }
  623. }
  624. void EditorDebuggerNode::remove_debugger_plugin(const Ref<Script> &p_script) {
  625. ERR_FAIL_COND_MSG(!debugger_plugins.has(p_script), "Debugger plugin doesn't exists.");
  626. debugger_plugins.erase(p_script);
  627. for (int i = 0; get_debugger(i); i++) {
  628. get_debugger(i)->remove_debugger_plugin(p_script);
  629. }
  630. }