script_editor_plugin.cpp 119 KB

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