script_editor_plugin.cpp 120 KB

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