script_editor_plugin.cpp 153 KB

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