script_editor_plugin.cpp 151 KB

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