script_editor_debugger.cpp 65 KB

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