script_editor_plugin.cpp 134 KB

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