script_editor_plugin.cpp 144 KB

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