script_editor_plugin.cpp 162 KB

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