script_editor_plugin.cpp 137 KB

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