script_editor_plugin.cpp 137 KB

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