code_edit.cpp 131 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841
  1. /**************************************************************************/
  2. /* code_edit.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "code_edit.h"
  31. #include "code_edit.compat.inc"
  32. #include "core/config/project_settings.h"
  33. #include "core/os/keyboard.h"
  34. #include "core/string/string_builder.h"
  35. #include "core/string/ustring.h"
  36. #include "scene/theme/theme_db.h"
  37. void CodeEdit::_apply_project_settings() {
  38. symbol_tooltip_timer->set_wait_time(GLOBAL_GET("gui/timers/tooltip_delay_sec"));
  39. }
  40. void CodeEdit::_notification(int p_what) {
  41. switch (p_what) {
  42. case NOTIFICATION_READY: {
  43. _apply_project_settings();
  44. #ifdef TOOLS_ENABLED
  45. if (Engine::get_singleton()->is_editor_hint()) {
  46. ProjectSettings::get_singleton()->connect("settings_changed", callable_mp(this, &CodeEdit::_apply_project_settings));
  47. }
  48. #endif // TOOLS_ENABLED
  49. } break;
  50. case NOTIFICATION_THEME_CHANGED: {
  51. set_gutter_width(main_gutter, get_line_height());
  52. _update_line_number_gutter_width();
  53. set_gutter_width(fold_gutter, get_line_height() / 1.2);
  54. _clear_line_number_text_cache();
  55. } break;
  56. case NOTIFICATION_TRANSLATION_CHANGED:
  57. [[fallthrough]];
  58. case NOTIFICATION_LAYOUT_DIRECTION_CHANGED:
  59. [[fallthrough]];
  60. case NOTIFICATION_VISIBILITY_CHANGED: {
  61. // Avoid having many hidden text editors with unused cache filling up memory.
  62. _clear_line_number_text_cache();
  63. } break;
  64. case NOTIFICATION_DRAW: {
  65. RID ci = get_canvas_item();
  66. const Size2 size = get_size();
  67. const bool caret_visible = is_caret_visible();
  68. const bool rtl = is_layout_rtl();
  69. const int row_height = get_line_height();
  70. if (line_length_guideline_columns.size() > 0) {
  71. const int xmargin_beg = theme_cache.style_normal->get_margin(SIDE_LEFT) + get_total_gutter_width();
  72. const int xmargin_end = size.width - theme_cache.style_normal->get_margin(SIDE_RIGHT) - (is_drawing_minimap() ? get_minimap_width() : 0);
  73. const float char_size = theme_cache.font->get_char_size('0', theme_cache.font_size).width;
  74. for (int i = 0; i < line_length_guideline_columns.size(); i++) {
  75. const int xoffset = xmargin_beg + char_size * (int)line_length_guideline_columns[i] - get_h_scroll();
  76. if (xoffset > xmargin_beg && xoffset < xmargin_end) {
  77. Color guideline_color = (i == 0) ? theme_cache.line_length_guideline_color : theme_cache.line_length_guideline_color * Color(1, 1, 1, 0.5);
  78. if (rtl) {
  79. RenderingServer::get_singleton()->canvas_item_add_line(ci, Point2(size.width - xoffset, 0), Point2(size.width - xoffset, size.height), guideline_color);
  80. continue;
  81. }
  82. RenderingServer::get_singleton()->canvas_item_add_line(ci, Point2(xoffset, 0), Point2(xoffset, size.height), guideline_color);
  83. }
  84. }
  85. }
  86. if (caret_visible) {
  87. const bool draw_code_completion = code_completion_active && !code_completion_options.is_empty();
  88. const bool draw_code_hint = !code_hint.is_empty();
  89. /* Code hint */
  90. Size2 code_hint_minsize;
  91. if (draw_code_hint) {
  92. const int font_height = theme_cache.font->get_height(theme_cache.font_size);
  93. Vector<String> code_hint_lines = code_hint.split("\n");
  94. int line_count = code_hint_lines.size();
  95. int max_width = 0;
  96. for (int i = 0; i < line_count; i++) {
  97. max_width = MAX(max_width, theme_cache.font->get_string_size(code_hint_lines[i], HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).x);
  98. }
  99. code_hint_minsize = theme_cache.code_hint_style->get_minimum_size() + Size2(max_width, line_count * font_height + (theme_cache.line_spacing * line_count - 1));
  100. int offset = theme_cache.font->get_string_size(code_hint_lines[0].substr(0, code_hint_lines[0].find(String::chr(0xFFFF))), HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).x;
  101. if (code_hint_xpos == -0xFFFF) {
  102. code_hint_xpos = get_caret_draw_pos().x - offset;
  103. }
  104. Point2 hint_ofs = Vector2(code_hint_xpos, get_caret_draw_pos().y);
  105. if (code_hint_draw_below) {
  106. hint_ofs.y += theme_cache.line_spacing / 2.0f;
  107. } else {
  108. hint_ofs.y -= (code_hint_minsize.y + row_height) - theme_cache.line_spacing;
  109. }
  110. draw_style_box(theme_cache.code_hint_style, Rect2(hint_ofs, code_hint_minsize));
  111. int yofs = 0;
  112. for (int i = 0; i < line_count; i++) {
  113. const String &line = code_hint_lines[i];
  114. int begin = 0;
  115. int end = 0;
  116. if (line.contains(String::chr(0xFFFF))) {
  117. begin = theme_cache.font->get_string_size(line.substr(0, line.find(String::chr(0xFFFF))), HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).x;
  118. end = theme_cache.font->get_string_size(line.substr(0, line.rfind(String::chr(0xFFFF))), HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).x;
  119. }
  120. Point2 round_ofs = hint_ofs + theme_cache.code_hint_style->get_offset() + Vector2(0, theme_cache.font->get_ascent(theme_cache.font_size) + font_height * i + yofs);
  121. round_ofs = round_ofs.round();
  122. draw_string(theme_cache.font, round_ofs, line.replace(String::chr(0xFFFF), ""), HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size, theme_cache.code_hint_color);
  123. if (end > 0) {
  124. // Draw an underline for the currently edited function parameter.
  125. const Vector2 b = hint_ofs + theme_cache.code_hint_style->get_offset() + Vector2(begin, font_height + font_height * i + yofs);
  126. draw_line(b, b + Vector2(end - begin, 0), theme_cache.code_hint_color, 2);
  127. // Draw a translucent text highlight as well.
  128. const Rect2 highlight_rect = Rect2(
  129. b - Vector2(0, font_height),
  130. Vector2(end - begin, font_height));
  131. draw_rect(highlight_rect, theme_cache.code_hint_color * Color(1, 1, 1, 0.2));
  132. }
  133. yofs += theme_cache.line_spacing;
  134. }
  135. }
  136. /* Code completion */
  137. if (draw_code_completion) {
  138. const int code_completion_options_count = code_completion_options.size();
  139. const int lines = MIN(code_completion_options_count, theme_cache.code_completion_max_lines);
  140. const Size2 icon_area_size(row_height, row_height);
  141. code_completion_rect.size.width = code_completion_longest_line + theme_cache.code_completion_icon_separation + icon_area_size.width + 2;
  142. code_completion_rect.size.height = lines * row_height;
  143. const Point2 caret_pos = get_caret_draw_pos();
  144. const int total_height = theme_cache.code_completion_style->get_minimum_size().y + code_completion_rect.size.height;
  145. int min_y = caret_pos.y - row_height;
  146. int max_y = caret_pos.y + row_height + total_height;
  147. if (draw_code_hint) {
  148. if (code_hint_draw_below) {
  149. max_y += code_hint_minsize.y;
  150. } else {
  151. min_y -= code_hint_minsize.y;
  152. }
  153. }
  154. const bool can_fit_completion_above = (min_y > total_height);
  155. const bool can_fit_completion_below = (max_y <= get_size().height);
  156. if (!can_fit_completion_below && can_fit_completion_above) {
  157. code_completion_rect.position.y = (caret_pos.y - total_height - row_height) + theme_cache.line_spacing;
  158. if (draw_code_hint && !code_hint_draw_below) {
  159. code_completion_rect.position.y -= code_hint_minsize.y;
  160. }
  161. } else {
  162. code_completion_rect.position.y = caret_pos.y + (theme_cache.line_spacing / 2.0f);
  163. if (draw_code_hint && code_hint_draw_below) {
  164. code_completion_rect.position.y += code_hint_minsize.y;
  165. }
  166. }
  167. const int scroll_width = code_completion_options_count > theme_cache.code_completion_max_lines ? theme_cache.code_completion_scroll_width : 0;
  168. const int code_completion_base_width = theme_cache.font->get_string_size(code_completion_base, HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).width;
  169. if (caret_pos.x - code_completion_base_width + code_completion_rect.size.width + scroll_width > get_size().width) {
  170. code_completion_rect.position.x = get_size().width - code_completion_rect.size.width - scroll_width;
  171. } else {
  172. code_completion_rect.position.x = caret_pos.x - code_completion_base_width;
  173. }
  174. draw_style_box(theme_cache.code_completion_style, Rect2(code_completion_rect.position - theme_cache.code_completion_style->get_offset(), code_completion_rect.size + theme_cache.code_completion_style->get_minimum_size() + Size2(scroll_width, 0)));
  175. if (theme_cache.code_completion_background_color.a > 0.01) {
  176. RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(code_completion_rect.position, code_completion_rect.size + Size2(scroll_width, 0)), theme_cache.code_completion_background_color);
  177. }
  178. code_completion_scroll_rect.position = code_completion_rect.position + Vector2(code_completion_rect.size.width, 0);
  179. code_completion_scroll_rect.size = Vector2(scroll_width, code_completion_rect.size.height);
  180. 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);
  181. 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)), theme_cache.code_completion_selected_color);
  182. for (int i = 0; i < lines; i++) {
  183. int l = code_completion_line_ofs + i;
  184. ERR_CONTINUE(l < 0 || l >= code_completion_options_count);
  185. Ref<TextLine> tl;
  186. tl.instantiate();
  187. tl->add_string(code_completion_options[l].display, theme_cache.font, theme_cache.font_size);
  188. int yofs = (row_height - tl->get_size().y) / 2;
  189. Point2 title_pos(code_completion_rect.position.x, code_completion_rect.position.y + i * row_height + yofs);
  190. /* Draw completion icon if it is valid. */
  191. const Ref<Texture2D> &icon = code_completion_options[l].icon;
  192. Rect2 icon_area(code_completion_rect.position.x, code_completion_rect.position.y + i * row_height, icon_area_size.width, icon_area_size.height);
  193. if (icon.is_valid()) {
  194. Size2 icon_size = icon_area.size * 0.7;
  195. icon->draw_rect(ci, Rect2(icon_area.position + (icon_area.size - icon_size) / 2, icon_size));
  196. }
  197. title_pos.x = icon_area.position.x + icon_area.size.width + theme_cache.code_completion_icon_separation;
  198. tl->set_width(code_completion_rect.size.width - (icon_area_size.x + theme_cache.code_completion_icon_separation));
  199. if (rtl) {
  200. if (code_completion_options[l].default_value.get_type() == Variant::COLOR) {
  201. draw_rect(Rect2(Point2(code_completion_rect.position.x, icon_area.position.y), icon_area_size), (Color)code_completion_options[l].default_value);
  202. }
  203. tl->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_RIGHT);
  204. } else {
  205. if (code_completion_options[l].default_value.get_type() == Variant::COLOR) {
  206. const Color color = code_completion_options[l].default_value;
  207. const Rect2 rect = Rect2(Point2(code_completion_rect.position.x + code_completion_rect.size.width - icon_area_size.x, icon_area.position.y), icon_area_size);
  208. if (color.a < 1.0) {
  209. draw_texture_rect(theme_cache.completion_color_bg, rect, true);
  210. }
  211. draw_rect(rect, color);
  212. }
  213. tl->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_LEFT);
  214. }
  215. Point2 match_pos = Point2(code_completion_rect.position.x + icon_area_size.x + theme_cache.code_completion_icon_separation, code_completion_rect.position.y + i * row_height);
  216. for (int j = 0; j < code_completion_options[l].matches.size(); j++) {
  217. Pair<int, int> match_segment = code_completion_options[l].matches[j];
  218. int match_offset = theme_cache.font->get_string_size(code_completion_options[l].display.substr(0, match_segment.first), HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).width;
  219. int match_len = theme_cache.font->get_string_size(code_completion_options[l].display.substr(match_segment.first, match_segment.second), HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).width;
  220. draw_rect(Rect2(match_pos + Point2(match_offset, 0), Size2(match_len, row_height)), theme_cache.code_completion_existing_color);
  221. }
  222. tl->draw(ci, title_pos, code_completion_options[l].font_color);
  223. }
  224. /* Draw a small scroll rectangle to show a position in the options. */
  225. if (scroll_width) {
  226. Color scroll_color = is_code_completion_scroll_hovered || is_code_completion_scroll_pressed ? theme_cache.code_completion_scroll_hovered_color : theme_cache.code_completion_scroll_color;
  227. float r = (float)theme_cache.code_completion_max_lines / code_completion_options_count;
  228. float o = (float)code_completion_line_ofs / code_completion_options_count;
  229. 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);
  230. }
  231. }
  232. }
  233. } break;
  234. case NOTIFICATION_DRAG_BEGIN: {
  235. cancel_code_completion();
  236. } break;
  237. case NOTIFICATION_MOUSE_EXIT: {
  238. queue_redraw();
  239. symbol_tooltip_timer->stop();
  240. } break;
  241. }
  242. }
  243. void CodeEdit::gui_input(const Ref<InputEvent> &p_gui_input) {
  244. Ref<InputEventPanGesture> pan_gesture = p_gui_input;
  245. if (pan_gesture.is_valid() && code_completion_active && code_completion_rect.has_point(pan_gesture->get_position())) {
  246. const real_t delta = pan_gesture->get_delta().y;
  247. code_completion_pan_offset += delta;
  248. if (code_completion_pan_offset <= -1.0) {
  249. if (code_completion_current_selected > 0) {
  250. code_completion_current_selected--;
  251. code_completion_force_item_center = -1;
  252. queue_redraw();
  253. }
  254. code_completion_pan_offset = 0;
  255. } else if (code_completion_pan_offset >= +1.0) {
  256. if (code_completion_current_selected < code_completion_options.size() - 1) {
  257. code_completion_current_selected++;
  258. code_completion_force_item_center = -1;
  259. queue_redraw();
  260. }
  261. code_completion_pan_offset = 0;
  262. }
  263. accept_event();
  264. return;
  265. }
  266. Ref<InputEventMouseButton> mb = p_gui_input;
  267. if (mb.is_valid()) {
  268. // Ignore mouse clicks in IME input mode, let TextEdit handle it.
  269. if (has_ime_text()) {
  270. TextEdit::gui_input(p_gui_input);
  271. return;
  272. }
  273. if (is_code_completion_scroll_pressed && mb->get_button_index() == MouseButton::LEFT) {
  274. is_code_completion_scroll_pressed = false;
  275. accept_event();
  276. queue_redraw();
  277. return;
  278. }
  279. if (is_code_completion_drag_started && !mb->is_pressed()) {
  280. is_code_completion_drag_started = false;
  281. accept_event();
  282. queue_redraw();
  283. return;
  284. }
  285. if (code_completion_active && code_completion_rect.has_point(mb->get_position())) {
  286. if (!mb->is_pressed()) {
  287. accept_event();
  288. return;
  289. }
  290. is_code_completion_drag_started = true;
  291. switch (mb->get_button_index()) {
  292. case MouseButton::WHEEL_UP: {
  293. if (code_completion_current_selected > 0) {
  294. code_completion_current_selected--;
  295. code_completion_force_item_center = -1;
  296. code_completion_pan_offset = 0.0f;
  297. queue_redraw();
  298. }
  299. } break;
  300. case MouseButton::WHEEL_DOWN: {
  301. if (code_completion_current_selected < code_completion_options.size() - 1) {
  302. code_completion_current_selected++;
  303. code_completion_force_item_center = -1;
  304. code_completion_pan_offset = 0.0f;
  305. queue_redraw();
  306. }
  307. } break;
  308. case MouseButton::LEFT: {
  309. if (code_completion_force_item_center == -1) {
  310. code_completion_force_item_center = code_completion_current_selected;
  311. }
  312. 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);
  313. code_completion_pan_offset = 0.0f;
  314. if (mb->is_double_click()) {
  315. confirm_code_completion();
  316. }
  317. queue_redraw();
  318. } break;
  319. default:
  320. break;
  321. }
  322. accept_event();
  323. return;
  324. } else if (code_completion_active && code_completion_scroll_rect.has_point(mb->get_position())) {
  325. if (mb->get_button_index() != MouseButton::LEFT) {
  326. accept_event();
  327. return;
  328. }
  329. if (mb->is_pressed()) {
  330. is_code_completion_drag_started = true;
  331. is_code_completion_scroll_pressed = true;
  332. _update_scroll_selected_line(mb->get_position().y);
  333. queue_redraw();
  334. }
  335. accept_event();
  336. return;
  337. }
  338. cancel_code_completion();
  339. set_code_hint("");
  340. if (mb->is_pressed()) {
  341. Vector2i mpos = mb->get_position();
  342. if (is_layout_rtl()) {
  343. mpos.x = get_size().x - mpos.x;
  344. }
  345. Point2i pos = get_line_column_at_pos(mpos, false);
  346. int line = pos.y;
  347. int col = pos.x;
  348. if (line != -1 && mb->get_button_index() == MouseButton::LEFT) {
  349. if (is_line_folded(line)) {
  350. int wrap_index = get_line_wrap_index_at_column(line, col);
  351. if (wrap_index == get_line_wrap_count(line)) {
  352. int eol_icon_width = theme_cache.folded_eol_icon->get_width();
  353. int left_margin = get_total_gutter_width() + eol_icon_width + get_line_width(line, wrap_index) - get_h_scroll();
  354. if (mpos.x > left_margin && mpos.x <= left_margin + eol_icon_width + 3) {
  355. unfold_line(line);
  356. return;
  357. }
  358. }
  359. }
  360. }
  361. } else {
  362. if (mb->get_button_index() == MouseButton::LEFT) {
  363. if (mb->is_command_or_control_pressed() && !symbol_lookup_word.is_empty()) {
  364. Vector2i mpos = mb->get_position();
  365. if (is_layout_rtl()) {
  366. mpos.x = get_size().x - mpos.x;
  367. }
  368. Point2i pos = get_line_column_at_pos(mpos, false, false);
  369. int line = pos.y;
  370. int col = pos.x;
  371. if (line != -1) {
  372. emit_signal(SNAME("symbol_lookup"), symbol_lookup_word, line, col);
  373. }
  374. return;
  375. }
  376. }
  377. }
  378. }
  379. Ref<InputEventMouseMotion> mm = p_gui_input;
  380. if (mm.is_valid()) {
  381. Vector2i mpos = mm->get_position();
  382. if (is_layout_rtl()) {
  383. mpos.x = get_size().x - mpos.x;
  384. }
  385. if (symbol_lookup_on_click_enabled) {
  386. if (mm->is_command_or_control_pressed() && mm->get_button_mask().is_empty()) {
  387. symbol_lookup_pos = get_line_column_at_pos(mpos, false, false);
  388. symbol_lookup_new_word = get_word_at_pos(mpos);
  389. if (symbol_lookup_new_word != symbol_lookup_word) {
  390. emit_signal(SNAME("symbol_validate"), symbol_lookup_new_word);
  391. }
  392. } else if (!mm->is_command_or_control_pressed() || (!mm->get_button_mask().is_empty() && symbol_lookup_pos != get_line_column_at_pos(mpos, false, false))) {
  393. set_symbol_lookup_word_as_valid(false);
  394. }
  395. }
  396. if (symbol_tooltip_on_hover_enabled) {
  397. symbol_tooltip_pos = get_line_column_at_pos(mpos, false, false);
  398. symbol_tooltip_word = get_word_at_pos(mpos);
  399. symbol_tooltip_timer->start();
  400. }
  401. bool scroll_hovered = code_completion_scroll_rect.has_point(mpos);
  402. if (is_code_completion_scroll_hovered != scroll_hovered) {
  403. is_code_completion_scroll_hovered = scroll_hovered;
  404. accept_event();
  405. queue_redraw();
  406. }
  407. if (is_code_completion_scroll_pressed) {
  408. _update_scroll_selected_line(mpos.y);
  409. accept_event();
  410. queue_redraw();
  411. return;
  412. }
  413. if (code_completion_active && code_completion_rect.has_point(mm->get_position())) {
  414. accept_event();
  415. return;
  416. }
  417. }
  418. Ref<InputEventKey> k = p_gui_input;
  419. if (TextEdit::alt_input(p_gui_input)) {
  420. accept_event();
  421. return;
  422. }
  423. bool update_code_completion = false;
  424. if (k.is_null()) {
  425. // MouseMotion events should not be handled by TextEdit logic if we're
  426. // currently clicking and dragging from the code completion panel.
  427. if (mm.is_null() || !is_code_completion_drag_started) {
  428. TextEdit::gui_input(p_gui_input);
  429. }
  430. return;
  431. }
  432. /* Ctrl + Hover symbols */
  433. bool mac_keys = OS::get_singleton()->has_feature("macos") || OS::get_singleton()->has_feature("web_macos") || OS::get_singleton()->has_feature("web_ios");
  434. if ((mac_keys && k->get_keycode() == Key::META) || (!mac_keys && k->get_keycode() == Key::CTRL)) {
  435. if (symbol_lookup_on_click_enabled) {
  436. if (k->is_pressed() && !is_dragging_cursor()) {
  437. symbol_lookup_new_word = get_word_at_pos(get_local_mouse_pos());
  438. if (symbol_lookup_new_word != symbol_lookup_word) {
  439. emit_signal(SNAME("symbol_validate"), symbol_lookup_new_word);
  440. }
  441. } else {
  442. set_symbol_lookup_word_as_valid(false);
  443. }
  444. }
  445. return;
  446. }
  447. /* If a modifier has been pressed, and nothing else, return. */
  448. if (!k->is_pressed() || k->get_keycode() == Key::CTRL || k->get_keycode() == Key::ALT || k->get_keycode() == Key::SHIFT || k->get_keycode() == Key::META || k->get_keycode() == Key::CAPSLOCK) {
  449. return;
  450. }
  451. // Allow unicode handling if:
  452. // No modifiers are pressed (except Shift and CapsLock)
  453. bool allow_unicode_handling = !(k->is_ctrl_pressed() || k->is_alt_pressed() || k->is_meta_pressed());
  454. /* AUTO-COMPLETE */
  455. if (code_completion_enabled && k->is_action("ui_text_completion_query", true)) {
  456. request_code_completion(true);
  457. accept_event();
  458. return;
  459. }
  460. if (code_completion_active) {
  461. if (k->is_action("ui_up", true)) {
  462. if (code_completion_current_selected > 0) {
  463. code_completion_current_selected--;
  464. } else {
  465. code_completion_current_selected = code_completion_options.size() - 1;
  466. }
  467. code_completion_force_item_center = -1;
  468. code_completion_pan_offset = 0.0f;
  469. queue_redraw();
  470. accept_event();
  471. return;
  472. }
  473. if (k->is_action("ui_down", true)) {
  474. if (code_completion_current_selected < code_completion_options.size() - 1) {
  475. code_completion_current_selected++;
  476. } else {
  477. code_completion_current_selected = 0;
  478. }
  479. code_completion_force_item_center = -1;
  480. code_completion_pan_offset = 0.0f;
  481. queue_redraw();
  482. accept_event();
  483. return;
  484. }
  485. if (k->is_action("ui_page_up", true)) {
  486. code_completion_current_selected = MAX(0, code_completion_current_selected - theme_cache.code_completion_max_lines);
  487. code_completion_force_item_center = -1;
  488. code_completion_pan_offset = 0.0f;
  489. queue_redraw();
  490. accept_event();
  491. return;
  492. }
  493. if (k->is_action("ui_page_down", true)) {
  494. code_completion_current_selected = MIN(code_completion_options.size() - 1, code_completion_current_selected + theme_cache.code_completion_max_lines);
  495. code_completion_force_item_center = -1;
  496. code_completion_pan_offset = 0.0f;
  497. queue_redraw();
  498. accept_event();
  499. return;
  500. }
  501. if (k->is_action("ui_text_caret_line_start", true) || k->is_action("ui_text_caret_line_end", true)) {
  502. cancel_code_completion();
  503. }
  504. if (k->is_action("ui_text_completion_replace", true) || k->is_action("ui_text_completion_accept", true)) {
  505. confirm_code_completion(k->is_action("ui_text_completion_replace", true));
  506. accept_event();
  507. return;
  508. }
  509. if (k->is_action("ui_cancel", true)) {
  510. cancel_code_completion();
  511. accept_event();
  512. return;
  513. }
  514. if (k->is_action("ui_text_backspace", true)) {
  515. backspace();
  516. _filter_code_completion_candidates_impl();
  517. accept_event();
  518. return;
  519. }
  520. if (k->is_action("ui_left", true) || k->is_action("ui_right", true)) {
  521. update_code_completion = true;
  522. } else {
  523. update_code_completion = (allow_unicode_handling && k->get_unicode() >= 32);
  524. }
  525. }
  526. /* MISC */
  527. if (!code_hint.is_empty() && k->is_action("ui_cancel", true)) {
  528. set_code_hint("");
  529. accept_event();
  530. return;
  531. }
  532. if (allow_unicode_handling && k->get_unicode() == ')') {
  533. set_code_hint("");
  534. }
  535. /* Indentation */
  536. if (k->is_action("ui_text_indent", true)) {
  537. do_indent();
  538. accept_event();
  539. return;
  540. }
  541. if (k->is_action("ui_text_dedent", true)) {
  542. unindent_lines();
  543. accept_event();
  544. return;
  545. }
  546. // Override new line actions, for auto indent.
  547. if (k->is_action("ui_text_newline_above", true)) {
  548. _new_line(false, true);
  549. accept_event();
  550. return;
  551. }
  552. if (k->is_action("ui_text_newline_blank", true)) {
  553. _new_line(false);
  554. accept_event();
  555. return;
  556. }
  557. if (k->is_action("ui_text_newline", true)) {
  558. _new_line();
  559. accept_event();
  560. return;
  561. }
  562. // Remove shift, otherwise actions will not match.
  563. k = k->duplicate();
  564. k->set_shift_pressed(false);
  565. if (k->is_action("ui_text_caret_up", true) ||
  566. k->is_action("ui_text_caret_down", true) ||
  567. k->is_action("ui_text_caret_line_start", true) ||
  568. k->is_action("ui_text_caret_line_end", true) ||
  569. k->is_action("ui_text_caret_page_up", true) ||
  570. k->is_action("ui_text_caret_page_down", true)) {
  571. set_code_hint("");
  572. }
  573. TextEdit::gui_input(p_gui_input);
  574. if (update_code_completion) {
  575. _filter_code_completion_candidates_impl();
  576. }
  577. }
  578. /* General overrides */
  579. Control::CursorShape CodeEdit::get_cursor_shape(const Point2 &p_pos) const {
  580. if (!symbol_lookup_word.is_empty()) {
  581. return CURSOR_POINTING_HAND;
  582. }
  583. if ((code_completion_active && code_completion_rect.has_point(p_pos)) || (!is_editable() && (!is_selecting_enabled() || get_line_count() == 0))) {
  584. return CURSOR_ARROW;
  585. }
  586. if (code_completion_active && code_completion_scroll_rect.has_point(p_pos)) {
  587. return CURSOR_ARROW;
  588. }
  589. Point2i pos = get_line_column_at_pos(p_pos, false);
  590. int line = pos.y;
  591. int col = pos.x;
  592. if (line != -1 && is_line_folded(line)) {
  593. int wrap_index = get_line_wrap_index_at_column(line, col);
  594. if (wrap_index == get_line_wrap_count(line)) {
  595. int eol_icon_width = theme_cache.folded_eol_icon->get_width();
  596. int left_margin = get_total_gutter_width() + eol_icon_width + get_line_width(line, wrap_index) - get_h_scroll();
  597. if (p_pos.x > left_margin && p_pos.x <= left_margin + eol_icon_width + 3) {
  598. return CURSOR_POINTING_HAND;
  599. }
  600. }
  601. }
  602. return TextEdit::get_cursor_shape(p_pos);
  603. }
  604. void CodeEdit::_unhide_carets() {
  605. // Unfold caret and selection origin.
  606. for (int i = 0; i < get_caret_count(); i++) {
  607. if (_is_line_hidden(get_caret_line(i))) {
  608. unfold_line(get_caret_line(i));
  609. }
  610. if (has_selection(i) && _is_line_hidden(get_selection_origin_line(i))) {
  611. unfold_line(get_selection_origin_line(i));
  612. }
  613. }
  614. }
  615. /* Text manipulation */
  616. // Overridable actions
  617. void CodeEdit::_handle_unicode_input_internal(const uint32_t p_unicode, int p_caret) {
  618. start_action(EditAction::ACTION_TYPING);
  619. begin_multicaret_edit();
  620. for (int i = 0; i < get_caret_count(); i++) {
  621. if (p_caret != -1 && p_caret != i) {
  622. continue;
  623. }
  624. if (p_caret == -1 && multicaret_edit_ignore_caret(i)) {
  625. continue;
  626. }
  627. bool had_selection = has_selection(i);
  628. String selection_text = (had_selection ? get_selected_text(i) : "");
  629. if (had_selection) {
  630. delete_selection(i);
  631. }
  632. // Remove the old character if in overtype mode and no selection.
  633. if (is_overtype_mode_enabled() && !had_selection) {
  634. // Make sure we don't try and remove empty space.
  635. if (get_caret_column(i) < get_line(get_caret_line(i)).length()) {
  636. remove_text(get_caret_line(i), get_caret_column(i), get_caret_line(i), get_caret_column(i) + 1);
  637. }
  638. }
  639. const char32_t chr[2] = { (char32_t)p_unicode, 0 };
  640. if (auto_brace_completion_enabled) {
  641. int cl = get_caret_line(i);
  642. int cc = get_caret_column(i);
  643. if (had_selection) {
  644. insert_text_at_caret(chr, i);
  645. String close_key = get_auto_brace_completion_close_key(chr);
  646. if (!close_key.is_empty()) {
  647. insert_text_at_caret(selection_text + close_key, i);
  648. set_caret_column(get_caret_column(i) - 1, i == 0, i);
  649. }
  650. } else {
  651. int caret_move_offset = 1;
  652. int post_brace_pair = cc < get_line(cl).length() ? _get_auto_brace_pair_close_at_pos(cl, cc) : -1;
  653. if (has_string_delimiter(chr) && cc > 0 && !is_symbol(get_line(cl)[cc - 1]) && post_brace_pair == -1) {
  654. insert_text_at_caret(chr, i);
  655. } else if (cc < get_line(cl).length() && !is_symbol(get_line(cl)[cc])) {
  656. insert_text_at_caret(chr, i);
  657. } else if (post_brace_pair != -1 && auto_brace_completion_pairs[post_brace_pair].close_key[0] == chr[0]) {
  658. caret_move_offset = auto_brace_completion_pairs[post_brace_pair].close_key.length();
  659. } else if (is_in_comment(cl, cc) != -1 || (is_in_string(cl, cc) != -1 && has_string_delimiter(chr))) {
  660. insert_text_at_caret(chr, i);
  661. } else {
  662. insert_text_at_caret(chr, i);
  663. int pre_brace_pair = _get_auto_brace_pair_open_at_pos(cl, cc + 1);
  664. if (pre_brace_pair != -1) {
  665. insert_text_at_caret(auto_brace_completion_pairs[pre_brace_pair].close_key, i);
  666. }
  667. }
  668. set_caret_column(cc + caret_move_offset, i == 0, i);
  669. }
  670. } else {
  671. insert_text_at_caret(chr, i);
  672. }
  673. }
  674. end_multicaret_edit();
  675. end_action();
  676. }
  677. void CodeEdit::_backspace_internal(int p_caret) {
  678. if (!is_editable()) {
  679. return;
  680. }
  681. if (has_selection(p_caret)) {
  682. delete_selection(p_caret);
  683. return;
  684. }
  685. begin_complex_operation();
  686. begin_multicaret_edit();
  687. for (int i = 0; i < get_caret_count(); i++) {
  688. if (p_caret != -1 && p_caret != i) {
  689. continue;
  690. }
  691. if (p_caret == -1 && multicaret_edit_ignore_caret(i)) {
  692. continue;
  693. }
  694. int to_line = get_caret_line(i);
  695. int to_column = get_caret_column(i);
  696. if (to_column == 0 && to_line == 0) {
  697. continue;
  698. }
  699. if (to_line > 0 && to_column == 0 && _is_line_hidden(to_line - 1)) {
  700. unfold_line(to_line - 1);
  701. }
  702. int from_line = to_column > 0 ? to_line : to_line - 1;
  703. int from_column = to_column > 0 ? (to_column - 1) : (get_line(to_line - 1).length());
  704. merge_gutters(from_line, to_line);
  705. if (auto_brace_completion_enabled && to_column > 0) {
  706. int idx = _get_auto_brace_pair_open_at_pos(to_line, to_column);
  707. if (idx != -1) {
  708. from_column = to_column - auto_brace_completion_pairs[idx].open_key.length();
  709. if (_get_auto_brace_pair_close_at_pos(to_line, to_column) == idx) {
  710. to_column += auto_brace_completion_pairs[idx].close_key.length();
  711. }
  712. }
  713. }
  714. // For space indentation we need to do a basic unindent if there are no chars to the left, acting the same way as tabs.
  715. if (indent_using_spaces && to_column != 0) {
  716. if (get_first_non_whitespace_column(to_line) >= to_column) {
  717. from_column = to_column - _calculate_spaces_till_next_left_indent(to_column);
  718. from_line = to_line;
  719. }
  720. }
  721. remove_text(from_line, from_column, to_line, to_column);
  722. set_caret_line(from_line, false, true, -1, i);
  723. set_caret_column(from_column, i == 0, i);
  724. }
  725. end_multicaret_edit();
  726. end_complex_operation();
  727. }
  728. void CodeEdit::_cut_internal(int p_caret) {
  729. // Overridden to unfold lines.
  730. _copy_internal(p_caret);
  731. if (!is_editable()) {
  732. return;
  733. }
  734. if (has_selection(p_caret)) {
  735. delete_selection(p_caret);
  736. return;
  737. }
  738. if (!is_empty_selection_clipboard_enabled()) {
  739. return;
  740. }
  741. if (p_caret == -1) {
  742. delete_lines();
  743. } else {
  744. unfold_line(get_caret_line(p_caret));
  745. remove_line_at(get_caret_line(p_caret));
  746. }
  747. }
  748. /* Indent management */
  749. void CodeEdit::set_indent_size(const int p_size) {
  750. ERR_FAIL_COND_MSG(p_size <= 0, "Indend size must be greater than 0.");
  751. if (indent_size == p_size) {
  752. return;
  753. }
  754. indent_size = p_size;
  755. if (indent_using_spaces) {
  756. indent_text = String(" ").repeat(p_size);
  757. } else {
  758. indent_text = "\t";
  759. }
  760. set_tab_size(p_size);
  761. }
  762. int CodeEdit::get_indent_size() const {
  763. return indent_size;
  764. }
  765. void CodeEdit::set_indent_using_spaces(const bool p_use_spaces) {
  766. indent_using_spaces = p_use_spaces;
  767. if (indent_using_spaces) {
  768. indent_text = String(" ").repeat(indent_size);
  769. } else {
  770. indent_text = "\t";
  771. }
  772. }
  773. bool CodeEdit::is_indent_using_spaces() const {
  774. return indent_using_spaces;
  775. }
  776. void CodeEdit::set_auto_indent_enabled(bool p_enabled) {
  777. auto_indent = p_enabled;
  778. }
  779. bool CodeEdit::is_auto_indent_enabled() const {
  780. return auto_indent;
  781. }
  782. void CodeEdit::set_auto_indent_prefixes(const TypedArray<String> &p_prefixes) {
  783. auto_indent_prefixes.clear();
  784. for (int i = 0; i < p_prefixes.size(); i++) {
  785. const String prefix = p_prefixes[i];
  786. auto_indent_prefixes.insert(prefix[0]);
  787. }
  788. }
  789. TypedArray<String> CodeEdit::get_auto_indent_prefixes() const {
  790. TypedArray<String> prefixes;
  791. for (const char32_t &E : auto_indent_prefixes) {
  792. prefixes.push_back(String::chr(E));
  793. }
  794. return prefixes;
  795. }
  796. void CodeEdit::do_indent() {
  797. if (!is_editable()) {
  798. return;
  799. }
  800. if (has_selection()) {
  801. indent_lines();
  802. return;
  803. }
  804. if (!indent_using_spaces) {
  805. insert_text_at_caret("\t");
  806. return;
  807. }
  808. begin_complex_operation();
  809. begin_multicaret_edit();
  810. for (int i = 0; i < get_caret_count(); i++) {
  811. if (multicaret_edit_ignore_caret(i)) {
  812. continue;
  813. }
  814. int spaces_to_add = _calculate_spaces_till_next_right_indent(get_caret_column(i));
  815. if (spaces_to_add > 0) {
  816. insert_text_at_caret(String(" ").repeat(spaces_to_add), i);
  817. }
  818. }
  819. end_multicaret_edit();
  820. end_complex_operation();
  821. }
  822. void CodeEdit::indent_lines() {
  823. if (!is_editable()) {
  824. return;
  825. }
  826. begin_complex_operation();
  827. begin_multicaret_edit();
  828. Vector<Point2i> line_ranges = get_line_ranges_from_carets();
  829. for (Point2i line_range : line_ranges) {
  830. for (int i = line_range.x; i <= line_range.y; i++) {
  831. const String line_text = get_line(i);
  832. if (line_text.size() == 0) {
  833. // Ignore empty lines.
  834. continue;
  835. }
  836. if (indent_using_spaces) {
  837. int spaces_to_add = _calculate_spaces_till_next_right_indent(get_first_non_whitespace_column(i));
  838. insert_text(String(" ").repeat(spaces_to_add), i, 0, false);
  839. } else {
  840. insert_text("\t", i, 0, false);
  841. }
  842. }
  843. }
  844. end_multicaret_edit();
  845. end_complex_operation();
  846. }
  847. void CodeEdit::unindent_lines() {
  848. if (!is_editable()) {
  849. return;
  850. }
  851. begin_complex_operation();
  852. begin_multicaret_edit();
  853. Vector<Point2i> line_ranges = get_line_ranges_from_carets();
  854. for (Point2i line_range : line_ranges) {
  855. for (int i = line_range.x; i <= line_range.y; i++) {
  856. const String line_text = get_line(i);
  857. if (line_text.begins_with("\t")) {
  858. remove_text(i, 0, i, 1);
  859. } else if (line_text.begins_with(" ")) {
  860. // Remove only enough spaces to align text to nearest full multiple of indentation_size.
  861. int spaces_to_remove = _calculate_spaces_till_next_left_indent(get_first_non_whitespace_column(i));
  862. remove_text(i, 0, i, spaces_to_remove);
  863. }
  864. }
  865. }
  866. end_multicaret_edit();
  867. end_complex_operation();
  868. }
  869. void CodeEdit::convert_indent(int p_from_line, int p_to_line) {
  870. if (!is_editable()) {
  871. return;
  872. }
  873. // Check line range.
  874. p_from_line = (p_from_line < 0) ? 0 : p_from_line;
  875. p_to_line = (p_to_line < 0) ? get_line_count() - 1 : p_to_line;
  876. ERR_FAIL_COND(p_from_line >= get_line_count());
  877. ERR_FAIL_COND(p_to_line >= get_line_count());
  878. ERR_FAIL_COND(p_to_line < p_from_line);
  879. // Check lines within range.
  880. const char32_t from_indent_char = indent_using_spaces ? '\t' : ' ';
  881. int size_diff = indent_using_spaces ? indent_size - 1 : -(indent_size - 1);
  882. bool changed_indentation = false;
  883. for (int i = p_from_line; i <= p_to_line; i++) {
  884. String line = get_line(i);
  885. if (line.length() <= 0) {
  886. continue;
  887. }
  888. // Check chars in the line.
  889. int j = 0;
  890. int space_count = 0;
  891. bool line_changed = false;
  892. while (j < line.length() && (line[j] == ' ' || line[j] == '\t')) {
  893. if (line[j] != from_indent_char) {
  894. space_count = 0;
  895. j++;
  896. continue;
  897. }
  898. space_count++;
  899. if (!indent_using_spaces && space_count != indent_size) {
  900. j++;
  901. continue;
  902. }
  903. line_changed = true;
  904. if (!changed_indentation) {
  905. begin_complex_operation();
  906. begin_multicaret_edit();
  907. changed_indentation = true;
  908. }
  909. // Calculate new line.
  910. line = line.left(j + ((size_diff < 0) ? size_diff : 0)) + indent_text + line.substr(j + 1);
  911. space_count = 0;
  912. j += size_diff;
  913. }
  914. if (line_changed) {
  915. // Use set line to preserve carets visual position.
  916. set_line(i, line);
  917. }
  918. }
  919. if (!changed_indentation) {
  920. return;
  921. }
  922. merge_overlapping_carets();
  923. end_multicaret_edit();
  924. end_complex_operation();
  925. }
  926. int CodeEdit::_calculate_spaces_till_next_left_indent(int p_column) const {
  927. int spaces_till_indent = p_column % indent_size;
  928. if (spaces_till_indent == 0) {
  929. spaces_till_indent = indent_size;
  930. }
  931. return spaces_till_indent;
  932. }
  933. int CodeEdit::_calculate_spaces_till_next_right_indent(int p_column) const {
  934. return indent_size - p_column % indent_size;
  935. }
  936. void CodeEdit::_new_line(bool p_split_current_line, bool p_above) {
  937. if (!is_editable()) {
  938. return;
  939. }
  940. begin_complex_operation();
  941. begin_multicaret_edit();
  942. for (int i = 0; i < get_caret_count(); i++) {
  943. if (multicaret_edit_ignore_caret(i)) {
  944. continue;
  945. }
  946. // When not splitting the line, we need to factor in indentation from the end of the current line.
  947. const int cc = p_split_current_line ? get_caret_column(i) : get_line(get_caret_line(i)).length();
  948. const int cl = get_caret_line(i);
  949. const String line = get_line(cl);
  950. String ins = "";
  951. if (!p_above) {
  952. ins = "\n";
  953. }
  954. // Append current indentation.
  955. int space_count = 0;
  956. int line_col = 0;
  957. for (; line_col < cc; line_col++) {
  958. if (line[line_col] == '\t') {
  959. ins += indent_text;
  960. space_count = 0;
  961. continue;
  962. }
  963. if (line[line_col] == ' ') {
  964. space_count++;
  965. if (space_count == indent_size) {
  966. ins += indent_text;
  967. space_count = 0;
  968. }
  969. continue;
  970. }
  971. break;
  972. }
  973. if (p_above) {
  974. ins += "\n";
  975. }
  976. if (is_line_folded(cl)) {
  977. unfold_line(cl);
  978. }
  979. // Indent once again if the previous line needs it, ie ':'.
  980. // Then add an addition new line for any closing pairs aka '()'.
  981. // Skip this in comments or if we are going above.
  982. bool brace_indent = false;
  983. if (auto_indent && !p_above && cc > 0 && is_in_comment(cl) == -1) {
  984. bool should_indent = false;
  985. char32_t indent_char = ' ';
  986. for (; line_col < cc; line_col++) {
  987. char32_t c = line[line_col];
  988. if (auto_indent_prefixes.has(c) && is_in_comment(cl, line_col) == -1) {
  989. should_indent = true;
  990. indent_char = c;
  991. continue;
  992. }
  993. // Make sure this is the last char, trailing whitespace or comments are okay.
  994. // Increment column for comments because the delimiter (#) should be ignored.
  995. if (should_indent && (!is_whitespace(c) && is_in_comment(cl, line_col + 1) == -1)) {
  996. should_indent = false;
  997. }
  998. }
  999. if (should_indent) {
  1000. ins += indent_text;
  1001. String closing_pair = get_auto_brace_completion_close_key(String::chr(indent_char));
  1002. if (!closing_pair.is_empty() && line.find(closing_pair, cc) == cc) {
  1003. // No need to move the brace below if we are not taking the text with us.
  1004. if (p_split_current_line) {
  1005. brace_indent = true;
  1006. ins += "\n" + ins.substr(indent_text.size(), ins.length() - 2);
  1007. } else {
  1008. brace_indent = false;
  1009. ins = "\n" + ins.substr(indent_text.size(), ins.length() - 2);
  1010. }
  1011. }
  1012. }
  1013. }
  1014. if (p_split_current_line) {
  1015. insert_text_at_caret(ins, i);
  1016. } else {
  1017. insert_text(ins, cl, p_above ? 0 : get_line(cl).length(), p_above, p_above);
  1018. deselect(i);
  1019. set_caret_line(p_above ? cl : cl + 1, false, true, -1, i);
  1020. set_caret_column(get_line(get_caret_line(i)).length(), i == 0, i);
  1021. }
  1022. if (brace_indent) {
  1023. // Move to inner indented line.
  1024. set_caret_line(get_caret_line(i) - 1, false, true, 0, i);
  1025. set_caret_column(get_line(get_caret_line(i)).length(), i == 0, i);
  1026. }
  1027. }
  1028. end_multicaret_edit();
  1029. end_complex_operation();
  1030. }
  1031. /* Auto brace completion */
  1032. void CodeEdit::set_auto_brace_completion_enabled(bool p_enabled) {
  1033. auto_brace_completion_enabled = p_enabled;
  1034. }
  1035. bool CodeEdit::is_auto_brace_completion_enabled() const {
  1036. return auto_brace_completion_enabled;
  1037. }
  1038. void CodeEdit::set_highlight_matching_braces_enabled(bool p_enabled) {
  1039. highlight_matching_braces_enabled = p_enabled;
  1040. queue_redraw();
  1041. }
  1042. bool CodeEdit::is_highlight_matching_braces_enabled() const {
  1043. return highlight_matching_braces_enabled;
  1044. }
  1045. void CodeEdit::add_auto_brace_completion_pair(const String &p_open_key, const String &p_close_key) {
  1046. ERR_FAIL_COND_MSG(p_open_key.is_empty(), "auto brace completion open key cannot be empty");
  1047. ERR_FAIL_COND_MSG(p_close_key.is_empty(), "auto brace completion close key cannot be empty");
  1048. for (int i = 0; i < p_open_key.length(); i++) {
  1049. ERR_FAIL_COND_MSG(!is_symbol(p_open_key[i]), "auto brace completion open key must be a symbol");
  1050. }
  1051. for (int i = 0; i < p_close_key.length(); i++) {
  1052. ERR_FAIL_COND_MSG(!is_symbol(p_close_key[i]), "auto brace completion close key must be a symbol");
  1053. }
  1054. int at = 0;
  1055. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1056. ERR_FAIL_COND_MSG(auto_brace_completion_pairs[i].open_key == p_open_key, "auto brace completion open key '" + p_open_key + "' already exists.");
  1057. if (p_open_key.length() < auto_brace_completion_pairs[i].open_key.length()) {
  1058. at++;
  1059. }
  1060. }
  1061. BracePair brace_pair;
  1062. brace_pair.open_key = p_open_key;
  1063. brace_pair.close_key = p_close_key;
  1064. auto_brace_completion_pairs.insert(at, brace_pair);
  1065. }
  1066. void CodeEdit::set_auto_brace_completion_pairs(const Dictionary &p_auto_brace_completion_pairs) {
  1067. auto_brace_completion_pairs.clear();
  1068. Array keys = p_auto_brace_completion_pairs.keys();
  1069. for (int i = 0; i < keys.size(); i++) {
  1070. add_auto_brace_completion_pair(keys[i], p_auto_brace_completion_pairs[keys[i]]);
  1071. }
  1072. }
  1073. Dictionary CodeEdit::get_auto_brace_completion_pairs() const {
  1074. Dictionary brace_pairs;
  1075. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1076. brace_pairs[auto_brace_completion_pairs[i].open_key] = auto_brace_completion_pairs[i].close_key;
  1077. }
  1078. return brace_pairs;
  1079. }
  1080. bool CodeEdit::has_auto_brace_completion_open_key(const String &p_open_key) const {
  1081. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1082. if (auto_brace_completion_pairs[i].open_key == p_open_key) {
  1083. return true;
  1084. }
  1085. }
  1086. return false;
  1087. }
  1088. bool CodeEdit::has_auto_brace_completion_close_key(const String &p_close_key) const {
  1089. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1090. if (auto_brace_completion_pairs[i].close_key == p_close_key) {
  1091. return true;
  1092. }
  1093. }
  1094. return false;
  1095. }
  1096. String CodeEdit::get_auto_brace_completion_close_key(const String &p_open_key) const {
  1097. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1098. if (auto_brace_completion_pairs[i].open_key == p_open_key) {
  1099. return auto_brace_completion_pairs[i].close_key;
  1100. }
  1101. }
  1102. return String();
  1103. }
  1104. /* Main Gutter */
  1105. void CodeEdit::_update_draw_main_gutter() {
  1106. set_gutter_draw(main_gutter, draw_breakpoints || draw_bookmarks || draw_executing_lines);
  1107. }
  1108. void CodeEdit::set_draw_breakpoints_gutter(bool p_draw) {
  1109. draw_breakpoints = p_draw;
  1110. set_gutter_clickable(main_gutter, p_draw);
  1111. _update_draw_main_gutter();
  1112. }
  1113. bool CodeEdit::is_drawing_breakpoints_gutter() const {
  1114. return draw_breakpoints;
  1115. }
  1116. void CodeEdit::set_draw_bookmarks_gutter(bool p_draw) {
  1117. draw_bookmarks = p_draw;
  1118. _update_draw_main_gutter();
  1119. }
  1120. bool CodeEdit::is_drawing_bookmarks_gutter() const {
  1121. return draw_bookmarks;
  1122. }
  1123. void CodeEdit::set_draw_executing_lines_gutter(bool p_draw) {
  1124. draw_executing_lines = p_draw;
  1125. _update_draw_main_gutter();
  1126. }
  1127. bool CodeEdit::is_drawing_executing_lines_gutter() const {
  1128. return draw_executing_lines;
  1129. }
  1130. void CodeEdit::_main_gutter_draw_callback(int p_line, int p_gutter, const Rect2 &p_region) {
  1131. bool hovering = get_hovered_gutter() == Vector2i(main_gutter, p_line);
  1132. if (draw_breakpoints && theme_cache.breakpoint_icon.is_valid()) {
  1133. bool breakpointed = is_line_breakpointed(p_line);
  1134. bool shift_pressed = Input::get_singleton()->is_key_pressed(Key::SHIFT);
  1135. if (breakpointed || (hovering && !is_dragging_cursor() && !shift_pressed)) {
  1136. int padding = p_region.size.x / 6;
  1137. Color use_color = theme_cache.breakpoint_color;
  1138. if (hovering && !shift_pressed) {
  1139. use_color = breakpointed ? use_color.lightened(0.3) : use_color.darkened(0.5);
  1140. }
  1141. Rect2 icon_region = p_region;
  1142. icon_region.position += Point2(padding, padding);
  1143. icon_region.size -= Point2(padding, padding) * 2;
  1144. theme_cache.breakpoint_icon->draw_rect(get_canvas_item(), icon_region, false, use_color);
  1145. }
  1146. }
  1147. if (draw_bookmarks && theme_cache.bookmark_icon.is_valid()) {
  1148. bool bookmarked = is_line_bookmarked(p_line);
  1149. bool shift_pressed = Input::get_singleton()->is_key_pressed(Key::SHIFT);
  1150. if (bookmarked || (hovering && !is_dragging_cursor() && shift_pressed)) {
  1151. int horizontal_padding = p_region.size.x / 2;
  1152. int vertical_padding = p_region.size.y / 4;
  1153. Color use_color = theme_cache.bookmark_color;
  1154. if (hovering && shift_pressed) {
  1155. use_color = bookmarked ? use_color.lightened(0.3) : use_color.darkened(0.5);
  1156. }
  1157. Rect2 icon_region = p_region;
  1158. icon_region.position += Point2(horizontal_padding, 0);
  1159. icon_region.size -= Point2(horizontal_padding * 1.1, vertical_padding);
  1160. theme_cache.bookmark_icon->draw_rect(get_canvas_item(), icon_region, false, use_color);
  1161. }
  1162. }
  1163. if (draw_executing_lines && is_line_executing(p_line) && theme_cache.executing_line_icon.is_valid()) {
  1164. int horizontal_padding = p_region.size.x / 10;
  1165. int vertical_padding = p_region.size.y / 4;
  1166. Rect2 icon_region = p_region;
  1167. icon_region.position += Point2(horizontal_padding, vertical_padding);
  1168. icon_region.size -= Point2(horizontal_padding, vertical_padding) * 2;
  1169. theme_cache.executing_line_icon->draw_rect(get_canvas_item(), icon_region, false, theme_cache.executing_line_color);
  1170. }
  1171. }
  1172. // Breakpoints
  1173. void CodeEdit::set_line_as_breakpoint(int p_line, bool p_breakpointed) {
  1174. ERR_FAIL_INDEX(p_line, get_line_count());
  1175. int mask = get_line_gutter_metadata(p_line, main_gutter);
  1176. set_line_gutter_metadata(p_line, main_gutter, p_breakpointed ? mask | MAIN_GUTTER_BREAKPOINT : mask & ~MAIN_GUTTER_BREAKPOINT);
  1177. if (p_breakpointed) {
  1178. breakpointed_lines[p_line] = true;
  1179. } else if (breakpointed_lines.has(p_line)) {
  1180. breakpointed_lines.erase(p_line);
  1181. }
  1182. emit_signal(SNAME("breakpoint_toggled"), p_line);
  1183. queue_redraw();
  1184. }
  1185. bool CodeEdit::is_line_breakpointed(int p_line) const {
  1186. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_BREAKPOINT;
  1187. }
  1188. void CodeEdit::clear_breakpointed_lines() {
  1189. for (int i = 0; i < get_line_count(); i++) {
  1190. if (is_line_breakpointed(i)) {
  1191. set_line_as_breakpoint(i, false);
  1192. }
  1193. }
  1194. }
  1195. PackedInt32Array CodeEdit::get_breakpointed_lines() const {
  1196. PackedInt32Array ret;
  1197. for (int i = 0; i < get_line_count(); i++) {
  1198. if (is_line_breakpointed(i)) {
  1199. ret.append(i);
  1200. }
  1201. }
  1202. return ret;
  1203. }
  1204. // Bookmarks
  1205. void CodeEdit::set_line_as_bookmarked(int p_line, bool p_bookmarked) {
  1206. int mask = get_line_gutter_metadata(p_line, main_gutter);
  1207. set_line_gutter_metadata(p_line, main_gutter, p_bookmarked ? mask | MAIN_GUTTER_BOOKMARK : mask & ~MAIN_GUTTER_BOOKMARK);
  1208. queue_redraw();
  1209. }
  1210. bool CodeEdit::is_line_bookmarked(int p_line) const {
  1211. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_BOOKMARK;
  1212. }
  1213. void CodeEdit::clear_bookmarked_lines() {
  1214. for (int i = 0; i < get_line_count(); i++) {
  1215. if (is_line_bookmarked(i)) {
  1216. set_line_as_bookmarked(i, false);
  1217. }
  1218. }
  1219. }
  1220. PackedInt32Array CodeEdit::get_bookmarked_lines() const {
  1221. PackedInt32Array ret;
  1222. for (int i = 0; i < get_line_count(); i++) {
  1223. if (is_line_bookmarked(i)) {
  1224. ret.append(i);
  1225. }
  1226. }
  1227. return ret;
  1228. }
  1229. // Executing lines
  1230. void CodeEdit::set_line_as_executing(int p_line, bool p_executing) {
  1231. int mask = get_line_gutter_metadata(p_line, main_gutter);
  1232. set_line_gutter_metadata(p_line, main_gutter, p_executing ? mask | MAIN_GUTTER_EXECUTING : mask & ~MAIN_GUTTER_EXECUTING);
  1233. queue_redraw();
  1234. }
  1235. bool CodeEdit::is_line_executing(int p_line) const {
  1236. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_EXECUTING;
  1237. }
  1238. void CodeEdit::clear_executing_lines() {
  1239. for (int i = 0; i < get_line_count(); i++) {
  1240. if (is_line_executing(i)) {
  1241. set_line_as_executing(i, false);
  1242. }
  1243. }
  1244. }
  1245. PackedInt32Array CodeEdit::get_executing_lines() const {
  1246. PackedInt32Array ret;
  1247. for (int i = 0; i < get_line_count(); i++) {
  1248. if (is_line_executing(i)) {
  1249. ret.append(i);
  1250. }
  1251. }
  1252. return ret;
  1253. }
  1254. /* Line numbers */
  1255. void CodeEdit::set_draw_line_numbers(bool p_draw) {
  1256. set_gutter_draw(line_number_gutter, p_draw);
  1257. }
  1258. bool CodeEdit::is_draw_line_numbers_enabled() const {
  1259. return is_gutter_drawn(line_number_gutter);
  1260. }
  1261. void CodeEdit::set_line_numbers_zero_padded(bool p_zero_padded) {
  1262. String new_line_number_padding = p_zero_padded ? "0" : " ";
  1263. if (line_number_padding == new_line_number_padding) {
  1264. return;
  1265. }
  1266. line_number_padding = new_line_number_padding;
  1267. _clear_line_number_text_cache();
  1268. queue_redraw();
  1269. }
  1270. bool CodeEdit::is_line_numbers_zero_padded() const {
  1271. return line_number_padding == "0";
  1272. }
  1273. void CodeEdit::_line_number_draw_callback(int p_line, int p_gutter, const Rect2 &p_region) {
  1274. if (!Rect2(Vector2(0, 0), get_size()).intersects(p_region)) {
  1275. return;
  1276. }
  1277. bool rtl = is_layout_rtl();
  1278. HashMap<int, RID>::Iterator E = line_number_text_cache.find(p_line);
  1279. RID text_rid;
  1280. if (E) {
  1281. text_rid = E->value;
  1282. } else {
  1283. String fc = String::num_int64(p_line + 1).lpad(line_number_digits, line_number_padding);
  1284. if (is_localizing_numeral_system()) {
  1285. fc = TS->format_number(fc);
  1286. }
  1287. text_rid = TS->create_shaped_text();
  1288. if (theme_cache.font.is_valid()) {
  1289. TS->shaped_text_add_string(text_rid, fc, theme_cache.font->get_rids(), theme_cache.font_size, theme_cache.font->get_opentype_features());
  1290. }
  1291. line_number_text_cache.insert(p_line, text_rid);
  1292. }
  1293. Size2 text_size = TS->shaped_text_get_size(text_rid);
  1294. Point2 ofs = p_region.get_center() - text_size / 2;
  1295. ofs.y += TS->shaped_text_get_ascent(text_rid);
  1296. if (rtl) {
  1297. ofs.x = p_region.get_end().x - text_size.width;
  1298. } else {
  1299. ofs.x = p_region.position.x;
  1300. }
  1301. Color number_color = get_line_gutter_item_color(p_line, line_number_gutter);
  1302. if (number_color == Color(1, 1, 1)) {
  1303. number_color = theme_cache.line_number_color;
  1304. }
  1305. TS->shaped_text_draw(text_rid, get_canvas_item(), ofs, -1, -1, number_color);
  1306. }
  1307. void CodeEdit::_clear_line_number_text_cache() {
  1308. for (const KeyValue<int, RID> &KV : line_number_text_cache) {
  1309. TS->free_rid(KV.value);
  1310. }
  1311. line_number_text_cache.clear();
  1312. }
  1313. void CodeEdit::_update_line_number_gutter_width() {
  1314. set_gutter_width(line_number_gutter, (line_number_digits + 1) * theme_cache.font->get_char_size('0', theme_cache.font_size).width);
  1315. }
  1316. /* Fold Gutter */
  1317. void CodeEdit::set_draw_fold_gutter(bool p_draw) {
  1318. set_gutter_draw(fold_gutter, p_draw);
  1319. }
  1320. bool CodeEdit::is_drawing_fold_gutter() const {
  1321. return is_gutter_drawn(fold_gutter);
  1322. }
  1323. void CodeEdit::_fold_gutter_draw_callback(int p_line, int p_gutter, Rect2 p_region) {
  1324. if (!can_fold_line(p_line) && !is_line_folded(p_line)) {
  1325. set_line_gutter_clickable(p_line, fold_gutter, false);
  1326. return;
  1327. }
  1328. set_line_gutter_clickable(p_line, fold_gutter, true);
  1329. int horizontal_padding = p_region.size.x / 10;
  1330. int vertical_padding = p_region.size.y / 6;
  1331. p_region.position += Point2(horizontal_padding, vertical_padding);
  1332. p_region.size -= Point2(horizontal_padding, vertical_padding) * 2;
  1333. bool can_fold = can_fold_line(p_line);
  1334. if (is_line_code_region_start(p_line)) {
  1335. Color region_icon_color = theme_cache.folded_code_region_color;
  1336. region_icon_color.a = MAX(region_icon_color.a, 0.4f);
  1337. if (can_fold) {
  1338. theme_cache.can_fold_code_region_icon->draw_rect(get_canvas_item(), p_region, false, region_icon_color);
  1339. } else {
  1340. theme_cache.folded_code_region_icon->draw_rect(get_canvas_item(), p_region, false, region_icon_color);
  1341. }
  1342. return;
  1343. }
  1344. if (can_fold) {
  1345. theme_cache.can_fold_icon->draw_rect(get_canvas_item(), p_region, false, theme_cache.code_folding_color);
  1346. return;
  1347. }
  1348. theme_cache.folded_icon->draw_rect(get_canvas_item(), p_region, false, theme_cache.code_folding_color);
  1349. }
  1350. /* Line Folding */
  1351. void CodeEdit::set_line_folding_enabled(bool p_enabled) {
  1352. line_folding_enabled = p_enabled;
  1353. _set_hiding_enabled(p_enabled);
  1354. }
  1355. bool CodeEdit::is_line_folding_enabled() const {
  1356. return line_folding_enabled;
  1357. }
  1358. bool CodeEdit::can_fold_line(int p_line) const {
  1359. ERR_FAIL_INDEX_V(p_line, get_line_count(), false);
  1360. if (!line_folding_enabled) {
  1361. return false;
  1362. }
  1363. if (p_line + 1 >= get_line_count() || get_line(p_line).strip_edges().size() == 0) {
  1364. return false;
  1365. }
  1366. if (_is_line_hidden(p_line) || is_line_folded(p_line)) {
  1367. return false;
  1368. }
  1369. // Check for code region.
  1370. if (is_line_code_region_end(p_line)) {
  1371. return false;
  1372. }
  1373. if (is_line_code_region_start(p_line)) {
  1374. int region_level = 0;
  1375. // Check if there is a valid end region tag.
  1376. for (int next_line = p_line + 1; next_line < get_line_count(); next_line++) {
  1377. if (is_line_code_region_end(next_line)) {
  1378. region_level -= 1;
  1379. if (region_level == -1) {
  1380. return true;
  1381. }
  1382. }
  1383. if (is_line_code_region_start(next_line)) {
  1384. region_level += 1;
  1385. }
  1386. }
  1387. return false;
  1388. }
  1389. /* Check for full multiline line or block strings / comments. */
  1390. int in_comment = is_in_comment(p_line);
  1391. int in_string = (in_comment == -1) ? is_in_string(p_line) : -1;
  1392. if (in_string != -1 || in_comment != -1) {
  1393. if (get_delimiter_start_position(p_line, get_line(p_line).size() - 1).y != p_line) {
  1394. return false;
  1395. }
  1396. int delimiter_end_line = get_delimiter_end_position(p_line, get_line(p_line).size() - 1).y;
  1397. /* No end line, therefore we have a multiline region over the rest of the file. */
  1398. if (delimiter_end_line == -1) {
  1399. return true;
  1400. }
  1401. /* End line is the same therefore we have a block. */
  1402. if (delimiter_end_line == p_line) {
  1403. /* Check we are the start of the block. */
  1404. if (p_line - 1 >= 0) {
  1405. if ((in_string != -1 && is_in_string(p_line - 1) != -1) || (in_comment != -1 && is_in_comment(p_line - 1) != -1)) {
  1406. return false;
  1407. }
  1408. }
  1409. /* Check it continues for at least one line. */
  1410. return ((in_string != -1 && is_in_string(p_line + 1) != -1) || (in_comment != -1 && is_in_comment(p_line + 1) != -1));
  1411. }
  1412. return ((in_string != -1 && is_in_string(delimiter_end_line) != -1) || (in_comment != -1 && is_in_comment(delimiter_end_line) != -1));
  1413. }
  1414. /* Otherwise check indent levels. */
  1415. int start_indent = get_indent_level(p_line);
  1416. for (int i = p_line + 1; i < get_line_count(); i++) {
  1417. if (is_in_string(i) != -1 || is_in_comment(i) != -1 || get_line(i).strip_edges().size() == 0) {
  1418. continue;
  1419. }
  1420. return (get_indent_level(i) > start_indent);
  1421. }
  1422. return false;
  1423. }
  1424. void CodeEdit::fold_line(int p_line) {
  1425. ERR_FAIL_INDEX(p_line, get_line_count());
  1426. if (!is_line_folding_enabled() || !can_fold_line(p_line)) {
  1427. return;
  1428. }
  1429. /* Find the last line to be hidden. */
  1430. const int line_count = get_line_count() - 1;
  1431. int end_line = line_count;
  1432. // Fold code region.
  1433. if (is_line_code_region_start(p_line)) {
  1434. int region_level = 0;
  1435. for (int endregion_line = p_line + 1; endregion_line < get_line_count(); endregion_line++) {
  1436. if (is_line_code_region_start(endregion_line)) {
  1437. region_level += 1;
  1438. }
  1439. if (is_line_code_region_end(endregion_line)) {
  1440. region_level -= 1;
  1441. if (region_level == -1) {
  1442. end_line = endregion_line;
  1443. break;
  1444. }
  1445. }
  1446. }
  1447. set_line_background_color(p_line, theme_cache.folded_code_region_color);
  1448. }
  1449. int in_comment = is_in_comment(p_line);
  1450. int in_string = (in_comment == -1) ? is_in_string(p_line) : -1;
  1451. if (!is_line_code_region_start(p_line)) {
  1452. if (in_string != -1 || in_comment != -1) {
  1453. end_line = get_delimiter_end_position(p_line, get_line(p_line).size() - 1).y;
  1454. // End line is the same therefore we have a block of single line delimiters.
  1455. if (end_line == p_line) {
  1456. for (int i = p_line + 1; i <= line_count; i++) {
  1457. if ((in_string != -1 && is_in_string(i) == -1) || (in_comment != -1 && is_in_comment(i) == -1)) {
  1458. break;
  1459. }
  1460. end_line = i;
  1461. }
  1462. }
  1463. } else {
  1464. int start_indent = get_indent_level(p_line);
  1465. for (int i = p_line + 1; i <= line_count; i++) {
  1466. if (get_line(i).strip_edges().size() == 0) {
  1467. continue;
  1468. }
  1469. if (get_indent_level(i) > start_indent) {
  1470. end_line = i;
  1471. continue;
  1472. }
  1473. if (is_in_string(i) == -1 && is_in_comment(i) == -1) {
  1474. break;
  1475. }
  1476. }
  1477. }
  1478. }
  1479. for (int i = p_line + 1; i <= end_line; i++) {
  1480. _set_line_as_hidden(i, true);
  1481. }
  1482. // Collapse any carets in the hidden area.
  1483. collapse_carets(p_line, get_line(p_line).length(), end_line, get_line(end_line).length(), true);
  1484. }
  1485. void CodeEdit::unfold_line(int p_line) {
  1486. ERR_FAIL_INDEX(p_line, get_line_count());
  1487. if (!is_line_folded(p_line) && !_is_line_hidden(p_line)) {
  1488. return;
  1489. }
  1490. int fold_start = p_line;
  1491. for (; fold_start > 0; fold_start--) {
  1492. if (is_line_folded(fold_start)) {
  1493. break;
  1494. }
  1495. }
  1496. fold_start = is_line_folded(fold_start) ? fold_start : p_line;
  1497. for (int i = fold_start + 1; i < get_line_count(); i++) {
  1498. if (!_is_line_hidden(i)) {
  1499. break;
  1500. }
  1501. _set_line_as_hidden(i, false);
  1502. if (is_line_code_region_start(i - 1)) {
  1503. set_line_background_color(i - 1, Color(0.0, 0.0, 0.0, 0.0));
  1504. }
  1505. }
  1506. queue_redraw();
  1507. }
  1508. void CodeEdit::fold_all_lines() {
  1509. for (int i = 0; i < get_line_count(); i++) {
  1510. fold_line(i);
  1511. }
  1512. queue_redraw();
  1513. }
  1514. void CodeEdit::unfold_all_lines() {
  1515. _unhide_all_lines();
  1516. }
  1517. void CodeEdit::toggle_foldable_line(int p_line) {
  1518. ERR_FAIL_INDEX(p_line, get_line_count());
  1519. if (is_line_folded(p_line)) {
  1520. unfold_line(p_line);
  1521. return;
  1522. }
  1523. fold_line(p_line);
  1524. }
  1525. void CodeEdit::toggle_foldable_lines_at_carets() {
  1526. begin_multicaret_edit();
  1527. int previous_line = -1;
  1528. Vector<int> sorted = get_sorted_carets();
  1529. for (int caret_idx : sorted) {
  1530. if (multicaret_edit_ignore_caret(caret_idx)) {
  1531. continue;
  1532. }
  1533. int line_idx = get_caret_line(caret_idx);
  1534. if (line_idx != previous_line) {
  1535. toggle_foldable_line(line_idx);
  1536. previous_line = line_idx;
  1537. }
  1538. }
  1539. end_multicaret_edit();
  1540. }
  1541. bool CodeEdit::is_line_folded(int p_line) const {
  1542. ERR_FAIL_INDEX_V(p_line, get_line_count(), false);
  1543. return p_line + 1 < get_line_count() && !_is_line_hidden(p_line) && _is_line_hidden(p_line + 1);
  1544. }
  1545. TypedArray<int> CodeEdit::get_folded_lines() const {
  1546. TypedArray<int> folded_lines;
  1547. for (int i = 0; i < get_line_count(); i++) {
  1548. if (is_line_folded(i)) {
  1549. folded_lines.push_back(i);
  1550. }
  1551. }
  1552. return folded_lines;
  1553. }
  1554. /* Code region */
  1555. void CodeEdit::create_code_region() {
  1556. // Abort if there is no selected text.
  1557. if (!has_selection()) {
  1558. return;
  1559. }
  1560. // Check that region tag find a comment delimiter and is valid.
  1561. if (code_region_start_string.is_empty()) {
  1562. WARN_PRINT_ONCE("Cannot create code region without any one line comment delimiters");
  1563. return;
  1564. }
  1565. String region_name = atr(ETR("New Code Region"));
  1566. begin_complex_operation();
  1567. begin_multicaret_edit();
  1568. Vector<Point2i> line_ranges = get_line_ranges_from_carets(true, false);
  1569. // Add start and end region tags.
  1570. int line_offset = 0;
  1571. for (Point2i line_range : line_ranges) {
  1572. insert_text("\n" + code_region_end_string, line_range.y + line_offset, get_line(line_range.y + line_offset).length());
  1573. insert_line_at(line_range.x + line_offset, code_region_start_string + " " + region_name);
  1574. fold_line(line_range.x + line_offset);
  1575. line_offset += 2;
  1576. }
  1577. int first_region_start = line_ranges[0].x;
  1578. // Select name of the first region to allow quick edit.
  1579. remove_secondary_carets();
  1580. int tag_length = code_region_start_string.length() + region_name.length() + 1;
  1581. select(first_region_start, code_region_start_string.length() + 1, first_region_start, tag_length);
  1582. end_multicaret_edit();
  1583. end_complex_operation();
  1584. }
  1585. String CodeEdit::get_code_region_start_tag() const {
  1586. return code_region_start_tag;
  1587. }
  1588. String CodeEdit::get_code_region_end_tag() const {
  1589. return code_region_end_tag;
  1590. }
  1591. void CodeEdit::set_code_region_tags(const String &p_start, const String &p_end) {
  1592. ERR_FAIL_COND_MSG(p_start == p_end, "Starting and ending region tags cannot be identical.");
  1593. ERR_FAIL_COND_MSG(p_start.is_empty(), "Starting region tag cannot be empty.");
  1594. ERR_FAIL_COND_MSG(p_end.is_empty(), "Ending region tag cannot be empty.");
  1595. code_region_start_tag = p_start;
  1596. code_region_end_tag = p_end;
  1597. _update_code_region_tags();
  1598. }
  1599. bool CodeEdit::is_line_code_region_start(int p_line) const {
  1600. ERR_FAIL_INDEX_V(p_line, get_line_count(), false);
  1601. if (code_region_start_string.is_empty()) {
  1602. return false;
  1603. }
  1604. if (is_in_string(p_line) != -1) {
  1605. return false;
  1606. }
  1607. return get_line(p_line).strip_edges().begins_with(code_region_start_string);
  1608. }
  1609. bool CodeEdit::is_line_code_region_end(int p_line) const {
  1610. ERR_FAIL_INDEX_V(p_line, get_line_count(), false);
  1611. if (code_region_start_string.is_empty()) {
  1612. return false;
  1613. }
  1614. if (is_in_string(p_line) != -1) {
  1615. return false;
  1616. }
  1617. return get_line(p_line).strip_edges().begins_with(code_region_end_string);
  1618. }
  1619. /* Delimiters */
  1620. // Strings
  1621. void CodeEdit::add_string_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only) {
  1622. _add_delimiter(p_start_key, p_end_key, p_line_only, TYPE_STRING);
  1623. }
  1624. void CodeEdit::remove_string_delimiter(const String &p_start_key) {
  1625. _remove_delimiter(p_start_key, TYPE_STRING);
  1626. }
  1627. bool CodeEdit::has_string_delimiter(const String &p_start_key) const {
  1628. return _has_delimiter(p_start_key, TYPE_STRING);
  1629. }
  1630. void CodeEdit::set_string_delimiters(const TypedArray<String> &p_string_delimiters) {
  1631. _set_delimiters(p_string_delimiters, TYPE_STRING);
  1632. }
  1633. void CodeEdit::clear_string_delimiters() {
  1634. _clear_delimiters(TYPE_STRING);
  1635. }
  1636. TypedArray<String> CodeEdit::get_string_delimiters() const {
  1637. return _get_delimiters(TYPE_STRING);
  1638. }
  1639. int CodeEdit::is_in_string(int p_line, int p_column) const {
  1640. return _is_in_delimiter(p_line, p_column, TYPE_STRING);
  1641. }
  1642. // Comments
  1643. void CodeEdit::add_comment_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only) {
  1644. _add_delimiter(p_start_key, p_end_key, p_line_only, TYPE_COMMENT);
  1645. }
  1646. void CodeEdit::remove_comment_delimiter(const String &p_start_key) {
  1647. _remove_delimiter(p_start_key, TYPE_COMMENT);
  1648. }
  1649. bool CodeEdit::has_comment_delimiter(const String &p_start_key) const {
  1650. return _has_delimiter(p_start_key, TYPE_COMMENT);
  1651. }
  1652. void CodeEdit::set_comment_delimiters(const TypedArray<String> &p_comment_delimiters) {
  1653. _set_delimiters(p_comment_delimiters, TYPE_COMMENT);
  1654. }
  1655. void CodeEdit::clear_comment_delimiters() {
  1656. _clear_delimiters(TYPE_COMMENT);
  1657. }
  1658. TypedArray<String> CodeEdit::get_comment_delimiters() const {
  1659. return _get_delimiters(TYPE_COMMENT);
  1660. }
  1661. int CodeEdit::is_in_comment(int p_line, int p_column) const {
  1662. return _is_in_delimiter(p_line, p_column, TYPE_COMMENT);
  1663. }
  1664. String CodeEdit::get_delimiter_start_key(int p_delimiter_idx) const {
  1665. ERR_FAIL_INDEX_V(p_delimiter_idx, delimiters.size(), "");
  1666. return delimiters[p_delimiter_idx].start_key;
  1667. }
  1668. String CodeEdit::get_delimiter_end_key(int p_delimiter_idx) const {
  1669. ERR_FAIL_INDEX_V(p_delimiter_idx, delimiters.size(), "");
  1670. return delimiters[p_delimiter_idx].end_key;
  1671. }
  1672. Point2 CodeEdit::get_delimiter_start_position(int p_line, int p_column) const {
  1673. if (delimiters.size() == 0) {
  1674. return Point2(-1, -1);
  1675. }
  1676. ERR_FAIL_INDEX_V(p_line, get_line_count(), Point2(-1, -1));
  1677. ERR_FAIL_COND_V(p_column - 1 > get_line(p_line).size(), Point2(-1, -1));
  1678. Point2 start_position;
  1679. start_position.y = -1;
  1680. start_position.x = -1;
  1681. bool in_region = ((p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->get()) != -1;
  1682. /* Check the keys for this line. */
  1683. for (const KeyValue<int, int> &E : delimiter_cache[p_line]) {
  1684. if (E.key > p_column) {
  1685. break;
  1686. }
  1687. in_region = E.value != -1;
  1688. start_position.x = in_region ? E.key : -1;
  1689. }
  1690. /* Region was found on this line and is not a multiline continuation. */
  1691. int line_length = get_line(p_line).length();
  1692. if (start_position.x != -1 && line_length > 0 && start_position.x != line_length + 1) {
  1693. start_position.y = p_line;
  1694. return start_position;
  1695. }
  1696. /* Not in a region */
  1697. if (!in_region) {
  1698. return start_position;
  1699. }
  1700. /* Region starts on a previous line */
  1701. for (int i = p_line - 1; i >= 0; i--) {
  1702. if (delimiter_cache[i].size() < 1) {
  1703. continue;
  1704. }
  1705. start_position.y = i;
  1706. start_position.x = delimiter_cache[i].back()->key();
  1707. /* Make sure it's not a multiline continuation. */
  1708. line_length = get_line(i).length();
  1709. if (line_length > 0 && start_position.x != line_length + 1) {
  1710. break;
  1711. }
  1712. }
  1713. return start_position;
  1714. }
  1715. Point2 CodeEdit::get_delimiter_end_position(int p_line, int p_column) const {
  1716. if (delimiters.size() == 0) {
  1717. return Point2(-1, -1);
  1718. }
  1719. ERR_FAIL_INDEX_V(p_line, get_line_count(), Point2(-1, -1));
  1720. ERR_FAIL_COND_V(p_column - 1 > get_line(p_line).size(), Point2(-1, -1));
  1721. Point2 end_position;
  1722. end_position.y = -1;
  1723. end_position.x = -1;
  1724. int region = (p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->value();
  1725. /* Check the keys for this line. */
  1726. for (const KeyValue<int, int> &E : delimiter_cache[p_line]) {
  1727. end_position.x = (E.value == -1) ? E.key : -1;
  1728. if (E.key > p_column) {
  1729. break;
  1730. }
  1731. region = E.value;
  1732. }
  1733. /* Region was found on this line and is not a multiline continuation. */
  1734. if (region != -1 && end_position.x != -1 && (delimiters[region].line_only || end_position.x != get_line(p_line).length() + 1)) {
  1735. end_position.y = p_line;
  1736. return end_position;
  1737. }
  1738. /* Not in a region */
  1739. if (region == -1) {
  1740. end_position.x = -1;
  1741. return end_position;
  1742. }
  1743. /* Region ends on a later line */
  1744. for (int i = p_line + 1; i < get_line_count(); i++) {
  1745. if (delimiter_cache[i].size() < 1 || delimiter_cache[i].front()->value() != -1) {
  1746. continue;
  1747. }
  1748. end_position.x = delimiter_cache[i].front()->key();
  1749. /* Make sure it's not a multiline continuation. */
  1750. if (get_line(i).length() > 0 && end_position.x != get_line(i).length() + 1) {
  1751. end_position.y = i;
  1752. break;
  1753. }
  1754. end_position.x = -1;
  1755. }
  1756. return end_position;
  1757. }
  1758. /* Code hint */
  1759. void CodeEdit::set_code_hint(const String &p_hint) {
  1760. if (code_hint == p_hint) {
  1761. return;
  1762. }
  1763. code_hint = p_hint;
  1764. code_hint_xpos = -0xFFFF;
  1765. queue_redraw();
  1766. }
  1767. void CodeEdit::set_code_hint_draw_below(bool p_below) {
  1768. if (code_hint_draw_below == p_below) {
  1769. return;
  1770. }
  1771. code_hint_draw_below = p_below;
  1772. queue_redraw();
  1773. }
  1774. /* Code Completion */
  1775. void CodeEdit::set_code_completion_enabled(bool p_enable) {
  1776. code_completion_enabled = p_enable;
  1777. }
  1778. bool CodeEdit::is_code_completion_enabled() const {
  1779. return code_completion_enabled;
  1780. }
  1781. void CodeEdit::set_code_completion_prefixes(const TypedArray<String> &p_prefixes) {
  1782. code_completion_prefixes.clear();
  1783. for (int i = 0; i < p_prefixes.size(); i++) {
  1784. const String prefix = p_prefixes[i];
  1785. ERR_CONTINUE_MSG(prefix.is_empty(), "Code completion prefix cannot be empty.");
  1786. code_completion_prefixes.insert(prefix[0]);
  1787. }
  1788. }
  1789. TypedArray<String> CodeEdit::get_code_completion_prefixes() const {
  1790. TypedArray<String> prefixes;
  1791. for (const char32_t &E : code_completion_prefixes) {
  1792. prefixes.push_back(String::chr(E));
  1793. }
  1794. return prefixes;
  1795. }
  1796. String CodeEdit::get_text_for_code_completion() const {
  1797. StringBuilder completion_text;
  1798. const int text_size = get_line_count();
  1799. for (int i = 0; i < text_size; i++) {
  1800. String line = get_line(i);
  1801. if (i == get_caret_line()) {
  1802. completion_text += line.substr(0, get_caret_column());
  1803. /* Not unicode, represents the caret. */
  1804. completion_text += String::chr(0xFFFF);
  1805. completion_text += line.substr(get_caret_column(), line.size());
  1806. } else {
  1807. completion_text += line;
  1808. }
  1809. if (i != text_size - 1) {
  1810. completion_text += "\n";
  1811. }
  1812. }
  1813. return completion_text.as_string();
  1814. }
  1815. void CodeEdit::request_code_completion(bool p_force) {
  1816. if (GDVIRTUAL_CALL(_request_code_completion, p_force)) {
  1817. return;
  1818. }
  1819. /* Don't re-query if all existing options are quoted types, eg path, signal. */
  1820. bool ignored = code_completion_active && !code_completion_options.is_empty();
  1821. if (ignored) {
  1822. ScriptLanguage::CodeCompletionKind kind = ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT;
  1823. const ScriptLanguage::CodeCompletionOption *previous_option = nullptr;
  1824. for (int i = 0; i < code_completion_options.size(); i++) {
  1825. const ScriptLanguage::CodeCompletionOption &current_option = code_completion_options[i];
  1826. if (!previous_option) {
  1827. previous_option = &current_option;
  1828. kind = current_option.kind;
  1829. }
  1830. if (previous_option->kind != current_option.kind) {
  1831. ignored = false;
  1832. break;
  1833. }
  1834. }
  1835. ignored = ignored && (kind == ScriptLanguage::CODE_COMPLETION_KIND_FILE_PATH || kind == ScriptLanguage::CODE_COMPLETION_KIND_NODE_PATH || kind == ScriptLanguage::CODE_COMPLETION_KIND_SIGNAL);
  1836. }
  1837. if (ignored) {
  1838. return;
  1839. }
  1840. if (p_force) {
  1841. emit_signal(SNAME("code_completion_requested"));
  1842. return;
  1843. }
  1844. String line = get_line(get_caret_line());
  1845. int ofs = CLAMP(get_caret_column(), 0, line.length());
  1846. if (ofs > 0 && (is_in_string(get_caret_line(), ofs) != -1 || !is_symbol(line[ofs - 1]) || code_completion_prefixes.has(line[ofs - 1]))) {
  1847. emit_signal(SNAME("code_completion_requested"));
  1848. } else if (ofs > 1 && line[ofs - 1] == ' ' && code_completion_prefixes.has(line[ofs - 2])) {
  1849. emit_signal(SNAME("code_completion_requested"));
  1850. }
  1851. }
  1852. 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, int p_location) {
  1853. ScriptLanguage::CodeCompletionOption completion_option;
  1854. completion_option.kind = (ScriptLanguage::CodeCompletionKind)p_type;
  1855. completion_option.display = p_display_text;
  1856. completion_option.insert_text = p_insert_text;
  1857. completion_option.font_color = p_text_color;
  1858. completion_option.icon = p_icon;
  1859. completion_option.default_value = p_value;
  1860. completion_option.location = p_location;
  1861. code_completion_option_submitted.push_back(completion_option);
  1862. }
  1863. void CodeEdit::update_code_completion_options(bool p_forced) {
  1864. code_completion_forced = p_forced;
  1865. code_completion_option_sources = code_completion_option_submitted;
  1866. code_completion_option_submitted.clear();
  1867. _filter_code_completion_candidates_impl();
  1868. }
  1869. TypedArray<Dictionary> CodeEdit::get_code_completion_options() const {
  1870. if (!code_completion_active) {
  1871. return TypedArray<Dictionary>();
  1872. }
  1873. TypedArray<Dictionary> completion_options;
  1874. completion_options.resize(code_completion_options.size());
  1875. for (int i = 0; i < code_completion_options.size(); i++) {
  1876. Dictionary option;
  1877. option["kind"] = code_completion_options[i].kind;
  1878. option["display_text"] = code_completion_options[i].display;
  1879. option["insert_text"] = code_completion_options[i].insert_text;
  1880. option["font_color"] = code_completion_options[i].font_color;
  1881. option["icon"] = code_completion_options[i].icon;
  1882. option["location"] = code_completion_options[i].location;
  1883. option["default_value"] = code_completion_options[i].default_value;
  1884. completion_options[i] = option;
  1885. }
  1886. return completion_options;
  1887. }
  1888. Dictionary CodeEdit::get_code_completion_option(int p_index) const {
  1889. if (!code_completion_active) {
  1890. return Dictionary();
  1891. }
  1892. ERR_FAIL_INDEX_V(p_index, code_completion_options.size(), Dictionary());
  1893. Dictionary option;
  1894. option["kind"] = code_completion_options[p_index].kind;
  1895. option["display_text"] = code_completion_options[p_index].display;
  1896. option["insert_text"] = code_completion_options[p_index].insert_text;
  1897. option["font_color"] = code_completion_options[p_index].font_color;
  1898. option["icon"] = code_completion_options[p_index].icon;
  1899. option["location"] = code_completion_options[p_index].location;
  1900. option["default_value"] = code_completion_options[p_index].default_value;
  1901. return option;
  1902. }
  1903. int CodeEdit::get_code_completion_selected_index() const {
  1904. return (code_completion_active) ? code_completion_current_selected : -1;
  1905. }
  1906. void CodeEdit::set_code_completion_selected_index(int p_index) {
  1907. if (!code_completion_active) {
  1908. return;
  1909. }
  1910. ERR_FAIL_INDEX(p_index, code_completion_options.size());
  1911. code_completion_current_selected = p_index;
  1912. code_completion_force_item_center = -1;
  1913. code_completion_pan_offset = 0.0f;
  1914. queue_redraw();
  1915. }
  1916. void CodeEdit::confirm_code_completion(bool p_replace) {
  1917. if (!is_editable() || !code_completion_active) {
  1918. return;
  1919. }
  1920. if (GDVIRTUAL_CALL(_confirm_code_completion, p_replace)) {
  1921. return;
  1922. }
  1923. char32_t caret_last_completion_char = 0;
  1924. begin_complex_operation();
  1925. begin_multicaret_edit();
  1926. for (int i = 0; i < get_caret_count(); i++) {
  1927. if (multicaret_edit_ignore_caret(i)) {
  1928. continue;
  1929. }
  1930. int caret_line = get_caret_line(i);
  1931. const String &insert_text = code_completion_options[code_completion_current_selected].insert_text;
  1932. const String &display_text = code_completion_options[code_completion_current_selected].display;
  1933. if (p_replace) {
  1934. // Find end of current section.
  1935. const String line = get_line(caret_line);
  1936. int caret_col = get_caret_column(i);
  1937. int caret_remove_line = caret_line;
  1938. bool merge_text = true;
  1939. int in_string = is_in_string(caret_line, caret_col);
  1940. if (in_string != -1) {
  1941. Point2 string_end = get_delimiter_end_position(caret_line, caret_col);
  1942. if (string_end.x != -1) {
  1943. merge_text = false;
  1944. caret_remove_line = string_end.y;
  1945. caret_col = string_end.x - 1;
  1946. }
  1947. }
  1948. if (merge_text) {
  1949. for (; caret_col < line.length(); caret_col++) {
  1950. if (is_symbol(line[caret_col])) {
  1951. break;
  1952. }
  1953. }
  1954. }
  1955. // Replace.
  1956. remove_text(caret_line, get_caret_column(i) - code_completion_base.length(), caret_remove_line, caret_col);
  1957. insert_text_at_caret(insert_text, i);
  1958. } else {
  1959. // Get first non-matching char.
  1960. const String line = get_line(caret_line);
  1961. int caret_col = get_caret_column(i);
  1962. int matching_chars = code_completion_base.length();
  1963. for (; matching_chars <= insert_text.length(); matching_chars++) {
  1964. if (caret_col >= line.length() || line[caret_col] != insert_text[matching_chars]) {
  1965. break;
  1966. }
  1967. caret_col++;
  1968. }
  1969. // Remove base completion text.
  1970. remove_text(caret_line, get_caret_column(i) - code_completion_base.length(), caret_line, get_caret_column(i));
  1971. // Merge with text.
  1972. insert_text_at_caret(insert_text.substr(0, code_completion_base.length()), i);
  1973. set_caret_column(caret_col, false, i);
  1974. insert_text_at_caret(insert_text.substr(matching_chars), i);
  1975. }
  1976. // Handle merging of symbols eg strings, brackets.
  1977. const String line = get_line(caret_line);
  1978. char32_t next_char = line[get_caret_column(i)];
  1979. char32_t last_completion_char = insert_text[insert_text.length() - 1];
  1980. if (i == 0) {
  1981. caret_last_completion_char = last_completion_char;
  1982. }
  1983. char32_t last_completion_char_display = display_text[display_text.length() - 1];
  1984. bool last_char_matches = (last_completion_char == next_char || last_completion_char_display == next_char);
  1985. int pre_brace_pair = get_caret_column(i) > 0 ? _get_auto_brace_pair_open_at_pos(caret_line, get_caret_column(i)) : -1;
  1986. 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;
  1987. // Strings do not nest like brackets, so ensure we don't add an additional closing pair.
  1988. if (has_string_delimiter(String::chr(last_completion_char))) {
  1989. if (post_brace_pair != -1 && last_char_matches) {
  1990. remove_text(caret_line, get_caret_column(i), caret_line, get_caret_column(i) + 1);
  1991. }
  1992. } else {
  1993. if (pre_brace_pair != -1 && pre_brace_pair != post_brace_pair && last_char_matches) {
  1994. remove_text(caret_line, get_caret_column(i), caret_line, get_caret_column(i) + 1);
  1995. } else if (auto_brace_completion_enabled && pre_brace_pair != -1) {
  1996. insert_text_at_caret(auto_brace_completion_pairs[pre_brace_pair].close_key, i);
  1997. set_caret_column(get_caret_column(i) - auto_brace_completion_pairs[pre_brace_pair].close_key.length(), i == 0, i);
  1998. }
  1999. }
  2000. if (pre_brace_pair == -1 && post_brace_pair == -1 && get_caret_column(i) > 0 && get_caret_column(i) < get_line(caret_line).length()) {
  2001. pre_brace_pair = _get_auto_brace_pair_open_at_pos(caret_line, get_caret_column(i) + 1);
  2002. if (pre_brace_pair != -1 && pre_brace_pair == _get_auto_brace_pair_close_at_pos(caret_line, get_caret_column(i) - 1)) {
  2003. remove_text(caret_line, get_caret_column(i) - 2, caret_line, get_caret_column(i));
  2004. if (_get_auto_brace_pair_close_at_pos(caret_line, get_caret_column(i) + 1) != pre_brace_pair) {
  2005. set_caret_column(get_caret_column(i) + 1, i == 0, i);
  2006. } else {
  2007. set_caret_column(get_caret_column(i) + 2, i == 0, i);
  2008. }
  2009. }
  2010. }
  2011. }
  2012. end_multicaret_edit();
  2013. end_complex_operation();
  2014. cancel_code_completion();
  2015. if (code_completion_prefixes.has(caret_last_completion_char)) {
  2016. request_code_completion();
  2017. }
  2018. }
  2019. void CodeEdit::cancel_code_completion() {
  2020. if (!code_completion_active) {
  2021. return;
  2022. }
  2023. code_completion_forced = false;
  2024. code_completion_active = false;
  2025. is_code_completion_drag_started = false;
  2026. queue_redraw();
  2027. }
  2028. /* Line length guidelines */
  2029. void CodeEdit::set_line_length_guidelines(TypedArray<int> p_guideline_columns) {
  2030. line_length_guideline_columns = p_guideline_columns;
  2031. queue_redraw();
  2032. }
  2033. TypedArray<int> CodeEdit::get_line_length_guidelines() const {
  2034. return line_length_guideline_columns;
  2035. }
  2036. /* Symbol lookup */
  2037. void CodeEdit::set_symbol_lookup_on_click_enabled(bool p_enabled) {
  2038. symbol_lookup_on_click_enabled = p_enabled;
  2039. set_symbol_lookup_word_as_valid(false);
  2040. }
  2041. bool CodeEdit::is_symbol_lookup_on_click_enabled() const {
  2042. return symbol_lookup_on_click_enabled;
  2043. }
  2044. String CodeEdit::get_text_for_symbol_lookup() const {
  2045. Point2i mp = get_local_mouse_pos();
  2046. Point2i pos = get_line_column_at_pos(mp, false, false);
  2047. int line = pos.y;
  2048. int col = pos.x;
  2049. if (line == -1) {
  2050. return String();
  2051. }
  2052. return get_text_with_cursor_char(line, col);
  2053. }
  2054. String CodeEdit::get_text_with_cursor_char(int p_line, int p_column) const {
  2055. const int text_size = get_line_count();
  2056. StringBuilder result;
  2057. for (int i = 0; i < text_size; i++) {
  2058. String line_text = get_line(i);
  2059. if (i == p_line && p_column >= 0 && p_column <= line_text.size()) {
  2060. result += line_text.substr(0, p_column);
  2061. /* Not unicode, represents the cursor. */
  2062. result += String::chr(0xFFFF);
  2063. result += line_text.substr(p_column, line_text.size());
  2064. } else {
  2065. result += line_text;
  2066. }
  2067. if (i != text_size - 1) {
  2068. result += "\n";
  2069. }
  2070. }
  2071. return result.as_string();
  2072. }
  2073. void CodeEdit::set_symbol_lookup_word_as_valid(bool p_valid) {
  2074. symbol_lookup_word = p_valid ? symbol_lookup_new_word : "";
  2075. symbol_lookup_new_word = "";
  2076. if (lookup_symbol_word != symbol_lookup_word) {
  2077. _set_symbol_lookup_word(symbol_lookup_word);
  2078. }
  2079. }
  2080. /* Symbol tooltip */
  2081. void CodeEdit::set_symbol_tooltip_on_hover_enabled(bool p_enabled) {
  2082. symbol_tooltip_on_hover_enabled = p_enabled;
  2083. if (!p_enabled) {
  2084. symbol_tooltip_timer->stop();
  2085. }
  2086. }
  2087. bool CodeEdit::is_symbol_tooltip_on_hover_enabled() const {
  2088. return symbol_tooltip_on_hover_enabled;
  2089. }
  2090. void CodeEdit::_on_symbol_tooltip_timer_timeout() {
  2091. const int line = symbol_tooltip_pos.y;
  2092. const int column = symbol_tooltip_pos.x;
  2093. if (line >= 0 && column >= 0 && !symbol_tooltip_word.is_empty() && !has_selection() && !Input::get_singleton()->is_anything_pressed()) {
  2094. emit_signal(SNAME("symbol_hovered"), symbol_tooltip_word, line, column);
  2095. }
  2096. }
  2097. /* Text manipulation */
  2098. void CodeEdit::move_lines_up() {
  2099. begin_complex_operation();
  2100. begin_multicaret_edit();
  2101. // Move lines up by swapping each line with the one above it.
  2102. Vector<Point2i> line_ranges = get_line_ranges_from_carets();
  2103. for (Point2i line_range : line_ranges) {
  2104. if (line_range.x == 0) {
  2105. continue;
  2106. }
  2107. unfold_line(line_range.x - 1);
  2108. for (int line = line_range.x; line <= line_range.y; line++) {
  2109. unfold_line(line);
  2110. swap_lines(line - 1, line);
  2111. }
  2112. // Fix selection if the last one ends at column 0, since it wasn't moved.
  2113. for (int i = 0; i < get_caret_count(); i++) {
  2114. if (has_selection(i) && get_selection_to_column(i) == 0 && get_selection_to_line(i) == line_range.y + 1) {
  2115. if (is_caret_after_selection_origin(i)) {
  2116. set_caret_line(get_caret_line(i) - 1, false, true, -1, i);
  2117. } else {
  2118. set_selection_origin_line(get_selection_origin_line(i) - 1, true, -1, i);
  2119. }
  2120. break;
  2121. }
  2122. }
  2123. }
  2124. adjust_viewport_to_caret();
  2125. end_multicaret_edit();
  2126. end_complex_operation();
  2127. }
  2128. void CodeEdit::move_lines_down() {
  2129. begin_complex_operation();
  2130. begin_multicaret_edit();
  2131. // Move lines down by swapping each line with the one below it.
  2132. Vector<Point2i> line_ranges = get_line_ranges_from_carets();
  2133. // Reverse in case line ranges are adjacent, if the first ends at column 0.
  2134. line_ranges.reverse();
  2135. for (Point2i line_range : line_ranges) {
  2136. if (line_range.y == get_line_count() - 1) {
  2137. continue;
  2138. }
  2139. // Fix selection if the last one ends at column 0, since it won't be moved.
  2140. bool selection_to_line_at_end = false;
  2141. for (int i = 0; i < get_caret_count(); i++) {
  2142. if (has_selection(i) && get_selection_to_column(i) == 0 && get_selection_to_line(i) == line_range.y + 1) {
  2143. selection_to_line_at_end = get_selection_to_line(i) == get_line_count() - 1;
  2144. if (selection_to_line_at_end) {
  2145. break;
  2146. }
  2147. if (is_caret_after_selection_origin(i)) {
  2148. set_caret_line(get_caret_line(i) + 1, false, true, -1, i);
  2149. } else {
  2150. set_selection_origin_line(get_selection_origin_line(i) + 1, true, -1, i);
  2151. }
  2152. break;
  2153. }
  2154. }
  2155. if (selection_to_line_at_end) {
  2156. continue;
  2157. }
  2158. unfold_line(line_range.y + 1);
  2159. for (int line = line_range.y; line >= line_range.x; line--) {
  2160. unfold_line(line);
  2161. swap_lines(line + 1, line);
  2162. }
  2163. }
  2164. adjust_viewport_to_caret();
  2165. end_multicaret_edit();
  2166. end_complex_operation();
  2167. }
  2168. void CodeEdit::delete_lines() {
  2169. begin_complex_operation();
  2170. begin_multicaret_edit();
  2171. Vector<Point2i> line_ranges = get_line_ranges_from_carets();
  2172. int line_offset = 0;
  2173. for (Point2i line_range : line_ranges) {
  2174. // Remove last line of range separately to preserve carets.
  2175. unfold_line(line_range.y + line_offset);
  2176. remove_line_at(line_range.y + line_offset);
  2177. if (line_range.x != line_range.y) {
  2178. remove_text(line_range.x + line_offset, 0, line_range.y + line_offset, 0);
  2179. }
  2180. line_offset += line_range.x - line_range.y - 1;
  2181. }
  2182. // Deselect all.
  2183. deselect();
  2184. end_multicaret_edit();
  2185. end_complex_operation();
  2186. }
  2187. void CodeEdit::duplicate_selection() {
  2188. begin_complex_operation();
  2189. begin_multicaret_edit();
  2190. // Duplicate lines from carets without selections first.
  2191. for (int i = 0; i < get_caret_count(); i++) {
  2192. if (multicaret_edit_ignore_caret(i)) {
  2193. continue;
  2194. }
  2195. for (int l = get_selection_from_line(i); l <= get_selection_to_line(i); l++) {
  2196. unfold_line(l);
  2197. }
  2198. if (has_selection(i)) {
  2199. continue;
  2200. }
  2201. String text_to_insert = get_line(get_caret_line(i)) + "\n";
  2202. // Insert new text before the line, so the caret is on the second one.
  2203. insert_text(text_to_insert, get_caret_line(i), 0);
  2204. }
  2205. // Duplicate selections.
  2206. for (int i = 0; i < get_caret_count(); i++) {
  2207. if (multicaret_edit_ignore_caret(i)) {
  2208. continue;
  2209. }
  2210. if (!has_selection(i)) {
  2211. continue;
  2212. }
  2213. // Insert new text before the selection, so the caret is on the second one.
  2214. insert_text(get_selected_text(i), get_selection_from_line(i), get_selection_from_column(i));
  2215. }
  2216. end_multicaret_edit();
  2217. end_complex_operation();
  2218. }
  2219. void CodeEdit::duplicate_lines() {
  2220. begin_complex_operation();
  2221. begin_multicaret_edit();
  2222. Vector<Point2i> line_ranges = get_line_ranges_from_carets(false, false);
  2223. int line_offset = 0;
  2224. for (Point2i line_range : line_ranges) {
  2225. // The text that will be inserted. All lines in one string.
  2226. String text_to_insert;
  2227. for (int i = line_range.x + line_offset; i <= line_range.y + line_offset; i++) {
  2228. text_to_insert += get_line(i) + "\n";
  2229. unfold_line(i);
  2230. }
  2231. // Insert new text before the line.
  2232. insert_text(text_to_insert, line_range.x + line_offset, 0);
  2233. line_offset += line_range.y - line_range.x + 1;
  2234. }
  2235. end_multicaret_edit();
  2236. end_complex_operation();
  2237. }
  2238. /* Visual */
  2239. Color CodeEdit::_get_brace_mismatch_color() const {
  2240. return theme_cache.brace_mismatch_color;
  2241. }
  2242. Color CodeEdit::_get_code_folding_color() const {
  2243. return theme_cache.code_folding_color;
  2244. }
  2245. Ref<Texture2D> CodeEdit::_get_folded_eol_icon() const {
  2246. return theme_cache.folded_eol_icon;
  2247. }
  2248. void CodeEdit::_bind_methods() {
  2249. /* Indent management */
  2250. ClassDB::bind_method(D_METHOD("set_indent_size", "size"), &CodeEdit::set_indent_size);
  2251. ClassDB::bind_method(D_METHOD("get_indent_size"), &CodeEdit::get_indent_size);
  2252. ClassDB::bind_method(D_METHOD("set_indent_using_spaces", "use_spaces"), &CodeEdit::set_indent_using_spaces);
  2253. ClassDB::bind_method(D_METHOD("is_indent_using_spaces"), &CodeEdit::is_indent_using_spaces);
  2254. ClassDB::bind_method(D_METHOD("set_auto_indent_enabled", "enable"), &CodeEdit::set_auto_indent_enabled);
  2255. ClassDB::bind_method(D_METHOD("is_auto_indent_enabled"), &CodeEdit::is_auto_indent_enabled);
  2256. ClassDB::bind_method(D_METHOD("set_auto_indent_prefixes", "prefixes"), &CodeEdit::set_auto_indent_prefixes);
  2257. ClassDB::bind_method(D_METHOD("get_auto_indent_prefixes"), &CodeEdit::get_auto_indent_prefixes);
  2258. ClassDB::bind_method(D_METHOD("do_indent"), &CodeEdit::do_indent);
  2259. ClassDB::bind_method(D_METHOD("indent_lines"), &CodeEdit::indent_lines);
  2260. ClassDB::bind_method(D_METHOD("unindent_lines"), &CodeEdit::unindent_lines);
  2261. ClassDB::bind_method(D_METHOD("convert_indent", "from_line", "to_line"), &CodeEdit::convert_indent, DEFVAL(-1), DEFVAL(-1));
  2262. /* Auto brace completion */
  2263. ClassDB::bind_method(D_METHOD("set_auto_brace_completion_enabled", "enable"), &CodeEdit::set_auto_brace_completion_enabled);
  2264. ClassDB::bind_method(D_METHOD("is_auto_brace_completion_enabled"), &CodeEdit::is_auto_brace_completion_enabled);
  2265. ClassDB::bind_method(D_METHOD("set_highlight_matching_braces_enabled", "enable"), &CodeEdit::set_highlight_matching_braces_enabled);
  2266. ClassDB::bind_method(D_METHOD("is_highlight_matching_braces_enabled"), &CodeEdit::is_highlight_matching_braces_enabled);
  2267. ClassDB::bind_method(D_METHOD("add_auto_brace_completion_pair", "start_key", "end_key"), &CodeEdit::add_auto_brace_completion_pair);
  2268. ClassDB::bind_method(D_METHOD("set_auto_brace_completion_pairs", "pairs"), &CodeEdit::set_auto_brace_completion_pairs);
  2269. ClassDB::bind_method(D_METHOD("get_auto_brace_completion_pairs"), &CodeEdit::get_auto_brace_completion_pairs);
  2270. ClassDB::bind_method(D_METHOD("has_auto_brace_completion_open_key", "open_key"), &CodeEdit::has_auto_brace_completion_open_key);
  2271. ClassDB::bind_method(D_METHOD("has_auto_brace_completion_close_key", "close_key"), &CodeEdit::has_auto_brace_completion_close_key);
  2272. ClassDB::bind_method(D_METHOD("get_auto_brace_completion_close_key", "open_key"), &CodeEdit::get_auto_brace_completion_close_key);
  2273. /* Main Gutter */
  2274. ClassDB::bind_method(D_METHOD("set_draw_breakpoints_gutter", "enable"), &CodeEdit::set_draw_breakpoints_gutter);
  2275. ClassDB::bind_method(D_METHOD("is_drawing_breakpoints_gutter"), &CodeEdit::is_drawing_breakpoints_gutter);
  2276. ClassDB::bind_method(D_METHOD("set_draw_bookmarks_gutter", "enable"), &CodeEdit::set_draw_bookmarks_gutter);
  2277. ClassDB::bind_method(D_METHOD("is_drawing_bookmarks_gutter"), &CodeEdit::is_drawing_bookmarks_gutter);
  2278. ClassDB::bind_method(D_METHOD("set_draw_executing_lines_gutter", "enable"), &CodeEdit::set_draw_executing_lines_gutter);
  2279. ClassDB::bind_method(D_METHOD("is_drawing_executing_lines_gutter"), &CodeEdit::is_drawing_executing_lines_gutter);
  2280. // Breakpoints
  2281. ClassDB::bind_method(D_METHOD("set_line_as_breakpoint", "line", "breakpointed"), &CodeEdit::set_line_as_breakpoint);
  2282. ClassDB::bind_method(D_METHOD("is_line_breakpointed", "line"), &CodeEdit::is_line_breakpointed);
  2283. ClassDB::bind_method(D_METHOD("clear_breakpointed_lines"), &CodeEdit::clear_breakpointed_lines);
  2284. ClassDB::bind_method(D_METHOD("get_breakpointed_lines"), &CodeEdit::get_breakpointed_lines);
  2285. // Bookmarks
  2286. ClassDB::bind_method(D_METHOD("set_line_as_bookmarked", "line", "bookmarked"), &CodeEdit::set_line_as_bookmarked);
  2287. ClassDB::bind_method(D_METHOD("is_line_bookmarked", "line"), &CodeEdit::is_line_bookmarked);
  2288. ClassDB::bind_method(D_METHOD("clear_bookmarked_lines"), &CodeEdit::clear_bookmarked_lines);
  2289. ClassDB::bind_method(D_METHOD("get_bookmarked_lines"), &CodeEdit::get_bookmarked_lines);
  2290. // Executing lines
  2291. ClassDB::bind_method(D_METHOD("set_line_as_executing", "line", "executing"), &CodeEdit::set_line_as_executing);
  2292. ClassDB::bind_method(D_METHOD("is_line_executing", "line"), &CodeEdit::is_line_executing);
  2293. ClassDB::bind_method(D_METHOD("clear_executing_lines"), &CodeEdit::clear_executing_lines);
  2294. ClassDB::bind_method(D_METHOD("get_executing_lines"), &CodeEdit::get_executing_lines);
  2295. /* Line numbers */
  2296. ClassDB::bind_method(D_METHOD("set_draw_line_numbers", "enable"), &CodeEdit::set_draw_line_numbers);
  2297. ClassDB::bind_method(D_METHOD("is_draw_line_numbers_enabled"), &CodeEdit::is_draw_line_numbers_enabled);
  2298. ClassDB::bind_method(D_METHOD("set_line_numbers_zero_padded", "enable"), &CodeEdit::set_line_numbers_zero_padded);
  2299. ClassDB::bind_method(D_METHOD("is_line_numbers_zero_padded"), &CodeEdit::is_line_numbers_zero_padded);
  2300. /* Fold Gutter */
  2301. ClassDB::bind_method(D_METHOD("set_draw_fold_gutter", "enable"), &CodeEdit::set_draw_fold_gutter);
  2302. ClassDB::bind_method(D_METHOD("is_drawing_fold_gutter"), &CodeEdit::is_drawing_fold_gutter);
  2303. /* Line folding */
  2304. ClassDB::bind_method(D_METHOD("set_line_folding_enabled", "enabled"), &CodeEdit::set_line_folding_enabled);
  2305. ClassDB::bind_method(D_METHOD("is_line_folding_enabled"), &CodeEdit::is_line_folding_enabled);
  2306. ClassDB::bind_method(D_METHOD("can_fold_line", "line"), &CodeEdit::can_fold_line);
  2307. ClassDB::bind_method(D_METHOD("fold_line", "line"), &CodeEdit::fold_line);
  2308. ClassDB::bind_method(D_METHOD("unfold_line", "line"), &CodeEdit::unfold_line);
  2309. ClassDB::bind_method(D_METHOD("fold_all_lines"), &CodeEdit::fold_all_lines);
  2310. ClassDB::bind_method(D_METHOD("unfold_all_lines"), &CodeEdit::unfold_all_lines);
  2311. ClassDB::bind_method(D_METHOD("toggle_foldable_line", "line"), &CodeEdit::toggle_foldable_line);
  2312. ClassDB::bind_method(D_METHOD("toggle_foldable_lines_at_carets"), &CodeEdit::toggle_foldable_lines_at_carets);
  2313. ClassDB::bind_method(D_METHOD("is_line_folded", "line"), &CodeEdit::is_line_folded);
  2314. ClassDB::bind_method(D_METHOD("get_folded_lines"), &CodeEdit::get_folded_lines);
  2315. /* Code region */
  2316. ClassDB::bind_method(D_METHOD("create_code_region"), &CodeEdit::create_code_region);
  2317. ClassDB::bind_method(D_METHOD("get_code_region_start_tag"), &CodeEdit::get_code_region_start_tag);
  2318. ClassDB::bind_method(D_METHOD("get_code_region_end_tag"), &CodeEdit::get_code_region_end_tag);
  2319. ClassDB::bind_method(D_METHOD("set_code_region_tags", "start", "end"), &CodeEdit::set_code_region_tags, DEFVAL("region"), DEFVAL("endregion"));
  2320. ClassDB::bind_method(D_METHOD("is_line_code_region_start", "line"), &CodeEdit::is_line_code_region_start);
  2321. ClassDB::bind_method(D_METHOD("is_line_code_region_end", "line"), &CodeEdit::is_line_code_region_end);
  2322. /* Delimiters */
  2323. // Strings
  2324. ClassDB::bind_method(D_METHOD("add_string_delimiter", "start_key", "end_key", "line_only"), &CodeEdit::add_string_delimiter, DEFVAL(false));
  2325. ClassDB::bind_method(D_METHOD("remove_string_delimiter", "start_key"), &CodeEdit::remove_string_delimiter);
  2326. ClassDB::bind_method(D_METHOD("has_string_delimiter", "start_key"), &CodeEdit::has_string_delimiter);
  2327. ClassDB::bind_method(D_METHOD("set_string_delimiters", "string_delimiters"), &CodeEdit::set_string_delimiters);
  2328. ClassDB::bind_method(D_METHOD("clear_string_delimiters"), &CodeEdit::clear_string_delimiters);
  2329. ClassDB::bind_method(D_METHOD("get_string_delimiters"), &CodeEdit::get_string_delimiters);
  2330. ClassDB::bind_method(D_METHOD("is_in_string", "line", "column"), &CodeEdit::is_in_string, DEFVAL(-1));
  2331. // Comments
  2332. ClassDB::bind_method(D_METHOD("add_comment_delimiter", "start_key", "end_key", "line_only"), &CodeEdit::add_comment_delimiter, DEFVAL(false));
  2333. ClassDB::bind_method(D_METHOD("remove_comment_delimiter", "start_key"), &CodeEdit::remove_comment_delimiter);
  2334. ClassDB::bind_method(D_METHOD("has_comment_delimiter", "start_key"), &CodeEdit::has_comment_delimiter);
  2335. ClassDB::bind_method(D_METHOD("set_comment_delimiters", "comment_delimiters"), &CodeEdit::set_comment_delimiters);
  2336. ClassDB::bind_method(D_METHOD("clear_comment_delimiters"), &CodeEdit::clear_comment_delimiters);
  2337. ClassDB::bind_method(D_METHOD("get_comment_delimiters"), &CodeEdit::get_comment_delimiters);
  2338. ClassDB::bind_method(D_METHOD("is_in_comment", "line", "column"), &CodeEdit::is_in_comment, DEFVAL(-1));
  2339. // Util
  2340. ClassDB::bind_method(D_METHOD("get_delimiter_start_key", "delimiter_index"), &CodeEdit::get_delimiter_start_key);
  2341. ClassDB::bind_method(D_METHOD("get_delimiter_end_key", "delimiter_index"), &CodeEdit::get_delimiter_end_key);
  2342. ClassDB::bind_method(D_METHOD("get_delimiter_start_position", "line", "column"), &CodeEdit::get_delimiter_start_position);
  2343. ClassDB::bind_method(D_METHOD("get_delimiter_end_position", "line", "column"), &CodeEdit::get_delimiter_end_position);
  2344. /* Code hint */
  2345. ClassDB::bind_method(D_METHOD("set_code_hint", "code_hint"), &CodeEdit::set_code_hint);
  2346. ClassDB::bind_method(D_METHOD("set_code_hint_draw_below", "draw_below"), &CodeEdit::set_code_hint_draw_below);
  2347. /* Code Completion */
  2348. BIND_ENUM_CONSTANT(KIND_CLASS);
  2349. BIND_ENUM_CONSTANT(KIND_FUNCTION);
  2350. BIND_ENUM_CONSTANT(KIND_SIGNAL);
  2351. BIND_ENUM_CONSTANT(KIND_VARIABLE);
  2352. BIND_ENUM_CONSTANT(KIND_MEMBER);
  2353. BIND_ENUM_CONSTANT(KIND_ENUM);
  2354. BIND_ENUM_CONSTANT(KIND_CONSTANT);
  2355. BIND_ENUM_CONSTANT(KIND_NODE_PATH);
  2356. BIND_ENUM_CONSTANT(KIND_FILE_PATH);
  2357. BIND_ENUM_CONSTANT(KIND_PLAIN_TEXT);
  2358. BIND_ENUM_CONSTANT(LOCATION_LOCAL);
  2359. BIND_ENUM_CONSTANT(LOCATION_PARENT_MASK);
  2360. BIND_ENUM_CONSTANT(LOCATION_OTHER_USER_CODE)
  2361. BIND_ENUM_CONSTANT(LOCATION_OTHER);
  2362. ClassDB::bind_method(D_METHOD("get_text_for_code_completion"), &CodeEdit::get_text_for_code_completion);
  2363. ClassDB::bind_method(D_METHOD("request_code_completion", "force"), &CodeEdit::request_code_completion, DEFVAL(false));
  2364. ClassDB::bind_method(D_METHOD("add_code_completion_option", "type", "display_text", "insert_text", "text_color", "icon", "value", "location"), &CodeEdit::add_code_completion_option, DEFVAL(Color(1, 1, 1)), DEFVAL(Ref<Resource>()), DEFVAL(Variant()), DEFVAL(LOCATION_OTHER));
  2365. ClassDB::bind_method(D_METHOD("update_code_completion_options", "force"), &CodeEdit::update_code_completion_options);
  2366. ClassDB::bind_method(D_METHOD("get_code_completion_options"), &CodeEdit::get_code_completion_options);
  2367. ClassDB::bind_method(D_METHOD("get_code_completion_option", "index"), &CodeEdit::get_code_completion_option);
  2368. ClassDB::bind_method(D_METHOD("get_code_completion_selected_index"), &CodeEdit::get_code_completion_selected_index);
  2369. ClassDB::bind_method(D_METHOD("set_code_completion_selected_index", "index"), &CodeEdit::set_code_completion_selected_index);
  2370. ClassDB::bind_method(D_METHOD("confirm_code_completion", "replace"), &CodeEdit::confirm_code_completion, DEFVAL(false));
  2371. ClassDB::bind_method(D_METHOD("cancel_code_completion"), &CodeEdit::cancel_code_completion);
  2372. ClassDB::bind_method(D_METHOD("set_code_completion_enabled", "enable"), &CodeEdit::set_code_completion_enabled);
  2373. ClassDB::bind_method(D_METHOD("is_code_completion_enabled"), &CodeEdit::is_code_completion_enabled);
  2374. ClassDB::bind_method(D_METHOD("set_code_completion_prefixes", "prefixes"), &CodeEdit::set_code_completion_prefixes);
  2375. ClassDB::bind_method(D_METHOD("get_code_completion_prefixes"), &CodeEdit::get_code_completion_prefixes);
  2376. // Overridable
  2377. GDVIRTUAL_BIND(_confirm_code_completion, "replace")
  2378. GDVIRTUAL_BIND(_request_code_completion, "force")
  2379. GDVIRTUAL_BIND(_filter_code_completion_candidates, "candidates")
  2380. /* Line length guidelines */
  2381. ClassDB::bind_method(D_METHOD("set_line_length_guidelines", "guideline_columns"), &CodeEdit::set_line_length_guidelines);
  2382. ClassDB::bind_method(D_METHOD("get_line_length_guidelines"), &CodeEdit::get_line_length_guidelines);
  2383. /* Symbol lookup */
  2384. ClassDB::bind_method(D_METHOD("set_symbol_lookup_on_click_enabled", "enable"), &CodeEdit::set_symbol_lookup_on_click_enabled);
  2385. ClassDB::bind_method(D_METHOD("is_symbol_lookup_on_click_enabled"), &CodeEdit::is_symbol_lookup_on_click_enabled);
  2386. ClassDB::bind_method(D_METHOD("get_text_for_symbol_lookup"), &CodeEdit::get_text_for_symbol_lookup);
  2387. ClassDB::bind_method(D_METHOD("get_text_with_cursor_char", "line", "column"), &CodeEdit::get_text_with_cursor_char);
  2388. ClassDB::bind_method(D_METHOD("set_symbol_lookup_word_as_valid", "valid"), &CodeEdit::set_symbol_lookup_word_as_valid);
  2389. /* Symbol tooltip */
  2390. ClassDB::bind_method(D_METHOD("set_symbol_tooltip_on_hover_enabled", "enable"), &CodeEdit::set_symbol_tooltip_on_hover_enabled);
  2391. ClassDB::bind_method(D_METHOD("is_symbol_tooltip_on_hover_enabled"), &CodeEdit::is_symbol_tooltip_on_hover_enabled);
  2392. /* Text manipulation */
  2393. ClassDB::bind_method(D_METHOD("move_lines_up"), &CodeEdit::move_lines_up);
  2394. ClassDB::bind_method(D_METHOD("move_lines_down"), &CodeEdit::move_lines_down);
  2395. ClassDB::bind_method(D_METHOD("delete_lines"), &CodeEdit::delete_lines);
  2396. ClassDB::bind_method(D_METHOD("duplicate_selection"), &CodeEdit::duplicate_selection);
  2397. ClassDB::bind_method(D_METHOD("duplicate_lines"), &CodeEdit::duplicate_lines);
  2398. /* Inspector */
  2399. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "symbol_lookup_on_click"), "set_symbol_lookup_on_click_enabled", "is_symbol_lookup_on_click_enabled");
  2400. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "symbol_tooltip_on_hover"), "set_symbol_tooltip_on_hover_enabled", "is_symbol_tooltip_on_hover_enabled");
  2401. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "line_folding"), "set_line_folding_enabled", "is_line_folding_enabled");
  2402. ADD_PROPERTY(PropertyInfo(Variant::PACKED_INT32_ARRAY, "line_length_guidelines"), "set_line_length_guidelines", "get_line_length_guidelines");
  2403. ADD_GROUP("Gutters", "gutters_");
  2404. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_breakpoints_gutter"), "set_draw_breakpoints_gutter", "is_drawing_breakpoints_gutter");
  2405. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_bookmarks"), "set_draw_bookmarks_gutter", "is_drawing_bookmarks_gutter");
  2406. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_executing_lines"), "set_draw_executing_lines_gutter", "is_drawing_executing_lines_gutter");
  2407. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_line_numbers"), "set_draw_line_numbers", "is_draw_line_numbers_enabled");
  2408. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_zero_pad_line_numbers"), "set_line_numbers_zero_padded", "is_line_numbers_zero_padded");
  2409. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_fold_gutter"), "set_draw_fold_gutter", "is_drawing_fold_gutter");
  2410. ADD_GROUP("Delimiters", "delimiter_");
  2411. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "delimiter_strings"), "set_string_delimiters", "get_string_delimiters");
  2412. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "delimiter_comments"), "set_comment_delimiters", "get_comment_delimiters");
  2413. ADD_GROUP("Code Completion", "code_completion_");
  2414. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "code_completion_enabled"), "set_code_completion_enabled", "is_code_completion_enabled");
  2415. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "code_completion_prefixes"), "set_code_completion_prefixes", "get_code_completion_prefixes");
  2416. ADD_GROUP("Indentation", "indent_");
  2417. ADD_PROPERTY(PropertyInfo(Variant::INT, "indent_size"), "set_indent_size", "get_indent_size");
  2418. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "indent_use_spaces"), "set_indent_using_spaces", "is_indent_using_spaces");
  2419. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "indent_automatic"), "set_auto_indent_enabled", "is_auto_indent_enabled");
  2420. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "indent_automatic_prefixes"), "set_auto_indent_prefixes", "get_auto_indent_prefixes");
  2421. ADD_GROUP("Auto Brace Completion", "auto_brace_completion_");
  2422. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "auto_brace_completion_enabled"), "set_auto_brace_completion_enabled", "is_auto_brace_completion_enabled");
  2423. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "auto_brace_completion_highlight_matching"), "set_highlight_matching_braces_enabled", "is_highlight_matching_braces_enabled");
  2424. ADD_PROPERTY(PropertyInfo(Variant::DICTIONARY, "auto_brace_completion_pairs"), "set_auto_brace_completion_pairs", "get_auto_brace_completion_pairs");
  2425. /* Signals */
  2426. /* Gutters */
  2427. ADD_SIGNAL(MethodInfo("breakpoint_toggled", PropertyInfo(Variant::INT, "line")));
  2428. /* Code Completion */
  2429. ADD_SIGNAL(MethodInfo("code_completion_requested"));
  2430. /* Symbol lookup */
  2431. ADD_SIGNAL(MethodInfo("symbol_lookup", PropertyInfo(Variant::STRING, "symbol"), PropertyInfo(Variant::INT, "line"), PropertyInfo(Variant::INT, "column")));
  2432. ADD_SIGNAL(MethodInfo("symbol_validate", PropertyInfo(Variant::STRING, "symbol")));
  2433. /* Symbol tooltip */
  2434. ADD_SIGNAL(MethodInfo("symbol_hovered", PropertyInfo(Variant::STRING, "symbol"), PropertyInfo(Variant::INT, "line"), PropertyInfo(Variant::INT, "column")));
  2435. /* Theme items */
  2436. /* Gutters */
  2437. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, code_folding_color);
  2438. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, folded_code_region_color);
  2439. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, can_fold_icon, "can_fold");
  2440. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, folded_icon, "folded");
  2441. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, can_fold_code_region_icon, "can_fold_code_region");
  2442. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, folded_code_region_icon, "folded_code_region");
  2443. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, CodeEdit, folded_eol_icon);
  2444. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, CodeEdit, completion_color_bg);
  2445. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, breakpoint_color);
  2446. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, breakpoint_icon, "breakpoint");
  2447. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, bookmark_color);
  2448. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, bookmark_icon, "bookmark");
  2449. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, executing_line_color);
  2450. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, executing_line_icon, "executing_line");
  2451. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, line_number_color);
  2452. /* Code Completion */
  2453. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_STYLEBOX, CodeEdit, code_completion_style, "completion");
  2454. BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_CONSTANT, CodeEdit, code_completion_icon_separation, "h_separation", "ItemList");
  2455. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_CONSTANT, CodeEdit, code_completion_max_width, "completion_max_width");
  2456. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_CONSTANT, CodeEdit, code_completion_max_lines, "completion_lines");
  2457. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_CONSTANT, CodeEdit, code_completion_scroll_width, "completion_scroll_width");
  2458. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_COLOR, CodeEdit, code_completion_scroll_color, "completion_scroll_color");
  2459. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_COLOR, CodeEdit, code_completion_scroll_hovered_color, "completion_scroll_hovered_color");
  2460. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_COLOR, CodeEdit, code_completion_background_color, "completion_background_color");
  2461. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_COLOR, CodeEdit, code_completion_selected_color, "completion_selected_color");
  2462. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_COLOR, CodeEdit, code_completion_existing_color, "completion_existing_color");
  2463. /* Code hint */
  2464. BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_STYLEBOX, CodeEdit, code_hint_style, "panel", "TooltipPanel");
  2465. BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, CodeEdit, code_hint_color, "font_color", "TooltipLabel");
  2466. /* Line length guideline */
  2467. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, line_length_guideline_color);
  2468. /* Other visuals */
  2469. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_STYLEBOX, CodeEdit, style_normal, "normal");
  2470. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, brace_mismatch_color);
  2471. BIND_THEME_ITEM(Theme::DATA_TYPE_FONT, CodeEdit, font);
  2472. BIND_THEME_ITEM(Theme::DATA_TYPE_FONT_SIZE, CodeEdit, font_size);
  2473. BIND_THEME_ITEM(Theme::DATA_TYPE_CONSTANT, CodeEdit, line_spacing);
  2474. }
  2475. /* Auto brace completion */
  2476. int CodeEdit::_get_auto_brace_pair_open_at_pos(int p_line, int p_col) {
  2477. const String &line = get_line(p_line);
  2478. /* Should be fast enough, expecting low amount of pairs... */
  2479. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  2480. const String &open_key = auto_brace_completion_pairs[i].open_key;
  2481. if (p_col - open_key.length() < 0) {
  2482. continue;
  2483. }
  2484. bool is_match = true;
  2485. for (int j = 0; j < open_key.length(); j++) {
  2486. if (line[(p_col - 1) - j] != open_key[(open_key.length() - 1) - j]) {
  2487. is_match = false;
  2488. break;
  2489. }
  2490. }
  2491. if (is_match) {
  2492. return i;
  2493. }
  2494. }
  2495. return -1;
  2496. }
  2497. int CodeEdit::_get_auto_brace_pair_close_at_pos(int p_line, int p_col) {
  2498. const String &line = get_line(p_line);
  2499. /* Should be fast enough, expecting low amount of pairs... */
  2500. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  2501. if (p_col + auto_brace_completion_pairs[i].close_key.length() > line.length()) {
  2502. continue;
  2503. }
  2504. bool is_match = true;
  2505. for (int j = 0; j < auto_brace_completion_pairs[i].close_key.length(); j++) {
  2506. if (line[p_col + j] != auto_brace_completion_pairs[i].close_key[j]) {
  2507. is_match = false;
  2508. break;
  2509. }
  2510. }
  2511. if (is_match) {
  2512. return i;
  2513. }
  2514. }
  2515. return -1;
  2516. }
  2517. /* Gutters */
  2518. void CodeEdit::_gutter_clicked(int p_line, int p_gutter) {
  2519. bool shift_pressed = Input::get_singleton()->is_key_pressed(Key::SHIFT);
  2520. if (p_gutter == main_gutter) {
  2521. if (draw_breakpoints && !shift_pressed) {
  2522. set_line_as_breakpoint(p_line, !is_line_breakpointed(p_line));
  2523. } else if (draw_bookmarks && shift_pressed) {
  2524. set_line_as_bookmarked(p_line, !is_line_bookmarked(p_line));
  2525. }
  2526. return;
  2527. }
  2528. if (p_gutter == line_number_gutter) {
  2529. remove_secondary_carets();
  2530. set_selection_mode(TextEdit::SelectionMode::SELECTION_MODE_LINE);
  2531. if (p_line == get_line_count() - 1) {
  2532. select(p_line, 0, p_line, INT_MAX);
  2533. } else {
  2534. select(p_line, 0, p_line + 1, 0);
  2535. }
  2536. return;
  2537. }
  2538. if (p_gutter == fold_gutter) {
  2539. if (is_line_folded(p_line)) {
  2540. unfold_line(p_line);
  2541. } else if (can_fold_line(p_line)) {
  2542. fold_line(p_line);
  2543. }
  2544. return;
  2545. }
  2546. }
  2547. void CodeEdit::_update_gutter_indexes() {
  2548. for (int i = 0; i < get_gutter_count(); i++) {
  2549. if (get_gutter_name(i) == "main_gutter") {
  2550. main_gutter = i;
  2551. continue;
  2552. }
  2553. if (get_gutter_name(i) == "line_numbers") {
  2554. line_number_gutter = i;
  2555. continue;
  2556. }
  2557. if (get_gutter_name(i) == "fold_gutter") {
  2558. fold_gutter = i;
  2559. continue;
  2560. }
  2561. }
  2562. }
  2563. /* Code Region */
  2564. void CodeEdit::_update_code_region_tags() {
  2565. code_region_start_string = "";
  2566. code_region_end_string = "";
  2567. if (code_region_start_tag.is_empty() || code_region_end_tag.is_empty()) {
  2568. return;
  2569. }
  2570. // A shorter delimiter has higher priority.
  2571. for (int i = delimiters.size() - 1; i >= 0; i--) {
  2572. if (delimiters[i].type != DelimiterType::TYPE_COMMENT) {
  2573. continue;
  2574. }
  2575. if (delimiters[i].end_key.is_empty() && delimiters[i].line_only == true) {
  2576. code_region_start_string = delimiters[i].start_key + code_region_start_tag;
  2577. code_region_end_string = delimiters[i].start_key + code_region_end_tag;
  2578. return;
  2579. }
  2580. }
  2581. }
  2582. /* Delimiters */
  2583. void CodeEdit::_update_delimiter_cache(int p_from_line, int p_to_line) {
  2584. if (delimiters.size() == 0) {
  2585. return;
  2586. }
  2587. int line_count = get_line_count();
  2588. if (p_to_line == -1) {
  2589. p_to_line = line_count;
  2590. }
  2591. int start_line = MIN(p_from_line, p_to_line);
  2592. int end_line = MAX(p_from_line, p_to_line);
  2593. /* Make sure delimiter_cache has all the lines. */
  2594. if (start_line != end_line) {
  2595. if (p_to_line < p_from_line) {
  2596. for (int i = end_line; i > start_line; i--) {
  2597. delimiter_cache.remove_at(i);
  2598. }
  2599. } else {
  2600. for (int i = start_line; i < end_line; i++) {
  2601. delimiter_cache.insert(i, RBMap<int, int>());
  2602. }
  2603. }
  2604. }
  2605. int in_region = -1;
  2606. for (int i = start_line; i < MIN(end_line + 1, line_count); i++) {
  2607. int current_end_region = (i < 0 || delimiter_cache[i].size() < 1) ? -1 : delimiter_cache[i].back()->value();
  2608. in_region = (i <= 0 || delimiter_cache[i - 1].size() < 1) ? -1 : delimiter_cache[i - 1].back()->value();
  2609. const String &str = get_line(i);
  2610. const int line_length = str.length();
  2611. delimiter_cache.write[i].clear();
  2612. if (str.length() == 0) {
  2613. if (in_region != -1) {
  2614. delimiter_cache.write[i][0] = in_region;
  2615. }
  2616. if (i == end_line && current_end_region != in_region) {
  2617. end_line++;
  2618. end_line = MIN(end_line, line_count);
  2619. }
  2620. continue;
  2621. }
  2622. int end_region = -1;
  2623. for (int j = 0; j < line_length; j++) {
  2624. int from = j;
  2625. for (; from < line_length; from++) {
  2626. if (str[from] == '\\') {
  2627. from++;
  2628. continue;
  2629. }
  2630. break;
  2631. }
  2632. /* check if we are in entering a region */
  2633. bool same_line = false;
  2634. if (in_region == -1) {
  2635. for (int d = 0; d < delimiters.size(); d++) {
  2636. /* check there is enough room */
  2637. int chars_left = line_length - from;
  2638. int start_key_length = delimiters[d].start_key.length();
  2639. int end_key_length = delimiters[d].end_key.length();
  2640. if (chars_left < start_key_length) {
  2641. continue;
  2642. }
  2643. /* search the line */
  2644. bool match = true;
  2645. const char32_t *start_key = delimiters[d].start_key.get_data();
  2646. for (int k = 0; k < start_key_length; k++) {
  2647. if (start_key[k] != str[from + k]) {
  2648. match = false;
  2649. break;
  2650. }
  2651. }
  2652. if (!match) {
  2653. continue;
  2654. }
  2655. same_line = true;
  2656. in_region = d;
  2657. delimiter_cache.write[i][from + 1] = d;
  2658. from += start_key_length;
  2659. /* check if it's the whole line */
  2660. if (end_key_length == 0 || delimiters[d].line_only || from + end_key_length > line_length) {
  2661. j = line_length;
  2662. if (delimiters[d].line_only) {
  2663. delimiter_cache.write[i][line_length + 1] = -1;
  2664. } else {
  2665. end_region = in_region;
  2666. }
  2667. }
  2668. break;
  2669. }
  2670. if (j == line_length || in_region == -1) {
  2671. continue;
  2672. }
  2673. }
  2674. /* if we are in one find the end key */
  2675. /* search the line */
  2676. int region_end_index = -1;
  2677. int end_key_length = delimiters[in_region].end_key.length();
  2678. const char32_t *end_key = delimiters[in_region].end_key.get_data();
  2679. for (; from < line_length; from++) {
  2680. if (line_length - from < end_key_length) {
  2681. break;
  2682. }
  2683. if (!is_symbol(str[from])) {
  2684. continue;
  2685. }
  2686. if (str[from] == '\\') {
  2687. from++;
  2688. continue;
  2689. }
  2690. region_end_index = from;
  2691. for (int k = 0; k < end_key_length; k++) {
  2692. if (end_key[k] != str[from + k]) {
  2693. region_end_index = -1;
  2694. break;
  2695. }
  2696. }
  2697. if (region_end_index != -1) {
  2698. break;
  2699. }
  2700. }
  2701. j = from + (end_key_length - 1);
  2702. end_region = (region_end_index == -1) ? in_region : -1;
  2703. if (!same_line || region_end_index != -1) {
  2704. delimiter_cache.write[i][j + 1] = end_region;
  2705. }
  2706. in_region = -1;
  2707. }
  2708. if (i == end_line && current_end_region != end_region) {
  2709. end_line++;
  2710. end_line = MIN(end_line, line_count);
  2711. }
  2712. }
  2713. }
  2714. int CodeEdit::_is_in_delimiter(int p_line, int p_column, DelimiterType p_type) const {
  2715. if (delimiters.size() == 0 || p_line >= delimiter_cache.size()) {
  2716. return -1;
  2717. }
  2718. ERR_FAIL_INDEX_V(p_line, get_line_count(), 0);
  2719. int region = (p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->value();
  2720. bool in_region = region != -1 && delimiters[region].type == p_type;
  2721. for (RBMap<int, int>::Element *E = delimiter_cache[p_line].front(); E; E = E->next()) {
  2722. /* If column is specified, loop until the key is larger then the column. */
  2723. if (p_column != -1) {
  2724. if (E->key() > p_column) {
  2725. break;
  2726. }
  2727. in_region = E->value() != -1 && delimiters[E->value()].type == p_type;
  2728. region = in_region ? E->value() : -1;
  2729. continue;
  2730. }
  2731. /* If no column, calculate if the entire line is a region */
  2732. /* excluding whitespace. */
  2733. const String line = get_line(p_line);
  2734. if (!in_region) {
  2735. if (E->value() == -1 || delimiters[E->value()].type != p_type) {
  2736. break;
  2737. }
  2738. region = E->value();
  2739. in_region = true;
  2740. for (int i = E->key() - 2; i >= 0; i--) {
  2741. if (!is_whitespace(line[i])) {
  2742. return -1;
  2743. }
  2744. }
  2745. }
  2746. if (delimiters[region].line_only) {
  2747. return region;
  2748. }
  2749. int end_col = E->key();
  2750. if (E->value() != -1) {
  2751. if (!E->next()) {
  2752. return region;
  2753. }
  2754. end_col = E->next()->key();
  2755. }
  2756. for (int i = end_col; i < line.length(); i++) {
  2757. if (!is_whitespace(line[i])) {
  2758. return -1;
  2759. }
  2760. }
  2761. return region;
  2762. }
  2763. return in_region ? region : -1;
  2764. }
  2765. void CodeEdit::_add_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only, DelimiterType p_type) {
  2766. // If we are the editor allow "null" as a valid start key, otherwise users cannot add delimiters via the inspector.
  2767. if (!(Engine::get_singleton()->is_editor_hint() && p_start_key == "null")) {
  2768. ERR_FAIL_COND_MSG(p_start_key.is_empty(), "delimiter start key cannot be empty");
  2769. for (int i = 0; i < p_start_key.length(); i++) {
  2770. ERR_FAIL_COND_MSG(!is_symbol(p_start_key[i]), "delimiter must start with a symbol");
  2771. }
  2772. }
  2773. if (p_end_key.length() > 0) {
  2774. for (int i = 0; i < p_end_key.length(); i++) {
  2775. ERR_FAIL_COND_MSG(!is_symbol(p_end_key[i]), "delimiter must end with a symbol");
  2776. }
  2777. }
  2778. int at = 0;
  2779. for (int i = 0; i < delimiters.size(); i++) {
  2780. ERR_FAIL_COND_MSG(delimiters[i].start_key == p_start_key, "delimiter with start key '" + p_start_key + "' already exists.");
  2781. if (p_start_key.length() < delimiters[i].start_key.length()) {
  2782. at++;
  2783. } else {
  2784. break;
  2785. }
  2786. }
  2787. Delimiter delimiter;
  2788. delimiter.type = p_type;
  2789. delimiter.start_key = p_start_key;
  2790. delimiter.end_key = p_end_key;
  2791. delimiter.line_only = p_line_only || p_end_key.is_empty();
  2792. delimiters.insert(at, delimiter);
  2793. if (!setting_delimiters) {
  2794. delimiter_cache.clear();
  2795. _update_delimiter_cache();
  2796. }
  2797. if (p_type == DelimiterType::TYPE_COMMENT) {
  2798. _update_code_region_tags();
  2799. }
  2800. }
  2801. void CodeEdit::_remove_delimiter(const String &p_start_key, DelimiterType p_type) {
  2802. for (int i = 0; i < delimiters.size(); i++) {
  2803. if (delimiters[i].start_key != p_start_key) {
  2804. continue;
  2805. }
  2806. if (delimiters[i].type != p_type) {
  2807. break;
  2808. }
  2809. delimiters.remove_at(i);
  2810. if (!setting_delimiters) {
  2811. delimiter_cache.clear();
  2812. _update_delimiter_cache();
  2813. }
  2814. if (p_type == DelimiterType::TYPE_COMMENT) {
  2815. _update_code_region_tags();
  2816. }
  2817. break;
  2818. }
  2819. }
  2820. bool CodeEdit::_has_delimiter(const String &p_start_key, DelimiterType p_type) const {
  2821. for (int i = 0; i < delimiters.size(); i++) {
  2822. if (delimiters[i].start_key == p_start_key) {
  2823. return delimiters[i].type == p_type;
  2824. }
  2825. }
  2826. return false;
  2827. }
  2828. void CodeEdit::_set_delimiters(const TypedArray<String> &p_delimiters, DelimiterType p_type) {
  2829. setting_delimiters = true;
  2830. _clear_delimiters(p_type);
  2831. for (int i = 0; i < p_delimiters.size(); i++) {
  2832. String key = p_delimiters[i];
  2833. if (key.is_empty()) {
  2834. continue;
  2835. }
  2836. const String start_key = key.get_slice(" ", 0);
  2837. const String end_key = key.get_slice_count(" ") > 1 ? key.get_slice(" ", 1) : String();
  2838. _add_delimiter(start_key, end_key, end_key.is_empty(), p_type);
  2839. }
  2840. setting_delimiters = false;
  2841. _update_delimiter_cache();
  2842. }
  2843. void CodeEdit::_clear_delimiters(DelimiterType p_type) {
  2844. for (int i = delimiters.size() - 1; i >= 0; i--) {
  2845. if (delimiters[i].type == p_type) {
  2846. delimiters.remove_at(i);
  2847. }
  2848. }
  2849. delimiter_cache.clear();
  2850. if (!setting_delimiters) {
  2851. _update_delimiter_cache();
  2852. }
  2853. if (p_type == DelimiterType::TYPE_COMMENT) {
  2854. _update_code_region_tags();
  2855. }
  2856. }
  2857. TypedArray<String> CodeEdit::_get_delimiters(DelimiterType p_type) const {
  2858. TypedArray<String> r_delimiters;
  2859. for (int i = 0; i < delimiters.size(); i++) {
  2860. if (delimiters[i].type != p_type) {
  2861. continue;
  2862. }
  2863. r_delimiters.push_back(delimiters[i].start_key + (delimiters[i].end_key.is_empty() ? "" : " " + delimiters[i].end_key));
  2864. }
  2865. return r_delimiters;
  2866. }
  2867. /* Code Completion */
  2868. void CodeEdit::_update_scroll_selected_line(float p_mouse_y) {
  2869. float percent = (float)(p_mouse_y - code_completion_scroll_rect.position.y) / code_completion_scroll_rect.size.height;
  2870. percent = CLAMP(percent, 0.0f, 1.0f);
  2871. code_completion_current_selected = (int)(percent * (code_completion_options.size() - 1));
  2872. code_completion_force_item_center = -1;
  2873. code_completion_pan_offset = 0.0f;
  2874. }
  2875. void CodeEdit::_filter_code_completion_candidates_impl() {
  2876. int line_height = get_line_height();
  2877. if (GDVIRTUAL_IS_OVERRIDDEN(_filter_code_completion_candidates)) {
  2878. Vector<ScriptLanguage::CodeCompletionOption> code_completion_options_new;
  2879. code_completion_base = "";
  2880. /* Build options argument. */
  2881. TypedArray<Dictionary> completion_options_sources;
  2882. completion_options_sources.resize(code_completion_option_sources.size());
  2883. int i = 0;
  2884. for (const ScriptLanguage::CodeCompletionOption &E : code_completion_option_sources) {
  2885. Dictionary option;
  2886. option["kind"] = E.kind;
  2887. option["display_text"] = E.display;
  2888. option["insert_text"] = E.insert_text;
  2889. option["font_color"] = E.font_color;
  2890. option["icon"] = E.icon;
  2891. option["default_value"] = E.default_value;
  2892. option["location"] = E.location;
  2893. completion_options_sources[i] = option;
  2894. i++;
  2895. }
  2896. TypedArray<Dictionary> completion_options;
  2897. GDVIRTUAL_CALL(_filter_code_completion_candidates, completion_options_sources, completion_options);
  2898. /* No options to complete, cancel. */
  2899. if (completion_options.size() == 0) {
  2900. cancel_code_completion();
  2901. return;
  2902. }
  2903. /* Convert back into options. */
  2904. int max_width = 0;
  2905. for (i = 0; i < completion_options.size(); i++) {
  2906. ScriptLanguage::CodeCompletionOption option;
  2907. option.kind = (ScriptLanguage::CodeCompletionKind)(int)completion_options[i].get("kind");
  2908. option.display = completion_options[i].get("display_text");
  2909. option.insert_text = completion_options[i].get("insert_text");
  2910. option.font_color = completion_options[i].get("font_color");
  2911. option.icon = completion_options[i].get("icon");
  2912. option.location = completion_options[i].get("location");
  2913. option.default_value = completion_options[i].get("default_value");
  2914. int offset = 0;
  2915. if (option.default_value.get_type() == Variant::COLOR) {
  2916. offset = line_height;
  2917. }
  2918. if (theme_cache.font.is_valid()) {
  2919. max_width = MAX(max_width, theme_cache.font->get_string_size(option.display, HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).width + offset);
  2920. }
  2921. code_completion_options_new.push_back(option);
  2922. }
  2923. if (_should_reset_selected_option_for_new_options(code_completion_options_new)) {
  2924. code_completion_current_selected = 0;
  2925. code_completion_pan_offset = 0.0f;
  2926. }
  2927. code_completion_options = code_completion_options_new;
  2928. code_completion_longest_line = MIN(max_width, theme_cache.code_completion_max_width * theme_cache.font_size);
  2929. code_completion_force_item_center = -1;
  2930. code_completion_active = true;
  2931. queue_redraw();
  2932. return;
  2933. }
  2934. const int caret_line = get_caret_line();
  2935. const int caret_column = get_caret_column();
  2936. const String line = get_line(caret_line);
  2937. ERR_FAIL_INDEX_MSG(caret_column, line.length() + 1, "Caret column exceeds line length.");
  2938. if (caret_column > 0 && line[caret_column - 1] == '(' && !code_completion_forced) {
  2939. cancel_code_completion();
  2940. return;
  2941. }
  2942. /* Get string status, are we in one or at the close. */
  2943. int in_string = is_in_string(caret_line, caret_column);
  2944. int first_quote_col = -1;
  2945. if (in_string != -1) {
  2946. Point2 string_start_pos = get_delimiter_start_position(caret_line, caret_column);
  2947. first_quote_col = (string_start_pos.y == caret_line) ? string_start_pos.x : -1;
  2948. } else if (caret_column > 0) {
  2949. if (is_in_string(caret_line, caret_column - 1) != -1) {
  2950. first_quote_col = caret_column - 1;
  2951. }
  2952. }
  2953. int cofs = caret_column;
  2954. String string_to_complete;
  2955. bool prev_is_word = false;
  2956. /* Cancel if we are at the close of a string. */
  2957. if (caret_column > 0 && in_string == -1 && first_quote_col == cofs - 1) {
  2958. cancel_code_completion();
  2959. return;
  2960. /* In a string, therefore we are trying to complete the string text. */
  2961. } else if (in_string != -1 && first_quote_col != -1) {
  2962. int key_length = delimiters[in_string].start_key.length();
  2963. string_to_complete = line.substr(first_quote_col - key_length, (cofs - first_quote_col) + key_length);
  2964. /* If we have a space, previous word might be a keyword. eg "func |". */
  2965. } else if (cofs > 0 && line[cofs - 1] == ' ') {
  2966. int ofs = cofs - 1;
  2967. while (ofs > 0 && line[ofs] == ' ') {
  2968. ofs--;
  2969. }
  2970. prev_is_word = !is_symbol(line[ofs]);
  2971. /* Otherwise get current word and set cofs to the start. */
  2972. } else {
  2973. int start_cofs = cofs;
  2974. while (cofs > 0 && line[cofs - 1] > 32 && (line[cofs - 1] == '/' || !is_symbol(line[cofs - 1]))) {
  2975. cofs--;
  2976. }
  2977. string_to_complete = line.substr(cofs, start_cofs - cofs);
  2978. }
  2979. /* If all else fails, check for a prefix. */
  2980. /* Single space between caret and prefix is okay. */
  2981. bool prev_is_prefix = false;
  2982. if (cofs > 0 && code_completion_prefixes.has(line[cofs - 1])) {
  2983. prev_is_prefix = true;
  2984. } else if (cofs > 1 && line[cofs - 1] == ' ' && code_completion_prefixes.has(line[cofs - 2])) {
  2985. prev_is_prefix = true;
  2986. }
  2987. if (!prev_is_word && string_to_complete.is_empty() && (cofs == 0 || !prev_is_prefix)) {
  2988. cancel_code_completion();
  2989. return;
  2990. }
  2991. /* Filter Options. */
  2992. /* For now handle only traditional quoted strings. */
  2993. bool single_quote = in_string != -1 && first_quote_col > 0 && delimiters[in_string].start_key == "'";
  2994. Vector<ScriptLanguage::CodeCompletionOption> code_completion_options_new;
  2995. code_completion_base = string_to_complete;
  2996. /* Don't autocomplete setting numerical values. */
  2997. if (code_completion_base.is_numeric()) {
  2998. cancel_code_completion();
  2999. return;
  3000. }
  3001. int max_width = 0;
  3002. String string_to_complete_lower = string_to_complete.to_lower();
  3003. for (ScriptLanguage::CodeCompletionOption &option : code_completion_option_sources) {
  3004. option.matches.clear();
  3005. if (single_quote && option.display.is_quoted()) {
  3006. option.display = option.display.unquote().quote("'");
  3007. }
  3008. int offset = option.default_value.get_type() == Variant::COLOR ? line_height : 0;
  3009. if (in_string != -1) {
  3010. // The completion string may have a literal behind it, which should be removed before re-quoting.
  3011. String literal;
  3012. if (option.insert_text.substr(1).is_quoted()) {
  3013. literal = option.display.left(1);
  3014. option.display = option.display.substr(1);
  3015. option.insert_text = option.insert_text.substr(1);
  3016. }
  3017. String quote = single_quote ? "'" : "\"";
  3018. option.display = literal + (option.display.unquote().quote(quote));
  3019. option.insert_text = literal + (option.insert_text.unquote().quote(quote));
  3020. }
  3021. if (option.display.length() == 0) {
  3022. continue;
  3023. }
  3024. if (string_to_complete.length() == 0) {
  3025. option.get_option_characteristics(string_to_complete);
  3026. code_completion_options_new.push_back(option);
  3027. if (theme_cache.font.is_valid()) {
  3028. max_width = MAX(max_width, theme_cache.font->get_string_size(option.display, HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).width + offset);
  3029. }
  3030. continue;
  3031. }
  3032. String target_lower = option.display.to_lower();
  3033. int long_option = target_lower.size() > 50;
  3034. const char32_t *string_to_complete_char_lower = &string_to_complete_lower[0];
  3035. const char32_t *target_char_lower = &target_lower[0];
  3036. Vector<Vector<Pair<int, int>>> all_possible_subsequence_matches;
  3037. for (int i = 0; *target_char_lower; i++, target_char_lower++) {
  3038. if (*target_char_lower == *string_to_complete_char_lower) {
  3039. all_possible_subsequence_matches.push_back({ { i, 1 } });
  3040. }
  3041. }
  3042. string_to_complete_char_lower++;
  3043. for (int i = 1; *string_to_complete_char_lower && (all_possible_subsequence_matches.size() > 0); i++, string_to_complete_char_lower++) {
  3044. // find all occurrences of ssq_lower to avoid looking everywhere each time
  3045. Vector<int> all_occurrences;
  3046. if (long_option) {
  3047. all_occurrences.push_back(target_lower.find_char(*string_to_complete_char_lower));
  3048. } else {
  3049. for (int j = i; j < target_lower.length(); j++) {
  3050. if (target_lower[j] == *string_to_complete_char_lower) {
  3051. all_occurrences.push_back(j);
  3052. }
  3053. }
  3054. }
  3055. Vector<Vector<Pair<int, int>>> next_subsequence_matches;
  3056. for (Vector<Pair<int, int>> &subsequence_match : all_possible_subsequence_matches) {
  3057. Pair<int, int> match_last_segment = subsequence_match[subsequence_match.size() - 1];
  3058. int next_index = match_last_segment.first + match_last_segment.second;
  3059. // get the last index from current sequence
  3060. // and look for next char starting from that index
  3061. if (target_lower[next_index] == *string_to_complete_char_lower) {
  3062. Vector<Pair<int, int>> new_match = subsequence_match;
  3063. new_match.write[new_match.size() - 1].second++;
  3064. next_subsequence_matches.push_back(new_match);
  3065. if (long_option) {
  3066. continue;
  3067. }
  3068. }
  3069. for (int index : all_occurrences) {
  3070. if (index > next_index) {
  3071. Vector<Pair<int, int>> new_match = subsequence_match;
  3072. new_match.push_back({ index, 1 });
  3073. next_subsequence_matches.push_back(new_match);
  3074. }
  3075. }
  3076. }
  3077. all_possible_subsequence_matches = next_subsequence_matches;
  3078. }
  3079. // go through all possible matches to get the best one as defined by CodeCompletionOptionCompare
  3080. if (all_possible_subsequence_matches.size() > 0) {
  3081. option.matches = all_possible_subsequence_matches[0];
  3082. option.get_option_characteristics(string_to_complete);
  3083. all_possible_subsequence_matches = all_possible_subsequence_matches.slice(1);
  3084. if (all_possible_subsequence_matches.size() > 0) {
  3085. CodeCompletionOptionCompare compare;
  3086. ScriptLanguage::CodeCompletionOption compared_option = option;
  3087. compared_option.clear_characteristics();
  3088. for (Vector<Pair<int, int>> &matches : all_possible_subsequence_matches) {
  3089. compared_option.matches = matches;
  3090. compared_option.get_option_characteristics(string_to_complete);
  3091. if (compare(compared_option, option)) {
  3092. option = compared_option;
  3093. compared_option.clear_characteristics();
  3094. }
  3095. }
  3096. }
  3097. code_completion_options_new.push_back(option);
  3098. if (theme_cache.font.is_valid()) {
  3099. max_width = MAX(max_width, theme_cache.font->get_string_size(option.display, HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).width + offset);
  3100. }
  3101. }
  3102. }
  3103. /* No options to complete, cancel. */
  3104. if (code_completion_options_new.size() == 0) {
  3105. cancel_code_completion();
  3106. return;
  3107. }
  3108. /* A perfect match, stop completion. */
  3109. if (code_completion_options_new.size() == 1 && string_to_complete == code_completion_options_new[0].display) {
  3110. cancel_code_completion();
  3111. return;
  3112. }
  3113. code_completion_options_new.sort_custom<CodeCompletionOptionCompare>();
  3114. if (_should_reset_selected_option_for_new_options(code_completion_options_new)) {
  3115. code_completion_current_selected = 0;
  3116. code_completion_pan_offset = 0.0f;
  3117. }
  3118. code_completion_options = code_completion_options_new;
  3119. code_completion_longest_line = MIN(max_width, theme_cache.code_completion_max_width * theme_cache.font_size);
  3120. code_completion_force_item_center = -1;
  3121. code_completion_active = true;
  3122. queue_redraw();
  3123. }
  3124. // Assumes both the new_options and the code_completion_options are sorted.
  3125. bool CodeEdit::_should_reset_selected_option_for_new_options(const Vector<ScriptLanguage::CodeCompletionOption> &p_new_options) {
  3126. if (code_completion_current_selected >= p_new_options.size()) {
  3127. return true;
  3128. }
  3129. for (int i = 0; i < code_completion_options.size() && i < p_new_options.size(); i++) {
  3130. if (i > code_completion_current_selected) {
  3131. return false;
  3132. }
  3133. if (code_completion_options[i].display != p_new_options[i].display) {
  3134. return true;
  3135. }
  3136. }
  3137. return false;
  3138. }
  3139. void CodeEdit::_lines_edited_from(int p_from_line, int p_to_line) {
  3140. _update_delimiter_cache(p_from_line, p_to_line);
  3141. if (p_from_line == p_to_line) {
  3142. return;
  3143. }
  3144. lines_edited_changed += p_to_line - p_from_line;
  3145. 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));
  3146. 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));
  3147. }
  3148. void CodeEdit::_text_set() {
  3149. lines_edited_from = 0;
  3150. lines_edited_to = 9999;
  3151. _text_changed();
  3152. }
  3153. void CodeEdit::_text_changed() {
  3154. if (lines_edited_from == -1) {
  3155. return;
  3156. }
  3157. int lc = get_line_count();
  3158. int new_line_number_digits = log10l(lc) + 1;
  3159. if (line_number_digits != new_line_number_digits) {
  3160. _clear_line_number_text_cache();
  3161. }
  3162. line_number_digits = new_line_number_digits;
  3163. _update_line_number_gutter_width();
  3164. List<int> breakpoints;
  3165. for (const KeyValue<int, bool> &E : breakpointed_lines) {
  3166. breakpoints.push_back(E.key);
  3167. }
  3168. for (const int &line : breakpoints) {
  3169. if (line < lines_edited_from || (line < lc && is_line_breakpointed(line))) {
  3170. continue;
  3171. }
  3172. breakpointed_lines.erase(line);
  3173. emit_signal(SNAME("breakpoint_toggled"), line);
  3174. int next_line = line + lines_edited_changed;
  3175. if (next_line > -1 && next_line < lc && is_line_breakpointed(next_line)) {
  3176. emit_signal(SNAME("breakpoint_toggled"), next_line);
  3177. breakpointed_lines[next_line] = true;
  3178. continue;
  3179. }
  3180. }
  3181. lines_edited_from = -1;
  3182. lines_edited_to = -1;
  3183. lines_edited_changed = 0;
  3184. }
  3185. CodeEdit::CodeEdit() {
  3186. /* Indent management */
  3187. auto_indent_prefixes.insert(':');
  3188. auto_indent_prefixes.insert('{');
  3189. auto_indent_prefixes.insert('[');
  3190. auto_indent_prefixes.insert('(');
  3191. /* Auto brace completion */
  3192. add_auto_brace_completion_pair("(", ")");
  3193. add_auto_brace_completion_pair("{", "}");
  3194. add_auto_brace_completion_pair("[", "]");
  3195. add_auto_brace_completion_pair("\"", "\"");
  3196. add_auto_brace_completion_pair("\'", "\'");
  3197. /* Delimiter tracking */
  3198. add_string_delimiter("\"", "\"", false);
  3199. add_string_delimiter("\'", "\'", false);
  3200. /* Text Direction */
  3201. set_layout_direction(LAYOUT_DIRECTION_LTR);
  3202. set_text_direction(TEXT_DIRECTION_LTR);
  3203. /* Gutters */
  3204. int gutter_idx = 0;
  3205. /* Main Gutter */
  3206. add_gutter();
  3207. set_gutter_name(gutter_idx, "main_gutter");
  3208. set_gutter_draw(gutter_idx, false);
  3209. set_gutter_overwritable(gutter_idx, true);
  3210. set_gutter_type(gutter_idx, GUTTER_TYPE_CUSTOM);
  3211. set_gutter_custom_draw(gutter_idx, callable_mp(this, &CodeEdit::_main_gutter_draw_callback));
  3212. gutter_idx++;
  3213. /* Line numbers */
  3214. add_gutter();
  3215. set_gutter_name(gutter_idx, "line_numbers");
  3216. set_gutter_draw(gutter_idx, false);
  3217. set_gutter_type(gutter_idx, GUTTER_TYPE_CUSTOM);
  3218. set_gutter_custom_draw(gutter_idx, callable_mp(this, &CodeEdit::_line_number_draw_callback));
  3219. gutter_idx++;
  3220. /* Fold Gutter */
  3221. add_gutter();
  3222. set_gutter_name(gutter_idx, "fold_gutter");
  3223. set_gutter_draw(gutter_idx, false);
  3224. set_gutter_type(gutter_idx, GUTTER_TYPE_CUSTOM);
  3225. set_gutter_custom_draw(gutter_idx, callable_mp(this, &CodeEdit::_fold_gutter_draw_callback));
  3226. gutter_idx++;
  3227. /* Symbol tooltip */
  3228. symbol_tooltip_timer = memnew(Timer);
  3229. symbol_tooltip_timer->set_wait_time(0.5); // See `_apply_project_settings()`.
  3230. symbol_tooltip_timer->set_one_shot(true);
  3231. symbol_tooltip_timer->connect("timeout", callable_mp(this, &CodeEdit::_on_symbol_tooltip_timer_timeout));
  3232. add_child(symbol_tooltip_timer, false, INTERNAL_MODE_FRONT);
  3233. connect("lines_edited_from", callable_mp(this, &CodeEdit::_lines_edited_from));
  3234. connect("text_set", callable_mp(this, &CodeEdit::_text_set));
  3235. connect(SceneStringName(text_changed), callable_mp(this, &CodeEdit::_text_changed));
  3236. connect("gutter_clicked", callable_mp(this, &CodeEdit::_gutter_clicked));
  3237. connect("gutter_added", callable_mp(this, &CodeEdit::_update_gutter_indexes));
  3238. connect("gutter_removed", callable_mp(this, &CodeEdit::_update_gutter_indexes));
  3239. _update_gutter_indexes();
  3240. }
  3241. CodeEdit::~CodeEdit() {
  3242. _clear_line_number_text_cache();
  3243. }
  3244. // Return true if l should come before r
  3245. bool CodeCompletionOptionCompare::operator()(const ScriptLanguage::CodeCompletionOption &l, const ScriptLanguage::CodeCompletionOption &r) const {
  3246. TypedArray<int> lcharac = l.get_option_cached_characteristics();
  3247. TypedArray<int> rcharac = r.get_option_cached_characteristics();
  3248. if (lcharac != rcharac) {
  3249. return lcharac < rcharac;
  3250. }
  3251. // to get here they need to have the same size so we can take the size of whichever we want
  3252. for (int i = 0; i < l.matches.size(); ++i) {
  3253. if (l.matches[i].first != r.matches[i].first) {
  3254. return l.matches[i].first < r.matches[i].first;
  3255. }
  3256. if (l.matches[i].second != r.matches[i].second) {
  3257. return l.matches[i].second > r.matches[i].second;
  3258. }
  3259. }
  3260. return l.display.naturalnocasecmp_to(r.display) < 0;
  3261. }