script_editor_plugin.cpp 132 KB

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