script_text_editor.cpp 86 KB

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