script_editor_plugin.cpp 115 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550
  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-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "script_editor_plugin.h"
  31. #include "core/io/resource_loader.h"
  32. #include "core/os/file_access.h"
  33. #include "core/os/input.h"
  34. #include "core/os/keyboard.h"
  35. #include "core/os/os.h"
  36. #include "core/project_settings.h"
  37. #include "editor/editor_node.h"
  38. #include "editor/editor_run_script.h"
  39. #include "editor/editor_scale.h"
  40. #include "editor/editor_settings.h"
  41. #include "editor/filesystem_dock.h"
  42. #include "editor/find_in_files.h"
  43. #include "editor/node_dock.h"
  44. #include "editor/plugins/shader_editor_plugin.h"
  45. #include "editor/script_editor_debugger.h"
  46. #include "scene/main/viewport.h"
  47. #include "scene/scene_string_names.h"
  48. #include "script_text_editor.h"
  49. #include "text_editor.h"
  50. /*** SCRIPT EDITOR ****/
  51. void ScriptEditorBase::_bind_methods() {
  52. ADD_SIGNAL(MethodInfo("name_changed"));
  53. ADD_SIGNAL(MethodInfo("edited_script_changed"));
  54. ADD_SIGNAL(MethodInfo("request_help", PropertyInfo(Variant::STRING, "topic")));
  55. ADD_SIGNAL(MethodInfo("request_open_script_at_line", PropertyInfo(Variant::OBJECT, "script"), PropertyInfo(Variant::INT, "line")));
  56. ADD_SIGNAL(MethodInfo("request_save_history"));
  57. ADD_SIGNAL(MethodInfo("go_to_help", PropertyInfo(Variant::STRING, "what")));
  58. // TODO: This signal is no use for VisualScript.
  59. ADD_SIGNAL(MethodInfo("search_in_files_requested", PropertyInfo(Variant::STRING, "text")));
  60. }
  61. static bool _is_built_in_script(Script *p_script) {
  62. String path = p_script->get_path();
  63. return path.find("::") != -1;
  64. }
  65. class EditorScriptCodeCompletionCache : public ScriptCodeCompletionCache {
  66. struct Cache {
  67. uint64_t time_loaded;
  68. RES cache;
  69. };
  70. Map<String, Cache> cached;
  71. public:
  72. uint64_t max_time_cache;
  73. int max_cache_size;
  74. void cleanup() {
  75. List<Map<String, Cache>::Element *> to_clean;
  76. Map<String, Cache>::Element *I = cached.front();
  77. while (I) {
  78. if ((OS::get_singleton()->get_ticks_msec() - I->get().time_loaded) > max_time_cache) {
  79. to_clean.push_back(I);
  80. }
  81. I = I->next();
  82. }
  83. while (to_clean.front()) {
  84. cached.erase(to_clean.front()->get());
  85. to_clean.pop_front();
  86. }
  87. }
  88. virtual RES get_cached_resource(const String &p_path) {
  89. Map<String, Cache>::Element *E = cached.find(p_path);
  90. if (!E) {
  91. Cache c;
  92. c.cache = ResourceLoader::load(p_path);
  93. E = cached.insert(p_path, c);
  94. }
  95. E->get().time_loaded = OS::get_singleton()->get_ticks_msec();
  96. if (cached.size() > max_cache_size) {
  97. uint64_t older;
  98. Map<String, Cache>::Element *O = cached.front();
  99. older = O->get().time_loaded;
  100. Map<String, Cache>::Element *I = O;
  101. while (I) {
  102. if (I->get().time_loaded < older) {
  103. older = I->get().time_loaded;
  104. O = I;
  105. }
  106. I = I->next();
  107. }
  108. if (O != E) { //should never happen..
  109. cached.erase(O);
  110. }
  111. }
  112. return E->get().cache;
  113. }
  114. EditorScriptCodeCompletionCache() {
  115. max_cache_size = 128;
  116. max_time_cache = 5 * 60 * 1000; //minutes, five
  117. }
  118. virtual ~EditorScriptCodeCompletionCache() {}
  119. };
  120. void ScriptEditorQuickOpen::popup_dialog(const Vector<String> &p_functions, bool p_dontclear) {
  121. popup_centered_ratio(0.6);
  122. if (p_dontclear) {
  123. search_box->select_all();
  124. } else {
  125. search_box->clear();
  126. }
  127. search_box->grab_focus();
  128. functions = p_functions;
  129. _update_search();
  130. }
  131. void ScriptEditorQuickOpen::_text_changed(const String &p_newtext) {
  132. _update_search();
  133. }
  134. void ScriptEditorQuickOpen::_sbox_input(const Ref<InputEvent> &p_ie) {
  135. Ref<InputEventKey> k = p_ie;
  136. if (k.is_valid() && (k->get_scancode() == KEY_UP ||
  137. k->get_scancode() == KEY_DOWN ||
  138. k->get_scancode() == KEY_PAGEUP ||
  139. k->get_scancode() == KEY_PAGEDOWN)) {
  140. search_options->call("_gui_input", k);
  141. search_box->accept_event();
  142. }
  143. }
  144. void ScriptEditorQuickOpen::_update_search() {
  145. search_options->clear();
  146. TreeItem *root = search_options->create_item();
  147. for (int i = 0; i < functions.size(); i++) {
  148. String file = functions[i];
  149. if ((search_box->get_text() == "" || file.findn(search_box->get_text()) != -1)) {
  150. TreeItem *ti = search_options->create_item(root);
  151. ti->set_text(0, file);
  152. if (root->get_children() == ti) {
  153. ti->select(0);
  154. }
  155. }
  156. }
  157. get_ok()->set_disabled(root->get_children() == nullptr);
  158. }
  159. void ScriptEditorQuickOpen::_confirmed() {
  160. TreeItem *ti = search_options->get_selected();
  161. if (!ti) {
  162. return;
  163. }
  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. search_box->set_clear_button_enabled(true);
  173. FALLTHROUGH;
  174. }
  175. case NOTIFICATION_THEME_CHANGED: {
  176. search_box->set_right_icon(get_icon("Search", "EditorIcons"));
  177. } break;
  178. case NOTIFICATION_EXIT_TREE: {
  179. disconnect("confirmed", this, "_confirmed");
  180. } break;
  181. }
  182. }
  183. void ScriptEditorQuickOpen::_bind_methods() {
  184. ClassDB::bind_method(D_METHOD("_text_changed"), &ScriptEditorQuickOpen::_text_changed);
  185. ClassDB::bind_method(D_METHOD("_confirmed"), &ScriptEditorQuickOpen::_confirmed);
  186. ClassDB::bind_method(D_METHOD("_sbox_input"), &ScriptEditorQuickOpen::_sbox_input);
  187. ADD_SIGNAL(MethodInfo("goto_line", PropertyInfo(Variant::INT, "line")));
  188. }
  189. ScriptEditorQuickOpen::ScriptEditorQuickOpen() {
  190. VBoxContainer *vbc = memnew(VBoxContainer);
  191. add_child(vbc);
  192. search_box = memnew(LineEdit);
  193. vbc->add_margin_child(TTR("Search:"), search_box);
  194. search_box->connect("text_changed", this, "_text_changed");
  195. search_box->connect("gui_input", this, "_sbox_input");
  196. search_options = memnew(Tree);
  197. vbc->add_margin_child(TTR("Matches:"), search_options, true);
  198. get_ok()->set_text(TTR("Open"));
  199. get_ok()->set_disabled(true);
  200. register_text_enter(search_box);
  201. set_hide_on_ok(false);
  202. search_options->connect("item_activated", this, "_confirmed");
  203. search_options->set_hide_root(true);
  204. search_options->set_hide_folding(true);
  205. search_options->add_constant_override("draw_guides", 1);
  206. }
  207. /////////////////////////////////
  208. ScriptEditor *ScriptEditor::script_editor = nullptr;
  209. /*** SCRIPT EDITOR ******/
  210. String ScriptEditor::_get_debug_tooltip(const String &p_text, Node *_se) {
  211. String val = debugger->get_var_value(p_text);
  212. if (val != String()) {
  213. return p_text + ": " + val;
  214. } else {
  215. return String();
  216. }
  217. }
  218. void ScriptEditor::_breaked(bool p_breaked, bool p_can_debug) {
  219. if (bool(EditorSettings::get_singleton()->get("text_editor/external/use_external_editor"))) {
  220. return;
  221. }
  222. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_NEXT), !(p_breaked && p_can_debug));
  223. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_STEP), !(p_breaked && p_can_debug));
  224. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_BREAK), p_breaked);
  225. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_CONTINUE), !p_breaked);
  226. for (int i = 0; i < tab_container->get_child_count(); i++) {
  227. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  228. if (!se) {
  229. continue;
  230. }
  231. se->set_debugger_active(p_breaked);
  232. }
  233. }
  234. void ScriptEditor::_show_debugger(bool p_show) {
  235. }
  236. void ScriptEditor::_script_created(Ref<Script> p_script) {
  237. editor->push_item(p_script.operator->());
  238. }
  239. void ScriptEditor::_goto_script_line2(int p_line) {
  240. ScriptEditorBase *current = _get_current_editor();
  241. if (current) {
  242. current->goto_line(p_line);
  243. }
  244. }
  245. void ScriptEditor::_goto_script_line(REF p_script, int p_line) {
  246. Ref<Script> script = Object::cast_to<Script>(*p_script);
  247. if (script.is_valid() && (script->has_source_code() || script->get_path().is_resource_file())) {
  248. if (edit(p_script, p_line, 0)) {
  249. editor->push_item(p_script.ptr());
  250. ScriptEditorBase *current = _get_current_editor();
  251. if (ScriptTextEditor *script_text_editor = Object::cast_to<ScriptTextEditor>(current)) {
  252. script_text_editor->goto_line_centered(p_line);
  253. } else if (current) {
  254. current->goto_line(p_line, true);
  255. }
  256. }
  257. }
  258. }
  259. void ScriptEditor::_set_execution(REF p_script, int p_line) {
  260. Ref<Script> script = Object::cast_to<Script>(*p_script);
  261. if (script.is_valid() && (script->has_source_code() || script->get_path().is_resource_file())) {
  262. for (int i = 0; i < tab_container->get_child_count(); i++) {
  263. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  264. if (!se) {
  265. continue;
  266. }
  267. if ((script != nullptr && se->get_edited_resource() == p_script) || se->get_edited_resource()->get_path() == script->get_path()) {
  268. se->set_executing_line(p_line);
  269. }
  270. }
  271. }
  272. }
  273. void ScriptEditor::_clear_execution(REF p_script) {
  274. Ref<Script> script = Object::cast_to<Script>(*p_script);
  275. if (script.is_valid() && (script->has_source_code() || script->get_path().is_resource_file())) {
  276. for (int i = 0; i < tab_container->get_child_count(); i++) {
  277. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  278. if (!se) {
  279. continue;
  280. }
  281. if ((script != nullptr && se->get_edited_resource() == p_script) || se->get_edited_resource()->get_path() == script->get_path()) {
  282. se->clear_executing_line();
  283. }
  284. }
  285. }
  286. }
  287. ScriptEditorBase *ScriptEditor::_get_current_editor() const {
  288. int selected = tab_container->get_current_tab();
  289. if (selected < 0 || selected >= tab_container->get_child_count()) {
  290. return nullptr;
  291. }
  292. return Object::cast_to<ScriptEditorBase>(tab_container->get_child(selected));
  293. }
  294. void ScriptEditor::_update_history_arrows() {
  295. script_back->set_disabled(history_pos <= 0);
  296. script_forward->set_disabled(history_pos >= history.size() - 1);
  297. }
  298. void ScriptEditor::_save_history() {
  299. if (history_pos >= 0 && history_pos < history.size() && history[history_pos].control == tab_container->get_current_tab_control()) {
  300. Node *n = tab_container->get_current_tab_control();
  301. if (Object::cast_to<ScriptEditorBase>(n)) {
  302. history.write[history_pos].state = Object::cast_to<ScriptEditorBase>(n)->get_edit_state();
  303. }
  304. if (Object::cast_to<EditorHelp>(n)) {
  305. history.write[history_pos].state = Object::cast_to<EditorHelp>(n)->get_scroll();
  306. }
  307. }
  308. history.resize(history_pos + 1);
  309. ScriptHistory sh;
  310. sh.control = tab_container->get_current_tab_control();
  311. sh.state = Variant();
  312. history.push_back(sh);
  313. history_pos++;
  314. _update_history_arrows();
  315. }
  316. void ScriptEditor::_go_to_tab(int p_idx) {
  317. ScriptEditorBase *current = _get_current_editor();
  318. if (current) {
  319. if (current->is_unsaved()) {
  320. current->apply_code();
  321. }
  322. }
  323. Control *c = Object::cast_to<Control>(tab_container->get_child(p_idx));
  324. if (!c) {
  325. return;
  326. }
  327. if (history_pos >= 0 && history_pos < history.size() && history[history_pos].control == tab_container->get_current_tab_control()) {
  328. Node *n = tab_container->get_current_tab_control();
  329. if (Object::cast_to<ScriptEditorBase>(n)) {
  330. history.write[history_pos].state = Object::cast_to<ScriptEditorBase>(n)->get_edit_state();
  331. }
  332. if (Object::cast_to<EditorHelp>(n)) {
  333. history.write[history_pos].state = Object::cast_to<EditorHelp>(n)->get_scroll();
  334. }
  335. }
  336. history.resize(history_pos + 1);
  337. ScriptHistory sh;
  338. sh.control = c;
  339. sh.state = Variant();
  340. history.push_back(sh);
  341. history_pos++;
  342. tab_container->set_current_tab(p_idx);
  343. c = tab_container->get_current_tab_control();
  344. if (Object::cast_to<ScriptEditorBase>(c)) {
  345. script_name_label->set_text(Object::cast_to<ScriptEditorBase>(c)->get_name());
  346. script_icon->set_texture(Object::cast_to<ScriptEditorBase>(c)->get_icon());
  347. if (is_visible_in_tree()) {
  348. Object::cast_to<ScriptEditorBase>(c)->ensure_focus();
  349. }
  350. Ref<Script> script = Object::cast_to<ScriptEditorBase>(c)->get_edited_resource();
  351. if (script != nullptr) {
  352. notify_script_changed(script);
  353. }
  354. Object::cast_to<ScriptEditorBase>(c)->validate();
  355. }
  356. if (Object::cast_to<EditorHelp>(c)) {
  357. script_name_label->set_text(Object::cast_to<EditorHelp>(c)->get_class());
  358. script_icon->set_texture(get_icon("Help", "EditorIcons"));
  359. if (is_visible_in_tree()) {
  360. Object::cast_to<EditorHelp>(c)->set_focused();
  361. }
  362. }
  363. c->set_meta("__editor_pass", ++edit_pass);
  364. _update_history_arrows();
  365. _update_script_colors();
  366. _update_members_overview();
  367. _update_help_overview();
  368. _update_selected_editor_menu();
  369. _update_members_overview_visibility();
  370. _update_help_overview_visibility();
  371. }
  372. void ScriptEditor::_add_recent_script(String p_path) {
  373. if (p_path.empty()) {
  374. return;
  375. }
  376. Array rc = EditorSettings::get_singleton()->get_project_metadata("recent_files", "scripts", Array());
  377. if (rc.find(p_path) != -1) {
  378. rc.erase(p_path);
  379. }
  380. rc.push_front(p_path);
  381. if (rc.size() > 10) {
  382. rc.resize(10);
  383. }
  384. EditorSettings::get_singleton()->set_project_metadata("recent_files", "scripts", rc);
  385. _update_recent_scripts();
  386. }
  387. void ScriptEditor::_update_recent_scripts() {
  388. Array rc = EditorSettings::get_singleton()->get_project_metadata("recent_files", "scripts", Array());
  389. recent_scripts->clear();
  390. String path;
  391. for (int i = 0; i < rc.size(); i++) {
  392. path = rc[i];
  393. recent_scripts->add_item(path.replace("res://", ""));
  394. }
  395. recent_scripts->add_separator();
  396. recent_scripts->add_shortcut(ED_SHORTCUT("script_editor/clear_recent", TTR("Clear Recent Files")));
  397. recent_scripts->set_as_minsize();
  398. }
  399. void ScriptEditor::_open_recent_script(int p_idx) {
  400. // clear button
  401. if (p_idx == recent_scripts->get_item_count() - 1) {
  402. EditorSettings::get_singleton()->set_project_metadata("recent_files", "scripts", Array());
  403. call_deferred("_update_recent_scripts");
  404. return;
  405. }
  406. Array rc = EditorSettings::get_singleton()->get_project_metadata("recent_files", "scripts", Array());
  407. ERR_FAIL_INDEX(p_idx, rc.size());
  408. String path = rc[p_idx];
  409. // if its not on disk its a help file or deleted
  410. if (FileAccess::exists(path)) {
  411. List<String> extensions;
  412. ResourceLoader::get_recognized_extensions_for_type("Script", &extensions);
  413. if (extensions.find(path.get_extension())) {
  414. Ref<Script> script = ResourceLoader::load(path);
  415. if (script.is_valid()) {
  416. edit(script, true);
  417. return;
  418. }
  419. }
  420. Error err;
  421. Ref<TextFile> text_file = _load_text_file(path, &err);
  422. if (text_file.is_valid()) {
  423. edit(text_file, true);
  424. return;
  425. }
  426. // if it's a path then it's most likely a deleted file not help
  427. } else if (path.find("::") != -1) {
  428. // built-in script
  429. String res_path = path.get_slice("::", 0);
  430. if (ResourceLoader::get_resource_type(res_path) == "PackedScene") {
  431. if (!EditorNode::get_singleton()->is_scene_open(res_path)) {
  432. EditorNode::get_singleton()->load_scene(res_path);
  433. }
  434. } else {
  435. EditorNode::get_singleton()->load_resource(res_path);
  436. }
  437. Ref<Script> script = ResourceLoader::load(path);
  438. if (script.is_valid()) {
  439. edit(script, true);
  440. return;
  441. }
  442. } else if (!path.is_resource_file()) {
  443. _help_class_open(path);
  444. return;
  445. }
  446. rc.remove(p_idx);
  447. EditorSettings::get_singleton()->set_project_metadata("recent_files", "scripts", rc);
  448. _update_recent_scripts();
  449. _show_error_dialog(path);
  450. }
  451. void ScriptEditor::_show_error_dialog(String p_path) {
  452. error_dialog->set_text(vformat(TTR("Can't open '%s'. The file could have been moved or deleted."), p_path));
  453. error_dialog->popup_centered_minsize();
  454. }
  455. void ScriptEditor::_close_tab(int p_idx, bool p_save, bool p_history_back) {
  456. int selected = p_idx;
  457. if (selected < 0 || selected >= tab_container->get_child_count()) {
  458. return;
  459. }
  460. Node *tselected = tab_container->get_child(selected);
  461. ScriptEditorBase *current = Object::cast_to<ScriptEditorBase>(tselected);
  462. if (current) {
  463. Ref<Script> script = current->get_edited_resource();
  464. if (p_save) {
  465. // Do not try to save internal scripts
  466. if (!script.is_valid() || !(script->get_path() == "" || script->get_path().find("local://") != -1 || script->get_path().find("::") != -1)) {
  467. save_current_script();
  468. }
  469. }
  470. if (script != nullptr) {
  471. previous_scripts.push_back(script->get_path());
  472. notify_script_close(script);
  473. }
  474. }
  475. // roll back to previous tab
  476. if (p_history_back) {
  477. _history_back();
  478. }
  479. //remove from history
  480. history.resize(history_pos + 1);
  481. for (int i = 0; i < history.size(); i++) {
  482. if (history[i].control == tselected) {
  483. history.remove(i);
  484. i--;
  485. history_pos--;
  486. }
  487. }
  488. if (history_pos >= history.size()) {
  489. history_pos = history.size() - 1;
  490. }
  491. int idx = tab_container->get_current_tab();
  492. if (current) {
  493. current->clear_edit_menu();
  494. }
  495. memdelete(tselected);
  496. if (idx >= tab_container->get_child_count()) {
  497. idx = tab_container->get_child_count() - 1;
  498. }
  499. if (idx >= 0) {
  500. if (history_pos >= 0) {
  501. idx = history[history_pos].control->get_index();
  502. }
  503. tab_container->set_current_tab(idx);
  504. } else {
  505. _update_selected_editor_menu();
  506. }
  507. _update_history_arrows();
  508. _update_script_names();
  509. _update_members_overview_visibility();
  510. _update_help_overview_visibility();
  511. _save_layout();
  512. }
  513. void ScriptEditor::_close_current_tab(bool p_save) {
  514. _close_tab(tab_container->get_current_tab(), p_save);
  515. }
  516. void ScriptEditor::_close_discard_current_tab(const String &p_str) {
  517. _close_tab(tab_container->get_current_tab(), false);
  518. erase_tab_confirm->hide();
  519. }
  520. void ScriptEditor::_close_docs_tab() {
  521. int child_count = tab_container->get_child_count();
  522. for (int i = child_count - 1; i >= 0; i--) {
  523. EditorHelp *se = Object::cast_to<EditorHelp>(tab_container->get_child(i));
  524. if (se) {
  525. _close_tab(i, true, false);
  526. }
  527. }
  528. }
  529. void ScriptEditor::_copy_script_path() {
  530. ScriptEditorBase *se = _get_current_editor();
  531. if (se) {
  532. RES script = se->get_edited_resource();
  533. OS::get_singleton()->set_clipboard(script->get_path());
  534. }
  535. }
  536. void ScriptEditor::_close_other_tabs() {
  537. int child_count = tab_container->get_child_count();
  538. int current_idx = tab_container->get_current_tab();
  539. for (int i = child_count - 1; i >= 0; i--) {
  540. if (i == current_idx) {
  541. continue;
  542. }
  543. tab_container->set_current_tab(i);
  544. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  545. if (se) {
  546. // Maybe there are unsaved changes
  547. if (se->is_unsaved()) {
  548. _ask_close_current_unsaved_tab(se);
  549. continue;
  550. }
  551. }
  552. _close_current_tab(false);
  553. }
  554. }
  555. void ScriptEditor::_close_all_tabs() {
  556. int child_count = tab_container->get_child_count();
  557. for (int i = child_count - 1; i >= 0; i--) {
  558. tab_container->set_current_tab(i);
  559. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  560. if (se) {
  561. // Maybe there are unsaved changes
  562. if (se->is_unsaved()) {
  563. _ask_close_current_unsaved_tab(se);
  564. continue;
  565. }
  566. }
  567. _close_current_tab(false);
  568. }
  569. }
  570. void ScriptEditor::_ask_close_current_unsaved_tab(ScriptEditorBase *current) {
  571. erase_tab_confirm->set_text(TTR("Close and save changes?") + "\n\"" + current->get_name() + "\"");
  572. erase_tab_confirm->popup_centered_minsize();
  573. }
  574. void ScriptEditor::_resave_scripts(const String &p_str) {
  575. apply_scripts();
  576. for (int i = 0; i < tab_container->get_child_count(); i++) {
  577. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  578. if (!se) {
  579. continue;
  580. }
  581. RES script = se->get_edited_resource();
  582. if (script->get_path() == "" || script->get_path().find("local://") != -1 || script->get_path().find("::") != -1) {
  583. continue; //internal script, who cares
  584. }
  585. if (trim_trailing_whitespace_on_save) {
  586. se->trim_trailing_whitespace();
  587. }
  588. se->insert_final_newline();
  589. if (convert_indent_on_save) {
  590. if (use_space_indentation) {
  591. se->convert_indent_to_spaces();
  592. } else {
  593. se->convert_indent_to_tabs();
  594. }
  595. }
  596. Ref<TextFile> text_file = script;
  597. if (text_file != nullptr) {
  598. se->apply_code();
  599. _save_text_file(text_file, text_file->get_path());
  600. break;
  601. } else {
  602. editor->save_resource(script);
  603. }
  604. se->tag_saved_version();
  605. }
  606. disk_changed->hide();
  607. }
  608. void ScriptEditor::_reload_scripts() {
  609. for (int i = 0; i < tab_container->get_child_count(); i++) {
  610. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  611. if (!se) {
  612. continue;
  613. }
  614. RES edited_res = se->get_edited_resource();
  615. if (edited_res->get_path() == "" || edited_res->get_path().find("local://") != -1 || edited_res->get_path().find("::") != -1) {
  616. continue; //internal script, who cares
  617. }
  618. uint64_t last_date = edited_res->get_last_modified_time();
  619. uint64_t date = FileAccess::get_modified_time(edited_res->get_path());
  620. if (last_date == date) {
  621. continue;
  622. }
  623. Ref<Script> script = edited_res;
  624. if (script != nullptr) {
  625. Ref<Script> rel_script = ResourceLoader::load(script->get_path(), script->get_class(), true);
  626. ERR_CONTINUE(!rel_script.is_valid());
  627. script->set_source_code(rel_script->get_source_code());
  628. script->set_last_modified_time(rel_script->get_last_modified_time());
  629. script->reload();
  630. }
  631. Ref<TextFile> text_file = edited_res;
  632. if (text_file != nullptr) {
  633. Error err;
  634. Ref<TextFile> rel_text_file = _load_text_file(text_file->get_path(), &err);
  635. ERR_CONTINUE(!rel_text_file.is_valid());
  636. text_file->set_text(rel_text_file->get_text());
  637. text_file->set_last_modified_time(rel_text_file->get_last_modified_time());
  638. }
  639. se->reload_text();
  640. }
  641. disk_changed->hide();
  642. _update_script_names();
  643. }
  644. void ScriptEditor::_res_saved_callback(const Ref<Resource> &p_res) {
  645. for (int i = 0; i < tab_container->get_child_count(); i++) {
  646. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  647. if (!se) {
  648. continue;
  649. }
  650. RES script = se->get_edited_resource();
  651. if (script->get_path() == "" || script->get_path().find("local://") != -1 || script->get_path().find("::") != -1) {
  652. continue; //internal script, who cares
  653. }
  654. if (script == p_res) {
  655. se->tag_saved_version();
  656. }
  657. }
  658. _update_script_names();
  659. _trigger_live_script_reload();
  660. }
  661. void ScriptEditor::_trigger_live_script_reload() {
  662. if (!pending_auto_reload && auto_reload_running_scripts) {
  663. call_deferred("_live_auto_reload_running_scripts");
  664. pending_auto_reload = true;
  665. }
  666. }
  667. void ScriptEditor::_live_auto_reload_running_scripts() {
  668. pending_auto_reload = false;
  669. debugger->reload_scripts();
  670. }
  671. bool ScriptEditor::_test_script_times_on_disk(RES p_for_script) {
  672. disk_changed_list->clear();
  673. TreeItem *r = disk_changed_list->create_item();
  674. disk_changed_list->set_hide_root(true);
  675. bool need_ask = false;
  676. bool need_reload = false;
  677. bool use_autoreload = bool(EDITOR_DEF("text_editor/files/auto_reload_scripts_on_external_change", false));
  678. for (int i = 0; i < tab_container->get_child_count(); i++) {
  679. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  680. if (se) {
  681. RES edited_res = se->get_edited_resource();
  682. if (p_for_script.is_valid() && edited_res.is_valid() && p_for_script != edited_res) {
  683. continue;
  684. }
  685. if (edited_res->get_path() == "" || edited_res->get_path().find("local://") != -1 || edited_res->get_path().find("::") != -1) {
  686. continue; //internal script, who cares
  687. }
  688. uint64_t last_date = edited_res->get_last_modified_time();
  689. uint64_t date = FileAccess::get_modified_time(edited_res->get_path());
  690. if (last_date != date) {
  691. TreeItem *ti = disk_changed_list->create_item(r);
  692. ti->set_text(0, edited_res->get_path().get_file());
  693. if (!use_autoreload || se->is_unsaved()) {
  694. need_ask = true;
  695. }
  696. need_reload = true;
  697. }
  698. }
  699. }
  700. if (need_reload) {
  701. if (!need_ask) {
  702. script_editor->_reload_scripts();
  703. need_reload = false;
  704. } else {
  705. disk_changed->call_deferred("popup_centered_ratio", 0.5);
  706. }
  707. }
  708. return need_reload;
  709. }
  710. void ScriptEditor::_file_dialog_action(String p_file) {
  711. switch (file_dialog_option) {
  712. case FILE_NEW_TEXTFILE: {
  713. Error err;
  714. FileAccess *file = FileAccess::open(p_file, FileAccess::WRITE, &err);
  715. if (err) {
  716. editor->show_warning(TTR("Error writing TextFile:") + "\n" + p_file, TTR("Error!"));
  717. break;
  718. }
  719. file->close();
  720. memdelete(file);
  721. FALLTHROUGH;
  722. }
  723. case FILE_OPEN: {
  724. List<String> extensions;
  725. ResourceLoader::get_recognized_extensions_for_type("Script", &extensions);
  726. if (extensions.find(p_file.get_extension())) {
  727. Ref<Script> scr = ResourceLoader::load(p_file);
  728. if (!scr.is_valid()) {
  729. editor->show_warning(TTR("Could not load file at:") + "\n\n" + p_file, TTR("Error!"));
  730. file_dialog_option = -1;
  731. return;
  732. }
  733. edit(scr);
  734. file_dialog_option = -1;
  735. return;
  736. }
  737. Error error;
  738. Ref<TextFile> text_file = _load_text_file(p_file, &error);
  739. if (error != OK) {
  740. editor->show_warning(TTR("Could not load file at:") + "\n\n" + p_file, TTR("Error!"));
  741. }
  742. if (text_file.is_valid()) {
  743. edit(text_file);
  744. file_dialog_option = -1;
  745. return;
  746. }
  747. } break;
  748. case FILE_SAVE_AS: {
  749. ScriptEditorBase *current = _get_current_editor();
  750. if (current) {
  751. RES resource = current->get_edited_resource();
  752. String path = ProjectSettings::get_singleton()->localize_path(p_file);
  753. Error err = _save_text_file(resource, path);
  754. if (err != OK) {
  755. editor->show_accept(TTR("Error saving file!"), TTR("OK"));
  756. return;
  757. }
  758. resource->set_path(path);
  759. _update_script_names();
  760. }
  761. } break;
  762. case THEME_SAVE_AS: {
  763. if (!EditorSettings::get_singleton()->save_text_editor_theme_as(p_file)) {
  764. editor->show_warning(TTR("Error while saving theme."), TTR("Error Saving"));
  765. }
  766. } break;
  767. case THEME_IMPORT: {
  768. if (!EditorSettings::get_singleton()->import_text_editor_theme(p_file)) {
  769. editor->show_warning(TTR("Error importing theme."), TTR("Error Importing"));
  770. }
  771. } break;
  772. }
  773. file_dialog_option = -1;
  774. }
  775. Ref<Script> ScriptEditor::_get_current_script() {
  776. ScriptEditorBase *current = _get_current_editor();
  777. if (current) {
  778. Ref<Script> script = current->get_edited_resource();
  779. return script != nullptr ? script : nullptr;
  780. } else {
  781. return nullptr;
  782. }
  783. }
  784. Array ScriptEditor::_get_open_scripts() const {
  785. Array ret;
  786. Vector<Ref<Script>> scripts = get_open_scripts();
  787. int scrits_amount = scripts.size();
  788. for (int idx_script = 0; idx_script < scrits_amount; idx_script++) {
  789. ret.push_back(scripts[idx_script]);
  790. }
  791. return ret;
  792. }
  793. bool ScriptEditor::toggle_scripts_panel() {
  794. list_split->set_visible(!list_split->is_visible());
  795. EditorSettings::get_singleton()->set_project_metadata("scripts_panel", "show_scripts_panel", list_split->is_visible());
  796. return list_split->is_visible();
  797. }
  798. bool ScriptEditor::is_scripts_panel_toggled() {
  799. return list_split->is_visible();
  800. }
  801. void ScriptEditor::_menu_option(int p_option) {
  802. ScriptEditorBase *current = _get_current_editor();
  803. switch (p_option) {
  804. case FILE_NEW: {
  805. script_create_dialog->config("Node", "new_script", false, false);
  806. script_create_dialog->popup_centered();
  807. } break;
  808. case FILE_NEW_TEXTFILE: {
  809. file_dialog->set_mode(EditorFileDialog::MODE_SAVE_FILE);
  810. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  811. file_dialog_option = FILE_NEW_TEXTFILE;
  812. file_dialog->clear_filters();
  813. file_dialog->popup_centered_ratio();
  814. file_dialog->set_title(TTR("New Text File..."));
  815. } break;
  816. case FILE_OPEN: {
  817. file_dialog->set_mode(EditorFileDialog::MODE_OPEN_FILE);
  818. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  819. file_dialog_option = FILE_OPEN;
  820. List<String> extensions;
  821. ResourceLoader::get_recognized_extensions_for_type("Script", &extensions);
  822. file_dialog->clear_filters();
  823. for (int i = 0; i < extensions.size(); i++) {
  824. file_dialog->add_filter("*." + extensions[i] + " ; " + extensions[i].to_upper());
  825. }
  826. file_dialog->popup_centered_ratio();
  827. file_dialog->set_title(TTR("Open File"));
  828. return;
  829. } break;
  830. case FILE_REOPEN_CLOSED: {
  831. if (previous_scripts.empty()) {
  832. return;
  833. }
  834. String path = previous_scripts.back()->get();
  835. previous_scripts.pop_back();
  836. List<String> extensions;
  837. ResourceLoader::get_recognized_extensions_for_type("Script", &extensions);
  838. bool built_in = !path.is_resource_file();
  839. if (extensions.find(path.get_extension()) || built_in) {
  840. if (built_in) {
  841. String res_path = path.get_slice("::", 0);
  842. if (ResourceLoader::get_resource_type(res_path) == "PackedScene") {
  843. if (!EditorNode::get_singleton()->is_scene_open(res_path)) {
  844. EditorNode::get_singleton()->load_scene(res_path);
  845. script_editor->call_deferred("_menu_option", p_option);
  846. previous_scripts.push_back(path); //repeat the operation
  847. return;
  848. }
  849. } else {
  850. EditorNode::get_singleton()->load_resource(res_path);
  851. }
  852. }
  853. Ref<Script> scr = ResourceLoader::load(path);
  854. if (!scr.is_valid()) {
  855. editor->show_warning(TTR("Could not load file at:") + "\n\n" + path, TTR("Error!"));
  856. file_dialog_option = -1;
  857. return;
  858. }
  859. edit(scr);
  860. file_dialog_option = -1;
  861. return;
  862. } else {
  863. Error error;
  864. Ref<TextFile> text_file = _load_text_file(path, &error);
  865. if (error != OK) {
  866. editor->show_warning(TTR("Could not load file at:") + "\n\n" + path, TTR("Error!"));
  867. }
  868. if (text_file.is_valid()) {
  869. edit(text_file);
  870. file_dialog_option = -1;
  871. return;
  872. }
  873. }
  874. } break;
  875. case FILE_SAVE_ALL: {
  876. if (_test_script_times_on_disk()) {
  877. return;
  878. }
  879. save_all_scripts();
  880. } break;
  881. case SEARCH_IN_FILES: {
  882. _on_find_in_files_requested("");
  883. } break;
  884. case SEARCH_HELP: {
  885. help_search_dialog->popup_dialog();
  886. } break;
  887. case SEARCH_WEBSITE: {
  888. OS::get_singleton()->shell_open("https://docs.godotengine.org/");
  889. } break;
  890. case WINDOW_NEXT: {
  891. _history_forward();
  892. } break;
  893. case WINDOW_PREV: {
  894. _history_back();
  895. } break;
  896. case WINDOW_SORT: {
  897. _sort_list_on_update = true;
  898. _update_script_names();
  899. } break;
  900. case DEBUG_KEEP_DEBUGGER_OPEN: {
  901. bool ischecked = debug_menu->get_popup()->is_item_checked(debug_menu->get_popup()->get_item_index(DEBUG_KEEP_DEBUGGER_OPEN));
  902. if (debugger) {
  903. debugger->set_hide_on_stop(ischecked);
  904. }
  905. debug_menu->get_popup()->set_item_checked(debug_menu->get_popup()->get_item_index(DEBUG_KEEP_DEBUGGER_OPEN), !ischecked);
  906. EditorSettings::get_singleton()->set_project_metadata("debug_options", "keep_debugger_open", !ischecked);
  907. } break;
  908. case DEBUG_WITH_EXTERNAL_EDITOR: {
  909. bool ischecked = debug_menu->get_popup()->is_item_checked(debug_menu->get_popup()->get_item_index(DEBUG_WITH_EXTERNAL_EDITOR));
  910. if (debugger) {
  911. debugger->set_debug_with_external_editor(!ischecked);
  912. }
  913. debug_menu->get_popup()->set_item_checked(debug_menu->get_popup()->get_item_index(DEBUG_WITH_EXTERNAL_EDITOR), !ischecked);
  914. EditorSettings::get_singleton()->set_project_metadata("debug_options", "debug_with_external_editor", !ischecked);
  915. } break;
  916. case TOGGLE_SCRIPTS_PANEL: {
  917. if (current) {
  918. ScriptTextEditor *editor = Object::cast_to<ScriptTextEditor>(current);
  919. toggle_scripts_panel();
  920. if (editor) {
  921. editor->update_toggle_scripts_button();
  922. }
  923. } else {
  924. toggle_scripts_panel();
  925. }
  926. }
  927. }
  928. if (current) {
  929. switch (p_option) {
  930. case FILE_SAVE: {
  931. save_current_script();
  932. } break;
  933. case FILE_SAVE_AS: {
  934. if (trim_trailing_whitespace_on_save) {
  935. current->trim_trailing_whitespace();
  936. }
  937. current->insert_final_newline();
  938. if (convert_indent_on_save) {
  939. if (use_space_indentation) {
  940. current->convert_indent_to_spaces();
  941. } else {
  942. current->convert_indent_to_tabs();
  943. }
  944. }
  945. RES resource = current->get_edited_resource();
  946. Ref<TextFile> text_file = resource;
  947. if (text_file != nullptr) {
  948. file_dialog->set_mode(EditorFileDialog::MODE_SAVE_FILE);
  949. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  950. file_dialog_option = FILE_SAVE_AS;
  951. List<String> extensions;
  952. ResourceLoader::get_recognized_extensions_for_type("Script", &extensions);
  953. file_dialog->clear_filters();
  954. file_dialog->set_current_dir(text_file->get_path().get_base_dir());
  955. file_dialog->set_current_file(text_file->get_path().get_file());
  956. file_dialog->popup_centered_ratio();
  957. file_dialog->set_title(TTR("Save File As..."));
  958. break;
  959. }
  960. editor->push_item(resource.ptr());
  961. editor->save_resource_as(resource);
  962. } break;
  963. case FILE_TOOL_RELOAD:
  964. case FILE_TOOL_RELOAD_SOFT: {
  965. current->reload(p_option == FILE_TOOL_RELOAD_SOFT);
  966. } break;
  967. case FILE_RUN: {
  968. Ref<Script> scr = current->get_edited_resource();
  969. if (scr == nullptr || scr.is_null()) {
  970. EditorNode::get_singleton()->show_warning(TTR("Can't obtain the script for running."));
  971. break;
  972. }
  973. current->apply_code();
  974. Error err = scr->reload(false); //hard reload script before running always
  975. if (err != OK) {
  976. EditorNode::get_singleton()->show_warning(TTR("Script failed reloading, check console for errors."));
  977. return;
  978. }
  979. if (!scr->is_tool()) {
  980. EditorNode::get_singleton()->show_warning(TTR("Script is not in tool mode, will not be able to run."));
  981. return;
  982. }
  983. if (!ClassDB::is_parent_class(scr->get_instance_base_type(), "EditorScript")) {
  984. EditorNode::get_singleton()->show_warning(TTR("To run this script, it must inherit EditorScript and be set to tool mode."));
  985. return;
  986. }
  987. Ref<EditorScript> es = memnew(EditorScript);
  988. es->set_script(scr.get_ref_ptr());
  989. es->set_editor(EditorNode::get_singleton());
  990. es->_run();
  991. EditorNode::get_undo_redo()->clear_history();
  992. } break;
  993. case FILE_CLOSE: {
  994. if (current->is_unsaved()) {
  995. _ask_close_current_unsaved_tab(current);
  996. } else {
  997. _close_current_tab(false);
  998. }
  999. } break;
  1000. case FILE_COPY_PATH: {
  1001. _copy_script_path();
  1002. } break;
  1003. case SHOW_IN_FILE_SYSTEM: {
  1004. const RES script = current->get_edited_resource();
  1005. const String path = script->get_path();
  1006. if (!path.empty()) {
  1007. FileSystemDock *file_system_dock = EditorNode::get_singleton()->get_filesystem_dock();
  1008. file_system_dock->navigate_to_path(path);
  1009. // Ensure that the FileSystem dock is visible.
  1010. TabContainer *tab_container = (TabContainer *)file_system_dock->get_parent_control();
  1011. tab_container->set_current_tab(file_system_dock->get_position_in_parent());
  1012. }
  1013. } break;
  1014. case CLOSE_DOCS: {
  1015. _close_docs_tab();
  1016. } break;
  1017. case CLOSE_OTHER_TABS: {
  1018. _close_other_tabs();
  1019. } break;
  1020. case CLOSE_ALL: {
  1021. _close_all_tabs();
  1022. } break;
  1023. case DEBUG_NEXT: {
  1024. if (debugger) {
  1025. debugger->debug_next();
  1026. }
  1027. } break;
  1028. case DEBUG_STEP: {
  1029. if (debugger) {
  1030. debugger->debug_step();
  1031. }
  1032. } break;
  1033. case DEBUG_BREAK: {
  1034. if (debugger) {
  1035. debugger->debug_break();
  1036. }
  1037. } break;
  1038. case DEBUG_CONTINUE: {
  1039. if (debugger) {
  1040. debugger->debug_continue();
  1041. }
  1042. } break;
  1043. case WINDOW_MOVE_UP: {
  1044. if (tab_container->get_current_tab() > 0) {
  1045. tab_container->move_child(current, tab_container->get_current_tab() - 1);
  1046. tab_container->set_current_tab(tab_container->get_current_tab() - 1);
  1047. _update_script_names();
  1048. }
  1049. } break;
  1050. case WINDOW_MOVE_DOWN: {
  1051. if (tab_container->get_current_tab() < tab_container->get_child_count() - 1) {
  1052. tab_container->move_child(current, tab_container->get_current_tab() + 1);
  1053. tab_container->set_current_tab(tab_container->get_current_tab() + 1);
  1054. _update_script_names();
  1055. }
  1056. } break;
  1057. default: {
  1058. if (p_option >= WINDOW_SELECT_BASE) {
  1059. tab_container->set_current_tab(p_option - WINDOW_SELECT_BASE);
  1060. _update_script_names();
  1061. }
  1062. }
  1063. }
  1064. } else {
  1065. EditorHelp *help = Object::cast_to<EditorHelp>(tab_container->get_current_tab_control());
  1066. if (help) {
  1067. switch (p_option) {
  1068. case HELP_SEARCH_FIND: {
  1069. help->popup_search();
  1070. } break;
  1071. case HELP_SEARCH_FIND_NEXT: {
  1072. help->search_again();
  1073. } break;
  1074. case HELP_SEARCH_FIND_PREVIOUS: {
  1075. help->search_again(true);
  1076. } break;
  1077. case FILE_CLOSE: {
  1078. _close_current_tab();
  1079. } break;
  1080. case CLOSE_DOCS: {
  1081. _close_docs_tab();
  1082. } break;
  1083. case CLOSE_OTHER_TABS: {
  1084. _close_other_tabs();
  1085. } break;
  1086. case CLOSE_ALL: {
  1087. _close_all_tabs();
  1088. } break;
  1089. case WINDOW_MOVE_UP: {
  1090. if (tab_container->get_current_tab() > 0) {
  1091. tab_container->move_child(help, tab_container->get_current_tab() - 1);
  1092. tab_container->set_current_tab(tab_container->get_current_tab() - 1);
  1093. _update_script_names();
  1094. }
  1095. } break;
  1096. case WINDOW_MOVE_DOWN: {
  1097. if (tab_container->get_current_tab() < tab_container->get_child_count() - 1) {
  1098. tab_container->move_child(help, tab_container->get_current_tab() + 1);
  1099. tab_container->set_current_tab(tab_container->get_current_tab() + 1);
  1100. _update_script_names();
  1101. }
  1102. } break;
  1103. }
  1104. }
  1105. }
  1106. }
  1107. void ScriptEditor::_update_debug_options() {
  1108. bool keep_debugger_open = EditorSettings::get_singleton()->get_project_metadata("debug_options", "keep_debugger_open", false);
  1109. bool debug_with_external_editor = EditorSettings::get_singleton()->get_project_metadata("debug_options", "debug_with_external_editor", false);
  1110. if (keep_debugger_open) {
  1111. _menu_option(DEBUG_KEEP_DEBUGGER_OPEN);
  1112. }
  1113. if (debug_with_external_editor) {
  1114. _menu_option(DEBUG_WITH_EXTERNAL_EDITOR);
  1115. }
  1116. }
  1117. void ScriptEditor::_theme_option(int p_option) {
  1118. switch (p_option) {
  1119. case THEME_IMPORT: {
  1120. file_dialog->set_mode(EditorFileDialog::MODE_OPEN_FILE);
  1121. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  1122. file_dialog_option = THEME_IMPORT;
  1123. file_dialog->clear_filters();
  1124. file_dialog->add_filter("*.tet");
  1125. file_dialog->popup_centered_ratio();
  1126. file_dialog->set_title(TTR("Import Theme"));
  1127. } break;
  1128. case THEME_RELOAD: {
  1129. EditorSettings::get_singleton()->load_text_editor_theme();
  1130. } break;
  1131. case THEME_SAVE: {
  1132. if (EditorSettings::get_singleton()->is_default_text_editor_theme()) {
  1133. ScriptEditor::_show_save_theme_as_dialog();
  1134. } else if (!EditorSettings::get_singleton()->save_text_editor_theme()) {
  1135. editor->show_warning(TTR("Error while saving theme"), TTR("Error saving"));
  1136. }
  1137. } break;
  1138. case THEME_SAVE_AS: {
  1139. ScriptEditor::_show_save_theme_as_dialog();
  1140. } break;
  1141. }
  1142. }
  1143. void ScriptEditor::_show_save_theme_as_dialog() {
  1144. file_dialog->set_mode(EditorFileDialog::MODE_SAVE_FILE);
  1145. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  1146. file_dialog_option = THEME_SAVE_AS;
  1147. file_dialog->clear_filters();
  1148. file_dialog->add_filter("*.tet");
  1149. file_dialog->set_current_path(EditorSettings::get_singleton()->get_text_editor_themes_dir().plus_file(EditorSettings::get_singleton()->get("text_editor/theme/color_theme")));
  1150. file_dialog->popup_centered_ratio();
  1151. file_dialog->set_title(TTR("Save Theme As..."));
  1152. }
  1153. void ScriptEditor::_tab_changed(int p_which) {
  1154. ensure_select_current();
  1155. }
  1156. void ScriptEditor::_notification(int p_what) {
  1157. switch (p_what) {
  1158. case NOTIFICATION_ENTER_TREE: {
  1159. editor->connect("play_pressed", this, "_editor_play");
  1160. editor->connect("pause_pressed", this, "_editor_pause");
  1161. editor->connect("stop_pressed", this, "_editor_stop");
  1162. editor->connect("script_add_function_request", this, "_add_callback");
  1163. editor->connect("resource_saved", this, "_res_saved_callback");
  1164. script_list->connect("item_selected", this, "_script_selected");
  1165. members_overview->connect("item_selected", this, "_members_overview_selected");
  1166. help_overview->connect("item_selected", this, "_help_overview_selected");
  1167. script_split->connect("dragged", this, "_script_split_dragged");
  1168. EditorSettings::get_singleton()->connect("settings_changed", this, "_editor_settings_changed");
  1169. FALLTHROUGH;
  1170. }
  1171. case NOTIFICATION_THEME_CHANGED: {
  1172. help_search->set_icon(get_icon("HelpSearch", "EditorIcons"));
  1173. site_search->set_icon(get_icon("Instance", "EditorIcons"));
  1174. script_forward->set_icon(get_icon("Forward", "EditorIcons"));
  1175. script_back->set_icon(get_icon("Back", "EditorIcons"));
  1176. members_overview_alphabeta_sort_button->set_icon(get_icon("Sort", "EditorIcons"));
  1177. filter_scripts->set_right_icon(get_icon("Search", "EditorIcons"));
  1178. filter_methods->set_right_icon(get_icon("Search", "EditorIcons"));
  1179. filename->add_style_override("normal", editor->get_gui_base()->get_stylebox("normal", "LineEdit"));
  1180. recent_scripts->set_as_minsize();
  1181. } break;
  1182. case NOTIFICATION_READY: {
  1183. get_tree()->connect("tree_changed", this, "_tree_changed");
  1184. editor->get_inspector_dock()->connect("request_help", this, "_request_help");
  1185. editor->connect("request_help_search", this, "_help_search");
  1186. _update_debug_options();
  1187. } break;
  1188. case NOTIFICATION_EXIT_TREE: {
  1189. editor->disconnect("play_pressed", this, "_editor_play");
  1190. editor->disconnect("pause_pressed", this, "_editor_pause");
  1191. editor->disconnect("stop_pressed", this, "_editor_stop");
  1192. } break;
  1193. case MainLoop::NOTIFICATION_WM_FOCUS_IN: {
  1194. _test_script_times_on_disk();
  1195. _update_modified_scripts_for_external_editor();
  1196. } break;
  1197. case CanvasItem::NOTIFICATION_VISIBILITY_CHANGED: {
  1198. if (is_visible()) {
  1199. find_in_files_button->show();
  1200. } else {
  1201. if (find_in_files->is_visible_in_tree()) {
  1202. editor->hide_bottom_panel();
  1203. }
  1204. find_in_files_button->hide();
  1205. }
  1206. } break;
  1207. default:
  1208. break;
  1209. }
  1210. }
  1211. bool ScriptEditor::can_take_away_focus() const {
  1212. ScriptEditorBase *current = _get_current_editor();
  1213. if (current) {
  1214. return current->can_lose_focus_on_node_selection();
  1215. } else {
  1216. return true;
  1217. }
  1218. }
  1219. void ScriptEditor::close_builtin_scripts_from_scene(const String &p_scene) {
  1220. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1221. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1222. if (se) {
  1223. Ref<Script> script = se->get_edited_resource();
  1224. if (script == nullptr || !script.is_valid()) {
  1225. continue;
  1226. }
  1227. if (script->get_path().find("::") != -1 && script->get_path().begins_with(p_scene)) { //is an internal script and belongs to scene being closed
  1228. _close_tab(i);
  1229. i--;
  1230. }
  1231. }
  1232. }
  1233. }
  1234. void ScriptEditor::edited_scene_changed() {
  1235. _update_modified_scripts_for_external_editor();
  1236. }
  1237. void ScriptEditor::notify_script_close(const Ref<Script> &p_script) {
  1238. emit_signal("script_close", p_script);
  1239. }
  1240. void ScriptEditor::notify_script_changed(const Ref<Script> &p_script) {
  1241. emit_signal("editor_script_changed", p_script);
  1242. }
  1243. void ScriptEditor::get_breakpoints(List<String> *p_breakpoints) {
  1244. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1245. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1246. if (!se) {
  1247. continue;
  1248. }
  1249. Ref<Script> script = se->get_edited_resource();
  1250. if (script == nullptr) {
  1251. continue;
  1252. }
  1253. List<int> bpoints;
  1254. se->get_breakpoints(&bpoints);
  1255. String base = script->get_path();
  1256. if (base.begins_with("local://") || base == "") {
  1257. continue;
  1258. }
  1259. for (List<int>::Element *E = bpoints.front(); E; E = E->next()) {
  1260. p_breakpoints->push_back(base + ":" + itos(E->get() + 1));
  1261. }
  1262. }
  1263. }
  1264. void ScriptEditor::ensure_focus_current() {
  1265. if (!is_inside_tree()) {
  1266. return;
  1267. }
  1268. ScriptEditorBase *current = _get_current_editor();
  1269. if (current) {
  1270. current->ensure_focus();
  1271. }
  1272. }
  1273. void ScriptEditor::_members_overview_selected(int p_idx) {
  1274. ScriptEditorBase *se = _get_current_editor();
  1275. if (!se) {
  1276. return;
  1277. }
  1278. // Go to the member's line and reset the cursor column. We can't change scroll_position
  1279. // directly until we have gone to the line first, since code might be folded.
  1280. se->goto_line(members_overview->get_item_metadata(p_idx));
  1281. Dictionary state = se->get_edit_state();
  1282. state["column"] = 0;
  1283. state["scroll_position"] = members_overview->get_item_metadata(p_idx);
  1284. se->set_edit_state(state);
  1285. }
  1286. void ScriptEditor::_help_overview_selected(int p_idx) {
  1287. Node *current = tab_container->get_child(tab_container->get_current_tab());
  1288. EditorHelp *se = Object::cast_to<EditorHelp>(current);
  1289. if (!se) {
  1290. return;
  1291. }
  1292. se->scroll_to_section(help_overview->get_item_metadata(p_idx));
  1293. }
  1294. void ScriptEditor::_script_selected(int p_idx) {
  1295. grab_focus_block = !Input::get_singleton()->is_mouse_button_pressed(1); //amazing hack, simply amazing
  1296. _go_to_tab(script_list->get_item_metadata(p_idx));
  1297. grab_focus_block = false;
  1298. }
  1299. void ScriptEditor::ensure_select_current() {
  1300. if (tab_container->get_child_count() && tab_container->get_current_tab() >= 0) {
  1301. ScriptEditorBase *se = _get_current_editor();
  1302. if (se) {
  1303. se->enable_editor();
  1304. if (!grab_focus_block && is_visible_in_tree()) {
  1305. se->ensure_focus();
  1306. }
  1307. }
  1308. }
  1309. _update_selected_editor_menu();
  1310. }
  1311. void ScriptEditor::_find_scripts(Node *p_base, Node *p_current, Set<Ref<Script>> &used) {
  1312. if (p_current != p_base && p_current->get_owner() != p_base) {
  1313. return;
  1314. }
  1315. if (p_current->get_script_instance()) {
  1316. Ref<Script> scr = p_current->get_script();
  1317. if (scr.is_valid()) {
  1318. used.insert(scr);
  1319. }
  1320. }
  1321. for (int i = 0; i < p_current->get_child_count(); i++) {
  1322. _find_scripts(p_base, p_current->get_child(i), used);
  1323. }
  1324. }
  1325. struct _ScriptEditorItemData {
  1326. String name;
  1327. String sort_key;
  1328. Ref<Texture> icon;
  1329. int index;
  1330. String tooltip;
  1331. bool used;
  1332. int category;
  1333. Node *ref;
  1334. bool operator<(const _ScriptEditorItemData &id) const {
  1335. if (category == id.category) {
  1336. if (sort_key == id.sort_key) {
  1337. return index < id.index;
  1338. } else {
  1339. return sort_key < id.sort_key;
  1340. }
  1341. } else {
  1342. return category < id.category;
  1343. }
  1344. }
  1345. };
  1346. void ScriptEditor::_update_members_overview_visibility() {
  1347. ScriptEditorBase *se = _get_current_editor();
  1348. if (!se) {
  1349. members_overview_alphabeta_sort_button->set_visible(false);
  1350. members_overview->set_visible(false);
  1351. overview_vbox->set_visible(false);
  1352. return;
  1353. }
  1354. if (members_overview_enabled && se->show_members_overview()) {
  1355. members_overview_alphabeta_sort_button->set_visible(true);
  1356. members_overview->set_visible(true);
  1357. overview_vbox->set_visible(true);
  1358. } else {
  1359. members_overview_alphabeta_sort_button->set_visible(false);
  1360. members_overview->set_visible(false);
  1361. overview_vbox->set_visible(false);
  1362. }
  1363. }
  1364. void ScriptEditor::_toggle_members_overview_alpha_sort(bool p_alphabetic_sort) {
  1365. EditorSettings::get_singleton()->set("text_editor/tools/sort_members_outline_alphabetically", p_alphabetic_sort);
  1366. _update_members_overview();
  1367. }
  1368. void ScriptEditor::_update_members_overview() {
  1369. members_overview->clear();
  1370. ScriptEditorBase *se = _get_current_editor();
  1371. if (!se) {
  1372. return;
  1373. }
  1374. Vector<String> functions = se->get_functions();
  1375. if (EditorSettings::get_singleton()->get("text_editor/tools/sort_members_outline_alphabetically")) {
  1376. functions.sort();
  1377. }
  1378. for (int i = 0; i < functions.size(); i++) {
  1379. String filter = filter_methods->get_text();
  1380. String name = functions[i].get_slice(":", 0);
  1381. if (filter == "" || filter.is_subsequence_ofi(name)) {
  1382. members_overview->add_item(name);
  1383. members_overview->set_item_metadata(members_overview->get_item_count() - 1, functions[i].get_slice(":", 1).to_int() - 1);
  1384. }
  1385. }
  1386. String path = se->get_edited_resource()->get_path();
  1387. bool built_in = !path.is_resource_file();
  1388. String name = built_in ? path.get_file() : se->get_name();
  1389. filename->set_text(name);
  1390. }
  1391. void ScriptEditor::_update_help_overview_visibility() {
  1392. int selected = tab_container->get_current_tab();
  1393. if (selected < 0 || selected >= tab_container->get_child_count()) {
  1394. help_overview->set_visible(false);
  1395. return;
  1396. }
  1397. Node *current = tab_container->get_child(tab_container->get_current_tab());
  1398. EditorHelp *se = Object::cast_to<EditorHelp>(current);
  1399. if (!se) {
  1400. help_overview->set_visible(false);
  1401. return;
  1402. }
  1403. if (help_overview_enabled) {
  1404. members_overview_alphabeta_sort_button->set_visible(false);
  1405. help_overview->set_visible(true);
  1406. overview_vbox->set_visible(true);
  1407. filename->set_text(se->get_name());
  1408. } else {
  1409. help_overview->set_visible(false);
  1410. overview_vbox->set_visible(false);
  1411. }
  1412. }
  1413. void ScriptEditor::_update_help_overview() {
  1414. help_overview->clear();
  1415. int selected = tab_container->get_current_tab();
  1416. if (selected < 0 || selected >= tab_container->get_child_count()) {
  1417. return;
  1418. }
  1419. Node *current = tab_container->get_child(tab_container->get_current_tab());
  1420. EditorHelp *se = Object::cast_to<EditorHelp>(current);
  1421. if (!se) {
  1422. return;
  1423. }
  1424. Vector<Pair<String, int>> sections = se->get_sections();
  1425. for (int i = 0; i < sections.size(); i++) {
  1426. help_overview->add_item(sections[i].first);
  1427. help_overview->set_item_metadata(i, sections[i].second);
  1428. }
  1429. }
  1430. void ScriptEditor::_update_script_colors() {
  1431. bool script_temperature_enabled = EditorSettings::get_singleton()->get("text_editor/script_list/script_temperature_enabled");
  1432. bool highlight_current = EditorSettings::get_singleton()->get("text_editor/script_list/highlight_current_script");
  1433. int hist_size = EditorSettings::get_singleton()->get("text_editor/script_list/script_temperature_history_size");
  1434. Color hot_color = get_color("accent_color", "Editor");
  1435. Color cold_color = get_color("font_color", "Editor");
  1436. for (int i = 0; i < script_list->get_item_count(); i++) {
  1437. int c = script_list->get_item_metadata(i);
  1438. Node *n = tab_container->get_child(c);
  1439. if (!n) {
  1440. continue;
  1441. }
  1442. script_list->set_item_custom_bg_color(i, Color(0, 0, 0, 0));
  1443. bool current = tab_container->get_current_tab() == c;
  1444. if (current && highlight_current) {
  1445. script_list->set_item_custom_bg_color(i, EditorSettings::get_singleton()->get("text_editor/script_list/current_script_background_color"));
  1446. } else if (script_temperature_enabled) {
  1447. if (!n->has_meta("__editor_pass")) {
  1448. continue;
  1449. }
  1450. int pass = n->get_meta("__editor_pass");
  1451. int h = edit_pass - pass;
  1452. if (h > hist_size) {
  1453. continue;
  1454. }
  1455. int non_zero_hist_size = (hist_size == 0) ? 1 : hist_size;
  1456. float v = Math::ease((edit_pass - pass) / float(non_zero_hist_size), 0.4);
  1457. script_list->set_item_custom_fg_color(i, hot_color.linear_interpolate(cold_color, v));
  1458. }
  1459. }
  1460. }
  1461. void ScriptEditor::_update_script_names() {
  1462. if (restoring_layout) {
  1463. return;
  1464. }
  1465. Set<Ref<Script>> used;
  1466. Node *edited = EditorNode::get_singleton()->get_edited_scene();
  1467. if (edited) {
  1468. _find_scripts(edited, edited, used);
  1469. }
  1470. script_list->clear();
  1471. bool split_script_help = EditorSettings::get_singleton()->get("text_editor/script_list/group_help_pages");
  1472. ScriptSortBy sort_by = (ScriptSortBy)(int)EditorSettings::get_singleton()->get("text_editor/script_list/sort_scripts_by");
  1473. ScriptListName display_as = (ScriptListName)(int)EditorSettings::get_singleton()->get("text_editor/script_list/list_script_names_as");
  1474. Vector<_ScriptEditorItemData> sedata;
  1475. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1476. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1477. if (se) {
  1478. Ref<Texture> icon = se->get_icon();
  1479. String path = se->get_edited_resource()->get_path();
  1480. bool built_in = !path.is_resource_file();
  1481. String name;
  1482. if (built_in) {
  1483. name = path.get_file();
  1484. const String &resource_name = se->get_edited_resource()->get_name();
  1485. if (resource_name != "") {
  1486. // If the built-in script has a custom resource name defined,
  1487. // display the built-in script name as follows: `ResourceName (scene_file.tscn)`
  1488. name = vformat("%s (%s)", resource_name, name.substr(0, name.find("::", 0)));
  1489. }
  1490. } else {
  1491. name = se->get_name();
  1492. }
  1493. _ScriptEditorItemData sd;
  1494. sd.icon = icon;
  1495. sd.name = name;
  1496. sd.tooltip = path;
  1497. sd.index = i;
  1498. sd.used = used.has(se->get_edited_resource());
  1499. sd.category = 0;
  1500. sd.ref = se;
  1501. switch (sort_by) {
  1502. case SORT_BY_NAME: {
  1503. sd.sort_key = name.to_lower();
  1504. } break;
  1505. case SORT_BY_PATH: {
  1506. sd.sort_key = path;
  1507. } break;
  1508. case SORT_BY_NONE: {
  1509. sd.sort_key = "";
  1510. } break;
  1511. }
  1512. switch (display_as) {
  1513. case DISPLAY_NAME: {
  1514. sd.name = name;
  1515. } break;
  1516. case DISPLAY_DIR_AND_NAME: {
  1517. if (!path.get_base_dir().get_file().empty()) {
  1518. sd.name = path.get_base_dir().get_file().plus_file(name);
  1519. } else {
  1520. sd.name = name;
  1521. }
  1522. } break;
  1523. case DISPLAY_FULL_PATH: {
  1524. sd.name = path;
  1525. } break;
  1526. }
  1527. sedata.push_back(sd);
  1528. }
  1529. Vector<String> disambiguated_script_names;
  1530. Vector<String> full_script_paths;
  1531. for (int j = 0; j < sedata.size(); j++) {
  1532. String name = sedata[j].name.replace("(*)", "");
  1533. ScriptListName script_display = (ScriptListName)(int)EditorSettings::get_singleton()->get("text_editor/script_list/list_script_names_as");
  1534. switch (script_display) {
  1535. case DISPLAY_NAME: {
  1536. name = name.get_file();
  1537. } break;
  1538. case DISPLAY_DIR_AND_NAME: {
  1539. name = name.get_base_dir().get_file().plus_file(name.get_file());
  1540. } break;
  1541. default:
  1542. break;
  1543. }
  1544. disambiguated_script_names.push_back(name);
  1545. full_script_paths.push_back(sedata[j].tooltip);
  1546. }
  1547. EditorNode::disambiguate_filenames(full_script_paths, disambiguated_script_names);
  1548. for (int j = 0; j < sedata.size(); j++) {
  1549. if (sedata[j].name.ends_with("(*)")) {
  1550. sedata.write[j].name = disambiguated_script_names[j] + "(*)";
  1551. } else {
  1552. sedata.write[j].name = disambiguated_script_names[j];
  1553. }
  1554. }
  1555. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_child(i));
  1556. if (eh) {
  1557. String name = eh->get_class();
  1558. Ref<Texture> icon = get_icon("Help", "EditorIcons");
  1559. String tooltip = vformat(TTR("%s Class Reference"), name);
  1560. _ScriptEditorItemData sd;
  1561. sd.icon = icon;
  1562. sd.name = name;
  1563. sd.sort_key = name.to_lower();
  1564. sd.tooltip = tooltip;
  1565. sd.index = i;
  1566. sd.used = false;
  1567. sd.category = split_script_help ? 1 : 0;
  1568. sd.ref = eh;
  1569. sedata.push_back(sd);
  1570. }
  1571. }
  1572. if (_sort_list_on_update && !sedata.empty()) {
  1573. sedata.sort();
  1574. // change actual order of tab_container so that the order can be rearranged by user
  1575. int cur_tab = tab_container->get_current_tab();
  1576. int prev_tab = tab_container->get_previous_tab();
  1577. int new_cur_tab = -1;
  1578. int new_prev_tab = -1;
  1579. for (int i = 0; i < sedata.size(); i++) {
  1580. tab_container->move_child(sedata[i].ref, i);
  1581. if (new_prev_tab == -1 && sedata[i].index == prev_tab) {
  1582. new_prev_tab = i;
  1583. }
  1584. if (new_cur_tab == -1 && sedata[i].index == cur_tab) {
  1585. new_cur_tab = i;
  1586. }
  1587. // Update index of sd entries for sorted order
  1588. _ScriptEditorItemData sd = sedata[i];
  1589. sd.index = i;
  1590. sedata.set(i, sd);
  1591. }
  1592. tab_container->set_current_tab(new_prev_tab);
  1593. tab_container->set_current_tab(new_cur_tab);
  1594. _sort_list_on_update = false;
  1595. }
  1596. Vector<_ScriptEditorItemData> sedata_filtered;
  1597. for (int i = 0; i < sedata.size(); i++) {
  1598. String filter = filter_scripts->get_text();
  1599. if (filter == "" || filter.is_subsequence_ofi(sedata[i].name)) {
  1600. sedata_filtered.push_back(sedata[i]);
  1601. }
  1602. }
  1603. for (int i = 0; i < sedata_filtered.size(); i++) {
  1604. script_list->add_item(sedata_filtered[i].name, sedata_filtered[i].icon);
  1605. int index = script_list->get_item_count() - 1;
  1606. script_list->set_item_tooltip(index, sedata_filtered[i].tooltip);
  1607. script_list->set_item_metadata(index, sedata_filtered[i].index); /* Saving as metadata the script's index in the tab container and not the filtered one */
  1608. if (sedata_filtered[i].used) {
  1609. script_list->set_item_custom_bg_color(index, Color(88 / 255.0, 88 / 255.0, 60 / 255.0));
  1610. }
  1611. if (tab_container->get_current_tab() == sedata_filtered[i].index) {
  1612. script_list->select(index);
  1613. script_name_label->set_text(sedata_filtered[i].name);
  1614. script_icon->set_texture(sedata_filtered[i].icon);
  1615. ScriptEditorBase *se = _get_current_editor();
  1616. if (se) {
  1617. se->enable_editor();
  1618. _update_selected_editor_menu();
  1619. }
  1620. }
  1621. }
  1622. if (!waiting_update_names) {
  1623. _update_members_overview();
  1624. _update_help_overview();
  1625. } else {
  1626. waiting_update_names = false;
  1627. }
  1628. _update_members_overview_visibility();
  1629. _update_help_overview_visibility();
  1630. _update_script_colors();
  1631. file_menu->get_popup()->set_item_disabled(file_menu->get_popup()->get_item_index(FILE_REOPEN_CLOSED), previous_scripts.empty());
  1632. }
  1633. void ScriptEditor::_update_script_connections() {
  1634. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1635. ScriptTextEditor *ste = Object::cast_to<ScriptTextEditor>(tab_container->get_child(i));
  1636. if (!ste) {
  1637. continue;
  1638. }
  1639. ste->_update_connected_methods();
  1640. }
  1641. }
  1642. Ref<TextFile> ScriptEditor::_load_text_file(const String &p_path, Error *r_error) {
  1643. if (r_error) {
  1644. *r_error = ERR_FILE_CANT_OPEN;
  1645. }
  1646. String local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  1647. String path = ResourceLoader::path_remap(local_path);
  1648. TextFile *text_file = memnew(TextFile);
  1649. Ref<TextFile> text_res(text_file);
  1650. Error err = text_file->load_text(path);
  1651. ERR_FAIL_COND_V_MSG(err != OK, RES(), "Cannot load text file '" + path + "'.");
  1652. text_file->set_file_path(local_path);
  1653. text_file->set_path(local_path, true);
  1654. if (ResourceLoader::get_timestamp_on_load()) {
  1655. text_file->set_last_modified_time(FileAccess::get_modified_time(path));
  1656. }
  1657. if (r_error) {
  1658. *r_error = OK;
  1659. }
  1660. return text_res;
  1661. }
  1662. Error ScriptEditor::_save_text_file(Ref<TextFile> p_text_file, const String &p_path) {
  1663. Ref<TextFile> sqscr = p_text_file;
  1664. ERR_FAIL_COND_V(sqscr.is_null(), ERR_INVALID_PARAMETER);
  1665. String source = sqscr->get_text();
  1666. Error err;
  1667. FileAccess *file = FileAccess::open(p_path, FileAccess::WRITE, &err);
  1668. ERR_FAIL_COND_V_MSG(err, err, "Cannot save text file '" + p_path + "'.");
  1669. file->store_string(source);
  1670. if (file->get_error() != OK && file->get_error() != ERR_FILE_EOF) {
  1671. memdelete(file);
  1672. return ERR_CANT_CREATE;
  1673. }
  1674. file->close();
  1675. memdelete(file);
  1676. if (ResourceSaver::get_timestamp_on_save()) {
  1677. p_text_file->set_last_modified_time(FileAccess::get_modified_time(p_path));
  1678. }
  1679. _res_saved_callback(sqscr);
  1680. return OK;
  1681. }
  1682. bool ScriptEditor::edit(const RES &p_resource, int p_line, int p_col, bool p_grab_focus) {
  1683. if (p_resource.is_null()) {
  1684. return false;
  1685. }
  1686. Ref<Script> script = p_resource;
  1687. // Don't open dominant script if using an external editor.
  1688. const bool use_external_editor =
  1689. EditorSettings::get_singleton()->get("text_editor/external/use_external_editor") ||
  1690. (script.is_valid() && script->get_language()->overrides_external_editor());
  1691. const bool open_dominant = EditorSettings::get_singleton()->get("text_editor/files/open_dominant_script_on_scene_change");
  1692. const bool should_open = (open_dominant && !use_external_editor) || !EditorNode::get_singleton()->is_changing_scene();
  1693. if (script.is_valid() && script->get_language()->overrides_external_editor()) {
  1694. if (should_open) {
  1695. Error err = script->get_language()->open_in_external_editor(script, p_line >= 0 ? p_line : 0, p_col);
  1696. if (err != OK)
  1697. ERR_PRINT("Couldn't open script in the overridden external text editor");
  1698. }
  1699. return false;
  1700. }
  1701. if (use_external_editor &&
  1702. (debugger->get_dump_stack_script() != p_resource || debugger->get_debug_with_external_editor()) &&
  1703. p_resource->get_path().is_resource_file() &&
  1704. p_resource->get_class_name() != StringName("VisualScript")) {
  1705. String path = EditorSettings::get_singleton()->get("text_editor/external/exec_path");
  1706. String flags = EditorSettings::get_singleton()->get("text_editor/external/exec_flags");
  1707. List<String> args;
  1708. bool has_file_flag = false;
  1709. String script_path = ProjectSettings::get_singleton()->globalize_path(p_resource->get_path());
  1710. if (flags.size()) {
  1711. String project_path = ProjectSettings::get_singleton()->get_resource_path();
  1712. flags = flags.replacen("{line}", itos(p_line > 0 ? p_line : 0));
  1713. flags = flags.replacen("{col}", itos(p_col));
  1714. flags = flags.strip_edges().replace("\\\\", "\\");
  1715. int from = 0;
  1716. int num_chars = 0;
  1717. bool inside_quotes = false;
  1718. for (int i = 0; i < flags.size(); i++) {
  1719. if (flags[i] == '"' && (!i || flags[i - 1] != '\\')) {
  1720. if (!inside_quotes) {
  1721. from++;
  1722. }
  1723. inside_quotes = !inside_quotes;
  1724. } else if (flags[i] == '\0' || (!inside_quotes && flags[i] == ' ')) {
  1725. String arg = flags.substr(from, num_chars);
  1726. if (arg.find("{file}") != -1) {
  1727. has_file_flag = true;
  1728. }
  1729. // do path replacement here, else there will be issues with spaces and quotes
  1730. arg = arg.replacen("{project}", project_path);
  1731. arg = arg.replacen("{file}", script_path);
  1732. args.push_back(arg);
  1733. from = i + 1;
  1734. num_chars = 0;
  1735. } else {
  1736. num_chars++;
  1737. }
  1738. }
  1739. }
  1740. // Default to passing script path if no {file} flag is specified.
  1741. if (!has_file_flag) {
  1742. args.push_back(script_path);
  1743. }
  1744. Error err = OS::get_singleton()->execute(path, args, false);
  1745. if (err == OK) {
  1746. return false;
  1747. }
  1748. WARN_PRINT("Couldn't open external text editor, using internal");
  1749. }
  1750. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1751. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1752. if (!se) {
  1753. continue;
  1754. }
  1755. if ((script != nullptr && se->get_edited_resource() == p_resource) || se->get_edited_resource()->get_path() == p_resource->get_path()) {
  1756. if (should_open) {
  1757. se->enable_editor();
  1758. if (tab_container->get_current_tab() != i) {
  1759. _go_to_tab(i);
  1760. _update_script_names();
  1761. }
  1762. if (is_visible_in_tree()) {
  1763. se->ensure_focus();
  1764. }
  1765. if (p_line > 0) {
  1766. se->goto_line(p_line - 1);
  1767. }
  1768. }
  1769. _update_script_names();
  1770. script_list->ensure_current_is_visible();
  1771. return true;
  1772. }
  1773. }
  1774. // doesn't have it, make a new one
  1775. ScriptEditorBase *se = nullptr;
  1776. for (int i = script_editor_func_count - 1; i >= 0; i--) {
  1777. se = script_editor_funcs[i](p_resource);
  1778. if (se) {
  1779. break;
  1780. }
  1781. }
  1782. ERR_FAIL_COND_V(!se, false);
  1783. se->set_edited_resource(p_resource);
  1784. if (p_resource->get_class_name() != StringName("VisualScript")) {
  1785. bool highlighter_set = false;
  1786. for (int i = 0; i < syntax_highlighters_func_count; i++) {
  1787. SyntaxHighlighter *highlighter = syntax_highlighters_funcs[i]();
  1788. se->add_syntax_highlighter(highlighter);
  1789. if (script != nullptr && !highlighter_set) {
  1790. List<String> languages = highlighter->get_supported_languages();
  1791. if (languages.find(script->get_language()->get_name())) {
  1792. se->set_syntax_highlighter(highlighter);
  1793. highlighter_set = true;
  1794. }
  1795. }
  1796. }
  1797. }
  1798. tab_container->add_child(se);
  1799. if (p_grab_focus) {
  1800. se->enable_editor();
  1801. }
  1802. se->set_tooltip_request_func("_get_debug_tooltip", this);
  1803. if (se->get_edit_menu()) {
  1804. se->get_edit_menu()->hide();
  1805. menu_hb->add_child(se->get_edit_menu());
  1806. menu_hb->move_child(se->get_edit_menu(), 1);
  1807. }
  1808. if (p_grab_focus) {
  1809. _go_to_tab(tab_container->get_tab_count() - 1);
  1810. _add_recent_script(p_resource->get_path());
  1811. }
  1812. _sort_list_on_update = true;
  1813. _update_script_names();
  1814. _save_layout();
  1815. se->connect("name_changed", this, "_update_script_names");
  1816. se->connect("edited_script_changed", this, "_script_changed");
  1817. se->connect("request_help", this, "_help_search");
  1818. se->connect("request_open_script_at_line", this, "_goto_script_line");
  1819. se->connect("go_to_help", this, "_help_class_goto");
  1820. se->connect("request_save_history", this, "_save_history");
  1821. se->connect("search_in_files_requested", this, "_on_find_in_files_requested");
  1822. //test for modification, maybe the script was not edited but was loaded
  1823. _test_script_times_on_disk(p_resource);
  1824. _update_modified_scripts_for_external_editor(p_resource);
  1825. if (p_line > 0) {
  1826. se->goto_line(p_line - 1);
  1827. }
  1828. notify_script_changed(p_resource);
  1829. return true;
  1830. }
  1831. void ScriptEditor::save_current_script() {
  1832. ScriptEditorBase *current = _get_current_editor();
  1833. if (!current || _test_script_times_on_disk()) {
  1834. return;
  1835. }
  1836. if (trim_trailing_whitespace_on_save) {
  1837. current->trim_trailing_whitespace();
  1838. }
  1839. current->insert_final_newline();
  1840. if (convert_indent_on_save) {
  1841. if (use_space_indentation) {
  1842. current->convert_indent_to_spaces();
  1843. } else {
  1844. current->convert_indent_to_tabs();
  1845. }
  1846. }
  1847. RES resource = current->get_edited_resource();
  1848. Ref<TextFile> text_file = resource;
  1849. if (text_file != nullptr) {
  1850. current->apply_code();
  1851. _save_text_file(text_file, text_file->get_path());
  1852. return;
  1853. }
  1854. editor->save_resource(resource);
  1855. }
  1856. void ScriptEditor::save_all_scripts() {
  1857. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1858. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1859. if (!se) {
  1860. continue;
  1861. }
  1862. if (convert_indent_on_save) {
  1863. if (use_space_indentation) {
  1864. se->convert_indent_to_spaces();
  1865. } else {
  1866. se->convert_indent_to_tabs();
  1867. }
  1868. }
  1869. if (trim_trailing_whitespace_on_save) {
  1870. se->trim_trailing_whitespace();
  1871. }
  1872. se->insert_final_newline();
  1873. if (!se->is_unsaved()) {
  1874. continue;
  1875. }
  1876. RES edited_res = se->get_edited_resource();
  1877. if (edited_res.is_valid()) {
  1878. se->apply_code();
  1879. }
  1880. if (edited_res->get_path() != "" && edited_res->get_path().find("local://") == -1 && edited_res->get_path().find("::") == -1) {
  1881. Ref<TextFile> text_file = edited_res;
  1882. if (text_file != nullptr) {
  1883. _save_text_file(text_file, text_file->get_path());
  1884. continue;
  1885. }
  1886. editor->save_resource(edited_res); //external script, save it
  1887. }
  1888. }
  1889. _update_script_names();
  1890. EditorFileSystem::get_singleton()->update_script_classes();
  1891. }
  1892. void ScriptEditor::apply_scripts() const {
  1893. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1894. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1895. if (!se) {
  1896. continue;
  1897. }
  1898. se->apply_code();
  1899. }
  1900. }
  1901. void ScriptEditor::open_script_create_dialog(const String &p_base_name, const String &p_base_path) {
  1902. _menu_option(FILE_NEW);
  1903. script_create_dialog->config(p_base_name, p_base_path);
  1904. }
  1905. void ScriptEditor::_editor_play() {
  1906. debugger->start();
  1907. debug_menu->get_popup()->grab_focus();
  1908. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_NEXT), true);
  1909. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_STEP), true);
  1910. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_BREAK), false);
  1911. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_CONTINUE), true);
  1912. }
  1913. void ScriptEditor::_editor_pause() {
  1914. }
  1915. void ScriptEditor::_editor_stop() {
  1916. debugger->stop();
  1917. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_NEXT), true);
  1918. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_STEP), true);
  1919. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_BREAK), true);
  1920. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_CONTINUE), true);
  1921. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1922. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1923. if (!se) {
  1924. continue;
  1925. }
  1926. se->set_debugger_active(false);
  1927. }
  1928. }
  1929. void ScriptEditor::_add_callback(Object *p_obj, const String &p_function, const PoolStringArray &p_args) {
  1930. ERR_FAIL_COND(!p_obj);
  1931. Ref<Script> script = p_obj->get_script();
  1932. ERR_FAIL_COND(!script.is_valid());
  1933. editor->push_item(script.ptr());
  1934. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1935. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1936. if (!se) {
  1937. continue;
  1938. }
  1939. if (se->get_edited_resource() != script) {
  1940. continue;
  1941. }
  1942. se->add_callback(p_function, p_args);
  1943. _go_to_tab(i);
  1944. script_list->select(script_list->find_metadata(i));
  1945. // Save the current script so the changes can be picked up by an external editor.
  1946. if (!_is_built_in_script(script.ptr())) { // But only if it's not built-in script.
  1947. save_current_script();
  1948. }
  1949. break;
  1950. }
  1951. }
  1952. void ScriptEditor::_save_layout() {
  1953. if (restoring_layout) {
  1954. return;
  1955. }
  1956. editor->save_layout();
  1957. }
  1958. void ScriptEditor::_editor_settings_changed() {
  1959. trim_trailing_whitespace_on_save = EditorSettings::get_singleton()->get("text_editor/files/trim_trailing_whitespace_on_save");
  1960. convert_indent_on_save = EditorSettings::get_singleton()->get("text_editor/indent/convert_indent_on_save");
  1961. use_space_indentation = EditorSettings::get_singleton()->get("text_editor/indent/type");
  1962. members_overview_enabled = EditorSettings::get_singleton()->get("text_editor/script_list/show_members_overview");
  1963. help_overview_enabled = EditorSettings::get_singleton()->get("text_editor/help/show_help_index");
  1964. _update_members_overview_visibility();
  1965. _update_help_overview_visibility();
  1966. _update_autosave_timer();
  1967. if (current_theme == "") {
  1968. current_theme = EditorSettings::get_singleton()->get("text_editor/theme/color_theme");
  1969. } else if (current_theme != EditorSettings::get_singleton()->get("text_editor/theme/color_theme")) {
  1970. current_theme = EditorSettings::get_singleton()->get("text_editor/theme/color_theme");
  1971. EditorSettings::get_singleton()->load_text_editor_theme();
  1972. }
  1973. for (int i = 0; i < tab_container->get_child_count(); i++) {
  1974. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  1975. if (!se) {
  1976. continue;
  1977. }
  1978. se->update_settings();
  1979. }
  1980. _update_script_colors();
  1981. _update_script_names();
  1982. ScriptServer::set_reload_scripts_on_save(EDITOR_DEF("text_editor/files/auto_reload_and_parse_scripts_on_save", true));
  1983. }
  1984. void ScriptEditor::_autosave_scripts() {
  1985. save_all_scripts();
  1986. }
  1987. void ScriptEditor::_update_autosave_timer() {
  1988. if (!autosave_timer->is_inside_tree()) {
  1989. return;
  1990. }
  1991. float autosave_time = EditorSettings::get_singleton()->get("text_editor/files/autosave_interval_secs");
  1992. if (autosave_time > 0) {
  1993. autosave_timer->set_wait_time(autosave_time);
  1994. autosave_timer->start();
  1995. } else {
  1996. autosave_timer->stop();
  1997. }
  1998. }
  1999. void ScriptEditor::_tree_changed() {
  2000. if (waiting_update_names) {
  2001. return;
  2002. }
  2003. waiting_update_names = true;
  2004. call_deferred("_update_script_names");
  2005. call_deferred("_update_script_connections");
  2006. }
  2007. void ScriptEditor::_script_split_dragged(float) {
  2008. _save_layout();
  2009. }
  2010. Variant ScriptEditor::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  2011. if (tab_container->get_child_count() == 0) {
  2012. return Variant();
  2013. }
  2014. Node *cur_node = tab_container->get_child(tab_container->get_current_tab());
  2015. HBoxContainer *drag_preview = memnew(HBoxContainer);
  2016. String preview_name = "";
  2017. Ref<Texture> preview_icon;
  2018. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(cur_node);
  2019. if (se) {
  2020. preview_name = se->get_name();
  2021. preview_icon = se->get_icon();
  2022. }
  2023. EditorHelp *eh = Object::cast_to<EditorHelp>(cur_node);
  2024. if (eh) {
  2025. preview_name = eh->get_class();
  2026. preview_icon = get_icon("Help", "EditorIcons");
  2027. }
  2028. if (!preview_icon.is_null()) {
  2029. TextureRect *tf = memnew(TextureRect);
  2030. tf->set_texture(preview_icon);
  2031. drag_preview->add_child(tf);
  2032. }
  2033. Label *label = memnew(Label(preview_name));
  2034. drag_preview->add_child(label);
  2035. set_drag_preview(drag_preview);
  2036. Dictionary drag_data;
  2037. drag_data["type"] = "script_list_element"; // using a custom type because node caused problems when dragging to scene tree
  2038. drag_data["script_list_element"] = cur_node;
  2039. return drag_data;
  2040. }
  2041. bool ScriptEditor::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
  2042. Dictionary d = p_data;
  2043. if (!d.has("type")) {
  2044. return false;
  2045. }
  2046. if (String(d["type"]) == "script_list_element") {
  2047. Node *node = d["script_list_element"];
  2048. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(node);
  2049. if (se) {
  2050. return true;
  2051. }
  2052. EditorHelp *eh = Object::cast_to<EditorHelp>(node);
  2053. if (eh) {
  2054. return true;
  2055. }
  2056. }
  2057. if (String(d["type"]) == "nodes") {
  2058. Array nodes = d["nodes"];
  2059. if (nodes.size() == 0) {
  2060. return false;
  2061. }
  2062. Node *node = get_node((nodes[0]));
  2063. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(node);
  2064. if (se) {
  2065. return true;
  2066. }
  2067. EditorHelp *eh = Object::cast_to<EditorHelp>(node);
  2068. if (eh) {
  2069. return true;
  2070. }
  2071. }
  2072. if (String(d["type"]) == "files") {
  2073. Vector<String> files = d["files"];
  2074. if (files.size() == 0) {
  2075. return false; //weird
  2076. }
  2077. for (int i = 0; i < files.size(); i++) {
  2078. String file = files[i];
  2079. if (file == "" || !FileAccess::exists(file)) {
  2080. continue;
  2081. }
  2082. Ref<Script> scr = ResourceLoader::load(file);
  2083. if (scr.is_valid()) {
  2084. return true;
  2085. }
  2086. }
  2087. return true;
  2088. }
  2089. return false;
  2090. }
  2091. void ScriptEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
  2092. if (!can_drop_data_fw(p_point, p_data, p_from)) {
  2093. return;
  2094. }
  2095. Dictionary d = p_data;
  2096. if (!d.has("type")) {
  2097. return;
  2098. }
  2099. if (String(d["type"]) == "script_list_element") {
  2100. Node *node = d["script_list_element"];
  2101. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(node);
  2102. EditorHelp *eh = Object::cast_to<EditorHelp>(node);
  2103. if (se || eh) {
  2104. int new_index = 0;
  2105. if (script_list->get_item_count() > 0) {
  2106. new_index = script_list->get_item_metadata(script_list->get_item_at_position(p_point));
  2107. }
  2108. tab_container->move_child(node, new_index);
  2109. tab_container->set_current_tab(new_index);
  2110. _update_script_names();
  2111. }
  2112. }
  2113. if (String(d["type"]) == "nodes") {
  2114. Array nodes = d["nodes"];
  2115. if (nodes.size() == 0) {
  2116. return;
  2117. }
  2118. Node *node = get_node(nodes[0]);
  2119. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(node);
  2120. EditorHelp *eh = Object::cast_to<EditorHelp>(node);
  2121. if (se || eh) {
  2122. int new_index = 0;
  2123. if (script_list->get_item_count() > 0) {
  2124. new_index = script_list->get_item_metadata(script_list->get_item_at_position(p_point));
  2125. }
  2126. tab_container->move_child(node, new_index);
  2127. tab_container->set_current_tab(new_index);
  2128. _update_script_names();
  2129. }
  2130. }
  2131. if (String(d["type"]) == "files") {
  2132. Vector<String> files = d["files"];
  2133. int new_index = 0;
  2134. if (script_list->get_item_count() > 0) {
  2135. new_index = script_list->get_item_metadata(script_list->get_item_at_position(p_point));
  2136. }
  2137. int num_tabs_before = tab_container->get_child_count();
  2138. for (int i = 0; i < files.size(); i++) {
  2139. String file = files[i];
  2140. if (file == "" || !FileAccess::exists(file)) {
  2141. continue;
  2142. }
  2143. Ref<Script> scr = ResourceLoader::load(file);
  2144. if (scr.is_valid()) {
  2145. edit(scr);
  2146. if (tab_container->get_child_count() > num_tabs_before) {
  2147. tab_container->move_child(tab_container->get_child(tab_container->get_child_count() - 1), new_index);
  2148. num_tabs_before = tab_container->get_child_count();
  2149. } else { /* Maybe script was already open */
  2150. tab_container->move_child(tab_container->get_child(tab_container->get_current_tab()), new_index);
  2151. }
  2152. }
  2153. }
  2154. tab_container->set_current_tab(new_index);
  2155. _update_script_names();
  2156. }
  2157. }
  2158. void ScriptEditor::_unhandled_input(const Ref<InputEvent> &p_event) {
  2159. ERR_FAIL_COND(p_event.is_null());
  2160. if (!is_visible_in_tree() || !p_event->is_pressed() || p_event->is_echo()) {
  2161. return;
  2162. }
  2163. if (ED_IS_SHORTCUT("script_editor/next_script", p_event)) {
  2164. if (script_list->get_item_count() > 1) {
  2165. int next_tab = script_list->get_current() + 1;
  2166. next_tab %= script_list->get_item_count();
  2167. _go_to_tab(script_list->get_item_metadata(next_tab));
  2168. _update_script_names();
  2169. }
  2170. }
  2171. if (ED_IS_SHORTCUT("script_editor/prev_script", p_event)) {
  2172. if (script_list->get_item_count() > 1) {
  2173. int next_tab = script_list->get_current() - 1;
  2174. next_tab = next_tab >= 0 ? next_tab : script_list->get_item_count() - 1;
  2175. _go_to_tab(script_list->get_item_metadata(next_tab));
  2176. _update_script_names();
  2177. }
  2178. }
  2179. if (ED_IS_SHORTCUT("script_editor/window_move_up", p_event)) {
  2180. _menu_option(WINDOW_MOVE_UP);
  2181. }
  2182. if (ED_IS_SHORTCUT("script_editor/window_move_down", p_event)) {
  2183. _menu_option(WINDOW_MOVE_DOWN);
  2184. }
  2185. }
  2186. void ScriptEditor::_script_list_gui_input(const Ref<InputEvent> &ev) {
  2187. Ref<InputEventMouseButton> mb = ev;
  2188. if (mb.is_valid() && mb->is_pressed()) {
  2189. switch (mb->get_button_index()) {
  2190. case BUTTON_MIDDLE: {
  2191. // Right-click selects automatically; middle-click does not.
  2192. int idx = script_list->get_item_at_position(mb->get_position(), true);
  2193. if (idx >= 0) {
  2194. script_list->select(idx);
  2195. _script_selected(idx);
  2196. _menu_option(FILE_CLOSE);
  2197. }
  2198. } break;
  2199. case BUTTON_RIGHT: {
  2200. _make_script_list_context_menu();
  2201. } break;
  2202. }
  2203. }
  2204. }
  2205. void ScriptEditor::_make_script_list_context_menu() {
  2206. context_menu->clear();
  2207. int selected = tab_container->get_current_tab();
  2208. if (selected < 0 || selected >= tab_container->get_child_count()) {
  2209. return;
  2210. }
  2211. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(selected));
  2212. if (se) {
  2213. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/save"), FILE_SAVE);
  2214. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/save_as"), FILE_SAVE_AS);
  2215. }
  2216. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/close_file"), FILE_CLOSE);
  2217. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/close_all"), CLOSE_ALL);
  2218. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/close_other_tabs"), CLOSE_OTHER_TABS);
  2219. context_menu->add_separator();
  2220. if (se) {
  2221. Ref<Script> scr = se->get_edited_resource();
  2222. if (scr != nullptr) {
  2223. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/reload_script_soft"), FILE_TOOL_RELOAD_SOFT);
  2224. if (!scr.is_null() && scr->is_tool()) {
  2225. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/run_file"), FILE_RUN);
  2226. context_menu->add_separator();
  2227. }
  2228. }
  2229. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/copy_path"), FILE_COPY_PATH);
  2230. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/show_in_file_system"), SHOW_IN_FILE_SYSTEM);
  2231. context_menu->add_separator();
  2232. }
  2233. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/window_move_up"), WINDOW_MOVE_UP);
  2234. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/window_move_down"), WINDOW_MOVE_DOWN);
  2235. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/window_sort"), WINDOW_SORT);
  2236. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/toggle_scripts_panel"), TOGGLE_SCRIPTS_PANEL);
  2237. context_menu->set_position(get_global_transform().xform(get_local_mouse_position()));
  2238. context_menu->set_size(Vector2(1, 1));
  2239. context_menu->popup();
  2240. }
  2241. void ScriptEditor::set_window_layout(Ref<ConfigFile> p_layout) {
  2242. if (!bool(EDITOR_DEF("text_editor/files/restore_scripts_on_load", true))) {
  2243. return;
  2244. }
  2245. if (!p_layout->has_section_key("ScriptEditor", "open_scripts") && !p_layout->has_section_key("ScriptEditor", "open_help")) {
  2246. return;
  2247. }
  2248. Array scripts = p_layout->get_value("ScriptEditor", "open_scripts");
  2249. Array helps;
  2250. if (p_layout->has_section_key("ScriptEditor", "open_help")) {
  2251. helps = p_layout->get_value("ScriptEditor", "open_help");
  2252. }
  2253. restoring_layout = true;
  2254. List<String> extensions;
  2255. ResourceLoader::get_recognized_extensions_for_type("Script", &extensions);
  2256. for (int i = 0; i < scripts.size(); i++) {
  2257. String path = scripts[i];
  2258. Dictionary script_info = scripts[i];
  2259. if (!script_info.empty()) {
  2260. path = script_info["path"];
  2261. }
  2262. if (!FileAccess::exists(path)) {
  2263. continue;
  2264. }
  2265. if (extensions.find(path.get_extension())) {
  2266. Ref<Script> scr = ResourceLoader::load(path);
  2267. if (!scr.is_valid()) {
  2268. continue;
  2269. }
  2270. if (!edit(scr, false)) {
  2271. continue;
  2272. }
  2273. } else {
  2274. Error error;
  2275. Ref<TextFile> text_file = _load_text_file(path, &error);
  2276. if (error != OK || !text_file.is_valid()) {
  2277. continue;
  2278. }
  2279. if (!edit(text_file, false)) {
  2280. continue;
  2281. }
  2282. }
  2283. if (!script_info.empty()) {
  2284. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(tab_container->get_tab_count() - 1));
  2285. if (se) {
  2286. se->set_edit_state(script_info["state"]);
  2287. }
  2288. }
  2289. }
  2290. for (int i = 0; i < helps.size(); i++) {
  2291. String path = helps[i];
  2292. if (path == "") { // invalid, skip
  2293. continue;
  2294. }
  2295. _help_class_open(path);
  2296. }
  2297. for (int i = 0; i < tab_container->get_child_count(); i++) {
  2298. tab_container->get_child(i)->set_meta("__editor_pass", Variant());
  2299. }
  2300. if (p_layout->has_section_key("ScriptEditor", "split_offset")) {
  2301. script_split->set_split_offset(p_layout->get_value("ScriptEditor", "split_offset"));
  2302. }
  2303. restoring_layout = false;
  2304. _update_script_names();
  2305. }
  2306. void ScriptEditor::get_window_layout(Ref<ConfigFile> p_layout) {
  2307. Array scripts;
  2308. Array helps;
  2309. for (int i = 0; i < tab_container->get_child_count(); i++) {
  2310. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  2311. if (se) {
  2312. String path = se->get_edited_resource()->get_path();
  2313. if (!path.is_resource_file()) {
  2314. continue;
  2315. }
  2316. Dictionary script_info;
  2317. script_info["path"] = path;
  2318. script_info["state"] = se->get_edit_state();
  2319. scripts.push_back(script_info);
  2320. }
  2321. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_child(i));
  2322. if (eh) {
  2323. helps.push_back(eh->get_class());
  2324. }
  2325. }
  2326. p_layout->set_value("ScriptEditor", "open_scripts", scripts);
  2327. p_layout->set_value("ScriptEditor", "open_help", helps);
  2328. p_layout->set_value("ScriptEditor", "split_offset", script_split->get_split_offset());
  2329. }
  2330. void ScriptEditor::_help_class_open(const String &p_class) {
  2331. if (p_class == "") {
  2332. return;
  2333. }
  2334. for (int i = 0; i < tab_container->get_child_count(); i++) {
  2335. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_child(i));
  2336. if (eh && eh->get_class() == p_class) {
  2337. _go_to_tab(i);
  2338. _update_script_names();
  2339. return;
  2340. }
  2341. }
  2342. EditorHelp *eh = memnew(EditorHelp);
  2343. eh->set_name(p_class);
  2344. tab_container->add_child(eh);
  2345. _go_to_tab(tab_container->get_tab_count() - 1);
  2346. eh->go_to_class(p_class, 0);
  2347. eh->connect("go_to_help", this, "_help_class_goto");
  2348. _add_recent_script(p_class);
  2349. _sort_list_on_update = true;
  2350. _update_script_names();
  2351. _save_layout();
  2352. }
  2353. void ScriptEditor::_help_class_goto(const String &p_desc) {
  2354. String cname = p_desc.get_slice(":", 1);
  2355. for (int i = 0; i < tab_container->get_child_count(); i++) {
  2356. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_child(i));
  2357. if (eh && eh->get_class() == cname) {
  2358. _go_to_tab(i);
  2359. eh->go_to_help(p_desc);
  2360. _update_script_names();
  2361. return;
  2362. }
  2363. }
  2364. EditorHelp *eh = memnew(EditorHelp);
  2365. eh->set_name(cname);
  2366. tab_container->add_child(eh);
  2367. _go_to_tab(tab_container->get_tab_count() - 1);
  2368. eh->go_to_help(p_desc);
  2369. eh->connect("go_to_help", this, "_help_class_goto");
  2370. _add_recent_script(eh->get_class());
  2371. _sort_list_on_update = true;
  2372. _update_script_names();
  2373. _save_layout();
  2374. }
  2375. void ScriptEditor::_update_selected_editor_menu() {
  2376. for (int i = 0; i < tab_container->get_child_count(); i++) {
  2377. bool current = tab_container->get_current_tab() == i;
  2378. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  2379. if (se && se->get_edit_menu()) {
  2380. if (current) {
  2381. se->get_edit_menu()->show();
  2382. } else {
  2383. se->get_edit_menu()->hide();
  2384. }
  2385. }
  2386. }
  2387. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_current_tab_control());
  2388. script_search_menu->get_popup()->clear();
  2389. if (eh) {
  2390. script_search_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/find", TTR("Find..."), KEY_MASK_CMD | KEY_F), HELP_SEARCH_FIND);
  2391. script_search_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/find_next", TTR("Find Next"), KEY_F3), HELP_SEARCH_FIND_NEXT);
  2392. script_search_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/find_previous", TTR("Find Previous"), KEY_MASK_SHIFT | KEY_F3), HELP_SEARCH_FIND_PREVIOUS);
  2393. script_search_menu->get_popup()->add_separator();
  2394. script_search_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/find_in_files", TTR("Find in Files"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_F), SEARCH_IN_FILES);
  2395. script_search_menu->show();
  2396. } else {
  2397. if (tab_container->get_child_count() == 0) {
  2398. script_search_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/find_in_files", TTR("Find in Files"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_F), SEARCH_IN_FILES);
  2399. script_search_menu->show();
  2400. } else {
  2401. script_search_menu->hide();
  2402. }
  2403. }
  2404. }
  2405. void ScriptEditor::_update_history_pos(int p_new_pos) {
  2406. Node *n = tab_container->get_current_tab_control();
  2407. if (Object::cast_to<ScriptEditorBase>(n)) {
  2408. history.write[history_pos].state = Object::cast_to<ScriptEditorBase>(n)->get_edit_state();
  2409. }
  2410. if (Object::cast_to<EditorHelp>(n)) {
  2411. history.write[history_pos].state = Object::cast_to<EditorHelp>(n)->get_scroll();
  2412. }
  2413. history_pos = p_new_pos;
  2414. tab_container->set_current_tab(history[history_pos].control->get_index());
  2415. n = history[history_pos].control;
  2416. if (Object::cast_to<ScriptEditorBase>(n)) {
  2417. Object::cast_to<ScriptEditorBase>(n)->set_edit_state(history[history_pos].state);
  2418. Object::cast_to<ScriptEditorBase>(n)->ensure_focus();
  2419. Ref<Script> script = Object::cast_to<ScriptEditorBase>(n)->get_edited_resource();
  2420. if (script != nullptr) {
  2421. notify_script_changed(script);
  2422. }
  2423. }
  2424. if (Object::cast_to<EditorHelp>(n)) {
  2425. Object::cast_to<EditorHelp>(n)->set_scroll(history[history_pos].state);
  2426. Object::cast_to<EditorHelp>(n)->set_focused();
  2427. }
  2428. n->set_meta("__editor_pass", ++edit_pass);
  2429. _update_script_names();
  2430. _update_history_arrows();
  2431. _update_selected_editor_menu();
  2432. }
  2433. void ScriptEditor::_history_forward() {
  2434. if (history_pos < history.size() - 1) {
  2435. _update_history_pos(history_pos + 1);
  2436. }
  2437. }
  2438. void ScriptEditor::_history_back() {
  2439. if (history_pos > 0) {
  2440. _update_history_pos(history_pos - 1);
  2441. }
  2442. }
  2443. Vector<Ref<Script>> ScriptEditor::get_open_scripts() const {
  2444. Vector<Ref<Script>> out_scripts = Vector<Ref<Script>>();
  2445. for (int i = 0; i < tab_container->get_child_count(); i++) {
  2446. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_child(i));
  2447. if (!se) {
  2448. continue;
  2449. }
  2450. Ref<Script> script = se->get_edited_resource();
  2451. if (script != nullptr) {
  2452. out_scripts.push_back(script);
  2453. }
  2454. }
  2455. return out_scripts;
  2456. }
  2457. void ScriptEditor::set_scene_root_script(Ref<Script> p_script) {
  2458. // Don't open dominant script if using an external editor.
  2459. const bool use_external_editor =
  2460. EditorSettings::get_singleton()->get("text_editor/external/use_external_editor") ||
  2461. (p_script.is_valid() && p_script->get_language()->overrides_external_editor());
  2462. const bool open_dominant = EditorSettings::get_singleton()->get("text_editor/files/open_dominant_script_on_scene_change");
  2463. if (open_dominant && !use_external_editor && p_script.is_valid()) {
  2464. edit(p_script);
  2465. }
  2466. }
  2467. bool ScriptEditor::script_goto_method(Ref<Script> p_script, const String &p_method) {
  2468. int line = p_script->get_member_line(p_method);
  2469. if (line == -1) {
  2470. return false;
  2471. }
  2472. return edit(p_script, line, 0);
  2473. }
  2474. void ScriptEditor::set_live_auto_reload_running_scripts(bool p_enabled) {
  2475. auto_reload_running_scripts = p_enabled;
  2476. }
  2477. void ScriptEditor::_help_search(String p_text) {
  2478. help_search_dialog->popup_dialog(p_text);
  2479. }
  2480. void ScriptEditor::_open_script_request(const String &p_path) {
  2481. Ref<Script> script = ResourceLoader::load(p_path);
  2482. if (script.is_valid()) {
  2483. script_editor->edit(script, false);
  2484. return;
  2485. }
  2486. Error err;
  2487. Ref<TextFile> text_file = script_editor->_load_text_file(p_path, &err);
  2488. if (text_file.is_valid()) {
  2489. script_editor->edit(text_file, false);
  2490. return;
  2491. }
  2492. }
  2493. int ScriptEditor::syntax_highlighters_func_count = 0;
  2494. CreateSyntaxHighlighterFunc ScriptEditor::syntax_highlighters_funcs[ScriptEditor::SYNTAX_HIGHLIGHTER_FUNC_MAX];
  2495. void ScriptEditor::register_create_syntax_highlighter_function(CreateSyntaxHighlighterFunc p_func) {
  2496. ERR_FAIL_COND(syntax_highlighters_func_count == SYNTAX_HIGHLIGHTER_FUNC_MAX);
  2497. syntax_highlighters_funcs[syntax_highlighters_func_count++] = p_func;
  2498. }
  2499. int ScriptEditor::script_editor_func_count = 0;
  2500. CreateScriptEditorFunc ScriptEditor::script_editor_funcs[ScriptEditor::SCRIPT_EDITOR_FUNC_MAX];
  2501. void ScriptEditor::register_create_script_editor_function(CreateScriptEditorFunc p_func) {
  2502. ERR_FAIL_COND(script_editor_func_count == SCRIPT_EDITOR_FUNC_MAX);
  2503. script_editor_funcs[script_editor_func_count++] = p_func;
  2504. }
  2505. void ScriptEditor::_script_changed() {
  2506. NodeDock::singleton->update_lists();
  2507. }
  2508. void ScriptEditor::_on_find_in_files_requested(String text) {
  2509. find_in_files_dialog->set_search_text(text);
  2510. find_in_files_dialog->popup_centered_minsize();
  2511. }
  2512. void ScriptEditor::_on_find_in_files_result_selected(String fpath, int line_number, int begin, int end) {
  2513. if (ResourceLoader::exists(fpath)) {
  2514. RES res = ResourceLoader::load(fpath);
  2515. if (fpath.get_extension() == "gdshader" || fpath.get_extension() == "shader") {
  2516. ShaderEditorPlugin *shader_editor = Object::cast_to<ShaderEditorPlugin>(EditorNode::get_singleton()->get_editor_data().get_editor("Shader"));
  2517. shader_editor->edit(res.ptr());
  2518. shader_editor->make_visible(true);
  2519. shader_editor->get_shader_editor()->goto_line_selection(line_number - 1, begin, end);
  2520. return;
  2521. } else {
  2522. Ref<Script> script = res;
  2523. if (script.is_valid()) {
  2524. edit(script);
  2525. ScriptTextEditor *ste = Object::cast_to<ScriptTextEditor>(_get_current_editor());
  2526. if (ste) {
  2527. ste->goto_line_selection(line_number - 1, begin, end);
  2528. }
  2529. return;
  2530. }
  2531. }
  2532. }
  2533. // If the file is not a valid resource/script, load it as a text file.
  2534. Error err;
  2535. Ref<TextFile> text_file = _load_text_file(fpath, &err);
  2536. if (text_file.is_valid()) {
  2537. edit(text_file);
  2538. TextEditor *te = Object::cast_to<TextEditor>(_get_current_editor());
  2539. if (te) {
  2540. te->goto_line_selection(line_number - 1, begin, end);
  2541. }
  2542. }
  2543. }
  2544. void ScriptEditor::_start_find_in_files(bool with_replace) {
  2545. FindInFiles *f = find_in_files->get_finder();
  2546. f->set_search_text(find_in_files_dialog->get_search_text());
  2547. f->set_match_case(find_in_files_dialog->is_match_case());
  2548. f->set_whole_words(find_in_files_dialog->is_whole_words());
  2549. f->set_folder(find_in_files_dialog->get_folder());
  2550. f->set_filter(find_in_files_dialog->get_filter());
  2551. find_in_files->set_with_replace(with_replace);
  2552. find_in_files->start_search();
  2553. editor->make_bottom_panel_item_visible(find_in_files);
  2554. }
  2555. void ScriptEditor::_on_find_in_files_modified_files(PoolStringArray paths) {
  2556. _test_script_times_on_disk();
  2557. _update_modified_scripts_for_external_editor();
  2558. }
  2559. void ScriptEditor::_filter_scripts_text_changed(const String &p_newtext) {
  2560. _update_script_names();
  2561. }
  2562. void ScriptEditor::_filter_methods_text_changed(const String &p_newtext) {
  2563. _update_members_overview();
  2564. }
  2565. void ScriptEditor::_bind_methods() {
  2566. ClassDB::bind_method("_file_dialog_action", &ScriptEditor::_file_dialog_action);
  2567. ClassDB::bind_method("_tab_changed", &ScriptEditor::_tab_changed);
  2568. ClassDB::bind_method("_menu_option", &ScriptEditor::_menu_option);
  2569. ClassDB::bind_method("_close_current_tab", &ScriptEditor::_close_current_tab);
  2570. ClassDB::bind_method("_close_discard_current_tab", &ScriptEditor::_close_discard_current_tab);
  2571. ClassDB::bind_method("_close_docs_tab", &ScriptEditor::_close_docs_tab);
  2572. ClassDB::bind_method("_close_all_tabs", &ScriptEditor::_close_all_tabs);
  2573. ClassDB::bind_method("_close_other_tabs", &ScriptEditor::_close_other_tabs);
  2574. ClassDB::bind_method("_open_recent_script", &ScriptEditor::_open_recent_script);
  2575. ClassDB::bind_method("_theme_option", &ScriptEditor::_theme_option);
  2576. ClassDB::bind_method("_editor_play", &ScriptEditor::_editor_play);
  2577. ClassDB::bind_method("_editor_pause", &ScriptEditor::_editor_pause);
  2578. ClassDB::bind_method("_editor_stop", &ScriptEditor::_editor_stop);
  2579. ClassDB::bind_method("_add_callback", &ScriptEditor::_add_callback);
  2580. ClassDB::bind_method("_reload_scripts", &ScriptEditor::_reload_scripts);
  2581. ClassDB::bind_method("_resave_scripts", &ScriptEditor::_resave_scripts);
  2582. ClassDB::bind_method("_res_saved_callback", &ScriptEditor::_res_saved_callback);
  2583. ClassDB::bind_method("_goto_script_line", &ScriptEditor::_goto_script_line);
  2584. ClassDB::bind_method("_goto_script_line2", &ScriptEditor::_goto_script_line2);
  2585. ClassDB::bind_method("_set_execution", &ScriptEditor::_set_execution);
  2586. ClassDB::bind_method("_clear_execution", &ScriptEditor::_clear_execution);
  2587. ClassDB::bind_method("_help_search", &ScriptEditor::_help_search);
  2588. ClassDB::bind_method("_save_history", &ScriptEditor::_save_history);
  2589. ClassDB::bind_method("_copy_script_path", &ScriptEditor::_copy_script_path);
  2590. ClassDB::bind_method("_breaked", &ScriptEditor::_breaked);
  2591. ClassDB::bind_method("_show_debugger", &ScriptEditor::_show_debugger);
  2592. ClassDB::bind_method("_get_debug_tooltip", &ScriptEditor::_get_debug_tooltip);
  2593. ClassDB::bind_method("_autosave_scripts", &ScriptEditor::_autosave_scripts);
  2594. ClassDB::bind_method("_update_autosave_timer", &ScriptEditor::_update_autosave_timer);
  2595. ClassDB::bind_method("_editor_settings_changed", &ScriptEditor::_editor_settings_changed);
  2596. ClassDB::bind_method("_update_script_names", &ScriptEditor::_update_script_names);
  2597. ClassDB::bind_method("_update_script_connections", &ScriptEditor::_update_script_connections);
  2598. ClassDB::bind_method("_tree_changed", &ScriptEditor::_tree_changed);
  2599. ClassDB::bind_method("_members_overview_selected", &ScriptEditor::_members_overview_selected);
  2600. ClassDB::bind_method("_help_overview_selected", &ScriptEditor::_help_overview_selected);
  2601. ClassDB::bind_method("_script_selected", &ScriptEditor::_script_selected);
  2602. ClassDB::bind_method("_script_created", &ScriptEditor::_script_created);
  2603. ClassDB::bind_method("_script_split_dragged", &ScriptEditor::_script_split_dragged);
  2604. ClassDB::bind_method("_help_class_open", &ScriptEditor::_help_class_open);
  2605. ClassDB::bind_method("_help_class_goto", &ScriptEditor::_help_class_goto);
  2606. ClassDB::bind_method("_request_help", &ScriptEditor::_help_class_open);
  2607. ClassDB::bind_method("_history_forward", &ScriptEditor::_history_forward);
  2608. ClassDB::bind_method("_history_back", &ScriptEditor::_history_back);
  2609. ClassDB::bind_method("_live_auto_reload_running_scripts", &ScriptEditor::_live_auto_reload_running_scripts);
  2610. ClassDB::bind_method("_unhandled_input", &ScriptEditor::_unhandled_input);
  2611. ClassDB::bind_method("_script_list_gui_input", &ScriptEditor::_script_list_gui_input);
  2612. ClassDB::bind_method("_toggle_members_overview_alpha_sort", &ScriptEditor::_toggle_members_overview_alpha_sort);
  2613. ClassDB::bind_method("_update_members_overview", &ScriptEditor::_update_members_overview);
  2614. ClassDB::bind_method("_script_changed", &ScriptEditor::_script_changed);
  2615. ClassDB::bind_method("_filter_scripts_text_changed", &ScriptEditor::_filter_scripts_text_changed);
  2616. ClassDB::bind_method("_filter_methods_text_changed", &ScriptEditor::_filter_methods_text_changed);
  2617. ClassDB::bind_method("_update_recent_scripts", &ScriptEditor::_update_recent_scripts);
  2618. ClassDB::bind_method("_on_find_in_files_requested", &ScriptEditor::_on_find_in_files_requested);
  2619. ClassDB::bind_method("_start_find_in_files", &ScriptEditor::_start_find_in_files);
  2620. ClassDB::bind_method("_on_find_in_files_result_selected", &ScriptEditor::_on_find_in_files_result_selected);
  2621. ClassDB::bind_method("_on_find_in_files_modified_files", &ScriptEditor::_on_find_in_files_modified_files);
  2622. ClassDB::bind_method(D_METHOD("get_drag_data_fw", "point", "from"), &ScriptEditor::get_drag_data_fw);
  2623. ClassDB::bind_method(D_METHOD("can_drop_data_fw", "point", "data", "from"), &ScriptEditor::can_drop_data_fw);
  2624. ClassDB::bind_method(D_METHOD("drop_data_fw", "point", "data", "from"), &ScriptEditor::drop_data_fw);
  2625. ClassDB::bind_method(D_METHOD("goto_line", "line_number"), &ScriptEditor::_goto_script_line2);
  2626. ClassDB::bind_method(D_METHOD("get_current_script"), &ScriptEditor::_get_current_script);
  2627. ClassDB::bind_method(D_METHOD("get_open_scripts"), &ScriptEditor::_get_open_scripts);
  2628. ClassDB::bind_method(D_METHOD("open_script_create_dialog", "base_name", "base_path"), &ScriptEditor::open_script_create_dialog);
  2629. ADD_SIGNAL(MethodInfo("editor_script_changed", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script")));
  2630. ADD_SIGNAL(MethodInfo("script_close", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script")));
  2631. }
  2632. ScriptEditor::ScriptEditor(EditorNode *p_editor) {
  2633. current_theme = "";
  2634. completion_cache = memnew(EditorScriptCodeCompletionCache);
  2635. restoring_layout = false;
  2636. waiting_update_names = false;
  2637. pending_auto_reload = false;
  2638. auto_reload_running_scripts = true;
  2639. members_overview_enabled = EditorSettings::get_singleton()->get("text_editor/script_list/show_members_overview");
  2640. help_overview_enabled = EditorSettings::get_singleton()->get("text_editor/help/show_help_index");
  2641. editor = p_editor;
  2642. VBoxContainer *main_container = memnew(VBoxContainer);
  2643. add_child(main_container);
  2644. menu_hb = memnew(HBoxContainer);
  2645. main_container->add_child(menu_hb);
  2646. script_split = memnew(HSplitContainer);
  2647. main_container->add_child(script_split);
  2648. script_split->set_v_size_flags(SIZE_EXPAND_FILL);
  2649. list_split = memnew(VSplitContainer);
  2650. script_split->add_child(list_split);
  2651. list_split->set_v_size_flags(SIZE_EXPAND_FILL);
  2652. scripts_vbox = memnew(VBoxContainer);
  2653. scripts_vbox->set_v_size_flags(SIZE_EXPAND_FILL);
  2654. list_split->add_child(scripts_vbox);
  2655. filter_scripts = memnew(LineEdit);
  2656. filter_scripts->set_placeholder(TTR("Filter scripts"));
  2657. filter_scripts->set_clear_button_enabled(true);
  2658. filter_scripts->connect("text_changed", this, "_filter_scripts_text_changed");
  2659. scripts_vbox->add_child(filter_scripts);
  2660. script_list = memnew(ItemList);
  2661. scripts_vbox->add_child(script_list);
  2662. script_list->set_custom_minimum_size(Size2(150, 60) * EDSCALE); //need to give a bit of limit to avoid it from disappearing
  2663. script_list->set_v_size_flags(SIZE_EXPAND_FILL);
  2664. script_split->set_split_offset(70 * EDSCALE);
  2665. _sort_list_on_update = true;
  2666. script_list->connect("gui_input", this, "_script_list_gui_input", varray(), CONNECT_DEFERRED);
  2667. script_list->set_allow_rmb_select(true);
  2668. script_list->set_drag_forwarding(this);
  2669. context_menu = memnew(PopupMenu);
  2670. add_child(context_menu);
  2671. context_menu->connect("id_pressed", this, "_menu_option");
  2672. context_menu->set_hide_on_window_lose_focus(true);
  2673. overview_vbox = memnew(VBoxContainer);
  2674. overview_vbox->set_custom_minimum_size(Size2(0, 90));
  2675. overview_vbox->set_v_size_flags(SIZE_EXPAND_FILL);
  2676. list_split->add_child(overview_vbox);
  2677. list_split->set_visible(EditorSettings::get_singleton()->get_project_metadata("scripts_panel", "show_scripts_panel", true));
  2678. buttons_hbox = memnew(HBoxContainer);
  2679. overview_vbox->add_child(buttons_hbox);
  2680. filename = memnew(Label);
  2681. filename->set_clip_text(true);
  2682. filename->set_h_size_flags(SIZE_EXPAND_FILL);
  2683. filename->add_style_override("normal", EditorNode::get_singleton()->get_gui_base()->get_stylebox("normal", "LineEdit"));
  2684. buttons_hbox->add_child(filename);
  2685. members_overview_alphabeta_sort_button = memnew(ToolButton);
  2686. members_overview_alphabeta_sort_button->set_tooltip(TTR("Toggle alphabetical sorting of the method list."));
  2687. members_overview_alphabeta_sort_button->set_toggle_mode(true);
  2688. members_overview_alphabeta_sort_button->set_pressed(EditorSettings::get_singleton()->get("text_editor/tools/sort_members_outline_alphabetically"));
  2689. members_overview_alphabeta_sort_button->connect("toggled", this, "_toggle_members_overview_alpha_sort");
  2690. buttons_hbox->add_child(members_overview_alphabeta_sort_button);
  2691. filter_methods = memnew(LineEdit);
  2692. filter_methods->set_placeholder(TTR("Filter methods"));
  2693. filter_methods->set_clear_button_enabled(true);
  2694. filter_methods->connect("text_changed", this, "_filter_methods_text_changed");
  2695. overview_vbox->add_child(filter_methods);
  2696. members_overview = memnew(ItemList);
  2697. overview_vbox->add_child(members_overview);
  2698. members_overview->set_allow_reselect(true);
  2699. members_overview->set_custom_minimum_size(Size2(0, 60) * EDSCALE); //need to give a bit of limit to avoid it from disappearing
  2700. members_overview->set_v_size_flags(SIZE_EXPAND_FILL);
  2701. members_overview->set_allow_rmb_select(true);
  2702. help_overview = memnew(ItemList);
  2703. overview_vbox->add_child(help_overview);
  2704. help_overview->set_allow_reselect(true);
  2705. help_overview->set_custom_minimum_size(Size2(0, 60) * EDSCALE); //need to give a bit of limit to avoid it from disappearing
  2706. help_overview->set_v_size_flags(SIZE_EXPAND_FILL);
  2707. tab_container = memnew(TabContainer);
  2708. tab_container->set_tabs_visible(false);
  2709. tab_container->set_custom_minimum_size(Size2(200, 0) * EDSCALE);
  2710. script_split->add_child(tab_container);
  2711. tab_container->set_h_size_flags(SIZE_EXPAND_FILL);
  2712. ED_SHORTCUT("script_editor/window_sort", TTR("Sort"));
  2713. ED_SHORTCUT("script_editor/window_move_up", TTR("Move Up"), KEY_MASK_SHIFT | KEY_MASK_ALT | KEY_UP);
  2714. ED_SHORTCUT("script_editor/window_move_down", TTR("Move Down"), KEY_MASK_SHIFT | KEY_MASK_ALT | KEY_DOWN);
  2715. 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
  2716. ED_SHORTCUT("script_editor/prev_script", TTR("Previous script"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_COMMA);
  2717. set_process_unhandled_input(true);
  2718. file_menu = memnew(MenuButton);
  2719. menu_hb->add_child(file_menu);
  2720. file_menu->set_text(TTR("File"));
  2721. file_menu->set_switch_on_hover(true);
  2722. file_menu->get_popup()->set_hide_on_window_lose_focus(true);
  2723. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/new", TTR("New Script...")), FILE_NEW);
  2724. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/new_textfile", TTR("New Text File...")), FILE_NEW_TEXTFILE);
  2725. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/open", TTR("Open...")), FILE_OPEN);
  2726. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/reopen_closed_script", TTR("Reopen Closed Script"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_T), FILE_REOPEN_CLOSED);
  2727. file_menu->get_popup()->add_submenu_item(TTR("Open Recent"), "RecentScripts", FILE_OPEN_RECENT);
  2728. recent_scripts = memnew(PopupMenu);
  2729. recent_scripts->set_name("RecentScripts");
  2730. file_menu->get_popup()->add_child(recent_scripts);
  2731. recent_scripts->connect("id_pressed", this, "_open_recent_script");
  2732. _update_recent_scripts();
  2733. file_menu->get_popup()->add_separator();
  2734. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/save", TTR("Save"), KEY_MASK_ALT | KEY_MASK_CMD | KEY_S), FILE_SAVE);
  2735. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/save_as", TTR("Save As...")), FILE_SAVE_AS);
  2736. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/save_all", TTR("Save All"), KEY_MASK_SHIFT | KEY_MASK_ALT | KEY_S), FILE_SAVE_ALL);
  2737. file_menu->get_popup()->add_separator();
  2738. 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);
  2739. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/copy_path", TTR("Copy Script Path")), FILE_COPY_PATH);
  2740. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/show_in_file_system", TTR("Show in FileSystem")), SHOW_IN_FILE_SYSTEM);
  2741. file_menu->get_popup()->add_separator();
  2742. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/history_previous", TTR("History Previous"), KEY_MASK_ALT | KEY_LEFT), WINDOW_PREV);
  2743. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/history_next", TTR("History Next"), KEY_MASK_ALT | KEY_RIGHT), WINDOW_NEXT);
  2744. file_menu->get_popup()->add_separator();
  2745. file_menu->get_popup()->add_submenu_item(TTR("Theme"), "Theme", FILE_THEME);
  2746. theme_submenu = memnew(PopupMenu);
  2747. theme_submenu->set_name("Theme");
  2748. file_menu->get_popup()->add_child(theme_submenu);
  2749. theme_submenu->connect("id_pressed", this, "_theme_option");
  2750. theme_submenu->add_shortcut(ED_SHORTCUT("script_editor/import_theme", TTR("Import Theme...")), THEME_IMPORT);
  2751. theme_submenu->add_shortcut(ED_SHORTCUT("script_editor/reload_theme", TTR("Reload Theme")), THEME_RELOAD);
  2752. theme_submenu->add_separator();
  2753. theme_submenu->add_shortcut(ED_SHORTCUT("script_editor/save_theme", TTR("Save Theme")), THEME_SAVE);
  2754. theme_submenu->add_shortcut(ED_SHORTCUT("script_editor/save_theme_as", TTR("Save Theme As...")), THEME_SAVE_AS);
  2755. file_menu->get_popup()->add_separator();
  2756. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/close_file", TTR("Close"), KEY_MASK_CMD | KEY_W), FILE_CLOSE);
  2757. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/close_all", TTR("Close All")), CLOSE_ALL);
  2758. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/close_other_tabs", TTR("Close Other Tabs")), CLOSE_OTHER_TABS);
  2759. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/close_docs", TTR("Close Docs")), CLOSE_DOCS);
  2760. file_menu->get_popup()->add_separator();
  2761. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/run_file", TTR("Run"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_X), FILE_RUN);
  2762. file_menu->get_popup()->add_separator();
  2763. 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);
  2764. file_menu->get_popup()->connect("id_pressed", this, "_menu_option");
  2765. script_search_menu = memnew(MenuButton);
  2766. menu_hb->add_child(script_search_menu);
  2767. script_search_menu->set_text(TTR("Search"));
  2768. script_search_menu->set_switch_on_hover(true);
  2769. script_search_menu->get_popup()->set_hide_on_window_lose_focus(true);
  2770. script_search_menu->get_popup()->connect("id_pressed", this, "_menu_option");
  2771. debug_menu = memnew(MenuButton);
  2772. menu_hb->add_child(debug_menu);
  2773. debug_menu->set_text(TTR("Debug"));
  2774. debug_menu->set_switch_on_hover(true);
  2775. debug_menu->get_popup()->set_hide_on_window_lose_focus(true);
  2776. debug_menu->get_popup()->add_shortcut(ED_SHORTCUT("debugger/step_into", TTR("Step Into"), KEY_F11), DEBUG_STEP);
  2777. debug_menu->get_popup()->add_shortcut(ED_SHORTCUT("debugger/step_over", TTR("Step Over"), KEY_F10), DEBUG_NEXT);
  2778. debug_menu->get_popup()->add_separator();
  2779. debug_menu->get_popup()->add_shortcut(ED_SHORTCUT("debugger/break", TTR("Break")), DEBUG_BREAK);
  2780. debug_menu->get_popup()->add_shortcut(ED_SHORTCUT("debugger/continue", TTR("Continue"), KEY_F12), DEBUG_CONTINUE);
  2781. debug_menu->get_popup()->add_separator();
  2782. debug_menu->get_popup()->add_check_shortcut(ED_SHORTCUT("debugger/keep_debugger_open", TTR("Keep Debugger Open")), DEBUG_KEEP_DEBUGGER_OPEN);
  2783. debug_menu->get_popup()->add_check_shortcut(ED_SHORTCUT("debugger/debug_with_external_editor", TTR("Debug with External Editor")), DEBUG_WITH_EXTERNAL_EDITOR);
  2784. debug_menu->get_popup()->connect("id_pressed", this, "_menu_option");
  2785. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_NEXT), true);
  2786. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_STEP), true);
  2787. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_BREAK), true);
  2788. debug_menu->get_popup()->set_item_disabled(debug_menu->get_popup()->get_item_index(DEBUG_CONTINUE), true);
  2789. menu_hb->add_spacer();
  2790. script_icon = memnew(TextureRect);
  2791. menu_hb->add_child(script_icon);
  2792. script_name_label = memnew(Label);
  2793. menu_hb->add_child(script_name_label);
  2794. script_icon->hide();
  2795. script_name_label->hide();
  2796. menu_hb->add_spacer();
  2797. site_search = memnew(ToolButton);
  2798. site_search->set_text(TTR("Online Docs"));
  2799. site_search->connect("pressed", this, "_menu_option", varray(SEARCH_WEBSITE));
  2800. menu_hb->add_child(site_search);
  2801. site_search->set_tooltip(TTR("Open Godot online documentation."));
  2802. help_search = memnew(ToolButton);
  2803. help_search->set_text(TTR("Search Help"));
  2804. help_search->connect("pressed", this, "_menu_option", varray(SEARCH_HELP));
  2805. menu_hb->add_child(help_search);
  2806. help_search->set_tooltip(TTR("Search the reference documentation."));
  2807. menu_hb->add_child(memnew(VSeparator));
  2808. script_back = memnew(ToolButton);
  2809. script_back->connect("pressed", this, "_history_back");
  2810. menu_hb->add_child(script_back);
  2811. script_back->set_disabled(true);
  2812. script_back->set_tooltip(TTR("Go to previous edited document."));
  2813. script_forward = memnew(ToolButton);
  2814. script_forward->connect("pressed", this, "_history_forward");
  2815. menu_hb->add_child(script_forward);
  2816. script_forward->set_disabled(true);
  2817. script_forward->set_tooltip(TTR("Go to next edited document."));
  2818. tab_container->connect("tab_changed", this, "_tab_changed");
  2819. erase_tab_confirm = memnew(ConfirmationDialog);
  2820. erase_tab_confirm->get_ok()->set_text(TTR("Save"));
  2821. erase_tab_confirm->add_button(TTR("Discard"), OS::get_singleton()->get_swap_ok_cancel(), "discard");
  2822. erase_tab_confirm->connect("confirmed", this, "_close_current_tab", varray(true));
  2823. erase_tab_confirm->connect("custom_action", this, "_close_discard_current_tab");
  2824. add_child(erase_tab_confirm);
  2825. script_create_dialog = memnew(ScriptCreateDialog);
  2826. script_create_dialog->set_title(TTR("Create Script"));
  2827. add_child(script_create_dialog);
  2828. script_create_dialog->connect("script_created", this, "_script_created");
  2829. file_dialog_option = -1;
  2830. file_dialog = memnew(EditorFileDialog);
  2831. add_child(file_dialog);
  2832. file_dialog->connect("file_selected", this, "_file_dialog_action");
  2833. error_dialog = memnew(AcceptDialog);
  2834. add_child(error_dialog);
  2835. debugger = memnew(ScriptEditorDebugger(editor));
  2836. debugger->connect("goto_script_line", this, "_goto_script_line");
  2837. debugger->connect("set_execution", this, "_set_execution");
  2838. debugger->connect("clear_execution", this, "_clear_execution");
  2839. debugger->connect("show_debugger", this, "_show_debugger");
  2840. disk_changed = memnew(ConfirmationDialog);
  2841. {
  2842. VBoxContainer *vbc = memnew(VBoxContainer);
  2843. disk_changed->add_child(vbc);
  2844. Label *dl = memnew(Label);
  2845. dl->set_text(TTR("The following files are newer on disk.\nWhat action should be taken?:"));
  2846. vbc->add_child(dl);
  2847. disk_changed_list = memnew(Tree);
  2848. vbc->add_child(disk_changed_list);
  2849. disk_changed_list->set_v_size_flags(SIZE_EXPAND_FILL);
  2850. disk_changed->connect("confirmed", this, "_reload_scripts");
  2851. disk_changed->get_ok()->set_text(TTR("Reload"));
  2852. disk_changed->add_button(TTR("Resave"), !OS::get_singleton()->get_swap_ok_cancel(), "resave");
  2853. disk_changed->connect("custom_action", this, "_resave_scripts");
  2854. }
  2855. add_child(disk_changed);
  2856. script_editor = this;
  2857. Button *db = EditorNode::get_singleton()->add_bottom_panel_item(TTR("Debugger"), debugger);
  2858. debugger->set_tool_button(db);
  2859. debugger->connect("breaked", this, "_breaked");
  2860. autosave_timer = memnew(Timer);
  2861. autosave_timer->set_one_shot(false);
  2862. autosave_timer->connect(SceneStringNames::get_singleton()->tree_entered, this, "_update_autosave_timer");
  2863. autosave_timer->connect("timeout", this, "_autosave_scripts");
  2864. add_child(autosave_timer);
  2865. grab_focus_block = false;
  2866. help_search_dialog = memnew(EditorHelpSearch);
  2867. add_child(help_search_dialog);
  2868. help_search_dialog->connect("go_to_help", this, "_help_class_goto");
  2869. find_in_files_dialog = memnew(FindInFilesDialog);
  2870. find_in_files_dialog->connect(FindInFilesDialog::SIGNAL_FIND_REQUESTED, this, "_start_find_in_files", varray(false));
  2871. find_in_files_dialog->connect(FindInFilesDialog::SIGNAL_REPLACE_REQUESTED, this, "_start_find_in_files", varray(true));
  2872. add_child(find_in_files_dialog);
  2873. find_in_files = memnew(FindInFilesPanel);
  2874. find_in_files_button = editor->add_bottom_panel_item(TTR("Search Results"), find_in_files);
  2875. find_in_files->set_custom_minimum_size(Size2(0, 200) * EDSCALE);
  2876. find_in_files->connect(FindInFilesPanel::SIGNAL_RESULT_SELECTED, this, "_on_find_in_files_result_selected");
  2877. find_in_files->connect(FindInFilesPanel::SIGNAL_FILES_MODIFIED, this, "_on_find_in_files_modified_files");
  2878. find_in_files->hide();
  2879. find_in_files_button->hide();
  2880. history_pos = -1;
  2881. //debugger_gui->hide();
  2882. edit_pass = 0;
  2883. trim_trailing_whitespace_on_save = EditorSettings::get_singleton()->get("text_editor/files/trim_trailing_whitespace_on_save");
  2884. convert_indent_on_save = EditorSettings::get_singleton()->get("text_editor/indent/convert_indent_on_save");
  2885. use_space_indentation = EditorSettings::get_singleton()->get("text_editor/indent/type");
  2886. ScriptServer::edit_request_func = _open_script_request;
  2887. add_style_override("panel", editor->get_gui_base()->get_stylebox("ScriptEditorPanel", "EditorStyles"));
  2888. tab_container->add_style_override("panel", editor->get_gui_base()->get_stylebox("ScriptEditor", "EditorStyles"));
  2889. }
  2890. ScriptEditor::~ScriptEditor() {
  2891. memdelete(completion_cache);
  2892. }
  2893. void ScriptEditorPlugin::edit(Object *p_object) {
  2894. if (Object::cast_to<Script>(p_object)) {
  2895. Script *p_script = Object::cast_to<Script>(p_object);
  2896. String res_path = p_script->get_path().get_slice("::", 0);
  2897. if (_is_built_in_script(p_script)) {
  2898. if (ResourceLoader::get_resource_type(res_path) == "PackedScene") {
  2899. if (!EditorNode::get_singleton()->is_scene_open(res_path)) {
  2900. EditorNode::get_singleton()->load_scene(res_path);
  2901. }
  2902. } else {
  2903. EditorNode::get_singleton()->load_resource(res_path);
  2904. }
  2905. }
  2906. script_editor->edit(p_script);
  2907. } else if (Object::cast_to<TextFile>(p_object)) {
  2908. script_editor->edit(Object::cast_to<TextFile>(p_object));
  2909. }
  2910. }
  2911. bool ScriptEditorPlugin::handles(Object *p_object) const {
  2912. if (Object::cast_to<TextFile>(p_object)) {
  2913. return true;
  2914. }
  2915. if (Object::cast_to<Script>(p_object)) {
  2916. return true;
  2917. }
  2918. return p_object->is_class("Script");
  2919. }
  2920. void ScriptEditorPlugin::make_visible(bool p_visible) {
  2921. if (p_visible) {
  2922. script_editor->show();
  2923. script_editor->set_process(true);
  2924. script_editor->ensure_select_current();
  2925. } else {
  2926. script_editor->hide();
  2927. script_editor->set_process(false);
  2928. }
  2929. }
  2930. void ScriptEditorPlugin::selected_notify() {
  2931. script_editor->ensure_select_current();
  2932. }
  2933. void ScriptEditorPlugin::save_external_data() {
  2934. script_editor->save_all_scripts();
  2935. }
  2936. void ScriptEditorPlugin::apply_changes() {
  2937. script_editor->apply_scripts();
  2938. }
  2939. void ScriptEditorPlugin::restore_global_state() {
  2940. }
  2941. void ScriptEditorPlugin::save_global_state() {
  2942. }
  2943. void ScriptEditorPlugin::set_window_layout(Ref<ConfigFile> p_layout) {
  2944. script_editor->set_window_layout(p_layout);
  2945. }
  2946. void ScriptEditorPlugin::get_window_layout(Ref<ConfigFile> p_layout) {
  2947. script_editor->get_window_layout(p_layout);
  2948. }
  2949. void ScriptEditorPlugin::get_breakpoints(List<String> *p_breakpoints) {
  2950. script_editor->get_breakpoints(p_breakpoints);
  2951. }
  2952. void ScriptEditorPlugin::edited_scene_changed() {
  2953. script_editor->edited_scene_changed();
  2954. }
  2955. ScriptEditorPlugin::ScriptEditorPlugin(EditorNode *p_node) {
  2956. editor = p_node;
  2957. script_editor = memnew(ScriptEditor(p_node));
  2958. editor->get_viewport()->add_child(script_editor);
  2959. script_editor->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  2960. script_editor->hide();
  2961. EDITOR_DEF("text_editor/files/auto_reload_scripts_on_external_change", true);
  2962. ScriptServer::set_reload_scripts_on_save(EDITOR_DEF("text_editor/files/auto_reload_and_parse_scripts_on_save", true));
  2963. EDITOR_DEF("text_editor/files/open_dominant_script_on_scene_change", true);
  2964. EDITOR_DEF("text_editor/external/use_external_editor", false);
  2965. EDITOR_DEF("text_editor/external/exec_path", "");
  2966. EDITOR_DEF("text_editor/script_list/script_temperature_enabled", true);
  2967. EDITOR_DEF("text_editor/script_list/highlight_current_script", true);
  2968. EDITOR_DEF("text_editor/script_list/script_temperature_history_size", 15);
  2969. EDITOR_DEF("text_editor/script_list/current_script_background_color", Color(1, 1, 1, 0.3));
  2970. EDITOR_DEF("text_editor/script_list/group_help_pages", true);
  2971. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::INT, "text_editor/script_list/sort_scripts_by", PROPERTY_HINT_ENUM, "Name,Path,None"));
  2972. EDITOR_DEF("text_editor/script_list/sort_scripts_by", 0);
  2973. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::INT, "text_editor/script_list/list_script_names_as", PROPERTY_HINT_ENUM, "Name,Parent Directory And Name,Full Path"));
  2974. EDITOR_DEF("text_editor/script_list/list_script_names_as", 0);
  2975. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "text_editor/external/exec_path", PROPERTY_HINT_GLOBAL_FILE));
  2976. EDITOR_DEF("text_editor/external/exec_flags", "{file}");
  2977. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "text_editor/external/exec_flags", PROPERTY_HINT_PLACEHOLDER_TEXT, "Call flags with placeholders: {project}, {file}, {col}, {line}."));
  2978. ED_SHORTCUT("script_editor/reopen_closed_script", TTR("Reopen Closed Script"), KEY_MASK_CMD | KEY_MASK_SHIFT | KEY_T);
  2979. ED_SHORTCUT("script_editor/clear_recent", TTR("Clear Recent Scripts"));
  2980. }
  2981. ScriptEditorPlugin::~ScriptEditorPlugin() {
  2982. }