script_editor_plugin.cpp 129 KB

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