script_editor_plugin.cpp 151 KB

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