code_edit.cpp 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971
  1. /*************************************************************************/
  2. /* code_edit.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "code_edit.h"
  31. #include "core/string/ustring.h"
  32. static bool _is_whitespace(char32_t c) {
  33. return c == '\t' || c == ' ';
  34. }
  35. void CodeEdit::_notification(int p_what) {
  36. switch (p_what) {
  37. case NOTIFICATION_THEME_CHANGED:
  38. case NOTIFICATION_ENTER_TREE: {
  39. set_gutter_width(main_gutter, get_row_height());
  40. set_gutter_width(line_number_gutter, (line_number_digits + 1) * cache.font->get_char_size('0', 0, cache.font_size).width);
  41. set_gutter_width(fold_gutter, get_row_height() / 1.2);
  42. breakpoint_color = get_theme_color("breakpoint_color");
  43. breakpoint_icon = get_theme_icon("breakpoint");
  44. bookmark_color = get_theme_color("bookmark_color");
  45. bookmark_icon = get_theme_icon("bookmark");
  46. executing_line_color = get_theme_color("executing_line_color");
  47. executing_line_icon = get_theme_icon("executing_line");
  48. line_number_color = get_theme_color("line_number_color");
  49. folding_color = get_theme_color("code_folding_color");
  50. can_fold_icon = get_theme_icon("can_fold");
  51. folded_icon = get_theme_icon("folded");
  52. } break;
  53. case NOTIFICATION_DRAW: {
  54. } break;
  55. }
  56. }
  57. /* Main Gutter */
  58. void CodeEdit::_update_draw_main_gutter() {
  59. set_gutter_draw(main_gutter, draw_breakpoints || draw_bookmarks || draw_executing_lines);
  60. }
  61. void CodeEdit::set_draw_breakpoints_gutter(bool p_draw) {
  62. draw_breakpoints = p_draw;
  63. set_gutter_clickable(main_gutter, p_draw);
  64. _update_draw_main_gutter();
  65. }
  66. bool CodeEdit::is_drawing_breakpoints_gutter() const {
  67. return draw_breakpoints;
  68. }
  69. void CodeEdit::set_draw_bookmarks_gutter(bool p_draw) {
  70. draw_bookmarks = p_draw;
  71. _update_draw_main_gutter();
  72. }
  73. bool CodeEdit::is_drawing_bookmarks_gutter() const {
  74. return draw_bookmarks;
  75. }
  76. void CodeEdit::set_draw_executing_lines_gutter(bool p_draw) {
  77. draw_executing_lines = p_draw;
  78. _update_draw_main_gutter();
  79. }
  80. bool CodeEdit::is_drawing_executing_lines_gutter() const {
  81. return draw_executing_lines;
  82. }
  83. void CodeEdit::_main_gutter_draw_callback(int p_line, int p_gutter, const Rect2 &p_region) {
  84. if (draw_breakpoints && is_line_breakpointed(p_line)) {
  85. int padding = p_region.size.x / 6;
  86. Rect2 breakpoint_region = p_region;
  87. breakpoint_region.position += Point2(padding, padding);
  88. breakpoint_region.size -= Point2(padding, padding) * 2;
  89. breakpoint_icon->draw_rect(get_canvas_item(), breakpoint_region, false, breakpoint_color);
  90. }
  91. if (draw_bookmarks && is_line_bookmarked(p_line)) {
  92. int horizontal_padding = p_region.size.x / 2;
  93. int vertical_padding = p_region.size.y / 4;
  94. Rect2 bookmark_region = p_region;
  95. bookmark_region.position += Point2(horizontal_padding, 0);
  96. bookmark_region.size -= Point2(horizontal_padding * 1.1, vertical_padding);
  97. bookmark_icon->draw_rect(get_canvas_item(), bookmark_region, false, bookmark_color);
  98. }
  99. if (draw_executing_lines && is_line_executing(p_line)) {
  100. int horizontal_padding = p_region.size.x / 10;
  101. int vertical_padding = p_region.size.y / 4;
  102. Rect2 executing_line_region = p_region;
  103. executing_line_region.position += Point2(horizontal_padding, vertical_padding);
  104. executing_line_region.size -= Point2(horizontal_padding, vertical_padding) * 2;
  105. executing_line_icon->draw_rect(get_canvas_item(), executing_line_region, false, executing_line_color);
  106. }
  107. }
  108. // Breakpoints
  109. void CodeEdit::set_line_as_breakpoint(int p_line, bool p_breakpointed) {
  110. int mask = get_line_gutter_metadata(p_line, main_gutter);
  111. set_line_gutter_metadata(p_line, main_gutter, p_breakpointed ? mask | MAIN_GUTTER_BREAKPOINT : mask & ~MAIN_GUTTER_BREAKPOINT);
  112. if (p_breakpointed) {
  113. breakpointed_lines[p_line] = true;
  114. } else if (breakpointed_lines.has(p_line)) {
  115. breakpointed_lines.erase(p_line);
  116. }
  117. emit_signal("breakpoint_toggled", p_line);
  118. update();
  119. }
  120. bool CodeEdit::is_line_breakpointed(int p_line) const {
  121. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_BREAKPOINT;
  122. }
  123. void CodeEdit::clear_breakpointed_lines() {
  124. for (int i = 0; i < get_line_count(); i++) {
  125. if (is_line_breakpointed(i)) {
  126. set_line_as_breakpoint(i, false);
  127. }
  128. }
  129. }
  130. Array CodeEdit::get_breakpointed_lines() const {
  131. Array ret;
  132. for (int i = 0; i < get_line_count(); i++) {
  133. if (is_line_breakpointed(i)) {
  134. ret.append(i);
  135. }
  136. }
  137. return ret;
  138. }
  139. // Bookmarks
  140. void CodeEdit::set_line_as_bookmarked(int p_line, bool p_bookmarked) {
  141. int mask = get_line_gutter_metadata(p_line, main_gutter);
  142. set_line_gutter_metadata(p_line, main_gutter, p_bookmarked ? mask | MAIN_GUTTER_BOOKMARK : mask & ~MAIN_GUTTER_BOOKMARK);
  143. update();
  144. }
  145. bool CodeEdit::is_line_bookmarked(int p_line) const {
  146. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_BOOKMARK;
  147. }
  148. void CodeEdit::clear_bookmarked_lines() {
  149. for (int i = 0; i < get_line_count(); i++) {
  150. if (is_line_bookmarked(i)) {
  151. set_line_as_bookmarked(i, false);
  152. }
  153. }
  154. }
  155. Array CodeEdit::get_bookmarked_lines() const {
  156. Array ret;
  157. for (int i = 0; i < get_line_count(); i++) {
  158. if (is_line_bookmarked(i)) {
  159. ret.append(i);
  160. }
  161. }
  162. return ret;
  163. }
  164. // executing lines
  165. void CodeEdit::set_line_as_executing(int p_line, bool p_executing) {
  166. int mask = get_line_gutter_metadata(p_line, main_gutter);
  167. set_line_gutter_metadata(p_line, main_gutter, p_executing ? mask | MAIN_GUTTER_EXECUTING : mask & ~MAIN_GUTTER_EXECUTING);
  168. update();
  169. }
  170. bool CodeEdit::is_line_executing(int p_line) const {
  171. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_EXECUTING;
  172. }
  173. void CodeEdit::clear_executing_lines() {
  174. for (int i = 0; i < get_line_count(); i++) {
  175. if (is_line_executing(i)) {
  176. set_line_as_executing(i, false);
  177. }
  178. }
  179. }
  180. Array CodeEdit::get_executing_lines() const {
  181. Array ret;
  182. for (int i = 0; i < get_line_count(); i++) {
  183. if (is_line_executing(i)) {
  184. ret.append(i);
  185. }
  186. }
  187. return ret;
  188. }
  189. /* Line numbers */
  190. void CodeEdit::set_draw_line_numbers(bool p_draw) {
  191. set_gutter_draw(line_number_gutter, p_draw);
  192. }
  193. bool CodeEdit::is_draw_line_numbers_enabled() const {
  194. return is_gutter_drawn(line_number_gutter);
  195. }
  196. void CodeEdit::set_line_numbers_zero_padded(bool p_zero_padded) {
  197. p_zero_padded ? line_number_padding = "0" : line_number_padding = " ";
  198. update();
  199. }
  200. bool CodeEdit::is_line_numbers_zero_padded() const {
  201. return line_number_padding == "0";
  202. }
  203. void CodeEdit::_line_number_draw_callback(int p_line, int p_gutter, const Rect2 &p_region) {
  204. String fc = TS->format_number(String::num(p_line + 1).lpad(line_number_digits, line_number_padding));
  205. Ref<TextLine> tl;
  206. tl.instance();
  207. tl->add_string(fc, cache.font, cache.font_size);
  208. int yofs = p_region.position.y + (get_row_height() - tl->get_size().y) / 2;
  209. Color number_color = get_line_gutter_item_color(p_line, line_number_gutter);
  210. if (number_color == Color(1, 1, 1)) {
  211. number_color = line_number_color;
  212. }
  213. tl->draw(get_canvas_item(), Point2(p_region.position.x, yofs), number_color);
  214. }
  215. /* Fold Gutter */
  216. void CodeEdit::set_draw_fold_gutter(bool p_draw) {
  217. set_gutter_draw(fold_gutter, p_draw);
  218. }
  219. bool CodeEdit::is_drawing_fold_gutter() const {
  220. return is_gutter_drawn(fold_gutter);
  221. }
  222. void CodeEdit::_fold_gutter_draw_callback(int p_line, int p_gutter, Rect2 p_region) {
  223. if (!can_fold(p_line) && !is_folded(p_line)) {
  224. set_line_gutter_clickable(p_line, fold_gutter, false);
  225. return;
  226. }
  227. set_line_gutter_clickable(p_line, fold_gutter, true);
  228. int horizontal_padding = p_region.size.x / 10;
  229. int vertical_padding = p_region.size.y / 6;
  230. p_region.position += Point2(horizontal_padding, vertical_padding);
  231. p_region.size -= Point2(horizontal_padding, vertical_padding) * 2;
  232. if (can_fold(p_line)) {
  233. can_fold_icon->draw_rect(get_canvas_item(), p_region, false, folding_color);
  234. return;
  235. }
  236. folded_icon->draw_rect(get_canvas_item(), p_region, false, folding_color);
  237. }
  238. /* Delimiters */
  239. // Strings
  240. void CodeEdit::add_string_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only) {
  241. _add_delimiter(p_start_key, p_end_key, p_line_only, TYPE_STRING);
  242. }
  243. void CodeEdit::remove_string_delimiter(const String &p_start_key) {
  244. _remove_delimiter(p_start_key, TYPE_STRING);
  245. }
  246. bool CodeEdit::has_string_delimiter(const String &p_start_key) const {
  247. return _has_delimiter(p_start_key, TYPE_STRING);
  248. }
  249. void CodeEdit::set_string_delimiters(const TypedArray<String> &p_string_delimiters) {
  250. _set_delimiters(p_string_delimiters, TYPE_STRING);
  251. }
  252. void CodeEdit::clear_string_delimiters() {
  253. _clear_delimiters(TYPE_STRING);
  254. }
  255. TypedArray<String> CodeEdit::get_string_delimiters() const {
  256. return _get_delimiters(TYPE_STRING);
  257. }
  258. int CodeEdit::is_in_string(int p_line, int p_column) const {
  259. return _is_in_delimiter(p_line, p_column, TYPE_STRING);
  260. }
  261. // Comments
  262. void CodeEdit::add_comment_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only) {
  263. _add_delimiter(p_start_key, p_end_key, p_line_only, TYPE_COMMENT);
  264. }
  265. void CodeEdit::remove_comment_delimiter(const String &p_start_key) {
  266. _remove_delimiter(p_start_key, TYPE_COMMENT);
  267. }
  268. bool CodeEdit::has_comment_delimiter(const String &p_start_key) const {
  269. return _has_delimiter(p_start_key, TYPE_COMMENT);
  270. }
  271. void CodeEdit::set_comment_delimiters(const TypedArray<String> &p_comment_delimiters) {
  272. _set_delimiters(p_comment_delimiters, TYPE_COMMENT);
  273. }
  274. void CodeEdit::clear_comment_delimiters() {
  275. _clear_delimiters(TYPE_COMMENT);
  276. }
  277. TypedArray<String> CodeEdit::get_comment_delimiters() const {
  278. return _get_delimiters(TYPE_COMMENT);
  279. }
  280. int CodeEdit::is_in_comment(int p_line, int p_column) const {
  281. return _is_in_delimiter(p_line, p_column, TYPE_COMMENT);
  282. }
  283. String CodeEdit::get_delimiter_start_key(int p_delimiter_idx) const {
  284. ERR_FAIL_INDEX_V(p_delimiter_idx, delimiters.size(), "");
  285. return delimiters[p_delimiter_idx].start_key;
  286. }
  287. String CodeEdit::get_delimiter_end_key(int p_delimiter_idx) const {
  288. ERR_FAIL_INDEX_V(p_delimiter_idx, delimiters.size(), "");
  289. return delimiters[p_delimiter_idx].end_key;
  290. }
  291. Point2 CodeEdit::get_delimiter_start_position(int p_line, int p_column) const {
  292. if (delimiters.size() == 0) {
  293. return Point2(-1, -1);
  294. }
  295. ERR_FAIL_INDEX_V(p_line, get_line_count(), Point2(-1, -1));
  296. ERR_FAIL_COND_V(p_column - 1 > get_line(p_line).size(), Point2(-1, -1));
  297. Point2 start_position;
  298. start_position.y = -1;
  299. start_position.x = -1;
  300. bool in_region = ((p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->value()) != -1;
  301. /* Check the keys for this line. */
  302. for (Map<int, int>::Element *E = delimiter_cache[p_line].front(); E; E = E->next()) {
  303. if (E->key() > p_column) {
  304. break;
  305. }
  306. in_region = E->value() != -1;
  307. start_position.x = in_region ? E->key() : -1;
  308. }
  309. /* Region was found on this line and is not a multiline continuation. */
  310. if (start_position.x != -1 && start_position.x != get_line(p_line).length() + 1) {
  311. start_position.y = p_line;
  312. return start_position;
  313. }
  314. /* Not in a region */
  315. if (!in_region) {
  316. return start_position;
  317. }
  318. /* Region starts on a previous line */
  319. for (int i = p_line - 1; i >= 0; i--) {
  320. if (delimiter_cache[i].size() < 1) {
  321. continue;
  322. }
  323. start_position.y = i;
  324. start_position.x = delimiter_cache[i].back()->key();
  325. /* Make sure it's not a multiline continuation. */
  326. if (start_position.x != get_line(i).length() + 1) {
  327. break;
  328. }
  329. }
  330. return start_position;
  331. }
  332. Point2 CodeEdit::get_delimiter_end_position(int p_line, int p_column) const {
  333. if (delimiters.size() == 0) {
  334. return Point2(-1, -1);
  335. }
  336. ERR_FAIL_INDEX_V(p_line, get_line_count(), Point2(-1, -1));
  337. ERR_FAIL_COND_V(p_column - 1 > get_line(p_line).size(), Point2(-1, -1));
  338. Point2 end_position;
  339. end_position.y = -1;
  340. end_position.x = -1;
  341. int region = (p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->value();
  342. /* Check the keys for this line. */
  343. for (Map<int, int>::Element *E = delimiter_cache[p_line].front(); E; E = E->next()) {
  344. end_position.x = (E->value() == -1) ? E->key() : -1;
  345. if (E->key() > p_column) {
  346. break;
  347. }
  348. region = E->value();
  349. }
  350. /* Region was found on this line and is not a multiline continuation. */
  351. if (region != -1 && end_position.x != -1 && (delimiters[region].line_only || end_position.x != get_line(p_line).length() + 1)) {
  352. end_position.y = p_line;
  353. return end_position;
  354. }
  355. /* Not in a region */
  356. if (region == -1) {
  357. end_position.x = -1;
  358. return end_position;
  359. }
  360. /* Region ends on a later line */
  361. for (int i = p_line + 1; i < get_line_count(); i++) {
  362. if (delimiter_cache[i].size() < 1 || delimiter_cache[i].front()->value() != -1) {
  363. continue;
  364. }
  365. end_position.x = delimiter_cache[i].front()->key();
  366. /* Make sure it's not a multiline continuation. */
  367. if (get_line(i).length() > 0 && end_position.x != get_line(i).length() + 1) {
  368. end_position.y = i;
  369. break;
  370. }
  371. end_position.x = -1;
  372. }
  373. return end_position;
  374. }
  375. void CodeEdit::_bind_methods() {
  376. /* Main Gutter */
  377. ClassDB::bind_method(D_METHOD("_main_gutter_draw_callback"), &CodeEdit::_main_gutter_draw_callback);
  378. ClassDB::bind_method(D_METHOD("set_draw_breakpoints_gutter", "enable"), &CodeEdit::set_draw_breakpoints_gutter);
  379. ClassDB::bind_method(D_METHOD("is_drawing_breakpoints_gutter"), &CodeEdit::is_drawing_breakpoints_gutter);
  380. ClassDB::bind_method(D_METHOD("set_draw_bookmarks_gutter", "enable"), &CodeEdit::set_draw_bookmarks_gutter);
  381. ClassDB::bind_method(D_METHOD("is_drawing_bookmarks_gutter"), &CodeEdit::is_drawing_bookmarks_gutter);
  382. ClassDB::bind_method(D_METHOD("set_draw_executing_lines_gutter", "enable"), &CodeEdit::set_draw_executing_lines_gutter);
  383. ClassDB::bind_method(D_METHOD("is_drawing_executing_lines_gutter"), &CodeEdit::is_drawing_executing_lines_gutter);
  384. // Breakpoints
  385. ClassDB::bind_method(D_METHOD("set_line_as_breakpoint", "line", "breakpointed"), &CodeEdit::set_line_as_breakpoint);
  386. ClassDB::bind_method(D_METHOD("is_line_breakpointed", "line"), &CodeEdit::is_line_breakpointed);
  387. ClassDB::bind_method(D_METHOD("clear_breakpointed_lines"), &CodeEdit::clear_breakpointed_lines);
  388. ClassDB::bind_method(D_METHOD("get_breakpointed_lines"), &CodeEdit::get_breakpointed_lines);
  389. // Bookmarks
  390. ClassDB::bind_method(D_METHOD("set_line_as_bookmarked", "line", "bookmarked"), &CodeEdit::set_line_as_bookmarked);
  391. ClassDB::bind_method(D_METHOD("is_line_bookmarked", "line"), &CodeEdit::is_line_bookmarked);
  392. ClassDB::bind_method(D_METHOD("clear_bookmarked_lines"), &CodeEdit::clear_bookmarked_lines);
  393. ClassDB::bind_method(D_METHOD("get_bookmarked_lines"), &CodeEdit::get_bookmarked_lines);
  394. // executing lines
  395. ClassDB::bind_method(D_METHOD("set_line_as_executing", "line", "executing"), &CodeEdit::set_line_as_executing);
  396. ClassDB::bind_method(D_METHOD("is_line_executing", "line"), &CodeEdit::is_line_executing);
  397. ClassDB::bind_method(D_METHOD("clear_executing_lines"), &CodeEdit::clear_executing_lines);
  398. ClassDB::bind_method(D_METHOD("get_executing_lines"), &CodeEdit::get_executing_lines);
  399. /* Line numbers */
  400. ClassDB::bind_method(D_METHOD("_line_number_draw_callback"), &CodeEdit::_line_number_draw_callback);
  401. ClassDB::bind_method(D_METHOD("set_draw_line_numbers", "enable"), &CodeEdit::set_draw_line_numbers);
  402. ClassDB::bind_method(D_METHOD("is_draw_line_numbers_enabled"), &CodeEdit::is_draw_line_numbers_enabled);
  403. ClassDB::bind_method(D_METHOD("set_line_numbers_zero_padded", "enable"), &CodeEdit::set_line_numbers_zero_padded);
  404. ClassDB::bind_method(D_METHOD("is_line_numbers_zero_padded"), &CodeEdit::is_line_numbers_zero_padded);
  405. /* Fold Gutter */
  406. ClassDB::bind_method(D_METHOD("_fold_gutter_draw_callback"), &CodeEdit::_fold_gutter_draw_callback);
  407. ClassDB::bind_method(D_METHOD("set_draw_fold_gutter", "enable"), &CodeEdit::set_draw_fold_gutter);
  408. ClassDB::bind_method(D_METHOD("is_drawing_fold_gutter"), &CodeEdit::is_drawing_fold_gutter);
  409. /* Delimiters */
  410. // Strings
  411. ClassDB::bind_method(D_METHOD("add_string_delimiter", "start_key", "end_key", "line_only"), &CodeEdit::add_string_delimiter, DEFVAL(false));
  412. ClassDB::bind_method(D_METHOD("remove_string_delimiter", "start_key"), &CodeEdit::remove_string_delimiter);
  413. ClassDB::bind_method(D_METHOD("has_string_delimiter", "start_key"), &CodeEdit::has_string_delimiter);
  414. ClassDB::bind_method(D_METHOD("set_string_delimiters", "string_delimiters"), &CodeEdit::set_string_delimiters);
  415. ClassDB::bind_method(D_METHOD("clear_string_delimiters"), &CodeEdit::clear_string_delimiters);
  416. ClassDB::bind_method(D_METHOD("get_string_delimiters"), &CodeEdit::get_string_delimiters);
  417. ClassDB::bind_method(D_METHOD("is_in_string", "line", "column"), &CodeEdit::is_in_string, DEFVAL(-1));
  418. // Comments
  419. ClassDB::bind_method(D_METHOD("add_comment_delimiter", "start_key", "end_key", "line_only"), &CodeEdit::add_comment_delimiter, DEFVAL(false));
  420. ClassDB::bind_method(D_METHOD("remove_comment_delimiter", "start_key"), &CodeEdit::remove_comment_delimiter);
  421. ClassDB::bind_method(D_METHOD("has_comment_delimiter", "start_key"), &CodeEdit::has_comment_delimiter);
  422. ClassDB::bind_method(D_METHOD("set_comment_delimiters", "comment_delimiters"), &CodeEdit::set_comment_delimiters);
  423. ClassDB::bind_method(D_METHOD("clear_comment_delimiters"), &CodeEdit::clear_comment_delimiters);
  424. ClassDB::bind_method(D_METHOD("get_comment_delimiters"), &CodeEdit::get_comment_delimiters);
  425. ClassDB::bind_method(D_METHOD("is_in_comment", "line", "column"), &CodeEdit::is_in_comment, DEFVAL(-1));
  426. // Util
  427. ClassDB::bind_method(D_METHOD("get_delimiter_start_key", "delimiter_index"), &CodeEdit::get_delimiter_start_key);
  428. ClassDB::bind_method(D_METHOD("get_delimiter_end_key", "delimiter_index"), &CodeEdit::get_delimiter_end_key);
  429. ClassDB::bind_method(D_METHOD("get_delimiter_start_postion", "line", "column"), &CodeEdit::get_delimiter_start_position);
  430. ClassDB::bind_method(D_METHOD("get_delimiter_end_postion", "line", "column"), &CodeEdit::get_delimiter_end_position);
  431. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_breakpoints_gutter"), "set_draw_breakpoints_gutter", "is_drawing_breakpoints_gutter");
  432. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_bookmarks"), "set_draw_bookmarks_gutter", "is_drawing_bookmarks_gutter");
  433. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_executing_lines"), "set_draw_executing_lines_gutter", "is_drawing_executing_lines_gutter");
  434. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_line_numbers"), "set_draw_line_numbers", "is_draw_line_numbers_enabled");
  435. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "zero_pad_line_numbers"), "set_line_numbers_zero_padded", "is_line_numbers_zero_padded");
  436. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_fold_gutter"), "set_draw_fold_gutter", "is_drawing_fold_gutter");
  437. ADD_GROUP("Delimiters", "delimiter_");
  438. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "delimiter_strings"), "set_string_delimiters", "get_string_delimiters");
  439. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "delimiter_comments"), "set_comment_delimiters", "get_comment_delimiters");
  440. ADD_SIGNAL(MethodInfo("breakpoint_toggled", PropertyInfo(Variant::INT, "line")));
  441. }
  442. void CodeEdit::_gutter_clicked(int p_line, int p_gutter) {
  443. if (p_gutter == main_gutter) {
  444. if (draw_breakpoints) {
  445. set_line_as_breakpoint(p_line, !is_line_breakpointed(p_line));
  446. }
  447. return;
  448. }
  449. if (p_gutter == line_number_gutter) {
  450. set_selection_mode(TextEdit::SelectionMode::SELECTION_MODE_LINE, p_line, 0);
  451. select(p_line, 0, p_line + 1, 0);
  452. cursor_set_line(p_line + 1);
  453. cursor_set_column(0);
  454. return;
  455. }
  456. if (p_gutter == fold_gutter) {
  457. if (is_folded(p_line)) {
  458. unfold_line(p_line);
  459. } else if (can_fold(p_line)) {
  460. fold_line(p_line);
  461. }
  462. return;
  463. }
  464. }
  465. void CodeEdit::_update_gutter_indexes() {
  466. for (int i = 0; i < get_gutter_count(); i++) {
  467. if (get_gutter_name(i) == "main_gutter") {
  468. main_gutter = i;
  469. continue;
  470. }
  471. if (get_gutter_name(i) == "line_numbers") {
  472. line_number_gutter = i;
  473. continue;
  474. }
  475. if (get_gutter_name(i) == "fold_gutter") {
  476. fold_gutter = i;
  477. continue;
  478. }
  479. }
  480. }
  481. /* Delimiters */
  482. void CodeEdit::_update_delimiter_cache(int p_from_line, int p_to_line) {
  483. if (delimiters.size() == 0) {
  484. return;
  485. }
  486. int line_count = get_line_count();
  487. if (p_to_line == -1) {
  488. p_to_line = line_count;
  489. }
  490. int start_line = MIN(p_from_line, p_to_line);
  491. int end_line = MAX(p_from_line, p_to_line);
  492. /* Make sure delimiter_cache has all the lines. */
  493. if (start_line != end_line) {
  494. if (p_to_line < p_from_line) {
  495. for (int i = end_line; i > start_line; i--) {
  496. delimiter_cache.remove(i);
  497. }
  498. } else {
  499. for (int i = start_line; i < end_line; i++) {
  500. delimiter_cache.insert(i, Map<int, int>());
  501. }
  502. }
  503. }
  504. int in_region = -1;
  505. for (int i = start_line; i < MIN(end_line + 1, line_count); i++) {
  506. int current_end_region = (i <= 0 || delimiter_cache[i].size() < 1) ? -1 : delimiter_cache[i].back()->value();
  507. in_region = (i <= 0 || delimiter_cache[i - 1].size() < 1) ? -1 : delimiter_cache[i - 1].back()->value();
  508. const String &str = get_line(i);
  509. const int line_length = str.length();
  510. delimiter_cache.write[i].clear();
  511. if (str.length() == 0) {
  512. if (in_region != -1) {
  513. delimiter_cache.write[i][0] = in_region;
  514. }
  515. if (i == end_line && current_end_region != in_region) {
  516. end_line = MIN(end_line++, line_count);
  517. }
  518. continue;
  519. }
  520. int end_region = -1;
  521. for (int j = 0; j < line_length; j++) {
  522. int from = j;
  523. for (; from < line_length; from++) {
  524. if (str[from] == '\\') {
  525. from++;
  526. continue;
  527. }
  528. break;
  529. }
  530. /* check if we are in entering a region */
  531. bool same_line = false;
  532. if (in_region == -1) {
  533. for (int d = 0; d < delimiters.size(); d++) {
  534. /* check there is enough room */
  535. int chars_left = line_length - from;
  536. int start_key_length = delimiters[d].start_key.length();
  537. int end_key_length = delimiters[d].end_key.length();
  538. if (chars_left < start_key_length) {
  539. continue;
  540. }
  541. /* search the line */
  542. bool match = true;
  543. const char32_t *start_key = delimiters[d].start_key.get_data();
  544. for (int k = 0; k < start_key_length; k++) {
  545. if (start_key[k] != str[from + k]) {
  546. match = false;
  547. break;
  548. }
  549. }
  550. if (!match) {
  551. continue;
  552. }
  553. same_line = true;
  554. in_region = d;
  555. delimiter_cache.write[i][from + 1] = d;
  556. from += start_key_length;
  557. /* check if it's the whole line */
  558. if (end_key_length == 0 || delimiters[d].line_only || from + end_key_length > line_length) {
  559. j = line_length;
  560. if (delimiters[d].line_only) {
  561. delimiter_cache.write[i][line_length + 1] = -1;
  562. } else {
  563. end_region = in_region;
  564. }
  565. }
  566. break;
  567. }
  568. if (j == line_length || in_region == -1) {
  569. continue;
  570. }
  571. }
  572. /* if we are in one find the end key */
  573. /* search the line */
  574. int region_end_index = -1;
  575. int end_key_length = delimiters[in_region].end_key.length();
  576. const char32_t *end_key = delimiters[in_region].end_key.get_data();
  577. for (; from < line_length; from++) {
  578. if (line_length - from < end_key_length) {
  579. break;
  580. }
  581. if (!is_symbol(str[from])) {
  582. continue;
  583. }
  584. if (str[from] == '\\') {
  585. from++;
  586. continue;
  587. }
  588. region_end_index = from;
  589. for (int k = 0; k < end_key_length; k++) {
  590. if (end_key[k] != str[from + k]) {
  591. region_end_index = -1;
  592. break;
  593. }
  594. }
  595. if (region_end_index != -1) {
  596. break;
  597. }
  598. }
  599. j = from + (end_key_length - 1);
  600. end_region = (region_end_index == -1) ? in_region : -1;
  601. if (!same_line || region_end_index != -1) {
  602. delimiter_cache.write[i][j + 1] = end_region;
  603. }
  604. in_region = -1;
  605. }
  606. if (i == end_line && current_end_region != end_region) {
  607. end_line = MIN(end_line++, line_count);
  608. }
  609. }
  610. }
  611. int CodeEdit::_is_in_delimiter(int p_line, int p_column, DelimiterType p_type) const {
  612. if (delimiters.size() == 0) {
  613. return -1;
  614. }
  615. ERR_FAIL_INDEX_V(p_line, get_line_count(), 0);
  616. int region = (p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->value();
  617. bool in_region = region != -1 && delimiters[region].type == p_type;
  618. for (Map<int, int>::Element *E = delimiter_cache[p_line].front(); E; E = E->next()) {
  619. /* If column is specified, loop untill the key is larger then the column. */
  620. if (p_column != -1) {
  621. if (E->key() > p_column) {
  622. break;
  623. }
  624. in_region = E->value() != -1 && delimiters[E->value()].type == p_type;
  625. region = in_region ? E->value() : -1;
  626. continue;
  627. }
  628. /* If no column, calulate if the entire line is a region */
  629. /* excluding whitespace. */
  630. const String line = get_line(p_line);
  631. if (!in_region) {
  632. if (E->value() == -1 || delimiters[E->value()].type != p_type) {
  633. break;
  634. }
  635. region = E->value();
  636. in_region = true;
  637. for (int i = E->key() - 2; i >= 0; i--) {
  638. if (!_is_whitespace(line[i])) {
  639. return -1;
  640. }
  641. }
  642. }
  643. if (delimiters[region].line_only) {
  644. return region;
  645. }
  646. int end_col = E->key();
  647. if (E->value() != -1) {
  648. if (!E->next()) {
  649. return region;
  650. }
  651. end_col = E->next()->key();
  652. }
  653. for (int i = end_col; i < line.length(); i++) {
  654. if (!_is_whitespace(line[i])) {
  655. return -1;
  656. }
  657. }
  658. return region;
  659. }
  660. return in_region ? region : -1;
  661. }
  662. void CodeEdit::_add_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only, DelimiterType p_type) {
  663. if (p_start_key.length() > 0) {
  664. for (int i = 0; i < p_start_key.length(); i++) {
  665. ERR_FAIL_COND_MSG(!is_symbol(p_start_key[i]), "delimiter must start with a symbol");
  666. }
  667. }
  668. if (p_end_key.length() > 0) {
  669. for (int i = 0; i < p_end_key.length(); i++) {
  670. ERR_FAIL_COND_MSG(!is_symbol(p_end_key[i]), "delimiter must end with a symbol");
  671. }
  672. }
  673. int at = 0;
  674. for (int i = 0; i < delimiters.size(); i++) {
  675. ERR_FAIL_COND_MSG(delimiters[i].start_key == p_start_key, "delimiter with start key '" + p_start_key + "' already exists.");
  676. if (p_start_key.length() < delimiters[i].start_key.length()) {
  677. at++;
  678. }
  679. }
  680. Delimiter delimiter;
  681. delimiter.type = p_type;
  682. delimiter.start_key = p_start_key;
  683. delimiter.end_key = p_end_key;
  684. delimiter.line_only = p_line_only || p_end_key == "";
  685. delimiters.insert(at, delimiter);
  686. if (!setting_delimiters) {
  687. delimiter_cache.clear();
  688. _update_delimiter_cache();
  689. }
  690. }
  691. void CodeEdit::_remove_delimiter(const String &p_start_key, DelimiterType p_type) {
  692. for (int i = 0; i < delimiters.size(); i++) {
  693. if (delimiters[i].start_key != p_start_key) {
  694. continue;
  695. }
  696. if (delimiters[i].type != p_type) {
  697. break;
  698. }
  699. delimiters.remove(i);
  700. if (!setting_delimiters) {
  701. delimiter_cache.clear();
  702. _update_delimiter_cache();
  703. }
  704. break;
  705. }
  706. }
  707. bool CodeEdit::_has_delimiter(const String &p_start_key, DelimiterType p_type) const {
  708. for (int i = 0; i < delimiters.size(); i++) {
  709. if (delimiters[i].start_key == p_start_key) {
  710. return delimiters[i].type == p_type;
  711. }
  712. }
  713. return false;
  714. }
  715. void CodeEdit::_set_delimiters(const TypedArray<String> &p_delimiters, DelimiterType p_type) {
  716. setting_delimiters = true;
  717. _clear_delimiters(p_type);
  718. for (int i = 0; i < p_delimiters.size(); i++) {
  719. String key = p_delimiters[i].is_null() ? "" : p_delimiters[i];
  720. const String start_key = key.get_slice(" ", 0);
  721. const String end_key = key.get_slice_count(" ") > 1 ? key.get_slice(" ", 1) : String();
  722. _add_delimiter(start_key, end_key, end_key == "", p_type);
  723. }
  724. setting_delimiters = false;
  725. _update_delimiter_cache();
  726. }
  727. void CodeEdit::_clear_delimiters(DelimiterType p_type) {
  728. for (int i = delimiters.size() - 1; i >= 0; i--) {
  729. if (delimiters[i].type == p_type) {
  730. delimiters.remove(i);
  731. }
  732. }
  733. delimiter_cache.clear();
  734. }
  735. TypedArray<String> CodeEdit::_get_delimiters(DelimiterType p_type) const {
  736. TypedArray<String> r_delimiters;
  737. for (int i = 0; i < delimiters.size(); i++) {
  738. if (delimiters[i].type != p_type) {
  739. continue;
  740. }
  741. r_delimiters.push_back(delimiters[i].start_key + (delimiters[i].end_key.empty() ? "" : " " + delimiters[i].end_key));
  742. }
  743. return r_delimiters;
  744. }
  745. void CodeEdit::_lines_edited_from(int p_from_line, int p_to_line) {
  746. _update_delimiter_cache(p_from_line, p_to_line);
  747. if (p_from_line == p_to_line) {
  748. return;
  749. }
  750. int lc = get_line_count();
  751. line_number_digits = 1;
  752. while (lc /= 10) {
  753. line_number_digits++;
  754. }
  755. set_gutter_width(line_number_gutter, (line_number_digits + 1) * cache.font->get_char_size('0', 0, cache.font_size).width);
  756. int from_line = MIN(p_from_line, p_to_line);
  757. int line_count = (p_to_line - p_from_line);
  758. List<int> breakpoints;
  759. breakpointed_lines.get_key_list(&breakpoints);
  760. for (const List<int>::Element *E = breakpoints.front(); E; E = E->next()) {
  761. int line = E->get();
  762. if (line <= from_line) {
  763. continue;
  764. }
  765. breakpointed_lines.erase(line);
  766. emit_signal("breakpoint_toggled", line);
  767. if (line_count > 0 || line >= p_from_line) {
  768. emit_signal("breakpoint_toggled", line + line_count);
  769. breakpointed_lines[line + line_count] = true;
  770. continue;
  771. }
  772. }
  773. }
  774. CodeEdit::CodeEdit() {
  775. /* Text Direction */
  776. set_layout_direction(LAYOUT_DIRECTION_LTR);
  777. set_text_direction(TEXT_DIRECTION_LTR);
  778. /* Gutters */
  779. int gutter_idx = 0;
  780. /* Main Gutter */
  781. add_gutter();
  782. set_gutter_name(gutter_idx, "main_gutter");
  783. set_gutter_draw(gutter_idx, false);
  784. set_gutter_overwritable(gutter_idx, true);
  785. set_gutter_type(gutter_idx, GUTTER_TPYE_CUSTOM);
  786. set_gutter_custom_draw(gutter_idx, this, "_main_gutter_draw_callback");
  787. gutter_idx++;
  788. /* Line numbers */
  789. add_gutter();
  790. set_gutter_name(gutter_idx, "line_numbers");
  791. set_gutter_draw(gutter_idx, false);
  792. set_gutter_type(gutter_idx, GUTTER_TPYE_CUSTOM);
  793. set_gutter_custom_draw(gutter_idx, this, "_line_number_draw_callback");
  794. gutter_idx++;
  795. /* Fold Gutter */
  796. add_gutter();
  797. set_gutter_name(gutter_idx, "fold_gutter");
  798. set_gutter_draw(gutter_idx, false);
  799. set_gutter_type(gutter_idx, GUTTER_TPYE_CUSTOM);
  800. set_gutter_custom_draw(gutter_idx, this, "_fold_gutter_draw_callback");
  801. gutter_idx++;
  802. connect("lines_edited_from", callable_mp(this, &CodeEdit::_lines_edited_from));
  803. connect("gutter_clicked", callable_mp(this, &CodeEdit::_gutter_clicked));
  804. connect("gutter_added", callable_mp(this, &CodeEdit::_update_gutter_indexes));
  805. connect("gutter_removed", callable_mp(this, &CodeEdit::_update_gutter_indexes));
  806. _update_gutter_indexes();
  807. }
  808. CodeEdit::~CodeEdit() {
  809. }