2
0

script_editor_plugin.cpp 160 KB

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