script_editor_plugin.cpp 152 KB

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