script_editor_plugin.cpp 121 KB

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