script_editor_plugin.cpp 145 KB

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