script_editor_plugin.cpp 134 KB

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