script_editor_plugin.cpp 116 KB

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