script_editor_plugin.cpp 144 KB

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