script_editor_plugin.cpp 128 KB

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