script_editor_plugin.cpp 149 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545
  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/config/project_settings.h"
  32. #include "core/input/input.h"
  33. #include "core/io/file_access.h"
  34. #include "core/io/json.h"
  35. #include "core/io/resource_loader.h"
  36. #include "core/os/keyboard.h"
  37. #include "core/os/os.h"
  38. #include "core/version.h"
  39. #include "editor/code_editor.h"
  40. #include "editor/debugger/editor_debugger_node.h"
  41. #include "editor/debugger/script_editor_debugger.h"
  42. #include "editor/editor_command_palette.h"
  43. #include "editor/editor_help_search.h"
  44. #include "editor/editor_interface.h"
  45. #include "editor/editor_node.h"
  46. #include "editor/editor_paths.h"
  47. #include "editor/editor_script.h"
  48. #include "editor/editor_settings.h"
  49. #include "editor/editor_string_names.h"
  50. #include "editor/filesystem_dock.h"
  51. #include "editor/find_in_files.h"
  52. #include "editor/gui/editor_bottom_panel.h"
  53. #include "editor/gui/editor_file_dialog.h"
  54. #include "editor/gui/editor_run_bar.h"
  55. #include "editor/gui/editor_toaster.h"
  56. #include "editor/inspector_dock.h"
  57. #include "editor/node_dock.h"
  58. #include "editor/plugins/shader_editor_plugin.h"
  59. #include "editor/plugins/text_shader_editor.h"
  60. #include "editor/themes/editor_scale.h"
  61. #include "editor/themes/editor_theme_manager.h"
  62. #include "editor/window_wrapper.h"
  63. #include "scene/main/node.h"
  64. #include "scene/main/window.h"
  65. #include "script_text_editor.h"
  66. #include "servers/display_server.h"
  67. #include "text_editor.h"
  68. /*** SYNTAX HIGHLIGHTER ****/
  69. String EditorSyntaxHighlighter::_get_name() const {
  70. String ret = "Unnamed";
  71. GDVIRTUAL_CALL(_get_name, ret);
  72. return ret;
  73. }
  74. PackedStringArray EditorSyntaxHighlighter::_get_supported_languages() const {
  75. PackedStringArray ret;
  76. GDVIRTUAL_CALL(_get_supported_languages, ret);
  77. return ret;
  78. }
  79. Ref<EditorSyntaxHighlighter> EditorSyntaxHighlighter::_create() const {
  80. Ref<EditorSyntaxHighlighter> syntax_highlighter;
  81. syntax_highlighter.instantiate();
  82. if (get_script_instance()) {
  83. syntax_highlighter->set_script(get_script_instance()->get_script());
  84. }
  85. return syntax_highlighter;
  86. }
  87. void EditorSyntaxHighlighter::_bind_methods() {
  88. ClassDB::bind_method(D_METHOD("_get_edited_resource"), &EditorSyntaxHighlighter::_get_edited_resource);
  89. GDVIRTUAL_BIND(_get_name)
  90. GDVIRTUAL_BIND(_get_supported_languages)
  91. }
  92. ////
  93. void EditorStandardSyntaxHighlighter::_update_cache() {
  94. highlighter->set_text_edit(text_edit);
  95. highlighter->clear_keyword_colors();
  96. highlighter->clear_member_keyword_colors();
  97. highlighter->clear_color_regions();
  98. highlighter->set_symbol_color(EDITOR_GET("text_editor/theme/highlighting/symbol_color"));
  99. highlighter->set_function_color(EDITOR_GET("text_editor/theme/highlighting/function_color"));
  100. highlighter->set_number_color(EDITOR_GET("text_editor/theme/highlighting/number_color"));
  101. highlighter->set_member_variable_color(EDITOR_GET("text_editor/theme/highlighting/member_variable_color"));
  102. /* Engine types. */
  103. const Color type_color = EDITOR_GET("text_editor/theme/highlighting/engine_type_color");
  104. List<StringName> types;
  105. ClassDB::get_class_list(&types);
  106. for (const StringName &E : types) {
  107. highlighter->add_keyword_color(E, type_color);
  108. }
  109. /* User types. */
  110. const Color usertype_color = EDITOR_GET("text_editor/theme/highlighting/user_type_color");
  111. List<StringName> global_classes;
  112. ScriptServer::get_global_class_list(&global_classes);
  113. for (const StringName &E : global_classes) {
  114. highlighter->add_keyword_color(E, usertype_color);
  115. }
  116. /* Autoloads. */
  117. HashMap<StringName, ProjectSettings::AutoloadInfo> autoloads = ProjectSettings::get_singleton()->get_autoload_list();
  118. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : autoloads) {
  119. const ProjectSettings::AutoloadInfo &info = E.value;
  120. if (info.is_singleton) {
  121. highlighter->add_keyword_color(info.name, usertype_color);
  122. }
  123. }
  124. const ScriptLanguage *scr_lang = script_language;
  125. StringName instance_base;
  126. if (scr_lang == nullptr) {
  127. const Ref<Script> scr = _get_edited_resource();
  128. if (scr.is_valid()) {
  129. scr_lang = scr->get_language();
  130. instance_base = scr->get_instance_base_type();
  131. }
  132. }
  133. if (scr_lang != nullptr) {
  134. /* Core types. */
  135. const Color basetype_color = EDITOR_GET("text_editor/theme/highlighting/base_type_color");
  136. List<String> core_types;
  137. scr_lang->get_core_type_words(&core_types);
  138. for (const String &E : core_types) {
  139. highlighter->add_keyword_color(E, basetype_color);
  140. }
  141. /* Reserved words. */
  142. const Color keyword_color = EDITOR_GET("text_editor/theme/highlighting/keyword_color");
  143. const Color control_flow_keyword_color = EDITOR_GET("text_editor/theme/highlighting/control_flow_keyword_color");
  144. List<String> keywords;
  145. scr_lang->get_reserved_words(&keywords);
  146. for (const String &E : keywords) {
  147. if (scr_lang->is_control_flow_keyword(E)) {
  148. highlighter->add_keyword_color(E, control_flow_keyword_color);
  149. } else {
  150. highlighter->add_keyword_color(E, keyword_color);
  151. }
  152. }
  153. /* Member types. */
  154. const Color member_variable_color = EDITOR_GET("text_editor/theme/highlighting/member_variable_color");
  155. if (instance_base != StringName()) {
  156. List<PropertyInfo> plist;
  157. ClassDB::get_property_list(instance_base, &plist);
  158. for (const PropertyInfo &E : plist) {
  159. String prop_name = E.name;
  160. if (E.usage & PROPERTY_USAGE_CATEGORY || E.usage & PROPERTY_USAGE_GROUP || E.usage & PROPERTY_USAGE_SUBGROUP) {
  161. continue;
  162. }
  163. if (prop_name.contains("/")) {
  164. continue;
  165. }
  166. highlighter->add_member_keyword_color(prop_name, member_variable_color);
  167. }
  168. List<String> clist;
  169. ClassDB::get_integer_constant_list(instance_base, &clist);
  170. for (const String &E : clist) {
  171. highlighter->add_member_keyword_color(E, member_variable_color);
  172. }
  173. }
  174. /* Comments */
  175. const Color comment_color = EDITOR_GET("text_editor/theme/highlighting/comment_color");
  176. List<String> comments;
  177. scr_lang->get_comment_delimiters(&comments);
  178. for (const String &comment : comments) {
  179. String beg = comment.get_slice(" ", 0);
  180. String end = comment.get_slice_count(" ") > 1 ? comment.get_slice(" ", 1) : String();
  181. highlighter->add_color_region(beg, end, comment_color, end.is_empty());
  182. }
  183. /* Doc comments */
  184. const Color doc_comment_color = EDITOR_GET("text_editor/theme/highlighting/doc_comment_color");
  185. List<String> doc_comments;
  186. scr_lang->get_doc_comment_delimiters(&doc_comments);
  187. for (const String &doc_comment : doc_comments) {
  188. String beg = doc_comment.get_slice(" ", 0);
  189. String end = doc_comment.get_slice_count(" ") > 1 ? doc_comment.get_slice(" ", 1) : String();
  190. highlighter->add_color_region(beg, end, doc_comment_color, end.is_empty());
  191. }
  192. /* Strings */
  193. const Color string_color = EDITOR_GET("text_editor/theme/highlighting/string_color");
  194. List<String> strings;
  195. scr_lang->get_string_delimiters(&strings);
  196. for (const String &string : strings) {
  197. String beg = string.get_slice(" ", 0);
  198. String end = string.get_slice_count(" ") > 1 ? string.get_slice(" ", 1) : String();
  199. highlighter->add_color_region(beg, end, string_color, end.is_empty());
  200. }
  201. }
  202. }
  203. Ref<EditorSyntaxHighlighter> EditorStandardSyntaxHighlighter::_create() const {
  204. Ref<EditorStandardSyntaxHighlighter> syntax_highlighter;
  205. syntax_highlighter.instantiate();
  206. return syntax_highlighter;
  207. }
  208. ////
  209. Ref<EditorSyntaxHighlighter> EditorPlainTextSyntaxHighlighter::_create() const {
  210. Ref<EditorPlainTextSyntaxHighlighter> syntax_highlighter;
  211. syntax_highlighter.instantiate();
  212. return syntax_highlighter;
  213. }
  214. ////
  215. void EditorJSONSyntaxHighlighter::_update_cache() {
  216. highlighter->set_text_edit(text_edit);
  217. highlighter->clear_keyword_colors();
  218. highlighter->clear_member_keyword_colors();
  219. highlighter->clear_color_regions();
  220. highlighter->set_symbol_color(EDITOR_GET("text_editor/theme/highlighting/symbol_color"));
  221. highlighter->set_number_color(EDITOR_GET("text_editor/theme/highlighting/number_color"));
  222. const Color string_color = EDITOR_GET("text_editor/theme/highlighting/string_color");
  223. highlighter->add_color_region("\"", "\"", string_color);
  224. }
  225. Ref<EditorSyntaxHighlighter> EditorJSONSyntaxHighlighter::_create() const {
  226. Ref<EditorJSONSyntaxHighlighter> syntax_highlighter;
  227. syntax_highlighter.instantiate();
  228. return syntax_highlighter;
  229. }
  230. ////////////////////////////////////////////////////////////////////////////////
  231. /*** SCRIPT EDITOR ****/
  232. void ScriptEditorBase::_bind_methods() {
  233. ClassDB::bind_method(D_METHOD("get_base_editor"), &ScriptEditorBase::get_base_editor);
  234. ClassDB::bind_method(D_METHOD("add_syntax_highlighter", "highlighter"), &ScriptEditorBase::add_syntax_highlighter);
  235. ADD_SIGNAL(MethodInfo("name_changed"));
  236. ADD_SIGNAL(MethodInfo("edited_script_changed"));
  237. ADD_SIGNAL(MethodInfo("request_help", PropertyInfo(Variant::STRING, "topic")));
  238. ADD_SIGNAL(MethodInfo("request_open_script_at_line", PropertyInfo(Variant::OBJECT, "script"), PropertyInfo(Variant::INT, "line")));
  239. ADD_SIGNAL(MethodInfo("request_save_history"));
  240. ADD_SIGNAL(MethodInfo("request_save_previous_state", PropertyInfo(Variant::INT, "line")));
  241. ADD_SIGNAL(MethodInfo("go_to_help", PropertyInfo(Variant::STRING, "what")));
  242. ADD_SIGNAL(MethodInfo("search_in_files_requested", PropertyInfo(Variant::STRING, "text")));
  243. ADD_SIGNAL(MethodInfo("replace_in_files_requested", PropertyInfo(Variant::STRING, "text")));
  244. ADD_SIGNAL(MethodInfo("go_to_method", PropertyInfo(Variant::OBJECT, "script"), PropertyInfo(Variant::STRING, "method")));
  245. }
  246. class EditorScriptCodeCompletionCache : public ScriptCodeCompletionCache {
  247. struct Cache {
  248. uint64_t time_loaded = 0;
  249. Ref<Resource> cache;
  250. };
  251. HashMap<String, Cache> cached;
  252. public:
  253. uint64_t max_time_cache = 5 * 60 * 1000; //minutes, five
  254. uint32_t max_cache_size = 128;
  255. void cleanup() {
  256. List<String> to_clean;
  257. HashMap<String, Cache>::Iterator I = cached.begin();
  258. while (I) {
  259. if ((OS::get_singleton()->get_ticks_msec() - I->value.time_loaded) > max_time_cache) {
  260. to_clean.push_back(I->key);
  261. }
  262. ++I;
  263. }
  264. while (to_clean.front()) {
  265. cached.erase(to_clean.front()->get());
  266. to_clean.pop_front();
  267. }
  268. }
  269. virtual Ref<Resource> get_cached_resource(const String &p_path) {
  270. HashMap<String, Cache>::Iterator E = cached.find(p_path);
  271. if (!E) {
  272. Cache c;
  273. c.cache = ResourceLoader::load(p_path);
  274. E = cached.insert(p_path, c);
  275. }
  276. E->value.time_loaded = OS::get_singleton()->get_ticks_msec();
  277. if (cached.size() > max_cache_size) {
  278. uint64_t older;
  279. HashMap<String, Cache>::Iterator O = cached.begin();
  280. older = O->value.time_loaded;
  281. HashMap<String, Cache>::Iterator I = O;
  282. while (I) {
  283. if (I->value.time_loaded < older) {
  284. older = I->value.time_loaded;
  285. O = I;
  286. }
  287. ++I;
  288. }
  289. if (O != E) { //should never happen..
  290. cached.remove(O);
  291. }
  292. }
  293. return E->value.cache;
  294. }
  295. virtual ~EditorScriptCodeCompletionCache() {}
  296. };
  297. void ScriptEditorQuickOpen::popup_dialog(const Vector<String> &p_functions, bool p_dontclear) {
  298. popup_centered_ratio(0.6);
  299. if (p_dontclear) {
  300. search_box->select_all();
  301. } else {
  302. search_box->clear();
  303. }
  304. search_box->grab_focus();
  305. functions = p_functions;
  306. _update_search();
  307. }
  308. void ScriptEditorQuickOpen::_text_changed(const String &p_newtext) {
  309. _update_search();
  310. }
  311. void ScriptEditorQuickOpen::_sbox_input(const Ref<InputEvent> &p_ie) {
  312. Ref<InputEventKey> k = p_ie;
  313. if (k.is_valid() && (k->get_keycode() == Key::UP || k->get_keycode() == Key::DOWN || k->get_keycode() == Key::PAGEUP || k->get_keycode() == Key::PAGEDOWN)) {
  314. search_options->gui_input(k);
  315. search_box->accept_event();
  316. }
  317. }
  318. void ScriptEditorQuickOpen::_update_search() {
  319. search_options->clear();
  320. TreeItem *root = search_options->create_item();
  321. for (int i = 0; i < functions.size(); i++) {
  322. String file = functions[i];
  323. if ((search_box->get_text().is_empty() || file.containsn(search_box->get_text()))) {
  324. TreeItem *ti = search_options->create_item(root);
  325. ti->set_text(0, file);
  326. if (root->get_first_child() == ti) {
  327. ti->select(0);
  328. }
  329. }
  330. }
  331. get_ok_button()->set_disabled(root->get_first_child() == nullptr);
  332. }
  333. void ScriptEditorQuickOpen::_confirmed() {
  334. TreeItem *ti = search_options->get_selected();
  335. if (!ti) {
  336. return;
  337. }
  338. int line = ti->get_text(0).get_slice(":", 1).to_int();
  339. emit_signal(SNAME("goto_line"), line - 1);
  340. hide();
  341. }
  342. void ScriptEditorQuickOpen::_notification(int p_what) {
  343. switch (p_what) {
  344. case NOTIFICATION_ENTER_TREE: {
  345. connect("confirmed", callable_mp(this, &ScriptEditorQuickOpen::_confirmed));
  346. search_box->set_clear_button_enabled(true);
  347. [[fallthrough]];
  348. }
  349. case NOTIFICATION_VISIBILITY_CHANGED: {
  350. search_box->set_right_icon(search_options->get_editor_theme_icon(SNAME("Search")));
  351. } break;
  352. case NOTIFICATION_EXIT_TREE: {
  353. disconnect("confirmed", callable_mp(this, &ScriptEditorQuickOpen::_confirmed));
  354. } break;
  355. }
  356. }
  357. void ScriptEditorQuickOpen::_bind_methods() {
  358. ADD_SIGNAL(MethodInfo("goto_line", PropertyInfo(Variant::INT, "line")));
  359. }
  360. ScriptEditorQuickOpen::ScriptEditorQuickOpen() {
  361. VBoxContainer *vbc = memnew(VBoxContainer);
  362. add_child(vbc);
  363. search_box = memnew(LineEdit);
  364. vbc->add_margin_child(TTR("Search:"), search_box);
  365. search_box->connect("text_changed", callable_mp(this, &ScriptEditorQuickOpen::_text_changed));
  366. search_box->connect(SceneStringName(gui_input), callable_mp(this, &ScriptEditorQuickOpen::_sbox_input));
  367. search_options = memnew(Tree);
  368. vbc->add_margin_child(TTR("Matches:"), search_options, true);
  369. set_ok_button_text(TTR("Open"));
  370. get_ok_button()->set_disabled(true);
  371. register_text_enter(search_box);
  372. set_hide_on_ok(false);
  373. search_options->connect("item_activated", callable_mp(this, &ScriptEditorQuickOpen::_confirmed));
  374. search_options->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  375. search_options->set_hide_root(true);
  376. search_options->set_hide_folding(true);
  377. search_options->add_theme_constant_override("draw_guides", 1);
  378. }
  379. /////////////////////////////////
  380. ScriptEditor *ScriptEditor::script_editor = nullptr;
  381. /*** SCRIPT EDITOR ******/
  382. String ScriptEditor::_get_debug_tooltip(const String &p_text, Node *_se) {
  383. String val = EditorDebuggerNode::get_singleton()->get_var_value(p_text);
  384. const int display_limit = 300;
  385. if (!val.is_empty()) {
  386. if (val.size() > display_limit) {
  387. val = val.left(display_limit) + " [...] truncated!";
  388. }
  389. return p_text + ": " + val;
  390. } else {
  391. return String();
  392. }
  393. }
  394. void ScriptEditor::_breaked(bool p_breaked, bool p_can_debug) {
  395. if (external_editor_active) {
  396. return;
  397. }
  398. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  399. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  400. if (!se) {
  401. continue;
  402. }
  403. se->set_debugger_active(p_breaked);
  404. }
  405. }
  406. void ScriptEditor::_script_created(Ref<Script> p_script) {
  407. EditorNode::get_singleton()->push_item(p_script.operator->());
  408. }
  409. void ScriptEditor::_goto_script_line2(int p_line) {
  410. ScriptEditorBase *current = _get_current_editor();
  411. if (current) {
  412. current->goto_line(p_line);
  413. }
  414. }
  415. void ScriptEditor::_goto_script_line(Ref<RefCounted> p_script, int p_line) {
  416. Ref<Script> scr = Object::cast_to<Script>(*p_script);
  417. if (scr.is_valid() && (scr->has_source_code() || scr->get_path().is_resource_file())) {
  418. if (edit(p_script, p_line, 0)) {
  419. EditorNode::get_singleton()->push_item(p_script.ptr());
  420. ScriptEditorBase *current = _get_current_editor();
  421. if (ScriptTextEditor *script_text_editor = Object::cast_to<ScriptTextEditor>(current)) {
  422. script_text_editor->goto_line_centered(p_line);
  423. } else if (current) {
  424. current->goto_line(p_line, true);
  425. }
  426. _save_history();
  427. }
  428. }
  429. }
  430. void ScriptEditor::_set_execution(Ref<RefCounted> p_script, int p_line) {
  431. Ref<Script> scr = Object::cast_to<Script>(*p_script);
  432. if (scr.is_valid() && (scr->has_source_code() || scr->get_path().is_resource_file())) {
  433. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  434. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  435. if (!se) {
  436. continue;
  437. }
  438. if ((scr != nullptr && se->get_edited_resource() == p_script) || se->get_edited_resource()->get_path() == scr->get_path()) {
  439. se->set_executing_line(p_line);
  440. }
  441. }
  442. }
  443. }
  444. void ScriptEditor::_clear_execution(Ref<RefCounted> p_script) {
  445. Ref<Script> scr = Object::cast_to<Script>(*p_script);
  446. if (scr.is_valid() && (scr->has_source_code() || scr->get_path().is_resource_file())) {
  447. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  448. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  449. if (!se) {
  450. continue;
  451. }
  452. if ((scr != nullptr && se->get_edited_resource() == p_script) || se->get_edited_resource()->get_path() == scr->get_path()) {
  453. se->clear_executing_line();
  454. }
  455. }
  456. }
  457. }
  458. void ScriptEditor::_set_breakpoint(Ref<RefCounted> p_script, int p_line, bool p_enabled) {
  459. Ref<Script> scr = Object::cast_to<Script>(*p_script);
  460. if (scr.is_valid() && (scr->has_source_code() || scr->get_path().is_resource_file())) {
  461. // Update if open.
  462. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  463. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  464. if (se && se->get_edited_resource()->get_path() == scr->get_path()) {
  465. se->set_breakpoint(p_line, p_enabled);
  466. return;
  467. }
  468. }
  469. // Handle closed.
  470. Dictionary state = script_editor_cache->get_value(scr->get_path(), "state");
  471. Array breakpoints;
  472. if (state.has("breakpoints")) {
  473. breakpoints = state["breakpoints"];
  474. }
  475. if (breakpoints.has(p_line)) {
  476. if (!p_enabled) {
  477. breakpoints.erase(p_line);
  478. }
  479. } else if (p_enabled) {
  480. breakpoints.push_back(p_line);
  481. }
  482. state["breakpoints"] = breakpoints;
  483. script_editor_cache->set_value(scr->get_path(), "state", state);
  484. EditorDebuggerNode::get_singleton()->set_breakpoint(scr->get_path(), p_line + 1, p_enabled);
  485. }
  486. }
  487. void ScriptEditor::_clear_breakpoints() {
  488. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  489. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  490. if (se) {
  491. se->clear_breakpoints();
  492. }
  493. }
  494. // Clear from closed scripts.
  495. List<String> cached_editors;
  496. script_editor_cache->get_sections(&cached_editors);
  497. for (const String &E : cached_editors) {
  498. Array breakpoints = _get_cached_breakpoints_for_script(E);
  499. for (int i = 0; i < breakpoints.size(); i++) {
  500. EditorDebuggerNode::get_singleton()->set_breakpoint(E, (int)breakpoints[i] + 1, false);
  501. }
  502. if (breakpoints.size() > 0) {
  503. Dictionary state = script_editor_cache->get_value(E, "state");
  504. state["breakpoints"] = Array();
  505. script_editor_cache->set_value(E, "state", state);
  506. }
  507. }
  508. }
  509. Array ScriptEditor::_get_cached_breakpoints_for_script(const String &p_path) const {
  510. if (!ResourceLoader::exists(p_path, "Script") || p_path.begins_with("local://") || !script_editor_cache->has_section_key(p_path, "state")) {
  511. return Array();
  512. }
  513. Dictionary state = script_editor_cache->get_value(p_path, "state");
  514. if (!state.has("breakpoints")) {
  515. return Array();
  516. }
  517. return state["breakpoints"];
  518. }
  519. ScriptEditorBase *ScriptEditor::_get_current_editor() const {
  520. int selected = tab_container->get_current_tab();
  521. if (selected < 0 || selected >= tab_container->get_tab_count()) {
  522. return nullptr;
  523. }
  524. return Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(selected));
  525. }
  526. void ScriptEditor::_update_history_arrows() {
  527. script_back->set_disabled(history_pos <= 0);
  528. script_forward->set_disabled(history_pos >= history.size() - 1);
  529. }
  530. void ScriptEditor::_save_history() {
  531. if (history_pos >= 0 && history_pos < history.size() && history[history_pos].control == tab_container->get_current_tab_control()) {
  532. Node *n = tab_container->get_current_tab_control();
  533. if (Object::cast_to<ScriptEditorBase>(n)) {
  534. history.write[history_pos].state = Object::cast_to<ScriptEditorBase>(n)->get_navigation_state();
  535. }
  536. if (Object::cast_to<EditorHelp>(n)) {
  537. history.write[history_pos].state = Object::cast_to<EditorHelp>(n)->get_scroll();
  538. }
  539. }
  540. history.resize(history_pos + 1);
  541. ScriptHistory sh;
  542. sh.control = tab_container->get_current_tab_control();
  543. sh.state = Variant();
  544. history.push_back(sh);
  545. history_pos++;
  546. _update_history_arrows();
  547. }
  548. void ScriptEditor::_save_previous_state(Dictionary p_state) {
  549. if (lock_history) {
  550. // Done as a result of a deferred call triggered by set_edit_state().
  551. lock_history = false;
  552. return;
  553. }
  554. if (history_pos >= 0 && history_pos < history.size() && history[history_pos].control == tab_container->get_current_tab_control()) {
  555. Node *n = tab_container->get_current_tab_control();
  556. if (Object::cast_to<ScriptTextEditor>(n)) {
  557. history.write[history_pos].state = p_state;
  558. }
  559. }
  560. history.resize(history_pos + 1);
  561. ScriptHistory sh;
  562. sh.control = tab_container->get_current_tab_control();
  563. sh.state = Variant();
  564. history.push_back(sh);
  565. history_pos++;
  566. _update_history_arrows();
  567. }
  568. void ScriptEditor::_go_to_tab(int p_idx) {
  569. ScriptEditorBase *current = _get_current_editor();
  570. if (current) {
  571. if (current->is_unsaved()) {
  572. current->apply_code();
  573. }
  574. }
  575. Control *c = tab_container->get_tab_control(p_idx);
  576. if (!c) {
  577. return;
  578. }
  579. if (history_pos >= 0 && history_pos < history.size() && history[history_pos].control == tab_container->get_current_tab_control()) {
  580. Node *n = tab_container->get_current_tab_control();
  581. if (Object::cast_to<ScriptEditorBase>(n)) {
  582. history.write[history_pos].state = Object::cast_to<ScriptEditorBase>(n)->get_navigation_state();
  583. }
  584. if (Object::cast_to<EditorHelp>(n)) {
  585. history.write[history_pos].state = Object::cast_to<EditorHelp>(n)->get_scroll();
  586. }
  587. }
  588. history.resize(history_pos + 1);
  589. ScriptHistory sh;
  590. sh.control = c;
  591. sh.state = Variant();
  592. if (!lock_history && (history.is_empty() || history[history.size() - 1].control != sh.control)) {
  593. history.push_back(sh);
  594. history_pos++;
  595. }
  596. tab_container->set_current_tab(p_idx);
  597. c = tab_container->get_current_tab_control();
  598. if (Object::cast_to<ScriptEditorBase>(c)) {
  599. script_name_label->set_text(Object::cast_to<ScriptEditorBase>(c)->get_name());
  600. script_icon->set_texture(Object::cast_to<ScriptEditorBase>(c)->get_theme_icon());
  601. if (is_visible_in_tree()) {
  602. Object::cast_to<ScriptEditorBase>(c)->ensure_focus();
  603. }
  604. Ref<Script> scr = Object::cast_to<ScriptEditorBase>(c)->get_edited_resource();
  605. if (scr != nullptr) {
  606. notify_script_changed(scr);
  607. }
  608. Object::cast_to<ScriptEditorBase>(c)->validate();
  609. }
  610. if (Object::cast_to<EditorHelp>(c)) {
  611. script_name_label->set_text(Object::cast_to<EditorHelp>(c)->get_class());
  612. script_icon->set_texture(get_editor_theme_icon(SNAME("Help")));
  613. if (is_visible_in_tree()) {
  614. Object::cast_to<EditorHelp>(c)->set_focused();
  615. }
  616. }
  617. c->set_meta("__editor_pass", ++edit_pass);
  618. _update_history_arrows();
  619. _update_script_colors();
  620. _update_members_overview();
  621. _update_help_overview();
  622. _update_selected_editor_menu();
  623. _update_online_doc();
  624. _update_members_overview_visibility();
  625. _update_help_overview_visibility();
  626. }
  627. void ScriptEditor::_add_recent_script(const String &p_path) {
  628. if (p_path.is_empty()) {
  629. return;
  630. }
  631. Array rc = EditorSettings::get_singleton()->get_project_metadata("recent_files", "scripts", Array());
  632. if (rc.has(p_path)) {
  633. rc.erase(p_path);
  634. }
  635. rc.push_front(p_path);
  636. if (rc.size() > 10) {
  637. rc.resize(10);
  638. }
  639. EditorSettings::get_singleton()->set_project_metadata("recent_files", "scripts", rc);
  640. _update_recent_scripts();
  641. }
  642. void ScriptEditor::_update_recent_scripts() {
  643. Array rc = EditorSettings::get_singleton()->get_project_metadata("recent_files", "scripts", Array());
  644. recent_scripts->clear();
  645. String path;
  646. for (int i = 0; i < rc.size(); i++) {
  647. path = rc[i];
  648. recent_scripts->add_item(path.replace("res://", ""));
  649. }
  650. recent_scripts->add_separator();
  651. recent_scripts->add_shortcut(ED_GET_SHORTCUT("script_editor/clear_recent"));
  652. recent_scripts->set_item_disabled(recent_scripts->get_item_id(recent_scripts->get_item_count() - 1), rc.is_empty());
  653. recent_scripts->reset_size();
  654. }
  655. void ScriptEditor::_open_recent_script(int p_idx) {
  656. // clear button
  657. if (p_idx == recent_scripts->get_item_count() - 1) {
  658. EditorSettings::get_singleton()->set_project_metadata("recent_files", "scripts", Array());
  659. callable_mp(this, &ScriptEditor::_update_recent_scripts).call_deferred();
  660. return;
  661. }
  662. Array rc = EditorSettings::get_singleton()->get_project_metadata("recent_files", "scripts", Array());
  663. ERR_FAIL_INDEX(p_idx, rc.size());
  664. String path = rc[p_idx];
  665. // if its not on disk its a help file or deleted
  666. if (FileAccess::exists(path)) {
  667. List<String> extensions;
  668. ResourceLoader::get_recognized_extensions_for_type("Script", &extensions);
  669. ResourceLoader::get_recognized_extensions_for_type("JSON", &extensions);
  670. if (extensions.find(path.get_extension())) {
  671. Ref<Resource> scr = ResourceLoader::load(path);
  672. if (scr.is_valid()) {
  673. edit(scr, true);
  674. return;
  675. }
  676. }
  677. Error err;
  678. Ref<TextFile> text_file = _load_text_file(path, &err);
  679. if (text_file.is_valid()) {
  680. edit(text_file, true);
  681. return;
  682. }
  683. // if it's a path then it's most likely a deleted file not help
  684. } else if (path.contains("::")) {
  685. // built-in script
  686. String res_path = path.get_slice("::", 0);
  687. if (ResourceLoader::get_resource_type(res_path) == "PackedScene") {
  688. if (!EditorNode::get_singleton()->is_scene_open(res_path)) {
  689. EditorNode::get_singleton()->load_scene(res_path);
  690. }
  691. } else {
  692. EditorNode::get_singleton()->load_resource(res_path);
  693. }
  694. Ref<Script> scr = ResourceLoader::load(path);
  695. if (scr.is_valid()) {
  696. edit(scr, true);
  697. return;
  698. }
  699. } else if (!path.is_resource_file()) {
  700. _help_class_open(path);
  701. return;
  702. }
  703. rc.remove_at(p_idx);
  704. EditorSettings::get_singleton()->set_project_metadata("recent_files", "scripts", rc);
  705. _update_recent_scripts();
  706. _show_error_dialog(path);
  707. }
  708. void ScriptEditor::_show_error_dialog(const String &p_path) {
  709. error_dialog->set_text(vformat(TTR("Can't open '%s'. The file could have been moved or deleted."), p_path));
  710. error_dialog->popup_centered();
  711. }
  712. void ScriptEditor::_close_tab(int p_idx, bool p_save, bool p_history_back) {
  713. int selected = p_idx;
  714. if (selected < 0 || selected >= tab_container->get_tab_count()) {
  715. return;
  716. }
  717. Node *tselected = tab_container->get_tab_control(selected);
  718. ScriptEditorBase *current = Object::cast_to<ScriptEditorBase>(tselected);
  719. if (current) {
  720. Ref<Resource> file = current->get_edited_resource();
  721. if (p_save && file.is_valid()) {
  722. // Do not try to save internal scripts, but prompt to save in-memory
  723. // scripts which are not saved to disk yet (have empty path).
  724. if (!file->is_built_in()) {
  725. save_current_script();
  726. }
  727. }
  728. if (file.is_valid()) {
  729. if (!file->get_path().is_empty()) {
  730. // Only saved scripts can be restored.
  731. previous_scripts.push_back(file->get_path());
  732. }
  733. Ref<Script> scr = file;
  734. if (scr.is_valid()) {
  735. notify_script_close(scr);
  736. }
  737. }
  738. }
  739. // roll back to previous tab
  740. if (p_history_back) {
  741. _history_back();
  742. }
  743. //remove from history
  744. history.resize(history_pos + 1);
  745. for (int i = 0; i < history.size(); i++) {
  746. if (history[i].control == tselected) {
  747. history.remove_at(i);
  748. i--;
  749. history_pos--;
  750. }
  751. }
  752. if (history_pos >= history.size()) {
  753. history_pos = history.size() - 1;
  754. }
  755. int idx = tab_container->get_current_tab();
  756. if (current) {
  757. current->clear_edit_menu();
  758. _save_editor_state(current);
  759. }
  760. memdelete(tselected);
  761. if (script_close_queue.is_empty()) {
  762. if (idx >= tab_container->get_tab_count()) {
  763. idx = tab_container->get_tab_count() - 1;
  764. }
  765. if (idx >= 0) {
  766. if (history_pos >= 0) {
  767. idx = tab_container->get_tab_idx_from_control(history[history_pos].control);
  768. }
  769. _go_to_tab(idx);
  770. } else {
  771. _update_selected_editor_menu();
  772. _update_online_doc();
  773. }
  774. _update_history_arrows();
  775. _update_script_names();
  776. _save_layout();
  777. _update_find_replace_bar();
  778. }
  779. }
  780. void ScriptEditor::_close_current_tab(bool p_save, bool p_history_back) {
  781. _close_tab(tab_container->get_current_tab(), p_save, p_history_back);
  782. }
  783. void ScriptEditor::_close_discard_current_tab(const String &p_str) {
  784. Ref<Script> scr = _get_current_script();
  785. if (scr.is_valid()) {
  786. scr->reload_from_file();
  787. }
  788. _close_tab(tab_container->get_current_tab(), false);
  789. erase_tab_confirm->hide();
  790. }
  791. void ScriptEditor::_close_docs_tab() {
  792. int child_count = tab_container->get_tab_count();
  793. for (int i = child_count - 1; i >= 0; i--) {
  794. EditorHelp *se = Object::cast_to<EditorHelp>(tab_container->get_tab_control(i));
  795. if (se) {
  796. _close_tab(i, true, false);
  797. }
  798. }
  799. }
  800. void ScriptEditor::_copy_script_path() {
  801. ScriptEditorBase *se = _get_current_editor();
  802. if (se) {
  803. Ref<Resource> scr = se->get_edited_resource();
  804. DisplayServer::get_singleton()->clipboard_set(scr->get_path());
  805. }
  806. }
  807. void ScriptEditor::_close_other_tabs() {
  808. int current_idx = tab_container->get_current_tab();
  809. for (int i = tab_container->get_tab_count() - 1; i >= 0; i--) {
  810. if (i != current_idx) {
  811. script_close_queue.push_back(i);
  812. }
  813. }
  814. _queue_close_tabs();
  815. }
  816. void ScriptEditor::_close_all_tabs() {
  817. for (int i = tab_container->get_tab_count() - 1; i >= 0; i--) {
  818. script_close_queue.push_back(i);
  819. }
  820. _queue_close_tabs();
  821. }
  822. void ScriptEditor::_queue_close_tabs() {
  823. while (!script_close_queue.is_empty()) {
  824. int idx = script_close_queue.front()->get();
  825. script_close_queue.pop_front();
  826. tab_container->set_current_tab(idx);
  827. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(idx));
  828. if (se) {
  829. // Maybe there are unsaved changes.
  830. if (se->is_unsaved()) {
  831. _ask_close_current_unsaved_tab(se);
  832. erase_tab_confirm->connect(SceneStringName(visibility_changed), callable_mp(this, &ScriptEditor::_queue_close_tabs), CONNECT_ONE_SHOT);
  833. break;
  834. }
  835. }
  836. _close_current_tab(false, false);
  837. }
  838. _update_find_replace_bar();
  839. }
  840. void ScriptEditor::_ask_close_current_unsaved_tab(ScriptEditorBase *current) {
  841. erase_tab_confirm->set_text(TTR("Close and save changes?") + "\n\"" + current->get_name() + "\"");
  842. erase_tab_confirm->popup_centered();
  843. }
  844. void ScriptEditor::_resave_scripts(const String &p_str) {
  845. apply_scripts();
  846. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  847. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  848. if (!se) {
  849. continue;
  850. }
  851. Ref<Resource> scr = se->get_edited_resource();
  852. if (scr->is_built_in()) {
  853. continue; //internal script, who cares
  854. }
  855. if (trim_trailing_whitespace_on_save) {
  856. se->trim_trailing_whitespace();
  857. }
  858. se->insert_final_newline();
  859. if (convert_indent_on_save) {
  860. se->convert_indent();
  861. }
  862. Ref<TextFile> text_file = scr;
  863. if (text_file != nullptr) {
  864. se->apply_code();
  865. _save_text_file(text_file, text_file->get_path());
  866. break;
  867. } else {
  868. EditorNode::get_singleton()->save_resource(scr);
  869. }
  870. se->tag_saved_version();
  871. }
  872. disk_changed->hide();
  873. }
  874. void ScriptEditor::_res_saved_callback(const Ref<Resource> &p_res) {
  875. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  876. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  877. if (!se) {
  878. continue;
  879. }
  880. Ref<Resource> scr = se->get_edited_resource();
  881. if (scr == p_res) {
  882. se->tag_saved_version();
  883. }
  884. }
  885. if (p_res.is_valid()) {
  886. // In case the Resource has built-in scripts.
  887. _mark_built_in_scripts_as_saved(p_res->get_path());
  888. }
  889. _update_script_names();
  890. Ref<Script> scr = p_res;
  891. if (scr.is_valid()) {
  892. trigger_live_script_reload(scr->get_path());
  893. }
  894. }
  895. void ScriptEditor::_scene_saved_callback(const String &p_path) {
  896. // If scene was saved, mark all built-in scripts from that scene as saved.
  897. _mark_built_in_scripts_as_saved(p_path);
  898. }
  899. void ScriptEditor::_mark_built_in_scripts_as_saved(const String &p_parent_path) {
  900. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  901. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  902. if (!se) {
  903. continue;
  904. }
  905. Ref<Resource> edited_res = se->get_edited_resource();
  906. if (!edited_res->is_built_in()) {
  907. continue; // External script, who cares.
  908. }
  909. if (edited_res->get_path().get_slice("::", 0) == p_parent_path) {
  910. se->tag_saved_version();
  911. }
  912. Ref<Script> scr = edited_res;
  913. if (scr.is_valid() && scr->is_tool()) {
  914. scr->reload(true);
  915. }
  916. }
  917. }
  918. void ScriptEditor::trigger_live_script_reload(const String &p_script_path) {
  919. if (!script_paths_to_reload.has(p_script_path)) {
  920. script_paths_to_reload.append(p_script_path);
  921. }
  922. if (!pending_auto_reload && auto_reload_running_scripts) {
  923. callable_mp(this, &ScriptEditor::_live_auto_reload_running_scripts).call_deferred();
  924. pending_auto_reload = true;
  925. }
  926. }
  927. void ScriptEditor::trigger_live_script_reload_all() {
  928. if (!pending_auto_reload && auto_reload_running_scripts) {
  929. call_deferred(SNAME("_live_auto_reload_running_scripts"));
  930. pending_auto_reload = true;
  931. reload_all_scripts = true;
  932. }
  933. }
  934. void ScriptEditor::_live_auto_reload_running_scripts() {
  935. pending_auto_reload = false;
  936. if (reload_all_scripts) {
  937. EditorDebuggerNode::get_singleton()->reload_all_scripts();
  938. } else {
  939. EditorDebuggerNode::get_singleton()->reload_scripts(script_paths_to_reload);
  940. }
  941. reload_all_scripts = false;
  942. script_paths_to_reload.clear();
  943. }
  944. bool ScriptEditor::_test_script_times_on_disk(Ref<Resource> p_for_script) {
  945. disk_changed_list->clear();
  946. TreeItem *r = disk_changed_list->create_item();
  947. disk_changed_list->set_hide_root(true);
  948. bool need_ask = false;
  949. bool need_reload = false;
  950. bool use_autoreload = bool(EDITOR_GET("text_editor/behavior/files/auto_reload_scripts_on_external_change"));
  951. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  952. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  953. if (se) {
  954. Ref<Resource> edited_res = se->get_edited_resource();
  955. if (p_for_script.is_valid() && edited_res.is_valid() && p_for_script != edited_res) {
  956. continue;
  957. }
  958. if (edited_res->is_built_in()) {
  959. continue; //internal script, who cares
  960. }
  961. uint64_t last_date = edited_res->get_last_modified_time();
  962. uint64_t date = FileAccess::get_modified_time(edited_res->get_path());
  963. if (last_date != date) {
  964. TreeItem *ti = disk_changed_list->create_item(r);
  965. ti->set_text(0, edited_res->get_path().get_file());
  966. if (!use_autoreload || se->is_unsaved()) {
  967. need_ask = true;
  968. }
  969. need_reload = true;
  970. }
  971. }
  972. }
  973. if (need_reload) {
  974. if (!need_ask) {
  975. script_editor->reload_scripts();
  976. need_reload = false;
  977. } else {
  978. callable_mp((Window *)disk_changed, &Window::popup_centered_ratio).call_deferred(0.3);
  979. }
  980. }
  981. return need_reload;
  982. }
  983. void ScriptEditor::_file_dialog_action(const String &p_file) {
  984. switch (file_dialog_option) {
  985. case FILE_NEW_TEXTFILE: {
  986. Error err;
  987. {
  988. Ref<FileAccess> file = FileAccess::open(p_file, FileAccess::WRITE, &err);
  989. if (err) {
  990. EditorNode::get_singleton()->show_warning(TTR("Error writing TextFile:") + "\n" + p_file, TTR("Error!"));
  991. break;
  992. }
  993. }
  994. if (EditorFileSystem::get_singleton()) {
  995. if (textfile_extensions.has(p_file.get_extension())) {
  996. EditorFileSystem::get_singleton()->update_file(p_file);
  997. }
  998. }
  999. if (!open_textfile_after_create) {
  1000. return;
  1001. }
  1002. [[fallthrough]];
  1003. }
  1004. case FILE_OPEN: {
  1005. open_file(p_file);
  1006. file_dialog_option = -1;
  1007. } break;
  1008. case FILE_SAVE_AS: {
  1009. ScriptEditorBase *current = _get_current_editor();
  1010. if (current) {
  1011. Ref<Resource> resource = current->get_edited_resource();
  1012. String path = ProjectSettings::get_singleton()->localize_path(p_file);
  1013. Error err = _save_text_file(resource, path);
  1014. if (err != OK) {
  1015. EditorNode::get_singleton()->show_accept(TTR("Error saving file!"), TTR("OK"));
  1016. return;
  1017. }
  1018. resource->set_path(path);
  1019. _update_script_names();
  1020. }
  1021. } break;
  1022. case THEME_SAVE_AS: {
  1023. if (!EditorSettings::get_singleton()->save_text_editor_theme_as(p_file)) {
  1024. EditorNode::get_singleton()->show_warning(TTR("Error while saving theme."), TTR("Error Saving"));
  1025. }
  1026. } break;
  1027. case THEME_IMPORT: {
  1028. if (!EditorSettings::get_singleton()->import_text_editor_theme(p_file)) {
  1029. EditorNode::get_singleton()->show_warning(TTR("Error importing theme."), TTR("Error Importing"));
  1030. }
  1031. } break;
  1032. }
  1033. file_dialog_option = -1;
  1034. }
  1035. Ref<Script> ScriptEditor::_get_current_script() {
  1036. ScriptEditorBase *current = _get_current_editor();
  1037. if (current) {
  1038. Ref<Script> scr = current->get_edited_resource();
  1039. return scr != nullptr ? scr : nullptr;
  1040. } else {
  1041. return nullptr;
  1042. }
  1043. }
  1044. TypedArray<Script> ScriptEditor::_get_open_scripts() const {
  1045. TypedArray<Script> ret;
  1046. Vector<Ref<Script>> scripts = get_open_scripts();
  1047. int scrits_amount = scripts.size();
  1048. for (int idx_script = 0; idx_script < scrits_amount; idx_script++) {
  1049. ret.push_back(scripts[idx_script]);
  1050. }
  1051. return ret;
  1052. }
  1053. bool ScriptEditor::toggle_scripts_panel() {
  1054. list_split->set_visible(!list_split->is_visible());
  1055. EditorSettings::get_singleton()->set_project_metadata("scripts_panel", "show_scripts_panel", list_split->is_visible());
  1056. return list_split->is_visible();
  1057. }
  1058. bool ScriptEditor::is_scripts_panel_toggled() {
  1059. return list_split->is_visible();
  1060. }
  1061. void ScriptEditor::_menu_option(int p_option) {
  1062. ScriptEditorBase *current = _get_current_editor();
  1063. switch (p_option) {
  1064. case FILE_NEW: {
  1065. script_create_dialog->config("Node", "new_script", false, false);
  1066. script_create_dialog->popup_centered();
  1067. } break;
  1068. case FILE_NEW_TEXTFILE: {
  1069. file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_SAVE_FILE);
  1070. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  1071. file_dialog_option = FILE_NEW_TEXTFILE;
  1072. file_dialog->clear_filters();
  1073. for (const String &E : textfile_extensions) {
  1074. file_dialog->add_filter("*." + E, E.to_upper());
  1075. }
  1076. file_dialog->set_title(TTR("New Text File..."));
  1077. file_dialog->popup_file_dialog();
  1078. open_textfile_after_create = true;
  1079. } break;
  1080. case FILE_OPEN: {
  1081. file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_OPEN_FILE);
  1082. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  1083. file_dialog_option = FILE_OPEN;
  1084. List<String> extensions;
  1085. ResourceLoader::get_recognized_extensions_for_type("Script", &extensions);
  1086. file_dialog->clear_filters();
  1087. for (const String &extension : extensions) {
  1088. file_dialog->add_filter("*." + extension, extension.to_upper());
  1089. }
  1090. for (const String &E : textfile_extensions) {
  1091. file_dialog->add_filter("*." + E, E.to_upper());
  1092. }
  1093. file_dialog->set_title(TTR("Open File"));
  1094. file_dialog->popup_file_dialog();
  1095. return;
  1096. } break;
  1097. case FILE_REOPEN_CLOSED: {
  1098. if (previous_scripts.is_empty()) {
  1099. return;
  1100. }
  1101. String path = previous_scripts.back()->get();
  1102. previous_scripts.pop_back();
  1103. List<String> extensions;
  1104. ResourceLoader::get_recognized_extensions_for_type("Script", &extensions);
  1105. ResourceLoader::get_recognized_extensions_for_type("JSON", &extensions);
  1106. bool built_in = !path.is_resource_file();
  1107. if (extensions.find(path.get_extension()) || built_in) {
  1108. if (built_in) {
  1109. String res_path = path.get_slice("::", 0);
  1110. if (ResourceLoader::get_resource_type(res_path) == "PackedScene") {
  1111. if (!EditorNode::get_singleton()->is_scene_open(res_path)) {
  1112. EditorNode::get_singleton()->load_scene(res_path);
  1113. }
  1114. } else {
  1115. EditorNode::get_singleton()->load_resource(res_path);
  1116. }
  1117. }
  1118. Ref<Resource> scr = ResourceLoader::load(path);
  1119. if (!scr.is_valid()) {
  1120. EditorNode::get_singleton()->show_warning(TTR("Could not load file at:") + "\n\n" + path, TTR("Error!"));
  1121. file_dialog_option = -1;
  1122. return;
  1123. }
  1124. edit(scr);
  1125. file_dialog_option = -1;
  1126. } else {
  1127. Error error;
  1128. Ref<TextFile> text_file = _load_text_file(path, &error);
  1129. if (error != OK) {
  1130. EditorNode::get_singleton()->show_warning(TTR("Could not load file at:") + "\n\n" + path, TTR("Error!"));
  1131. }
  1132. if (text_file.is_valid()) {
  1133. edit(text_file);
  1134. file_dialog_option = -1;
  1135. }
  1136. }
  1137. } break;
  1138. case FILE_SAVE_ALL: {
  1139. if (_test_script_times_on_disk()) {
  1140. return;
  1141. }
  1142. save_all_scripts();
  1143. } break;
  1144. case SEARCH_IN_FILES: {
  1145. _on_find_in_files_requested("");
  1146. } break;
  1147. case REPLACE_IN_FILES: {
  1148. _on_replace_in_files_requested("");
  1149. } break;
  1150. case SEARCH_HELP: {
  1151. help_search_dialog->popup_dialog();
  1152. } break;
  1153. case SEARCH_WEBSITE: {
  1154. Control *tab = tab_container->get_current_tab_control();
  1155. EditorHelp *eh = Object::cast_to<EditorHelp>(tab);
  1156. bool native_class_doc = false;
  1157. if (eh) {
  1158. const HashMap<String, DocData::ClassDoc>::ConstIterator E = EditorHelp::get_doc_data()->class_list.find(eh->get_class());
  1159. native_class_doc = E && !E->value.is_script_doc;
  1160. }
  1161. if (native_class_doc) {
  1162. String name = eh->get_class().to_lower();
  1163. String doc_url = vformat(VERSION_DOCS_URL "/classes/class_%s.html", name);
  1164. OS::get_singleton()->shell_open(doc_url);
  1165. } else {
  1166. OS::get_singleton()->shell_open(VERSION_DOCS_URL "/");
  1167. }
  1168. } break;
  1169. case WINDOW_NEXT: {
  1170. _history_forward();
  1171. } break;
  1172. case WINDOW_PREV: {
  1173. _history_back();
  1174. } break;
  1175. case WINDOW_SORT: {
  1176. _sort_list_on_update = true;
  1177. _update_script_names();
  1178. } break;
  1179. case TOGGLE_SCRIPTS_PANEL: {
  1180. toggle_scripts_panel();
  1181. if (current) {
  1182. current->update_toggle_scripts_button();
  1183. } else {
  1184. Control *tab = tab_container->get_current_tab_control();
  1185. EditorHelp *editor_help = Object::cast_to<EditorHelp>(tab);
  1186. if (editor_help) {
  1187. editor_help->update_toggle_scripts_button();
  1188. }
  1189. }
  1190. }
  1191. }
  1192. if (current) {
  1193. switch (p_option) {
  1194. case FILE_SAVE: {
  1195. save_current_script();
  1196. } break;
  1197. case FILE_SAVE_AS: {
  1198. if (trim_trailing_whitespace_on_save) {
  1199. current->trim_trailing_whitespace();
  1200. }
  1201. current->insert_final_newline();
  1202. if (convert_indent_on_save) {
  1203. current->convert_indent();
  1204. }
  1205. Ref<Resource> resource = current->get_edited_resource();
  1206. Ref<TextFile> text_file = resource;
  1207. Ref<Script> scr = resource;
  1208. if (text_file != nullptr) {
  1209. file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_SAVE_FILE);
  1210. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  1211. file_dialog_option = FILE_SAVE_AS;
  1212. List<String> extensions;
  1213. ResourceLoader::get_recognized_extensions_for_type("Script", &extensions);
  1214. file_dialog->clear_filters();
  1215. file_dialog->set_current_dir(text_file->get_path().get_base_dir());
  1216. file_dialog->set_current_file(text_file->get_path().get_file());
  1217. file_dialog->set_title(TTR("Save File As..."));
  1218. file_dialog->popup_file_dialog();
  1219. break;
  1220. }
  1221. if (scr.is_valid()) {
  1222. clear_docs_from_script(scr);
  1223. }
  1224. EditorNode::get_singleton()->push_item(resource.ptr());
  1225. EditorNode::get_singleton()->save_resource_as(resource);
  1226. if (scr.is_valid()) {
  1227. update_docs_from_script(scr);
  1228. }
  1229. } break;
  1230. case FILE_TOOL_RELOAD_SOFT: {
  1231. Ref<Script> scr = current->get_edited_resource();
  1232. if (scr == nullptr || scr.is_null()) {
  1233. EditorNode::get_singleton()->show_warning(TTR("Can't obtain the script for reloading."));
  1234. break;
  1235. }
  1236. if (!scr->is_tool()) {
  1237. EditorNode::get_singleton()->show_warning(TTR("Reload only takes effect on tool scripts."));
  1238. return;
  1239. }
  1240. scr->reload(true);
  1241. } break;
  1242. case FILE_RUN: {
  1243. Ref<Script> scr = current->get_edited_resource();
  1244. if (scr == nullptr || scr.is_null()) {
  1245. EditorToaster::get_singleton()->popup_str(TTR("Cannot run the edited file because it's not a script."), EditorToaster::SEVERITY_WARNING);
  1246. break;
  1247. }
  1248. current->apply_code();
  1249. Error err = scr->reload(false); // Always hard reload the script before running.
  1250. if (err != OK || !scr->is_valid()) {
  1251. EditorToaster::get_singleton()->popup_str(TTR("Cannot run the script because it contains errors, check the output log."), EditorToaster::SEVERITY_WARNING);
  1252. return;
  1253. }
  1254. // Perform additional checks on the script to evaluate if it's runnable.
  1255. bool is_runnable = true;
  1256. if (!ClassDB::is_parent_class(scr->get_instance_base_type(), "EditorScript")) {
  1257. is_runnable = false;
  1258. EditorToaster::get_singleton()->popup_str(TTR("Cannot run the script because it doesn't extend EditorScript."), EditorToaster::SEVERITY_WARNING);
  1259. }
  1260. if (!scr->is_tool()) {
  1261. is_runnable = false;
  1262. if (scr->get_class() == "GDScript") {
  1263. EditorToaster::get_singleton()->popup_str(TTR("Cannot run the script because it's not a tool script (add the @tool annotation at the top)."), EditorToaster::SEVERITY_WARNING);
  1264. } else {
  1265. EditorToaster::get_singleton()->popup_str(TTR("Cannot run the script because it's not a tool script."), EditorToaster::SEVERITY_WARNING);
  1266. }
  1267. }
  1268. if (!is_runnable) {
  1269. return;
  1270. }
  1271. Ref<EditorScript> es = memnew(EditorScript);
  1272. es->set_script(scr);
  1273. es->run();
  1274. } break;
  1275. case FILE_CLOSE: {
  1276. if (current->is_unsaved()) {
  1277. _ask_close_current_unsaved_tab(current);
  1278. } else {
  1279. _close_current_tab(false);
  1280. }
  1281. } break;
  1282. case FILE_COPY_PATH: {
  1283. _copy_script_path();
  1284. } break;
  1285. case SHOW_IN_FILE_SYSTEM: {
  1286. const Ref<Resource> scr = current->get_edited_resource();
  1287. String path = scr->get_path();
  1288. if (!path.is_empty()) {
  1289. if (scr->is_built_in()) {
  1290. path = path.get_slice("::", 0); // Show the scene instead.
  1291. }
  1292. FileSystemDock::get_singleton()->navigate_to_path(path);
  1293. }
  1294. } break;
  1295. case CLOSE_DOCS: {
  1296. _close_docs_tab();
  1297. } break;
  1298. case CLOSE_OTHER_TABS: {
  1299. _close_other_tabs();
  1300. } break;
  1301. case CLOSE_ALL: {
  1302. _close_all_tabs();
  1303. } break;
  1304. case WINDOW_MOVE_UP: {
  1305. if (tab_container->get_current_tab() > 0) {
  1306. tab_container->move_child(current, tab_container->get_current_tab() - 1);
  1307. tab_container->set_current_tab(tab_container->get_current_tab());
  1308. _update_script_names();
  1309. }
  1310. } break;
  1311. case WINDOW_MOVE_DOWN: {
  1312. if (tab_container->get_current_tab() < tab_container->get_tab_count() - 1) {
  1313. tab_container->move_child(current, tab_container->get_current_tab() + 1);
  1314. tab_container->set_current_tab(tab_container->get_current_tab());
  1315. _update_script_names();
  1316. }
  1317. } break;
  1318. default: {
  1319. if (p_option >= WINDOW_SELECT_BASE) {
  1320. _go_to_tab(p_option - WINDOW_SELECT_BASE);
  1321. _update_script_names();
  1322. }
  1323. }
  1324. }
  1325. } else {
  1326. EditorHelp *help = Object::cast_to<EditorHelp>(tab_container->get_current_tab_control());
  1327. if (help) {
  1328. switch (p_option) {
  1329. case HELP_SEARCH_FIND: {
  1330. help->popup_search();
  1331. } break;
  1332. case HELP_SEARCH_FIND_NEXT: {
  1333. help->search_again();
  1334. } break;
  1335. case HELP_SEARCH_FIND_PREVIOUS: {
  1336. help->search_again(true);
  1337. } break;
  1338. case FILE_CLOSE: {
  1339. _close_current_tab();
  1340. } break;
  1341. case CLOSE_DOCS: {
  1342. _close_docs_tab();
  1343. } break;
  1344. case CLOSE_OTHER_TABS: {
  1345. _close_other_tabs();
  1346. } break;
  1347. case CLOSE_ALL: {
  1348. _close_all_tabs();
  1349. } break;
  1350. case WINDOW_MOVE_UP: {
  1351. if (tab_container->get_current_tab() > 0) {
  1352. tab_container->move_child(help, tab_container->get_current_tab() - 1);
  1353. tab_container->set_current_tab(tab_container->get_current_tab());
  1354. _update_script_names();
  1355. }
  1356. } break;
  1357. case WINDOW_MOVE_DOWN: {
  1358. if (tab_container->get_current_tab() < tab_container->get_tab_count() - 1) {
  1359. tab_container->move_child(help, tab_container->get_current_tab() + 1);
  1360. tab_container->set_current_tab(tab_container->get_current_tab());
  1361. _update_script_names();
  1362. }
  1363. } break;
  1364. }
  1365. }
  1366. }
  1367. }
  1368. void ScriptEditor::_theme_option(int p_option) {
  1369. switch (p_option) {
  1370. case THEME_IMPORT: {
  1371. file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_OPEN_FILE);
  1372. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  1373. file_dialog_option = THEME_IMPORT;
  1374. file_dialog->clear_filters();
  1375. file_dialog->add_filter("*.tet");
  1376. file_dialog->set_title(TTR("Import Theme"));
  1377. file_dialog->popup_file_dialog();
  1378. } break;
  1379. case THEME_RELOAD: {
  1380. EditorSettings::get_singleton()->load_text_editor_theme();
  1381. } break;
  1382. case THEME_SAVE: {
  1383. if (EditorSettings::get_singleton()->is_default_text_editor_theme()) {
  1384. ScriptEditor::_show_save_theme_as_dialog();
  1385. } else if (!EditorSettings::get_singleton()->save_text_editor_theme()) {
  1386. EditorNode::get_singleton()->show_warning(TTR("Error while saving theme"), TTR("Error saving"));
  1387. }
  1388. } break;
  1389. case THEME_SAVE_AS: {
  1390. ScriptEditor::_show_save_theme_as_dialog();
  1391. } break;
  1392. }
  1393. }
  1394. void ScriptEditor::_show_save_theme_as_dialog() {
  1395. file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_SAVE_FILE);
  1396. file_dialog->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
  1397. file_dialog_option = THEME_SAVE_AS;
  1398. file_dialog->clear_filters();
  1399. file_dialog->add_filter("*.tet");
  1400. file_dialog->set_current_path(EditorPaths::get_singleton()->get_text_editor_themes_dir().path_join(EDITOR_GET("text_editor/theme/color_theme")));
  1401. file_dialog->set_title(TTR("Save Theme As..."));
  1402. file_dialog->popup_file_dialog();
  1403. }
  1404. bool ScriptEditor::_has_docs_tab() const {
  1405. const int child_count = tab_container->get_tab_count();
  1406. for (int i = 0; i < child_count; i++) {
  1407. if (Object::cast_to<EditorHelp>(tab_container->get_tab_control(i))) {
  1408. return true;
  1409. }
  1410. }
  1411. return false;
  1412. }
  1413. bool ScriptEditor::_has_script_tab() const {
  1414. const int child_count = tab_container->get_tab_count();
  1415. for (int i = 0; i < child_count; i++) {
  1416. if (Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i))) {
  1417. return true;
  1418. }
  1419. }
  1420. return false;
  1421. }
  1422. void ScriptEditor::_prepare_file_menu() {
  1423. PopupMenu *menu = file_menu->get_popup();
  1424. const bool current_is_doc = _get_current_editor() == nullptr;
  1425. menu->set_item_disabled(menu->get_item_index(FILE_REOPEN_CLOSED), previous_scripts.is_empty());
  1426. menu->set_item_disabled(menu->get_item_index(FILE_SAVE), current_is_doc);
  1427. menu->set_item_disabled(menu->get_item_index(FILE_SAVE_AS), current_is_doc);
  1428. menu->set_item_disabled(menu->get_item_index(FILE_SAVE_ALL), !_has_script_tab());
  1429. menu->set_item_disabled(menu->get_item_index(FILE_TOOL_RELOAD_SOFT), current_is_doc);
  1430. menu->set_item_disabled(menu->get_item_index(FILE_COPY_PATH), current_is_doc);
  1431. menu->set_item_disabled(menu->get_item_index(SHOW_IN_FILE_SYSTEM), current_is_doc);
  1432. menu->set_item_disabled(menu->get_item_index(WINDOW_PREV), history_pos <= 0);
  1433. menu->set_item_disabled(menu->get_item_index(WINDOW_NEXT), history_pos >= history.size() - 1);
  1434. menu->set_item_disabled(menu->get_item_index(FILE_CLOSE), tab_container->get_tab_count() < 1);
  1435. menu->set_item_disabled(menu->get_item_index(CLOSE_ALL), tab_container->get_tab_count() < 1);
  1436. menu->set_item_disabled(menu->get_item_index(CLOSE_OTHER_TABS), tab_container->get_tab_count() <= 1);
  1437. menu->set_item_disabled(menu->get_item_index(CLOSE_DOCS), !_has_docs_tab());
  1438. menu->set_item_disabled(menu->get_item_index(FILE_RUN), current_is_doc);
  1439. }
  1440. void ScriptEditor::_file_menu_closed() {
  1441. PopupMenu *menu = file_menu->get_popup();
  1442. menu->set_item_disabled(menu->get_item_index(FILE_REOPEN_CLOSED), false);
  1443. menu->set_item_disabled(menu->get_item_index(FILE_SAVE), false);
  1444. menu->set_item_disabled(menu->get_item_index(FILE_SAVE_AS), false);
  1445. menu->set_item_disabled(menu->get_item_index(FILE_SAVE_ALL), false);
  1446. menu->set_item_disabled(menu->get_item_index(FILE_TOOL_RELOAD_SOFT), false);
  1447. menu->set_item_disabled(menu->get_item_index(FILE_COPY_PATH), false);
  1448. menu->set_item_disabled(menu->get_item_index(SHOW_IN_FILE_SYSTEM), false);
  1449. menu->set_item_disabled(menu->get_item_index(WINDOW_PREV), false);
  1450. menu->set_item_disabled(menu->get_item_index(WINDOW_NEXT), false);
  1451. menu->set_item_disabled(menu->get_item_index(FILE_CLOSE), false);
  1452. menu->set_item_disabled(menu->get_item_index(CLOSE_ALL), false);
  1453. menu->set_item_disabled(menu->get_item_index(CLOSE_OTHER_TABS), false);
  1454. menu->set_item_disabled(menu->get_item_index(CLOSE_DOCS), false);
  1455. menu->set_item_disabled(menu->get_item_index(FILE_RUN), false);
  1456. }
  1457. void ScriptEditor::_tab_changed(int p_which) {
  1458. ensure_select_current();
  1459. }
  1460. void ScriptEditor::_notification(int p_what) {
  1461. switch (p_what) {
  1462. case NOTIFICATION_ENTER_TREE: {
  1463. EditorRunBar::get_singleton()->connect("stop_pressed", callable_mp(this, &ScriptEditor::_editor_stop));
  1464. _apply_editor_settings();
  1465. [[fallthrough]];
  1466. }
  1467. case NOTIFICATION_TRANSLATION_CHANGED:
  1468. case NOTIFICATION_LAYOUT_DIRECTION_CHANGED:
  1469. case NOTIFICATION_THEME_CHANGED: {
  1470. tab_container->add_theme_style_override("panel", get_theme_stylebox(SNAME("ScriptEditor"), EditorStringName(EditorStyles)));
  1471. help_search->set_icon(get_editor_theme_icon(SNAME("HelpSearch")));
  1472. site_search->set_icon(get_editor_theme_icon(SNAME("ExternalLink")));
  1473. if (is_layout_rtl()) {
  1474. script_forward->set_icon(get_editor_theme_icon(SNAME("Back")));
  1475. script_back->set_icon(get_editor_theme_icon(SNAME("Forward")));
  1476. } else {
  1477. script_forward->set_icon(get_editor_theme_icon(SNAME("Forward")));
  1478. script_back->set_icon(get_editor_theme_icon(SNAME("Back")));
  1479. }
  1480. members_overview_alphabeta_sort_button->set_icon(get_editor_theme_icon(SNAME("Sort")));
  1481. filter_scripts->set_right_icon(get_editor_theme_icon(SNAME("Search")));
  1482. filter_methods->set_right_icon(get_editor_theme_icon(SNAME("Search")));
  1483. filename->add_theme_style_override("normal", get_theme_stylebox(CoreStringName(normal), SNAME("LineEdit")));
  1484. recent_scripts->reset_size();
  1485. if (is_inside_tree()) {
  1486. _update_script_names();
  1487. }
  1488. } break;
  1489. case NOTIFICATION_READY: {
  1490. // Can't set own styles in NOTIFICATION_THEME_CHANGED, so for now this will do.
  1491. add_theme_style_override("panel", get_theme_stylebox(SNAME("ScriptEditorPanel"), EditorStringName(EditorStyles)));
  1492. get_tree()->connect("tree_changed", callable_mp(this, &ScriptEditor::_tree_changed));
  1493. InspectorDock::get_singleton()->connect("request_help", callable_mp(this, &ScriptEditor::_help_class_open));
  1494. EditorNode::get_singleton()->connect("request_help_search", callable_mp(this, &ScriptEditor::_help_search));
  1495. EditorNode::get_singleton()->connect("scene_closed", callable_mp(this, &ScriptEditor::_close_builtin_scripts_from_scene));
  1496. EditorNode::get_singleton()->connect("script_add_function_request", callable_mp(this, &ScriptEditor::_add_callback));
  1497. EditorNode::get_singleton()->connect("resource_saved", callable_mp(this, &ScriptEditor::_res_saved_callback));
  1498. EditorNode::get_singleton()->connect("scene_saved", callable_mp(this, &ScriptEditor::_scene_saved_callback));
  1499. FileSystemDock::get_singleton()->connect("files_moved", callable_mp(this, &ScriptEditor::_files_moved));
  1500. FileSystemDock::get_singleton()->connect("file_removed", callable_mp(this, &ScriptEditor::_file_removed));
  1501. script_list->connect("item_selected", callable_mp(this, &ScriptEditor::_script_selected));
  1502. members_overview->connect("item_selected", callable_mp(this, &ScriptEditor::_members_overview_selected));
  1503. help_overview->connect("item_selected", callable_mp(this, &ScriptEditor::_help_overview_selected));
  1504. script_split->connect("dragged", callable_mp(this, &ScriptEditor::_split_dragged));
  1505. list_split->connect("dragged", callable_mp(this, &ScriptEditor::_split_dragged));
  1506. EditorSettings::get_singleton()->connect("settings_changed", callable_mp(this, &ScriptEditor::_editor_settings_changed));
  1507. EditorFileSystem::get_singleton()->connect("filesystem_changed", callable_mp(this, &ScriptEditor::_filesystem_changed));
  1508. } break;
  1509. case NOTIFICATION_EXIT_TREE: {
  1510. EditorRunBar::get_singleton()->disconnect("stop_pressed", callable_mp(this, &ScriptEditor::_editor_stop));
  1511. } break;
  1512. case NOTIFICATION_APPLICATION_FOCUS_IN: {
  1513. _test_script_times_on_disk();
  1514. _update_modified_scripts_for_external_editor();
  1515. } break;
  1516. }
  1517. }
  1518. bool ScriptEditor::can_take_away_focus() const {
  1519. ScriptEditorBase *current = _get_current_editor();
  1520. if (current) {
  1521. return current->can_lose_focus_on_node_selection();
  1522. } else {
  1523. return true;
  1524. }
  1525. }
  1526. void ScriptEditor::_close_builtin_scripts_from_scene(const String &p_scene) {
  1527. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  1528. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  1529. if (se) {
  1530. Ref<Script> scr = se->get_edited_resource();
  1531. if (scr == nullptr || !scr.is_valid()) {
  1532. continue;
  1533. }
  1534. if (scr->is_built_in() && scr->get_path().begins_with(p_scene)) { // Is an internal script and belongs to scene being closed.
  1535. _close_tab(i, false);
  1536. i--;
  1537. }
  1538. }
  1539. }
  1540. }
  1541. void ScriptEditor::edited_scene_changed() {
  1542. _update_modified_scripts_for_external_editor();
  1543. }
  1544. void ScriptEditor::notify_script_close(const Ref<Script> &p_script) {
  1545. emit_signal(SNAME("script_close"), p_script);
  1546. }
  1547. void ScriptEditor::notify_script_changed(const Ref<Script> &p_script) {
  1548. emit_signal(SNAME("editor_script_changed"), p_script);
  1549. }
  1550. void ScriptEditor::get_breakpoints(List<String> *p_breakpoints) {
  1551. HashSet<String> loaded_scripts;
  1552. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  1553. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  1554. if (!se) {
  1555. continue;
  1556. }
  1557. Ref<Script> scr = se->get_edited_resource();
  1558. if (scr == nullptr) {
  1559. continue;
  1560. }
  1561. String base = scr->get_path();
  1562. loaded_scripts.insert(base);
  1563. if (base.begins_with("local://") || base.is_empty()) {
  1564. continue;
  1565. }
  1566. PackedInt32Array bpoints = se->get_breakpoints();
  1567. for (int j = 0; j < bpoints.size(); j++) {
  1568. p_breakpoints->push_back(base + ":" + itos((int)bpoints[j] + 1));
  1569. }
  1570. }
  1571. // Load breakpoints that are in closed scripts.
  1572. List<String> cached_editors;
  1573. script_editor_cache->get_sections(&cached_editors);
  1574. for (const String &E : cached_editors) {
  1575. if (loaded_scripts.has(E)) {
  1576. continue;
  1577. }
  1578. Array breakpoints = _get_cached_breakpoints_for_script(E);
  1579. for (int i = 0; i < breakpoints.size(); i++) {
  1580. p_breakpoints->push_back(E + ":" + itos((int)breakpoints[i] + 1));
  1581. }
  1582. }
  1583. }
  1584. void ScriptEditor::_members_overview_selected(int p_idx) {
  1585. ScriptEditorBase *se = _get_current_editor();
  1586. if (!se) {
  1587. return;
  1588. }
  1589. // Go to the member's line and reset the cursor column. We can't change scroll_position
  1590. // directly until we have gone to the line first, since code might be folded.
  1591. se->goto_line(members_overview->get_item_metadata(p_idx));
  1592. Dictionary state = se->get_edit_state();
  1593. state["column"] = 0;
  1594. state["scroll_position"] = members_overview->get_item_metadata(p_idx);
  1595. se->set_edit_state(state);
  1596. }
  1597. void ScriptEditor::_help_overview_selected(int p_idx) {
  1598. Node *current = tab_container->get_tab_control(tab_container->get_current_tab());
  1599. EditorHelp *se = Object::cast_to<EditorHelp>(current);
  1600. if (!se) {
  1601. return;
  1602. }
  1603. se->scroll_to_section(help_overview->get_item_metadata(p_idx));
  1604. }
  1605. void ScriptEditor::_script_selected(int p_idx) {
  1606. grab_focus_block = !Input::get_singleton()->is_mouse_button_pressed(MouseButton::LEFT); //amazing hack, simply amazing
  1607. _go_to_tab(script_list->get_item_metadata(p_idx));
  1608. grab_focus_block = false;
  1609. }
  1610. void ScriptEditor::ensure_select_current() {
  1611. if (tab_container->get_tab_count() && tab_container->get_current_tab() >= 0) {
  1612. ScriptEditorBase *se = _get_current_editor();
  1613. if (se) {
  1614. se->enable_editor(this);
  1615. if (!grab_focus_block && is_visible_in_tree()) {
  1616. se->ensure_focus();
  1617. }
  1618. }
  1619. }
  1620. _update_find_replace_bar();
  1621. _update_selected_editor_menu();
  1622. }
  1623. bool ScriptEditor::is_editor_floating() {
  1624. return is_floating;
  1625. }
  1626. void ScriptEditor::_find_scripts(Node *p_base, Node *p_current, HashSet<Ref<Script>> &used) {
  1627. if (p_current != p_base && p_current->get_owner() != p_base) {
  1628. return;
  1629. }
  1630. if (p_current->get_script_instance()) {
  1631. Ref<Script> scr = p_current->get_script();
  1632. if (scr.is_valid()) {
  1633. used.insert(scr);
  1634. }
  1635. }
  1636. for (int i = 0; i < p_current->get_child_count(); i++) {
  1637. _find_scripts(p_base, p_current->get_child(i), used);
  1638. }
  1639. }
  1640. struct _ScriptEditorItemData {
  1641. String name;
  1642. String sort_key;
  1643. Ref<Texture2D> icon;
  1644. bool tool = false;
  1645. int index = 0;
  1646. String tooltip;
  1647. bool used = false;
  1648. int category = 0;
  1649. Node *ref = nullptr;
  1650. bool operator<(const _ScriptEditorItemData &id) const {
  1651. if (category == id.category) {
  1652. if (sort_key == id.sort_key) {
  1653. return index < id.index;
  1654. } else {
  1655. return sort_key.filenocasecmp_to(id.sort_key) < 0;
  1656. }
  1657. } else {
  1658. return category < id.category;
  1659. }
  1660. }
  1661. };
  1662. void ScriptEditor::_update_members_overview_visibility() {
  1663. ScriptEditorBase *se = _get_current_editor();
  1664. if (!se) {
  1665. members_overview_alphabeta_sort_button->set_visible(false);
  1666. members_overview->set_visible(false);
  1667. overview_vbox->set_visible(false);
  1668. return;
  1669. }
  1670. if (members_overview_enabled && se->show_members_overview()) {
  1671. members_overview_alphabeta_sort_button->set_visible(true);
  1672. filter_methods->set_visible(true);
  1673. members_overview->set_visible(true);
  1674. overview_vbox->set_visible(true);
  1675. } else {
  1676. members_overview_alphabeta_sort_button->set_visible(false);
  1677. filter_methods->set_visible(false);
  1678. members_overview->set_visible(false);
  1679. overview_vbox->set_visible(false);
  1680. }
  1681. }
  1682. void ScriptEditor::_toggle_members_overview_alpha_sort(bool p_alphabetic_sort) {
  1683. EditorSettings::get_singleton()->set("text_editor/script_list/sort_members_outline_alphabetically", p_alphabetic_sort);
  1684. _update_members_overview();
  1685. }
  1686. void ScriptEditor::_update_members_overview() {
  1687. members_overview->clear();
  1688. ScriptEditorBase *se = _get_current_editor();
  1689. if (!se) {
  1690. return;
  1691. }
  1692. Vector<String> functions = se->get_functions();
  1693. if (EDITOR_GET("text_editor/script_list/sort_members_outline_alphabetically")) {
  1694. functions.sort();
  1695. }
  1696. for (int i = 0; i < functions.size(); i++) {
  1697. String filter = filter_methods->get_text();
  1698. String name = functions[i].get_slice(":", 0);
  1699. if (filter.is_empty() || filter.is_subsequence_ofn(name)) {
  1700. members_overview->add_item(name);
  1701. members_overview->set_item_metadata(-1, functions[i].get_slice(":", 1).to_int() - 1);
  1702. }
  1703. }
  1704. String path = se->get_edited_resource()->get_path();
  1705. bool built_in = !path.is_resource_file();
  1706. String name = built_in ? path.get_file() : se->get_name();
  1707. filename->set_text(name);
  1708. }
  1709. void ScriptEditor::_update_help_overview_visibility() {
  1710. int selected = tab_container->get_current_tab();
  1711. if (selected < 0 || selected >= tab_container->get_tab_count()) {
  1712. help_overview->set_visible(false);
  1713. return;
  1714. }
  1715. Node *current = tab_container->get_tab_control(tab_container->get_current_tab());
  1716. EditorHelp *se = Object::cast_to<EditorHelp>(current);
  1717. if (!se) {
  1718. help_overview->set_visible(false);
  1719. return;
  1720. }
  1721. if (help_overview_enabled) {
  1722. members_overview_alphabeta_sort_button->set_visible(false);
  1723. filter_methods->set_visible(false);
  1724. help_overview->set_visible(true);
  1725. overview_vbox->set_visible(true);
  1726. filename->set_text(se->get_name());
  1727. } else {
  1728. help_overview->set_visible(false);
  1729. overview_vbox->set_visible(false);
  1730. }
  1731. }
  1732. void ScriptEditor::_update_help_overview() {
  1733. help_overview->clear();
  1734. int selected = tab_container->get_current_tab();
  1735. if (selected < 0 || selected >= tab_container->get_tab_count()) {
  1736. return;
  1737. }
  1738. Node *current = tab_container->get_tab_control(tab_container->get_current_tab());
  1739. EditorHelp *se = Object::cast_to<EditorHelp>(current);
  1740. if (!se) {
  1741. return;
  1742. }
  1743. Vector<Pair<String, int>> sections = se->get_sections();
  1744. for (int i = 0; i < sections.size(); i++) {
  1745. help_overview->add_item(sections[i].first);
  1746. help_overview->set_item_metadata(i, sections[i].second);
  1747. }
  1748. }
  1749. void ScriptEditor::_update_online_doc() {
  1750. Node *current = tab_container->get_tab_control(tab_container->get_current_tab());
  1751. EditorHelp *eh = Object::cast_to<EditorHelp>(current);
  1752. bool native_class_doc = false;
  1753. if (eh) {
  1754. const HashMap<String, DocData::ClassDoc>::ConstIterator E = EditorHelp::get_doc_data()->class_list.find(eh->get_class());
  1755. native_class_doc = E && !E->value.is_script_doc;
  1756. }
  1757. if (native_class_doc) {
  1758. String name = eh->get_class();
  1759. String tooltip = vformat(TTR("Open '%s' in Godot online documentation."), name);
  1760. site_search->set_text(TTR("Open in Online Docs"));
  1761. site_search->set_tooltip_text(tooltip);
  1762. } else {
  1763. site_search->set_text(TTR("Online Docs"));
  1764. site_search->set_tooltip_text(TTR("Open Godot online documentation."));
  1765. }
  1766. }
  1767. void ScriptEditor::_update_script_colors() {
  1768. bool script_temperature_enabled = EDITOR_GET("text_editor/script_list/script_temperature_enabled");
  1769. int hist_size = EDITOR_GET("text_editor/script_list/script_temperature_history_size");
  1770. Color hot_color = get_theme_color(SNAME("accent_color"), EditorStringName(Editor));
  1771. hot_color.set_s(hot_color.get_s() * 0.9);
  1772. Color cold_color = get_theme_color(SNAME("font_color"), EditorStringName(Editor));
  1773. for (int i = 0; i < script_list->get_item_count(); i++) {
  1774. int c = script_list->get_item_metadata(i);
  1775. Node *n = tab_container->get_tab_control(c);
  1776. if (!n) {
  1777. continue;
  1778. }
  1779. script_list->set_item_custom_bg_color(i, Color(0, 0, 0, 0));
  1780. if (script_temperature_enabled) {
  1781. int pass = n->get_meta("__editor_pass", -1);
  1782. if (pass < 0) {
  1783. continue;
  1784. }
  1785. int h = edit_pass - pass;
  1786. if (h > hist_size) {
  1787. continue;
  1788. }
  1789. int non_zero_hist_size = (hist_size == 0) ? 1 : hist_size;
  1790. float v = Math::ease((edit_pass - pass) / float(non_zero_hist_size), 0.4);
  1791. script_list->set_item_custom_fg_color(i, hot_color.lerp(cold_color, v));
  1792. }
  1793. }
  1794. }
  1795. void ScriptEditor::_update_script_names() {
  1796. if (restoring_layout) {
  1797. return;
  1798. }
  1799. HashSet<Ref<Script>> used;
  1800. Node *edited = EditorNode::get_singleton()->get_edited_scene();
  1801. if (edited) {
  1802. _find_scripts(edited, edited, used);
  1803. }
  1804. script_list->clear();
  1805. bool split_script_help = EDITOR_GET("text_editor/script_list/group_help_pages");
  1806. ScriptSortBy sort_by = (ScriptSortBy)(int)EDITOR_GET("text_editor/script_list/sort_scripts_by");
  1807. ScriptListName display_as = (ScriptListName)(int)EDITOR_GET("text_editor/script_list/list_script_names_as");
  1808. Vector<_ScriptEditorItemData> sedata;
  1809. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  1810. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  1811. if (se) {
  1812. Ref<Texture2D> icon = se->get_theme_icon();
  1813. String path = se->get_edited_resource()->get_path();
  1814. bool saved = !path.is_empty();
  1815. if (saved) {
  1816. // The script might be deleted, moved, or renamed, so make sure
  1817. // to update original path to previously edited resource.
  1818. se->set_meta("_edit_res_path", path);
  1819. }
  1820. String name = se->get_name();
  1821. Ref<Script> scr = se->get_edited_resource();
  1822. _ScriptEditorItemData sd;
  1823. sd.icon = icon;
  1824. sd.name = name;
  1825. sd.tooltip = saved ? path : TTR("Unsaved file.");
  1826. sd.index = i;
  1827. sd.used = used.has(se->get_edited_resource());
  1828. sd.category = 0;
  1829. sd.ref = se;
  1830. if (scr.is_valid()) {
  1831. sd.tool = scr->is_tool();
  1832. }
  1833. switch (sort_by) {
  1834. case SORT_BY_NAME: {
  1835. sd.sort_key = name.to_lower();
  1836. } break;
  1837. case SORT_BY_PATH: {
  1838. sd.sort_key = path;
  1839. } break;
  1840. case SORT_BY_NONE: {
  1841. sd.sort_key = "";
  1842. } break;
  1843. }
  1844. switch (display_as) {
  1845. case DISPLAY_NAME: {
  1846. sd.name = name;
  1847. } break;
  1848. case DISPLAY_DIR_AND_NAME: {
  1849. if (!path.get_base_dir().get_file().is_empty()) {
  1850. sd.name = path.get_base_dir().get_file().path_join(name);
  1851. } else {
  1852. sd.name = name;
  1853. }
  1854. } break;
  1855. case DISPLAY_FULL_PATH: {
  1856. sd.name = path;
  1857. } break;
  1858. }
  1859. if (!saved) {
  1860. sd.name = se->get_name();
  1861. }
  1862. sedata.push_back(sd);
  1863. }
  1864. Vector<String> disambiguated_script_names;
  1865. Vector<String> full_script_paths;
  1866. for (int j = 0; j < sedata.size(); j++) {
  1867. String name = sedata[j].name.replace("(*)", "");
  1868. ScriptListName script_display = (ScriptListName)(int)EDITOR_GET("text_editor/script_list/list_script_names_as");
  1869. switch (script_display) {
  1870. case DISPLAY_NAME: {
  1871. name = name.get_file();
  1872. } break;
  1873. case DISPLAY_DIR_AND_NAME: {
  1874. name = name.get_base_dir().get_file().path_join(name.get_file());
  1875. } break;
  1876. default:
  1877. break;
  1878. }
  1879. disambiguated_script_names.append(name);
  1880. full_script_paths.append(sedata[j].tooltip);
  1881. }
  1882. EditorNode::disambiguate_filenames(full_script_paths, disambiguated_script_names);
  1883. for (int j = 0; j < sedata.size(); j++) {
  1884. if (sedata[j].name.ends_with("(*)")) {
  1885. sedata.write[j].name = disambiguated_script_names[j] + "(*)";
  1886. } else {
  1887. sedata.write[j].name = disambiguated_script_names[j];
  1888. }
  1889. }
  1890. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_tab_control(i));
  1891. if (eh) {
  1892. String name = eh->get_class();
  1893. Ref<Texture2D> icon = get_editor_theme_icon(SNAME("Help"));
  1894. String tooltip = vformat(TTR("%s Class Reference"), name);
  1895. _ScriptEditorItemData sd;
  1896. sd.icon = icon;
  1897. sd.name = name;
  1898. sd.sort_key = name.to_lower();
  1899. sd.tooltip = tooltip;
  1900. sd.index = i;
  1901. sd.used = false;
  1902. sd.category = split_script_help ? 1 : 0;
  1903. sd.ref = eh;
  1904. sedata.push_back(sd);
  1905. }
  1906. }
  1907. if (_sort_list_on_update && !sedata.is_empty()) {
  1908. sedata.sort();
  1909. // change actual order of tab_container so that the order can be rearranged by user
  1910. int cur_tab = tab_container->get_current_tab();
  1911. int prev_tab = tab_container->get_previous_tab();
  1912. int new_cur_tab = -1;
  1913. int new_prev_tab = -1;
  1914. for (int i = 0; i < sedata.size(); i++) {
  1915. tab_container->move_child(sedata[i].ref, i);
  1916. if (new_prev_tab == -1 && sedata[i].index == prev_tab) {
  1917. new_prev_tab = i;
  1918. }
  1919. if (new_cur_tab == -1 && sedata[i].index == cur_tab) {
  1920. new_cur_tab = i;
  1921. }
  1922. // Update index of sd entries for sorted order
  1923. _ScriptEditorItemData sd = sedata[i];
  1924. sd.index = i;
  1925. sedata.set(i, sd);
  1926. }
  1927. lock_history = true;
  1928. _go_to_tab(new_prev_tab);
  1929. _go_to_tab(new_cur_tab);
  1930. lock_history = false;
  1931. _sort_list_on_update = false;
  1932. }
  1933. Vector<_ScriptEditorItemData> sedata_filtered;
  1934. for (int i = 0; i < sedata.size(); i++) {
  1935. String filter = filter_scripts->get_text();
  1936. if (filter.is_empty() || filter.is_subsequence_ofn(sedata[i].name)) {
  1937. sedata_filtered.push_back(sedata[i]);
  1938. }
  1939. }
  1940. Color tool_color = get_theme_color(SNAME("accent_color"), EditorStringName(Editor));
  1941. tool_color.set_s(tool_color.get_s() * 1.5);
  1942. for (int i = 0; i < sedata_filtered.size(); i++) {
  1943. script_list->add_item(sedata_filtered[i].name, sedata_filtered[i].icon);
  1944. if (sedata_filtered[i].tool) {
  1945. script_list->set_item_icon_modulate(-1, tool_color);
  1946. }
  1947. int index = script_list->get_item_count() - 1;
  1948. script_list->set_item_tooltip(index, sedata_filtered[i].tooltip);
  1949. 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 */
  1950. if (sedata_filtered[i].used) {
  1951. script_list->set_item_custom_bg_color(index, Color(88 / 255.0, 88 / 255.0, 60 / 255.0));
  1952. }
  1953. if (tab_container->get_current_tab() == sedata_filtered[i].index) {
  1954. script_list->select(index);
  1955. script_name_label->set_text(sedata_filtered[i].name);
  1956. script_icon->set_texture(sedata_filtered[i].icon);
  1957. ScriptEditorBase *se = _get_current_editor();
  1958. if (se) {
  1959. se->enable_editor(this);
  1960. _update_selected_editor_menu();
  1961. }
  1962. }
  1963. }
  1964. if (!waiting_update_names) {
  1965. _update_members_overview();
  1966. _update_help_overview();
  1967. } else {
  1968. waiting_update_names = false;
  1969. }
  1970. _update_members_overview_visibility();
  1971. _update_help_overview_visibility();
  1972. _update_script_colors();
  1973. }
  1974. Ref<TextFile> ScriptEditor::_load_text_file(const String &p_path, Error *r_error) const {
  1975. if (r_error) {
  1976. *r_error = ERR_FILE_CANT_OPEN;
  1977. }
  1978. String local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  1979. String path = ResourceLoader::path_remap(local_path);
  1980. TextFile *text_file = memnew(TextFile);
  1981. Ref<TextFile> text_res(text_file);
  1982. Error err = text_file->load_text(path);
  1983. ERR_FAIL_COND_V_MSG(err != OK, Ref<Resource>(), "Cannot load text file '" + path + "'.");
  1984. text_file->set_file_path(local_path);
  1985. text_file->set_path(local_path, true);
  1986. if (ResourceLoader::get_timestamp_on_load()) {
  1987. text_file->set_last_modified_time(FileAccess::get_modified_time(path));
  1988. }
  1989. if (r_error) {
  1990. *r_error = OK;
  1991. }
  1992. return text_res;
  1993. }
  1994. Error ScriptEditor::_save_text_file(Ref<TextFile> p_text_file, const String &p_path) {
  1995. Ref<TextFile> sqscr = p_text_file;
  1996. ERR_FAIL_COND_V(sqscr.is_null(), ERR_INVALID_PARAMETER);
  1997. String source = sqscr->get_text();
  1998. Error err;
  1999. {
  2000. Ref<FileAccess> file = FileAccess::open(p_path, FileAccess::WRITE, &err);
  2001. ERR_FAIL_COND_V_MSG(err, err, "Cannot save text file '" + p_path + "'.");
  2002. file->store_string(source);
  2003. if (file->get_error() != OK && file->get_error() != ERR_FILE_EOF) {
  2004. return ERR_CANT_CREATE;
  2005. }
  2006. }
  2007. if (ResourceSaver::get_timestamp_on_save()) {
  2008. p_text_file->set_last_modified_time(FileAccess::get_modified_time(p_path));
  2009. }
  2010. EditorFileSystem::get_singleton()->update_file(p_path);
  2011. _res_saved_callback(sqscr);
  2012. return OK;
  2013. }
  2014. bool ScriptEditor::edit(const Ref<Resource> &p_resource, int p_line, int p_col, bool p_grab_focus) {
  2015. if (p_resource.is_null()) {
  2016. return false;
  2017. }
  2018. Ref<Script> scr = p_resource;
  2019. // Don't open dominant script if using an external editor.
  2020. bool use_external_editor =
  2021. external_editor_active ||
  2022. (scr.is_valid() && scr->get_language()->overrides_external_editor());
  2023. use_external_editor = use_external_editor && !(scr.is_valid() && scr->is_built_in()); // Ignore external editor for built-in scripts.
  2024. const bool open_dominant = EDITOR_GET("text_editor/behavior/files/open_dominant_script_on_scene_change");
  2025. const bool should_open = (open_dominant && !use_external_editor) || !EditorNode::get_singleton()->is_changing_scene();
  2026. if (scr.is_valid() && scr->get_language()->overrides_external_editor()) {
  2027. if (should_open) {
  2028. Error err = scr->get_language()->open_in_external_editor(scr, p_line >= 0 ? p_line : 0, p_col);
  2029. if (err != OK) {
  2030. ERR_PRINT("Couldn't open script in the overridden external text editor");
  2031. }
  2032. }
  2033. return false;
  2034. }
  2035. if (use_external_editor &&
  2036. (EditorDebuggerNode::get_singleton()->get_dump_stack_script() != p_resource || EditorDebuggerNode::get_singleton()->get_debug_with_external_editor()) &&
  2037. p_resource->get_path().is_resource_file()) {
  2038. String path = EDITOR_GET("text_editor/external/exec_path");
  2039. String flags = EDITOR_GET("text_editor/external/exec_flags");
  2040. List<String> args;
  2041. bool has_file_flag = false;
  2042. String script_path = ProjectSettings::get_singleton()->globalize_path(p_resource->get_path());
  2043. if (flags.size()) {
  2044. String project_path = ProjectSettings::get_singleton()->get_resource_path();
  2045. flags = flags.replacen("{line}", itos(p_line > 0 ? p_line : 0));
  2046. flags = flags.replacen("{col}", itos(p_col));
  2047. flags = flags.strip_edges().replace("\\\\", "\\");
  2048. int from = 0;
  2049. int num_chars = 0;
  2050. bool inside_quotes = false;
  2051. for (int i = 0; i < flags.size(); i++) {
  2052. if (flags[i] == '"' && (!i || flags[i - 1] != '\\')) {
  2053. if (!inside_quotes) {
  2054. from++;
  2055. }
  2056. inside_quotes = !inside_quotes;
  2057. } else if (flags[i] == '\0' || (!inside_quotes && flags[i] == ' ')) {
  2058. String arg = flags.substr(from, num_chars);
  2059. if (arg.contains("{file}")) {
  2060. has_file_flag = true;
  2061. }
  2062. // do path replacement here, else there will be issues with spaces and quotes
  2063. arg = arg.replacen("{project}", project_path);
  2064. arg = arg.replacen("{file}", script_path);
  2065. args.push_back(arg);
  2066. from = i + 1;
  2067. num_chars = 0;
  2068. } else {
  2069. num_chars++;
  2070. }
  2071. }
  2072. }
  2073. // Default to passing script path if no {file} flag is specified.
  2074. if (!has_file_flag) {
  2075. args.push_back(script_path);
  2076. }
  2077. if (!path.is_empty()) {
  2078. Error err = OS::get_singleton()->create_process(path, args);
  2079. if (err == OK) {
  2080. return false;
  2081. }
  2082. }
  2083. ERR_PRINT("Couldn't open external text editor, falling back to the internal editor. Review your `text_editor/external/` editor settings.");
  2084. }
  2085. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2086. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  2087. if (!se) {
  2088. continue;
  2089. }
  2090. if ((scr != nullptr && se->get_edited_resource() == p_resource) || se->get_edited_resource()->get_path() == p_resource->get_path()) {
  2091. if (should_open) {
  2092. se->enable_editor(this);
  2093. if (tab_container->get_current_tab() != i) {
  2094. _go_to_tab(i);
  2095. }
  2096. if (is_visible_in_tree()) {
  2097. se->ensure_focus();
  2098. }
  2099. if (p_line > 0) {
  2100. se->goto_line(p_line);
  2101. }
  2102. }
  2103. _update_script_names();
  2104. script_list->ensure_current_is_visible();
  2105. return true;
  2106. }
  2107. }
  2108. // doesn't have it, make a new one
  2109. ScriptEditorBase *se = nullptr;
  2110. for (int i = script_editor_func_count - 1; i >= 0; i--) {
  2111. se = script_editor_funcs[i](p_resource);
  2112. if (se) {
  2113. break;
  2114. }
  2115. }
  2116. ERR_FAIL_NULL_V(se, false);
  2117. se->set_edited_resource(p_resource);
  2118. // Syntax highlighting.
  2119. bool highlighter_set = false;
  2120. for (int i = 0; i < syntax_highlighters.size(); i++) {
  2121. Ref<EditorSyntaxHighlighter> highlighter = syntax_highlighters[i]->_create();
  2122. if (highlighter.is_null()) {
  2123. continue;
  2124. }
  2125. se->add_syntax_highlighter(highlighter);
  2126. if (highlighter_set) {
  2127. continue;
  2128. }
  2129. PackedStringArray languages = highlighter->_get_supported_languages();
  2130. // If script try language, else use extension.
  2131. if (scr != nullptr) {
  2132. if (languages.has(scr->get_language()->get_name())) {
  2133. se->set_syntax_highlighter(highlighter);
  2134. highlighter_set = true;
  2135. }
  2136. continue;
  2137. }
  2138. if (languages.has(p_resource->get_path().get_extension())) {
  2139. se->set_syntax_highlighter(highlighter);
  2140. highlighter_set = true;
  2141. }
  2142. }
  2143. tab_container->add_child(se);
  2144. if (p_grab_focus) {
  2145. se->enable_editor(this);
  2146. }
  2147. // If we delete a script within the filesystem, the original resource path
  2148. // is lost, so keep it as metadata to figure out the exact tab to delete.
  2149. se->set_meta("_edit_res_path", p_resource->get_path());
  2150. se->set_tooltip_request_func(callable_mp(this, &ScriptEditor::_get_debug_tooltip));
  2151. if (se->get_edit_menu()) {
  2152. se->get_edit_menu()->hide();
  2153. menu_hb->add_child(se->get_edit_menu());
  2154. menu_hb->move_child(se->get_edit_menu(), 1);
  2155. }
  2156. if (p_grab_focus) {
  2157. _go_to_tab(tab_container->get_tab_count() - 1);
  2158. _add_recent_script(p_resource->get_path());
  2159. }
  2160. if (script_editor_cache->has_section(p_resource->get_path())) {
  2161. se->set_edit_state(script_editor_cache->get_value(p_resource->get_path(), "state"));
  2162. ScriptTextEditor *ste = Object::cast_to<ScriptTextEditor>(se);
  2163. if (ste) {
  2164. ste->store_previous_state();
  2165. }
  2166. }
  2167. _sort_list_on_update = true;
  2168. _update_script_names();
  2169. _save_layout();
  2170. se->connect("name_changed", callable_mp(this, &ScriptEditor::_update_script_names));
  2171. se->connect("edited_script_changed", callable_mp(this, &ScriptEditor::_script_changed));
  2172. se->connect("request_help", callable_mp(this, &ScriptEditor::_help_search));
  2173. se->connect("request_open_script_at_line", callable_mp(this, &ScriptEditor::_goto_script_line));
  2174. se->connect("go_to_help", callable_mp(this, &ScriptEditor::_help_class_goto));
  2175. se->connect("request_save_history", callable_mp(this, &ScriptEditor::_save_history));
  2176. se->connect("request_save_previous_state", callable_mp(this, &ScriptEditor::_save_previous_state));
  2177. se->connect("search_in_files_requested", callable_mp(this, &ScriptEditor::_on_find_in_files_requested));
  2178. se->connect("replace_in_files_requested", callable_mp(this, &ScriptEditor::_on_replace_in_files_requested));
  2179. se->connect("go_to_method", callable_mp(this, &ScriptEditor::script_goto_method));
  2180. CodeTextEditor *cte = se->get_code_editor();
  2181. if (cte) {
  2182. cte->set_zoom_factor(zoom_factor);
  2183. cte->connect("zoomed", callable_mp(this, &ScriptEditor::_set_zoom_factor));
  2184. }
  2185. //test for modification, maybe the script was not edited but was loaded
  2186. _test_script_times_on_disk(p_resource);
  2187. _update_modified_scripts_for_external_editor(p_resource);
  2188. if (p_line >= 0) {
  2189. se->goto_line(p_line);
  2190. }
  2191. notify_script_changed(p_resource);
  2192. return true;
  2193. }
  2194. PackedStringArray ScriptEditor::get_unsaved_scripts() const {
  2195. PackedStringArray unsaved_list;
  2196. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2197. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  2198. if (se && se->is_unsaved()) {
  2199. unsaved_list.append(se->get_name());
  2200. }
  2201. }
  2202. return unsaved_list;
  2203. }
  2204. void ScriptEditor::save_current_script() {
  2205. ScriptEditorBase *current = _get_current_editor();
  2206. if (!current || _test_script_times_on_disk()) {
  2207. return;
  2208. }
  2209. if (trim_trailing_whitespace_on_save) {
  2210. current->trim_trailing_whitespace();
  2211. }
  2212. current->insert_final_newline();
  2213. if (convert_indent_on_save) {
  2214. current->convert_indent();
  2215. }
  2216. Ref<Resource> resource = current->get_edited_resource();
  2217. Ref<TextFile> text_file = resource;
  2218. Ref<Script> scr = resource;
  2219. if (text_file != nullptr) {
  2220. current->apply_code();
  2221. _save_text_file(text_file, text_file->get_path());
  2222. return;
  2223. }
  2224. if (scr.is_valid()) {
  2225. clear_docs_from_script(scr);
  2226. }
  2227. EditorNode::get_singleton()->save_resource(resource);
  2228. if (scr.is_valid()) {
  2229. update_docs_from_script(scr);
  2230. }
  2231. }
  2232. void ScriptEditor::save_all_scripts() {
  2233. HashSet<String> scenes_to_save;
  2234. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2235. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  2236. if (!se) {
  2237. continue;
  2238. }
  2239. if (convert_indent_on_save) {
  2240. se->convert_indent();
  2241. }
  2242. if (trim_trailing_whitespace_on_save) {
  2243. se->trim_trailing_whitespace();
  2244. }
  2245. se->insert_final_newline();
  2246. if (!se->is_unsaved()) {
  2247. continue;
  2248. }
  2249. Ref<Resource> edited_res = se->get_edited_resource();
  2250. if (edited_res.is_valid()) {
  2251. se->apply_code();
  2252. }
  2253. if (!edited_res->is_built_in()) {
  2254. Ref<TextFile> text_file = edited_res;
  2255. Ref<Script> scr = edited_res;
  2256. if (text_file != nullptr) {
  2257. _save_text_file(text_file, text_file->get_path());
  2258. continue;
  2259. }
  2260. if (scr.is_valid()) {
  2261. clear_docs_from_script(scr);
  2262. }
  2263. EditorNode::get_singleton()->save_resource(edited_res); //external script, save it
  2264. if (scr.is_valid()) {
  2265. update_docs_from_script(scr);
  2266. }
  2267. } else {
  2268. // For built-in scripts, save their scenes instead.
  2269. const String scene_path = edited_res->get_path().get_slice("::", 0);
  2270. if (!scene_path.is_empty() && !scenes_to_save.has(scene_path)) {
  2271. scenes_to_save.insert(scene_path);
  2272. }
  2273. }
  2274. }
  2275. if (!scenes_to_save.is_empty()) {
  2276. EditorNode::get_singleton()->save_scene_list(scenes_to_save);
  2277. }
  2278. _update_script_names();
  2279. }
  2280. void ScriptEditor::apply_scripts() const {
  2281. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2282. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  2283. if (!se) {
  2284. continue;
  2285. }
  2286. se->apply_code();
  2287. }
  2288. }
  2289. void ScriptEditor::reload_scripts(bool p_refresh_only) {
  2290. if (external_editor_active) {
  2291. return;
  2292. }
  2293. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2294. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  2295. if (!se) {
  2296. continue;
  2297. }
  2298. Ref<Resource> edited_res = se->get_edited_resource();
  2299. if (edited_res->is_built_in()) {
  2300. continue; //internal script, who cares
  2301. }
  2302. if (!p_refresh_only) {
  2303. uint64_t last_date = edited_res->get_last_modified_time();
  2304. uint64_t date = FileAccess::get_modified_time(edited_res->get_path());
  2305. if (last_date == date) {
  2306. continue;
  2307. }
  2308. Ref<Script> scr = edited_res;
  2309. if (scr.is_valid()) {
  2310. Ref<Script> rel_scr = ResourceLoader::load(scr->get_path(), scr->get_class(), ResourceFormatLoader::CACHE_MODE_IGNORE);
  2311. ERR_CONTINUE(!rel_scr.is_valid());
  2312. scr->set_source_code(rel_scr->get_source_code());
  2313. scr->set_last_modified_time(rel_scr->get_last_modified_time());
  2314. scr->reload(true);
  2315. }
  2316. Ref<JSON> json = edited_res;
  2317. if (json != nullptr) {
  2318. Ref<JSON> rel_json = ResourceLoader::load(json->get_path(), json->get_class(), ResourceFormatLoader::CACHE_MODE_IGNORE);
  2319. ERR_CONTINUE(!rel_json.is_valid());
  2320. json->parse(rel_json->get_parsed_text(), true);
  2321. json->set_last_modified_time(rel_json->get_last_modified_time());
  2322. }
  2323. Ref<TextFile> text_file = edited_res;
  2324. if (text_file.is_valid()) {
  2325. text_file->reload_from_file();
  2326. }
  2327. }
  2328. se->reload_text();
  2329. }
  2330. disk_changed->hide();
  2331. _update_script_names();
  2332. }
  2333. void ScriptEditor::open_script_create_dialog(const String &p_base_name, const String &p_base_path) {
  2334. _menu_option(FILE_NEW);
  2335. script_create_dialog->config(p_base_name, p_base_path);
  2336. }
  2337. void ScriptEditor::open_text_file_create_dialog(const String &p_base_path, const String &p_base_name) {
  2338. _menu_option(FILE_NEW_TEXTFILE);
  2339. file_dialog->set_current_dir(p_base_path);
  2340. file_dialog->set_current_file(p_base_name);
  2341. open_textfile_after_create = false;
  2342. }
  2343. Ref<Resource> ScriptEditor::open_file(const String &p_file) {
  2344. List<String> extensions;
  2345. ResourceLoader::get_recognized_extensions_for_type("Script", &extensions);
  2346. ResourceLoader::get_recognized_extensions_for_type("JSON", &extensions);
  2347. if (extensions.find(p_file.get_extension())) {
  2348. Ref<Resource> scr = ResourceLoader::load(p_file);
  2349. if (!scr.is_valid()) {
  2350. EditorNode::get_singleton()->show_warning(TTR("Could not load file at:") + "\n\n" + p_file, TTR("Error!"));
  2351. return Ref<Resource>();
  2352. }
  2353. edit(scr);
  2354. return scr;
  2355. }
  2356. Error error;
  2357. Ref<TextFile> text_file = _load_text_file(p_file, &error);
  2358. if (error != OK) {
  2359. EditorNode::get_singleton()->show_warning(TTR("Could not load file at:") + "\n\n" + p_file, TTR("Error!"));
  2360. return Ref<Resource>();
  2361. }
  2362. if (text_file.is_valid()) {
  2363. edit(text_file);
  2364. return text_file;
  2365. }
  2366. return Ref<Resource>();
  2367. }
  2368. void ScriptEditor::_editor_stop() {
  2369. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2370. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  2371. if (!se) {
  2372. continue;
  2373. }
  2374. se->set_debugger_active(false);
  2375. }
  2376. }
  2377. void ScriptEditor::_add_callback(Object *p_obj, const String &p_function, const PackedStringArray &p_args) {
  2378. ERR_FAIL_NULL(p_obj);
  2379. Ref<Script> scr = p_obj->get_script();
  2380. ERR_FAIL_COND(!scr.is_valid());
  2381. if (!scr->get_language()->can_make_function()) {
  2382. return;
  2383. }
  2384. EditorNode::get_singleton()->push_item(scr.ptr());
  2385. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2386. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  2387. if (!se) {
  2388. continue;
  2389. }
  2390. if (se->get_edited_resource() != scr) {
  2391. continue;
  2392. }
  2393. se->add_callback(p_function, p_args);
  2394. _go_to_tab(i);
  2395. script_list->select(script_list->find_metadata(i));
  2396. // Save the current script so the changes can be picked up by an external editor.
  2397. if (!scr.ptr()->is_built_in()) { // But only if it's not built-in script.
  2398. save_current_script();
  2399. }
  2400. break;
  2401. }
  2402. }
  2403. void ScriptEditor::_save_editor_state(ScriptEditorBase *p_editor) {
  2404. if (restoring_layout) {
  2405. return;
  2406. }
  2407. const String &path = p_editor->get_edited_resource()->get_path();
  2408. if (!path.is_resource_file()) {
  2409. return;
  2410. }
  2411. script_editor_cache->set_value(path, "state", p_editor->get_edit_state());
  2412. // This is saved later when we save the editor layout.
  2413. }
  2414. void ScriptEditor::_save_layout() {
  2415. if (restoring_layout) {
  2416. return;
  2417. }
  2418. EditorNode::get_singleton()->save_editor_layout_delayed();
  2419. }
  2420. void ScriptEditor::_editor_settings_changed() {
  2421. if (!EditorThemeManager::is_generated_theme_outdated() &&
  2422. !EditorSettings::get_singleton()->check_changed_settings_in_group("interface/editor") &&
  2423. !EditorSettings::get_singleton()->check_changed_settings_in_group("text_editor") &&
  2424. !EditorSettings::get_singleton()->check_changed_settings_in_group("docks/filesystem")) {
  2425. return;
  2426. }
  2427. _apply_editor_settings();
  2428. }
  2429. void ScriptEditor::_apply_editor_settings() {
  2430. textfile_extensions.clear();
  2431. const Vector<String> textfile_ext = ((String)(EDITOR_GET("docks/filesystem/textfile_extensions"))).split(",", false);
  2432. for (const String &E : textfile_ext) {
  2433. textfile_extensions.insert(E);
  2434. }
  2435. trim_trailing_whitespace_on_save = EDITOR_GET("text_editor/behavior/files/trim_trailing_whitespace_on_save");
  2436. convert_indent_on_save = EDITOR_GET("text_editor/behavior/files/convert_indent_on_save");
  2437. members_overview_enabled = EDITOR_GET("text_editor/script_list/show_members_overview");
  2438. help_overview_enabled = EDITOR_GET("text_editor/help/show_help_index");
  2439. external_editor_active = EDITOR_GET("text_editor/external/use_external_editor");
  2440. _update_members_overview_visibility();
  2441. _update_help_overview_visibility();
  2442. _update_autosave_timer();
  2443. if (current_theme.is_empty()) {
  2444. current_theme = EDITOR_GET("text_editor/theme/color_theme");
  2445. } else if (current_theme != String(EDITOR_GET("text_editor/theme/color_theme"))) {
  2446. current_theme = EDITOR_GET("text_editor/theme/color_theme");
  2447. EditorSettings::get_singleton()->load_text_editor_theme();
  2448. }
  2449. _update_script_names();
  2450. ScriptServer::set_reload_scripts_on_save(EDITOR_GET("text_editor/behavior/files/auto_reload_and_parse_scripts_on_save"));
  2451. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2452. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  2453. if (!se) {
  2454. continue;
  2455. }
  2456. se->update_settings();
  2457. }
  2458. }
  2459. void ScriptEditor::_filesystem_changed() {
  2460. _update_script_names();
  2461. }
  2462. void ScriptEditor::_files_moved(const String &p_old_file, const String &p_new_file) {
  2463. if (!script_editor_cache->has_section(p_old_file)) {
  2464. return;
  2465. }
  2466. Variant state = script_editor_cache->get_value(p_old_file, "state");
  2467. script_editor_cache->erase_section(p_old_file);
  2468. script_editor_cache->set_value(p_new_file, "state", state);
  2469. // If Script, update breakpoints with debugger.
  2470. Array breakpoints = _get_cached_breakpoints_for_script(p_new_file);
  2471. for (int i = 0; i < breakpoints.size(); i++) {
  2472. int line = (int)breakpoints[i] + 1;
  2473. EditorDebuggerNode::get_singleton()->set_breakpoint(p_old_file, line, false);
  2474. if (!p_new_file.begins_with("local://") && ResourceLoader::exists(p_new_file, "Script")) {
  2475. EditorDebuggerNode::get_singleton()->set_breakpoint(p_new_file, line, true);
  2476. }
  2477. }
  2478. // This is saved later when we save the editor layout.
  2479. }
  2480. void ScriptEditor::_file_removed(const String &p_removed_file) {
  2481. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2482. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  2483. if (!se) {
  2484. continue;
  2485. }
  2486. if (se->get_meta("_edit_res_path") == p_removed_file) {
  2487. // The script is deleted with no undo, so just close the tab.
  2488. _close_tab(i, false, false);
  2489. }
  2490. }
  2491. // Check closed.
  2492. if (script_editor_cache->has_section(p_removed_file)) {
  2493. Array breakpoints = _get_cached_breakpoints_for_script(p_removed_file);
  2494. for (int i = 0; i < breakpoints.size(); i++) {
  2495. EditorDebuggerNode::get_singleton()->set_breakpoint(p_removed_file, (int)breakpoints[i] + 1, false);
  2496. }
  2497. script_editor_cache->erase_section(p_removed_file);
  2498. }
  2499. }
  2500. void ScriptEditor::_update_find_replace_bar() {
  2501. ScriptEditorBase *se = _get_current_editor();
  2502. if (se) {
  2503. se->set_find_replace_bar(find_replace_bar);
  2504. } else {
  2505. find_replace_bar->set_text_edit(nullptr);
  2506. find_replace_bar->hide();
  2507. }
  2508. }
  2509. void ScriptEditor::_autosave_scripts() {
  2510. save_all_scripts();
  2511. }
  2512. void ScriptEditor::_update_autosave_timer() {
  2513. if (!autosave_timer->is_inside_tree()) {
  2514. return;
  2515. }
  2516. float autosave_time = EDITOR_GET("text_editor/behavior/files/autosave_interval_secs");
  2517. if (autosave_time > 0) {
  2518. autosave_timer->set_wait_time(autosave_time);
  2519. autosave_timer->start();
  2520. } else {
  2521. autosave_timer->stop();
  2522. }
  2523. }
  2524. void ScriptEditor::_tree_changed() {
  2525. if (waiting_update_names) {
  2526. return;
  2527. }
  2528. waiting_update_names = true;
  2529. callable_mp(this, &ScriptEditor::_update_script_names).call_deferred();
  2530. }
  2531. void ScriptEditor::_split_dragged(float) {
  2532. _save_layout();
  2533. }
  2534. Variant ScriptEditor::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  2535. if (tab_container->get_tab_count() == 0) {
  2536. return Variant();
  2537. }
  2538. Node *cur_node = tab_container->get_tab_control(tab_container->get_current_tab());
  2539. HBoxContainer *drag_preview = memnew(HBoxContainer);
  2540. String preview_name = "";
  2541. Ref<Texture2D> preview_icon;
  2542. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(cur_node);
  2543. if (se) {
  2544. preview_name = se->get_name();
  2545. preview_icon = se->get_theme_icon();
  2546. }
  2547. EditorHelp *eh = Object::cast_to<EditorHelp>(cur_node);
  2548. if (eh) {
  2549. preview_name = eh->get_class();
  2550. preview_icon = get_editor_theme_icon(SNAME("Help"));
  2551. }
  2552. if (!preview_icon.is_null()) {
  2553. TextureRect *tf = memnew(TextureRect);
  2554. tf->set_texture(preview_icon);
  2555. tf->set_stretch_mode(TextureRect::STRETCH_KEEP_CENTERED);
  2556. drag_preview->add_child(tf);
  2557. }
  2558. Label *label = memnew(Label(preview_name));
  2559. drag_preview->add_child(label);
  2560. set_drag_preview(drag_preview);
  2561. Dictionary drag_data;
  2562. drag_data["type"] = "script_list_element"; // using a custom type because node caused problems when dragging to scene tree
  2563. drag_data["script_list_element"] = cur_node;
  2564. return drag_data;
  2565. }
  2566. bool ScriptEditor::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
  2567. Dictionary d = p_data;
  2568. if (!d.has("type")) {
  2569. return false;
  2570. }
  2571. if (String(d["type"]) == "script_list_element") {
  2572. Node *node = Object::cast_to<Node>(d["script_list_element"]);
  2573. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(node);
  2574. if (se) {
  2575. return true;
  2576. }
  2577. EditorHelp *eh = Object::cast_to<EditorHelp>(node);
  2578. if (eh) {
  2579. return true;
  2580. }
  2581. }
  2582. if (String(d["type"]) == "nodes") {
  2583. Array nodes = d["nodes"];
  2584. if (nodes.size() == 0) {
  2585. return false;
  2586. }
  2587. Node *node = get_node((nodes[0]));
  2588. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(node);
  2589. if (se) {
  2590. return true;
  2591. }
  2592. EditorHelp *eh = Object::cast_to<EditorHelp>(node);
  2593. if (eh) {
  2594. return true;
  2595. }
  2596. }
  2597. if (String(d["type"]) == "files") {
  2598. Vector<String> files = d["files"];
  2599. if (files.size() == 0) {
  2600. return false; //weird
  2601. }
  2602. for (int i = 0; i < files.size(); i++) {
  2603. const String &file = files[i];
  2604. if (file.is_empty() || !FileAccess::exists(file)) {
  2605. continue;
  2606. }
  2607. if (ResourceLoader::exists(file, "Script") || ResourceLoader::exists(file, "JSON")) {
  2608. Ref<Resource> scr = ResourceLoader::load(file);
  2609. if (scr.is_valid()) {
  2610. return true;
  2611. }
  2612. }
  2613. if (textfile_extensions.has(file.get_extension())) {
  2614. Error err;
  2615. Ref<TextFile> text_file = _load_text_file(file, &err);
  2616. if (text_file.is_valid() && err == OK) {
  2617. return true;
  2618. }
  2619. }
  2620. }
  2621. return false;
  2622. }
  2623. return false;
  2624. }
  2625. void ScriptEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
  2626. if (!can_drop_data_fw(p_point, p_data, p_from)) {
  2627. return;
  2628. }
  2629. Dictionary d = p_data;
  2630. if (!d.has("type")) {
  2631. return;
  2632. }
  2633. if (String(d["type"]) == "script_list_element") {
  2634. Node *node = Object::cast_to<Node>(d["script_list_element"]);
  2635. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(node);
  2636. EditorHelp *eh = Object::cast_to<EditorHelp>(node);
  2637. if (se || eh) {
  2638. int new_index = 0;
  2639. if (script_list->get_item_count() > 0) {
  2640. new_index = script_list->get_item_metadata(script_list->get_item_at_position(p_point));
  2641. }
  2642. tab_container->move_child(node, new_index);
  2643. tab_container->set_current_tab(new_index);
  2644. _update_script_names();
  2645. }
  2646. }
  2647. if (String(d["type"]) == "nodes") {
  2648. Array nodes = d["nodes"];
  2649. if (nodes.size() == 0) {
  2650. return;
  2651. }
  2652. Node *node = get_node(nodes[0]);
  2653. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(node);
  2654. EditorHelp *eh = Object::cast_to<EditorHelp>(node);
  2655. if (se || eh) {
  2656. int new_index = 0;
  2657. if (script_list->get_item_count() > 0) {
  2658. new_index = script_list->get_item_metadata(script_list->get_item_at_position(p_point));
  2659. }
  2660. tab_container->move_child(node, new_index);
  2661. tab_container->set_current_tab(new_index);
  2662. _update_script_names();
  2663. }
  2664. }
  2665. if (String(d["type"]) == "files") {
  2666. Vector<String> files = d["files"];
  2667. int new_index = 0;
  2668. if (script_list->get_item_count() > 0) {
  2669. new_index = script_list->get_item_metadata(script_list->get_item_at_position(p_point));
  2670. }
  2671. int num_tabs_before = tab_container->get_tab_count();
  2672. for (int i = 0; i < files.size(); i++) {
  2673. const String &file = files[i];
  2674. if (file.is_empty() || !FileAccess::exists(file)) {
  2675. continue;
  2676. }
  2677. if (!ResourceLoader::exists(file, "Script") && !ResourceLoader::exists(file, "JSON") && !textfile_extensions.has(file.get_extension())) {
  2678. continue;
  2679. }
  2680. Ref<Resource> res = open_file(file);
  2681. if (res.is_valid()) {
  2682. const int num_tabs = tab_container->get_tab_count();
  2683. if (num_tabs > num_tabs_before) {
  2684. tab_container->move_child(tab_container->get_tab_control(tab_container->get_tab_count() - 1), new_index);
  2685. num_tabs_before = num_tabs;
  2686. } else if (num_tabs > 0) { /* Maybe script was already open */
  2687. tab_container->move_child(tab_container->get_tab_control(tab_container->get_current_tab()), new_index);
  2688. }
  2689. }
  2690. }
  2691. if (tab_container->get_tab_count() > 0) {
  2692. tab_container->set_current_tab(new_index);
  2693. }
  2694. _update_script_names();
  2695. }
  2696. }
  2697. void ScriptEditor::input(const Ref<InputEvent> &p_event) {
  2698. // This is implemented in `input()` rather than `unhandled_input()` to allow
  2699. // the shortcut to be used regardless of the click location.
  2700. // This feature can be disabled to avoid interfering with other uses of the additional
  2701. // mouse buttons, such as push-to-talk in a VoIP program.
  2702. if (EDITOR_GET("interface/editor/mouse_extra_buttons_navigate_history")) {
  2703. const Ref<InputEventMouseButton> mb = p_event;
  2704. // Navigate the script history using additional mouse buttons present on some mice.
  2705. // This must be hardcoded as the editor shortcuts dialog doesn't allow assigning
  2706. // more than one shortcut per action.
  2707. if (mb.is_valid() && mb->is_pressed() && is_visible_in_tree()) {
  2708. if (mb->get_button_index() == MouseButton::MB_XBUTTON1) {
  2709. _history_back();
  2710. }
  2711. if (mb->get_button_index() == MouseButton::MB_XBUTTON2) {
  2712. _history_forward();
  2713. }
  2714. }
  2715. }
  2716. }
  2717. void ScriptEditor::shortcut_input(const Ref<InputEvent> &p_event) {
  2718. ERR_FAIL_COND(p_event.is_null());
  2719. if (!is_visible_in_tree() || !p_event->is_pressed() || p_event->is_echo()) {
  2720. return;
  2721. }
  2722. if (ED_IS_SHORTCUT("script_editor/next_script", p_event)) {
  2723. if (script_list->get_item_count() > 1) {
  2724. int next_tab = script_list->get_current() + 1;
  2725. next_tab %= script_list->get_item_count();
  2726. _go_to_tab(script_list->get_item_metadata(next_tab));
  2727. _update_script_names();
  2728. }
  2729. accept_event();
  2730. }
  2731. if (ED_IS_SHORTCUT("script_editor/prev_script", p_event)) {
  2732. if (script_list->get_item_count() > 1) {
  2733. int next_tab = script_list->get_current() - 1;
  2734. next_tab = next_tab >= 0 ? next_tab : script_list->get_item_count() - 1;
  2735. _go_to_tab(script_list->get_item_metadata(next_tab));
  2736. _update_script_names();
  2737. }
  2738. accept_event();
  2739. }
  2740. if (ED_IS_SHORTCUT("script_editor/window_move_up", p_event)) {
  2741. _menu_option(WINDOW_MOVE_UP);
  2742. accept_event();
  2743. }
  2744. if (ED_IS_SHORTCUT("script_editor/window_move_down", p_event)) {
  2745. _menu_option(WINDOW_MOVE_DOWN);
  2746. accept_event();
  2747. }
  2748. }
  2749. void ScriptEditor::_script_list_clicked(int p_item, Vector2 p_local_mouse_pos, MouseButton p_mouse_button_index) {
  2750. if (p_mouse_button_index == MouseButton::MIDDLE) {
  2751. script_list->select(p_item);
  2752. _script_selected(p_item);
  2753. _menu_option(FILE_CLOSE);
  2754. }
  2755. if (p_mouse_button_index == MouseButton::RIGHT) {
  2756. _make_script_list_context_menu();
  2757. }
  2758. }
  2759. void ScriptEditor::_make_script_list_context_menu() {
  2760. context_menu->clear();
  2761. int selected = tab_container->get_current_tab();
  2762. if (selected < 0 || selected >= tab_container->get_tab_count()) {
  2763. return;
  2764. }
  2765. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(selected));
  2766. if (se) {
  2767. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/save"), FILE_SAVE);
  2768. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/save_as"), FILE_SAVE_AS);
  2769. }
  2770. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/close_file"), FILE_CLOSE);
  2771. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/close_all"), CLOSE_ALL);
  2772. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/close_other_tabs"), CLOSE_OTHER_TABS);
  2773. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/close_docs"), CLOSE_DOCS);
  2774. context_menu->add_separator();
  2775. if (se) {
  2776. Ref<Script> scr = se->get_edited_resource();
  2777. if (scr != nullptr) {
  2778. if (!scr.is_null() && scr->is_tool()) {
  2779. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/reload_script_soft"), FILE_TOOL_RELOAD_SOFT);
  2780. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/run_file"), FILE_RUN);
  2781. context_menu->add_separator();
  2782. }
  2783. }
  2784. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/copy_path"), FILE_COPY_PATH);
  2785. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/show_in_file_system"), SHOW_IN_FILE_SYSTEM);
  2786. context_menu->add_separator();
  2787. }
  2788. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/window_move_up"), WINDOW_MOVE_UP);
  2789. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/window_move_down"), WINDOW_MOVE_DOWN);
  2790. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/window_sort"), WINDOW_SORT);
  2791. context_menu->add_shortcut(ED_GET_SHORTCUT("script_editor/toggle_scripts_panel"), TOGGLE_SCRIPTS_PANEL);
  2792. context_menu->set_item_disabled(context_menu->get_item_index(CLOSE_ALL), tab_container->get_tab_count() <= 0);
  2793. context_menu->set_item_disabled(context_menu->get_item_index(CLOSE_OTHER_TABS), tab_container->get_tab_count() <= 1);
  2794. context_menu->set_item_disabled(context_menu->get_item_index(CLOSE_DOCS), !_has_docs_tab());
  2795. context_menu->set_item_disabled(context_menu->get_item_index(WINDOW_MOVE_UP), tab_container->get_current_tab() <= 0);
  2796. context_menu->set_item_disabled(context_menu->get_item_index(WINDOW_MOVE_DOWN), tab_container->get_current_tab() >= tab_container->get_tab_count() - 1);
  2797. context_menu->set_item_disabled(context_menu->get_item_index(WINDOW_SORT), tab_container->get_tab_count() <= 1);
  2798. context_menu->set_position(get_screen_position() + get_local_mouse_position());
  2799. context_menu->reset_size();
  2800. context_menu->popup();
  2801. }
  2802. void ScriptEditor::set_window_layout(Ref<ConfigFile> p_layout) {
  2803. if (!bool(EDITOR_GET("text_editor/behavior/files/restore_scripts_on_load"))) {
  2804. return;
  2805. }
  2806. if (!p_layout->has_section_key("ScriptEditor", "open_scripts") && !p_layout->has_section_key("ScriptEditor", "open_help")) {
  2807. return;
  2808. }
  2809. Array scripts = p_layout->get_value("ScriptEditor", "open_scripts");
  2810. Array helps;
  2811. if (p_layout->has_section_key("ScriptEditor", "open_help")) {
  2812. helps = p_layout->get_value("ScriptEditor", "open_help");
  2813. }
  2814. restoring_layout = true;
  2815. HashSet<String> loaded_scripts;
  2816. List<String> extensions;
  2817. ResourceLoader::get_recognized_extensions_for_type("Script", &extensions);
  2818. ResourceLoader::get_recognized_extensions_for_type("JSON", &extensions);
  2819. for (int i = 0; i < scripts.size(); i++) {
  2820. String path = scripts[i];
  2821. Dictionary script_info = scripts[i];
  2822. if (!script_info.is_empty()) {
  2823. path = script_info["path"];
  2824. }
  2825. if (!FileAccess::exists(path)) {
  2826. if (script_editor_cache->has_section(path)) {
  2827. script_editor_cache->erase_section(path);
  2828. }
  2829. continue;
  2830. }
  2831. loaded_scripts.insert(path);
  2832. if (extensions.find(path.get_extension())) {
  2833. Ref<Resource> scr = ResourceLoader::load(path);
  2834. if (!scr.is_valid()) {
  2835. continue;
  2836. }
  2837. if (!edit(scr, false)) {
  2838. continue;
  2839. }
  2840. } else {
  2841. Error error;
  2842. Ref<TextFile> text_file = _load_text_file(path, &error);
  2843. if (error != OK || !text_file.is_valid()) {
  2844. continue;
  2845. }
  2846. if (!edit(text_file, false)) {
  2847. continue;
  2848. }
  2849. }
  2850. if (!script_info.is_empty()) {
  2851. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(tab_container->get_tab_count() - 1));
  2852. if (se) {
  2853. se->set_edit_state(script_info["state"]);
  2854. }
  2855. }
  2856. }
  2857. for (int i = 0; i < helps.size(); i++) {
  2858. String path = helps[i];
  2859. if (path.is_empty()) { // invalid, skip
  2860. continue;
  2861. }
  2862. _help_class_open(path);
  2863. }
  2864. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2865. tab_container->get_tab_control(i)->set_meta("__editor_pass", Variant());
  2866. }
  2867. if (p_layout->has_section_key("ScriptEditor", "script_split_offset")) {
  2868. script_split->set_split_offset(p_layout->get_value("ScriptEditor", "script_split_offset"));
  2869. }
  2870. if (p_layout->has_section_key("ScriptEditor", "list_split_offset")) {
  2871. list_split->set_split_offset(p_layout->get_value("ScriptEditor", "list_split_offset"));
  2872. }
  2873. // Remove any deleted editors that have been removed between launches.
  2874. // and if a Script, register breakpoints with the debugger.
  2875. List<String> cached_editors;
  2876. script_editor_cache->get_sections(&cached_editors);
  2877. for (const String &E : cached_editors) {
  2878. if (loaded_scripts.has(E)) {
  2879. continue;
  2880. }
  2881. if (!FileAccess::exists(E)) {
  2882. script_editor_cache->erase_section(E);
  2883. continue;
  2884. }
  2885. Array breakpoints = _get_cached_breakpoints_for_script(E);
  2886. for (int i = 0; i < breakpoints.size(); i++) {
  2887. EditorDebuggerNode::get_singleton()->set_breakpoint(E, (int)breakpoints[i] + 1, true);
  2888. }
  2889. }
  2890. _set_zoom_factor(p_layout->get_value("ScriptEditor", "zoom_factor", 1.0f));
  2891. restoring_layout = false;
  2892. _update_script_names();
  2893. if (p_layout->has_section_key("ScriptEditor", "selected_script")) {
  2894. String selected_script = p_layout->get_value("ScriptEditor", "selected_script");
  2895. // If the selected script is not in the list of open scripts, select nothing.
  2896. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2897. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  2898. if (se && se->get_edited_resource()->get_path() == selected_script) {
  2899. _go_to_tab(i);
  2900. break;
  2901. }
  2902. }
  2903. }
  2904. }
  2905. void ScriptEditor::get_window_layout(Ref<ConfigFile> p_layout) {
  2906. Array scripts;
  2907. Array helps;
  2908. String selected_script;
  2909. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2910. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  2911. if (se) {
  2912. String path = se->get_edited_resource()->get_path();
  2913. if (!path.is_resource_file()) {
  2914. continue;
  2915. }
  2916. if (tab_container->get_current_tab_control() == tab_container->get_tab_control(i)) {
  2917. selected_script = path;
  2918. }
  2919. _save_editor_state(se);
  2920. scripts.push_back(path);
  2921. }
  2922. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_tab_control(i));
  2923. if (eh) {
  2924. helps.push_back(eh->get_class());
  2925. }
  2926. }
  2927. p_layout->set_value("ScriptEditor", "open_scripts", scripts);
  2928. p_layout->set_value("ScriptEditor", "selected_script", selected_script);
  2929. p_layout->set_value("ScriptEditor", "open_help", helps);
  2930. p_layout->set_value("ScriptEditor", "script_split_offset", script_split->get_split_offset());
  2931. p_layout->set_value("ScriptEditor", "list_split_offset", list_split->get_split_offset());
  2932. p_layout->set_value("ScriptEditor", "zoom_factor", zoom_factor);
  2933. // Save the cache.
  2934. script_editor_cache->save(EditorPaths::get_singleton()->get_project_settings_dir().path_join("script_editor_cache.cfg"));
  2935. }
  2936. void ScriptEditor::_help_class_open(const String &p_class) {
  2937. if (p_class.is_empty()) {
  2938. return;
  2939. }
  2940. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2941. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_tab_control(i));
  2942. if (eh && eh->get_class() == p_class) {
  2943. _go_to_tab(i);
  2944. _update_script_names();
  2945. return;
  2946. }
  2947. }
  2948. EditorHelp *eh = memnew(EditorHelp);
  2949. eh->set_name(p_class);
  2950. tab_container->add_child(eh);
  2951. _go_to_tab(tab_container->get_tab_count() - 1);
  2952. eh->go_to_class(p_class);
  2953. eh->connect("go_to_help", callable_mp(this, &ScriptEditor::_help_class_goto));
  2954. eh->connect("request_save_history", callable_mp(this, &ScriptEditor::_save_history));
  2955. _add_recent_script(p_class);
  2956. _sort_list_on_update = true;
  2957. _update_script_names();
  2958. _save_layout();
  2959. }
  2960. void ScriptEditor::_help_class_goto(const String &p_desc) {
  2961. String cname = p_desc.get_slice(":", 1);
  2962. if (_help_tab_goto(cname, p_desc)) {
  2963. return;
  2964. }
  2965. EditorHelp *eh = memnew(EditorHelp);
  2966. eh->set_name(cname);
  2967. tab_container->add_child(eh);
  2968. eh->go_to_help(p_desc);
  2969. eh->connect("go_to_help", callable_mp(this, &ScriptEditor::_help_class_goto));
  2970. _add_recent_script(eh->get_class());
  2971. _sort_list_on_update = true;
  2972. _update_script_names();
  2973. _save_layout();
  2974. callable_mp(this, &ScriptEditor::_help_tab_goto).call_deferred(cname, p_desc);
  2975. }
  2976. bool ScriptEditor::_help_tab_goto(const String &p_name, const String &p_desc) {
  2977. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2978. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_tab_control(i));
  2979. if (eh && eh->get_class() == p_name) {
  2980. _go_to_tab(i);
  2981. eh->go_to_help(p_desc);
  2982. _update_script_names();
  2983. return true;
  2984. }
  2985. }
  2986. return false;
  2987. }
  2988. void ScriptEditor::update_doc(const String &p_name) {
  2989. ERR_FAIL_COND(!EditorHelp::get_doc_data()->has_doc(p_name));
  2990. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  2991. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_tab_control(i));
  2992. if (eh && eh->get_class() == p_name) {
  2993. eh->update_doc();
  2994. return;
  2995. }
  2996. }
  2997. }
  2998. void ScriptEditor::clear_docs_from_script(const Ref<Script> &p_script) {
  2999. ERR_FAIL_COND(p_script.is_null());
  3000. Vector<DocData::ClassDoc> documentations = p_script->get_documentation();
  3001. for (int j = 0; j < documentations.size(); j++) {
  3002. const DocData::ClassDoc &doc = documentations.get(j);
  3003. if (EditorHelp::get_doc_data()->has_doc(doc.name)) {
  3004. EditorHelp::get_doc_data()->remove_doc(doc.name);
  3005. }
  3006. }
  3007. }
  3008. void ScriptEditor::update_docs_from_script(const Ref<Script> &p_script) {
  3009. ERR_FAIL_COND(p_script.is_null());
  3010. Vector<DocData::ClassDoc> documentations = p_script->get_documentation();
  3011. for (int j = 0; j < documentations.size(); j++) {
  3012. const DocData::ClassDoc &doc = documentations.get(j);
  3013. EditorHelp::get_doc_data()->add_doc(doc);
  3014. update_doc(doc.name);
  3015. }
  3016. }
  3017. void ScriptEditor::_update_selected_editor_menu() {
  3018. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  3019. bool current = tab_container->get_current_tab() == i;
  3020. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  3021. if (se && se->get_edit_menu()) {
  3022. if (current) {
  3023. se->get_edit_menu()->show();
  3024. } else {
  3025. se->get_edit_menu()->hide();
  3026. }
  3027. }
  3028. }
  3029. EditorHelp *eh = Object::cast_to<EditorHelp>(tab_container->get_current_tab_control());
  3030. script_search_menu->get_popup()->clear();
  3031. if (eh) {
  3032. script_search_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/find", TTR("Find..."), KeyModifierMask::CMD_OR_CTRL | Key::F), HELP_SEARCH_FIND);
  3033. script_search_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/find_next", TTR("Find Next"), Key::F3), HELP_SEARCH_FIND_NEXT);
  3034. script_search_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/find_previous", TTR("Find Previous"), KeyModifierMask::SHIFT | Key::F3), HELP_SEARCH_FIND_PREVIOUS);
  3035. script_search_menu->get_popup()->add_separator();
  3036. script_search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_editor/find_in_files"), SEARCH_IN_FILES);
  3037. script_search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_editor/replace_in_files"), REPLACE_IN_FILES);
  3038. script_search_menu->show();
  3039. } else {
  3040. if (tab_container->get_tab_count() == 0) {
  3041. script_search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_editor/find_in_files"), SEARCH_IN_FILES);
  3042. script_search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_editor/replace_in_files"), REPLACE_IN_FILES);
  3043. script_search_menu->show();
  3044. } else {
  3045. script_search_menu->hide();
  3046. }
  3047. }
  3048. }
  3049. void ScriptEditor::_update_history_pos(int p_new_pos) {
  3050. Node *n = tab_container->get_current_tab_control();
  3051. if (Object::cast_to<ScriptEditorBase>(n)) {
  3052. history.write[history_pos].state = Object::cast_to<ScriptEditorBase>(n)->get_navigation_state();
  3053. }
  3054. if (Object::cast_to<EditorHelp>(n)) {
  3055. history.write[history_pos].state = Object::cast_to<EditorHelp>(n)->get_scroll();
  3056. }
  3057. history_pos = p_new_pos;
  3058. tab_container->set_current_tab(tab_container->get_tab_idx_from_control(history[history_pos].control));
  3059. n = history[history_pos].control;
  3060. ScriptEditorBase *seb = Object::cast_to<ScriptEditorBase>(n);
  3061. if (seb) {
  3062. lock_history = true;
  3063. seb->set_edit_state(history[history_pos].state);
  3064. seb->ensure_focus();
  3065. Ref<Script> scr = seb->get_edited_resource();
  3066. if (scr != nullptr) {
  3067. notify_script_changed(scr);
  3068. }
  3069. }
  3070. EditorHelp *eh = Object::cast_to<EditorHelp>(n);
  3071. if (eh) {
  3072. eh->set_scroll(history[history_pos].state);
  3073. eh->set_focused();
  3074. }
  3075. n->set_meta("__editor_pass", ++edit_pass);
  3076. _update_script_names();
  3077. _update_history_arrows();
  3078. _update_selected_editor_menu();
  3079. }
  3080. void ScriptEditor::_history_forward() {
  3081. if (history_pos < history.size() - 1) {
  3082. _update_history_pos(history_pos + 1);
  3083. }
  3084. }
  3085. void ScriptEditor::_history_back() {
  3086. if (history_pos > 0) {
  3087. _update_history_pos(history_pos - 1);
  3088. }
  3089. }
  3090. Vector<Ref<Script>> ScriptEditor::get_open_scripts() const {
  3091. Vector<Ref<Script>> out_scripts = Vector<Ref<Script>>();
  3092. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  3093. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  3094. if (!se) {
  3095. continue;
  3096. }
  3097. Ref<Script> scr = se->get_edited_resource();
  3098. if (scr != nullptr) {
  3099. out_scripts.push_back(scr);
  3100. }
  3101. }
  3102. return out_scripts;
  3103. }
  3104. TypedArray<ScriptEditorBase> ScriptEditor::_get_open_script_editors() const {
  3105. TypedArray<ScriptEditorBase> script_editors;
  3106. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  3107. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  3108. if (!se) {
  3109. continue;
  3110. }
  3111. script_editors.push_back(se);
  3112. }
  3113. return script_editors;
  3114. }
  3115. void ScriptEditor::set_scene_root_script(Ref<Script> p_script) {
  3116. // Don't open dominant script if using an external editor.
  3117. bool use_external_editor =
  3118. external_editor_active ||
  3119. (p_script.is_valid() && p_script->get_language()->overrides_external_editor());
  3120. use_external_editor = use_external_editor && !(p_script.is_valid() && p_script->is_built_in()); // Ignore external editor for built-in scripts.
  3121. const bool open_dominant = EDITOR_GET("text_editor/behavior/files/open_dominant_script_on_scene_change");
  3122. if (open_dominant && !use_external_editor && p_script.is_valid()) {
  3123. edit(p_script);
  3124. }
  3125. }
  3126. bool ScriptEditor::script_goto_method(Ref<Script> p_script, const String &p_method) {
  3127. int line = p_script->get_member_line(p_method);
  3128. if (line == -1) {
  3129. return false;
  3130. }
  3131. return edit(p_script, line, 0);
  3132. }
  3133. void ScriptEditor::set_live_auto_reload_running_scripts(bool p_enabled) {
  3134. auto_reload_running_scripts = p_enabled;
  3135. }
  3136. void ScriptEditor::_help_search(const String &p_text) {
  3137. help_search_dialog->popup_dialog(p_text);
  3138. }
  3139. void ScriptEditor::_open_script_request(const String &p_path) {
  3140. Ref<Script> scr = ResourceLoader::load(p_path);
  3141. if (scr.is_valid()) {
  3142. script_editor->edit(scr, false);
  3143. return;
  3144. }
  3145. Ref<JSON> json = ResourceLoader::load(p_path);
  3146. if (json.is_valid()) {
  3147. script_editor->edit(json, false);
  3148. return;
  3149. }
  3150. Error err;
  3151. Ref<TextFile> text_file = script_editor->_load_text_file(p_path, &err);
  3152. if (text_file.is_valid()) {
  3153. script_editor->edit(text_file, false);
  3154. return;
  3155. }
  3156. }
  3157. void ScriptEditor::register_syntax_highlighter(const Ref<EditorSyntaxHighlighter> &p_syntax_highlighter) {
  3158. ERR_FAIL_COND(p_syntax_highlighter.is_null());
  3159. if (!syntax_highlighters.has(p_syntax_highlighter)) {
  3160. syntax_highlighters.push_back(p_syntax_highlighter);
  3161. }
  3162. }
  3163. void ScriptEditor::unregister_syntax_highlighter(const Ref<EditorSyntaxHighlighter> &p_syntax_highlighter) {
  3164. ERR_FAIL_COND(p_syntax_highlighter.is_null());
  3165. syntax_highlighters.erase(p_syntax_highlighter);
  3166. }
  3167. int ScriptEditor::script_editor_func_count = 0;
  3168. CreateScriptEditorFunc ScriptEditor::script_editor_funcs[ScriptEditor::SCRIPT_EDITOR_FUNC_MAX];
  3169. void ScriptEditor::register_create_script_editor_function(CreateScriptEditorFunc p_func) {
  3170. ERR_FAIL_COND(script_editor_func_count == SCRIPT_EDITOR_FUNC_MAX);
  3171. script_editor_funcs[script_editor_func_count++] = p_func;
  3172. }
  3173. void ScriptEditor::_script_changed() {
  3174. NodeDock::get_singleton()->update_lists();
  3175. }
  3176. void ScriptEditor::_on_find_in_files_requested(const String &text) {
  3177. find_in_files_dialog->set_find_in_files_mode(FindInFilesDialog::SEARCH_MODE);
  3178. find_in_files_dialog->set_search_text(text);
  3179. find_in_files_dialog->popup_centered();
  3180. }
  3181. void ScriptEditor::_on_replace_in_files_requested(const String &text) {
  3182. find_in_files_dialog->set_find_in_files_mode(FindInFilesDialog::REPLACE_MODE);
  3183. find_in_files_dialog->set_search_text(text);
  3184. find_in_files_dialog->set_replace_text("");
  3185. find_in_files_dialog->popup_centered();
  3186. }
  3187. void ScriptEditor::_on_find_in_files_result_selected(const String &fpath, int line_number, int begin, int end) {
  3188. if (ResourceLoader::exists(fpath)) {
  3189. Ref<Resource> res = ResourceLoader::load(fpath);
  3190. if (fpath.get_extension() == "gdshader") {
  3191. ShaderEditorPlugin *shader_editor = Object::cast_to<ShaderEditorPlugin>(EditorNode::get_editor_data().get_editor_by_name("Shader"));
  3192. shader_editor->edit(res.ptr());
  3193. shader_editor->make_visible(true);
  3194. shader_editor->get_shader_editor(res)->goto_line_selection(line_number - 1, begin, end);
  3195. return;
  3196. } else if (fpath.get_extension() == "tscn") {
  3197. Ref<FileAccess> f = FileAccess::open(fpath, FileAccess::READ);
  3198. bool is_script_found = false;
  3199. // Starting from top of the tscn file.
  3200. int scr_start_line = 1;
  3201. String scr_header = "[sub_resource type=\"GDScript\" id=\"";
  3202. String scr_id = "";
  3203. String line = "";
  3204. int l = 0;
  3205. while (!f->eof_reached()) {
  3206. line = f->get_line();
  3207. l++;
  3208. if (!line.begins_with(scr_header)) {
  3209. continue;
  3210. }
  3211. // Found the end of the script.
  3212. scr_id = line.get_slice(scr_header, 1);
  3213. scr_id = scr_id.get_slice("\"", 0);
  3214. scr_start_line = l + 1;
  3215. int scr_line_count = 0;
  3216. do {
  3217. line = f->get_line();
  3218. l++;
  3219. String strline = line.strip_edges();
  3220. if (strline.ends_with("\"") && !strline.ends_with("\\\"")) {
  3221. // Found the end of script.
  3222. break;
  3223. }
  3224. scr_line_count++;
  3225. } while (!f->eof_reached());
  3226. if (line_number > scr_start_line + scr_line_count) {
  3227. // Find in another built-in GDScript.
  3228. continue;
  3229. }
  3230. // Real line number of the built-in script.
  3231. line_number = line_number - scr_start_line;
  3232. is_script_found = true;
  3233. break;
  3234. }
  3235. EditorNode::get_singleton()->load_scene(fpath);
  3236. if (is_script_found && !scr_id.is_empty()) {
  3237. Ref<Script> scr = ResourceLoader::load(fpath + "::" + scr_id, "Script");
  3238. if (scr.is_valid()) {
  3239. edit(scr);
  3240. ScriptTextEditor *ste = Object::cast_to<ScriptTextEditor>(_get_current_editor());
  3241. if (ste) {
  3242. EditorInterface::get_singleton()->set_main_screen_editor("Script");
  3243. ste->goto_line_selection(line_number, begin, end);
  3244. }
  3245. }
  3246. }
  3247. return;
  3248. } else {
  3249. Ref<Script> scr = res;
  3250. Ref<JSON> json = res;
  3251. if (scr.is_valid() || json.is_valid()) {
  3252. edit(scr);
  3253. ScriptTextEditor *ste = Object::cast_to<ScriptTextEditor>(_get_current_editor());
  3254. if (ste) {
  3255. EditorInterface::get_singleton()->set_main_screen_editor("Script");
  3256. ste->goto_line_selection(line_number - 1, begin, end);
  3257. }
  3258. return;
  3259. }
  3260. }
  3261. }
  3262. // If the file is not a valid resource/script, load it as a text file.
  3263. Error err;
  3264. Ref<TextFile> text_file = _load_text_file(fpath, &err);
  3265. if (text_file.is_valid()) {
  3266. edit(text_file);
  3267. TextEditor *te = Object::cast_to<TextEditor>(_get_current_editor());
  3268. if (te) {
  3269. te->goto_line_selection(line_number - 1, begin, end);
  3270. }
  3271. }
  3272. }
  3273. void ScriptEditor::_start_find_in_files(bool with_replace) {
  3274. FindInFiles *f = find_in_files->get_finder();
  3275. f->set_search_text(find_in_files_dialog->get_search_text());
  3276. f->set_match_case(find_in_files_dialog->is_match_case());
  3277. f->set_whole_words(find_in_files_dialog->is_whole_words());
  3278. f->set_folder(find_in_files_dialog->get_folder());
  3279. f->set_filter(find_in_files_dialog->get_filter());
  3280. find_in_files->set_with_replace(with_replace);
  3281. find_in_files->set_replace_text(find_in_files_dialog->get_replace_text());
  3282. find_in_files->start_search();
  3283. if (find_in_files_button->get_index() != find_in_files_button->get_parent()->get_child_count()) {
  3284. find_in_files_button->get_parent()->move_child(find_in_files_button, -1);
  3285. }
  3286. if (!find_in_files_button->is_visible()) {
  3287. find_in_files_button->show();
  3288. }
  3289. EditorNode::get_bottom_panel()->make_item_visible(find_in_files);
  3290. }
  3291. void ScriptEditor::_on_find_in_files_modified_files(const PackedStringArray &paths) {
  3292. _test_script_times_on_disk();
  3293. _update_modified_scripts_for_external_editor();
  3294. }
  3295. void ScriptEditor::_set_zoom_factor(float p_zoom_factor) {
  3296. if (zoom_factor == p_zoom_factor) {
  3297. return;
  3298. }
  3299. zoom_factor = p_zoom_factor;
  3300. for (int i = 0; i < tab_container->get_tab_count(); i++) {
  3301. ScriptEditorBase *se = Object::cast_to<ScriptEditorBase>(tab_container->get_tab_control(i));
  3302. if (se) {
  3303. CodeTextEditor *cte = se->get_code_editor();
  3304. if (cte) {
  3305. if (zoom_factor != cte->get_zoom_factor()) {
  3306. cte->set_zoom_factor(zoom_factor);
  3307. }
  3308. }
  3309. }
  3310. }
  3311. }
  3312. void ScriptEditor::_on_find_in_files_close_button_clicked() {
  3313. EditorNode::get_bottom_panel()->hide_bottom_panel();
  3314. find_in_files_button->hide();
  3315. }
  3316. void ScriptEditor::_window_changed(bool p_visible) {
  3317. make_floating->set_visible(!p_visible);
  3318. is_floating = p_visible;
  3319. }
  3320. void ScriptEditor::_filter_scripts_text_changed(const String &p_newtext) {
  3321. _update_script_names();
  3322. }
  3323. void ScriptEditor::_filter_methods_text_changed(const String &p_newtext) {
  3324. _update_members_overview();
  3325. }
  3326. void ScriptEditor::_bind_methods() {
  3327. ClassDB::bind_method("_help_tab_goto", &ScriptEditor::_help_tab_goto);
  3328. ClassDB::bind_method("get_current_editor", &ScriptEditor::_get_current_editor);
  3329. ClassDB::bind_method("get_open_script_editors", &ScriptEditor::_get_open_script_editors);
  3330. ClassDB::bind_method(D_METHOD("register_syntax_highlighter", "syntax_highlighter"), &ScriptEditor::register_syntax_highlighter);
  3331. ClassDB::bind_method(D_METHOD("unregister_syntax_highlighter", "syntax_highlighter"), &ScriptEditor::unregister_syntax_highlighter);
  3332. ClassDB::bind_method(D_METHOD("goto_line", "line_number"), &ScriptEditor::_goto_script_line2);
  3333. ClassDB::bind_method(D_METHOD("get_current_script"), &ScriptEditor::_get_current_script);
  3334. ClassDB::bind_method(D_METHOD("get_open_scripts"), &ScriptEditor::_get_open_scripts);
  3335. ClassDB::bind_method(D_METHOD("open_script_create_dialog", "base_name", "base_path"), &ScriptEditor::open_script_create_dialog);
  3336. ClassDB::bind_method(D_METHOD("goto_help", "topic"), &ScriptEditor::goto_help);
  3337. ADD_SIGNAL(MethodInfo("editor_script_changed", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script")));
  3338. ADD_SIGNAL(MethodInfo("script_close", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script")));
  3339. }
  3340. ScriptEditor::ScriptEditor(WindowWrapper *p_wrapper) {
  3341. window_wrapper = p_wrapper;
  3342. current_theme = "";
  3343. script_editor_cache.instantiate();
  3344. script_editor_cache->load(EditorPaths::get_singleton()->get_project_settings_dir().path_join("script_editor_cache.cfg"));
  3345. completion_cache = memnew(EditorScriptCodeCompletionCache);
  3346. restoring_layout = false;
  3347. waiting_update_names = false;
  3348. pending_auto_reload = false;
  3349. auto_reload_running_scripts = true;
  3350. external_editor_active = false;
  3351. members_overview_enabled = EDITOR_GET("text_editor/script_list/show_members_overview");
  3352. help_overview_enabled = EDITOR_GET("text_editor/help/show_help_index");
  3353. VBoxContainer *main_container = memnew(VBoxContainer);
  3354. add_child(main_container);
  3355. menu_hb = memnew(HBoxContainer);
  3356. main_container->add_child(menu_hb);
  3357. script_split = memnew(HSplitContainer);
  3358. main_container->add_child(script_split);
  3359. script_split->set_v_size_flags(SIZE_EXPAND_FILL);
  3360. list_split = memnew(VSplitContainer);
  3361. script_split->add_child(list_split);
  3362. list_split->set_v_size_flags(SIZE_EXPAND_FILL);
  3363. scripts_vbox = memnew(VBoxContainer);
  3364. scripts_vbox->set_v_size_flags(SIZE_EXPAND_FILL);
  3365. list_split->add_child(scripts_vbox);
  3366. filter_scripts = memnew(LineEdit);
  3367. filter_scripts->set_placeholder(TTR("Filter Scripts"));
  3368. filter_scripts->set_clear_button_enabled(true);
  3369. filter_scripts->connect("text_changed", callable_mp(this, &ScriptEditor::_filter_scripts_text_changed));
  3370. scripts_vbox->add_child(filter_scripts);
  3371. script_list = memnew(ItemList);
  3372. script_list->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  3373. scripts_vbox->add_child(script_list);
  3374. script_list->set_custom_minimum_size(Size2(150, 60) * EDSCALE); //need to give a bit of limit to avoid it from disappearing
  3375. script_list->set_v_size_flags(SIZE_EXPAND_FILL);
  3376. script_split->set_split_offset(70 * EDSCALE);
  3377. _sort_list_on_update = true;
  3378. script_list->connect("item_clicked", callable_mp(this, &ScriptEditor::_script_list_clicked), CONNECT_DEFERRED);
  3379. script_list->set_allow_rmb_select(true);
  3380. SET_DRAG_FORWARDING_GCD(script_list, ScriptEditor);
  3381. context_menu = memnew(PopupMenu);
  3382. add_child(context_menu);
  3383. context_menu->connect("id_pressed", callable_mp(this, &ScriptEditor::_menu_option));
  3384. overview_vbox = memnew(VBoxContainer);
  3385. overview_vbox->set_custom_minimum_size(Size2(0, 90));
  3386. overview_vbox->set_v_size_flags(SIZE_EXPAND_FILL);
  3387. list_split->add_child(overview_vbox);
  3388. list_split->set_visible(EditorSettings::get_singleton()->get_project_metadata("scripts_panel", "show_scripts_panel", true));
  3389. buttons_hbox = memnew(HBoxContainer);
  3390. overview_vbox->add_child(buttons_hbox);
  3391. filename = memnew(Label);
  3392. filename->set_clip_text(true);
  3393. filename->set_h_size_flags(SIZE_EXPAND_FILL);
  3394. filename->add_theme_style_override("normal", EditorNode::get_singleton()->get_editor_theme()->get_stylebox(CoreStringName(normal), SNAME("LineEdit")));
  3395. buttons_hbox->add_child(filename);
  3396. members_overview_alphabeta_sort_button = memnew(Button);
  3397. members_overview_alphabeta_sort_button->set_flat(true);
  3398. members_overview_alphabeta_sort_button->set_tooltip_text(TTR("Toggle alphabetical sorting of the method list."));
  3399. members_overview_alphabeta_sort_button->set_toggle_mode(true);
  3400. members_overview_alphabeta_sort_button->set_pressed(EDITOR_GET("text_editor/script_list/sort_members_outline_alphabetically"));
  3401. members_overview_alphabeta_sort_button->connect("toggled", callable_mp(this, &ScriptEditor::_toggle_members_overview_alpha_sort));
  3402. buttons_hbox->add_child(members_overview_alphabeta_sort_button);
  3403. filter_methods = memnew(LineEdit);
  3404. filter_methods->set_placeholder(TTR("Filter Methods"));
  3405. filter_methods->set_clear_button_enabled(true);
  3406. filter_methods->connect("text_changed", callable_mp(this, &ScriptEditor::_filter_methods_text_changed));
  3407. overview_vbox->add_child(filter_methods);
  3408. members_overview = memnew(ItemList);
  3409. members_overview->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  3410. overview_vbox->add_child(members_overview);
  3411. members_overview->set_allow_reselect(true);
  3412. members_overview->set_custom_minimum_size(Size2(0, 60) * EDSCALE); //need to give a bit of limit to avoid it from disappearing
  3413. members_overview->set_v_size_flags(SIZE_EXPAND_FILL);
  3414. members_overview->set_allow_rmb_select(true);
  3415. help_overview = memnew(ItemList);
  3416. help_overview->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  3417. overview_vbox->add_child(help_overview);
  3418. help_overview->set_allow_reselect(true);
  3419. help_overview->set_custom_minimum_size(Size2(0, 60) * EDSCALE); //need to give a bit of limit to avoid it from disappearing
  3420. help_overview->set_v_size_flags(SIZE_EXPAND_FILL);
  3421. VBoxContainer *code_editor_container = memnew(VBoxContainer);
  3422. script_split->add_child(code_editor_container);
  3423. tab_container = memnew(TabContainer);
  3424. tab_container->set_tabs_visible(false);
  3425. tab_container->set_custom_minimum_size(Size2(200, 0) * EDSCALE);
  3426. code_editor_container->add_child(tab_container);
  3427. tab_container->set_h_size_flags(SIZE_EXPAND_FILL);
  3428. tab_container->set_v_size_flags(SIZE_EXPAND_FILL);
  3429. find_replace_bar = memnew(FindReplaceBar);
  3430. code_editor_container->add_child(find_replace_bar);
  3431. find_replace_bar->hide();
  3432. ED_SHORTCUT("script_editor/window_sort", TTR("Sort"));
  3433. ED_SHORTCUT("script_editor/window_move_up", TTR("Move Up"), KeyModifierMask::SHIFT | KeyModifierMask::ALT | Key::UP);
  3434. ED_SHORTCUT("script_editor/window_move_down", TTR("Move Down"), KeyModifierMask::SHIFT | KeyModifierMask::ALT | Key::DOWN);
  3435. // FIXME: These should be `Key::GREATER` and `Key::LESS` but those don't work.
  3436. ED_SHORTCUT("script_editor/next_script", TTR("Next Script"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::PERIOD);
  3437. ED_SHORTCUT("script_editor/prev_script", TTR("Previous Script"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::COMMA);
  3438. set_process_input(true);
  3439. set_process_shortcut_input(true);
  3440. file_menu = memnew(MenuButton);
  3441. file_menu->set_text(TTR("File"));
  3442. file_menu->set_switch_on_hover(true);
  3443. file_menu->set_shortcut_context(this);
  3444. menu_hb->add_child(file_menu);
  3445. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/new", TTR("New Script..."), KeyModifierMask::CMD_OR_CTRL | Key::N), FILE_NEW);
  3446. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/new_textfile", TTR("New Text File..."), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::N), FILE_NEW_TEXTFILE);
  3447. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/open", TTR("Open...")), FILE_OPEN);
  3448. file_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_editor/reopen_closed_script"), FILE_REOPEN_CLOSED);
  3449. recent_scripts = memnew(PopupMenu);
  3450. file_menu->get_popup()->add_submenu_node_item(TTR("Open Recent"), recent_scripts, FILE_OPEN_RECENT);
  3451. recent_scripts->connect("id_pressed", callable_mp(this, &ScriptEditor::_open_recent_script));
  3452. _update_recent_scripts();
  3453. file_menu->get_popup()->add_separator();
  3454. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/save", TTR("Save"), KeyModifierMask::ALT | KeyModifierMask::CMD_OR_CTRL | Key::S), FILE_SAVE);
  3455. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/save_as", TTR("Save As...")), FILE_SAVE_AS);
  3456. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/save_all", TTR("Save All"), KeyModifierMask::SHIFT | KeyModifierMask::ALT | Key::S), FILE_SAVE_ALL);
  3457. ED_SHORTCUT_OVERRIDE("script_editor/save_all", "macos", KeyModifierMask::META | KeyModifierMask::CTRL | Key::S);
  3458. file_menu->get_popup()->add_separator();
  3459. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/reload_script_soft", TTR("Soft Reload Tool Script"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::ALT | Key::R), FILE_TOOL_RELOAD_SOFT);
  3460. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/copy_path", TTR("Copy Script Path")), FILE_COPY_PATH);
  3461. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/show_in_file_system", TTR("Show in FileSystem")), SHOW_IN_FILE_SYSTEM);
  3462. file_menu->get_popup()->add_separator();
  3463. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/history_previous", TTR("History Previous"), KeyModifierMask::ALT | Key::LEFT), WINDOW_PREV);
  3464. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/history_next", TTR("History Next"), KeyModifierMask::ALT | Key::RIGHT), WINDOW_NEXT);
  3465. ED_SHORTCUT_OVERRIDE("script_editor/history_previous", "macos", KeyModifierMask::ALT | KeyModifierMask::META | Key::LEFT);
  3466. ED_SHORTCUT_OVERRIDE("script_editor/history_next", "macos", KeyModifierMask::ALT | KeyModifierMask::META | Key::RIGHT);
  3467. file_menu->get_popup()->add_separator();
  3468. theme_submenu = memnew(PopupMenu);
  3469. theme_submenu->add_shortcut(ED_SHORTCUT("script_editor/import_theme", TTR("Import Theme...")), THEME_IMPORT);
  3470. theme_submenu->add_shortcut(ED_SHORTCUT("script_editor/reload_theme", TTR("Reload Theme")), THEME_RELOAD);
  3471. file_menu->get_popup()->add_submenu_node_item(TTR("Theme"), theme_submenu, FILE_THEME);
  3472. theme_submenu->connect("id_pressed", callable_mp(this, &ScriptEditor::_theme_option));
  3473. theme_submenu->add_separator();
  3474. theme_submenu->add_shortcut(ED_SHORTCUT("script_editor/save_theme", TTR("Save Theme")), THEME_SAVE);
  3475. theme_submenu->add_shortcut(ED_SHORTCUT("script_editor/save_theme_as", TTR("Save Theme As...")), THEME_SAVE_AS);
  3476. file_menu->get_popup()->add_separator();
  3477. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/close_file", TTR("Close"), KeyModifierMask::CMD_OR_CTRL | Key::W), FILE_CLOSE);
  3478. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/close_all", TTR("Close All")), CLOSE_ALL);
  3479. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/close_other_tabs", TTR("Close Other Tabs")), CLOSE_OTHER_TABS);
  3480. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/close_docs", TTR("Close Docs")), CLOSE_DOCS);
  3481. file_menu->get_popup()->add_separator();
  3482. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/run_file", TTR("Run"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::X), FILE_RUN);
  3483. file_menu->get_popup()->add_separator();
  3484. file_menu->get_popup()->add_shortcut(ED_SHORTCUT("script_editor/toggle_scripts_panel", TTR("Toggle Scripts Panel"), KeyModifierMask::CMD_OR_CTRL | Key::BACKSLASH), TOGGLE_SCRIPTS_PANEL);
  3485. file_menu->get_popup()->connect("id_pressed", callable_mp(this, &ScriptEditor::_menu_option));
  3486. file_menu->get_popup()->connect("about_to_popup", callable_mp(this, &ScriptEditor::_prepare_file_menu));
  3487. file_menu->get_popup()->connect("popup_hide", callable_mp(this, &ScriptEditor::_file_menu_closed));
  3488. script_search_menu = memnew(MenuButton);
  3489. script_search_menu->set_text(TTR("Search"));
  3490. script_search_menu->set_switch_on_hover(true);
  3491. script_search_menu->set_shortcut_context(this);
  3492. script_search_menu->get_popup()->connect("id_pressed", callable_mp(this, &ScriptEditor::_menu_option));
  3493. menu_hb->add_child(script_search_menu);
  3494. MenuButton *debug_menu_btn = memnew(MenuButton);
  3495. menu_hb->add_child(debug_menu_btn);
  3496. debug_menu_btn->hide(); // Handled by EditorDebuggerNode below.
  3497. EditorDebuggerNode *debugger = EditorDebuggerNode::get_singleton();
  3498. debugger->set_script_debug_button(debug_menu_btn);
  3499. debugger->connect("goto_script_line", callable_mp(this, &ScriptEditor::_goto_script_line));
  3500. debugger->connect("set_execution", callable_mp(this, &ScriptEditor::_set_execution));
  3501. debugger->connect("clear_execution", callable_mp(this, &ScriptEditor::_clear_execution));
  3502. debugger->connect("breaked", callable_mp(this, &ScriptEditor::_breaked));
  3503. debugger->connect("breakpoint_set_in_tree", callable_mp(this, &ScriptEditor::_set_breakpoint));
  3504. debugger->connect("breakpoints_cleared_in_tree", callable_mp(this, &ScriptEditor::_clear_breakpoints));
  3505. menu_hb->add_spacer();
  3506. script_icon = memnew(TextureRect);
  3507. menu_hb->add_child(script_icon);
  3508. script_name_label = memnew(Label);
  3509. menu_hb->add_child(script_name_label);
  3510. script_icon->hide();
  3511. script_name_label->hide();
  3512. menu_hb->add_spacer();
  3513. site_search = memnew(Button);
  3514. site_search->set_flat(true);
  3515. site_search->connect(SceneStringName(pressed), callable_mp(this, &ScriptEditor::_menu_option).bind(SEARCH_WEBSITE));
  3516. menu_hb->add_child(site_search);
  3517. help_search = memnew(Button);
  3518. help_search->set_flat(true);
  3519. help_search->set_text(TTR("Search Help"));
  3520. help_search->connect(SceneStringName(pressed), callable_mp(this, &ScriptEditor::_menu_option).bind(SEARCH_HELP));
  3521. menu_hb->add_child(help_search);
  3522. help_search->set_tooltip_text(TTR("Search the reference documentation."));
  3523. menu_hb->add_child(memnew(VSeparator));
  3524. script_back = memnew(Button);
  3525. script_back->set_flat(true);
  3526. script_back->connect(SceneStringName(pressed), callable_mp(this, &ScriptEditor::_history_back));
  3527. menu_hb->add_child(script_back);
  3528. script_back->set_disabled(true);
  3529. script_back->set_tooltip_text(TTR("Go to previous edited document."));
  3530. script_forward = memnew(Button);
  3531. script_forward->set_flat(true);
  3532. script_forward->connect(SceneStringName(pressed), callable_mp(this, &ScriptEditor::_history_forward));
  3533. menu_hb->add_child(script_forward);
  3534. script_forward->set_disabled(true);
  3535. script_forward->set_tooltip_text(TTR("Go to next edited document."));
  3536. menu_hb->add_child(memnew(VSeparator));
  3537. make_floating = memnew(ScreenSelect);
  3538. make_floating->set_flat(true);
  3539. make_floating->connect("request_open_in_screen", callable_mp(window_wrapper, &WindowWrapper::enable_window_on_screen).bind(true));
  3540. if (!make_floating->is_disabled()) {
  3541. // Override default ScreenSelect tooltip if multi-window support is available.
  3542. make_floating->set_tooltip_text(TTR("Make the script editor floating."));
  3543. }
  3544. menu_hb->add_child(make_floating);
  3545. p_wrapper->connect("window_visibility_changed", callable_mp(this, &ScriptEditor::_window_changed));
  3546. tab_container->connect("tab_changed", callable_mp(this, &ScriptEditor::_tab_changed));
  3547. erase_tab_confirm = memnew(ConfirmationDialog);
  3548. erase_tab_confirm->set_ok_button_text(TTR("Save"));
  3549. erase_tab_confirm->add_button(TTR("Discard"), DisplayServer::get_singleton()->get_swap_cancel_ok(), "discard");
  3550. erase_tab_confirm->connect("confirmed", callable_mp(this, &ScriptEditor::_close_current_tab).bind(true, true));
  3551. erase_tab_confirm->connect("custom_action", callable_mp(this, &ScriptEditor::_close_discard_current_tab));
  3552. add_child(erase_tab_confirm);
  3553. script_create_dialog = memnew(ScriptCreateDialog);
  3554. script_create_dialog->set_title(TTR("Create Script"));
  3555. add_child(script_create_dialog);
  3556. script_create_dialog->connect("script_created", callable_mp(this, &ScriptEditor::_script_created));
  3557. file_dialog_option = -1;
  3558. file_dialog = memnew(EditorFileDialog);
  3559. add_child(file_dialog);
  3560. file_dialog->connect("file_selected", callable_mp(this, &ScriptEditor::_file_dialog_action));
  3561. error_dialog = memnew(AcceptDialog);
  3562. add_child(error_dialog);
  3563. disk_changed = memnew(ConfirmationDialog);
  3564. {
  3565. VBoxContainer *vbc = memnew(VBoxContainer);
  3566. disk_changed->add_child(vbc);
  3567. Label *dl = memnew(Label);
  3568. dl->set_text(TTR("The following files are newer on disk.\nWhat action should be taken?:"));
  3569. vbc->add_child(dl);
  3570. disk_changed_list = memnew(Tree);
  3571. vbc->add_child(disk_changed_list);
  3572. disk_changed_list->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  3573. disk_changed_list->set_v_size_flags(SIZE_EXPAND_FILL);
  3574. disk_changed->connect("confirmed", callable_mp(this, &ScriptEditor::reload_scripts).bind(false));
  3575. disk_changed->set_ok_button_text(TTR("Reload"));
  3576. disk_changed->add_button(TTR("Resave"), !DisplayServer::get_singleton()->get_swap_cancel_ok(), "resave");
  3577. disk_changed->connect("custom_action", callable_mp(this, &ScriptEditor::_resave_scripts));
  3578. }
  3579. add_child(disk_changed);
  3580. script_editor = this;
  3581. autosave_timer = memnew(Timer);
  3582. autosave_timer->set_one_shot(false);
  3583. autosave_timer->connect(SceneStringName(tree_entered), callable_mp(this, &ScriptEditor::_update_autosave_timer));
  3584. autosave_timer->connect("timeout", callable_mp(this, &ScriptEditor::_autosave_scripts));
  3585. add_child(autosave_timer);
  3586. grab_focus_block = false;
  3587. help_search_dialog = memnew(EditorHelpSearch);
  3588. add_child(help_search_dialog);
  3589. help_search_dialog->connect("go_to_help", callable_mp(this, &ScriptEditor::_help_class_goto));
  3590. find_in_files_dialog = memnew(FindInFilesDialog);
  3591. find_in_files_dialog->connect(FindInFilesDialog::SIGNAL_FIND_REQUESTED, callable_mp(this, &ScriptEditor::_start_find_in_files).bind(false));
  3592. find_in_files_dialog->connect(FindInFilesDialog::SIGNAL_REPLACE_REQUESTED, callable_mp(this, &ScriptEditor::_start_find_in_files).bind(true));
  3593. add_child(find_in_files_dialog);
  3594. find_in_files = memnew(FindInFilesPanel);
  3595. find_in_files_button = EditorNode::get_bottom_panel()->add_item(TTR("Search Results"), find_in_files, ED_SHORTCUT_AND_COMMAND("bottom_panels/toggle_search_results_bottom_panel", TTR("Toggle Search Results Bottom Panel")));
  3596. find_in_files->set_custom_minimum_size(Size2(0, 200) * EDSCALE);
  3597. find_in_files->connect(FindInFilesPanel::SIGNAL_RESULT_SELECTED, callable_mp(this, &ScriptEditor::_on_find_in_files_result_selected));
  3598. find_in_files->connect(FindInFilesPanel::SIGNAL_FILES_MODIFIED, callable_mp(this, &ScriptEditor::_on_find_in_files_modified_files));
  3599. find_in_files->connect(FindInFilesPanel::SIGNAL_CLOSE_BUTTON_CLICKED, callable_mp(this, &ScriptEditor::_on_find_in_files_close_button_clicked));
  3600. find_in_files->hide();
  3601. find_in_files_button->hide();
  3602. history_pos = -1;
  3603. edit_pass = 0;
  3604. trim_trailing_whitespace_on_save = EDITOR_GET("text_editor/behavior/files/trim_trailing_whitespace_on_save");
  3605. convert_indent_on_save = EDITOR_GET("text_editor/behavior/files/convert_indent_on_save");
  3606. ScriptServer::edit_request_func = _open_script_request;
  3607. Ref<EditorJSONSyntaxHighlighter> json_syntax_highlighter;
  3608. json_syntax_highlighter.instantiate();
  3609. register_syntax_highlighter(json_syntax_highlighter);
  3610. _update_online_doc();
  3611. }
  3612. ScriptEditor::~ScriptEditor() {
  3613. memdelete(completion_cache);
  3614. }
  3615. void ScriptEditorPlugin::_focus_another_editor() {
  3616. if (window_wrapper->get_window_enabled()) {
  3617. ERR_FAIL_COND(last_editor.is_empty());
  3618. EditorInterface::get_singleton()->set_main_screen_editor(last_editor);
  3619. }
  3620. }
  3621. void ScriptEditorPlugin::_save_last_editor(const String &p_editor) {
  3622. if (p_editor != get_name()) {
  3623. last_editor = p_editor;
  3624. }
  3625. }
  3626. void ScriptEditorPlugin::_window_visibility_changed(bool p_visible) {
  3627. _focus_another_editor();
  3628. if (p_visible) {
  3629. script_editor->add_theme_style_override("panel", script_editor->get_theme_stylebox("ScriptEditorPanelFloating", EditorStringName(EditorStyles)));
  3630. } else {
  3631. script_editor->add_theme_style_override("panel", script_editor->get_theme_stylebox("ScriptEditorPanel", EditorStringName(EditorStyles)));
  3632. }
  3633. }
  3634. void ScriptEditorPlugin::_notification(int p_what) {
  3635. switch (p_what) {
  3636. case NOTIFICATION_ENTER_TREE: {
  3637. connect("main_screen_changed", callable_mp(this, &ScriptEditorPlugin::_save_last_editor));
  3638. } break;
  3639. case NOTIFICATION_EXIT_TREE: {
  3640. disconnect("main_screen_changed", callable_mp(this, &ScriptEditorPlugin::_save_last_editor));
  3641. } break;
  3642. }
  3643. }
  3644. void ScriptEditorPlugin::edit(Object *p_object) {
  3645. if (Object::cast_to<Script>(p_object)) {
  3646. Script *p_script = Object::cast_to<Script>(p_object);
  3647. String res_path = p_script->get_path().get_slice("::", 0);
  3648. if (p_script->is_built_in() && !res_path.is_empty()) {
  3649. if (ResourceLoader::get_resource_type(res_path) == "PackedScene") {
  3650. if (!EditorNode::get_singleton()->is_scene_open(res_path)) {
  3651. EditorNode::get_singleton()->load_scene(res_path);
  3652. }
  3653. } else {
  3654. EditorNode::get_singleton()->load_resource(res_path);
  3655. }
  3656. }
  3657. script_editor->edit(p_script);
  3658. } else if (Object::cast_to<JSON>(p_object)) {
  3659. script_editor->edit(Object::cast_to<JSON>(p_object));
  3660. } else if (Object::cast_to<TextFile>(p_object)) {
  3661. script_editor->edit(Object::cast_to<TextFile>(p_object));
  3662. }
  3663. }
  3664. bool ScriptEditorPlugin::handles(Object *p_object) const {
  3665. if (Object::cast_to<TextFile>(p_object)) {
  3666. return true;
  3667. }
  3668. if (Object::cast_to<Script>(p_object)) {
  3669. return true;
  3670. }
  3671. if (Object::cast_to<JSON>(p_object)) {
  3672. return true;
  3673. }
  3674. return p_object->is_class("Script");
  3675. }
  3676. void ScriptEditorPlugin::make_visible(bool p_visible) {
  3677. if (p_visible) {
  3678. window_wrapper->show();
  3679. script_editor->set_process(true);
  3680. script_editor->ensure_select_current();
  3681. } else {
  3682. window_wrapper->hide();
  3683. if (!window_wrapper->get_window_enabled()) {
  3684. script_editor->set_process(false);
  3685. }
  3686. }
  3687. }
  3688. void ScriptEditorPlugin::selected_notify() {
  3689. script_editor->ensure_select_current();
  3690. _focus_another_editor();
  3691. }
  3692. String ScriptEditorPlugin::get_unsaved_status(const String &p_for_scene) const {
  3693. const PackedStringArray unsaved_scripts = script_editor->get_unsaved_scripts();
  3694. if (unsaved_scripts.is_empty()) {
  3695. return String();
  3696. }
  3697. PackedStringArray message;
  3698. if (!p_for_scene.is_empty()) {
  3699. PackedStringArray unsaved_built_in_scripts;
  3700. const String scene_file = p_for_scene.get_file();
  3701. for (const String &E : unsaved_scripts) {
  3702. if (!E.is_resource_file() && E.contains(scene_file)) {
  3703. unsaved_built_in_scripts.append(E);
  3704. }
  3705. }
  3706. if (unsaved_built_in_scripts.is_empty()) {
  3707. return String();
  3708. } else {
  3709. message.resize(unsaved_built_in_scripts.size() + 1);
  3710. message.write[0] = TTR("There are unsaved changes in the following built-in script(s):");
  3711. int i = 1;
  3712. for (const String &E : unsaved_built_in_scripts) {
  3713. message.write[i] = E.trim_suffix("(*)");
  3714. i++;
  3715. }
  3716. return String("\n").join(message);
  3717. }
  3718. }
  3719. message.resize(unsaved_scripts.size() + 1);
  3720. message.write[0] = TTR("Save changes to the following script(s) before quitting?");
  3721. int i = 1;
  3722. for (const String &E : unsaved_scripts) {
  3723. message.write[i] = E.trim_suffix("(*)");
  3724. i++;
  3725. }
  3726. return String("\n").join(message);
  3727. }
  3728. void ScriptEditorPlugin::save_external_data() {
  3729. if (!EditorNode::get_singleton()->is_exiting()) {
  3730. script_editor->save_all_scripts();
  3731. }
  3732. }
  3733. void ScriptEditorPlugin::apply_changes() {
  3734. script_editor->apply_scripts();
  3735. }
  3736. void ScriptEditorPlugin::set_window_layout(Ref<ConfigFile> p_layout) {
  3737. script_editor->set_window_layout(p_layout);
  3738. if (EDITOR_GET("interface/multi_window/restore_windows_on_load") && window_wrapper->is_window_available() && p_layout->has_section_key("ScriptEditor", "window_rect")) {
  3739. window_wrapper->restore_window_from_saved_position(
  3740. p_layout->get_value("ScriptEditor", "window_rect", Rect2i()),
  3741. p_layout->get_value("ScriptEditor", "window_screen", -1),
  3742. p_layout->get_value("ScriptEditor", "window_screen_rect", Rect2i()));
  3743. } else {
  3744. window_wrapper->set_window_enabled(false);
  3745. }
  3746. }
  3747. void ScriptEditorPlugin::get_window_layout(Ref<ConfigFile> p_layout) {
  3748. script_editor->get_window_layout(p_layout);
  3749. if (window_wrapper->get_window_enabled()) {
  3750. p_layout->set_value("ScriptEditor", "window_rect", window_wrapper->get_window_rect());
  3751. int screen = window_wrapper->get_window_screen();
  3752. p_layout->set_value("ScriptEditor", "window_screen", screen);
  3753. p_layout->set_value("ScriptEditor", "window_screen_rect", DisplayServer::get_singleton()->screen_get_usable_rect(screen));
  3754. } else {
  3755. if (p_layout->has_section_key("ScriptEditor", "window_rect")) {
  3756. p_layout->erase_section_key("ScriptEditor", "window_rect");
  3757. }
  3758. if (p_layout->has_section_key("ScriptEditor", "window_screen")) {
  3759. p_layout->erase_section_key("ScriptEditor", "window_screen");
  3760. }
  3761. if (p_layout->has_section_key("ScriptEditor", "window_screen_rect")) {
  3762. p_layout->erase_section_key("ScriptEditor", "window_screen_rect");
  3763. }
  3764. }
  3765. }
  3766. void ScriptEditorPlugin::get_breakpoints(List<String> *p_breakpoints) {
  3767. script_editor->get_breakpoints(p_breakpoints);
  3768. }
  3769. void ScriptEditorPlugin::edited_scene_changed() {
  3770. script_editor->edited_scene_changed();
  3771. }
  3772. ScriptEditorPlugin::ScriptEditorPlugin() {
  3773. ED_SHORTCUT("script_editor/reopen_closed_script", TTR("Reopen Closed Script"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::T);
  3774. ED_SHORTCUT("script_editor/clear_recent", TTR("Clear Recent Scripts"));
  3775. ED_SHORTCUT("script_editor/find_in_files", TTR("Find in Files"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::F);
  3776. ED_SHORTCUT("script_editor/replace_in_files", TTR("Replace in Files"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::R);
  3777. ED_SHORTCUT("script_text_editor/convert_to_uppercase", TTR("Uppercase"), KeyModifierMask::SHIFT | Key::F4);
  3778. ED_SHORTCUT("script_text_editor/convert_to_lowercase", TTR("Lowercase"), KeyModifierMask::SHIFT | Key::F5);
  3779. ED_SHORTCUT("script_text_editor/capitalize", TTR("Capitalize"), KeyModifierMask::SHIFT | Key::F6);
  3780. window_wrapper = memnew(WindowWrapper);
  3781. window_wrapper->set_window_title(vformat(TTR("%s - Godot Engine"), TTR("Script Editor")));
  3782. window_wrapper->set_margins_enabled(true);
  3783. script_editor = memnew(ScriptEditor(window_wrapper));
  3784. Ref<Shortcut> make_floating_shortcut = ED_SHORTCUT_AND_COMMAND("script_editor/make_floating", TTR("Make Floating"));
  3785. window_wrapper->set_wrapped_control(script_editor, make_floating_shortcut);
  3786. EditorNode::get_singleton()->get_main_screen_control()->add_child(window_wrapper);
  3787. window_wrapper->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  3788. window_wrapper->hide();
  3789. window_wrapper->connect("window_visibility_changed", callable_mp(this, &ScriptEditorPlugin::_window_visibility_changed));
  3790. EDITOR_GET("text_editor/behavior/files/auto_reload_scripts_on_external_change");
  3791. ScriptServer::set_reload_scripts_on_save(EDITOR_DEF("text_editor/behavior/files/auto_reload_and_parse_scripts_on_save", true));
  3792. EDITOR_DEF("text_editor/behavior/files/open_dominant_script_on_scene_change", false);
  3793. EDITOR_DEF("text_editor/external/use_external_editor", false);
  3794. EDITOR_DEF("text_editor/external/exec_path", "");
  3795. EDITOR_DEF("text_editor/script_list/script_temperature_enabled", true);
  3796. EDITOR_DEF("text_editor/script_list/script_temperature_history_size", 15);
  3797. EDITOR_DEF("text_editor/script_list/group_help_pages", true);
  3798. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::INT, "text_editor/script_list/sort_scripts_by", PROPERTY_HINT_ENUM, "Name,Path,None"));
  3799. EDITOR_DEF("text_editor/script_list/sort_scripts_by", 0);
  3800. 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"));
  3801. EDITOR_DEF("text_editor/script_list/list_script_names_as", 0);
  3802. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "text_editor/external/exec_path", PROPERTY_HINT_GLOBAL_FILE));
  3803. EDITOR_DEF("text_editor/external/exec_flags", "{file}");
  3804. 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}."));
  3805. }
  3806. ScriptEditorPlugin::~ScriptEditorPlugin() {
  3807. }