script_editor_plugin.cpp 152 KB

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