script_editor_plugin.cpp 150 KB

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