script_text_editor.cpp 84 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349
  1. /**************************************************************************/
  2. /* script_text_editor.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  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_text_editor.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/math/expression.h"
  33. #include "core/os/keyboard.h"
  34. #include "editor/debugger/editor_debugger_node.h"
  35. #include "editor/editor_command_palette.h"
  36. #include "editor/editor_node.h"
  37. #include "editor/editor_scale.h"
  38. #include "editor/editor_settings.h"
  39. #include "scene/gui/rich_text_label.h"
  40. #include "scene/gui/split_container.h"
  41. void ConnectionInfoDialog::ok_pressed() {
  42. }
  43. void ConnectionInfoDialog::popup_connections(String p_method, Vector<Node *> p_nodes) {
  44. method->set_text(p_method);
  45. tree->clear();
  46. TreeItem *root = tree->create_item();
  47. for (int i = 0; i < p_nodes.size(); i++) {
  48. List<Connection> all_connections;
  49. p_nodes[i]->get_signals_connected_to_this(&all_connections);
  50. for (const Connection &connection : all_connections) {
  51. if (connection.callable.get_method() != p_method) {
  52. continue;
  53. }
  54. TreeItem *node_item = tree->create_item(root);
  55. node_item->set_text(0, Object::cast_to<Node>(connection.signal.get_object())->get_name());
  56. node_item->set_icon(0, EditorNode::get_singleton()->get_object_icon(connection.signal.get_object(), "Node"));
  57. node_item->set_selectable(0, false);
  58. node_item->set_editable(0, false);
  59. node_item->set_text(1, connection.signal.get_name());
  60. Control *p = Object::cast_to<Control>(get_parent());
  61. node_item->set_icon(1, p->get_theme_icon(SNAME("Slot"), SNAME("EditorIcons")));
  62. node_item->set_selectable(1, false);
  63. node_item->set_editable(1, false);
  64. node_item->set_text(2, Object::cast_to<Node>(connection.callable.get_object())->get_name());
  65. node_item->set_icon(2, EditorNode::get_singleton()->get_object_icon(connection.callable.get_object(), "Node"));
  66. node_item->set_selectable(2, false);
  67. node_item->set_editable(2, false);
  68. }
  69. }
  70. popup_centered(Size2(600, 300) * EDSCALE);
  71. }
  72. ConnectionInfoDialog::ConnectionInfoDialog() {
  73. set_title(TTR("Connections to method:"));
  74. VBoxContainer *vbc = memnew(VBoxContainer);
  75. vbc->set_anchor_and_offset(SIDE_LEFT, Control::ANCHOR_BEGIN, 8 * EDSCALE);
  76. vbc->set_anchor_and_offset(SIDE_TOP, Control::ANCHOR_BEGIN, 8 * EDSCALE);
  77. vbc->set_anchor_and_offset(SIDE_RIGHT, Control::ANCHOR_END, -8 * EDSCALE);
  78. vbc->set_anchor_and_offset(SIDE_BOTTOM, Control::ANCHOR_END, -8 * EDSCALE);
  79. add_child(vbc);
  80. method = memnew(Label);
  81. method->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_CENTER);
  82. vbc->add_child(method);
  83. tree = memnew(Tree);
  84. tree->set_columns(3);
  85. tree->set_hide_root(true);
  86. tree->set_column_titles_visible(true);
  87. tree->set_column_title(0, TTR("Source"));
  88. tree->set_column_title(1, TTR("Signal"));
  89. tree->set_column_title(2, TTR("Target"));
  90. vbc->add_child(tree);
  91. tree->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  92. tree->set_allow_rmb_select(true);
  93. }
  94. ////////////////////////////////////////////////////////////////////////////////
  95. Vector<String> ScriptTextEditor::get_functions() {
  96. CodeEdit *te = code_editor->get_text_editor();
  97. String text = te->get_text();
  98. List<String> fnc;
  99. if (script->get_language()->validate(text, script->get_path(), &fnc)) {
  100. //if valid rewrite functions to latest
  101. functions.clear();
  102. for (const String &E : fnc) {
  103. functions.push_back(E);
  104. }
  105. }
  106. return functions;
  107. }
  108. void ScriptTextEditor::apply_code() {
  109. if (script.is_null()) {
  110. return;
  111. }
  112. script->set_source_code(code_editor->get_text_editor()->get_text());
  113. script->update_exports();
  114. code_editor->get_text_editor()->get_syntax_highlighter()->update_cache();
  115. }
  116. Ref<Resource> ScriptTextEditor::get_edited_resource() const {
  117. return script;
  118. }
  119. void ScriptTextEditor::set_edited_resource(const Ref<Resource> &p_res) {
  120. ERR_FAIL_COND(script.is_valid());
  121. ERR_FAIL_COND(p_res.is_null());
  122. script = p_res;
  123. code_editor->get_text_editor()->set_text(script->get_source_code());
  124. code_editor->get_text_editor()->clear_undo_history();
  125. code_editor->get_text_editor()->tag_saved_version();
  126. emit_signal(SNAME("name_changed"));
  127. code_editor->update_line_and_column();
  128. }
  129. void ScriptTextEditor::enable_editor(Control *p_shortcut_context) {
  130. if (editor_enabled) {
  131. return;
  132. }
  133. editor_enabled = true;
  134. _enable_code_editor();
  135. _validate_script();
  136. if (p_shortcut_context) {
  137. for (int i = 0; i < edit_hb->get_child_count(); ++i) {
  138. Control *c = cast_to<Control>(edit_hb->get_child(i));
  139. if (c) {
  140. c->set_shortcut_context(p_shortcut_context);
  141. }
  142. }
  143. }
  144. }
  145. void ScriptTextEditor::_load_theme_settings() {
  146. CodeEdit *text_edit = code_editor->get_text_editor();
  147. Color updated_marked_line_color = EDITOR_GET("text_editor/theme/highlighting/mark_color");
  148. Color updated_safe_line_number_color = EDITOR_GET("text_editor/theme/highlighting/safe_line_number_color");
  149. bool safe_line_number_color_updated = updated_safe_line_number_color != safe_line_number_color;
  150. bool marked_line_color_updated = updated_marked_line_color != marked_line_color;
  151. if (safe_line_number_color_updated || marked_line_color_updated) {
  152. safe_line_number_color = updated_safe_line_number_color;
  153. for (int i = 0; i < text_edit->get_line_count(); i++) {
  154. if (marked_line_color_updated && text_edit->get_line_background_color(i) == marked_line_color) {
  155. text_edit->set_line_background_color(i, updated_marked_line_color);
  156. }
  157. if (safe_line_number_color_updated && text_edit->get_line_gutter_item_color(i, line_number_gutter) != default_line_number_color) {
  158. text_edit->set_line_gutter_item_color(i, line_number_gutter, safe_line_number_color);
  159. }
  160. }
  161. marked_line_color = updated_marked_line_color;
  162. }
  163. theme_loaded = true;
  164. if (!script.is_null()) {
  165. _set_theme_for_script();
  166. }
  167. }
  168. void ScriptTextEditor::_set_theme_for_script() {
  169. if (!theme_loaded) {
  170. return;
  171. }
  172. CodeEdit *text_edit = code_editor->get_text_editor();
  173. text_edit->get_syntax_highlighter()->update_cache();
  174. List<String> strings;
  175. script->get_language()->get_string_delimiters(&strings);
  176. text_edit->clear_string_delimiters();
  177. for (const String &string : strings) {
  178. String beg = string.get_slice(" ", 0);
  179. String end = string.get_slice_count(" ") > 1 ? string.get_slice(" ", 1) : String();
  180. if (!text_edit->has_string_delimiter(beg)) {
  181. text_edit->add_string_delimiter(beg, end, end.is_empty());
  182. }
  183. if (!end.is_empty() && !text_edit->has_auto_brace_completion_open_key(beg)) {
  184. text_edit->add_auto_brace_completion_pair(beg, end);
  185. }
  186. }
  187. List<String> comments;
  188. script->get_language()->get_comment_delimiters(&comments);
  189. text_edit->clear_comment_delimiters();
  190. for (const String &comment : comments) {
  191. String beg = comment.get_slice(" ", 0);
  192. String end = comment.get_slice_count(" ") > 1 ? comment.get_slice(" ", 1) : String();
  193. text_edit->add_comment_delimiter(beg, end, end.is_empty());
  194. if (!end.is_empty() && !text_edit->has_auto_brace_completion_open_key(beg)) {
  195. text_edit->add_auto_brace_completion_pair(beg, end);
  196. }
  197. }
  198. }
  199. void ScriptTextEditor::_show_errors_panel(bool p_show) {
  200. errors_panel->set_visible(p_show);
  201. }
  202. void ScriptTextEditor::_show_warnings_panel(bool p_show) {
  203. warnings_panel->set_visible(p_show);
  204. }
  205. void ScriptTextEditor::_warning_clicked(Variant p_line) {
  206. if (p_line.get_type() == Variant::INT) {
  207. goto_line_centered(p_line.operator int64_t());
  208. } else if (p_line.get_type() == Variant::DICTIONARY) {
  209. Dictionary meta = p_line.operator Dictionary();
  210. const int line = meta["line"].operator int64_t() - 1;
  211. const String code = meta["code"].operator String();
  212. const String quote_style = EDITOR_GET("text_editor/completion/use_single_quotes") ? "'" : "\"";
  213. CodeEdit *text_editor = code_editor->get_text_editor();
  214. String prev_line = line > 0 ? text_editor->get_line(line - 1) : "";
  215. if (prev_line.contains("@warning_ignore")) {
  216. const int closing_bracket_idx = prev_line.find(")");
  217. const String text_to_insert = ", " + code.quote(quote_style);
  218. prev_line = prev_line.insert(closing_bracket_idx, text_to_insert);
  219. text_editor->set_line(line - 1, prev_line);
  220. } else {
  221. const int indent = text_editor->get_indent_level(line) / text_editor->get_indent_size();
  222. String annotation_indent;
  223. if (!text_editor->is_indent_using_spaces()) {
  224. annotation_indent = String("\t").repeat(indent);
  225. } else {
  226. annotation_indent = String(" ").repeat(text_editor->get_indent_size() * indent);
  227. }
  228. text_editor->insert_line_at(line, annotation_indent + "@warning_ignore(" + code.quote(quote_style) + ")");
  229. }
  230. _validate_script();
  231. }
  232. }
  233. void ScriptTextEditor::_error_clicked(Variant p_line) {
  234. if (p_line.get_type() == Variant::INT) {
  235. code_editor->get_text_editor()->remove_secondary_carets();
  236. code_editor->get_text_editor()->set_caret_line(p_line.operator int64_t());
  237. }
  238. }
  239. void ScriptTextEditor::reload_text() {
  240. ERR_FAIL_COND(script.is_null());
  241. CodeEdit *te = code_editor->get_text_editor();
  242. int column = te->get_caret_column();
  243. int row = te->get_caret_line();
  244. int h = te->get_h_scroll();
  245. int v = te->get_v_scroll();
  246. te->set_text(script->get_source_code());
  247. te->set_caret_line(row);
  248. te->set_caret_column(column);
  249. te->set_h_scroll(h);
  250. te->set_v_scroll(v);
  251. te->tag_saved_version();
  252. code_editor->update_line_and_column();
  253. _validate_script();
  254. }
  255. void ScriptTextEditor::add_callback(const String &p_function, PackedStringArray p_args) {
  256. String code = code_editor->get_text_editor()->get_text();
  257. int pos = script->get_language()->find_function(p_function, code);
  258. code_editor->get_text_editor()->remove_secondary_carets();
  259. if (pos == -1) {
  260. //does not exist
  261. code_editor->get_text_editor()->deselect();
  262. pos = code_editor->get_text_editor()->get_line_count() + 2;
  263. String func = script->get_language()->make_function("", p_function, p_args);
  264. //code=code+func;
  265. code_editor->get_text_editor()->set_caret_line(pos + 1);
  266. code_editor->get_text_editor()->set_caret_column(1000000); //none shall be that big
  267. code_editor->get_text_editor()->insert_text_at_caret("\n\n" + func);
  268. }
  269. code_editor->get_text_editor()->set_caret_line(pos);
  270. code_editor->get_text_editor()->set_caret_column(1);
  271. }
  272. bool ScriptTextEditor::show_members_overview() {
  273. return true;
  274. }
  275. void ScriptTextEditor::update_settings() {
  276. code_editor->get_text_editor()->set_gutter_draw(connection_gutter, EDITOR_GET("text_editor/appearance/gutters/show_info_gutter"));
  277. code_editor->update_editor_settings();
  278. }
  279. bool ScriptTextEditor::is_unsaved() {
  280. const bool unsaved =
  281. code_editor->get_text_editor()->get_version() != code_editor->get_text_editor()->get_saved_version() ||
  282. script->get_path().is_empty(); // In memory.
  283. return unsaved;
  284. }
  285. Variant ScriptTextEditor::get_edit_state() {
  286. return code_editor->get_edit_state();
  287. }
  288. void ScriptTextEditor::set_edit_state(const Variant &p_state) {
  289. code_editor->set_edit_state(p_state);
  290. Dictionary state = p_state;
  291. if (state.has("syntax_highlighter")) {
  292. int idx = highlighter_menu->get_item_idx_from_text(state["syntax_highlighter"]);
  293. if (idx >= 0) {
  294. _change_syntax_highlighter(idx);
  295. }
  296. }
  297. if (editor_enabled) {
  298. #ifndef ANDROID_ENABLED
  299. ensure_focus();
  300. #endif
  301. }
  302. }
  303. Variant ScriptTextEditor::get_navigation_state() {
  304. return code_editor->get_navigation_state();
  305. }
  306. void ScriptTextEditor::_convert_case(CodeTextEditor::CaseStyle p_case) {
  307. code_editor->convert_case(p_case);
  308. }
  309. void ScriptTextEditor::trim_trailing_whitespace() {
  310. code_editor->trim_trailing_whitespace();
  311. }
  312. void ScriptTextEditor::insert_final_newline() {
  313. code_editor->insert_final_newline();
  314. }
  315. void ScriptTextEditor::convert_indent() {
  316. code_editor->get_text_editor()->convert_indent();
  317. }
  318. void ScriptTextEditor::tag_saved_version() {
  319. code_editor->get_text_editor()->tag_saved_version();
  320. }
  321. void ScriptTextEditor::goto_line(int p_line, bool p_with_error) {
  322. code_editor->goto_line(p_line);
  323. }
  324. void ScriptTextEditor::goto_line_selection(int p_line, int p_begin, int p_end) {
  325. code_editor->goto_line_selection(p_line, p_begin, p_end);
  326. }
  327. void ScriptTextEditor::goto_line_centered(int p_line) {
  328. code_editor->goto_line_centered(p_line);
  329. }
  330. void ScriptTextEditor::set_executing_line(int p_line) {
  331. code_editor->set_executing_line(p_line);
  332. }
  333. void ScriptTextEditor::clear_executing_line() {
  334. code_editor->clear_executing_line();
  335. }
  336. void ScriptTextEditor::ensure_focus() {
  337. code_editor->get_text_editor()->grab_focus();
  338. }
  339. String ScriptTextEditor::get_name() {
  340. String name;
  341. name = script->get_path().get_file();
  342. if (name.is_empty()) {
  343. // This appears for newly created built-in scripts before saving the scene.
  344. name = TTR("[unsaved]");
  345. } else if (script->is_built_in()) {
  346. const String &script_name = script->get_name();
  347. if (!script_name.is_empty()) {
  348. // If the built-in script has a custom resource name defined,
  349. // display the built-in script name as follows: `ResourceName (scene_file.tscn)`
  350. name = vformat("%s (%s)", script_name, name.get_slice("::", 0));
  351. }
  352. }
  353. if (is_unsaved()) {
  354. name += "(*)";
  355. }
  356. return name;
  357. }
  358. Ref<Texture2D> ScriptTextEditor::get_theme_icon() {
  359. if (get_parent_control()) {
  360. String icon_name = script->get_class();
  361. if (script->is_built_in()) {
  362. icon_name += "Internal";
  363. }
  364. if (get_parent_control()->has_theme_icon(icon_name, SNAME("EditorIcons"))) {
  365. return get_parent_control()->get_theme_icon(icon_name, SNAME("EditorIcons"));
  366. } else if (get_parent_control()->has_theme_icon(script->get_class(), SNAME("EditorIcons"))) {
  367. return get_parent_control()->get_theme_icon(script->get_class(), SNAME("EditorIcons"));
  368. }
  369. }
  370. return Ref<Texture2D>();
  371. }
  372. void ScriptTextEditor::_validate_script() {
  373. CodeEdit *te = code_editor->get_text_editor();
  374. String text = te->get_text();
  375. List<String> fnc;
  376. warnings.clear();
  377. errors.clear();
  378. safe_lines.clear();
  379. if (!script->get_language()->validate(text, script->get_path(), &fnc, &errors, &warnings, &safe_lines)) {
  380. // TRANSLATORS: Script error pointing to a line and column number.
  381. String error_text = vformat(TTR("Error at (%d, %d):"), errors[0].line, errors[0].column) + " " + errors[0].message;
  382. code_editor->set_error(error_text);
  383. code_editor->set_error_pos(errors[0].line - 1, errors[0].column - 1);
  384. script_is_valid = false;
  385. } else {
  386. code_editor->set_error("");
  387. if (!script->is_tool()) {
  388. script->set_source_code(text);
  389. script->update_exports();
  390. te->get_syntax_highlighter()->update_cache();
  391. }
  392. functions.clear();
  393. for (const String &E : fnc) {
  394. functions.push_back(E);
  395. }
  396. script_is_valid = true;
  397. }
  398. _update_connected_methods();
  399. _update_warnings();
  400. _update_errors();
  401. emit_signal(SNAME("name_changed"));
  402. emit_signal(SNAME("edited_script_changed"));
  403. }
  404. void ScriptTextEditor::_update_warnings() {
  405. int warning_nb = warnings.size();
  406. warnings_panel->clear();
  407. bool has_connections_table = false;
  408. // Add missing connections.
  409. if (GLOBAL_GET("debug/gdscript/warnings/enable").booleanize()) {
  410. Node *base = get_tree()->get_edited_scene_root();
  411. if (base && missing_connections.size() > 0) {
  412. has_connections_table = true;
  413. warnings_panel->push_table(1);
  414. for (const Connection &connection : missing_connections) {
  415. String base_path = base->get_name();
  416. String source_path = base == connection.signal.get_object() ? base_path : base_path + "/" + base->get_path_to(Object::cast_to<Node>(connection.signal.get_object()));
  417. String target_path = base == connection.callable.get_object() ? base_path : base_path + "/" + base->get_path_to(Object::cast_to<Node>(connection.callable.get_object()));
  418. warnings_panel->push_cell();
  419. warnings_panel->push_color(warnings_panel->get_theme_color(SNAME("warning_color"), SNAME("Editor")));
  420. warnings_panel->add_text(vformat(TTR("Missing connected method '%s' for signal '%s' from node '%s' to node '%s'."), connection.callable.get_method(), connection.signal.get_name(), source_path, target_path));
  421. warnings_panel->pop(); // Color.
  422. warnings_panel->pop(); // Cell.
  423. }
  424. warnings_panel->pop(); // Table.
  425. warning_nb += missing_connections.size();
  426. }
  427. }
  428. code_editor->set_warning_count(warning_nb);
  429. if (has_connections_table) {
  430. warnings_panel->add_newline();
  431. }
  432. // Add script warnings.
  433. warnings_panel->push_table(3);
  434. for (const ScriptLanguage::Warning &w : warnings) {
  435. Dictionary ignore_meta;
  436. ignore_meta["line"] = w.start_line;
  437. ignore_meta["code"] = w.string_code.to_lower();
  438. warnings_panel->push_cell();
  439. warnings_panel->push_meta(ignore_meta);
  440. warnings_panel->push_color(
  441. warnings_panel->get_theme_color(SNAME("accent_color"), SNAME("Editor")).lerp(warnings_panel->get_theme_color(SNAME("mono_color"), SNAME("Editor")), 0.5f));
  442. warnings_panel->add_text(TTR("[Ignore]"));
  443. warnings_panel->pop(); // Color.
  444. warnings_panel->pop(); // Meta ignore.
  445. warnings_panel->pop(); // Cell.
  446. warnings_panel->push_cell();
  447. warnings_panel->push_meta(w.start_line - 1);
  448. warnings_panel->push_color(warnings_panel->get_theme_color(SNAME("warning_color"), SNAME("Editor")));
  449. warnings_panel->add_text(TTR("Line") + " " + itos(w.start_line));
  450. warnings_panel->add_text(" (" + w.string_code + "):");
  451. warnings_panel->pop(); // Color.
  452. warnings_panel->pop(); // Meta goto.
  453. warnings_panel->pop(); // Cell.
  454. warnings_panel->push_cell();
  455. warnings_panel->add_text(w.message);
  456. warnings_panel->add_newline();
  457. warnings_panel->pop(); // Cell.
  458. }
  459. warnings_panel->pop(); // Table.
  460. }
  461. void ScriptTextEditor::_update_errors() {
  462. code_editor->set_error_count(errors.size());
  463. errors_panel->clear();
  464. errors_panel->push_table(2);
  465. for (const ScriptLanguage::ScriptError &err : errors) {
  466. errors_panel->push_cell();
  467. errors_panel->push_meta(err.line - 1);
  468. errors_panel->push_color(warnings_panel->get_theme_color(SNAME("error_color"), SNAME("Editor")));
  469. errors_panel->add_text(TTR("Line") + " " + itos(err.line) + ":");
  470. errors_panel->pop(); // Color.
  471. errors_panel->pop(); // Meta goto.
  472. errors_panel->pop(); // Cell.
  473. errors_panel->push_cell();
  474. errors_panel->add_text(err.message);
  475. errors_panel->add_newline();
  476. errors_panel->pop(); // Cell.
  477. }
  478. errors_panel->pop(); // Table
  479. CodeEdit *te = code_editor->get_text_editor();
  480. bool highlight_safe = EDITOR_GET("text_editor/appearance/gutters/highlight_type_safe_lines");
  481. bool last_is_safe = false;
  482. for (int i = 0; i < te->get_line_count(); i++) {
  483. if (errors.is_empty()) {
  484. te->set_line_background_color(i, Color(0, 0, 0, 0));
  485. } else {
  486. for (const ScriptLanguage::ScriptError &E : errors) {
  487. bool error_line = i == E.line - 1;
  488. te->set_line_background_color(i, error_line ? marked_line_color : Color(0, 0, 0, 0));
  489. if (error_line) {
  490. break;
  491. }
  492. }
  493. }
  494. if (highlight_safe) {
  495. if (safe_lines.has(i + 1)) {
  496. te->set_line_gutter_item_color(i, line_number_gutter, safe_line_number_color);
  497. last_is_safe = true;
  498. } else if (last_is_safe && (te->is_in_comment(i) != -1 || te->get_line(i).strip_edges().is_empty())) {
  499. te->set_line_gutter_item_color(i, line_number_gutter, safe_line_number_color);
  500. } else {
  501. te->set_line_gutter_item_color(i, line_number_gutter, default_line_number_color);
  502. last_is_safe = false;
  503. }
  504. } else {
  505. te->set_line_gutter_item_color(i, 1, default_line_number_color);
  506. }
  507. }
  508. }
  509. void ScriptTextEditor::_update_bookmark_list() {
  510. bookmarks_menu->clear();
  511. bookmarks_menu->reset_size();
  512. bookmarks_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_bookmark"), BOOKMARK_TOGGLE);
  513. bookmarks_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/remove_all_bookmarks"), BOOKMARK_REMOVE_ALL);
  514. bookmarks_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/goto_next_bookmark"), BOOKMARK_GOTO_NEXT);
  515. bookmarks_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/goto_previous_bookmark"), BOOKMARK_GOTO_PREV);
  516. PackedInt32Array bookmark_list = code_editor->get_text_editor()->get_bookmarked_lines();
  517. if (bookmark_list.size() == 0) {
  518. return;
  519. }
  520. bookmarks_menu->add_separator();
  521. for (int i = 0; i < bookmark_list.size(); i++) {
  522. // Strip edges to remove spaces or tabs.
  523. // Also replace any tabs by spaces, since we can't print tabs in the menu.
  524. String line = code_editor->get_text_editor()->get_line(bookmark_list[i]).replace("\t", " ").strip_edges();
  525. // Limit the size of the line if too big.
  526. if (line.length() > 50) {
  527. line = line.substr(0, 50);
  528. }
  529. bookmarks_menu->add_item(String::num((int)bookmark_list[i] + 1) + " - `" + line + "`");
  530. bookmarks_menu->set_item_metadata(-1, bookmark_list[i]);
  531. }
  532. }
  533. void ScriptTextEditor::_bookmark_item_pressed(int p_idx) {
  534. if (p_idx < 4) { // Any item before the separator.
  535. _edit_option(bookmarks_menu->get_item_id(p_idx));
  536. } else {
  537. code_editor->goto_line_centered(bookmarks_menu->get_item_metadata(p_idx));
  538. }
  539. }
  540. static Vector<Node *> _find_all_node_for_script(Node *p_base, Node *p_current, const Ref<Script> &p_script) {
  541. Vector<Node *> nodes;
  542. if (p_current->get_owner() != p_base && p_base != p_current) {
  543. return nodes;
  544. }
  545. Ref<Script> c = p_current->get_script();
  546. if (c == p_script) {
  547. nodes.push_back(p_current);
  548. }
  549. for (int i = 0; i < p_current->get_child_count(); i++) {
  550. Vector<Node *> found = _find_all_node_for_script(p_base, p_current->get_child(i), p_script);
  551. nodes.append_array(found);
  552. }
  553. return nodes;
  554. }
  555. static Node *_find_node_for_script(Node *p_base, Node *p_current, const Ref<Script> &p_script) {
  556. if (p_current->get_owner() != p_base && p_base != p_current) {
  557. return nullptr;
  558. }
  559. Ref<Script> c = p_current->get_script();
  560. if (c == p_script) {
  561. return p_current;
  562. }
  563. for (int i = 0; i < p_current->get_child_count(); i++) {
  564. Node *found = _find_node_for_script(p_base, p_current->get_child(i), p_script);
  565. if (found) {
  566. return found;
  567. }
  568. }
  569. return nullptr;
  570. }
  571. static void _find_changed_scripts_for_external_editor(Node *p_base, Node *p_current, HashSet<Ref<Script>> &r_scripts) {
  572. if (p_current->get_owner() != p_base && p_base != p_current) {
  573. return;
  574. }
  575. Ref<Script> c = p_current->get_script();
  576. if (c.is_valid()) {
  577. r_scripts.insert(c);
  578. }
  579. for (int i = 0; i < p_current->get_child_count(); i++) {
  580. _find_changed_scripts_for_external_editor(p_base, p_current->get_child(i), r_scripts);
  581. }
  582. }
  583. void ScriptEditor::_update_modified_scripts_for_external_editor(Ref<Script> p_for_script) {
  584. if (!bool(EDITOR_GET("text_editor/external/use_external_editor"))) {
  585. return;
  586. }
  587. ERR_FAIL_COND(!get_tree());
  588. HashSet<Ref<Script>> scripts;
  589. Node *base = get_tree()->get_edited_scene_root();
  590. if (base) {
  591. _find_changed_scripts_for_external_editor(base, base, scripts);
  592. }
  593. for (const Ref<Script> &E : scripts) {
  594. Ref<Script> scr = E;
  595. if (p_for_script.is_valid() && p_for_script != scr) {
  596. continue;
  597. }
  598. if (scr->is_built_in()) {
  599. continue; //internal script, who cares, though weird
  600. }
  601. uint64_t last_date = scr->get_last_modified_time();
  602. uint64_t date = FileAccess::get_modified_time(scr->get_path());
  603. if (last_date != date) {
  604. Ref<Script> rel_scr = ResourceLoader::load(scr->get_path(), scr->get_class(), ResourceFormatLoader::CACHE_MODE_IGNORE);
  605. ERR_CONTINUE(!rel_scr.is_valid());
  606. scr->set_source_code(rel_scr->get_source_code());
  607. scr->set_last_modified_time(rel_scr->get_last_modified_time());
  608. scr->update_exports();
  609. _trigger_live_script_reload();
  610. }
  611. }
  612. }
  613. void ScriptTextEditor::_code_complete_scripts(void *p_ud, const String &p_code, List<ScriptLanguage::CodeCompletionOption> *r_options, bool &r_force) {
  614. ScriptTextEditor *ste = (ScriptTextEditor *)p_ud;
  615. ste->_code_complete_script(p_code, r_options, r_force);
  616. }
  617. void ScriptTextEditor::_code_complete_script(const String &p_code, List<ScriptLanguage::CodeCompletionOption> *r_options, bool &r_force) {
  618. if (color_panel->is_visible()) {
  619. return;
  620. }
  621. Node *base = get_tree()->get_edited_scene_root();
  622. if (base) {
  623. base = _find_node_for_script(base, base, script);
  624. }
  625. String hint;
  626. Error err = script->get_language()->complete_code(p_code, script->get_path(), base, r_options, r_force, hint);
  627. if (err == OK) {
  628. code_editor->get_text_editor()->set_code_hint(hint);
  629. }
  630. }
  631. void ScriptTextEditor::_update_breakpoint_list() {
  632. breakpoints_menu->clear();
  633. breakpoints_menu->reset_size();
  634. breakpoints_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_breakpoint"), DEBUG_TOGGLE_BREAKPOINT);
  635. breakpoints_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/remove_all_breakpoints"), DEBUG_REMOVE_ALL_BREAKPOINTS);
  636. breakpoints_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/goto_next_breakpoint"), DEBUG_GOTO_NEXT_BREAKPOINT);
  637. breakpoints_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/goto_previous_breakpoint"), DEBUG_GOTO_PREV_BREAKPOINT);
  638. PackedInt32Array breakpoint_list = code_editor->get_text_editor()->get_breakpointed_lines();
  639. if (breakpoint_list.size() == 0) {
  640. return;
  641. }
  642. breakpoints_menu->add_separator();
  643. for (int i = 0; i < breakpoint_list.size(); i++) {
  644. // Strip edges to remove spaces or tabs.
  645. // Also replace any tabs by spaces, since we can't print tabs in the menu.
  646. String line = code_editor->get_text_editor()->get_line(breakpoint_list[i]).replace("\t", " ").strip_edges();
  647. // Limit the size of the line if too big.
  648. if (line.length() > 50) {
  649. line = line.substr(0, 50);
  650. }
  651. breakpoints_menu->add_item(String::num((int)breakpoint_list[i] + 1) + " - `" + line + "`");
  652. breakpoints_menu->set_item_metadata(-1, breakpoint_list[i]);
  653. }
  654. }
  655. void ScriptTextEditor::_breakpoint_item_pressed(int p_idx) {
  656. if (p_idx < 4) { // Any item before the separator.
  657. _edit_option(breakpoints_menu->get_item_id(p_idx));
  658. } else {
  659. code_editor->goto_line(breakpoints_menu->get_item_metadata(p_idx));
  660. code_editor->get_text_editor()->call_deferred(SNAME("center_viewport_to_caret")); //Need to be deferred, because goto uses call_deferred().
  661. }
  662. }
  663. void ScriptTextEditor::_breakpoint_toggled(int p_row) {
  664. EditorDebuggerNode::get_singleton()->set_breakpoint(script->get_path(), p_row + 1, code_editor->get_text_editor()->is_line_breakpointed(p_row));
  665. }
  666. void ScriptTextEditor::_lookup_symbol(const String &p_symbol, int p_row, int p_column) {
  667. Node *base = get_tree()->get_edited_scene_root();
  668. if (base) {
  669. base = _find_node_for_script(base, base, script);
  670. }
  671. ScriptLanguage::LookupResult result;
  672. if (ScriptServer::is_global_class(p_symbol)) {
  673. EditorNode::get_singleton()->load_resource(ScriptServer::get_global_class_path(p_symbol));
  674. } else if (p_symbol.is_resource_file()) {
  675. List<String> scene_extensions;
  676. ResourceLoader::get_recognized_extensions_for_type("PackedScene", &scene_extensions);
  677. if (scene_extensions.find(p_symbol.get_extension())) {
  678. EditorNode::get_singleton()->load_scene(p_symbol);
  679. } else {
  680. EditorNode::get_singleton()->load_resource(p_symbol);
  681. }
  682. } else if (script->get_language()->lookup_code(code_editor->get_text_editor()->get_text_for_symbol_lookup(), p_symbol, script->get_path(), base, result) == OK) {
  683. _goto_line(p_row);
  684. switch (result.type) {
  685. case ScriptLanguage::LOOKUP_RESULT_SCRIPT_LOCATION: {
  686. if (result.script.is_valid()) {
  687. emit_signal(SNAME("request_open_script_at_line"), result.script, result.location - 1);
  688. } else {
  689. emit_signal(SNAME("request_save_history"));
  690. goto_line_centered(result.location - 1);
  691. }
  692. } break;
  693. case ScriptLanguage::LOOKUP_RESULT_CLASS: {
  694. emit_signal(SNAME("go_to_help"), "class_name:" + result.class_name);
  695. } break;
  696. case ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT: {
  697. StringName cname = result.class_name;
  698. bool success;
  699. while (true) {
  700. ClassDB::get_integer_constant(cname, result.class_member, &success);
  701. if (success) {
  702. result.class_name = cname;
  703. cname = ClassDB::get_parent_class(cname);
  704. } else {
  705. break;
  706. }
  707. }
  708. emit_signal(SNAME("go_to_help"), "class_constant:" + result.class_name + ":" + result.class_member);
  709. } break;
  710. case ScriptLanguage::LOOKUP_RESULT_CLASS_PROPERTY: {
  711. emit_signal(SNAME("go_to_help"), "class_property:" + result.class_name + ":" + result.class_member);
  712. } break;
  713. case ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD: {
  714. StringName cname = result.class_name;
  715. while (true) {
  716. if (ClassDB::has_method(cname, result.class_member)) {
  717. result.class_name = cname;
  718. cname = ClassDB::get_parent_class(cname);
  719. } else {
  720. break;
  721. }
  722. }
  723. emit_signal(SNAME("go_to_help"), "class_method:" + result.class_name + ":" + result.class_member);
  724. } break;
  725. case ScriptLanguage::LOOKUP_RESULT_CLASS_SIGNAL: {
  726. StringName cname = result.class_name;
  727. while (true) {
  728. if (ClassDB::has_signal(cname, result.class_member)) {
  729. result.class_name = cname;
  730. cname = ClassDB::get_parent_class(cname);
  731. } else {
  732. break;
  733. }
  734. }
  735. emit_signal(SNAME("go_to_help"), "class_signal:" + result.class_name + ":" + result.class_member);
  736. } break;
  737. case ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM: {
  738. StringName cname = result.class_name;
  739. StringName success;
  740. while (true) {
  741. success = ClassDB::get_integer_constant_enum(cname, result.class_member, true);
  742. if (success != StringName()) {
  743. result.class_name = cname;
  744. cname = ClassDB::get_parent_class(cname);
  745. } else {
  746. break;
  747. }
  748. }
  749. emit_signal(SNAME("go_to_help"), "class_enum:" + result.class_name + ":" + result.class_member);
  750. } break;
  751. case ScriptLanguage::LOOKUP_RESULT_CLASS_ANNOTATION: {
  752. emit_signal(SNAME("go_to_help"), "class_annotation:" + result.class_name + ":" + result.class_member);
  753. } break;
  754. case ScriptLanguage::LOOKUP_RESULT_CLASS_TBD_GLOBALSCOPE: {
  755. emit_signal(SNAME("go_to_help"), "class_global:" + result.class_name + ":" + result.class_member);
  756. } break;
  757. default: {
  758. }
  759. }
  760. } else if (ProjectSettings::get_singleton()->has_autoload(p_symbol)) {
  761. // Check for Autoload scenes.
  762. const ProjectSettings::AutoloadInfo &info = ProjectSettings::get_singleton()->get_autoload(p_symbol);
  763. if (info.is_singleton) {
  764. EditorNode::get_singleton()->load_scene(info.path);
  765. }
  766. } else if (p_symbol.is_relative_path()) {
  767. // Every symbol other than absolute path is relative path so keep this condition at last.
  768. String path = _get_absolute_path(p_symbol);
  769. if (FileAccess::exists(path)) {
  770. List<String> scene_extensions;
  771. ResourceLoader::get_recognized_extensions_for_type("PackedScene", &scene_extensions);
  772. if (scene_extensions.find(path.get_extension())) {
  773. EditorNode::get_singleton()->load_scene(path);
  774. } else {
  775. EditorNode::get_singleton()->load_resource(path);
  776. }
  777. }
  778. }
  779. }
  780. void ScriptTextEditor::_validate_symbol(const String &p_symbol) {
  781. CodeEdit *text_edit = code_editor->get_text_editor();
  782. Node *base = get_tree()->get_edited_scene_root();
  783. if (base) {
  784. base = _find_node_for_script(base, base, script);
  785. }
  786. ScriptLanguage::LookupResult result;
  787. if (ScriptServer::is_global_class(p_symbol) || p_symbol.is_resource_file() || script->get_language()->lookup_code(code_editor->get_text_editor()->get_text_for_symbol_lookup(), p_symbol, script->get_path(), base, result) == OK || (ProjectSettings::get_singleton()->has_autoload(p_symbol) && ProjectSettings::get_singleton()->get_autoload(p_symbol).is_singleton)) {
  788. text_edit->set_symbol_lookup_word_as_valid(true);
  789. } else if (p_symbol.is_relative_path()) {
  790. String path = _get_absolute_path(p_symbol);
  791. if (FileAccess::exists(path)) {
  792. text_edit->set_symbol_lookup_word_as_valid(true);
  793. } else {
  794. text_edit->set_symbol_lookup_word_as_valid(false);
  795. }
  796. } else {
  797. text_edit->set_symbol_lookup_word_as_valid(false);
  798. }
  799. }
  800. String ScriptTextEditor::_get_absolute_path(const String &rel_path) {
  801. String base_path = script->get_path().get_base_dir();
  802. String path = base_path.path_join(rel_path);
  803. return path.replace("///", "//").simplify_path();
  804. }
  805. void ScriptTextEditor::update_toggle_scripts_button() {
  806. code_editor->update_toggle_scripts_button();
  807. }
  808. void ScriptTextEditor::_update_connected_methods() {
  809. CodeEdit *text_edit = code_editor->get_text_editor();
  810. text_edit->set_gutter_width(connection_gutter, text_edit->get_line_height());
  811. for (int i = 0; i < text_edit->get_line_count(); i++) {
  812. text_edit->set_line_gutter_metadata(i, connection_gutter, Dictionary());
  813. text_edit->set_line_gutter_icon(i, connection_gutter, nullptr);
  814. text_edit->set_line_gutter_clickable(i, connection_gutter, false);
  815. }
  816. missing_connections.clear();
  817. if (!script_is_valid) {
  818. return;
  819. }
  820. Node *base = get_tree()->get_edited_scene_root();
  821. if (!base) {
  822. return;
  823. }
  824. // Add connection icons to methods.
  825. Vector<Node *> nodes = _find_all_node_for_script(base, base, script);
  826. HashSet<StringName> methods_found;
  827. for (int i = 0; i < nodes.size(); i++) {
  828. List<Connection> signal_connections;
  829. nodes[i]->get_signals_connected_to_this(&signal_connections);
  830. for (const Connection &connection : signal_connections) {
  831. if (!(connection.flags & CONNECT_PERSIST)) {
  832. continue;
  833. }
  834. // As deleted nodes are still accessible via the undo/redo system, check if they're still on the tree.
  835. Node *source = Object::cast_to<Node>(connection.signal.get_object());
  836. if (source && !source->is_inside_tree()) {
  837. continue;
  838. }
  839. const StringName method = connection.callable.get_method();
  840. if (methods_found.has(method)) {
  841. continue;
  842. }
  843. if (!ClassDB::has_method(script->get_instance_base_type(), method)) {
  844. int line = -1;
  845. for (int j = 0; j < functions.size(); j++) {
  846. String name = functions[j].get_slice(":", 0);
  847. if (name == method) {
  848. Dictionary line_meta;
  849. line_meta["type"] = "connection";
  850. line_meta["method"] = method;
  851. line = functions[j].get_slice(":", 1).to_int() - 1;
  852. text_edit->set_line_gutter_metadata(line, connection_gutter, line_meta);
  853. text_edit->set_line_gutter_icon(line, connection_gutter, get_parent_control()->get_theme_icon(SNAME("Slot"), SNAME("EditorIcons")));
  854. text_edit->set_line_gutter_clickable(line, connection_gutter, true);
  855. methods_found.insert(method);
  856. break;
  857. }
  858. }
  859. if (line >= 0) {
  860. continue;
  861. }
  862. // There is a chance that the method is inherited from another script.
  863. bool found_inherited_function = false;
  864. Ref<Script> inherited_script = script->get_base_script();
  865. while (!inherited_script.is_null()) {
  866. if (inherited_script->has_method(method)) {
  867. found_inherited_function = true;
  868. break;
  869. }
  870. inherited_script = inherited_script->get_base_script();
  871. }
  872. if (!found_inherited_function) {
  873. missing_connections.push_back(connection);
  874. }
  875. }
  876. }
  877. }
  878. // Add override icons to methods.
  879. methods_found.clear();
  880. for (int i = 0; i < functions.size(); i++) {
  881. StringName name = StringName(functions[i].get_slice(":", 0));
  882. if (methods_found.has(name)) {
  883. continue;
  884. }
  885. String found_base_class;
  886. StringName base_class = script->get_instance_base_type();
  887. Ref<Script> inherited_script = script->get_base_script();
  888. while (!inherited_script.is_null()) {
  889. if (inherited_script->has_method(name)) {
  890. found_base_class = "script:" + inherited_script->get_path();
  891. break;
  892. }
  893. base_class = inherited_script->get_instance_base_type();
  894. inherited_script = inherited_script->get_base_script();
  895. }
  896. if (found_base_class.is_empty()) {
  897. while (base_class) {
  898. List<MethodInfo> methods;
  899. ClassDB::get_method_list(base_class, &methods, true);
  900. for (int j = 0; j < methods.size(); j++) {
  901. if (methods[j].name == name) {
  902. found_base_class = "builtin:" + base_class;
  903. break;
  904. }
  905. }
  906. ClassDB::ClassInfo *base_class_ptr = ClassDB::classes.getptr(base_class)->inherits_ptr;
  907. if (base_class_ptr == nullptr) {
  908. break;
  909. }
  910. base_class = base_class_ptr->name;
  911. }
  912. }
  913. if (!found_base_class.is_empty()) {
  914. int line = functions[i].get_slice(":", 1).to_int() - 1;
  915. Dictionary line_meta = text_edit->get_line_gutter_metadata(line, connection_gutter);
  916. if (line_meta.is_empty()) {
  917. // Add override icon to gutter.
  918. line_meta["type"] = "inherits";
  919. line_meta["method"] = name;
  920. line_meta["base_class"] = found_base_class;
  921. text_edit->set_line_gutter_icon(line, connection_gutter, get_parent_control()->get_theme_icon(SNAME("MethodOverride"), SNAME("EditorIcons")));
  922. text_edit->set_line_gutter_clickable(line, connection_gutter, true);
  923. } else {
  924. // If method is also connected to signal, then merge icons and keep the click behavior of the slot.
  925. text_edit->set_line_gutter_icon(line, connection_gutter, get_parent_control()->get_theme_icon(SNAME("MethodOverrideAndSlot"), SNAME("EditorIcons")));
  926. }
  927. methods_found.insert(name);
  928. }
  929. }
  930. }
  931. void ScriptTextEditor::_update_gutter_indexes() {
  932. for (int i = 0; i < code_editor->get_text_editor()->get_gutter_count(); i++) {
  933. if (code_editor->get_text_editor()->get_gutter_name(i) == "connection_gutter") {
  934. connection_gutter = i;
  935. continue;
  936. }
  937. if (code_editor->get_text_editor()->get_gutter_name(i) == "line_numbers") {
  938. line_number_gutter = i;
  939. continue;
  940. }
  941. }
  942. }
  943. void ScriptTextEditor::_gutter_clicked(int p_line, int p_gutter) {
  944. if (p_gutter != connection_gutter) {
  945. return;
  946. }
  947. Dictionary meta = code_editor->get_text_editor()->get_line_gutter_metadata(p_line, p_gutter);
  948. String type = meta.get("type", "");
  949. if (type.is_empty()) {
  950. return;
  951. }
  952. // All types currently need a method name.
  953. String method = meta.get("method", "");
  954. if (method.is_empty()) {
  955. return;
  956. }
  957. if (type == "connection") {
  958. Node *base = get_tree()->get_edited_scene_root();
  959. if (!base) {
  960. return;
  961. }
  962. Vector<Node *> nodes = _find_all_node_for_script(base, base, script);
  963. connection_info_dialog->popup_connections(method, nodes);
  964. } else if (type == "inherits") {
  965. String base_class_raw = meta["base_class"];
  966. PackedStringArray base_class_split = base_class_raw.split(":", true, 1);
  967. if (base_class_split[0] == "script") {
  968. // Go to function declaration.
  969. Ref<Script> base_script = ResourceLoader::load(base_class_split[1]);
  970. ERR_FAIL_COND(!base_script.is_valid());
  971. emit_signal(SNAME("go_to_method"), base_script, method);
  972. } else if (base_class_split[0] == "builtin") {
  973. // Open method documentation.
  974. emit_signal(SNAME("go_to_help"), "class_method:" + base_class_split[1] + ":" + method);
  975. }
  976. }
  977. }
  978. void ScriptTextEditor::_edit_option(int p_op) {
  979. CodeEdit *tx = code_editor->get_text_editor();
  980. switch (p_op) {
  981. case EDIT_UNDO: {
  982. tx->undo();
  983. tx->call_deferred(SNAME("grab_focus"));
  984. } break;
  985. case EDIT_REDO: {
  986. tx->redo();
  987. tx->call_deferred(SNAME("grab_focus"));
  988. } break;
  989. case EDIT_CUT: {
  990. tx->cut();
  991. tx->call_deferred(SNAME("grab_focus"));
  992. } break;
  993. case EDIT_COPY: {
  994. tx->copy();
  995. tx->call_deferred(SNAME("grab_focus"));
  996. } break;
  997. case EDIT_PASTE: {
  998. tx->paste();
  999. tx->call_deferred(SNAME("grab_focus"));
  1000. } break;
  1001. case EDIT_SELECT_ALL: {
  1002. tx->select_all();
  1003. tx->call_deferred(SNAME("grab_focus"));
  1004. } break;
  1005. case EDIT_MOVE_LINE_UP: {
  1006. code_editor->move_lines_up();
  1007. } break;
  1008. case EDIT_MOVE_LINE_DOWN: {
  1009. code_editor->move_lines_down();
  1010. } break;
  1011. case EDIT_INDENT: {
  1012. Ref<Script> scr = script;
  1013. if (scr.is_null()) {
  1014. return;
  1015. }
  1016. tx->indent_lines();
  1017. } break;
  1018. case EDIT_UNINDENT: {
  1019. Ref<Script> scr = script;
  1020. if (scr.is_null()) {
  1021. return;
  1022. }
  1023. tx->unindent_lines();
  1024. } break;
  1025. case EDIT_DELETE_LINE: {
  1026. code_editor->delete_lines();
  1027. } break;
  1028. case EDIT_DUPLICATE_SELECTION: {
  1029. code_editor->duplicate_selection();
  1030. } break;
  1031. case EDIT_TOGGLE_FOLD_LINE: {
  1032. int previous_line = -1;
  1033. for (int caret_idx : tx->get_caret_index_edit_order()) {
  1034. int line_idx = tx->get_caret_line(caret_idx);
  1035. if (line_idx != previous_line) {
  1036. tx->toggle_foldable_line(line_idx);
  1037. previous_line = line_idx;
  1038. }
  1039. }
  1040. tx->queue_redraw();
  1041. } break;
  1042. case EDIT_FOLD_ALL_LINES: {
  1043. tx->fold_all_lines();
  1044. tx->queue_redraw();
  1045. } break;
  1046. case EDIT_UNFOLD_ALL_LINES: {
  1047. tx->unfold_all_lines();
  1048. tx->queue_redraw();
  1049. } break;
  1050. case EDIT_TOGGLE_COMMENT: {
  1051. _edit_option_toggle_inline_comment();
  1052. } break;
  1053. case EDIT_COMPLETE: {
  1054. tx->request_code_completion(true);
  1055. } break;
  1056. case EDIT_AUTO_INDENT: {
  1057. String text = tx->get_text();
  1058. Ref<Script> scr = script;
  1059. if (scr.is_null()) {
  1060. return;
  1061. }
  1062. tx->begin_complex_operation();
  1063. int begin, end;
  1064. if (tx->has_selection()) {
  1065. begin = tx->get_selection_from_line();
  1066. end = tx->get_selection_to_line();
  1067. // ignore if the cursor is not past the first column
  1068. if (tx->get_selection_to_column() == 0) {
  1069. end--;
  1070. }
  1071. } else {
  1072. begin = 0;
  1073. end = tx->get_line_count() - 1;
  1074. }
  1075. scr->get_language()->auto_indent_code(text, begin, end);
  1076. Vector<String> lines = text.split("\n");
  1077. for (int i = begin; i <= end; ++i) {
  1078. tx->set_line(i, lines[i]);
  1079. }
  1080. tx->end_complex_operation();
  1081. } break;
  1082. case EDIT_TRIM_TRAILING_WHITESAPCE: {
  1083. trim_trailing_whitespace();
  1084. } break;
  1085. case EDIT_CONVERT_INDENT_TO_SPACES: {
  1086. tx->set_indent_using_spaces(true);
  1087. convert_indent();
  1088. } break;
  1089. case EDIT_CONVERT_INDENT_TO_TABS: {
  1090. tx->set_indent_using_spaces(false);
  1091. convert_indent();
  1092. } break;
  1093. case EDIT_PICK_COLOR: {
  1094. color_panel->popup();
  1095. } break;
  1096. case EDIT_TO_UPPERCASE: {
  1097. _convert_case(CodeTextEditor::UPPER);
  1098. } break;
  1099. case EDIT_TO_LOWERCASE: {
  1100. _convert_case(CodeTextEditor::LOWER);
  1101. } break;
  1102. case EDIT_CAPITALIZE: {
  1103. _convert_case(CodeTextEditor::CAPITALIZE);
  1104. } break;
  1105. case EDIT_EVALUATE: {
  1106. Expression expression;
  1107. tx->begin_complex_operation();
  1108. for (int caret_idx = 0; caret_idx < tx->get_caret_count(); caret_idx++) {
  1109. Vector<String> lines = tx->get_selected_text(caret_idx).split("\n");
  1110. PackedStringArray results;
  1111. for (int i = 0; i < lines.size(); i++) {
  1112. String line = lines[i];
  1113. String whitespace = line.substr(0, line.size() - line.strip_edges(true, false).size()); // Extract the whitespace at the beginning.
  1114. if (expression.parse(line) == OK) {
  1115. Variant result = expression.execute(Array(), Variant(), false, true);
  1116. if (expression.get_error_text().is_empty()) {
  1117. results.push_back(whitespace + result.get_construct_string());
  1118. } else {
  1119. results.push_back(line);
  1120. }
  1121. } else {
  1122. results.push_back(line);
  1123. }
  1124. }
  1125. tx->insert_text_at_caret(String("\n").join(results), caret_idx);
  1126. }
  1127. tx->end_complex_operation();
  1128. } break;
  1129. case EDIT_TOGGLE_WORD_WRAP: {
  1130. TextEdit::LineWrappingMode wrap = code_editor->get_text_editor()->get_line_wrapping_mode();
  1131. code_editor->get_text_editor()->set_line_wrapping_mode(wrap == TextEdit::LINE_WRAPPING_BOUNDARY ? TextEdit::LINE_WRAPPING_NONE : TextEdit::LINE_WRAPPING_BOUNDARY);
  1132. } break;
  1133. case SEARCH_FIND: {
  1134. code_editor->get_find_replace_bar()->popup_search();
  1135. } break;
  1136. case SEARCH_FIND_NEXT: {
  1137. code_editor->get_find_replace_bar()->search_next();
  1138. } break;
  1139. case SEARCH_FIND_PREV: {
  1140. code_editor->get_find_replace_bar()->search_prev();
  1141. } break;
  1142. case SEARCH_REPLACE: {
  1143. code_editor->get_find_replace_bar()->popup_replace();
  1144. } break;
  1145. case SEARCH_IN_FILES: {
  1146. String selected_text = tx->get_selected_text();
  1147. // Yep, because it doesn't make sense to instance this dialog for every single script open...
  1148. // So this will be delegated to the ScriptEditor.
  1149. emit_signal(SNAME("search_in_files_requested"), selected_text);
  1150. } break;
  1151. case REPLACE_IN_FILES: {
  1152. String selected_text = tx->get_selected_text();
  1153. emit_signal(SNAME("replace_in_files_requested"), selected_text);
  1154. } break;
  1155. case SEARCH_LOCATE_FUNCTION: {
  1156. quick_open->popup_dialog(get_functions());
  1157. quick_open->set_title(TTR("Go to Function"));
  1158. } break;
  1159. case SEARCH_GOTO_LINE: {
  1160. goto_line_dialog->popup_find_line(tx);
  1161. } break;
  1162. case BOOKMARK_TOGGLE: {
  1163. code_editor->toggle_bookmark();
  1164. } break;
  1165. case BOOKMARK_GOTO_NEXT: {
  1166. code_editor->goto_next_bookmark();
  1167. } break;
  1168. case BOOKMARK_GOTO_PREV: {
  1169. code_editor->goto_prev_bookmark();
  1170. } break;
  1171. case BOOKMARK_REMOVE_ALL: {
  1172. code_editor->remove_all_bookmarks();
  1173. } break;
  1174. case DEBUG_TOGGLE_BREAKPOINT: {
  1175. Vector<int> caret_edit_order = tx->get_caret_index_edit_order();
  1176. caret_edit_order.reverse();
  1177. int last_line = -1;
  1178. for (const int &c : caret_edit_order) {
  1179. int from = tx->has_selection(c) ? tx->get_selection_from_line(c) : tx->get_caret_line(c);
  1180. from += from == last_line ? 1 : 0;
  1181. int to = tx->has_selection(c) ? tx->get_selection_to_line(c) : tx->get_caret_line(c);
  1182. if (to < from) {
  1183. continue;
  1184. }
  1185. // Check first if there's any lines with breakpoints in the selection.
  1186. bool selection_has_breakpoints = false;
  1187. for (int line = from; line <= to; line++) {
  1188. if (tx->is_line_breakpointed(line)) {
  1189. selection_has_breakpoints = true;
  1190. break;
  1191. }
  1192. }
  1193. // Set breakpoint on caret or remove all bookmarks from the selection.
  1194. if (!selection_has_breakpoints) {
  1195. if (tx->get_caret_line(c) != last_line) {
  1196. tx->set_line_as_breakpoint(tx->get_caret_line(c), true);
  1197. }
  1198. } else {
  1199. for (int line = from; line <= to; line++) {
  1200. tx->set_line_as_breakpoint(line, false);
  1201. }
  1202. }
  1203. last_line = to;
  1204. }
  1205. } break;
  1206. case DEBUG_REMOVE_ALL_BREAKPOINTS: {
  1207. PackedInt32Array bpoints = tx->get_breakpointed_lines();
  1208. for (int i = 0; i < bpoints.size(); i++) {
  1209. int line = bpoints[i];
  1210. bool dobreak = !tx->is_line_breakpointed(line);
  1211. tx->set_line_as_breakpoint(line, dobreak);
  1212. EditorDebuggerNode::get_singleton()->set_breakpoint(script->get_path(), line + 1, dobreak);
  1213. }
  1214. } break;
  1215. case DEBUG_GOTO_NEXT_BREAKPOINT: {
  1216. PackedInt32Array bpoints = tx->get_breakpointed_lines();
  1217. if (bpoints.size() <= 0) {
  1218. return;
  1219. }
  1220. int current_line = tx->get_caret_line();
  1221. int bpoint_idx = 0;
  1222. if (current_line < (int)bpoints[bpoints.size() - 1]) {
  1223. while (bpoint_idx < bpoints.size() && bpoints[bpoint_idx] <= current_line) {
  1224. bpoint_idx++;
  1225. }
  1226. }
  1227. code_editor->goto_line_centered(bpoints[bpoint_idx]);
  1228. } break;
  1229. case DEBUG_GOTO_PREV_BREAKPOINT: {
  1230. PackedInt32Array bpoints = tx->get_breakpointed_lines();
  1231. if (bpoints.size() <= 0) {
  1232. return;
  1233. }
  1234. int current_line = tx->get_caret_line();
  1235. int bpoint_idx = bpoints.size() - 1;
  1236. if (current_line > (int)bpoints[0]) {
  1237. while (bpoint_idx >= 0 && bpoints[bpoint_idx] >= current_line) {
  1238. bpoint_idx--;
  1239. }
  1240. }
  1241. code_editor->goto_line_centered(bpoints[bpoint_idx]);
  1242. } break;
  1243. case HELP_CONTEXTUAL: {
  1244. String text = tx->get_selected_text(0);
  1245. if (text.is_empty()) {
  1246. text = tx->get_word_under_caret(0);
  1247. }
  1248. if (!text.is_empty()) {
  1249. emit_signal(SNAME("request_help"), text);
  1250. }
  1251. } break;
  1252. case LOOKUP_SYMBOL: {
  1253. String text = tx->get_word_under_caret(0);
  1254. if (text.is_empty()) {
  1255. text = tx->get_selected_text(0);
  1256. }
  1257. if (!text.is_empty()) {
  1258. _lookup_symbol(text, tx->get_caret_line(0), tx->get_caret_column(0));
  1259. }
  1260. } break;
  1261. }
  1262. }
  1263. void ScriptTextEditor::_edit_option_toggle_inline_comment() {
  1264. if (script.is_null()) {
  1265. return;
  1266. }
  1267. String delimiter = "#";
  1268. List<String> comment_delimiters;
  1269. script->get_language()->get_comment_delimiters(&comment_delimiters);
  1270. for (const String &script_delimiter : comment_delimiters) {
  1271. if (!script_delimiter.contains(" ")) {
  1272. delimiter = script_delimiter;
  1273. break;
  1274. }
  1275. }
  1276. code_editor->toggle_inline_comment(delimiter);
  1277. }
  1278. void ScriptTextEditor::add_syntax_highlighter(Ref<EditorSyntaxHighlighter> p_highlighter) {
  1279. ERR_FAIL_COND(p_highlighter.is_null());
  1280. highlighters[p_highlighter->_get_name()] = p_highlighter;
  1281. highlighter_menu->add_radio_check_item(p_highlighter->_get_name());
  1282. }
  1283. void ScriptTextEditor::set_syntax_highlighter(Ref<EditorSyntaxHighlighter> p_highlighter) {
  1284. ERR_FAIL_COND(p_highlighter.is_null());
  1285. HashMap<String, Ref<EditorSyntaxHighlighter>>::Iterator el = highlighters.begin();
  1286. while (el) {
  1287. int highlighter_index = highlighter_menu->get_item_idx_from_text(el->key);
  1288. highlighter_menu->set_item_checked(highlighter_index, el->value == p_highlighter);
  1289. ++el;
  1290. }
  1291. CodeEdit *te = code_editor->get_text_editor();
  1292. p_highlighter->_set_edited_resource(script);
  1293. te->set_syntax_highlighter(p_highlighter);
  1294. }
  1295. void ScriptTextEditor::_change_syntax_highlighter(int p_idx) {
  1296. set_syntax_highlighter(highlighters[highlighter_menu->get_item_text(p_idx)]);
  1297. }
  1298. void ScriptTextEditor::_notification(int p_what) {
  1299. switch (p_what) {
  1300. case NOTIFICATION_THEME_CHANGED:
  1301. if (!editor_enabled) {
  1302. break;
  1303. }
  1304. if (is_visible_in_tree()) {
  1305. _update_warnings();
  1306. _update_errors();
  1307. }
  1308. [[fallthrough]];
  1309. case NOTIFICATION_ENTER_TREE: {
  1310. code_editor->get_text_editor()->set_gutter_width(connection_gutter, code_editor->get_text_editor()->get_line_height());
  1311. } break;
  1312. }
  1313. }
  1314. Control *ScriptTextEditor::get_edit_menu() {
  1315. return edit_hb;
  1316. }
  1317. void ScriptTextEditor::clear_edit_menu() {
  1318. if (editor_enabled) {
  1319. memdelete(edit_hb);
  1320. }
  1321. }
  1322. void ScriptTextEditor::set_find_replace_bar(FindReplaceBar *p_bar) {
  1323. code_editor->set_find_replace_bar(p_bar);
  1324. }
  1325. void ScriptTextEditor::reload(bool p_soft) {
  1326. CodeEdit *te = code_editor->get_text_editor();
  1327. Ref<Script> scr = script;
  1328. if (scr.is_null()) {
  1329. return;
  1330. }
  1331. scr->set_source_code(te->get_text());
  1332. bool soft = p_soft || scr->get_instance_base_type() == "EditorPlugin"; // Always soft-reload editor plugins.
  1333. scr->get_language()->reload_tool_script(scr, soft);
  1334. }
  1335. PackedInt32Array ScriptTextEditor::get_breakpoints() {
  1336. return code_editor->get_text_editor()->get_breakpointed_lines();
  1337. }
  1338. void ScriptTextEditor::set_breakpoint(int p_line, bool p_enabled) {
  1339. code_editor->get_text_editor()->set_line_as_breakpoint(p_line, p_enabled);
  1340. }
  1341. void ScriptTextEditor::clear_breakpoints() {
  1342. code_editor->get_text_editor()->clear_breakpointed_lines();
  1343. }
  1344. void ScriptTextEditor::set_tooltip_request_func(const Callable &p_toolip_callback) {
  1345. Variant args[1] = { this };
  1346. const Variant *argp[] = { &args[0] };
  1347. code_editor->get_text_editor()->set_tooltip_request_func(p_toolip_callback.bindp(argp, 1));
  1348. }
  1349. void ScriptTextEditor::set_debugger_active(bool p_active) {
  1350. }
  1351. Control *ScriptTextEditor::get_base_editor() const {
  1352. return code_editor->get_text_editor();
  1353. }
  1354. Variant ScriptTextEditor::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
  1355. return Variant();
  1356. }
  1357. bool ScriptTextEditor::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
  1358. Dictionary d = p_data;
  1359. if (d.has("type") &&
  1360. (String(d["type"]) == "resource" ||
  1361. String(d["type"]) == "files" ||
  1362. String(d["type"]) == "nodes" ||
  1363. String(d["type"]) == "obj_property" ||
  1364. String(d["type"]) == "files_and_dirs")) {
  1365. return true;
  1366. }
  1367. return false;
  1368. }
  1369. static Node *_find_script_node(Node *p_edited_scene, Node *p_current_node, const Ref<Script> &script) {
  1370. // Check scripts only for the nodes belonging to the edited scene.
  1371. if (p_current_node == p_edited_scene || p_current_node->get_owner() == p_edited_scene) {
  1372. Ref<Script> scr = p_current_node->get_script();
  1373. if (scr.is_valid() && scr == script) {
  1374. return p_current_node;
  1375. }
  1376. }
  1377. // Traverse all children, even the ones not owned by the edited scene as they
  1378. // can still have child nodes added within the edited scene and thus owned by
  1379. // it (e.g. nodes added to subscene's root or to its editable children).
  1380. for (int i = 0; i < p_current_node->get_child_count(); i++) {
  1381. Node *n = _find_script_node(p_edited_scene, p_current_node->get_child(i), script);
  1382. if (n) {
  1383. return n;
  1384. }
  1385. }
  1386. return nullptr;
  1387. }
  1388. static String _quote_drop_data(const String &str) {
  1389. // This function prepares a string for being "dropped" into the script editor.
  1390. // The string can be a resource path, node path or property name.
  1391. const bool using_single_quotes = EDITOR_GET("text_editor/completion/use_single_quotes");
  1392. String escaped = str.c_escape();
  1393. // If string is double quoted, there is no need to escape single quotes.
  1394. // We can revert the extra escaping added in c_escape().
  1395. if (!using_single_quotes) {
  1396. escaped = escaped.replace("\\'", "\'");
  1397. }
  1398. return escaped.quote(using_single_quotes ? "'" : "\"");
  1399. }
  1400. void ScriptTextEditor::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
  1401. Dictionary d = p_data;
  1402. CodeEdit *te = code_editor->get_text_editor();
  1403. Point2i pos = te->get_line_column_at_pos(p_point);
  1404. int row = pos.y;
  1405. int col = pos.x;
  1406. if (d.has("type") && String(d["type"]) == "resource") {
  1407. te->remove_secondary_carets();
  1408. Ref<Resource> res = d["resource"];
  1409. if (!res.is_valid()) {
  1410. return;
  1411. }
  1412. if (res->get_path().is_resource_file()) {
  1413. EditorNode::get_singleton()->show_warning(TTR("Only resources from filesystem can be dropped."));
  1414. return;
  1415. }
  1416. te->set_caret_line(row);
  1417. te->set_caret_column(col);
  1418. te->insert_text_at_caret(res->get_path());
  1419. te->grab_focus();
  1420. }
  1421. if (d.has("type") && (String(d["type"]) == "files" || String(d["type"]) == "files_and_dirs")) {
  1422. te->remove_secondary_carets();
  1423. Array files = d["files"];
  1424. String text_to_drop;
  1425. bool preload = Input::get_singleton()->is_key_pressed(Key::CTRL);
  1426. for (int i = 0; i < files.size(); i++) {
  1427. if (i > 0) {
  1428. text_to_drop += ", ";
  1429. }
  1430. if (preload) {
  1431. text_to_drop += "preload(" + _quote_drop_data(String(files[i])) + ")";
  1432. } else {
  1433. text_to_drop += _quote_drop_data(String(files[i]));
  1434. }
  1435. }
  1436. te->set_caret_line(row);
  1437. te->set_caret_column(col);
  1438. te->insert_text_at_caret(text_to_drop);
  1439. te->grab_focus();
  1440. }
  1441. if (d.has("type") && String(d["type"]) == "nodes") {
  1442. te->remove_secondary_carets();
  1443. Node *scene_root = get_tree()->get_edited_scene_root();
  1444. if (!scene_root) {
  1445. EditorNode::get_singleton()->show_warning(TTR("Can't drop nodes without an open scene."));
  1446. return;
  1447. }
  1448. Node *sn = _find_script_node(scene_root, scene_root, script);
  1449. if (!sn) {
  1450. EditorNode::get_singleton()->show_warning(vformat(TTR("Can't drop nodes because script '%s' is not used in this scene."), get_name()));
  1451. return;
  1452. }
  1453. Array nodes = d["nodes"];
  1454. String text_to_drop;
  1455. if (Input::get_singleton()->is_key_pressed(Key::CTRL)) {
  1456. bool use_type = EDITOR_GET("text_editor/completion/add_type_hints");
  1457. for (int i = 0; i < nodes.size(); i++) {
  1458. NodePath np = nodes[i];
  1459. Node *node = get_node(np);
  1460. if (!node) {
  1461. continue;
  1462. }
  1463. bool is_unique = false;
  1464. String path;
  1465. if (node->is_unique_name_in_owner()) {
  1466. path = node->get_name();
  1467. is_unique = true;
  1468. } else {
  1469. path = sn->get_path_to(node);
  1470. }
  1471. for (const String &segment : path.split("/")) {
  1472. if (!segment.is_valid_identifier()) {
  1473. path = _quote_drop_data(path);
  1474. break;
  1475. }
  1476. }
  1477. String variable_name = String(node->get_name()).to_snake_case().validate_identifier();
  1478. if (use_type) {
  1479. StringName class_name = node->get_class_name();
  1480. Ref<Script> node_script = node->get_script();
  1481. if (node_script.is_valid()) {
  1482. StringName global_node_script_name = node_script->get_global_name();
  1483. if (global_node_script_name != StringName()) {
  1484. class_name = global_node_script_name;
  1485. }
  1486. }
  1487. text_to_drop += vformat("@onready var %s: %s = %c%s\n", variable_name, class_name, is_unique ? '%' : '$', path);
  1488. } else {
  1489. text_to_drop += vformat("@onready var %s = %c%s\n", variable_name, is_unique ? '%' : '$', path);
  1490. }
  1491. }
  1492. } else {
  1493. for (int i = 0; i < nodes.size(); i++) {
  1494. if (i > 0) {
  1495. text_to_drop += ", ";
  1496. }
  1497. NodePath np = nodes[i];
  1498. Node *node = get_node(np);
  1499. if (!node) {
  1500. continue;
  1501. }
  1502. bool is_unique = false;
  1503. String path;
  1504. if (node->is_unique_name_in_owner()) {
  1505. path = node->get_name();
  1506. is_unique = true;
  1507. } else {
  1508. path = sn->get_path_to(node);
  1509. }
  1510. for (const String &segment : path.split("/")) {
  1511. if (!segment.is_valid_identifier()) {
  1512. path = _quote_drop_data(path);
  1513. break;
  1514. }
  1515. }
  1516. text_to_drop += (is_unique ? "%" : "$") + path;
  1517. }
  1518. }
  1519. te->set_caret_line(row);
  1520. te->set_caret_column(col);
  1521. te->insert_text_at_caret(text_to_drop);
  1522. te->grab_focus();
  1523. }
  1524. if (d.has("type") && String(d["type"]) == "obj_property") {
  1525. te->remove_secondary_carets();
  1526. // It is unclear whether properties may contain single or double quotes.
  1527. // Assume here that double-quotes may not exist. We are escaping single-quotes if necessary.
  1528. const String text_to_drop = _quote_drop_data(String(d["property"]));
  1529. te->set_caret_line(row);
  1530. te->set_caret_column(col);
  1531. te->insert_text_at_caret(text_to_drop);
  1532. te->grab_focus();
  1533. }
  1534. }
  1535. void ScriptTextEditor::_text_edit_gui_input(const Ref<InputEvent> &ev) {
  1536. Ref<InputEventMouseButton> mb = ev;
  1537. Ref<InputEventKey> k = ev;
  1538. Point2 local_pos;
  1539. bool create_menu = false;
  1540. CodeEdit *tx = code_editor->get_text_editor();
  1541. if (mb.is_valid() && mb->get_button_index() == MouseButton::RIGHT && mb->is_pressed()) {
  1542. local_pos = mb->get_global_position() - tx->get_global_position();
  1543. create_menu = true;
  1544. } else if (k.is_valid() && k->is_action("ui_menu", true)) {
  1545. tx->adjust_viewport_to_caret(0);
  1546. local_pos = tx->get_caret_draw_pos(0);
  1547. create_menu = true;
  1548. }
  1549. if (create_menu) {
  1550. Point2i pos = tx->get_line_column_at_pos(local_pos);
  1551. int row = pos.y;
  1552. int col = pos.x;
  1553. tx->set_move_caret_on_right_click_enabled(EDITOR_GET("text_editor/behavior/navigation/move_caret_on_right_click"));
  1554. int caret_clicked = -1;
  1555. if (tx->is_move_caret_on_right_click_enabled()) {
  1556. if (tx->has_selection()) {
  1557. for (int i = 0; i < tx->get_caret_count(); i++) {
  1558. int from_line = tx->get_selection_from_line(i);
  1559. int to_line = tx->get_selection_to_line(i);
  1560. int from_column = tx->get_selection_from_column(i);
  1561. int to_column = tx->get_selection_to_column(i);
  1562. if (row >= from_line && row <= to_line && (row != from_line || col >= from_column) && (row != to_line || col <= to_column)) {
  1563. // Right click in one of the selected text
  1564. caret_clicked = i;
  1565. break;
  1566. }
  1567. }
  1568. }
  1569. if (caret_clicked < 0) {
  1570. tx->deselect();
  1571. tx->remove_secondary_carets();
  1572. caret_clicked = 0;
  1573. tx->set_caret_line(row, false, false);
  1574. tx->set_caret_column(col);
  1575. }
  1576. }
  1577. String word_at_pos = tx->get_word_at_pos(local_pos);
  1578. if (word_at_pos.is_empty()) {
  1579. word_at_pos = tx->get_word_under_caret(caret_clicked);
  1580. }
  1581. if (word_at_pos.is_empty()) {
  1582. word_at_pos = tx->get_selected_text(caret_clicked);
  1583. }
  1584. bool has_color = (word_at_pos == "Color");
  1585. bool foldable = tx->can_fold_line(row) || tx->is_line_folded(row);
  1586. bool open_docs = false;
  1587. bool goto_definition = false;
  1588. if (word_at_pos.is_resource_file()) {
  1589. open_docs = true;
  1590. } else {
  1591. Node *base = get_tree()->get_edited_scene_root();
  1592. if (base) {
  1593. base = _find_node_for_script(base, base, script);
  1594. }
  1595. ScriptLanguage::LookupResult result;
  1596. if (script->get_language()->lookup_code(tx->get_text_for_symbol_lookup(), word_at_pos, script->get_path(), base, result) == OK) {
  1597. open_docs = true;
  1598. }
  1599. }
  1600. if (has_color) {
  1601. String line = tx->get_line(row);
  1602. color_position.x = row;
  1603. color_position.y = col;
  1604. int begin = -1;
  1605. int end = -1;
  1606. enum EXPRESSION_PATTERNS {
  1607. NOT_PARSED,
  1608. RGBA_PARAMETER, // Color(float,float,float) or Color(float,float,float,float)
  1609. COLOR_NAME, // Color.COLOR_NAME
  1610. } expression_pattern = NOT_PARSED;
  1611. for (int i = col; i < line.length(); i++) {
  1612. if (line[i] == '(') {
  1613. if (expression_pattern == NOT_PARSED) {
  1614. begin = i;
  1615. expression_pattern = RGBA_PARAMETER;
  1616. } else {
  1617. // Method call or '(' appearing twice.
  1618. expression_pattern = NOT_PARSED;
  1619. break;
  1620. }
  1621. } else if (expression_pattern == RGBA_PARAMETER && line[i] == ')' && end < 0) {
  1622. end = i + 1;
  1623. break;
  1624. } else if (expression_pattern == NOT_PARSED && line[i] == '.') {
  1625. begin = i;
  1626. expression_pattern = COLOR_NAME;
  1627. } else if (expression_pattern == COLOR_NAME && end < 0 && (line[i] == ' ' || line[i] == '\t')) {
  1628. // Including '.' and spaces.
  1629. continue;
  1630. } else if (expression_pattern == COLOR_NAME && !(line[i] == '_' || ('A' <= line[i] && line[i] <= 'Z'))) {
  1631. end = i;
  1632. break;
  1633. }
  1634. }
  1635. switch (expression_pattern) {
  1636. case RGBA_PARAMETER: {
  1637. color_args = line.substr(begin, end - begin);
  1638. String stripped = color_args.replace(" ", "").replace("\t", "").replace("(", "").replace(")", "");
  1639. PackedFloat64Array color = stripped.split_floats(",");
  1640. if (color.size() > 2) {
  1641. float alpha = color.size() > 3 ? color[3] : 1.0f;
  1642. color_picker->set_pick_color(Color(color[0], color[1], color[2], alpha));
  1643. }
  1644. } break;
  1645. case COLOR_NAME: {
  1646. if (end < 0) {
  1647. end = line.length();
  1648. }
  1649. color_args = line.substr(begin, end - begin);
  1650. const String color_name = color_args.replace(" ", "").replace("\t", "").replace(".", "");
  1651. const int color_index = Color::find_named_color(color_name);
  1652. if (0 <= color_index) {
  1653. const Color color_constant = Color::get_named_color(color_index);
  1654. color_picker->set_pick_color(color_constant);
  1655. } else {
  1656. has_color = false;
  1657. }
  1658. } break;
  1659. default:
  1660. has_color = false;
  1661. break;
  1662. }
  1663. if (has_color) {
  1664. color_panel->set_position(get_screen_position() + local_pos);
  1665. }
  1666. }
  1667. _make_context_menu(tx->has_selection(), has_color, foldable, open_docs, goto_definition, local_pos);
  1668. }
  1669. }
  1670. void ScriptTextEditor::_color_changed(const Color &p_color) {
  1671. String new_args;
  1672. if (p_color.a == 1.0f) {
  1673. new_args = String("(" + rtos(p_color.r) + ", " + rtos(p_color.g) + ", " + rtos(p_color.b) + ")");
  1674. } else {
  1675. new_args = String("(" + rtos(p_color.r) + ", " + rtos(p_color.g) + ", " + rtos(p_color.b) + ", " + rtos(p_color.a) + ")");
  1676. }
  1677. String line = code_editor->get_text_editor()->get_line(color_position.x);
  1678. String line_with_replaced_args = line.replace(color_args, new_args);
  1679. color_args = new_args;
  1680. code_editor->get_text_editor()->begin_complex_operation();
  1681. code_editor->get_text_editor()->set_line(color_position.x, line_with_replaced_args);
  1682. code_editor->get_text_editor()->end_complex_operation();
  1683. code_editor->get_text_editor()->queue_redraw();
  1684. }
  1685. void ScriptTextEditor::_prepare_edit_menu() {
  1686. const CodeEdit *tx = code_editor->get_text_editor();
  1687. PopupMenu *popup = edit_menu->get_popup();
  1688. popup->set_item_disabled(popup->get_item_index(EDIT_UNDO), !tx->has_undo());
  1689. popup->set_item_disabled(popup->get_item_index(EDIT_REDO), !tx->has_redo());
  1690. }
  1691. void ScriptTextEditor::_make_context_menu(bool p_selection, bool p_color, bool p_foldable, bool p_open_docs, bool p_goto_definition, Vector2 p_pos) {
  1692. context_menu->clear();
  1693. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_undo"), EDIT_UNDO);
  1694. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_redo"), EDIT_REDO);
  1695. context_menu->add_separator();
  1696. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_cut"), EDIT_CUT);
  1697. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_copy"), EDIT_COPY);
  1698. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_paste"), EDIT_PASTE);
  1699. context_menu->add_separator();
  1700. context_menu->add_shortcut(ED_GET_SHORTCUT("ui_text_select_all"), EDIT_SELECT_ALL);
  1701. context_menu->add_separator();
  1702. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/indent"), EDIT_INDENT);
  1703. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/unindent"), EDIT_UNINDENT);
  1704. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_comment"), EDIT_TOGGLE_COMMENT);
  1705. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_bookmark"), BOOKMARK_TOGGLE);
  1706. if (p_selection) {
  1707. context_menu->add_separator();
  1708. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/convert_to_uppercase"), EDIT_TO_UPPERCASE);
  1709. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/convert_to_lowercase"), EDIT_TO_LOWERCASE);
  1710. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/evaluate_selection"), EDIT_EVALUATE);
  1711. }
  1712. if (p_foldable) {
  1713. context_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_fold_line"), EDIT_TOGGLE_FOLD_LINE);
  1714. }
  1715. if (p_color || p_open_docs || p_goto_definition) {
  1716. context_menu->add_separator();
  1717. if (p_open_docs) {
  1718. context_menu->add_item(TTR("Lookup Symbol"), LOOKUP_SYMBOL);
  1719. }
  1720. if (p_color) {
  1721. context_menu->add_item(TTR("Pick Color"), EDIT_PICK_COLOR);
  1722. }
  1723. }
  1724. const CodeEdit *tx = code_editor->get_text_editor();
  1725. context_menu->set_item_disabled(context_menu->get_item_index(EDIT_UNDO), !tx->has_undo());
  1726. context_menu->set_item_disabled(context_menu->get_item_index(EDIT_REDO), !tx->has_redo());
  1727. context_menu->set_position(get_screen_position() + p_pos);
  1728. context_menu->reset_size();
  1729. context_menu->popup();
  1730. }
  1731. void ScriptTextEditor::_enable_code_editor() {
  1732. ERR_FAIL_COND(code_editor->get_parent());
  1733. VSplitContainer *editor_box = memnew(VSplitContainer);
  1734. add_child(editor_box);
  1735. editor_box->set_anchors_and_offsets_preset(Control::PRESET_FULL_RECT);
  1736. editor_box->set_v_size_flags(SIZE_EXPAND_FILL);
  1737. editor_box->add_child(code_editor);
  1738. code_editor->connect("show_errors_panel", callable_mp(this, &ScriptTextEditor::_show_errors_panel));
  1739. code_editor->connect("show_warnings_panel", callable_mp(this, &ScriptTextEditor::_show_warnings_panel));
  1740. code_editor->connect("validate_script", callable_mp(this, &ScriptTextEditor::_validate_script));
  1741. code_editor->connect("load_theme_settings", callable_mp(this, &ScriptTextEditor::_load_theme_settings));
  1742. code_editor->get_text_editor()->connect("symbol_lookup", callable_mp(this, &ScriptTextEditor::_lookup_symbol));
  1743. code_editor->get_text_editor()->connect("symbol_validate", callable_mp(this, &ScriptTextEditor::_validate_symbol));
  1744. code_editor->get_text_editor()->connect("gutter_added", callable_mp(this, &ScriptTextEditor::_update_gutter_indexes));
  1745. code_editor->get_text_editor()->connect("gutter_removed", callable_mp(this, &ScriptTextEditor::_update_gutter_indexes));
  1746. code_editor->get_text_editor()->connect("gutter_clicked", callable_mp(this, &ScriptTextEditor::_gutter_clicked));
  1747. code_editor->get_text_editor()->connect("gui_input", callable_mp(this, &ScriptTextEditor::_text_edit_gui_input));
  1748. code_editor->show_toggle_scripts_button();
  1749. _update_gutter_indexes();
  1750. editor_box->add_child(warnings_panel);
  1751. warnings_panel->add_theme_font_override(
  1752. "normal_font", EditorNode::get_singleton()->get_gui_base()->get_theme_font(SNAME("main"), SNAME("EditorFonts")));
  1753. warnings_panel->add_theme_font_size_override(
  1754. "normal_font_size", EditorNode::get_singleton()->get_gui_base()->get_theme_font_size(SNAME("main_size"), SNAME("EditorFonts")));
  1755. warnings_panel->connect("meta_clicked", callable_mp(this, &ScriptTextEditor::_warning_clicked));
  1756. editor_box->add_child(errors_panel);
  1757. errors_panel->add_theme_font_override(
  1758. "normal_font", EditorNode::get_singleton()->get_gui_base()->get_theme_font(SNAME("main"), SNAME("EditorFonts")));
  1759. errors_panel->add_theme_font_size_override(
  1760. "normal_font_size", EditorNode::get_singleton()->get_gui_base()->get_theme_font_size(SNAME("main_size"), SNAME("EditorFonts")));
  1761. errors_panel->connect("meta_clicked", callable_mp(this, &ScriptTextEditor::_error_clicked));
  1762. add_child(context_menu);
  1763. context_menu->connect("id_pressed", callable_mp(this, &ScriptTextEditor::_edit_option));
  1764. add_child(color_panel);
  1765. color_picker = memnew(ColorPicker);
  1766. color_picker->set_deferred_mode(true);
  1767. color_picker->connect("color_changed", callable_mp(this, &ScriptTextEditor::_color_changed));
  1768. color_panel->connect("about_to_popup", callable_mp(EditorNode::get_singleton(), &EditorNode::setup_color_picker).bind(color_picker));
  1769. color_panel->add_child(color_picker);
  1770. quick_open = memnew(ScriptEditorQuickOpen);
  1771. quick_open->connect("goto_line", callable_mp(this, &ScriptTextEditor::_goto_line));
  1772. add_child(quick_open);
  1773. goto_line_dialog = memnew(GotoLineDialog);
  1774. add_child(goto_line_dialog);
  1775. add_child(connection_info_dialog);
  1776. edit_hb->add_child(edit_menu);
  1777. edit_menu->connect("about_to_popup", callable_mp(this, &ScriptTextEditor::_prepare_edit_menu));
  1778. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_undo"), EDIT_UNDO);
  1779. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_redo"), EDIT_REDO);
  1780. edit_menu->get_popup()->add_separator();
  1781. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_cut"), EDIT_CUT);
  1782. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_copy"), EDIT_COPY);
  1783. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_paste"), EDIT_PASTE);
  1784. edit_menu->get_popup()->add_separator();
  1785. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_text_select_all"), EDIT_SELECT_ALL);
  1786. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/duplicate_selection"), EDIT_DUPLICATE_SELECTION);
  1787. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/evaluate_selection"), EDIT_EVALUATE);
  1788. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_word_wrap"), EDIT_TOGGLE_WORD_WRAP);
  1789. edit_menu->get_popup()->add_separator();
  1790. {
  1791. PopupMenu *sub_menu = memnew(PopupMenu);
  1792. sub_menu->set_name("line_menu");
  1793. sub_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/move_up"), EDIT_MOVE_LINE_UP);
  1794. sub_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/move_down"), EDIT_MOVE_LINE_DOWN);
  1795. sub_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/indent"), EDIT_INDENT);
  1796. sub_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/unindent"), EDIT_UNINDENT);
  1797. sub_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/delete_line"), EDIT_DELETE_LINE);
  1798. sub_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_comment"), EDIT_TOGGLE_COMMENT);
  1799. sub_menu->connect("id_pressed", callable_mp(this, &ScriptTextEditor::_edit_option));
  1800. edit_menu->get_popup()->add_child(sub_menu);
  1801. edit_menu->get_popup()->add_submenu_item(TTR("Line"), "line_menu");
  1802. }
  1803. {
  1804. PopupMenu *sub_menu = memnew(PopupMenu);
  1805. sub_menu->set_name("folding_menu");
  1806. sub_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/toggle_fold_line"), EDIT_TOGGLE_FOLD_LINE);
  1807. sub_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/fold_all_lines"), EDIT_FOLD_ALL_LINES);
  1808. sub_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/unfold_all_lines"), EDIT_UNFOLD_ALL_LINES);
  1809. sub_menu->connect("id_pressed", callable_mp(this, &ScriptTextEditor::_edit_option));
  1810. edit_menu->get_popup()->add_child(sub_menu);
  1811. edit_menu->get_popup()->add_submenu_item(TTR("Folding"), "folding_menu");
  1812. }
  1813. edit_menu->get_popup()->add_separator();
  1814. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("ui_text_completion_query"), EDIT_COMPLETE);
  1815. edit_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/trim_trailing_whitespace"), EDIT_TRIM_TRAILING_WHITESAPCE);
  1816. {
  1817. PopupMenu *sub_menu = memnew(PopupMenu);
  1818. sub_menu->set_name("indent_menu");
  1819. sub_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/convert_indent_to_spaces"), EDIT_CONVERT_INDENT_TO_SPACES);
  1820. sub_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/convert_indent_to_tabs"), EDIT_CONVERT_INDENT_TO_TABS);
  1821. sub_menu->add_shortcut(ED_GET_SHORTCUT("script_text_editor/auto_indent"), EDIT_AUTO_INDENT);
  1822. sub_menu->connect("id_pressed", callable_mp(this, &ScriptTextEditor::_edit_option));
  1823. edit_menu->get_popup()->add_child(sub_menu);
  1824. edit_menu->get_popup()->add_submenu_item(TTR("Indentation"), "indent_menu");
  1825. }
  1826. edit_menu->get_popup()->connect("id_pressed", callable_mp(this, &ScriptTextEditor::_edit_option));
  1827. edit_menu->get_popup()->add_separator();
  1828. {
  1829. PopupMenu *sub_menu = memnew(PopupMenu);
  1830. sub_menu->set_name("convert_case");
  1831. sub_menu->add_shortcut(ED_SHORTCUT("script_text_editor/convert_to_uppercase", TTR("Uppercase"), KeyModifierMask::SHIFT | Key::F4), EDIT_TO_UPPERCASE);
  1832. sub_menu->add_shortcut(ED_SHORTCUT("script_text_editor/convert_to_lowercase", TTR("Lowercase"), KeyModifierMask::SHIFT | Key::F5), EDIT_TO_LOWERCASE);
  1833. sub_menu->add_shortcut(ED_SHORTCUT("script_text_editor/capitalize", TTR("Capitalize"), KeyModifierMask::SHIFT | Key::F6), EDIT_CAPITALIZE);
  1834. sub_menu->connect("id_pressed", callable_mp(this, &ScriptTextEditor::_edit_option));
  1835. edit_menu->get_popup()->add_child(sub_menu);
  1836. edit_menu->get_popup()->add_submenu_item(TTR("Convert Case"), "convert_case");
  1837. }
  1838. edit_menu->get_popup()->add_child(highlighter_menu);
  1839. edit_menu->get_popup()->add_submenu_item(TTR("Syntax Highlighter"), "highlighter_menu");
  1840. highlighter_menu->connect("id_pressed", callable_mp(this, &ScriptTextEditor::_change_syntax_highlighter));
  1841. edit_hb->add_child(search_menu);
  1842. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/find"), SEARCH_FIND);
  1843. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/find_next"), SEARCH_FIND_NEXT);
  1844. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/find_previous"), SEARCH_FIND_PREV);
  1845. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/replace"), SEARCH_REPLACE);
  1846. search_menu->get_popup()->add_separator();
  1847. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/find_in_files"), SEARCH_IN_FILES);
  1848. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/replace_in_files"), REPLACE_IN_FILES);
  1849. search_menu->get_popup()->add_separator();
  1850. search_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/contextual_help"), HELP_CONTEXTUAL);
  1851. search_menu->get_popup()->connect("id_pressed", callable_mp(this, &ScriptTextEditor::_edit_option));
  1852. _load_theme_settings();
  1853. edit_hb->add_child(goto_menu);
  1854. goto_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/goto_function"), SEARCH_LOCATE_FUNCTION);
  1855. goto_menu->get_popup()->add_shortcut(ED_GET_SHORTCUT("script_text_editor/goto_line"), SEARCH_GOTO_LINE);
  1856. goto_menu->get_popup()->add_separator();
  1857. goto_menu->get_popup()->add_child(bookmarks_menu);
  1858. goto_menu->get_popup()->add_submenu_item(TTR("Bookmarks"), "Bookmarks");
  1859. _update_bookmark_list();
  1860. bookmarks_menu->connect("about_to_popup", callable_mp(this, &ScriptTextEditor::_update_bookmark_list));
  1861. bookmarks_menu->connect("index_pressed", callable_mp(this, &ScriptTextEditor::_bookmark_item_pressed));
  1862. goto_menu->get_popup()->add_child(breakpoints_menu);
  1863. goto_menu->get_popup()->add_submenu_item(TTR("Breakpoints"), "Breakpoints");
  1864. _update_breakpoint_list();
  1865. breakpoints_menu->connect("about_to_popup", callable_mp(this, &ScriptTextEditor::_update_breakpoint_list));
  1866. breakpoints_menu->connect("index_pressed", callable_mp(this, &ScriptTextEditor::_breakpoint_item_pressed));
  1867. goto_menu->get_popup()->connect("id_pressed", callable_mp(this, &ScriptTextEditor::_edit_option));
  1868. }
  1869. ScriptTextEditor::ScriptTextEditor() {
  1870. code_editor = memnew(CodeTextEditor);
  1871. code_editor->add_theme_constant_override("separation", 2);
  1872. code_editor->set_anchors_and_offsets_preset(Control::PRESET_FULL_RECT);
  1873. code_editor->set_code_complete_func(_code_complete_scripts, this);
  1874. code_editor->set_v_size_flags(SIZE_EXPAND_FILL);
  1875. code_editor->get_text_editor()->set_draw_breakpoints_gutter(true);
  1876. code_editor->get_text_editor()->set_draw_executing_lines_gutter(true);
  1877. code_editor->get_text_editor()->connect("breakpoint_toggled", callable_mp(this, &ScriptTextEditor::_breakpoint_toggled));
  1878. connection_gutter = 1;
  1879. code_editor->get_text_editor()->add_gutter(connection_gutter);
  1880. code_editor->get_text_editor()->set_gutter_name(connection_gutter, "connection_gutter");
  1881. code_editor->get_text_editor()->set_gutter_draw(connection_gutter, false);
  1882. code_editor->get_text_editor()->set_gutter_overwritable(connection_gutter, true);
  1883. code_editor->get_text_editor()->set_gutter_type(connection_gutter, TextEdit::GUTTER_TYPE_ICON);
  1884. warnings_panel = memnew(RichTextLabel);
  1885. warnings_panel->set_custom_minimum_size(Size2(0, 100 * EDSCALE));
  1886. warnings_panel->set_h_size_flags(SIZE_EXPAND_FILL);
  1887. warnings_panel->set_meta_underline(true);
  1888. warnings_panel->set_selection_enabled(true);
  1889. warnings_panel->set_context_menu_enabled(true);
  1890. warnings_panel->set_focus_mode(FOCUS_CLICK);
  1891. warnings_panel->hide();
  1892. errors_panel = memnew(RichTextLabel);
  1893. errors_panel->set_custom_minimum_size(Size2(0, 100 * EDSCALE));
  1894. errors_panel->set_h_size_flags(SIZE_EXPAND_FILL);
  1895. errors_panel->set_meta_underline(true);
  1896. errors_panel->set_selection_enabled(true);
  1897. errors_panel->set_context_menu_enabled(true);
  1898. errors_panel->set_focus_mode(FOCUS_CLICK);
  1899. errors_panel->hide();
  1900. update_settings();
  1901. code_editor->get_text_editor()->set_code_hint_draw_below(EDITOR_GET("text_editor/completion/put_callhint_tooltip_below_current_line"));
  1902. code_editor->get_text_editor()->set_symbol_lookup_on_click_enabled(true);
  1903. code_editor->get_text_editor()->set_context_menu_enabled(false);
  1904. context_menu = memnew(PopupMenu);
  1905. color_panel = memnew(PopupPanel);
  1906. edit_hb = memnew(HBoxContainer);
  1907. edit_menu = memnew(MenuButton);
  1908. edit_menu->set_text(TTR("Edit"));
  1909. edit_menu->set_switch_on_hover(true);
  1910. edit_menu->set_shortcut_context(this);
  1911. highlighter_menu = memnew(PopupMenu);
  1912. highlighter_menu->set_name("highlighter_menu");
  1913. Ref<EditorPlainTextSyntaxHighlighter> plain_highlighter;
  1914. plain_highlighter.instantiate();
  1915. add_syntax_highlighter(plain_highlighter);
  1916. Ref<EditorStandardSyntaxHighlighter> highlighter;
  1917. highlighter.instantiate();
  1918. add_syntax_highlighter(highlighter);
  1919. set_syntax_highlighter(highlighter);
  1920. search_menu = memnew(MenuButton);
  1921. search_menu->set_text(TTR("Search"));
  1922. search_menu->set_switch_on_hover(true);
  1923. search_menu->set_shortcut_context(this);
  1924. goto_menu = memnew(MenuButton);
  1925. goto_menu->set_text(TTR("Go To"));
  1926. goto_menu->set_switch_on_hover(true);
  1927. goto_menu->set_shortcut_context(this);
  1928. bookmarks_menu = memnew(PopupMenu);
  1929. bookmarks_menu->set_name("Bookmarks");
  1930. breakpoints_menu = memnew(PopupMenu);
  1931. breakpoints_menu->set_name("Breakpoints");
  1932. connection_info_dialog = memnew(ConnectionInfoDialog);
  1933. SET_DRAG_FORWARDING_GCD(code_editor->get_text_editor(), ScriptTextEditor);
  1934. }
  1935. ScriptTextEditor::~ScriptTextEditor() {
  1936. highlighters.clear();
  1937. if (!editor_enabled) {
  1938. memdelete(code_editor);
  1939. memdelete(warnings_panel);
  1940. memdelete(errors_panel);
  1941. memdelete(context_menu);
  1942. memdelete(color_panel);
  1943. memdelete(edit_hb);
  1944. memdelete(edit_menu);
  1945. memdelete(highlighter_menu);
  1946. memdelete(search_menu);
  1947. memdelete(goto_menu);
  1948. memdelete(bookmarks_menu);
  1949. memdelete(breakpoints_menu);
  1950. memdelete(connection_info_dialog);
  1951. }
  1952. }
  1953. static ScriptEditorBase *create_editor(const Ref<Resource> &p_resource) {
  1954. if (Object::cast_to<Script>(*p_resource)) {
  1955. return memnew(ScriptTextEditor);
  1956. }
  1957. return nullptr;
  1958. }
  1959. void ScriptTextEditor::register_editor() {
  1960. ED_SHORTCUT("script_text_editor/move_up", TTR("Move Up"), KeyModifierMask::ALT | Key::UP);
  1961. ED_SHORTCUT("script_text_editor/move_down", TTR("Move Down"), KeyModifierMask::ALT | Key::DOWN);
  1962. ED_SHORTCUT("script_text_editor/delete_line", TTR("Delete Line"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::K);
  1963. // Leave these at zero, same can be accomplished with tab/shift-tab, including selection.
  1964. // The next/previous in history shortcut in this case makes a lot more sense.
  1965. ED_SHORTCUT("script_text_editor/indent", TTR("Indent"), Key::NONE);
  1966. ED_SHORTCUT("script_text_editor/unindent", TTR("Unindent"), KeyModifierMask::SHIFT | Key::TAB);
  1967. ED_SHORTCUT_ARRAY("script_text_editor/toggle_comment", TTR("Toggle Comment"), { int32_t(KeyModifierMask::CMD_OR_CTRL | Key::K), int32_t(KeyModifierMask::CMD_OR_CTRL | Key::SLASH) });
  1968. ED_SHORTCUT("script_text_editor/toggle_fold_line", TTR("Fold/Unfold Line"), KeyModifierMask::ALT | Key::F);
  1969. ED_SHORTCUT_OVERRIDE("script_text_editor/toggle_fold_line", "macos", KeyModifierMask::CTRL | KeyModifierMask::META | Key::F);
  1970. ED_SHORTCUT("script_text_editor/fold_all_lines", TTR("Fold All Lines"), Key::NONE);
  1971. ED_SHORTCUT("script_text_editor/unfold_all_lines", TTR("Unfold All Lines"), Key::NONE);
  1972. ED_SHORTCUT("script_text_editor/duplicate_selection", TTR("Duplicate Selection"), KeyModifierMask::SHIFT | KeyModifierMask::CTRL | Key::D);
  1973. ED_SHORTCUT_OVERRIDE("script_text_editor/duplicate_selection", "macos", KeyModifierMask::SHIFT | KeyModifierMask::META | Key::C);
  1974. ED_SHORTCUT("script_text_editor/evaluate_selection", TTR("Evaluate Selection"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::E);
  1975. ED_SHORTCUT("script_text_editor/toggle_word_wrap", TTR("Toggle Word Wrap"), KeyModifierMask::ALT | Key::Z);
  1976. ED_SHORTCUT("script_text_editor/trim_trailing_whitespace", TTR("Trim Trailing Whitespace"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::ALT | Key::T);
  1977. ED_SHORTCUT("script_text_editor/convert_indent_to_spaces", TTR("Convert Indent to Spaces"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::Y);
  1978. ED_SHORTCUT("script_text_editor/convert_indent_to_tabs", TTR("Convert Indent to Tabs"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::I);
  1979. ED_SHORTCUT("script_text_editor/auto_indent", TTR("Auto Indent"), KeyModifierMask::CMD_OR_CTRL | Key::I);
  1980. ED_SHORTCUT_AND_COMMAND("script_text_editor/find", TTR("Find..."), KeyModifierMask::CMD_OR_CTRL | Key::F);
  1981. ED_SHORTCUT("script_text_editor/find_next", TTR("Find Next"), Key::F3);
  1982. ED_SHORTCUT_OVERRIDE("script_text_editor/find_next", "macos", KeyModifierMask::META | Key::G);
  1983. ED_SHORTCUT("script_text_editor/find_previous", TTR("Find Previous"), KeyModifierMask::SHIFT | Key::F3);
  1984. ED_SHORTCUT_OVERRIDE("script_text_editor/find_previous", "macos", KeyModifierMask::META | KeyModifierMask::SHIFT | Key::G);
  1985. ED_SHORTCUT_AND_COMMAND("script_text_editor/replace", TTR("Replace..."), KeyModifierMask::CTRL | Key::R);
  1986. ED_SHORTCUT_OVERRIDE("script_text_editor/replace", "macos", KeyModifierMask::ALT | KeyModifierMask::META | Key::F);
  1987. ED_SHORTCUT("script_text_editor/find_in_files", TTR("Find in Files..."), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::F);
  1988. ED_SHORTCUT("script_text_editor/replace_in_files", TTR("Replace in Files..."), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::R);
  1989. ED_SHORTCUT("script_text_editor/contextual_help", TTR("Contextual Help"), KeyModifierMask::ALT | Key::F1);
  1990. ED_SHORTCUT_OVERRIDE("script_text_editor/contextual_help", "macos", KeyModifierMask::ALT | KeyModifierMask::SHIFT | Key::SPACE);
  1991. ED_SHORTCUT("script_text_editor/toggle_bookmark", TTR("Toggle Bookmark"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::ALT | Key::B);
  1992. ED_SHORTCUT("script_text_editor/goto_next_bookmark", TTR("Go to Next Bookmark"), KeyModifierMask::CMD_OR_CTRL | Key::B);
  1993. ED_SHORTCUT("script_text_editor/goto_previous_bookmark", TTR("Go to Previous Bookmark"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::B);
  1994. ED_SHORTCUT("script_text_editor/remove_all_bookmarks", TTR("Remove All Bookmarks"), Key::NONE);
  1995. ED_SHORTCUT("script_text_editor/goto_function", TTR("Go to Function..."), KeyModifierMask::ALT | KeyModifierMask::CTRL | Key::F);
  1996. ED_SHORTCUT_OVERRIDE("script_text_editor/goto_function", "macos", KeyModifierMask::CTRL | KeyModifierMask::META | Key::J);
  1997. ED_SHORTCUT("script_text_editor/goto_line", TTR("Go to Line..."), KeyModifierMask::CMD_OR_CTRL | Key::L);
  1998. ED_SHORTCUT("script_text_editor/toggle_breakpoint", TTR("Toggle Breakpoint"), Key::F9);
  1999. ED_SHORTCUT_OVERRIDE("script_text_editor/toggle_breakpoint", "macos", KeyModifierMask::META | KeyModifierMask::SHIFT | Key::B);
  2000. ED_SHORTCUT("script_text_editor/remove_all_breakpoints", TTR("Remove All Breakpoints"), KeyModifierMask::CMD_OR_CTRL | KeyModifierMask::SHIFT | Key::F9);
  2001. ED_SHORTCUT("script_text_editor/goto_next_breakpoint", TTR("Go to Next Breakpoint"), KeyModifierMask::CMD_OR_CTRL | Key::PERIOD);
  2002. ED_SHORTCUT("script_text_editor/goto_previous_breakpoint", TTR("Go to Previous Breakpoint"), KeyModifierMask::CMD_OR_CTRL | Key::COMMA);
  2003. ScriptEditor::register_create_script_editor_function(create_editor);
  2004. }
  2005. void ScriptTextEditor::validate() {
  2006. this->code_editor->validate_script();
  2007. }