script_editor_debugger.cpp 82 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779
  1. /*************************************************************************/
  2. /* script_editor_debugger.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "script_editor_debugger.h"
  31. #include "core/io/marshalls.h"
  32. #include "core/project_settings.h"
  33. #include "core/ustring.h"
  34. #include "editor/editor_log.h"
  35. #include "editor/plugins/canvas_item_editor_plugin.h"
  36. #include "editor/plugins/spatial_editor_plugin.h"
  37. #include "editor_log.h"
  38. #include "editor_network_profiler.h"
  39. #include "editor_node.h"
  40. #include "editor_profiler.h"
  41. #include "editor_scale.h"
  42. #include "editor_settings.h"
  43. #include "main/performance.h"
  44. #include "property_editor.h"
  45. #include "scene/debugger/script_debugger_remote.h"
  46. #include "scene/gui/dialogs.h"
  47. #include "scene/gui/label.h"
  48. #include "scene/gui/line_edit.h"
  49. #include "scene/gui/margin_container.h"
  50. #include "scene/gui/rich_text_label.h"
  51. #include "scene/gui/separator.h"
  52. #include "scene/gui/split_container.h"
  53. #include "scene/gui/tab_container.h"
  54. #include "scene/gui/texture_button.h"
  55. #include "scene/gui/tree.h"
  56. #include "scene/resources/packed_scene.h"
  57. class ScriptEditorDebuggerVariables : public Object {
  58. GDCLASS(ScriptEditorDebuggerVariables, Object);
  59. List<PropertyInfo> props;
  60. Map<StringName, Variant> values;
  61. protected:
  62. bool _set(const StringName &p_name, const Variant &p_value) {
  63. return false;
  64. }
  65. bool _get(const StringName &p_name, Variant &r_ret) const {
  66. if (!values.has(p_name))
  67. return false;
  68. r_ret = values[p_name];
  69. return true;
  70. }
  71. void _get_property_list(List<PropertyInfo> *p_list) const {
  72. for (const List<PropertyInfo>::Element *E = props.front(); E; E = E->next())
  73. p_list->push_back(E->get());
  74. }
  75. public:
  76. void clear() {
  77. props.clear();
  78. values.clear();
  79. }
  80. String get_var_value(const String &p_var) const {
  81. for (Map<StringName, Variant>::Element *E = values.front(); E; E = E->next()) {
  82. String v = E->key().operator String().get_slice("/", 1);
  83. if (v == p_var)
  84. return E->get();
  85. }
  86. return "";
  87. }
  88. void add_property(const String &p_name, const Variant &p_value, const PropertyHint &p_hint, const String p_hint_string) {
  89. PropertyInfo pinfo;
  90. pinfo.name = p_name;
  91. pinfo.type = p_value.get_type();
  92. pinfo.hint = p_hint;
  93. pinfo.hint_string = p_hint_string;
  94. props.push_back(pinfo);
  95. values[p_name] = p_value;
  96. }
  97. void update() {
  98. _change_notify();
  99. }
  100. ScriptEditorDebuggerVariables() {
  101. }
  102. };
  103. class ScriptEditorDebuggerInspectedObject : public Object {
  104. GDCLASS(ScriptEditorDebuggerInspectedObject, Object);
  105. protected:
  106. bool _set(const StringName &p_name, const Variant &p_value) {
  107. if (!prop_values.has(p_name) || String(p_name).begins_with("Constants/"))
  108. return false;
  109. prop_values[p_name] = p_value;
  110. emit_signal("value_edited", p_name, p_value);
  111. return true;
  112. }
  113. bool _get(const StringName &p_name, Variant &r_ret) const {
  114. if (!prop_values.has(p_name))
  115. return false;
  116. r_ret = prop_values[p_name];
  117. return true;
  118. }
  119. void _get_property_list(List<PropertyInfo> *p_list) const {
  120. p_list->clear(); //sorry, no want category
  121. for (const List<PropertyInfo>::Element *E = prop_list.front(); E; E = E->next()) {
  122. p_list->push_back(E->get());
  123. }
  124. }
  125. static void _bind_methods() {
  126. ClassDB::bind_method(D_METHOD("get_title"), &ScriptEditorDebuggerInspectedObject::get_title);
  127. ClassDB::bind_method(D_METHOD("get_variant"), &ScriptEditorDebuggerInspectedObject::get_variant);
  128. ClassDB::bind_method(D_METHOD("clear"), &ScriptEditorDebuggerInspectedObject::clear);
  129. ClassDB::bind_method(D_METHOD("get_remote_object_id"), &ScriptEditorDebuggerInspectedObject::get_remote_object_id);
  130. ADD_SIGNAL(MethodInfo("value_edited"));
  131. }
  132. public:
  133. String type_name;
  134. ObjectID remote_object_id;
  135. List<PropertyInfo> prop_list;
  136. Map<StringName, Variant> prop_values;
  137. ObjectID get_remote_object_id() {
  138. return remote_object_id;
  139. }
  140. String get_title() {
  141. if (remote_object_id)
  142. return TTR("Remote ") + String(type_name) + ": " + itos(remote_object_id);
  143. else
  144. return "<null>";
  145. }
  146. Variant get_variant(const StringName &p_name) {
  147. Variant var;
  148. _get(p_name, var);
  149. return var;
  150. }
  151. void clear() {
  152. prop_list.clear();
  153. prop_values.clear();
  154. }
  155. void update() {
  156. _change_notify();
  157. }
  158. void update_single(const char *p_prop) {
  159. _change_notify(p_prop);
  160. }
  161. ScriptEditorDebuggerInspectedObject() {
  162. remote_object_id = 0;
  163. }
  164. };
  165. void ScriptEditorDebugger::debug_copy() {
  166. String msg = reason->get_text();
  167. if (msg == "") return;
  168. OS::get_singleton()->set_clipboard(msg);
  169. }
  170. void ScriptEditorDebugger::debug_skip_breakpoints() {
  171. skip_breakpoints_value = !skip_breakpoints_value;
  172. if (skip_breakpoints_value)
  173. skip_breakpoints->set_icon(get_icon("DebugSkipBreakpointsOn", "EditorIcons"));
  174. else
  175. skip_breakpoints->set_icon(get_icon("DebugSkipBreakpointsOff", "EditorIcons"));
  176. if (connection.is_valid()) {
  177. Array msg;
  178. msg.push_back("set_skip_breakpoints");
  179. msg.push_back(skip_breakpoints_value);
  180. ppeer->put_var(msg);
  181. }
  182. }
  183. void ScriptEditorDebugger::debug_next() {
  184. ERR_FAIL_COND(!breaked);
  185. ERR_FAIL_COND(connection.is_null());
  186. ERR_FAIL_COND(!connection->is_connected_to_host());
  187. Array msg;
  188. msg.push_back("next");
  189. ppeer->put_var(msg);
  190. _clear_execution();
  191. stack_dump->clear();
  192. }
  193. void ScriptEditorDebugger::debug_step() {
  194. ERR_FAIL_COND(!breaked);
  195. ERR_FAIL_COND(connection.is_null());
  196. ERR_FAIL_COND(!connection->is_connected_to_host());
  197. Array msg;
  198. msg.push_back("step");
  199. ppeer->put_var(msg);
  200. _clear_execution();
  201. stack_dump->clear();
  202. }
  203. void ScriptEditorDebugger::debug_break() {
  204. ERR_FAIL_COND(breaked);
  205. ERR_FAIL_COND(connection.is_null());
  206. ERR_FAIL_COND(!connection->is_connected_to_host());
  207. Array msg;
  208. msg.push_back("break");
  209. ppeer->put_var(msg);
  210. }
  211. void ScriptEditorDebugger::debug_continue() {
  212. ERR_FAIL_COND(!breaked);
  213. ERR_FAIL_COND(connection.is_null());
  214. ERR_FAIL_COND(!connection->is_connected_to_host());
  215. OS::get_singleton()->enable_for_stealing_focus(EditorNode::get_singleton()->get_child_process_id());
  216. Array msg;
  217. _clear_execution();
  218. msg.push_back("continue");
  219. ppeer->put_var(msg);
  220. }
  221. void ScriptEditorDebugger::_scene_tree_folded(Object *obj) {
  222. if (updating_scene_tree) {
  223. return;
  224. }
  225. TreeItem *item = Object::cast_to<TreeItem>(obj);
  226. if (!item)
  227. return;
  228. ObjectID id = item->get_metadata(0);
  229. if (unfold_cache.has(id)) {
  230. unfold_cache.erase(id);
  231. } else {
  232. unfold_cache.insert(id);
  233. }
  234. }
  235. void ScriptEditorDebugger::_scene_tree_selected() {
  236. if (updating_scene_tree) {
  237. return;
  238. }
  239. TreeItem *item = inspect_scene_tree->get_selected();
  240. if (!item) {
  241. return;
  242. }
  243. inspected_object_id = item->get_metadata(0);
  244. Array msg;
  245. msg.push_back("inspect_object");
  246. msg.push_back(inspected_object_id);
  247. ppeer->put_var(msg);
  248. }
  249. void ScriptEditorDebugger::_scene_tree_rmb_selected(const Vector2 &p_position) {
  250. TreeItem *item = inspect_scene_tree->get_item_at_position(p_position);
  251. if (!item)
  252. return;
  253. item->select(0);
  254. item_menu->clear();
  255. item_menu->add_icon_item(get_icon("CreateNewSceneFrom", "EditorIcons"), TTR("Save Branch as Scene"), ITEM_MENU_SAVE_REMOTE_NODE);
  256. item_menu->add_icon_item(get_icon("CopyNodePath", "EditorIcons"), TTR("Copy Node Path"), ITEM_MENU_COPY_NODE_PATH);
  257. item_menu->set_global_position(get_global_mouse_position());
  258. item_menu->popup();
  259. }
  260. void ScriptEditorDebugger::_file_selected(const String &p_file) {
  261. switch (file_dialog_mode) {
  262. case SAVE_NODE: {
  263. Array msg;
  264. msg.push_back("save_node");
  265. msg.push_back(inspected_object_id);
  266. msg.push_back(p_file);
  267. ppeer->put_var(msg);
  268. } break;
  269. case SAVE_MONITORS_CSV: {
  270. Error err;
  271. FileAccessRef file = FileAccess::open(p_file, FileAccess::WRITE, &err);
  272. if (err != OK) {
  273. ERR_PRINTS("Failed to open " + p_file);
  274. return;
  275. }
  276. Vector<String> line;
  277. line.resize(Performance::MONITOR_MAX);
  278. // signatures
  279. for (int i = 0; i < Performance::MONITOR_MAX; i++) {
  280. line.write[i] = Performance::get_singleton()->get_monitor_name(Performance::Monitor(i));
  281. }
  282. file->store_csv_line(line);
  283. // values
  284. List<Vector<float> >::Element *E = perf_history.back();
  285. while (E) {
  286. Vector<float> &perf_data = E->get();
  287. for (int i = 0; i < perf_data.size(); i++) {
  288. line.write[i] = String::num_real(perf_data[i]);
  289. }
  290. file->store_csv_line(line);
  291. E = E->prev();
  292. }
  293. file->store_string("\n");
  294. Vector<Vector<String> > profiler_data = profiler->get_data_as_csv();
  295. for (int i = 0; i < profiler_data.size(); i++) {
  296. file->store_csv_line(profiler_data[i]);
  297. }
  298. } break;
  299. case SAVE_VRAM_CSV: {
  300. Error err;
  301. FileAccessRef file = FileAccess::open(p_file, FileAccess::WRITE, &err);
  302. if (err != OK) {
  303. ERR_PRINTS("Failed to open " + p_file);
  304. return;
  305. }
  306. Vector<String> headers;
  307. headers.resize(vmem_tree->get_columns());
  308. for (int i = 0; i < vmem_tree->get_columns(); ++i) {
  309. headers.write[i] = vmem_tree->get_column_title(i);
  310. }
  311. file->store_csv_line(headers);
  312. if (vmem_tree->get_root()) {
  313. TreeItem *ti = vmem_tree->get_root()->get_children();
  314. while (ti) {
  315. Vector<String> values;
  316. values.resize(vmem_tree->get_columns());
  317. for (int i = 0; i < vmem_tree->get_columns(); ++i) {
  318. values.write[i] = ti->get_text(i);
  319. }
  320. file->store_csv_line(values);
  321. ti = ti->get_next();
  322. }
  323. }
  324. } break;
  325. }
  326. }
  327. void ScriptEditorDebugger::_scene_tree_property_value_edited(const String &p_prop, const Variant &p_value) {
  328. Array msg;
  329. msg.push_back("set_object_property");
  330. msg.push_back(inspected_object_id);
  331. msg.push_back(p_prop);
  332. msg.push_back(p_value);
  333. ppeer->put_var(msg);
  334. inspect_edited_object_timeout = 0.7; //avoid annoyance, don't request soon after editing
  335. }
  336. void ScriptEditorDebugger::_scene_tree_property_select_object(ObjectID p_object) {
  337. inspected_object_id = p_object;
  338. Array msg;
  339. msg.push_back("inspect_object");
  340. msg.push_back(inspected_object_id);
  341. ppeer->put_var(msg);
  342. }
  343. void ScriptEditorDebugger::_scene_tree_request() {
  344. ERR_FAIL_COND(connection.is_null());
  345. ERR_FAIL_COND(!connection->is_connected_to_host());
  346. Array msg;
  347. msg.push_back("request_scene_tree");
  348. ppeer->put_var(msg);
  349. }
  350. /// Populates inspect_scene_tree recursively given data in nodes.
  351. /// Nodes is an array containing 4 elements for each node, it follows this pattern:
  352. /// nodes[i] == number of direct children of this node
  353. /// nodes[i + 1] == node name
  354. /// nodes[i + 2] == node class
  355. /// nodes[i + 3] == node instance id
  356. ///
  357. /// Returns the number of items parsed in nodes from current_index.
  358. ///
  359. /// Given a nodes array like [R,A,B,C,D,E] the following Tree will be generated, assuming
  360. /// filter is an empty String, R and A child count are 2, B is 1 and C, D and E are 0.
  361. ///
  362. /// R
  363. /// |-A
  364. /// | |-B
  365. /// | | |-C
  366. /// | |
  367. /// | |-D
  368. /// |
  369. /// |-E
  370. ///
  371. int ScriptEditorDebugger::_update_scene_tree(TreeItem *parent, const Array &nodes, int current_index) {
  372. String filter = EditorNode::get_singleton()->get_scene_tree_dock()->get_filter();
  373. String item_text = nodes[current_index + 1];
  374. String item_type = nodes[current_index + 2];
  375. bool keep = filter.is_subsequence_ofi(item_text);
  376. TreeItem *item = inspect_scene_tree->create_item(parent);
  377. item->set_text(0, item_text);
  378. item->set_tooltip(0, TTR("Type:") + " " + item_type);
  379. ObjectID id = ObjectID(nodes[current_index + 3]);
  380. Ref<Texture> icon = EditorNode::get_singleton()->get_class_icon(nodes[current_index + 2], "");
  381. if (icon.is_valid()) {
  382. item->set_icon(0, icon);
  383. }
  384. item->set_metadata(0, id);
  385. bool scroll = false;
  386. if (id == inspected_object_id) {
  387. TreeItem *cti = item->get_parent();
  388. while (cti) {
  389. cti->set_collapsed(false);
  390. cti = cti->get_parent();
  391. }
  392. item->select(0);
  393. scroll = filter != last_filter;
  394. }
  395. // Set current item as collapsed if necessary
  396. if (parent) {
  397. if (!unfold_cache.has(id)) {
  398. item->set_collapsed(true);
  399. }
  400. }
  401. int children_count = nodes[current_index];
  402. // Tracks the total number of items parsed in nodes, this is used to skips nodes that
  403. // are not direct children of the current node since we can't know in advance the total
  404. // number of children, direct and not, of a node without traversing the nodes array previously.
  405. // Keeping track of this allows us to build our remote scene tree by traversing the node
  406. // array just once.
  407. int items_count = 1;
  408. for (int i = 0; i < children_count; i++) {
  409. // Called for each direct child of item.
  410. // Direct children of current item might not be adjacent so items_count must
  411. // be incremented by the number of items parsed until now, otherwise we would not
  412. // be able to access the next child of the current item.
  413. // items_count is multiplied by 4 since that's the number of elements in the nodes
  414. // array needed to represent a single node.
  415. items_count += _update_scene_tree(item, nodes, current_index + items_count * 4);
  416. }
  417. // If item has not children and should not be kept delete it
  418. if (!keep && !item->get_children() && parent) {
  419. parent->remove_child(item);
  420. memdelete(item);
  421. } else if (scroll) {
  422. inspect_scene_tree->call_deferred("scroll_to_item", item);
  423. }
  424. if (!parent) {
  425. last_filter = filter;
  426. }
  427. return items_count;
  428. }
  429. void ScriptEditorDebugger::_video_mem_request() {
  430. if (connection.is_null() || !connection->is_connected_to_host()) {
  431. // Video RAM usage is only available while a project is being debugged.
  432. return;
  433. }
  434. Array msg;
  435. msg.push_back("request_video_mem");
  436. ppeer->put_var(msg);
  437. }
  438. void ScriptEditorDebugger::_video_mem_export() {
  439. file_dialog->set_mode(EditorFileDialog::MODE_SAVE_FILE);
  440. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  441. file_dialog->clear_filters();
  442. file_dialog_mode = SAVE_VRAM_CSV;
  443. file_dialog->popup_centered_ratio();
  444. }
  445. Size2 ScriptEditorDebugger::get_minimum_size() const {
  446. Size2 ms = MarginContainer::get_minimum_size();
  447. ms.y = MAX(ms.y, 250 * EDSCALE);
  448. return ms;
  449. }
  450. void ScriptEditorDebugger::_parse_message(const String &p_msg, const Array &p_data) {
  451. if (p_msg == "debug_enter") {
  452. Array msg;
  453. msg.push_back("get_stack_dump");
  454. ppeer->put_var(msg);
  455. ERR_FAIL_COND(p_data.size() != 2);
  456. bool can_continue = p_data[0];
  457. String error = p_data[1];
  458. step->set_disabled(!can_continue);
  459. next->set_disabled(!can_continue);
  460. _set_reason_text(error, MESSAGE_ERROR);
  461. copy->set_disabled(false);
  462. breaked = true;
  463. dobreak->set_disabled(true);
  464. docontinue->set_disabled(false);
  465. emit_signal("breaked", true, can_continue);
  466. OS::get_singleton()->move_window_to_foreground();
  467. if (error != "") {
  468. tabs->set_current_tab(0);
  469. }
  470. profiler->set_enabled(false);
  471. EditorNode::get_singleton()->get_pause_button()->set_pressed(true);
  472. EditorNode::get_singleton()->make_bottom_panel_item_visible(this);
  473. _clear_remote_objects();
  474. } else if (p_msg == "debug_exit") {
  475. breaked = false;
  476. _clear_execution();
  477. copy->set_disabled(true);
  478. step->set_disabled(true);
  479. next->set_disabled(true);
  480. reason->set_text("");
  481. reason->set_tooltip("");
  482. back->set_disabled(true);
  483. forward->set_disabled(true);
  484. dobreak->set_disabled(false);
  485. docontinue->set_disabled(true);
  486. emit_signal("breaked", false, false, Variant());
  487. profiler->set_enabled(true);
  488. profiler->disable_seeking();
  489. EditorNode::get_singleton()->get_pause_button()->set_pressed(false);
  490. } else if (p_msg == "message:click_ctrl") {
  491. clicked_ctrl->set_text(p_data[0]);
  492. clicked_ctrl_type->set_text(p_data[1]);
  493. } else if (p_msg == "message:scene_tree") {
  494. inspect_scene_tree->clear();
  495. Map<int, TreeItem *> lv;
  496. updating_scene_tree = true;
  497. _update_scene_tree(NULL, p_data, 0);
  498. updating_scene_tree = false;
  499. le_clear->set_disabled(false);
  500. le_set->set_disabled(false);
  501. } else if (p_msg == "message:inspect_object") {
  502. ScriptEditorDebuggerInspectedObject *debugObj = NULL;
  503. ObjectID id = p_data[0];
  504. String type = p_data[1];
  505. Array properties = p_data[2];
  506. if (remote_objects.has(id)) {
  507. debugObj = remote_objects[id];
  508. } else {
  509. debugObj = memnew(ScriptEditorDebuggerInspectedObject);
  510. debugObj->remote_object_id = id;
  511. debugObj->type_name = type;
  512. remote_objects[id] = debugObj;
  513. debugObj->connect("value_edited", this, "_scene_tree_property_value_edited");
  514. }
  515. int old_prop_size = debugObj->prop_list.size();
  516. debugObj->prop_list.clear();
  517. int new_props_added = 0;
  518. Set<String> changed;
  519. for (int i = 0; i < properties.size(); i++) {
  520. Array prop = properties[i];
  521. if (prop.size() != 6)
  522. continue;
  523. PropertyInfo pinfo;
  524. pinfo.name = prop[0];
  525. pinfo.type = Variant::Type(int(prop[1]));
  526. pinfo.hint = PropertyHint(int(prop[2]));
  527. pinfo.hint_string = prop[3];
  528. pinfo.usage = PropertyUsageFlags(int(prop[4]));
  529. Variant var = prop[5];
  530. if (pinfo.type == Variant::OBJECT) {
  531. if (var.is_zero()) {
  532. var = RES();
  533. } else if (var.get_type() == Variant::STRING) {
  534. String path = var;
  535. if (path.find("::") != -1) {
  536. // built-in resource
  537. String base_path = path.get_slice("::", 0);
  538. RES dependency = ResourceLoader::load(base_path);
  539. if (dependency.is_valid()) {
  540. remote_dependencies.insert(dependency);
  541. }
  542. }
  543. var = ResourceLoader::load(path);
  544. if (pinfo.hint_string == "Script") {
  545. if (debugObj->get_script() != var) {
  546. debugObj->set_script(RefPtr());
  547. Ref<Script> script(var);
  548. if (!script.is_null()) {
  549. ScriptInstance *script_instance = script->placeholder_instance_create(debugObj);
  550. debugObj->set_script_and_instance(var, script_instance);
  551. }
  552. }
  553. }
  554. } else if (var.get_type() == Variant::OBJECT) {
  555. if (((Object *)var)->is_class("EncodedObjectAsID")) {
  556. var = Object::cast_to<EncodedObjectAsID>(var)->get_object_id();
  557. pinfo.type = var.get_type();
  558. pinfo.hint = PROPERTY_HINT_OBJECT_ID;
  559. pinfo.hint_string = "Object";
  560. }
  561. }
  562. }
  563. //always add the property, since props may have been added or removed
  564. debugObj->prop_list.push_back(pinfo);
  565. if (!debugObj->prop_values.has(pinfo.name)) {
  566. new_props_added++;
  567. debugObj->prop_values[pinfo.name] = var;
  568. } else {
  569. if (bool(Variant::evaluate(Variant::OP_NOT_EQUAL, debugObj->prop_values[pinfo.name], var))) {
  570. debugObj->prop_values[pinfo.name] = var;
  571. changed.insert(pinfo.name);
  572. }
  573. }
  574. }
  575. if (editor->get_editor_history()->get_current() != debugObj->get_instance_id()) {
  576. editor->push_item(debugObj, "");
  577. } else {
  578. if (old_prop_size == debugObj->prop_list.size() && new_props_added == 0) {
  579. //only some may have changed, if so, then update those, if exist
  580. for (Set<String>::Element *E = changed.front(); E; E = E->next()) {
  581. EditorNode::get_singleton()->get_inspector()->update_property(E->get());
  582. }
  583. } else {
  584. //full update, because props were added or removed
  585. debugObj->update();
  586. }
  587. }
  588. } else if (p_msg == "message:video_mem") {
  589. vmem_tree->clear();
  590. TreeItem *root = vmem_tree->create_item();
  591. uint64_t total = 0;
  592. for (int i = 0; i < p_data.size(); i += 4) {
  593. TreeItem *it = vmem_tree->create_item(root);
  594. String type = p_data[i + 1];
  595. int bytes = p_data[i + 3].operator int();
  596. it->set_text(0, p_data[i + 0]); //path
  597. it->set_text(1, type); //type
  598. it->set_text(2, p_data[i + 2]); //type
  599. it->set_text(3, String::humanize_size(bytes)); //type
  600. total += bytes;
  601. if (has_icon(type, "EditorIcons"))
  602. it->set_icon(0, get_icon(type, "EditorIcons"));
  603. }
  604. vmem_total->set_tooltip(TTR("Bytes:") + " " + itos(total));
  605. vmem_total->set_text(String::humanize_size(total));
  606. } else if (p_msg == "stack_dump") {
  607. stack_dump->clear();
  608. TreeItem *r = stack_dump->create_item();
  609. for (int i = 0; i < p_data.size(); i++) {
  610. Dictionary d = p_data[i];
  611. ERR_CONTINUE(!d.has("function"));
  612. ERR_CONTINUE(!d.has("file"));
  613. ERR_CONTINUE(!d.has("line"));
  614. ERR_CONTINUE(!d.has("id"));
  615. TreeItem *s = stack_dump->create_item(r);
  616. d["frame"] = i;
  617. s->set_metadata(0, d);
  618. String line = itos(i) + " - " + String(d["file"]) + ":" + itos(d["line"]) + " - at function: " + d["function"];
  619. s->set_text(0, line);
  620. if (i == 0)
  621. s->select(0);
  622. }
  623. } else if (p_msg == "stack_frame_vars") {
  624. variables->clear();
  625. int ofs = 0;
  626. int mcount = p_data[ofs];
  627. ofs++;
  628. for (int i = 0; i < mcount; i++) {
  629. String n = p_data[ofs + i * 2 + 0];
  630. Variant v = p_data[ofs + i * 2 + 1];
  631. PropertyHint h = PROPERTY_HINT_NONE;
  632. String hs = String();
  633. if (v.get_type() == Variant::OBJECT) {
  634. v = Object::cast_to<EncodedObjectAsID>(v)->get_object_id();
  635. h = PROPERTY_HINT_OBJECT_ID;
  636. hs = "Object";
  637. }
  638. variables->add_property("Locals/" + n, v, h, hs);
  639. }
  640. ofs += mcount * 2;
  641. mcount = p_data[ofs];
  642. ofs++;
  643. for (int i = 0; i < mcount; i++) {
  644. String n = p_data[ofs + i * 2 + 0];
  645. Variant v = p_data[ofs + i * 2 + 1];
  646. PropertyHint h = PROPERTY_HINT_NONE;
  647. String hs = String();
  648. if (v.get_type() == Variant::OBJECT) {
  649. v = Object::cast_to<EncodedObjectAsID>(v)->get_object_id();
  650. h = PROPERTY_HINT_OBJECT_ID;
  651. hs = "Object";
  652. }
  653. variables->add_property("Members/" + n, v, h, hs);
  654. if (n == "self") {
  655. _scene_tree_property_select_object(v);
  656. }
  657. }
  658. ofs += mcount * 2;
  659. mcount = p_data[ofs];
  660. ofs++;
  661. for (int i = 0; i < mcount; i++) {
  662. String n = p_data[ofs + i * 2 + 0];
  663. Variant v = p_data[ofs + i * 2 + 1];
  664. PropertyHint h = PROPERTY_HINT_NONE;
  665. String hs = String();
  666. if (v.get_type() == Variant::OBJECT) {
  667. v = Object::cast_to<EncodedObjectAsID>(v)->get_object_id();
  668. h = PROPERTY_HINT_OBJECT_ID;
  669. hs = "Object";
  670. }
  671. variables->add_property("Globals/" + n, v, h, hs);
  672. }
  673. variables->update();
  674. inspector->edit(variables);
  675. } else if (p_msg == "output") {
  676. //OUT
  677. for (int i = 0; i < p_data.size(); i++) {
  678. Array output = p_data[i];
  679. ERR_FAIL_COND_MSG(output.size() < 2, "Malformed output message from script debugger.");
  680. String str = output[0];
  681. ScriptDebuggerRemote::MessageType type = (ScriptDebuggerRemote::MessageType)(int)(output[1]);
  682. EditorLog::MessageType msg_type;
  683. switch (type) {
  684. case ScriptDebuggerRemote::MESSAGE_TYPE_LOG: {
  685. msg_type = EditorLog::MSG_TYPE_STD;
  686. } break;
  687. case ScriptDebuggerRemote::MESSAGE_TYPE_ERROR: {
  688. msg_type = EditorLog::MSG_TYPE_ERROR;
  689. } break;
  690. default: {
  691. WARN_PRINTS("Unhandled script debugger message type: " + itos(type));
  692. msg_type = EditorLog::MSG_TYPE_STD;
  693. } break;
  694. }
  695. //LOG
  696. if (!EditorNode::get_log()->is_visible()) {
  697. if (EditorNode::get_singleton()->are_bottom_panels_hidden()) {
  698. if (EDITOR_GET("run/output/always_open_output_on_play")) {
  699. EditorNode::get_singleton()->make_bottom_panel_item_visible(EditorNode::get_log());
  700. }
  701. }
  702. }
  703. EditorNode::get_log()->add_message(str, msg_type);
  704. }
  705. } else if (p_msg == "performance") {
  706. Array arr = p_data[0];
  707. Vector<float> p;
  708. p.resize(arr.size());
  709. for (int i = 0; i < arr.size(); i++) {
  710. p.write[i] = arr[i];
  711. if (i < perf_items.size()) {
  712. const float value = p[i];
  713. String label = rtos(value);
  714. String tooltip = label;
  715. switch (Performance::MonitorType((int)perf_items[i]->get_metadata(1))) {
  716. case Performance::MONITOR_TYPE_MEMORY: {
  717. label = String::humanize_size(value);
  718. tooltip = label;
  719. } break;
  720. case Performance::MONITOR_TYPE_TIME: {
  721. label = rtos(value * 1000).pad_decimals(2) + " ms";
  722. tooltip = label;
  723. } break;
  724. default: {
  725. tooltip += " " + perf_items[i]->get_text(0);
  726. } break;
  727. }
  728. perf_items[i]->set_text(1, label);
  729. perf_items[i]->set_tooltip(1, tooltip);
  730. if (p[i] > perf_max[i])
  731. perf_max.write[i] = p[i];
  732. }
  733. }
  734. perf_history.push_front(p);
  735. perf_draw->update();
  736. } else if (p_msg == "error") {
  737. // Should have at least two elements, error array and stack items count.
  738. ERR_FAIL_COND_MSG(p_data.size() < 2, "Malformed error message from script debugger.");
  739. // Error or warning data.
  740. Array err = p_data[0];
  741. ERR_FAIL_COND_MSG(err.size() < 10, "Malformed error message from script debugger.");
  742. // Format time.
  743. Array time_vals;
  744. time_vals.push_back(err[0]);
  745. time_vals.push_back(err[1]);
  746. time_vals.push_back(err[2]);
  747. time_vals.push_back(err[3]);
  748. bool e;
  749. String time = String("%d:%02d:%02d.%03d").sprintf(time_vals, &e);
  750. // Rest of the error data.
  751. String method = err[4];
  752. String source_file = err[5];
  753. String source_line = err[6];
  754. String error_cond = err[7];
  755. String error_msg = err[8];
  756. bool is_warning = err[9];
  757. bool has_method = !method.empty();
  758. bool has_error_msg = !error_msg.empty();
  759. bool source_is_project_file = source_file.begins_with("res://");
  760. // Metadata to highlight error line in scripts.
  761. Array source_meta;
  762. source_meta.push_back(source_file);
  763. source_meta.push_back(source_line);
  764. // Create error tree to display above error or warning details.
  765. TreeItem *r = error_tree->get_root();
  766. if (!r) {
  767. r = error_tree->create_item();
  768. }
  769. // Also provide the relevant details as tooltip to quickly check without
  770. // uncollapsing the tree.
  771. String tooltip = is_warning ? TTR("Warning:") : TTR("Error:");
  772. TreeItem *error = error_tree->create_item(r);
  773. error->set_collapsed(true);
  774. error->set_icon(0, get_icon(is_warning ? "Warning" : "Error", "EditorIcons"));
  775. error->set_text(0, time);
  776. error->set_text_align(0, TreeItem::ALIGN_LEFT);
  777. String error_title;
  778. // Include method name, when given, in error title.
  779. if (has_method)
  780. error_title += method + ": ";
  781. // If we have a (custom) error message, use it as title, and add a C++ Error
  782. // item with the original error condition.
  783. error_title += error_msg.empty() ? error_cond : error_msg;
  784. error->set_text(1, error_title);
  785. tooltip += " " + error_title + "\n";
  786. if (has_error_msg) {
  787. // Add item for C++ error condition.
  788. TreeItem *cpp_cond = error_tree->create_item(error);
  789. cpp_cond->set_text(0, "<" + TTR("C++ Error") + ">");
  790. cpp_cond->set_text(1, error_cond);
  791. cpp_cond->set_text_align(0, TreeItem::ALIGN_LEFT);
  792. tooltip += TTR("C++ Error:") + " " + error_cond + "\n";
  793. if (source_is_project_file)
  794. cpp_cond->set_metadata(0, source_meta);
  795. }
  796. // Source of the error.
  797. String source_txt = (source_is_project_file ? source_file.get_file() : source_file) + ":" + source_line;
  798. if (has_method)
  799. source_txt += " @ " + method + "()";
  800. TreeItem *cpp_source = error_tree->create_item(error);
  801. cpp_source->set_text(0, "<" + (source_is_project_file ? TTR("Source") : TTR("C++ Source")) + ">");
  802. cpp_source->set_text(1, source_txt);
  803. cpp_source->set_text_align(0, TreeItem::ALIGN_LEFT);
  804. tooltip += (source_is_project_file ? TTR("Source:") : TTR("C++ Source:")) + " " + source_txt + "\n";
  805. // Set metadata to highlight error line in scripts.
  806. if (source_is_project_file) {
  807. error->set_metadata(0, source_meta);
  808. cpp_source->set_metadata(0, source_meta);
  809. }
  810. error->set_tooltip(0, tooltip);
  811. error->set_tooltip(1, tooltip);
  812. // Format stack trace.
  813. // stack_items_count is the number of elements to parse, with 3 items per frame
  814. // of the stack trace (script, method, line).
  815. int stack_items_count = p_data[1];
  816. for (int i = 0; i < stack_items_count; i += 3) {
  817. String script = p_data[2 + i];
  818. String method2 = p_data[3 + i];
  819. int line = p_data[4 + i];
  820. TreeItem *stack_trace = error_tree->create_item(error);
  821. Array meta;
  822. meta.push_back(script);
  823. meta.push_back(line);
  824. stack_trace->set_metadata(0, meta);
  825. if (i == 0) {
  826. stack_trace->set_text(0, "<" + TTR("Stack Trace") + ">");
  827. stack_trace->set_text_align(0, TreeItem::ALIGN_LEFT);
  828. error->set_metadata(0, meta);
  829. }
  830. stack_trace->set_text(1, script.get_file() + ":" + itos(line) + " @ " + method2 + "()");
  831. }
  832. if (is_warning)
  833. warning_count++;
  834. else
  835. error_count++;
  836. } else if (p_msg == "profile_sig") {
  837. //cache a signature
  838. profiler_signature[p_data[1]] = p_data[0];
  839. } else if (p_msg == "profile_frame" || p_msg == "profile_total") {
  840. EditorProfiler::Metric metric;
  841. metric.valid = true;
  842. metric.frame_number = p_data[0];
  843. metric.frame_time = p_data[1];
  844. metric.idle_time = p_data[2];
  845. metric.physics_time = p_data[3];
  846. metric.physics_frame_time = p_data[4];
  847. int frame_data_amount = p_data[6];
  848. int frame_function_amount = p_data[7];
  849. if (frame_data_amount) {
  850. EditorProfiler::Metric::Category frame_time;
  851. frame_time.signature = "category_frame_time";
  852. frame_time.name = "Frame Time";
  853. frame_time.total_time = metric.frame_time;
  854. EditorProfiler::Metric::Category::Item item;
  855. item.calls = 1;
  856. item.line = 0;
  857. item.name = "Physics Time";
  858. item.total = metric.physics_time;
  859. item.self = item.total;
  860. item.signature = "physics_time";
  861. frame_time.items.push_back(item);
  862. item.name = "Idle Time";
  863. item.total = metric.idle_time;
  864. item.self = item.total;
  865. item.signature = "idle_time";
  866. frame_time.items.push_back(item);
  867. item.name = "Physics Frame Time";
  868. item.total = metric.physics_frame_time;
  869. item.self = item.total;
  870. item.signature = "physics_frame_time";
  871. frame_time.items.push_back(item);
  872. metric.categories.push_back(frame_time);
  873. }
  874. int idx = 8;
  875. for (int i = 0; i < frame_data_amount; i++) {
  876. EditorProfiler::Metric::Category c;
  877. String name = p_data[idx++];
  878. Array values = p_data[idx++];
  879. c.name = name.capitalize();
  880. c.items.resize(values.size() / 2);
  881. c.total_time = 0;
  882. c.signature = "categ::" + name;
  883. for (int j = 0; j < values.size(); j += 2) {
  884. EditorProfiler::Metric::Category::Item item;
  885. item.calls = 1;
  886. item.line = 0;
  887. item.name = values[j];
  888. item.self = values[j + 1];
  889. item.total = item.self;
  890. item.signature = "categ::" + name + "::" + item.name;
  891. item.name = item.name.capitalize();
  892. c.total_time += item.total;
  893. c.items.write[j / 2] = item;
  894. }
  895. metric.categories.push_back(c);
  896. }
  897. EditorProfiler::Metric::Category funcs;
  898. funcs.total_time = p_data[5]; //script time
  899. funcs.items.resize(frame_function_amount);
  900. funcs.name = "Script Functions";
  901. funcs.signature = "script_functions";
  902. for (int i = 0; i < frame_function_amount; i++) {
  903. int signature = p_data[idx++];
  904. int calls = p_data[idx++];
  905. float total = p_data[idx++];
  906. float self = p_data[idx++];
  907. EditorProfiler::Metric::Category::Item item;
  908. if (profiler_signature.has(signature)) {
  909. item.signature = profiler_signature[signature];
  910. String name = profiler_signature[signature];
  911. Vector<String> strings = name.split("::");
  912. if (strings.size() == 3) {
  913. item.name = strings[2];
  914. item.script = strings[0];
  915. item.line = strings[1].to_int();
  916. } else if (strings.size() == 4) { //Built-in scripts have an :: in their name
  917. item.name = strings[3];
  918. item.script = strings[0] + "::" + strings[1];
  919. item.line = strings[2].to_int();
  920. }
  921. } else {
  922. item.name = "SigErr " + itos(signature);
  923. }
  924. item.calls = calls;
  925. item.self = self;
  926. item.total = total;
  927. funcs.items.write[i] = item;
  928. }
  929. metric.categories.push_back(funcs);
  930. if (p_msg == "profile_frame")
  931. profiler->add_frame_metric(metric, false);
  932. else
  933. profiler->add_frame_metric(metric, true);
  934. } else if (p_msg == "network_profile") {
  935. int frame_size = 6;
  936. for (int i = 0; i < p_data.size(); i += frame_size) {
  937. MultiplayerAPI::ProfilingInfo pi;
  938. pi.node = p_data[i + 0];
  939. pi.node_path = p_data[i + 1];
  940. pi.incoming_rpc = p_data[i + 2];
  941. pi.incoming_rset = p_data[i + 3];
  942. pi.outgoing_rpc = p_data[i + 4];
  943. pi.outgoing_rset = p_data[i + 5];
  944. network_profiler->add_node_frame_data(pi);
  945. }
  946. } else if (p_msg == "network_bandwidth") {
  947. network_profiler->set_bandwidth(p_data[0], p_data[1]);
  948. } else if (p_msg == "kill_me") {
  949. editor->call_deferred("stop_child_process");
  950. }
  951. }
  952. void ScriptEditorDebugger::_set_reason_text(const String &p_reason, MessageType p_type) {
  953. switch (p_type) {
  954. case MESSAGE_ERROR:
  955. reason->add_color_override("font_color", get_color("error_color", "Editor"));
  956. break;
  957. case MESSAGE_WARNING:
  958. reason->add_color_override("font_color", get_color("warning_color", "Editor"));
  959. break;
  960. default:
  961. reason->add_color_override("font_color", get_color("success_color", "Editor"));
  962. }
  963. reason->set_text(p_reason);
  964. reason->set_tooltip(p_reason.word_wrap(80));
  965. }
  966. void ScriptEditorDebugger::_performance_select() {
  967. perf_draw->update();
  968. }
  969. void ScriptEditorDebugger::_performance_draw() {
  970. Vector<int> which;
  971. for (int i = 0; i < perf_items.size(); i++) {
  972. if (perf_items[i]->is_checked(0))
  973. which.push_back(i);
  974. }
  975. if (which.empty()) {
  976. info_message->show();
  977. return;
  978. }
  979. info_message->hide();
  980. const Ref<StyleBox> graph_sb = get_stylebox("normal", "TextEdit");
  981. const Ref<Font> graph_font = get_font("font", "TextEdit");
  982. const int cols = Math::ceil(Math::sqrt((float)which.size()));
  983. int rows = Math::ceil((float)which.size() / cols);
  984. if (which.size() == 1) {
  985. rows = 1;
  986. }
  987. const int margin = 3;
  988. const int point_sep = 5;
  989. const Size2i s = Size2i(perf_draw->get_size()) / Size2i(cols, rows);
  990. for (int i = 0; i < which.size(); i++) {
  991. Point2i p(i % cols, i / cols);
  992. Rect2i r(p * s, s);
  993. r.position += Point2(margin, margin);
  994. r.size -= Point2(margin, margin) * 2.0;
  995. perf_draw->draw_style_box(graph_sb, r);
  996. r.position += graph_sb->get_offset();
  997. r.size -= graph_sb->get_minimum_size();
  998. const int pi = which[i];
  999. // Draw horizontal lines with labels.
  1000. int nb_lines = 5;
  1001. // Draw less lines if the monitor isn't tall enough to display 5 labels.
  1002. if (r.size.height <= 160 * EDSCALE) {
  1003. nb_lines = 3;
  1004. } else if (r.size.height <= 240 * EDSCALE) {
  1005. nb_lines = 4;
  1006. }
  1007. const float inv_nb_lines = 1.0 / nb_lines;
  1008. for (int line = 0; line < nb_lines; line += 1) {
  1009. const int from_x = r.position.x;
  1010. const int to_x = r.position.x + r.size.width;
  1011. const int y = r.position.y + (r.size.height * inv_nb_lines + line * inv_nb_lines * r.size.height);
  1012. perf_draw->draw_line(
  1013. Point2(from_x, y),
  1014. Point2i(to_x, y),
  1015. Color(0.5, 0.5, 0.5, 0.25),
  1016. Math::round(EDSCALE));
  1017. String label;
  1018. switch (Performance::MonitorType((int)perf_items[pi]->get_metadata(1))) {
  1019. case Performance::MONITOR_TYPE_MEMORY: {
  1020. label = String::humanize_size(Math::ceil((1 - inv_nb_lines - inv_nb_lines * line) * perf_max[pi]));
  1021. } break;
  1022. case Performance::MONITOR_TYPE_TIME: {
  1023. label = rtos((1 - inv_nb_lines - inv_nb_lines * line) * perf_max[pi] * 1000).pad_decimals(2) + " ms";
  1024. } break;
  1025. default: {
  1026. label = itos(Math::ceil((1 - inv_nb_lines - inv_nb_lines * line) * perf_max[pi]));
  1027. } break;
  1028. }
  1029. perf_draw->draw_string(
  1030. graph_font,
  1031. Point2(from_x, y - graph_font->get_ascent() * 0.25),
  1032. label,
  1033. Color(0.5, 0.5, 0.5, 1.0));
  1034. }
  1035. const float h = (float)which[i] / (float)(perf_items.size());
  1036. // Use a darker color on light backgrounds for better visibility.
  1037. const float value_multiplier = EditorSettings::get_singleton()->is_dark_theme() ? 1.4 : 0.55;
  1038. Color color = get_color("accent_color", "Editor");
  1039. color.set_hsv(Math::fmod(h + 0.4, 0.9), color.get_s() * 0.9, color.get_v() * value_multiplier);
  1040. // Draw the monitor name in the top-left corner.
  1041. color.a = 0.6;
  1042. perf_draw->draw_string(
  1043. graph_font,
  1044. r.position + Point2(0, graph_font->get_ascent()),
  1045. perf_items[pi]->get_text(0),
  1046. color,
  1047. r.size.x);
  1048. // Draw the monitor value in the top-left corner, just below the name.
  1049. color.a = 0.9;
  1050. perf_draw->draw_string(
  1051. graph_font,
  1052. r.position + Point2(0, graph_font->get_ascent() + graph_font->get_height()),
  1053. perf_items[pi]->get_text(1),
  1054. color,
  1055. r.size.y);
  1056. const float spacing = point_sep / float(cols);
  1057. float from = r.size.width;
  1058. const List<Vector<float> >::Element *E = perf_history.front();
  1059. float prev = -1;
  1060. while (from >= 0 && E) {
  1061. float m = perf_max[pi];
  1062. if (m == 0) {
  1063. m = 0.00001;
  1064. }
  1065. float h2 = E->get()[pi] / m;
  1066. h2 = (1.0 - h2) * r.size.y;
  1067. if (E != perf_history.front()) {
  1068. perf_draw->draw_line(
  1069. r.position + Point2(from, h2),
  1070. r.position + Point2(from + spacing, prev),
  1071. color,
  1072. Math::round(EDSCALE));
  1073. }
  1074. prev = h2;
  1075. E = E->next();
  1076. from -= spacing;
  1077. }
  1078. }
  1079. }
  1080. void ScriptEditorDebugger::_notification(int p_what) {
  1081. switch (p_what) {
  1082. case NOTIFICATION_ENTER_TREE: {
  1083. inspector->edit(variables);
  1084. skip_breakpoints->set_icon(get_icon("DebugSkipBreakpointsOff", "EditorIcons"));
  1085. copy->set_icon(get_icon("ActionCopy", "EditorIcons"));
  1086. step->set_icon(get_icon("DebugStep", "EditorIcons"));
  1087. next->set_icon(get_icon("DebugNext", "EditorIcons"));
  1088. back->set_icon(get_icon("Back", "EditorIcons"));
  1089. forward->set_icon(get_icon("Forward", "EditorIcons"));
  1090. dobreak->set_icon(get_icon("Pause", "EditorIcons"));
  1091. docontinue->set_icon(get_icon("DebugContinue", "EditorIcons"));
  1092. le_set->connect("pressed", this, "_live_edit_set");
  1093. le_clear->connect("pressed", this, "_live_edit_clear");
  1094. error_tree->connect("item_selected", this, "_error_selected");
  1095. error_tree->connect("item_activated", this, "_error_activated");
  1096. vmem_refresh->set_icon(get_icon("Reload", "EditorIcons"));
  1097. vmem_export->set_icon(get_icon("Save", "EditorIcons"));
  1098. reason->add_color_override("font_color", get_color("error_color", "Editor"));
  1099. } break;
  1100. case NOTIFICATION_PROCESS: {
  1101. if (connection.is_valid()) {
  1102. inspect_scene_tree_timeout -= get_process_delta_time();
  1103. if (inspect_scene_tree_timeout < 0) {
  1104. inspect_scene_tree_timeout = EditorSettings::get_singleton()->get("debugger/remote_scene_tree_refresh_interval");
  1105. if (inspect_scene_tree->is_visible_in_tree()) {
  1106. _scene_tree_request();
  1107. }
  1108. }
  1109. inspect_edited_object_timeout -= get_process_delta_time();
  1110. if (inspect_edited_object_timeout < 0) {
  1111. inspect_edited_object_timeout = EditorSettings::get_singleton()->get("debugger/remote_inspect_refresh_interval");
  1112. if (inspected_object_id) {
  1113. if (ScriptEditorDebuggerInspectedObject *obj = Object::cast_to<ScriptEditorDebuggerInspectedObject>(ObjectDB::get_instance(editor->get_editor_history()->get_current()))) {
  1114. if (obj->remote_object_id == inspected_object_id) {
  1115. //take the chance and re-inspect selected object
  1116. Array msg;
  1117. msg.push_back("inspect_object");
  1118. msg.push_back(inspected_object_id);
  1119. ppeer->put_var(msg);
  1120. }
  1121. }
  1122. }
  1123. }
  1124. if (camera_override == OVERRIDE_2D) {
  1125. CanvasItemEditor *editor = CanvasItemEditor::get_singleton();
  1126. Dictionary state = editor->get_state();
  1127. float zoom = state["zoom"];
  1128. Point2 offset = state["ofs"];
  1129. Transform2D transform;
  1130. transform.scale_basis(Size2(zoom, zoom));
  1131. transform.elements[2] = -offset * zoom;
  1132. Array msg;
  1133. msg.push_back("override_camera_2D:transform");
  1134. msg.push_back(transform);
  1135. ppeer->put_var(msg);
  1136. } else if (camera_override >= OVERRIDE_3D_1) {
  1137. int viewport_idx = camera_override - OVERRIDE_3D_1;
  1138. SpatialEditorViewport *viewport = SpatialEditor::get_singleton()->get_editor_viewport(viewport_idx);
  1139. Camera *const cam = viewport->get_camera();
  1140. Array msg;
  1141. msg.push_back("override_camera_3D:transform");
  1142. msg.push_back(cam->get_camera_transform());
  1143. if (cam->get_projection() == Camera::PROJECTION_ORTHOGONAL) {
  1144. msg.push_back(false);
  1145. msg.push_back(cam->get_size());
  1146. } else {
  1147. msg.push_back(true);
  1148. msg.push_back(cam->get_fov());
  1149. }
  1150. msg.push_back(cam->get_znear());
  1151. msg.push_back(cam->get_zfar());
  1152. ppeer->put_var(msg);
  1153. }
  1154. }
  1155. if (error_count != last_error_count || warning_count != last_warning_count) {
  1156. if (error_count == 0 && warning_count == 0) {
  1157. errors_tab->set_name(TTR("Errors"));
  1158. debugger_button->set_text(TTR("Debugger"));
  1159. debugger_button->set_icon(Ref<Texture>());
  1160. tabs->set_tab_icon(errors_tab->get_index(), Ref<Texture>());
  1161. } else {
  1162. errors_tab->set_name(TTR("Errors") + " (" + itos(error_count + warning_count) + ")");
  1163. debugger_button->set_text(TTR("Debugger") + " (" + itos(error_count + warning_count) + ")");
  1164. if (error_count >= 1 && warning_count >= 1) {
  1165. debugger_button->set_icon(get_icon("ErrorWarning", "EditorIcons"));
  1166. tabs->set_tab_icon(errors_tab->get_index(), get_icon("ErrorWarning", "EditorIcons"));
  1167. } else if (error_count >= 1) {
  1168. debugger_button->set_icon(get_icon("Error", "EditorIcons"));
  1169. tabs->set_tab_icon(errors_tab->get_index(), get_icon("Error", "EditorIcons"));
  1170. } else {
  1171. debugger_button->set_icon(get_icon("Warning", "EditorIcons"));
  1172. tabs->set_tab_icon(errors_tab->get_index(), get_icon("Warning", "EditorIcons"));
  1173. }
  1174. }
  1175. last_error_count = error_count;
  1176. last_warning_count = warning_count;
  1177. }
  1178. if (server->is_connection_available()) {
  1179. if (connection.is_valid()) {
  1180. // We already have a valid connection. Disconnecting any new connecting client to prevent it from hanging.
  1181. // (If we don't keep a reference to the connection it will be destroyed and disconnect_from_host will be called internally)
  1182. server->take_connection();
  1183. } else {
  1184. // We just got the first connection.
  1185. connection = server->take_connection();
  1186. if (connection.is_null())
  1187. break;
  1188. EditorNode::get_log()->add_message("--- Debugging process started ---", EditorLog::MSG_TYPE_EDITOR);
  1189. ppeer->set_stream_peer(connection);
  1190. //EditorNode::get_singleton()->make_bottom_panel_item_visible(this);
  1191. //emit_signal("show_debugger",true);
  1192. dobreak->set_disabled(false);
  1193. tabs->set_current_tab(0);
  1194. _set_reason_text(TTR("Child process connected."), MESSAGE_SUCCESS);
  1195. profiler->clear();
  1196. inspect_scene_tree->clear();
  1197. le_set->set_disabled(true);
  1198. le_clear->set_disabled(false);
  1199. vmem_refresh->set_disabled(false);
  1200. error_tree->clear();
  1201. error_count = 0;
  1202. warning_count = 0;
  1203. profiler_signature.clear();
  1204. //live_edit_root->set_text("/root");
  1205. EditorNode::get_singleton()->get_pause_button()->set_pressed(false);
  1206. EditorNode::get_singleton()->get_pause_button()->set_disabled(false);
  1207. update_live_edit_root();
  1208. if (profiler->is_profiling()) {
  1209. _profiler_activate(true);
  1210. }
  1211. if (network_profiler->is_profiling()) {
  1212. _network_profiler_activate(true);
  1213. }
  1214. }
  1215. }
  1216. if (connection.is_null())
  1217. break;
  1218. if (!connection->is_connected_to_host()) {
  1219. stop();
  1220. editor->notify_child_process_exited(); //somehow, exited
  1221. break;
  1222. };
  1223. if (ppeer->get_available_packet_count() <= 0) {
  1224. break;
  1225. };
  1226. const uint64_t until = OS::get_singleton()->get_ticks_msec() + 20;
  1227. while (ppeer->get_available_packet_count() > 0) {
  1228. if (pending_in_queue) {
  1229. int todo = MIN(ppeer->get_available_packet_count(), pending_in_queue);
  1230. for (int i = 0; i < todo; i++) {
  1231. Variant cmd;
  1232. Error ret = ppeer->get_var(cmd);
  1233. if (ret != OK) {
  1234. stop();
  1235. ERR_FAIL_COND(ret != OK);
  1236. }
  1237. message.push_back(cmd);
  1238. pending_in_queue--;
  1239. }
  1240. if (pending_in_queue == 0) {
  1241. _parse_message(message_type, message);
  1242. message.clear();
  1243. }
  1244. } else {
  1245. if (ppeer->get_available_packet_count() >= 2) {
  1246. Variant cmd;
  1247. Error ret = ppeer->get_var(cmd);
  1248. if (ret != OK) {
  1249. stop();
  1250. ERR_FAIL_COND(ret != OK);
  1251. }
  1252. if (cmd.get_type() != Variant::STRING) {
  1253. stop();
  1254. ERR_FAIL_COND(cmd.get_type() != Variant::STRING);
  1255. }
  1256. message_type = cmd;
  1257. ret = ppeer->get_var(cmd);
  1258. if (ret != OK) {
  1259. stop();
  1260. ERR_FAIL_COND(ret != OK);
  1261. }
  1262. if (cmd.get_type() != Variant::INT) {
  1263. stop();
  1264. ERR_FAIL_COND(cmd.get_type() != Variant::INT);
  1265. }
  1266. pending_in_queue = cmd;
  1267. if (pending_in_queue == 0) {
  1268. _parse_message(message_type, Array());
  1269. message.clear();
  1270. }
  1271. } else {
  1272. break;
  1273. }
  1274. }
  1275. if (OS::get_singleton()->get_ticks_msec() > until)
  1276. break;
  1277. }
  1278. } break;
  1279. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  1280. add_constant_override("margin_left", -EditorNode::get_singleton()->get_gui_base()->get_stylebox("BottomPanelDebuggerOverride", "EditorStyles")->get_margin(MARGIN_LEFT));
  1281. add_constant_override("margin_right", -EditorNode::get_singleton()->get_gui_base()->get_stylebox("BottomPanelDebuggerOverride", "EditorStyles")->get_margin(MARGIN_RIGHT));
  1282. tabs->add_style_override("panel", editor->get_gui_base()->get_stylebox("DebuggerPanel", "EditorStyles"));
  1283. tabs->add_style_override("tab_fg", editor->get_gui_base()->get_stylebox("DebuggerTabFG", "EditorStyles"));
  1284. tabs->add_style_override("tab_bg", editor->get_gui_base()->get_stylebox("DebuggerTabBG", "EditorStyles"));
  1285. copy->set_icon(get_icon("ActionCopy", "EditorIcons"));
  1286. step->set_icon(get_icon("DebugStep", "EditorIcons"));
  1287. next->set_icon(get_icon("DebugNext", "EditorIcons"));
  1288. back->set_icon(get_icon("Back", "EditorIcons"));
  1289. forward->set_icon(get_icon("Forward", "EditorIcons"));
  1290. dobreak->set_icon(get_icon("Pause", "EditorIcons"));
  1291. docontinue->set_icon(get_icon("DebugContinue", "EditorIcons"));
  1292. vmem_refresh->set_icon(get_icon("Reload", "EditorIcons"));
  1293. vmem_export->set_icon(get_icon("Save", "EditorIcons"));
  1294. } break;
  1295. }
  1296. }
  1297. void ScriptEditorDebugger::_clear_execution() {
  1298. TreeItem *ti = stack_dump->get_selected();
  1299. if (!ti)
  1300. return;
  1301. Dictionary d = ti->get_metadata(0);
  1302. stack_script = ResourceLoader::load(d["file"]);
  1303. emit_signal("clear_execution", stack_script);
  1304. stack_script.unref();
  1305. }
  1306. void ScriptEditorDebugger::start() {
  1307. stop();
  1308. if (is_visible_in_tree()) {
  1309. EditorNode::get_singleton()->make_bottom_panel_item_visible(this);
  1310. }
  1311. perf_history.clear();
  1312. for (int i = 0; i < Performance::MONITOR_MAX; i++) {
  1313. perf_max.write[i] = 0;
  1314. }
  1315. int remote_port = (int)EditorSettings::get_singleton()->get("network/debug/remote_port");
  1316. if (server->listen(remote_port) != OK) {
  1317. EditorNode::get_log()->add_message(String("Error listening on port ") + itos(remote_port), EditorLog::MSG_TYPE_ERROR);
  1318. return;
  1319. }
  1320. EditorNode::get_singleton()->get_scene_tree_dock()->show_tab_buttons();
  1321. auto_switch_remote_scene_tree = (bool)EditorSettings::get_singleton()->get("debugger/auto_switch_to_remote_scene_tree");
  1322. if (auto_switch_remote_scene_tree) {
  1323. EditorNode::get_singleton()->get_scene_tree_dock()->show_remote_tree();
  1324. }
  1325. set_process(true);
  1326. breaked = false;
  1327. camera_override = OVERRIDE_NONE;
  1328. }
  1329. void ScriptEditorDebugger::pause() {
  1330. }
  1331. void ScriptEditorDebugger::unpause() {
  1332. }
  1333. void ScriptEditorDebugger::stop() {
  1334. set_process(false);
  1335. breaked = false;
  1336. _clear_execution();
  1337. server->stop();
  1338. _clear_remote_objects();
  1339. ppeer->set_stream_peer(Ref<StreamPeer>());
  1340. if (connection.is_valid()) {
  1341. EditorNode::get_log()->add_message("--- Debugging process stopped ---", EditorLog::MSG_TYPE_EDITOR);
  1342. connection.unref();
  1343. reason->set_text("");
  1344. reason->set_tooltip("");
  1345. }
  1346. pending_in_queue = 0;
  1347. message.clear();
  1348. node_path_cache.clear();
  1349. res_path_cache.clear();
  1350. profiler_signature.clear();
  1351. le_clear->set_disabled(false);
  1352. le_set->set_disabled(true);
  1353. profiler->set_enabled(true);
  1354. vmem_refresh->set_disabled(true);
  1355. inspect_scene_tree->clear();
  1356. inspector->edit(NULL);
  1357. EditorNode::get_singleton()->get_pause_button()->set_pressed(false);
  1358. EditorNode::get_singleton()->get_pause_button()->set_disabled(true);
  1359. EditorNode::get_singleton()->get_scene_tree_dock()->hide_remote_tree();
  1360. EditorNode::get_singleton()->get_scene_tree_dock()->hide_tab_buttons();
  1361. if (hide_on_stop) {
  1362. if (is_visible_in_tree())
  1363. EditorNode::get_singleton()->hide_bottom_panel();
  1364. emit_signal("show_debugger", false);
  1365. }
  1366. }
  1367. void ScriptEditorDebugger::_profiler_activate(bool p_enable) {
  1368. if (!connection.is_valid())
  1369. return;
  1370. if (p_enable) {
  1371. profiler_signature.clear();
  1372. Array msg;
  1373. msg.push_back("start_profiling");
  1374. int max_funcs = EditorSettings::get_singleton()->get("debugger/profiler_frame_max_functions");
  1375. max_funcs = CLAMP(max_funcs, 16, 512);
  1376. msg.push_back(max_funcs);
  1377. ppeer->put_var(msg);
  1378. print_verbose("Starting profiling.");
  1379. } else {
  1380. Array msg;
  1381. msg.push_back("stop_profiling");
  1382. ppeer->put_var(msg);
  1383. print_verbose("Ending profiling.");
  1384. }
  1385. }
  1386. void ScriptEditorDebugger::_network_profiler_activate(bool p_enable) {
  1387. if (!connection.is_valid())
  1388. return;
  1389. if (p_enable) {
  1390. Array msg;
  1391. msg.push_back("start_network_profiling");
  1392. ppeer->put_var(msg);
  1393. print_verbose("Starting network profiling.");
  1394. } else {
  1395. Array msg;
  1396. msg.push_back("stop_network_profiling");
  1397. ppeer->put_var(msg);
  1398. print_verbose("Ending network profiling.");
  1399. }
  1400. }
  1401. void ScriptEditorDebugger::_profiler_seeked() {
  1402. if (!connection.is_valid() || !connection->is_connected_to_host())
  1403. return;
  1404. if (breaked)
  1405. return;
  1406. debug_break();
  1407. }
  1408. void ScriptEditorDebugger::_stack_dump_frame_selected() {
  1409. TreeItem *ti = stack_dump->get_selected();
  1410. if (!ti)
  1411. return;
  1412. Dictionary d = ti->get_metadata(0);
  1413. stack_script = ResourceLoader::load(d["file"]);
  1414. emit_signal("goto_script_line", stack_script, int(d["line"]) - 1);
  1415. emit_signal("set_execution", stack_script, int(d["line"]) - 1);
  1416. stack_script.unref();
  1417. if (connection.is_valid() && connection->is_connected_to_host()) {
  1418. Array msg;
  1419. msg.push_back("get_stack_frame_vars");
  1420. msg.push_back(d["frame"]);
  1421. ppeer->put_var(msg);
  1422. } else {
  1423. inspector->edit(NULL);
  1424. }
  1425. }
  1426. void ScriptEditorDebugger::_output_clear() {
  1427. //output->clear();
  1428. //output->push_color(Color(0,0,0));
  1429. }
  1430. void ScriptEditorDebugger::_export_csv() {
  1431. file_dialog->set_mode(EditorFileDialog::MODE_SAVE_FILE);
  1432. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  1433. file_dialog->clear_filters();
  1434. file_dialog_mode = SAVE_MONITORS_CSV;
  1435. file_dialog->popup_centered_ratio();
  1436. }
  1437. String ScriptEditorDebugger::get_var_value(const String &p_var) const {
  1438. if (!breaked)
  1439. return String();
  1440. return variables->get_var_value(p_var);
  1441. }
  1442. int ScriptEditorDebugger::_get_node_path_cache(const NodePath &p_path) {
  1443. const int *r = node_path_cache.getptr(p_path);
  1444. if (r)
  1445. return *r;
  1446. last_path_id++;
  1447. node_path_cache[p_path] = last_path_id;
  1448. Array msg;
  1449. msg.push_back("live_node_path");
  1450. msg.push_back(p_path);
  1451. msg.push_back(last_path_id);
  1452. ppeer->put_var(msg);
  1453. return last_path_id;
  1454. }
  1455. int ScriptEditorDebugger::_get_res_path_cache(const String &p_path) {
  1456. Map<String, int>::Element *E = res_path_cache.find(p_path);
  1457. if (E)
  1458. return E->get();
  1459. last_path_id++;
  1460. res_path_cache[p_path] = last_path_id;
  1461. Array msg;
  1462. msg.push_back("live_res_path");
  1463. msg.push_back(p_path);
  1464. msg.push_back(last_path_id);
  1465. ppeer->put_var(msg);
  1466. return last_path_id;
  1467. }
  1468. void ScriptEditorDebugger::_method_changed(Object *p_base, const StringName &p_name, VARIANT_ARG_DECLARE) {
  1469. if (!p_base || !live_debug || !connection.is_valid() || !editor->get_edited_scene())
  1470. return;
  1471. Node *node = Object::cast_to<Node>(p_base);
  1472. VARIANT_ARGPTRS
  1473. for (int i = 0; i < VARIANT_ARG_MAX; i++) {
  1474. //no pointers, sorry
  1475. if (argptr[i] && (argptr[i]->get_type() == Variant::OBJECT || argptr[i]->get_type() == Variant::_RID))
  1476. return;
  1477. }
  1478. if (node) {
  1479. NodePath path = editor->get_edited_scene()->get_path_to(node);
  1480. int pathid = _get_node_path_cache(path);
  1481. Array msg;
  1482. msg.push_back("live_node_call");
  1483. msg.push_back(pathid);
  1484. msg.push_back(p_name);
  1485. for (int i = 0; i < VARIANT_ARG_MAX; i++) {
  1486. //no pointers, sorry
  1487. msg.push_back(*argptr[i]);
  1488. }
  1489. ppeer->put_var(msg);
  1490. return;
  1491. }
  1492. Resource *res = Object::cast_to<Resource>(p_base);
  1493. if (res && res->get_path() != String()) {
  1494. String respath = res->get_path();
  1495. int pathid = _get_res_path_cache(respath);
  1496. Array msg;
  1497. msg.push_back("live_res_call");
  1498. msg.push_back(pathid);
  1499. msg.push_back(p_name);
  1500. for (int i = 0; i < VARIANT_ARG_MAX; i++) {
  1501. //no pointers, sorry
  1502. msg.push_back(*argptr[i]);
  1503. }
  1504. ppeer->put_var(msg);
  1505. return;
  1506. }
  1507. }
  1508. void ScriptEditorDebugger::_property_changed(Object *p_base, const StringName &p_property, const Variant &p_value) {
  1509. if (!p_base || !live_debug || !connection.is_valid() || !editor->get_edited_scene())
  1510. return;
  1511. Node *node = Object::cast_to<Node>(p_base);
  1512. if (node) {
  1513. NodePath path = editor->get_edited_scene()->get_path_to(node);
  1514. int pathid = _get_node_path_cache(path);
  1515. if (p_value.is_ref()) {
  1516. Ref<Resource> res = p_value;
  1517. if (res.is_valid() && res->get_path() != String()) {
  1518. Array msg;
  1519. msg.push_back("live_node_prop_res");
  1520. msg.push_back(pathid);
  1521. msg.push_back(p_property);
  1522. msg.push_back(res->get_path());
  1523. ppeer->put_var(msg);
  1524. }
  1525. } else {
  1526. Array msg;
  1527. msg.push_back("live_node_prop");
  1528. msg.push_back(pathid);
  1529. msg.push_back(p_property);
  1530. msg.push_back(p_value);
  1531. ppeer->put_var(msg);
  1532. }
  1533. return;
  1534. }
  1535. Resource *res = Object::cast_to<Resource>(p_base);
  1536. if (res && res->get_path() != String()) {
  1537. String respath = res->get_path();
  1538. int pathid = _get_res_path_cache(respath);
  1539. if (p_value.is_ref()) {
  1540. Ref<Resource> res2 = p_value;
  1541. if (res2.is_valid() && res2->get_path() != String()) {
  1542. Array msg;
  1543. msg.push_back("live_res_prop_res");
  1544. msg.push_back(pathid);
  1545. msg.push_back(p_property);
  1546. msg.push_back(res2->get_path());
  1547. ppeer->put_var(msg);
  1548. }
  1549. } else {
  1550. Array msg;
  1551. msg.push_back("live_res_prop");
  1552. msg.push_back(pathid);
  1553. msg.push_back(p_property);
  1554. msg.push_back(p_value);
  1555. ppeer->put_var(msg);
  1556. }
  1557. return;
  1558. }
  1559. }
  1560. void ScriptEditorDebugger::_method_changeds(void *p_ud, Object *p_base, const StringName &p_name, VARIANT_ARG_DECLARE) {
  1561. ScriptEditorDebugger *sed = (ScriptEditorDebugger *)p_ud;
  1562. sed->_method_changed(p_base, p_name, VARIANT_ARG_PASS);
  1563. }
  1564. void ScriptEditorDebugger::_property_changeds(void *p_ud, Object *p_base, const StringName &p_property, const Variant &p_value) {
  1565. ScriptEditorDebugger *sed = (ScriptEditorDebugger *)p_ud;
  1566. sed->_property_changed(p_base, p_property, p_value);
  1567. }
  1568. void ScriptEditorDebugger::set_live_debugging(bool p_enable) {
  1569. live_debug = p_enable;
  1570. }
  1571. void ScriptEditorDebugger::_live_edit_set() {
  1572. if (!connection.is_valid())
  1573. return;
  1574. TreeItem *ti = inspect_scene_tree->get_selected();
  1575. if (!ti)
  1576. return;
  1577. String path;
  1578. while (ti) {
  1579. String lp = ti->get_text(0);
  1580. path = "/" + lp + path;
  1581. ti = ti->get_parent();
  1582. }
  1583. NodePath np = path;
  1584. editor->get_editor_data().set_edited_scene_live_edit_root(np);
  1585. update_live_edit_root();
  1586. }
  1587. void ScriptEditorDebugger::_live_edit_clear() {
  1588. NodePath np = NodePath("/root");
  1589. editor->get_editor_data().set_edited_scene_live_edit_root(np);
  1590. update_live_edit_root();
  1591. }
  1592. void ScriptEditorDebugger::update_live_edit_root() {
  1593. NodePath np = editor->get_editor_data().get_edited_scene_live_edit_root();
  1594. if (connection.is_valid()) {
  1595. Array msg;
  1596. msg.push_back("live_set_root");
  1597. msg.push_back(np);
  1598. if (editor->get_edited_scene())
  1599. msg.push_back(editor->get_edited_scene()->get_filename());
  1600. else
  1601. msg.push_back("");
  1602. ppeer->put_var(msg);
  1603. }
  1604. live_edit_root->set_text(np);
  1605. }
  1606. void ScriptEditorDebugger::live_debug_create_node(const NodePath &p_parent, const String &p_type, const String &p_name) {
  1607. if (live_debug && connection.is_valid()) {
  1608. Array msg;
  1609. msg.push_back("live_create_node");
  1610. msg.push_back(p_parent);
  1611. msg.push_back(p_type);
  1612. msg.push_back(p_name);
  1613. ppeer->put_var(msg);
  1614. }
  1615. }
  1616. void ScriptEditorDebugger::live_debug_instance_node(const NodePath &p_parent, const String &p_path, const String &p_name) {
  1617. if (live_debug && connection.is_valid()) {
  1618. Array msg;
  1619. msg.push_back("live_instance_node");
  1620. msg.push_back(p_parent);
  1621. msg.push_back(p_path);
  1622. msg.push_back(p_name);
  1623. ppeer->put_var(msg);
  1624. }
  1625. }
  1626. void ScriptEditorDebugger::live_debug_remove_node(const NodePath &p_at) {
  1627. if (live_debug && connection.is_valid()) {
  1628. Array msg;
  1629. msg.push_back("live_remove_node");
  1630. msg.push_back(p_at);
  1631. ppeer->put_var(msg);
  1632. }
  1633. }
  1634. void ScriptEditorDebugger::live_debug_remove_and_keep_node(const NodePath &p_at, ObjectID p_keep_id) {
  1635. if (live_debug && connection.is_valid()) {
  1636. Array msg;
  1637. msg.push_back("live_remove_and_keep_node");
  1638. msg.push_back(p_at);
  1639. msg.push_back(p_keep_id);
  1640. ppeer->put_var(msg);
  1641. }
  1642. }
  1643. void ScriptEditorDebugger::live_debug_restore_node(ObjectID p_id, const NodePath &p_at, int p_at_pos) {
  1644. if (live_debug && connection.is_valid()) {
  1645. Array msg;
  1646. msg.push_back("live_restore_node");
  1647. msg.push_back(p_id);
  1648. msg.push_back(p_at);
  1649. msg.push_back(p_at_pos);
  1650. ppeer->put_var(msg);
  1651. }
  1652. }
  1653. void ScriptEditorDebugger::live_debug_duplicate_node(const NodePath &p_at, const String &p_new_name) {
  1654. if (live_debug && connection.is_valid()) {
  1655. Array msg;
  1656. msg.push_back("live_duplicate_node");
  1657. msg.push_back(p_at);
  1658. msg.push_back(p_new_name);
  1659. ppeer->put_var(msg);
  1660. }
  1661. }
  1662. void ScriptEditorDebugger::live_debug_reparent_node(const NodePath &p_at, const NodePath &p_new_place, const String &p_new_name, int p_at_pos) {
  1663. if (live_debug && connection.is_valid()) {
  1664. Array msg;
  1665. msg.push_back("live_reparent_node");
  1666. msg.push_back(p_at);
  1667. msg.push_back(p_new_place);
  1668. msg.push_back(p_new_name);
  1669. msg.push_back(p_at_pos);
  1670. ppeer->put_var(msg);
  1671. }
  1672. }
  1673. ScriptEditorDebugger::CameraOverride ScriptEditorDebugger::get_camera_override() const {
  1674. return camera_override;
  1675. }
  1676. void ScriptEditorDebugger::set_camera_override(CameraOverride p_override) {
  1677. if (p_override == OVERRIDE_2D && camera_override != OVERRIDE_2D) {
  1678. if (connection.is_valid()) {
  1679. Array msg;
  1680. msg.push_back("override_camera_2D:set");
  1681. msg.push_back(true);
  1682. ppeer->put_var(msg);
  1683. }
  1684. } else if (p_override != OVERRIDE_2D && camera_override == OVERRIDE_2D) {
  1685. if (connection.is_valid()) {
  1686. Array msg;
  1687. msg.push_back("override_camera_2D:set");
  1688. msg.push_back(false);
  1689. ppeer->put_var(msg);
  1690. }
  1691. } else if (p_override >= OVERRIDE_3D_1 && camera_override < OVERRIDE_3D_1) {
  1692. if (connection.is_valid()) {
  1693. Array msg;
  1694. msg.push_back("override_camera_3D:set");
  1695. msg.push_back(true);
  1696. ppeer->put_var(msg);
  1697. }
  1698. } else if (p_override < OVERRIDE_3D_1 && camera_override >= OVERRIDE_3D_1) {
  1699. if (connection.is_valid()) {
  1700. Array msg;
  1701. msg.push_back("override_camera_3D:set");
  1702. msg.push_back(false);
  1703. ppeer->put_var(msg);
  1704. }
  1705. }
  1706. camera_override = p_override;
  1707. }
  1708. void ScriptEditorDebugger::set_breakpoint(const String &p_path, int p_line, bool p_enabled) {
  1709. if (connection.is_valid()) {
  1710. Array msg;
  1711. msg.push_back("breakpoint");
  1712. msg.push_back(p_path);
  1713. msg.push_back(p_line);
  1714. msg.push_back(p_enabled);
  1715. ppeer->put_var(msg);
  1716. }
  1717. }
  1718. void ScriptEditorDebugger::reload_scripts() {
  1719. if (connection.is_valid()) {
  1720. Array msg;
  1721. msg.push_back("reload_scripts");
  1722. ppeer->put_var(msg);
  1723. }
  1724. }
  1725. bool ScriptEditorDebugger::is_skip_breakpoints() {
  1726. return skip_breakpoints_value;
  1727. }
  1728. void ScriptEditorDebugger::_error_activated() {
  1729. TreeItem *selected = error_tree->get_selected();
  1730. TreeItem *ci = selected->get_children();
  1731. if (ci) {
  1732. selected->set_collapsed(!selected->is_collapsed());
  1733. }
  1734. }
  1735. void ScriptEditorDebugger::_error_selected() {
  1736. TreeItem *selected = error_tree->get_selected();
  1737. Array meta = selected->get_metadata(0);
  1738. if (meta.size() == 0) {
  1739. return;
  1740. }
  1741. Ref<Script> s = ResourceLoader::load(meta[0]);
  1742. emit_signal("goto_script_line", s, int(meta[1]) - 1);
  1743. }
  1744. void ScriptEditorDebugger::_expand_errors_list() {
  1745. TreeItem *root = error_tree->get_root();
  1746. if (!root)
  1747. return;
  1748. TreeItem *item = root->get_children();
  1749. while (item) {
  1750. item->set_collapsed(false);
  1751. item = item->get_next();
  1752. }
  1753. }
  1754. void ScriptEditorDebugger::_collapse_errors_list() {
  1755. TreeItem *root = error_tree->get_root();
  1756. if (!root)
  1757. return;
  1758. TreeItem *item = root->get_children();
  1759. while (item) {
  1760. item->set_collapsed(true);
  1761. item = item->get_next();
  1762. }
  1763. }
  1764. void ScriptEditorDebugger::set_hide_on_stop(bool p_hide) {
  1765. hide_on_stop = p_hide;
  1766. }
  1767. bool ScriptEditorDebugger::get_debug_with_external_editor() const {
  1768. return enable_external_editor;
  1769. }
  1770. void ScriptEditorDebugger::set_debug_with_external_editor(bool p_enabled) {
  1771. enable_external_editor = p_enabled;
  1772. }
  1773. Ref<Script> ScriptEditorDebugger::get_dump_stack_script() const {
  1774. return stack_script;
  1775. }
  1776. void ScriptEditorDebugger::_paused() {
  1777. ERR_FAIL_COND(connection.is_null());
  1778. ERR_FAIL_COND(!connection->is_connected_to_host());
  1779. if (!breaked && EditorNode::get_singleton()->get_pause_button()->is_pressed()) {
  1780. debug_break();
  1781. }
  1782. if (breaked && !EditorNode::get_singleton()->get_pause_button()->is_pressed()) {
  1783. debug_continue();
  1784. }
  1785. }
  1786. void ScriptEditorDebugger::_set_remote_object(ObjectID p_id, ScriptEditorDebuggerInspectedObject *p_obj) {
  1787. if (remote_objects.has(p_id))
  1788. memdelete(remote_objects[p_id]);
  1789. remote_objects[p_id] = p_obj;
  1790. }
  1791. void ScriptEditorDebugger::_clear_remote_objects() {
  1792. for (Map<ObjectID, ScriptEditorDebuggerInspectedObject *>::Element *E = remote_objects.front(); E; E = E->next()) {
  1793. if (editor->get_editor_history()->get_current() == E->value()->get_instance_id()) {
  1794. editor->push_item(NULL);
  1795. }
  1796. memdelete(E->value());
  1797. }
  1798. remote_objects.clear();
  1799. remote_dependencies.clear();
  1800. }
  1801. void ScriptEditorDebugger::_clear_errors_list() {
  1802. error_tree->clear();
  1803. error_count = 0;
  1804. warning_count = 0;
  1805. _notification(NOTIFICATION_PROCESS);
  1806. }
  1807. // Right click on specific file(s) or folder(s).
  1808. void ScriptEditorDebugger::_error_tree_item_rmb_selected(const Vector2 &p_pos) {
  1809. item_menu->clear();
  1810. item_menu->set_size(Size2(1, 1));
  1811. if (error_tree->is_anything_selected()) {
  1812. item_menu->add_icon_item(get_icon("ActionCopy", "EditorIcons"), TTR("Copy Error"), ITEM_MENU_COPY_ERROR);
  1813. }
  1814. if (item_menu->get_item_count() > 0) {
  1815. item_menu->set_position(error_tree->get_global_position() + p_pos);
  1816. item_menu->popup();
  1817. }
  1818. }
  1819. void ScriptEditorDebugger::_item_menu_id_pressed(int p_option) {
  1820. switch (p_option) {
  1821. case ITEM_MENU_COPY_ERROR: {
  1822. TreeItem *ti = error_tree->get_selected();
  1823. while (ti->get_parent() != error_tree->get_root())
  1824. ti = ti->get_parent();
  1825. String type;
  1826. if (ti->get_icon(0) == get_icon("Warning", "EditorIcons")) {
  1827. type = "W ";
  1828. } else if (ti->get_icon(0) == get_icon("Error", "EditorIcons")) {
  1829. type = "E ";
  1830. }
  1831. String text = ti->get_text(0) + " ";
  1832. int rpad_len = text.length();
  1833. text = type + text + ti->get_text(1) + "\n";
  1834. TreeItem *ci = ti->get_children();
  1835. while (ci) {
  1836. text += " " + ci->get_text(0).rpad(rpad_len) + ci->get_text(1) + "\n";
  1837. ci = ci->get_next();
  1838. }
  1839. OS::get_singleton()->set_clipboard(text);
  1840. } break;
  1841. case ITEM_MENU_SAVE_REMOTE_NODE: {
  1842. file_dialog->set_access(EditorFileDialog::ACCESS_RESOURCES);
  1843. file_dialog->set_mode(EditorFileDialog::MODE_SAVE_FILE);
  1844. file_dialog_mode = SAVE_NODE;
  1845. List<String> extensions;
  1846. Ref<PackedScene> sd = memnew(PackedScene);
  1847. ResourceSaver::get_recognized_extensions(sd, &extensions);
  1848. file_dialog->clear_filters();
  1849. for (int i = 0; i < extensions.size(); i++) {
  1850. file_dialog->add_filter("*." + extensions[i] + " ; " + extensions[i].to_upper());
  1851. }
  1852. file_dialog->popup_centered_ratio();
  1853. } break;
  1854. case ITEM_MENU_COPY_NODE_PATH: {
  1855. TreeItem *ti = inspect_scene_tree->get_selected();
  1856. String text = ti->get_text(0);
  1857. if (ti->get_parent() == NULL) {
  1858. text = ".";
  1859. } else if (ti->get_parent()->get_parent() == NULL) {
  1860. text = ".";
  1861. } else {
  1862. while (ti->get_parent()->get_parent() != inspect_scene_tree->get_root()) {
  1863. ti = ti->get_parent();
  1864. text = ti->get_text(0) + "/" + text;
  1865. }
  1866. }
  1867. OS::get_singleton()->set_clipboard(text);
  1868. } break;
  1869. }
  1870. }
  1871. void ScriptEditorDebugger::_tab_changed(int p_tab) {
  1872. if (tabs->get_tab_title(p_tab) == TTR("Video RAM")) {
  1873. // "Video RAM" tab was clicked, refresh the data it's displaying when entering the tab.
  1874. _video_mem_request();
  1875. }
  1876. }
  1877. void ScriptEditorDebugger::_bind_methods() {
  1878. ClassDB::bind_method(D_METHOD("_stack_dump_frame_selected"), &ScriptEditorDebugger::_stack_dump_frame_selected);
  1879. ClassDB::bind_method(D_METHOD("debug_skip_breakpoints"), &ScriptEditorDebugger::debug_skip_breakpoints);
  1880. ClassDB::bind_method(D_METHOD("debug_copy"), &ScriptEditorDebugger::debug_copy);
  1881. ClassDB::bind_method(D_METHOD("debug_next"), &ScriptEditorDebugger::debug_next);
  1882. ClassDB::bind_method(D_METHOD("debug_step"), &ScriptEditorDebugger::debug_step);
  1883. ClassDB::bind_method(D_METHOD("debug_break"), &ScriptEditorDebugger::debug_break);
  1884. ClassDB::bind_method(D_METHOD("debug_continue"), &ScriptEditorDebugger::debug_continue);
  1885. ClassDB::bind_method(D_METHOD("_output_clear"), &ScriptEditorDebugger::_output_clear);
  1886. ClassDB::bind_method(D_METHOD("_export_csv"), &ScriptEditorDebugger::_export_csv);
  1887. ClassDB::bind_method(D_METHOD("_performance_draw"), &ScriptEditorDebugger::_performance_draw);
  1888. ClassDB::bind_method(D_METHOD("_performance_select"), &ScriptEditorDebugger::_performance_select);
  1889. ClassDB::bind_method(D_METHOD("_scene_tree_request"), &ScriptEditorDebugger::_scene_tree_request);
  1890. ClassDB::bind_method(D_METHOD("_video_mem_request"), &ScriptEditorDebugger::_video_mem_request);
  1891. ClassDB::bind_method(D_METHOD("_video_mem_export"), &ScriptEditorDebugger::_video_mem_export);
  1892. ClassDB::bind_method(D_METHOD("_live_edit_set"), &ScriptEditorDebugger::_live_edit_set);
  1893. ClassDB::bind_method(D_METHOD("_live_edit_clear"), &ScriptEditorDebugger::_live_edit_clear);
  1894. ClassDB::bind_method(D_METHOD("_error_selected"), &ScriptEditorDebugger::_error_selected);
  1895. ClassDB::bind_method(D_METHOD("_error_activated"), &ScriptEditorDebugger::_error_activated);
  1896. ClassDB::bind_method(D_METHOD("_expand_errors_list"), &ScriptEditorDebugger::_expand_errors_list);
  1897. ClassDB::bind_method(D_METHOD("_collapse_errors_list"), &ScriptEditorDebugger::_collapse_errors_list);
  1898. ClassDB::bind_method(D_METHOD("_profiler_activate"), &ScriptEditorDebugger::_profiler_activate);
  1899. ClassDB::bind_method(D_METHOD("_network_profiler_activate"), &ScriptEditorDebugger::_network_profiler_activate);
  1900. ClassDB::bind_method(D_METHOD("_profiler_seeked"), &ScriptEditorDebugger::_profiler_seeked);
  1901. ClassDB::bind_method(D_METHOD("_clear_errors_list"), &ScriptEditorDebugger::_clear_errors_list);
  1902. ClassDB::bind_method(D_METHOD("_error_tree_item_rmb_selected"), &ScriptEditorDebugger::_error_tree_item_rmb_selected);
  1903. ClassDB::bind_method(D_METHOD("_item_menu_id_pressed"), &ScriptEditorDebugger::_item_menu_id_pressed);
  1904. ClassDB::bind_method(D_METHOD("_tab_changed"), &ScriptEditorDebugger::_tab_changed);
  1905. ClassDB::bind_method(D_METHOD("_paused"), &ScriptEditorDebugger::_paused);
  1906. ClassDB::bind_method(D_METHOD("_scene_tree_selected"), &ScriptEditorDebugger::_scene_tree_selected);
  1907. ClassDB::bind_method(D_METHOD("_scene_tree_folded"), &ScriptEditorDebugger::_scene_tree_folded);
  1908. ClassDB::bind_method(D_METHOD("_scene_tree_rmb_selected"), &ScriptEditorDebugger::_scene_tree_rmb_selected);
  1909. ClassDB::bind_method(D_METHOD("_file_selected"), &ScriptEditorDebugger::_file_selected);
  1910. ClassDB::bind_method(D_METHOD("live_debug_create_node"), &ScriptEditorDebugger::live_debug_create_node);
  1911. ClassDB::bind_method(D_METHOD("live_debug_instance_node"), &ScriptEditorDebugger::live_debug_instance_node);
  1912. ClassDB::bind_method(D_METHOD("live_debug_remove_node"), &ScriptEditorDebugger::live_debug_remove_node);
  1913. ClassDB::bind_method(D_METHOD("live_debug_remove_and_keep_node"), &ScriptEditorDebugger::live_debug_remove_and_keep_node);
  1914. ClassDB::bind_method(D_METHOD("live_debug_restore_node"), &ScriptEditorDebugger::live_debug_restore_node);
  1915. ClassDB::bind_method(D_METHOD("live_debug_duplicate_node"), &ScriptEditorDebugger::live_debug_duplicate_node);
  1916. ClassDB::bind_method(D_METHOD("live_debug_reparent_node"), &ScriptEditorDebugger::live_debug_reparent_node);
  1917. ClassDB::bind_method(D_METHOD("_scene_tree_property_select_object"), &ScriptEditorDebugger::_scene_tree_property_select_object);
  1918. ClassDB::bind_method(D_METHOD("_scene_tree_property_value_edited"), &ScriptEditorDebugger::_scene_tree_property_value_edited);
  1919. ADD_SIGNAL(MethodInfo("goto_script_line"));
  1920. ADD_SIGNAL(MethodInfo("set_execution", PropertyInfo("script"), PropertyInfo(Variant::INT, "line")));
  1921. ADD_SIGNAL(MethodInfo("clear_execution", PropertyInfo("script")));
  1922. ADD_SIGNAL(MethodInfo("breaked", PropertyInfo(Variant::BOOL, "reallydid"), PropertyInfo(Variant::BOOL, "can_debug")));
  1923. ADD_SIGNAL(MethodInfo("show_debugger", PropertyInfo(Variant::BOOL, "reallydid")));
  1924. }
  1925. ScriptEditorDebugger::ScriptEditorDebugger(EditorNode *p_editor) {
  1926. add_constant_override("margin_left", -EditorNode::get_singleton()->get_gui_base()->get_stylebox("BottomPanelDebuggerOverride", "EditorStyles")->get_margin(MARGIN_LEFT));
  1927. add_constant_override("margin_right", -EditorNode::get_singleton()->get_gui_base()->get_stylebox("BottomPanelDebuggerOverride", "EditorStyles")->get_margin(MARGIN_RIGHT));
  1928. ppeer = Ref<PacketPeerStream>(memnew(PacketPeerStream));
  1929. ppeer->set_input_buffer_max_size((1024 * 1024 * 8) - 4); // 8 MiB should be enough, minus 4 bytes for separator.
  1930. editor = p_editor;
  1931. editor->get_inspector()->connect("object_id_selected", this, "_scene_tree_property_select_object");
  1932. tabs = memnew(TabContainer);
  1933. tabs->set_tab_align(TabContainer::ALIGN_LEFT);
  1934. tabs->add_style_override("panel", editor->get_gui_base()->get_stylebox("DebuggerPanel", "EditorStyles"));
  1935. tabs->add_style_override("tab_fg", editor->get_gui_base()->get_stylebox("DebuggerTabFG", "EditorStyles"));
  1936. tabs->add_style_override("tab_bg", editor->get_gui_base()->get_stylebox("DebuggerTabBG", "EditorStyles"));
  1937. tabs->connect("tab_changed", this, "_tab_changed");
  1938. add_child(tabs);
  1939. { //debugger
  1940. VBoxContainer *vbc = memnew(VBoxContainer);
  1941. vbc->set_name(TTR("Debugger"));
  1942. Control *dbg = vbc;
  1943. HBoxContainer *hbc = memnew(HBoxContainer);
  1944. vbc->add_child(hbc);
  1945. reason = memnew(Label);
  1946. reason->set_text("");
  1947. hbc->add_child(reason);
  1948. reason->set_h_size_flags(SIZE_EXPAND_FILL);
  1949. reason->set_autowrap(true);
  1950. reason->set_max_lines_visible(3);
  1951. reason->set_mouse_filter(Control::MOUSE_FILTER_PASS);
  1952. hbc->add_child(memnew(VSeparator));
  1953. skip_breakpoints = memnew(ToolButton);
  1954. hbc->add_child(skip_breakpoints);
  1955. skip_breakpoints->set_tooltip(TTR("Skip Breakpoints"));
  1956. skip_breakpoints->connect("pressed", this, "debug_skip_breakpoints");
  1957. hbc->add_child(memnew(VSeparator));
  1958. copy = memnew(ToolButton);
  1959. hbc->add_child(copy);
  1960. copy->set_tooltip(TTR("Copy Error"));
  1961. copy->connect("pressed", this, "debug_copy");
  1962. hbc->add_child(memnew(VSeparator));
  1963. step = memnew(ToolButton);
  1964. hbc->add_child(step);
  1965. step->set_tooltip(TTR("Step Into"));
  1966. step->set_shortcut(ED_GET_SHORTCUT("debugger/step_into"));
  1967. step->connect("pressed", this, "debug_step");
  1968. next = memnew(ToolButton);
  1969. hbc->add_child(next);
  1970. next->set_tooltip(TTR("Step Over"));
  1971. next->set_shortcut(ED_GET_SHORTCUT("debugger/step_over"));
  1972. next->connect("pressed", this, "debug_next");
  1973. hbc->add_child(memnew(VSeparator));
  1974. dobreak = memnew(ToolButton);
  1975. hbc->add_child(dobreak);
  1976. dobreak->set_tooltip(TTR("Break"));
  1977. dobreak->set_shortcut(ED_GET_SHORTCUT("debugger/break"));
  1978. dobreak->connect("pressed", this, "debug_break");
  1979. docontinue = memnew(ToolButton);
  1980. hbc->add_child(docontinue);
  1981. docontinue->set_tooltip(TTR("Continue"));
  1982. docontinue->set_shortcut(ED_GET_SHORTCUT("debugger/continue"));
  1983. docontinue->connect("pressed", this, "debug_continue");
  1984. back = memnew(Button);
  1985. hbc->add_child(back);
  1986. back->set_tooltip(TTR("Inspect Previous Instance"));
  1987. back->hide();
  1988. forward = memnew(Button);
  1989. hbc->add_child(forward);
  1990. forward->set_tooltip(TTR("Inspect Next Instance"));
  1991. forward->hide();
  1992. HSplitContainer *sc = memnew(HSplitContainer);
  1993. vbc->add_child(sc);
  1994. sc->set_v_size_flags(SIZE_EXPAND_FILL);
  1995. stack_dump = memnew(Tree);
  1996. stack_dump->set_allow_reselect(true);
  1997. stack_dump->set_columns(1);
  1998. stack_dump->set_column_titles_visible(true);
  1999. stack_dump->set_column_title(0, TTR("Stack Frames"));
  2000. stack_dump->set_h_size_flags(SIZE_EXPAND_FILL);
  2001. stack_dump->set_hide_root(true);
  2002. stack_dump->connect("cell_selected", this, "_stack_dump_frame_selected");
  2003. sc->add_child(stack_dump);
  2004. inspector = memnew(EditorInspector);
  2005. inspector->set_h_size_flags(SIZE_EXPAND_FILL);
  2006. inspector->set_enable_capitalize_paths(false);
  2007. inspector->set_read_only(true);
  2008. inspector->connect("object_id_selected", this, "_scene_tree_property_select_object");
  2009. sc->add_child(inspector);
  2010. server.instance();
  2011. pending_in_queue = 0;
  2012. variables = memnew(ScriptEditorDebuggerVariables);
  2013. breaked = false;
  2014. tabs->add_child(dbg);
  2015. }
  2016. { //errors
  2017. errors_tab = memnew(VBoxContainer);
  2018. errors_tab->set_name(TTR("Errors"));
  2019. HBoxContainer *errhb = memnew(HBoxContainer);
  2020. errors_tab->add_child(errhb);
  2021. Button *expand_all = memnew(Button);
  2022. expand_all->set_text(TTR("Expand All"));
  2023. expand_all->connect("pressed", this, "_expand_errors_list");
  2024. errhb->add_child(expand_all);
  2025. Button *collapse_all = memnew(Button);
  2026. collapse_all->set_text(TTR("Collapse All"));
  2027. collapse_all->connect("pressed", this, "_collapse_errors_list");
  2028. errhb->add_child(collapse_all);
  2029. Control *space = memnew(Control);
  2030. space->set_h_size_flags(SIZE_EXPAND_FILL);
  2031. errhb->add_child(space);
  2032. clearbutton = memnew(Button);
  2033. clearbutton->set_text(TTR("Clear"));
  2034. clearbutton->set_h_size_flags(0);
  2035. clearbutton->connect("pressed", this, "_clear_errors_list");
  2036. errhb->add_child(clearbutton);
  2037. error_tree = memnew(Tree);
  2038. error_tree->set_columns(2);
  2039. error_tree->set_column_expand(0, false);
  2040. error_tree->set_column_min_width(0, 140);
  2041. error_tree->set_column_expand(1, true);
  2042. error_tree->set_select_mode(Tree::SELECT_ROW);
  2043. error_tree->set_hide_root(true);
  2044. error_tree->set_v_size_flags(SIZE_EXPAND_FILL);
  2045. error_tree->set_allow_rmb_select(true);
  2046. error_tree->connect("item_rmb_selected", this, "_error_tree_item_rmb_selected");
  2047. errors_tab->add_child(error_tree);
  2048. item_menu = memnew(PopupMenu);
  2049. item_menu->connect("id_pressed", this, "_item_menu_id_pressed");
  2050. error_tree->add_child(item_menu);
  2051. tabs->add_child(errors_tab);
  2052. }
  2053. { // remote scene tree
  2054. inspect_scene_tree = memnew(Tree);
  2055. EditorNode::get_singleton()->get_scene_tree_dock()->add_remote_tree_editor(inspect_scene_tree);
  2056. EditorNode::get_singleton()->get_scene_tree_dock()->connect("remote_tree_selected", this, "_scene_tree_selected");
  2057. inspect_scene_tree->set_v_size_flags(SIZE_EXPAND_FILL);
  2058. inspect_scene_tree->connect("cell_selected", this, "_scene_tree_selected");
  2059. inspect_scene_tree->connect("item_collapsed", this, "_scene_tree_folded");
  2060. inspect_scene_tree->set_allow_rmb_select(true);
  2061. inspect_scene_tree->connect("item_rmb_selected", this, "_scene_tree_rmb_selected");
  2062. auto_switch_remote_scene_tree = EDITOR_DEF("debugger/auto_switch_to_remote_scene_tree", false);
  2063. inspect_scene_tree_timeout = EDITOR_DEF("debugger/remote_scene_tree_refresh_interval", 1.0);
  2064. inspect_edited_object_timeout = EDITOR_DEF("debugger/remote_inspect_refresh_interval", 0.2);
  2065. inspected_object_id = 0;
  2066. updating_scene_tree = false;
  2067. }
  2068. { // File dialog
  2069. file_dialog = memnew(EditorFileDialog);
  2070. file_dialog->connect("file_selected", this, "_file_selected");
  2071. add_child(file_dialog);
  2072. }
  2073. { //profiler
  2074. profiler = memnew(EditorProfiler);
  2075. profiler->set_name(TTR("Profiler"));
  2076. tabs->add_child(profiler);
  2077. profiler->connect("enable_profiling", this, "_profiler_activate");
  2078. profiler->connect("break_request", this, "_profiler_seeked");
  2079. }
  2080. { //network profiler
  2081. network_profiler = memnew(EditorNetworkProfiler);
  2082. network_profiler->set_name(TTR("Network Profiler"));
  2083. tabs->add_child(network_profiler);
  2084. network_profiler->connect("enable_profiling", this, "_network_profiler_activate");
  2085. }
  2086. { //monitors
  2087. HSplitContainer *hsp = memnew(HSplitContainer);
  2088. perf_monitors = memnew(Tree);
  2089. perf_monitors->set_columns(2);
  2090. perf_monitors->set_column_title(0, TTR("Monitor"));
  2091. perf_monitors->set_column_title(1, TTR("Value"));
  2092. perf_monitors->set_column_titles_visible(true);
  2093. perf_monitors->connect("item_edited", this, "_performance_select");
  2094. hsp->add_child(perf_monitors);
  2095. perf_draw = memnew(Control);
  2096. perf_draw->set_clip_contents(true);
  2097. perf_draw->connect("draw", this, "_performance_draw");
  2098. hsp->add_child(perf_draw);
  2099. hsp->set_name(TTR("Monitors"));
  2100. hsp->set_split_offset(340 * EDSCALE);
  2101. tabs->add_child(hsp);
  2102. perf_max.resize(Performance::MONITOR_MAX);
  2103. Map<String, TreeItem *> bases;
  2104. TreeItem *root = perf_monitors->create_item();
  2105. perf_monitors->set_hide_root(true);
  2106. for (int i = 0; i < Performance::MONITOR_MAX; i++) {
  2107. String n = Performance::get_singleton()->get_monitor_name(Performance::Monitor(i));
  2108. Performance::MonitorType mtype = Performance::get_singleton()->get_monitor_type(Performance::Monitor(i));
  2109. String base = n.get_slice("/", 0);
  2110. String name = n.get_slice("/", 1);
  2111. if (!bases.has(base)) {
  2112. TreeItem *b = perf_monitors->create_item(root);
  2113. b->set_text(0, base.capitalize());
  2114. b->set_editable(0, false);
  2115. b->set_selectable(0, false);
  2116. b->set_expand_right(0, true);
  2117. bases[base] = b;
  2118. }
  2119. TreeItem *it = perf_monitors->create_item(bases[base]);
  2120. it->set_metadata(1, mtype);
  2121. it->set_cell_mode(0, TreeItem::CELL_MODE_CHECK);
  2122. it->set_editable(0, true);
  2123. it->set_selectable(0, false);
  2124. it->set_selectable(1, false);
  2125. it->set_text(0, name.capitalize());
  2126. perf_items.push_back(it);
  2127. perf_max.write[i] = 0;
  2128. }
  2129. info_message = memnew(Label);
  2130. info_message->set_text(TTR("Pick one or more items from the list to display the graph."));
  2131. info_message->set_valign(Label::VALIGN_CENTER);
  2132. info_message->set_align(Label::ALIGN_CENTER);
  2133. info_message->set_autowrap(true);
  2134. info_message->set_custom_minimum_size(Size2(100 * EDSCALE, 0));
  2135. info_message->set_anchors_and_margins_preset(PRESET_WIDE, PRESET_MODE_KEEP_SIZE, 8 * EDSCALE);
  2136. perf_draw->add_child(info_message);
  2137. }
  2138. { //vmem inspect
  2139. VBoxContainer *vmem_vb = memnew(VBoxContainer);
  2140. HBoxContainer *vmem_hb = memnew(HBoxContainer);
  2141. Label *vmlb = memnew(Label(TTR("List of Video Memory Usage by Resource:") + " "));
  2142. vmlb->set_h_size_flags(SIZE_EXPAND_FILL);
  2143. vmem_hb->add_child(vmlb);
  2144. vmem_hb->add_child(memnew(Label(TTR("Total:") + " ")));
  2145. vmem_total = memnew(LineEdit);
  2146. vmem_total->set_editable(false);
  2147. vmem_total->set_custom_minimum_size(Size2(100, 0) * EDSCALE);
  2148. vmem_hb->add_child(vmem_total);
  2149. vmem_refresh = memnew(ToolButton);
  2150. vmem_refresh->set_disabled(true);
  2151. vmem_hb->add_child(vmem_refresh);
  2152. vmem_export = memnew(ToolButton);
  2153. vmem_export->set_tooltip(TTR("Export list to a CSV file"));
  2154. vmem_hb->add_child(vmem_export);
  2155. vmem_vb->add_child(vmem_hb);
  2156. vmem_refresh->connect("pressed", this, "_video_mem_request");
  2157. vmem_export->connect("pressed", this, "_video_mem_export");
  2158. VBoxContainer *vmmc = memnew(VBoxContainer);
  2159. vmem_tree = memnew(Tree);
  2160. vmem_tree->set_v_size_flags(SIZE_EXPAND_FILL);
  2161. vmem_tree->set_h_size_flags(SIZE_EXPAND_FILL);
  2162. vmmc->add_child(vmem_tree);
  2163. vmmc->set_v_size_flags(SIZE_EXPAND_FILL);
  2164. vmem_vb->add_child(vmmc);
  2165. vmem_vb->set_name(TTR("Video RAM"));
  2166. vmem_tree->set_columns(4);
  2167. vmem_tree->set_column_titles_visible(true);
  2168. vmem_tree->set_column_title(0, TTR("Resource Path"));
  2169. vmem_tree->set_column_expand(0, true);
  2170. vmem_tree->set_column_expand(1, false);
  2171. vmem_tree->set_column_title(1, TTR("Type"));
  2172. vmem_tree->set_column_min_width(1, 100 * EDSCALE);
  2173. vmem_tree->set_column_expand(2, false);
  2174. vmem_tree->set_column_title(2, TTR("Format"));
  2175. vmem_tree->set_column_min_width(2, 150 * EDSCALE);
  2176. vmem_tree->set_column_expand(3, false);
  2177. vmem_tree->set_column_title(3, TTR("Usage"));
  2178. vmem_tree->set_column_min_width(3, 80 * EDSCALE);
  2179. vmem_tree->set_hide_root(true);
  2180. tabs->add_child(vmem_vb);
  2181. }
  2182. { // misc
  2183. VBoxContainer *misc = memnew(VBoxContainer);
  2184. misc->set_name(TTR("Misc"));
  2185. tabs->add_child(misc);
  2186. GridContainer *info_left = memnew(GridContainer);
  2187. info_left->set_columns(2);
  2188. misc->add_child(info_left);
  2189. clicked_ctrl = memnew(LineEdit);
  2190. clicked_ctrl->set_h_size_flags(SIZE_EXPAND_FILL);
  2191. info_left->add_child(memnew(Label(TTR("Clicked Control:"))));
  2192. info_left->add_child(clicked_ctrl);
  2193. clicked_ctrl_type = memnew(LineEdit);
  2194. info_left->add_child(memnew(Label(TTR("Clicked Control Type:"))));
  2195. info_left->add_child(clicked_ctrl_type);
  2196. live_edit_root = memnew(LineEdit);
  2197. live_edit_root->set_h_size_flags(SIZE_EXPAND_FILL);
  2198. {
  2199. HBoxContainer *lehb = memnew(HBoxContainer);
  2200. Label *l = memnew(Label(TTR("Live Edit Root:")));
  2201. info_left->add_child(l);
  2202. lehb->add_child(live_edit_root);
  2203. le_set = memnew(Button(TTR("Set From Tree")));
  2204. lehb->add_child(le_set);
  2205. le_clear = memnew(Button(TTR("Clear")));
  2206. lehb->add_child(le_clear);
  2207. info_left->add_child(lehb);
  2208. le_set->set_disabled(true);
  2209. le_clear->set_disabled(true);
  2210. }
  2211. misc->add_child(memnew(VSeparator));
  2212. HBoxContainer *buttons = memnew(HBoxContainer);
  2213. export_csv = memnew(Button(TTR("Export measures as CSV")));
  2214. export_csv->connect("pressed", this, "_export_csv");
  2215. buttons->add_child(export_csv);
  2216. misc->add_child(buttons);
  2217. }
  2218. msgdialog = memnew(AcceptDialog);
  2219. add_child(msgdialog);
  2220. p_editor->get_undo_redo()->set_method_notify_callback(_method_changeds, this);
  2221. p_editor->get_undo_redo()->set_property_notify_callback(_property_changeds, this);
  2222. live_debug = true;
  2223. camera_override = OVERRIDE_NONE;
  2224. last_path_id = false;
  2225. error_count = 0;
  2226. warning_count = 0;
  2227. hide_on_stop = true;
  2228. enable_external_editor = false;
  2229. last_error_count = 0;
  2230. last_warning_count = 0;
  2231. EditorNode::get_singleton()->get_pause_button()->connect("pressed", this, "_paused");
  2232. }
  2233. ScriptEditorDebugger::~ScriptEditorDebugger() {
  2234. memdelete(variables);
  2235. ppeer->set_stream_peer(Ref<StreamPeer>());
  2236. server->stop();
  2237. _clear_remote_objects();
  2238. }