script_editor_plugin.cpp 122 KB

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