script_editor_plugin.cpp 133 KB

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