script_editor_plugin.cpp 134 KB

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