script_editor_plugin.cpp 134 KB

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