script_editor_plugin.cpp 154 KB

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