code_edit.cpp 102 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057
  1. /*************************************************************************/
  2. /* code_edit.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  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 "core/os/keyboard.h"
  32. #include "core/string/string_builder.h"
  33. #include "core/string/ustring.h"
  34. static bool _is_whitespace(char32_t c) {
  35. return c == '\t' || c == ' ';
  36. }
  37. static bool _is_char(char32_t c) {
  38. return !is_symbol(c);
  39. }
  40. void CodeEdit::_notification(int p_what) {
  41. switch (p_what) {
  42. case NOTIFICATION_THEME_CHANGED:
  43. case NOTIFICATION_ENTER_TREE: {
  44. style_normal = get_theme_stylebox(SNAME("normal"));
  45. font = get_theme_font(SNAME("font"));
  46. font_size = get_theme_font_size(SNAME("font_size"));
  47. line_spacing = get_theme_constant(SNAME("line_spacing"));
  48. set_gutter_width(main_gutter, get_line_height());
  49. set_gutter_width(line_number_gutter, (line_number_digits + 1) * font->get_char_size('0', 0, font_size).width);
  50. set_gutter_width(fold_gutter, get_line_height() / 1.2);
  51. breakpoint_color = get_theme_color(SNAME("breakpoint_color"));
  52. breakpoint_icon = get_theme_icon(SNAME("breakpoint"));
  53. bookmark_color = get_theme_color(SNAME("bookmark_color"));
  54. bookmark_icon = get_theme_icon(SNAME("bookmark"));
  55. executing_line_color = get_theme_color(SNAME("executing_line_color"));
  56. executing_line_icon = get_theme_icon(SNAME("executing_line"));
  57. line_number_color = get_theme_color(SNAME("line_number_color"));
  58. folding_color = get_theme_color(SNAME("code_folding_color"));
  59. can_fold_icon = get_theme_icon(SNAME("can_fold"));
  60. folded_icon = get_theme_icon(SNAME("folded"));
  61. code_completion_max_width = get_theme_constant(SNAME("completion_max_width"));
  62. code_completion_max_lines = get_theme_constant(SNAME("completion_lines"));
  63. code_completion_scroll_width = get_theme_constant(SNAME("completion_scroll_width"));
  64. code_completion_scroll_color = get_theme_color(SNAME("completion_scroll_color"));
  65. code_completion_background_color = get_theme_color(SNAME("completion_background_color"));
  66. code_completion_selected_color = get_theme_color(SNAME("completion_selected_color"));
  67. code_completion_existing_color = get_theme_color(SNAME("completion_existing_color"));
  68. line_length_guideline_color = get_theme_color(SNAME("line_length_guideline_color"));
  69. } break;
  70. case NOTIFICATION_DRAW: {
  71. RID ci = get_canvas_item();
  72. const Size2 size = get_size();
  73. const bool caret_visible = is_caret_visible();
  74. const bool rtl = is_layout_rtl();
  75. const int row_height = get_line_height();
  76. if (line_length_guideline_columns.size() > 0) {
  77. const int xmargin_beg = style_normal->get_margin(SIDE_LEFT) + get_total_gutter_width();
  78. const int xmargin_end = size.width - style_normal->get_margin(SIDE_RIGHT) - (is_drawing_minimap() ? get_minimap_width() : 0);
  79. const int char_size = (int)font->get_char_size('0', 0, font_size).width;
  80. for (int i = 0; i < line_length_guideline_columns.size(); i++) {
  81. const int xoffset = xmargin_beg + char_size * (int)line_length_guideline_columns[i] - get_h_scroll();
  82. if (xoffset > xmargin_beg && xoffset < xmargin_end) {
  83. Color guideline_color = (i == 0) ? line_length_guideline_color : line_length_guideline_color * Color(1, 1, 1, 0.5);
  84. if (rtl) {
  85. RenderingServer::get_singleton()->canvas_item_add_line(ci, Point2(size.width - xoffset, 0), Point2(size.width - xoffset, size.height), guideline_color);
  86. continue;
  87. }
  88. RenderingServer::get_singleton()->canvas_item_add_line(ci, Point2(xoffset, 0), Point2(xoffset, size.height), guideline_color);
  89. }
  90. }
  91. }
  92. bool code_completion_below = false;
  93. if (caret_visible && code_completion_active && code_completion_options.size() > 0) {
  94. Ref<StyleBox> csb = get_theme_stylebox(SNAME("completion"));
  95. const int code_completion_options_count = code_completion_options.size();
  96. const int lines = MIN(code_completion_options_count, code_completion_max_lines);
  97. const int icon_hsep = get_theme_constant(SNAME("hseparation"), SNAME("ItemList"));
  98. const Size2 icon_area_size(row_height, row_height);
  99. code_completion_rect.size.width = code_completion_longest_line + icon_hsep + icon_area_size.width + 2;
  100. code_completion_rect.size.height = lines * row_height;
  101. const Point2 caret_pos = get_caret_draw_pos();
  102. const int total_height = csb->get_minimum_size().y + code_completion_rect.size.height;
  103. if (caret_pos.y + row_height + total_height > get_size().height) {
  104. code_completion_rect.position.y = (caret_pos.y - total_height - row_height) + line_spacing;
  105. } else {
  106. code_completion_rect.position.y = caret_pos.y + (line_spacing / 2.0f);
  107. code_completion_below = true;
  108. }
  109. const int scroll_width = code_completion_options_count > code_completion_max_lines ? code_completion_scroll_width : 0;
  110. const int code_completion_base_width = font->get_string_size(code_completion_base, font_size).width;
  111. if (caret_pos.x - code_completion_base_width + code_completion_rect.size.width + scroll_width > get_size().width) {
  112. code_completion_rect.position.x = get_size().width - code_completion_rect.size.width - scroll_width;
  113. } else {
  114. code_completion_rect.position.x = caret_pos.x - code_completion_base_width;
  115. }
  116. draw_style_box(csb, Rect2(code_completion_rect.position - csb->get_offset(), code_completion_rect.size + csb->get_minimum_size() + Size2(scroll_width, 0)));
  117. if (code_completion_background_color.a > 0.01) {
  118. RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(code_completion_rect.position, code_completion_rect.size + Size2(scroll_width, 0)), code_completion_background_color);
  119. }
  120. code_completion_line_ofs = CLAMP(code_completion_current_selected - lines / 2, 0, code_completion_options_count - lines);
  121. 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)), code_completion_selected_color);
  122. draw_rect(Rect2(code_completion_rect.position + Vector2(icon_area_size.x + icon_hsep, 0), Size2(MIN(code_completion_base_width, code_completion_rect.size.width - (icon_area_size.x + icon_hsep)), code_completion_rect.size.height)), code_completion_existing_color);
  123. for (int i = 0; i < lines; i++) {
  124. int l = code_completion_line_ofs + i;
  125. ERR_CONTINUE(l < 0 || l >= code_completion_options_count);
  126. Ref<TextLine> tl;
  127. tl.instantiate();
  128. tl->add_string(code_completion_options[l].display, font, font_size);
  129. int yofs = (row_height - tl->get_size().y) / 2;
  130. Point2 title_pos(code_completion_rect.position.x, code_completion_rect.position.y + i * row_height + yofs);
  131. /* Draw completion icon if it is valid. */
  132. const Ref<Texture2D> &icon = code_completion_options[l].icon;
  133. Rect2 icon_area(code_completion_rect.position.x, code_completion_rect.position.y + i * row_height, icon_area_size.width, icon_area_size.height);
  134. if (icon.is_valid()) {
  135. Size2 icon_size = icon_area.size * 0.7;
  136. icon->draw_rect(ci, Rect2(icon_area.position + (icon_area.size - icon_size) / 2, icon_size));
  137. }
  138. title_pos.x = icon_area.position.x + icon_area.size.width + icon_hsep;
  139. tl->set_width(code_completion_rect.size.width - (icon_area_size.x + icon_hsep));
  140. if (rtl) {
  141. if (code_completion_options[l].default_value.get_type() == Variant::COLOR) {
  142. draw_rect(Rect2(Point2(code_completion_rect.position.x, icon_area.position.y), icon_area_size), (Color)code_completion_options[l].default_value);
  143. }
  144. tl->set_align(HALIGN_RIGHT);
  145. } else {
  146. if (code_completion_options[l].default_value.get_type() == Variant::COLOR) {
  147. draw_rect(Rect2(Point2(code_completion_rect.position.x + code_completion_rect.size.width - icon_area_size.x, icon_area.position.y), icon_area_size), (Color)code_completion_options[l].default_value);
  148. }
  149. tl->set_align(HALIGN_LEFT);
  150. }
  151. tl->draw(ci, title_pos, code_completion_options[l].font_color);
  152. }
  153. /* Draw a small scroll rectangle to show a position in the options. */
  154. if (scroll_width) {
  155. float r = (float)code_completion_max_lines / code_completion_options_count;
  156. float o = (float)code_completion_line_ofs / code_completion_options_count;
  157. 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), code_completion_scroll_color);
  158. }
  159. }
  160. /* Code hint */
  161. if (caret_visible && code_hint != "" && (!code_completion_active || (code_completion_below != code_hint_draw_below))) {
  162. const int font_height = font->get_height(font_size);
  163. Ref<StyleBox> sb = get_theme_stylebox(SNAME("panel"), SNAME("TooltipPanel"));
  164. Color font_color = get_theme_color(SNAME("font_color"), SNAME("TooltipLabel"));
  165. Vector<String> code_hint_lines = code_hint.split("\n");
  166. int line_count = code_hint_lines.size();
  167. int max_width = 0;
  168. for (int i = 0; i < line_count; i++) {
  169. max_width = MAX(max_width, font->get_string_size(code_hint_lines[i], font_size).x);
  170. }
  171. Size2 minsize = sb->get_minimum_size() + Size2(max_width, line_count * font_height + (line_spacing * line_count - 1));
  172. int offset = font->get_string_size(code_hint_lines[0].substr(0, code_hint_lines[0].find(String::chr(0xFFFF))), font_size).x;
  173. if (code_hint_xpos == -0xFFFF) {
  174. code_hint_xpos = get_caret_draw_pos().x - offset;
  175. }
  176. Point2 hint_ofs = Vector2(code_hint_xpos, get_caret_draw_pos().y);
  177. if (code_hint_draw_below) {
  178. hint_ofs.y += line_spacing / 2.0f;
  179. } else {
  180. hint_ofs.y -= (minsize.y + row_height) - line_spacing;
  181. }
  182. draw_style_box(sb, Rect2(hint_ofs, minsize));
  183. int yofs = 0;
  184. for (int i = 0; i < line_count; i++) {
  185. const String &line = code_hint_lines[i];
  186. int begin = 0;
  187. int end = 0;
  188. if (line.find(String::chr(0xFFFF)) != -1) {
  189. begin = font->get_string_size(line.substr(0, line.find(String::chr(0xFFFF))), font_size).x;
  190. end = font->get_string_size(line.substr(0, line.rfind(String::chr(0xFFFF))), font_size).x;
  191. }
  192. Point2 round_ofs = hint_ofs + sb->get_offset() + Vector2(0, font->get_ascent(font_size) + font_height * i + yofs);
  193. round_ofs = round_ofs.round();
  194. draw_string(font, round_ofs, line.replace(String::chr(0xFFFF), ""), HALIGN_LEFT, -1, font_size, font_color);
  195. if (end > 0) {
  196. // Draw an underline for the currently edited function parameter.
  197. const Vector2 b = hint_ofs + sb->get_offset() + Vector2(begin, font_height + font_height * i + yofs);
  198. draw_line(b, b + Vector2(end - begin, 0), font_color, 2);
  199. // Draw a translucent text highlight as well.
  200. const Rect2 highlight_rect = Rect2(
  201. b - Vector2(0, font_height),
  202. Vector2(end - begin, font_height));
  203. draw_rect(highlight_rect, font_color * Color(1, 1, 1, 0.2));
  204. }
  205. yofs += line_spacing;
  206. }
  207. }
  208. } break;
  209. }
  210. }
  211. void CodeEdit::gui_input(const Ref<InputEvent> &p_gui_input) {
  212. Ref<InputEventMouseButton> mb = p_gui_input;
  213. if (mb.is_valid()) {
  214. /* Ignore mouse clicks in IME input mode. */
  215. if (has_ime_text()) {
  216. return;
  217. }
  218. if (code_completion_active && code_completion_rect.has_point(mb->get_position())) {
  219. if (!mb->is_pressed()) {
  220. return;
  221. }
  222. switch (mb->get_button_index()) {
  223. case MouseButton::WHEEL_UP: {
  224. if (code_completion_current_selected > 0) {
  225. code_completion_current_selected--;
  226. update();
  227. }
  228. } break;
  229. case MouseButton::WHEEL_DOWN: {
  230. if (code_completion_current_selected < code_completion_options.size() - 1) {
  231. code_completion_current_selected++;
  232. update();
  233. }
  234. } break;
  235. case MouseButton::LEFT: {
  236. 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);
  237. if (mb->is_double_click()) {
  238. confirm_code_completion();
  239. }
  240. update();
  241. } break;
  242. default:
  243. break;
  244. }
  245. return;
  246. }
  247. cancel_code_completion();
  248. set_code_hint("");
  249. if (mb->is_pressed()) {
  250. Vector2i mpos = mb->get_position();
  251. if (is_layout_rtl()) {
  252. mpos.x = get_size().x - mpos.x;
  253. }
  254. Point2i pos = get_line_column_at_pos(mpos, false);
  255. int line = pos.y;
  256. int col = pos.x;
  257. if (line != -1 && mb->get_button_index() == MouseButton::LEFT) {
  258. if (is_line_folded(line)) {
  259. int wrap_index = get_line_wrap_index_at_column(line, col);
  260. if (wrap_index == get_line_wrap_count(line)) {
  261. int eol_icon_width = folded_eol_icon->get_width();
  262. int left_margin = get_total_gutter_width() + eol_icon_width + get_line_width(line, wrap_index) - get_h_scroll();
  263. if (mpos.x > left_margin && mpos.x <= left_margin + eol_icon_width + 3) {
  264. unfold_line(line);
  265. return;
  266. }
  267. }
  268. }
  269. }
  270. } else {
  271. if (mb->get_button_index() == MouseButton::LEFT) {
  272. if (mb->is_command_pressed() && symbol_lookup_word != String()) {
  273. Vector2i mpos = mb->get_position();
  274. if (is_layout_rtl()) {
  275. mpos.x = get_size().x - mpos.x;
  276. }
  277. Point2i pos = get_line_column_at_pos(mpos, false);
  278. int line = pos.y;
  279. int col = pos.x;
  280. if (line != -1) {
  281. emit_signal(SNAME("symbol_lookup"), symbol_lookup_word, line, col);
  282. }
  283. return;
  284. }
  285. }
  286. }
  287. }
  288. Ref<InputEventMouseMotion> mm = p_gui_input;
  289. if (mm.is_valid()) {
  290. Vector2i mpos = mm->get_position();
  291. if (is_layout_rtl()) {
  292. mpos.x = get_size().x - mpos.x;
  293. }
  294. if (symbol_lookup_on_click_enabled) {
  295. if (mm->is_command_pressed() && mm->get_button_mask() == MouseButton::NONE && !is_dragging_cursor()) {
  296. symbol_lookup_new_word = get_word_at_pos(mpos);
  297. if (symbol_lookup_new_word != symbol_lookup_word) {
  298. emit_signal(SNAME("symbol_validate"), symbol_lookup_new_word);
  299. }
  300. } else {
  301. set_symbol_lookup_word_as_valid(false);
  302. }
  303. }
  304. }
  305. Ref<InputEventKey> k = p_gui_input;
  306. bool update_code_completion = false;
  307. if (!k.is_valid()) {
  308. TextEdit::gui_input(p_gui_input);
  309. return;
  310. }
  311. /* Ctrl + Hover symbols */
  312. #ifdef OSX_ENABLED
  313. if (k->get_keycode() == Key::META) {
  314. #else
  315. if (k->get_keycode() == Key::CTRL) {
  316. #endif
  317. if (symbol_lookup_on_click_enabled) {
  318. if (k->is_pressed() && !is_dragging_cursor()) {
  319. symbol_lookup_new_word = get_word_at_pos(get_local_mouse_pos());
  320. if (symbol_lookup_new_word != symbol_lookup_word) {
  321. emit_signal(SNAME("symbol_validate"), symbol_lookup_new_word);
  322. }
  323. } else {
  324. set_symbol_lookup_word_as_valid(false);
  325. }
  326. }
  327. return;
  328. }
  329. /* If a modifier has been pressed, and nothing else, return. */
  330. if (!k->is_pressed() || k->get_keycode() == Key::CTRL || k->get_keycode() == Key::ALT || k->get_keycode() == Key::SHIFT || k->get_keycode() == Key::META) {
  331. return;
  332. }
  333. /* Allow unicode handling if: */
  334. /* No Modifiers are pressed (except shift) */
  335. bool allow_unicode_handling = !(k->is_command_pressed() || k->is_ctrl_pressed() || k->is_alt_pressed() || k->is_meta_pressed());
  336. /* AUTO-COMPLETE */
  337. if (code_completion_enabled && k->is_action("ui_text_completion_query", true)) {
  338. request_code_completion(true);
  339. accept_event();
  340. return;
  341. }
  342. if (code_completion_active) {
  343. if (k->is_action("ui_up", true)) {
  344. if (code_completion_current_selected > 0) {
  345. code_completion_current_selected--;
  346. } else {
  347. code_completion_current_selected = code_completion_options.size() - 1;
  348. }
  349. update();
  350. accept_event();
  351. return;
  352. }
  353. if (k->is_action("ui_down", true)) {
  354. if (code_completion_current_selected < code_completion_options.size() - 1) {
  355. code_completion_current_selected++;
  356. } else {
  357. code_completion_current_selected = 0;
  358. }
  359. update();
  360. accept_event();
  361. return;
  362. }
  363. if (k->is_action("ui_page_up", true)) {
  364. code_completion_current_selected = MAX(0, code_completion_current_selected - code_completion_max_lines);
  365. update();
  366. accept_event();
  367. return;
  368. }
  369. if (k->is_action("ui_page_down", true)) {
  370. code_completion_current_selected = MIN(code_completion_options.size() - 1, code_completion_current_selected + code_completion_max_lines);
  371. update();
  372. accept_event();
  373. return;
  374. }
  375. if (k->is_action("ui_home", true)) {
  376. code_completion_current_selected = 0;
  377. update();
  378. accept_event();
  379. return;
  380. }
  381. if (k->is_action("ui_end", true)) {
  382. code_completion_current_selected = code_completion_options.size() - 1;
  383. update();
  384. accept_event();
  385. return;
  386. }
  387. if (k->is_action("ui_text_completion_replace", true) || k->is_action("ui_text_completion_accept", true)) {
  388. confirm_code_completion(k->is_action("ui_text_completion_replace", true));
  389. accept_event();
  390. return;
  391. }
  392. if (k->is_action("ui_cancel", true)) {
  393. cancel_code_completion();
  394. accept_event();
  395. return;
  396. }
  397. if (k->is_action("ui_text_backspace", true)) {
  398. backspace();
  399. _filter_code_completion_candidates_impl();
  400. accept_event();
  401. return;
  402. }
  403. if (k->is_action("ui_left", true) || k->is_action("ui_right", true)) {
  404. update_code_completion = true;
  405. } else {
  406. update_code_completion = (allow_unicode_handling && k->get_unicode() >= 32);
  407. }
  408. if (!update_code_completion) {
  409. cancel_code_completion();
  410. }
  411. }
  412. /* MISC */
  413. if (!code_hint.is_empty() && k->is_action("ui_cancel", true)) {
  414. set_code_hint("");
  415. accept_event();
  416. return;
  417. }
  418. if (allow_unicode_handling && k->get_unicode() == ')') {
  419. set_code_hint("");
  420. }
  421. /* Indentation */
  422. if (k->is_action("ui_text_indent", true)) {
  423. do_indent();
  424. accept_event();
  425. return;
  426. }
  427. if (k->is_action("ui_text_dedent", true)) {
  428. do_unindent();
  429. accept_event();
  430. return;
  431. }
  432. // Override new line actions, for auto indent
  433. if (k->is_action("ui_text_newline_above", true)) {
  434. _new_line(false, true);
  435. accept_event();
  436. return;
  437. }
  438. if (k->is_action("ui_text_newline_blank", true)) {
  439. _new_line(false);
  440. accept_event();
  441. return;
  442. }
  443. if (k->is_action("ui_text_newline", true)) {
  444. _new_line();
  445. accept_event();
  446. return;
  447. }
  448. /* Remove shift otherwise actions will not match. */
  449. k = k->duplicate();
  450. k->set_shift_pressed(false);
  451. if (k->is_action("ui_text_caret_up", true) ||
  452. k->is_action("ui_text_caret_down", true) ||
  453. k->is_action("ui_text_caret_line_start", true) ||
  454. k->is_action("ui_text_caret_line_end", true) ||
  455. k->is_action("ui_text_caret_page_up", true) ||
  456. k->is_action("ui_text_caret_page_down", true)) {
  457. set_code_hint("");
  458. }
  459. TextEdit::gui_input(p_gui_input);
  460. if (update_code_completion) {
  461. _filter_code_completion_candidates_impl();
  462. }
  463. }
  464. /* General overrides */
  465. Control::CursorShape CodeEdit::get_cursor_shape(const Point2 &p_pos) const {
  466. if (symbol_lookup_word != String()) {
  467. return CURSOR_POINTING_HAND;
  468. }
  469. if ((code_completion_active && code_completion_rect.has_point(p_pos)) || (!is_editable() && (!is_selecting_enabled() || get_line_count() == 0))) {
  470. return CURSOR_ARROW;
  471. }
  472. Point2i pos = get_line_column_at_pos(p_pos, false);
  473. int line = pos.y;
  474. int col = pos.x;
  475. if (line != -1 && is_line_folded(line)) {
  476. int wrap_index = get_line_wrap_index_at_column(line, col);
  477. if (wrap_index == get_line_wrap_count(line)) {
  478. int eol_icon_width = folded_eol_icon->get_width();
  479. int left_margin = get_total_gutter_width() + eol_icon_width + get_line_width(line, wrap_index) - get_h_scroll();
  480. if (p_pos.x > left_margin && p_pos.x <= left_margin + eol_icon_width + 3) {
  481. return CURSOR_POINTING_HAND;
  482. }
  483. }
  484. }
  485. return TextEdit::get_cursor_shape(p_pos);
  486. }
  487. /* Text manipulation */
  488. // Overridable actions
  489. void CodeEdit::_handle_unicode_input_internal(const uint32_t p_unicode) {
  490. bool had_selection = has_selection();
  491. if (had_selection) {
  492. begin_complex_operation();
  493. delete_selection();
  494. }
  495. // Remove the old character if in overtype mode and no selection.
  496. if (is_overtype_mode_enabled() && !had_selection) {
  497. begin_complex_operation();
  498. /* Make sure we don't try and remove empty space. */
  499. if (get_caret_column() < get_line(get_caret_line()).length()) {
  500. remove_text(get_caret_line(), get_caret_column(), get_caret_line(), get_caret_column() + 1);
  501. }
  502. }
  503. const char32_t chr[2] = { (char32_t)p_unicode, 0 };
  504. if (auto_brace_completion_enabled) {
  505. int cl = get_caret_line();
  506. int cc = get_caret_column();
  507. int caret_move_offset = 1;
  508. int post_brace_pair = cc < get_line(cl).length() ? _get_auto_brace_pair_close_at_pos(cl, cc) : -1;
  509. if (has_string_delimiter(chr) && cc > 0 && _is_char(get_line(cl)[cc - 1]) && post_brace_pair == -1) {
  510. insert_text_at_caret(chr);
  511. } else if (cc < get_line(cl).length() && _is_char(get_line(cl)[cc])) {
  512. insert_text_at_caret(chr);
  513. } else if (post_brace_pair != -1 && auto_brace_completion_pairs[post_brace_pair].close_key[0] == chr[0]) {
  514. caret_move_offset = auto_brace_completion_pairs[post_brace_pair].close_key.length();
  515. } else if (is_in_comment(cl, cc) != -1 || (is_in_string(cl, cc) != -1 && has_string_delimiter(chr))) {
  516. insert_text_at_caret(chr);
  517. } else {
  518. insert_text_at_caret(chr);
  519. int pre_brace_pair = _get_auto_brace_pair_open_at_pos(cl, cc + 1);
  520. if (pre_brace_pair != -1) {
  521. insert_text_at_caret(auto_brace_completion_pairs[pre_brace_pair].close_key);
  522. }
  523. }
  524. set_caret_column(cc + caret_move_offset);
  525. } else {
  526. insert_text_at_caret(chr);
  527. }
  528. if ((is_overtype_mode_enabled() && !had_selection) || (had_selection)) {
  529. end_complex_operation();
  530. }
  531. }
  532. void CodeEdit::_backspace_internal() {
  533. if (!is_editable()) {
  534. return;
  535. }
  536. if (has_selection()) {
  537. delete_selection();
  538. return;
  539. }
  540. int cc = get_caret_column();
  541. int cl = get_caret_line();
  542. if (cc == 0 && cl == 0) {
  543. return;
  544. }
  545. if (cl > 0 && _is_line_hidden(cl - 1)) {
  546. unfold_line(get_caret_line() - 1);
  547. }
  548. int prev_line = cc ? cl : cl - 1;
  549. int prev_column = cc ? (cc - 1) : (get_line(cl - 1).length());
  550. merge_gutters(prev_line, cl);
  551. if (auto_brace_completion_enabled && cc > 0) {
  552. int idx = _get_auto_brace_pair_open_at_pos(cl, cc);
  553. if (idx != -1) {
  554. prev_column = cc - auto_brace_completion_pairs[idx].open_key.length();
  555. if (_get_auto_brace_pair_close_at_pos(cl, cc) == idx) {
  556. remove_text(prev_line, prev_column, cl, cc + auto_brace_completion_pairs[idx].close_key.length());
  557. } else {
  558. remove_text(prev_line, prev_column, cl, cc);
  559. }
  560. set_caret_line(prev_line, false, true);
  561. set_caret_column(prev_column);
  562. return;
  563. }
  564. }
  565. // For space indentation we need to do a simple unindent if there are no chars to the left, acting in the
  566. // same way as tabs.
  567. if (indent_using_spaces && cc != 0) {
  568. if (get_first_non_whitespace_column(cl) >= cc) {
  569. prev_column = cc - _calculate_spaces_till_next_left_indent(cc);
  570. prev_line = cl;
  571. }
  572. }
  573. remove_text(prev_line, prev_column, cl, cc);
  574. set_caret_line(prev_line, false, true);
  575. set_caret_column(prev_column);
  576. }
  577. /* Indent management */
  578. void CodeEdit::set_indent_size(const int p_size) {
  579. ERR_FAIL_COND_MSG(p_size <= 0, "Indend size must be greater than 0.");
  580. if (indent_size == p_size) {
  581. return;
  582. }
  583. indent_size = p_size;
  584. if (indent_using_spaces) {
  585. indent_text = String(" ").repeat(p_size);
  586. } else {
  587. indent_text = "\t";
  588. }
  589. set_tab_size(p_size);
  590. }
  591. int CodeEdit::get_indent_size() const {
  592. return indent_size;
  593. }
  594. void CodeEdit::set_indent_using_spaces(const bool p_use_spaces) {
  595. indent_using_spaces = p_use_spaces;
  596. if (indent_using_spaces) {
  597. indent_text = String(" ").repeat(indent_size);
  598. } else {
  599. indent_text = "\t";
  600. }
  601. }
  602. bool CodeEdit::is_indent_using_spaces() const {
  603. return indent_using_spaces;
  604. }
  605. void CodeEdit::set_auto_indent_enabled(bool p_enabled) {
  606. auto_indent = p_enabled;
  607. }
  608. bool CodeEdit::is_auto_indent_enabled() const {
  609. return auto_indent;
  610. }
  611. void CodeEdit::set_auto_indent_prefixes(const TypedArray<String> &p_prefixes) {
  612. auto_indent_prefixes.clear();
  613. for (int i = 0; i < p_prefixes.size(); i++) {
  614. const String prefix = p_prefixes[i];
  615. auto_indent_prefixes.insert(prefix[0]);
  616. }
  617. }
  618. TypedArray<String> CodeEdit::get_auto_indent_prefixes() const {
  619. TypedArray<String> prefixes;
  620. for (const Set<char32_t>::Element *E = auto_indent_prefixes.front(); E; E = E->next()) {
  621. prefixes.push_back(String::chr(E->get()));
  622. }
  623. return prefixes;
  624. }
  625. void CodeEdit::do_indent() {
  626. if (!is_editable()) {
  627. return;
  628. }
  629. if (has_selection()) {
  630. indent_lines();
  631. return;
  632. }
  633. if (!indent_using_spaces) {
  634. insert_text_at_caret("\t");
  635. return;
  636. }
  637. int spaces_to_add = _calculate_spaces_till_next_right_indent(get_caret_column());
  638. if (spaces_to_add > 0) {
  639. insert_text_at_caret(String(" ").repeat(spaces_to_add));
  640. }
  641. }
  642. void CodeEdit::indent_lines() {
  643. if (!is_editable()) {
  644. return;
  645. }
  646. begin_complex_operation();
  647. /* This value informs us by how much we changed selection position by indenting right. */
  648. /* Default is 1 for tab indentation. */
  649. int selection_offset = 1;
  650. int start_line = get_caret_line();
  651. int end_line = start_line;
  652. if (has_selection()) {
  653. start_line = get_selection_from_line();
  654. end_line = get_selection_to_line();
  655. /* Ignore the last line if the selection is not past the first column. */
  656. if (get_selection_to_column() == 0) {
  657. selection_offset = 0;
  658. end_line--;
  659. }
  660. }
  661. for (int i = start_line; i <= end_line; i++) {
  662. const String line_text = get_line(i);
  663. if (line_text.size() == 0 && has_selection()) {
  664. continue;
  665. }
  666. if (!indent_using_spaces) {
  667. set_line(i, '\t' + line_text);
  668. continue;
  669. }
  670. /* We don't really care where selection is - we just need to know indentation level at the beginning of the line. */
  671. /* Since we will add this many spaces, we want to move the whole selection and caret by this much. */
  672. int spaces_to_add = _calculate_spaces_till_next_right_indent(get_first_non_whitespace_column(i));
  673. set_line(i, String(" ").repeat(spaces_to_add) + line_text);
  674. selection_offset = spaces_to_add;
  675. }
  676. /* Fix selection and caret being off after shifting selection right.*/
  677. if (has_selection()) {
  678. select(start_line, get_selection_from_column() + selection_offset, get_selection_to_line(), get_selection_to_column() + selection_offset);
  679. }
  680. set_caret_column(get_caret_column() + selection_offset, false);
  681. end_complex_operation();
  682. }
  683. void CodeEdit::do_unindent() {
  684. if (!is_editable()) {
  685. return;
  686. }
  687. int cc = get_caret_column();
  688. if (has_selection() || cc <= 0) {
  689. unindent_lines();
  690. return;
  691. }
  692. int cl = get_caret_line();
  693. const String &line = get_line(cl);
  694. if (line[cc - 1] == '\t') {
  695. remove_text(cl, cc - 1, cl, cc);
  696. set_caret_column(MAX(0, cc - 1));
  697. return;
  698. }
  699. if (line[cc - 1] != ' ') {
  700. return;
  701. }
  702. int spaces_to_remove = _calculate_spaces_till_next_left_indent(cc);
  703. if (spaces_to_remove > 0) {
  704. for (int i = 1; i <= spaces_to_remove; i++) {
  705. if (line[cc - i] != ' ') {
  706. spaces_to_remove = i - 1;
  707. break;
  708. }
  709. }
  710. remove_text(cl, cc - spaces_to_remove, cl, cc);
  711. set_caret_column(MAX(0, cc - spaces_to_remove));
  712. }
  713. }
  714. void CodeEdit::unindent_lines() {
  715. if (!is_editable()) {
  716. return;
  717. }
  718. begin_complex_operation();
  719. /* Moving caret and selection after unindenting can get tricky because */
  720. /* changing content of line can move caret and selection on its own (if new line ends before previous position of either), */
  721. /* therefore we just remember initial values and at the end of the operation offset them by number of removed characters. */
  722. int removed_characters = 0;
  723. int initial_selection_end_column = 0;
  724. int initial_cursor_column = get_caret_column();
  725. int start_line = get_caret_line();
  726. int end_line = start_line;
  727. if (has_selection()) {
  728. start_line = get_selection_from_line();
  729. end_line = get_selection_to_line();
  730. /* Ignore the last line if the selection is not past the first column. */
  731. initial_selection_end_column = get_selection_to_column();
  732. if (initial_selection_end_column == 0) {
  733. end_line--;
  734. }
  735. }
  736. bool first_line_edited = false;
  737. bool last_line_edited = false;
  738. for (int i = start_line; i <= end_line; i++) {
  739. String line_text = get_line(i);
  740. if (line_text.begins_with("\t")) {
  741. line_text = line_text.substr(1, line_text.length());
  742. set_line(i, line_text);
  743. removed_characters = 1;
  744. first_line_edited = (i == start_line) ? true : first_line_edited;
  745. last_line_edited = (i == end_line) ? true : last_line_edited;
  746. continue;
  747. }
  748. if (line_text.begins_with(" ")) {
  749. /* When unindenting we aim to remove spaces before line that has selection no matter what is selected, */
  750. /* Here we remove only enough spaces to align text to nearest full multiple of indentation_size. */
  751. /* In case where selection begins at the start of indentation_size multiple we remove whole indentation level. */
  752. int spaces_to_remove = _calculate_spaces_till_next_left_indent(get_first_non_whitespace_column(i));
  753. line_text = line_text.substr(spaces_to_remove, line_text.length());
  754. set_line(i, line_text);
  755. removed_characters = spaces_to_remove;
  756. first_line_edited = (i == start_line) ? true : first_line_edited;
  757. last_line_edited = (i == end_line) ? true : last_line_edited;
  758. }
  759. }
  760. if (has_selection()) {
  761. /* Fix selection being off by one on the first line. */
  762. if (first_line_edited) {
  763. select(get_selection_from_line(), get_selection_from_column() - removed_characters, get_selection_to_line(), initial_selection_end_column);
  764. }
  765. /* Fix selection being off by one on the last line. */
  766. if (last_line_edited) {
  767. select(get_selection_from_line(), get_selection_from_column(), get_selection_to_line(), initial_selection_end_column - removed_characters);
  768. }
  769. }
  770. set_caret_column(initial_cursor_column - removed_characters, false);
  771. end_complex_operation();
  772. }
  773. int CodeEdit::_calculate_spaces_till_next_left_indent(int p_column) const {
  774. int spaces_till_indent = p_column % indent_size;
  775. if (spaces_till_indent == 0) {
  776. spaces_till_indent = indent_size;
  777. }
  778. return spaces_till_indent;
  779. }
  780. int CodeEdit::_calculate_spaces_till_next_right_indent(int p_column) const {
  781. return indent_size - p_column % indent_size;
  782. }
  783. void CodeEdit::_new_line(bool p_split_current_line, bool p_above) {
  784. if (!is_editable()) {
  785. return;
  786. }
  787. const int cc = get_caret_column();
  788. const int cl = get_caret_line();
  789. const String line = get_line(cl);
  790. String ins = "\n";
  791. /* Append current indentation. */
  792. int space_count = 0;
  793. int line_col = 0;
  794. for (; line_col < cc; line_col++) {
  795. if (line[line_col] == '\t') {
  796. ins += indent_text;
  797. space_count = 0;
  798. continue;
  799. }
  800. if (line[line_col] == ' ') {
  801. space_count++;
  802. if (space_count == indent_size) {
  803. ins += indent_text;
  804. space_count = 0;
  805. }
  806. continue;
  807. }
  808. break;
  809. }
  810. if (is_line_folded(cl)) {
  811. unfold_line(cl);
  812. }
  813. /* Indent once again if the previous line needs it, ie ':'. */
  814. /* Then add an addition new line for any closing pairs aka '()'. */
  815. /* Skip this in comments or if we are going above. */
  816. bool brace_indent = false;
  817. if (auto_indent && !p_above && cc > 0 && is_in_comment(cl) == -1) {
  818. bool should_indent = false;
  819. char32_t indent_char = ' ';
  820. for (; line_col < cc; line_col++) {
  821. char32_t c = line[line_col];
  822. if (auto_indent_prefixes.has(c)) {
  823. should_indent = true;
  824. indent_char = c;
  825. continue;
  826. }
  827. /* Make sure this is the last char, trailing whitespace or comments are okay. */
  828. if (should_indent && (!_is_whitespace(c) && is_in_comment(cl, cc) == -1)) {
  829. should_indent = false;
  830. }
  831. }
  832. if (should_indent) {
  833. ins += indent_text;
  834. String closing_pair = get_auto_brace_completion_close_key(String::chr(indent_char));
  835. if (!closing_pair.is_empty() && line.find(closing_pair, cc) == cc) {
  836. /* No need to move the brace below if we are not taking the text with us. */
  837. if (p_split_current_line) {
  838. brace_indent = true;
  839. ins += "\n" + ins.substr(indent_text.size(), ins.length() - 2);
  840. } else {
  841. brace_indent = false;
  842. ins = "\n" + ins.substr(indent_text.size(), ins.length() - 2);
  843. }
  844. }
  845. }
  846. }
  847. begin_complex_operation();
  848. bool first_line = false;
  849. if (!p_split_current_line) {
  850. if (p_above) {
  851. if (cl > 0) {
  852. set_caret_line(cl - 1, false);
  853. set_caret_column(get_line(get_caret_line()).length());
  854. } else {
  855. set_caret_column(0);
  856. first_line = true;
  857. }
  858. } else {
  859. set_caret_column(line.length());
  860. }
  861. }
  862. insert_text_at_caret(ins);
  863. if (first_line) {
  864. set_caret_line(0);
  865. } else if (brace_indent) {
  866. set_caret_line(get_caret_line() - 1, false);
  867. set_caret_column(get_line(get_caret_line()).length());
  868. }
  869. end_complex_operation();
  870. }
  871. /* Auto brace completion */
  872. void CodeEdit::set_auto_brace_completion_enabled(bool p_enabled) {
  873. auto_brace_completion_enabled = p_enabled;
  874. }
  875. bool CodeEdit::is_auto_brace_completion_enabled() const {
  876. return auto_brace_completion_enabled;
  877. }
  878. void CodeEdit::set_highlight_matching_braces_enabled(bool p_enabled) {
  879. highlight_matching_braces_enabled = p_enabled;
  880. update();
  881. }
  882. bool CodeEdit::is_highlight_matching_braces_enabled() const {
  883. return highlight_matching_braces_enabled;
  884. }
  885. void CodeEdit::add_auto_brace_completion_pair(const String &p_open_key, const String &p_close_key) {
  886. ERR_FAIL_COND_MSG(p_open_key.is_empty(), "auto brace completion open key cannot be empty");
  887. ERR_FAIL_COND_MSG(p_close_key.is_empty(), "auto brace completion close key cannot be empty");
  888. for (int i = 0; i < p_open_key.length(); i++) {
  889. ERR_FAIL_COND_MSG(!is_symbol(p_open_key[i]), "auto brace completion open key must be a symbol");
  890. }
  891. for (int i = 0; i < p_close_key.length(); i++) {
  892. ERR_FAIL_COND_MSG(!is_symbol(p_close_key[i]), "auto brace completion close key must be a symbol");
  893. }
  894. int at = 0;
  895. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  896. ERR_FAIL_COND_MSG(auto_brace_completion_pairs[i].open_key == p_open_key, "auto brace completion open key '" + p_open_key + "' already exists.");
  897. if (p_open_key.length() < auto_brace_completion_pairs[i].open_key.length()) {
  898. at++;
  899. }
  900. }
  901. BracePair brace_pair;
  902. brace_pair.open_key = p_open_key;
  903. brace_pair.close_key = p_close_key;
  904. auto_brace_completion_pairs.insert(at, brace_pair);
  905. }
  906. void CodeEdit::set_auto_brace_completion_pairs(const Dictionary &p_auto_brace_completion_pairs) {
  907. auto_brace_completion_pairs.clear();
  908. Array keys = p_auto_brace_completion_pairs.keys();
  909. for (int i = 0; i < keys.size(); i++) {
  910. add_auto_brace_completion_pair(keys[i], p_auto_brace_completion_pairs[keys[i]]);
  911. }
  912. }
  913. Dictionary CodeEdit::get_auto_brace_completion_pairs() const {
  914. Dictionary brace_pairs;
  915. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  916. brace_pairs[auto_brace_completion_pairs[i].open_key] = auto_brace_completion_pairs[i].close_key;
  917. }
  918. return brace_pairs;
  919. }
  920. bool CodeEdit::has_auto_brace_completion_open_key(const String &p_open_key) const {
  921. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  922. if (auto_brace_completion_pairs[i].open_key == p_open_key) {
  923. return true;
  924. }
  925. }
  926. return false;
  927. }
  928. bool CodeEdit::has_auto_brace_completion_close_key(const String &p_close_key) const {
  929. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  930. if (auto_brace_completion_pairs[i].close_key == p_close_key) {
  931. return true;
  932. }
  933. }
  934. return false;
  935. }
  936. String CodeEdit::get_auto_brace_completion_close_key(const String &p_open_key) const {
  937. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  938. if (auto_brace_completion_pairs[i].open_key == p_open_key) {
  939. return auto_brace_completion_pairs[i].close_key;
  940. }
  941. }
  942. return String();
  943. }
  944. /* Main Gutter */
  945. void CodeEdit::_update_draw_main_gutter() {
  946. set_gutter_draw(main_gutter, draw_breakpoints || draw_bookmarks || draw_executing_lines);
  947. }
  948. void CodeEdit::set_draw_breakpoints_gutter(bool p_draw) {
  949. draw_breakpoints = p_draw;
  950. set_gutter_clickable(main_gutter, p_draw);
  951. _update_draw_main_gutter();
  952. }
  953. bool CodeEdit::is_drawing_breakpoints_gutter() const {
  954. return draw_breakpoints;
  955. }
  956. void CodeEdit::set_draw_bookmarks_gutter(bool p_draw) {
  957. draw_bookmarks = p_draw;
  958. _update_draw_main_gutter();
  959. }
  960. bool CodeEdit::is_drawing_bookmarks_gutter() const {
  961. return draw_bookmarks;
  962. }
  963. void CodeEdit::set_draw_executing_lines_gutter(bool p_draw) {
  964. draw_executing_lines = p_draw;
  965. _update_draw_main_gutter();
  966. }
  967. bool CodeEdit::is_drawing_executing_lines_gutter() const {
  968. return draw_executing_lines;
  969. }
  970. void CodeEdit::_main_gutter_draw_callback(int p_line, int p_gutter, const Rect2 &p_region) {
  971. if (draw_breakpoints && breakpoint_icon.is_valid()) {
  972. bool hovering = p_region.has_point(get_local_mouse_pos());
  973. bool breakpointed = is_line_breakpointed(p_line);
  974. if (breakpointed || (hovering && !is_dragging_cursor())) {
  975. int padding = p_region.size.x / 6;
  976. Rect2 icon_region = p_region;
  977. icon_region.position += Point2(padding, padding);
  978. icon_region.size -= Point2(padding, padding) * 2;
  979. // Darken icon when hovering & not yet breakpointed.
  980. Color use_color = hovering && !breakpointed ? breakpoint_color.darkened(0.4) : breakpoint_color;
  981. breakpoint_icon->draw_rect(get_canvas_item(), icon_region, false, use_color);
  982. }
  983. }
  984. if (draw_bookmarks && is_line_bookmarked(p_line) && bookmark_icon.is_valid()) {
  985. int horizontal_padding = p_region.size.x / 2;
  986. int vertical_padding = p_region.size.y / 4;
  987. Rect2 bookmark_region = p_region;
  988. bookmark_region.position += Point2(horizontal_padding, 0);
  989. bookmark_region.size -= Point2(horizontal_padding * 1.1, vertical_padding);
  990. bookmark_icon->draw_rect(get_canvas_item(), bookmark_region, false, bookmark_color);
  991. }
  992. if (draw_executing_lines && is_line_executing(p_line) && executing_line_icon.is_valid()) {
  993. int horizontal_padding = p_region.size.x / 10;
  994. int vertical_padding = p_region.size.y / 4;
  995. Rect2 executing_line_region = p_region;
  996. executing_line_region.position += Point2(horizontal_padding, vertical_padding);
  997. executing_line_region.size -= Point2(horizontal_padding, vertical_padding) * 2;
  998. executing_line_icon->draw_rect(get_canvas_item(), executing_line_region, false, executing_line_color);
  999. }
  1000. }
  1001. // Breakpoints
  1002. void CodeEdit::set_line_as_breakpoint(int p_line, bool p_breakpointed) {
  1003. ERR_FAIL_INDEX(p_line, get_line_count());
  1004. int mask = get_line_gutter_metadata(p_line, main_gutter);
  1005. set_line_gutter_metadata(p_line, main_gutter, p_breakpointed ? mask | MAIN_GUTTER_BREAKPOINT : mask & ~MAIN_GUTTER_BREAKPOINT);
  1006. if (p_breakpointed) {
  1007. breakpointed_lines[p_line] = true;
  1008. } else if (breakpointed_lines.has(p_line)) {
  1009. breakpointed_lines.erase(p_line);
  1010. }
  1011. emit_signal(SNAME("breakpoint_toggled"), p_line);
  1012. update();
  1013. }
  1014. bool CodeEdit::is_line_breakpointed(int p_line) const {
  1015. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_BREAKPOINT;
  1016. }
  1017. void CodeEdit::clear_breakpointed_lines() {
  1018. for (int i = 0; i < get_line_count(); i++) {
  1019. if (is_line_breakpointed(i)) {
  1020. set_line_as_breakpoint(i, false);
  1021. }
  1022. }
  1023. }
  1024. Array CodeEdit::get_breakpointed_lines() const {
  1025. Array ret;
  1026. for (int i = 0; i < get_line_count(); i++) {
  1027. if (is_line_breakpointed(i)) {
  1028. ret.append(i);
  1029. }
  1030. }
  1031. return ret;
  1032. }
  1033. // Bookmarks
  1034. void CodeEdit::set_line_as_bookmarked(int p_line, bool p_bookmarked) {
  1035. int mask = get_line_gutter_metadata(p_line, main_gutter);
  1036. set_line_gutter_metadata(p_line, main_gutter, p_bookmarked ? mask | MAIN_GUTTER_BOOKMARK : mask & ~MAIN_GUTTER_BOOKMARK);
  1037. update();
  1038. }
  1039. bool CodeEdit::is_line_bookmarked(int p_line) const {
  1040. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_BOOKMARK;
  1041. }
  1042. void CodeEdit::clear_bookmarked_lines() {
  1043. for (int i = 0; i < get_line_count(); i++) {
  1044. if (is_line_bookmarked(i)) {
  1045. set_line_as_bookmarked(i, false);
  1046. }
  1047. }
  1048. }
  1049. Array CodeEdit::get_bookmarked_lines() const {
  1050. Array ret;
  1051. for (int i = 0; i < get_line_count(); i++) {
  1052. if (is_line_bookmarked(i)) {
  1053. ret.append(i);
  1054. }
  1055. }
  1056. return ret;
  1057. }
  1058. // executing lines
  1059. void CodeEdit::set_line_as_executing(int p_line, bool p_executing) {
  1060. int mask = get_line_gutter_metadata(p_line, main_gutter);
  1061. set_line_gutter_metadata(p_line, main_gutter, p_executing ? mask | MAIN_GUTTER_EXECUTING : mask & ~MAIN_GUTTER_EXECUTING);
  1062. update();
  1063. }
  1064. bool CodeEdit::is_line_executing(int p_line) const {
  1065. return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_EXECUTING;
  1066. }
  1067. void CodeEdit::clear_executing_lines() {
  1068. for (int i = 0; i < get_line_count(); i++) {
  1069. if (is_line_executing(i)) {
  1070. set_line_as_executing(i, false);
  1071. }
  1072. }
  1073. }
  1074. Array CodeEdit::get_executing_lines() const {
  1075. Array ret;
  1076. for (int i = 0; i < get_line_count(); i++) {
  1077. if (is_line_executing(i)) {
  1078. ret.append(i);
  1079. }
  1080. }
  1081. return ret;
  1082. }
  1083. /* Line numbers */
  1084. void CodeEdit::set_draw_line_numbers(bool p_draw) {
  1085. set_gutter_draw(line_number_gutter, p_draw);
  1086. }
  1087. bool CodeEdit::is_draw_line_numbers_enabled() const {
  1088. return is_gutter_drawn(line_number_gutter);
  1089. }
  1090. void CodeEdit::set_line_numbers_zero_padded(bool p_zero_padded) {
  1091. p_zero_padded ? line_number_padding = "0" : line_number_padding = " ";
  1092. update();
  1093. }
  1094. bool CodeEdit::is_line_numbers_zero_padded() const {
  1095. return line_number_padding == "0";
  1096. }
  1097. void CodeEdit::_line_number_draw_callback(int p_line, int p_gutter, const Rect2 &p_region) {
  1098. String fc = TS->format_number(String::num(p_line + 1).lpad(line_number_digits, line_number_padding));
  1099. Ref<TextLine> tl;
  1100. tl.instantiate();
  1101. tl->add_string(fc, font, font_size);
  1102. int yofs = p_region.position.y + (get_line_height() - tl->get_size().y) / 2;
  1103. Color number_color = get_line_gutter_item_color(p_line, line_number_gutter);
  1104. if (number_color == Color(1, 1, 1)) {
  1105. number_color = line_number_color;
  1106. }
  1107. tl->draw(get_canvas_item(), Point2(p_region.position.x, yofs), number_color);
  1108. }
  1109. /* Fold Gutter */
  1110. void CodeEdit::set_draw_fold_gutter(bool p_draw) {
  1111. set_gutter_draw(fold_gutter, p_draw);
  1112. }
  1113. bool CodeEdit::is_drawing_fold_gutter() const {
  1114. return is_gutter_drawn(fold_gutter);
  1115. }
  1116. void CodeEdit::_fold_gutter_draw_callback(int p_line, int p_gutter, Rect2 p_region) {
  1117. if (!can_fold_line(p_line) && !is_line_folded(p_line)) {
  1118. set_line_gutter_clickable(p_line, fold_gutter, false);
  1119. return;
  1120. }
  1121. set_line_gutter_clickable(p_line, fold_gutter, true);
  1122. int horizontal_padding = p_region.size.x / 10;
  1123. int vertical_padding = p_region.size.y / 6;
  1124. p_region.position += Point2(horizontal_padding, vertical_padding);
  1125. p_region.size -= Point2(horizontal_padding, vertical_padding) * 2;
  1126. if (can_fold_line(p_line)) {
  1127. can_fold_icon->draw_rect(get_canvas_item(), p_region, false, folding_color);
  1128. return;
  1129. }
  1130. folded_icon->draw_rect(get_canvas_item(), p_region, false, folding_color);
  1131. }
  1132. /* Line Folding */
  1133. void CodeEdit::set_line_folding_enabled(bool p_enabled) {
  1134. line_folding_enabled = p_enabled;
  1135. _set_hiding_enabled(p_enabled);
  1136. }
  1137. bool CodeEdit::is_line_folding_enabled() const {
  1138. return line_folding_enabled;
  1139. }
  1140. bool CodeEdit::can_fold_line(int p_line) const {
  1141. ERR_FAIL_INDEX_V(p_line, get_line_count(), false);
  1142. if (!line_folding_enabled) {
  1143. return false;
  1144. }
  1145. if (p_line + 1 >= get_line_count() || get_line(p_line).strip_edges().size() == 0) {
  1146. return false;
  1147. }
  1148. if (_is_line_hidden(p_line) || is_line_folded(p_line)) {
  1149. return false;
  1150. }
  1151. /* Check for full multiline line or block strings / comments. */
  1152. int in_comment = is_in_comment(p_line);
  1153. int in_string = (in_comment == -1) ? is_in_string(p_line) : -1;
  1154. if (in_string != -1 || in_comment != -1) {
  1155. if (get_delimiter_start_position(p_line, get_line(p_line).size() - 1).y != p_line) {
  1156. return false;
  1157. }
  1158. int delimter_end_line = get_delimiter_end_position(p_line, get_line(p_line).size() - 1).y;
  1159. /* No end line, therefore we have a multiline region over the rest of the file. */
  1160. if (delimter_end_line == -1) {
  1161. return true;
  1162. }
  1163. /* End line is the same therefore we have a block. */
  1164. if (delimter_end_line == p_line) {
  1165. /* Check we are the start of the block. */
  1166. if (p_line - 1 >= 0) {
  1167. if ((in_string != -1 && is_in_string(p_line - 1) != -1) || (in_comment != -1 && is_in_comment(p_line - 1) != -1)) {
  1168. return false;
  1169. }
  1170. }
  1171. /* Check it continues for at least one line. */
  1172. return ((in_string != -1 && is_in_string(p_line + 1) != -1) || (in_comment != -1 && is_in_comment(p_line + 1) != -1));
  1173. }
  1174. return ((in_string != -1 && is_in_string(delimter_end_line) != -1) || (in_comment != -1 && is_in_comment(delimter_end_line) != -1));
  1175. }
  1176. /* Otherwise check indent levels. */
  1177. int start_indent = get_indent_level(p_line);
  1178. for (int i = p_line + 1; i < get_line_count(); i++) {
  1179. if (is_in_string(i) != -1 || is_in_comment(i) != -1 || get_line(i).strip_edges().size() == 0) {
  1180. continue;
  1181. }
  1182. return (get_indent_level(i) > start_indent);
  1183. }
  1184. return false;
  1185. }
  1186. void CodeEdit::fold_line(int p_line) {
  1187. ERR_FAIL_INDEX(p_line, get_line_count());
  1188. if (!is_line_folding_enabled() || !can_fold_line(p_line)) {
  1189. return;
  1190. }
  1191. /* Find the last line to be hidden. */
  1192. const int line_count = get_line_count() - 1;
  1193. int end_line = line_count;
  1194. int in_comment = is_in_comment(p_line);
  1195. int in_string = (in_comment == -1) ? is_in_string(p_line) : -1;
  1196. if (in_string != -1 || in_comment != -1) {
  1197. end_line = get_delimiter_end_position(p_line, get_line(p_line).size() - 1).y;
  1198. /* End line is the same therefore we have a block of single line delimiters. */
  1199. if (end_line == p_line) {
  1200. for (int i = p_line + 1; i <= line_count; i++) {
  1201. if (i == line_count) {
  1202. end_line = line_count;
  1203. break;
  1204. }
  1205. if ((in_string != -1 && is_in_string(i) == -1) || (in_comment != -1 && is_in_comment(i) == -1)) {
  1206. end_line = i - 1;
  1207. break;
  1208. }
  1209. }
  1210. }
  1211. } else {
  1212. int start_indent = get_indent_level(p_line);
  1213. for (int i = p_line + 1; i <= line_count; i++) {
  1214. if (get_line(p_line).strip_edges().size() == 0 || is_in_string(i) != -1 || is_in_comment(i) != -1) {
  1215. end_line = i;
  1216. continue;
  1217. }
  1218. if (i == line_count) {
  1219. /* Do not fold empty last line of script if any */
  1220. end_line = i;
  1221. if (get_line(i).strip_edges().size() == 0) {
  1222. end_line--;
  1223. }
  1224. break;
  1225. }
  1226. if ((get_indent_level(i) <= start_indent && get_line(i).strip_edges().size() != 0)) {
  1227. /* Keep an empty line unfolded if any */
  1228. end_line = i - 1;
  1229. if (get_line(i - 1).strip_edges().size() == 0 && i - 2 > p_line) {
  1230. end_line = i - 2;
  1231. }
  1232. break;
  1233. }
  1234. }
  1235. }
  1236. for (int i = p_line + 1; i <= end_line; i++) {
  1237. _set_line_as_hidden(i, true);
  1238. }
  1239. /* Fix selection. */
  1240. if (has_selection()) {
  1241. if (_is_line_hidden(get_selection_from_line()) && _is_line_hidden(get_selection_to_line())) {
  1242. deselect();
  1243. } else if (_is_line_hidden(get_selection_from_line())) {
  1244. select(p_line, 9999, get_selection_to_line(), get_selection_to_column());
  1245. } else if (_is_line_hidden(get_selection_to_line())) {
  1246. select(get_selection_from_line(), get_selection_from_column(), p_line, 9999);
  1247. }
  1248. }
  1249. /* Reset caret. */
  1250. if (_is_line_hidden(get_caret_line())) {
  1251. set_caret_line(p_line, false, false);
  1252. set_caret_column(get_line(p_line).length(), false);
  1253. }
  1254. update();
  1255. }
  1256. void CodeEdit::unfold_line(int p_line) {
  1257. ERR_FAIL_INDEX(p_line, get_line_count());
  1258. if (!is_line_folded(p_line) && !_is_line_hidden(p_line)) {
  1259. return;
  1260. }
  1261. int fold_start = p_line;
  1262. for (; fold_start > 0; fold_start--) {
  1263. if (is_line_folded(fold_start)) {
  1264. break;
  1265. }
  1266. }
  1267. fold_start = is_line_folded(fold_start) ? fold_start : p_line;
  1268. for (int i = fold_start + 1; i < get_line_count(); i++) {
  1269. if (!_is_line_hidden(i)) {
  1270. break;
  1271. }
  1272. _set_line_as_hidden(i, false);
  1273. }
  1274. update();
  1275. }
  1276. void CodeEdit::fold_all_lines() {
  1277. for (int i = 0; i < get_line_count(); i++) {
  1278. fold_line(i);
  1279. }
  1280. update();
  1281. }
  1282. void CodeEdit::unfold_all_lines() {
  1283. _unhide_all_lines();
  1284. }
  1285. void CodeEdit::toggle_foldable_line(int p_line) {
  1286. ERR_FAIL_INDEX(p_line, get_line_count());
  1287. if (is_line_folded(p_line)) {
  1288. unfold_line(p_line);
  1289. return;
  1290. }
  1291. fold_line(p_line);
  1292. }
  1293. bool CodeEdit::is_line_folded(int p_line) const {
  1294. ERR_FAIL_INDEX_V(p_line, get_line_count(), false);
  1295. return p_line + 1 < get_line_count() && !_is_line_hidden(p_line) && _is_line_hidden(p_line + 1);
  1296. }
  1297. TypedArray<int> CodeEdit::get_folded_lines() const {
  1298. TypedArray<int> folded_lines;
  1299. for (int i = 0; i < get_line_count(); i++) {
  1300. if (is_line_folded(i)) {
  1301. folded_lines.push_back(i);
  1302. }
  1303. }
  1304. return folded_lines;
  1305. }
  1306. /* Delimiters */
  1307. // Strings
  1308. void CodeEdit::add_string_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only) {
  1309. _add_delimiter(p_start_key, p_end_key, p_line_only, TYPE_STRING);
  1310. }
  1311. void CodeEdit::remove_string_delimiter(const String &p_start_key) {
  1312. _remove_delimiter(p_start_key, TYPE_STRING);
  1313. }
  1314. bool CodeEdit::has_string_delimiter(const String &p_start_key) const {
  1315. return _has_delimiter(p_start_key, TYPE_STRING);
  1316. }
  1317. void CodeEdit::set_string_delimiters(const TypedArray<String> &p_string_delimiters) {
  1318. _set_delimiters(p_string_delimiters, TYPE_STRING);
  1319. }
  1320. void CodeEdit::clear_string_delimiters() {
  1321. _clear_delimiters(TYPE_STRING);
  1322. }
  1323. TypedArray<String> CodeEdit::get_string_delimiters() const {
  1324. return _get_delimiters(TYPE_STRING);
  1325. }
  1326. int CodeEdit::is_in_string(int p_line, int p_column) const {
  1327. return _is_in_delimiter(p_line, p_column, TYPE_STRING);
  1328. }
  1329. // Comments
  1330. void CodeEdit::add_comment_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only) {
  1331. _add_delimiter(p_start_key, p_end_key, p_line_only, TYPE_COMMENT);
  1332. }
  1333. void CodeEdit::remove_comment_delimiter(const String &p_start_key) {
  1334. _remove_delimiter(p_start_key, TYPE_COMMENT);
  1335. }
  1336. bool CodeEdit::has_comment_delimiter(const String &p_start_key) const {
  1337. return _has_delimiter(p_start_key, TYPE_COMMENT);
  1338. }
  1339. void CodeEdit::set_comment_delimiters(const TypedArray<String> &p_comment_delimiters) {
  1340. _set_delimiters(p_comment_delimiters, TYPE_COMMENT);
  1341. }
  1342. void CodeEdit::clear_comment_delimiters() {
  1343. _clear_delimiters(TYPE_COMMENT);
  1344. }
  1345. TypedArray<String> CodeEdit::get_comment_delimiters() const {
  1346. return _get_delimiters(TYPE_COMMENT);
  1347. }
  1348. int CodeEdit::is_in_comment(int p_line, int p_column) const {
  1349. return _is_in_delimiter(p_line, p_column, TYPE_COMMENT);
  1350. }
  1351. String CodeEdit::get_delimiter_start_key(int p_delimiter_idx) const {
  1352. ERR_FAIL_INDEX_V(p_delimiter_idx, delimiters.size(), "");
  1353. return delimiters[p_delimiter_idx].start_key;
  1354. }
  1355. String CodeEdit::get_delimiter_end_key(int p_delimiter_idx) const {
  1356. ERR_FAIL_INDEX_V(p_delimiter_idx, delimiters.size(), "");
  1357. return delimiters[p_delimiter_idx].end_key;
  1358. }
  1359. Point2 CodeEdit::get_delimiter_start_position(int p_line, int p_column) const {
  1360. if (delimiters.size() == 0) {
  1361. return Point2(-1, -1);
  1362. }
  1363. ERR_FAIL_INDEX_V(p_line, get_line_count(), Point2(-1, -1));
  1364. ERR_FAIL_COND_V(p_column - 1 > get_line(p_line).size(), Point2(-1, -1));
  1365. Point2 start_position;
  1366. start_position.y = -1;
  1367. start_position.x = -1;
  1368. bool in_region = ((p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->value()) != -1;
  1369. /* Check the keys for this line. */
  1370. for (const KeyValue<int, int> &E : delimiter_cache[p_line]) {
  1371. if (E.key > p_column) {
  1372. break;
  1373. }
  1374. in_region = E.value != -1;
  1375. start_position.x = in_region ? E.key : -1;
  1376. }
  1377. /* Region was found on this line and is not a multiline continuation. */
  1378. int line_length = get_line(p_line).length();
  1379. if (start_position.x != -1 && line_length > 0 && start_position.x != line_length + 1) {
  1380. start_position.y = p_line;
  1381. return start_position;
  1382. }
  1383. /* Not in a region */
  1384. if (!in_region) {
  1385. return start_position;
  1386. }
  1387. /* Region starts on a previous line */
  1388. for (int i = p_line - 1; i >= 0; i--) {
  1389. if (delimiter_cache[i].size() < 1) {
  1390. continue;
  1391. }
  1392. start_position.y = i;
  1393. start_position.x = delimiter_cache[i].back()->key();
  1394. /* Make sure it's not a multiline continuation. */
  1395. line_length = get_line(i).length();
  1396. if (line_length > 0 && start_position.x != line_length + 1) {
  1397. break;
  1398. }
  1399. }
  1400. return start_position;
  1401. }
  1402. Point2 CodeEdit::get_delimiter_end_position(int p_line, int p_column) const {
  1403. if (delimiters.size() == 0) {
  1404. return Point2(-1, -1);
  1405. }
  1406. ERR_FAIL_INDEX_V(p_line, get_line_count(), Point2(-1, -1));
  1407. ERR_FAIL_COND_V(p_column - 1 > get_line(p_line).size(), Point2(-1, -1));
  1408. Point2 end_position;
  1409. end_position.y = -1;
  1410. end_position.x = -1;
  1411. int region = (p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->value();
  1412. /* Check the keys for this line. */
  1413. for (const KeyValue<int, int> &E : delimiter_cache[p_line]) {
  1414. end_position.x = (E.value == -1) ? E.key : -1;
  1415. if (E.key > p_column) {
  1416. break;
  1417. }
  1418. region = E.value;
  1419. }
  1420. /* Region was found on this line and is not a multiline continuation. */
  1421. if (region != -1 && end_position.x != -1 && (delimiters[region].line_only || end_position.x != get_line(p_line).length() + 1)) {
  1422. end_position.y = p_line;
  1423. return end_position;
  1424. }
  1425. /* Not in a region */
  1426. if (region == -1) {
  1427. end_position.x = -1;
  1428. return end_position;
  1429. }
  1430. /* Region ends on a later line */
  1431. for (int i = p_line + 1; i < get_line_count(); i++) {
  1432. if (delimiter_cache[i].size() < 1 || delimiter_cache[i].front()->value() != -1) {
  1433. continue;
  1434. }
  1435. end_position.x = delimiter_cache[i].front()->key();
  1436. /* Make sure it's not a multiline continuation. */
  1437. if (get_line(i).length() > 0 && end_position.x != get_line(i).length() + 1) {
  1438. end_position.y = i;
  1439. break;
  1440. }
  1441. end_position.x = -1;
  1442. }
  1443. return end_position;
  1444. }
  1445. /* Code hint */
  1446. void CodeEdit::set_code_hint(const String &p_hint) {
  1447. code_hint = p_hint;
  1448. code_hint_xpos = -0xFFFF;
  1449. update();
  1450. }
  1451. void CodeEdit::set_code_hint_draw_below(bool p_below) {
  1452. code_hint_draw_below = p_below;
  1453. update();
  1454. }
  1455. /* Code Completion */
  1456. void CodeEdit::set_code_completion_enabled(bool p_enable) {
  1457. code_completion_enabled = p_enable;
  1458. }
  1459. bool CodeEdit::is_code_completion_enabled() const {
  1460. return code_completion_enabled;
  1461. }
  1462. void CodeEdit::set_code_completion_prefixes(const TypedArray<String> &p_prefixes) {
  1463. code_completion_prefixes.clear();
  1464. for (int i = 0; i < p_prefixes.size(); i++) {
  1465. const String prefix = p_prefixes[i];
  1466. ERR_CONTINUE_MSG(prefix.is_empty(), "Code completion prefix cannot be empty.");
  1467. code_completion_prefixes.insert(prefix[0]);
  1468. }
  1469. }
  1470. TypedArray<String> CodeEdit::get_code_completion_prefixes() const {
  1471. TypedArray<String> prefixes;
  1472. for (const Set<char32_t>::Element *E = code_completion_prefixes.front(); E; E = E->next()) {
  1473. prefixes.push_back(String::chr(E->get()));
  1474. }
  1475. return prefixes;
  1476. }
  1477. String CodeEdit::get_text_for_code_completion() const {
  1478. StringBuilder completion_text;
  1479. const int text_size = get_line_count();
  1480. for (int i = 0; i < text_size; i++) {
  1481. String line = get_line(i);
  1482. if (i == get_caret_line()) {
  1483. completion_text += line.substr(0, get_caret_column());
  1484. /* Not unicode, represents the caret. */
  1485. completion_text += String::chr(0xFFFF);
  1486. completion_text += line.substr(get_caret_column(), line.size());
  1487. } else {
  1488. completion_text += line;
  1489. }
  1490. if (i != text_size - 1) {
  1491. completion_text += "\n";
  1492. }
  1493. }
  1494. return completion_text.as_string();
  1495. }
  1496. void CodeEdit::request_code_completion(bool p_force) {
  1497. if (GDVIRTUAL_CALL(_request_code_completion, p_force)) {
  1498. return;
  1499. }
  1500. /* Don't re-query if all existing options are quoted types, eg path, signal. */
  1501. bool ignored = code_completion_active && !code_completion_options.is_empty();
  1502. if (ignored) {
  1503. ScriptCodeCompletionOption::Kind kind = ScriptCodeCompletionOption::KIND_PLAIN_TEXT;
  1504. const ScriptCodeCompletionOption *previous_option = nullptr;
  1505. for (int i = 0; i < code_completion_options.size(); i++) {
  1506. const ScriptCodeCompletionOption &current_option = code_completion_options[i];
  1507. if (!previous_option) {
  1508. previous_option = &current_option;
  1509. kind = current_option.kind;
  1510. }
  1511. if (previous_option->kind != current_option.kind) {
  1512. ignored = false;
  1513. break;
  1514. }
  1515. }
  1516. ignored = ignored && (kind == ScriptCodeCompletionOption::KIND_FILE_PATH || kind == ScriptCodeCompletionOption::KIND_NODE_PATH || kind == ScriptCodeCompletionOption::KIND_SIGNAL);
  1517. }
  1518. if (ignored) {
  1519. return;
  1520. }
  1521. if (p_force) {
  1522. emit_signal(SNAME("request_code_completion"));
  1523. return;
  1524. }
  1525. String line = get_line(get_caret_line());
  1526. int ofs = CLAMP(get_caret_column(), 0, line.length());
  1527. if (ofs > 0 && (is_in_string(get_caret_line(), ofs) != -1 || _is_char(line[ofs - 1]) || code_completion_prefixes.has(line[ofs - 1]))) {
  1528. emit_signal(SNAME("request_code_completion"));
  1529. } else if (ofs > 1 && line[ofs - 1] == ' ' && code_completion_prefixes.has(line[ofs - 2])) {
  1530. emit_signal(SNAME("request_code_completion"));
  1531. }
  1532. }
  1533. 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 RES &p_icon, const Variant &p_value) {
  1534. ScriptCodeCompletionOption completion_option;
  1535. completion_option.kind = (ScriptCodeCompletionOption::Kind)p_type;
  1536. completion_option.display = p_display_text;
  1537. completion_option.insert_text = p_insert_text;
  1538. completion_option.font_color = p_text_color;
  1539. completion_option.icon = p_icon;
  1540. completion_option.default_value = p_value;
  1541. code_completion_option_submitted.push_back(completion_option);
  1542. }
  1543. void CodeEdit::update_code_completion_options(bool p_forced) {
  1544. code_completion_forced = p_forced;
  1545. code_completion_option_sources = code_completion_option_submitted;
  1546. code_completion_option_submitted.clear();
  1547. _filter_code_completion_candidates_impl();
  1548. }
  1549. TypedArray<Dictionary> CodeEdit::get_code_completion_options() const {
  1550. if (!code_completion_active) {
  1551. return TypedArray<Dictionary>();
  1552. }
  1553. TypedArray<Dictionary> completion_options;
  1554. completion_options.resize(code_completion_options.size());
  1555. for (int i = 0; i < code_completion_options.size(); i++) {
  1556. Dictionary option;
  1557. option["kind"] = code_completion_options[i].kind;
  1558. option["display_text"] = code_completion_options[i].display;
  1559. option["insert_text"] = code_completion_options[i].insert_text;
  1560. option["font_color"] = code_completion_options[i].font_color;
  1561. option["icon"] = code_completion_options[i].icon;
  1562. option["default_value"] = code_completion_options[i].default_value;
  1563. completion_options[i] = option;
  1564. }
  1565. return completion_options;
  1566. }
  1567. Dictionary CodeEdit::get_code_completion_option(int p_index) const {
  1568. if (!code_completion_active) {
  1569. return Dictionary();
  1570. }
  1571. ERR_FAIL_INDEX_V(p_index, code_completion_options.size(), Dictionary());
  1572. Dictionary option;
  1573. option["kind"] = code_completion_options[p_index].kind;
  1574. option["display_text"] = code_completion_options[p_index].display;
  1575. option["insert_text"] = code_completion_options[p_index].insert_text;
  1576. option["font_color"] = code_completion_options[p_index].font_color;
  1577. option["icon"] = code_completion_options[p_index].icon;
  1578. option["default_value"] = code_completion_options[p_index].default_value;
  1579. return option;
  1580. }
  1581. int CodeEdit::get_code_completion_selected_index() const {
  1582. return (code_completion_active) ? code_completion_current_selected : -1;
  1583. }
  1584. void CodeEdit::set_code_completion_selected_index(int p_index) {
  1585. if (!code_completion_active) {
  1586. return;
  1587. }
  1588. ERR_FAIL_INDEX(p_index, code_completion_options.size());
  1589. code_completion_current_selected = p_index;
  1590. update();
  1591. }
  1592. void CodeEdit::confirm_code_completion(bool p_replace) {
  1593. if (!is_editable() || !code_completion_active) {
  1594. return;
  1595. }
  1596. if (GDVIRTUAL_CALL(_confirm_code_completion, p_replace)) {
  1597. return;
  1598. }
  1599. begin_complex_operation();
  1600. int caret_line = get_caret_line();
  1601. const String &insert_text = code_completion_options[code_completion_current_selected].insert_text;
  1602. const String &display_text = code_completion_options[code_completion_current_selected].display;
  1603. if (p_replace) {
  1604. /* Find end of current section */
  1605. const String line = get_line(caret_line);
  1606. int caret_col = get_caret_column();
  1607. int caret_remove_line = caret_line;
  1608. bool merge_text = true;
  1609. int in_string = is_in_string(caret_line, caret_col);
  1610. if (in_string != -1) {
  1611. Point2 string_end = get_delimiter_end_position(caret_line, caret_col);
  1612. if (string_end.x != -1) {
  1613. merge_text = false;
  1614. caret_remove_line = string_end.y;
  1615. caret_col = string_end.x - 1;
  1616. }
  1617. }
  1618. if (merge_text) {
  1619. for (; caret_col < line.length(); caret_col++) {
  1620. if (!_is_char(line[caret_col])) {
  1621. break;
  1622. }
  1623. }
  1624. }
  1625. /* Replace. */
  1626. remove_text(caret_line, get_caret_column() - code_completion_base.length(), caret_remove_line, caret_col);
  1627. set_caret_column(get_caret_column() - code_completion_base.length(), false);
  1628. insert_text_at_caret(insert_text);
  1629. } else {
  1630. /* Get first non-matching char. */
  1631. const String line = get_line(caret_line);
  1632. int caret_col = get_caret_column();
  1633. int matching_chars = code_completion_base.length();
  1634. for (; matching_chars <= insert_text.length(); matching_chars++) {
  1635. if (caret_col >= line.length() || line[caret_col] != insert_text[matching_chars]) {
  1636. break;
  1637. }
  1638. caret_col++;
  1639. }
  1640. /* Remove base completion text. */
  1641. remove_text(caret_line, get_caret_column() - code_completion_base.length(), caret_line, get_caret_column());
  1642. set_caret_column(get_caret_column() - code_completion_base.length(), false);
  1643. /* Merge with text. */
  1644. insert_text_at_caret(insert_text.substr(0, code_completion_base.length()));
  1645. set_caret_column(caret_col, false);
  1646. insert_text_at_caret(insert_text.substr(matching_chars));
  1647. }
  1648. /* Handle merging of symbols eg strings, brackets. */
  1649. const String line = get_line(caret_line);
  1650. char32_t next_char = line[get_caret_column()];
  1651. char32_t last_completion_char = insert_text[insert_text.length() - 1];
  1652. char32_t last_completion_char_display = display_text[display_text.length() - 1];
  1653. int pre_brace_pair = get_caret_column() > 0 ? _get_auto_brace_pair_open_at_pos(caret_line, get_caret_column()) : -1;
  1654. int post_brace_pair = get_caret_column() < get_line(caret_line).length() ? _get_auto_brace_pair_close_at_pos(caret_line, get_caret_column()) : -1;
  1655. if (post_brace_pair != -1 && (last_completion_char == next_char || last_completion_char_display == next_char)) {
  1656. remove_text(caret_line, get_caret_column(), caret_line, get_caret_column() + 1);
  1657. }
  1658. if (pre_brace_pair != -1 && pre_brace_pair != post_brace_pair && (last_completion_char == next_char || last_completion_char_display == next_char)) {
  1659. remove_text(caret_line, get_caret_column(), caret_line, get_caret_column() + 1);
  1660. } else if (auto_brace_completion_enabled && pre_brace_pair != -1 && post_brace_pair == -1) {
  1661. insert_text_at_caret(auto_brace_completion_pairs[pre_brace_pair].close_key);
  1662. set_caret_column(get_caret_column() - auto_brace_completion_pairs[pre_brace_pair].close_key.length());
  1663. }
  1664. if (pre_brace_pair == -1 && post_brace_pair == -1 && get_caret_column() > 0 && get_caret_column() < get_line(caret_line).length()) {
  1665. pre_brace_pair = _get_auto_brace_pair_open_at_pos(caret_line, get_caret_column() + 1);
  1666. if (pre_brace_pair != -1 && pre_brace_pair == _get_auto_brace_pair_close_at_pos(caret_line, get_caret_column() - 1)) {
  1667. remove_text(caret_line, get_caret_column() - 2, caret_line, get_caret_column());
  1668. if (_get_auto_brace_pair_close_at_pos(caret_line, get_caret_column() - 1) != pre_brace_pair) {
  1669. set_caret_column(get_caret_column() - 1);
  1670. }
  1671. }
  1672. }
  1673. end_complex_operation();
  1674. cancel_code_completion();
  1675. if (code_completion_prefixes.has(last_completion_char)) {
  1676. request_code_completion();
  1677. }
  1678. }
  1679. void CodeEdit::cancel_code_completion() {
  1680. if (!code_completion_active) {
  1681. return;
  1682. }
  1683. code_completion_forced = false;
  1684. code_completion_active = false;
  1685. update();
  1686. }
  1687. /* Line length guidelines */
  1688. void CodeEdit::set_line_length_guidelines(TypedArray<int> p_guideline_columns) {
  1689. line_length_guideline_columns = p_guideline_columns;
  1690. update();
  1691. }
  1692. TypedArray<int> CodeEdit::get_line_length_guidelines() const {
  1693. return line_length_guideline_columns;
  1694. }
  1695. /* Symbol lookup */
  1696. void CodeEdit::set_symbol_lookup_on_click_enabled(bool p_enabled) {
  1697. symbol_lookup_on_click_enabled = p_enabled;
  1698. set_symbol_lookup_word_as_valid(false);
  1699. }
  1700. bool CodeEdit::is_symbol_lookup_on_click_enabled() const {
  1701. return symbol_lookup_on_click_enabled;
  1702. }
  1703. String CodeEdit::get_text_for_symbol_lookup() {
  1704. Point2i mp = get_local_mouse_pos();
  1705. Point2i pos = get_line_column_at_pos(mp, false);
  1706. int line = pos.y;
  1707. int col = pos.x;
  1708. if (line == -1) {
  1709. return String();
  1710. }
  1711. StringBuilder lookup_text;
  1712. const int text_size = get_line_count();
  1713. for (int i = 0; i < text_size; i++) {
  1714. String text = get_line(i);
  1715. if (i == line) {
  1716. lookup_text += text.substr(0, col);
  1717. /* Not unicode, represents the cursor. */
  1718. lookup_text += String::chr(0xFFFF);
  1719. lookup_text += text.substr(col, text.size());
  1720. } else {
  1721. lookup_text += text;
  1722. }
  1723. if (i != text_size - 1) {
  1724. lookup_text += "\n";
  1725. }
  1726. }
  1727. return lookup_text.as_string();
  1728. }
  1729. void CodeEdit::set_symbol_lookup_word_as_valid(bool p_valid) {
  1730. symbol_lookup_word = p_valid ? symbol_lookup_new_word : "";
  1731. symbol_lookup_new_word = "";
  1732. if (lookup_symbol_word != symbol_lookup_word) {
  1733. _set_symbol_lookup_word(symbol_lookup_word);
  1734. }
  1735. }
  1736. void CodeEdit::_bind_methods() {
  1737. /* Indent management */
  1738. ClassDB::bind_method(D_METHOD("set_indent_size", "size"), &CodeEdit::set_indent_size);
  1739. ClassDB::bind_method(D_METHOD("get_indent_size"), &CodeEdit::get_indent_size);
  1740. ClassDB::bind_method(D_METHOD("set_indent_using_spaces", "use_spaces"), &CodeEdit::set_indent_using_spaces);
  1741. ClassDB::bind_method(D_METHOD("is_indent_using_spaces"), &CodeEdit::is_indent_using_spaces);
  1742. ClassDB::bind_method(D_METHOD("set_auto_indent_enabled", "enable"), &CodeEdit::set_auto_indent_enabled);
  1743. ClassDB::bind_method(D_METHOD("is_auto_indent_enabled"), &CodeEdit::is_auto_indent_enabled);
  1744. ClassDB::bind_method(D_METHOD("set_auto_indent_prefixes", "prefixes"), &CodeEdit::set_auto_indent_prefixes);
  1745. ClassDB::bind_method(D_METHOD("get_auto_indent_prefixes"), &CodeEdit::get_auto_indent_prefixes);
  1746. ClassDB::bind_method(D_METHOD("do_indent"), &CodeEdit::do_indent);
  1747. ClassDB::bind_method(D_METHOD("do_unindent"), &CodeEdit::do_unindent);
  1748. ClassDB::bind_method(D_METHOD("indent_lines"), &CodeEdit::indent_lines);
  1749. ClassDB::bind_method(D_METHOD("unindent_lines"), &CodeEdit::unindent_lines);
  1750. /* Auto brace completion */
  1751. ClassDB::bind_method(D_METHOD("set_auto_brace_completion_enabled", "enable"), &CodeEdit::set_auto_brace_completion_enabled);
  1752. ClassDB::bind_method(D_METHOD("is_auto_brace_completion_enabled"), &CodeEdit::is_auto_brace_completion_enabled);
  1753. ClassDB::bind_method(D_METHOD("set_highlight_matching_braces_enabled", "enable"), &CodeEdit::set_highlight_matching_braces_enabled);
  1754. ClassDB::bind_method(D_METHOD("is_highlight_matching_braces_enabled"), &CodeEdit::is_highlight_matching_braces_enabled);
  1755. ClassDB::bind_method(D_METHOD("add_auto_brace_completion_pair", "start_key", "end_key"), &CodeEdit::add_auto_brace_completion_pair);
  1756. ClassDB::bind_method(D_METHOD("set_auto_brace_completion_pairs", "pairs"), &CodeEdit::set_auto_brace_completion_pairs);
  1757. ClassDB::bind_method(D_METHOD("get_auto_brace_completion_pairs"), &CodeEdit::get_auto_brace_completion_pairs);
  1758. ClassDB::bind_method(D_METHOD("has_auto_brace_completion_open_key", "open_key"), &CodeEdit::has_auto_brace_completion_open_key);
  1759. ClassDB::bind_method(D_METHOD("has_auto_brace_completion_close_key", "close_key"), &CodeEdit::has_auto_brace_completion_close_key);
  1760. ClassDB::bind_method(D_METHOD("get_auto_brace_completion_close_key", "open_key"), &CodeEdit::get_auto_brace_completion_close_key);
  1761. /* Main Gutter */
  1762. ClassDB::bind_method(D_METHOD("_main_gutter_draw_callback"), &CodeEdit::_main_gutter_draw_callback);
  1763. ClassDB::bind_method(D_METHOD("set_draw_breakpoints_gutter", "enable"), &CodeEdit::set_draw_breakpoints_gutter);
  1764. ClassDB::bind_method(D_METHOD("is_drawing_breakpoints_gutter"), &CodeEdit::is_drawing_breakpoints_gutter);
  1765. ClassDB::bind_method(D_METHOD("set_draw_bookmarks_gutter", "enable"), &CodeEdit::set_draw_bookmarks_gutter);
  1766. ClassDB::bind_method(D_METHOD("is_drawing_bookmarks_gutter"), &CodeEdit::is_drawing_bookmarks_gutter);
  1767. ClassDB::bind_method(D_METHOD("set_draw_executing_lines_gutter", "enable"), &CodeEdit::set_draw_executing_lines_gutter);
  1768. ClassDB::bind_method(D_METHOD("is_drawing_executing_lines_gutter"), &CodeEdit::is_drawing_executing_lines_gutter);
  1769. // Breakpoints
  1770. ClassDB::bind_method(D_METHOD("set_line_as_breakpoint", "line", "breakpointed"), &CodeEdit::set_line_as_breakpoint);
  1771. ClassDB::bind_method(D_METHOD("is_line_breakpointed", "line"), &CodeEdit::is_line_breakpointed);
  1772. ClassDB::bind_method(D_METHOD("clear_breakpointed_lines"), &CodeEdit::clear_breakpointed_lines);
  1773. ClassDB::bind_method(D_METHOD("get_breakpointed_lines"), &CodeEdit::get_breakpointed_lines);
  1774. // Bookmarks
  1775. ClassDB::bind_method(D_METHOD("set_line_as_bookmarked", "line", "bookmarked"), &CodeEdit::set_line_as_bookmarked);
  1776. ClassDB::bind_method(D_METHOD("is_line_bookmarked", "line"), &CodeEdit::is_line_bookmarked);
  1777. ClassDB::bind_method(D_METHOD("clear_bookmarked_lines"), &CodeEdit::clear_bookmarked_lines);
  1778. ClassDB::bind_method(D_METHOD("get_bookmarked_lines"), &CodeEdit::get_bookmarked_lines);
  1779. // executing lines
  1780. ClassDB::bind_method(D_METHOD("set_line_as_executing", "line", "executing"), &CodeEdit::set_line_as_executing);
  1781. ClassDB::bind_method(D_METHOD("is_line_executing", "line"), &CodeEdit::is_line_executing);
  1782. ClassDB::bind_method(D_METHOD("clear_executing_lines"), &CodeEdit::clear_executing_lines);
  1783. ClassDB::bind_method(D_METHOD("get_executing_lines"), &CodeEdit::get_executing_lines);
  1784. /* Line numbers */
  1785. ClassDB::bind_method(D_METHOD("_line_number_draw_callback"), &CodeEdit::_line_number_draw_callback);
  1786. ClassDB::bind_method(D_METHOD("set_draw_line_numbers", "enable"), &CodeEdit::set_draw_line_numbers);
  1787. ClassDB::bind_method(D_METHOD("is_draw_line_numbers_enabled"), &CodeEdit::is_draw_line_numbers_enabled);
  1788. ClassDB::bind_method(D_METHOD("set_line_numbers_zero_padded", "enable"), &CodeEdit::set_line_numbers_zero_padded);
  1789. ClassDB::bind_method(D_METHOD("is_line_numbers_zero_padded"), &CodeEdit::is_line_numbers_zero_padded);
  1790. /* Fold Gutter */
  1791. ClassDB::bind_method(D_METHOD("_fold_gutter_draw_callback"), &CodeEdit::_fold_gutter_draw_callback);
  1792. ClassDB::bind_method(D_METHOD("set_draw_fold_gutter", "enable"), &CodeEdit::set_draw_fold_gutter);
  1793. ClassDB::bind_method(D_METHOD("is_drawing_fold_gutter"), &CodeEdit::is_drawing_fold_gutter);
  1794. /* Line folding */
  1795. ClassDB::bind_method(D_METHOD("set_line_folding_enabled", "enabled"), &CodeEdit::set_line_folding_enabled);
  1796. ClassDB::bind_method(D_METHOD("is_line_folding_enabled"), &CodeEdit::is_line_folding_enabled);
  1797. ClassDB::bind_method(D_METHOD("can_fold_line", "line"), &CodeEdit::can_fold_line);
  1798. ClassDB::bind_method(D_METHOD("fold_line", "line"), &CodeEdit::fold_line);
  1799. ClassDB::bind_method(D_METHOD("unfold_line", "line"), &CodeEdit::unfold_line);
  1800. ClassDB::bind_method(D_METHOD("fold_all_lines"), &CodeEdit::fold_all_lines);
  1801. ClassDB::bind_method(D_METHOD("unfold_all_lines"), &CodeEdit::unfold_all_lines);
  1802. ClassDB::bind_method(D_METHOD("toggle_foldable_line", "line"), &CodeEdit::toggle_foldable_line);
  1803. ClassDB::bind_method(D_METHOD("is_line_folded", "line"), &CodeEdit::is_line_folded);
  1804. ClassDB::bind_method(D_METHOD("get_folded_lines"), &CodeEdit::get_folded_lines);
  1805. /* Delimiters */
  1806. // Strings
  1807. ClassDB::bind_method(D_METHOD("add_string_delimiter", "start_key", "end_key", "line_only"), &CodeEdit::add_string_delimiter, DEFVAL(false));
  1808. ClassDB::bind_method(D_METHOD("remove_string_delimiter", "start_key"), &CodeEdit::remove_string_delimiter);
  1809. ClassDB::bind_method(D_METHOD("has_string_delimiter", "start_key"), &CodeEdit::has_string_delimiter);
  1810. ClassDB::bind_method(D_METHOD("set_string_delimiters", "string_delimiters"), &CodeEdit::set_string_delimiters);
  1811. ClassDB::bind_method(D_METHOD("clear_string_delimiters"), &CodeEdit::clear_string_delimiters);
  1812. ClassDB::bind_method(D_METHOD("get_string_delimiters"), &CodeEdit::get_string_delimiters);
  1813. ClassDB::bind_method(D_METHOD("is_in_string", "line", "column"), &CodeEdit::is_in_string, DEFVAL(-1));
  1814. // Comments
  1815. ClassDB::bind_method(D_METHOD("add_comment_delimiter", "start_key", "end_key", "line_only"), &CodeEdit::add_comment_delimiter, DEFVAL(false));
  1816. ClassDB::bind_method(D_METHOD("remove_comment_delimiter", "start_key"), &CodeEdit::remove_comment_delimiter);
  1817. ClassDB::bind_method(D_METHOD("has_comment_delimiter", "start_key"), &CodeEdit::has_comment_delimiter);
  1818. ClassDB::bind_method(D_METHOD("set_comment_delimiters", "comment_delimiters"), &CodeEdit::set_comment_delimiters);
  1819. ClassDB::bind_method(D_METHOD("clear_comment_delimiters"), &CodeEdit::clear_comment_delimiters);
  1820. ClassDB::bind_method(D_METHOD("get_comment_delimiters"), &CodeEdit::get_comment_delimiters);
  1821. ClassDB::bind_method(D_METHOD("is_in_comment", "line", "column"), &CodeEdit::is_in_comment, DEFVAL(-1));
  1822. // Util
  1823. ClassDB::bind_method(D_METHOD("get_delimiter_start_key", "delimiter_index"), &CodeEdit::get_delimiter_start_key);
  1824. ClassDB::bind_method(D_METHOD("get_delimiter_end_key", "delimiter_index"), &CodeEdit::get_delimiter_end_key);
  1825. ClassDB::bind_method(D_METHOD("get_delimiter_start_position", "line", "column"), &CodeEdit::get_delimiter_start_position);
  1826. ClassDB::bind_method(D_METHOD("get_delimiter_end_position", "line", "column"), &CodeEdit::get_delimiter_end_position);
  1827. /* Code hint */
  1828. ClassDB::bind_method(D_METHOD("set_code_hint", "code_hint"), &CodeEdit::set_code_hint);
  1829. ClassDB::bind_method(D_METHOD("set_code_hint_draw_below", "draw_below"), &CodeEdit::set_code_hint_draw_below);
  1830. /* Code Completion */
  1831. BIND_ENUM_CONSTANT(KIND_CLASS);
  1832. BIND_ENUM_CONSTANT(KIND_FUNCTION);
  1833. BIND_ENUM_CONSTANT(KIND_SIGNAL);
  1834. BIND_ENUM_CONSTANT(KIND_VARIABLE);
  1835. BIND_ENUM_CONSTANT(KIND_MEMBER);
  1836. BIND_ENUM_CONSTANT(KIND_ENUM);
  1837. BIND_ENUM_CONSTANT(KIND_CONSTANT);
  1838. BIND_ENUM_CONSTANT(KIND_NODE_PATH);
  1839. BIND_ENUM_CONSTANT(KIND_FILE_PATH);
  1840. BIND_ENUM_CONSTANT(KIND_PLAIN_TEXT);
  1841. ClassDB::bind_method(D_METHOD("get_text_for_code_completion"), &CodeEdit::get_text_for_code_completion);
  1842. ClassDB::bind_method(D_METHOD("request_code_completion", "force"), &CodeEdit::request_code_completion, DEFVAL(false));
  1843. ClassDB::bind_method(D_METHOD("add_code_completion_option", "type", "display_text", "insert_text", "text_color", "icon", "value"), &CodeEdit::add_code_completion_option, DEFVAL(Color(1, 1, 1)), DEFVAL(RES()), DEFVAL(Variant::NIL));
  1844. ClassDB::bind_method(D_METHOD("update_code_completion_options", "force"), &CodeEdit::update_code_completion_options);
  1845. ClassDB::bind_method(D_METHOD("get_code_completion_options"), &CodeEdit::get_code_completion_options);
  1846. ClassDB::bind_method(D_METHOD("get_code_completion_option", "index"), &CodeEdit::get_code_completion_option);
  1847. ClassDB::bind_method(D_METHOD("get_code_completion_selected_index"), &CodeEdit::get_code_completion_selected_index);
  1848. ClassDB::bind_method(D_METHOD("set_code_completion_selected_index", "index"), &CodeEdit::set_code_completion_selected_index);
  1849. ClassDB::bind_method(D_METHOD("confirm_code_completion", "replace"), &CodeEdit::confirm_code_completion, DEFVAL(false));
  1850. ClassDB::bind_method(D_METHOD("cancel_code_completion"), &CodeEdit::cancel_code_completion);
  1851. ClassDB::bind_method(D_METHOD("set_code_completion_enabled", "enable"), &CodeEdit::set_code_completion_enabled);
  1852. ClassDB::bind_method(D_METHOD("is_code_completion_enabled"), &CodeEdit::is_code_completion_enabled);
  1853. ClassDB::bind_method(D_METHOD("set_code_completion_prefixes", "prefixes"), &CodeEdit::set_code_completion_prefixes);
  1854. ClassDB::bind_method(D_METHOD("get_code_comletion_prefixes"), &CodeEdit::get_code_completion_prefixes);
  1855. // Overridable
  1856. GDVIRTUAL_BIND(_confirm_code_completion, "replace")
  1857. GDVIRTUAL_BIND(_request_code_completion, "force")
  1858. GDVIRTUAL_BIND(_filter_code_completion_candidates, "candidates")
  1859. /* Line length guidelines */
  1860. ClassDB::bind_method(D_METHOD("set_line_length_guidelines", "guideline_columns"), &CodeEdit::set_line_length_guidelines);
  1861. ClassDB::bind_method(D_METHOD("get_line_length_guidelines"), &CodeEdit::get_line_length_guidelines);
  1862. /* Symbol lookup */
  1863. ClassDB::bind_method(D_METHOD("set_symbol_lookup_on_click_enabled", "enable"), &CodeEdit::set_symbol_lookup_on_click_enabled);
  1864. ClassDB::bind_method(D_METHOD("is_symbol_lookup_on_click_enabled"), &CodeEdit::is_symbol_lookup_on_click_enabled);
  1865. ClassDB::bind_method(D_METHOD("get_text_for_symbol_lookup"), &CodeEdit::get_text_for_symbol_lookup);
  1866. ClassDB::bind_method(D_METHOD("set_symbol_lookup_word_as_valid", "valid"), &CodeEdit::set_symbol_lookup_word_as_valid);
  1867. /* Inspector */
  1868. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "symbol_lookup_on_click"), "set_symbol_lookup_on_click_enabled", "is_symbol_lookup_on_click_enabled");
  1869. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "line_folding"), "set_line_folding_enabled", "is_line_folding_enabled");
  1870. ADD_PROPERTY(PropertyInfo(Variant::PACKED_INT32_ARRAY, "line_length_guidelines"), "set_line_length_guidelines", "get_line_length_guidelines");
  1871. ADD_GROUP("Gutters", "gutters_");
  1872. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_breakpoints_gutter"), "set_draw_breakpoints_gutter", "is_drawing_breakpoints_gutter");
  1873. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_bookmarks"), "set_draw_bookmarks_gutter", "is_drawing_bookmarks_gutter");
  1874. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_executing_lines"), "set_draw_executing_lines_gutter", "is_drawing_executing_lines_gutter");
  1875. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_line_numbers"), "set_draw_line_numbers", "is_draw_line_numbers_enabled");
  1876. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_zero_pad_line_numbers"), "set_line_numbers_zero_padded", "is_line_numbers_zero_padded");
  1877. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "gutters_draw_fold_gutter"), "set_draw_fold_gutter", "is_drawing_fold_gutter");
  1878. ADD_GROUP("Delimiters", "delimiter_");
  1879. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "delimiter_strings"), "set_string_delimiters", "get_string_delimiters");
  1880. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "delimiter_comments"), "set_comment_delimiters", "get_comment_delimiters");
  1881. ADD_GROUP("Code Completion", "code_completion_");
  1882. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "code_completion_enabled"), "set_code_completion_enabled", "is_code_completion_enabled");
  1883. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "code_completion_prefixes"), "set_code_completion_prefixes", "get_code_comletion_prefixes");
  1884. ADD_GROUP("Indentation", "indent_");
  1885. ADD_PROPERTY(PropertyInfo(Variant::INT, "indent_size"), "set_indent_size", "get_indent_size");
  1886. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "indent_use_spaces"), "set_indent_using_spaces", "is_indent_using_spaces");
  1887. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "indent_automatic"), "set_auto_indent_enabled", "is_auto_indent_enabled");
  1888. ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "indent_automatic_prefixes"), "set_auto_indent_prefixes", "get_auto_indent_prefixes");
  1889. ADD_GROUP("Auto brace completion", "auto_brace_completion_");
  1890. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "auto_brace_completion_enabled"), "set_auto_brace_completion_enabled", "is_auto_brace_completion_enabled");
  1891. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "auto_brace_completion_highlight_matching"), "set_highlight_matching_braces_enabled", "is_highlight_matching_braces_enabled");
  1892. ADD_PROPERTY(PropertyInfo(Variant::DICTIONARY, "auto_brace_completion_pairs"), "set_auto_brace_completion_pairs", "get_auto_brace_completion_pairs");
  1893. /* Signals */
  1894. /* Gutters */
  1895. ADD_SIGNAL(MethodInfo("breakpoint_toggled", PropertyInfo(Variant::INT, "line")));
  1896. /* Code Completion */
  1897. ADD_SIGNAL(MethodInfo("request_code_completion"));
  1898. /* Symbol lookup */
  1899. ADD_SIGNAL(MethodInfo("symbol_lookup", PropertyInfo(Variant::STRING, "symbol"), PropertyInfo(Variant::INT, "line"), PropertyInfo(Variant::INT, "column")));
  1900. ADD_SIGNAL(MethodInfo("symbol_validate", PropertyInfo(Variant::STRING, "symbol")));
  1901. }
  1902. /* Auto brace completion */
  1903. int CodeEdit::_get_auto_brace_pair_open_at_pos(int p_line, int p_col) {
  1904. const String &line = get_line(p_line);
  1905. /* Should be fast enough, expecting low amount of pairs... */
  1906. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1907. const String &open_key = auto_brace_completion_pairs[i].open_key;
  1908. if (p_col - open_key.length() < 0) {
  1909. continue;
  1910. }
  1911. bool is_match = true;
  1912. for (int j = 0; j < open_key.length(); j++) {
  1913. if (line[(p_col - 1) - j] != open_key[(open_key.length() - 1) - j]) {
  1914. is_match = false;
  1915. break;
  1916. }
  1917. }
  1918. if (is_match) {
  1919. return i;
  1920. }
  1921. }
  1922. return -1;
  1923. }
  1924. int CodeEdit::_get_auto_brace_pair_close_at_pos(int p_line, int p_col) {
  1925. const String &line = get_line(p_line);
  1926. /* Should be fast enough, expecting low amount of pairs... */
  1927. for (int i = 0; i < auto_brace_completion_pairs.size(); i++) {
  1928. if (p_col + auto_brace_completion_pairs[i].close_key.length() > line.length()) {
  1929. continue;
  1930. }
  1931. bool is_match = true;
  1932. for (int j = 0; j < auto_brace_completion_pairs[i].close_key.length(); j++) {
  1933. if (line[p_col + j] != auto_brace_completion_pairs[i].close_key[j]) {
  1934. is_match = false;
  1935. break;
  1936. }
  1937. }
  1938. if (is_match) {
  1939. return i;
  1940. }
  1941. }
  1942. return -1;
  1943. }
  1944. /* Gutters */
  1945. void CodeEdit::_gutter_clicked(int p_line, int p_gutter) {
  1946. if (p_gutter == main_gutter) {
  1947. if (draw_breakpoints) {
  1948. set_line_as_breakpoint(p_line, !is_line_breakpointed(p_line));
  1949. }
  1950. return;
  1951. }
  1952. if (p_gutter == line_number_gutter) {
  1953. set_selection_mode(TextEdit::SelectionMode::SELECTION_MODE_LINE, p_line, 0);
  1954. select(p_line, 0, p_line + 1, 0);
  1955. set_caret_line(p_line + 1);
  1956. set_caret_column(0);
  1957. return;
  1958. }
  1959. if (p_gutter == fold_gutter) {
  1960. if (is_line_folded(p_line)) {
  1961. unfold_line(p_line);
  1962. } else if (can_fold_line(p_line)) {
  1963. fold_line(p_line);
  1964. }
  1965. return;
  1966. }
  1967. }
  1968. void CodeEdit::_update_gutter_indexes() {
  1969. for (int i = 0; i < get_gutter_count(); i++) {
  1970. if (get_gutter_name(i) == "main_gutter") {
  1971. main_gutter = i;
  1972. continue;
  1973. }
  1974. if (get_gutter_name(i) == "line_numbers") {
  1975. line_number_gutter = i;
  1976. continue;
  1977. }
  1978. if (get_gutter_name(i) == "fold_gutter") {
  1979. fold_gutter = i;
  1980. continue;
  1981. }
  1982. }
  1983. }
  1984. /* Delimiters */
  1985. void CodeEdit::_update_delimiter_cache(int p_from_line, int p_to_line) {
  1986. if (delimiters.size() == 0) {
  1987. return;
  1988. }
  1989. int line_count = get_line_count();
  1990. if (p_to_line == -1) {
  1991. p_to_line = line_count;
  1992. }
  1993. int start_line = MIN(p_from_line, p_to_line);
  1994. int end_line = MAX(p_from_line, p_to_line);
  1995. /* Make sure delimiter_cache has all the lines. */
  1996. if (start_line != end_line) {
  1997. if (p_to_line < p_from_line) {
  1998. for (int i = end_line; i > start_line; i--) {
  1999. delimiter_cache.remove(i);
  2000. }
  2001. } else {
  2002. for (int i = start_line; i < end_line; i++) {
  2003. delimiter_cache.insert(i, Map<int, int>());
  2004. }
  2005. }
  2006. }
  2007. int in_region = -1;
  2008. for (int i = start_line; i < MIN(end_line + 1, line_count); i++) {
  2009. int current_end_region = (i <= 0 || delimiter_cache[i].size() < 1) ? -1 : delimiter_cache[i].back()->value();
  2010. in_region = (i <= 0 || delimiter_cache[i - 1].size() < 1) ? -1 : delimiter_cache[i - 1].back()->value();
  2011. const String &str = get_line(i);
  2012. const int line_length = str.length();
  2013. delimiter_cache.write[i].clear();
  2014. if (str.length() == 0) {
  2015. if (in_region != -1) {
  2016. delimiter_cache.write[i][0] = in_region;
  2017. }
  2018. if (i == end_line && current_end_region != in_region) {
  2019. end_line++;
  2020. end_line = MIN(end_line, line_count);
  2021. }
  2022. continue;
  2023. }
  2024. int end_region = -1;
  2025. for (int j = 0; j < line_length; j++) {
  2026. int from = j;
  2027. for (; from < line_length; from++) {
  2028. if (str[from] == '\\') {
  2029. from++;
  2030. continue;
  2031. }
  2032. break;
  2033. }
  2034. /* check if we are in entering a region */
  2035. bool same_line = false;
  2036. if (in_region == -1) {
  2037. for (int d = 0; d < delimiters.size(); d++) {
  2038. /* check there is enough room */
  2039. int chars_left = line_length - from;
  2040. int start_key_length = delimiters[d].start_key.length();
  2041. int end_key_length = delimiters[d].end_key.length();
  2042. if (chars_left < start_key_length) {
  2043. continue;
  2044. }
  2045. /* search the line */
  2046. bool match = true;
  2047. const char32_t *start_key = delimiters[d].start_key.get_data();
  2048. for (int k = 0; k < start_key_length; k++) {
  2049. if (start_key[k] != str[from + k]) {
  2050. match = false;
  2051. break;
  2052. }
  2053. }
  2054. if (!match) {
  2055. continue;
  2056. }
  2057. same_line = true;
  2058. in_region = d;
  2059. delimiter_cache.write[i][from + 1] = d;
  2060. from += start_key_length;
  2061. /* check if it's the whole line */
  2062. if (end_key_length == 0 || delimiters[d].line_only || from + end_key_length > line_length) {
  2063. j = line_length;
  2064. if (delimiters[d].line_only) {
  2065. delimiter_cache.write[i][line_length + 1] = -1;
  2066. } else {
  2067. end_region = in_region;
  2068. }
  2069. }
  2070. break;
  2071. }
  2072. if (j == line_length || in_region == -1) {
  2073. continue;
  2074. }
  2075. }
  2076. /* if we are in one find the end key */
  2077. /* search the line */
  2078. int region_end_index = -1;
  2079. int end_key_length = delimiters[in_region].end_key.length();
  2080. const char32_t *end_key = delimiters[in_region].end_key.get_data();
  2081. for (; from < line_length; from++) {
  2082. if (line_length - from < end_key_length) {
  2083. break;
  2084. }
  2085. if (!is_symbol(str[from])) {
  2086. continue;
  2087. }
  2088. if (str[from] == '\\') {
  2089. from++;
  2090. continue;
  2091. }
  2092. region_end_index = from;
  2093. for (int k = 0; k < end_key_length; k++) {
  2094. if (end_key[k] != str[from + k]) {
  2095. region_end_index = -1;
  2096. break;
  2097. }
  2098. }
  2099. if (region_end_index != -1) {
  2100. break;
  2101. }
  2102. }
  2103. j = from + (end_key_length - 1);
  2104. end_region = (region_end_index == -1) ? in_region : -1;
  2105. if (!same_line || region_end_index != -1) {
  2106. delimiter_cache.write[i][j + 1] = end_region;
  2107. }
  2108. in_region = -1;
  2109. }
  2110. if (i == end_line && current_end_region != end_region) {
  2111. end_line++;
  2112. end_line = MIN(end_line, line_count);
  2113. }
  2114. }
  2115. }
  2116. int CodeEdit::_is_in_delimiter(int p_line, int p_column, DelimiterType p_type) const {
  2117. if (delimiters.size() == 0) {
  2118. return -1;
  2119. }
  2120. ERR_FAIL_INDEX_V(p_line, get_line_count(), 0);
  2121. int region = (p_line <= 0 || delimiter_cache[p_line - 1].size() < 1) ? -1 : delimiter_cache[p_line - 1].back()->value();
  2122. bool in_region = region != -1 && delimiters[region].type == p_type;
  2123. for (Map<int, int>::Element *E = delimiter_cache[p_line].front(); E; E = E->next()) {
  2124. /* If column is specified, loop until the key is larger then the column. */
  2125. if (p_column != -1) {
  2126. if (E->key() > p_column) {
  2127. break;
  2128. }
  2129. in_region = E->value() != -1 && delimiters[E->value()].type == p_type;
  2130. region = in_region ? E->value() : -1;
  2131. continue;
  2132. }
  2133. /* If no column, calculate if the entire line is a region */
  2134. /* excluding whitespace. */
  2135. const String line = get_line(p_line);
  2136. if (!in_region) {
  2137. if (E->value() == -1 || delimiters[E->value()].type != p_type) {
  2138. break;
  2139. }
  2140. region = E->value();
  2141. in_region = true;
  2142. for (int i = E->key() - 2; i >= 0; i--) {
  2143. if (!_is_whitespace(line[i])) {
  2144. return -1;
  2145. }
  2146. }
  2147. }
  2148. if (delimiters[region].line_only) {
  2149. return region;
  2150. }
  2151. int end_col = E->key();
  2152. if (E->value() != -1) {
  2153. if (!E->next()) {
  2154. return region;
  2155. }
  2156. end_col = E->next()->key();
  2157. }
  2158. for (int i = end_col; i < line.length(); i++) {
  2159. if (!_is_whitespace(line[i])) {
  2160. return -1;
  2161. }
  2162. }
  2163. return region;
  2164. }
  2165. return in_region ? region : -1;
  2166. }
  2167. void CodeEdit::_add_delimiter(const String &p_start_key, const String &p_end_key, bool p_line_only, DelimiterType p_type) {
  2168. // If we are the editor allow "null" as a valid start key, otherwise users cannot add delimiters via the inspector.
  2169. if (!(Engine::get_singleton()->is_editor_hint() && p_start_key == "null")) {
  2170. ERR_FAIL_COND_MSG(p_start_key.is_empty(), "delimiter start key cannot be empty");
  2171. for (int i = 0; i < p_start_key.length(); i++) {
  2172. ERR_FAIL_COND_MSG(!is_symbol(p_start_key[i]), "delimiter must start with a symbol");
  2173. }
  2174. }
  2175. if (p_end_key.length() > 0) {
  2176. for (int i = 0; i < p_end_key.length(); i++) {
  2177. ERR_FAIL_COND_MSG(!is_symbol(p_end_key[i]), "delimiter must end with a symbol");
  2178. }
  2179. }
  2180. int at = 0;
  2181. for (int i = 0; i < delimiters.size(); i++) {
  2182. ERR_FAIL_COND_MSG(delimiters[i].start_key == p_start_key, "delimiter with start key '" + p_start_key + "' already exists.");
  2183. if (p_start_key.length() < delimiters[i].start_key.length()) {
  2184. at++;
  2185. }
  2186. }
  2187. Delimiter delimiter;
  2188. delimiter.type = p_type;
  2189. delimiter.start_key = p_start_key;
  2190. delimiter.end_key = p_end_key;
  2191. delimiter.line_only = p_line_only || p_end_key == "";
  2192. delimiters.insert(at, delimiter);
  2193. if (!setting_delimiters) {
  2194. delimiter_cache.clear();
  2195. _update_delimiter_cache();
  2196. }
  2197. }
  2198. void CodeEdit::_remove_delimiter(const String &p_start_key, DelimiterType p_type) {
  2199. for (int i = 0; i < delimiters.size(); i++) {
  2200. if (delimiters[i].start_key != p_start_key) {
  2201. continue;
  2202. }
  2203. if (delimiters[i].type != p_type) {
  2204. break;
  2205. }
  2206. delimiters.remove(i);
  2207. if (!setting_delimiters) {
  2208. delimiter_cache.clear();
  2209. _update_delimiter_cache();
  2210. }
  2211. break;
  2212. }
  2213. }
  2214. bool CodeEdit::_has_delimiter(const String &p_start_key, DelimiterType p_type) const {
  2215. for (int i = 0; i < delimiters.size(); i++) {
  2216. if (delimiters[i].start_key == p_start_key) {
  2217. return delimiters[i].type == p_type;
  2218. }
  2219. }
  2220. return false;
  2221. }
  2222. void CodeEdit::_set_delimiters(const TypedArray<String> &p_delimiters, DelimiterType p_type) {
  2223. setting_delimiters = true;
  2224. _clear_delimiters(p_type);
  2225. for (int i = 0; i < p_delimiters.size(); i++) {
  2226. String key = p_delimiters[i];
  2227. if (key.is_empty()) {
  2228. continue;
  2229. }
  2230. const String start_key = key.get_slice(" ", 0);
  2231. const String end_key = key.get_slice_count(" ") > 1 ? key.get_slice(" ", 1) : String();
  2232. _add_delimiter(start_key, end_key, end_key == "", p_type);
  2233. }
  2234. setting_delimiters = false;
  2235. _update_delimiter_cache();
  2236. }
  2237. void CodeEdit::_clear_delimiters(DelimiterType p_type) {
  2238. for (int i = delimiters.size() - 1; i >= 0; i--) {
  2239. if (delimiters[i].type == p_type) {
  2240. delimiters.remove(i);
  2241. }
  2242. }
  2243. delimiter_cache.clear();
  2244. if (!setting_delimiters) {
  2245. _update_delimiter_cache();
  2246. }
  2247. }
  2248. TypedArray<String> CodeEdit::_get_delimiters(DelimiterType p_type) const {
  2249. TypedArray<String> r_delimiters;
  2250. for (int i = 0; i < delimiters.size(); i++) {
  2251. if (delimiters[i].type != p_type) {
  2252. continue;
  2253. }
  2254. r_delimiters.push_back(delimiters[i].start_key + (delimiters[i].end_key.is_empty() ? "" : " " + delimiters[i].end_key));
  2255. }
  2256. return r_delimiters;
  2257. }
  2258. /* Code Completion */
  2259. void CodeEdit::_filter_code_completion_candidates_impl() {
  2260. int line_height = get_line_height();
  2261. if (GDVIRTUAL_IS_OVERRIDDEN(_filter_code_completion_candidates)) {
  2262. code_completion_options.clear();
  2263. code_completion_base = "";
  2264. /* Build options argument. */
  2265. TypedArray<Dictionary> completion_options_sources;
  2266. completion_options_sources.resize(code_completion_option_sources.size());
  2267. int i = 0;
  2268. for (const ScriptCodeCompletionOption &E : code_completion_option_sources) {
  2269. Dictionary option;
  2270. option["kind"] = E.kind;
  2271. option["display_text"] = E.display;
  2272. option["insert_text"] = E.insert_text;
  2273. option["font_color"] = E.font_color;
  2274. option["icon"] = E.icon;
  2275. option["default_value"] = E.default_value;
  2276. completion_options_sources[i] = option;
  2277. i++;
  2278. }
  2279. Array completion_options;
  2280. GDVIRTUAL_CALL(_filter_code_completion_candidates, completion_options_sources, completion_options);
  2281. /* No options to complete, cancel. */
  2282. if (completion_options.size() == 0) {
  2283. cancel_code_completion();
  2284. return;
  2285. }
  2286. /* Convert back into options. */
  2287. int max_width = 0;
  2288. for (i = 0; i < completion_options.size(); i++) {
  2289. ScriptCodeCompletionOption option;
  2290. option.kind = (ScriptCodeCompletionOption::Kind)(int)completion_options[i].get("kind");
  2291. option.display = completion_options[i].get("display_text");
  2292. option.insert_text = completion_options[i].get("insert_text");
  2293. option.font_color = completion_options[i].get("font_color");
  2294. option.icon = completion_options[i].get("icon");
  2295. option.default_value = completion_options[i].get("default_value");
  2296. int offset = 0;
  2297. if (option.default_value.get_type() == Variant::COLOR) {
  2298. offset = line_height;
  2299. }
  2300. max_width = MAX(max_width, font->get_string_size(option.display, font_size).width + offset);
  2301. code_completion_options.push_back(option);
  2302. }
  2303. code_completion_longest_line = MIN(max_width, code_completion_max_width * font_size);
  2304. code_completion_current_selected = 0;
  2305. code_completion_active = true;
  2306. update();
  2307. return;
  2308. }
  2309. const int caret_line = get_caret_line();
  2310. const int caret_column = get_caret_column();
  2311. const String line = get_line(caret_line);
  2312. if (caret_column > 0 && line[caret_column - 1] == '(' && !code_completion_forced) {
  2313. cancel_code_completion();
  2314. return;
  2315. }
  2316. /* Get string status, are we in one or at the close. */
  2317. int in_string = is_in_string(caret_line, caret_column);
  2318. int first_quote_col = -1;
  2319. if (in_string != -1) {
  2320. Point2 string_start_pos = get_delimiter_start_position(caret_line, caret_column);
  2321. first_quote_col = (string_start_pos.y == caret_line) ? string_start_pos.x : -1;
  2322. } else if (caret_column > 0) {
  2323. if (is_in_string(caret_line, caret_column - 1) != -1) {
  2324. first_quote_col = caret_column - 1;
  2325. }
  2326. }
  2327. int cofs = caret_column;
  2328. String string_to_complete;
  2329. bool prev_is_word = false;
  2330. /* Cancel if we are at the close of a string. */
  2331. if (caret_column > 0 && in_string == -1 && first_quote_col == cofs - 1) {
  2332. cancel_code_completion();
  2333. return;
  2334. /* In a string, therefore we are trying to complete the string text. */
  2335. } else if (in_string != -1 && first_quote_col != -1) {
  2336. int key_length = delimiters[in_string].start_key.length();
  2337. string_to_complete = line.substr(first_quote_col - key_length, (cofs - first_quote_col) + key_length);
  2338. /* If we have a space, previous word might be a keyword. eg "func |". */
  2339. } else if (cofs > 0 && line[cofs - 1] == ' ') {
  2340. int ofs = cofs - 1;
  2341. while (ofs > 0 && line[ofs] == ' ') {
  2342. ofs--;
  2343. }
  2344. prev_is_word = _is_char(line[ofs]);
  2345. /* Otherwise get current word and set cofs to the start. */
  2346. } else {
  2347. int start_cofs = cofs;
  2348. while (cofs > 0 && line[cofs - 1] > 32 && (line[cofs - 1] == '/' || _is_char(line[cofs - 1]))) {
  2349. cofs--;
  2350. }
  2351. string_to_complete = line.substr(cofs, start_cofs - cofs);
  2352. }
  2353. /* If all else fails, check for a prefix. */
  2354. /* Single space between caret and prefix is okay. */
  2355. bool prev_is_prefix = false;
  2356. if (cofs > 0 && code_completion_prefixes.has(line[cofs - 1])) {
  2357. prev_is_prefix = true;
  2358. } else if (cofs > 1 && line[cofs - 1] == ' ' && code_completion_prefixes.has(line[cofs - 2])) {
  2359. prev_is_prefix = true;
  2360. }
  2361. if (!prev_is_word && string_to_complete.is_empty() && (cofs == 0 || !prev_is_prefix)) {
  2362. cancel_code_completion();
  2363. return;
  2364. }
  2365. /* Filter Options. */
  2366. /* For now handle only tradional quoted strings. */
  2367. bool single_quote = in_string != -1 && first_quote_col > 0 && delimiters[in_string].start_key == "'";
  2368. code_completion_options.clear();
  2369. code_completion_base = string_to_complete;
  2370. Vector<ScriptCodeCompletionOption> completion_options_casei;
  2371. Vector<ScriptCodeCompletionOption> completion_options_subseq;
  2372. Vector<ScriptCodeCompletionOption> completion_options_subseq_casei;
  2373. int max_width = 0;
  2374. String string_to_complete_lower = string_to_complete.to_lower();
  2375. for (ScriptCodeCompletionOption &option : code_completion_option_sources) {
  2376. if (single_quote && option.display.is_quoted()) {
  2377. option.display = option.display.unquote().quote("'");
  2378. }
  2379. int offset = 0;
  2380. if (option.default_value.get_type() == Variant::COLOR) {
  2381. offset = line_height;
  2382. }
  2383. if (in_string != -1) {
  2384. String quote = single_quote ? "'" : "\"";
  2385. option.display = option.display.unquote().quote(quote);
  2386. option.insert_text = option.insert_text.unquote().quote(quote);
  2387. }
  2388. if (option.display.length() == 0) {
  2389. continue;
  2390. }
  2391. if (string_to_complete.length() == 0) {
  2392. code_completion_options.push_back(option);
  2393. max_width = MAX(max_width, font->get_string_size(option.display, font_size).width + offset);
  2394. continue;
  2395. }
  2396. /* This code works the same as:
  2397. if (option.display.begins_with(s)) {
  2398. completion_options.push_back(option);
  2399. } else if (option.display.to_lower().begins_with(s.to_lower())) {
  2400. completion_options_casei.push_back(option);
  2401. } else if (s.is_subsequence_of(option.display)) {
  2402. completion_options_subseq.push_back(option);
  2403. } else if (s.is_subsequence_ofi(option.display)) {
  2404. completion_options_subseq_casei.push_back(option);
  2405. }
  2406. But is more performant due to being inlined and looping over the characters only once
  2407. */
  2408. String display_lower = option.display.to_lower();
  2409. const char32_t *ssq = &string_to_complete[0];
  2410. const char32_t *ssq_lower = &string_to_complete_lower[0];
  2411. const char32_t *tgt = &option.display[0];
  2412. const char32_t *tgt_lower = &display_lower[0];
  2413. const char32_t *ssq_last_tgt = nullptr;
  2414. const char32_t *ssq_lower_last_tgt = nullptr;
  2415. for (; *tgt; tgt++, tgt_lower++) {
  2416. if (*ssq == *tgt) {
  2417. ssq++;
  2418. ssq_last_tgt = tgt;
  2419. }
  2420. if (*ssq_lower == *tgt_lower) {
  2421. ssq_lower++;
  2422. ssq_lower_last_tgt = tgt;
  2423. }
  2424. }
  2425. /* Matched the whole subsequence in s. */
  2426. if (!*ssq) {
  2427. /* Finished matching in the first s.length() characters. */
  2428. if (ssq_last_tgt == &option.display[string_to_complete.length() - 1]) {
  2429. code_completion_options.push_back(option);
  2430. } else {
  2431. completion_options_subseq.push_back(option);
  2432. }
  2433. max_width = MAX(max_width, font->get_string_size(option.display, font_size).width + offset);
  2434. /* Matched the whole subsequence in s_lower. */
  2435. } else if (!*ssq_lower) {
  2436. /* Finished matching in the first s.length() characters. */
  2437. if (ssq_lower_last_tgt == &option.display[string_to_complete.length() - 1]) {
  2438. completion_options_casei.push_back(option);
  2439. } else {
  2440. completion_options_subseq_casei.push_back(option);
  2441. }
  2442. max_width = MAX(max_width, font->get_string_size(option.display, font_size).width + offset);
  2443. }
  2444. }
  2445. code_completion_options.append_array(completion_options_casei);
  2446. code_completion_options.append_array(completion_options_subseq);
  2447. code_completion_options.append_array(completion_options_subseq_casei);
  2448. /* No options to complete, cancel. */
  2449. if (code_completion_options.size() == 0) {
  2450. cancel_code_completion();
  2451. return;
  2452. }
  2453. /* A perfect match, stop completion. */
  2454. if (code_completion_options.size() == 1 && string_to_complete == code_completion_options[0].display) {
  2455. cancel_code_completion();
  2456. return;
  2457. }
  2458. code_completion_longest_line = MIN(max_width, code_completion_max_width * font_size);
  2459. code_completion_current_selected = 0;
  2460. code_completion_active = true;
  2461. update();
  2462. }
  2463. void CodeEdit::_lines_edited_from(int p_from_line, int p_to_line) {
  2464. _update_delimiter_cache(p_from_line, p_to_line);
  2465. if (p_from_line == p_to_line) {
  2466. return;
  2467. }
  2468. lines_edited_changed += p_to_line - p_from_line;
  2469. 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));
  2470. 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));
  2471. }
  2472. void CodeEdit::_text_set() {
  2473. lines_edited_from = 0;
  2474. lines_edited_to = 9999;
  2475. _text_changed();
  2476. }
  2477. void CodeEdit::_text_changed() {
  2478. if (lines_edited_from == -1) {
  2479. return;
  2480. }
  2481. int lc = get_line_count();
  2482. line_number_digits = 1;
  2483. while (lc /= 10) {
  2484. line_number_digits++;
  2485. }
  2486. if (font.is_valid()) {
  2487. set_gutter_width(line_number_gutter, (line_number_digits + 1) * font->get_char_size('0', 0, font_size).width);
  2488. }
  2489. lc = get_line_count();
  2490. List<int> breakpoints;
  2491. breakpointed_lines.get_key_list(&breakpoints);
  2492. for (const int &line : breakpoints) {
  2493. if (line < lines_edited_from || (line < lc && is_line_breakpointed(line))) {
  2494. continue;
  2495. }
  2496. breakpointed_lines.erase(line);
  2497. emit_signal(SNAME("breakpoint_toggled"), line);
  2498. int next_line = line + lines_edited_changed;
  2499. if (next_line > -1 && next_line < lc && is_line_breakpointed(next_line)) {
  2500. emit_signal(SNAME("breakpoint_toggled"), next_line);
  2501. breakpointed_lines[next_line] = true;
  2502. continue;
  2503. }
  2504. }
  2505. lines_edited_from = -1;
  2506. lines_edited_to = -1;
  2507. lines_edited_changed = 0;
  2508. }
  2509. CodeEdit::CodeEdit() {
  2510. /* Indent management */
  2511. auto_indent_prefixes.insert(':');
  2512. auto_indent_prefixes.insert('{');
  2513. auto_indent_prefixes.insert('[');
  2514. auto_indent_prefixes.insert('(');
  2515. /* Auto brace completion */
  2516. add_auto_brace_completion_pair("(", ")");
  2517. add_auto_brace_completion_pair("{", "}");
  2518. add_auto_brace_completion_pair("[", "]");
  2519. add_auto_brace_completion_pair("\"", "\"");
  2520. add_auto_brace_completion_pair("\'", "\'");
  2521. /* Delimiter traking */
  2522. add_string_delimiter("\"", "\"", false);
  2523. add_string_delimiter("\'", "\'", false);
  2524. /* Text Direction */
  2525. set_layout_direction(LAYOUT_DIRECTION_LTR);
  2526. set_text_direction(TEXT_DIRECTION_LTR);
  2527. /* Gutters */
  2528. int gutter_idx = 0;
  2529. /* Main Gutter */
  2530. add_gutter();
  2531. set_gutter_name(gutter_idx, "main_gutter");
  2532. set_gutter_draw(gutter_idx, false);
  2533. set_gutter_overwritable(gutter_idx, true);
  2534. set_gutter_type(gutter_idx, GUTTER_TYPE_CUSTOM);
  2535. set_gutter_custom_draw(gutter_idx, this, "_main_gutter_draw_callback");
  2536. gutter_idx++;
  2537. /* Line numbers */
  2538. add_gutter();
  2539. set_gutter_name(gutter_idx, "line_numbers");
  2540. set_gutter_draw(gutter_idx, false);
  2541. set_gutter_type(gutter_idx, GUTTER_TYPE_CUSTOM);
  2542. set_gutter_custom_draw(gutter_idx, this, "_line_number_draw_callback");
  2543. gutter_idx++;
  2544. /* Fold Gutter */
  2545. add_gutter();
  2546. set_gutter_name(gutter_idx, "fold_gutter");
  2547. set_gutter_draw(gutter_idx, false);
  2548. set_gutter_type(gutter_idx, GUTTER_TYPE_CUSTOM);
  2549. set_gutter_custom_draw(gutter_idx, this, "_fold_gutter_draw_callback");
  2550. gutter_idx++;
  2551. connect("lines_edited_from", callable_mp(this, &CodeEdit::_lines_edited_from));
  2552. connect("text_set", callable_mp(this, &CodeEdit::_text_set));
  2553. connect("text_changed", callable_mp(this, &CodeEdit::_text_changed));
  2554. connect("gutter_clicked", callable_mp(this, &CodeEdit::_gutter_clicked));
  2555. connect("gutter_added", callable_mp(this, &CodeEdit::_update_gutter_indexes));
  2556. connect("gutter_removed", callable_mp(this, &CodeEdit::_update_gutter_indexes));
  2557. _update_gutter_indexes();
  2558. }
  2559. CodeEdit::~CodeEdit() {
  2560. }