script_editor_debugger.cpp 65 KB

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