script_editor_plugin.cpp 155 KB

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