script_editor_plugin.cpp 130 KB

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