script_editor_plugin.cpp 87 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878
  1. /*************************************************************************/
  2. /* script_editor_plugin.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2017 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_plugin.h"
  31. #include "core/io/resource_loader.h"
  32. #include "core/io/resource_saver.h"
  33. #include "core/os/file_access.h"
  34. #include "core/os/input.h"
  35. #include "core/os/keyboard.h"
  36. #include "core/os/os.h"
  37. #include "core/project_settings.h"
  38. #include "editor/editor_node.h"
  39. #include "editor/editor_settings.h"
  40. #include "editor/node_dock.h"
  41. #include "editor/script_editor_debugger.h"
  42. #include "scene/main/viewport.h"
  43. /*** SCRIPT EDITOR ****/
  44. void ScriptEditorBase::_bind_methods() {
  45. ADD_SIGNAL(MethodInfo("name_changed"));
  46. ADD_SIGNAL(MethodInfo("edited_script_changed"));
  47. ADD_SIGNAL(MethodInfo("request_help_search", PropertyInfo(Variant::STRING, "topic")));
  48. ADD_SIGNAL(MethodInfo("request_help_index"));
  49. ADD_SIGNAL(MethodInfo("request_open_script_at_line", PropertyInfo(Variant::OBJECT, "script"), PropertyInfo(Variant::INT, "line")));
  50. ADD_SIGNAL(MethodInfo("request_save_history"));
  51. ADD_SIGNAL(MethodInfo("go_to_help", PropertyInfo(Variant::STRING, "what")));
  52. }
  53. static bool _can_open_in_editor(Script *p_script) {
  54. String path = p_script->get_path();
  55. if (path.find("::") != -1) {
  56. //refuse handling this if it can't be edited
  57. bool valid = false;
  58. for (int i = 0; i < EditorNode::get_singleton()->get_editor_data().get_edited_scene_count(); i++) {
  59. if (path.begins_with(EditorNode::get_singleton()->get_editor_data().get_scene_path(i))) {
  60. valid = true;
  61. break;
  62. }
  63. }
  64. return valid;
  65. }
  66. return true;
  67. }
  68. class EditorScriptCodeCompletionCache : public ScriptCodeCompletionCache {
  69. struct Cache {
  70. uint64_t time_loaded;
  71. RES cache;
  72. };
  73. Map<String, Cache> cached;
  74. public:
  75. uint64_t max_time_cache;
  76. int max_cache_size;
  77. void cleanup() {
  78. List<Map<String, Cache>::Element *> to_clean;
  79. Map<String, Cache>::Element *I = cached.front();
  80. while (I) {
  81. if ((OS::get_singleton()->get_ticks_msec() - I->get().time_loaded) > max_time_cache) {
  82. to_clean.push_back(I);
  83. }
  84. I = I->next();
  85. }
  86. while (to_clean.front()) {
  87. cached.erase(to_clean.front()->get());
  88. to_clean.pop_front();
  89. }
  90. }
  91. RES get_cached_resource(const String &p_path) {
  92. Map<String, Cache>::Element *E = cached.find(p_path);
  93. if (!E) {
  94. Cache c;
  95. c.cache = ResourceLoader::load(p_path);
  96. E = cached.insert(p_path, c);
  97. }
  98. E->get().time_loaded = OS::get_singleton()->get_ticks_msec();
  99. if (cached.size() > max_cache_size) {
  100. uint64_t older;
  101. Map<String, Cache>::Element *O = cached.front();
  102. older = O->get().time_loaded;
  103. Map<String, Cache>::Element *I = O;
  104. while (I) {
  105. if (I->get().time_loaded < older) {
  106. older = I->get().time_loaded;
  107. O = I;
  108. }
  109. I = I->next();
  110. }
  111. if (O != E) { //should never heppane..
  112. cached.erase(O);
  113. }
  114. }
  115. return E->get().cache;
  116. }
  117. EditorScriptCodeCompletionCache() {
  118. max_cache_size = 128;
  119. max_time_cache = 5 * 60 * 1000; //minutes, five
  120. }
  121. };
  122. #define SORT_SCRIPT_LIST
  123. void ScriptEditorQuickOpen::popup(const Vector<String> &p_functions, bool p_dontclear) {
  124. popup_centered_ratio(0.6);
  125. if (p_dontclear)
  126. search_box->select_all();
  127. else
  128. search_box->clear();
  129. search_box->grab_focus();
  130. functions = p_functions;
  131. _update_search();
  132. }
  133. void ScriptEditorQuickOpen::_text_changed(const String &p_newtext) {
  134. _update_search();
  135. }
  136. void ScriptEditorQuickOpen::_sbox_input(const Ref<InputEvent> &p_ie) {
  137. Ref<InputEventKey> k = p_ie;
  138. if (k.is_valid() && (k->get_scancode() == KEY_UP ||
  139. k->get_scancode() == KEY_DOWN ||
  140. k->get_scancode() == KEY_PAGEUP ||
  141. k->get_scancode() == KEY_PAGEDOWN)) {
  142. search_options->call("_gui_input", k);
  143. search_box->accept_event();
  144. }
  145. }
  146. void ScriptEditorQuickOpen::_update_search() {
  147. search_options->clear();
  148. TreeItem *root = search_options->create_item();
  149. for (int i = 0; i < functions.size(); i++) {
  150. String file = functions[i];
  151. if ((search_box->get_text() == "" || file.findn(search_box->get_text()) != -1)) {
  152. TreeItem *ti = search_options->create_item(root);
  153. ti->set_text(0, file);
  154. if (root->get_children() == ti)
  155. ti->select(0);
  156. }
  157. }
  158. get_ok()->set_disabled(root->get_children() == NULL);
  159. }
  160. void ScriptEditorQuickOpen::_confirmed() {
  161. TreeItem *ti = search_options->get_selected();
  162. if (!ti)
  163. return;
  164. int line = ti->get_text(0).get_slice(":", 1).to_int();
  165. emit_signal("goto_line", line - 1);
  166. hide();
  167. }
  168. void ScriptEditorQuickOpen::_notification(int p_what) {
  169. switch (p_what) {
  170. case NOTIFICATION_ENTER_TREE: {
  171. connect("confirmed", this, "_confirmed");
  172. } break;
  173. }
  174. }
  175. void ScriptEditorQuickOpen::_bind_methods() {
  176. ClassDB::bind_method(D_METHOD("_text_changed"), &ScriptEditorQuickOpen::_text_changed);
  177. ClassDB::bind_method(D_METHOD("_confirmed"), &ScriptEditorQuickOpen::_confirmed);
  178. ClassDB::bind_method(D_METHOD("_sbox_input"), &ScriptEditorQuickOpen::_sbox_input);
  179. ADD_SIGNAL(MethodInfo("goto_line", PropertyInfo(Variant::INT, "line")));
  180. }
  181. ScriptEditorQuickOpen::ScriptEditorQuickOpen() {
  182. VBoxContainer *vbc = memnew(VBoxContainer);
  183. add_child(vbc);
  184. //set_child_rect(vbc);
  185. search_box = memnew(LineEdit);
  186. vbc->add_margin_child(TTR("Search:"), search_box);
  187. search_box->connect("text_changed", this, "_text_changed");
  188. search_box->connect("gui_input", this, "_sbox_input");
  189. search_options = memnew(Tree);
  190. vbc->add_margin_child(TTR("Matches:"), search_options, true);
  191. get_ok()->set_text(TTR("Open"));
  192. get_ok()->set_disabled(true);
  193. register_text_enter(search_box);
  194. set_hide_on_ok(false);
  195. search_options->connect("item_activated", this, "_confirmed");
  196. search_options->set_hide_root(true);
  197. }
  198. /////////////////////////////////
  199. ScriptEditor *ScriptEditor::script_editor = NULL;
  200. /*** SCRIPT EDITOR ******/
  201. String ScriptEditor::_get_debug_tooltip(const String &p_text, Node *_se) {
  202. //ScriptEditorBase *se=Object::cast_to<ScriptEditorBase>(_se);
  203. String val = debugger->get_var_value(p_text);
  204. if (val != String()) {
  205. return p_text + ": " + val;
  206. } else {
  207. return String();
  208. }
  209. }
  210. void ScriptEditor::_breaked(bool p_breaked, bool p_can_debug) {
  211. if (bool(EditorSettings::get_singleton()->get("text_editor/external/use_external_editor"))) {
  212. return;
  213. }
  214. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_NEXT), !(p_breaked && p_can_debug));
  215. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_STEP), !(p_breaked && p_can_debug));
  216. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_BREAK), p_breaked);
  217. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_CONTINUE), !p_breaked);
  218. for (int i = 0; i < tab_container->get_child_count(); i++) {
  219. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  220. if (!se) {
  221. continue;
  222. }
  223. se->set_debugger_active(p_breaked);
  224. }
  225. }
  226. void ScriptEditor::_show_debugger(bool p_show) {
  227. //debug_menu->get_popup()->set_item_checked( debug_menu->get_popup()->get_item_index(DEBUG_SHOW), p_show);
  228. }
  229. void ScriptEditor::_script_created(Ref<Script> p_script) {
  230. editor->push_item(p_script.operator->());
  231. }
  232. void ScriptEditor::_goto_script_line2(int p_line) {
  233. int selected = tab_container->get_current_tab();
  234. if (selected < 0 || selected >= tab_container->get_child_count())
  235. return;
  236. ScriptEditorBase *current = Object::cast_to<ScriptEditorBase>(tab_container->get_child(selected));
  237. if (!current)
  238. return;
  239. current->goto_line(p_line);
  240. }
  241. void ScriptEditor::_goto_script_line(REF p_script, int p_line) {
  242. editor->push_item(p_script.ptr());
  243. if (bool(EditorSettings::get_singleton()->get("text_editor/external/use_external_editor"))) {
  244. Ref<Script> script = Object::cast_to<Script>(*p_script);
  245. if (!script.is_null() && script->get_path().is_resource_file())
  246. edit(p_script, p_line, 0);
  247. }
  248. int selected = tab_container->get_current_tab();
  249. if (selected < 0 || selected >= tab_container->get_child_count())
  250. return;
  251. ScriptEditorBase *current = Object::cast_to<ScriptEditorBase>(tab_container->get_child(selected));
  252. if (!current)
  253. return;
  254. current->goto_line(p_line, true);
  255. }
  256. void ScriptEditor::_update_history_arrows() {
  257. script_back->set_disabled(history_pos <= 0);
  258. script_forward->set_disabled(history_pos >= history.size() - 1);
  259. }
  260. void ScriptEditor::_save_history() {
  261. if (history_pos >= 0 && history_pos < history.size() && history[history_pos].control == tab_container->get_current_tab_control()) {
  262. Node *n = tab_container->get_current_tab_control();
  263. if (Object::cast_to<ScriptEditorBase>(n)) {
  264. history[history_pos].state = Object::cast_to<ScriptEditorBase>(n)->get_edit_state();
  265. }
  266. if (Object::cast_to<EditorHelp>(n)) {
  267. history[history_pos].state = Object::cast_to<EditorHelp>(n)->get_scroll();
  268. }
  269. }
  270. history.resize(history_pos + 1);
  271. ScriptHistory sh;
  272. sh.control = tab_container->get_current_tab_control();
  273. sh.state = Variant();
  274. history.push_back(sh);
  275. history_pos++;
  276. _update_history_arrows();
  277. }
  278. void ScriptEditor::_go_to_tab(int p_idx) {
  279. Control *c = Object::cast_to<Control>(tab_container->get_child(p_idx));
  280. if (!c)
  281. return;
  282. if (history_pos >= 0 && history_pos < history.size() && history[history_pos].control == tab_container->get_current_tab_control()) {
  283. Node *n = tab_container->get_current_tab_control();
  284. if (Object::cast_to<ScriptEditorBase>(n)) {
  285. history[history_pos].state = Object::cast_to<ScriptEditorBase>(n)->get_edit_state();
  286. }
  287. if (Object::cast_to<EditorHelp>(n)) {
  288. history[history_pos].state = Object::cast_to<EditorHelp>(n)->get_scroll();
  289. }
  290. }
  291. history.resize(history_pos + 1);
  292. ScriptHistory sh;
  293. sh.control = c;
  294. sh.state = Variant();
  295. history.push_back(sh);
  296. history_pos++;
  297. tab_container->set_current_tab(p_idx);
  298. c = tab_container->get_current_tab_control();
  299. if (Object::cast_to<ScriptEditorBase>(c)) {
  300. script_name_label->set_text(Object::cast_to<ScriptEditorBase>(c)->get_name());
  301. script_icon->set_texture(Object::cast_to<ScriptEditorBase>(c)->get_icon());
  302. if (is_visible_in_tree())
  303. Object::cast_to<ScriptEditorBase>(c)->ensure_focus();
  304. notify_script_changed(Object::cast_to<ScriptEditorBase>(c)->get_edited_script());
  305. }
  306. if (Object::cast_to<EditorHelp>(c)) {
  307. script_name_label->set_text(Object::cast_to<EditorHelp>(c)->get_class());
  308. script_icon->set_texture(get_icon("Help", "EditorIcons"));
  309. if (is_visible_in_tree())
  310. Object::cast_to<EditorHelp>(c)->set_focused();
  311. }
  312. c->set_meta("__editor_pass", ++edit_pass);
  313. _update_history_arrows();
  314. _update_script_colors();
  315. _update_members_overview();
  316. _update_help_overview();
  317. _update_selected_editor_menu();
  318. _update_members_overview_visibility();
  319. _update_help_overview_visibility();
  320. }
  321. void ScriptEditor::_add_recent_script(String p_path) {
  322. if (p_path.empty()) {
  323. return;
  324. }
  325. // remove if already stored
  326. int already_recent = previous_scripts.find(p_path);
  327. if (already_recent >= 0) {
  328. previous_scripts.remove(already_recent);
  329. }
  330. // add to list
  331. previous_scripts.insert(0, p_path);
  332. _update_recent_scripts();
  333. }
  334. void ScriptEditor::_update_recent_scripts() {
  335. // make sure we don't exceed max size
  336. const int max_history = EDITOR_DEF("text_editor/files/maximum_recent_files", 20);
  337. if (previous_scripts.size() > max_history) {
  338. previous_scripts.resize(max_history);
  339. }
  340. recent_scripts->clear();
  341. recent_scripts->add_shortcut(ED_SHORTCUT("script_editor/open_recent", TTR("Open Recent"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_T));
  342. recent_scripts->add_separator();
  343. const int max_shown = 8;
  344. for (int i = 0; i < previous_scripts.size() && i <= max_shown; i++) {
  345. String path = previous_scripts.get(i);
  346. // just show script name and last dir
  347. recent_scripts->add_item(path.get_slice("/", path.get_slice_count("/") - 2) + "/" + path.get_file());
  348. }
  349. recent_scripts->add_separator();
  350. recent_scripts->add_shortcut(ED_SHORTCUT("script_editor/clear_recent", TTR("Clear Recent Files")));
  351. recent_scripts->set_as_minsize();
  352. }
  353. void ScriptEditor::_open_recent_script(int p_idx) {
  354. // clear button
  355. if (p_idx == recent_scripts->get_item_count() - 1) {
  356. previous_scripts.clear();
  357. call_deferred("_update_recent_scripts");
  358. return;
  359. }
  360. // take two for the open recent button
  361. if (p_idx > 0) {
  362. p_idx -= 2;
  363. }
  364. if (p_idx < previous_scripts.size() && p_idx >= 0) {
  365. String path = previous_scripts.get(p_idx);
  366. // if its not on disk its a help file or deleted
  367. if (FileAccess::exists(path)) {
  368. Ref<Script> script = ResourceLoader::load(path);
  369. if (script.is_valid()) {
  370. edit(script, true);
  371. }
  372. // if it's a path then its most likely a delted file not help
  373. } else if (!path.is_resource_file()) {
  374. _help_class_open(path);
  375. }
  376. previous_scripts.remove(p_idx);
  377. _update_recent_scripts();
  378. }
  379. }
  380. void ScriptEditor::_close_tab(int p_idx, bool p_save) {
  381. int selected = p_idx;
  382. if (selected < 0 || selected >= tab_container->get_child_count())
  383. return;
  384. Node *tselected = tab_container->get_child(selected);
  385. ScriptEditorBase *current = Object::cast_to<ScriptEditorBase>(tab_container->get_child(selected));
  386. if (current) {
  387. _add_recent_script(current->get_edited_script()->get_path());
  388. if (p_save) {
  389. apply_scripts();
  390. }
  391. current->clear_edit_menu();
  392. notify_script_close(current->get_edited_script());
  393. } else {
  394. EditorHelp *help = Object::cast_to<EditorHelp>(tab_container->get_child(selected));
  395. _add_recent_script(help->get_class());
  396. }
  397. // roll back to previous tab
  398. _history_back();
  399. //remove from history
  400. history.resize(history_pos + 1);
  401. for (int i = 0; i < history.size(); i++) {
  402. if (history[i].control == tselected) {
  403. history.remove(i);
  404. i--;
  405. history_pos--;
  406. }
  407. }
  408. if (history_pos >= history.size()) {
  409. history_pos = history.size() - 1;
  410. }
  411. int idx = tab_container->get_current_tab();
  412. memdelete(tselected);
  413. if (idx >= tab_container->get_child_count())
  414. idx = tab_container->get_child_count() - 1;
  415. if (idx >= 0) {
  416. if (history_pos >= 0) {
  417. idx = history[history_pos].control->get_index();
  418. }
  419. tab_container->set_current_tab(idx);
  420. //script_list->select(idx);
  421. }
  422. _update_history_arrows();
  423. _update_script_names();
  424. _update_members_overview_visibility();
  425. _update_help_overview_visibility();
  426. _save_layout();
  427. }
  428. void ScriptEditor::_close_current_tab() {
  429. _close_tab(tab_container->get_current_tab());
  430. }
  431. void ScriptEditor::_close_discard_current_tab(const String &p_str) {
  432. _close_tab(tab_container->get_current_tab(), false);
  433. erase_tab_confirm->hide();
  434. }
  435. void ScriptEditor::_close_docs_tab() {
  436. int child_count = tab_container->get_child_count();
  437. for (int i = child_count - 1; i >= 0; i--) {
  438. EditorHelp *se = Object::cast_to<EditorHelp>(tab_container->get_child(i));
  439. if (se) {
  440. _close_tab(i);
  441. }
  442. }
  443. }
  444. void ScriptEditor::_close_all_tabs() {
  445. int child_count = tab_container->get_child_count();
  446. for (int i = child_count - 1; i >= 0; i--) {
  447. tab_container->set_current_tab(i);
  448. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  449. if (se) {
  450. // Maybe there are unsaved changes
  451. if (se->is_unsaved()) {
  452. _ask_close_current_unsaved_tab(se);
  453. continue;
  454. }
  455. }
  456. _close_current_tab();
  457. }
  458. }
  459. void ScriptEditor::_ask_close_current_unsaved_tab(ScriptEditorBase *current) {
  460. erase_tab_confirm->set_text(TTR("Close and save changes?\n\"") + current->get_name() + "\"");
  461. erase_tab_confirm->popup_centered_minsize();
  462. }
  463. void ScriptEditor::_resave_scripts(const String &p_str) {
  464. apply_scripts();
  465. for (int i = 0; i < tab_container->get_child_count(); i++) {
  466. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  467. if (!se)
  468. continue;
  469. Ref<Script> script = se->get_edited_script();
  470. if (script->get_path() == "" || script->get_path().find("local://") != -1 || script->get_path().find("::") != -1)
  471. continue; //internal script, who cares
  472. if (trim_trailing_whitespace_on_save) {
  473. se->trim_trailing_whitespace();
  474. }
  475. if (convert_indent_on_save) {
  476. if (use_space_indentation) {
  477. se->convert_indent_to_spaces();
  478. } else {
  479. se->convert_indent_to_tabs();
  480. }
  481. }
  482. editor->save_resource(script);
  483. se->tag_saved_version();
  484. }
  485. disk_changed->hide();
  486. }
  487. void ScriptEditor::_reload_scripts() {
  488. for (int i = 0; i < tab_container->get_child_count(); i++) {
  489. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  490. if (!se) {
  491. continue;
  492. }
  493. Ref<Script> script = se->get_edited_script();
  494. if (script->get_path() == "" || script->get_path().find("local://") != -1 || script->get_path().find("::") != -1) {
  495. continue; //internal script, who cares
  496. }
  497. uint64_t last_date = script->get_last_modified_time();
  498. uint64_t date = FileAccess::get_modified_time(script->get_path());
  499. //printf("last date: %lli vs date: %lli\n",last_date,date);
  500. if (last_date == date) {
  501. continue;
  502. }
  503. Ref<Script> rel_script = ResourceLoader::load(script->get_path(), script->get_class(), true);
  504. ERR_CONTINUE(!rel_script.is_valid());
  505. script->set_source_code(rel_script->get_source_code());
  506. script->set_last_modified_time(rel_script->get_last_modified_time());
  507. script->reload();
  508. se->reload_text();
  509. }
  510. disk_changed->hide();
  511. _update_script_names();
  512. }
  513. void ScriptEditor::_res_saved_callback(const Ref<Resource> &p_res) {
  514. for (int i = 0; i < tab_container->get_child_count(); i++) {
  515. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  516. if (!se) {
  517. continue;
  518. }
  519. Ref<Script> script = se->get_edited_script();
  520. if (script->get_path() == "" || script->get_path().find("local://") != -1 || script->get_path().find("::") != -1) {
  521. continue; //internal script, who cares
  522. }
  523. if (script == p_res) {
  524. se->tag_saved_version();
  525. }
  526. }
  527. _update_script_names();
  528. if (!pending_auto_reload && auto_reload_running_scripts) {
  529. call_deferred("_live_auto_reload_running_scripts");
  530. pending_auto_reload = true;
  531. }
  532. }
  533. void ScriptEditor::_live_auto_reload_running_scripts() {
  534. pending_auto_reload = false;
  535. debugger->reload_scripts();
  536. }
  537. bool ScriptEditor::_test_script_times_on_disk(Ref<Script> p_for_script) {
  538. disk_changed_list->clear();
  539. TreeItem *r = disk_changed_list->create_item();
  540. disk_changed_list->set_hide_root(true);
  541. bool need_ask = false;
  542. bool need_reload = false;
  543. bool use_autoreload = bool(EDITOR_DEF("text_editor/files/auto_reload_scripts_on_external_change", false));
  544. for (int i = 0; i < tab_container->get_child_count(); i++) {
  545. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  546. if (se) {
  547. Ref<Script> script = se->get_edited_script();
  548. if (p_for_script.is_valid() && p_for_script != script)
  549. continue;
  550. if (script->get_path() == "" || script->get_path().find("local://") != -1 || script->get_path().find("::") != -1)
  551. continue; //internal script, who cares
  552. uint64_t last_date = script->get_last_modified_time();
  553. uint64_t date = FileAccess::get_modified_time(script->get_path());
  554. //printf("last date: %lli vs date: %lli\n",last_date,date);
  555. if (last_date != date) {
  556. TreeItem *ti = disk_changed_list->create_item(r);
  557. ti->set_text(0, script->get_path().get_file());
  558. if (!use_autoreload || se->is_unsaved()) {
  559. need_ask = true;
  560. }
  561. need_reload = true;
  562. //r->set_metadata(0,);
  563. }
  564. }
  565. }
  566. if (need_reload) {
  567. if (!need_ask) {
  568. script_editor->_reload_scripts();
  569. need_reload = false;
  570. } else {
  571. disk_changed->call_deferred("popup_centered_ratio", 0.5);
  572. }
  573. }
  574. return need_reload;
  575. }
  576. void ScriptEditor::_file_dialog_action(String p_file) {
  577. switch (file_dialog_option) {
  578. case FILE_SAVE_THEME_AS: {
  579. if (!EditorSettings::get_singleton()->save_text_editor_theme_as(p_file)) {
  580. editor->show_warning(TTR("Error while saving theme"), TTR("Error saving"));
  581. }
  582. } break;
  583. case FILE_IMPORT_THEME: {
  584. if (!EditorSettings::get_singleton()->import_text_editor_theme(p_file)) {
  585. editor->show_warning(TTR("Error importing theme"), TTR("Error importing"));
  586. }
  587. } break;
  588. }
  589. file_dialog_option = -1;
  590. }
  591. Ref<Script> ScriptEditor::_get_current_script() {
  592. int selected = tab_container->get_current_tab();
  593. if (selected < 0 || selected >= tab_container->get_child_count())
  594. return NULL;
  595. ScriptEditorBase *current = Object::cast_to<ScriptEditorBase>(tab_container->get_child(selected));
  596. if (current) {
  597. return current->get_edited_script();
  598. } else {
  599. return NULL;
  600. }
  601. }
  602. Array ScriptEditor::_get_open_scripts() const {
  603. Array ret;
  604. Vector<Ref<Script> > scripts = get_open_scripts();
  605. int scrits_amount = scripts.size();
  606. for (int idx_script = 0; idx_script < scrits_amount; idx_script++) {
  607. ret.push_back(scripts[idx_script]);
  608. }
  609. return ret;
  610. }
  611. void ScriptEditor::_menu_option(int p_option) {
  612. switch (p_option) {
  613. case FILE_NEW: {
  614. script_create_dialog->config("Node", ".gd");
  615. script_create_dialog->popup_centered(Size2(300, 300) * EDSCALE);
  616. } break;
  617. case FILE_OPEN: {
  618. editor->open_resource("Script");
  619. return;
  620. } break;
  621. case FILE_SAVE_ALL: {
  622. if (_test_script_times_on_disk())
  623. return;
  624. save_all_scripts();
  625. } break;
  626. case FILE_IMPORT_THEME: {
  627. file_dialog->set_mode(EditorFileDialog::MODE_OPEN_FILE);
  628. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  629. file_dialog_option = FILE_IMPORT_THEME;
  630. file_dialog->clear_filters();
  631. file_dialog->add_filter("*.tet");
  632. file_dialog->popup_centered_ratio();
  633. file_dialog->set_title(TTR("Import Theme"));
  634. } break;
  635. case FILE_RELOAD_THEME: {
  636. EditorSettings::get_singleton()->load_text_editor_theme();
  637. } break;
  638. case FILE_SAVE_THEME: {
  639. if (!EditorSettings::get_singleton()->save_text_editor_theme()) {
  640. editor->show_warning(TTR("Error while saving theme"), TTR("Error saving"));
  641. }
  642. } break;
  643. case FILE_SAVE_THEME_AS: {
  644. file_dialog->set_mode(EditorFileDialog::MODE_SAVE_FILE);
  645. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  646. file_dialog_option = FILE_SAVE_THEME_AS;
  647. file_dialog->clear_filters();
  648. file_dialog->add_filter("*.tet");
  649. file_dialog->set_current_path(EditorSettings::get_singleton()->get_settings_path() + "/text_editor_themes/" + EditorSettings::get_singleton()->get("text_editor/theme/color_theme"));
  650. file_dialog->popup_centered_ratio();
  651. file_dialog->set_title(TTR("Save Theme As.."));
  652. } break;
  653. case SEARCH_HELP: {
  654. help_search_dialog->popup();
  655. } break;
  656. case SEARCH_CLASSES: {
  657. help_index->popup();
  658. } break;
  659. case SEARCH_WEBSITE: {
  660. OS::get_singleton()->shell_open("http://docs.godotengine.org/");
  661. } break;
  662. case WINDOW_NEXT: {
  663. _history_forward();
  664. } break;
  665. case WINDOW_PREV: {
  666. _history_back();
  667. } break;
  668. case WINDOW_SORT: {
  669. _sort_list_on_update = true;
  670. _update_script_names();
  671. } break;
  672. case DEBUG_SHOW: {
  673. if (debugger) {
  674. bool visible = debug_menu->get_popup()->is_item_checked(debug_menu->get_popup()->get_item_index(DEBUG_SHOW));
  675. debug_menu->get_popup()->set_item_checked(debug_menu->get_popup()->get_item_index(DEBUG_SHOW), !visible);
  676. if (visible)
  677. debugger->hide();
  678. else
  679. debugger->show();
  680. }
  681. } break;
  682. case DEBUG_SHOW_KEEP_OPEN: {
  683. bool visible = debug_menu->get_popup()->is_item_checked(debug_menu->get_popup()->get_item_index(DEBUG_SHOW_KEEP_OPEN));
  684. if (debugger)
  685. debugger->set_hide_on_stop(visible);
  686. debug_menu->get_popup()->set_item_checked(debug_menu->get_popup()->get_item_index(DEBUG_SHOW_KEEP_OPEN), !visible);
  687. } break;
  688. case DEBUG_WITH_EXTERNAL_EDITOR: {
  689. bool debug_with_external_editor = !debug_menu->get_popup()->is_item_checked(debug_menu->get_popup()->get_item_index(DEBUG_WITH_EXTERNAL_EDITOR));
  690. debugger->set_debug_with_external_editor(debug_with_external_editor);
  691. debug_menu->get_popup()->set_item_checked(debug_menu->get_popup()->get_item_index(DEBUG_WITH_EXTERNAL_EDITOR), debug_with_external_editor);
  692. } break;
  693. case TOGGLE_SCRIPTS_PANEL: {
  694. list_split->set_visible(!list_split->is_visible());
  695. }
  696. }
  697. int selected = tab_container->get_current_tab();
  698. if (selected < 0 || selected >= tab_container->get_child_count())
  699. return;
  700. ScriptEditorBase *current = Object::cast_to<ScriptEditorBase>(tab_container->get_child(selected));
  701. if (current) {
  702. switch (p_option) {
  703. case FILE_SAVE: {
  704. if (_test_script_times_on_disk())
  705. return;
  706. if (trim_trailing_whitespace_on_save)
  707. current->trim_trailing_whitespace();
  708. if (convert_indent_on_save) {
  709. if (use_space_indentation) {
  710. current->convert_indent_to_spaces();
  711. } else {
  712. current->convert_indent_to_tabs();
  713. }
  714. }
  715. editor->save_resource(current->get_edited_script());
  716. } break;
  717. case FILE_SAVE_AS: {
  718. current->trim_trailing_whitespace();
  719. if (convert_indent_on_save) {
  720. if (use_space_indentation) {
  721. current->convert_indent_to_spaces();
  722. } else {
  723. current->convert_indent_to_tabs();
  724. }
  725. }
  726. editor->push_item(Object::cast_to<Object>(current->get_edited_script().ptr()));
  727. editor->save_resource_as(current->get_edited_script());
  728. } break;
  729. case FILE_TOOL_RELOAD:
  730. case FILE_TOOL_RELOAD_SOFT: {
  731. current->reload(p_option == FILE_TOOL_RELOAD_SOFT);
  732. } break;
  733. case FILE_RUN: {
  734. Ref<Script> scr = current->get_edited_script();
  735. if (scr.is_null()) {
  736. EditorNode::get_singleton()->show_warning("Can't obtain the script for running");
  737. break;
  738. }
  739. current->apply_code();
  740. Error err = scr->reload(false); //hard reload script before running always
  741. if (err != OK) {
  742. EditorNode::get_singleton()->show_warning("Script failed reloading, check console for errors.");
  743. return;
  744. }
  745. if (!scr->is_tool()) {
  746. EditorNode::get_singleton()->show_warning("Script is not in tool mode, will not be able to run");
  747. return;
  748. }
  749. if (!ClassDB::is_parent_class(scr->get_instance_base_type(), "EditorScript")) {
  750. EditorNode::get_singleton()->show_warning("To run this script, it must inherit EditorScript and be set to tool mode");
  751. return;
  752. }
  753. Ref<EditorScript> es = memnew(EditorScript);
  754. es->set_script(scr.get_ref_ptr());
  755. es->set_editor(EditorNode::get_singleton());
  756. es->_run();
  757. EditorNode::get_undo_redo()->clear_history();
  758. } break;
  759. case FILE_CLOSE: {
  760. if (current->is_unsaved()) {
  761. _ask_close_current_unsaved_tab(current);
  762. } else {
  763. _close_current_tab();
  764. }
  765. } break;
  766. case CLOSE_DOCS: {
  767. _close_docs_tab();
  768. } break;
  769. case CLOSE_ALL: {
  770. _close_all_tabs();
  771. } break;
  772. case DEBUG_NEXT: {
  773. if (debugger)
  774. debugger->debug_next();
  775. } break;
  776. case DEBUG_STEP: {
  777. if (debugger)
  778. debugger->debug_step();
  779. } break;
  780. case DEBUG_BREAK: {
  781. if (debugger)
  782. debugger->debug_break();
  783. } break;
  784. case DEBUG_CONTINUE: {
  785. if (debugger)
  786. debugger->debug_continue();
  787. } break;
  788. case WINDOW_MOVE_UP: {
  789. if (tab_container->get_current_tab() > 0) {
  790. tab_container->move_child(current, tab_container->get_current_tab() - 1);
  791. tab_container->set_current_tab(tab_container->get_current_tab() - 1);
  792. _update_script_names();
  793. }
  794. } break;
  795. case WINDOW_MOVE_DOWN: {
  796. if (tab_container->get_current_tab() < tab_container->get_child_count() - 1) {
  797. tab_container->move_child(current, tab_container->get_current_tab() + 1);
  798. tab_container->set_current_tab(tab_container->get_current_tab() + 1);
  799. _update_script_names();
  800. }
  801. } break;
  802. default: {
  803. if (p_option >= WINDOW_SELECT_BASE) {
  804. tab_container->set_current_tab(p_option - WINDOW_SELECT_BASE);
  805. script_list->select(p_option - WINDOW_SELECT_BASE);
  806. }
  807. }
  808. }
  809. } else {
  810. EditorHelp *help = Object::cast_to<EditorHelp>(tab_container->get_current_tab_control());
  811. if (help) {
  812. switch (p_option) {
  813. case SEARCH_CLASSES: {
  814. help_index->popup();
  815. help_index->call_deferred("select_class", help->get_class());
  816. } break;
  817. case HELP_SEARCH_FIND: {
  818. help->popup_search();
  819. } break;
  820. case HELP_SEARCH_FIND_NEXT: {
  821. help->search_again();
  822. } break;
  823. case FILE_CLOSE: {
  824. _close_current_tab();
  825. } break;
  826. case CLOSE_DOCS: {
  827. _close_docs_tab();
  828. } break;
  829. case CLOSE_ALL: {
  830. _close_all_tabs();
  831. } break;
  832. case WINDOW_MOVE_UP: {
  833. if (tab_container->get_current_tab() > 0) {
  834. tab_container->move_child(help, tab_container->get_current_tab() - 1);
  835. tab_container->set_current_tab(tab_container->get_current_tab() - 1);
  836. _update_script_names();
  837. }
  838. } break;
  839. case WINDOW_MOVE_DOWN: {
  840. if (tab_container->get_current_tab() < tab_container->get_child_count() - 1) {
  841. tab_container->move_child(help, tab_container->get_current_tab() + 1);
  842. tab_container->set_current_tab(tab_container->get_current_tab() + 1);
  843. _update_script_names();
  844. }
  845. } break;
  846. }
  847. }
  848. }
  849. }
  850. void ScriptEditor::_tab_changed(int p_which) {
  851. ensure_select_current();
  852. }
  853. void ScriptEditor::_notification(int p_what) {
  854. switch (p_what) {
  855. case NOTIFICATION_ENTER_TREE: {
  856. editor->connect("play_pressed", this, "_editor_play");
  857. editor->connect("pause_pressed", this, "_editor_pause");
  858. editor->connect("stop_pressed", this, "_editor_stop");
  859. editor->connect("script_add_function_request", this, "_add_callback");
  860. editor->connect("resource_saved", this, "_res_saved_callback");
  861. script_list->connect("item_selected", this, "_script_selected");
  862. members_overview->connect("item_selected", this, "_members_overview_selected");
  863. help_overview->connect("item_selected", this, "_help_overview_selected");
  864. script_split->connect("dragged", this, "_script_split_dragged");
  865. autosave_timer->connect("timeout", this, "_autosave_scripts");
  866. {
  867. float autosave_time = EditorSettings::get_singleton()->get("text_editor/files/autosave_interval_secs");
  868. if (autosave_time > 0) {
  869. autosave_timer->set_wait_time(autosave_time);
  870. autosave_timer->start();
  871. } else {
  872. autosave_timer->stop();
  873. }
  874. }
  875. EditorSettings::get_singleton()->connect("settings_changed", this, "_editor_settings_changed");
  876. help_search->set_icon(get_icon("HelpSearch", "EditorIcons"));
  877. site_search->set_icon(get_icon("Instance", "EditorIcons"));
  878. class_search->set_icon(get_icon("ClassList", "EditorIcons"));
  879. script_forward->set_icon(get_icon("Forward", "EditorIcons"));
  880. script_back->set_icon(get_icon("Back", "EditorIcons"));
  881. } break;
  882. case NOTIFICATION_READY: {
  883. get_tree()->connect("tree_changed", this, "_tree_changed");
  884. editor->connect("request_help", this, "_request_help");
  885. editor->connect("request_help_search", this, "_help_search");
  886. editor->connect("request_help_index", this, "_help_index");
  887. } break;
  888. case NOTIFICATION_EXIT_TREE: {
  889. editor->disconnect("play_pressed", this, "_editor_play");
  890. editor->disconnect("pause_pressed", this, "_editor_pause");
  891. editor->disconnect("stop_pressed", this, "_editor_stop");
  892. } break;
  893. case MainLoop::NOTIFICATION_WM_FOCUS_IN: {
  894. _test_script_times_on_disk();
  895. _update_modified_scripts_for_external_editor();
  896. } break;
  897. case NOTIFICATION_PROCESS: {
  898. } break;
  899. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  900. help_search->set_icon(get_icon("HelpSearch", "EditorIcons"));
  901. site_search->set_icon(get_icon("Instance", "EditorIcons"));
  902. class_search->set_icon(get_icon("ClassList", "EditorIcons"));
  903. script_forward->set_icon(get_icon("Forward", "EditorIcons"));
  904. script_back->set_icon(get_icon("Back", "EditorIcons"));
  905. recent_scripts->set_as_minsize();
  906. } break;
  907. default:
  908. break;
  909. }
  910. }
  911. bool ScriptEditor::can_take_away_focus() const {
  912. int selected = tab_container->get_current_tab();
  913. if (selected < 0 || selected >= tab_container->get_child_count())
  914. return true;
  915. ScriptEditorBase *current = Object::cast_to<ScriptEditorBase>(tab_container->get_child(selected));
  916. if (!current)
  917. return true;
  918. return current->can_lose_focus_on_node_selection();
  919. }
  920. void ScriptEditor::close_builtin_scripts_from_scene(const String &p_scene) {
  921. for (int i = 0; i < tab_container->get_child_count(); i++) {
  922. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  923. if (se) {
  924. Ref<Script> script = se->get_edited_script();
  925. if (!script.is_valid())
  926. continue;
  927. if (script->get_path().find("::") != -1 && script->get_path().begins_with(p_scene)) { //is an internal script and belongs to scene being closed
  928. _close_tab(i);
  929. i--;
  930. }
  931. }
  932. }
  933. }
  934. void ScriptEditor::edited_scene_changed() {
  935. _update_modified_scripts_for_external_editor();
  936. }
  937. void ScriptEditor::notify_script_close(const Ref<Script> &p_script) {
  938. emit_signal("script_close", p_script);
  939. }
  940. void ScriptEditor::notify_script_changed(const Ref<Script> &p_script) {
  941. emit_signal("editor_script_changed", p_script);
  942. }
  943. static const Node *_find_node_with_script(const Node *p_node, const RefPtr &p_script) {
  944. if (p_node->get_script() == p_script)
  945. return p_node;
  946. for (int i = 0; i < p_node->get_child_count(); i++) {
  947. const Node *result = _find_node_with_script(p_node->get_child(i), p_script);
  948. if (result)
  949. return result;
  950. }
  951. return NULL;
  952. }
  953. void ScriptEditor::get_breakpoints(List<String> *p_breakpoints) {
  954. for (int i = 0; i < tab_container->get_child_count(); i++) {
  955. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  956. if (!se)
  957. continue;
  958. List<int> bpoints;
  959. se->get_breakpoints(&bpoints);
  960. Ref<Script> script = se->get_edited_script();
  961. String base = script->get_path();
  962. ERR_CONTINUE(base.begins_with("local://") || base == "");
  963. for (List<int>::Element *E = bpoints.front(); E; E = E->next()) {
  964. p_breakpoints->push_back(base + ":" + itos(E->get() + 1));
  965. }
  966. }
  967. }
  968. void ScriptEditor::ensure_focus_current() {
  969. if (!is_inside_tree())
  970. return;
  971. int cidx = tab_container->get_current_tab();
  972. if (cidx < 0 || cidx >= tab_container->get_tab_count())
  973. return;
  974. Control *c = Object::cast_to<Control>(tab_container->get_child(cidx));
  975. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(c);
  976. if (!se)
  977. return;
  978. se->ensure_focus();
  979. }
  980. void ScriptEditor::_members_overview_selected(int p_idx) {
  981. Node *current = tab_container->get_child(tab_container->get_current_tab());
  982. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(current);
  983. if (!se) {
  984. return;
  985. }
  986. Dictionary state;
  987. state["scroll_position"] = members_overview->get_item_metadata(p_idx);
  988. state["column"] = 0;
  989. state["row"] = members_overview->get_item_metadata(p_idx);
  990. se->set_edit_state(state);
  991. se->ensure_focus();
  992. }
  993. void ScriptEditor::_help_overview_selected(int p_idx) {
  994. Node *current = tab_container->get_child(tab_container->get_current_tab());
  995. EditorHelp *se = Object::cast_to<EditorHelp>(current);
  996. if (!se) {
  997. return;
  998. }
  999. se->scroll_to_section(help_overview->get_item_metadata(p_idx));
  1000. }
  1001. void ScriptEditor::_script_selected(int p_idx) {
  1002. grab_focus_block = !Input::get_singleton()->is_mouse_button_pressed(1); //amazing hack, simply amazing
  1003. _go_to_tab(script_list->get_item_metadata(p_idx));
  1004. grab_focus_block = false;
  1005. }
  1006. void ScriptEditor::ensure_select_current() {
  1007. if (tab_container->get_child_count() && tab_container->get_current_tab() >= 0) {
  1008. Node *current = tab_container->get_child(tab_container->get_current_tab());
  1009. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(current);
  1010. if (se) {
  1011. Ref<Script> script = se->get_edited_script();
  1012. if (!grab_focus_block && is_visible_in_tree())
  1013. se->ensure_focus();
  1014. //edit_menu->show();
  1015. //search_menu->show();
  1016. }
  1017. EditorHelp *eh = Object::cast_to<EditorHelp>(current);
  1018. if (eh) {
  1019. //edit_menu->hide();
  1020. //search_menu->hide();
  1021. //script_search_menu->show();
  1022. }
  1023. }
  1024. _update_selected_editor_menu();
  1025. }
  1026. void ScriptEditor::_find_scripts(Node *p_base, Node *p_current, Set<Ref<Script> > &used) {
  1027. if (p_current != p_base && p_current->get_owner() != p_base)
  1028. return;
  1029. if (p_current->get_script_instance()) {
  1030. Ref<Script> scr = p_current->get_script();
  1031. if (scr.is_valid())
  1032. used.insert(scr);
  1033. }
  1034. for (int i = 0; i < p_current->get_child_count(); i++) {
  1035. _find_scripts(p_base, p_current->get_child(i), used);
  1036. }
  1037. }
  1038. struct _ScriptEditorItemData {
  1039. String name;
  1040. String sort_key;
  1041. Ref<Texture> icon;
  1042. int index;
  1043. String tooltip;
  1044. bool used;
  1045. int category;
  1046. Node *ref;
  1047. bool operator<(const _ScriptEditorItemData &id) const {
  1048. return category == id.category ? sort_key < id.sort_key : category < id.category;
  1049. }
  1050. };
  1051. void ScriptEditor::_update_members_overview_visibility() {
  1052. int selected = tab_container->get_current_tab();
  1053. if (selected < 0 || selected >= tab_container->get_child_count())
  1054. return;
  1055. Node *current = tab_container->get_child(tab_container->get_current_tab());
  1056. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(current);
  1057. if (!se) {
  1058. members_overview->set_visible(false);
  1059. return;
  1060. }
  1061. if (members_overview_enabled && se->show_members_overview()) {
  1062. members_overview->set_visible(true);
  1063. } else {
  1064. members_overview->set_visible(false);
  1065. }
  1066. }
  1067. void ScriptEditor::_update_members_overview() {
  1068. members_overview->clear();
  1069. int selected = tab_container->get_current_tab();
  1070. if (selected < 0 || selected >= tab_container->get_child_count())
  1071. return;
  1072. Node *current = tab_container->get_child(tab_container->get_current_tab());
  1073. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(current);
  1074. if (!se) {
  1075. return;
  1076. }
  1077. Vector<String> functions = se->get_functions();
  1078. for (int i = 0; i < functions.size(); i++) {
  1079. members_overview->add_item(functions[i].get_slice(":", 0));
  1080. members_overview->set_item_metadata(i, functions[i].get_slice(":", 1).to_int() - 1);
  1081. }
  1082. }
  1083. void ScriptEditor::_update_help_overview_visibility() {
  1084. int selected = tab_container->get_current_tab();
  1085. if (selected < 0 || selected >= tab_container->get_child_count()) {
  1086. help_overview->set_visible(false);
  1087. return;
  1088. }
  1089. Node *current = tab_container->get_child(tab_container->get_current_tab());
  1090. EditorHelp *se = Object::cast_to<EditorHelp>(current);
  1091. if (!se) {
  1092. help_overview->set_visible(false);
  1093. return;
  1094. }
  1095. if (help_overview_enabled) {
  1096. help_overview->set_visible(true);
  1097. } else {
  1098. help_overview->set_visible(false);
  1099. }
  1100. }
  1101. void ScriptEditor::_update_help_overview() {
  1102. help_overview->clear();
  1103. int selected = tab_container->get_current_tab();
  1104. if (selected < 0 || selected >= tab_container->get_child_count())
  1105. return;
  1106. Node *current = tab_container->get_child(tab_container->get_current_tab());
  1107. EditorHelp *se = Object::cast_to<EditorHelp>(current);
  1108. if (!se) {
  1109. return;
  1110. }
  1111. Vector<Pair<String, int> > sections = se->get_sections();
  1112. for (int i = 0; i < sections.size(); i++) {
  1113. help_overview->add_item(sections[i].first);
  1114. help_overview->set_item_metadata(i, sections[i].second);
  1115. }
  1116. }
  1117. void ScriptEditor::_update_script_colors() {
  1118. bool script_temperature_enabled = EditorSettings::get_singleton()->get("text_editor/open_scripts/script_temperature_enabled");
  1119. bool highlight_current = EditorSettings::get_singleton()->get("text_editor/open_scripts/highlight_current_script");
  1120. int hist_size = EditorSettings::get_singleton()->get("text_editor/open_scripts/script_temperature_history_size");
  1121. Color hot_color = get_color("accent_color", "Editor");
  1122. Color cold_color = get_color("font_color", "Editor");
  1123. for (int i = 0; i < script_list->get_item_count(); i++) {
  1124. int c = script_list->get_item_metadata(i);
  1125. Node *n = tab_container->get_child(c);
  1126. if (!n)
  1127. continue;
  1128. script_list->set_item_custom_bg_color(i, Color(0, 0, 0, 0));
  1129. bool current = tab_container->get_current_tab() == c;
  1130. if (current && highlight_current) {
  1131. script_list->set_item_custom_bg_color(i, EditorSettings::get_singleton()->get("text_editor/open_scripts/current_script_background_color"));
  1132. } else if (script_temperature_enabled) {
  1133. if (!n->has_meta("__editor_pass")) {
  1134. continue;
  1135. }
  1136. int pass = n->get_meta("__editor_pass");
  1137. int h = edit_pass - pass;
  1138. if (h > hist_size) {
  1139. continue;
  1140. }
  1141. int non_zero_hist_size = (hist_size == 0) ? 1 : hist_size;
  1142. float v = Math::ease((edit_pass - pass) / float(non_zero_hist_size), 0.4);
  1143. script_list->set_item_custom_fg_color(i, hot_color.linear_interpolate(cold_color, v));
  1144. }
  1145. }
  1146. }
  1147. void ScriptEditor::_update_script_names() {
  1148. if (restoring_layout)
  1149. return;
  1150. waiting_update_names = false;
  1151. Set<Ref<Script> > used;
  1152. Node *edited = EditorNode::get_singleton()->get_edited_scene();
  1153. if (edited) {
  1154. _find_scripts(edited, edited, used);
  1155. }
  1156. script_list->clear();
  1157. bool split_script_help = EditorSettings::get_singleton()->get("text_editor/open_scripts/group_help_pages");
  1158. ScriptSortBy sort_by = (ScriptSortBy)(int)EditorSettings::get_singleton()->get("text_editor/open_scripts/sort_scripts_by");
  1159. ScriptListName display_as = (ScriptListName)(int)EditorSettings::get_singleton()->get("text_editor/open_scripts/list_script_names_as");
  1160. Vector<_ScriptEditorItemData> sedata;
  1161. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1162. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1163. if (se) {
  1164. String name = se->get_name();
  1165. Ref<Texture> icon = se->get_icon();
  1166. String path = se->get_edited_script()->get_path();
  1167. _ScriptEditorItemData sd;
  1168. sd.icon = icon;
  1169. sd.name = name;
  1170. sd.tooltip = path;
  1171. sd.index = i;
  1172. sd.used = used.has(se->get_edited_script());
  1173. sd.category = 0;
  1174. sd.ref = se;
  1175. switch (sort_by) {
  1176. case SORT_BY_NAME: {
  1177. sd.sort_key = name.to_lower();
  1178. } break;
  1179. case SORT_BY_PATH: {
  1180. sd.sort_key = path;
  1181. } break;
  1182. }
  1183. switch (display_as) {
  1184. case DISPLAY_NAME: {
  1185. sd.name = name;
  1186. } break;
  1187. case DISPLAY_DIR_AND_NAME: {
  1188. if (!path.get_base_dir().get_file().empty()) {
  1189. sd.name = path.get_base_dir().get_file() + "/" + name;
  1190. } else {
  1191. sd.name = name;
  1192. }
  1193. } break;
  1194. case DISPLAY_FULL_PATH: {
  1195. sd.name = path;
  1196. } break;
  1197. }
  1198. sedata.push_back(sd);
  1199. }
  1200. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_child(i));
  1201. if (eh) {
  1202. String name = eh->get_class();
  1203. Ref<Texture> icon = get_icon("Help", "EditorIcons");
  1204. String tooltip = name + TTR(" Class Reference");
  1205. _ScriptEditorItemData sd;
  1206. sd.icon = icon;
  1207. sd.name = name;
  1208. sd.sort_key = name.to_lower();
  1209. sd.tooltip = tooltip;
  1210. sd.index = i;
  1211. sd.used = false;
  1212. sd.category = split_script_help ? 1 : 0;
  1213. sd.ref = eh;
  1214. sedata.push_back(sd);
  1215. }
  1216. }
  1217. if (_sort_list_on_update) {
  1218. sedata.sort();
  1219. // change actual order of tab_container so that the order can be rearranged by user
  1220. int cur_tab = tab_container->get_current_tab();
  1221. int prev_tab = tab_container->get_previous_tab();
  1222. int new_cur_tab = -1;
  1223. int new_prev_tab = -1;
  1224. for (int i = 0; i < sedata.size(); i++) {
  1225. tab_container->move_child(sedata[i].ref, i);
  1226. if (new_prev_tab == -1 && sedata[i].index == prev_tab) {
  1227. new_prev_tab = i;
  1228. }
  1229. if (new_cur_tab == -1 && sedata[i].index == cur_tab) {
  1230. new_cur_tab = i;
  1231. }
  1232. }
  1233. tab_container->call_deferred("set_current_tab", new_prev_tab);
  1234. tab_container->call_deferred("set_current_tab", new_cur_tab);
  1235. _sort_list_on_update = false;
  1236. }
  1237. for (int i = 0; i < sedata.size(); i++) {
  1238. script_list->add_item(sedata[i].name, sedata[i].icon);
  1239. int index = script_list->get_item_count() - 1;
  1240. script_list->set_item_tooltip(index, sedata[i].tooltip);
  1241. script_list->set_item_metadata(index, sedata[i].index);
  1242. if (sedata[i].used) {
  1243. script_list->set_item_custom_bg_color(index, Color(88 / 255.0, 88 / 255.0, 60 / 255.0));
  1244. }
  1245. if (tab_container->get_current_tab() == sedata[i].index) {
  1246. script_list->select(index);
  1247. script_name_label->set_text(sedata[i].name);
  1248. script_icon->set_texture(sedata[i].icon);
  1249. }
  1250. }
  1251. _update_members_overview();
  1252. _update_help_overview();
  1253. _update_members_overview_visibility();
  1254. _update_help_overview_visibility();
  1255. _update_script_colors();
  1256. }
  1257. bool ScriptEditor::edit(const Ref<Script> &p_script, int p_line, int p_col, bool p_grab_focus) {
  1258. if (p_script.is_null())
  1259. return false;
  1260. // refuse to open built-in if scene is not loaded
  1261. // see if already has it
  1262. bool open_dominant = EditorSettings::get_singleton()->get("text_editor/files/open_dominant_script_on_scene_change");
  1263. if (p_script->get_language()->overrides_external_editor()) {
  1264. Error err = p_script->get_language()->open_in_external_editor(p_script, p_line >= 0 ? p_line : 0, p_col);
  1265. if (err != OK)
  1266. ERR_PRINT("Couldn't open script in the overridden external text editor");
  1267. return false;
  1268. }
  1269. if ((debugger->get_dump_stack_script() != p_script || debugger->get_debug_with_external_editor()) &&
  1270. p_script->get_path().is_resource_file() &&
  1271. bool(EditorSettings::get_singleton()->get("text_editor/external/use_external_editor"))) {
  1272. String path = EditorSettings::get_singleton()->get("text_editor/external/exec_path");
  1273. String flags = EditorSettings::get_singleton()->get("text_editor/external/exec_flags");
  1274. Dictionary keys;
  1275. keys["project"] = ProjectSettings::get_singleton()->get_resource_path();
  1276. keys["file"] = ProjectSettings::get_singleton()->globalize_path(p_script->get_path());
  1277. keys["line"] = p_line >= 0 ? p_line : 0;
  1278. keys["col"] = p_col;
  1279. flags = flags.format(keys).strip_edges().replace("\\\\", "\\");
  1280. List<String> args;
  1281. if (flags.size()) {
  1282. int from = 0, to = 0;
  1283. bool inside_quotes = false;
  1284. for (int i = 0; i < flags.size(); i++) {
  1285. if (flags[i] == '"' && (!i || flags[i - 1] != '\\')) {
  1286. inside_quotes = !inside_quotes;
  1287. } else if (flags[i] == '\0' || (!inside_quotes && flags[i] == ' ')) {
  1288. args.push_back(flags.substr(from, to));
  1289. from = i + 1;
  1290. to = 0;
  1291. } else {
  1292. to++;
  1293. }
  1294. }
  1295. }
  1296. Error err = OS::get_singleton()->execute(path, args, false);
  1297. if (err == OK)
  1298. return false;
  1299. WARN_PRINT("Couldn't open external text editor, using internal");
  1300. }
  1301. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1302. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1303. if (!se)
  1304. continue;
  1305. if (se->get_edited_script() == p_script) {
  1306. if (open_dominant || !EditorNode::get_singleton()->is_changing_scene()) {
  1307. if (tab_container->get_current_tab() != i) {
  1308. _go_to_tab(i);
  1309. script_list->select(script_list->find_metadata(i));
  1310. }
  1311. if (is_visible_in_tree())
  1312. se->ensure_focus();
  1313. if (p_line >= 0)
  1314. se->goto_line(p_line - 1);
  1315. }
  1316. return true;
  1317. }
  1318. }
  1319. // doesn't have it, make a new one
  1320. ScriptEditorBase *se;
  1321. for (int i = script_editor_func_count - 1; i >= 0; i--) {
  1322. se = script_editor_funcs[i](p_script);
  1323. if (se)
  1324. break;
  1325. }
  1326. ERR_FAIL_COND_V(!se, false);
  1327. tab_container->add_child(se);
  1328. se->set_edited_script(p_script);
  1329. se->set_tooltip_request_func("_get_debug_tooltip", this);
  1330. if (se->get_edit_menu()) {
  1331. se->get_edit_menu()->hide();
  1332. menu_hb->add_child(se->get_edit_menu());
  1333. menu_hb->move_child(se->get_edit_menu(), 1);
  1334. }
  1335. if (p_grab_focus) {
  1336. _go_to_tab(tab_container->get_tab_count() - 1);
  1337. }
  1338. _update_script_names();
  1339. _save_layout();
  1340. se->connect("name_changed", this, "_update_script_names");
  1341. se->connect("edited_script_changed", this, "_script_changed");
  1342. se->connect("request_help_search", this, "_help_search");
  1343. se->connect("request_open_script_at_line", this, "_goto_script_line");
  1344. se->connect("go_to_help", this, "_help_class_goto");
  1345. se->connect("request_save_history", this, "_save_history");
  1346. //test for modification, maybe the script was not edited but was loaded
  1347. _test_script_times_on_disk(p_script);
  1348. _update_modified_scripts_for_external_editor(p_script);
  1349. if (p_line >= 0)
  1350. se->goto_line(p_line - 1);
  1351. notify_script_changed(p_script);
  1352. return true;
  1353. }
  1354. void ScriptEditor::save_all_scripts() {
  1355. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1356. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1357. if (!se)
  1358. continue;
  1359. if (convert_indent_on_save) {
  1360. if (use_space_indentation) {
  1361. se->convert_indent_to_spaces();
  1362. } else {
  1363. se->convert_indent_to_tabs();
  1364. }
  1365. }
  1366. if (trim_trailing_whitespace_on_save) {
  1367. se->trim_trailing_whitespace();
  1368. }
  1369. if (!se->is_unsaved())
  1370. continue;
  1371. Ref<Script> script = se->get_edited_script();
  1372. if (script.is_valid())
  1373. se->apply_code();
  1374. if (script->get_path() != "" && script->get_path().find("local://") == -1 && script->get_path().find("::") == -1) {
  1375. //external script, save it
  1376. editor->save_resource(script);
  1377. //ResourceSaver::save(script->get_path(),script);
  1378. }
  1379. }
  1380. _update_script_names();
  1381. }
  1382. void ScriptEditor::apply_scripts() const {
  1383. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1384. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1385. if (!se)
  1386. continue;
  1387. se->apply_code();
  1388. }
  1389. }
  1390. void ScriptEditor::_editor_play() {
  1391. debugger->start();
  1392. debug_menu->get_popup()->grab_focus();
  1393. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_NEXT), true);
  1394. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_STEP), true);
  1395. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_BREAK), false);
  1396. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_CONTINUE), true);
  1397. //debugger_gui->start_listening(Globals::get_singleton()->get("debug/debug_port"));
  1398. }
  1399. void ScriptEditor::_editor_pause() {
  1400. }
  1401. void ScriptEditor::_editor_stop() {
  1402. debugger->stop();
  1403. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_NEXT), true);
  1404. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_STEP), true);
  1405. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_BREAK), true);
  1406. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_CONTINUE), true);
  1407. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1408. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1409. if (!se) {
  1410. continue;
  1411. }
  1412. se->set_debugger_active(false);
  1413. }
  1414. }
  1415. void ScriptEditor::_add_callback(Object *p_obj, const String &p_function, const PoolStringArray &p_args) {
  1416. //print_line("add callback! hohoho"); kinda sad to remove this
  1417. ERR_FAIL_COND(!p_obj);
  1418. Ref<Script> script = p_obj->get_script();
  1419. ERR_FAIL_COND(!script.is_valid());
  1420. editor->push_item(script.ptr());
  1421. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1422. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1423. if (!se)
  1424. continue;
  1425. if (se->get_edited_script() != script)
  1426. continue;
  1427. se->add_callback(p_function, p_args);
  1428. _go_to_tab(i);
  1429. script_list->select(script_list->find_metadata(i));
  1430. break;
  1431. }
  1432. }
  1433. void ScriptEditor::_save_layout() {
  1434. if (restoring_layout) {
  1435. return;
  1436. }
  1437. editor->save_layout();
  1438. }
  1439. void ScriptEditor::_editor_settings_changed() {
  1440. trim_trailing_whitespace_on_save = EditorSettings::get_singleton()->get("text_editor/files/trim_trailing_whitespace_on_save");
  1441. convert_indent_on_save = EditorSettings::get_singleton()->get("text_editor/indent/convert_indent_on_save");
  1442. use_space_indentation = EditorSettings::get_singleton()->get("text_editor/indent/type");
  1443. members_overview_enabled = EditorSettings::get_singleton()->get("text_editor/open_scripts/show_members_overview");
  1444. help_overview_enabled = EditorSettings::get_singleton()->get("text_editor/help/show_help_index");
  1445. _update_members_overview_visibility();
  1446. _update_help_overview_visibility();
  1447. float autosave_time = EditorSettings::get_singleton()->get("text_editor/files/autosave_interval_secs");
  1448. if (autosave_time > 0) {
  1449. autosave_timer->set_wait_time(autosave_time);
  1450. autosave_timer->start();
  1451. } else {
  1452. autosave_timer->stop();
  1453. }
  1454. if (current_theme == "") {
  1455. current_theme = EditorSettings::get_singleton()->get("text_editor/theme/color_theme");
  1456. } else if (current_theme != EditorSettings::get_singleton()->get("text_editor/theme/color_theme")) {
  1457. current_theme = EditorSettings::get_singleton()->get("text_editor/theme/color_theme");
  1458. EditorSettings::get_singleton()->load_text_editor_theme();
  1459. }
  1460. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1461. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1462. if (!se)
  1463. continue;
  1464. se->update_settings();
  1465. }
  1466. _update_script_colors();
  1467. _update_script_names();
  1468. ScriptServer::set_reload_scripts_on_save(EDITOR_DEF("text_editor/files/auto_reload_and_parse_scripts_on_save", true));
  1469. }
  1470. void ScriptEditor::_autosave_scripts() {
  1471. save_all_scripts();
  1472. }
  1473. void ScriptEditor::_tree_changed() {
  1474. if (waiting_update_names)
  1475. return;
  1476. waiting_update_names = true;
  1477. call_deferred("_update_script_names");
  1478. }
  1479. void ScriptEditor::_script_split_dragged(float) {
  1480. _save_layout();
  1481. }
  1482. Variant ScriptEditor::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  1483. // return Variant(); // return this if drag disabled
  1484. Node *cur_node = tab_container->get_child(tab_container->get_current_tab());
  1485. HBoxContainer *drag_preview = memnew(HBoxContainer);
  1486. String preview_name = "";
  1487. Ref<Texture> preview_icon;
  1488. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(cur_node);
  1489. if (se) {
  1490. preview_name = se->get_name();
  1491. preview_icon = se->get_icon();
  1492. }
  1493. EditorHelp *eh = Object::cast_to<EditorHelp>(cur_node);
  1494. if (eh) {
  1495. preview_name = eh->get_class();
  1496. preview_icon = get_icon("Help", "EditorIcons");
  1497. }
  1498. if (!preview_icon.is_null()) {
  1499. TextureRect *tf = memnew(TextureRect);
  1500. tf->set_texture(preview_icon);
  1501. drag_preview->add_child(tf);
  1502. }
  1503. Label *label = memnew(Label(preview_name));
  1504. drag_preview->add_child(label);
  1505. set_drag_preview(drag_preview);
  1506. Dictionary drag_data;
  1507. drag_data["type"] = "script_list_element"; // using a custom type because node caused problems when dragging to scene tree
  1508. drag_data["script_list_element"] = cur_node;
  1509. return drag_data;
  1510. }
  1511. bool ScriptEditor::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
  1512. Dictionary d = p_data;
  1513. if (!d.has("type"))
  1514. return false;
  1515. if (String(d["type"]) == "script_list_element") {
  1516. Node *node = d["script_list_element"];
  1517. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(node);
  1518. if (se) {
  1519. return true;
  1520. }
  1521. EditorHelp *eh = Object::cast_to<EditorHelp>(node);
  1522. if (eh) {
  1523. return true;
  1524. }
  1525. }
  1526. if (String(d["type"]) == "nodes") {
  1527. Array nodes = d["nodes"];
  1528. if (nodes.size() == 0)
  1529. return false;
  1530. Node *node = get_node((nodes[0]));
  1531. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(node);
  1532. if (se) {
  1533. return true;
  1534. }
  1535. EditorHelp *eh = Object::cast_to<EditorHelp>(node);
  1536. if (eh) {
  1537. return true;
  1538. }
  1539. }
  1540. if (String(d["type"]) == "files") {
  1541. Vector<String> files = d["files"];
  1542. if (files.size() == 0)
  1543. return false; //weird
  1544. for (int i = 0; i < files.size(); i++) {
  1545. String file = files[i];
  1546. if (file == "" || !FileAccess::exists(file))
  1547. continue;
  1548. Ref<Script> scr = ResourceLoader::load(file);
  1549. if (scr.is_valid()) {
  1550. return true;
  1551. }
  1552. }
  1553. return true;
  1554. }
  1555. return false;
  1556. }
  1557. void ScriptEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
  1558. if (!can_drop_data_fw(p_point, p_data, p_from))
  1559. return;
  1560. Dictionary d = p_data;
  1561. if (!d.has("type"))
  1562. return;
  1563. if (String(d["type"]) == "script_list_element") {
  1564. Node *node = d["script_list_element"];
  1565. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(node);
  1566. EditorHelp *eh = Object::cast_to<EditorHelp>(node);
  1567. if (se || eh) {
  1568. int new_index = script_list->get_item_at_position(p_point);
  1569. tab_container->move_child(node, new_index);
  1570. tab_container->set_current_tab(new_index);
  1571. _update_script_names();
  1572. }
  1573. }
  1574. if (String(d["type"]) == "nodes") {
  1575. Array nodes = d["nodes"];
  1576. if (nodes.size() == 0)
  1577. return;
  1578. Node *node = get_node(nodes[0]);
  1579. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(node);
  1580. EditorHelp *eh = Object::cast_to<EditorHelp>(node);
  1581. if (se || eh) {
  1582. int new_index = script_list->get_item_at_position(p_point);
  1583. tab_container->move_child(node, new_index);
  1584. tab_container->set_current_tab(new_index);
  1585. _update_script_names();
  1586. }
  1587. }
  1588. if (String(d["type"]) == "files") {
  1589. Vector<String> files = d["files"];
  1590. int new_index = script_list->get_item_at_position(p_point);
  1591. int num_tabs_before = tab_container->get_child_count();
  1592. for (int i = 0; i < files.size(); i++) {
  1593. String file = files[i];
  1594. if (file == "" || !FileAccess::exists(file))
  1595. continue;
  1596. Ref<Script> scr = ResourceLoader::load(file);
  1597. if (scr.is_valid()) {
  1598. edit(scr);
  1599. if (tab_container->get_child_count() > num_tabs_before) {
  1600. tab_container->move_child(tab_container->get_child(tab_container->get_child_count() - 1), new_index);
  1601. num_tabs_before = tab_container->get_child_count();
  1602. } else {
  1603. tab_container->move_child(tab_container->get_child(tab_container->get_current_tab()), new_index);
  1604. }
  1605. }
  1606. }
  1607. tab_container->set_current_tab(new_index);
  1608. _update_script_names();
  1609. }
  1610. }
  1611. void ScriptEditor::_unhandled_input(const Ref<InputEvent> &p_event) {
  1612. if (!is_visible_in_tree() || !p_event->is_pressed() || p_event->is_echo())
  1613. return;
  1614. if (ED_IS_SHORTCUT("script_editor/next_script", p_event)) {
  1615. int next_tab = script_list->get_current() + 1;
  1616. next_tab %= script_list->get_item_count();
  1617. _go_to_tab(script_list->get_item_metadata(next_tab));
  1618. _update_script_names();
  1619. }
  1620. if (ED_IS_SHORTCUT("script_editor/prev_script", p_event)) {
  1621. int next_tab = script_list->get_current() - 1;
  1622. next_tab = next_tab >= 0 ? next_tab : script_list->get_item_count() - 1;
  1623. _go_to_tab(script_list->get_item_metadata(next_tab));
  1624. _update_script_names();
  1625. }
  1626. if (ED_IS_SHORTCUT("script_editor/window_move_up", p_event)) {
  1627. _menu_option(WINDOW_MOVE_UP);
  1628. }
  1629. if (ED_IS_SHORTCUT("script_editor/window_move_down", p_event)) {
  1630. _menu_option(WINDOW_MOVE_DOWN);
  1631. }
  1632. }
  1633. void ScriptEditor::_script_list_gui_input(const Ref<InputEvent> &ev) {
  1634. Ref<InputEventMouseButton> mb = ev;
  1635. if (mb.is_valid() && mb->get_button_index() == BUTTON_RIGHT && mb->is_pressed()) {
  1636. _make_script_list_context_menu();
  1637. }
  1638. }
  1639. void ScriptEditor::_make_script_list_context_menu() {
  1640. context_menu->clear();
  1641. int selected = tab_container->get_current_tab();
  1642. if (selected < 0 || selected >= tab_container->get_child_count())
  1643. return;
  1644. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(selected));
  1645. if (se) {
  1646. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/save"), FILE_SAVE);
  1647. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/save_as"), FILE_SAVE_AS);
  1648. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/close_file"), FILE_CLOSE);
  1649. context_menu->add_separator();
  1650. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/reload_script_soft"), FILE_TOOL_RELOAD_SOFT);
  1651. Ref<Script> scr = se->get_edited_script();
  1652. if (!scr.is_null() && scr->is_tool()) {
  1653. context_menu->add_separator();
  1654. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/run_file"), FILE_RUN);
  1655. }
  1656. } else {
  1657. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/close_file"), FILE_CLOSE);
  1658. }
  1659. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_child(selected));
  1660. if (eh) {
  1661. // nothing
  1662. }
  1663. context_menu->add_separator();
  1664. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/window_move_up"), WINDOW_MOVE_UP);
  1665. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/window_move_down"), WINDOW_MOVE_DOWN);
  1666. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/window_sort"), WINDOW_SORT);
  1667. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/toggle_scripts_panel"), TOGGLE_SCRIPTS_PANEL);
  1668. context_menu->set_position(get_global_transform().xform(get_local_mouse_position()));
  1669. context_menu->set_size(Vector2(1, 1));
  1670. context_menu->popup();
  1671. }
  1672. void ScriptEditor::set_window_layout(Ref<ConfigFile> p_layout) {
  1673. if (!bool(EDITOR_DEF("text_editor/files/restore_scripts_on_load", true))) {
  1674. return;
  1675. }
  1676. if (!p_layout->has_section_key("ScriptEditor", "open_scripts") && !p_layout->has_section_key("ScriptEditor", "open_help"))
  1677. return;
  1678. Array scripts = p_layout->get_value("ScriptEditor", "open_scripts");
  1679. Array helps;
  1680. if (p_layout->has_section_key("ScriptEditor", "open_help"))
  1681. helps = p_layout->get_value("ScriptEditor", "open_help");
  1682. restoring_layout = true;
  1683. for (int i = 0; i < scripts.size(); i++) {
  1684. String path = scripts[i];
  1685. if (!FileAccess::exists(path))
  1686. continue;
  1687. Ref<Script> scr = ResourceLoader::load(path);
  1688. if (scr.is_valid()) {
  1689. edit(scr);
  1690. }
  1691. }
  1692. for (int i = 0; i < helps.size(); i++) {
  1693. String path = helps[i];
  1694. if (path == "") { // invalid, skip
  1695. continue;
  1696. }
  1697. _help_class_open(path);
  1698. }
  1699. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1700. tab_container->get_child(i)->set_meta("__editor_pass", Variant());
  1701. }
  1702. if (p_layout->has_section_key("ScriptEditor", "split_offset")) {
  1703. script_split->set_split_offset(p_layout->get_value("ScriptEditor", "split_offset"));
  1704. }
  1705. restoring_layout = false;
  1706. _update_script_names();
  1707. }
  1708. void ScriptEditor::get_window_layout(Ref<ConfigFile> p_layout) {
  1709. Array scripts;
  1710. Array helps;
  1711. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1712. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1713. if (se) {
  1714. String path = se->get_edited_script()->get_path();
  1715. if (!path.is_resource_file())
  1716. continue;
  1717. scripts.push_back(path);
  1718. }
  1719. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_child(i));
  1720. if (eh) {
  1721. helps.push_back(eh->get_class());
  1722. }
  1723. }
  1724. p_layout->set_value("ScriptEditor", "open_scripts", scripts);
  1725. p_layout->set_value("ScriptEditor", "open_help", helps);
  1726. p_layout->set_value("ScriptEditor", "split_offset", script_split->get_split_offset());
  1727. }
  1728. void ScriptEditor::_help_class_open(const String &p_class) {
  1729. if (p_class == "")
  1730. return;
  1731. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1732. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_child(i));
  1733. if (eh && eh->get_class() == p_class) {
  1734. _go_to_tab(i);
  1735. _update_script_names();
  1736. return;
  1737. }
  1738. }
  1739. EditorHelp *eh = memnew(EditorHelp);
  1740. eh->set_name(p_class);
  1741. tab_container->add_child(eh);
  1742. _go_to_tab(tab_container->get_tab_count() - 1);
  1743. eh->go_to_class(p_class, 0);
  1744. eh->connect("go_to_help", this, "_help_class_goto");
  1745. _update_script_names();
  1746. _save_layout();
  1747. }
  1748. void ScriptEditor::_help_class_goto(const String &p_desc) {
  1749. String cname = p_desc.get_slice(":", 1);
  1750. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1751. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_child(i));
  1752. if (eh && eh->get_class() == cname) {
  1753. _go_to_tab(i);
  1754. eh->go_to_help(p_desc);
  1755. _update_script_names();
  1756. return;
  1757. }
  1758. }
  1759. EditorHelp *eh = memnew(EditorHelp);
  1760. eh->set_name(cname);
  1761. tab_container->add_child(eh);
  1762. _go_to_tab(tab_container->get_tab_count() - 1);
  1763. eh->go_to_help(p_desc);
  1764. eh->connect("go_to_help", this, "_help_class_goto");
  1765. _update_script_names();
  1766. _save_layout();
  1767. }
  1768. void ScriptEditor::_update_selected_editor_menu() {
  1769. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1770. bool current = tab_container->get_current_tab() == i;
  1771. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1772. if (se && se->get_edit_menu()) {
  1773. if (current)
  1774. se->get_edit_menu()->show();
  1775. else
  1776. se->get_edit_menu()->hide();
  1777. }
  1778. }
  1779. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_current_tab_control());
  1780. if (eh) {
  1781. script_search_menu->show();
  1782. } else {
  1783. script_search_menu->hide();
  1784. }
  1785. }
  1786. void ScriptEditor::_update_history_pos(int p_new_pos) {
  1787. Node *n = tab_container->get_current_tab_control();
  1788. if (Object::cast_to<ScriptEditorBase>(n)) {
  1789. history[history_pos].state = Object::cast_to<ScriptEditorBase>(n)->get_edit_state();
  1790. }
  1791. if (Object::cast_to<EditorHelp>(n)) {
  1792. history[history_pos].state = Object::cast_to<EditorHelp>(n)->get_scroll();
  1793. }
  1794. history_pos = p_new_pos;
  1795. tab_container->set_current_tab(history[history_pos].control->get_index());
  1796. n = history[history_pos].control;
  1797. if (Object::cast_to<ScriptEditorBase>(n)) {
  1798. Object::cast_to<ScriptEditorBase>(n)->set_edit_state(history[history_pos].state);
  1799. Object::cast_to<ScriptEditorBase>(n)->ensure_focus();
  1800. notify_script_changed(Object::cast_to<ScriptEditorBase>(n)->get_edited_script());
  1801. }
  1802. if (Object::cast_to<EditorHelp>(n)) {
  1803. Object::cast_to<EditorHelp>(n)->set_scroll(history[history_pos].state);
  1804. Object::cast_to<EditorHelp>(n)->set_focused();
  1805. }
  1806. n->set_meta("__editor_pass", ++edit_pass);
  1807. _update_script_names();
  1808. _update_history_arrows();
  1809. _update_selected_editor_menu();
  1810. }
  1811. void ScriptEditor::_history_forward() {
  1812. if (history_pos < history.size() - 1) {
  1813. _update_history_pos(history_pos + 1);
  1814. }
  1815. }
  1816. void ScriptEditor::_history_back() {
  1817. if (history_pos > 0) {
  1818. _update_history_pos(history_pos - 1);
  1819. }
  1820. }
  1821. Vector<Ref<Script> > ScriptEditor::get_open_scripts() const {
  1822. Vector<Ref<Script> > out_scripts = Vector<Ref<Script> >();
  1823. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1824. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1825. if (!se)
  1826. continue;
  1827. out_scripts.push_back(se->get_edited_script());
  1828. }
  1829. return out_scripts;
  1830. }
  1831. void ScriptEditor::set_scene_root_script(Ref<Script> p_script) {
  1832. bool open_dominant = EditorSettings::get_singleton()->get("text_editor/files/open_dominant_script_on_scene_change");
  1833. if (bool(EditorSettings::get_singleton()->get("text_editor/external/use_external_editor")))
  1834. return;
  1835. if (open_dominant && p_script.is_valid() && _can_open_in_editor(p_script.ptr())) {
  1836. edit(p_script);
  1837. }
  1838. }
  1839. bool ScriptEditor::script_goto_method(Ref<Script> p_script, const String &p_method) {
  1840. int line = p_script->get_member_line(p_method);
  1841. if (line == -1)
  1842. return false;
  1843. return edit(p_script, line, 0);
  1844. }
  1845. void ScriptEditor::set_live_auto_reload_running_scripts(bool p_enabled) {
  1846. auto_reload_running_scripts = p_enabled;
  1847. }
  1848. void ScriptEditor::_help_index(String p_text) {
  1849. help_index->popup();
  1850. }
  1851. void ScriptEditor::_help_search(String p_text) {
  1852. help_search_dialog->popup(p_text);
  1853. }
  1854. void ScriptEditor::_open_script_request(const String &p_path) {
  1855. Ref<Script> script = ResourceLoader::load(p_path);
  1856. if (script.is_valid()) {
  1857. script_editor->edit(script, false);
  1858. }
  1859. }
  1860. int ScriptEditor::script_editor_func_count = 0;
  1861. CreateScriptEditorFunc ScriptEditor::script_editor_funcs[ScriptEditor::SCRIPT_EDITOR_FUNC_MAX];
  1862. void ScriptEditor::register_create_script_editor_function(CreateScriptEditorFunc p_func) {
  1863. ERR_FAIL_COND(script_editor_func_count == SCRIPT_EDITOR_FUNC_MAX);
  1864. script_editor_funcs[script_editor_func_count++] = p_func;
  1865. }
  1866. void ScriptEditor::_script_changed() {
  1867. NodeDock::singleton->update_lists();
  1868. }
  1869. void ScriptEditor::_bind_methods() {
  1870. ClassDB::bind_method("_file_dialog_action", &ScriptEditor::_file_dialog_action);
  1871. ClassDB::bind_method("_tab_changed", &ScriptEditor::_tab_changed);
  1872. ClassDB::bind_method("_menu_option", &ScriptEditor::_menu_option);
  1873. ClassDB::bind_method("_close_current_tab", &ScriptEditor::_close_current_tab);
  1874. ClassDB::bind_method("_close_discard_current_tab", &ScriptEditor::_close_discard_current_tab);
  1875. ClassDB::bind_method("_close_docs_tab", &ScriptEditor::_close_docs_tab);
  1876. ClassDB::bind_method("_close_all_tabs", &ScriptEditor::_close_all_tabs);
  1877. ClassDB::bind_method("_open_recent_script", &ScriptEditor::_open_recent_script);
  1878. ClassDB::bind_method("_editor_play", &ScriptEditor::_editor_play);
  1879. ClassDB::bind_method("_editor_pause", &ScriptEditor::_editor_pause);
  1880. ClassDB::bind_method("_editor_stop", &ScriptEditor::_editor_stop);
  1881. ClassDB::bind_method("_add_callback", &ScriptEditor::_add_callback);
  1882. ClassDB::bind_method("_reload_scripts", &ScriptEditor::_reload_scripts);
  1883. ClassDB::bind_method("_resave_scripts", &ScriptEditor::_resave_scripts);
  1884. ClassDB::bind_method("_res_saved_callback", &ScriptEditor::_res_saved_callback);
  1885. ClassDB::bind_method("_goto_script_line", &ScriptEditor::_goto_script_line);
  1886. ClassDB::bind_method("_goto_script_line2", &ScriptEditor::_goto_script_line2);
  1887. ClassDB::bind_method("_help_search", &ScriptEditor::_help_search);
  1888. ClassDB::bind_method("_help_index", &ScriptEditor::_help_index);
  1889. ClassDB::bind_method("_save_history", &ScriptEditor::_save_history);
  1890. ClassDB::bind_method("_breaked", &ScriptEditor::_breaked);
  1891. ClassDB::bind_method("_show_debugger", &ScriptEditor::_show_debugger);
  1892. ClassDB::bind_method("_get_debug_tooltip", &ScriptEditor::_get_debug_tooltip);
  1893. ClassDB::bind_method("_autosave_scripts", &ScriptEditor::_autosave_scripts);
  1894. ClassDB::bind_method("_editor_settings_changed", &ScriptEditor::_editor_settings_changed);
  1895. ClassDB::bind_method("_update_script_names", &ScriptEditor::_update_script_names);
  1896. ClassDB::bind_method("_tree_changed", &ScriptEditor::_tree_changed);
  1897. ClassDB::bind_method("_members_overview_selected", &ScriptEditor::_members_overview_selected);
  1898. ClassDB::bind_method("_help_overview_selected", &ScriptEditor::_help_overview_selected);
  1899. ClassDB::bind_method("_script_selected", &ScriptEditor::_script_selected);
  1900. ClassDB::bind_method("_script_created", &ScriptEditor::_script_created);
  1901. ClassDB::bind_method("_script_split_dragged", &ScriptEditor::_script_split_dragged);
  1902. ClassDB::bind_method("_help_class_open", &ScriptEditor::_help_class_open);
  1903. ClassDB::bind_method("_help_class_goto", &ScriptEditor::_help_class_goto);
  1904. ClassDB::bind_method("_request_help", &ScriptEditor::_help_class_open);
  1905. ClassDB::bind_method("_history_forward", &ScriptEditor::_history_forward);
  1906. ClassDB::bind_method("_history_back", &ScriptEditor::_history_back);
  1907. ClassDB::bind_method("_live_auto_reload_running_scripts", &ScriptEditor::_live_auto_reload_running_scripts);
  1908. ClassDB::bind_method("_unhandled_input", &ScriptEditor::_unhandled_input);
  1909. ClassDB::bind_method("_script_list_gui_input", &ScriptEditor::_script_list_gui_input);
  1910. ClassDB::bind_method("_script_changed", &ScriptEditor::_script_changed);
  1911. ClassDB::bind_method("_update_recent_scripts", &ScriptEditor::_update_recent_scripts);
  1912. ClassDB::bind_method(D_METHOD("get_drag_data_fw"), &ScriptEditor::get_drag_data_fw);
  1913. ClassDB::bind_method(D_METHOD("can_drop_data_fw"), &ScriptEditor::can_drop_data_fw);
  1914. ClassDB::bind_method(D_METHOD("drop_data_fw"), &ScriptEditor::drop_data_fw);
  1915. ClassDB::bind_method(D_METHOD("get_current_script"), &ScriptEditor::_get_current_script);
  1916. ClassDB::bind_method(D_METHOD("get_open_scripts"), &ScriptEditor::_get_open_scripts);
  1917. ADD_SIGNAL(MethodInfo("editor_script_changed", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script")));
  1918. ADD_SIGNAL(MethodInfo("script_close", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script")));
  1919. }
  1920. ScriptEditor::ScriptEditor(EditorNode *p_editor) {
  1921. current_theme = "";
  1922. completion_cache = memnew(EditorScriptCodeCompletionCache);
  1923. restoring_layout = false;
  1924. waiting_update_names = false;
  1925. pending_auto_reload = false;
  1926. auto_reload_running_scripts = false;
  1927. members_overview_enabled = true;
  1928. help_overview_enabled = true;
  1929. editor = p_editor;
  1930. VBoxContainer *main_container = memnew(VBoxContainer);
  1931. add_child(main_container);
  1932. menu_hb = memnew(HBoxContainer);
  1933. main_container->add_child(menu_hb);
  1934. script_split = memnew(HSplitContainer);
  1935. main_container->add_child(script_split);
  1936. script_split->set_v_size_flags(SIZE_EXPAND_FILL);
  1937. list_split = memnew(VSplitContainer);
  1938. script_split->add_child(list_split);
  1939. list_split->set_v_size_flags(SIZE_EXPAND_FILL);
  1940. script_list = memnew(ItemList);
  1941. list_split->add_child(script_list);
  1942. script_list->set_custom_minimum_size(Size2(150 * EDSCALE, 100)); //need to give a bit of limit to avoid it from disappearing
  1943. script_list->set_v_size_flags(SIZE_EXPAND_FILL);
  1944. script_split->set_split_offset(140);
  1945. //list_split->set_split_offset(500);
  1946. _sort_list_on_update = true;
  1947. script_list->connect("gui_input", this, "_script_list_gui_input");
  1948. script_list->set_allow_rmb_select(true);
  1949. script_list->set_drag_forwarding(this);
  1950. context_menu = memnew(PopupMenu);
  1951. add_child(context_menu);
  1952. context_menu->connect("id_pressed", this, "_menu_option");
  1953. members_overview = memnew(ItemList);
  1954. list_split->add_child(members_overview);
  1955. members_overview->set_custom_minimum_size(Size2(0, 100)); //need to give a bit of limit to avoid it from disappearing
  1956. members_overview->set_v_size_flags(SIZE_EXPAND_FILL);
  1957. help_overview = memnew(ItemList);
  1958. list_split->add_child(help_overview);
  1959. help_overview->set_custom_minimum_size(Size2(0, 100)); //need to give a bit of limit to avoid it from disappearing
  1960. help_overview->set_v_size_flags(SIZE_EXPAND_FILL);
  1961. tab_container = memnew(TabContainer);
  1962. tab_container->set_tabs_visible(false);
  1963. script_split->add_child(tab_container);
  1964. tab_container->set_h_size_flags(SIZE_EXPAND_FILL);
  1965. ED_SHORTCUT("script_editor/window_sort", TTR("Sort"));
  1966. ED_SHORTCUT("script_editor/window_move_up", TTR("Move Up"), KEY_MASK_SHIFT | KEY_MASK_ALT | KEY_UP);
  1967. ED_SHORTCUT("script_editor/window_move_down", TTR("Move Down"), KEY_MASK_SHIFT | KEY_MASK_ALT | KEY_DOWN);
  1968. ED_SHORTCUT("script_editor/next_script", TTR("Next script"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_PERIOD); // these should be KEY_GREATER and KEY_LESS but those don't work
  1969. ED_SHORTCUT("script_editor/prev_script", TTR("Previous script"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_COLON);
  1970. set_process_unhandled_input(true);
  1971. file_menu = memnew(MenuButton);
  1972. menu_hb->add_child(file_menu);
  1973. file_menu->set_text(TTR("File"));
  1974. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/new", TTR("New")), FILE_NEW);
  1975. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/open", TTR("Open")), FILE_OPEN);
  1976. file_menu->get_popup()->add_submenu_item(TTR("Open Recent"), "RecentScripts", FILE_OPEN_RECENT);
  1977. recent_scripts = memnew(PopupMenu);
  1978. recent_scripts->set_name("RecentScripts");
  1979. file_menu->get_popup()->add_child(recent_scripts);
  1980. recent_scripts->connect("id_pressed", this, "_open_recent_script");
  1981. _update_recent_scripts();
  1982. file_menu->get_popup()->add_separator();
  1983. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/save", TTR("Save"), KEY_MASK_ALT | KEY_MASK_CMD | KEY_S), FILE_SAVE);
  1984. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/save_as", TTR("Save As..")), FILE_SAVE_AS);
  1985. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/save_all", TTR("Save All"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_MASK_ALT | KEY_S), FILE_SAVE_ALL);
  1986. file_menu->get_popup()->add_separator();
  1987. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/reload_script_soft", TTR("Soft Reload Script"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_R), FILE_TOOL_RELOAD_SOFT);
  1988. file_menu->get_popup()->add_separator();
  1989. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/history_previous", TTR("History Prev"), KEY_MASK_ALT | KEY_LEFT), WINDOW_PREV);
  1990. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/history_next", TTR("History Next"), KEY_MASK_ALT | KEY_RIGHT), WINDOW_NEXT);
  1991. file_menu->get_popup()->add_separator();
  1992. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/import_theme", TTR("Import Theme")), FILE_IMPORT_THEME);
  1993. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/reload_theme", TTR("Reload Theme")), FILE_RELOAD_THEME);
  1994. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/save_theme", TTR("Save Theme")), FILE_SAVE_THEME);
  1995. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/save_theme_as", TTR("Save Theme As")), FILE_SAVE_THEME_AS);
  1996. file_menu->get_popup()->add_separator();
  1997. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/close_docs", TTR("Close Docs")), CLOSE_DOCS);
  1998. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/close_file", TTR("Close"), KEY_MASK_CMD | KEY_W), FILE_CLOSE);
  1999. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/close_all", TTR("Close All")), CLOSE_ALL);
  2000. file_menu->get_popup()->add_separator();
  2001. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/run_file", TTR("Run"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_X), FILE_RUN);
  2002. file_menu->get_popup()->add_separator();
  2003. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/toggle_scripts_panel", TTR("Toggle Scripts Panel"), KEY_MASK_CMD | KEY_BACKSLASH), TOGGLE_SCRIPTS_PANEL);
  2004. file_menu->get_popup()->connect("id_pressed", this, "_menu_option");
  2005. script_search_menu = memnew(MenuButton);
  2006. menu_hb->add_child(script_search_menu);
  2007. script_search_menu->set_text(TTR("Search"));
  2008. script_search_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/find", TTR("Find.."), KEY_MASK_CMD | KEY_F), HELP_SEARCH_FIND);
  2009. script_search_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/find_next", TTR("Find Next"), KEY_F3), HELP_SEARCH_FIND_NEXT);
  2010. script_search_menu->get_popup()->connect("id_pressed", this, "_menu_option");
  2011. script_search_menu->hide();
  2012. debug_menu = memnew(MenuButton);
  2013. menu_hb->add_child(debug_menu);
  2014. debug_menu->set_text(TTR("Debug"));
  2015. debug_menu->get_popup()->add_shortcut(ED_SHORTCUT("debugger/step_over", TTR("Step Over"), KEY_F10), DEBUG_NEXT);
  2016. debug_menu->get_popup()->add_shortcut(ED_SHORTCUT("debugger/step_into", TTR("Step Into"), KEY_F11), DEBUG_STEP);
  2017. debug_menu->get_popup()->add_separator();
  2018. debug_menu->get_popup()->add_shortcut(ED_SHORTCUT("debugger/break", TTR("Break")), DEBUG_BREAK);
  2019. debug_menu->get_popup()->add_shortcut(ED_SHORTCUT("debugger/continue", TTR("Continue"), KEY_F12), DEBUG_CONTINUE);
  2020. debug_menu->get_popup()->add_separator();
  2021. //debug_menu->get_popup()->add_check_item("Show Debugger",DEBUG_SHOW);
  2022. debug_menu->get_popup()->add_check_shortcut(ED_SHORTCUT("debugger/keep_debugger_open", TTR("Keep Debugger Open")), DEBUG_SHOW_KEEP_OPEN);
  2023. debug_menu->get_popup()->add_check_shortcut(ED_SHORTCUT("debugger/debug_with_exteral_editor", TTR("Debug with external editor")), DEBUG_WITH_EXTERNAL_EDITOR);
  2024. debug_menu->get_popup()->connect("id_pressed", this, "_menu_option");
  2025. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_NEXT), true);
  2026. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_STEP), true);
  2027. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_BREAK), true);
  2028. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_CONTINUE), true);
  2029. menu_hb->add_spacer();
  2030. script_icon = memnew(TextureRect);
  2031. menu_hb->add_child(script_icon);
  2032. script_name_label = memnew(Label);
  2033. menu_hb->add_child(script_name_label);
  2034. script_icon->hide();
  2035. script_name_label->hide();
  2036. menu_hb->add_spacer();
  2037. site_search = memnew(ToolButton);
  2038. site_search->set_text(TTR("Online Docs"));
  2039. site_search->connect("pressed", this, "_menu_option", varray(SEARCH_WEBSITE));
  2040. menu_hb->add_child(site_search);
  2041. site_search->set_tooltip(TTR("Open Godot online documentation"));
  2042. class_search = memnew(ToolButton);
  2043. class_search->set_text(TTR("Classes"));
  2044. class_search->connect("pressed", this, "_menu_option", varray(SEARCH_CLASSES));
  2045. menu_hb->add_child(class_search);
  2046. class_search->set_tooltip(TTR("Search the class hierarchy."));
  2047. help_search = memnew(ToolButton);
  2048. help_search->set_text(TTR("Search Help"));
  2049. help_search->connect("pressed", this, "_menu_option", varray(SEARCH_HELP));
  2050. menu_hb->add_child(help_search);
  2051. help_search->set_tooltip(TTR("Search the reference documentation."));
  2052. menu_hb->add_child(memnew(VSeparator));
  2053. script_back = memnew(ToolButton);
  2054. script_back->connect("pressed", this, "_history_back");
  2055. menu_hb->add_child(script_back);
  2056. script_back->set_disabled(true);
  2057. script_back->set_tooltip(TTR("Go to previous edited document."));
  2058. script_forward = memnew(ToolButton);
  2059. script_forward->connect("pressed", this, "_history_forward");
  2060. menu_hb->add_child(script_forward);
  2061. script_forward->set_disabled(true);
  2062. script_forward->set_tooltip(TTR("Go to next edited document."));
  2063. tab_container->connect("tab_changed", this, "_tab_changed");
  2064. erase_tab_confirm = memnew(ConfirmationDialog);
  2065. erase_tab_confirm->get_ok()->set_text(TTR("Save"));
  2066. erase_tab_confirm->add_button(TTR("Discard"), OS::get_singleton()->get_swap_ok_cancel(), "discard");
  2067. erase_tab_confirm->connect("confirmed", this, "_close_current_tab");
  2068. erase_tab_confirm->connect("custom_action", this, "_close_discard_current_tab");
  2069. add_child(erase_tab_confirm);
  2070. script_create_dialog = memnew(ScriptCreateDialog);
  2071. script_create_dialog->set_title(TTR("Create Script"));
  2072. add_child(script_create_dialog);
  2073. script_create_dialog->connect("script_created", this, "_script_created");
  2074. file_dialog_option = -1;
  2075. file_dialog = memnew(EditorFileDialog);
  2076. add_child(file_dialog);
  2077. file_dialog->connect("file_selected", this, "_file_dialog_action");
  2078. debugger = memnew(ScriptEditorDebugger(editor));
  2079. debugger->connect("goto_script_line", this, "_goto_script_line");
  2080. debugger->connect("show_debugger", this, "_show_debugger");
  2081. disk_changed = memnew(ConfirmationDialog);
  2082. {
  2083. VBoxContainer *vbc = memnew(VBoxContainer);
  2084. disk_changed->add_child(vbc);
  2085. //disk_changed->set_child_rect(vbc);
  2086. Label *dl = memnew(Label);
  2087. dl->set_text(TTR("The following files are newer on disk.\nWhat action should be taken?:"));
  2088. vbc->add_child(dl);
  2089. disk_changed_list = memnew(Tree);
  2090. vbc->add_child(disk_changed_list);
  2091. disk_changed_list->set_v_size_flags(SIZE_EXPAND_FILL);
  2092. disk_changed->connect("confirmed", this, "_reload_scripts");
  2093. disk_changed->get_ok()->set_text(TTR("Reload"));
  2094. disk_changed->add_button(TTR("Resave"), !OS::get_singleton()->get_swap_ok_cancel(), "resave");
  2095. disk_changed->connect("custom_action", this, "_resave_scripts");
  2096. }
  2097. add_child(disk_changed);
  2098. script_editor = this;
  2099. Button *db = EditorNode::get_singleton()->add_bottom_panel_item(TTR("Debugger"), debugger);
  2100. debugger->set_tool_button(db);
  2101. debugger->connect("breaked", this, "_breaked");
  2102. autosave_timer = memnew(Timer);
  2103. autosave_timer->set_one_shot(false);
  2104. add_child(autosave_timer);
  2105. grab_focus_block = false;
  2106. help_search_dialog = memnew(EditorHelpSearch);
  2107. add_child(help_search_dialog);
  2108. help_search_dialog->connect("go_to_help", this, "_help_class_goto");
  2109. help_index = memnew(EditorHelpIndex);
  2110. add_child(help_index);
  2111. help_index->connect("open_class", this, "_help_class_open");
  2112. history_pos = -1;
  2113. //debugger_gui->hide();
  2114. edit_pass = 0;
  2115. trim_trailing_whitespace_on_save = false;
  2116. convert_indent_on_save = false;
  2117. use_space_indentation = false;
  2118. ScriptServer::edit_request_func = _open_script_request;
  2119. add_style_override("panel", editor->get_gui_base()->get_stylebox("ScriptEditorPanel", "EditorStyles"));
  2120. tab_container->add_style_override("panel", editor->get_gui_base()->get_stylebox("ScriptEditor", "EditorStyles"));
  2121. }
  2122. ScriptEditor::~ScriptEditor() {
  2123. memdelete(completion_cache);
  2124. }
  2125. void ScriptEditorPlugin::edit(Object *p_object) {
  2126. if (!Object::cast_to<Script>(p_object))
  2127. return;
  2128. script_editor->edit(Object::cast_to<Script>(p_object));
  2129. }
  2130. bool ScriptEditorPlugin::handles(Object *p_object) const {
  2131. if (Object::cast_to<Script>(p_object)) {
  2132. bool valid = _can_open_in_editor(Object::cast_to<Script>(p_object));
  2133. if (!valid) { //user tried to open it by clicking
  2134. EditorNode::get_singleton()->show_warning(TTR("Built-in scripts can only be edited when the scene they belong to is loaded"));
  2135. }
  2136. return valid;
  2137. }
  2138. return p_object->is_class("Script");
  2139. }
  2140. void ScriptEditorPlugin::make_visible(bool p_visible) {
  2141. if (p_visible) {
  2142. script_editor->show();
  2143. script_editor->set_process(true);
  2144. script_editor->ensure_select_current();
  2145. } else {
  2146. script_editor->hide();
  2147. script_editor->set_process(false);
  2148. }
  2149. }
  2150. void ScriptEditorPlugin::selected_notify() {
  2151. script_editor->ensure_select_current();
  2152. }
  2153. void ScriptEditorPlugin::save_external_data() {
  2154. script_editor->save_all_scripts();
  2155. }
  2156. void ScriptEditorPlugin::apply_changes() {
  2157. script_editor->apply_scripts();
  2158. }
  2159. void ScriptEditorPlugin::restore_global_state() {
  2160. }
  2161. void ScriptEditorPlugin::save_global_state() {
  2162. }
  2163. void ScriptEditorPlugin::set_window_layout(Ref<ConfigFile> p_layout) {
  2164. script_editor->set_window_layout(p_layout);
  2165. }
  2166. void ScriptEditorPlugin::get_window_layout(Ref<ConfigFile> p_layout) {
  2167. script_editor->get_window_layout(p_layout);
  2168. }
  2169. void ScriptEditorPlugin::get_breakpoints(List<String> *p_breakpoints) {
  2170. return script_editor->get_breakpoints(p_breakpoints);
  2171. }
  2172. void ScriptEditorPlugin::edited_scene_changed() {
  2173. script_editor->edited_scene_changed();
  2174. }
  2175. ScriptEditorPlugin::ScriptEditorPlugin(EditorNode *p_node) {
  2176. editor = p_node;
  2177. script_editor = memnew(ScriptEditor(p_node));
  2178. editor->get_viewport()->add_child(script_editor);
  2179. script_editor->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  2180. script_editor->hide();
  2181. EDITOR_DEF("text_editor/files/auto_reload_scripts_on_external_change", true);
  2182. ScriptServer::set_reload_scripts_on_save(EDITOR_DEF("text_editor/files/auto_reload_and_parse_scripts_on_save", true));
  2183. EDITOR_DEF("text_editor/files/open_dominant_script_on_scene_change", true);
  2184. EDITOR_DEF("text_editor/external/use_external_editor", false);
  2185. EDITOR_DEF("text_editor/external/exec_path", "");
  2186. EDITOR_DEF("text_editor/open_scripts/script_temperature_enabled", true);
  2187. EDITOR_DEF("text_editor/open_scripts/highlight_current_script", true);
  2188. EDITOR_DEF("text_editor/open_scripts/script_temperature_history_size", 15);
  2189. EDITOR_DEF("text_editor/open_scripts/current_script_background_color", Color(1, 1, 1, 0.5));
  2190. EDITOR_DEF("text_editor/open_scripts/group_help_pages", true);
  2191. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::INT, "text_editor/open_scripts/sort_scripts_by", PROPERTY_HINT_ENUM, "Name,Path"));
  2192. EDITOR_DEF("text_editor/open_scripts/sort_scripts_by", 0);
  2193. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::INT, "text_editor/open_scripts/list_script_names_as", PROPERTY_HINT_ENUM, "Name,Parent Directory And Name,Full Path"));
  2194. EDITOR_DEF("text_editor/open_scripts/list_script_names_as", 0);
  2195. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "text_editor/external/exec_path", PROPERTY_HINT_GLOBAL_FILE));
  2196. EDITOR_DEF("text_editor/external/exec_flags", "");
  2197. ED_SHORTCUT("script_editor/open_recent", TTR("Open Recent"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_T);
  2198. ED_SHORTCUT("script_editor/clear_recent", TTR("Clear Recent Files"));
  2199. }
  2200. ScriptEditorPlugin::~ScriptEditorPlugin() {
  2201. }