script_editor_plugin.cpp 117 KB

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