script_editor_plugin.cpp 155 KB

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