script_editor_plugin.cpp 154 KB

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