script_editor_plugin.cpp 144 KB

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