script_editor_debugger.cpp 65 KB

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