script_editor_plugin.cpp 156 KB

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