script_editor_debugger.cpp 66 KB

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