script_editor_plugin.cpp 120 KB

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