script_editor_debugger.cpp 69 KB

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