script_editor_plugin.cpp 132 KB

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