script_editor_plugin.cpp 143 KB

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