script_text_editor.cpp 86 KB

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