code_edit.cpp 133 KB

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