script_editor_plugin.cpp 128 KB

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