code_edit.cpp 111 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271
  1. /*************************************************************************/
  2. /* code_edit.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 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/os/keyboard.h"
  32. #include "core/string/string_builder.h"
  33. #include "core/string/ustring.h"
  34. void CodeEdit::_notification(int p_what) {
  35. switch (p_what) {
  36. case NOTIFICATION_THEME_CHANGED:
  37. case NOTIFICATION_ENTER_TREE: {
  38. style_normal = get_theme_stylebox(SNAME("normal"));
  39. font = get_theme_font(SNAME("font"));
  40. font_size = get_theme_font_size(SNAME("font_size"));
  41. line_spacing = get_theme_constant(SNAME("line_spacing"));
  42. set_gutter_width(main_gutter, get_line_height());
  43. set_gutter_width(line_number_gutter, (line_number_digits + 1) * font->get_char_size('0', font_size).width);
  44. set_gutter_width(fold_gutter, get_line_height() / 1.2);
  45. breakpoint_color = get_theme_color(SNAME("breakpoint_color"));
  46. breakpoint_icon = get_theme_icon(SNAME("breakpoint"));
  47. bookmark_color = get_theme_color(SNAME("bookmark_color"));
  48. bookmark_icon = get_theme_icon(SNAME("bookmark"));
  49. executing_line_color = get_theme_color(SNAME("executing_line_color"));
  50. executing_line_icon = get_theme_icon(SNAME("executing_line"));
  51. line_number_color = get_theme_color(SNAME("line_number_color"));
  52. folding_color = get_theme_color(SNAME("code_folding_color"));
  53. can_fold_icon = get_theme_icon(SNAME("can_fold"));
  54. folded_icon = get_theme_icon(SNAME("folded"));
  55. code_completion_max_width = get_theme_constant(SNAME("completion_max_width"));
  56. code_completion_max_lines = get_theme_constant(SNAME("completion_lines"));
  57. code_completion_scroll_width = get_theme_constant(SNAME("completion_scroll_width"));
  58. code_completion_scroll_color = get_theme_color(SNAME("completion_scroll_color"));
  59. code_completion_scroll_hovered_color = get_theme_color(SNAME("completion_scroll_hovered_color"));
  60. code_completion_background_color = get_theme_color(SNAME("completion_background_color"));
  61. code_completion_selected_color = get_theme_color(SNAME("completion_selected_color"));
  62. code_completion_existing_color = get_theme_color(SNAME("completion_existing_color"));
  63. line_length_guideline_color = get_theme_color(SNAME("line_length_guideline_color"));
  64. } break;
  65. case NOTIFICATION_DRAW: {
  66. RID ci = get_canvas_item();
  67. const Size2 size = get_size();
  68. const bool caret_visible = is_caret_visible();
  69. const bool rtl = is_layout_rtl();
  70. const int row_height = get_line_height();
  71. if (line_length_guideline_columns.size() > 0) {
  72. const int xmargin_beg = style_normal->get_margin(SIDE_LEFT) + get_total_gutter_width();
  73. const int xmargin_end = size.width - style_normal->get_margin(SIDE_RIGHT) - (is_drawing_minimap() ? get_minimap_width() : 0);
  74. const float char_size = font->get_char_size('0', font_size).width;
  75. for (int i = 0; i < line_length_guideline_columns.size(); i++) {
  76. const int xoffset = xmargin_beg + char_size * (int)line_length_guideline_columns[i] - get_h_scroll();
  77. if (xoffset > xmargin_beg && xoffset < xmargin_end) {
  78. Color guideline_color = (i == 0) ? line_length_guideline_color : line_length_guideline_color * Color(1, 1, 1, 0.5);
  79. if (rtl) {
  80. RenderingServer::get_singleton()->canvas_item_add_line(ci, Point2(size.width - xoffset, 0), Point2(size.width - xoffset, size.height), guideline_color);
  81. continue;
  82. }
  83. RenderingServer::get_singleton()->canvas_item_add_line(ci, Point2(xoffset, 0), Point2(xoffset, size.height), guideline_color);
  84. }
  85. }
  86. }
  87. bool code_completion_below = false;
  88. if (caret_visible && code_completion_active && code_completion_options.size() > 0) {
  89. Ref<StyleBox> csb = get_theme_stylebox(SNAME("completion"));
  90. const int code_completion_options_count = code_completion_options.size();
  91. const int lines = MIN(code_completion_options_count, code_completion_max_lines);
  92. const int icon_hsep = get_theme_constant(SNAME("h_separation"), SNAME("ItemList"));
  93. const Size2 icon_area_size(row_height, row_height);
  94. code_completion_rect.size.width = code_completion_longest_line + icon_hsep + icon_area_size.width + 2;
  95. code_completion_rect.size.height = lines * row_height;
  96. const Point2 caret_pos = get_caret_draw_pos();
  97. const int total_height = csb->get_minimum_size().y + code_completion_rect.size.height;
  98. if (caret_pos.y + row_height + total_height > get_size().height) {
  99. code_completion_rect.position.y = (caret_pos.y - total_height - row_height) + line_spacing;
  100. } else {
  101. code_completion_rect.position.y = caret_pos.y + (line_spacing / 2.0f);
  102. code_completion_below = true;
  103. }
  104. const int scroll_width = code_completion_options_count > code_completion_max_lines ? code_completion_scroll_width : 0;
  105. const int code_completion_base_width = font->get_string_size(code_completion_base, HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).width;
  106. if (caret_pos.x - code_completion_base_width + code_completion_rect.size.width + scroll_width > get_size().width) {
  107. code_completion_rect.position.x = get_size().width - code_completion_rect.size.width - scroll_width;
  108. } else {
  109. code_completion_rect.position.x = caret_pos.x - code_completion_base_width;
  110. }
  111. draw_style_box(csb, Rect2(code_completion_rect.position - csb->get_offset(), code_completion_rect.size + csb->get_minimum_size() + Size2(scroll_width, 0)));
  112. if (code_completion_background_color.a > 0.01) {
  113. RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(code_completion_rect.position, code_completion_rect.size + Size2(scroll_width, 0)), code_completion_background_color);
  114. }
  115. code_completion_scroll_rect.position = code_completion_rect.position + Vector2(code_completion_rect.size.width, 0);
  116. code_completion_scroll_rect.size = Vector2(scroll_width, code_completion_rect.size.height);
  117. code_completion_line_ofs = CLAMP((code_completion_force_item_center < 0 ? code_completion_current_selected : code_completion_force_item_center) - lines / 2, 0, code_completion_options_count - lines);
  118. RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(Point2(code_completion_rect.position.x, code_completion_rect.position.y + (code_completion_current_selected - code_completion_line_ofs) * row_height), Size2(code_completion_rect.size.width, row_height)), code_completion_selected_color);
  119. for (int i = 0; i < lines; i++) {
  120. int l = code_completion_line_ofs + i;
  121. ERR_CONTINUE(l < 0 || l >= code_completion_options_count);
  122. Ref<TextLine> tl;
  123. tl.instantiate();
  124. tl->add_string(code_completion_options[l].display, font, font_size);
  125. int yofs = (row_height - tl->get_size().y) / 2;
  126. Point2 title_pos(code_completion_rect.position.x, code_completion_rect.position.y + i * row_height + yofs);
  127. /* Draw completion icon if it is valid. */
  128. const Ref<Texture2D> &icon = code_completion_options[l].icon;
  129. Rect2 icon_area(code_completion_rect.position.x, code_completion_rect.position.y + i * row_height, icon_area_size.width, icon_area_size.height);
  130. if (icon.is_valid()) {
  131. Size2 icon_size = icon_area.size * 0.7;
  132. icon->draw_rect(ci, Rect2(icon_area.position + (icon_area.size - icon_size) / 2, icon_size));
  133. }
  134. title_pos.x = icon_area.position.x + icon_area.size.width + icon_hsep;
  135. tl->set_width(code_completion_rect.size.width - (icon_area_size.x + icon_hsep));
  136. if (rtl) {
  137. if (code_completion_options[l].default_value.get_type() == Variant::COLOR) {
  138. draw_rect(Rect2(Point2(code_completion_rect.position.x, icon_area.position.y), icon_area_size), (Color)code_completion_options[l].default_value);
  139. }
  140. tl->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_RIGHT);
  141. } else {
  142. if (code_completion_options[l].default_value.get_type() == Variant::COLOR) {
  143. draw_rect(Rect2(Point2(code_completion_rect.position.x + code_completion_rect.size.width - icon_area_size.x, icon_area.position.y), icon_area_size), (Color)code_completion_options[l].default_value);
  144. }
  145. tl->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_LEFT);
  146. }
  147. Point2 match_pos = Point2(code_completion_rect.position.x + icon_area_size.x + icon_hsep, code_completion_rect.position.y + i * row_height);
  148. for (int j = 0; j < code_completion_options[l].matches.size(); j++) {
  149. Pair<int, int> match = code_completion_options[l].matches[j];
  150. int match_offset = font->get_string_size(code_completion_options[l].display.substr(0, match.first), HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).width;
  151. int match_len = font->get_string_size(code_completion_options[l].display.substr(match.first, match.second), HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).width;
  152. draw_rect(Rect2(match_pos + Point2(match_offset, 0), Size2(match_len, row_height)), code_completion_existing_color);
  153. }
  154. tl->draw(ci, title_pos, code_completion_options[l].font_color);
  155. }
  156. /* Draw a small scroll rectangle to show a position in the options. */
  157. if (scroll_width) {
  158. Color scroll_color = is_code_completion_scroll_hovered || is_code_completion_scroll_pressed ? code_completion_scroll_hovered_color : code_completion_scroll_color;
  159. float r = (float)code_completion_max_lines / code_completion_options_count;
  160. float o = (float)code_completion_line_ofs / code_completion_options_count;
  161. draw_rect(Rect2(code_completion_rect.position.x + code_completion_rect.size.width, code_completion_rect.position.y + o * code_completion_rect.size.y, scroll_width, code_completion_rect.size.y * r), scroll_color);
  162. }
  163. }
  164. /* Code hint */
  165. if (caret_visible && !code_hint.is_empty() && (!code_completion_active || (code_completion_below != code_hint_draw_below))) {
  166. const int font_height = font->get_height(font_size);
  167. Ref<StyleBox> sb = get_theme_stylebox(SNAME("panel"), SNAME("TooltipPanel"));
  168. Color color = get_theme_color(SNAME("font_color"), SNAME("TooltipLabel"));
  169. Vector<String> code_hint_lines = code_hint.split("\n");
  170. int line_count = code_hint_lines.size();
  171. int max_width = 0;
  172. for (int i = 0; i < line_count; i++) {
  173. max_width = MAX(max_width, font->get_string_size(code_hint_lines[i], HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).x);
  174. }
  175. Size2 minsize = sb->get_minimum_size() + Size2(max_width, line_count * font_height + (line_spacing * line_count - 1));
  176. int offset = font->get_string_size(code_hint_lines[0].substr(0, code_hint_lines[0].find(String::chr(0xFFFF))), HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).x;
  177. if (code_hint_xpos == -0xFFFF) {
  178. code_hint_xpos = get_caret_draw_pos().x - offset;
  179. }
  180. Point2 hint_ofs = Vector2(code_hint_xpos, get_caret_draw_pos().y);
  181. if (code_hint_draw_below) {
  182. hint_ofs.y += line_spacing / 2.0f;
  183. } else {
  184. hint_ofs.y -= (minsize.y + row_height) - line_spacing;
  185. }
  186. draw_style_box(sb, Rect2(hint_ofs, minsize));
  187. int yofs = 0;
  188. for (int i = 0; i < line_count; i++) {
  189. const String &line = code_hint_lines[i];
  190. int begin = 0;
  191. int end = 0;
  192. if (line.contains(String::chr(0xFFFF))) {
  193. begin = font->get_string_size(line.substr(0, line.find(String::chr(0xFFFF))), HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).x;
  194. end = font->get_string_size(line.substr(0, line.rfind(String::chr(0xFFFF))), HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).x;
  195. }
  196. Point2 round_ofs = hint_ofs + sb->get_offset() + Vector2(0, font->get_ascent(font_size) + font_height * i + yofs);
  197. round_ofs = round_ofs.round();
  198. draw_string(font, round_ofs, line.replace(String::chr(0xFFFF), ""), HORIZONTAL_ALIGNMENT_LEFT, -1, font_size, color);
  199. if (end > 0) {
  200. // Draw an underline for the currently edited function parameter.
  201. const Vector2 b = hint_ofs + sb->get_offset() + Vector2(begin, font_height + font_height * i + yofs);
  202. draw_line(b, b + Vector2(end - begin, 0), color, 2);
  203. // Draw a translucent text highlight as well.
  204. const Rect2 highlight_rect = Rect2(
  205. b - Vector2(0, font_height),
  206. Vector2(end - begin, font_height));
  207. draw_rect(highlight_rect, color * Color(1, 1, 1, 0.2));
  208. }
  209. yofs += line_spacing;
  210. }
  211. }
  212. } break;
  213. }
  214. }
  215. void CodeEdit::gui_input(const Ref<InputEvent> &p_gui_input) {
  216. Ref<InputEventMouseButton> mb = p_gui_input;
  217. if (mb.is_valid()) {
  218. /* Ignore mouse clicks in IME input mode. */
  219. if (has_ime_text()) {
  220. return;
  221. }
  222. if (is_code_completion_scroll_pressed && mb->get_button_index() == MouseButton::LEFT) {
  223. is_code_completion_scroll_pressed = false;
  224. queue_redraw();
  225. return;
  226. }
  227. if (code_completion_active && code_completion_rect.has_point(mb->get_position())) {
  228. if (!mb->is_pressed()) {
  229. return;
  230. }
  231. switch (mb->get_button_index()) {
  232. case MouseButton::WHEEL_UP: {
  233. if (code_completion_current_selected > 0) {
  234. code_completion_current_selected--;
  235. code_completion_force_item_center = -1;
  236. queue_redraw();
  237. }
  238. } break;
  239. case MouseButton::WHEEL_DOWN: {
  240. if (code_completion_current_selected < code_completion_options.size() - 1) {
  241. code_completion_current_selected++;
  242. code_completion_force_item_center = -1;
  243. queue_redraw();
  244. }
  245. } break;
  246. case MouseButton::LEFT: {
  247. if (code_completion_force_item_center == -1) {
  248. code_completion_force_item_center = code_completion_current_selected;
  249. }
  250. code_completion_current_selected = CLAMP(code_completion_line_ofs + (mb->get_position().y - code_completion_rect.position.y) / get_line_height(), 0, code_completion_options.size() - 1);
  251. if (mb->is_double_click()) {
  252. confirm_code_completion();
  253. }
  254. queue_redraw();
  255. } break;
  256. default:
  257. break;
  258. }
  259. return;
  260. } else if (code_completion_active && code_completion_scroll_rect.has_point(mb->get_position())) {
  261. if (mb->get_button_index() != MouseButton::LEFT) {
  262. return;
  263. }
  264. if (mb->is_pressed()) {
  265. is_code_completion_scroll_pressed = true;
  266. _update_scroll_selected_line(mb->get_position().y);
  267. queue_redraw();
  268. }
  269. return;
  270. }
  271. cancel_code_completion();
  272. set_code_hint("");
  273. if (mb->is_pressed()) {
  274. Vector2i mpos = mb->get_position();
  275. if (is_layout_rtl()) {
  276. mpos.x = get_size().x - mpos.x;
  277. }
  278. Point2i pos = get_line_column_at_pos(mpos, false);
  279. int line = pos.y;
  280. int col = pos.x;
  281. if (line != -1 && mb->get_button_index() == MouseButton::LEFT) {
  282. if (is_line_folded(line)) {
  283. int wrap_index = get_line_wrap_index_at_column(line, col);
  284. if (wrap_index == get_line_wrap_count(line)) {
  285. int eol_icon_width = folded_eol_icon->get_width();
  286. int left_margin = get_total_gutter_width() + eol_icon_width + get_line_width(line, wrap_index) - get_h_scroll();
  287. if (mpos.x > left_margin && mpos.x <= left_margin + eol_icon_width + 3) {
  288. unfold_line(line);
  289. return;
  290. }
  291. }
  292. }
  293. }
  294. } else {
  295. if (mb->get_button_index() == MouseButton::LEFT) {
  296. if (mb->is_command_or_control_pressed() && !symbol_lookup_word.is_empty()) {
  297. Vector2i mpos = mb->get_position();
  298. if (is_layout_rtl()) {
  299. mpos.x = get_size().x - mpos.x;
  300. }
  301. Point2i pos = get_line_column_at_pos(mpos, false);
  302. int line = pos.y;
  303. int col = pos.x;
  304. if (line != -1) {
  305. emit_signal(SNAME("symbol_lookup"), symbol_lookup_word, line, col);
  306. }
  307. return;
  308. }
  309. }
  310. }
  311. }
  312. Ref<InputEventMouseMotion> mm = p_gui_input;
  313. if (mm.is_valid()) {
  314. Vector2i mpos = mm->get_position();
  315. if (is_layout_rtl()) {
  316. mpos.x = get_size().x - mpos.x;
  317. }
  318. if (symbol_lookup_on_click_enabled) {
  319. if (mm->is_command_or_control_pressed() && mm->get_button_mask() == MouseButton::NONE) {
  320. symbol_lookup_pos = get_line_column_at_pos(mpos);
  321. symbol_lookup_new_word = get_word_at_pos(mpos);
  322. if (symbol_lookup_new_word != symbol_lookup_word) {
  323. emit_signal(SNAME("symbol_validate"), symbol_lookup_new_word);
  324. }
  325. } else if (!mm->is_command_or_control_pressed() || (mm->get_button_mask() != MouseButton::NONE && symbol_lookup_pos != get_line_column_at_pos(mpos))) {
  326. set_symbol_lookup_word_as_valid(false);
  327. }
  328. }
  329. bool scroll_hovered = code_completion_scroll_rect.has_point(mpos);
  330. if (is_code_completion_scroll_hovered != scroll_hovered) {
  331. is_code_completion_scroll_hovered = scroll_hovered;
  332. queue_redraw();
  333. }
  334. if (is_code_completion_scroll_pressed) {
  335. _update_scroll_selected_line(mpos.y);
  336. queue_redraw();
  337. return;
  338. }
  339. }
  340. Ref<InputEventKey> k = p_gui_input;
  341. if (TextEdit::alt_input(p_gui_input)) {
  342. accept_event();
  343. return;
  344. }
  345. bool update_code_completion = false;
  346. if (!k.is_valid()) {
  347. TextEdit::gui_input(p_gui_input);
  348. return;
  349. }
  350. /* Ctrl + Hover symbols */
  351. #ifdef MACOS_ENABLED
  352. if (k->get_keycode() == Key::META) {
  353. #else
  354. if (k->get_keycode() == Key::CTRL) {
  355. #endif
  356. if (symbol_lookup_on_click_enabled) {
  357. if (k->is_pressed() && !is_dragging_cursor()) {
  358. symbol_lookup_new_word = get_word_at_pos(get_local_mouse_pos());
  359. if (symbol_lookup_new_word != symbol_lookup_word) {
  360. emit_signal(SNAME("symbol_validate"), symbol_lookup_new_word);
  361. }
  362. } else {
  363. set_symbol_lookup_word_as_valid(false);
  364. }
  365. }
  366. return;
  367. }
  368. /* If a modifier has been pressed, and nothing else, return. */
  369. if (!k->is_pressed() || k->get_keycode() == Key::CTRL || k->get_keycode() == Key::ALT || k->get_keycode() == Key::SHIFT || k->get_keycode() == Key::META) {
  370. return;
  371. }
  372. /* Allow unicode handling if: */
  373. /* No Modifiers are pressed (except shift) */
  374. bool allow_unicode_handling = !(k->is_command_or_control_pressed() || k->is_ctrl_pressed() || k->is_alt_pressed() || k->is_meta_pressed());
  375. /* AUTO-COMPLETE */
  376. if (code_completion_enabled && k->is_action("ui_text_completion_query", true)) {
  377. request_code_completion(true);
  378. accept_event();
  379. return;
  380. }
  381. if (code_completion_active) {
  382. if (k->is_action("ui_up", true)) {
  383. if (code_completion_current_selected > 0) {
  384. code_completion_current_selected--;
  385. } else {
  386. code_completion_current_selected = code_completion_options.size() - 1;
  387. }
  388. code_completion_force_item_center = -1;
  389. queue_redraw();
  390. accept_event();
  391. return;
  392. }
  393. if (k->is_action("ui_down", true)) {
  394. if (code_completion_current_selected < code_completion_options.size() - 1) {
  395. code_completion_current_selected++;
  396. } else {
  397. code_completion_current_selected = 0;
  398. }
  399. code_completion_force_item_center = -1;
  400. queue_redraw();
  401. accept_event();
  402. return;
  403. }
  404. if (k->is_action("ui_page_up", true)) {
  405. code_completion_current_selected = MAX(0, code_completion_current_selected - code_completion_max_lines);
  406. code_completion_force_item_center = -1;
  407. queue_redraw();
  408. accept_event();
  409. return;
  410. }
  411. if (k->is_action("ui_page_down", true)) {
  412. code_completion_current_selected = MIN(code_completion_options.size() - 1, code_completion_current_selected + code_completion_max_lines);
  413. code_completion_force_item_center = -1;
  414. queue_redraw();
  415. accept_event();
  416. return;
  417. }
  418. if (k->is_action("ui_home", true)) {
  419. code_completion_current_selected = 0;
  420. code_completion_force_item_center = -1;
  421. queue_redraw();
  422. accept_event();
  423. return;
  424. }
  425. if (k->is_action("ui_end", true)) {
  426. code_completion_current_selected = code_completion_options.size() - 1;
  427. code_completion_force_item_center = -1;
  428. queue_redraw();
  429. accept_event();
  430. return;
  431. }
  432. if (k->is_action("ui_text_completion_replace", true) || k->is_action("ui_text_completion_accept", true)) {
  433. confirm_code_completion(k->is_action("ui_text_completion_replace", true));
  434. accept_event();
  435. return;
  436. }
  437. if (k->is_action("ui_cancel", true)) {
  438. cancel_code_completion();
  439. accept_event();
  440. return;
  441. }
  442. if (k->is_action("ui_text_backspace", true)) {
  443. backspace();
  444. _filter_code_completion_candidates_impl();
  445. accept_event();
  446. return;
  447. }
  448. if (k->is_action("ui_left", true) || k->is_action("ui_right", true)) {
  449. update_code_completion = true;
  450. } else {
  451. update_code_completion = (allow_unicode_handling && k->get_unicode() >= 32);
  452. }
  453. if (!update_code_completion) {
  454. cancel_code_completion();
  455. }
  456. }
  457. /* MISC */
  458. if (!code_hint.is_empty() && k->is_action("ui_cancel", true)) {
  459. set_code_hint("");
  460. accept_event();
  461. return;
  462. }
  463. if (allow_unicode_handling && k->get_unicode() == ')') {
  464. set_code_hint("");
  465. }
  466. /* Indentation */
  467. if (k->is_action("ui_text_indent", true)) {
  468. do_indent();
  469. accept_event();
  470. return;
  471. }
  472. if (k->is_action("ui_text_dedent", true)) {
  473. do_unindent();
  474. accept_event();
  475. return;
  476. }
  477. // Override new line actions, for auto indent
  478. if (k->is_action("ui_text_newline_above", true)) {
  479. _new_line(false, true);
  480. accept_event();
  481. return;
  482. }
  483. if (k->is_action("ui_text_newline_blank", true)) {
  484. _new_line(false);
  485. accept_event();
  486. return;
  487. }
  488. if (k->is_action("ui_text_newline", true)) {
  489. _new_line();
  490. accept_event();
  491. return;
  492. }
  493. /* Remove shift otherwise actions will not match. */
  494. k = k->duplicate();
  495. k->set_shift_pressed(false);
  496. if (k->is_action("ui_text_caret_up", true) ||
  497. k->is_action("ui_text_caret_down", true) ||
  498. k->is_action("ui_text_caret_line_start", true) ||
  499. k->is_action("ui_text_caret_line_end", true) ||
  500. k->is_action("ui_text_caret_page_up", true) ||
  501. k->is_action("ui_text_caret_page_down", true)) {
  502. set_code_hint("");
  503. }
  504. TextEdit::gui_input(p_gui_input);
  505. if (update_code_completion) {
  506. _filter_code_completion_candidates_impl();
  507. }
  508. }
  509. /* General overrides */
  510. Control::CursorShape CodeEdit::get_cursor_shape(const Point2 &p_pos) const {
  511. if (!symbol_lookup_word.is_empty()) {
  512. return CURSOR_POINTING_HAND;
  513. }
  514. if ((code_completion_active && code_completion_rect.has_point(p_pos)) || (!is_editable() && (!is_selecting_enabled() || get_line_count() == 0))) {
  515. return CURSOR_ARROW;
  516. }
  517. if (code_completion_active && code_completion_scroll_rect.has_point(p_pos)) {
  518. return CURSOR_ARROW;
  519. }
  520. Point2i pos = get_line_column_at_pos(p_pos, false);
  521. int line = pos.y;
  522. int col = pos.x;
  523. if (line != -1 && is_line_folded(line)) {
  524. int wrap_index = get_line_wrap_index_at_column(line, col);
  525. if (wrap_index == get_line_wrap_count(line)) {
  526. int eol_icon_width = folded_eol_icon->get_width();
  527. int left_margin = get_total_gutter_width() + eol_icon_width + get_line_width(line, wrap_index) - get_h_scroll();
  528. if (p_pos.x > left_margin && p_pos.x <= left_margin + eol_icon_width + 3) {
  529. return CURSOR_POINTING_HAND;
  530. }
  531. }
  532. }
  533. return TextEdit::get_cursor_shape(p_pos);
  534. }
  535. /* Text manipulation */
  536. // Overridable actions
  537. void CodeEdit::_handle_unicode_input_internal(const uint32_t p_unicode, int p_caret) {
  538. start_action(EditAction::ACTION_TYPING);
  539. Vector<int> caret_edit_order = get_caret_index_edit_order();
  540. for (const int &i : caret_edit_order) {
  541. if (p_caret != -1 && p_caret != i) {
  542. continue;
  543. }
  544. bool had_selection = has_selection(i);
  545. String selection_text = (had_selection ? get_selected_text(i) : "");
  546. if (had_selection) {
  547. delete_selection(i);
  548. }
  549. // Remove the old character if in overtype mode and no selection.
  550. if (is_overtype_mode_enabled() && !had_selection) {
  551. // Make sure we don't try and remove empty space.
  552. if (get_caret_column(i) < get_line(get_caret_line(i)).length()) {
  553. remove_text(get_caret_line(i), get_caret_column(i), get_caret_line(i), get_caret_column(i) + 1);
  554. }
  555. }
  556. const char32_t chr[2] = { (char32_t)p_unicode, 0 };
  557. if (auto_brace_completion_enabled) {
  558. int cl = get_caret_line(i);
  559. int cc = get_caret_column(i);
  560. if (had_selection) {
  561. insert_text_at_caret(chr, i);
  562. String close_key = get_auto_brace_completion_close_key(chr);
  563. if (!close_key.is_empty()) {
  564. insert_text_at_caret(selection_text + close_key, i);
  565. set_caret_column(get_caret_column(i) - 1, i == 0, i);
  566. }
  567. } else {
  568. int caret_move_offset = 1;
  569. int post_brace_pair = cc < get_line(cl).length() ? _get_auto_brace_pair_close_at_pos(cl, cc) : -1;
  570. if (has_string_delimiter(chr) && cc > 0 && !is_symbol(get_line(cl)[cc - 1]) && post_brace_pair == -1) {
  571. insert_text_at_caret(chr, i);
  572. } else if (cc < get_line(cl).length() && !is_symbol(get_line(cl)[cc])) {
  573. insert_text_at_caret(chr, i);
  574. } else if (post_brace_pair != -1 && auto_brace_completion_pairs[post_brace_pair].close_key[0] == chr[0]) {
  575. caret_move_offset = auto_brace_completion_pairs[post_brace_pair].close_key.length();
  576. } else if (is_in_comment(cl, cc) != -1 || (is_in_string(cl, cc) != -1 && has_string_delimiter(chr))) {
  577. insert_text_at_caret(chr, i);
  578. } else {
  579. insert_text_at_caret(chr, i);
  580. int pre_brace_pair = _get_auto_brace_pair_open_at_pos(cl, cc + 1);
  581. if (pre_brace_pair != -1) {
  582. insert_text_at_caret(auto_brace_completion_pairs[pre_brace_pair].close_key, i);
  583. }
  584. }
  585. set_caret_column(cc + caret_move_offset, i == 0, i);
  586. }
  587. } else {
  588. insert_text_at_caret(chr, i);
  589. }
  590. }
  591. end_action();
  592. }
  593. void CodeEdit::_backspace_internal(int p_caret) {
  594. if (!is_editable()) {
  595. return;
  596. }
  597. if (has_selection(p_caret)) {
  598. delete_selection(p_caret);
  599. return;
  600. }
  601. begin_complex_operation();
  602. Vector<int> caret_edit_order = get_caret_index_edit_order();
  603. for (const int &i : caret_edit_order) {
  604. if (p_caret != -1 && p_caret != i) {
  605. continue;
  606. }
  607. int cc = get_caret_column(i);
  608. int cl = get_caret_line(i);
  609. if (cc == 0 && cl == 0) {
  610. continue;
  611. }
  612. if (cl > 0 && _is_line_hidden(cl - 1)) {
  613. unfold_line(get_caret_line(i) - 1);
  614. }
  615. int prev_line = cc ? cl : cl - 1;
  616. int prev_column = cc ? (cc - 1) : (get_line(cl - 1).length());
  617. merge_gutters(prev_line, cl);
  618. if (auto_brace_completion_enabled && cc > 0) {
  619. int idx = _get_auto_brace_pair_open_at_pos(cl, cc);
  620. if (idx != -1) {
  621. prev_column = cc - auto_brace_completion_pairs[idx].open_key.length();
  622. if (_get_auto_brace_pair_close_at_pos(cl, cc) == idx) {
  623. remove_text(prev_line, prev_column, cl, cc + auto_brace_completion_pairs[idx].close_key.length());
  624. } else {
  625. remove_text(prev_line, prev_column, cl, cc);
  626. }
  627. set_caret_line(prev_line, false, true, 0, i);
  628. set_caret_column(prev_column, i == 0, i);
  629. adjust_carets_after_edit(i, prev_line, prev_column, cl, cc + auto_brace_completion_pairs[idx].close_key.length());
  630. continue;
  631. }
  632. }
  633. // For space indentation we need to do a simple unindent if there are no chars to the left, acting in the
  634. // same way as tabs.
  635. if (indent_using_spaces && cc != 0) {
  636. if (get_first_non_whitespace_column(cl) >= cc) {
  637. prev_column = cc - _calculate_spaces_till_next_left_indent(cc);
  638. prev_line = cl;
  639. }
  640. }
  641. remove_text(prev_line, prev_column, cl, cc);
  642. set_caret_line(prev_line, false, true, 0, i);
  643. set_caret_column(prev_column, i == 0, i);
  644. adjust_carets_after_edit(i, prev_line, prev_column, cl, cc);
  645. }
  646. merge_overlapping_carets();
  647. end_complex_operation();
  648. }
  649. /* Indent management */
  650. void CodeEdit::set_indent_size(const int p_size) {
  651. ERR_FAIL_COND_MSG(p_size <= 0, "Indend size must be greater than 0.");
  652. if (indent_size == p_size) {
  653. return;
  654. }
  655. indent_size = p_size;
  656. if (indent_using_spaces) {
  657. indent_text = String(" ").repeat(p_size);
  658. } else {
  659. indent_text = "\t";
  660. }
  661. set_tab_size(p_size);
  662. }
  663. int CodeEdit::get_indent_size() const {
  664. return indent_size;
  665. }
  666. void CodeEdit::set_indent_using_spaces(const bool p_use_spaces) {
  667. indent_using_spaces = p_use_spaces;
  668. if (indent_using_spaces) {
  669. indent_text = String(" ").repeat(indent_size);
  670. } else {
  671. indent_text = "\t";
  672. }
  673. }
  674. bool CodeEdit::is_indent_using_spaces() const {
  675. return indent_using_spaces;
  676. }
  677. void CodeEdit::set_auto_indent_enabled(bool p_enabled) {
  678. auto_indent = p_enabled;
  679. }
  680. bool CodeEdit::is_auto_indent_enabled() const {
  681. return auto_indent;
  682. }
  683. void CodeEdit::set_auto_indent_prefixes(const TypedArray<String> &p_prefixes) {
  684. auto_indent_prefixes.clear();
  685. for (int i = 0; i < p_prefixes.size(); i++) {
  686. const String prefix = p_prefixes[i];
  687. auto_indent_prefixes.insert(prefix[0]);
  688. }
  689. }
  690. TypedArray<String> CodeEdit::get_auto_indent_prefixes() const {
  691. TypedArray<String> prefixes;
  692. for (const char32_t &E : auto_indent_prefixes) {
  693. prefixes.push_back(String::chr(E));
  694. }
  695. return prefixes;
  696. }
  697. void CodeEdit::do_indent() {
  698. if (!is_editable()) {
  699. return;
  700. }
  701. if (has_selection()) {
  702. indent_lines();
  703. return;
  704. }
  705. if (!indent_using_spaces) {
  706. insert_text_at_caret("\t");
  707. return;
  708. }
  709. begin_complex_operation();
  710. Vector<int> caret_edit_order = get_caret_index_edit_order();
  711. for (const int &i : caret_edit_order) {
  712. int spaces_to_add = _calculate_spaces_till_next_right_indent(get_caret_column(i));
  713. if (spaces_to_add > 0) {
  714. insert_text_at_caret(String(" ").repeat(spaces_to_add), i);
  715. }
  716. }
  717. end_complex_operation();
  718. }
  719. void CodeEdit::indent_lines() {
  720. if (!is_editable()) {
  721. return;
  722. }
  723. begin_complex_operation();
  724. Vector<int> caret_edit_order = get_caret_index_edit_order();
  725. for (const int &c : caret_edit_order) {
  726. // This value informs us by how much we changed selection position by indenting right.
  727. // Default is 1 for tab indentation.
  728. int selection_offset = 1;
  729. int start_line = get_caret_line(c);
  730. int end_line = start_line;
  731. if (has_selection(c)) {
  732. start_line = get_selection_from_line(c);
  733. end_line = get_selection_to_line(c);
  734. // Ignore the last line if the selection is not past the first column.
  735. if (get_selection_to_column(c) == 0) {
  736. selection_offset = 0;
  737. end_line--;
  738. }
  739. }
  740. for (int i = start_line; i <= end_line; i++) {
  741. const String line_text = get_line(i);
  742. if (line_text.size() == 0 && has_selection(c)) {
  743. continue;
  744. }
  745. if (!indent_using_spaces) {
  746. set_line(i, '\t' + line_text);
  747. continue;
  748. }
  749. // We don't really care where selection is - we just need to know indentation level at the beginning of the line.
  750. // Since we will add this many spaces, we want to move the whole selection and caret by this much.
  751. int spaces_to_add = _calculate_spaces_till_next_right_indent(get_first_non_whitespace_column(i));
  752. set_line(i, String(" ").repeat(spaces_to_add) + line_text);
  753. selection_offset = spaces_to_add;
  754. }
  755. // Fix selection and caret being off after shifting selection right.
  756. if (has_selection(c)) {
  757. select(start_line, get_selection_from_column(c) + selection_offset, get_selection_to_line(c), get_selection_to_column(c) + selection_offset, c);
  758. }
  759. set_caret_column(get_caret_column(c) + selection_offset, false, c);
  760. }
  761. end_complex_operation();
  762. }
  763. void CodeEdit::do_unindent() {
  764. if (!is_editable()) {
  765. return;
  766. }
  767. int cc = get_caret_column();
  768. if (has_selection() || cc <= 0) {
  769. unindent_lines();
  770. return;
  771. }
  772. begin_complex_operation();
  773. Vector<int> caret_edit_order = get_caret_index_edit_order();
  774. for (const int &c : caret_edit_order) {
  775. int cl = get_caret_line(c);
  776. const String &line = get_line(cl);
  777. if (line[cc - 1] == '\t') {
  778. remove_text(cl, cc - 1, cl, cc);
  779. set_caret_column(MAX(0, cc - 1), c == 0, c);
  780. adjust_carets_after_edit(c, cl, cc, cl, cc - 1);
  781. continue;
  782. }
  783. if (line[cc - 1] != ' ') {
  784. continue;
  785. }
  786. int spaces_to_remove = _calculate_spaces_till_next_left_indent(cc);
  787. if (spaces_to_remove > 0) {
  788. for (int i = 1; i <= spaces_to_remove; i++) {
  789. if (line[cc - i] != ' ') {
  790. spaces_to_remove = i - 1;
  791. break;
  792. }
  793. }
  794. remove_text(cl, cc - spaces_to_remove, cl, cc);
  795. set_caret_column(MAX(0, cc - spaces_to_remove), c == 0, c);
  796. }
  797. }
  798. end_complex_operation();
  799. }
  800. void CodeEdit::unindent_lines() {
  801. if (!is_editable()) {
  802. return;
  803. }
  804. begin_complex_operation();
  805. Vector<int> caret_edit_order = get_caret_index_edit_order();
  806. for (const int &c : caret_edit_order) {
  807. // Moving caret and selection after unindenting can get tricky because
  808. // changing content of line can move caret and selection on its own (if new line ends before previous position of either)
  809. // therefore we just remember initial values and at the end of the operation offset them by number of removed characters.
  810. int removed_characters = 0;
  811. int initial_selection_end_column = 0;
  812. int initial_cursor_column = get_caret_column(c);
  813. int start_line = get_caret_line(c);
  814. int end_line = start_line;
  815. if (has_selection(c)) {
  816. start_line = get_selection_from_line(c);
  817. end_line = get_selection_to_line(c);
  818. // Ignore the last line if the selection is not past the first column.
  819. initial_selection_end_column = get_selection_to_column(c);
  820. if (initial_selection_end_column == 0) {
  821. end_line--;
  822. }
  823. }
  824. bool first_line_edited = false;
  825. bool last_line_edited = false;
  826. for (int i = start_line; i <= end_line; i++) {
  827. String line_text = get_line(i);
  828. if (line_text.begins_with("\t")) {
  829. line_text = line_text.substr(1, line_text.length());
  830. set_line(i, line_text);
  831. removed_characters = 1;
  832. first_line_edited = (i == start_line) ? true : first_line_edited;
  833. last_line_edited = (i == end_line) ? true : last_line_edited;
  834. continue;
  835. }
  836. if (line_text.begins_with(" ")) {
  837. // When unindenting we aim to remove spaces before line that has selection no matter what is selected.
  838. // Here we remove only enough spaces to align text to nearest full multiple of indentation_size.
  839. // In case where selection begins at the start of indentation_size multiple we remove whole indentation level.
  840. int spaces_to_remove = _calculate_spaces_till_next_left_indent(get_first_non_whitespace_column(i));
  841. line_text = line_text.substr(spaces_to_remove, line_text.length());
  842. set_line(i, line_text);
  843. removed_characters = spaces_to_remove;
  844. first_line_edited = (i == start_line) ? true : first_line_edited;
  845. last_line_edited = (i == end_line) ? true : last_line_edited;
  846. }
  847. }
  848. if (has_selection(c)) {
  849. // Fix selection being off by one on the first line.
  850. if (first_line_edited) {
  851. select(get_selection_from_line(c), get_selection_from_column(c) - removed_characters, get_selection_to_line(c), initial_selection_end_column, c);
  852. }
  853. // Fix selection being off by one on the last line.
  854. if (last_line_edited) {
  855. select(get_selection_from_line(c), get_selection_from_column(c), get_selection_to_line(c), initial_selection_end_column - removed_characters, c);
  856. }
  857. }
  858. set_caret_column(initial_cursor_column - removed_characters, false, c);
  859. }
  860. end_complex_operation();
  861. }
  862. int CodeEdit::_calculate_spaces_till_next_left_indent(int p_column) const {
  863. int spaces_till_indent = p_column % indent_size;
  864. if (spaces_till_indent == 0) {
  865. spaces_till_indent = indent_size;
  866. }
  867. return spaces_till_indent;
  868. }
  869. int CodeEdit::_calculate_spaces_till_next_right_indent(int p_column) const {
  870. return indent_size - p_column % indent_size;
  871. }
  872. void CodeEdit::_new_line(bool p_split_current_line, bool p_above) {
  873. if (!is_editable()) {
  874. return;
  875. }
  876. begin_complex_operation();
  877. Vector<int> caret_edit_order = get_caret_index_edit_order();
  878. for (const int &i : caret_edit_order) {
  879. // When not splitting the line, we need to factor in indentation from the end of the current line.
  880. const int cc = p_split_current_line ? get_caret_column(i) : get_line(get_caret_line(i)).length();
  881. const int cl = get_caret_line(i);
  882. const String line = get_line(cl);
  883. String ins = "\n";
  884. // Append current indentation.
  885. int space_count = 0;
  886. int line_col = 0;
  887. for (; line_col < cc; line_col++) {
  888. if (line[line_col] == '\t') {
  889. ins += indent_text;
  890. space_count = 0;
  891. continue;
  892. }
  893. if (line[line_col] == ' ') {
  894. space_count++;
  895. if (space_count == indent_size) {
  896. ins += indent_text;
  897. space_count = 0;
  898. }
  899. continue;
  900. }
  901. break;
  902. }
  903. if (is_line_folded(cl)) {
  904. unfold_line(cl);
  905. }
  906. // Indent once again if the previous line needs it, ie ':'.
  907. // Then add an addition new line for any closing pairs aka '()'.
  908. // Skip this in comments or if we are going above.
  909. bool brace_indent = false;
  910. if (auto_indent && !p_above && cc > 0 && is_in_comment(cl) == -1) {
  911. bool should_indent = false;
  912. char32_t indent_char = ' ';
  913. for (; line_col < cc; line_col++) {
  914. char32_t c = line[line_col];
  915. if (auto_indent_prefixes.has(c)) {
  916. should_indent = true;
  917. indent_char = c;
  918. continue;
  919. }
  920. // Make sure this is the last char, trailing whitespace or comments are okay.
  921. // Increment column for comments because the delimiter (#) should be ignored.
  922. if (should_indent && (!is_whitespace(c) && is_in_comment(cl, line_col + 1) == -1)) {
  923. should_indent = false;
  924. }
  925. }
  926. if (should_indent) {
  927. ins += indent_text;
  928. String closing_pair = get_auto_brace_completion_close_key(String::chr(indent_char));
  929. if (!closing_pair.is_empty() && line.find(closing_pair, cc) == cc) {
  930. // No need to move the brace below if we are not taking the text with us.
  931. if (p_split_current_line) {
  932. brace_indent = true;
  933. ins += "\n" + ins.substr(indent_text.size(), ins.length() - 2);
  934. } else {
  935. brace_indent = false;
  936. ins = "\n" + ins.substr(indent_text.size(), ins.length() - 2);
  937. }
  938. }
  939. }
  940. }
  941. bool first_line = false;
  942. if (!p_split_current_line) {
  943. deselect(i);
  944. if (p_above) {
  945. if (cl > 0) {
  946. set_caret_line(cl - 1, false, true, 0, i);
  947. set_caret_column(get_line(get_caret_line(i)).length(), i == 0, i);
  948. } else {
  949. set_caret_column(0, i == 0, i);
  950. first_line = true;
  951. }
  952. } else {
  953. set_caret_column(line.length(), i == 0, i);
  954. }
  955. }
  956. insert_text_at_caret(ins, i);
  957. if (first_line) {
  958. set_caret_line(0, i == 0, true, 0, i);
  959. } else if (brace_indent) {
  960. set_caret_line(get_caret_line(i) - 1, false, true, 0, i);
  961. set_caret_column(get_line(get_caret_line(i)).length(), i == 0, i);
  962. }
  963. }
  964. end_complex_operation();
  965. }
  966. /* Auto brace completion */
  967. void CodeEdit::set_auto_brace_completion_enabled(bool p_enabled) {
  968. auto_brace_completion_enabled = p_enabled;
  969. }
  970. bool CodeEdit::is_auto_brace_completion_enabled() const {
  971. return auto_brace_completion_enabled;
  972. }
  973. void CodeEdit::set_highlight_matching_braces_enabled(bool p_enabled) {
  974. highlight_matching_braces_enabled = p_enabled;
  975. queue_redraw();
  976. }
  977. bool CodeEdit::is_highlight_matching_braces_enabled() const {
  978. return highlight_matching_braces_enabled;
  979. }
  980. void CodeEdit::add_auto_brace_completion_pair(const String &p_open_key, const String &p_close_key) {
  981. ERR_FAIL_COND_MSG(p_open_key.is_empty(), "auto brace completion open key cannot be empty");
  982. ERR_FAIL_COND_MSG(p_close_key.is_empty(), "auto brace completion close key cannot be empty");
  983. for (int i = 0; i < p_open_key.length(); i++) {
  984. ERR_FAIL_COND_MSG(!is_symbol(p_open_key[i]), "auto brace completion open key must be a symbol");
  985. }
  986. for (int i = 0; i < p_close_key.length(); i++) {
  987. ERR_FAIL_COND_MSG(!is_symbol(p_close_key[i]), "auto brace completion close key must be a symbol");
  988. }
  989. int at = 0;
  990. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  991. ERR_FAIL_COND_MSG(auto_brace_completion_pairs[i].open_key == p_open_key, "auto brace completion open key '" + p_open_key + "' already exists.");
  992. if (p_open_key.length() < auto_brace_completion_pairs[i].open_key.length()) {
  993. at++;
  994. }
  995. }
  996. BracePair brace_pair;
  997. brace_pair.open_key = p_open_key;
  998. brace_pair.close_key = p_close_key;
  999. auto_brace_completion_pairs.insert(at, brace_pair);
  1000. }
  1001. void CodeEdit::set_auto_brace_completion_pairs(const Dictionary &p_auto_brace_completion_pairs) {
  1002. auto_brace_completion_pairs.clear();
  1003. Array keys = p_auto_brace_completion_pairs.keys();
  1004. for (int i = 0; i < keys.size(); i++) {
  1005. add_auto_brace_completion_pair(keys[i], p_auto_brace_completion_pairs[keys[i]]);
  1006. }
  1007. }
  1008. Dictionary CodeEdit::get_auto_brace_completion_pairs() const {
  1009. Dictionary brace_pairs;
  1010. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1011. brace_pairs[auto_brace_completion_pairs[i].open_key] = auto_brace_completion_pairs[i].close_key;
  1012. }
  1013. return brace_pairs;
  1014. }
  1015. bool CodeEdit::has_auto_brace_completion_open_key(const String &p_open_key) const {
  1016. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1017. if (auto_brace_completion_pairs[i].open_key == p_open_key) {
  1018. return true;
  1019. }
  1020. }
  1021. return false;
  1022. }
  1023. bool CodeEdit::has_auto_brace_completion_close_key(const String &p_close_key) const {
  1024. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1025. if (auto_brace_completion_pairs[i].close_key == p_close_key) {
  1026. return true;
  1027. }
  1028. }
  1029. return false;
  1030. }
  1031. String CodeEdit::get_auto_brace_completion_close_key(const String &p_open_key) const {
  1032. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1033. if (auto_brace_completion_pairs[i].open_key == p_open_key) {
  1034. return auto_brace_completion_pairs[i].close_key;
  1035. }
  1036. }
  1037. return String();
  1038. }
  1039. /* Main Gutter */
  1040. void CodeEdit::_update_draw_main_gutter() {
  1041. set_gutter_draw(main_gutter, draw_breakpoints || draw_bookmarks || draw_executing_lines);
  1042. }
  1043. void CodeEdit::set_draw_breakpoints_gutter(bool p_draw) {
  1044. draw_breakpoints = p_draw;
  1045. set_gutter_clickable(main_gutter, p_draw);
  1046. _update_draw_main_gutter();
  1047. }
  1048. bool CodeEdit::is_drawing_breakpoints_gutter() const {
  1049. return draw_breakpoints;
  1050. }
  1051. void CodeEdit::set_draw_bookmarks_gutter(bool p_draw) {
  1052. draw_bookmarks = p_draw;
  1053. _update_draw_main_gutter();
  1054. }
  1055. bool CodeEdit::is_drawing_bookmarks_gutter() const {
  1056. return draw_bookmarks;
  1057. }
  1058. void CodeEdit::set_draw_executing_lines_gutter(bool p_draw) {
  1059. draw_executing_lines = p_draw;
  1060. _update_draw_main_gutter();
  1061. }
  1062. bool CodeEdit::is_drawing_executing_lines_gutter() const {
  1063. return draw_executing_lines;
  1064. }
  1065. void CodeEdit::_main_gutter_draw_callback(int p_line, int p_gutter, const Rect2 &p_region) {
  1066. if (draw_breakpoints && breakpoint_icon.is_valid()) {
  1067. bool breakpointed = is_line_breakpointed(p_line);
  1068. bool hovering = p_region.has_point(get_local_mouse_pos());
  1069. bool shift_pressed = Input::get_singleton()->is_key_pressed(Key::SHIFT);
  1070. if (breakpointed || (hovering && !is_dragging_cursor() && !shift_pressed)) {
  1071. int padding = p_region.size.x / 6;
  1072. Color use_color = breakpoint_color;
  1073. if (hovering && !shift_pressed) {
  1074. use_color = breakpointed ? use_color.lightened(0.3) : use_color.darkened(0.5);
  1075. }
  1076. Rect2 icon_region = p_region;
  1077. icon_region.position += Point2(padding, padding);
  1078. icon_region.size -= Point2(padding, padding) * 2;
  1079. breakpoint_icon->draw_rect(get_canvas_item(), icon_region, false, use_color);
  1080. }
  1081. }
  1082. if (draw_bookmarks && bookmark_icon.is_valid()) {
  1083. bool bookmarked = is_line_bookmarked(p_line);
  1084. bool hovering = p_region.has_point(get_local_mouse_pos());
  1085. bool shift_pressed = Input::get_singleton()->is_key_pressed(Key::SHIFT);
  1086. if (bookmarked || (hovering && !is_dragging_cursor() && shift_pressed)) {
  1087. int horizontal_padding = p_region.size.x / 2;
  1088. int vertical_padding = p_region.size.y / 4;
  1089. Color use_color = bookmark_color;
  1090. if (hovering && shift_pressed) {
  1091. use_color = bookmarked ? use_color.lightened(0.3) : use_color.darkened(0.5);
  1092. }
  1093. Rect2 icon_region = p_region;
  1094. icon_region.position += Point2(horizontal_padding, 0);
  1095. icon_region.size -= Point2(horizontal_padding * 1.1, vertical_padding);
  1096. bookmark_icon->draw_rect(get_canvas_item(), icon_region, false, use_color);
  1097. }
  1098. }
  1099. if (draw_executing_lines && is_line_executing(p_line) && executing_line_icon.is_valid()) {
  1100. int horizontal_padding = p_region.size.x / 10;
  1101. int vertical_padding = p_region.size.y / 4;
  1102. Rect2 icon_region = p_region;
  1103. icon_region.position += Point2(horizontal_padding, vertical_padding);
  1104. icon_region.size -= Point2(horizontal_padding, vertical_padding) * 2;
  1105. executing_line_icon->draw_rect(get_canvas_item(), icon_region, false, executing_line_color);
  1106. }
  1107. }
  1108. // Breakpoints
  1109. void CodeEdit::set_line_as_breakpoint(int p_line, bool p_breakpointed) {
  1110. ERR_FAIL_INDEX(p_line, get_line_count());
  1111. int mask = get_line_gutter_metadata(p_line, main_gutter);
  1112. set_line_gutter_metadata(p_line, main_gutter, p_breakpointed ? mask | MAIN_GUTTER_BREAKPOINT : mask & ~MAIN_GUTTER_BREAKPOINT);
  1113. if (p_breakpointed) {
  1114. breakpointed_lines[p_line] = true;
  1115. } else if (breakpointed_lines.has(p_line)) {
  1116. breakpointed_lines.erase(p_line);
  1117. }
  1118. emit_signal(SNAME("breakpoint_toggled"), p_line);
  1119. queue_redraw();
  1120. }
  1121. bool CodeEdit::is_line_breakpointed(int p_line) const {
  1122. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_BREAKPOINT;
  1123. }
  1124. void CodeEdit::clear_breakpointed_lines() {
  1125. for (int i = 0; i < get_line_count(); i++) {
  1126. if (is_line_breakpointed(i)) {
  1127. set_line_as_breakpoint(i, false);
  1128. }
  1129. }
  1130. }
  1131. PackedInt32Array CodeEdit::get_breakpointed_lines() const {
  1132. PackedInt32Array ret;
  1133. for (int i = 0; i < get_line_count(); i++) {
  1134. if (is_line_breakpointed(i)) {
  1135. ret.append(i);
  1136. }
  1137. }
  1138. return ret;
  1139. }
  1140. // Bookmarks
  1141. void CodeEdit::set_line_as_bookmarked(int p_line, bool p_bookmarked) {
  1142. int mask = get_line_gutter_metadata(p_line, main_gutter);
  1143. set_line_gutter_metadata(p_line, main_gutter, p_bookmarked ? mask | MAIN_GUTTER_BOOKMARK : mask & ~MAIN_GUTTER_BOOKMARK);
  1144. queue_redraw();
  1145. }
  1146. bool CodeEdit::is_line_bookmarked(int p_line) const {
  1147. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_BOOKMARK;
  1148. }
  1149. void CodeEdit::clear_bookmarked_lines() {
  1150. for (int i = 0; i < get_line_count(); i++) {
  1151. if (is_line_bookmarked(i)) {
  1152. set_line_as_bookmarked(i, false);
  1153. }
  1154. }
  1155. }
  1156. PackedInt32Array CodeEdit::get_bookmarked_lines() const {
  1157. PackedInt32Array ret;
  1158. for (int i = 0; i < get_line_count(); i++) {
  1159. if (is_line_bookmarked(i)) {
  1160. ret.append(i);
  1161. }
  1162. }
  1163. return ret;
  1164. }
  1165. // executing lines
  1166. void CodeEdit::set_line_as_executing(int p_line, bool p_executing) {
  1167. int mask = get_line_gutter_metadata(p_line, main_gutter);
  1168. set_line_gutter_metadata(p_line, main_gutter, p_executing ? mask | MAIN_GUTTER_EXECUTING : mask & ~MAIN_GUTTER_EXECUTING);
  1169. queue_redraw();
  1170. }
  1171. bool CodeEdit::is_line_executing(int p_line) const {
  1172. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_EXECUTING;
  1173. }
  1174. void CodeEdit::clear_executing_lines() {
  1175. for (int i = 0; i < get_line_count(); i++) {
  1176. if (is_line_executing(i)) {
  1177. set_line_as_executing(i, false);
  1178. }
  1179. }
  1180. }
  1181. PackedInt32Array CodeEdit::get_executing_lines() const {
  1182. PackedInt32Array ret;
  1183. for (int i = 0; i < get_line_count(); i++) {
  1184. if (is_line_executing(i)) {
  1185. ret.append(i);
  1186. }
  1187. }
  1188. return ret;
  1189. }
  1190. /* Line numbers */
  1191. void CodeEdit::set_draw_line_numbers(bool p_draw) {
  1192. set_gutter_draw(line_number_gutter, p_draw);
  1193. }
  1194. bool CodeEdit::is_draw_line_numbers_enabled() const {
  1195. return is_gutter_drawn(line_number_gutter);
  1196. }
  1197. void CodeEdit::set_line_numbers_zero_padded(bool p_zero_padded) {
  1198. p_zero_padded ? line_number_padding = "0" : line_number_padding = " ";
  1199. queue_redraw();
  1200. }
  1201. bool CodeEdit::is_line_numbers_zero_padded() const {
  1202. return line_number_padding == "0";
  1203. }
  1204. void CodeEdit::_line_number_draw_callback(int p_line, int p_gutter, const Rect2 &p_region) {
  1205. String fc = String::num(p_line + 1).lpad(line_number_digits, line_number_padding);
  1206. if (is_localizing_numeral_system()) {
  1207. fc = TS->format_number(fc);
  1208. }
  1209. Ref<TextLine> tl;
  1210. tl.instantiate();
  1211. tl->add_string(fc, font, font_size);
  1212. int yofs = p_region.position.y + (get_line_height() - tl->get_size().y) / 2;
  1213. Color number_color = get_line_gutter_item_color(p_line, line_number_gutter);
  1214. if (number_color == Color(1, 1, 1)) {
  1215. number_color = line_number_color;
  1216. }
  1217. tl->draw(get_canvas_item(), Point2(p_region.position.x, yofs), number_color);
  1218. }
  1219. /* Fold Gutter */
  1220. void CodeEdit::set_draw_fold_gutter(bool p_draw) {
  1221. set_gutter_draw(fold_gutter, p_draw);
  1222. }
  1223. bool CodeEdit::is_drawing_fold_gutter() const {
  1224. return is_gutter_drawn(fold_gutter);
  1225. }
  1226. void CodeEdit::_fold_gutter_draw_callback(int p_line, int p_gutter, Rect2 p_region) {
  1227. if (!can_fold_line(p_line) && !is_line_folded(p_line)) {
  1228. set_line_gutter_clickable(p_line, fold_gutter, false);
  1229. return;
  1230. }
  1231. set_line_gutter_clickable(p_line, fold_gutter, true);
  1232. int horizontal_padding = p_region.size.x / 10;
  1233. int vertical_padding = p_region.size.y / 6;
  1234. p_region.position += Point2(horizontal_padding, vertical_padding);
  1235. p_region.size -= Point2(horizontal_padding, vertical_padding) * 2;
  1236. if (can_fold_line(p_line)) {
  1237. can_fold_icon->draw_rect(get_canvas_item(), p_region, false, folding_color);
  1238. return;
  1239. }
  1240. folded_icon->draw_rect(get_canvas_item(), p_region, false, folding_color);
  1241. }
  1242. /* Line Folding */
  1243. void CodeEdit::set_line_folding_enabled(bool p_enabled) {
  1244. line_folding_enabled = p_enabled;
  1245. _set_hiding_enabled(p_enabled);
  1246. }
  1247. bool CodeEdit::is_line_folding_enabled() const {
  1248. return line_folding_enabled;
  1249. }
  1250. bool CodeEdit::can_fold_line(int p_line) const {
  1251. ERR_FAIL_INDEX_V(p_line, get_line_count(), false);
  1252. if (!line_folding_enabled) {
  1253. return false;
  1254. }
  1255. if (p_line + 1 >= get_line_count() || get_line(p_line).strip_edges().size() == 0) {
  1256. return false;
  1257. }
  1258. if (_is_line_hidden(p_line) || is_line_folded(p_line)) {
  1259. return false;
  1260. }
  1261. /* Check for full multiline line or block strings / comments. */
  1262. int in_comment = is_in_comment(p_line);
  1263. int in_string = (in_comment == -1) ? is_in_string(p_line) : -1;
  1264. if (in_string != -1 || in_comment != -1) {
  1265. if (get_delimiter_start_position(p_line, get_line(p_line).size() - 1).y != p_line) {
  1266. return false;
  1267. }
  1268. int delimter_end_line = get_delimiter_end_position(p_line, get_line(p_line).size() - 1).y;
  1269. /* No end line, therefore we have a multiline region over the rest of the file. */
  1270. if (delimter_end_line == -1) {
  1271. return true;
  1272. }
  1273. /* End line is the same therefore we have a block. */
  1274. if (delimter_end_line == p_line) {
  1275. /* Check we are the start of the block. */
  1276. if (p_line - 1 >= 0) {
  1277. if ((in_string != -1 && is_in_string(p_line - 1) != -1) || (in_comment != -1 && is_in_comment(p_line - 1) != -1)) {
  1278. return false;
  1279. }
  1280. }
  1281. /* Check it continues for at least one line. */
  1282. return ((in_string != -1 && is_in_string(p_line + 1) != -1) || (in_comment != -1 && is_in_comment(p_line + 1) != -1));
  1283. }
  1284. return ((in_string != -1 && is_in_string(delimter_end_line) != -1) || (in_comment != -1 && is_in_comment(delimter_end_line) != -1));
  1285. }
  1286. /* Otherwise check indent levels. */
  1287. int start_indent = get_indent_level(p_line);
  1288. for (int i = p_line + 1; i < get_line_count(); i++) {
  1289. if (is_in_string(i) != -1 || is_in_comment(i) != -1 || get_line(i).strip_edges().size() == 0) {
  1290. continue;
  1291. }
  1292. return (get_indent_level(i) > start_indent);
  1293. }
  1294. return false;
  1295. }
  1296. void CodeEdit::fold_line(int p_line) {
  1297. ERR_FAIL_INDEX(p_line, get_line_count());
  1298. if (!is_line_folding_enabled() || !can_fold_line(p_line)) {
  1299. return;
  1300. }
  1301. /* Find the last line to be hidden. */
  1302. const int line_count = get_line_count() - 1;
  1303. int end_line = line_count;
  1304. int in_comment = is_in_comment(p_line);
  1305. int in_string = (in_comment == -1) ? is_in_string(p_line) : -1;
  1306. if (in_string != -1 || in_comment != -1) {
  1307. end_line = get_delimiter_end_position(p_line, get_line(p_line).size() - 1).y;
  1308. /* End line is the same therefore we have a block of single line delimiters. */
  1309. if (end_line == p_line) {
  1310. for (int i = p_line + 1; i <= line_count; i++) {
  1311. if ((in_string != -1 && is_in_string(i) == -1) || (in_comment != -1 && is_in_comment(i) == -1)) {
  1312. break;
  1313. }
  1314. end_line = i;
  1315. }
  1316. }
  1317. } else {
  1318. int start_indent = get_indent_level(p_line);
  1319. for (int i = p_line + 1; i <= line_count; i++) {
  1320. if (get_line(i).strip_edges().size() == 0) {
  1321. continue;
  1322. }
  1323. if (get_indent_level(i) > start_indent) {
  1324. end_line = i;
  1325. continue;
  1326. }
  1327. if (is_in_string(i) == -1 && is_in_comment(i) == -1) {
  1328. break;
  1329. }
  1330. }
  1331. }
  1332. for (int i = p_line + 1; i <= end_line; i++) {
  1333. _set_line_as_hidden(i, true);
  1334. }
  1335. for (int i = 0; i < get_caret_count(); i++) {
  1336. // Fix selection.
  1337. if (has_selection(i)) {
  1338. if (_is_line_hidden(get_selection_from_line(i)) && _is_line_hidden(get_selection_to_line(i))) {
  1339. deselect(i);
  1340. } else if (_is_line_hidden(get_selection_from_line(i))) {
  1341. select(p_line, 9999, get_selection_to_line(i), get_selection_to_column(i), i);
  1342. } else if (_is_line_hidden(get_selection_to_line(i))) {
  1343. select(get_selection_from_line(i), get_selection_from_column(i), p_line, 9999, i);
  1344. }
  1345. }
  1346. // Reset caret.
  1347. if (_is_line_hidden(get_caret_line(i))) {
  1348. set_caret_line(p_line, false, false, 0, i);
  1349. set_caret_column(get_line(p_line).length(), false, i);
  1350. }
  1351. }
  1352. merge_overlapping_carets();
  1353. queue_redraw();
  1354. }
  1355. void CodeEdit::unfold_line(int p_line) {
  1356. ERR_FAIL_INDEX(p_line, get_line_count());
  1357. if (!is_line_folded(p_line) && !_is_line_hidden(p_line)) {
  1358. return;
  1359. }
  1360. int fold_start = p_line;
  1361. for (; fold_start > 0; fold_start--) {
  1362. if (is_line_folded(fold_start)) {
  1363. break;
  1364. }
  1365. }
  1366. fold_start = is_line_folded(fold_start) ? fold_start : p_line;
  1367. for (int i = fold_start + 1; i < get_line_count(); i++) {
  1368. if (!_is_line_hidden(i)) {
  1369. break;
  1370. }
  1371. _set_line_as_hidden(i, false);
  1372. }
  1373. queue_redraw();
  1374. }
  1375. void CodeEdit::fold_all_lines() {
  1376. for (int i = 0; i < get_line_count(); i++) {
  1377. fold_line(i);
  1378. }
  1379. queue_redraw();
  1380. }
  1381. void CodeEdit::unfold_all_lines() {
  1382. _unhide_all_lines();
  1383. }
  1384. void CodeEdit::toggle_foldable_line(int p_line) {
  1385. ERR_FAIL_INDEX(p_line, get_line_count());
  1386. if (is_line_folded(p_line)) {
  1387. unfold_line(p_line);
  1388. return;
  1389. }
  1390. fold_line(p_line);
  1391. }
  1392. bool CodeEdit::is_line_folded(int p_line) const {
  1393. ERR_FAIL_INDEX_V(p_line, get_line_count(), false);
  1394. return p_line + 1 < get_line_count() && !_is_line_hidden(p_line) && _is_line_hidden(p_line + 1);
  1395. }
  1396. TypedArray<int> CodeEdit::get_folded_lines() const {
  1397. TypedArray<int> folded_lines;
  1398. for (int i = 0; i < get_line_count(); i++) {
  1399. if (is_line_folded(i)) {
  1400. folded_lines.push_back(i);
  1401. }
  1402. }
  1403. return folded_lines;
  1404. }
  1405. /* Delimiters */
  1406. // Strings
  1407. void CodeEdit::add_string_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only) {
  1408. _add_delimiter(p_start_key, p_end_key, p_line_only, TYPE_STRING);
  1409. }
  1410. void CodeEdit::remove_string_delimiter(const String &p_start_key) {
  1411. _remove_delimiter(p_start_key, TYPE_STRING);
  1412. }
  1413. bool CodeEdit::has_string_delimiter(const String &p_start_key) const {
  1414. return _has_delimiter(p_start_key, TYPE_STRING);
  1415. }
  1416. void CodeEdit::set_string_delimiters(const TypedArray<String> &p_string_delimiters) {
  1417. _set_delimiters(p_string_delimiters, TYPE_STRING);
  1418. }
  1419. void CodeEdit::clear_string_delimiters() {
  1420. _clear_delimiters(TYPE_STRING);
  1421. }
  1422. TypedArray<String> CodeEdit::get_string_delimiters() const {
  1423. return _get_delimiters(TYPE_STRING);
  1424. }
  1425. int CodeEdit::is_in_string(int p_line, int p_column) const {
  1426. return _is_in_delimiter(p_line, p_column, TYPE_STRING);
  1427. }
  1428. // Comments
  1429. void CodeEdit::add_comment_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only) {
  1430. _add_delimiter(p_start_key, p_end_key, p_line_only, TYPE_COMMENT);
  1431. }
  1432. void CodeEdit::remove_comment_delimiter(const String &p_start_key) {
  1433. _remove_delimiter(p_start_key, TYPE_COMMENT);
  1434. }
  1435. bool CodeEdit::has_comment_delimiter(const String &p_start_key) const {
  1436. return _has_delimiter(p_start_key, TYPE_COMMENT);
  1437. }
  1438. void CodeEdit::set_comment_delimiters(const TypedArray<String> &p_comment_delimiters) {
  1439. _set_delimiters(p_comment_delimiters, TYPE_COMMENT);
  1440. }
  1441. void CodeEdit::clear_comment_delimiters() {
  1442. _clear_delimiters(TYPE_COMMENT);
  1443. }
  1444. TypedArray<String> CodeEdit::get_comment_delimiters() const {
  1445. return _get_delimiters(TYPE_COMMENT);
  1446. }
  1447. int CodeEdit::is_in_comment(int p_line, int p_column) const {
  1448. return _is_in_delimiter(p_line, p_column, TYPE_COMMENT);
  1449. }
  1450. String CodeEdit::get_delimiter_start_key(int p_delimiter_idx) const {
  1451. ERR_FAIL_INDEX_V(p_delimiter_idx, delimiters.size(), "");
  1452. return delimiters[p_delimiter_idx].start_key;
  1453. }
  1454. String CodeEdit::get_delimiter_end_key(int p_delimiter_idx) const {
  1455. ERR_FAIL_INDEX_V(p_delimiter_idx, delimiters.size(), "");
  1456. return delimiters[p_delimiter_idx].end_key;
  1457. }
  1458. Point2 CodeEdit::get_delimiter_start_position(int p_line, int p_column) const {
  1459. if (delimiters.size() == 0) {
  1460. return Point2(-1, -1);
  1461. }
  1462. ERR_FAIL_INDEX_V(p_line, get_line_count(), Point2(-1, -1));
  1463. ERR_FAIL_COND_V(p_column - 1 > get_line(p_line).size(), Point2(-1, -1));
  1464. Point2 start_position;
  1465. start_position.y = -1;
  1466. start_position.x = -1;
  1467. bool in_region = ((p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->get()) != -1;
  1468. /* Check the keys for this line. */
  1469. for (const KeyValue<int, int> &E : delimiter_cache[p_line]) {
  1470. if (E.key > p_column) {
  1471. break;
  1472. }
  1473. in_region = E.value != -1;
  1474. start_position.x = in_region ? E.key : -1;
  1475. }
  1476. /* Region was found on this line and is not a multiline continuation. */
  1477. int line_length = get_line(p_line).length();
  1478. if (start_position.x != -1 && line_length > 0 && start_position.x != line_length + 1) {
  1479. start_position.y = p_line;
  1480. return start_position;
  1481. }
  1482. /* Not in a region */
  1483. if (!in_region) {
  1484. return start_position;
  1485. }
  1486. /* Region starts on a previous line */
  1487. for (int i = p_line - 1; i >= 0; i--) {
  1488. if (delimiter_cache[i].size() < 1) {
  1489. continue;
  1490. }
  1491. start_position.y = i;
  1492. start_position.x = delimiter_cache[i].back()->key();
  1493. /* Make sure it's not a multiline continuation. */
  1494. line_length = get_line(i).length();
  1495. if (line_length > 0 && start_position.x != line_length + 1) {
  1496. break;
  1497. }
  1498. }
  1499. return start_position;
  1500. }
  1501. Point2 CodeEdit::get_delimiter_end_position(int p_line, int p_column) const {
  1502. if (delimiters.size() == 0) {
  1503. return Point2(-1, -1);
  1504. }
  1505. ERR_FAIL_INDEX_V(p_line, get_line_count(), Point2(-1, -1));
  1506. ERR_FAIL_COND_V(p_column - 1 > get_line(p_line).size(), Point2(-1, -1));
  1507. Point2 end_position;
  1508. end_position.y = -1;
  1509. end_position.x = -1;
  1510. int region = (p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->value();
  1511. /* Check the keys for this line. */
  1512. for (const KeyValue<int, int> &E : delimiter_cache[p_line]) {
  1513. end_position.x = (E.value == -1) ? E.key : -1;
  1514. if (E.key > p_column) {
  1515. break;
  1516. }
  1517. region = E.value;
  1518. }
  1519. /* Region was found on this line and is not a multiline continuation. */
  1520. if (region != -1 && end_position.x != -1 && (delimiters[region].line_only || end_position.x != get_line(p_line).length() + 1)) {
  1521. end_position.y = p_line;
  1522. return end_position;
  1523. }
  1524. /* Not in a region */
  1525. if (region == -1) {
  1526. end_position.x = -1;
  1527. return end_position;
  1528. }
  1529. /* Region ends on a later line */
  1530. for (int i = p_line + 1; i < get_line_count(); i++) {
  1531. if (delimiter_cache[i].size() < 1 || delimiter_cache[i].front()->value() != -1) {
  1532. continue;
  1533. }
  1534. end_position.x = delimiter_cache[i].front()->key();
  1535. /* Make sure it's not a multiline continuation. */
  1536. if (get_line(i).length() > 0 && end_position.x != get_line(i).length() + 1) {
  1537. end_position.y = i;
  1538. break;
  1539. }
  1540. end_position.x = -1;
  1541. }
  1542. return end_position;
  1543. }
  1544. /* Code hint */
  1545. void CodeEdit::set_code_hint(const String &p_hint) {
  1546. code_hint = p_hint;
  1547. code_hint_xpos = -0xFFFF;
  1548. queue_redraw();
  1549. }
  1550. void CodeEdit::set_code_hint_draw_below(bool p_below) {
  1551. code_hint_draw_below = p_below;
  1552. queue_redraw();
  1553. }
  1554. /* Code Completion */
  1555. void CodeEdit::set_code_completion_enabled(bool p_enable) {
  1556. code_completion_enabled = p_enable;
  1557. }
  1558. bool CodeEdit::is_code_completion_enabled() const {
  1559. return code_completion_enabled;
  1560. }
  1561. void CodeEdit::set_code_completion_prefixes(const TypedArray<String> &p_prefixes) {
  1562. code_completion_prefixes.clear();
  1563. for (int i = 0; i < p_prefixes.size(); i++) {
  1564. const String prefix = p_prefixes[i];
  1565. ERR_CONTINUE_MSG(prefix.is_empty(), "Code completion prefix cannot be empty.");
  1566. code_completion_prefixes.insert(prefix[0]);
  1567. }
  1568. }
  1569. TypedArray<String> CodeEdit::get_code_completion_prefixes() const {
  1570. TypedArray<String> prefixes;
  1571. for (const char32_t &E : code_completion_prefixes) {
  1572. prefixes.push_back(String::chr(E));
  1573. }
  1574. return prefixes;
  1575. }
  1576. String CodeEdit::get_text_for_code_completion() const {
  1577. StringBuilder completion_text;
  1578. const int text_size = get_line_count();
  1579. for (int i = 0; i < text_size; i++) {
  1580. String line = get_line(i);
  1581. if (i == get_caret_line()) {
  1582. completion_text += line.substr(0, get_caret_column());
  1583. /* Not unicode, represents the caret. */
  1584. completion_text += String::chr(0xFFFF);
  1585. completion_text += line.substr(get_caret_column(), line.size());
  1586. } else {
  1587. completion_text += line;
  1588. }
  1589. if (i != text_size - 1) {
  1590. completion_text += "\n";
  1591. }
  1592. }
  1593. return completion_text.as_string();
  1594. }
  1595. void CodeEdit::request_code_completion(bool p_force) {
  1596. if (GDVIRTUAL_CALL(_request_code_completion, p_force)) {
  1597. return;
  1598. }
  1599. /* Don't re-query if all existing options are quoted types, eg path, signal. */
  1600. bool ignored = code_completion_active && !code_completion_options.is_empty();
  1601. if (ignored) {
  1602. ScriptLanguage::CodeCompletionKind kind = ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT;
  1603. const ScriptLanguage::CodeCompletionOption *previous_option = nullptr;
  1604. for (int i = 0; i < code_completion_options.size(); i++) {
  1605. const ScriptLanguage::CodeCompletionOption &current_option = code_completion_options[i];
  1606. if (!previous_option) {
  1607. previous_option = &current_option;
  1608. kind = current_option.kind;
  1609. }
  1610. if (previous_option->kind != current_option.kind) {
  1611. ignored = false;
  1612. break;
  1613. }
  1614. }
  1615. ignored = ignored && (kind == ScriptLanguage::CODE_COMPLETION_KIND_FILE_PATH || kind == ScriptLanguage::CODE_COMPLETION_KIND_NODE_PATH || kind == ScriptLanguage::CODE_COMPLETION_KIND_SIGNAL);
  1616. }
  1617. if (ignored) {
  1618. return;
  1619. }
  1620. if (p_force) {
  1621. emit_signal(SNAME("code_completion_requested"));
  1622. return;
  1623. }
  1624. String line = get_line(get_caret_line());
  1625. int ofs = CLAMP(get_caret_column(), 0, line.length());
  1626. if (ofs > 0 && (is_in_string(get_caret_line(), ofs) != -1 || !is_symbol(line[ofs - 1]) || code_completion_prefixes.has(line[ofs - 1]))) {
  1627. emit_signal(SNAME("code_completion_requested"));
  1628. } else if (ofs > 1 && line[ofs - 1] == ' ' && code_completion_prefixes.has(line[ofs - 2])) {
  1629. emit_signal(SNAME("code_completion_requested"));
  1630. }
  1631. }
  1632. void CodeEdit::add_code_completion_option(CodeCompletionKind p_type, const String &p_display_text, const String &p_insert_text, const Color &p_text_color, const Ref<Resource> &p_icon, const Variant &p_value) {
  1633. ScriptLanguage::CodeCompletionOption completion_option;
  1634. completion_option.kind = (ScriptLanguage::CodeCompletionKind)p_type;
  1635. completion_option.display = p_display_text;
  1636. completion_option.insert_text = p_insert_text;
  1637. completion_option.font_color = p_text_color;
  1638. completion_option.icon = p_icon;
  1639. completion_option.default_value = p_value;
  1640. code_completion_option_submitted.push_back(completion_option);
  1641. }
  1642. void CodeEdit::update_code_completion_options(bool p_forced) {
  1643. code_completion_forced = p_forced;
  1644. code_completion_option_sources = code_completion_option_submitted;
  1645. code_completion_option_submitted.clear();
  1646. _filter_code_completion_candidates_impl();
  1647. }
  1648. TypedArray<Dictionary> CodeEdit::get_code_completion_options() const {
  1649. if (!code_completion_active) {
  1650. return TypedArray<Dictionary>();
  1651. }
  1652. TypedArray<Dictionary> completion_options;
  1653. completion_options.resize(code_completion_options.size());
  1654. for (int i = 0; i < code_completion_options.size(); i++) {
  1655. Dictionary option;
  1656. option["kind"] = code_completion_options[i].kind;
  1657. option["display_text"] = code_completion_options[i].display;
  1658. option["insert_text"] = code_completion_options[i].insert_text;
  1659. option["font_color"] = code_completion_options[i].font_color;
  1660. option["icon"] = code_completion_options[i].icon;
  1661. option["default_value"] = code_completion_options[i].default_value;
  1662. completion_options[i] = option;
  1663. }
  1664. return completion_options;
  1665. }
  1666. Dictionary CodeEdit::get_code_completion_option(int p_index) const {
  1667. if (!code_completion_active) {
  1668. return Dictionary();
  1669. }
  1670. ERR_FAIL_INDEX_V(p_index, code_completion_options.size(), Dictionary());
  1671. Dictionary option;
  1672. option["kind"] = code_completion_options[p_index].kind;
  1673. option["display_text"] = code_completion_options[p_index].display;
  1674. option["insert_text"] = code_completion_options[p_index].insert_text;
  1675. option["font_color"] = code_completion_options[p_index].font_color;
  1676. option["icon"] = code_completion_options[p_index].icon;
  1677. option["default_value"] = code_completion_options[p_index].default_value;
  1678. return option;
  1679. }
  1680. int CodeEdit::get_code_completion_selected_index() const {
  1681. return (code_completion_active) ? code_completion_current_selected : -1;
  1682. }
  1683. void CodeEdit::set_code_completion_selected_index(int p_index) {
  1684. if (!code_completion_active) {
  1685. return;
  1686. }
  1687. ERR_FAIL_INDEX(p_index, code_completion_options.size());
  1688. code_completion_current_selected = p_index;
  1689. code_completion_force_item_center = -1;
  1690. queue_redraw();
  1691. }
  1692. void CodeEdit::confirm_code_completion(bool p_replace) {
  1693. if (!is_editable() || !code_completion_active) {
  1694. return;
  1695. }
  1696. if (GDVIRTUAL_CALL(_confirm_code_completion, p_replace)) {
  1697. return;
  1698. }
  1699. char32_t caret_last_completion_char;
  1700. begin_complex_operation();
  1701. Vector<int> caret_edit_order = get_caret_index_edit_order();
  1702. for (const int &i : caret_edit_order) {
  1703. int caret_line = get_caret_line(i);
  1704. const String &insert_text = code_completion_options[code_completion_current_selected].insert_text;
  1705. const String &display_text = code_completion_options[code_completion_current_selected].display;
  1706. if (p_replace) {
  1707. // Find end of current section.
  1708. const String line = get_line(caret_line);
  1709. int caret_col = get_caret_column(i);
  1710. int caret_remove_line = caret_line;
  1711. bool merge_text = true;
  1712. int in_string = is_in_string(caret_line, caret_col);
  1713. if (in_string != -1) {
  1714. Point2 string_end = get_delimiter_end_position(caret_line, caret_col);
  1715. if (string_end.x != -1) {
  1716. merge_text = false;
  1717. caret_remove_line = string_end.y;
  1718. caret_col = string_end.x - 1;
  1719. }
  1720. }
  1721. if (merge_text) {
  1722. for (; caret_col < line.length(); caret_col++) {
  1723. if (is_symbol(line[caret_col])) {
  1724. break;
  1725. }
  1726. }
  1727. }
  1728. // Replace.
  1729. remove_text(caret_line, get_caret_column(i) - code_completion_base.length(), caret_remove_line, caret_col);
  1730. adjust_carets_after_edit(i, caret_line, caret_col - code_completion_base.length(), caret_remove_line, caret_col);
  1731. set_caret_column(get_caret_column(i) - code_completion_base.length(), false, i);
  1732. insert_text_at_caret(insert_text, i);
  1733. } else {
  1734. // Get first non-matching char.
  1735. const String line = get_line(caret_line);
  1736. int caret_col = get_caret_column(i);
  1737. int matching_chars = code_completion_base.length();
  1738. for (; matching_chars <= insert_text.length(); matching_chars++) {
  1739. if (caret_col >= line.length() || line[caret_col] != insert_text[matching_chars]) {
  1740. break;
  1741. }
  1742. caret_col++;
  1743. }
  1744. // Remove base completion text.
  1745. remove_text(caret_line, get_caret_column(i) - code_completion_base.length(), caret_line, get_caret_column(i));
  1746. adjust_carets_after_edit(i, caret_line, get_caret_column(i) - code_completion_base.length(), caret_line, get_caret_column(i));
  1747. set_caret_column(get_caret_column(i) - code_completion_base.length(), false, i);
  1748. // Merge with text.
  1749. insert_text_at_caret(insert_text.substr(0, code_completion_base.length()), i);
  1750. set_caret_column(caret_col, false, i);
  1751. insert_text_at_caret(insert_text.substr(matching_chars), i);
  1752. }
  1753. //* Handle merging of symbols eg strings, brackets.
  1754. const String line = get_line(caret_line);
  1755. char32_t next_char = line[get_caret_column(i)];
  1756. char32_t last_completion_char = insert_text[insert_text.length() - 1];
  1757. if (i == 0) {
  1758. caret_last_completion_char = last_completion_char;
  1759. }
  1760. char32_t last_completion_char_display = display_text[display_text.length() - 1];
  1761. int pre_brace_pair = get_caret_column(i) > 0 ? _get_auto_brace_pair_open_at_pos(caret_line, get_caret_column(i)) : -1;
  1762. int post_brace_pair = get_caret_column(i) < get_line(caret_line).length() ? _get_auto_brace_pair_close_at_pos(caret_line, get_caret_column(i)) : -1;
  1763. if (post_brace_pair != -1 && (last_completion_char == next_char || last_completion_char_display == next_char)) {
  1764. remove_text(caret_line, get_caret_column(i), caret_line, get_caret_column(i) + 1);
  1765. adjust_carets_after_edit(i, caret_line, get_caret_column(i), caret_line, get_caret_column(i) + 1);
  1766. }
  1767. if (pre_brace_pair != -1 && pre_brace_pair != post_brace_pair && (last_completion_char == next_char || last_completion_char_display == next_char)) {
  1768. remove_text(caret_line, get_caret_column(i), caret_line, get_caret_column(i) + 1);
  1769. adjust_carets_after_edit(i, caret_line, get_caret_column(i), caret_line, get_caret_column(i) + 1);
  1770. } else if (auto_brace_completion_enabled && pre_brace_pair != -1 && post_brace_pair == -1) {
  1771. insert_text_at_caret(auto_brace_completion_pairs[pre_brace_pair].close_key, i);
  1772. set_caret_column(get_caret_column(i) - auto_brace_completion_pairs[pre_brace_pair].close_key.length(), i == 0, i);
  1773. }
  1774. if (pre_brace_pair == -1 && post_brace_pair == -1 && get_caret_column(i) > 0 && get_caret_column(i) < get_line(caret_line).length()) {
  1775. pre_brace_pair = _get_auto_brace_pair_open_at_pos(caret_line, get_caret_column(i) + 1);
  1776. if (pre_brace_pair != -1 && pre_brace_pair == _get_auto_brace_pair_close_at_pos(caret_line, get_caret_column(i) - 1)) {
  1777. remove_text(caret_line, get_caret_column(i) - 2, caret_line, get_caret_column(i));
  1778. adjust_carets_after_edit(i, caret_line, get_caret_column(i) - 2, caret_line, get_caret_column(i));
  1779. if (_get_auto_brace_pair_close_at_pos(caret_line, get_caret_column(i) - 1) != pre_brace_pair) {
  1780. set_caret_column(get_caret_column(i) - 1, i == 0, i);
  1781. }
  1782. }
  1783. }
  1784. }
  1785. end_complex_operation();
  1786. cancel_code_completion();
  1787. if (code_completion_prefixes.has(caret_last_completion_char)) {
  1788. request_code_completion();
  1789. }
  1790. }
  1791. void CodeEdit::cancel_code_completion() {
  1792. if (!code_completion_active) {
  1793. return;
  1794. }
  1795. code_completion_forced = false;
  1796. code_completion_active = false;
  1797. queue_redraw();
  1798. }
  1799. /* Line length guidelines */
  1800. void CodeEdit::set_line_length_guidelines(TypedArray<int> p_guideline_columns) {
  1801. line_length_guideline_columns = p_guideline_columns;
  1802. queue_redraw();
  1803. }
  1804. TypedArray<int> CodeEdit::get_line_length_guidelines() const {
  1805. return line_length_guideline_columns;
  1806. }
  1807. /* Symbol lookup */
  1808. void CodeEdit::set_symbol_lookup_on_click_enabled(bool p_enabled) {
  1809. symbol_lookup_on_click_enabled = p_enabled;
  1810. set_symbol_lookup_word_as_valid(false);
  1811. }
  1812. bool CodeEdit::is_symbol_lookup_on_click_enabled() const {
  1813. return symbol_lookup_on_click_enabled;
  1814. }
  1815. String CodeEdit::get_text_for_symbol_lookup() {
  1816. Point2i mp = get_local_mouse_pos();
  1817. Point2i pos = get_line_column_at_pos(mp, false);
  1818. int line = pos.y;
  1819. int col = pos.x;
  1820. if (line == -1) {
  1821. return String();
  1822. }
  1823. StringBuilder lookup_text;
  1824. const int text_size = get_line_count();
  1825. for (int i = 0; i < text_size; i++) {
  1826. String line_text = get_line(i);
  1827. if (i == line) {
  1828. lookup_text += line_text.substr(0, col);
  1829. /* Not unicode, represents the cursor. */
  1830. lookup_text += String::chr(0xFFFF);
  1831. lookup_text += line_text.substr(col, line_text.size());
  1832. } else {
  1833. lookup_text += line_text;
  1834. }
  1835. if (i != text_size - 1) {
  1836. lookup_text += "\n";
  1837. }
  1838. }
  1839. return lookup_text.as_string();
  1840. }
  1841. void CodeEdit::set_symbol_lookup_word_as_valid(bool p_valid) {
  1842. symbol_lookup_word = p_valid ? symbol_lookup_new_word : "";
  1843. symbol_lookup_new_word = "";
  1844. if (lookup_symbol_word != symbol_lookup_word) {
  1845. _set_symbol_lookup_word(symbol_lookup_word);
  1846. }
  1847. }
  1848. void CodeEdit::_bind_methods() {
  1849. /* Indent management */
  1850. ClassDB::bind_method(D_METHOD("set_indent_size", "size"), &CodeEdit::set_indent_size);
  1851. ClassDB::bind_method(D_METHOD("get_indent_size"), &CodeEdit::get_indent_size);
  1852. ClassDB::bind_method(D_METHOD("set_indent_using_spaces", "use_spaces"), &CodeEdit::set_indent_using_spaces);
  1853. ClassDB::bind_method(D_METHOD("is_indent_using_spaces"), &CodeEdit::is_indent_using_spaces);
  1854. ClassDB::bind_method(D_METHOD("set_auto_indent_enabled", "enable"), &CodeEdit::set_auto_indent_enabled);
  1855. ClassDB::bind_method(D_METHOD("is_auto_indent_enabled"), &CodeEdit::is_auto_indent_enabled);
  1856. ClassDB::bind_method(D_METHOD("set_auto_indent_prefixes", "prefixes"), &CodeEdit::set_auto_indent_prefixes);
  1857. ClassDB::bind_method(D_METHOD("get_auto_indent_prefixes"), &CodeEdit::get_auto_indent_prefixes);
  1858. ClassDB::bind_method(D_METHOD("do_indent"), &CodeEdit::do_indent);
  1859. ClassDB::bind_method(D_METHOD("do_unindent"), &CodeEdit::do_unindent);
  1860. ClassDB::bind_method(D_METHOD("indent_lines"), &CodeEdit::indent_lines);
  1861. ClassDB::bind_method(D_METHOD("unindent_lines"), &CodeEdit::unindent_lines);
  1862. /* Auto brace completion */
  1863. ClassDB::bind_method(D_METHOD("set_auto_brace_completion_enabled", "enable"), &CodeEdit::set_auto_brace_completion_enabled);
  1864. ClassDB::bind_method(D_METHOD("is_auto_brace_completion_enabled"), &CodeEdit::is_auto_brace_completion_enabled);
  1865. ClassDB::bind_method(D_METHOD("set_highlight_matching_braces_enabled", "enable"), &CodeEdit::set_highlight_matching_braces_enabled);
  1866. ClassDB::bind_method(D_METHOD("is_highlight_matching_braces_enabled"), &CodeEdit::is_highlight_matching_braces_enabled);
  1867. ClassDB::bind_method(D_METHOD("add_auto_brace_completion_pair", "start_key", "end_key"), &CodeEdit::add_auto_brace_completion_pair);
  1868. ClassDB::bind_method(D_METHOD("set_auto_brace_completion_pairs", "pairs"), &CodeEdit::set_auto_brace_completion_pairs);
  1869. ClassDB::bind_method(D_METHOD("get_auto_brace_completion_pairs"), &CodeEdit::get_auto_brace_completion_pairs);
  1870. ClassDB::bind_method(D_METHOD("has_auto_brace_completion_open_key", "open_key"), &CodeEdit::has_auto_brace_completion_open_key);
  1871. ClassDB::bind_method(D_METHOD("has_auto_brace_completion_close_key", "close_key"), &CodeEdit::has_auto_brace_completion_close_key);
  1872. ClassDB::bind_method(D_METHOD("get_auto_brace_completion_close_key", "open_key"), &CodeEdit::get_auto_brace_completion_close_key);
  1873. /* Main Gutter */
  1874. ClassDB::bind_method(D_METHOD("set_draw_breakpoints_gutter", "enable"), &CodeEdit::set_draw_breakpoints_gutter);
  1875. ClassDB::bind_method(D_METHOD("is_drawing_breakpoints_gutter"), &CodeEdit::is_drawing_breakpoints_gutter);
  1876. ClassDB::bind_method(D_METHOD("set_draw_bookmarks_gutter", "enable"), &CodeEdit::set_draw_bookmarks_gutter);
  1877. ClassDB::bind_method(D_METHOD("is_drawing_bookmarks_gutter"), &CodeEdit::is_drawing_bookmarks_gutter);
  1878. ClassDB::bind_method(D_METHOD("set_draw_executing_lines_gutter", "enable"), &CodeEdit::set_draw_executing_lines_gutter);
  1879. ClassDB::bind_method(D_METHOD("is_drawing_executing_lines_gutter"), &CodeEdit::is_drawing_executing_lines_gutter);
  1880. // Breakpoints
  1881. ClassDB::bind_method(D_METHOD("set_line_as_breakpoint", "line", "breakpointed"), &CodeEdit::set_line_as_breakpoint);
  1882. ClassDB::bind_method(D_METHOD("is_line_breakpointed", "line"), &CodeEdit::is_line_breakpointed);
  1883. ClassDB::bind_method(D_METHOD("clear_breakpointed_lines"), &CodeEdit::clear_breakpointed_lines);
  1884. ClassDB::bind_method(D_METHOD("get_breakpointed_lines"), &CodeEdit::get_breakpointed_lines);
  1885. // Bookmarks
  1886. ClassDB::bind_method(D_METHOD("set_line_as_bookmarked", "line", "bookmarked"), &CodeEdit::set_line_as_bookmarked);
  1887. ClassDB::bind_method(D_METHOD("is_line_bookmarked", "line"), &CodeEdit::is_line_bookmarked);
  1888. ClassDB::bind_method(D_METHOD("clear_bookmarked_lines"), &CodeEdit::clear_bookmarked_lines);
  1889. ClassDB::bind_method(D_METHOD("get_bookmarked_lines"), &CodeEdit::get_bookmarked_lines);
  1890. // executing lines
  1891. ClassDB::bind_method(D_METHOD("set_line_as_executing", "line", "executing"), &CodeEdit::set_line_as_executing);
  1892. ClassDB::bind_method(D_METHOD("is_line_executing", "line"), &CodeEdit::is_line_executing);
  1893. ClassDB::bind_method(D_METHOD("clear_executing_lines"), &CodeEdit::clear_executing_lines);
  1894. ClassDB::bind_method(D_METHOD("get_executing_lines"), &CodeEdit::get_executing_lines);
  1895. /* Line numbers */
  1896. ClassDB::bind_method(D_METHOD("set_draw_line_numbers", "enable"), &CodeEdit::set_draw_line_numbers);
  1897. ClassDB::bind_method(D_METHOD("is_draw_line_numbers_enabled"), &CodeEdit::is_draw_line_numbers_enabled);
  1898. ClassDB::bind_method(D_METHOD("set_line_numbers_zero_padded", "enable"), &CodeEdit::set_line_numbers_zero_padded);
  1899. ClassDB::bind_method(D_METHOD("is_line_numbers_zero_padded"), &CodeEdit::is_line_numbers_zero_padded);
  1900. /* Fold Gutter */
  1901. ClassDB::bind_method(D_METHOD("set_draw_fold_gutter", "enable"), &CodeEdit::set_draw_fold_gutter);
  1902. ClassDB::bind_method(D_METHOD("is_drawing_fold_gutter"), &CodeEdit::is_drawing_fold_gutter);
  1903. /* Line folding */
  1904. ClassDB::bind_method(D_METHOD("set_line_folding_enabled", "enabled"), &CodeEdit::set_line_folding_enabled);
  1905. ClassDB::bind_method(D_METHOD("is_line_folding_enabled"), &CodeEdit::is_line_folding_enabled);
  1906. ClassDB::bind_method(D_METHOD("can_fold_line", "line"), &CodeEdit::can_fold_line);
  1907. ClassDB::bind_method(D_METHOD("fold_line", "line"), &CodeEdit::fold_line);
  1908. ClassDB::bind_method(D_METHOD("unfold_line", "line"), &CodeEdit::unfold_line);
  1909. ClassDB::bind_method(D_METHOD("fold_all_lines"), &CodeEdit::fold_all_lines);
  1910. ClassDB::bind_method(D_METHOD("unfold_all_lines"), &CodeEdit::unfold_all_lines);
  1911. ClassDB::bind_method(D_METHOD("toggle_foldable_line", "line"), &CodeEdit::toggle_foldable_line);
  1912. ClassDB::bind_method(D_METHOD("is_line_folded", "line"), &CodeEdit::is_line_folded);
  1913. ClassDB::bind_method(D_METHOD("get_folded_lines"), &CodeEdit::get_folded_lines);
  1914. /* Delimiters */
  1915. // Strings
  1916. ClassDB::bind_method(D_METHOD("add_string_delimiter", "start_key", "end_key", "line_only"), &CodeEdit::add_string_delimiter, DEFVAL(false));
  1917. ClassDB::bind_method(D_METHOD("remove_string_delimiter", "start_key"), &CodeEdit::remove_string_delimiter);
  1918. ClassDB::bind_method(D_METHOD("has_string_delimiter", "start_key"), &CodeEdit::has_string_delimiter);
  1919. ClassDB::bind_method(D_METHOD("set_string_delimiters", "string_delimiters"), &CodeEdit::set_string_delimiters);
  1920. ClassDB::bind_method(D_METHOD("clear_string_delimiters"), &CodeEdit::clear_string_delimiters);
  1921. ClassDB::bind_method(D_METHOD("get_string_delimiters"), &CodeEdit::get_string_delimiters);
  1922. ClassDB::bind_method(D_METHOD("is_in_string", "line", "column"), &CodeEdit::is_in_string, DEFVAL(-1));
  1923. // Comments
  1924. ClassDB::bind_method(D_METHOD("add_comment_delimiter", "start_key", "end_key", "line_only"), &CodeEdit::add_comment_delimiter, DEFVAL(false));
  1925. ClassDB::bind_method(D_METHOD("remove_comment_delimiter", "start_key"), &CodeEdit::remove_comment_delimiter);
  1926. ClassDB::bind_method(D_METHOD("has_comment_delimiter", "start_key"), &CodeEdit::has_comment_delimiter);
  1927. ClassDB::bind_method(D_METHOD("set_comment_delimiters", "comment_delimiters"), &CodeEdit::set_comment_delimiters);
  1928. ClassDB::bind_method(D_METHOD("clear_comment_delimiters"), &CodeEdit::clear_comment_delimiters);
  1929. ClassDB::bind_method(D_METHOD("get_comment_delimiters"), &CodeEdit::get_comment_delimiters);
  1930. ClassDB::bind_method(D_METHOD("is_in_comment", "line", "column"), &CodeEdit::is_in_comment, DEFVAL(-1));
  1931. // Util
  1932. ClassDB::bind_method(D_METHOD("get_delimiter_start_key", "delimiter_index"), &CodeEdit::get_delimiter_start_key);
  1933. ClassDB::bind_method(D_METHOD("get_delimiter_end_key", "delimiter_index"), &CodeEdit::get_delimiter_end_key);
  1934. ClassDB::bind_method(D_METHOD("get_delimiter_start_position", "line", "column"), &CodeEdit::get_delimiter_start_position);
  1935. ClassDB::bind_method(D_METHOD("get_delimiter_end_position", "line", "column"), &CodeEdit::get_delimiter_end_position);
  1936. /* Code hint */
  1937. ClassDB::bind_method(D_METHOD("set_code_hint", "code_hint"), &CodeEdit::set_code_hint);
  1938. ClassDB::bind_method(D_METHOD("set_code_hint_draw_below", "draw_below"), &CodeEdit::set_code_hint_draw_below);
  1939. /* Code Completion */
  1940. BIND_ENUM_CONSTANT(KIND_CLASS);
  1941. BIND_ENUM_CONSTANT(KIND_FUNCTION);
  1942. BIND_ENUM_CONSTANT(KIND_SIGNAL);
  1943. BIND_ENUM_CONSTANT(KIND_VARIABLE);
  1944. BIND_ENUM_CONSTANT(KIND_MEMBER);
  1945. BIND_ENUM_CONSTANT(KIND_ENUM);
  1946. BIND_ENUM_CONSTANT(KIND_CONSTANT);
  1947. BIND_ENUM_CONSTANT(KIND_NODE_PATH);
  1948. BIND_ENUM_CONSTANT(KIND_FILE_PATH);
  1949. BIND_ENUM_CONSTANT(KIND_PLAIN_TEXT);
  1950. ClassDB::bind_method(D_METHOD("get_text_for_code_completion"), &CodeEdit::get_text_for_code_completion);
  1951. ClassDB::bind_method(D_METHOD("request_code_completion", "force"), &CodeEdit::request_code_completion, DEFVAL(false));
  1952. ClassDB::bind_method(D_METHOD("add_code_completion_option", "type", "display_text", "insert_text", "text_color", "icon", "value"), &CodeEdit::add_code_completion_option, DEFVAL(Color(1, 1, 1)), DEFVAL(Ref<Resource>()), DEFVAL(Variant::NIL));
  1953. ClassDB::bind_method(D_METHOD("update_code_completion_options", "force"), &CodeEdit::update_code_completion_options);
  1954. ClassDB::bind_method(D_METHOD("get_code_completion_options"), &CodeEdit::get_code_completion_options);
  1955. ClassDB::bind_method(D_METHOD("get_code_completion_option", "index"), &CodeEdit::get_code_completion_option);
  1956. ClassDB::bind_method(D_METHOD("get_code_completion_selected_index"), &CodeEdit::get_code_completion_selected_index);
  1957. ClassDB::bind_method(D_METHOD("set_code_completion_selected_index", "index"), &CodeEdit::set_code_completion_selected_index);
  1958. ClassDB::bind_method(D_METHOD("confirm_code_completion", "replace"), &CodeEdit::confirm_code_completion, DEFVAL(false));
  1959. ClassDB::bind_method(D_METHOD("cancel_code_completion"), &CodeEdit::cancel_code_completion);
  1960. ClassDB::bind_method(D_METHOD("set_code_completion_enabled", "enable"), &CodeEdit::set_code_completion_enabled);
  1961. ClassDB::bind_method(D_METHOD("is_code_completion_enabled"), &CodeEdit::is_code_completion_enabled);
  1962. ClassDB::bind_method(D_METHOD("set_code_completion_prefixes", "prefixes"), &CodeEdit::set_code_completion_prefixes);
  1963. ClassDB::bind_method(D_METHOD("get_code_comletion_prefixes"), &CodeEdit::get_code_completion_prefixes);
  1964. // Overridable
  1965. GDVIRTUAL_BIND(_confirm_code_completion, "replace")
  1966. GDVIRTUAL_BIND(_request_code_completion, "force")
  1967. GDVIRTUAL_BIND(_filter_code_completion_candidates, "candidates")
  1968. /* Line length guidelines */
  1969. ClassDB::bind_method(D_METHOD("set_line_length_guidelines", "guideline_columns"), &CodeEdit::set_line_length_guidelines);
  1970. ClassDB::bind_method(D_METHOD("get_line_length_guidelines"), &CodeEdit::get_line_length_guidelines);
  1971. /* Symbol lookup */
  1972. ClassDB::bind_method(D_METHOD("set_symbol_lookup_on_click_enabled", "enable"), &CodeEdit::set_symbol_lookup_on_click_enabled);
  1973. ClassDB::bind_method(D_METHOD("is_symbol_lookup_on_click_enabled"), &CodeEdit::is_symbol_lookup_on_click_enabled);
  1974. ClassDB::bind_method(D_METHOD("get_text_for_symbol_lookup"), &CodeEdit::get_text_for_symbol_lookup);
  1975. ClassDB::bind_method(D_METHOD("set_symbol_lookup_word_as_valid", "valid"), &CodeEdit::set_symbol_lookup_word_as_valid);
  1976. /* Inspector */
  1977. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "symbol_lookup_on_click"), "set_symbol_lookup_on_click_enabled", "is_symbol_lookup_on_click_enabled");
  1978. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "line_folding"), "set_line_folding_enabled", "is_line_folding_enabled");
  1979. ADD_PROPERTY(PropertyInfo(Variant::PACKED_INT32_ARRAY, "line_length_guidelines"), "set_line_length_guidelines", "get_line_length_guidelines");
  1980. ADD_GROUP("Gutters", "gutters_");
  1981. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_breakpoints_gutter"), "set_draw_breakpoints_gutter", "is_drawing_breakpoints_gutter");
  1982. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_bookmarks"), "set_draw_bookmarks_gutter", "is_drawing_bookmarks_gutter");
  1983. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_executing_lines"), "set_draw_executing_lines_gutter", "is_drawing_executing_lines_gutter");
  1984. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_line_numbers"), "set_draw_line_numbers", "is_draw_line_numbers_enabled");
  1985. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_zero_pad_line_numbers"), "set_line_numbers_zero_padded", "is_line_numbers_zero_padded");
  1986. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_fold_gutter"), "set_draw_fold_gutter", "is_drawing_fold_gutter");
  1987. ADD_GROUP("Delimiters", "delimiter_");
  1988. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "delimiter_strings"), "set_string_delimiters", "get_string_delimiters");
  1989. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "delimiter_comments"), "set_comment_delimiters", "get_comment_delimiters");
  1990. ADD_GROUP("Code Completion", "code_completion_");
  1991. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "code_completion_enabled"), "set_code_completion_enabled", "is_code_completion_enabled");
  1992. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "code_completion_prefixes"), "set_code_completion_prefixes", "get_code_comletion_prefixes");
  1993. ADD_GROUP("Indentation", "indent_");
  1994. ADD_PROPERTY(PropertyInfo(Variant::INT, "indent_size"), "set_indent_size", "get_indent_size");
  1995. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "indent_use_spaces"), "set_indent_using_spaces", "is_indent_using_spaces");
  1996. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "indent_automatic"), "set_auto_indent_enabled", "is_auto_indent_enabled");
  1997. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "indent_automatic_prefixes"), "set_auto_indent_prefixes", "get_auto_indent_prefixes");
  1998. ADD_GROUP("Auto Brace Completion", "auto_brace_completion_");
  1999. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "auto_brace_completion_enabled"), "set_auto_brace_completion_enabled", "is_auto_brace_completion_enabled");
  2000. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "auto_brace_completion_highlight_matching"), "set_highlight_matching_braces_enabled", "is_highlight_matching_braces_enabled");
  2001. ADD_PROPERTY(PropertyInfo(Variant::DICTIONARY, "auto_brace_completion_pairs"), "set_auto_brace_completion_pairs", "get_auto_brace_completion_pairs");
  2002. /* Signals */
  2003. /* Gutters */
  2004. ADD_SIGNAL(MethodInfo("breakpoint_toggled", PropertyInfo(Variant::INT, "line")));
  2005. /* Code Completion */
  2006. ADD_SIGNAL(MethodInfo("code_completion_requested"));
  2007. /* Symbol lookup */
  2008. ADD_SIGNAL(MethodInfo("symbol_lookup", PropertyInfo(Variant::STRING, "symbol"), PropertyInfo(Variant::INT, "line"), PropertyInfo(Variant::INT, "column")));
  2009. ADD_SIGNAL(MethodInfo("symbol_validate", PropertyInfo(Variant::STRING, "symbol")));
  2010. }
  2011. /* Auto brace completion */
  2012. int CodeEdit::_get_auto_brace_pair_open_at_pos(int p_line, int p_col) {
  2013. const String &line = get_line(p_line);
  2014. /* Should be fast enough, expecting low amount of pairs... */
  2015. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  2016. const String &open_key = auto_brace_completion_pairs[i].open_key;
  2017. if (p_col - open_key.length() < 0) {
  2018. continue;
  2019. }
  2020. bool is_match = true;
  2021. for (int j = 0; j < open_key.length(); j++) {
  2022. if (line[(p_col - 1) - j] != open_key[(open_key.length() - 1) - j]) {
  2023. is_match = false;
  2024. break;
  2025. }
  2026. }
  2027. if (is_match) {
  2028. return i;
  2029. }
  2030. }
  2031. return -1;
  2032. }
  2033. int CodeEdit::_get_auto_brace_pair_close_at_pos(int p_line, int p_col) {
  2034. const String &line = get_line(p_line);
  2035. /* Should be fast enough, expecting low amount of pairs... */
  2036. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  2037. if (p_col + auto_brace_completion_pairs[i].close_key.length() > line.length()) {
  2038. continue;
  2039. }
  2040. bool is_match = true;
  2041. for (int j = 0; j < auto_brace_completion_pairs[i].close_key.length(); j++) {
  2042. if (line[p_col + j] != auto_brace_completion_pairs[i].close_key[j]) {
  2043. is_match = false;
  2044. break;
  2045. }
  2046. }
  2047. if (is_match) {
  2048. return i;
  2049. }
  2050. }
  2051. return -1;
  2052. }
  2053. /* Gutters */
  2054. void CodeEdit::_gutter_clicked(int p_line, int p_gutter) {
  2055. bool shift_pressed = Input::get_singleton()->is_key_pressed(Key::SHIFT);
  2056. if (p_gutter == main_gutter) {
  2057. if (draw_breakpoints && !shift_pressed) {
  2058. set_line_as_breakpoint(p_line, !is_line_breakpointed(p_line));
  2059. } else if (draw_bookmarks && shift_pressed) {
  2060. set_line_as_bookmarked(p_line, !is_line_bookmarked(p_line));
  2061. }
  2062. return;
  2063. }
  2064. if (p_gutter == line_number_gutter) {
  2065. remove_secondary_carets();
  2066. set_selection_mode(TextEdit::SelectionMode::SELECTION_MODE_LINE, p_line, 0);
  2067. select(p_line, 0, p_line + 1, 0);
  2068. set_caret_line(p_line + 1);
  2069. set_caret_column(0);
  2070. return;
  2071. }
  2072. if (p_gutter == fold_gutter) {
  2073. if (is_line_folded(p_line)) {
  2074. unfold_line(p_line);
  2075. } else if (can_fold_line(p_line)) {
  2076. fold_line(p_line);
  2077. }
  2078. return;
  2079. }
  2080. }
  2081. void CodeEdit::_update_gutter_indexes() {
  2082. for (int i = 0; i < get_gutter_count(); i++) {
  2083. if (get_gutter_name(i) == "main_gutter") {
  2084. main_gutter = i;
  2085. continue;
  2086. }
  2087. if (get_gutter_name(i) == "line_numbers") {
  2088. line_number_gutter = i;
  2089. continue;
  2090. }
  2091. if (get_gutter_name(i) == "fold_gutter") {
  2092. fold_gutter = i;
  2093. continue;
  2094. }
  2095. }
  2096. }
  2097. /* Delimiters */
  2098. void CodeEdit::_update_delimiter_cache(int p_from_line, int p_to_line) {
  2099. if (delimiters.size() == 0) {
  2100. return;
  2101. }
  2102. int line_count = get_line_count();
  2103. if (p_to_line == -1) {
  2104. p_to_line = line_count;
  2105. }
  2106. int start_line = MIN(p_from_line, p_to_line);
  2107. int end_line = MAX(p_from_line, p_to_line);
  2108. /* Make sure delimiter_cache has all the lines. */
  2109. if (start_line != end_line) {
  2110. if (p_to_line < p_from_line) {
  2111. for (int i = end_line; i > start_line; i--) {
  2112. delimiter_cache.remove_at(i);
  2113. }
  2114. } else {
  2115. for (int i = start_line; i < end_line; i++) {
  2116. delimiter_cache.insert(i, RBMap<int, int>());
  2117. }
  2118. }
  2119. }
  2120. int in_region = -1;
  2121. for (int i = start_line; i < MIN(end_line + 1, line_count); i++) {
  2122. int current_end_region = (i <= 0 || delimiter_cache[i].size() < 1) ? -1 : delimiter_cache[i].back()->value();
  2123. in_region = (i <= 0 || delimiter_cache[i - 1].size() < 1) ? -1 : delimiter_cache[i - 1].back()->value();
  2124. const String &str = get_line(i);
  2125. const int line_length = str.length();
  2126. delimiter_cache.write[i].clear();
  2127. if (str.length() == 0) {
  2128. if (in_region != -1) {
  2129. delimiter_cache.write[i][0] = in_region;
  2130. }
  2131. if (i == end_line && current_end_region != in_region) {
  2132. end_line++;
  2133. end_line = MIN(end_line, line_count);
  2134. }
  2135. continue;
  2136. }
  2137. int end_region = -1;
  2138. for (int j = 0; j < line_length; j++) {
  2139. int from = j;
  2140. for (; from < line_length; from++) {
  2141. if (str[from] == '\\') {
  2142. from++;
  2143. continue;
  2144. }
  2145. break;
  2146. }
  2147. /* check if we are in entering a region */
  2148. bool same_line = false;
  2149. if (in_region == -1) {
  2150. for (int d = 0; d < delimiters.size(); d++) {
  2151. /* check there is enough room */
  2152. int chars_left = line_length - from;
  2153. int start_key_length = delimiters[d].start_key.length();
  2154. int end_key_length = delimiters[d].end_key.length();
  2155. if (chars_left < start_key_length) {
  2156. continue;
  2157. }
  2158. /* search the line */
  2159. bool match = true;
  2160. const char32_t *start_key = delimiters[d].start_key.get_data();
  2161. for (int k = 0; k < start_key_length; k++) {
  2162. if (start_key[k] != str[from + k]) {
  2163. match = false;
  2164. break;
  2165. }
  2166. }
  2167. if (!match) {
  2168. continue;
  2169. }
  2170. same_line = true;
  2171. in_region = d;
  2172. delimiter_cache.write[i][from + 1] = d;
  2173. from += start_key_length;
  2174. /* check if it's the whole line */
  2175. if (end_key_length == 0 || delimiters[d].line_only || from + end_key_length > line_length) {
  2176. j = line_length;
  2177. if (delimiters[d].line_only) {
  2178. delimiter_cache.write[i][line_length + 1] = -1;
  2179. } else {
  2180. end_region = in_region;
  2181. }
  2182. }
  2183. break;
  2184. }
  2185. if (j == line_length || in_region == -1) {
  2186. continue;
  2187. }
  2188. }
  2189. /* if we are in one find the end key */
  2190. /* search the line */
  2191. int region_end_index = -1;
  2192. int end_key_length = delimiters[in_region].end_key.length();
  2193. const char32_t *end_key = delimiters[in_region].end_key.get_data();
  2194. for (; from < line_length; from++) {
  2195. if (line_length - from < end_key_length) {
  2196. break;
  2197. }
  2198. if (!is_symbol(str[from])) {
  2199. continue;
  2200. }
  2201. if (str[from] == '\\') {
  2202. from++;
  2203. continue;
  2204. }
  2205. region_end_index = from;
  2206. for (int k = 0; k < end_key_length; k++) {
  2207. if (end_key[k] != str[from + k]) {
  2208. region_end_index = -1;
  2209. break;
  2210. }
  2211. }
  2212. if (region_end_index != -1) {
  2213. break;
  2214. }
  2215. }
  2216. j = from + (end_key_length - 1);
  2217. end_region = (region_end_index == -1) ? in_region : -1;
  2218. if (!same_line || region_end_index != -1) {
  2219. delimiter_cache.write[i][j + 1] = end_region;
  2220. }
  2221. in_region = -1;
  2222. }
  2223. if (i == end_line && current_end_region != end_region) {
  2224. end_line++;
  2225. end_line = MIN(end_line, line_count);
  2226. }
  2227. }
  2228. }
  2229. int CodeEdit::_is_in_delimiter(int p_line, int p_column, DelimiterType p_type) const {
  2230. if (delimiters.size() == 0) {
  2231. return -1;
  2232. }
  2233. ERR_FAIL_INDEX_V(p_line, get_line_count(), 0);
  2234. int region = (p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->value();
  2235. bool in_region = region != -1 && delimiters[region].type == p_type;
  2236. for (RBMap<int, int>::Element *E = delimiter_cache[p_line].front(); E; E = E->next()) {
  2237. /* If column is specified, loop until the key is larger then the column. */
  2238. if (p_column != -1) {
  2239. if (E->key() > p_column) {
  2240. break;
  2241. }
  2242. in_region = E->value() != -1 && delimiters[E->value()].type == p_type;
  2243. region = in_region ? E->value() : -1;
  2244. continue;
  2245. }
  2246. /* If no column, calculate if the entire line is a region */
  2247. /* excluding whitespace. */
  2248. const String line = get_line(p_line);
  2249. if (!in_region) {
  2250. if (E->value() == -1 || delimiters[E->value()].type != p_type) {
  2251. break;
  2252. }
  2253. region = E->value();
  2254. in_region = true;
  2255. for (int i = E->key() - 2; i >= 0; i--) {
  2256. if (!is_whitespace(line[i])) {
  2257. return -1;
  2258. }
  2259. }
  2260. }
  2261. if (delimiters[region].line_only) {
  2262. return region;
  2263. }
  2264. int end_col = E->key();
  2265. if (E->value() != -1) {
  2266. if (!E->next()) {
  2267. return region;
  2268. }
  2269. end_col = E->next()->key();
  2270. }
  2271. for (int i = end_col; i < line.length(); i++) {
  2272. if (!is_whitespace(line[i])) {
  2273. return -1;
  2274. }
  2275. }
  2276. return region;
  2277. }
  2278. return in_region ? region : -1;
  2279. }
  2280. void CodeEdit::_add_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only, DelimiterType p_type) {
  2281. // If we are the editor allow "null" as a valid start key, otherwise users cannot add delimiters via the inspector.
  2282. if (!(Engine::get_singleton()->is_editor_hint() && p_start_key == "null")) {
  2283. ERR_FAIL_COND_MSG(p_start_key.is_empty(), "delimiter start key cannot be empty");
  2284. for (int i = 0; i < p_start_key.length(); i++) {
  2285. ERR_FAIL_COND_MSG(!is_symbol(p_start_key[i]), "delimiter must start with a symbol");
  2286. }
  2287. }
  2288. if (p_end_key.length() > 0) {
  2289. for (int i = 0; i < p_end_key.length(); i++) {
  2290. ERR_FAIL_COND_MSG(!is_symbol(p_end_key[i]), "delimiter must end with a symbol");
  2291. }
  2292. }
  2293. int at = 0;
  2294. for (int i = 0; i < delimiters.size(); i++) {
  2295. ERR_FAIL_COND_MSG(delimiters[i].start_key == p_start_key, "delimiter with start key '" + p_start_key + "' already exists.");
  2296. if (p_start_key.length() < delimiters[i].start_key.length()) {
  2297. at++;
  2298. }
  2299. }
  2300. Delimiter delimiter;
  2301. delimiter.type = p_type;
  2302. delimiter.start_key = p_start_key;
  2303. delimiter.end_key = p_end_key;
  2304. delimiter.line_only = p_line_only || p_end_key.is_empty();
  2305. delimiters.insert(at, delimiter);
  2306. if (!setting_delimiters) {
  2307. delimiter_cache.clear();
  2308. _update_delimiter_cache();
  2309. }
  2310. }
  2311. void CodeEdit::_remove_delimiter(const String &p_start_key, DelimiterType p_type) {
  2312. for (int i = 0; i < delimiters.size(); i++) {
  2313. if (delimiters[i].start_key != p_start_key) {
  2314. continue;
  2315. }
  2316. if (delimiters[i].type != p_type) {
  2317. break;
  2318. }
  2319. delimiters.remove_at(i);
  2320. if (!setting_delimiters) {
  2321. delimiter_cache.clear();
  2322. _update_delimiter_cache();
  2323. }
  2324. break;
  2325. }
  2326. }
  2327. bool CodeEdit::_has_delimiter(const String &p_start_key, DelimiterType p_type) const {
  2328. for (int i = 0; i < delimiters.size(); i++) {
  2329. if (delimiters[i].start_key == p_start_key) {
  2330. return delimiters[i].type == p_type;
  2331. }
  2332. }
  2333. return false;
  2334. }
  2335. void CodeEdit::_set_delimiters(const TypedArray<String> &p_delimiters, DelimiterType p_type) {
  2336. setting_delimiters = true;
  2337. _clear_delimiters(p_type);
  2338. for (int i = 0; i < p_delimiters.size(); i++) {
  2339. String key = p_delimiters[i];
  2340. if (key.is_empty()) {
  2341. continue;
  2342. }
  2343. const String start_key = key.get_slice(" ", 0);
  2344. const String end_key = key.get_slice_count(" ") > 1 ? key.get_slice(" ", 1) : String();
  2345. _add_delimiter(start_key, end_key, end_key.is_empty(), p_type);
  2346. }
  2347. setting_delimiters = false;
  2348. _update_delimiter_cache();
  2349. }
  2350. void CodeEdit::_clear_delimiters(DelimiterType p_type) {
  2351. for (int i = delimiters.size() - 1; i >= 0; i--) {
  2352. if (delimiters[i].type == p_type) {
  2353. delimiters.remove_at(i);
  2354. }
  2355. }
  2356. delimiter_cache.clear();
  2357. if (!setting_delimiters) {
  2358. _update_delimiter_cache();
  2359. }
  2360. }
  2361. TypedArray<String> CodeEdit::_get_delimiters(DelimiterType p_type) const {
  2362. TypedArray<String> r_delimiters;
  2363. for (int i = 0; i < delimiters.size(); i++) {
  2364. if (delimiters[i].type != p_type) {
  2365. continue;
  2366. }
  2367. r_delimiters.push_back(delimiters[i].start_key + (delimiters[i].end_key.is_empty() ? "" : " " + delimiters[i].end_key));
  2368. }
  2369. return r_delimiters;
  2370. }
  2371. /* Code Completion */
  2372. void CodeEdit::_update_scroll_selected_line(float p_mouse_y) {
  2373. float percent = (float)(p_mouse_y - code_completion_scroll_rect.position.y) / code_completion_scroll_rect.size.height;
  2374. percent = CLAMP(percent, 0.0f, 1.0f);
  2375. code_completion_current_selected = (int)(percent * (code_completion_options.size() - 1));
  2376. code_completion_force_item_center = -1;
  2377. }
  2378. void CodeEdit::_filter_code_completion_candidates_impl() {
  2379. int line_height = get_line_height();
  2380. if (GDVIRTUAL_IS_OVERRIDDEN(_filter_code_completion_candidates)) {
  2381. code_completion_options.clear();
  2382. code_completion_base = "";
  2383. /* Build options argument. */
  2384. TypedArray<Dictionary> completion_options_sources;
  2385. completion_options_sources.resize(code_completion_option_sources.size());
  2386. int i = 0;
  2387. for (const ScriptLanguage::CodeCompletionOption &E : code_completion_option_sources) {
  2388. Dictionary option;
  2389. option["kind"] = E.kind;
  2390. option["display_text"] = E.display;
  2391. option["insert_text"] = E.insert_text;
  2392. option["font_color"] = E.font_color;
  2393. option["icon"] = E.icon;
  2394. option["default_value"] = E.default_value;
  2395. completion_options_sources[i] = option;
  2396. i++;
  2397. }
  2398. TypedArray<Dictionary> completion_options;
  2399. GDVIRTUAL_CALL(_filter_code_completion_candidates, completion_options_sources, completion_options);
  2400. /* No options to complete, cancel. */
  2401. if (completion_options.size() == 0) {
  2402. cancel_code_completion();
  2403. return;
  2404. }
  2405. /* Convert back into options. */
  2406. int max_width = 0;
  2407. for (i = 0; i < completion_options.size(); i++) {
  2408. ScriptLanguage::CodeCompletionOption option;
  2409. option.kind = (ScriptLanguage::CodeCompletionKind)(int)completion_options[i].get("kind");
  2410. option.display = completion_options[i].get("display_text");
  2411. option.insert_text = completion_options[i].get("insert_text");
  2412. option.font_color = completion_options[i].get("font_color");
  2413. option.icon = completion_options[i].get("icon");
  2414. option.default_value = completion_options[i].get("default_value");
  2415. int offset = 0;
  2416. if (option.default_value.get_type() == Variant::COLOR) {
  2417. offset = line_height;
  2418. }
  2419. if (font.is_valid()) {
  2420. max_width = MAX(max_width, font->get_string_size(option.display, HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).width + offset);
  2421. }
  2422. code_completion_options.push_back(option);
  2423. }
  2424. code_completion_longest_line = MIN(max_width, code_completion_max_width * font_size);
  2425. code_completion_current_selected = 0;
  2426. code_completion_force_item_center = -1;
  2427. code_completion_active = true;
  2428. queue_redraw();
  2429. return;
  2430. }
  2431. const int caret_line = get_caret_line();
  2432. const int caret_column = get_caret_column();
  2433. const String line = get_line(caret_line);
  2434. if (caret_column > 0 && line[caret_column - 1] == '(' && !code_completion_forced) {
  2435. cancel_code_completion();
  2436. return;
  2437. }
  2438. /* Get string status, are we in one or at the close. */
  2439. int in_string = is_in_string(caret_line, caret_column);
  2440. int first_quote_col = -1;
  2441. if (in_string != -1) {
  2442. Point2 string_start_pos = get_delimiter_start_position(caret_line, caret_column);
  2443. first_quote_col = (string_start_pos.y == caret_line) ? string_start_pos.x : -1;
  2444. } else if (caret_column > 0) {
  2445. if (is_in_string(caret_line, caret_column - 1) != -1) {
  2446. first_quote_col = caret_column - 1;
  2447. }
  2448. }
  2449. int cofs = caret_column;
  2450. String string_to_complete;
  2451. bool prev_is_word = false;
  2452. /* Cancel if we are at the close of a string. */
  2453. if (caret_column > 0 && in_string == -1 && first_quote_col == cofs - 1) {
  2454. cancel_code_completion();
  2455. return;
  2456. /* In a string, therefore we are trying to complete the string text. */
  2457. } else if (in_string != -1 && first_quote_col != -1) {
  2458. int key_length = delimiters[in_string].start_key.length();
  2459. string_to_complete = line.substr(first_quote_col - key_length, (cofs - first_quote_col) + key_length);
  2460. /* If we have a space, previous word might be a keyword. eg "func |". */
  2461. } else if (cofs > 0 && line[cofs - 1] == ' ') {
  2462. int ofs = cofs - 1;
  2463. while (ofs > 0 && line[ofs] == ' ') {
  2464. ofs--;
  2465. }
  2466. prev_is_word = !is_symbol(line[ofs]);
  2467. /* Otherwise get current word and set cofs to the start. */
  2468. } else {
  2469. int start_cofs = cofs;
  2470. while (cofs > 0 && line[cofs - 1] > 32 && (line[cofs - 1] == '/' || !is_symbol(line[cofs - 1]))) {
  2471. cofs--;
  2472. }
  2473. string_to_complete = line.substr(cofs, start_cofs - cofs);
  2474. }
  2475. /* If all else fails, check for a prefix. */
  2476. /* Single space between caret and prefix is okay. */
  2477. bool prev_is_prefix = false;
  2478. if (cofs > 0 && code_completion_prefixes.has(line[cofs - 1])) {
  2479. prev_is_prefix = true;
  2480. } else if (cofs > 1 && line[cofs - 1] == ' ' && code_completion_prefixes.has(line[cofs - 2])) {
  2481. prev_is_prefix = true;
  2482. }
  2483. if (!prev_is_word && string_to_complete.is_empty() && (cofs == 0 || !prev_is_prefix)) {
  2484. cancel_code_completion();
  2485. return;
  2486. }
  2487. /* Filter Options. */
  2488. /* For now handle only tradional quoted strings. */
  2489. bool single_quote = in_string != -1 && first_quote_col > 0 && delimiters[in_string].start_key == "'";
  2490. code_completion_options.clear();
  2491. code_completion_base = string_to_complete;
  2492. Vector<ScriptLanguage::CodeCompletionOption> completion_options_casei;
  2493. Vector<ScriptLanguage::CodeCompletionOption> completion_options_substr;
  2494. Vector<ScriptLanguage::CodeCompletionOption> completion_options_substr_casei;
  2495. Vector<ScriptLanguage::CodeCompletionOption> completion_options_subseq;
  2496. Vector<ScriptLanguage::CodeCompletionOption> completion_options_subseq_casei;
  2497. int max_width = 0;
  2498. String string_to_complete_lower = string_to_complete.to_lower();
  2499. for (ScriptLanguage::CodeCompletionOption &option : code_completion_option_sources) {
  2500. if (single_quote && option.display.is_quoted()) {
  2501. option.display = option.display.unquote().quote("'");
  2502. }
  2503. int offset = 0;
  2504. if (option.default_value.get_type() == Variant::COLOR) {
  2505. offset = line_height;
  2506. }
  2507. if (in_string != -1) {
  2508. String quote = single_quote ? "'" : "\"";
  2509. option.display = option.display.unquote().quote(quote);
  2510. option.insert_text = option.insert_text.unquote().quote(quote);
  2511. }
  2512. if (option.display.length() == 0) {
  2513. continue;
  2514. }
  2515. if (string_to_complete.length() == 0) {
  2516. code_completion_options.push_back(option);
  2517. if (font.is_valid()) {
  2518. max_width = MAX(max_width, font->get_string_size(option.display, HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).width + offset);
  2519. }
  2520. continue;
  2521. }
  2522. /* This code works the same as:
  2523. if (option.display.begins_with(s)) {
  2524. completion_options.push_back(option);
  2525. } else if (option.display.to_lower().begins_with(s.to_lower())) {
  2526. completion_options_casei.push_back(option);
  2527. } else if (s.is_subsequence_of(option.display)) {
  2528. completion_options_subseq.push_back(option);
  2529. } else if (s.is_subsequence_ofn(option.display)) {
  2530. completion_options_subseq_casei.push_back(option);
  2531. }
  2532. But is more performant due to being inlined and looping over the characters only once
  2533. */
  2534. String display_lower = option.display.to_lower();
  2535. const char32_t *ssq = &string_to_complete[0];
  2536. const char32_t *ssq_lower = &string_to_complete_lower[0];
  2537. const char32_t *tgt = &option.display[0];
  2538. const char32_t *tgt_lower = &display_lower[0];
  2539. const char32_t *sst = &string_to_complete[0];
  2540. const char32_t *sst_lower = &display_lower[0];
  2541. Vector<Pair<int, int>> ssq_matches;
  2542. int ssq_match_start = 0;
  2543. int ssq_match_len = 0;
  2544. Vector<Pair<int, int>> ssq_lower_matches;
  2545. int ssq_lower_match_start = 0;
  2546. int ssq_lower_match_len = 0;
  2547. int sst_start = -1;
  2548. int sst_lower_start = -1;
  2549. for (int i = 0; *tgt; tgt++, tgt_lower++, i++) {
  2550. // Check substring.
  2551. if (*sst == *tgt) {
  2552. sst++;
  2553. if (sst_start == -1) {
  2554. sst_start = i;
  2555. }
  2556. } else if (sst_start != -1 && *sst) {
  2557. sst = &string_to_complete[0];
  2558. sst_start = -1;
  2559. }
  2560. // Check subsequence.
  2561. if (*ssq == *tgt) {
  2562. ssq++;
  2563. if (ssq_match_len == 0) {
  2564. ssq_match_start = i;
  2565. }
  2566. ssq_match_len++;
  2567. } else if (ssq_match_len > 0) {
  2568. ssq_matches.push_back(Pair<int, int>(ssq_match_start, ssq_match_len));
  2569. ssq_match_len = 0;
  2570. }
  2571. // Check lower substring.
  2572. if (*sst_lower == *tgt) {
  2573. sst_lower++;
  2574. if (sst_lower_start == -1) {
  2575. sst_lower_start = i;
  2576. }
  2577. } else if (sst_lower_start != -1 && *sst_lower) {
  2578. sst_lower = &string_to_complete[0];
  2579. sst_lower_start = -1;
  2580. }
  2581. // Check lower subsequence.
  2582. if (*ssq_lower == *tgt_lower) {
  2583. ssq_lower++;
  2584. if (ssq_lower_match_len == 0) {
  2585. ssq_lower_match_start = i;
  2586. }
  2587. ssq_lower_match_len++;
  2588. } else if (ssq_lower_match_len > 0) {
  2589. ssq_lower_matches.push_back(Pair<int, int>(ssq_lower_match_start, ssq_lower_match_len));
  2590. ssq_lower_match_len = 0;
  2591. }
  2592. }
  2593. /* Matched the whole subsequence in s. */
  2594. if (!*ssq) { // Matched the whole subsequence in s.
  2595. option.matches.clear();
  2596. if (sst_start == 0) { // Matched substring in beginning of s.
  2597. option.matches.push_back(Pair<int, int>(sst_start, string_to_complete.length()));
  2598. code_completion_options.push_back(option);
  2599. } else if (sst_start > 0) { // Matched substring in s.
  2600. option.matches.push_back(Pair<int, int>(sst_start, string_to_complete.length()));
  2601. completion_options_substr.push_back(option);
  2602. } else {
  2603. if (ssq_match_len > 0) {
  2604. ssq_matches.push_back(Pair<int, int>(ssq_match_start, ssq_match_len));
  2605. }
  2606. option.matches.append_array(ssq_matches);
  2607. completion_options_subseq.push_back(option);
  2608. }
  2609. if (font.is_valid()) {
  2610. max_width = MAX(max_width, font->get_string_size(option.display, HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).width + offset);
  2611. }
  2612. } else if (!*ssq_lower) { // Matched the whole subsequence in s_lower.
  2613. option.matches.clear();
  2614. if (sst_lower_start == 0) { // Matched substring in beginning of s_lower.
  2615. option.matches.push_back(Pair<int, int>(sst_lower_start, string_to_complete.length()));
  2616. completion_options_casei.push_back(option);
  2617. } else if (sst_lower_start > 0) { // Matched substring in s_lower.
  2618. option.matches.push_back(Pair<int, int>(sst_lower_start, string_to_complete.length()));
  2619. completion_options_substr_casei.push_back(option);
  2620. } else {
  2621. if (ssq_lower_match_len > 0) {
  2622. ssq_lower_matches.push_back(Pair<int, int>(ssq_lower_match_start, ssq_lower_match_len));
  2623. }
  2624. option.matches.append_array(ssq_lower_matches);
  2625. completion_options_subseq_casei.push_back(option);
  2626. }
  2627. if (font.is_valid()) {
  2628. max_width = MAX(max_width, font->get_string_size(option.display, HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).width + offset);
  2629. }
  2630. }
  2631. }
  2632. code_completion_options.append_array(completion_options_casei);
  2633. code_completion_options.append_array(completion_options_subseq);
  2634. code_completion_options.append_array(completion_options_subseq_casei);
  2635. /* No options to complete, cancel. */
  2636. if (code_completion_options.size() == 0) {
  2637. cancel_code_completion();
  2638. return;
  2639. }
  2640. /* A perfect match, stop completion. */
  2641. if (code_completion_options.size() == 1 && string_to_complete == code_completion_options[0].display) {
  2642. cancel_code_completion();
  2643. return;
  2644. }
  2645. code_completion_longest_line = MIN(max_width, code_completion_max_width * font_size);
  2646. code_completion_current_selected = 0;
  2647. code_completion_force_item_center = -1;
  2648. code_completion_active = true;
  2649. queue_redraw();
  2650. }
  2651. void CodeEdit::_lines_edited_from(int p_from_line, int p_to_line) {
  2652. _update_delimiter_cache(p_from_line, p_to_line);
  2653. if (p_from_line == p_to_line) {
  2654. return;
  2655. }
  2656. lines_edited_changed += p_to_line - p_from_line;
  2657. lines_edited_from = (lines_edited_from == -1) ? MIN(p_from_line, p_to_line) : MIN(lines_edited_from, MIN(p_from_line, p_to_line));
  2658. lines_edited_to = (lines_edited_to == -1) ? MAX(p_from_line, p_to_line) : MAX(lines_edited_from, MAX(p_from_line, p_to_line));
  2659. }
  2660. void CodeEdit::_text_set() {
  2661. lines_edited_from = 0;
  2662. lines_edited_to = 9999;
  2663. _text_changed();
  2664. }
  2665. void CodeEdit::_text_changed() {
  2666. if (lines_edited_from == -1) {
  2667. return;
  2668. }
  2669. int lc = get_line_count();
  2670. line_number_digits = 1;
  2671. while (lc /= 10) {
  2672. line_number_digits++;
  2673. }
  2674. if (font.is_valid()) {
  2675. set_gutter_width(line_number_gutter, (line_number_digits + 1) * font->get_char_size('0', font_size).width);
  2676. }
  2677. lc = get_line_count();
  2678. List<int> breakpoints;
  2679. for (const KeyValue<int, bool> &E : breakpointed_lines) {
  2680. breakpoints.push_back(E.key);
  2681. }
  2682. for (const int &line : breakpoints) {
  2683. if (line < lines_edited_from || (line < lc && is_line_breakpointed(line))) {
  2684. continue;
  2685. }
  2686. breakpointed_lines.erase(line);
  2687. emit_signal(SNAME("breakpoint_toggled"), line);
  2688. int next_line = line + lines_edited_changed;
  2689. if (next_line > -1 && next_line < lc && is_line_breakpointed(next_line)) {
  2690. emit_signal(SNAME("breakpoint_toggled"), next_line);
  2691. breakpointed_lines[next_line] = true;
  2692. continue;
  2693. }
  2694. }
  2695. lines_edited_from = -1;
  2696. lines_edited_to = -1;
  2697. lines_edited_changed = 0;
  2698. }
  2699. CodeEdit::CodeEdit() {
  2700. /* Indent management */
  2701. auto_indent_prefixes.insert(':');
  2702. auto_indent_prefixes.insert('{');
  2703. auto_indent_prefixes.insert('[');
  2704. auto_indent_prefixes.insert('(');
  2705. /* Auto brace completion */
  2706. add_auto_brace_completion_pair("(", ")");
  2707. add_auto_brace_completion_pair("{", "}");
  2708. add_auto_brace_completion_pair("[", "]");
  2709. add_auto_brace_completion_pair("\"", "\"");
  2710. add_auto_brace_completion_pair("\'", "\'");
  2711. /* Delimiter tracking */
  2712. add_string_delimiter("\"", "\"", false);
  2713. add_string_delimiter("\'", "\'", false);
  2714. /* Text Direction */
  2715. set_layout_direction(LAYOUT_DIRECTION_LTR);
  2716. set_text_direction(TEXT_DIRECTION_LTR);
  2717. /* Gutters */
  2718. int gutter_idx = 0;
  2719. /* Main Gutter */
  2720. add_gutter();
  2721. set_gutter_name(gutter_idx, "main_gutter");
  2722. set_gutter_draw(gutter_idx, false);
  2723. set_gutter_overwritable(gutter_idx, true);
  2724. set_gutter_type(gutter_idx, GUTTER_TYPE_CUSTOM);
  2725. set_gutter_custom_draw(gutter_idx, callable_mp(this, &CodeEdit::_main_gutter_draw_callback));
  2726. gutter_idx++;
  2727. /* Line numbers */
  2728. add_gutter();
  2729. set_gutter_name(gutter_idx, "line_numbers");
  2730. set_gutter_draw(gutter_idx, false);
  2731. set_gutter_type(gutter_idx, GUTTER_TYPE_CUSTOM);
  2732. set_gutter_custom_draw(gutter_idx, callable_mp(this, &CodeEdit::_line_number_draw_callback));
  2733. gutter_idx++;
  2734. /* Fold Gutter */
  2735. add_gutter();
  2736. set_gutter_name(gutter_idx, "fold_gutter");
  2737. set_gutter_draw(gutter_idx, false);
  2738. set_gutter_type(gutter_idx, GUTTER_TYPE_CUSTOM);
  2739. set_gutter_custom_draw(gutter_idx, callable_mp(this, &CodeEdit::_fold_gutter_draw_callback));
  2740. gutter_idx++;
  2741. connect("lines_edited_from", callable_mp(this, &CodeEdit::_lines_edited_from));
  2742. connect("text_set", callable_mp(this, &CodeEdit::_text_set));
  2743. connect("text_changed", callable_mp(this, &CodeEdit::_text_changed));
  2744. connect("gutter_clicked", callable_mp(this, &CodeEdit::_gutter_clicked));
  2745. connect("gutter_added", callable_mp(this, &CodeEdit::_update_gutter_indexes));
  2746. connect("gutter_removed", callable_mp(this, &CodeEdit::_update_gutter_indexes));
  2747. _update_gutter_indexes();
  2748. }
  2749. CodeEdit::~CodeEdit() {
  2750. }