editor_debugger_node.cpp 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770
  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. remote_scene_tree->connect("button_clicked", callable_mp(this, &EditorDebuggerNode::_remote_tree_button_pressed));
  71. SceneTreeDock::get_singleton()->add_remote_tree_editor(remote_scene_tree);
  72. SceneTreeDock::get_singleton()->connect("remote_tree_selected", callable_mp(this, &EditorDebuggerNode::request_remote_tree));
  73. remote_scene_tree_timeout = EDITOR_DEF("debugger/remote_scene_tree_refresh_interval", 1.0);
  74. inspect_edited_object_timeout = EDITOR_DEF("debugger/remote_inspect_refresh_interval", 0.2);
  75. EditorNode *editor = EditorNode::get_singleton();
  76. editor->get_pause_button()->connect("pressed", callable_mp(this, &EditorDebuggerNode::_paused));
  77. }
  78. ScriptEditorDebugger *EditorDebuggerNode::_add_debugger() {
  79. ScriptEditorDebugger *node = memnew(ScriptEditorDebugger);
  80. int id = tabs->get_tab_count();
  81. node->connect("stop_requested", callable_mp(this, &EditorDebuggerNode::_debugger_wants_stop).bind(id));
  82. node->connect("stopped", callable_mp(this, &EditorDebuggerNode::_debugger_stopped).bind(id));
  83. node->connect("stack_frame_selected", callable_mp(this, &EditorDebuggerNode::_stack_frame_selected).bind(id));
  84. node->connect("error_selected", callable_mp(this, &EditorDebuggerNode::_error_selected).bind(id));
  85. node->connect("breakpoint_selected", callable_mp(this, &EditorDebuggerNode::_error_selected).bind(id));
  86. node->connect("clear_execution", callable_mp(this, &EditorDebuggerNode::_clear_execution));
  87. node->connect("breaked", callable_mp(this, &EditorDebuggerNode::_breaked).bind(id));
  88. node->connect("remote_tree_updated", callable_mp(this, &EditorDebuggerNode::_remote_tree_updated).bind(id));
  89. node->connect("remote_object_updated", callable_mp(this, &EditorDebuggerNode::_remote_object_updated).bind(id));
  90. node->connect("remote_object_property_updated", callable_mp(this, &EditorDebuggerNode::_remote_object_property_updated).bind(id));
  91. node->connect("remote_object_requested", callable_mp(this, &EditorDebuggerNode::_remote_object_requested).bind(id));
  92. node->connect("errors_cleared", callable_mp(this, &EditorDebuggerNode::_update_errors));
  93. if (tabs->get_tab_count() > 0) {
  94. get_debugger(0)->clear_style();
  95. }
  96. tabs->add_child(node);
  97. node->set_name("Session " + itos(tabs->get_tab_count()));
  98. if (tabs->get_tab_count() > 1) {
  99. node->clear_style();
  100. tabs->set_tabs_visible(true);
  101. tabs->add_theme_style_override("panel", EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("DebuggerPanel"), SNAME("EditorStyles")));
  102. }
  103. if (!debugger_plugins.is_empty()) {
  104. for (Ref<EditorDebuggerPlugin> plugin : debugger_plugins) {
  105. plugin->create_session(node);
  106. }
  107. }
  108. return node;
  109. }
  110. void EditorDebuggerNode::_stack_frame_selected(int p_debugger) {
  111. const ScriptEditorDebugger *dbg = get_debugger(p_debugger);
  112. ERR_FAIL_COND(!dbg);
  113. if (dbg != get_current_debugger()) {
  114. return;
  115. }
  116. _text_editor_stack_goto(dbg);
  117. }
  118. void EditorDebuggerNode::_error_selected(const String &p_file, int p_line, int p_debugger) {
  119. Ref<Script> s = ResourceLoader::load(p_file);
  120. emit_signal(SNAME("goto_script_line"), s, p_line - 1);
  121. }
  122. void EditorDebuggerNode::_text_editor_stack_goto(const ScriptEditorDebugger *p_debugger) {
  123. String file = p_debugger->get_stack_script_file();
  124. if (file.is_empty()) {
  125. return;
  126. }
  127. if (file.is_resource_file()) {
  128. stack_script = ResourceLoader::load(file);
  129. } else {
  130. // If the script is built-in, it can be opened only if the scene is loaded in memory.
  131. int i = file.find("::");
  132. int j = file.rfind("(", i);
  133. if (j > -1) { // If the script is named, the string is "name (file)", so we need to extract the path.
  134. file = file.substr(j + 1, file.find(")", i) - j - 1);
  135. }
  136. Ref<PackedScene> ps = ResourceLoader::load(file.get_slice("::", 0));
  137. stack_script = ResourceLoader::load(file);
  138. }
  139. const int line = p_debugger->get_stack_script_line() - 1;
  140. emit_signal(SNAME("goto_script_line"), stack_script, line);
  141. emit_signal(SNAME("set_execution"), stack_script, line);
  142. stack_script.unref(); // Why?!?
  143. }
  144. void EditorDebuggerNode::_bind_methods() {
  145. // LiveDebug.
  146. ClassDB::bind_method("live_debug_create_node", &EditorDebuggerNode::live_debug_create_node);
  147. ClassDB::bind_method("live_debug_instantiate_node", &EditorDebuggerNode::live_debug_instantiate_node);
  148. ClassDB::bind_method("live_debug_remove_node", &EditorDebuggerNode::live_debug_remove_node);
  149. ClassDB::bind_method("live_debug_remove_and_keep_node", &EditorDebuggerNode::live_debug_remove_and_keep_node);
  150. ClassDB::bind_method("live_debug_restore_node", &EditorDebuggerNode::live_debug_restore_node);
  151. ClassDB::bind_method("live_debug_duplicate_node", &EditorDebuggerNode::live_debug_duplicate_node);
  152. ClassDB::bind_method("live_debug_reparent_node", &EditorDebuggerNode::live_debug_reparent_node);
  153. ADD_SIGNAL(MethodInfo("goto_script_line"));
  154. ADD_SIGNAL(MethodInfo("set_execution", PropertyInfo("script"), PropertyInfo(Variant::INT, "line")));
  155. ADD_SIGNAL(MethodInfo("clear_execution", PropertyInfo("script")));
  156. ADD_SIGNAL(MethodInfo("breaked", PropertyInfo(Variant::BOOL, "reallydid"), PropertyInfo(Variant::BOOL, "can_debug")));
  157. ADD_SIGNAL(MethodInfo("breakpoint_toggled", PropertyInfo(Variant::STRING, "path"), PropertyInfo(Variant::INT, "line"), PropertyInfo(Variant::BOOL, "enabled")));
  158. }
  159. void EditorDebuggerNode::register_undo_redo(UndoRedo *p_undo_redo) {
  160. p_undo_redo->set_method_notify_callback(_method_changeds, this);
  161. p_undo_redo->set_property_notify_callback(_property_changeds, this);
  162. }
  163. EditorDebuggerRemoteObject *EditorDebuggerNode::get_inspected_remote_object() {
  164. return Object::cast_to<EditorDebuggerRemoteObject>(ObjectDB::get_instance(EditorNode::get_singleton()->get_editor_selection_history()->get_current()));
  165. }
  166. ScriptEditorDebugger *EditorDebuggerNode::get_debugger(int p_id) const {
  167. return Object::cast_to<ScriptEditorDebugger>(tabs->get_tab_control(p_id));
  168. }
  169. ScriptEditorDebugger *EditorDebuggerNode::get_current_debugger() const {
  170. return Object::cast_to<ScriptEditorDebugger>(tabs->get_tab_control(tabs->get_current_tab()));
  171. }
  172. ScriptEditorDebugger *EditorDebuggerNode::get_default_debugger() const {
  173. return Object::cast_to<ScriptEditorDebugger>(tabs->get_tab_control(0));
  174. }
  175. String EditorDebuggerNode::get_server_uri() const {
  176. ERR_FAIL_COND_V(server.is_null(), "");
  177. return server->get_uri();
  178. }
  179. void EditorDebuggerNode::set_keep_open(bool p_keep_open) {
  180. keep_open = p_keep_open;
  181. if (keep_open) {
  182. if (server.is_null() || !server->is_active()) {
  183. start();
  184. }
  185. } else {
  186. bool found = false;
  187. _for_all(tabs, [&](ScriptEditorDebugger *p_debugger) {
  188. if (p_debugger->is_session_active()) {
  189. found = true;
  190. }
  191. });
  192. if (!found) {
  193. stop();
  194. }
  195. }
  196. }
  197. Error EditorDebuggerNode::start(const String &p_uri) {
  198. ERR_FAIL_COND_V(p_uri.find("://") < 0, ERR_INVALID_PARAMETER);
  199. if (keep_open && current_uri == p_uri && server.is_valid()) {
  200. return OK;
  201. }
  202. stop(true);
  203. current_uri = p_uri;
  204. if (EDITOR_GET("run/output/always_open_output_on_play")) {
  205. EditorNode::get_singleton()->make_bottom_panel_item_visible(EditorNode::get_log());
  206. } else {
  207. EditorNode::get_singleton()->make_bottom_panel_item_visible(this);
  208. }
  209. server = Ref<EditorDebuggerServer>(EditorDebuggerServer::create(p_uri.substr(0, p_uri.find("://") + 3)));
  210. const Error err = server->start(p_uri);
  211. if (err != OK) {
  212. return err;
  213. }
  214. set_process(true);
  215. EditorNode::get_log()->add_message("--- Debugging process started ---", EditorLog::MSG_TYPE_EDITOR);
  216. return OK;
  217. }
  218. void EditorDebuggerNode::stop(bool p_force) {
  219. if (keep_open && !p_force) {
  220. return;
  221. }
  222. current_uri.clear();
  223. if (server.is_valid()) {
  224. server->stop();
  225. EditorNode::get_log()->add_message("--- Debugging process stopped ---", EditorLog::MSG_TYPE_EDITOR);
  226. if (EditorNode::get_singleton()->is_movie_maker_enabled()) {
  227. // Request attention in case the user was doing something else when movie recording is finished.
  228. DisplayServer::get_singleton()->window_request_attention();
  229. }
  230. server.unref();
  231. }
  232. // Also close all debugging sessions.
  233. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  234. if (dbg->is_session_active()) {
  235. dbg->_stop_and_notify();
  236. }
  237. });
  238. _break_state_changed();
  239. breakpoints.clear();
  240. set_process(false);
  241. }
  242. void EditorDebuggerNode::_notification(int p_what) {
  243. switch (p_what) {
  244. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  245. if (tabs->get_tab_count() > 1) {
  246. add_theme_constant_override("margin_left", -EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("BottomPanelDebuggerOverride"), SNAME("EditorStyles"))->get_margin(SIDE_LEFT));
  247. add_theme_constant_override("margin_right", -EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("BottomPanelDebuggerOverride"), SNAME("EditorStyles"))->get_margin(SIDE_RIGHT));
  248. tabs->add_theme_style_override("panel", EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("DebuggerPanel"), SNAME("EditorStyles")));
  249. }
  250. } break;
  251. case NOTIFICATION_READY: {
  252. _update_debug_options();
  253. } break;
  254. case NOTIFICATION_PROCESS: {
  255. if (!server.is_valid()) {
  256. return;
  257. }
  258. if (!server->is_active()) {
  259. stop();
  260. return;
  261. }
  262. server->poll();
  263. _update_errors();
  264. // Remote scene tree update
  265. remote_scene_tree_timeout -= get_process_delta_time();
  266. if (remote_scene_tree_timeout < 0) {
  267. remote_scene_tree_timeout = EDITOR_GET("debugger/remote_scene_tree_refresh_interval");
  268. if (remote_scene_tree->is_visible_in_tree()) {
  269. get_current_debugger()->request_remote_tree();
  270. }
  271. }
  272. // Remote inspector update
  273. inspect_edited_object_timeout -= get_process_delta_time();
  274. if (inspect_edited_object_timeout < 0) {
  275. inspect_edited_object_timeout = EDITOR_GET("debugger/remote_inspect_refresh_interval");
  276. if (EditorDebuggerRemoteObject *obj = get_inspected_remote_object()) {
  277. get_current_debugger()->request_remote_object(obj->remote_object_id);
  278. }
  279. }
  280. // Take connections.
  281. if (server->is_connection_available()) {
  282. ScriptEditorDebugger *debugger = nullptr;
  283. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  284. if (debugger || dbg->is_session_active()) {
  285. return;
  286. }
  287. debugger = dbg;
  288. });
  289. if (debugger == nullptr) {
  290. if (tabs->get_tab_count() <= 4) { // Max 4 debugging sessions active.
  291. debugger = _add_debugger();
  292. } else {
  293. // We already have too many sessions, disconnecting new clients to prevent them from hanging.
  294. server->take_connection()->close();
  295. return; // Can't add, stop here.
  296. }
  297. }
  298. EditorNode::get_singleton()->get_pause_button()->set_disabled(false);
  299. // Switch to remote tree view if so desired.
  300. auto_switch_remote_scene_tree = (bool)EDITOR_GET("debugger/auto_switch_to_remote_scene_tree");
  301. if (auto_switch_remote_scene_tree) {
  302. SceneTreeDock::get_singleton()->show_remote_tree();
  303. }
  304. // Good to go.
  305. SceneTreeDock::get_singleton()->show_tab_buttons();
  306. debugger->set_editor_remote_tree(remote_scene_tree);
  307. debugger->start(server->take_connection());
  308. // Send breakpoints.
  309. for (const KeyValue<Breakpoint, bool> &E : breakpoints) {
  310. const Breakpoint &bp = E.key;
  311. debugger->set_breakpoint(bp.source, bp.line, E.value);
  312. } // Will arrive too late, how does the regular run work?
  313. debugger->update_live_edit_root();
  314. }
  315. } break;
  316. }
  317. }
  318. void EditorDebuggerNode::_update_errors() {
  319. int error_count = 0;
  320. int warning_count = 0;
  321. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  322. error_count += dbg->get_error_count();
  323. warning_count += dbg->get_warning_count();
  324. });
  325. if (error_count != last_error_count || warning_count != last_warning_count) {
  326. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  327. dbg->update_tabs();
  328. });
  329. if (error_count == 0 && warning_count == 0) {
  330. debugger_button->set_text(TTR("Debugger"));
  331. debugger_button->remove_theme_color_override("font_color");
  332. debugger_button->set_icon(Ref<Texture2D>());
  333. } else {
  334. debugger_button->set_text(TTR("Debugger") + " (" + itos(error_count + warning_count) + ")");
  335. if (error_count >= 1 && warning_count >= 1) {
  336. debugger_button->set_icon(get_theme_icon(SNAME("ErrorWarning"), SNAME("EditorIcons")));
  337. // Use error color to represent the highest level of severity reported.
  338. debugger_button->add_theme_color_override("font_color", get_theme_color(SNAME("error_color"), SNAME("Editor")));
  339. } else if (error_count >= 1) {
  340. debugger_button->set_icon(get_theme_icon(SNAME("Error"), SNAME("EditorIcons")));
  341. debugger_button->add_theme_color_override("font_color", get_theme_color(SNAME("error_color"), SNAME("Editor")));
  342. } else {
  343. debugger_button->set_icon(get_theme_icon(SNAME("Warning"), SNAME("EditorIcons")));
  344. debugger_button->add_theme_color_override("font_color", get_theme_color(SNAME("warning_color"), SNAME("Editor")));
  345. }
  346. }
  347. last_error_count = error_count;
  348. last_warning_count = warning_count;
  349. }
  350. }
  351. void EditorDebuggerNode::_debugger_stopped(int p_id) {
  352. ScriptEditorDebugger *dbg = get_debugger(p_id);
  353. ERR_FAIL_COND(!dbg);
  354. bool found = false;
  355. _for_all(tabs, [&](ScriptEditorDebugger *p_debugger) {
  356. if (p_debugger->is_session_active()) {
  357. found = true;
  358. }
  359. });
  360. if (!found) {
  361. EditorNode::get_singleton()->get_pause_button()->set_pressed(false);
  362. EditorNode::get_singleton()->get_pause_button()->set_disabled(true);
  363. SceneTreeDock::get_singleton()->hide_remote_tree();
  364. SceneTreeDock::get_singleton()->hide_tab_buttons();
  365. EditorNode::get_singleton()->notify_all_debug_sessions_exited();
  366. }
  367. }
  368. void EditorDebuggerNode::_debugger_wants_stop(int p_id) {
  369. // Ask editor to kill PID.
  370. int pid = get_debugger(p_id)->get_remote_pid();
  371. if (pid) {
  372. EditorNode::get_singleton()->call_deferred(SNAME("stop_child_process"), pid);
  373. }
  374. }
  375. void EditorDebuggerNode::_debugger_changed(int p_tab) {
  376. if (get_inspected_remote_object()) {
  377. // Clear inspected object, you can only inspect objects in selected debugger.
  378. // Hopefully, in the future, we will have one inspector per debugger.
  379. EditorNode::get_singleton()->push_item(nullptr);
  380. }
  381. if (remote_scene_tree->is_visible_in_tree()) {
  382. get_current_debugger()->request_remote_tree();
  383. }
  384. if (get_current_debugger()->is_breaked()) {
  385. _text_editor_stack_goto(get_current_debugger());
  386. }
  387. }
  388. void EditorDebuggerNode::set_script_debug_button(MenuButton *p_button) {
  389. script_menu = p_button;
  390. script_menu->set_text(TTR("Debug"));
  391. script_menu->set_switch_on_hover(true);
  392. PopupMenu *p = script_menu->get_popup();
  393. p->add_shortcut(ED_GET_SHORTCUT("debugger/step_into"), DEBUG_STEP);
  394. p->add_shortcut(ED_GET_SHORTCUT("debugger/step_over"), DEBUG_NEXT);
  395. p->add_separator();
  396. p->add_shortcut(ED_GET_SHORTCUT("debugger/break"), DEBUG_BREAK);
  397. p->add_shortcut(ED_GET_SHORTCUT("debugger/continue"), DEBUG_CONTINUE);
  398. p->add_separator();
  399. p->add_check_shortcut(ED_GET_SHORTCUT("debugger/debug_with_external_editor"), DEBUG_WITH_EXTERNAL_EDITOR);
  400. p->connect("id_pressed", callable_mp(this, &EditorDebuggerNode::_menu_option));
  401. _break_state_changed();
  402. script_menu->show();
  403. }
  404. void EditorDebuggerNode::_break_state_changed() {
  405. const bool breaked = get_current_debugger()->is_breaked();
  406. const bool can_debug = get_current_debugger()->is_debuggable();
  407. if (breaked) { // Show debugger.
  408. EditorNode::get_singleton()->make_bottom_panel_item_visible(this);
  409. }
  410. // Update script menu.
  411. if (!script_menu) {
  412. return;
  413. }
  414. PopupMenu *p = script_menu->get_popup();
  415. p->set_item_disabled(p->get_item_index(DEBUG_NEXT), !(breaked && can_debug));
  416. p->set_item_disabled(p->get_item_index(DEBUG_STEP), !(breaked && can_debug));
  417. p->set_item_disabled(p->get_item_index(DEBUG_BREAK), breaked);
  418. p->set_item_disabled(p->get_item_index(DEBUG_CONTINUE), !breaked);
  419. }
  420. void EditorDebuggerNode::_menu_option(int p_id) {
  421. switch (p_id) {
  422. case DEBUG_NEXT: {
  423. debug_next();
  424. } break;
  425. case DEBUG_STEP: {
  426. debug_step();
  427. } break;
  428. case DEBUG_BREAK: {
  429. debug_break();
  430. } break;
  431. case DEBUG_CONTINUE: {
  432. debug_continue();
  433. } break;
  434. case DEBUG_WITH_EXTERNAL_EDITOR: {
  435. bool ischecked = script_menu->get_popup()->is_item_checked(script_menu->get_popup()->get_item_index(DEBUG_WITH_EXTERNAL_EDITOR));
  436. debug_with_external_editor = !ischecked;
  437. script_menu->get_popup()->set_item_checked(script_menu->get_popup()->get_item_index(DEBUG_WITH_EXTERNAL_EDITOR), !ischecked);
  438. EditorSettings::get_singleton()->set_project_metadata("debug_options", "debug_with_external_editor", !ischecked);
  439. } break;
  440. }
  441. }
  442. void EditorDebuggerNode::_update_debug_options() {
  443. if (EditorSettings::get_singleton()->get_project_metadata("debug_options", "debug_with_external_editor", false).operator bool()) {
  444. _menu_option(DEBUG_WITH_EXTERNAL_EDITOR);
  445. }
  446. }
  447. void EditorDebuggerNode::_paused() {
  448. const bool paused = EditorNode::get_singleton()->get_pause_button()->is_pressed();
  449. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  450. if (paused && !dbg->is_breaked()) {
  451. dbg->debug_break();
  452. } else if (!paused && dbg->is_breaked()) {
  453. dbg->debug_continue();
  454. }
  455. });
  456. }
  457. void EditorDebuggerNode::_breaked(bool p_breaked, bool p_can_debug, String p_message, bool p_has_stackdump, int p_debugger) {
  458. if (get_current_debugger() != get_debugger(p_debugger)) {
  459. if (!p_breaked) {
  460. return;
  461. }
  462. tabs->set_current_tab(p_debugger);
  463. }
  464. _break_state_changed();
  465. EditorNode::get_singleton()->get_pause_button()->set_pressed(p_breaked);
  466. emit_signal(SNAME("breaked"), p_breaked, p_can_debug);
  467. }
  468. bool EditorDebuggerNode::is_skip_breakpoints() const {
  469. return get_default_debugger()->is_skip_breakpoints();
  470. }
  471. void EditorDebuggerNode::set_breakpoint(const String &p_path, int p_line, bool p_enabled) {
  472. breakpoints[Breakpoint(p_path, p_line)] = p_enabled;
  473. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  474. dbg->set_breakpoint(p_path, p_line, p_enabled);
  475. });
  476. emit_signal(SNAME("breakpoint_toggled"), p_path, p_line, p_enabled);
  477. }
  478. void EditorDebuggerNode::set_breakpoints(const String &p_path, Array p_lines) {
  479. for (int i = 0; i < p_lines.size(); i++) {
  480. set_breakpoint(p_path, p_lines[i], true);
  481. }
  482. for (const KeyValue<Breakpoint, bool> &E : breakpoints) {
  483. Breakpoint b = E.key;
  484. if (b.source == p_path && !p_lines.has(b.line)) {
  485. set_breakpoint(p_path, b.line, false);
  486. }
  487. }
  488. }
  489. void EditorDebuggerNode::reload_scripts() {
  490. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  491. dbg->reload_scripts();
  492. });
  493. }
  494. void EditorDebuggerNode::debug_next() {
  495. get_default_debugger()->debug_next();
  496. }
  497. void EditorDebuggerNode::debug_step() {
  498. get_default_debugger()->debug_step();
  499. }
  500. void EditorDebuggerNode::debug_break() {
  501. get_default_debugger()->debug_break();
  502. }
  503. void EditorDebuggerNode::debug_continue() {
  504. get_default_debugger()->debug_continue();
  505. }
  506. String EditorDebuggerNode::get_var_value(const String &p_var) const {
  507. return get_default_debugger()->get_var_value(p_var);
  508. }
  509. // LiveEdit/Inspector
  510. void EditorDebuggerNode::request_remote_tree() {
  511. get_current_debugger()->request_remote_tree();
  512. }
  513. void EditorDebuggerNode::_remote_tree_updated(int p_debugger) {
  514. if (p_debugger != tabs->get_current_tab()) {
  515. return;
  516. }
  517. remote_scene_tree->clear();
  518. remote_scene_tree->update_scene_tree(get_current_debugger()->get_remote_tree(), p_debugger);
  519. }
  520. void EditorDebuggerNode::_remote_tree_button_pressed(Object *p_item, int p_column, int p_id, MouseButton p_button) {
  521. if (p_button != MouseButton::LEFT) {
  522. return;
  523. }
  524. TreeItem *item = Object::cast_to<TreeItem>(p_item);
  525. ERR_FAIL_COND(!item);
  526. if (p_id == EditorDebuggerTree::BUTTON_SUBSCENE) {
  527. remote_scene_tree->emit_signal(SNAME("open"), item->get_meta("scene_file_path"));
  528. } else if (p_id == EditorDebuggerTree::BUTTON_VISIBILITY) {
  529. ObjectID obj_id = item->get_metadata(0);
  530. ERR_FAIL_COND(obj_id.is_null());
  531. get_current_debugger()->update_remote_object(obj_id, "visible", !item->get_meta("visible"));
  532. get_current_debugger()->request_remote_tree();
  533. }
  534. }
  535. void EditorDebuggerNode::_remote_object_updated(ObjectID p_id, int p_debugger) {
  536. if (p_debugger != tabs->get_current_tab()) {
  537. return;
  538. }
  539. if (EditorDebuggerRemoteObject *obj = get_inspected_remote_object()) {
  540. if (obj->remote_object_id == p_id) {
  541. return; // Already being edited
  542. }
  543. }
  544. EditorNode::get_singleton()->push_item(get_current_debugger()->get_remote_object(p_id));
  545. }
  546. void EditorDebuggerNode::_remote_object_property_updated(ObjectID p_id, const String &p_property, int p_debugger) {
  547. if (p_debugger != tabs->get_current_tab()) {
  548. return;
  549. }
  550. if (EditorDebuggerRemoteObject *obj = get_inspected_remote_object()) {
  551. if (obj->remote_object_id != p_id) {
  552. return;
  553. }
  554. InspectorDock::get_inspector_singleton()->update_property(p_property);
  555. }
  556. }
  557. void EditorDebuggerNode::_remote_object_requested(ObjectID p_id, int p_debugger) {
  558. if (p_debugger != tabs->get_current_tab()) {
  559. return;
  560. }
  561. inspect_edited_object_timeout = 0.7; // Temporarily disable timeout to avoid multiple requests.
  562. get_current_debugger()->request_remote_object(p_id);
  563. }
  564. void EditorDebuggerNode::_save_node_requested(ObjectID p_id, const String &p_file, int p_debugger) {
  565. if (p_debugger != tabs->get_current_tab()) {
  566. return;
  567. }
  568. get_current_debugger()->save_node(p_id, p_file);
  569. }
  570. // Remote inspector/edit.
  571. void EditorDebuggerNode::_method_changeds(void *p_ud, Object *p_base, const StringName &p_name, const Variant **p_args, int p_argcount) {
  572. if (!singleton) {
  573. return;
  574. }
  575. _for_all(singleton->tabs, [&](ScriptEditorDebugger *dbg) {
  576. dbg->_method_changed(p_base, p_name, p_args, p_argcount);
  577. });
  578. }
  579. void EditorDebuggerNode::_property_changeds(void *p_ud, Object *p_base, const StringName &p_property, const Variant &p_value) {
  580. if (!singleton) {
  581. return;
  582. }
  583. _for_all(singleton->tabs, [&](ScriptEditorDebugger *dbg) {
  584. dbg->_property_changed(p_base, p_property, p_value);
  585. });
  586. }
  587. // LiveDebug
  588. void EditorDebuggerNode::set_live_debugging(bool p_enabled) {
  589. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  590. dbg->set_live_debugging(p_enabled);
  591. });
  592. }
  593. void EditorDebuggerNode::update_live_edit_root() {
  594. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  595. dbg->update_live_edit_root();
  596. });
  597. }
  598. void EditorDebuggerNode::live_debug_create_node(const NodePath &p_parent, const String &p_type, const String &p_name) {
  599. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  600. dbg->live_debug_create_node(p_parent, p_type, p_name);
  601. });
  602. }
  603. void EditorDebuggerNode::live_debug_instantiate_node(const NodePath &p_parent, const String &p_path, const String &p_name) {
  604. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  605. dbg->live_debug_instantiate_node(p_parent, p_path, p_name);
  606. });
  607. }
  608. void EditorDebuggerNode::live_debug_remove_node(const NodePath &p_at) {
  609. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  610. dbg->live_debug_remove_node(p_at);
  611. });
  612. }
  613. void EditorDebuggerNode::live_debug_remove_and_keep_node(const NodePath &p_at, ObjectID p_keep_id) {
  614. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  615. dbg->live_debug_remove_and_keep_node(p_at, p_keep_id);
  616. });
  617. }
  618. void EditorDebuggerNode::live_debug_restore_node(ObjectID p_id, const NodePath &p_at, int p_at_pos) {
  619. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  620. dbg->live_debug_restore_node(p_id, p_at, p_at_pos);
  621. });
  622. }
  623. void EditorDebuggerNode::live_debug_duplicate_node(const NodePath &p_at, const String &p_new_name) {
  624. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  625. dbg->live_debug_duplicate_node(p_at, p_new_name);
  626. });
  627. }
  628. void EditorDebuggerNode::live_debug_reparent_node(const NodePath &p_at, const NodePath &p_new_place, const String &p_new_name, int p_at_pos) {
  629. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  630. dbg->live_debug_reparent_node(p_at, p_new_place, p_new_name, p_at_pos);
  631. });
  632. }
  633. void EditorDebuggerNode::set_camera_override(CameraOverride p_override) {
  634. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  635. dbg->set_camera_override(p_override);
  636. });
  637. camera_override = p_override;
  638. }
  639. EditorDebuggerNode::CameraOverride EditorDebuggerNode::get_camera_override() {
  640. return camera_override;
  641. }
  642. void EditorDebuggerNode::add_debugger_plugin(const Ref<EditorDebuggerPlugin> &p_plugin) {
  643. ERR_FAIL_COND_MSG(p_plugin.is_null(), "Debugger plugin is null.");
  644. ERR_FAIL_COND_MSG(debugger_plugins.has(p_plugin), "Debugger plugin already exists.");
  645. debugger_plugins.insert(p_plugin);
  646. Ref<EditorDebuggerPlugin> plugin = p_plugin;
  647. for (int i = 0; get_debugger(i); i++) {
  648. plugin->create_session(get_debugger(i));
  649. }
  650. }
  651. void EditorDebuggerNode::remove_debugger_plugin(const Ref<EditorDebuggerPlugin> &p_plugin) {
  652. ERR_FAIL_COND_MSG(p_plugin.is_null(), "Debugger plugin is null.");
  653. ERR_FAIL_COND_MSG(!debugger_plugins.has(p_plugin), "Debugger plugin doesn't exists.");
  654. debugger_plugins.erase(p_plugin);
  655. Ref<EditorDebuggerPlugin>(p_plugin)->clear();
  656. }
  657. bool EditorDebuggerNode::plugins_capture(ScriptEditorDebugger *p_debugger, const String &p_message, const Array &p_data) {
  658. int session_index = tabs->get_tab_idx_from_control(p_debugger);
  659. ERR_FAIL_COND_V(session_index < 0, false);
  660. int colon_index = p_message.find_char(':');
  661. ERR_FAIL_COND_V_MSG(colon_index < 1, false, "Invalid message received.");
  662. const String cap = p_message.substr(0, colon_index);
  663. bool parsed = false;
  664. for (Ref<EditorDebuggerPlugin> plugin : debugger_plugins) {
  665. if (plugin->has_capture(cap)) {
  666. parsed |= plugin->capture(p_message, p_data, session_index);
  667. }
  668. }
  669. return parsed;
  670. }