script_editor_plugin.cpp 161 KB

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