script_editor_plugin.cpp 155 KB

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