script_editor_debugger.cpp 60 KB

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