script_editor_plugin.cpp 133 KB

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