script_editor_plugin.cpp 152 KB

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