script_editor_plugin.cpp 143 KB

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