code_edit.cpp 128 KB

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