editor_debugger_node.cpp 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718
  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 "editor/debugger/editor_debugger_tree.h"
  32. #include "editor/debugger/script_editor_debugger.h"
  33. #include "editor/editor_log.h"
  34. #include "editor/editor_node.h"
  35. #include "editor/plugins/editor_debugger_plugin.h"
  36. #include "editor/plugins/script_editor_plugin.h"
  37. #include "editor/scene_tree_dock.h"
  38. #include "scene/gui/menu_button.h"
  39. #include "scene/gui/tab_container.h"
  40. #include "scene/resources/packed_scene.h"
  41. template <typename Func>
  42. void _for_all(TabContainer *p_node, const Func &p_func) {
  43. for (int i = 0; i < p_node->get_tab_count(); i++) {
  44. ScriptEditorDebugger *dbg = Object::cast_to<ScriptEditorDebugger>(p_node->get_tab_control(i));
  45. ERR_FAIL_COND(!dbg);
  46. p_func(dbg);
  47. }
  48. }
  49. EditorDebuggerNode *EditorDebuggerNode::singleton = nullptr;
  50. EditorDebuggerNode::EditorDebuggerNode() {
  51. if (!singleton) {
  52. singleton = this;
  53. }
  54. add_theme_constant_override("margin_left", -EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("BottomPanelDebuggerOverride"), SNAME("EditorStyles"))->get_margin(SIDE_LEFT));
  55. add_theme_constant_override("margin_right", -EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("BottomPanelDebuggerOverride"), SNAME("EditorStyles"))->get_margin(SIDE_RIGHT));
  56. tabs = memnew(TabContainer);
  57. tabs->set_tabs_visible(false);
  58. tabs->connect("tab_changed", callable_mp(this, &EditorDebuggerNode::_debugger_changed));
  59. add_child(tabs);
  60. Ref<StyleBoxEmpty> empty;
  61. empty.instantiate();
  62. tabs->add_theme_style_override("panel", empty);
  63. auto_switch_remote_scene_tree = EDITOR_DEF("debugger/auto_switch_to_remote_scene_tree", false);
  64. _add_debugger();
  65. // Remote scene tree
  66. remote_scene_tree = memnew(EditorDebuggerTree);
  67. remote_scene_tree->connect("object_selected", callable_mp(this, &EditorDebuggerNode::_remote_object_requested));
  68. remote_scene_tree->connect("save_node", callable_mp(this, &EditorDebuggerNode::_save_node_requested));
  69. SceneTreeDock::get_singleton()->add_remote_tree_editor(remote_scene_tree);
  70. SceneTreeDock::get_singleton()->connect("remote_tree_selected", callable_mp(this, &EditorDebuggerNode::request_remote_tree));
  71. remote_scene_tree_timeout = EDITOR_DEF("debugger/remote_scene_tree_refresh_interval", 1.0);
  72. inspect_edited_object_timeout = EDITOR_DEF("debugger/remote_inspect_refresh_interval", 0.2);
  73. EditorNode *editor = EditorNode::get_singleton();
  74. editor->get_undo_redo()->set_method_notify_callback(_method_changeds, this);
  75. editor->get_undo_redo()->set_property_notify_callback(_property_changeds, this);
  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 (const Ref<Script> &i : debugger_plugins) {
  105. node->add_debugger_plugin(i);
  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_instance_node", &EditorDebuggerNode::live_debug_instance_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. EditorDebuggerRemoteObject *EditorDebuggerNode::get_inspected_remote_object() {
  160. return Object::cast_to<EditorDebuggerRemoteObject>(ObjectDB::get_instance(EditorNode::get_singleton()->get_editor_selection_history()->get_current()));
  161. }
  162. ScriptEditorDebugger *EditorDebuggerNode::get_debugger(int p_id) const {
  163. return Object::cast_to<ScriptEditorDebugger>(tabs->get_tab_control(p_id));
  164. }
  165. ScriptEditorDebugger *EditorDebuggerNode::get_current_debugger() const {
  166. return Object::cast_to<ScriptEditorDebugger>(tabs->get_tab_control(tabs->get_current_tab()));
  167. }
  168. ScriptEditorDebugger *EditorDebuggerNode::get_default_debugger() const {
  169. return Object::cast_to<ScriptEditorDebugger>(tabs->get_tab_control(0));
  170. }
  171. String EditorDebuggerNode::get_server_uri() const {
  172. ERR_FAIL_COND_V(server.is_null(), "");
  173. return server->get_uri();
  174. }
  175. Error EditorDebuggerNode::start(const String &p_uri) {
  176. stop();
  177. ERR_FAIL_COND_V(p_uri.find("://") < 0, ERR_INVALID_PARAMETER);
  178. if (EDITOR_GET("run/output/always_open_output_on_play")) {
  179. EditorNode::get_singleton()->make_bottom_panel_item_visible(EditorNode::get_log());
  180. } else {
  181. EditorNode::get_singleton()->make_bottom_panel_item_visible(this);
  182. }
  183. server = Ref<EditorDebuggerServer>(EditorDebuggerServer::create(p_uri.substr(0, p_uri.find("://") + 3)));
  184. const Error err = server->start(p_uri);
  185. if (err != OK) {
  186. return err;
  187. }
  188. set_process(true);
  189. EditorNode::get_log()->add_message("--- Debugging process started ---", EditorLog::MSG_TYPE_EDITOR);
  190. return OK;
  191. }
  192. void EditorDebuggerNode::stop() {
  193. if (server.is_valid()) {
  194. server->stop();
  195. EditorNode::get_log()->add_message("--- Debugging process stopped ---", EditorLog::MSG_TYPE_EDITOR);
  196. server.unref();
  197. }
  198. // Also close all debugging sessions.
  199. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  200. if (dbg->is_session_active()) {
  201. dbg->_stop_and_notify();
  202. }
  203. });
  204. _break_state_changed();
  205. if (hide_on_stop) {
  206. if (is_visible_in_tree()) {
  207. EditorNode::get_singleton()->hide_bottom_panel();
  208. }
  209. }
  210. breakpoints.clear();
  211. set_process(false);
  212. }
  213. void EditorDebuggerNode::_notification(int p_what) {
  214. switch (p_what) {
  215. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  216. if (tabs->get_tab_count() > 1) {
  217. add_theme_constant_override("margin_left", -EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("BottomPanelDebuggerOverride"), SNAME("EditorStyles"))->get_margin(SIDE_LEFT));
  218. add_theme_constant_override("margin_right", -EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("BottomPanelDebuggerOverride"), SNAME("EditorStyles"))->get_margin(SIDE_RIGHT));
  219. tabs->add_theme_style_override("panel", EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("DebuggerPanel"), SNAME("EditorStyles")));
  220. }
  221. } break;
  222. case NOTIFICATION_READY: {
  223. _update_debug_options();
  224. } break;
  225. case NOTIFICATION_PROCESS: {
  226. if (!server.is_valid()) {
  227. return;
  228. }
  229. if (!server->is_active()) {
  230. stop();
  231. return;
  232. }
  233. server->poll();
  234. _update_errors();
  235. // Remote scene tree update
  236. remote_scene_tree_timeout -= get_process_delta_time();
  237. if (remote_scene_tree_timeout < 0) {
  238. remote_scene_tree_timeout = EditorSettings::get_singleton()->get("debugger/remote_scene_tree_refresh_interval");
  239. if (remote_scene_tree->is_visible_in_tree()) {
  240. get_current_debugger()->request_remote_tree();
  241. }
  242. }
  243. // Remote inspector update
  244. inspect_edited_object_timeout -= get_process_delta_time();
  245. if (inspect_edited_object_timeout < 0) {
  246. inspect_edited_object_timeout = EditorSettings::get_singleton()->get("debugger/remote_inspect_refresh_interval");
  247. if (EditorDebuggerRemoteObject *obj = get_inspected_remote_object()) {
  248. get_current_debugger()->request_remote_object(obj->remote_object_id);
  249. }
  250. }
  251. // Take connections.
  252. if (server->is_connection_available()) {
  253. ScriptEditorDebugger *debugger = nullptr;
  254. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  255. if (debugger || dbg->is_session_active()) {
  256. return;
  257. }
  258. debugger = dbg;
  259. });
  260. if (debugger == nullptr) {
  261. if (tabs->get_tab_count() <= 4) { // Max 4 debugging sessions active.
  262. debugger = _add_debugger();
  263. } else {
  264. // We already have too many sessions, disconnecting new clients to prevent them from hanging.
  265. server->take_connection()->close();
  266. return; // Can't add, stop here.
  267. }
  268. }
  269. EditorNode::get_singleton()->get_pause_button()->set_disabled(false);
  270. // Switch to remote tree view if so desired.
  271. auto_switch_remote_scene_tree = (bool)EditorSettings::get_singleton()->get("debugger/auto_switch_to_remote_scene_tree");
  272. if (auto_switch_remote_scene_tree) {
  273. SceneTreeDock::get_singleton()->show_remote_tree();
  274. }
  275. // Good to go.
  276. SceneTreeDock::get_singleton()->show_tab_buttons();
  277. debugger->set_editor_remote_tree(remote_scene_tree);
  278. debugger->start(server->take_connection());
  279. // Send breakpoints.
  280. for (const KeyValue<Breakpoint, bool> &E : breakpoints) {
  281. const Breakpoint &bp = E.key;
  282. debugger->set_breakpoint(bp.source, bp.line, E.value);
  283. } // Will arrive too late, how does the regular run work?
  284. debugger->update_live_edit_root();
  285. }
  286. } break;
  287. }
  288. }
  289. void EditorDebuggerNode::_update_errors() {
  290. int error_count = 0;
  291. int warning_count = 0;
  292. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  293. error_count += dbg->get_error_count();
  294. warning_count += dbg->get_warning_count();
  295. });
  296. if (error_count != last_error_count || warning_count != last_warning_count) {
  297. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  298. dbg->update_tabs();
  299. });
  300. if (error_count == 0 && warning_count == 0) {
  301. debugger_button->set_text(TTR("Debugger"));
  302. debugger_button->remove_theme_color_override("font_color");
  303. debugger_button->set_icon(Ref<Texture2D>());
  304. } else {
  305. debugger_button->set_text(TTR("Debugger") + " (" + itos(error_count + warning_count) + ")");
  306. if (error_count >= 1 && warning_count >= 1) {
  307. debugger_button->set_icon(get_theme_icon(SNAME("ErrorWarning"), SNAME("EditorIcons")));
  308. // Use error color to represent the highest level of severity reported.
  309. debugger_button->add_theme_color_override("font_color", get_theme_color(SNAME("error_color"), SNAME("Editor")));
  310. } else if (error_count >= 1) {
  311. debugger_button->set_icon(get_theme_icon(SNAME("Error"), SNAME("EditorIcons")));
  312. debugger_button->add_theme_color_override("font_color", get_theme_color(SNAME("error_color"), SNAME("Editor")));
  313. } else {
  314. debugger_button->set_icon(get_theme_icon(SNAME("Warning"), SNAME("EditorIcons")));
  315. debugger_button->add_theme_color_override("font_color", get_theme_color(SNAME("warning_color"), SNAME("Editor")));
  316. }
  317. }
  318. last_error_count = error_count;
  319. last_warning_count = warning_count;
  320. }
  321. }
  322. void EditorDebuggerNode::_debugger_stopped(int p_id) {
  323. ScriptEditorDebugger *dbg = get_debugger(p_id);
  324. ERR_FAIL_COND(!dbg);
  325. bool found = false;
  326. _for_all(tabs, [&](ScriptEditorDebugger *p_debugger) {
  327. if (p_debugger->is_session_active()) {
  328. found = true;
  329. }
  330. });
  331. if (!found) {
  332. EditorNode::get_singleton()->get_pause_button()->set_pressed(false);
  333. EditorNode::get_singleton()->get_pause_button()->set_disabled(true);
  334. SceneTreeDock::get_singleton()->hide_remote_tree();
  335. SceneTreeDock::get_singleton()->hide_tab_buttons();
  336. EditorNode::get_singleton()->notify_all_debug_sessions_exited();
  337. }
  338. }
  339. void EditorDebuggerNode::_debugger_wants_stop(int p_id) {
  340. // Ask editor to kill PID.
  341. int pid = get_debugger(p_id)->get_remote_pid();
  342. if (pid) {
  343. EditorNode::get_singleton()->call_deferred(SNAME("stop_child_process"), pid);
  344. }
  345. }
  346. void EditorDebuggerNode::_debugger_changed(int p_tab) {
  347. if (get_inspected_remote_object()) {
  348. // Clear inspected object, you can only inspect objects in selected debugger.
  349. // Hopefully, in the future, we will have one inspector per debugger.
  350. EditorNode::get_singleton()->push_item(nullptr);
  351. }
  352. if (remote_scene_tree->is_visible_in_tree()) {
  353. get_current_debugger()->request_remote_tree();
  354. }
  355. if (get_current_debugger()->is_breaked()) {
  356. _text_editor_stack_goto(get_current_debugger());
  357. }
  358. }
  359. void EditorDebuggerNode::set_script_debug_button(MenuButton *p_button) {
  360. script_menu = p_button;
  361. script_menu->set_text(TTR("Debug"));
  362. script_menu->set_switch_on_hover(true);
  363. PopupMenu *p = script_menu->get_popup();
  364. p->add_shortcut(ED_GET_SHORTCUT("debugger/step_into"), DEBUG_STEP);
  365. p->add_shortcut(ED_GET_SHORTCUT("debugger/step_over"), DEBUG_NEXT);
  366. p->add_separator();
  367. p->add_shortcut(ED_GET_SHORTCUT("debugger/break"), DEBUG_BREAK);
  368. p->add_shortcut(ED_GET_SHORTCUT("debugger/continue"), DEBUG_CONTINUE);
  369. p->add_separator();
  370. p->add_check_shortcut(ED_GET_SHORTCUT("debugger/keep_debugger_open"), DEBUG_KEEP_DEBUGGER_OPEN);
  371. p->add_check_shortcut(ED_GET_SHORTCUT("debugger/debug_with_external_editor"), DEBUG_WITH_EXTERNAL_EDITOR);
  372. p->connect("id_pressed", callable_mp(this, &EditorDebuggerNode::_menu_option));
  373. _break_state_changed();
  374. script_menu->show();
  375. }
  376. void EditorDebuggerNode::_break_state_changed() {
  377. const bool breaked = get_current_debugger()->is_breaked();
  378. const bool can_debug = get_current_debugger()->is_debuggable();
  379. if (breaked) { // Show debugger.
  380. EditorNode::get_singleton()->make_bottom_panel_item_visible(this);
  381. }
  382. // Update script menu.
  383. if (!script_menu) {
  384. return;
  385. }
  386. PopupMenu *p = script_menu->get_popup();
  387. p->set_item_disabled(p->get_item_index(DEBUG_NEXT), !(breaked && can_debug));
  388. p->set_item_disabled(p->get_item_index(DEBUG_STEP), !(breaked && can_debug));
  389. p->set_item_disabled(p->get_item_index(DEBUG_BREAK), breaked);
  390. p->set_item_disabled(p->get_item_index(DEBUG_CONTINUE), !breaked);
  391. }
  392. void EditorDebuggerNode::_menu_option(int p_id) {
  393. switch (p_id) {
  394. case DEBUG_NEXT: {
  395. debug_next();
  396. } break;
  397. case DEBUG_STEP: {
  398. debug_step();
  399. } break;
  400. case DEBUG_BREAK: {
  401. debug_break();
  402. } break;
  403. case DEBUG_CONTINUE: {
  404. debug_continue();
  405. } break;
  406. case DEBUG_KEEP_DEBUGGER_OPEN: {
  407. bool ischecked = script_menu->get_popup()->is_item_checked(script_menu->get_popup()->get_item_index(DEBUG_KEEP_DEBUGGER_OPEN));
  408. hide_on_stop = ischecked;
  409. script_menu->get_popup()->set_item_checked(script_menu->get_popup()->get_item_index(DEBUG_KEEP_DEBUGGER_OPEN), !ischecked);
  410. EditorSettings::get_singleton()->set_project_metadata("debug_options", "keep_debugger_open", !ischecked);
  411. } break;
  412. case DEBUG_WITH_EXTERNAL_EDITOR: {
  413. bool ischecked = script_menu->get_popup()->is_item_checked(script_menu->get_popup()->get_item_index(DEBUG_WITH_EXTERNAL_EDITOR));
  414. debug_with_external_editor = !ischecked;
  415. script_menu->get_popup()->set_item_checked(script_menu->get_popup()->get_item_index(DEBUG_WITH_EXTERNAL_EDITOR), !ischecked);
  416. EditorSettings::get_singleton()->set_project_metadata("debug_options", "debug_with_external_editor", !ischecked);
  417. } break;
  418. }
  419. }
  420. void EditorDebuggerNode::_update_debug_options() {
  421. bool keep_debugger_open = EditorSettings::get_singleton()->get_project_metadata("debug_options", "keep_debugger_open", false);
  422. bool debug_with_external_editor = EditorSettings::get_singleton()->get_project_metadata("debug_options", "debug_with_external_editor", false);
  423. if (keep_debugger_open) {
  424. _menu_option(DEBUG_KEEP_DEBUGGER_OPEN);
  425. }
  426. if (debug_with_external_editor) {
  427. _menu_option(DEBUG_WITH_EXTERNAL_EDITOR);
  428. }
  429. }
  430. void EditorDebuggerNode::_paused() {
  431. const bool paused = EditorNode::get_singleton()->get_pause_button()->is_pressed();
  432. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  433. if (paused && !dbg->is_breaked()) {
  434. dbg->debug_break();
  435. } else if (!paused && dbg->is_breaked()) {
  436. dbg->debug_continue();
  437. }
  438. });
  439. }
  440. void EditorDebuggerNode::_breaked(bool p_breaked, bool p_can_debug, String p_message, bool p_has_stackdump, int p_debugger) {
  441. if (get_current_debugger() != get_debugger(p_debugger)) {
  442. if (!p_breaked) {
  443. return;
  444. }
  445. tabs->set_current_tab(p_debugger);
  446. }
  447. _break_state_changed();
  448. EditorNode::get_singleton()->get_pause_button()->set_pressed(p_breaked);
  449. emit_signal(SNAME("breaked"), p_breaked, p_can_debug);
  450. }
  451. bool EditorDebuggerNode::is_skip_breakpoints() const {
  452. return get_default_debugger()->is_skip_breakpoints();
  453. }
  454. void EditorDebuggerNode::set_breakpoint(const String &p_path, int p_line, bool p_enabled) {
  455. breakpoints[Breakpoint(p_path, p_line)] = p_enabled;
  456. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  457. dbg->set_breakpoint(p_path, p_line, p_enabled);
  458. });
  459. emit_signal(SNAME("breakpoint_toggled"), p_path, p_line, p_enabled);
  460. }
  461. void EditorDebuggerNode::set_breakpoints(const String &p_path, Array p_lines) {
  462. for (int i = 0; i < p_lines.size(); i++) {
  463. set_breakpoint(p_path, p_lines[i], true);
  464. }
  465. for (const KeyValue<Breakpoint, bool> &E : breakpoints) {
  466. Breakpoint b = E.key;
  467. if (b.source == p_path && !p_lines.has(b.line)) {
  468. set_breakpoint(p_path, b.line, false);
  469. }
  470. }
  471. }
  472. void EditorDebuggerNode::reload_scripts() {
  473. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  474. dbg->reload_scripts();
  475. });
  476. }
  477. void EditorDebuggerNode::debug_next() {
  478. get_default_debugger()->debug_next();
  479. }
  480. void EditorDebuggerNode::debug_step() {
  481. get_default_debugger()->debug_step();
  482. }
  483. void EditorDebuggerNode::debug_break() {
  484. get_default_debugger()->debug_break();
  485. }
  486. void EditorDebuggerNode::debug_continue() {
  487. get_default_debugger()->debug_continue();
  488. }
  489. String EditorDebuggerNode::get_var_value(const String &p_var) const {
  490. return get_default_debugger()->get_var_value(p_var);
  491. }
  492. // LiveEdit/Inspector
  493. void EditorDebuggerNode::request_remote_tree() {
  494. get_current_debugger()->request_remote_tree();
  495. }
  496. void EditorDebuggerNode::_remote_tree_updated(int p_debugger) {
  497. if (p_debugger != tabs->get_current_tab()) {
  498. return;
  499. }
  500. remote_scene_tree->clear();
  501. remote_scene_tree->update_scene_tree(get_current_debugger()->get_remote_tree(), p_debugger);
  502. }
  503. void EditorDebuggerNode::_remote_object_updated(ObjectID p_id, int p_debugger) {
  504. if (p_debugger != tabs->get_current_tab()) {
  505. return;
  506. }
  507. if (EditorDebuggerRemoteObject *obj = get_inspected_remote_object()) {
  508. if (obj->remote_object_id == p_id) {
  509. return; // Already being edited
  510. }
  511. }
  512. EditorNode::get_singleton()->push_item(get_current_debugger()->get_remote_object(p_id));
  513. }
  514. void EditorDebuggerNode::_remote_object_property_updated(ObjectID p_id, const String &p_property, int p_debugger) {
  515. if (p_debugger != tabs->get_current_tab()) {
  516. return;
  517. }
  518. if (EditorDebuggerRemoteObject *obj = get_inspected_remote_object()) {
  519. if (obj->remote_object_id != p_id) {
  520. return;
  521. }
  522. InspectorDock::get_inspector_singleton()->update_property(p_property);
  523. }
  524. }
  525. void EditorDebuggerNode::_remote_object_requested(ObjectID p_id, int p_debugger) {
  526. if (p_debugger != tabs->get_current_tab()) {
  527. return;
  528. }
  529. inspect_edited_object_timeout = 0.7; // Temporarily disable timeout to avoid multiple requests.
  530. get_current_debugger()->request_remote_object(p_id);
  531. }
  532. void EditorDebuggerNode::_save_node_requested(ObjectID p_id, const String &p_file, int p_debugger) {
  533. if (p_debugger != tabs->get_current_tab()) {
  534. return;
  535. }
  536. get_current_debugger()->save_node(p_id, p_file);
  537. }
  538. // Remote inspector/edit.
  539. void EditorDebuggerNode::_method_changeds(void *p_ud, Object *p_base, const StringName &p_name, const Variant **p_args, int p_argcount) {
  540. if (!singleton) {
  541. return;
  542. }
  543. _for_all(singleton->tabs, [&](ScriptEditorDebugger *dbg) {
  544. dbg->_method_changed(p_base, p_name, p_args, p_argcount);
  545. });
  546. }
  547. void EditorDebuggerNode::_property_changeds(void *p_ud, Object *p_base, const StringName &p_property, const Variant &p_value) {
  548. if (!singleton) {
  549. return;
  550. }
  551. _for_all(singleton->tabs, [&](ScriptEditorDebugger *dbg) {
  552. dbg->_property_changed(p_base, p_property, p_value);
  553. });
  554. }
  555. // LiveDebug
  556. void EditorDebuggerNode::set_live_debugging(bool p_enabled) {
  557. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  558. dbg->set_live_debugging(p_enabled);
  559. });
  560. }
  561. void EditorDebuggerNode::update_live_edit_root() {
  562. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  563. dbg->update_live_edit_root();
  564. });
  565. }
  566. void EditorDebuggerNode::live_debug_create_node(const NodePath &p_parent, const String &p_type, const String &p_name) {
  567. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  568. dbg->live_debug_create_node(p_parent, p_type, p_name);
  569. });
  570. }
  571. void EditorDebuggerNode::live_debug_instance_node(const NodePath &p_parent, const String &p_path, const String &p_name) {
  572. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  573. dbg->live_debug_instance_node(p_parent, p_path, p_name);
  574. });
  575. }
  576. void EditorDebuggerNode::live_debug_remove_node(const NodePath &p_at) {
  577. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  578. dbg->live_debug_remove_node(p_at);
  579. });
  580. }
  581. void EditorDebuggerNode::live_debug_remove_and_keep_node(const NodePath &p_at, ObjectID p_keep_id) {
  582. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  583. dbg->live_debug_remove_and_keep_node(p_at, p_keep_id);
  584. });
  585. }
  586. void EditorDebuggerNode::live_debug_restore_node(ObjectID p_id, const NodePath &p_at, int p_at_pos) {
  587. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  588. dbg->live_debug_restore_node(p_id, p_at, p_at_pos);
  589. });
  590. }
  591. void EditorDebuggerNode::live_debug_duplicate_node(const NodePath &p_at, const String &p_new_name) {
  592. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  593. dbg->live_debug_duplicate_node(p_at, p_new_name);
  594. });
  595. }
  596. void EditorDebuggerNode::live_debug_reparent_node(const NodePath &p_at, const NodePath &p_new_place, const String &p_new_name, int p_at_pos) {
  597. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  598. dbg->live_debug_reparent_node(p_at, p_new_place, p_new_name, p_at_pos);
  599. });
  600. }
  601. void EditorDebuggerNode::set_camera_override(CameraOverride p_override) {
  602. _for_all(tabs, [&](ScriptEditorDebugger *dbg) {
  603. dbg->set_camera_override(p_override);
  604. });
  605. camera_override = p_override;
  606. }
  607. EditorDebuggerNode::CameraOverride EditorDebuggerNode::get_camera_override() {
  608. return camera_override;
  609. }
  610. void EditorDebuggerNode::add_debugger_plugin(const Ref<Script> &p_script) {
  611. ERR_FAIL_COND_MSG(debugger_plugins.has(p_script), "Debugger plugin already exists.");
  612. ERR_FAIL_COND_MSG(p_script.is_null(), "Debugger plugin script is null");
  613. ERR_FAIL_COND_MSG(p_script->get_instance_base_type() == StringName(), "Debugger plugin script has error.");
  614. ERR_FAIL_COND_MSG(String(p_script->get_instance_base_type()) != "EditorDebuggerPlugin", "Base type of debugger plugin is not 'EditorDebuggerPlugin'.");
  615. ERR_FAIL_COND_MSG(!p_script->is_tool(), "Debugger plugin script is not in tool mode.");
  616. debugger_plugins.insert(p_script);
  617. for (int i = 0; get_debugger(i); i++) {
  618. get_debugger(i)->add_debugger_plugin(p_script);
  619. }
  620. }
  621. void EditorDebuggerNode::remove_debugger_plugin(const Ref<Script> &p_script) {
  622. ERR_FAIL_COND_MSG(!debugger_plugins.has(p_script), "Debugger plugin doesn't exists.");
  623. debugger_plugins.erase(p_script);
  624. for (int i = 0; get_debugger(i); i++) {
  625. get_debugger(i)->remove_debugger_plugin(p_script);
  626. }
  627. }