script_editor_plugin.cpp 147 KB

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