code_edit.cpp 131 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849
  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.remove_char(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.is_empty()) {
  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. for (const KeyValue<Variant, Variant> &kv : p_auto_brace_completion_pairs) {
  1071. add_auto_brace_completion_pair(kv.key, kv.value);
  1072. }
  1073. }
  1074. Dictionary CodeEdit::get_auto_brace_completion_pairs() const {
  1075. Dictionary brace_pairs;
  1076. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1077. brace_pairs[auto_brace_completion_pairs[i].open_key] = auto_brace_completion_pairs[i].close_key;
  1078. }
  1079. return brace_pairs;
  1080. }
  1081. bool CodeEdit::has_auto_brace_completion_open_key(const String &p_open_key) const {
  1082. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1083. if (auto_brace_completion_pairs[i].open_key == p_open_key) {
  1084. return true;
  1085. }
  1086. }
  1087. return false;
  1088. }
  1089. bool CodeEdit::has_auto_brace_completion_close_key(const String &p_close_key) const {
  1090. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1091. if (auto_brace_completion_pairs[i].close_key == p_close_key) {
  1092. return true;
  1093. }
  1094. }
  1095. return false;
  1096. }
  1097. String CodeEdit::get_auto_brace_completion_close_key(const String &p_open_key) const {
  1098. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1099. if (auto_brace_completion_pairs[i].open_key == p_open_key) {
  1100. return auto_brace_completion_pairs[i].close_key;
  1101. }
  1102. }
  1103. return String();
  1104. }
  1105. /* Main Gutter */
  1106. void CodeEdit::_update_draw_main_gutter() {
  1107. set_gutter_draw(main_gutter, draw_breakpoints || draw_bookmarks || draw_executing_lines);
  1108. }
  1109. void CodeEdit::set_draw_breakpoints_gutter(bool p_draw) {
  1110. draw_breakpoints = p_draw;
  1111. set_gutter_clickable(main_gutter, p_draw);
  1112. _update_draw_main_gutter();
  1113. }
  1114. bool CodeEdit::is_drawing_breakpoints_gutter() const {
  1115. return draw_breakpoints;
  1116. }
  1117. void CodeEdit::set_draw_bookmarks_gutter(bool p_draw) {
  1118. draw_bookmarks = p_draw;
  1119. _update_draw_main_gutter();
  1120. }
  1121. bool CodeEdit::is_drawing_bookmarks_gutter() const {
  1122. return draw_bookmarks;
  1123. }
  1124. void CodeEdit::set_draw_executing_lines_gutter(bool p_draw) {
  1125. draw_executing_lines = p_draw;
  1126. _update_draw_main_gutter();
  1127. }
  1128. bool CodeEdit::is_drawing_executing_lines_gutter() const {
  1129. return draw_executing_lines;
  1130. }
  1131. void CodeEdit::_main_gutter_draw_callback(int p_line, int p_gutter, const Rect2 &p_region) {
  1132. bool hovering = get_hovered_gutter() == Vector2i(main_gutter, p_line);
  1133. if (draw_breakpoints && theme_cache.breakpoint_icon.is_valid()) {
  1134. bool breakpointed = is_line_breakpointed(p_line);
  1135. bool shift_pressed = Input::get_singleton()->is_key_pressed(Key::SHIFT);
  1136. if (breakpointed || (hovering && !is_dragging_cursor() && !shift_pressed)) {
  1137. int padding = p_region.size.x / 6;
  1138. Color use_color = theme_cache.breakpoint_color;
  1139. if (hovering && !shift_pressed) {
  1140. use_color = breakpointed ? use_color.lightened(0.3) : use_color.darkened(0.5);
  1141. }
  1142. Rect2 icon_region = p_region;
  1143. icon_region.position += Point2(padding, padding);
  1144. icon_region.size -= Point2(padding, padding) * 2;
  1145. theme_cache.breakpoint_icon->draw_rect(get_canvas_item(), icon_region, false, use_color);
  1146. }
  1147. }
  1148. if (draw_bookmarks && theme_cache.bookmark_icon.is_valid()) {
  1149. bool bookmarked = is_line_bookmarked(p_line);
  1150. bool shift_pressed = Input::get_singleton()->is_key_pressed(Key::SHIFT);
  1151. if (bookmarked || (hovering && !is_dragging_cursor() && shift_pressed)) {
  1152. int horizontal_padding = p_region.size.x / 2;
  1153. int vertical_padding = p_region.size.y / 4;
  1154. Color use_color = theme_cache.bookmark_color;
  1155. if (hovering && shift_pressed) {
  1156. use_color = bookmarked ? use_color.lightened(0.3) : use_color.darkened(0.5);
  1157. }
  1158. Rect2 icon_region = p_region;
  1159. icon_region.position += Point2(horizontal_padding, 0);
  1160. icon_region.size -= Point2(horizontal_padding * 1.1, vertical_padding);
  1161. theme_cache.bookmark_icon->draw_rect(get_canvas_item(), icon_region, false, use_color);
  1162. }
  1163. }
  1164. if (draw_executing_lines && is_line_executing(p_line) && theme_cache.executing_line_icon.is_valid()) {
  1165. int horizontal_padding = p_region.size.x / 10;
  1166. int vertical_padding = p_region.size.y / 4;
  1167. Rect2 icon_region = p_region;
  1168. icon_region.position += Point2(horizontal_padding, vertical_padding);
  1169. icon_region.size -= Point2(horizontal_padding, vertical_padding) * 2;
  1170. theme_cache.executing_line_icon->draw_rect(get_canvas_item(), icon_region, false, theme_cache.executing_line_color);
  1171. }
  1172. }
  1173. // Breakpoints
  1174. void CodeEdit::set_line_as_breakpoint(int p_line, bool p_breakpointed) {
  1175. ERR_FAIL_INDEX(p_line, get_line_count());
  1176. int mask = get_line_gutter_metadata(p_line, main_gutter);
  1177. set_line_gutter_metadata(p_line, main_gutter, p_breakpointed ? mask | MAIN_GUTTER_BREAKPOINT : mask & ~MAIN_GUTTER_BREAKPOINT);
  1178. if (p_breakpointed) {
  1179. breakpointed_lines[p_line] = true;
  1180. } else if (breakpointed_lines.has(p_line)) {
  1181. breakpointed_lines.erase(p_line);
  1182. }
  1183. emit_signal(SNAME("breakpoint_toggled"), p_line);
  1184. queue_redraw();
  1185. }
  1186. bool CodeEdit::is_line_breakpointed(int p_line) const {
  1187. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_BREAKPOINT;
  1188. }
  1189. void CodeEdit::clear_breakpointed_lines() {
  1190. for (int i = 0; i < get_line_count(); i++) {
  1191. if (is_line_breakpointed(i)) {
  1192. set_line_as_breakpoint(i, false);
  1193. }
  1194. }
  1195. }
  1196. PackedInt32Array CodeEdit::get_breakpointed_lines() const {
  1197. PackedInt32Array ret;
  1198. for (int i = 0; i < get_line_count(); i++) {
  1199. if (is_line_breakpointed(i)) {
  1200. ret.append(i);
  1201. }
  1202. }
  1203. return ret;
  1204. }
  1205. // Bookmarks
  1206. void CodeEdit::set_line_as_bookmarked(int p_line, bool p_bookmarked) {
  1207. int mask = get_line_gutter_metadata(p_line, main_gutter);
  1208. set_line_gutter_metadata(p_line, main_gutter, p_bookmarked ? mask | MAIN_GUTTER_BOOKMARK : mask & ~MAIN_GUTTER_BOOKMARK);
  1209. queue_redraw();
  1210. }
  1211. bool CodeEdit::is_line_bookmarked(int p_line) const {
  1212. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_BOOKMARK;
  1213. }
  1214. void CodeEdit::clear_bookmarked_lines() {
  1215. for (int i = 0; i < get_line_count(); i++) {
  1216. if (is_line_bookmarked(i)) {
  1217. set_line_as_bookmarked(i, false);
  1218. }
  1219. }
  1220. }
  1221. PackedInt32Array CodeEdit::get_bookmarked_lines() const {
  1222. PackedInt32Array ret;
  1223. for (int i = 0; i < get_line_count(); i++) {
  1224. if (is_line_bookmarked(i)) {
  1225. ret.append(i);
  1226. }
  1227. }
  1228. return ret;
  1229. }
  1230. // Executing lines
  1231. void CodeEdit::set_line_as_executing(int p_line, bool p_executing) {
  1232. int mask = get_line_gutter_metadata(p_line, main_gutter);
  1233. set_line_gutter_metadata(p_line, main_gutter, p_executing ? mask | MAIN_GUTTER_EXECUTING : mask & ~MAIN_GUTTER_EXECUTING);
  1234. queue_redraw();
  1235. }
  1236. bool CodeEdit::is_line_executing(int p_line) const {
  1237. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_EXECUTING;
  1238. }
  1239. void CodeEdit::clear_executing_lines() {
  1240. for (int i = 0; i < get_line_count(); i++) {
  1241. if (is_line_executing(i)) {
  1242. set_line_as_executing(i, false);
  1243. }
  1244. }
  1245. }
  1246. PackedInt32Array CodeEdit::get_executing_lines() const {
  1247. PackedInt32Array ret;
  1248. for (int i = 0; i < get_line_count(); i++) {
  1249. if (is_line_executing(i)) {
  1250. ret.append(i);
  1251. }
  1252. }
  1253. return ret;
  1254. }
  1255. /* Line numbers */
  1256. void CodeEdit::set_draw_line_numbers(bool p_draw) {
  1257. set_gutter_draw(line_number_gutter, p_draw);
  1258. }
  1259. bool CodeEdit::is_draw_line_numbers_enabled() const {
  1260. return is_gutter_drawn(line_number_gutter);
  1261. }
  1262. void CodeEdit::set_line_numbers_zero_padded(bool p_zero_padded) {
  1263. String new_line_number_padding = p_zero_padded ? "0" : " ";
  1264. if (line_number_padding == new_line_number_padding) {
  1265. return;
  1266. }
  1267. line_number_padding = new_line_number_padding;
  1268. _clear_line_number_text_cache();
  1269. queue_redraw();
  1270. }
  1271. bool CodeEdit::is_line_numbers_zero_padded() const {
  1272. return line_number_padding == "0";
  1273. }
  1274. void CodeEdit::_line_number_draw_callback(int p_line, int p_gutter, const Rect2 &p_region) {
  1275. if (!Rect2(Vector2(0, 0), get_size()).intersects(p_region)) {
  1276. return;
  1277. }
  1278. bool rtl = is_layout_rtl();
  1279. HashMap<int, RID>::Iterator E = line_number_text_cache.find(p_line);
  1280. RID text_rid;
  1281. if (E) {
  1282. text_rid = E->value;
  1283. } else {
  1284. String fc = String::num_int64(p_line + 1).lpad(line_number_digits, line_number_padding);
  1285. if (is_localizing_numeral_system()) {
  1286. fc = TS->format_number(fc);
  1287. }
  1288. text_rid = TS->create_shaped_text();
  1289. if (theme_cache.font.is_valid()) {
  1290. TS->shaped_text_add_string(text_rid, fc, theme_cache.font->get_rids(), theme_cache.font_size, theme_cache.font->get_opentype_features());
  1291. }
  1292. line_number_text_cache.insert(p_line, text_rid);
  1293. }
  1294. Size2 text_size = TS->shaped_text_get_size(text_rid);
  1295. Point2 ofs = p_region.get_center() - text_size / 2;
  1296. ofs.y += TS->shaped_text_get_ascent(text_rid);
  1297. if (rtl) {
  1298. ofs.x = p_region.get_end().x - text_size.width;
  1299. } else {
  1300. ofs.x = p_region.position.x;
  1301. }
  1302. Color number_color = get_line_gutter_item_color(p_line, line_number_gutter);
  1303. if (number_color == Color(1, 1, 1)) {
  1304. number_color = theme_cache.line_number_color;
  1305. }
  1306. TS->shaped_text_draw(text_rid, get_canvas_item(), ofs, -1, -1, number_color);
  1307. }
  1308. void CodeEdit::_clear_line_number_text_cache() {
  1309. for (const KeyValue<int, RID> &KV : line_number_text_cache) {
  1310. TS->free_rid(KV.value);
  1311. }
  1312. line_number_text_cache.clear();
  1313. }
  1314. void CodeEdit::_update_line_number_gutter_width() {
  1315. set_gutter_width(line_number_gutter, (line_number_digits + 1) * theme_cache.font->get_char_size('0', theme_cache.font_size).width);
  1316. }
  1317. /* Fold Gutter */
  1318. void CodeEdit::set_draw_fold_gutter(bool p_draw) {
  1319. set_gutter_draw(fold_gutter, p_draw);
  1320. }
  1321. bool CodeEdit::is_drawing_fold_gutter() const {
  1322. return is_gutter_drawn(fold_gutter);
  1323. }
  1324. void CodeEdit::_fold_gutter_draw_callback(int p_line, int p_gutter, Rect2 p_region) {
  1325. if (!can_fold_line(p_line) && !is_line_folded(p_line)) {
  1326. set_line_gutter_clickable(p_line, fold_gutter, false);
  1327. return;
  1328. }
  1329. set_line_gutter_clickable(p_line, fold_gutter, true);
  1330. int horizontal_padding = p_region.size.x / 10;
  1331. int vertical_padding = p_region.size.y / 6;
  1332. p_region.position += Point2(horizontal_padding, vertical_padding);
  1333. p_region.size -= Point2(horizontal_padding, vertical_padding) * 2;
  1334. bool can_fold = can_fold_line(p_line);
  1335. if (is_line_code_region_start(p_line)) {
  1336. Color region_icon_color = theme_cache.folded_code_region_color;
  1337. region_icon_color.a = MAX(region_icon_color.a, 0.4f);
  1338. if (can_fold) {
  1339. theme_cache.can_fold_code_region_icon->draw_rect(get_canvas_item(), p_region, false, region_icon_color);
  1340. } else {
  1341. theme_cache.folded_code_region_icon->draw_rect(get_canvas_item(), p_region, false, region_icon_color);
  1342. }
  1343. return;
  1344. }
  1345. if (can_fold) {
  1346. theme_cache.can_fold_icon->draw_rect(get_canvas_item(), p_region, false, theme_cache.code_folding_color);
  1347. return;
  1348. }
  1349. theme_cache.folded_icon->draw_rect(get_canvas_item(), p_region, false, theme_cache.code_folding_color);
  1350. }
  1351. /* Line Folding */
  1352. void CodeEdit::set_line_folding_enabled(bool p_enabled) {
  1353. line_folding_enabled = p_enabled;
  1354. _set_hiding_enabled(p_enabled);
  1355. }
  1356. bool CodeEdit::is_line_folding_enabled() const {
  1357. return line_folding_enabled;
  1358. }
  1359. bool CodeEdit::can_fold_line(int p_line) const {
  1360. ERR_FAIL_INDEX_V(p_line, get_line_count(), false);
  1361. if (!line_folding_enabled) {
  1362. return false;
  1363. }
  1364. if (p_line + 1 >= get_line_count() || get_line(p_line).strip_edges().is_empty()) {
  1365. return false;
  1366. }
  1367. if (_is_line_hidden(p_line) || is_line_folded(p_line)) {
  1368. return false;
  1369. }
  1370. // Check for code region.
  1371. if (is_line_code_region_end(p_line)) {
  1372. return false;
  1373. }
  1374. if (is_line_code_region_start(p_line)) {
  1375. int region_level = 0;
  1376. // Check if there is a valid end region tag.
  1377. for (int next_line = p_line + 1; next_line < get_line_count(); next_line++) {
  1378. if (is_line_code_region_end(next_line)) {
  1379. region_level -= 1;
  1380. if (region_level == -1) {
  1381. return true;
  1382. }
  1383. }
  1384. if (is_line_code_region_start(next_line)) {
  1385. region_level += 1;
  1386. }
  1387. }
  1388. return false;
  1389. }
  1390. /* Check for full multiline line or block strings / comments. */
  1391. int in_comment = is_in_comment(p_line);
  1392. int in_string = (in_comment == -1) ? is_in_string(p_line) : -1;
  1393. if (in_string != -1 || in_comment != -1) {
  1394. if (get_delimiter_start_position(p_line, get_line(p_line).size() - 1).y != p_line) {
  1395. return false;
  1396. }
  1397. int delimiter_end_line = get_delimiter_end_position(p_line, get_line(p_line).size() - 1).y;
  1398. /* No end line, therefore we have a multiline region over the rest of the file. */
  1399. if (delimiter_end_line == -1) {
  1400. return true;
  1401. }
  1402. /* End line is the same therefore we have a block. */
  1403. if (delimiter_end_line == p_line) {
  1404. /* Check we are the start of the block. */
  1405. if (p_line - 1 >= 0) {
  1406. if ((in_string != -1 && is_in_string(p_line - 1) != -1) || (in_comment != -1 && is_in_comment(p_line - 1) != -1 && !is_line_code_region_start(p_line - 1) && !is_line_code_region_end(p_line - 1))) {
  1407. return false;
  1408. }
  1409. }
  1410. /* Check it continues for at least one line. */
  1411. return ((in_string != -1 && is_in_string(p_line + 1) != -1) || (in_comment != -1 && is_in_comment(p_line + 1) != -1 && !is_line_code_region_start(p_line + 1) && !is_line_code_region_end(p_line + 1)));
  1412. }
  1413. return ((in_string != -1 && is_in_string(delimiter_end_line) != -1) || (in_comment != -1 && is_in_comment(delimiter_end_line) != -1));
  1414. }
  1415. /* Otherwise check indent levels. */
  1416. int start_indent = get_indent_level(p_line);
  1417. for (int i = p_line + 1; i < get_line_count(); i++) {
  1418. if (is_in_string(i) != -1 || is_in_comment(i) != -1 || get_line(i).strip_edges().is_empty()) {
  1419. continue;
  1420. }
  1421. return (get_indent_level(i) > start_indent);
  1422. }
  1423. return false;
  1424. }
  1425. void CodeEdit::fold_line(int p_line) {
  1426. ERR_FAIL_INDEX(p_line, get_line_count());
  1427. if (!is_line_folding_enabled() || !can_fold_line(p_line)) {
  1428. return;
  1429. }
  1430. /* Find the last line to be hidden. */
  1431. const int line_count = get_line_count() - 1;
  1432. int end_line = line_count;
  1433. // Fold code region.
  1434. if (is_line_code_region_start(p_line)) {
  1435. int region_level = 0;
  1436. for (int endregion_line = p_line + 1; endregion_line < get_line_count(); endregion_line++) {
  1437. if (is_line_code_region_start(endregion_line)) {
  1438. region_level += 1;
  1439. }
  1440. if (is_line_code_region_end(endregion_line)) {
  1441. region_level -= 1;
  1442. if (region_level == -1) {
  1443. end_line = endregion_line;
  1444. break;
  1445. }
  1446. }
  1447. }
  1448. set_line_background_color(p_line, theme_cache.folded_code_region_color);
  1449. }
  1450. int in_comment = is_in_comment(p_line);
  1451. int in_string = (in_comment == -1) ? is_in_string(p_line) : -1;
  1452. if (!is_line_code_region_start(p_line)) {
  1453. if (in_string != -1 || in_comment != -1) {
  1454. end_line = get_delimiter_end_position(p_line, get_line(p_line).size() - 1).y;
  1455. // End line is the same therefore we have a block of single line delimiters.
  1456. if (end_line == p_line) {
  1457. for (int i = p_line + 1; i <= line_count; i++) {
  1458. if ((in_string != -1 && is_in_string(i) == -1) || (in_comment != -1 && is_in_comment(i) == -1)) {
  1459. break;
  1460. }
  1461. if (in_comment != -1 && (is_line_code_region_start(i) || is_line_code_region_end(i))) {
  1462. // A code region tag should split a comment block, ending it early.
  1463. break;
  1464. }
  1465. end_line = i;
  1466. }
  1467. }
  1468. } else {
  1469. int start_indent = get_indent_level(p_line);
  1470. for (int i = p_line + 1; i <= line_count; i++) {
  1471. if (get_line(i).strip_edges().is_empty()) {
  1472. continue;
  1473. }
  1474. if (get_indent_level(i) > start_indent) {
  1475. end_line = i;
  1476. continue;
  1477. }
  1478. if (is_in_string(i) == -1 && is_in_comment(i) == -1) {
  1479. break;
  1480. }
  1481. }
  1482. }
  1483. }
  1484. for (int i = p_line + 1; i <= end_line; i++) {
  1485. _set_line_as_hidden(i, true);
  1486. }
  1487. // Collapse any carets in the hidden area.
  1488. collapse_carets(p_line, get_line(p_line).length(), end_line, get_line(end_line).length(), true);
  1489. }
  1490. void CodeEdit::unfold_line(int p_line) {
  1491. ERR_FAIL_INDEX(p_line, get_line_count());
  1492. if (!is_line_folded(p_line) && !_is_line_hidden(p_line)) {
  1493. return;
  1494. }
  1495. int fold_start = p_line;
  1496. for (; fold_start > 0; fold_start--) {
  1497. if (is_line_folded(fold_start)) {
  1498. break;
  1499. }
  1500. }
  1501. fold_start = is_line_folded(fold_start) ? fold_start : p_line;
  1502. for (int i = fold_start + 1; i < get_line_count(); i++) {
  1503. if (!_is_line_hidden(i)) {
  1504. break;
  1505. }
  1506. _set_line_as_hidden(i, false);
  1507. if (is_line_code_region_start(i - 1)) {
  1508. set_line_background_color(i - 1, Color(0.0, 0.0, 0.0, 0.0));
  1509. }
  1510. }
  1511. queue_redraw();
  1512. }
  1513. void CodeEdit::fold_all_lines() {
  1514. for (int i = 0; i < get_line_count(); i++) {
  1515. fold_line(i);
  1516. }
  1517. queue_redraw();
  1518. }
  1519. void CodeEdit::unfold_all_lines() {
  1520. _unhide_all_lines();
  1521. }
  1522. void CodeEdit::toggle_foldable_line(int p_line) {
  1523. ERR_FAIL_INDEX(p_line, get_line_count());
  1524. if (is_line_folded(p_line)) {
  1525. unfold_line(p_line);
  1526. return;
  1527. }
  1528. fold_line(p_line);
  1529. }
  1530. void CodeEdit::toggle_foldable_lines_at_carets() {
  1531. begin_multicaret_edit();
  1532. int previous_line = -1;
  1533. Vector<int> sorted = get_sorted_carets();
  1534. for (int caret_idx : sorted) {
  1535. if (multicaret_edit_ignore_caret(caret_idx)) {
  1536. continue;
  1537. }
  1538. int line_idx = get_caret_line(caret_idx);
  1539. if (line_idx != previous_line) {
  1540. toggle_foldable_line(line_idx);
  1541. previous_line = line_idx;
  1542. }
  1543. }
  1544. end_multicaret_edit();
  1545. }
  1546. bool CodeEdit::is_line_folded(int p_line) const {
  1547. ERR_FAIL_INDEX_V(p_line, get_line_count(), false);
  1548. return p_line + 1 < get_line_count() && !_is_line_hidden(p_line) && _is_line_hidden(p_line + 1);
  1549. }
  1550. TypedArray<int> CodeEdit::get_folded_lines() const {
  1551. TypedArray<int> folded_lines;
  1552. for (int i = 0; i < get_line_count(); i++) {
  1553. if (is_line_folded(i)) {
  1554. folded_lines.push_back(i);
  1555. }
  1556. }
  1557. return folded_lines;
  1558. }
  1559. /* Code region */
  1560. void CodeEdit::create_code_region() {
  1561. // Abort if there is no selected text.
  1562. if (!has_selection()) {
  1563. return;
  1564. }
  1565. // Check that region tag find a comment delimiter and is valid.
  1566. if (code_region_start_string.is_empty()) {
  1567. WARN_PRINT_ONCE("Cannot create code region without any one line comment delimiters");
  1568. return;
  1569. }
  1570. String region_name = atr(ETR("New Code Region"));
  1571. begin_complex_operation();
  1572. begin_multicaret_edit();
  1573. Vector<Point2i> line_ranges = get_line_ranges_from_carets(true, false);
  1574. // Add start and end region tags.
  1575. int line_offset = 0;
  1576. for (Point2i line_range : line_ranges) {
  1577. insert_text("\n" + code_region_end_string, line_range.y + line_offset, get_line(line_range.y + line_offset).length());
  1578. insert_line_at(line_range.x + line_offset, code_region_start_string + " " + region_name);
  1579. fold_line(line_range.x + line_offset);
  1580. line_offset += 2;
  1581. }
  1582. int first_region_start = line_ranges[0].x;
  1583. // Select name of the first region to allow quick edit.
  1584. remove_secondary_carets();
  1585. int tag_length = code_region_start_string.length() + region_name.length() + 1;
  1586. select(first_region_start, code_region_start_string.length() + 1, first_region_start, tag_length);
  1587. end_multicaret_edit();
  1588. end_complex_operation();
  1589. }
  1590. String CodeEdit::get_code_region_start_tag() const {
  1591. return code_region_start_tag;
  1592. }
  1593. String CodeEdit::get_code_region_end_tag() const {
  1594. return code_region_end_tag;
  1595. }
  1596. void CodeEdit::set_code_region_tags(const String &p_start, const String &p_end) {
  1597. ERR_FAIL_COND_MSG(p_start == p_end, "Starting and ending region tags cannot be identical.");
  1598. ERR_FAIL_COND_MSG(p_start.is_empty(), "Starting region tag cannot be empty.");
  1599. ERR_FAIL_COND_MSG(p_end.is_empty(), "Ending region tag cannot be empty.");
  1600. code_region_start_tag = p_start;
  1601. code_region_end_tag = p_end;
  1602. _update_code_region_tags();
  1603. }
  1604. bool CodeEdit::is_line_code_region_start(int p_line) const {
  1605. ERR_FAIL_INDEX_V(p_line, get_line_count(), false);
  1606. if (code_region_start_string.is_empty()) {
  1607. return false;
  1608. }
  1609. if (is_in_string(p_line) != -1) {
  1610. return false;
  1611. }
  1612. Vector<String> split = get_line(p_line).strip_edges().split_spaces(1);
  1613. return split.size() > 0 && split[0] == code_region_start_string;
  1614. }
  1615. bool CodeEdit::is_line_code_region_end(int p_line) const {
  1616. ERR_FAIL_INDEX_V(p_line, get_line_count(), false);
  1617. if (code_region_start_string.is_empty()) {
  1618. return false;
  1619. }
  1620. if (is_in_string(p_line) != -1) {
  1621. return false;
  1622. }
  1623. Vector<String> split = get_line(p_line).strip_edges().split_spaces(1);
  1624. return split.size() > 0 && split[0] == code_region_end_string;
  1625. }
  1626. /* Delimiters */
  1627. // Strings
  1628. void CodeEdit::add_string_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only) {
  1629. _add_delimiter(p_start_key, p_end_key, p_line_only, TYPE_STRING);
  1630. }
  1631. void CodeEdit::remove_string_delimiter(const String &p_start_key) {
  1632. _remove_delimiter(p_start_key, TYPE_STRING);
  1633. }
  1634. bool CodeEdit::has_string_delimiter(const String &p_start_key) const {
  1635. return _has_delimiter(p_start_key, TYPE_STRING);
  1636. }
  1637. void CodeEdit::set_string_delimiters(const TypedArray<String> &p_string_delimiters) {
  1638. _set_delimiters(p_string_delimiters, TYPE_STRING);
  1639. }
  1640. void CodeEdit::clear_string_delimiters() {
  1641. _clear_delimiters(TYPE_STRING);
  1642. }
  1643. TypedArray<String> CodeEdit::get_string_delimiters() const {
  1644. return _get_delimiters(TYPE_STRING);
  1645. }
  1646. int CodeEdit::is_in_string(int p_line, int p_column) const {
  1647. return _is_in_delimiter(p_line, p_column, TYPE_STRING);
  1648. }
  1649. // Comments
  1650. void CodeEdit::add_comment_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only) {
  1651. _add_delimiter(p_start_key, p_end_key, p_line_only, TYPE_COMMENT);
  1652. }
  1653. void CodeEdit::remove_comment_delimiter(const String &p_start_key) {
  1654. _remove_delimiter(p_start_key, TYPE_COMMENT);
  1655. }
  1656. bool CodeEdit::has_comment_delimiter(const String &p_start_key) const {
  1657. return _has_delimiter(p_start_key, TYPE_COMMENT);
  1658. }
  1659. void CodeEdit::set_comment_delimiters(const TypedArray<String> &p_comment_delimiters) {
  1660. _set_delimiters(p_comment_delimiters, TYPE_COMMENT);
  1661. }
  1662. void CodeEdit::clear_comment_delimiters() {
  1663. _clear_delimiters(TYPE_COMMENT);
  1664. }
  1665. TypedArray<String> CodeEdit::get_comment_delimiters() const {
  1666. return _get_delimiters(TYPE_COMMENT);
  1667. }
  1668. int CodeEdit::is_in_comment(int p_line, int p_column) const {
  1669. return _is_in_delimiter(p_line, p_column, TYPE_COMMENT);
  1670. }
  1671. String CodeEdit::get_delimiter_start_key(int p_delimiter_idx) const {
  1672. ERR_FAIL_INDEX_V(p_delimiter_idx, delimiters.size(), "");
  1673. return delimiters[p_delimiter_idx].start_key;
  1674. }
  1675. String CodeEdit::get_delimiter_end_key(int p_delimiter_idx) const {
  1676. ERR_FAIL_INDEX_V(p_delimiter_idx, delimiters.size(), "");
  1677. return delimiters[p_delimiter_idx].end_key;
  1678. }
  1679. Point2 CodeEdit::get_delimiter_start_position(int p_line, int p_column) const {
  1680. if (delimiters.is_empty()) {
  1681. return Point2(-1, -1);
  1682. }
  1683. ERR_FAIL_INDEX_V(p_line, get_line_count(), Point2(-1, -1));
  1684. ERR_FAIL_COND_V(p_column - 1 > get_line(p_line).size(), Point2(-1, -1));
  1685. Point2 start_position;
  1686. start_position.y = -1;
  1687. start_position.x = -1;
  1688. bool in_region = ((p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->get()) != -1;
  1689. /* Check the keys for this line. */
  1690. for (const KeyValue<int, int> &E : delimiter_cache[p_line]) {
  1691. if (E.key > p_column) {
  1692. break;
  1693. }
  1694. in_region = E.value != -1;
  1695. start_position.x = in_region ? E.key : -1;
  1696. }
  1697. /* Region was found on this line and is not a multiline continuation. */
  1698. int line_length = get_line(p_line).length();
  1699. if (start_position.x != -1 && line_length > 0 && start_position.x != line_length + 1) {
  1700. start_position.y = p_line;
  1701. return start_position;
  1702. }
  1703. /* Not in a region */
  1704. if (!in_region) {
  1705. return start_position;
  1706. }
  1707. /* Region starts on a previous line */
  1708. for (int i = p_line - 1; i >= 0; i--) {
  1709. if (delimiter_cache[i].size() < 1) {
  1710. continue;
  1711. }
  1712. start_position.y = i;
  1713. start_position.x = delimiter_cache[i].back()->key();
  1714. /* Make sure it's not a multiline continuation. */
  1715. line_length = get_line(i).length();
  1716. if (line_length > 0 && start_position.x != line_length + 1) {
  1717. break;
  1718. }
  1719. }
  1720. return start_position;
  1721. }
  1722. Point2 CodeEdit::get_delimiter_end_position(int p_line, int p_column) const {
  1723. if (delimiters.is_empty()) {
  1724. return Point2(-1, -1);
  1725. }
  1726. ERR_FAIL_INDEX_V(p_line, get_line_count(), Point2(-1, -1));
  1727. ERR_FAIL_COND_V(p_column - 1 > get_line(p_line).size(), Point2(-1, -1));
  1728. Point2 end_position;
  1729. end_position.y = -1;
  1730. end_position.x = -1;
  1731. int region = (p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->value();
  1732. /* Check the keys for this line. */
  1733. for (const KeyValue<int, int> &E : delimiter_cache[p_line]) {
  1734. end_position.x = (E.value == -1) ? E.key : -1;
  1735. if (E.key > p_column) {
  1736. break;
  1737. }
  1738. region = E.value;
  1739. }
  1740. /* Region was found on this line and is not a multiline continuation. */
  1741. if (region != -1 && end_position.x != -1 && (delimiters[region].line_only || end_position.x != get_line(p_line).length() + 1)) {
  1742. end_position.y = p_line;
  1743. return end_position;
  1744. }
  1745. /* Not in a region */
  1746. if (region == -1) {
  1747. end_position.x = -1;
  1748. return end_position;
  1749. }
  1750. /* Region ends on a later line */
  1751. for (int i = p_line + 1; i < get_line_count(); i++) {
  1752. if (delimiter_cache[i].size() < 1 || delimiter_cache[i].front()->value() != -1) {
  1753. continue;
  1754. }
  1755. end_position.x = delimiter_cache[i].front()->key();
  1756. /* Make sure it's not a multiline continuation. */
  1757. if (get_line(i).length() > 0 && end_position.x != get_line(i).length() + 1) {
  1758. end_position.y = i;
  1759. break;
  1760. }
  1761. end_position.x = -1;
  1762. }
  1763. return end_position;
  1764. }
  1765. /* Code hint */
  1766. void CodeEdit::set_code_hint(const String &p_hint) {
  1767. if (code_hint == p_hint) {
  1768. return;
  1769. }
  1770. code_hint = p_hint;
  1771. code_hint_xpos = -0xFFFF;
  1772. queue_redraw();
  1773. }
  1774. void CodeEdit::set_code_hint_draw_below(bool p_below) {
  1775. if (code_hint_draw_below == p_below) {
  1776. return;
  1777. }
  1778. code_hint_draw_below = p_below;
  1779. queue_redraw();
  1780. }
  1781. /* Code Completion */
  1782. void CodeEdit::set_code_completion_enabled(bool p_enable) {
  1783. code_completion_enabled = p_enable;
  1784. }
  1785. bool CodeEdit::is_code_completion_enabled() const {
  1786. return code_completion_enabled;
  1787. }
  1788. void CodeEdit::set_code_completion_prefixes(const TypedArray<String> &p_prefixes) {
  1789. code_completion_prefixes.clear();
  1790. for (int i = 0; i < p_prefixes.size(); i++) {
  1791. const String prefix = p_prefixes[i];
  1792. ERR_CONTINUE_MSG(prefix.is_empty(), "Code completion prefix cannot be empty.");
  1793. code_completion_prefixes.insert(prefix[0]);
  1794. }
  1795. }
  1796. TypedArray<String> CodeEdit::get_code_completion_prefixes() const {
  1797. TypedArray<String> prefixes;
  1798. for (const char32_t &E : code_completion_prefixes) {
  1799. prefixes.push_back(String::chr(E));
  1800. }
  1801. return prefixes;
  1802. }
  1803. String CodeEdit::get_text_for_code_completion() const {
  1804. StringBuilder completion_text;
  1805. const int text_size = get_line_count();
  1806. for (int i = 0; i < text_size; i++) {
  1807. String line = get_line(i);
  1808. if (i == get_caret_line()) {
  1809. completion_text += line.substr(0, get_caret_column());
  1810. /* Not unicode, represents the caret. */
  1811. completion_text += String::chr(0xFFFF);
  1812. completion_text += line.substr(get_caret_column());
  1813. } else {
  1814. completion_text += line;
  1815. }
  1816. if (i != text_size - 1) {
  1817. completion_text += "\n";
  1818. }
  1819. }
  1820. return completion_text.as_string();
  1821. }
  1822. void CodeEdit::request_code_completion(bool p_force) {
  1823. if (GDVIRTUAL_CALL(_request_code_completion, p_force)) {
  1824. return;
  1825. }
  1826. /* Don't re-query if all existing options are quoted types, eg path, signal. */
  1827. bool ignored = code_completion_active && !code_completion_options.is_empty();
  1828. if (ignored) {
  1829. ScriptLanguage::CodeCompletionKind kind = ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT;
  1830. const ScriptLanguage::CodeCompletionOption *previous_option = nullptr;
  1831. for (int i = 0; i < code_completion_options.size(); i++) {
  1832. const ScriptLanguage::CodeCompletionOption &current_option = code_completion_options[i];
  1833. if (!previous_option) {
  1834. previous_option = &current_option;
  1835. kind = current_option.kind;
  1836. }
  1837. if (previous_option->kind != current_option.kind) {
  1838. ignored = false;
  1839. break;
  1840. }
  1841. }
  1842. ignored = ignored && (kind == ScriptLanguage::CODE_COMPLETION_KIND_FILE_PATH || kind == ScriptLanguage::CODE_COMPLETION_KIND_NODE_PATH || kind == ScriptLanguage::CODE_COMPLETION_KIND_SIGNAL);
  1843. }
  1844. if (ignored) {
  1845. return;
  1846. }
  1847. if (p_force) {
  1848. emit_signal(SNAME("code_completion_requested"));
  1849. return;
  1850. }
  1851. String line = get_line(get_caret_line());
  1852. int ofs = CLAMP(get_caret_column(), 0, line.length());
  1853. if (ofs > 0 && (is_in_string(get_caret_line(), ofs) != -1 || !is_symbol(line[ofs - 1]) || code_completion_prefixes.has(line[ofs - 1]))) {
  1854. emit_signal(SNAME("code_completion_requested"));
  1855. } else if (ofs > 1 && line[ofs - 1] == ' ' && code_completion_prefixes.has(line[ofs - 2])) {
  1856. emit_signal(SNAME("code_completion_requested"));
  1857. }
  1858. }
  1859. 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) {
  1860. ScriptLanguage::CodeCompletionOption completion_option;
  1861. completion_option.kind = (ScriptLanguage::CodeCompletionKind)p_type;
  1862. completion_option.display = p_display_text;
  1863. completion_option.insert_text = p_insert_text;
  1864. completion_option.font_color = p_text_color;
  1865. completion_option.icon = p_icon;
  1866. completion_option.default_value = p_value;
  1867. completion_option.location = p_location;
  1868. code_completion_option_submitted.push_back(completion_option);
  1869. }
  1870. void CodeEdit::update_code_completion_options(bool p_forced) {
  1871. code_completion_forced = p_forced;
  1872. code_completion_option_sources = code_completion_option_submitted;
  1873. code_completion_option_submitted.clear();
  1874. _filter_code_completion_candidates_impl();
  1875. }
  1876. TypedArray<Dictionary> CodeEdit::get_code_completion_options() const {
  1877. if (!code_completion_active) {
  1878. return TypedArray<Dictionary>();
  1879. }
  1880. TypedArray<Dictionary> completion_options;
  1881. completion_options.resize(code_completion_options.size());
  1882. for (int i = 0; i < code_completion_options.size(); i++) {
  1883. Dictionary option;
  1884. option["kind"] = code_completion_options[i].kind;
  1885. option["display_text"] = code_completion_options[i].display;
  1886. option["insert_text"] = code_completion_options[i].insert_text;
  1887. option["font_color"] = code_completion_options[i].font_color;
  1888. option["icon"] = code_completion_options[i].icon;
  1889. option["location"] = code_completion_options[i].location;
  1890. option["default_value"] = code_completion_options[i].default_value;
  1891. completion_options[i] = option;
  1892. }
  1893. return completion_options;
  1894. }
  1895. Dictionary CodeEdit::get_code_completion_option(int p_index) const {
  1896. if (!code_completion_active) {
  1897. return Dictionary();
  1898. }
  1899. ERR_FAIL_INDEX_V(p_index, code_completion_options.size(), Dictionary());
  1900. Dictionary option;
  1901. option["kind"] = code_completion_options[p_index].kind;
  1902. option["display_text"] = code_completion_options[p_index].display;
  1903. option["insert_text"] = code_completion_options[p_index].insert_text;
  1904. option["font_color"] = code_completion_options[p_index].font_color;
  1905. option["icon"] = code_completion_options[p_index].icon;
  1906. option["location"] = code_completion_options[p_index].location;
  1907. option["default_value"] = code_completion_options[p_index].default_value;
  1908. return option;
  1909. }
  1910. int CodeEdit::get_code_completion_selected_index() const {
  1911. return (code_completion_active) ? code_completion_current_selected : -1;
  1912. }
  1913. void CodeEdit::set_code_completion_selected_index(int p_index) {
  1914. if (!code_completion_active) {
  1915. return;
  1916. }
  1917. ERR_FAIL_INDEX(p_index, code_completion_options.size());
  1918. code_completion_current_selected = p_index;
  1919. code_completion_force_item_center = -1;
  1920. code_completion_pan_offset = 0.0f;
  1921. queue_redraw();
  1922. }
  1923. void CodeEdit::confirm_code_completion(bool p_replace) {
  1924. if (!is_editable() || !code_completion_active) {
  1925. return;
  1926. }
  1927. if (GDVIRTUAL_CALL(_confirm_code_completion, p_replace)) {
  1928. return;
  1929. }
  1930. char32_t caret_last_completion_char = 0;
  1931. begin_complex_operation();
  1932. begin_multicaret_edit();
  1933. for (int i = 0; i < get_caret_count(); i++) {
  1934. if (multicaret_edit_ignore_caret(i)) {
  1935. continue;
  1936. }
  1937. int caret_line = get_caret_line(i);
  1938. const String &insert_text = code_completion_options[code_completion_current_selected].insert_text;
  1939. const String &display_text = code_completion_options[code_completion_current_selected].display;
  1940. if (p_replace) {
  1941. // Find end of current section.
  1942. const String line = get_line(caret_line);
  1943. int caret_col = get_caret_column(i);
  1944. int caret_remove_line = caret_line;
  1945. bool merge_text = true;
  1946. int in_string = is_in_string(caret_line, caret_col);
  1947. if (in_string != -1) {
  1948. Point2 string_end = get_delimiter_end_position(caret_line, caret_col);
  1949. if (string_end.x != -1) {
  1950. merge_text = false;
  1951. caret_remove_line = string_end.y;
  1952. caret_col = string_end.x - 1;
  1953. }
  1954. }
  1955. if (merge_text) {
  1956. for (; caret_col < line.length(); caret_col++) {
  1957. if (is_symbol(line[caret_col])) {
  1958. break;
  1959. }
  1960. }
  1961. }
  1962. // Replace.
  1963. remove_text(caret_line, get_caret_column(i) - code_completion_base.length(), caret_remove_line, caret_col);
  1964. insert_text_at_caret(insert_text, i);
  1965. } else {
  1966. // Get first non-matching char.
  1967. const String line = get_line(caret_line);
  1968. int caret_col = get_caret_column(i);
  1969. int matching_chars = code_completion_base.length();
  1970. for (; matching_chars <= insert_text.length(); matching_chars++) {
  1971. if (caret_col >= line.length() || line[caret_col] != insert_text[matching_chars]) {
  1972. break;
  1973. }
  1974. caret_col++;
  1975. }
  1976. // Remove base completion text.
  1977. remove_text(caret_line, get_caret_column(i) - code_completion_base.length(), caret_line, get_caret_column(i));
  1978. // Merge with text.
  1979. insert_text_at_caret(insert_text.substr(0, code_completion_base.length()), i);
  1980. set_caret_column(caret_col, false, i);
  1981. insert_text_at_caret(insert_text.substr(matching_chars), i);
  1982. }
  1983. // Handle merging of symbols eg strings, brackets.
  1984. const String line = get_line(caret_line);
  1985. char32_t next_char = line[get_caret_column(i)];
  1986. char32_t last_completion_char = insert_text[insert_text.length() - 1];
  1987. if (i == 0) {
  1988. caret_last_completion_char = last_completion_char;
  1989. }
  1990. char32_t last_completion_char_display = display_text[display_text.length() - 1];
  1991. bool last_char_matches = (last_completion_char == next_char || last_completion_char_display == next_char);
  1992. int pre_brace_pair = get_caret_column(i) > 0 ? _get_auto_brace_pair_open_at_pos(caret_line, get_caret_column(i)) : -1;
  1993. 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;
  1994. // Strings do not nest like brackets, so ensure we don't add an additional closing pair.
  1995. if (has_string_delimiter(String::chr(last_completion_char))) {
  1996. if (post_brace_pair != -1 && last_char_matches) {
  1997. remove_text(caret_line, get_caret_column(i), caret_line, get_caret_column(i) + 1);
  1998. }
  1999. } else {
  2000. if (pre_brace_pair != -1 && pre_brace_pair != post_brace_pair && last_char_matches) {
  2001. remove_text(caret_line, get_caret_column(i), caret_line, get_caret_column(i) + 1);
  2002. } else if (auto_brace_completion_enabled && pre_brace_pair != -1) {
  2003. insert_text_at_caret(auto_brace_completion_pairs[pre_brace_pair].close_key, i);
  2004. set_caret_column(get_caret_column(i) - auto_brace_completion_pairs[pre_brace_pair].close_key.length(), i == 0, i);
  2005. }
  2006. }
  2007. if (pre_brace_pair == -1 && post_brace_pair == -1 && get_caret_column(i) > 0 && get_caret_column(i) < get_line(caret_line).length()) {
  2008. pre_brace_pair = _get_auto_brace_pair_open_at_pos(caret_line, get_caret_column(i) + 1);
  2009. if (pre_brace_pair != -1 && pre_brace_pair == _get_auto_brace_pair_close_at_pos(caret_line, get_caret_column(i) - 1)) {
  2010. remove_text(caret_line, get_caret_column(i) - 2, caret_line, get_caret_column(i));
  2011. if (_get_auto_brace_pair_close_at_pos(caret_line, get_caret_column(i) + 1) != pre_brace_pair) {
  2012. set_caret_column(get_caret_column(i) + 1, i == 0, i);
  2013. } else {
  2014. set_caret_column(get_caret_column(i) + 2, i == 0, i);
  2015. }
  2016. }
  2017. }
  2018. }
  2019. end_multicaret_edit();
  2020. end_complex_operation();
  2021. cancel_code_completion();
  2022. if (code_completion_prefixes.has(caret_last_completion_char)) {
  2023. request_code_completion();
  2024. }
  2025. }
  2026. void CodeEdit::cancel_code_completion() {
  2027. if (!code_completion_active) {
  2028. return;
  2029. }
  2030. code_completion_forced = false;
  2031. code_completion_active = false;
  2032. is_code_completion_drag_started = false;
  2033. queue_redraw();
  2034. }
  2035. /* Line length guidelines */
  2036. void CodeEdit::set_line_length_guidelines(TypedArray<int> p_guideline_columns) {
  2037. line_length_guideline_columns = p_guideline_columns;
  2038. queue_redraw();
  2039. }
  2040. TypedArray<int> CodeEdit::get_line_length_guidelines() const {
  2041. return line_length_guideline_columns;
  2042. }
  2043. /* Symbol lookup */
  2044. void CodeEdit::set_symbol_lookup_on_click_enabled(bool p_enabled) {
  2045. symbol_lookup_on_click_enabled = p_enabled;
  2046. set_symbol_lookup_word_as_valid(false);
  2047. }
  2048. bool CodeEdit::is_symbol_lookup_on_click_enabled() const {
  2049. return symbol_lookup_on_click_enabled;
  2050. }
  2051. String CodeEdit::get_text_for_symbol_lookup() const {
  2052. Point2i mp = get_local_mouse_pos();
  2053. Point2i pos = get_line_column_at_pos(mp, false, false);
  2054. int line = pos.y;
  2055. int col = pos.x;
  2056. if (line == -1) {
  2057. return String();
  2058. }
  2059. return get_text_with_cursor_char(line, col);
  2060. }
  2061. String CodeEdit::get_text_with_cursor_char(int p_line, int p_column) const {
  2062. const int text_size = get_line_count();
  2063. StringBuilder result;
  2064. for (int i = 0; i < text_size; i++) {
  2065. String line_text = get_line(i);
  2066. if (i == p_line && p_column >= 0 && p_column <= line_text.size()) {
  2067. result += line_text.substr(0, p_column);
  2068. /* Not unicode, represents the cursor. */
  2069. result += String::chr(0xFFFF);
  2070. result += line_text.substr(p_column);
  2071. } else {
  2072. result += line_text;
  2073. }
  2074. if (i != text_size - 1) {
  2075. result += "\n";
  2076. }
  2077. }
  2078. return result.as_string();
  2079. }
  2080. void CodeEdit::set_symbol_lookup_word_as_valid(bool p_valid) {
  2081. symbol_lookup_word = p_valid ? symbol_lookup_new_word : "";
  2082. symbol_lookup_new_word = "";
  2083. if (lookup_symbol_word != symbol_lookup_word) {
  2084. _set_symbol_lookup_word(symbol_lookup_word);
  2085. }
  2086. }
  2087. /* Symbol tooltip */
  2088. void CodeEdit::set_symbol_tooltip_on_hover_enabled(bool p_enabled) {
  2089. symbol_tooltip_on_hover_enabled = p_enabled;
  2090. if (!p_enabled) {
  2091. symbol_tooltip_timer->stop();
  2092. }
  2093. }
  2094. bool CodeEdit::is_symbol_tooltip_on_hover_enabled() const {
  2095. return symbol_tooltip_on_hover_enabled;
  2096. }
  2097. void CodeEdit::_on_symbol_tooltip_timer_timeout() {
  2098. const int line = symbol_tooltip_pos.y;
  2099. const int column = symbol_tooltip_pos.x;
  2100. if (line >= 0 && column >= 0 && !symbol_tooltip_word.is_empty() && !has_selection() && !Input::get_singleton()->is_anything_pressed()) {
  2101. emit_signal(SNAME("symbol_hovered"), symbol_tooltip_word, line, column);
  2102. }
  2103. }
  2104. /* Text manipulation */
  2105. void CodeEdit::move_lines_up() {
  2106. begin_complex_operation();
  2107. begin_multicaret_edit();
  2108. // Move lines up by swapping each line with the one above it.
  2109. Vector<Point2i> line_ranges = get_line_ranges_from_carets();
  2110. for (Point2i line_range : line_ranges) {
  2111. if (line_range.x == 0) {
  2112. continue;
  2113. }
  2114. unfold_line(line_range.x - 1);
  2115. for (int line = line_range.x; line <= line_range.y; line++) {
  2116. unfold_line(line);
  2117. swap_lines(line - 1, line);
  2118. }
  2119. // Fix selection if the last one ends at column 0, since it wasn't moved.
  2120. for (int i = 0; i < get_caret_count(); i++) {
  2121. if (has_selection(i) && get_selection_to_column(i) == 0 && get_selection_to_line(i) == line_range.y + 1) {
  2122. if (is_caret_after_selection_origin(i)) {
  2123. set_caret_line(get_caret_line(i) - 1, false, true, -1, i);
  2124. } else {
  2125. set_selection_origin_line(get_selection_origin_line(i) - 1, true, -1, i);
  2126. }
  2127. break;
  2128. }
  2129. }
  2130. }
  2131. adjust_viewport_to_caret();
  2132. end_multicaret_edit();
  2133. end_complex_operation();
  2134. }
  2135. void CodeEdit::move_lines_down() {
  2136. begin_complex_operation();
  2137. begin_multicaret_edit();
  2138. // Move lines down by swapping each line with the one below it.
  2139. Vector<Point2i> line_ranges = get_line_ranges_from_carets();
  2140. // Reverse in case line ranges are adjacent, if the first ends at column 0.
  2141. line_ranges.reverse();
  2142. for (Point2i line_range : line_ranges) {
  2143. if (line_range.y == get_line_count() - 1) {
  2144. continue;
  2145. }
  2146. // Fix selection if the last one ends at column 0, since it won't be moved.
  2147. bool selection_to_line_at_end = false;
  2148. for (int i = 0; i < get_caret_count(); i++) {
  2149. if (has_selection(i) && get_selection_to_column(i) == 0 && get_selection_to_line(i) == line_range.y + 1) {
  2150. selection_to_line_at_end = get_selection_to_line(i) == get_line_count() - 1;
  2151. if (selection_to_line_at_end) {
  2152. break;
  2153. }
  2154. if (is_caret_after_selection_origin(i)) {
  2155. set_caret_line(get_caret_line(i) + 1, false, true, -1, i);
  2156. } else {
  2157. set_selection_origin_line(get_selection_origin_line(i) + 1, true, -1, i);
  2158. }
  2159. break;
  2160. }
  2161. }
  2162. if (selection_to_line_at_end) {
  2163. continue;
  2164. }
  2165. unfold_line(line_range.y + 1);
  2166. for (int line = line_range.y; line >= line_range.x; line--) {
  2167. unfold_line(line);
  2168. swap_lines(line + 1, line);
  2169. }
  2170. }
  2171. adjust_viewport_to_caret();
  2172. end_multicaret_edit();
  2173. end_complex_operation();
  2174. }
  2175. void CodeEdit::delete_lines() {
  2176. begin_complex_operation();
  2177. begin_multicaret_edit();
  2178. Vector<Point2i> line_ranges = get_line_ranges_from_carets();
  2179. int line_offset = 0;
  2180. for (Point2i line_range : line_ranges) {
  2181. // Remove last line of range separately to preserve carets.
  2182. unfold_line(line_range.y + line_offset);
  2183. remove_line_at(line_range.y + line_offset);
  2184. if (line_range.x != line_range.y) {
  2185. remove_text(line_range.x + line_offset, 0, line_range.y + line_offset, 0);
  2186. }
  2187. line_offset += line_range.x - line_range.y - 1;
  2188. }
  2189. // Deselect all.
  2190. deselect();
  2191. end_multicaret_edit();
  2192. end_complex_operation();
  2193. }
  2194. void CodeEdit::duplicate_selection() {
  2195. begin_complex_operation();
  2196. begin_multicaret_edit();
  2197. // Duplicate lines from carets without selections first.
  2198. for (int i = 0; i < get_caret_count(); i++) {
  2199. if (multicaret_edit_ignore_caret(i)) {
  2200. continue;
  2201. }
  2202. for (int l = get_selection_from_line(i); l <= get_selection_to_line(i); l++) {
  2203. unfold_line(l);
  2204. }
  2205. if (has_selection(i)) {
  2206. continue;
  2207. }
  2208. String text_to_insert = get_line(get_caret_line(i)) + "\n";
  2209. // Insert new text before the line, so the caret is on the second one.
  2210. insert_text(text_to_insert, get_caret_line(i), 0);
  2211. }
  2212. // Duplicate selections.
  2213. for (int i = 0; i < get_caret_count(); i++) {
  2214. if (multicaret_edit_ignore_caret(i)) {
  2215. continue;
  2216. }
  2217. if (!has_selection(i)) {
  2218. continue;
  2219. }
  2220. // Insert new text before the selection, so the caret is on the second one.
  2221. insert_text(get_selected_text(i), get_selection_from_line(i), get_selection_from_column(i));
  2222. }
  2223. end_multicaret_edit();
  2224. end_complex_operation();
  2225. }
  2226. void CodeEdit::duplicate_lines() {
  2227. begin_complex_operation();
  2228. begin_multicaret_edit();
  2229. Vector<Point2i> line_ranges = get_line_ranges_from_carets(false, false);
  2230. int line_offset = 0;
  2231. for (Point2i line_range : line_ranges) {
  2232. // The text that will be inserted. All lines in one string.
  2233. String text_to_insert;
  2234. for (int i = line_range.x + line_offset; i <= line_range.y + line_offset; i++) {
  2235. text_to_insert += get_line(i) + "\n";
  2236. unfold_line(i);
  2237. }
  2238. // Insert new text before the line.
  2239. insert_text(text_to_insert, line_range.x + line_offset, 0);
  2240. line_offset += line_range.y - line_range.x + 1;
  2241. }
  2242. end_multicaret_edit();
  2243. end_complex_operation();
  2244. }
  2245. /* Visual */
  2246. Color CodeEdit::_get_brace_mismatch_color() const {
  2247. return theme_cache.brace_mismatch_color;
  2248. }
  2249. Color CodeEdit::_get_code_folding_color() const {
  2250. return theme_cache.code_folding_color;
  2251. }
  2252. Ref<Texture2D> CodeEdit::_get_folded_eol_icon() const {
  2253. return theme_cache.folded_eol_icon;
  2254. }
  2255. void CodeEdit::_bind_methods() {
  2256. /* Indent management */
  2257. ClassDB::bind_method(D_METHOD("set_indent_size", "size"), &CodeEdit::set_indent_size);
  2258. ClassDB::bind_method(D_METHOD("get_indent_size"), &CodeEdit::get_indent_size);
  2259. ClassDB::bind_method(D_METHOD("set_indent_using_spaces", "use_spaces"), &CodeEdit::set_indent_using_spaces);
  2260. ClassDB::bind_method(D_METHOD("is_indent_using_spaces"), &CodeEdit::is_indent_using_spaces);
  2261. ClassDB::bind_method(D_METHOD("set_auto_indent_enabled", "enable"), &CodeEdit::set_auto_indent_enabled);
  2262. ClassDB::bind_method(D_METHOD("is_auto_indent_enabled"), &CodeEdit::is_auto_indent_enabled);
  2263. ClassDB::bind_method(D_METHOD("set_auto_indent_prefixes", "prefixes"), &CodeEdit::set_auto_indent_prefixes);
  2264. ClassDB::bind_method(D_METHOD("get_auto_indent_prefixes"), &CodeEdit::get_auto_indent_prefixes);
  2265. ClassDB::bind_method(D_METHOD("do_indent"), &CodeEdit::do_indent);
  2266. ClassDB::bind_method(D_METHOD("indent_lines"), &CodeEdit::indent_lines);
  2267. ClassDB::bind_method(D_METHOD("unindent_lines"), &CodeEdit::unindent_lines);
  2268. ClassDB::bind_method(D_METHOD("convert_indent", "from_line", "to_line"), &CodeEdit::convert_indent, DEFVAL(-1), DEFVAL(-1));
  2269. /* Auto brace completion */
  2270. ClassDB::bind_method(D_METHOD("set_auto_brace_completion_enabled", "enable"), &CodeEdit::set_auto_brace_completion_enabled);
  2271. ClassDB::bind_method(D_METHOD("is_auto_brace_completion_enabled"), &CodeEdit::is_auto_brace_completion_enabled);
  2272. ClassDB::bind_method(D_METHOD("set_highlight_matching_braces_enabled", "enable"), &CodeEdit::set_highlight_matching_braces_enabled);
  2273. ClassDB::bind_method(D_METHOD("is_highlight_matching_braces_enabled"), &CodeEdit::is_highlight_matching_braces_enabled);
  2274. ClassDB::bind_method(D_METHOD("add_auto_brace_completion_pair", "start_key", "end_key"), &CodeEdit::add_auto_brace_completion_pair);
  2275. ClassDB::bind_method(D_METHOD("set_auto_brace_completion_pairs", "pairs"), &CodeEdit::set_auto_brace_completion_pairs);
  2276. ClassDB::bind_method(D_METHOD("get_auto_brace_completion_pairs"), &CodeEdit::get_auto_brace_completion_pairs);
  2277. ClassDB::bind_method(D_METHOD("has_auto_brace_completion_open_key", "open_key"), &CodeEdit::has_auto_brace_completion_open_key);
  2278. ClassDB::bind_method(D_METHOD("has_auto_brace_completion_close_key", "close_key"), &CodeEdit::has_auto_brace_completion_close_key);
  2279. ClassDB::bind_method(D_METHOD("get_auto_brace_completion_close_key", "open_key"), &CodeEdit::get_auto_brace_completion_close_key);
  2280. /* Main Gutter */
  2281. ClassDB::bind_method(D_METHOD("set_draw_breakpoints_gutter", "enable"), &CodeEdit::set_draw_breakpoints_gutter);
  2282. ClassDB::bind_method(D_METHOD("is_drawing_breakpoints_gutter"), &CodeEdit::is_drawing_breakpoints_gutter);
  2283. ClassDB::bind_method(D_METHOD("set_draw_bookmarks_gutter", "enable"), &CodeEdit::set_draw_bookmarks_gutter);
  2284. ClassDB::bind_method(D_METHOD("is_drawing_bookmarks_gutter"), &CodeEdit::is_drawing_bookmarks_gutter);
  2285. ClassDB::bind_method(D_METHOD("set_draw_executing_lines_gutter", "enable"), &CodeEdit::set_draw_executing_lines_gutter);
  2286. ClassDB::bind_method(D_METHOD("is_drawing_executing_lines_gutter"), &CodeEdit::is_drawing_executing_lines_gutter);
  2287. // Breakpoints
  2288. ClassDB::bind_method(D_METHOD("set_line_as_breakpoint", "line", "breakpointed"), &CodeEdit::set_line_as_breakpoint);
  2289. ClassDB::bind_method(D_METHOD("is_line_breakpointed", "line"), &CodeEdit::is_line_breakpointed);
  2290. ClassDB::bind_method(D_METHOD("clear_breakpointed_lines"), &CodeEdit::clear_breakpointed_lines);
  2291. ClassDB::bind_method(D_METHOD("get_breakpointed_lines"), &CodeEdit::get_breakpointed_lines);
  2292. // Bookmarks
  2293. ClassDB::bind_method(D_METHOD("set_line_as_bookmarked", "line", "bookmarked"), &CodeEdit::set_line_as_bookmarked);
  2294. ClassDB::bind_method(D_METHOD("is_line_bookmarked", "line"), &CodeEdit::is_line_bookmarked);
  2295. ClassDB::bind_method(D_METHOD("clear_bookmarked_lines"), &CodeEdit::clear_bookmarked_lines);
  2296. ClassDB::bind_method(D_METHOD("get_bookmarked_lines"), &CodeEdit::get_bookmarked_lines);
  2297. // Executing lines
  2298. ClassDB::bind_method(D_METHOD("set_line_as_executing", "line", "executing"), &CodeEdit::set_line_as_executing);
  2299. ClassDB::bind_method(D_METHOD("is_line_executing", "line"), &CodeEdit::is_line_executing);
  2300. ClassDB::bind_method(D_METHOD("clear_executing_lines"), &CodeEdit::clear_executing_lines);
  2301. ClassDB::bind_method(D_METHOD("get_executing_lines"), &CodeEdit::get_executing_lines);
  2302. /* Line numbers */
  2303. ClassDB::bind_method(D_METHOD("set_draw_line_numbers", "enable"), &CodeEdit::set_draw_line_numbers);
  2304. ClassDB::bind_method(D_METHOD("is_draw_line_numbers_enabled"), &CodeEdit::is_draw_line_numbers_enabled);
  2305. ClassDB::bind_method(D_METHOD("set_line_numbers_zero_padded", "enable"), &CodeEdit::set_line_numbers_zero_padded);
  2306. ClassDB::bind_method(D_METHOD("is_line_numbers_zero_padded"), &CodeEdit::is_line_numbers_zero_padded);
  2307. /* Fold Gutter */
  2308. ClassDB::bind_method(D_METHOD("set_draw_fold_gutter", "enable"), &CodeEdit::set_draw_fold_gutter);
  2309. ClassDB::bind_method(D_METHOD("is_drawing_fold_gutter"), &CodeEdit::is_drawing_fold_gutter);
  2310. /* Line folding */
  2311. ClassDB::bind_method(D_METHOD("set_line_folding_enabled", "enabled"), &CodeEdit::set_line_folding_enabled);
  2312. ClassDB::bind_method(D_METHOD("is_line_folding_enabled"), &CodeEdit::is_line_folding_enabled);
  2313. ClassDB::bind_method(D_METHOD("can_fold_line", "line"), &CodeEdit::can_fold_line);
  2314. ClassDB::bind_method(D_METHOD("fold_line", "line"), &CodeEdit::fold_line);
  2315. ClassDB::bind_method(D_METHOD("unfold_line", "line"), &CodeEdit::unfold_line);
  2316. ClassDB::bind_method(D_METHOD("fold_all_lines"), &CodeEdit::fold_all_lines);
  2317. ClassDB::bind_method(D_METHOD("unfold_all_lines"), &CodeEdit::unfold_all_lines);
  2318. ClassDB::bind_method(D_METHOD("toggle_foldable_line", "line"), &CodeEdit::toggle_foldable_line);
  2319. ClassDB::bind_method(D_METHOD("toggle_foldable_lines_at_carets"), &CodeEdit::toggle_foldable_lines_at_carets);
  2320. ClassDB::bind_method(D_METHOD("is_line_folded", "line"), &CodeEdit::is_line_folded);
  2321. ClassDB::bind_method(D_METHOD("get_folded_lines"), &CodeEdit::get_folded_lines);
  2322. /* Code region */
  2323. ClassDB::bind_method(D_METHOD("create_code_region"), &CodeEdit::create_code_region);
  2324. ClassDB::bind_method(D_METHOD("get_code_region_start_tag"), &CodeEdit::get_code_region_start_tag);
  2325. ClassDB::bind_method(D_METHOD("get_code_region_end_tag"), &CodeEdit::get_code_region_end_tag);
  2326. ClassDB::bind_method(D_METHOD("set_code_region_tags", "start", "end"), &CodeEdit::set_code_region_tags, DEFVAL("region"), DEFVAL("endregion"));
  2327. ClassDB::bind_method(D_METHOD("is_line_code_region_start", "line"), &CodeEdit::is_line_code_region_start);
  2328. ClassDB::bind_method(D_METHOD("is_line_code_region_end", "line"), &CodeEdit::is_line_code_region_end);
  2329. /* Delimiters */
  2330. // Strings
  2331. ClassDB::bind_method(D_METHOD("add_string_delimiter", "start_key", "end_key", "line_only"), &CodeEdit::add_string_delimiter, DEFVAL(false));
  2332. ClassDB::bind_method(D_METHOD("remove_string_delimiter", "start_key"), &CodeEdit::remove_string_delimiter);
  2333. ClassDB::bind_method(D_METHOD("has_string_delimiter", "start_key"), &CodeEdit::has_string_delimiter);
  2334. ClassDB::bind_method(D_METHOD("set_string_delimiters", "string_delimiters"), &CodeEdit::set_string_delimiters);
  2335. ClassDB::bind_method(D_METHOD("clear_string_delimiters"), &CodeEdit::clear_string_delimiters);
  2336. ClassDB::bind_method(D_METHOD("get_string_delimiters"), &CodeEdit::get_string_delimiters);
  2337. ClassDB::bind_method(D_METHOD("is_in_string", "line", "column"), &CodeEdit::is_in_string, DEFVAL(-1));
  2338. // Comments
  2339. ClassDB::bind_method(D_METHOD("add_comment_delimiter", "start_key", "end_key", "line_only"), &CodeEdit::add_comment_delimiter, DEFVAL(false));
  2340. ClassDB::bind_method(D_METHOD("remove_comment_delimiter", "start_key"), &CodeEdit::remove_comment_delimiter);
  2341. ClassDB::bind_method(D_METHOD("has_comment_delimiter", "start_key"), &CodeEdit::has_comment_delimiter);
  2342. ClassDB::bind_method(D_METHOD("set_comment_delimiters", "comment_delimiters"), &CodeEdit::set_comment_delimiters);
  2343. ClassDB::bind_method(D_METHOD("clear_comment_delimiters"), &CodeEdit::clear_comment_delimiters);
  2344. ClassDB::bind_method(D_METHOD("get_comment_delimiters"), &CodeEdit::get_comment_delimiters);
  2345. ClassDB::bind_method(D_METHOD("is_in_comment", "line", "column"), &CodeEdit::is_in_comment, DEFVAL(-1));
  2346. // Util
  2347. ClassDB::bind_method(D_METHOD("get_delimiter_start_key", "delimiter_index"), &CodeEdit::get_delimiter_start_key);
  2348. ClassDB::bind_method(D_METHOD("get_delimiter_end_key", "delimiter_index"), &CodeEdit::get_delimiter_end_key);
  2349. ClassDB::bind_method(D_METHOD("get_delimiter_start_position", "line", "column"), &CodeEdit::get_delimiter_start_position);
  2350. ClassDB::bind_method(D_METHOD("get_delimiter_end_position", "line", "column"), &CodeEdit::get_delimiter_end_position);
  2351. /* Code hint */
  2352. ClassDB::bind_method(D_METHOD("set_code_hint", "code_hint"), &CodeEdit::set_code_hint);
  2353. ClassDB::bind_method(D_METHOD("set_code_hint_draw_below", "draw_below"), &CodeEdit::set_code_hint_draw_below);
  2354. /* Code Completion */
  2355. BIND_ENUM_CONSTANT(KIND_CLASS);
  2356. BIND_ENUM_CONSTANT(KIND_FUNCTION);
  2357. BIND_ENUM_CONSTANT(KIND_SIGNAL);
  2358. BIND_ENUM_CONSTANT(KIND_VARIABLE);
  2359. BIND_ENUM_CONSTANT(KIND_MEMBER);
  2360. BIND_ENUM_CONSTANT(KIND_ENUM);
  2361. BIND_ENUM_CONSTANT(KIND_CONSTANT);
  2362. BIND_ENUM_CONSTANT(KIND_NODE_PATH);
  2363. BIND_ENUM_CONSTANT(KIND_FILE_PATH);
  2364. BIND_ENUM_CONSTANT(KIND_PLAIN_TEXT);
  2365. BIND_ENUM_CONSTANT(LOCATION_LOCAL);
  2366. BIND_ENUM_CONSTANT(LOCATION_PARENT_MASK);
  2367. BIND_ENUM_CONSTANT(LOCATION_OTHER_USER_CODE)
  2368. BIND_ENUM_CONSTANT(LOCATION_OTHER);
  2369. ClassDB::bind_method(D_METHOD("get_text_for_code_completion"), &CodeEdit::get_text_for_code_completion);
  2370. ClassDB::bind_method(D_METHOD("request_code_completion", "force"), &CodeEdit::request_code_completion, DEFVAL(false));
  2371. 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));
  2372. ClassDB::bind_method(D_METHOD("update_code_completion_options", "force"), &CodeEdit::update_code_completion_options);
  2373. ClassDB::bind_method(D_METHOD("get_code_completion_options"), &CodeEdit::get_code_completion_options);
  2374. ClassDB::bind_method(D_METHOD("get_code_completion_option", "index"), &CodeEdit::get_code_completion_option);
  2375. ClassDB::bind_method(D_METHOD("get_code_completion_selected_index"), &CodeEdit::get_code_completion_selected_index);
  2376. ClassDB::bind_method(D_METHOD("set_code_completion_selected_index", "index"), &CodeEdit::set_code_completion_selected_index);
  2377. ClassDB::bind_method(D_METHOD("confirm_code_completion", "replace"), &CodeEdit::confirm_code_completion, DEFVAL(false));
  2378. ClassDB::bind_method(D_METHOD("cancel_code_completion"), &CodeEdit::cancel_code_completion);
  2379. ClassDB::bind_method(D_METHOD("set_code_completion_enabled", "enable"), &CodeEdit::set_code_completion_enabled);
  2380. ClassDB::bind_method(D_METHOD("is_code_completion_enabled"), &CodeEdit::is_code_completion_enabled);
  2381. ClassDB::bind_method(D_METHOD("set_code_completion_prefixes", "prefixes"), &CodeEdit::set_code_completion_prefixes);
  2382. ClassDB::bind_method(D_METHOD("get_code_completion_prefixes"), &CodeEdit::get_code_completion_prefixes);
  2383. // Overridable
  2384. GDVIRTUAL_BIND(_confirm_code_completion, "replace")
  2385. GDVIRTUAL_BIND(_request_code_completion, "force")
  2386. GDVIRTUAL_BIND(_filter_code_completion_candidates, "candidates")
  2387. /* Line length guidelines */
  2388. ClassDB::bind_method(D_METHOD("set_line_length_guidelines", "guideline_columns"), &CodeEdit::set_line_length_guidelines);
  2389. ClassDB::bind_method(D_METHOD("get_line_length_guidelines"), &CodeEdit::get_line_length_guidelines);
  2390. /* Symbol lookup */
  2391. ClassDB::bind_method(D_METHOD("set_symbol_lookup_on_click_enabled", "enable"), &CodeEdit::set_symbol_lookup_on_click_enabled);
  2392. ClassDB::bind_method(D_METHOD("is_symbol_lookup_on_click_enabled"), &CodeEdit::is_symbol_lookup_on_click_enabled);
  2393. ClassDB::bind_method(D_METHOD("get_text_for_symbol_lookup"), &CodeEdit::get_text_for_symbol_lookup);
  2394. ClassDB::bind_method(D_METHOD("get_text_with_cursor_char", "line", "column"), &CodeEdit::get_text_with_cursor_char);
  2395. ClassDB::bind_method(D_METHOD("set_symbol_lookup_word_as_valid", "valid"), &CodeEdit::set_symbol_lookup_word_as_valid);
  2396. /* Symbol tooltip */
  2397. ClassDB::bind_method(D_METHOD("set_symbol_tooltip_on_hover_enabled", "enable"), &CodeEdit::set_symbol_tooltip_on_hover_enabled);
  2398. ClassDB::bind_method(D_METHOD("is_symbol_tooltip_on_hover_enabled"), &CodeEdit::is_symbol_tooltip_on_hover_enabled);
  2399. /* Text manipulation */
  2400. ClassDB::bind_method(D_METHOD("move_lines_up"), &CodeEdit::move_lines_up);
  2401. ClassDB::bind_method(D_METHOD("move_lines_down"), &CodeEdit::move_lines_down);
  2402. ClassDB::bind_method(D_METHOD("delete_lines"), &CodeEdit::delete_lines);
  2403. ClassDB::bind_method(D_METHOD("duplicate_selection"), &CodeEdit::duplicate_selection);
  2404. ClassDB::bind_method(D_METHOD("duplicate_lines"), &CodeEdit::duplicate_lines);
  2405. /* Inspector */
  2406. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "symbol_lookup_on_click"), "set_symbol_lookup_on_click_enabled", "is_symbol_lookup_on_click_enabled");
  2407. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "symbol_tooltip_on_hover"), "set_symbol_tooltip_on_hover_enabled", "is_symbol_tooltip_on_hover_enabled");
  2408. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "line_folding"), "set_line_folding_enabled", "is_line_folding_enabled");
  2409. ADD_PROPERTY(PropertyInfo(Variant::PACKED_INT32_ARRAY, "line_length_guidelines"), "set_line_length_guidelines", "get_line_length_guidelines");
  2410. ADD_GROUP("Gutters", "gutters_");
  2411. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_breakpoints_gutter"), "set_draw_breakpoints_gutter", "is_drawing_breakpoints_gutter");
  2412. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_bookmarks"), "set_draw_bookmarks_gutter", "is_drawing_bookmarks_gutter");
  2413. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_executing_lines"), "set_draw_executing_lines_gutter", "is_drawing_executing_lines_gutter");
  2414. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_line_numbers"), "set_draw_line_numbers", "is_draw_line_numbers_enabled");
  2415. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_zero_pad_line_numbers"), "set_line_numbers_zero_padded", "is_line_numbers_zero_padded");
  2416. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_fold_gutter"), "set_draw_fold_gutter", "is_drawing_fold_gutter");
  2417. ADD_GROUP("Delimiters", "delimiter_");
  2418. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "delimiter_strings"), "set_string_delimiters", "get_string_delimiters");
  2419. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "delimiter_comments"), "set_comment_delimiters", "get_comment_delimiters");
  2420. ADD_GROUP("Code Completion", "code_completion_");
  2421. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "code_completion_enabled"), "set_code_completion_enabled", "is_code_completion_enabled");
  2422. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "code_completion_prefixes"), "set_code_completion_prefixes", "get_code_completion_prefixes");
  2423. ADD_GROUP("Indentation", "indent_");
  2424. ADD_PROPERTY(PropertyInfo(Variant::INT, "indent_size"), "set_indent_size", "get_indent_size");
  2425. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "indent_use_spaces"), "set_indent_using_spaces", "is_indent_using_spaces");
  2426. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "indent_automatic"), "set_auto_indent_enabled", "is_auto_indent_enabled");
  2427. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "indent_automatic_prefixes"), "set_auto_indent_prefixes", "get_auto_indent_prefixes");
  2428. ADD_GROUP("Auto Brace Completion", "auto_brace_completion_");
  2429. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "auto_brace_completion_enabled"), "set_auto_brace_completion_enabled", "is_auto_brace_completion_enabled");
  2430. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "auto_brace_completion_highlight_matching"), "set_highlight_matching_braces_enabled", "is_highlight_matching_braces_enabled");
  2431. ADD_PROPERTY(PropertyInfo(Variant::DICTIONARY, "auto_brace_completion_pairs"), "set_auto_brace_completion_pairs", "get_auto_brace_completion_pairs");
  2432. /* Signals */
  2433. /* Gutters */
  2434. ADD_SIGNAL(MethodInfo("breakpoint_toggled", PropertyInfo(Variant::INT, "line")));
  2435. /* Code Completion */
  2436. ADD_SIGNAL(MethodInfo("code_completion_requested"));
  2437. /* Symbol lookup */
  2438. ADD_SIGNAL(MethodInfo("symbol_lookup", PropertyInfo(Variant::STRING, "symbol"), PropertyInfo(Variant::INT, "line"), PropertyInfo(Variant::INT, "column")));
  2439. ADD_SIGNAL(MethodInfo("symbol_validate", PropertyInfo(Variant::STRING, "symbol")));
  2440. /* Symbol tooltip */
  2441. ADD_SIGNAL(MethodInfo("symbol_hovered", PropertyInfo(Variant::STRING, "symbol"), PropertyInfo(Variant::INT, "line"), PropertyInfo(Variant::INT, "column")));
  2442. /* Theme items */
  2443. /* Gutters */
  2444. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, code_folding_color);
  2445. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, folded_code_region_color);
  2446. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, can_fold_icon, "can_fold");
  2447. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, folded_icon, "folded");
  2448. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, can_fold_code_region_icon, "can_fold_code_region");
  2449. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, folded_code_region_icon, "folded_code_region");
  2450. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, CodeEdit, folded_eol_icon);
  2451. BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, CodeEdit, completion_color_bg);
  2452. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, breakpoint_color);
  2453. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, breakpoint_icon, "breakpoint");
  2454. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, bookmark_color);
  2455. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, bookmark_icon, "bookmark");
  2456. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, executing_line_color);
  2457. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_ICON, CodeEdit, executing_line_icon, "executing_line");
  2458. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, line_number_color);
  2459. /* Code Completion */
  2460. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_STYLEBOX, CodeEdit, code_completion_style, "completion");
  2461. BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_CONSTANT, CodeEdit, code_completion_icon_separation, "h_separation", "ItemList");
  2462. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_CONSTANT, CodeEdit, code_completion_max_width, "completion_max_width");
  2463. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_CONSTANT, CodeEdit, code_completion_max_lines, "completion_lines");
  2464. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_CONSTANT, CodeEdit, code_completion_scroll_width, "completion_scroll_width");
  2465. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_COLOR, CodeEdit, code_completion_scroll_color, "completion_scroll_color");
  2466. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_COLOR, CodeEdit, code_completion_scroll_hovered_color, "completion_scroll_hovered_color");
  2467. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_COLOR, CodeEdit, code_completion_background_color, "completion_background_color");
  2468. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_COLOR, CodeEdit, code_completion_selected_color, "completion_selected_color");
  2469. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_COLOR, CodeEdit, code_completion_existing_color, "completion_existing_color");
  2470. /* Code hint */
  2471. BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_STYLEBOX, CodeEdit, code_hint_style, "panel", "TooltipPanel");
  2472. BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, CodeEdit, code_hint_color, "font_color", "TooltipLabel");
  2473. /* Line length guideline */
  2474. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, line_length_guideline_color);
  2475. /* Other visuals */
  2476. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_STYLEBOX, CodeEdit, style_normal, "normal");
  2477. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, CodeEdit, brace_mismatch_color);
  2478. BIND_THEME_ITEM(Theme::DATA_TYPE_FONT, CodeEdit, font);
  2479. BIND_THEME_ITEM(Theme::DATA_TYPE_FONT_SIZE, CodeEdit, font_size);
  2480. BIND_THEME_ITEM(Theme::DATA_TYPE_CONSTANT, CodeEdit, line_spacing);
  2481. }
  2482. /* Auto brace completion */
  2483. int CodeEdit::_get_auto_brace_pair_open_at_pos(int p_line, int p_col) {
  2484. const String &line = get_line(p_line);
  2485. /* Should be fast enough, expecting low amount of pairs... */
  2486. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  2487. const String &open_key = auto_brace_completion_pairs[i].open_key;
  2488. if (p_col - open_key.length() < 0) {
  2489. continue;
  2490. }
  2491. bool is_match = true;
  2492. for (int j = 0; j < open_key.length(); j++) {
  2493. if (line[(p_col - 1) - j] != open_key[(open_key.length() - 1) - j]) {
  2494. is_match = false;
  2495. break;
  2496. }
  2497. }
  2498. if (is_match) {
  2499. return i;
  2500. }
  2501. }
  2502. return -1;
  2503. }
  2504. int CodeEdit::_get_auto_brace_pair_close_at_pos(int p_line, int p_col) {
  2505. const String &line = get_line(p_line);
  2506. /* Should be fast enough, expecting low amount of pairs... */
  2507. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  2508. if (p_col + auto_brace_completion_pairs[i].close_key.length() > line.length()) {
  2509. continue;
  2510. }
  2511. bool is_match = true;
  2512. for (int j = 0; j < auto_brace_completion_pairs[i].close_key.length(); j++) {
  2513. if (line[p_col + j] != auto_brace_completion_pairs[i].close_key[j]) {
  2514. is_match = false;
  2515. break;
  2516. }
  2517. }
  2518. if (is_match) {
  2519. return i;
  2520. }
  2521. }
  2522. return -1;
  2523. }
  2524. /* Gutters */
  2525. void CodeEdit::_gutter_clicked(int p_line, int p_gutter) {
  2526. bool shift_pressed = Input::get_singleton()->is_key_pressed(Key::SHIFT);
  2527. if (p_gutter == main_gutter) {
  2528. if (draw_breakpoints && !shift_pressed) {
  2529. set_line_as_breakpoint(p_line, !is_line_breakpointed(p_line));
  2530. } else if (draw_bookmarks && shift_pressed) {
  2531. set_line_as_bookmarked(p_line, !is_line_bookmarked(p_line));
  2532. }
  2533. return;
  2534. }
  2535. if (p_gutter == line_number_gutter) {
  2536. remove_secondary_carets();
  2537. set_selection_mode(TextEdit::SelectionMode::SELECTION_MODE_LINE);
  2538. if (p_line == get_line_count() - 1) {
  2539. select(p_line, 0, p_line, INT_MAX);
  2540. } else {
  2541. select(p_line, 0, p_line + 1, 0);
  2542. }
  2543. return;
  2544. }
  2545. if (p_gutter == fold_gutter) {
  2546. if (is_line_folded(p_line)) {
  2547. unfold_line(p_line);
  2548. } else if (can_fold_line(p_line)) {
  2549. fold_line(p_line);
  2550. }
  2551. return;
  2552. }
  2553. }
  2554. void CodeEdit::_update_gutter_indexes() {
  2555. for (int i = 0; i < get_gutter_count(); i++) {
  2556. if (get_gutter_name(i) == "main_gutter") {
  2557. main_gutter = i;
  2558. continue;
  2559. }
  2560. if (get_gutter_name(i) == "line_numbers") {
  2561. line_number_gutter = i;
  2562. continue;
  2563. }
  2564. if (get_gutter_name(i) == "fold_gutter") {
  2565. fold_gutter = i;
  2566. continue;
  2567. }
  2568. }
  2569. }
  2570. /* Code Region */
  2571. void CodeEdit::_update_code_region_tags() {
  2572. code_region_start_string = "";
  2573. code_region_end_string = "";
  2574. if (code_region_start_tag.is_empty() || code_region_end_tag.is_empty()) {
  2575. return;
  2576. }
  2577. // A shorter delimiter has higher priority.
  2578. for (int i = delimiters.size() - 1; i >= 0; i--) {
  2579. if (delimiters[i].type != DelimiterType::TYPE_COMMENT) {
  2580. continue;
  2581. }
  2582. if (delimiters[i].end_key.is_empty() && delimiters[i].line_only == true) {
  2583. code_region_start_string = delimiters[i].start_key + code_region_start_tag;
  2584. code_region_end_string = delimiters[i].start_key + code_region_end_tag;
  2585. return;
  2586. }
  2587. }
  2588. }
  2589. /* Delimiters */
  2590. void CodeEdit::_update_delimiter_cache(int p_from_line, int p_to_line) {
  2591. if (delimiters.is_empty()) {
  2592. return;
  2593. }
  2594. int line_count = get_line_count();
  2595. if (p_to_line == -1) {
  2596. p_to_line = line_count;
  2597. }
  2598. int start_line = MIN(p_from_line, p_to_line);
  2599. int end_line = MAX(p_from_line, p_to_line);
  2600. /* Make sure delimiter_cache has all the lines. */
  2601. if (start_line != end_line) {
  2602. if (p_to_line < p_from_line) {
  2603. for (int i = end_line; i > start_line; i--) {
  2604. delimiter_cache.remove_at(i);
  2605. }
  2606. } else {
  2607. for (int i = start_line; i < end_line; i++) {
  2608. delimiter_cache.insert(i, RBMap<int, int>());
  2609. }
  2610. }
  2611. }
  2612. int in_region = -1;
  2613. for (int i = start_line; i < MIN(end_line + 1, line_count); i++) {
  2614. int current_end_region = (i < 0 || delimiter_cache[i].size() < 1) ? -1 : delimiter_cache[i].back()->value();
  2615. in_region = (i <= 0 || delimiter_cache[i - 1].size() < 1) ? -1 : delimiter_cache[i - 1].back()->value();
  2616. const String &str = get_line(i);
  2617. const int line_length = str.length();
  2618. delimiter_cache.write[i].clear();
  2619. if (str.length() == 0) {
  2620. if (in_region != -1) {
  2621. delimiter_cache.write[i][0] = in_region;
  2622. }
  2623. if (i == end_line && current_end_region != in_region) {
  2624. end_line++;
  2625. end_line = MIN(end_line, line_count);
  2626. }
  2627. continue;
  2628. }
  2629. int end_region = -1;
  2630. for (int j = 0; j < line_length; j++) {
  2631. int from = j;
  2632. for (; from < line_length; from++) {
  2633. if (str[from] == '\\') {
  2634. from++;
  2635. continue;
  2636. }
  2637. break;
  2638. }
  2639. /* check if we are in entering a region */
  2640. bool same_line = false;
  2641. if (in_region == -1) {
  2642. for (int d = 0; d < delimiters.size(); d++) {
  2643. /* check there is enough room */
  2644. int chars_left = line_length - from;
  2645. int start_key_length = delimiters[d].start_key.length();
  2646. int end_key_length = delimiters[d].end_key.length();
  2647. if (chars_left < start_key_length) {
  2648. continue;
  2649. }
  2650. /* search the line */
  2651. bool match = true;
  2652. const char32_t *start_key = delimiters[d].start_key.get_data();
  2653. for (int k = 0; k < start_key_length; k++) {
  2654. if (start_key[k] != str[from + k]) {
  2655. match = false;
  2656. break;
  2657. }
  2658. }
  2659. if (!match) {
  2660. continue;
  2661. }
  2662. same_line = true;
  2663. in_region = d;
  2664. delimiter_cache.write[i][from + 1] = d;
  2665. from += start_key_length;
  2666. /* check if it's the whole line */
  2667. if (end_key_length == 0 || delimiters[d].line_only || from + end_key_length > line_length) {
  2668. j = line_length;
  2669. if (delimiters[d].line_only) {
  2670. delimiter_cache.write[i][line_length + 1] = -1;
  2671. } else {
  2672. end_region = in_region;
  2673. }
  2674. }
  2675. break;
  2676. }
  2677. if (j == line_length || in_region == -1) {
  2678. continue;
  2679. }
  2680. }
  2681. /* if we are in one find the end key */
  2682. /* search the line */
  2683. int region_end_index = -1;
  2684. int end_key_length = delimiters[in_region].end_key.length();
  2685. const char32_t *end_key = delimiters[in_region].end_key.get_data();
  2686. for (; from < line_length; from++) {
  2687. if (line_length - from < end_key_length) {
  2688. break;
  2689. }
  2690. if (!is_symbol(str[from])) {
  2691. continue;
  2692. }
  2693. if (str[from] == '\\') {
  2694. from++;
  2695. continue;
  2696. }
  2697. region_end_index = from;
  2698. for (int k = 0; k < end_key_length; k++) {
  2699. if (end_key[k] != str[from + k]) {
  2700. region_end_index = -1;
  2701. break;
  2702. }
  2703. }
  2704. if (region_end_index != -1) {
  2705. break;
  2706. }
  2707. }
  2708. j = from + (end_key_length - 1);
  2709. end_region = (region_end_index == -1) ? in_region : -1;
  2710. if (!same_line || region_end_index != -1) {
  2711. delimiter_cache.write[i][j + 1] = end_region;
  2712. }
  2713. in_region = -1;
  2714. }
  2715. if (i == end_line && current_end_region != end_region) {
  2716. end_line++;
  2717. end_line = MIN(end_line, line_count);
  2718. }
  2719. }
  2720. }
  2721. int CodeEdit::_is_in_delimiter(int p_line, int p_column, DelimiterType p_type) const {
  2722. if (delimiters.is_empty() || p_line >= delimiter_cache.size()) {
  2723. return -1;
  2724. }
  2725. ERR_FAIL_INDEX_V(p_line, get_line_count(), 0);
  2726. int region = (p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->value();
  2727. bool in_region = region != -1 && delimiters[region].type == p_type;
  2728. for (RBMap<int, int>::Element *E = delimiter_cache[p_line].front(); E; E = E->next()) {
  2729. /* If column is specified, loop until the key is larger then the column. */
  2730. if (p_column != -1) {
  2731. if (E->key() > p_column) {
  2732. break;
  2733. }
  2734. in_region = E->value() != -1 && delimiters[E->value()].type == p_type;
  2735. region = in_region ? E->value() : -1;
  2736. continue;
  2737. }
  2738. /* If no column, calculate if the entire line is a region */
  2739. /* excluding whitespace. */
  2740. const String line = get_line(p_line);
  2741. if (!in_region) {
  2742. if (E->value() == -1 || delimiters[E->value()].type != p_type) {
  2743. break;
  2744. }
  2745. region = E->value();
  2746. in_region = true;
  2747. for (int i = E->key() - 2; i >= 0; i--) {
  2748. if (!is_whitespace(line[i])) {
  2749. return -1;
  2750. }
  2751. }
  2752. }
  2753. if (delimiters[region].line_only) {
  2754. return region;
  2755. }
  2756. int end_col = E->key();
  2757. if (E->value() != -1) {
  2758. if (!E->next()) {
  2759. return region;
  2760. }
  2761. end_col = E->next()->key();
  2762. }
  2763. for (int i = end_col; i < line.length(); i++) {
  2764. if (!is_whitespace(line[i])) {
  2765. return -1;
  2766. }
  2767. }
  2768. return region;
  2769. }
  2770. return in_region ? region : -1;
  2771. }
  2772. void CodeEdit::_add_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only, DelimiterType p_type) {
  2773. // If we are the editor allow "null" as a valid start key, otherwise users cannot add delimiters via the inspector.
  2774. if (!(Engine::get_singleton()->is_editor_hint() && p_start_key == "null")) {
  2775. ERR_FAIL_COND_MSG(p_start_key.is_empty(), "delimiter start key cannot be empty");
  2776. for (int i = 0; i < p_start_key.length(); i++) {
  2777. ERR_FAIL_COND_MSG(!is_symbol(p_start_key[i]), "delimiter must start with a symbol");
  2778. }
  2779. }
  2780. if (p_end_key.length() > 0) {
  2781. for (int i = 0; i < p_end_key.length(); i++) {
  2782. ERR_FAIL_COND_MSG(!is_symbol(p_end_key[i]), "delimiter must end with a symbol");
  2783. }
  2784. }
  2785. int at = 0;
  2786. for (int i = 0; i < delimiters.size(); i++) {
  2787. ERR_FAIL_COND_MSG(delimiters[i].start_key == p_start_key, "delimiter with start key '" + p_start_key + "' already exists.");
  2788. if (p_start_key.length() < delimiters[i].start_key.length()) {
  2789. at++;
  2790. } else {
  2791. break;
  2792. }
  2793. }
  2794. Delimiter delimiter;
  2795. delimiter.type = p_type;
  2796. delimiter.start_key = p_start_key;
  2797. delimiter.end_key = p_end_key;
  2798. delimiter.line_only = p_line_only || p_end_key.is_empty();
  2799. delimiters.insert(at, delimiter);
  2800. if (!setting_delimiters) {
  2801. delimiter_cache.clear();
  2802. _update_delimiter_cache();
  2803. }
  2804. if (p_type == DelimiterType::TYPE_COMMENT) {
  2805. _update_code_region_tags();
  2806. }
  2807. }
  2808. void CodeEdit::_remove_delimiter(const String &p_start_key, DelimiterType p_type) {
  2809. for (int i = 0; i < delimiters.size(); i++) {
  2810. if (delimiters[i].start_key != p_start_key) {
  2811. continue;
  2812. }
  2813. if (delimiters[i].type != p_type) {
  2814. break;
  2815. }
  2816. delimiters.remove_at(i);
  2817. if (!setting_delimiters) {
  2818. delimiter_cache.clear();
  2819. _update_delimiter_cache();
  2820. }
  2821. if (p_type == DelimiterType::TYPE_COMMENT) {
  2822. _update_code_region_tags();
  2823. }
  2824. break;
  2825. }
  2826. }
  2827. bool CodeEdit::_has_delimiter(const String &p_start_key, DelimiterType p_type) const {
  2828. for (int i = 0; i < delimiters.size(); i++) {
  2829. if (delimiters[i].start_key == p_start_key) {
  2830. return delimiters[i].type == p_type;
  2831. }
  2832. }
  2833. return false;
  2834. }
  2835. void CodeEdit::_set_delimiters(const TypedArray<String> &p_delimiters, DelimiterType p_type) {
  2836. setting_delimiters = true;
  2837. _clear_delimiters(p_type);
  2838. for (int i = 0; i < p_delimiters.size(); i++) {
  2839. String key = p_delimiters[i];
  2840. if (key.is_empty()) {
  2841. continue;
  2842. }
  2843. const String start_key = key.get_slicec(' ', 0);
  2844. const String end_key = key.get_slice_count(" ") > 1 ? key.get_slicec(' ', 1) : String();
  2845. _add_delimiter(start_key, end_key, end_key.is_empty(), p_type);
  2846. }
  2847. setting_delimiters = false;
  2848. _update_delimiter_cache();
  2849. }
  2850. void CodeEdit::_clear_delimiters(DelimiterType p_type) {
  2851. for (int i = delimiters.size() - 1; i >= 0; i--) {
  2852. if (delimiters[i].type == p_type) {
  2853. delimiters.remove_at(i);
  2854. }
  2855. }
  2856. delimiter_cache.clear();
  2857. if (!setting_delimiters) {
  2858. _update_delimiter_cache();
  2859. }
  2860. if (p_type == DelimiterType::TYPE_COMMENT) {
  2861. _update_code_region_tags();
  2862. }
  2863. }
  2864. TypedArray<String> CodeEdit::_get_delimiters(DelimiterType p_type) const {
  2865. TypedArray<String> r_delimiters;
  2866. for (int i = 0; i < delimiters.size(); i++) {
  2867. if (delimiters[i].type != p_type) {
  2868. continue;
  2869. }
  2870. r_delimiters.push_back(delimiters[i].start_key + (delimiters[i].end_key.is_empty() ? "" : " " + delimiters[i].end_key));
  2871. }
  2872. return r_delimiters;
  2873. }
  2874. /* Code Completion */
  2875. void CodeEdit::_update_scroll_selected_line(float p_mouse_y) {
  2876. float percent = (float)(p_mouse_y - code_completion_scroll_rect.position.y) / code_completion_scroll_rect.size.height;
  2877. percent = CLAMP(percent, 0.0f, 1.0f);
  2878. code_completion_current_selected = (int)(percent * (code_completion_options.size() - 1));
  2879. code_completion_force_item_center = -1;
  2880. code_completion_pan_offset = 0.0f;
  2881. }
  2882. void CodeEdit::_filter_code_completion_candidates_impl() {
  2883. int line_height = get_line_height();
  2884. if (GDVIRTUAL_IS_OVERRIDDEN(_filter_code_completion_candidates)) {
  2885. Vector<ScriptLanguage::CodeCompletionOption> code_completion_options_new;
  2886. code_completion_base = "";
  2887. /* Build options argument. */
  2888. TypedArray<Dictionary> completion_options_sources;
  2889. completion_options_sources.resize(code_completion_option_sources.size());
  2890. int i = 0;
  2891. for (const ScriptLanguage::CodeCompletionOption &E : code_completion_option_sources) {
  2892. Dictionary option;
  2893. option["kind"] = E.kind;
  2894. option["display_text"] = E.display;
  2895. option["insert_text"] = E.insert_text;
  2896. option["font_color"] = E.font_color;
  2897. option["icon"] = E.icon;
  2898. option["default_value"] = E.default_value;
  2899. option["location"] = E.location;
  2900. completion_options_sources[i] = option;
  2901. i++;
  2902. }
  2903. TypedArray<Dictionary> completion_options;
  2904. GDVIRTUAL_CALL(_filter_code_completion_candidates, completion_options_sources, completion_options);
  2905. /* No options to complete, cancel. */
  2906. if (completion_options.is_empty()) {
  2907. cancel_code_completion();
  2908. return;
  2909. }
  2910. /* Convert back into options. */
  2911. int max_width = 0;
  2912. for (i = 0; i < completion_options.size(); i++) {
  2913. ScriptLanguage::CodeCompletionOption option;
  2914. option.kind = (ScriptLanguage::CodeCompletionKind)(int)completion_options[i].get("kind");
  2915. option.display = completion_options[i].get("display_text");
  2916. option.insert_text = completion_options[i].get("insert_text");
  2917. option.font_color = completion_options[i].get("font_color");
  2918. option.icon = completion_options[i].get("icon");
  2919. option.location = completion_options[i].get("location");
  2920. option.default_value = completion_options[i].get("default_value");
  2921. int offset = 0;
  2922. if (option.default_value.get_type() == Variant::COLOR) {
  2923. offset = line_height;
  2924. }
  2925. if (theme_cache.font.is_valid()) {
  2926. max_width = MAX(max_width, theme_cache.font->get_string_size(option.display, HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).width + offset);
  2927. }
  2928. code_completion_options_new.push_back(option);
  2929. }
  2930. if (_should_reset_selected_option_for_new_options(code_completion_options_new)) {
  2931. code_completion_current_selected = 0;
  2932. code_completion_pan_offset = 0.0f;
  2933. }
  2934. code_completion_options = code_completion_options_new;
  2935. code_completion_longest_line = MIN(max_width, theme_cache.code_completion_max_width * theme_cache.font_size);
  2936. code_completion_force_item_center = -1;
  2937. code_completion_active = true;
  2938. queue_redraw();
  2939. return;
  2940. }
  2941. const int caret_line = get_caret_line();
  2942. const int caret_column = get_caret_column();
  2943. const String line = get_line(caret_line);
  2944. ERR_FAIL_INDEX_MSG(caret_column, line.length() + 1, "Caret column exceeds line length.");
  2945. if (caret_column > 0 && line[caret_column - 1] == '(' && !code_completion_forced) {
  2946. cancel_code_completion();
  2947. return;
  2948. }
  2949. /* Get string status, are we in one or at the close. */
  2950. int in_string = is_in_string(caret_line, caret_column);
  2951. int first_quote_col = -1;
  2952. if (in_string != -1) {
  2953. Point2 string_start_pos = get_delimiter_start_position(caret_line, caret_column);
  2954. first_quote_col = (string_start_pos.y == caret_line) ? string_start_pos.x : -1;
  2955. } else if (caret_column > 0) {
  2956. if (is_in_string(caret_line, caret_column - 1) != -1) {
  2957. first_quote_col = caret_column - 1;
  2958. }
  2959. }
  2960. int cofs = caret_column;
  2961. String string_to_complete;
  2962. bool prev_is_word = false;
  2963. /* Cancel if we are at the close of a string. */
  2964. if (caret_column > 0 && in_string == -1 && first_quote_col == cofs - 1) {
  2965. cancel_code_completion();
  2966. return;
  2967. /* In a string, therefore we are trying to complete the string text. */
  2968. } else if (in_string != -1 && first_quote_col != -1) {
  2969. int key_length = delimiters[in_string].start_key.length();
  2970. string_to_complete = line.substr(first_quote_col - key_length, (cofs - first_quote_col) + key_length);
  2971. /* If we have a space, previous word might be a keyword. eg "func |". */
  2972. } else if (cofs > 0 && line[cofs - 1] == ' ') {
  2973. int ofs = cofs - 1;
  2974. while (ofs > 0 && line[ofs] == ' ') {
  2975. ofs--;
  2976. }
  2977. prev_is_word = !is_symbol(line[ofs]);
  2978. /* Otherwise get current word and set cofs to the start. */
  2979. } else {
  2980. int start_cofs = cofs;
  2981. while (cofs > 0 && line[cofs - 1] > 32 && (line[cofs - 1] == '/' || !is_symbol(line[cofs - 1]))) {
  2982. cofs--;
  2983. }
  2984. string_to_complete = line.substr(cofs, start_cofs - cofs);
  2985. }
  2986. /* If all else fails, check for a prefix. */
  2987. /* Single space between caret and prefix is okay. */
  2988. bool prev_is_prefix = false;
  2989. if (cofs > 0 && code_completion_prefixes.has(line[cofs - 1])) {
  2990. prev_is_prefix = true;
  2991. } else if (cofs > 1 && line[cofs - 1] == ' ' && code_completion_prefixes.has(line[cofs - 2])) {
  2992. prev_is_prefix = true;
  2993. }
  2994. if (!prev_is_word && string_to_complete.is_empty() && (cofs == 0 || !prev_is_prefix)) {
  2995. cancel_code_completion();
  2996. return;
  2997. }
  2998. /* Filter Options. */
  2999. /* For now handle only traditional quoted strings. */
  3000. bool single_quote = in_string != -1 && first_quote_col > 0 && delimiters[in_string].start_key == "'";
  3001. Vector<ScriptLanguage::CodeCompletionOption> code_completion_options_new;
  3002. code_completion_base = string_to_complete;
  3003. /* Don't autocomplete setting numerical values. */
  3004. if (code_completion_base.is_numeric()) {
  3005. cancel_code_completion();
  3006. return;
  3007. }
  3008. int max_width = 0;
  3009. String string_to_complete_lower = string_to_complete.to_lower();
  3010. for (ScriptLanguage::CodeCompletionOption &option : code_completion_option_sources) {
  3011. option.matches.clear();
  3012. if (single_quote && option.display.is_quoted()) {
  3013. option.display = option.display.unquote().quote("'");
  3014. }
  3015. int offset = option.default_value.get_type() == Variant::COLOR ? line_height : 0;
  3016. if (in_string != -1) {
  3017. // The completion string may have a literal behind it, which should be removed before re-quoting.
  3018. String literal;
  3019. if (option.insert_text.substr(1).is_quoted()) {
  3020. literal = option.display.left(1);
  3021. option.display = option.display.substr(1);
  3022. option.insert_text = option.insert_text.substr(1);
  3023. }
  3024. String quote = single_quote ? "'" : "\"";
  3025. option.display = literal + (option.display.unquote().quote(quote));
  3026. option.insert_text = literal + (option.insert_text.unquote().quote(quote));
  3027. }
  3028. if (option.display.length() == 0) {
  3029. continue;
  3030. }
  3031. if (string_to_complete.length() == 0) {
  3032. option.get_option_characteristics(string_to_complete);
  3033. code_completion_options_new.push_back(option);
  3034. if (theme_cache.font.is_valid()) {
  3035. max_width = MAX(max_width, theme_cache.font->get_string_size(option.display, HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).width + offset);
  3036. }
  3037. continue;
  3038. }
  3039. String target_lower = option.display.to_lower();
  3040. int long_option = target_lower.size() > 50;
  3041. const char32_t *string_to_complete_char_lower = &string_to_complete_lower[0];
  3042. const char32_t *target_char_lower = &target_lower[0];
  3043. Vector<Vector<Pair<int, int>>> all_possible_subsequence_matches;
  3044. for (int i = 0; *target_char_lower; i++, target_char_lower++) {
  3045. if (*target_char_lower == *string_to_complete_char_lower) {
  3046. all_possible_subsequence_matches.push_back({ { i, 1 } });
  3047. }
  3048. }
  3049. string_to_complete_char_lower++;
  3050. for (int i = 1; *string_to_complete_char_lower && (all_possible_subsequence_matches.size() > 0); i++, string_to_complete_char_lower++) {
  3051. // find all occurrences of ssq_lower to avoid looking everywhere each time
  3052. Vector<int> all_occurrences;
  3053. if (long_option) {
  3054. all_occurrences.push_back(target_lower.find_char(*string_to_complete_char_lower));
  3055. } else {
  3056. for (int j = i; j < target_lower.length(); j++) {
  3057. if (target_lower[j] == *string_to_complete_char_lower) {
  3058. all_occurrences.push_back(j);
  3059. }
  3060. }
  3061. }
  3062. Vector<Vector<Pair<int, int>>> next_subsequence_matches;
  3063. for (Vector<Pair<int, int>> &subsequence_match : all_possible_subsequence_matches) {
  3064. Pair<int, int> match_last_segment = subsequence_match[subsequence_match.size() - 1];
  3065. int next_index = match_last_segment.first + match_last_segment.second;
  3066. // get the last index from current sequence
  3067. // and look for next char starting from that index
  3068. if (target_lower[next_index] == *string_to_complete_char_lower) {
  3069. Vector<Pair<int, int>> new_match = subsequence_match;
  3070. new_match.write[new_match.size() - 1].second++;
  3071. next_subsequence_matches.push_back(new_match);
  3072. if (long_option) {
  3073. continue;
  3074. }
  3075. }
  3076. for (int index : all_occurrences) {
  3077. if (index > next_index) {
  3078. Vector<Pair<int, int>> new_match = subsequence_match;
  3079. new_match.push_back({ index, 1 });
  3080. next_subsequence_matches.push_back(new_match);
  3081. }
  3082. }
  3083. }
  3084. all_possible_subsequence_matches = next_subsequence_matches;
  3085. }
  3086. // go through all possible matches to get the best one as defined by CodeCompletionOptionCompare
  3087. if (all_possible_subsequence_matches.size() > 0) {
  3088. option.matches = all_possible_subsequence_matches[0];
  3089. option.get_option_characteristics(string_to_complete);
  3090. all_possible_subsequence_matches = all_possible_subsequence_matches.slice(1);
  3091. if (all_possible_subsequence_matches.size() > 0) {
  3092. CodeCompletionOptionCompare compare;
  3093. ScriptLanguage::CodeCompletionOption compared_option = option;
  3094. compared_option.clear_characteristics();
  3095. for (Vector<Pair<int, int>> &matches : all_possible_subsequence_matches) {
  3096. compared_option.matches = matches;
  3097. compared_option.get_option_characteristics(string_to_complete);
  3098. if (compare(compared_option, option)) {
  3099. option = compared_option;
  3100. compared_option.clear_characteristics();
  3101. }
  3102. }
  3103. }
  3104. code_completion_options_new.push_back(option);
  3105. if (theme_cache.font.is_valid()) {
  3106. max_width = MAX(max_width, theme_cache.font->get_string_size(option.display, HORIZONTAL_ALIGNMENT_LEFT, -1, theme_cache.font_size).width + offset);
  3107. }
  3108. }
  3109. }
  3110. /* No options to complete, cancel. */
  3111. if (code_completion_options_new.is_empty()) {
  3112. cancel_code_completion();
  3113. return;
  3114. }
  3115. /* A perfect match, stop completion. */
  3116. if (code_completion_options_new.size() == 1 && string_to_complete == code_completion_options_new[0].display) {
  3117. cancel_code_completion();
  3118. return;
  3119. }
  3120. code_completion_options_new.sort_custom<CodeCompletionOptionCompare>();
  3121. if (_should_reset_selected_option_for_new_options(code_completion_options_new)) {
  3122. code_completion_current_selected = 0;
  3123. code_completion_pan_offset = 0.0f;
  3124. }
  3125. code_completion_options = code_completion_options_new;
  3126. code_completion_longest_line = MIN(max_width, theme_cache.code_completion_max_width * theme_cache.font_size);
  3127. code_completion_force_item_center = -1;
  3128. code_completion_active = true;
  3129. queue_redraw();
  3130. }
  3131. // Assumes both the new_options and the code_completion_options are sorted.
  3132. bool CodeEdit::_should_reset_selected_option_for_new_options(const Vector<ScriptLanguage::CodeCompletionOption> &p_new_options) {
  3133. if (code_completion_current_selected >= p_new_options.size()) {
  3134. return true;
  3135. }
  3136. for (int i = 0; i < code_completion_options.size() && i < p_new_options.size(); i++) {
  3137. if (i > code_completion_current_selected) {
  3138. return false;
  3139. }
  3140. if (code_completion_options[i].display != p_new_options[i].display) {
  3141. return true;
  3142. }
  3143. }
  3144. return false;
  3145. }
  3146. void CodeEdit::_lines_edited_from(int p_from_line, int p_to_line) {
  3147. _update_delimiter_cache(p_from_line, p_to_line);
  3148. if (p_from_line == p_to_line) {
  3149. return;
  3150. }
  3151. lines_edited_changed += p_to_line - p_from_line;
  3152. 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));
  3153. 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));
  3154. }
  3155. void CodeEdit::_text_set() {
  3156. lines_edited_from = 0;
  3157. lines_edited_to = 9999;
  3158. _text_changed();
  3159. }
  3160. void CodeEdit::_text_changed() {
  3161. if (lines_edited_from == -1) {
  3162. return;
  3163. }
  3164. int lc = get_line_count();
  3165. int new_line_number_digits = log10l(lc) + 1;
  3166. if (line_number_digits != new_line_number_digits) {
  3167. _clear_line_number_text_cache();
  3168. }
  3169. line_number_digits = new_line_number_digits;
  3170. _update_line_number_gutter_width();
  3171. List<int> breakpoints;
  3172. for (const KeyValue<int, bool> &E : breakpointed_lines) {
  3173. breakpoints.push_back(E.key);
  3174. }
  3175. for (const int &line : breakpoints) {
  3176. if (line < lines_edited_from || (line < lc && is_line_breakpointed(line))) {
  3177. continue;
  3178. }
  3179. breakpointed_lines.erase(line);
  3180. emit_signal(SNAME("breakpoint_toggled"), line);
  3181. int next_line = line + lines_edited_changed;
  3182. if (next_line > -1 && next_line < lc && is_line_breakpointed(next_line)) {
  3183. emit_signal(SNAME("breakpoint_toggled"), next_line);
  3184. breakpointed_lines[next_line] = true;
  3185. continue;
  3186. }
  3187. }
  3188. lines_edited_from = -1;
  3189. lines_edited_to = -1;
  3190. lines_edited_changed = 0;
  3191. }
  3192. CodeEdit::CodeEdit() {
  3193. /* Indent management */
  3194. auto_indent_prefixes.insert(':');
  3195. auto_indent_prefixes.insert('{');
  3196. auto_indent_prefixes.insert('[');
  3197. auto_indent_prefixes.insert('(');
  3198. /* Auto brace completion */
  3199. add_auto_brace_completion_pair("(", ")");
  3200. add_auto_brace_completion_pair("{", "}");
  3201. add_auto_brace_completion_pair("[", "]");
  3202. add_auto_brace_completion_pair("\"", "\"");
  3203. add_auto_brace_completion_pair("\'", "\'");
  3204. /* Delimiter tracking */
  3205. add_string_delimiter("\"", "\"", false);
  3206. add_string_delimiter("\'", "\'", false);
  3207. /* Text Direction */
  3208. set_layout_direction(LAYOUT_DIRECTION_LTR);
  3209. set_text_direction(TEXT_DIRECTION_LTR);
  3210. /* Gutters */
  3211. int gutter_idx = 0;
  3212. /* Main Gutter */
  3213. add_gutter();
  3214. set_gutter_name(gutter_idx, "main_gutter");
  3215. set_gutter_draw(gutter_idx, false);
  3216. set_gutter_overwritable(gutter_idx, true);
  3217. set_gutter_type(gutter_idx, GUTTER_TYPE_CUSTOM);
  3218. set_gutter_custom_draw(gutter_idx, callable_mp(this, &CodeEdit::_main_gutter_draw_callback));
  3219. gutter_idx++;
  3220. /* Line numbers */
  3221. add_gutter();
  3222. set_gutter_name(gutter_idx, "line_numbers");
  3223. set_gutter_draw(gutter_idx, false);
  3224. set_gutter_type(gutter_idx, GUTTER_TYPE_CUSTOM);
  3225. set_gutter_custom_draw(gutter_idx, callable_mp(this, &CodeEdit::_line_number_draw_callback));
  3226. gutter_idx++;
  3227. /* Fold Gutter */
  3228. add_gutter();
  3229. set_gutter_name(gutter_idx, "fold_gutter");
  3230. set_gutter_draw(gutter_idx, false);
  3231. set_gutter_type(gutter_idx, GUTTER_TYPE_CUSTOM);
  3232. set_gutter_custom_draw(gutter_idx, callable_mp(this, &CodeEdit::_fold_gutter_draw_callback));
  3233. gutter_idx++;
  3234. /* Symbol tooltip */
  3235. symbol_tooltip_timer = memnew(Timer);
  3236. symbol_tooltip_timer->set_wait_time(0.5); // See `_apply_project_settings()`.
  3237. symbol_tooltip_timer->set_one_shot(true);
  3238. symbol_tooltip_timer->connect("timeout", callable_mp(this, &CodeEdit::_on_symbol_tooltip_timer_timeout));
  3239. add_child(symbol_tooltip_timer, false, INTERNAL_MODE_FRONT);
  3240. connect("lines_edited_from", callable_mp(this, &CodeEdit::_lines_edited_from));
  3241. connect("text_set", callable_mp(this, &CodeEdit::_text_set));
  3242. connect(SceneStringName(text_changed), callable_mp(this, &CodeEdit::_text_changed));
  3243. connect("gutter_clicked", callable_mp(this, &CodeEdit::_gutter_clicked));
  3244. connect("gutter_added", callable_mp(this, &CodeEdit::_update_gutter_indexes));
  3245. connect("gutter_removed", callable_mp(this, &CodeEdit::_update_gutter_indexes));
  3246. _update_gutter_indexes();
  3247. }
  3248. CodeEdit::~CodeEdit() {
  3249. _clear_line_number_text_cache();
  3250. }
  3251. // Return true if l should come before r
  3252. bool CodeCompletionOptionCompare::operator()(const ScriptLanguage::CodeCompletionOption &l, const ScriptLanguage::CodeCompletionOption &r) const {
  3253. TypedArray<int> lcharac = l.get_option_cached_characteristics();
  3254. TypedArray<int> rcharac = r.get_option_cached_characteristics();
  3255. if (lcharac != rcharac) {
  3256. return lcharac < rcharac;
  3257. }
  3258. // to get here they need to have the same size so we can take the size of whichever we want
  3259. for (int i = 0; i < l.matches.size(); ++i) {
  3260. if (l.matches[i].first != r.matches[i].first) {
  3261. return l.matches[i].first < r.matches[i].first;
  3262. }
  3263. if (l.matches[i].second != r.matches[i].second) {
  3264. return l.matches[i].second > r.matches[i].second;
  3265. }
  3266. }
  3267. return l.display.naturalnocasecmp_to(r.display) < 0;
  3268. }