code_edit.cpp 131 KB

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