script_editor_debugger.cpp 86 KB

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