script_editor_plugin.cpp 120 KB

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