script_editor_plugin.cpp 119 KB

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