script_editor_plugin.cpp 141 KB

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