script_editor_plugin.cpp 155 KB

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