script_editor_plugin.cpp 133 KB

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