script_editor_debugger.cpp 65 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990
  1. /*************************************************************************/
  2. /* script_editor_debugger.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 "script_editor_debugger.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/debugger/debugger_marshalls.h"
  33. #include "core/debugger/remote_debugger.h"
  34. #include "core/io/marshalls.h"
  35. #include "core/string/ustring.h"
  36. #include "core/version.h"
  37. #include "editor/debugger/debug_adapter/debug_adapter_protocol.h"
  38. #include "editor/debugger/editor_network_profiler.h"
  39. #include "editor/debugger/editor_performance_profiler.h"
  40. #include "editor/debugger/editor_profiler.h"
  41. #include "editor/debugger/editor_visual_profiler.h"
  42. #include "editor/editor_file_dialog.h"
  43. #include "editor/editor_log.h"
  44. #include "editor/editor_node.h"
  45. #include "editor/editor_scale.h"
  46. #include "editor/editor_settings.h"
  47. #include "editor/plugins/canvas_item_editor_plugin.h"
  48. #include "editor/plugins/editor_debugger_plugin.h"
  49. #include "editor/plugins/node_3d_editor_plugin.h"
  50. #include "editor/property_editor.h"
  51. #include "main/performance.h"
  52. #include "scene/3d/camera_3d.h"
  53. #include "scene/debugger/scene_debugger.h"
  54. #include "scene/gui/dialogs.h"
  55. #include "scene/gui/label.h"
  56. #include "scene/gui/line_edit.h"
  57. #include "scene/gui/margin_container.h"
  58. #include "scene/gui/rich_text_label.h"
  59. #include "scene/gui/separator.h"
  60. #include "scene/gui/split_container.h"
  61. #include "scene/gui/tab_container.h"
  62. #include "scene/gui/texture_button.h"
  63. #include "scene/gui/tree.h"
  64. #include "scene/resources/packed_scene.h"
  65. #include "servers/debugger/servers_debugger.h"
  66. #include "servers/display_server.h"
  67. using CameraOverride = EditorDebuggerNode::CameraOverride;
  68. void ScriptEditorDebugger::_put_msg(String p_message, Array p_data) {
  69. if (is_session_active()) {
  70. Array msg;
  71. msg.push_back(p_message);
  72. msg.push_back(p_data);
  73. peer->put_message(msg);
  74. }
  75. }
  76. void ScriptEditorDebugger::debug_copy() {
  77. String msg = reason->get_text();
  78. if (msg.is_empty()) {
  79. return;
  80. }
  81. DisplayServer::get_singleton()->clipboard_set(msg);
  82. }
  83. void ScriptEditorDebugger::debug_skip_breakpoints() {
  84. skip_breakpoints_value = !skip_breakpoints_value;
  85. if (skip_breakpoints_value) {
  86. skip_breakpoints->set_icon(get_theme_icon(SNAME("DebugSkipBreakpointsOn"), SNAME("EditorIcons")));
  87. } else {
  88. skip_breakpoints->set_icon(get_theme_icon(SNAME("DebugSkipBreakpointsOff"), SNAME("EditorIcons")));
  89. }
  90. Array msg;
  91. msg.push_back(skip_breakpoints_value);
  92. _put_msg("set_skip_breakpoints", msg);
  93. }
  94. void ScriptEditorDebugger::debug_next() {
  95. ERR_FAIL_COND(!breaked);
  96. _put_msg("next", Array());
  97. _clear_execution();
  98. }
  99. void ScriptEditorDebugger::debug_step() {
  100. ERR_FAIL_COND(!breaked);
  101. _put_msg("step", Array());
  102. _clear_execution();
  103. }
  104. void ScriptEditorDebugger::debug_break() {
  105. ERR_FAIL_COND(breaked);
  106. _put_msg("break", Array());
  107. }
  108. void ScriptEditorDebugger::debug_continue() {
  109. ERR_FAIL_COND(!breaked);
  110. // Allow focus stealing only if we actually run this client for security.
  111. if (remote_pid && EditorNode::get_singleton()->has_child_process(remote_pid)) {
  112. DisplayServer::get_singleton()->enable_for_stealing_focus(remote_pid);
  113. }
  114. _clear_execution();
  115. _put_msg("continue", Array());
  116. _put_msg("servers:foreground", Array());
  117. }
  118. void ScriptEditorDebugger::update_tabs() {
  119. if (error_count == 0 && warning_count == 0) {
  120. errors_tab->set_name(TTR("Errors"));
  121. tabs->set_tab_icon(tabs->get_tab_idx_from_control(errors_tab), Ref<Texture2D>());
  122. } else {
  123. errors_tab->set_name(TTR("Errors") + " (" + itos(error_count + warning_count) + ")");
  124. if (error_count >= 1 && warning_count >= 1) {
  125. tabs->set_tab_icon(tabs->get_tab_idx_from_control(errors_tab), get_theme_icon(SNAME("ErrorWarning"), SNAME("EditorIcons")));
  126. } else if (error_count >= 1) {
  127. tabs->set_tab_icon(tabs->get_tab_idx_from_control(errors_tab), get_theme_icon(SNAME("Error"), SNAME("EditorIcons")));
  128. } else {
  129. tabs->set_tab_icon(tabs->get_tab_idx_from_control(errors_tab), get_theme_icon(SNAME("Warning"), SNAME("EditorIcons")));
  130. }
  131. }
  132. }
  133. void ScriptEditorDebugger::clear_style() {
  134. tabs->remove_theme_style_override("panel");
  135. }
  136. void ScriptEditorDebugger::save_node(ObjectID p_id, const String &p_file) {
  137. Array msg;
  138. msg.push_back(p_id);
  139. msg.push_back(p_file);
  140. _put_msg("scene:save_node", msg);
  141. }
  142. void ScriptEditorDebugger::_file_selected(const String &p_file) {
  143. switch (file_dialog_purpose) {
  144. case SAVE_MONITORS_CSV: {
  145. Error err;
  146. FileAccessRef file = FileAccess::open(p_file, FileAccess::WRITE, &err);
  147. if (err != OK) {
  148. ERR_PRINT("Failed to open " + p_file);
  149. return;
  150. }
  151. Vector<String> line;
  152. line.resize(Performance::MONITOR_MAX);
  153. // signatures
  154. for (int i = 0; i < Performance::MONITOR_MAX; i++) {
  155. line.write[i] = Performance::get_singleton()->get_monitor_name(Performance::Monitor(i));
  156. }
  157. file->store_csv_line(line);
  158. // values
  159. Vector<List<float>::Element *> iterators;
  160. iterators.resize(Performance::MONITOR_MAX);
  161. bool continue_iteration = false;
  162. for (int i = 0; i < Performance::MONITOR_MAX; i++) {
  163. iterators.write[i] = performance_profiler->get_monitor_data(Performance::get_singleton()->get_monitor_name(Performance::Monitor(i)))->back();
  164. continue_iteration = continue_iteration || iterators[i];
  165. }
  166. while (continue_iteration) {
  167. continue_iteration = false;
  168. for (int i = 0; i < Performance::MONITOR_MAX; i++) {
  169. if (iterators[i]) {
  170. line.write[i] = String::num_real(iterators[i]->get());
  171. iterators.write[i] = iterators[i]->prev();
  172. } else {
  173. line.write[i] = "";
  174. }
  175. continue_iteration = continue_iteration || iterators[i];
  176. }
  177. file->store_csv_line(line);
  178. }
  179. file->store_string("\n");
  180. Vector<Vector<String>> profiler_data = profiler->get_data_as_csv();
  181. for (int i = 0; i < profiler_data.size(); i++) {
  182. file->store_csv_line(profiler_data[i]);
  183. }
  184. } break;
  185. case SAVE_VRAM_CSV: {
  186. Error err;
  187. FileAccessRef file = FileAccess::open(p_file, FileAccess::WRITE, &err);
  188. if (err != OK) {
  189. ERR_PRINT("Failed to open " + p_file);
  190. return;
  191. }
  192. Vector<String> headers;
  193. headers.resize(vmem_tree->get_columns());
  194. for (int i = 0; i < vmem_tree->get_columns(); ++i) {
  195. headers.write[i] = vmem_tree->get_column_title(i);
  196. }
  197. file->store_csv_line(headers);
  198. if (vmem_tree->get_root()) {
  199. TreeItem *ti = vmem_tree->get_root()->get_first_child();
  200. while (ti) {
  201. Vector<String> values;
  202. values.resize(vmem_tree->get_columns());
  203. for (int i = 0; i < vmem_tree->get_columns(); ++i) {
  204. values.write[i] = ti->get_text(i);
  205. }
  206. file->store_csv_line(values);
  207. ti = ti->get_next();
  208. }
  209. }
  210. } break;
  211. }
  212. }
  213. void ScriptEditorDebugger::request_remote_tree() {
  214. _put_msg("scene:request_scene_tree", Array());
  215. }
  216. const SceneDebuggerTree *ScriptEditorDebugger::get_remote_tree() {
  217. return scene_tree;
  218. }
  219. void ScriptEditorDebugger::update_remote_object(ObjectID p_obj_id, const String &p_prop, const Variant &p_value) {
  220. Array msg;
  221. msg.push_back(p_obj_id);
  222. msg.push_back(p_prop);
  223. msg.push_back(p_value);
  224. _put_msg("scene:set_object_property", msg);
  225. }
  226. void ScriptEditorDebugger::request_remote_object(ObjectID p_obj_id) {
  227. ERR_FAIL_COND(p_obj_id.is_null());
  228. Array msg;
  229. msg.push_back(p_obj_id);
  230. _put_msg("scene:inspect_object", msg);
  231. }
  232. Object *ScriptEditorDebugger::get_remote_object(ObjectID p_id) {
  233. return inspector->get_object(p_id);
  234. }
  235. void ScriptEditorDebugger::_remote_object_selected(ObjectID p_id) {
  236. emit_signal(SNAME("remote_object_requested"), p_id);
  237. }
  238. void ScriptEditorDebugger::_remote_object_edited(ObjectID p_id, const String &p_prop, const Variant &p_value) {
  239. update_remote_object(p_id, p_prop, p_value);
  240. request_remote_object(p_id);
  241. }
  242. void ScriptEditorDebugger::_remote_object_property_updated(ObjectID p_id, const String &p_property) {
  243. emit_signal(SNAME("remote_object_property_updated"), p_id, p_property);
  244. }
  245. void ScriptEditorDebugger::_video_mem_request() {
  246. _put_msg("servers:memory", Array());
  247. }
  248. void ScriptEditorDebugger::_video_mem_export() {
  249. file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_SAVE_FILE);
  250. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  251. file_dialog->clear_filters();
  252. file_dialog_purpose = SAVE_VRAM_CSV;
  253. file_dialog->popup_file_dialog();
  254. }
  255. Size2 ScriptEditorDebugger::get_minimum_size() const {
  256. Size2 ms = MarginContainer::get_minimum_size();
  257. ms.y = MAX(ms.y, 250 * EDSCALE);
  258. return ms;
  259. }
  260. void ScriptEditorDebugger::_parse_message(const String &p_msg, const Array &p_data) {
  261. emit_signal(SNAME("debug_data"), p_msg, p_data);
  262. if (p_msg == "debug_enter") {
  263. _put_msg("get_stack_dump", Array());
  264. ERR_FAIL_COND(p_data.size() != 3);
  265. bool can_continue = p_data[0];
  266. String error = p_data[1];
  267. bool has_stackdump = p_data[2];
  268. breaked = true;
  269. can_debug = can_continue;
  270. _update_buttons_state();
  271. _set_reason_text(error, MESSAGE_ERROR);
  272. emit_signal(SNAME("breaked"), true, can_continue, error, has_stackdump);
  273. if (is_move_to_foreground()) {
  274. DisplayServer::get_singleton()->window_move_to_foreground();
  275. }
  276. if (!error.is_empty()) {
  277. tabs->set_current_tab(0);
  278. }
  279. profiler->set_enabled(false);
  280. inspector->clear_cache(); // Take a chance to force remote objects update.
  281. } else if (p_msg == "debug_exit") {
  282. breaked = false;
  283. can_debug = false;
  284. _clear_execution();
  285. _update_buttons_state();
  286. _set_reason_text(TTR("Execution resumed."), MESSAGE_SUCCESS);
  287. emit_signal(SNAME("breaked"), false, false, "", false);
  288. profiler->set_enabled(true);
  289. profiler->disable_seeking();
  290. } else if (p_msg == "set_pid") {
  291. ERR_FAIL_COND(p_data.size() < 1);
  292. remote_pid = p_data[0];
  293. } else if (p_msg == "scene:click_ctrl") {
  294. ERR_FAIL_COND(p_data.size() < 2);
  295. clicked_ctrl->set_text(p_data[0]);
  296. clicked_ctrl_type->set_text(p_data[1]);
  297. } else if (p_msg == "scene:scene_tree") {
  298. scene_tree->nodes.clear();
  299. scene_tree->deserialize(p_data);
  300. emit_signal(SNAME("remote_tree_updated"));
  301. _update_buttons_state();
  302. } else if (p_msg == "scene:inspect_object") {
  303. ObjectID id = inspector->add_object(p_data);
  304. if (id.is_valid()) {
  305. emit_signal(SNAME("remote_object_updated"), id);
  306. }
  307. } else if (p_msg == "servers:memory_usage") {
  308. vmem_tree->clear();
  309. TreeItem *root = vmem_tree->create_item();
  310. ServersDebugger::ResourceUsage usage;
  311. usage.deserialize(p_data);
  312. uint64_t total = 0;
  313. for (const ServersDebugger::ResourceInfo &E : usage.infos) {
  314. TreeItem *it = vmem_tree->create_item(root);
  315. String type = E.type;
  316. int bytes = E.vram;
  317. it->set_text(0, E.path);
  318. it->set_text(1, type);
  319. it->set_text(2, E.format);
  320. it->set_text(3, String::humanize_size(bytes));
  321. total += bytes;
  322. if (has_theme_icon(type, SNAME("EditorIcons"))) {
  323. it->set_icon(0, get_theme_icon(type, SNAME("EditorIcons")));
  324. }
  325. }
  326. vmem_total->set_tooltip(TTR("Bytes:") + " " + itos(total));
  327. vmem_total->set_text(String::humanize_size(total));
  328. } else if (p_msg == "stack_dump") {
  329. DebuggerMarshalls::ScriptStackDump stack;
  330. stack.deserialize(p_data);
  331. stack_dump->clear();
  332. inspector->clear_stack_variables();
  333. TreeItem *r = stack_dump->create_item();
  334. Array stack_dump_info;
  335. for (int i = 0; i < stack.frames.size(); i++) {
  336. TreeItem *s = stack_dump->create_item(r);
  337. Dictionary d;
  338. d["frame"] = i;
  339. d["file"] = stack.frames[i].file;
  340. d["function"] = stack.frames[i].func;
  341. d["line"] = stack.frames[i].line;
  342. stack_dump_info.push_back(d);
  343. s->set_metadata(0, d);
  344. String line = itos(i) + " - " + String(d["file"]) + ":" + itos(d["line"]) + " - at function: " + d["function"];
  345. s->set_text(0, line);
  346. if (i == 0) {
  347. s->select(0);
  348. }
  349. }
  350. emit_signal(SNAME("stack_dump"), stack_dump_info);
  351. } else if (p_msg == "stack_frame_vars") {
  352. inspector->clear_stack_variables();
  353. ERR_FAIL_COND(p_data.size() != 1);
  354. emit_signal(SNAME("stack_frame_vars"), p_data[0]);
  355. } else if (p_msg == "stack_frame_var") {
  356. inspector->add_stack_variable(p_data);
  357. emit_signal(SNAME("stack_frame_var"), p_data);
  358. } else if (p_msg == "output") {
  359. ERR_FAIL_COND(p_data.size() != 2);
  360. ERR_FAIL_COND(p_data[0].get_type() != Variant::PACKED_STRING_ARRAY);
  361. Vector<String> output_strings = p_data[0];
  362. ERR_FAIL_COND(p_data[1].get_type() != Variant::PACKED_INT32_ARRAY);
  363. Vector<int> output_types = p_data[1];
  364. ERR_FAIL_COND(output_strings.size() != output_types.size());
  365. for (int i = 0; i < output_strings.size(); i++) {
  366. RemoteDebugger::MessageType type = (RemoteDebugger::MessageType)(int)(output_types[i]);
  367. EditorLog::MessageType msg_type;
  368. switch (type) {
  369. case RemoteDebugger::MESSAGE_TYPE_LOG: {
  370. msg_type = EditorLog::MSG_TYPE_STD;
  371. } break;
  372. case RemoteDebugger::MESSAGE_TYPE_ERROR: {
  373. msg_type = EditorLog::MSG_TYPE_ERROR;
  374. } break;
  375. default: {
  376. WARN_PRINT("Unhandled script debugger message type: " + itos(type));
  377. msg_type = EditorLog::MSG_TYPE_STD;
  378. } break;
  379. }
  380. EditorNode::get_log()->add_message(output_strings[i], msg_type);
  381. emit_signal(SNAME("output"), output_strings[i]);
  382. }
  383. } else if (p_msg == "performance:profile_frame") {
  384. Vector<float> frame_data;
  385. frame_data.resize(p_data.size());
  386. for (int i = 0; i < p_data.size(); i++) {
  387. frame_data.write[i] = p_data[i];
  388. }
  389. performance_profiler->add_profile_frame(frame_data);
  390. } else if (p_msg == "visual:profile_frame") {
  391. ServersDebugger::VisualProfilerFrame frame;
  392. frame.deserialize(p_data);
  393. EditorVisualProfiler::Metric metric;
  394. metric.areas.resize(frame.areas.size());
  395. metric.frame_number = frame.frame_number;
  396. metric.valid = true;
  397. {
  398. EditorVisualProfiler::Metric::Area *areas_ptr = metric.areas.ptrw();
  399. for (int i = 0; i < frame.areas.size(); i++) {
  400. areas_ptr[i].name = frame.areas[i].name;
  401. areas_ptr[i].cpu_time = frame.areas[i].cpu_msec;
  402. areas_ptr[i].gpu_time = frame.areas[i].gpu_msec;
  403. }
  404. }
  405. visual_profiler->add_frame_metric(metric);
  406. } else if (p_msg == "error") {
  407. DebuggerMarshalls::OutputError oe;
  408. ERR_FAIL_COND_MSG(oe.deserialize(p_data) == false, "Failed to deserialize error message");
  409. // Format time.
  410. Array time_vals;
  411. time_vals.push_back(oe.hr);
  412. time_vals.push_back(oe.min);
  413. time_vals.push_back(oe.sec);
  414. time_vals.push_back(oe.msec);
  415. bool e;
  416. String time = String("%d:%02d:%02d:%04d").sprintf(time_vals, &e);
  417. // Rest of the error data.
  418. bool source_is_project_file = oe.source_file.begins_with("res://");
  419. // Metadata to highlight error line in scripts.
  420. Array source_meta;
  421. source_meta.push_back(oe.source_file);
  422. source_meta.push_back(oe.source_line);
  423. // Create error tree to display above error or warning details.
  424. TreeItem *r = error_tree->get_root();
  425. if (!r) {
  426. r = error_tree->create_item();
  427. }
  428. // Also provide the relevant details as tooltip to quickly check without
  429. // uncollapsing the tree.
  430. String tooltip = oe.warning ? TTR("Warning:") : TTR("Error:");
  431. TreeItem *error = error_tree->create_item(r);
  432. error->set_collapsed(true);
  433. error->set_icon(0, get_theme_icon(oe.warning ? SNAME("Warning") : SNAME("Error"), SNAME("EditorIcons")));
  434. error->set_text(0, time);
  435. error->set_text_alignment(0, HORIZONTAL_ALIGNMENT_LEFT);
  436. const Color color = get_theme_color(oe.warning ? SNAME("warning_color") : SNAME("error_color"), SNAME("Editor"));
  437. error->set_custom_color(0, color);
  438. error->set_custom_color(1, color);
  439. String error_title;
  440. if (oe.callstack.size() > 0) {
  441. // If available, use the script's stack in the error title.
  442. error_title = oe.callstack[oe.callstack.size() - 1].func + ": ";
  443. } else if (!oe.source_func.is_empty()) {
  444. // Otherwise try to use the C++ source function.
  445. error_title += oe.source_func + ": ";
  446. }
  447. // If we have a (custom) error message, use it as title, and add a C++ Error
  448. // item with the original error condition.
  449. error_title += oe.error_descr.is_empty() ? oe.error : oe.error_descr;
  450. error->set_text(1, error_title);
  451. tooltip += " " + error_title + "\n";
  452. if (!oe.error_descr.is_empty()) {
  453. // Add item for C++ error condition.
  454. TreeItem *cpp_cond = error_tree->create_item(error);
  455. cpp_cond->set_text(0, "<" + TTR("C++ Error") + ">");
  456. cpp_cond->set_text(1, oe.error);
  457. cpp_cond->set_text_alignment(0, HORIZONTAL_ALIGNMENT_LEFT);
  458. tooltip += TTR("C++ Error:") + " " + oe.error + "\n";
  459. if (source_is_project_file) {
  460. cpp_cond->set_metadata(0, source_meta);
  461. }
  462. }
  463. Vector<uint8_t> v;
  464. v.resize(100);
  465. // Source of the error.
  466. String source_txt = (source_is_project_file ? oe.source_file.get_file() : oe.source_file) + ":" + itos(oe.source_line);
  467. if (!oe.source_func.is_empty()) {
  468. source_txt += " @ " + oe.source_func + "()";
  469. }
  470. TreeItem *cpp_source = error_tree->create_item(error);
  471. cpp_source->set_text(0, "<" + (source_is_project_file ? TTR("Source") : TTR("C++ Source")) + ">");
  472. cpp_source->set_text(1, source_txt);
  473. cpp_source->set_text_alignment(0, HORIZONTAL_ALIGNMENT_LEFT);
  474. tooltip += (source_is_project_file ? TTR("Source:") : TTR("C++ Source:")) + " " + source_txt + "\n";
  475. // Set metadata to highlight error line in scripts.
  476. if (source_is_project_file) {
  477. error->set_metadata(0, source_meta);
  478. cpp_source->set_metadata(0, source_meta);
  479. }
  480. // Format stack trace.
  481. // stack_items_count is the number of elements to parse, with 3 items per frame
  482. // of the stack trace (script, method, line).
  483. const ScriptLanguage::StackInfo *infos = oe.callstack.ptr();
  484. for (unsigned int i = 0; i < (unsigned int)oe.callstack.size(); i++) {
  485. TreeItem *stack_trace = error_tree->create_item(error);
  486. Array meta;
  487. meta.push_back(infos[i].file);
  488. meta.push_back(infos[i].line);
  489. stack_trace->set_metadata(0, meta);
  490. if (i == 0) {
  491. stack_trace->set_text(0, "<" + TTR("Stack Trace") + ">");
  492. stack_trace->set_text_alignment(0, HORIZONTAL_ALIGNMENT_LEFT);
  493. error->set_metadata(0, meta);
  494. tooltip += TTR("Stack Trace:") + "\n";
  495. }
  496. String frame_txt = infos[i].file.get_file() + ":" + itos(infos[i].line) + " @ " + infos[i].func + "()";
  497. tooltip += frame_txt + "\n";
  498. stack_trace->set_text(1, frame_txt);
  499. }
  500. error->set_tooltip(0, tooltip);
  501. error->set_tooltip(1, tooltip);
  502. if (warning_count == 0 && error_count == 0) {
  503. expand_all_button->set_disabled(false);
  504. collapse_all_button->set_disabled(false);
  505. clear_button->set_disabled(false);
  506. }
  507. if (oe.warning) {
  508. warning_count++;
  509. } else {
  510. error_count++;
  511. }
  512. } else if (p_msg == "servers:function_signature") {
  513. // Cache a profiler signature.
  514. ServersDebugger::ScriptFunctionSignature sig;
  515. sig.deserialize(p_data);
  516. profiler_signature[sig.id] = sig.name;
  517. } else if (p_msg == "servers:profile_frame" || p_msg == "servers:profile_total") {
  518. EditorProfiler::Metric metric;
  519. ServersDebugger::ServersProfilerFrame frame;
  520. frame.deserialize(p_data);
  521. metric.valid = true;
  522. metric.frame_number = frame.frame_number;
  523. metric.frame_time = frame.frame_time;
  524. metric.idle_time = frame.idle_time;
  525. metric.physics_time = frame.physics_time;
  526. metric.physics_frame_time = frame.physics_frame_time;
  527. if (frame.servers.size()) {
  528. EditorProfiler::Metric::Category frame_time;
  529. frame_time.signature = "category_frame_time";
  530. frame_time.name = "Frame Time";
  531. frame_time.total_time = metric.frame_time;
  532. EditorProfiler::Metric::Category::Item item;
  533. item.calls = 1;
  534. item.line = 0;
  535. item.name = "Physics Time";
  536. item.total = metric.physics_time;
  537. item.self = item.total;
  538. item.signature = "physics_time";
  539. frame_time.items.push_back(item);
  540. item.name = "Idle Time";
  541. item.total = metric.idle_time;
  542. item.self = item.total;
  543. item.signature = "idle_time";
  544. frame_time.items.push_back(item);
  545. item.name = "Physics Frame Time";
  546. item.total = metric.physics_frame_time;
  547. item.self = item.total;
  548. item.signature = "physics_frame_time";
  549. frame_time.items.push_back(item);
  550. metric.categories.push_back(frame_time);
  551. }
  552. for (int i = 0; i < frame.servers.size(); i++) {
  553. const ServersDebugger::ServerInfo &srv = frame.servers[i];
  554. EditorProfiler::Metric::Category c;
  555. const String name = srv.name;
  556. c.name = name.capitalize();
  557. c.items.resize(srv.functions.size());
  558. c.total_time = 0;
  559. c.signature = "categ::" + name;
  560. for (int j = 0; j < srv.functions.size(); j++) {
  561. EditorProfiler::Metric::Category::Item item;
  562. item.calls = 1;
  563. item.line = 0;
  564. item.name = srv.functions[j].name;
  565. item.self = srv.functions[j].time;
  566. item.total = item.self;
  567. item.signature = "categ::" + name + "::" + item.name;
  568. item.name = item.name.capitalize();
  569. c.total_time += item.total;
  570. c.items.write[j] = item;
  571. }
  572. metric.categories.push_back(c);
  573. }
  574. EditorProfiler::Metric::Category funcs;
  575. funcs.total_time = frame.script_time;
  576. funcs.items.resize(frame.script_functions.size());
  577. funcs.name = "Script Functions";
  578. funcs.signature = "script_functions";
  579. for (int i = 0; i < frame.script_functions.size(); i++) {
  580. int signature = frame.script_functions[i].sig_id;
  581. int calls = frame.script_functions[i].call_count;
  582. float total = frame.script_functions[i].total_time;
  583. float self = frame.script_functions[i].self_time;
  584. EditorProfiler::Metric::Category::Item item;
  585. if (profiler_signature.has(signature)) {
  586. item.signature = profiler_signature[signature];
  587. String name = profiler_signature[signature];
  588. Vector<String> strings = name.split("::");
  589. if (strings.size() == 3) {
  590. item.name = strings[2];
  591. item.script = strings[0];
  592. item.line = strings[1].to_int();
  593. } else if (strings.size() == 4) { //Built-in scripts have an :: in their name
  594. item.name = strings[3];
  595. item.script = strings[0] + "::" + strings[1];
  596. item.line = strings[2].to_int();
  597. }
  598. } else {
  599. item.name = "SigErr " + itos(signature);
  600. }
  601. item.calls = calls;
  602. item.self = self;
  603. item.total = total;
  604. funcs.items.write[i] = item;
  605. }
  606. metric.categories.push_back(funcs);
  607. if (p_msg == "servers:profile_frame") {
  608. profiler->add_frame_metric(metric, false);
  609. } else {
  610. profiler->add_frame_metric(metric, true);
  611. }
  612. } else if (p_msg == "multiplayer:rpc") {
  613. SceneDebugger::RPCProfilerFrame frame;
  614. frame.deserialize(p_data);
  615. for (int i = 0; i < frame.infos.size(); i++) {
  616. network_profiler->add_node_frame_data(frame.infos[i]);
  617. }
  618. } else if (p_msg == "multiplayer:bandwidth") {
  619. ERR_FAIL_COND(p_data.size() < 2);
  620. network_profiler->set_bandwidth(p_data[0], p_data[1]);
  621. } else if (p_msg == "request_quit") {
  622. emit_signal(SNAME("stop_requested"));
  623. _stop_and_notify();
  624. } else if (p_msg == "performance:profile_names") {
  625. Vector<StringName> monitors;
  626. monitors.resize(p_data.size());
  627. for (int i = 0; i < p_data.size(); i++) {
  628. ERR_FAIL_COND(p_data[i].get_type() != Variant::STRING_NAME);
  629. monitors.set(i, p_data[i]);
  630. }
  631. performance_profiler->update_monitors(monitors);
  632. } else {
  633. int colon_index = p_msg.find_char(':');
  634. ERR_FAIL_COND_MSG(colon_index < 1, "Invalid message received");
  635. bool parsed = false;
  636. const String cap = p_msg.substr(0, colon_index);
  637. Map<StringName, Callable>::Element *element = captures.find(cap);
  638. if (element) {
  639. Callable &c = element->value();
  640. ERR_FAIL_COND_MSG(c.is_null(), "Invalid callable registered: " + cap);
  641. Variant cmd = p_msg.substr(colon_index + 1), data = p_data;
  642. const Variant *args[2] = { &cmd, &data };
  643. Variant retval;
  644. Callable::CallError err;
  645. c.call(args, 2, retval, err);
  646. ERR_FAIL_COND_MSG(err.error != Callable::CallError::CALL_OK, "Error calling 'capture' to callable: " + Variant::get_callable_error_text(c, args, 2, err));
  647. ERR_FAIL_COND_MSG(retval.get_type() != Variant::BOOL, "Error calling 'capture' to callable: " + String(c) + ". Return type is not bool.");
  648. parsed = retval;
  649. }
  650. if (!parsed) {
  651. WARN_PRINT("unknown message " + p_msg);
  652. }
  653. }
  654. }
  655. void ScriptEditorDebugger::_set_reason_text(const String &p_reason, MessageType p_type) {
  656. switch (p_type) {
  657. case MESSAGE_ERROR:
  658. reason->add_theme_color_override("font_color", get_theme_color(SNAME("error_color"), SNAME("Editor")));
  659. break;
  660. case MESSAGE_WARNING:
  661. reason->add_theme_color_override("font_color", get_theme_color(SNAME("warning_color"), SNAME("Editor")));
  662. break;
  663. default:
  664. reason->add_theme_color_override("font_color", get_theme_color(SNAME("success_color"), SNAME("Editor")));
  665. }
  666. reason->set_text(p_reason);
  667. reason->set_tooltip(p_reason.word_wrap(80));
  668. }
  669. void ScriptEditorDebugger::_notification(int p_what) {
  670. switch (p_what) {
  671. case NOTIFICATION_ENTER_TREE: {
  672. skip_breakpoints->set_icon(get_theme_icon(SNAME("DebugSkipBreakpointsOff"), SNAME("EditorIcons")));
  673. copy->set_icon(get_theme_icon(SNAME("ActionCopy"), SNAME("EditorIcons")));
  674. step->set_icon(get_theme_icon(SNAME("DebugStep"), SNAME("EditorIcons")));
  675. next->set_icon(get_theme_icon(SNAME("DebugNext"), SNAME("EditorIcons")));
  676. dobreak->set_icon(get_theme_icon(SNAME("Pause"), SNAME("EditorIcons")));
  677. docontinue->set_icon(get_theme_icon(SNAME("DebugContinue"), SNAME("EditorIcons")));
  678. le_set->connect("pressed", callable_mp(this, &ScriptEditorDebugger::_live_edit_set));
  679. le_clear->connect("pressed", callable_mp(this, &ScriptEditorDebugger::_live_edit_clear));
  680. error_tree->connect("item_selected", callable_mp(this, &ScriptEditorDebugger::_error_selected));
  681. error_tree->connect("item_activated", callable_mp(this, &ScriptEditorDebugger::_error_activated));
  682. breakpoints_tree->connect("item_activated", callable_mp(this, &ScriptEditorDebugger::_breakpoint_tree_clicked));
  683. vmem_refresh->set_icon(get_theme_icon(SNAME("Reload"), SNAME("EditorIcons")));
  684. vmem_export->set_icon(get_theme_icon(SNAME("Save"), SNAME("EditorIcons")));
  685. search->set_right_icon(get_theme_icon(SNAME("Search"), SNAME("EditorIcons")));
  686. reason->add_theme_color_override("font_color", get_theme_color(SNAME("error_color"), SNAME("Editor")));
  687. } break;
  688. case NOTIFICATION_PROCESS: {
  689. if (is_session_active()) {
  690. peer->poll();
  691. if (camera_override == CameraOverride::OVERRIDE_2D) {
  692. Dictionary state = CanvasItemEditor::get_singleton()->get_state();
  693. float zoom = state["zoom"];
  694. Point2 offset = state["ofs"];
  695. Transform2D transform;
  696. transform.scale_basis(Size2(zoom, zoom));
  697. transform.elements[2] = -offset * zoom;
  698. Array msg;
  699. msg.push_back(transform);
  700. _put_msg("scene:override_camera_2D:transform", msg);
  701. } else if (camera_override >= CameraOverride::OVERRIDE_3D_1) {
  702. int viewport_idx = camera_override - CameraOverride::OVERRIDE_3D_1;
  703. Node3DEditorViewport *viewport = Node3DEditor::get_singleton()->get_editor_viewport(viewport_idx);
  704. Camera3D *const cam = viewport->get_camera_3d();
  705. Array msg;
  706. msg.push_back(cam->get_camera_transform());
  707. if (cam->get_projection() == Camera3D::PROJECTION_ORTHOGONAL) {
  708. msg.push_back(false);
  709. msg.push_back(cam->get_size());
  710. } else {
  711. msg.push_back(true);
  712. msg.push_back(cam->get_fov());
  713. }
  714. msg.push_back(cam->get_near());
  715. msg.push_back(cam->get_far());
  716. _put_msg("scene:override_camera_3D:transform", msg);
  717. }
  718. if (breaked) {
  719. _put_msg("servers:draw", Array());
  720. }
  721. }
  722. const uint64_t until = OS::get_singleton()->get_ticks_msec() + 20;
  723. while (peer.is_valid() && peer->has_message()) {
  724. Array arr = peer->get_message();
  725. if (arr.size() != 2 || arr[0].get_type() != Variant::STRING || arr[1].get_type() != Variant::ARRAY) {
  726. _stop_and_notify();
  727. ERR_FAIL_MSG("Invalid message format received from peer");
  728. }
  729. _parse_message(arr[0], arr[1]);
  730. if (OS::get_singleton()->get_ticks_msec() > until) {
  731. break;
  732. }
  733. }
  734. if (!is_session_active()) {
  735. _stop_and_notify();
  736. break;
  737. };
  738. } break;
  739. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  740. if (tabs->has_theme_stylebox_override("panel")) {
  741. tabs->add_theme_style_override("panel", EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("DebuggerPanel"), SNAME("EditorStyles")));
  742. }
  743. copy->set_icon(get_theme_icon(SNAME("ActionCopy"), SNAME("EditorIcons")));
  744. step->set_icon(get_theme_icon(SNAME("DebugStep"), SNAME("EditorIcons")));
  745. next->set_icon(get_theme_icon(SNAME("DebugNext"), SNAME("EditorIcons")));
  746. dobreak->set_icon(get_theme_icon(SNAME("Pause"), SNAME("EditorIcons")));
  747. docontinue->set_icon(get_theme_icon(SNAME("DebugContinue"), SNAME("EditorIcons")));
  748. vmem_refresh->set_icon(get_theme_icon(SNAME("Reload"), SNAME("EditorIcons")));
  749. vmem_export->set_icon(get_theme_icon(SNAME("Save"), SNAME("EditorIcons")));
  750. search->set_right_icon(get_theme_icon(SNAME("Search"), SNAME("EditorIcons")));
  751. } break;
  752. }
  753. }
  754. void ScriptEditorDebugger::_clear_execution() {
  755. TreeItem *ti = stack_dump->get_selected();
  756. if (!ti) {
  757. return;
  758. }
  759. Dictionary d = ti->get_metadata(0);
  760. stack_script = ResourceLoader::load(d["file"]);
  761. emit_signal(SNAME("clear_execution"), stack_script);
  762. stack_script.unref();
  763. stack_dump->clear();
  764. inspector->clear_stack_variables();
  765. }
  766. void ScriptEditorDebugger::_set_breakpoint(const String &p_file, const int &p_line, const bool &p_enabled) {
  767. Ref<Script> script = ResourceLoader::load(p_file);
  768. emit_signal(SNAME("set_breakpoint"), script, p_line - 1, p_enabled);
  769. script.unref();
  770. }
  771. void ScriptEditorDebugger::_clear_breakpoints() {
  772. emit_signal(SNAME("clear_breakpoints"));
  773. }
  774. void ScriptEditorDebugger::_breakpoint_tree_clicked() {
  775. TreeItem *selected = breakpoints_tree->get_selected();
  776. if (selected->has_meta("line")) {
  777. emit_signal(SNAME("breakpoint_selected"), selected->get_parent()->get_text(0), int(selected->get_meta("line")));
  778. }
  779. }
  780. void ScriptEditorDebugger::start(Ref<RemoteDebuggerPeer> p_peer) {
  781. _clear_errors_list();
  782. stop();
  783. peer = p_peer;
  784. ERR_FAIL_COND(p_peer.is_null());
  785. performance_profiler->reset();
  786. set_process(true);
  787. breaked = false;
  788. can_debug = true;
  789. camera_override = CameraOverride::OVERRIDE_NONE;
  790. tabs->set_current_tab(0);
  791. _set_reason_text(TTR("Debug session started."), MESSAGE_SUCCESS);
  792. _update_buttons_state();
  793. emit_signal(SNAME("started"));
  794. }
  795. void ScriptEditorDebugger::_update_buttons_state() {
  796. const bool active = is_session_active();
  797. const bool has_editor_tree = active && editor_remote_tree && editor_remote_tree->get_selected();
  798. vmem_refresh->set_disabled(!active);
  799. step->set_disabled(!active || !breaked || !can_debug);
  800. next->set_disabled(!active || !breaked || !can_debug);
  801. copy->set_disabled(!active || !breaked);
  802. docontinue->set_disabled(!active || !breaked);
  803. dobreak->set_disabled(!active || breaked);
  804. le_clear->set_disabled(!active);
  805. le_set->set_disabled(!has_editor_tree);
  806. }
  807. void ScriptEditorDebugger::_stop_and_notify() {
  808. stop();
  809. emit_signal(SNAME("stopped"));
  810. _set_reason_text(TTR("Debug session closed."), MESSAGE_WARNING);
  811. }
  812. void ScriptEditorDebugger::stop() {
  813. set_process(false);
  814. breaked = false;
  815. can_debug = false;
  816. remote_pid = 0;
  817. _clear_execution();
  818. inspector->clear_cache();
  819. if (peer.is_valid()) {
  820. peer->close();
  821. peer.unref();
  822. reason->set_text("");
  823. reason->set_tooltip("");
  824. }
  825. node_path_cache.clear();
  826. res_path_cache.clear();
  827. profiler_signature.clear();
  828. inspector->edit(nullptr);
  829. _update_buttons_state();
  830. }
  831. void ScriptEditorDebugger::_profiler_activate(bool p_enable, int p_type) {
  832. Array data;
  833. data.push_back(p_enable);
  834. switch (p_type) {
  835. case PROFILER_NETWORK:
  836. _put_msg("profiler:multiplayer", data);
  837. _put_msg("profiler:rpc", data);
  838. break;
  839. case PROFILER_VISUAL:
  840. _put_msg("profiler:visual", data);
  841. break;
  842. case PROFILER_SCRIPTS_SERVERS:
  843. if (p_enable) {
  844. // Clear old script signatures. (should we move all this into the profiler?)
  845. profiler_signature.clear();
  846. // Add max funcs options to request.
  847. Array opts;
  848. int max_funcs = EditorSettings::get_singleton()->get("debugger/profiler_frame_max_functions");
  849. opts.push_back(CLAMP(max_funcs, 16, 512));
  850. data.push_back(opts);
  851. }
  852. _put_msg("profiler:servers", data);
  853. break;
  854. default:
  855. ERR_FAIL_MSG("Invalid profiler type");
  856. }
  857. }
  858. void ScriptEditorDebugger::_profiler_seeked() {
  859. if (breaked) {
  860. return;
  861. }
  862. debug_break();
  863. }
  864. void ScriptEditorDebugger::_stack_dump_frame_selected() {
  865. emit_signal(SNAME("stack_frame_selected"));
  866. int frame = get_stack_script_frame();
  867. if (!request_stack_dump(frame)) {
  868. inspector->edit(nullptr);
  869. }
  870. }
  871. void ScriptEditorDebugger::_export_csv() {
  872. file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_SAVE_FILE);
  873. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  874. file_dialog_purpose = SAVE_MONITORS_CSV;
  875. file_dialog->popup_file_dialog();
  876. }
  877. String ScriptEditorDebugger::get_var_value(const String &p_var) const {
  878. if (!breaked) {
  879. return String();
  880. }
  881. return inspector->get_stack_variable(p_var);
  882. }
  883. int ScriptEditorDebugger::_get_node_path_cache(const NodePath &p_path) {
  884. const int *r = node_path_cache.getptr(p_path);
  885. if (r) {
  886. return *r;
  887. }
  888. last_path_id++;
  889. node_path_cache[p_path] = last_path_id;
  890. Array msg;
  891. msg.push_back(p_path);
  892. msg.push_back(last_path_id);
  893. _put_msg("scene:live_node_path", msg);
  894. return last_path_id;
  895. }
  896. int ScriptEditorDebugger::_get_res_path_cache(const String &p_path) {
  897. Map<String, int>::Element *E = res_path_cache.find(p_path);
  898. if (E) {
  899. return E->get();
  900. }
  901. last_path_id++;
  902. res_path_cache[p_path] = last_path_id;
  903. Array msg;
  904. msg.push_back(p_path);
  905. msg.push_back(last_path_id);
  906. _put_msg("scene:live_res_path", msg);
  907. return last_path_id;
  908. }
  909. void ScriptEditorDebugger::_method_changed(Object *p_base, const StringName &p_name, const Variant **p_args, int p_argcount) {
  910. if (!p_base || !live_debug || !is_session_active() || !EditorNode::get_singleton()->get_edited_scene()) {
  911. return;
  912. }
  913. Node *node = Object::cast_to<Node>(p_base);
  914. for (int i = 0; i < p_argcount; i++) {
  915. //no pointers, sorry
  916. if (p_args[i]->get_type() == Variant::OBJECT || p_args[i]->get_type() == Variant::RID) {
  917. return;
  918. }
  919. }
  920. if (node) {
  921. NodePath path = EditorNode::get_singleton()->get_edited_scene()->get_path_to(node);
  922. int pathid = _get_node_path_cache(path);
  923. Array msg;
  924. msg.push_back(pathid);
  925. msg.push_back(p_name);
  926. for (int i = 0; i < p_argcount; i++) {
  927. //no pointers, sorry
  928. msg.push_back(*p_args[i]);
  929. }
  930. _put_msg("scene:live_node_call", msg);
  931. return;
  932. }
  933. Resource *res = Object::cast_to<Resource>(p_base);
  934. if (res && !res->get_path().is_empty()) {
  935. String respath = res->get_path();
  936. int pathid = _get_res_path_cache(respath);
  937. Array msg;
  938. msg.push_back(pathid);
  939. msg.push_back(p_name);
  940. for (int i = 0; i < p_argcount; i++) {
  941. //no pointers, sorry
  942. msg.push_back(*p_args[i]);
  943. }
  944. _put_msg("scene:live_res_call", msg);
  945. return;
  946. }
  947. }
  948. void ScriptEditorDebugger::_property_changed(Object *p_base, const StringName &p_property, const Variant &p_value) {
  949. if (!p_base || !live_debug || !EditorNode::get_singleton()->get_edited_scene()) {
  950. return;
  951. }
  952. Node *node = Object::cast_to<Node>(p_base);
  953. if (node) {
  954. NodePath path = EditorNode::get_singleton()->get_edited_scene()->get_path_to(node);
  955. int pathid = _get_node_path_cache(path);
  956. if (p_value.is_ref_counted()) {
  957. Ref<Resource> res = p_value;
  958. if (res.is_valid() && !res->get_path().is_empty()) {
  959. Array msg;
  960. msg.push_back(pathid);
  961. msg.push_back(p_property);
  962. msg.push_back(res->get_path());
  963. _put_msg("scene:live_node_prop_res", msg);
  964. }
  965. } else {
  966. Array msg;
  967. msg.push_back(pathid);
  968. msg.push_back(p_property);
  969. msg.push_back(p_value);
  970. _put_msg("scene:live_node_prop", msg);
  971. }
  972. return;
  973. }
  974. Resource *res = Object::cast_to<Resource>(p_base);
  975. if (res && !res->get_path().is_empty()) {
  976. String respath = res->get_path();
  977. int pathid = _get_res_path_cache(respath);
  978. if (p_value.is_ref_counted()) {
  979. Ref<Resource> res2 = p_value;
  980. if (res2.is_valid() && !res2->get_path().is_empty()) {
  981. Array msg;
  982. msg.push_back(pathid);
  983. msg.push_back(p_property);
  984. msg.push_back(res2->get_path());
  985. _put_msg("scene:live_res_prop_res", msg);
  986. }
  987. } else {
  988. Array msg;
  989. msg.push_back(pathid);
  990. msg.push_back(p_property);
  991. msg.push_back(p_value);
  992. _put_msg("scene:live_res_prop", msg);
  993. }
  994. return;
  995. }
  996. }
  997. bool ScriptEditorDebugger::is_move_to_foreground() const {
  998. return move_to_foreground;
  999. }
  1000. void ScriptEditorDebugger::set_move_to_foreground(const bool &p_move_to_foreground) {
  1001. move_to_foreground = p_move_to_foreground;
  1002. }
  1003. String ScriptEditorDebugger::get_stack_script_file() const {
  1004. TreeItem *ti = stack_dump->get_selected();
  1005. if (!ti) {
  1006. return "";
  1007. }
  1008. Dictionary d = ti->get_metadata(0);
  1009. return d["file"];
  1010. }
  1011. int ScriptEditorDebugger::get_stack_script_line() const {
  1012. TreeItem *ti = stack_dump->get_selected();
  1013. if (!ti) {
  1014. return -1;
  1015. }
  1016. Dictionary d = ti->get_metadata(0);
  1017. return d["line"];
  1018. }
  1019. int ScriptEditorDebugger::get_stack_script_frame() const {
  1020. TreeItem *ti = stack_dump->get_selected();
  1021. if (!ti) {
  1022. return -1;
  1023. }
  1024. Dictionary d = ti->get_metadata(0);
  1025. return d["frame"];
  1026. }
  1027. bool ScriptEditorDebugger::request_stack_dump(const int &p_frame) {
  1028. ERR_FAIL_COND_V(!is_session_active() || p_frame < 0, false);
  1029. Array msg;
  1030. msg.push_back(p_frame);
  1031. _put_msg("get_stack_frame_vars", msg);
  1032. return true;
  1033. }
  1034. void ScriptEditorDebugger::set_live_debugging(bool p_enable) {
  1035. live_debug = p_enable;
  1036. }
  1037. void ScriptEditorDebugger::_live_edit_set() {
  1038. if (!is_session_active() || !editor_remote_tree) {
  1039. return;
  1040. }
  1041. TreeItem *ti = editor_remote_tree->get_selected();
  1042. if (!ti) {
  1043. return;
  1044. }
  1045. String path;
  1046. while (ti) {
  1047. String lp = ti->get_text(0);
  1048. path = "/" + lp + path;
  1049. ti = ti->get_parent();
  1050. }
  1051. NodePath np = path;
  1052. EditorNode::get_singleton()->get_editor_data().set_edited_scene_live_edit_root(np);
  1053. update_live_edit_root();
  1054. }
  1055. void ScriptEditorDebugger::_live_edit_clear() {
  1056. NodePath np = NodePath("/root");
  1057. EditorNode::get_singleton()->get_editor_data().set_edited_scene_live_edit_root(np);
  1058. update_live_edit_root();
  1059. }
  1060. void ScriptEditorDebugger::update_live_edit_root() {
  1061. NodePath np = EditorNode::get_singleton()->get_editor_data().get_edited_scene_live_edit_root();
  1062. Array msg;
  1063. msg.push_back(np);
  1064. if (EditorNode::get_singleton()->get_edited_scene()) {
  1065. msg.push_back(EditorNode::get_singleton()->get_edited_scene()->get_scene_file_path());
  1066. } else {
  1067. msg.push_back("");
  1068. }
  1069. _put_msg("scene:live_set_root", msg);
  1070. live_edit_root->set_text(np);
  1071. }
  1072. void ScriptEditorDebugger::live_debug_create_node(const NodePath &p_parent, const String &p_type, const String &p_name) {
  1073. if (live_debug) {
  1074. Array msg;
  1075. msg.push_back(p_parent);
  1076. msg.push_back(p_type);
  1077. msg.push_back(p_name);
  1078. _put_msg("scene:live_create_node", msg);
  1079. }
  1080. }
  1081. void ScriptEditorDebugger::live_debug_instance_node(const NodePath &p_parent, const String &p_path, const String &p_name) {
  1082. if (live_debug) {
  1083. Array msg;
  1084. msg.push_back(p_parent);
  1085. msg.push_back(p_path);
  1086. msg.push_back(p_name);
  1087. _put_msg("scene:live_instance_node", msg);
  1088. }
  1089. }
  1090. void ScriptEditorDebugger::live_debug_remove_node(const NodePath &p_at) {
  1091. if (live_debug) {
  1092. Array msg;
  1093. msg.push_back(p_at);
  1094. _put_msg("scene:live_remove_node", msg);
  1095. }
  1096. }
  1097. void ScriptEditorDebugger::live_debug_remove_and_keep_node(const NodePath &p_at, ObjectID p_keep_id) {
  1098. if (live_debug) {
  1099. Array msg;
  1100. msg.push_back(p_at);
  1101. msg.push_back(p_keep_id);
  1102. _put_msg("scene:live_remove_and_keep_node", msg);
  1103. }
  1104. }
  1105. void ScriptEditorDebugger::live_debug_restore_node(ObjectID p_id, const NodePath &p_at, int p_at_pos) {
  1106. if (live_debug) {
  1107. Array msg;
  1108. msg.push_back(p_id);
  1109. msg.push_back(p_at);
  1110. msg.push_back(p_at_pos);
  1111. _put_msg("scene:live_restore_node", msg);
  1112. }
  1113. }
  1114. void ScriptEditorDebugger::live_debug_duplicate_node(const NodePath &p_at, const String &p_new_name) {
  1115. if (live_debug) {
  1116. Array msg;
  1117. msg.push_back(p_at);
  1118. msg.push_back(p_new_name);
  1119. _put_msg("scene:live_duplicate_node", msg);
  1120. }
  1121. }
  1122. void ScriptEditorDebugger::live_debug_reparent_node(const NodePath &p_at, const NodePath &p_new_place, const String &p_new_name, int p_at_pos) {
  1123. if (live_debug) {
  1124. Array msg;
  1125. msg.push_back(p_at);
  1126. msg.push_back(p_new_place);
  1127. msg.push_back(p_new_name);
  1128. msg.push_back(p_at_pos);
  1129. _put_msg("scene:live_reparent_node", msg);
  1130. }
  1131. }
  1132. CameraOverride ScriptEditorDebugger::get_camera_override() const {
  1133. return camera_override;
  1134. }
  1135. void ScriptEditorDebugger::set_camera_override(CameraOverride p_override) {
  1136. if (p_override == CameraOverride::OVERRIDE_2D && camera_override != CameraOverride::OVERRIDE_2D) {
  1137. Array msg;
  1138. msg.push_back(true);
  1139. _put_msg("scene:override_camera_2D:set", msg);
  1140. } else if (p_override != CameraOverride::OVERRIDE_2D && camera_override == CameraOverride::OVERRIDE_2D) {
  1141. Array msg;
  1142. msg.push_back(false);
  1143. _put_msg("scene:override_camera_2D:set", msg);
  1144. } else if (p_override >= CameraOverride::OVERRIDE_3D_1 && camera_override < CameraOverride::OVERRIDE_3D_1) {
  1145. Array msg;
  1146. msg.push_back(true);
  1147. _put_msg("scene:override_camera_3D:set", msg);
  1148. } else if (p_override < CameraOverride::OVERRIDE_3D_1 && camera_override >= CameraOverride::OVERRIDE_3D_1) {
  1149. Array msg;
  1150. msg.push_back(false);
  1151. _put_msg("scene:override_camera_3D:set", msg);
  1152. }
  1153. camera_override = p_override;
  1154. }
  1155. void ScriptEditorDebugger::set_breakpoint(const String &p_path, int p_line, bool p_enabled) {
  1156. Array msg;
  1157. msg.push_back(p_path);
  1158. msg.push_back(p_line);
  1159. msg.push_back(p_enabled);
  1160. _put_msg("breakpoint", msg);
  1161. TreeItem *path_item = breakpoints_tree->search_item_text(p_path);
  1162. if (path_item == nullptr) {
  1163. if (!p_enabled) {
  1164. return;
  1165. }
  1166. path_item = breakpoints_tree->create_item();
  1167. path_item->set_text(0, p_path);
  1168. }
  1169. int idx = 0;
  1170. TreeItem *breakpoint_item;
  1171. for (breakpoint_item = path_item->get_first_child(); breakpoint_item; breakpoint_item = breakpoint_item->get_next()) {
  1172. if ((int)breakpoint_item->get_meta("line") < p_line) {
  1173. idx++;
  1174. continue;
  1175. }
  1176. if ((int)breakpoint_item->get_meta("line") == p_line) {
  1177. break;
  1178. }
  1179. }
  1180. if (breakpoint_item == nullptr) {
  1181. if (!p_enabled) {
  1182. return;
  1183. }
  1184. breakpoint_item = breakpoints_tree->create_item(path_item, idx);
  1185. breakpoint_item->set_meta("line", p_line);
  1186. breakpoint_item->set_text(0, vformat(TTR("Line %d"), p_line));
  1187. return;
  1188. }
  1189. if (!p_enabled) {
  1190. path_item->remove_child(breakpoint_item);
  1191. if (path_item->get_first_child() == nullptr) {
  1192. breakpoints_tree->get_root()->remove_child(path_item);
  1193. }
  1194. }
  1195. }
  1196. void ScriptEditorDebugger::reload_scripts() {
  1197. _put_msg("reload_scripts", Array());
  1198. }
  1199. bool ScriptEditorDebugger::is_skip_breakpoints() {
  1200. return skip_breakpoints_value;
  1201. }
  1202. void ScriptEditorDebugger::_error_activated() {
  1203. TreeItem *selected = error_tree->get_selected();
  1204. TreeItem *ci = selected->get_first_child();
  1205. if (ci) {
  1206. selected->set_collapsed(!selected->is_collapsed());
  1207. }
  1208. }
  1209. void ScriptEditorDebugger::_error_selected() {
  1210. TreeItem *selected = error_tree->get_selected();
  1211. Array meta = selected->get_metadata(0);
  1212. if (meta.size() == 0) {
  1213. return;
  1214. }
  1215. emit_signal(SNAME("error_selected"), String(meta[0]), int(meta[1]));
  1216. }
  1217. void ScriptEditorDebugger::_expand_errors_list() {
  1218. TreeItem *root = error_tree->get_root();
  1219. if (!root) {
  1220. return;
  1221. }
  1222. TreeItem *item = root->get_first_child();
  1223. while (item) {
  1224. item->set_collapsed(false);
  1225. item = item->get_next();
  1226. }
  1227. }
  1228. void ScriptEditorDebugger::_collapse_errors_list() {
  1229. TreeItem *root = error_tree->get_root();
  1230. if (!root) {
  1231. return;
  1232. }
  1233. TreeItem *item = root->get_first_child();
  1234. while (item) {
  1235. item->set_collapsed(true);
  1236. item = item->get_next();
  1237. }
  1238. }
  1239. void ScriptEditorDebugger::_clear_errors_list() {
  1240. error_tree->clear();
  1241. error_count = 0;
  1242. warning_count = 0;
  1243. update_tabs();
  1244. expand_all_button->set_disabled(true);
  1245. collapse_all_button->set_disabled(true);
  1246. clear_button->set_disabled(true);
  1247. }
  1248. void ScriptEditorDebugger::_breakpoints_item_rmb_selected(const Vector2 &p_pos) {
  1249. breakpoints_menu->clear();
  1250. breakpoints_menu->set_size(Size2(1, 1));
  1251. const TreeItem *selected = breakpoints_tree->get_selected();
  1252. String file = selected->get_text(0);
  1253. if (selected->has_meta("line")) {
  1254. breakpoints_menu->add_icon_item(get_theme_icon(SNAME("Remove"), SNAME("EditorIcons")), TTR("Delete Breakpoint"), ACTION_DELETE_BREAKPOINT);
  1255. file = selected->get_parent()->get_text(0);
  1256. }
  1257. breakpoints_menu->add_icon_item(get_theme_icon(SNAME("Remove"), SNAME("EditorIcons")), TTR("Delete All Breakpoints in: ") + file, ACTION_DELETE_BREAKPOINTS_IN_FILE);
  1258. breakpoints_menu->add_icon_item(get_theme_icon(SNAME("Remove"), SNAME("EditorIcons")), TTR("Delete All Breakpoints"), ACTION_DELETE_ALL_BREAKPOINTS);
  1259. breakpoints_menu->set_position(breakpoints_tree->get_global_position() + p_pos);
  1260. breakpoints_menu->popup();
  1261. }
  1262. // Right click on specific file(s) or folder(s).
  1263. void ScriptEditorDebugger::_error_tree_item_rmb_selected(const Vector2 &p_pos) {
  1264. item_menu->clear();
  1265. item_menu->reset_size();
  1266. if (error_tree->is_anything_selected()) {
  1267. item_menu->add_icon_item(get_theme_icon(SNAME("ActionCopy"), SNAME("EditorIcons")), TTR("Copy Error"), ACTION_COPY_ERROR);
  1268. item_menu->add_icon_item(get_theme_icon(SNAME("Instance"), SNAME("EditorIcons")), TTR("Open C++ Source on GitHub"), ACTION_OPEN_SOURCE);
  1269. }
  1270. if (item_menu->get_item_count() > 0) {
  1271. item_menu->set_position(error_tree->get_screen_position() + p_pos);
  1272. item_menu->popup();
  1273. }
  1274. }
  1275. void ScriptEditorDebugger::_item_menu_id_pressed(int p_option) {
  1276. switch (p_option) {
  1277. case ACTION_COPY_ERROR: {
  1278. TreeItem *ti = error_tree->get_selected();
  1279. while (ti->get_parent() != error_tree->get_root()) {
  1280. ti = ti->get_parent();
  1281. }
  1282. String type;
  1283. if (ti->get_icon(0) == get_theme_icon(SNAME("Warning"), SNAME("EditorIcons"))) {
  1284. type = "W ";
  1285. } else if (ti->get_icon(0) == get_theme_icon(SNAME("Error"), SNAME("EditorIcons"))) {
  1286. type = "E ";
  1287. }
  1288. String text = ti->get_text(0) + " ";
  1289. int rpad_len = text.length();
  1290. text = type + text + ti->get_text(1) + "\n";
  1291. TreeItem *ci = ti->get_first_child();
  1292. while (ci) {
  1293. text += " " + ci->get_text(0).rpad(rpad_len) + ci->get_text(1) + "\n";
  1294. ci = ci->get_next();
  1295. }
  1296. DisplayServer::get_singleton()->clipboard_set(text);
  1297. } break;
  1298. case ACTION_OPEN_SOURCE: {
  1299. TreeItem *ti = error_tree->get_selected();
  1300. while (ti->get_parent() != error_tree->get_root()) {
  1301. ti = ti->get_parent();
  1302. }
  1303. // We only need the first child here (C++ source stack trace).
  1304. TreeItem *ci = ti->get_first_child();
  1305. // Parse back the `file:line @ method()` string.
  1306. const Vector<String> file_line_number = ci->get_text(1).split("@")[0].strip_edges().split(":");
  1307. ERR_FAIL_COND_MSG(file_line_number.size() < 2, "Incorrect C++ source stack trace file:line format (please report).");
  1308. const String file = file_line_number[0];
  1309. const int line_number = file_line_number[1].to_int();
  1310. // Construct a GitHub repository URL and open it in the user's default web browser.
  1311. // If the commit hash is available, use it for greater accuracy. Otherwise fall back to tagged release.
  1312. String git_ref = String(VERSION_HASH).is_empty() ? String(VERSION_NUMBER) + "-stable" : String(VERSION_HASH);
  1313. OS::get_singleton()->shell_open(vformat("https://github.com/godotengine/godot/blob/%s/%s#L%d",
  1314. git_ref, file, line_number));
  1315. } break;
  1316. case ACTION_DELETE_BREAKPOINT: {
  1317. const TreeItem *selected = breakpoints_tree->get_selected();
  1318. _set_breakpoint(selected->get_parent()->get_text(0), selected->get_meta("line"), false);
  1319. } break;
  1320. case ACTION_DELETE_BREAKPOINTS_IN_FILE: {
  1321. TreeItem *file_item = breakpoints_tree->get_selected();
  1322. if (file_item->has_meta("line")) {
  1323. file_item = file_item->get_parent();
  1324. }
  1325. // Store first else we will be removing as we loop.
  1326. List<int> lines;
  1327. for (TreeItem *breakpoint_item = file_item->get_first_child(); breakpoint_item; breakpoint_item = breakpoint_item->get_next()) {
  1328. lines.push_back(breakpoint_item->get_meta("line"));
  1329. }
  1330. for (const int &line : lines) {
  1331. _set_breakpoint(file_item->get_text(0), line, false);
  1332. }
  1333. } break;
  1334. case ACTION_DELETE_ALL_BREAKPOINTS: {
  1335. _clear_breakpoints();
  1336. } break;
  1337. }
  1338. }
  1339. void ScriptEditorDebugger::_tab_changed(int p_tab) {
  1340. if (tabs->get_tab_title(p_tab) == TTR("Video RAM")) {
  1341. // "Video RAM" tab was clicked, refresh the data it's displaying when entering the tab.
  1342. _video_mem_request();
  1343. }
  1344. }
  1345. void ScriptEditorDebugger::_bind_methods() {
  1346. ClassDB::bind_method(D_METHOD("live_debug_create_node"), &ScriptEditorDebugger::live_debug_create_node);
  1347. ClassDB::bind_method(D_METHOD("live_debug_instance_node"), &ScriptEditorDebugger::live_debug_instance_node);
  1348. ClassDB::bind_method(D_METHOD("live_debug_remove_node"), &ScriptEditorDebugger::live_debug_remove_node);
  1349. ClassDB::bind_method(D_METHOD("live_debug_remove_and_keep_node"), &ScriptEditorDebugger::live_debug_remove_and_keep_node);
  1350. ClassDB::bind_method(D_METHOD("live_debug_restore_node"), &ScriptEditorDebugger::live_debug_restore_node);
  1351. ClassDB::bind_method(D_METHOD("live_debug_duplicate_node"), &ScriptEditorDebugger::live_debug_duplicate_node);
  1352. ClassDB::bind_method(D_METHOD("live_debug_reparent_node"), &ScriptEditorDebugger::live_debug_reparent_node);
  1353. ClassDB::bind_method(D_METHOD("request_remote_object", "id"), &ScriptEditorDebugger::request_remote_object);
  1354. ClassDB::bind_method(D_METHOD("update_remote_object", "id", "property", "value"), &ScriptEditorDebugger::update_remote_object);
  1355. ADD_SIGNAL(MethodInfo("started"));
  1356. ADD_SIGNAL(MethodInfo("stopped"));
  1357. ADD_SIGNAL(MethodInfo("stop_requested"));
  1358. ADD_SIGNAL(MethodInfo("stack_frame_selected", PropertyInfo(Variant::INT, "frame")));
  1359. ADD_SIGNAL(MethodInfo("error_selected", PropertyInfo(Variant::INT, "error")));
  1360. ADD_SIGNAL(MethodInfo("breakpoint_selected", PropertyInfo("script"), PropertyInfo(Variant::INT, "line")));
  1361. ADD_SIGNAL(MethodInfo("set_execution", PropertyInfo("script"), PropertyInfo(Variant::INT, "line")));
  1362. ADD_SIGNAL(MethodInfo("clear_execution", PropertyInfo("script")));
  1363. ADD_SIGNAL(MethodInfo("breaked", PropertyInfo(Variant::BOOL, "reallydid"), PropertyInfo(Variant::BOOL, "can_debug"), PropertyInfo(Variant::STRING, "reason"), PropertyInfo(Variant::BOOL, "has_stackdump")));
  1364. ADD_SIGNAL(MethodInfo("remote_object_requested", PropertyInfo(Variant::INT, "id")));
  1365. ADD_SIGNAL(MethodInfo("remote_object_updated", PropertyInfo(Variant::INT, "id")));
  1366. ADD_SIGNAL(MethodInfo("remote_object_property_updated", PropertyInfo(Variant::INT, "id"), PropertyInfo(Variant::STRING, "property")));
  1367. ADD_SIGNAL(MethodInfo("remote_tree_updated"));
  1368. ADD_SIGNAL(MethodInfo("output"));
  1369. ADD_SIGNAL(MethodInfo("stack_dump", PropertyInfo(Variant::ARRAY, "stack_dump")));
  1370. ADD_SIGNAL(MethodInfo("stack_frame_vars", PropertyInfo(Variant::INT, "num_vars")));
  1371. ADD_SIGNAL(MethodInfo("stack_frame_var", PropertyInfo(Variant::ARRAY, "data")));
  1372. ADD_SIGNAL(MethodInfo("debug_data", PropertyInfo(Variant::STRING, "msg"), PropertyInfo(Variant::ARRAY, "data")));
  1373. ADD_SIGNAL(MethodInfo("set_breakpoint", PropertyInfo("script"), PropertyInfo(Variant::INT, "line"), PropertyInfo(Variant::BOOL, "enabled")));
  1374. ADD_SIGNAL(MethodInfo("clear_breakpoints"));
  1375. }
  1376. void ScriptEditorDebugger::add_debugger_plugin(const Ref<Script> &p_script) {
  1377. if (!debugger_plugins.has(p_script)) {
  1378. EditorDebuggerPlugin *plugin = memnew(EditorDebuggerPlugin());
  1379. plugin->attach_debugger(this);
  1380. plugin->set_script(p_script);
  1381. tabs->add_child(plugin);
  1382. debugger_plugins.insert(p_script, plugin);
  1383. }
  1384. }
  1385. void ScriptEditorDebugger::remove_debugger_plugin(const Ref<Script> &p_script) {
  1386. if (debugger_plugins.has(p_script)) {
  1387. tabs->remove_child(debugger_plugins[p_script]);
  1388. debugger_plugins[p_script]->detach_debugger(false);
  1389. memdelete(debugger_plugins[p_script]);
  1390. debugger_plugins.erase(p_script);
  1391. }
  1392. }
  1393. void ScriptEditorDebugger::send_message(const String &p_message, const Array &p_args) {
  1394. _put_msg(p_message, p_args);
  1395. }
  1396. void ScriptEditorDebugger::register_message_capture(const StringName &p_name, const Callable &p_callable) {
  1397. ERR_FAIL_COND_MSG(has_capture(p_name), "Capture already registered: " + p_name);
  1398. captures.insert(p_name, p_callable);
  1399. }
  1400. void ScriptEditorDebugger::unregister_message_capture(const StringName &p_name) {
  1401. ERR_FAIL_COND_MSG(!has_capture(p_name), "Capture not registered: " + p_name);
  1402. captures.erase(p_name);
  1403. }
  1404. bool ScriptEditorDebugger::has_capture(const StringName &p_name) {
  1405. return captures.has(p_name);
  1406. }
  1407. ScriptEditorDebugger::ScriptEditorDebugger() {
  1408. tabs = memnew(TabContainer);
  1409. tabs->set_tab_alignment(TabBar::ALIGNMENT_LEFT);
  1410. tabs->add_theme_style_override("panel", EditorNode::get_singleton()->get_gui_base()->get_theme_stylebox(SNAME("DebuggerPanel"), SNAME("EditorStyles")));
  1411. tabs->connect("tab_changed", callable_mp(this, &ScriptEditorDebugger::_tab_changed));
  1412. add_child(tabs);
  1413. { //debugger
  1414. VBoxContainer *vbc = memnew(VBoxContainer);
  1415. vbc->set_name(TTR("Debugger"));
  1416. Control *dbg = vbc;
  1417. HBoxContainer *hbc = memnew(HBoxContainer);
  1418. vbc->add_child(hbc);
  1419. reason = memnew(Label);
  1420. reason->set_text("");
  1421. hbc->add_child(reason);
  1422. reason->set_h_size_flags(SIZE_EXPAND_FILL);
  1423. reason->set_autowrap_mode(Label::AUTOWRAP_WORD_SMART);
  1424. reason->set_max_lines_visible(3);
  1425. reason->set_mouse_filter(Control::MOUSE_FILTER_PASS);
  1426. hbc->add_child(memnew(VSeparator));
  1427. skip_breakpoints = memnew(Button);
  1428. skip_breakpoints->set_flat(true);
  1429. hbc->add_child(skip_breakpoints);
  1430. skip_breakpoints->set_tooltip(TTR("Skip Breakpoints"));
  1431. skip_breakpoints->connect("pressed", callable_mp(this, &ScriptEditorDebugger::debug_skip_breakpoints));
  1432. hbc->add_child(memnew(VSeparator));
  1433. copy = memnew(Button);
  1434. copy->set_flat(true);
  1435. hbc->add_child(copy);
  1436. copy->set_tooltip(TTR("Copy Error"));
  1437. copy->connect("pressed", callable_mp(this, &ScriptEditorDebugger::debug_copy));
  1438. hbc->add_child(memnew(VSeparator));
  1439. step = memnew(Button);
  1440. step->set_flat(true);
  1441. hbc->add_child(step);
  1442. step->set_tooltip(TTR("Step Into"));
  1443. step->set_shortcut(ED_GET_SHORTCUT("debugger/step_into"));
  1444. step->connect("pressed", callable_mp(this, &ScriptEditorDebugger::debug_step));
  1445. next = memnew(Button);
  1446. next->set_flat(true);
  1447. hbc->add_child(next);
  1448. next->set_tooltip(TTR("Step Over"));
  1449. next->set_shortcut(ED_GET_SHORTCUT("debugger/step_over"));
  1450. next->connect("pressed", callable_mp(this, &ScriptEditorDebugger::debug_next));
  1451. hbc->add_child(memnew(VSeparator));
  1452. dobreak = memnew(Button);
  1453. dobreak->set_flat(true);
  1454. hbc->add_child(dobreak);
  1455. dobreak->set_tooltip(TTR("Break"));
  1456. dobreak->set_shortcut(ED_GET_SHORTCUT("debugger/break"));
  1457. dobreak->connect("pressed", callable_mp(this, &ScriptEditorDebugger::debug_break));
  1458. docontinue = memnew(Button);
  1459. docontinue->set_flat(true);
  1460. hbc->add_child(docontinue);
  1461. docontinue->set_tooltip(TTR("Continue"));
  1462. docontinue->set_shortcut(ED_GET_SHORTCUT("debugger/continue"));
  1463. docontinue->connect("pressed", callable_mp(this, &ScriptEditorDebugger::debug_continue));
  1464. HSplitContainer *parent_sc = memnew(HSplitContainer);
  1465. vbc->add_child(parent_sc);
  1466. parent_sc->set_v_size_flags(SIZE_EXPAND_FILL);
  1467. parent_sc->set_split_offset(500 * EDSCALE);
  1468. HSplitContainer *sc = memnew(HSplitContainer);
  1469. sc->set_v_size_flags(SIZE_EXPAND_FILL);
  1470. sc->set_h_size_flags(SIZE_EXPAND_FILL);
  1471. parent_sc->add_child(sc);
  1472. stack_dump = memnew(Tree);
  1473. stack_dump->set_allow_reselect(true);
  1474. stack_dump->set_columns(1);
  1475. stack_dump->set_column_titles_visible(true);
  1476. stack_dump->set_column_title(0, TTR("Stack Frames"));
  1477. stack_dump->set_h_size_flags(SIZE_EXPAND_FILL);
  1478. stack_dump->set_hide_root(true);
  1479. stack_dump->connect("cell_selected", callable_mp(this, &ScriptEditorDebugger::_stack_dump_frame_selected));
  1480. sc->add_child(stack_dump);
  1481. VBoxContainer *inspector_vbox = memnew(VBoxContainer);
  1482. inspector_vbox->set_h_size_flags(SIZE_EXPAND_FILL);
  1483. sc->add_child(inspector_vbox);
  1484. HBoxContainer *tools_hb = memnew(HBoxContainer);
  1485. inspector_vbox->add_child(tools_hb);
  1486. search = memnew(LineEdit);
  1487. search->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  1488. search->set_placeholder(TTR("Filter stack variables"));
  1489. search->set_clear_button_enabled(true);
  1490. tools_hb->add_child(search);
  1491. inspector = memnew(EditorDebuggerInspector);
  1492. inspector->set_h_size_flags(SIZE_EXPAND_FILL);
  1493. inspector->set_v_size_flags(SIZE_EXPAND_FILL);
  1494. inspector->set_enable_capitalize_paths(false);
  1495. inspector->set_read_only(true);
  1496. inspector->connect("object_selected", callable_mp(this, &ScriptEditorDebugger::_remote_object_selected));
  1497. inspector->connect("object_edited", callable_mp(this, &ScriptEditorDebugger::_remote_object_edited));
  1498. inspector->connect("object_property_updated", callable_mp(this, &ScriptEditorDebugger::_remote_object_property_updated));
  1499. inspector->register_text_enter(search);
  1500. inspector->set_use_filter(true);
  1501. inspector_vbox->add_child(inspector);
  1502. breakpoints_tree = memnew(Tree);
  1503. breakpoints_tree->set_h_size_flags(SIZE_EXPAND_FILL);
  1504. breakpoints_tree->set_column_titles_visible(true);
  1505. breakpoints_tree->set_column_title(0, TTR("Breakpoints"));
  1506. breakpoints_tree->set_allow_reselect(true);
  1507. breakpoints_tree->set_allow_rmb_select(true);
  1508. breakpoints_tree->set_hide_root(true);
  1509. breakpoints_tree->connect("item_rmb_selected", callable_mp(this, &ScriptEditorDebugger::_breakpoints_item_rmb_selected));
  1510. breakpoints_tree->create_item();
  1511. parent_sc->add_child(breakpoints_tree);
  1512. tabs->add_child(dbg);
  1513. breakpoints_menu = memnew(PopupMenu);
  1514. breakpoints_menu->connect("id_pressed", callable_mp(this, &ScriptEditorDebugger::_item_menu_id_pressed));
  1515. breakpoints_tree->add_child(breakpoints_menu);
  1516. }
  1517. { //errors
  1518. errors_tab = memnew(VBoxContainer);
  1519. errors_tab->set_name(TTR("Errors"));
  1520. HBoxContainer *error_hbox = memnew(HBoxContainer);
  1521. errors_tab->add_child(error_hbox);
  1522. expand_all_button = memnew(Button);
  1523. expand_all_button->set_text(TTR("Expand All"));
  1524. expand_all_button->set_disabled(true);
  1525. expand_all_button->connect("pressed", callable_mp(this, &ScriptEditorDebugger::_expand_errors_list));
  1526. error_hbox->add_child(expand_all_button);
  1527. collapse_all_button = memnew(Button);
  1528. collapse_all_button->set_text(TTR("Collapse All"));
  1529. collapse_all_button->set_disabled(true);
  1530. collapse_all_button->connect("pressed", callable_mp(this, &ScriptEditorDebugger::_collapse_errors_list));
  1531. error_hbox->add_child(collapse_all_button);
  1532. Control *space = memnew(Control);
  1533. space->set_h_size_flags(SIZE_EXPAND_FILL);
  1534. error_hbox->add_child(space);
  1535. clear_button = memnew(Button);
  1536. clear_button->set_text(TTR("Clear"));
  1537. clear_button->set_h_size_flags(0);
  1538. clear_button->set_disabled(true);
  1539. clear_button->connect("pressed", callable_mp(this, &ScriptEditorDebugger::_clear_errors_list));
  1540. error_hbox->add_child(clear_button);
  1541. error_tree = memnew(Tree);
  1542. error_tree->set_columns(2);
  1543. error_tree->set_column_expand(0, false);
  1544. error_tree->set_column_custom_minimum_width(0, 140);
  1545. error_tree->set_column_clip_content(0, true);
  1546. error_tree->set_column_expand(1, true);
  1547. error_tree->set_column_clip_content(1, true);
  1548. error_tree->set_select_mode(Tree::SELECT_ROW);
  1549. error_tree->set_hide_root(true);
  1550. error_tree->set_v_size_flags(SIZE_EXPAND_FILL);
  1551. error_tree->set_allow_rmb_select(true);
  1552. error_tree->connect("item_rmb_selected", callable_mp(this, &ScriptEditorDebugger::_error_tree_item_rmb_selected));
  1553. errors_tab->add_child(error_tree);
  1554. item_menu = memnew(PopupMenu);
  1555. item_menu->connect("id_pressed", callable_mp(this, &ScriptEditorDebugger::_item_menu_id_pressed));
  1556. error_tree->add_child(item_menu);
  1557. tabs->add_child(errors_tab);
  1558. }
  1559. { // File dialog
  1560. file_dialog = memnew(EditorFileDialog);
  1561. file_dialog->connect("file_selected", callable_mp(this, &ScriptEditorDebugger::_file_selected));
  1562. add_child(file_dialog);
  1563. }
  1564. { //profiler
  1565. profiler = memnew(EditorProfiler);
  1566. profiler->set_name(TTR("Profiler"));
  1567. tabs->add_child(profiler);
  1568. profiler->connect("enable_profiling", callable_mp(this, &ScriptEditorDebugger::_profiler_activate), varray(PROFILER_SCRIPTS_SERVERS));
  1569. profiler->connect("break_request", callable_mp(this, &ScriptEditorDebugger::_profiler_seeked));
  1570. }
  1571. { //frame profiler
  1572. visual_profiler = memnew(EditorVisualProfiler);
  1573. visual_profiler->set_name(TTR("Visual Profiler"));
  1574. tabs->add_child(visual_profiler);
  1575. visual_profiler->connect("enable_profiling", callable_mp(this, &ScriptEditorDebugger::_profiler_activate), varray(PROFILER_VISUAL));
  1576. }
  1577. { //network profiler
  1578. network_profiler = memnew(EditorNetworkProfiler);
  1579. network_profiler->set_name(TTR("Network Profiler"));
  1580. tabs->add_child(network_profiler);
  1581. network_profiler->connect("enable_profiling", callable_mp(this, &ScriptEditorDebugger::_profiler_activate), varray(PROFILER_NETWORK));
  1582. }
  1583. { //monitors
  1584. performance_profiler = memnew(EditorPerformanceProfiler);
  1585. tabs->add_child(performance_profiler);
  1586. }
  1587. { //vmem inspect
  1588. VBoxContainer *vmem_vb = memnew(VBoxContainer);
  1589. HBoxContainer *vmem_hb = memnew(HBoxContainer);
  1590. Label *vmlb = memnew(Label(TTR("List of Video Memory Usage by Resource:") + " "));
  1591. vmlb->set_theme_type_variation("HeaderSmall");
  1592. vmlb->set_h_size_flags(SIZE_EXPAND_FILL);
  1593. vmem_hb->add_child(vmlb);
  1594. vmem_hb->add_child(memnew(Label(TTR("Total:") + " ")));
  1595. vmem_total = memnew(LineEdit);
  1596. vmem_total->set_editable(false);
  1597. vmem_total->set_custom_minimum_size(Size2(100, 0) * EDSCALE);
  1598. vmem_hb->add_child(vmem_total);
  1599. vmem_refresh = memnew(Button);
  1600. vmem_refresh->set_flat(true);
  1601. vmem_hb->add_child(vmem_refresh);
  1602. vmem_export = memnew(Button);
  1603. vmem_export->set_flat(true);
  1604. vmem_export->set_tooltip(TTR("Export list to a CSV file"));
  1605. vmem_hb->add_child(vmem_export);
  1606. vmem_vb->add_child(vmem_hb);
  1607. vmem_refresh->connect("pressed", callable_mp(this, &ScriptEditorDebugger::_video_mem_request));
  1608. vmem_export->connect("pressed", callable_mp(this, &ScriptEditorDebugger::_video_mem_export));
  1609. VBoxContainer *vmmc = memnew(VBoxContainer);
  1610. vmem_tree = memnew(Tree);
  1611. vmem_tree->set_v_size_flags(SIZE_EXPAND_FILL);
  1612. vmem_tree->set_h_size_flags(SIZE_EXPAND_FILL);
  1613. vmmc->add_child(vmem_tree);
  1614. vmmc->set_v_size_flags(SIZE_EXPAND_FILL);
  1615. vmem_vb->add_child(vmmc);
  1616. vmem_vb->set_name(TTR("Video RAM"));
  1617. vmem_tree->set_columns(4);
  1618. vmem_tree->set_column_titles_visible(true);
  1619. vmem_tree->set_column_title(0, TTR("Resource Path"));
  1620. vmem_tree->set_column_expand(0, true);
  1621. vmem_tree->set_column_expand(1, false);
  1622. vmem_tree->set_column_title(1, TTR("Type"));
  1623. vmem_tree->set_column_custom_minimum_width(1, 100 * EDSCALE);
  1624. vmem_tree->set_column_expand(2, false);
  1625. vmem_tree->set_column_title(2, TTR("Format"));
  1626. vmem_tree->set_column_custom_minimum_width(2, 150 * EDSCALE);
  1627. vmem_tree->set_column_expand(3, false);
  1628. vmem_tree->set_column_title(3, TTR("Usage"));
  1629. vmem_tree->set_column_custom_minimum_width(3, 80 * EDSCALE);
  1630. vmem_tree->set_hide_root(true);
  1631. tabs->add_child(vmem_vb);
  1632. }
  1633. { // misc
  1634. VBoxContainer *misc = memnew(VBoxContainer);
  1635. misc->set_name(TTR("Misc"));
  1636. tabs->add_child(misc);
  1637. GridContainer *info_left = memnew(GridContainer);
  1638. info_left->set_columns(2);
  1639. misc->add_child(info_left);
  1640. clicked_ctrl = memnew(LineEdit);
  1641. clicked_ctrl->set_h_size_flags(SIZE_EXPAND_FILL);
  1642. info_left->add_child(memnew(Label(TTR("Clicked Control:"))));
  1643. info_left->add_child(clicked_ctrl);
  1644. clicked_ctrl_type = memnew(LineEdit);
  1645. info_left->add_child(memnew(Label(TTR("Clicked Control Type:"))));
  1646. info_left->add_child(clicked_ctrl_type);
  1647. scene_tree = memnew(SceneDebuggerTree);
  1648. live_edit_root = memnew(LineEdit);
  1649. live_edit_root->set_h_size_flags(SIZE_EXPAND_FILL);
  1650. {
  1651. HBoxContainer *lehb = memnew(HBoxContainer);
  1652. Label *l = memnew(Label(TTR("Live Edit Root:")));
  1653. info_left->add_child(l);
  1654. lehb->add_child(live_edit_root);
  1655. le_set = memnew(Button(TTR("Set From Tree")));
  1656. lehb->add_child(le_set);
  1657. le_clear = memnew(Button(TTR("Clear")));
  1658. lehb->add_child(le_clear);
  1659. info_left->add_child(lehb);
  1660. }
  1661. misc->add_child(memnew(VSeparator));
  1662. HBoxContainer *buttons = memnew(HBoxContainer);
  1663. export_csv = memnew(Button(TTR("Export measures as CSV")));
  1664. export_csv->connect("pressed", callable_mp(this, &ScriptEditorDebugger::_export_csv));
  1665. buttons->add_child(export_csv);
  1666. misc->add_child(buttons);
  1667. }
  1668. msgdialog = memnew(AcceptDialog);
  1669. add_child(msgdialog);
  1670. live_debug = true;
  1671. camera_override = CameraOverride::OVERRIDE_NONE;
  1672. last_path_id = false;
  1673. error_count = 0;
  1674. warning_count = 0;
  1675. _update_buttons_state();
  1676. }
  1677. ScriptEditorDebugger::~ScriptEditorDebugger() {
  1678. if (peer.is_valid()) {
  1679. peer->close();
  1680. peer.unref();
  1681. }
  1682. memdelete(scene_tree);
  1683. }