script_editor_debugger.cpp 34 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400
  1. /*************************************************************************/
  2. /* script_editor_debugger.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* http://www.godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2015 Juan Linietsky, Ariel Manzur. */
  9. /* */
  10. /* Permission is hereby granted, free of charge, to any person obtaining */
  11. /* a copy of this software and associated documentation files (the */
  12. /* "Software"), to deal in the Software without restriction, including */
  13. /* without limitation the rights to use, copy, modify, merge, publish, */
  14. /* distribute, sublicense, and/or sell copies of the Software, and to */
  15. /* permit persons to whom the Software is furnished to do so, subject to */
  16. /* the following conditions: */
  17. /* */
  18. /* The above copyright notice and this permission notice shall be */
  19. /* included in all copies or substantial portions of the Software. */
  20. /* */
  21. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  22. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  23. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  24. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  25. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  26. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  27. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  28. /*************************************************************************/
  29. #include "script_editor_debugger.h"
  30. #include "scene/gui/separator.h"
  31. #include "scene/gui/label.h"
  32. #include "scene/gui/split_container.h"
  33. #include "scene/gui/tree.h"
  34. #include "scene/gui/texture_button.h"
  35. #include "scene/gui/tab_container.h"
  36. #include "scene/gui/line_edit.h"
  37. #include "scene/gui/dialogs.h"
  38. #include "scene/gui/rich_text_label.h"
  39. #include "scene/gui/margin_container.h"
  40. #include "property_editor.h"
  41. #include "globals.h"
  42. #include "editor_node.h"
  43. #include "main/performance.h"
  44. class ScriptEditorDebuggerVariables : public Object {
  45. OBJ_TYPE( ScriptEditorDebuggerVariables, Object );
  46. List<PropertyInfo> props;
  47. Map<StringName,Variant> values;
  48. protected:
  49. bool _set(const StringName& p_name, const Variant& p_value) {
  50. return false;
  51. }
  52. bool _get(const StringName& p_name,Variant &r_ret) const {
  53. if (!values.has(p_name))
  54. return false;
  55. r_ret=values[p_name];
  56. return true;
  57. }
  58. void _get_property_list( List<PropertyInfo> *p_list) const {
  59. for(const List<PropertyInfo>::Element *E=props.front();E;E=E->next() )
  60. p_list->push_back(E->get());
  61. }
  62. public:
  63. void clear() {
  64. props.clear();
  65. values.clear();
  66. }
  67. String get_var_value(const String& p_var) const {
  68. for(Map<StringName,Variant>::Element *E=values.front();E;E=E->next()) {
  69. String v = E->key().operator String().get_slice("/",1);
  70. if (v==p_var)
  71. return E->get();
  72. }
  73. return "";
  74. }
  75. void add_property(const String &p_name, const Variant& p_value) {
  76. PropertyInfo pinfo;
  77. pinfo.name=p_name;
  78. pinfo.type=p_value.get_type();
  79. props.push_back(pinfo);
  80. values[p_name]=p_value;
  81. }
  82. void update() {
  83. _change_notify();
  84. }
  85. ScriptEditorDebuggerVariables() {
  86. }
  87. };
  88. void ScriptEditorDebugger::debug_next() {
  89. ERR_FAIL_COND(!breaked);
  90. ERR_FAIL_COND(connection.is_null());
  91. ERR_FAIL_COND(!connection->is_connected());
  92. Array msg;
  93. msg.push_back("next");
  94. ppeer->put_var(msg);
  95. stack_dump->clear();
  96. inspector->edit(NULL);
  97. }
  98. void ScriptEditorDebugger::debug_step() {
  99. ERR_FAIL_COND(!breaked);
  100. ERR_FAIL_COND(connection.is_null());
  101. ERR_FAIL_COND(!connection->is_connected());
  102. Array msg;
  103. msg.push_back("step");
  104. ppeer->put_var(msg);
  105. stack_dump->clear();
  106. inspector->edit(NULL);
  107. }
  108. void ScriptEditorDebugger::debug_break() {
  109. ERR_FAIL_COND(breaked);
  110. ERR_FAIL_COND(connection.is_null());
  111. ERR_FAIL_COND(!connection->is_connected());
  112. Array msg;
  113. msg.push_back("break");
  114. ppeer->put_var(msg);
  115. }
  116. void ScriptEditorDebugger::debug_continue() {
  117. ERR_FAIL_COND(!breaked);
  118. ERR_FAIL_COND(connection.is_null());
  119. ERR_FAIL_COND(!connection->is_connected());
  120. Array msg;
  121. msg.push_back("continue");
  122. ppeer->put_var(msg);
  123. }
  124. void ScriptEditorDebugger::_scene_tree_request() {
  125. ERR_FAIL_COND(connection.is_null());
  126. ERR_FAIL_COND(!connection->is_connected());
  127. Array msg;
  128. msg.push_back("request_scene_tree");
  129. ppeer->put_var(msg);
  130. }
  131. Size2 ScriptEditorDebugger::get_minimum_size() const {
  132. Size2 ms = Control::get_minimum_size();
  133. ms.y = MAX(ms.y , 250 );
  134. return ms;
  135. }
  136. void ScriptEditorDebugger::_parse_message(const String& p_msg,const Array& p_data) {
  137. if (p_msg=="debug_enter") {
  138. Array msg;
  139. msg.push_back("get_stack_dump");
  140. ppeer->put_var(msg);
  141. ERR_FAIL_COND(p_data.size()!=2);
  142. bool can_continue=p_data[0];
  143. String error = p_data[1];
  144. step->set_disabled(!can_continue);
  145. next->set_disabled(!can_continue);
  146. reason->set_text(error);
  147. reason->set_tooltip(error);
  148. breaked=true;
  149. dobreak->set_disabled(true);
  150. docontinue->set_disabled(false);
  151. emit_signal("breaked",true,can_continue);
  152. OS::get_singleton()->move_window_to_foreground();
  153. tabs->set_current_tab(0);
  154. } else if (p_msg=="debug_exit") {
  155. breaked=false;
  156. step->set_disabled(true);
  157. next->set_disabled(true);
  158. reason->set_text("");
  159. reason->set_tooltip("");
  160. back->set_disabled(true);
  161. forward->set_disabled(true);
  162. dobreak->set_disabled(false);
  163. docontinue->set_disabled(true);
  164. emit_signal("breaked",false,false);
  165. //tabs->set_current_tab(0);
  166. } else if (p_msg=="message:click_ctrl") {
  167. clicked_ctrl->set_text(p_data[0]);
  168. clicked_ctrl_type->set_text(p_data[1]);
  169. } else if (p_msg=="message:scene_tree") {
  170. scene_tree->clear();
  171. Map<int,TreeItem*> lv;
  172. for(int i=0;i<p_data.size();i+=3) {
  173. TreeItem *p;
  174. int level = p_data[i];
  175. if (level==0) {
  176. p = NULL;
  177. } else {
  178. ERR_CONTINUE(!lv.has(level-1));
  179. p=lv[level-1];
  180. }
  181. TreeItem *it = scene_tree->create_item(p);
  182. it->set_text(0,p_data[i+1]);
  183. if (has_icon(p_data[i+2],"EditorIcons"))
  184. it->set_icon(0,get_icon(p_data[i+2],"EditorIcons"));
  185. lv[level]=it;
  186. }
  187. le_clear->set_disabled(false);
  188. le_set->set_disabled(false);
  189. } else if (p_msg=="stack_dump") {
  190. stack_dump->clear();
  191. TreeItem *r = stack_dump->create_item();
  192. for(int i=0;i<p_data.size();i++) {
  193. Dictionary d = p_data[i];
  194. ERR_CONTINUE(!d.has("function"));
  195. ERR_CONTINUE(!d.has("file"));
  196. ERR_CONTINUE(!d.has("line"));
  197. ERR_CONTINUE(!d.has("id"));
  198. TreeItem *s = stack_dump->create_item(r);
  199. d["frame"]=i;
  200. s->set_metadata(0,d);
  201. // String line = itos(i)+" - "+String(d["file"])+":"+itos(d["line"])+" - at func: "+d["function"];
  202. String line = itos(i)+" - "+String(d["file"])+":"+itos(d["line"]);
  203. s->set_text(0,line);
  204. if (i==0)
  205. s->select(0);
  206. }
  207. } else if (p_msg=="stack_frame_vars") {
  208. variables->clear();
  209. int ofs =0;
  210. int mcount = p_data[ofs];
  211. ofs++;
  212. for(int i=0;i<mcount;i++) {
  213. String n = p_data[ofs+i*2+0];
  214. Variant v = p_data[ofs+i*2+1];
  215. if (n.begins_with("*")) {
  216. n=n.substr(1,n.length());
  217. }
  218. variables->add_property("members/"+n,v);
  219. }
  220. ofs+=mcount*2;
  221. mcount = p_data[ofs];
  222. ofs++;
  223. for(int i=0;i<mcount;i++) {
  224. String n = p_data[ofs+i*2+0];
  225. Variant v = p_data[ofs+i*2+1];
  226. if (n.begins_with("*")) {
  227. n=n.substr(1,n.length());
  228. }
  229. variables->add_property("locals/"+n,v);
  230. }
  231. variables->update();
  232. inspector->edit(variables);
  233. } else if (p_msg=="output") {
  234. //OUT
  235. for(int i=0;i<p_data.size();i++) {
  236. String t = p_data[i];
  237. //LOG
  238. if (EditorNode::get_log()->is_hidden()) {
  239. log_forced_visible=true;
  240. EditorNode::get_log()->show();
  241. }
  242. EditorNode::get_log()->add_message(t);
  243. }
  244. } else if (p_msg=="performance") {
  245. Array arr = p_data[0];
  246. Vector<float> p;
  247. p.resize(arr.size());
  248. for(int i=0;i<arr.size();i++) {
  249. p[i]=arr[i];
  250. if (i<perf_items.size()) {
  251. perf_items[i]->set_text(1,rtos(p[i]));
  252. if (p[i]>perf_max[i])
  253. perf_max[i]=p[i];
  254. }
  255. }
  256. perf_history.push_front(p);
  257. perf_draw->update();
  258. } else if (p_msg=="error") {
  259. Array err = p_data[0];
  260. Array vals;
  261. vals.push_back(err[0]);
  262. vals.push_back(err[1]);
  263. vals.push_back(err[2]);
  264. vals.push_back(err[3]);
  265. bool warning = err[9];
  266. bool e;
  267. String time = String("%d:%02d:%02d:%04d").sprintf(vals,&e);
  268. String txt=time+" - "+String(err[8]);
  269. String tooltip="Type:"+String(warning?"Warning":"Error");
  270. tooltip+="\nDescription: "+String(err[8]);
  271. tooltip+="\nTime: "+time;
  272. tooltip+="\nC Error: "+String(err[7]);
  273. tooltip+="\nC Source: "+String(err[5])+":"+String(err[6]);
  274. tooltip+="\nC Function: "+String(err[4]);
  275. error_list->add_item(txt,EditorNode::get_singleton()->get_gui_base()->get_icon(warning?"Warning":"Error","EditorIcons"));
  276. error_list->set_item_tooltip( error_list->get_item_count() -1,tooltip );
  277. int scc = p_data[1];
  278. Array stack;
  279. stack.resize(scc);
  280. for(int i=0;i<scc;i++) {
  281. stack[i]=p_data[2+i];
  282. }
  283. error_list->set_item_metadata( error_list->get_item_count() -1,stack );
  284. error_count++;
  285. /*
  286. int count = p_data[1];
  287. Array cstack;
  288. OutputError oe = errors.front()->get();
  289. packet_peer_stream->put_var(oe.hr);
  290. packet_peer_stream->put_var(oe.min);
  291. packet_peer_stream->put_var(oe.sec);
  292. packet_peer_stream->put_var(oe.msec);
  293. packet_peer_stream->put_var(oe.source_func);
  294. packet_peer_stream->put_var(oe.source_file);
  295. packet_peer_stream->put_var(oe.source_line);
  296. packet_peer_stream->put_var(oe.error);
  297. packet_peer_stream->put_var(oe.error_descr);
  298. packet_peer_stream->put_var(oe.warning);
  299. packet_peer_stream->put_var(oe.callstack);
  300. */
  301. } else if (p_msg=="kill_me") {
  302. editor->call_deferred("stop_child_process");
  303. }
  304. }
  305. void ScriptEditorDebugger::_performance_select(Object*,int,bool) {
  306. perf_draw->update();
  307. }
  308. void ScriptEditorDebugger::_performance_draw() {
  309. Vector<int> which;
  310. for(int i=0;i<perf_items.size();i++) {
  311. if (perf_items[i]->is_selected(0))
  312. which.push_back(i);
  313. }
  314. if(which.empty())
  315. return;
  316. Color graph_color=get_color("font_color","TextEdit");
  317. Ref<StyleBox> graph_sb = get_stylebox("normal","TextEdit");
  318. Ref<Font> graph_font = get_font("font","TextEdit");
  319. int cols = Math::ceil(Math::sqrt(which.size()));
  320. int rows = (which.size()+1)/cols;
  321. if (which.size()==1)
  322. rows=1;
  323. int margin =3;
  324. int point_sep=5;
  325. Size2i s = Size2i(perf_draw->get_size())/Size2i(cols,rows);
  326. for(int i=0;i<which.size();i++) {
  327. Point2i p(i%cols,i/cols);
  328. Rect2i r(p*s,s);
  329. r.pos+=Point2(margin,margin);
  330. r.size-=Point2(margin,margin)*2.0;
  331. perf_draw->draw_style_box(graph_sb,r);
  332. r.pos+=graph_sb->get_offset();
  333. r.size-=graph_sb->get_minimum_size();
  334. int pi=which[i];
  335. Color c = Color(0.7,0.9,0.5);
  336. c.set_hsv(Math::fmod(c.get_h()+pi*0.7654,1),c.get_s(),c.get_v());
  337. c.a=0.8;
  338. perf_draw->draw_string(graph_font,r.pos+Point2(0,graph_font->get_ascent()),perf_items[pi]->get_text(0),c,r.size.x);
  339. c.a=0.6;
  340. perf_draw->draw_string(graph_font,r.pos+Point2(graph_font->get_char_size('X').width,graph_font->get_ascent()+graph_font->get_height()),perf_items[pi]->get_text(1),c,r.size.y);
  341. float spacing=point_sep/float(cols);
  342. float from = r.size.width;
  343. List<Vector<float> >::Element *E=perf_history.front();
  344. float prev=-1;
  345. while(from>=0 && E) {
  346. float m = perf_max[pi];
  347. if (m==0)
  348. m=0.00001;
  349. float h = E->get()[pi]/m;
  350. h=(1.0-h)*r.size.y;
  351. c.a=0.7;
  352. if (E!=perf_history.front())
  353. perf_draw->draw_line(r.pos+Point2(from,h),r.pos+Point2(from+spacing,prev),c,2.0);
  354. prev=h;
  355. E=E->next();
  356. from-=spacing;
  357. }
  358. }
  359. }
  360. void ScriptEditorDebugger::_notification(int p_what) {
  361. switch(p_what) {
  362. case NOTIFICATION_ENTER_TREE: {
  363. step->set_icon( get_icon("DebugStep","EditorIcons"));
  364. next->set_icon( get_icon("DebugNext","EditorIcons"));
  365. back->set_icon( get_icon("Back","EditorIcons"));
  366. forward->set_icon( get_icon("Forward","EditorIcons"));
  367. dobreak->set_icon( get_icon("Pause","EditorIcons"));
  368. docontinue->set_icon( get_icon("DebugContinue","EditorIcons"));
  369. tb->set_normal_texture( get_icon("Close","EditorIcons"));
  370. tb->set_hover_texture( get_icon("CloseHover","EditorIcons"));
  371. tb->set_pressed_texture( get_icon("Close","EditorIcons"));
  372. scene_tree_refresh->set_icon( get_icon("Reload","EditorIcons"));
  373. le_set->connect("pressed",this,"_live_edit_set");
  374. le_clear->connect("pressed",this,"_live_edit_clear");
  375. error_list->connect("item_selected",this,"_error_selected");
  376. error_stack->connect("item_selected",this,"_error_stack_selected");
  377. } break;
  378. case NOTIFICATION_PROCESS: {
  379. if (error_count!=last_error_count) {
  380. if (error_count==0) {
  381. error_split->set_name("Errors");
  382. } else {
  383. error_split->set_name("Errors ("+itos(error_count)+")");
  384. }
  385. last_error_count=error_count;
  386. }
  387. if (connection.is_null()) {
  388. if (server->is_connection_available()) {
  389. connection = server->take_connection();
  390. if (connection.is_null())
  391. break;
  392. EditorNode::get_log()->add_message("** Debug Process Started **");
  393. log_forced_visible=false;
  394. ppeer->set_stream_peer(connection);
  395. show();
  396. dobreak->set_disabled(false);
  397. tabs->set_current_tab(0);
  398. emit_signal("show_debugger",true);
  399. reason->set_text("Child Process Connected");
  400. reason->set_tooltip("Child Process Connected");
  401. scene_tree->clear();
  402. le_set->set_disabled(true);
  403. le_clear->set_disabled(false);
  404. error_list->clear();
  405. error_stack->clear();
  406. error_count=0;
  407. //live_edit_root->set_text("/root");
  408. update_live_edit_root();
  409. } else {
  410. break;
  411. }
  412. };
  413. if (!connection->is_connected()) {
  414. stop();
  415. editor->notify_child_process_exited(); //somehow, exited
  416. break;
  417. };
  418. if (ppeer->get_available_packet_count() <= 0) {
  419. break;
  420. };
  421. while(ppeer->get_available_packet_count() > 0) {
  422. if (pending_in_queue) {
  423. int todo = MIN( ppeer->get_available_packet_count(), pending_in_queue );
  424. for(int i=0;i<todo;i++) {
  425. Variant cmd;
  426. Error ret = ppeer->get_var(cmd);
  427. if (ret!=OK) {
  428. stop();
  429. ERR_FAIL_COND(ret!=OK);
  430. }
  431. message.push_back(cmd);
  432. pending_in_queue--;
  433. }
  434. if (pending_in_queue==0) {
  435. _parse_message(message_type,message);
  436. message.clear();
  437. }
  438. } else {
  439. if (ppeer->get_available_packet_count()>=2) {
  440. Variant cmd;
  441. Error ret = ppeer->get_var(cmd);
  442. if (ret!=OK) {
  443. stop();
  444. ERR_FAIL_COND(ret!=OK);
  445. }
  446. if (cmd.get_type()!=Variant::STRING) {
  447. stop();
  448. ERR_FAIL_COND(cmd.get_type()!=Variant::STRING);
  449. }
  450. message_type=cmd;
  451. ret = ppeer->get_var(cmd);
  452. if (ret!=OK) {
  453. stop();
  454. ERR_FAIL_COND(ret!=OK);
  455. }
  456. if (cmd.get_type()!=Variant::INT) {
  457. stop();
  458. ERR_FAIL_COND(cmd.get_type()!=Variant::INT);
  459. }
  460. pending_in_queue=cmd;
  461. if (pending_in_queue==0) {
  462. _parse_message(message_type,Array());
  463. message.clear();
  464. }
  465. } else {
  466. break;
  467. }
  468. }
  469. }
  470. } break;
  471. }
  472. }
  473. void ScriptEditorDebugger::start() {
  474. stop();
  475. uint16_t port = GLOBAL_DEF("debug/remote_port",6007);
  476. perf_history.clear();
  477. for(int i=0;i<Performance::MONITOR_MAX;i++) {
  478. perf_max[i]=0;
  479. }
  480. server->listen(port);
  481. set_process(true);
  482. }
  483. void ScriptEditorDebugger::pause(){
  484. }
  485. void ScriptEditorDebugger::unpause(){
  486. }
  487. void ScriptEditorDebugger::stop(){
  488. set_process(false);
  489. server->stop();
  490. ppeer->set_stream_peer(Ref<StreamPeer>());
  491. if (connection.is_valid()) {
  492. EditorNode::get_log()->add_message("** Debug Process Stopped **");
  493. connection.unref();
  494. }
  495. pending_in_queue=0;
  496. message.clear();
  497. if (log_forced_visible) {
  498. EditorNode::get_log()->hide();
  499. log_forced_visible=false;
  500. }
  501. node_path_cache.clear();
  502. res_path_cache.clear();
  503. le_clear->set_disabled(false);
  504. le_set->set_disabled(true);
  505. hide();
  506. emit_signal("show_debugger",false);
  507. }
  508. void ScriptEditorDebugger::_stack_dump_frame_selected() {
  509. TreeItem *ti = stack_dump->get_selected();
  510. if (!ti)
  511. return;
  512. Dictionary d = ti->get_metadata(0);
  513. Ref<Script> s = ResourceLoader::load(d["file"]);
  514. emit_signal("goto_script_line",s,int(d["line"])-1);
  515. ERR_FAIL_COND(connection.is_null());
  516. ERR_FAIL_COND(!connection->is_connected());
  517. ///
  518. Array msg;
  519. msg.push_back("get_stack_frame_vars");
  520. msg.push_back(d["frame"]);
  521. ppeer->put_var(msg);
  522. }
  523. void ScriptEditorDebugger::_hide_request() {
  524. hide();
  525. emit_signal("show_debugger",false);
  526. }
  527. void ScriptEditorDebugger::_output_clear() {
  528. //output->clear();
  529. //output->push_color(Color(0,0,0));
  530. }
  531. String ScriptEditorDebugger::get_var_value(const String& p_var) const {
  532. if (!breaked)
  533. return String();
  534. return variables->get_var_value(p_var);
  535. }
  536. int ScriptEditorDebugger::_get_node_path_cache(const NodePath& p_path) {
  537. const int *r = node_path_cache.getptr(p_path);
  538. if (r)
  539. return *r;
  540. last_path_id++;
  541. node_path_cache[p_path]=last_path_id;
  542. Array msg;
  543. msg.push_back("live_node_path");
  544. msg.push_back(p_path);
  545. msg.push_back(last_path_id);
  546. ppeer->put_var(msg);
  547. return last_path_id;
  548. }
  549. int ScriptEditorDebugger::_get_res_path_cache(const String& p_path) {
  550. Map<String,int>::Element *E=res_path_cache.find(p_path);
  551. if (E)
  552. return E->get();
  553. last_path_id++;
  554. res_path_cache[p_path]=last_path_id;
  555. Array msg;
  556. msg.push_back("live_res_path");
  557. msg.push_back(p_path);
  558. msg.push_back(last_path_id);
  559. ppeer->put_var(msg);
  560. return last_path_id;
  561. }
  562. void ScriptEditorDebugger::_method_changed(Object*p_base,const StringName& p_name,VARIANT_ARG_DECLARE) {
  563. if (!p_base || !live_debug || !connection.is_valid() || !editor->get_edited_scene())
  564. return;
  565. Node *node = p_base->cast_to<Node>();
  566. VARIANT_ARGPTRS
  567. for(int i=0;i<VARIANT_ARG_MAX;i++) {
  568. //no pointers, sorry
  569. if (argptr[i] && (argptr[i]->get_type()==Variant::OBJECT || argptr[i]->get_type()==Variant::_RID))
  570. return;
  571. }
  572. if (node) {
  573. NodePath path = editor->get_edited_scene()->get_path_to(node);
  574. int pathid = _get_node_path_cache(path);
  575. Array msg;
  576. msg.push_back("live_node_call");
  577. msg.push_back(pathid);
  578. msg.push_back(p_name);
  579. for(int i=0;i<VARIANT_ARG_MAX;i++) {
  580. //no pointers, sorry
  581. msg.push_back(*argptr[i]);
  582. }
  583. ppeer->put_var(msg);
  584. return;
  585. }
  586. Resource *res = p_base->cast_to<Resource>();
  587. if (res && res->get_path()!=String()) {
  588. String respath = res->get_path();
  589. int pathid = _get_res_path_cache(respath);
  590. Array msg;
  591. msg.push_back("live_res_call");
  592. msg.push_back(pathid);
  593. msg.push_back(p_name);
  594. for(int i=0;i<VARIANT_ARG_MAX;i++) {
  595. //no pointers, sorry
  596. msg.push_back(*argptr[i]);
  597. }
  598. ppeer->put_var(msg);
  599. return;
  600. }
  601. //print_line("method");
  602. }
  603. void ScriptEditorDebugger::_property_changed(Object*p_base,const StringName& p_property,const Variant& p_value){
  604. if (!p_base || !live_debug || !connection.is_valid() || !editor->get_edited_scene())
  605. return;
  606. Node *node = p_base->cast_to<Node>();
  607. if (node) {
  608. NodePath path = editor->get_edited_scene()->get_path_to(node);
  609. int pathid = _get_node_path_cache(path);
  610. if (p_value.is_ref()) {
  611. Ref<Resource> res = p_value;
  612. if (res.is_valid() && res->get_path()!=String()) {
  613. Array msg;
  614. msg.push_back("live_node_prop_res");
  615. msg.push_back(pathid);
  616. msg.push_back(p_property);
  617. msg.push_back(res->get_path());
  618. ppeer->put_var(msg);
  619. }
  620. } else {
  621. Array msg;
  622. msg.push_back("live_node_prop");
  623. msg.push_back(pathid);
  624. msg.push_back(p_property);
  625. msg.push_back(p_value);
  626. ppeer->put_var(msg);
  627. }
  628. return;
  629. }
  630. Resource *res = p_base->cast_to<Resource>();
  631. if (res && res->get_path()!=String()) {
  632. String respath = res->get_path();
  633. int pathid = _get_res_path_cache(respath);
  634. if (p_value.is_ref()) {
  635. Ref<Resource> res = p_value;
  636. if (res.is_valid() && res->get_path()!=String()) {
  637. Array msg;
  638. msg.push_back("live_res_prop_res");
  639. msg.push_back(pathid);
  640. msg.push_back(p_property);
  641. msg.push_back(res->get_path());
  642. ppeer->put_var(msg);
  643. }
  644. } else {
  645. Array msg;
  646. msg.push_back("live_res_prop");
  647. msg.push_back(pathid);
  648. msg.push_back(p_property);
  649. msg.push_back(p_value);
  650. ppeer->put_var(msg);
  651. }
  652. return;
  653. }
  654. //print_line("prop");
  655. }
  656. void ScriptEditorDebugger::_method_changeds(void *p_ud,Object*p_base,const StringName& p_name,VARIANT_ARG_DECLARE) {
  657. ScriptEditorDebugger *sed = (ScriptEditorDebugger*)p_ud;
  658. sed->_method_changed(p_base,p_name,VARIANT_ARG_PASS);
  659. }
  660. void ScriptEditorDebugger::_property_changeds(void *p_ud,Object*p_base,const StringName& p_property,const Variant& p_value){
  661. ScriptEditorDebugger *sed = (ScriptEditorDebugger*)p_ud;
  662. sed->_property_changed(p_base,p_property,p_value);
  663. }
  664. void ScriptEditorDebugger::set_live_debugging(bool p_enable) {
  665. live_debug=p_enable;
  666. }
  667. void ScriptEditorDebugger::_live_edit_set() {
  668. if (!connection.is_valid())
  669. return;
  670. TreeItem* ti = scene_tree->get_selected();
  671. if (!ti)
  672. return;
  673. String path;
  674. while(ti) {
  675. String lp=ti->get_text(0);
  676. path="/"+lp+path;
  677. ti=ti->get_parent();
  678. }
  679. NodePath np = path;
  680. editor->get_editor_data().set_edited_scene_live_edit_root(np);
  681. update_live_edit_root();
  682. }
  683. void ScriptEditorDebugger::_live_edit_clear() {
  684. NodePath np = NodePath("/root");
  685. editor->get_editor_data().set_edited_scene_live_edit_root(np);
  686. update_live_edit_root();
  687. }
  688. void ScriptEditorDebugger::update_live_edit_root() {
  689. NodePath np = editor->get_editor_data().get_edited_scene_live_edit_root();
  690. if (connection.is_valid()) {
  691. Array msg;
  692. msg.push_back("live_set_root");
  693. msg.push_back(np);
  694. if (editor->get_edited_scene())
  695. msg.push_back(editor->get_edited_scene()->get_filename());
  696. else
  697. msg.push_back("");
  698. ppeer->put_var(msg);
  699. }
  700. live_edit_root->set_text(np);
  701. }
  702. void ScriptEditorDebugger::live_debug_create_node(const NodePath& p_parent,const String& p_type,const String& p_name) {
  703. if (live_debug && connection.is_valid()) {
  704. Array msg;
  705. msg.push_back("live_create_node");
  706. msg.push_back(p_parent);
  707. msg.push_back(p_type);
  708. msg.push_back(p_name);
  709. ppeer->put_var(msg);
  710. }
  711. }
  712. void ScriptEditorDebugger::live_debug_instance_node(const NodePath& p_parent,const String& p_path,const String& p_name){
  713. if (live_debug && connection.is_valid()) {
  714. Array msg;
  715. msg.push_back("live_instance_node");
  716. msg.push_back(p_parent);
  717. msg.push_back(p_path);
  718. msg.push_back(p_name);
  719. ppeer->put_var(msg);
  720. }
  721. }
  722. void ScriptEditorDebugger::live_debug_remove_node(const NodePath& p_at){
  723. if (live_debug && connection.is_valid()) {
  724. Array msg;
  725. msg.push_back("live_remove_node");
  726. msg.push_back(p_at);
  727. ppeer->put_var(msg);
  728. }
  729. }
  730. void ScriptEditorDebugger::live_debug_remove_and_keep_node(const NodePath& p_at,ObjectID p_keep_id) {
  731. if (live_debug && connection.is_valid()) {
  732. Array msg;
  733. msg.push_back("live_remove_and_keep_node");
  734. msg.push_back(p_at);
  735. msg.push_back(p_keep_id);
  736. ppeer->put_var(msg);
  737. }
  738. }
  739. void ScriptEditorDebugger::live_debug_restore_node(ObjectID p_id, const NodePath& p_at, int p_at_pos){
  740. if (live_debug && connection.is_valid()) {
  741. Array msg;
  742. msg.push_back("live_restore_node");
  743. msg.push_back(p_id);
  744. msg.push_back(p_at);
  745. msg.push_back(p_at_pos);
  746. ppeer->put_var(msg);
  747. }
  748. }
  749. void ScriptEditorDebugger::live_debug_duplicate_node(const NodePath& p_at,const String& p_new_name){
  750. if (live_debug && connection.is_valid()) {
  751. Array msg;
  752. msg.push_back("live_duplicate_node");
  753. msg.push_back(p_at);
  754. msg.push_back(p_new_name);
  755. ppeer->put_var(msg);
  756. }
  757. }
  758. void ScriptEditorDebugger::live_debug_reparent_node(const NodePath& p_at, const NodePath& p_new_place, const String &p_new_name, int p_at_pos){
  759. if (live_debug && connection.is_valid()) {
  760. Array msg;
  761. msg.push_back("live_reparent_node");
  762. msg.push_back(p_at);
  763. msg.push_back(p_new_place);
  764. msg.push_back(p_new_name);
  765. msg.push_back(p_at_pos);
  766. ppeer->put_var(msg);
  767. }
  768. }
  769. void ScriptEditorDebugger::set_breakpoint(const String& p_path,int p_line,bool p_enabled) {
  770. if (connection.is_valid()) {
  771. Array msg;
  772. msg.push_back("breakpoint");
  773. msg.push_back(p_path);
  774. msg.push_back(p_line);
  775. msg.push_back(p_enabled);
  776. ppeer->put_var(msg);
  777. }
  778. }
  779. void ScriptEditorDebugger::_error_selected(int p_idx) {
  780. error_stack->clear();
  781. Array st=error_list->get_item_metadata(p_idx);
  782. for(int i=0;i<st.size();i+=2) {
  783. String script=st[i];
  784. int line=st[i+1];
  785. Array md;
  786. md.push_back(st[i]);
  787. md.push_back(st[i+1]);
  788. String str = script.get_file()+":"+itos(line);
  789. error_stack->add_item(str);
  790. error_stack->set_item_metadata(error_stack->get_item_count()-1,md);
  791. error_stack->set_item_tooltip(error_stack->get_item_count()-1,"File: "+String(st[i])+"\nLine: "+itos(line));
  792. }
  793. }
  794. void ScriptEditorDebugger:: _error_stack_selected(int p_idx){
  795. Array arr = error_stack->get_item_metadata(p_idx);
  796. if (arr.size()!=2)
  797. return;
  798. Ref<Script> s = ResourceLoader::load(arr[0]);
  799. emit_signal("goto_script_line",s,int(arr[1])-1);
  800. }
  801. void ScriptEditorDebugger::_bind_methods() {
  802. ObjectTypeDB::bind_method(_MD("_stack_dump_frame_selected"),&ScriptEditorDebugger::_stack_dump_frame_selected);
  803. ObjectTypeDB::bind_method(_MD("debug_next"),&ScriptEditorDebugger::debug_next);
  804. ObjectTypeDB::bind_method(_MD("debug_step"),&ScriptEditorDebugger::debug_step);
  805. ObjectTypeDB::bind_method(_MD("debug_break"),&ScriptEditorDebugger::debug_break);
  806. ObjectTypeDB::bind_method(_MD("debug_continue"),&ScriptEditorDebugger::debug_continue);
  807. ObjectTypeDB::bind_method(_MD("_output_clear"),&ScriptEditorDebugger::_output_clear);
  808. ObjectTypeDB::bind_method(_MD("_hide_request"),&ScriptEditorDebugger::_hide_request);
  809. ObjectTypeDB::bind_method(_MD("_performance_draw"),&ScriptEditorDebugger::_performance_draw);
  810. ObjectTypeDB::bind_method(_MD("_performance_select"),&ScriptEditorDebugger::_performance_select);
  811. ObjectTypeDB::bind_method(_MD("_scene_tree_request"),&ScriptEditorDebugger::_scene_tree_request);
  812. ObjectTypeDB::bind_method(_MD("_live_edit_set"),&ScriptEditorDebugger::_live_edit_set);
  813. ObjectTypeDB::bind_method(_MD("_live_edit_clear"),&ScriptEditorDebugger::_live_edit_clear);
  814. ObjectTypeDB::bind_method(_MD("_error_selected"),&ScriptEditorDebugger::_error_selected);
  815. ObjectTypeDB::bind_method(_MD("_error_stack_selected"),&ScriptEditorDebugger::_error_stack_selected);
  816. ObjectTypeDB::bind_method(_MD("live_debug_create_node"),&ScriptEditorDebugger::live_debug_create_node);
  817. ObjectTypeDB::bind_method(_MD("live_debug_instance_node"),&ScriptEditorDebugger::live_debug_instance_node);
  818. ObjectTypeDB::bind_method(_MD("live_debug_remove_node"),&ScriptEditorDebugger::live_debug_remove_node);
  819. ObjectTypeDB::bind_method(_MD("live_debug_remove_and_keep_node"),&ScriptEditorDebugger::live_debug_remove_and_keep_node);
  820. ObjectTypeDB::bind_method(_MD("live_debug_restore_node"),&ScriptEditorDebugger::live_debug_restore_node);
  821. ObjectTypeDB::bind_method(_MD("live_debug_duplicate_node"),&ScriptEditorDebugger::live_debug_duplicate_node);
  822. ObjectTypeDB::bind_method(_MD("live_debug_reparent_node"),&ScriptEditorDebugger::live_debug_reparent_node);
  823. ADD_SIGNAL(MethodInfo("goto_script_line"));
  824. ADD_SIGNAL(MethodInfo("breaked",PropertyInfo(Variant::BOOL,"reallydid")));
  825. ADD_SIGNAL(MethodInfo("show_debugger",PropertyInfo(Variant::BOOL,"reallydid")));
  826. }
  827. ScriptEditorDebugger::ScriptEditorDebugger(EditorNode *p_editor){
  828. ppeer = Ref<PacketPeerStream>( memnew( PacketPeerStream ) );
  829. editor=p_editor;
  830. tabs = memnew( TabContainer );
  831. tabs->set_v_size_flags(SIZE_EXPAND_FILL);
  832. tabs->set_area_as_parent_rect();
  833. add_child(tabs);
  834. tb = memnew( TextureButton );
  835. tb->connect("pressed",this,"_hide_request");
  836. tb->set_anchor_and_margin(MARGIN_LEFT,ANCHOR_END,20);
  837. tb->set_margin(MARGIN_TOP,2);
  838. add_child(tb);
  839. VBoxContainer *vbc = memnew( VBoxContainer );
  840. vbc->set_name("Debugger");
  841. //tabs->add_child(vbc);
  842. Control *dbg=vbc;
  843. HBoxContainer *hbc = memnew( HBoxContainer );
  844. vbc->add_child(hbc);
  845. reason = memnew( Label );
  846. reason->set_text("");
  847. hbc->add_child(reason);
  848. reason->add_color_override("font_color",Color(1,0.4,0.0,0.8));
  849. reason->set_h_size_flags(SIZE_EXPAND_FILL);
  850. reason->set_clip_text(true);
  851. hbc->add_child( memnew( VSeparator) );
  852. step = memnew( Button );
  853. hbc->add_child(step);
  854. step->set_tooltip("Step Into");
  855. step->connect("pressed",this,"debug_step");
  856. next = memnew( Button );
  857. hbc->add_child(next);
  858. next->set_tooltip("Step Over");
  859. next->connect("pressed",this,"debug_next");
  860. hbc->add_child( memnew( VSeparator) );
  861. dobreak = memnew( Button );
  862. hbc->add_child(dobreak);
  863. dobreak->set_tooltip("Break");
  864. dobreak->connect("pressed",this,"debug_break");
  865. docontinue = memnew( Button );
  866. hbc->add_child(docontinue);
  867. docontinue->set_tooltip("Continue");
  868. docontinue->connect("pressed",this,"debug_continue");
  869. hbc->add_child( memnew( VSeparator) );
  870. back = memnew( Button );
  871. hbc->add_child(back);
  872. back->set_tooltip("Inspect Previous Instance");
  873. forward = memnew( Button );
  874. hbc->add_child(forward);
  875. back->set_tooltip("Inspect Next Instance");
  876. HSplitContainer *sc = memnew( HSplitContainer );
  877. vbc->add_child(sc);
  878. sc->set_v_size_flags(SIZE_EXPAND_FILL);
  879. stack_dump = memnew( Tree );
  880. stack_dump->set_columns(1);
  881. stack_dump->set_column_titles_visible(true);
  882. stack_dump->set_column_title(0,"Stack Frames");
  883. stack_dump->set_h_size_flags(SIZE_EXPAND_FILL);
  884. stack_dump->set_hide_root(true);
  885. stack_dump->connect("cell_selected",this,"_stack_dump_frame_selected");
  886. sc->add_child(stack_dump);
  887. inspector = memnew( PropertyEditor );
  888. inspector->set_h_size_flags(SIZE_EXPAND_FILL);
  889. inspector->hide_top_label();
  890. inspector->get_scene_tree()->set_column_title(0,"Variable");
  891. inspector->set_capitalize_paths(false);
  892. inspector->set_read_only(true);
  893. sc->add_child(inspector);
  894. server = TCP_Server::create_ref();
  895. pending_in_queue=0;
  896. variables = memnew( ScriptEditorDebuggerVariables );
  897. inspector->edit(variables);
  898. breaked=false;
  899. tabs->add_child(dbg);
  900. //tabs->move_child(vbc,0);
  901. hbc = memnew( HBoxContainer );
  902. vbc->add_child(hbc);
  903. error_split = memnew( HSplitContainer );
  904. VBoxContainer *errvb = memnew( VBoxContainer );
  905. errvb->set_h_size_flags(SIZE_EXPAND_FILL);
  906. error_list = memnew( ItemList );
  907. errvb->add_margin_child("Errors:",error_list,true);
  908. error_split->add_child(errvb);
  909. errvb = memnew( VBoxContainer );
  910. errvb->set_h_size_flags(SIZE_EXPAND_FILL);
  911. error_stack = memnew( ItemList );
  912. errvb->add_margin_child("Stack Trace (if applies):",error_stack,true);
  913. error_split->add_child(errvb);
  914. error_split->set_name("Errors");
  915. tabs->add_child(error_split);
  916. HSplitContainer *hsp = memnew( HSplitContainer );
  917. perf_monitors = memnew(Tree);
  918. perf_monitors->set_columns(2);
  919. perf_monitors->set_column_title(0,"Monitor");
  920. perf_monitors->set_column_title(1,"Value");
  921. perf_monitors->set_column_titles_visible(true);
  922. hsp->add_child(perf_monitors);
  923. perf_monitors->set_select_mode(Tree::SELECT_MULTI);
  924. perf_monitors->connect("multi_selected",this,"_performance_select");
  925. perf_draw = memnew( Control );
  926. perf_draw->connect("draw",this,"_performance_draw");
  927. hsp->add_child(perf_draw);
  928. hsp->set_name("Performance");
  929. hsp->set_split_offset(300);
  930. tabs->add_child(hsp);
  931. perf_max.resize(Performance::MONITOR_MAX);
  932. Map<String,TreeItem*> bases;
  933. TreeItem *root=perf_monitors->create_item();
  934. perf_monitors->set_hide_root(true);
  935. for(int i=0;i<Performance::MONITOR_MAX;i++) {
  936. String n = Performance::get_singleton()->get_monitor_name(Performance::Monitor(i));
  937. String base = n.get_slice("/",0);
  938. String name = n.get_slice("/",1);
  939. if (!bases.has(base)) {
  940. TreeItem *b = perf_monitors->create_item(root);
  941. b->set_text(0,base.capitalize());
  942. b->set_editable(0,false);
  943. b->set_selectable(0,false);
  944. bases[base]=b;
  945. }
  946. TreeItem *it = perf_monitors->create_item(bases[base]);
  947. it->set_editable(0,false);
  948. it->set_selectable(0,true);
  949. it->set_text(0,name.capitalize());
  950. perf_items.push_back(it);
  951. perf_max[i]=0;
  952. }
  953. info = memnew( HSplitContainer );
  954. info->set_name("Info");
  955. tabs->add_child(info);
  956. VBoxContainer *info_left = memnew( VBoxContainer );
  957. info_left->set_h_size_flags(SIZE_EXPAND_FILL);
  958. info->add_child(info_left);
  959. clicked_ctrl = memnew( LineEdit );
  960. info_left->add_margin_child("Clicked Control:",clicked_ctrl);
  961. clicked_ctrl_type = memnew( LineEdit );
  962. info_left->add_margin_child("Clicked Control Type:",clicked_ctrl_type);
  963. live_edit_root = memnew( LineEdit );
  964. {
  965. HBoxContainer *lehb = memnew( HBoxContainer );
  966. Label *l = memnew( Label("Live Edit Root:") );
  967. lehb->add_child(l);
  968. l->set_h_size_flags(SIZE_EXPAND_FILL);
  969. le_set = memnew( Button("Set From Tree") );
  970. lehb->add_child(le_set);
  971. le_clear = memnew( Button("Clear") );
  972. lehb->add_child(le_clear);
  973. info_left->add_child(lehb);
  974. MarginContainer *mc = memnew( MarginContainer );
  975. mc->add_child(live_edit_root);
  976. info_left->add_child(mc);
  977. le_set->set_disabled(true);
  978. le_clear->set_disabled(true);
  979. }
  980. VBoxContainer *info_right = memnew(VBoxContainer);
  981. info_right->set_h_size_flags(SIZE_EXPAND_FILL);
  982. info->add_child(info_right);
  983. HBoxContainer *inforhb = memnew( HBoxContainer );
  984. info_right->add_child(inforhb);
  985. Label *l2 = memnew( Label("Scene Tree:" ) );
  986. l2->set_h_size_flags(SIZE_EXPAND_FILL);
  987. inforhb->add_child( l2 );
  988. Button *refresh = memnew( Button );
  989. inforhb->add_child(refresh);
  990. refresh->connect("pressed",this,"_scene_tree_request");
  991. scene_tree_refresh=refresh;
  992. MarginContainer *infomc = memnew( MarginContainer );
  993. info_right->add_child(infomc);
  994. infomc->set_v_size_flags(SIZE_EXPAND_FILL);
  995. scene_tree = memnew( Tree );
  996. infomc->add_child(scene_tree);
  997. msgdialog = memnew( AcceptDialog );
  998. add_child(msgdialog);
  999. hide();
  1000. log_forced_visible=false;
  1001. p_editor->get_undo_redo()->set_method_notify_callback(_method_changeds,this);
  1002. p_editor->get_undo_redo()->set_property_notify_callback(_property_changeds,this);
  1003. live_debug=false;
  1004. last_path_id=false;
  1005. error_count=0;
  1006. last_error_count=0;
  1007. }
  1008. ScriptEditorDebugger::~ScriptEditorDebugger() {
  1009. // inspector->edit(NULL);
  1010. memdelete(variables);
  1011. ppeer->set_stream_peer(Ref<StreamPeer>());
  1012. server->stop();
  1013. }