TextEditor.cpp 83 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2021, networkException <networkexception@serenityos.org>
  4. * Copyright (c) 2022, the SerenityOS developers.
  5. *
  6. * SPDX-License-Identifier: BSD-2-Clause
  7. */
  8. #include <AK/CharacterTypes.h>
  9. #include <AK/Debug.h>
  10. #include <AK/ScopeGuard.h>
  11. #include <AK/StringBuilder.h>
  12. #include <AK/TemporaryChange.h>
  13. #include <LibCore/File.h>
  14. #include <LibCore/Timer.h>
  15. #include <LibGUI/Action.h>
  16. #include <LibGUI/AutocompleteProvider.h>
  17. #include <LibGUI/Clipboard.h>
  18. #include <LibGUI/EditingEngine.h>
  19. #include <LibGUI/EmojiInputDialog.h>
  20. #include <LibGUI/IncrementalSearchBanner.h>
  21. #include <LibGUI/InputBox.h>
  22. #include <LibGUI/Menu.h>
  23. #include <LibGUI/Painter.h>
  24. #include <LibGUI/RegularEditingEngine.h>
  25. #include <LibGUI/Scrollbar.h>
  26. #include <LibGUI/TextEditor.h>
  27. #include <LibGUI/Window.h>
  28. #include <LibGfx/Bitmap.h>
  29. #include <LibGfx/Font/Font.h>
  30. #include <LibGfx/Font/FontDatabase.h>
  31. #include <LibGfx/Palette.h>
  32. #include <LibGfx/StandardCursor.h>
  33. #include <LibSyntax/Highlighter.h>
  34. #include <fcntl.h>
  35. #include <stdio.h>
  36. #include <unistd.h>
  37. REGISTER_WIDGET(GUI, TextEditor)
  38. namespace GUI {
  39. TextEditor::TextEditor(Type type)
  40. : m_type(type)
  41. {
  42. REGISTER_STRING_PROPERTY("text", text, set_text);
  43. REGISTER_STRING_PROPERTY("placeholder", placeholder, set_placeholder);
  44. REGISTER_BOOL_PROPERTY("gutter", is_gutter_visible, set_gutter_visible);
  45. REGISTER_BOOL_PROPERTY("ruler", is_ruler_visible, set_ruler_visible);
  46. REGISTER_ENUM_PROPERTY("mode", mode, set_mode, Mode,
  47. { Editable, "Editable" },
  48. { ReadOnly, "ReadOnly" },
  49. { DisplayOnly, "DisplayOnly" });
  50. set_focus_policy(GUI::FocusPolicy::StrongFocus);
  51. set_or_clear_emoji_input_callback();
  52. set_override_cursor(Gfx::StandardCursor::IBeam);
  53. set_background_role(ColorRole::Base);
  54. set_foreground_role(ColorRole::BaseText);
  55. set_document(TextDocument::create());
  56. if (is_single_line())
  57. set_visualize_trailing_whitespace(false);
  58. set_scrollbars_enabled(is_multi_line());
  59. if (is_multi_line()) {
  60. set_font(Gfx::FontDatabase::default_fixed_width_font());
  61. set_wrapping_mode(WrappingMode::WrapAtWords);
  62. m_search_banner = GUI::IncrementalSearchBanner::construct(*this);
  63. set_banner_widget(m_search_banner);
  64. }
  65. vertical_scrollbar().set_step(line_height());
  66. m_cursor = { 0, 0 };
  67. m_automatic_selection_scroll_timer = add<Core::Timer>(100, [this] {
  68. automatic_selection_scroll_timer_fired();
  69. });
  70. m_automatic_selection_scroll_timer->stop();
  71. create_actions();
  72. set_editing_engine(make<RegularEditingEngine>());
  73. }
  74. TextEditor::~TextEditor()
  75. {
  76. if (m_document)
  77. m_document->unregister_client(*this);
  78. }
  79. void TextEditor::create_actions()
  80. {
  81. m_undo_action = CommonActions::make_undo_action([&](auto&) { undo(); }, this);
  82. m_redo_action = CommonActions::make_redo_action([&](auto&) { redo(); }, this);
  83. m_undo_action->set_enabled(false);
  84. m_redo_action->set_enabled(false);
  85. m_cut_action = CommonActions::make_cut_action([&](auto&) { cut(); }, this);
  86. m_copy_action = CommonActions::make_copy_action([&](auto&) { copy(); }, this);
  87. m_cut_action->set_enabled(false);
  88. m_copy_action->set_enabled(false);
  89. m_paste_action = CommonActions::make_paste_action([&](auto&) { paste(); }, this);
  90. m_paste_action->set_enabled(is_editable() && Clipboard::the().fetch_mime_type().starts_with("text/"sv));
  91. if (is_multi_line()) {
  92. m_go_to_line_action = Action::create(
  93. "Go to line...", { Mod_Ctrl, Key_L }, Gfx::Bitmap::try_load_from_file("/res/icons/16x16/go-to.png"sv).release_value_but_fixme_should_propagate_errors(), [this](auto&) {
  94. DeprecatedString value;
  95. if (InputBox::show(window(), value, "Line:"sv, "Go to line"sv) == InputBox::ExecResult::OK) {
  96. auto line_target = value.to_uint();
  97. if (line_target.has_value()) {
  98. set_cursor_and_focus_line(line_target.value() - 1, 0);
  99. }
  100. }
  101. },
  102. this);
  103. }
  104. m_select_all_action = CommonActions::make_select_all_action([this](auto&) { select_all(); }, this);
  105. m_insert_emoji_action = CommonActions::make_insert_emoji_action([&](auto&) { insert_emoji(); }, this);
  106. }
  107. void TextEditor::set_text(StringView text, AllowCallback allow_callback)
  108. {
  109. m_selection.clear();
  110. document().set_text(text, allow_callback);
  111. update_content_size();
  112. recompute_all_visual_lines();
  113. if (is_single_line())
  114. set_cursor(0, line(0).length());
  115. else
  116. set_cursor(0, 0);
  117. did_update_selection();
  118. update();
  119. }
  120. void TextEditor::update_content_size()
  121. {
  122. int content_width = 0;
  123. int content_height = 0;
  124. for (auto& line : m_line_visual_data) {
  125. content_width = max(line.visual_rect.width(), content_width);
  126. content_height += line.visual_rect.height();
  127. }
  128. content_width += m_horizontal_content_padding * 2;
  129. if (is_right_text_alignment(m_text_alignment))
  130. content_width = max(frame_inner_rect().width(), content_width);
  131. set_content_size({ content_width, content_height });
  132. set_size_occupied_by_fixed_elements({ ruler_width() + gutter_width(), 0 });
  133. }
  134. TextPosition TextEditor::text_position_at_content_position(Gfx::IntPoint content_position) const
  135. {
  136. auto position = content_position;
  137. if (is_single_line() && icon())
  138. position.translate_by(-(icon_size() + icon_padding()), 0);
  139. size_t line_index = 0;
  140. if (position.y() >= 0) {
  141. if (is_wrapping_enabled()) {
  142. for (size_t i = 0; i < line_count(); ++i) {
  143. auto& rect = m_line_visual_data[i].visual_rect;
  144. if (position.y() >= rect.top() && position.y() <= rect.bottom()) {
  145. line_index = i;
  146. break;
  147. }
  148. if (position.y() > rect.bottom())
  149. line_index = line_count() - 1;
  150. }
  151. } else {
  152. line_index = (size_t)(position.y() / line_height());
  153. }
  154. line_index = max((size_t)0, min(line_index, line_count() - 1));
  155. }
  156. size_t column_index = 0;
  157. switch (m_text_alignment) {
  158. case Gfx::TextAlignment::CenterLeft:
  159. for_each_visual_line(line_index, [&](Gfx::IntRect const& rect, auto& view, size_t start_of_line, [[maybe_unused]] bool is_last_visual_line) {
  160. if (is_multi_line() && !rect.contains_vertically(position.y()) && !is_last_visual_line)
  161. return IterationDecision::Continue;
  162. column_index = start_of_line;
  163. if (position.x() <= 0) {
  164. // We're outside the text on the left side, put cursor at column 0 on this visual line.
  165. } else {
  166. int glyph_x = 0;
  167. size_t i = 0;
  168. for (; i < view.length(); ++i) {
  169. int advance = font().glyph_or_emoji_width(view.code_points()[i]) + font().glyph_spacing();
  170. if ((glyph_x + (advance / 2)) >= position.x())
  171. break;
  172. glyph_x += advance;
  173. }
  174. column_index += i;
  175. }
  176. return IterationDecision::Break;
  177. });
  178. break;
  179. case Gfx::TextAlignment::CenterRight:
  180. // FIXME: Support right-aligned line wrapping, I guess.
  181. VERIFY(!is_wrapping_enabled());
  182. column_index = (position.x() - content_x_for_position({ line_index, 0 }) + fixed_glyph_width() / 2) / fixed_glyph_width();
  183. break;
  184. default:
  185. VERIFY_NOT_REACHED();
  186. }
  187. column_index = max((size_t)0, min(column_index, line(line_index).length()));
  188. return { line_index, column_index };
  189. }
  190. TextPosition TextEditor::text_position_at(Gfx::IntPoint widget_position) const
  191. {
  192. auto content_position = widget_position;
  193. content_position.translate_by(horizontal_scrollbar().value(), vertical_scrollbar().value());
  194. content_position.translate_by(-(m_horizontal_content_padding + ruler_width() + gutter_width()), 0);
  195. content_position.translate_by(-frame_thickness(), -frame_thickness());
  196. content_position.translate_by(0, -height_occupied_by_banner_widget());
  197. return text_position_at_content_position(content_position);
  198. }
  199. void TextEditor::doubleclick_event(MouseEvent& event)
  200. {
  201. if (event.button() != MouseButton::Primary)
  202. return;
  203. if (is_displayonly())
  204. return;
  205. if (!current_line().can_select())
  206. return;
  207. rehighlight_if_needed();
  208. m_triple_click_timer.start();
  209. m_in_drag_select = false;
  210. auto position = text_position_at(event.position());
  211. if (m_substitution_code_point.has_value()) {
  212. // NOTE: If we substitute the code points, we don't want double clicking to only select a single word, since
  213. // whitespace isn't visible anymore.
  214. m_selection = document().range_for_entire_line(position.line());
  215. } else if (document().has_spans()) {
  216. for (auto& span : document().spans()) {
  217. if (span.range.contains(position)) {
  218. m_selection = span.range;
  219. break;
  220. }
  221. }
  222. } else {
  223. m_selection.set_start(document().first_word_break_before(position, false));
  224. m_selection.set_end(document().first_word_break_after(position));
  225. }
  226. set_cursor(m_selection.end());
  227. update();
  228. did_update_selection();
  229. }
  230. void TextEditor::mousedown_event(MouseEvent& event)
  231. {
  232. if (event.button() != MouseButton::Primary) {
  233. return;
  234. }
  235. if (on_mousedown)
  236. on_mousedown();
  237. if (is_displayonly())
  238. return;
  239. if (m_triple_click_timer.is_valid() && m_triple_click_timer.elapsed() < 250) {
  240. m_triple_click_timer = Core::ElapsedTimer();
  241. select_current_line();
  242. return;
  243. }
  244. if (event.modifiers() & Mod_Shift) {
  245. if (!has_selection())
  246. m_selection.set(m_cursor, {});
  247. } else {
  248. m_selection.clear();
  249. }
  250. m_in_drag_select = true;
  251. m_automatic_selection_scroll_timer->start();
  252. set_cursor(text_position_at(event.position()));
  253. if (!(event.modifiers() & Mod_Shift)) {
  254. if (!has_selection())
  255. m_selection.set(m_cursor, {});
  256. }
  257. if (m_selection.start().is_valid() && m_selection.start() != m_cursor)
  258. m_selection.set_end(m_cursor);
  259. // FIXME: Only update the relevant rects.
  260. update();
  261. did_update_selection();
  262. }
  263. void TextEditor::mouseup_event(MouseEvent& event)
  264. {
  265. if (event.button() == MouseButton::Primary) {
  266. if (m_in_drag_select) {
  267. m_in_drag_select = false;
  268. }
  269. return;
  270. }
  271. }
  272. void TextEditor::mousemove_event(MouseEvent& event)
  273. {
  274. m_last_mousemove_position = event.position();
  275. if (m_in_drag_select && (rect().contains(event.position()) || !m_automatic_selection_scroll_timer->is_active())) {
  276. set_cursor(text_position_at(event.position()));
  277. m_selection.set_end(m_cursor);
  278. did_update_selection();
  279. update();
  280. return;
  281. }
  282. if (m_ruler_visible && (ruler_rect_in_inner_coordinates().contains(event.position()))) {
  283. set_override_cursor(Gfx::StandardCursor::None);
  284. } else {
  285. set_editing_cursor();
  286. }
  287. }
  288. void TextEditor::select_current_line()
  289. {
  290. m_selection = document().range_for_entire_line(m_cursor.line());
  291. set_cursor(m_selection.end());
  292. update();
  293. did_update_selection();
  294. }
  295. void TextEditor::automatic_selection_scroll_timer_fired()
  296. {
  297. if (!m_in_drag_select) {
  298. m_automatic_selection_scroll_timer->stop();
  299. return;
  300. }
  301. set_cursor(text_position_at(m_last_mousemove_position));
  302. m_selection.set_end(m_cursor);
  303. did_update_selection();
  304. update();
  305. }
  306. int TextEditor::ruler_width() const
  307. {
  308. if (!m_ruler_visible)
  309. return 0;
  310. int line_count_digits = static_cast<int>(log10(line_count())) + 1;
  311. auto padding = 5 + (font().is_fixed_width() ? 1 : (line_count_digits - (line_count() < 10 ? -1 : 0)));
  312. auto widest_numeral = font().bold_variant().glyph_width('4');
  313. return line_count() < 10 ? (line_count_digits + 1) * widest_numeral + padding : line_count_digits * widest_numeral + padding;
  314. }
  315. int TextEditor::gutter_width() const
  316. {
  317. if (!m_gutter_visible)
  318. return 0;
  319. return line_height(); // square gutter
  320. }
  321. Gfx::IntRect TextEditor::ruler_content_rect(size_t line_index) const
  322. {
  323. if (!m_ruler_visible)
  324. return {};
  325. return {
  326. 0 - ruler_width() + horizontal_scrollbar().value(),
  327. line_content_rect(line_index).y(),
  328. ruler_width(),
  329. line_content_rect(line_index).height()
  330. };
  331. }
  332. Gfx::IntRect TextEditor::gutter_content_rect(size_t line_index) const
  333. {
  334. if (!m_gutter_visible)
  335. return {};
  336. return {
  337. 0 - ruler_width() - gutter_width() + horizontal_scrollbar().value(),
  338. line_content_rect(line_index).y(),
  339. gutter_width(),
  340. line_content_rect(line_index).height()
  341. };
  342. }
  343. Gfx::IntRect TextEditor::ruler_rect_in_inner_coordinates() const
  344. {
  345. return { gutter_width(), 0, ruler_width(), widget_inner_rect().height() };
  346. }
  347. Gfx::IntRect TextEditor::gutter_rect_in_inner_coordinates() const
  348. {
  349. return { 0, 0, gutter_width(), widget_inner_rect().height() };
  350. }
  351. Gfx::IntRect TextEditor::visible_text_rect_in_inner_coordinates() const
  352. {
  353. return {
  354. m_horizontal_content_padding + (m_ruler_visible ? (ruler_rect_in_inner_coordinates().right() + 1) : 0),
  355. 0,
  356. frame_inner_rect().width() - (m_horizontal_content_padding * 2) - width_occupied_by_vertical_scrollbar() - ruler_width(),
  357. frame_inner_rect().height() - height_occupied_by_horizontal_scrollbar()
  358. };
  359. }
  360. void TextEditor::paint_event(PaintEvent& event)
  361. {
  362. Color widget_background_color = palette().color(is_enabled() ? background_role() : Gfx::ColorRole::Window);
  363. rehighlight_if_needed();
  364. Frame::paint_event(event);
  365. Painter painter(*this);
  366. painter.add_clip_rect(widget_inner_rect());
  367. painter.add_clip_rect(event.rect());
  368. painter.fill_rect(event.rect(), widget_background_color);
  369. // NOTE: This lambda and TextEditor::text_width_for_font() are used to substitute all glyphs with m_substitution_code_point if necessary.
  370. // Painter::draw_text() and Gfx::Font::width() should not be called directly, but using this lambda and TextEditor::text_width_for_font().
  371. auto draw_text = [&](Gfx::IntRect const& rect, auto const& raw_text, Gfx::Font const& font, Gfx::TextAlignment alignment, Gfx::TextAttributes attributes, bool substitute = true) {
  372. if (m_substitution_code_point.has_value() && substitute) {
  373. painter.draw_text(rect, substitution_code_point_view(raw_text.length()), font, alignment, attributes.color);
  374. } else {
  375. painter.draw_text(rect, raw_text, font, alignment, attributes.color);
  376. }
  377. if (attributes.underline) {
  378. if (attributes.underline_style == Gfx::TextAttributes::UnderlineStyle::Solid)
  379. painter.draw_line(rect.bottom_left().translated(0, 1), rect.bottom_right().translated(0, 1), attributes.underline_color.value_or(attributes.color));
  380. if (attributes.underline_style == Gfx::TextAttributes::UnderlineStyle::Wavy)
  381. painter.draw_triangle_wave(rect.bottom_left().translated(0, 1), rect.bottom_right().translated(0, 1), attributes.underline_color.value_or(attributes.color), 2);
  382. }
  383. };
  384. if (is_displayonly() && is_focused()) {
  385. Gfx::IntRect display_rect {
  386. widget_inner_rect().x() + 1,
  387. widget_inner_rect().y() + 1,
  388. widget_inner_rect().width() - 2,
  389. widget_inner_rect().height() - 2
  390. };
  391. painter.fill_rect(display_rect, palette().selection());
  392. }
  393. painter.translate(frame_thickness(), frame_thickness());
  394. painter.translate(0, height_occupied_by_banner_widget());
  395. if (!is_multi_line() && m_icon) {
  396. Gfx::IntRect icon_rect { icon_padding(), 1, icon_size(), icon_size() };
  397. painter.draw_scaled_bitmap(icon_rect, *m_icon, m_icon->rect());
  398. }
  399. if (m_gutter_visible) {
  400. auto gutter_rect = gutter_rect_in_inner_coordinates();
  401. painter.fill_rect(gutter_rect, palette().gutter());
  402. if (!m_ruler_visible)
  403. painter.draw_line(gutter_rect.top_right(), gutter_rect.bottom_right(), palette().gutter_border());
  404. }
  405. if (m_ruler_visible) {
  406. auto ruler_rect = ruler_rect_in_inner_coordinates();
  407. painter.fill_rect(ruler_rect, palette().ruler());
  408. painter.draw_line(ruler_rect.top_right(), ruler_rect.bottom_right(), palette().ruler_border());
  409. }
  410. auto horizontal_scrollbar_value = horizontal_scrollbar().value();
  411. painter.translate(-horizontal_scrollbar_value, -vertical_scrollbar().value());
  412. if (m_icon && horizontal_scrollbar_value > 0)
  413. painter.translate(min(icon_size() + icon_padding(), horizontal_scrollbar_value), 0);
  414. painter.translate(gutter_width(), 0);
  415. painter.translate(ruler_width(), 0);
  416. size_t first_visible_line = text_position_at(event.rect().top_left()).line();
  417. size_t last_visible_line = text_position_at(event.rect().bottom_right()).line();
  418. auto selection = normalized_selection();
  419. bool has_selection = selection.is_valid();
  420. if (m_ruler_visible) {
  421. for (size_t i = first_visible_line; i <= last_visible_line; ++i) {
  422. bool is_current_line = i == m_cursor.line();
  423. auto ruler_line_rect = ruler_content_rect(i);
  424. // NOTE: Shrink the rectangle to be only on the first visual line.
  425. auto const line_height = font().preferred_line_height();
  426. if (ruler_line_rect.height() > line_height)
  427. ruler_line_rect.set_height(line_height);
  428. // NOTE: Use Painter::draw_text() directly here, as we want to always draw the line numbers in clear text.
  429. size_t const line_number = is_relative_line_number() && !is_current_line ? max(i, m_cursor.line()) - min(i, m_cursor.line()) : i + 1;
  430. painter.draw_text(
  431. ruler_line_rect.shrunken(2, 0),
  432. DeprecatedString::number(line_number),
  433. is_current_line ? font().bold_variant() : font(),
  434. Gfx::TextAlignment::CenterRight,
  435. is_current_line ? palette().ruler_active_text() : palette().ruler_inactive_text());
  436. }
  437. }
  438. auto gutter_ruler_width = gutter_width() + ruler_width();
  439. Gfx::IntRect text_clip_rect { 0, 0, widget_inner_rect().width() - gutter_ruler_width, widget_inner_rect().height() };
  440. text_clip_rect.translate_by(horizontal_scrollbar().value(), vertical_scrollbar().value());
  441. painter.add_clip_rect(text_clip_rect);
  442. size_t span_index = 0;
  443. if (document().has_spans()) {
  444. for (;;) {
  445. if (span_index >= document().spans().size() || document().spans()[span_index].range.end().line() >= first_visible_line) {
  446. break;
  447. }
  448. ++span_index;
  449. }
  450. }
  451. for (size_t line_index = first_visible_line; line_index <= last_visible_line; ++line_index) {
  452. auto& line = this->line(line_index);
  453. bool physical_line_has_selection = has_selection && line_index >= selection.start().line() && line_index <= selection.end().line();
  454. size_t first_visual_line_with_selection = 0;
  455. size_t last_visual_line_with_selection = 0;
  456. if (physical_line_has_selection) {
  457. if (selection.start().line() < line_index)
  458. first_visual_line_with_selection = 0;
  459. else
  460. first_visual_line_with_selection = visual_line_containing(line_index, selection.start().column());
  461. if (selection.end().line() > line_index)
  462. last_visual_line_with_selection = m_line_visual_data[line_index].visual_line_breaks.size();
  463. else
  464. last_visual_line_with_selection = visual_line_containing(line_index, selection.end().column());
  465. }
  466. size_t selection_start_column_within_line = selection.start().line() == line_index ? selection.start().column() : 0;
  467. size_t selection_end_column_within_line = selection.end().line() == line_index ? selection.end().column() : line.length();
  468. size_t visual_line_index = 0;
  469. size_t last_start_of_visual_line = 0;
  470. Optional<size_t> multiline_trailing_space_offset {};
  471. for_each_visual_line(line_index, [&](Gfx::IntRect const& visual_line_rect, auto& visual_line_text, size_t start_of_visual_line, [[maybe_unused]] bool is_last_visual_line) {
  472. ScopeGuard update_last_start_of_visual_line { [&]() { last_start_of_visual_line = start_of_visual_line; } };
  473. if (is_focused() && is_multi_line() && line_index == m_cursor.line() && is_cursor_line_highlighted()) {
  474. Gfx::IntRect visible_content_line_rect {
  475. visible_content_rect().x(),
  476. visual_line_rect.y(),
  477. widget_inner_rect().width() - gutter_ruler_width,
  478. line_height()
  479. };
  480. painter.fill_rect(visible_content_line_rect, widget_background_color.darkened(0.9f));
  481. }
  482. if constexpr (TEXTEDITOR_DEBUG)
  483. painter.draw_rect(visual_line_rect, Color::Cyan);
  484. if (!placeholder().is_empty() && document().is_empty() && line_index == 0) {
  485. auto line_rect = visual_line_rect;
  486. line_rect.set_width(text_width_for_font(placeholder(), font()));
  487. draw_text(line_rect, placeholder(), font(), m_text_alignment, { palette().color(Gfx::ColorRole::PlaceholderText) }, false);
  488. } else if (!document().has_spans()) {
  489. // Fast-path for plain text
  490. auto color = palette().color(is_enabled() ? foreground_role() : Gfx::ColorRole::DisabledText);
  491. if (is_displayonly() && is_focused())
  492. color = palette().color(is_enabled() ? Gfx::ColorRole::SelectionText : Gfx::ColorRole::DisabledText);
  493. draw_text(visual_line_rect, visual_line_text, font(), m_text_alignment, { color });
  494. } else {
  495. auto unspanned_color = palette().color(is_enabled() ? foreground_role() : Gfx::ColorRole::DisabledText);
  496. if (is_displayonly() && is_focused())
  497. unspanned_color = palette().color(is_enabled() ? Gfx::ColorRole::SelectionText : Gfx::ColorRole::DisabledText);
  498. RefPtr<Gfx::Font> unspanned_font = this->font();
  499. size_t next_column = 0;
  500. Gfx::IntRect span_rect = { visual_line_rect.location(), { 0, line_height() } };
  501. auto draw_text_helper = [&](size_t start, size_t end, RefPtr<Gfx::Font>& font, Gfx::TextAttributes text_attributes) {
  502. size_t length = end - start;
  503. if (length == 0)
  504. return;
  505. auto text = visual_line_text.substring_view(start, length);
  506. span_rect.set_width(font->width(text));
  507. if (text_attributes.background_color.has_value()) {
  508. painter.fill_rect(span_rect, text_attributes.background_color.value());
  509. }
  510. draw_text(span_rect, text, *font, m_text_alignment, text_attributes);
  511. span_rect.translate_by(span_rect.width(), 0);
  512. };
  513. for (;;) {
  514. if (span_index >= document().spans().size()) {
  515. break;
  516. }
  517. auto& span = document().spans()[span_index];
  518. if (!span.range.is_valid()) {
  519. ++span_index;
  520. continue;
  521. }
  522. if (span.range.end().line() < line_index) {
  523. dbgln_if(TEXTEDITOR_DEBUG, "spans not sorted (span end {}:{} is before current line {}) => ignoring", span.range.end().line(), span.range.end().column(), line_index);
  524. ++span_index;
  525. continue;
  526. }
  527. if (span.range.start().line() > line_index
  528. || (span.range.start().line() == line_index && span.range.start().column() >= start_of_visual_line + visual_line_text.length())) {
  529. // no more spans in this line, moving on
  530. break;
  531. }
  532. if (span.range.start().line() == span.range.end().line() && span.range.end().column() < span.range.start().column()) {
  533. dbgln_if(TEXTEDITOR_DEBUG, "span from {}:{} to {}:{} has negative length => ignoring", span.range.start().line(), span.range.start().column(), span.range.end().line(), span.range.end().column());
  534. ++span_index;
  535. continue;
  536. }
  537. if (span.range.end().line() == line_index && span.range.end().column() < start_of_visual_line + next_column) {
  538. dbgln_if(TEXTEDITOR_DEBUG, "spans not sorted (span end {}:{} is before current position {}:{}) => ignoring",
  539. span.range.end().line(), span.range.end().column(), line_index, start_of_visual_line + next_column);
  540. ++span_index;
  541. continue;
  542. }
  543. size_t span_start;
  544. if (span.range.start().line() < line_index || span.range.start().column() < start_of_visual_line) {
  545. span_start = 0;
  546. } else {
  547. span_start = span.range.start().column() - start_of_visual_line;
  548. }
  549. if (span_start < next_column) {
  550. dbgln_if(TEXTEDITOR_DEBUG, "span started before the current position, maybe two spans overlap? (span start {} is before current position {}) => ignoring", span_start, next_column);
  551. ++span_index;
  552. continue;
  553. }
  554. size_t span_end;
  555. bool span_consumned;
  556. if (span.range.end().line() > line_index || span.range.end().column() > start_of_visual_line + visual_line_text.length()) {
  557. span_end = visual_line_text.length();
  558. span_consumned = false;
  559. } else {
  560. span_end = span.range.end().column() - start_of_visual_line;
  561. span_consumned = true;
  562. }
  563. if (span_start != next_column) {
  564. // draw unspanned text between spans
  565. draw_text_helper(next_column, span_start, unspanned_font, { unspanned_color });
  566. }
  567. auto font = unspanned_font;
  568. if (span.attributes.bold) {
  569. if (auto bold_font = Gfx::FontDatabase::the().get(font->family(), font->presentation_size(), 700, 0))
  570. font = bold_font;
  571. }
  572. draw_text_helper(span_start, span_end, font, span.attributes);
  573. next_column = span_end;
  574. if (!span_consumned) {
  575. // continue with same span on next line
  576. break;
  577. } else {
  578. ++span_index;
  579. }
  580. }
  581. // draw unspanned text after last span
  582. if (next_column < visual_line_text.length()) {
  583. draw_text_helper(next_column, visual_line_text.length(), unspanned_font, { unspanned_color });
  584. }
  585. // consume all spans that should end this line
  586. // this is necessary since the spans can include the new line character
  587. while (is_last_visual_line && span_index < document().spans().size()) {
  588. auto& span = document().spans()[span_index];
  589. if (span.range.end().line() == line_index) {
  590. ++span_index;
  591. } else {
  592. break;
  593. }
  594. }
  595. }
  596. if (m_visualize_trailing_whitespace && line.ends_in_whitespace()) {
  597. size_t physical_column;
  598. auto last_non_whitespace_column = line.last_non_whitespace_column();
  599. if (last_non_whitespace_column.has_value())
  600. physical_column = last_non_whitespace_column.value() + 1;
  601. else
  602. physical_column = 0;
  603. size_t end_of_visual_line = (start_of_visual_line + visual_line_text.length());
  604. if (physical_column < end_of_visual_line) {
  605. physical_column -= multiline_trailing_space_offset.value_or(0);
  606. size_t visual_column = physical_column > start_of_visual_line ? (physical_column - start_of_visual_line) : 0;
  607. Gfx::IntRect whitespace_rect {
  608. content_x_for_position({ line_index, physical_column }),
  609. visual_line_rect.y(),
  610. text_width_for_font(visual_line_text.substring_view(visual_column, visual_line_text.length() - visual_column), font()),
  611. visual_line_rect.height()
  612. };
  613. painter.fill_rect_with_dither_pattern(whitespace_rect, Color(), Color(255, 192, 192));
  614. if (!multiline_trailing_space_offset.has_value())
  615. multiline_trailing_space_offset = physical_column - last_start_of_visual_line;
  616. }
  617. }
  618. if (m_visualize_leading_whitespace && line.leading_spaces() > 0) {
  619. size_t physical_column = line.leading_spaces();
  620. if (start_of_visual_line < physical_column) {
  621. size_t end_of_leading_whitespace = min(physical_column - start_of_visual_line, visual_line_text.length());
  622. Gfx::IntRect whitespace_rect {
  623. content_x_for_position({ line_index, start_of_visual_line }),
  624. visual_line_rect.y(),
  625. text_width_for_font(visual_line_text.substring_view(0, end_of_leading_whitespace), font()),
  626. visual_line_rect.height()
  627. };
  628. painter.fill_rect_with_dither_pattern(whitespace_rect, Color(), Color(192, 255, 192));
  629. }
  630. }
  631. if (physical_line_has_selection && window()->focused_widget() == this) {
  632. size_t const start_of_selection_within_visual_line = (size_t)max(0, (int)selection_start_column_within_line - (int)start_of_visual_line);
  633. size_t const end_of_selection_within_visual_line = min(selection_end_column_within_line - start_of_visual_line, visual_line_text.length());
  634. bool current_visual_line_has_selection = start_of_selection_within_visual_line != end_of_selection_within_visual_line
  635. && ((line_index != selection.start().line() && line_index != selection.end().line())
  636. || (visual_line_index >= first_visual_line_with_selection && visual_line_index <= last_visual_line_with_selection));
  637. if (current_visual_line_has_selection) {
  638. bool selection_begins_on_current_visual_line = visual_line_index == first_visual_line_with_selection;
  639. bool selection_ends_on_current_visual_line = visual_line_index == last_visual_line_with_selection;
  640. int selection_left = selection_begins_on_current_visual_line
  641. ? content_x_for_position({ line_index, (size_t)selection_start_column_within_line })
  642. : m_horizontal_content_padding;
  643. int selection_right = selection_ends_on_current_visual_line
  644. ? content_x_for_position({ line_index, (size_t)selection_end_column_within_line })
  645. : visual_line_rect.right() + 1;
  646. Gfx::IntRect selection_rect {
  647. selection_left,
  648. visual_line_rect.y(),
  649. selection_right - selection_left,
  650. visual_line_rect.height()
  651. };
  652. Color background_color = is_focused() ? palette().selection() : palette().inactive_selection();
  653. Color text_color = is_focused() ? palette().selection_text() : palette().inactive_selection_text();
  654. painter.fill_rect(selection_rect, background_color);
  655. if (visual_line_text.code_points()) {
  656. Utf32View visual_selected_text {
  657. visual_line_text.code_points() + start_of_selection_within_visual_line,
  658. end_of_selection_within_visual_line - start_of_selection_within_visual_line
  659. };
  660. draw_text(selection_rect, visual_selected_text, font(), Gfx::TextAlignment::CenterLeft, { text_color });
  661. }
  662. }
  663. }
  664. ++visual_line_index;
  665. return IterationDecision::Continue;
  666. });
  667. }
  668. if (is_enabled() && is_focused() && !focus_preempted() && m_cursor_state && !is_displayonly())
  669. painter.fill_rect(cursor_content_rect(), palette().text_cursor());
  670. }
  671. Optional<UISize> TextEditor::calculated_min_size() const
  672. {
  673. if (is_multi_line())
  674. return AbstractScrollableWidget::calculated_min_size();
  675. auto m = content_margins();
  676. return UISize { m.left() + m.right(), m.top() + m.bottom() };
  677. }
  678. void TextEditor::select_all()
  679. {
  680. TextPosition start_of_document { 0, 0 };
  681. TextPosition end_of_document { line_count() - 1, line(line_count() - 1).length() };
  682. m_selection.set(end_of_document, start_of_document);
  683. did_update_selection();
  684. set_cursor(start_of_document);
  685. update();
  686. }
  687. void TextEditor::insert_emoji()
  688. {
  689. if (!on_emoji_input || window()->blocks_emoji_input())
  690. return;
  691. auto emoji_input_dialog = EmojiInputDialog::construct(window());
  692. if (emoji_input_dialog->exec() != EmojiInputDialog::ExecResult::OK)
  693. return;
  694. auto emoji_code_point = emoji_input_dialog->selected_emoji_text();
  695. insert_at_cursor_or_replace_selection(emoji_code_point);
  696. }
  697. void TextEditor::set_or_clear_emoji_input_callback()
  698. {
  699. switch (m_mode) {
  700. case Editable:
  701. on_emoji_input = [this](auto emoji) {
  702. insert_at_cursor_or_replace_selection(emoji);
  703. };
  704. break;
  705. case DisplayOnly:
  706. case ReadOnly:
  707. on_emoji_input = {};
  708. break;
  709. default:
  710. VERIFY_NOT_REACHED();
  711. }
  712. }
  713. void TextEditor::keydown_event(KeyEvent& event)
  714. {
  715. if (!is_editable() && event.key() == KeyCode::Key_Tab)
  716. return AbstractScrollableWidget::keydown_event(event);
  717. if (m_autocomplete_box && m_autocomplete_box->is_visible() && (event.key() == KeyCode::Key_Return || event.key() == KeyCode::Key_Tab)) {
  718. TemporaryChange change { m_should_keep_autocomplete_box, true };
  719. if (m_autocomplete_box->apply_suggestion() == CodeComprehension::AutocompleteResultEntry::HideAutocompleteAfterApplying::Yes)
  720. hide_autocomplete();
  721. else
  722. try_update_autocomplete();
  723. return;
  724. }
  725. if (m_autocomplete_box && m_autocomplete_box->is_visible() && event.key() == KeyCode::Key_Escape) {
  726. hide_autocomplete();
  727. return;
  728. }
  729. if (m_autocomplete_box && m_autocomplete_box->is_visible() && event.key() == KeyCode::Key_Up) {
  730. m_autocomplete_box->previous_suggestion();
  731. return;
  732. }
  733. if (m_autocomplete_box && m_autocomplete_box->is_visible() && event.key() == KeyCode::Key_Down) {
  734. m_autocomplete_box->next_suggestion();
  735. return;
  736. }
  737. if (is_single_line()) {
  738. if (event.key() == KeyCode::Key_Tab)
  739. return AbstractScrollableWidget::keydown_event(event);
  740. if (event.modifiers() == KeyModifier::Mod_Shift && event.key() == KeyCode::Key_Return) {
  741. if (on_shift_return_pressed)
  742. on_shift_return_pressed();
  743. return;
  744. }
  745. if (event.modifiers() == KeyModifier::Mod_Ctrl && event.key() == KeyCode::Key_Return) {
  746. if (on_ctrl_return_pressed)
  747. on_ctrl_return_pressed();
  748. return;
  749. }
  750. if (event.key() == KeyCode::Key_Return) {
  751. if (on_return_pressed)
  752. on_return_pressed();
  753. return;
  754. }
  755. if (event.key() == KeyCode::Key_Up) {
  756. if (on_up_pressed)
  757. on_up_pressed();
  758. return;
  759. }
  760. if (event.key() == KeyCode::Key_Down) {
  761. if (on_down_pressed)
  762. on_down_pressed();
  763. return;
  764. }
  765. if (event.key() == KeyCode::Key_PageUp) {
  766. if (on_pageup_pressed)
  767. on_pageup_pressed();
  768. return;
  769. }
  770. if (event.key() == KeyCode::Key_PageDown) {
  771. if (on_pagedown_pressed)
  772. on_pagedown_pressed();
  773. return;
  774. }
  775. } else if (!is_multi_line()) {
  776. VERIFY_NOT_REACHED();
  777. }
  778. ArmedScopeGuard update_autocomplete { [&] {
  779. try_update_autocomplete();
  780. } };
  781. if (is_multi_line() && !event.alt() && event.ctrl() && event.key() == KeyCode::Key_Return) {
  782. if (!is_editable())
  783. return;
  784. size_t indent_length = current_line().leading_spaces();
  785. DeprecatedString indent = current_line().to_utf8().substring(0, indent_length);
  786. auto insert_pos = event.shift() ? InsertLineCommand::InsertPosition::Above : InsertLineCommand::InsertPosition::Below;
  787. execute<InsertLineCommand>(m_cursor, move(indent), insert_pos);
  788. return;
  789. }
  790. if (is_multi_line() && !event.shift() && !event.alt() && event.ctrl() && event.key() == KeyCode::Key_Space) {
  791. if (m_autocomplete_provider) {
  792. try_show_autocomplete(UserRequestedAutocomplete::Yes);
  793. update_autocomplete.disarm();
  794. return;
  795. }
  796. }
  797. if (is_multi_line() && !event.shift() && !event.alt() && event.ctrl() && event.key() == KeyCode::Key_F) {
  798. m_search_banner->show();
  799. return;
  800. }
  801. if (m_editing_engine->on_key(event))
  802. return;
  803. if (event.key() == KeyCode::Key_Escape) {
  804. if (on_escape_pressed)
  805. on_escape_pressed();
  806. return;
  807. }
  808. if (event.modifiers() == Mod_Shift && event.key() == KeyCode::Key_Delete) {
  809. if (m_autocomplete_box)
  810. hide_autocomplete();
  811. return;
  812. }
  813. if (event.key() == KeyCode::Key_Tab) {
  814. if (has_selection()) {
  815. if (event.modifiers() == Mod_Shift) {
  816. unindent_selection();
  817. return;
  818. }
  819. if (is_indenting_selection()) {
  820. indent_selection();
  821. return;
  822. }
  823. } else {
  824. if (event.modifiers() == Mod_Shift) {
  825. unindent_line();
  826. return;
  827. }
  828. }
  829. }
  830. if (event.key() == KeyCode::Key_Delete) {
  831. if (!is_editable())
  832. return;
  833. if (m_autocomplete_box)
  834. hide_autocomplete();
  835. if (has_selection()) {
  836. delete_selection();
  837. did_update_selection();
  838. return;
  839. }
  840. if (m_cursor.column() < current_line().length()) {
  841. // Delete within line
  842. int erase_count = 1;
  843. if (event.modifiers() == Mod_Ctrl) {
  844. auto word_break_pos = document().first_word_break_after(m_cursor);
  845. erase_count = word_break_pos.column() - m_cursor.column();
  846. }
  847. TextRange erased_range(m_cursor, { m_cursor.line(), m_cursor.column() + erase_count });
  848. execute<RemoveTextCommand>(document().text_in_range(erased_range), erased_range);
  849. return;
  850. }
  851. if (m_cursor.column() == current_line().length() && m_cursor.line() != line_count() - 1) {
  852. // Delete at end of line; merge with next line
  853. size_t erase_count = 0;
  854. if (event.modifiers() == Mod_Ctrl) {
  855. erase_count = document().first_word_break_after({ m_cursor.line() + 1, 0 }).column();
  856. }
  857. TextRange erased_range(m_cursor, { m_cursor.line() + 1, erase_count });
  858. execute<RemoveTextCommand>(document().text_in_range(erased_range), erased_range);
  859. return;
  860. }
  861. return;
  862. }
  863. if (event.key() == KeyCode::Key_Backspace) {
  864. if (!is_editable())
  865. return;
  866. if (m_autocomplete_box)
  867. hide_autocomplete();
  868. if (has_selection()) {
  869. delete_selection();
  870. did_update_selection();
  871. return;
  872. }
  873. if (m_cursor.column() > 0) {
  874. int erase_count = 1;
  875. if (event.modifiers() == Mod_Ctrl) {
  876. auto word_break_pos = document().first_word_break_before(m_cursor, true);
  877. erase_count = m_cursor.column() - word_break_pos.column();
  878. } else if (current_line().first_non_whitespace_column() >= m_cursor.column()) {
  879. int new_column;
  880. if (m_cursor.column() % m_soft_tab_width == 0)
  881. new_column = m_cursor.column() - m_soft_tab_width;
  882. else
  883. new_column = (m_cursor.column() / m_soft_tab_width) * m_soft_tab_width;
  884. erase_count = m_cursor.column() - new_column;
  885. }
  886. // Backspace within line
  887. TextRange erased_range({ m_cursor.line(), m_cursor.column() - erase_count }, m_cursor);
  888. auto erased_text = document().text_in_range(erased_range);
  889. execute<RemoveTextCommand>(erased_text, erased_range);
  890. return;
  891. }
  892. if (m_cursor.column() == 0 && m_cursor.line() != 0) {
  893. // Backspace at column 0; merge with previous line
  894. size_t previous_length = line(m_cursor.line() - 1).length();
  895. TextRange erased_range({ m_cursor.line() - 1, previous_length }, m_cursor);
  896. execute<RemoveTextCommand>("\n", erased_range);
  897. return;
  898. }
  899. return;
  900. }
  901. // AltGr is emulated as Ctrl+Alt; if Ctrl is set check if it's not for AltGr
  902. if ((!event.ctrl() || event.altgr()) && !event.alt() && event.code_point() != 0) {
  903. TemporaryChange change { m_should_keep_autocomplete_box, true };
  904. add_code_point(event.code_point());
  905. return;
  906. }
  907. if (event.ctrl() && event.key() == KeyCode::Key_Slash) {
  908. if (m_highlighter != nullptr) {
  909. auto prefix = m_highlighter->comment_prefix().value_or(""sv);
  910. auto suffix = m_highlighter->comment_suffix().value_or(""sv);
  911. auto range = has_selection() ? selection().normalized() : TextRange { { m_cursor.line(), m_cursor.column() }, { m_cursor.line(), m_cursor.column() } };
  912. auto is_already_commented = true;
  913. for (size_t i = range.start().line(); i <= range.end().line(); i++) {
  914. auto text = m_document->line(i).to_utf8().trim_whitespace();
  915. if (!(text.starts_with(prefix) && text.ends_with(suffix))) {
  916. is_already_commented = false;
  917. break;
  918. }
  919. }
  920. if (is_already_commented)
  921. execute<UncommentSelection>(prefix, suffix, range);
  922. else
  923. execute<CommentSelection>(prefix, suffix, range);
  924. return;
  925. }
  926. }
  927. event.ignore();
  928. }
  929. bool TextEditor::is_indenting_selection()
  930. {
  931. auto const selection_start = m_selection.start() > m_selection.end() ? m_selection.end() : m_selection.start();
  932. auto const selection_end = m_selection.end() > m_selection.start() ? m_selection.end() : m_selection.start();
  933. auto const whole_line_selected = selection_end.column() - selection_start.column() >= current_line().length() - current_line().first_non_whitespace_column();
  934. auto const on_same_line = selection_start.line() == selection_end.line();
  935. if (has_selection() && (whole_line_selected || !on_same_line)) {
  936. return true;
  937. }
  938. return false;
  939. }
  940. void TextEditor::indent_selection()
  941. {
  942. auto const selection_start = m_selection.start() > m_selection.end() ? m_selection.end() : m_selection.start();
  943. auto const selection_end = m_selection.end() > m_selection.start() ? m_selection.end() : m_selection.start();
  944. if (is_indenting_selection()) {
  945. execute<IndentSelection>(m_soft_tab_width, TextRange(selection_start, selection_end));
  946. m_selection.set_start({ selection_start.line(), selection_start.column() + m_soft_tab_width });
  947. m_selection.set_end({ selection_end.line(), selection_end.column() + m_soft_tab_width });
  948. set_cursor({ m_cursor.line(), m_cursor.column() + m_soft_tab_width });
  949. }
  950. }
  951. void TextEditor::unindent_selection()
  952. {
  953. auto const selection_start = m_selection.start() > m_selection.end() ? m_selection.end() : m_selection.start();
  954. auto const selection_end = m_selection.end() > m_selection.start() ? m_selection.end() : m_selection.start();
  955. if (current_line().first_non_whitespace_column() != 0) {
  956. if (current_line().first_non_whitespace_column() > m_soft_tab_width && selection_start.column() != 0) {
  957. m_selection.set_start({ selection_start.line(), selection_start.column() - m_soft_tab_width });
  958. m_selection.set_end({ selection_end.line(), selection_end.column() - m_soft_tab_width });
  959. } else if (selection_start.column() != 0) {
  960. m_selection.set_start({ selection_start.line(), selection_start.column() - current_line().leading_spaces() });
  961. m_selection.set_end({ selection_end.line(), selection_end.column() - current_line().leading_spaces() });
  962. }
  963. execute<UnindentSelection>(m_soft_tab_width, TextRange(selection_start, selection_end));
  964. }
  965. }
  966. void TextEditor::unindent_line()
  967. {
  968. if (current_line().first_non_whitespace_column() != 0) {
  969. auto const unindent_size = current_line().leading_spaces() < m_soft_tab_width ? current_line().leading_spaces() : m_soft_tab_width;
  970. auto const temp_column = m_cursor.column();
  971. execute<UnindentSelection>(unindent_size, TextRange({ m_cursor.line(), 0 }, { m_cursor.line(), line(m_cursor.line()).length() }));
  972. set_cursor({ m_cursor.line(), temp_column <= unindent_size ? 0 : temp_column - unindent_size });
  973. }
  974. }
  975. void TextEditor::delete_previous_word()
  976. {
  977. TextRange to_erase(document().first_word_before(m_cursor, true), m_cursor);
  978. execute<RemoveTextCommand>(document().text_in_range(to_erase), to_erase);
  979. }
  980. void TextEditor::delete_current_line()
  981. {
  982. if (has_selection())
  983. return delete_selection();
  984. TextPosition start;
  985. TextPosition end;
  986. if (m_cursor.line() == 0 && line_count() == 1) {
  987. start = { 0, 0 };
  988. end = { 0, line(0).length() };
  989. } else if (m_cursor.line() == line_count() - 1) {
  990. start = { m_cursor.line() - 1, line(m_cursor.line() - 1).length() };
  991. end = { m_cursor.line(), line(m_cursor.line()).length() };
  992. } else {
  993. start = { m_cursor.line(), 0 };
  994. end = { m_cursor.line() + 1, 0 };
  995. }
  996. TextRange erased_range(start, end);
  997. execute<RemoveTextCommand>(document().text_in_range(erased_range), erased_range);
  998. }
  999. void TextEditor::delete_previous_char()
  1000. {
  1001. if (!is_editable())
  1002. return;
  1003. if (has_selection())
  1004. return delete_selection();
  1005. TextRange to_erase({ m_cursor.line(), m_cursor.column() - 1 }, m_cursor);
  1006. if (m_cursor.column() == 0 && m_cursor.line() != 0) {
  1007. size_t prev_line_len = line(m_cursor.line() - 1).length();
  1008. to_erase.set_start({ m_cursor.line() - 1, prev_line_len });
  1009. }
  1010. execute<RemoveTextCommand>(document().text_in_range(to_erase), to_erase);
  1011. }
  1012. void TextEditor::delete_from_line_start_to_cursor()
  1013. {
  1014. TextPosition start(m_cursor.line(), current_line().first_non_whitespace_column());
  1015. TextRange to_erase(start, m_cursor);
  1016. execute<RemoveTextCommand>(document().text_in_range(to_erase), to_erase);
  1017. }
  1018. void TextEditor::do_delete()
  1019. {
  1020. if (!is_editable())
  1021. return;
  1022. if (has_selection())
  1023. return delete_selection();
  1024. if (m_cursor.column() < current_line().length()) {
  1025. // Delete within line
  1026. TextRange erased_range(m_cursor, { m_cursor.line(), m_cursor.column() + 1 });
  1027. execute<RemoveTextCommand>(document().text_in_range(erased_range), erased_range);
  1028. return;
  1029. }
  1030. if (m_cursor.column() == current_line().length() && m_cursor.line() != line_count() - 1) {
  1031. // Delete at end of line; merge with next line
  1032. TextRange erased_range(m_cursor, { m_cursor.line() + 1, 0 });
  1033. execute<RemoveTextCommand>(document().text_in_range(erased_range), erased_range);
  1034. return;
  1035. }
  1036. }
  1037. void TextEditor::add_code_point(u32 code_point)
  1038. {
  1039. if (!is_editable())
  1040. return;
  1041. StringBuilder sb;
  1042. sb.append_code_point(code_point);
  1043. if (should_autocomplete_automatically()) {
  1044. if (sb.string_view().is_whitespace())
  1045. m_autocomplete_timer->stop();
  1046. else
  1047. m_autocomplete_timer->start();
  1048. }
  1049. insert_at_cursor_or_replace_selection(sb.to_deprecated_string());
  1050. };
  1051. void TextEditor::reset_cursor_blink()
  1052. {
  1053. m_cursor_state = true;
  1054. update_cursor();
  1055. stop_timer();
  1056. start_timer(500);
  1057. }
  1058. void TextEditor::update_selection(bool is_selecting)
  1059. {
  1060. if (is_selecting && !selection().is_valid()) {
  1061. selection().set(cursor(), {});
  1062. did_update_selection();
  1063. update();
  1064. return;
  1065. }
  1066. if (!is_selecting && selection().is_valid()) {
  1067. selection().clear();
  1068. did_update_selection();
  1069. update();
  1070. return;
  1071. }
  1072. if (is_selecting && selection().start().is_valid()) {
  1073. selection().set_end(cursor());
  1074. did_update_selection();
  1075. update();
  1076. return;
  1077. }
  1078. }
  1079. int TextEditor::content_x_for_position(TextPosition const& position) const
  1080. {
  1081. auto& line = this->line(position.line());
  1082. int x_offset = 0;
  1083. switch (m_text_alignment) {
  1084. case Gfx::TextAlignment::CenterLeft:
  1085. for_each_visual_line(position.line(), [&](Gfx::IntRect const&, auto& visual_line_view, size_t start_of_visual_line, bool is_last_visual_line) {
  1086. size_t offset_in_visual_line = position.column() - start_of_visual_line;
  1087. auto before_line_end = is_last_visual_line ? (offset_in_visual_line <= visual_line_view.length()) : (offset_in_visual_line < visual_line_view.length());
  1088. if (position.column() >= start_of_visual_line && before_line_end) {
  1089. if (offset_in_visual_line == 0) {
  1090. x_offset = 0;
  1091. } else {
  1092. x_offset = text_width_for_font(visual_line_view.substring_view(0, offset_in_visual_line), font());
  1093. x_offset += font().glyph_spacing();
  1094. }
  1095. return IterationDecision::Break;
  1096. }
  1097. return IterationDecision::Continue;
  1098. });
  1099. return m_horizontal_content_padding + ((is_single_line() && icon()) ? (icon_size() + icon_padding()) : 0) + x_offset;
  1100. case Gfx::TextAlignment::CenterRight:
  1101. // FIXME
  1102. VERIFY(!is_wrapping_enabled());
  1103. return content_width() - m_horizontal_content_padding - (line.length() * fixed_glyph_width()) + (position.column() * fixed_glyph_width());
  1104. default:
  1105. VERIFY_NOT_REACHED();
  1106. }
  1107. }
  1108. int TextEditor::text_width_for_font(auto const& text, Gfx::Font const& font) const
  1109. {
  1110. if (m_substitution_code_point.has_value())
  1111. return font.width(substitution_code_point_view(text.length()));
  1112. else
  1113. return font.width(text);
  1114. }
  1115. Utf32View TextEditor::substitution_code_point_view(size_t length) const
  1116. {
  1117. VERIFY(m_substitution_code_point.has_value());
  1118. if (!m_substitution_string_data)
  1119. m_substitution_string_data = make<Vector<u32>>();
  1120. if (!m_substitution_string_data->is_empty())
  1121. VERIFY(m_substitution_string_data->first() == m_substitution_code_point);
  1122. while (m_substitution_string_data->size() < length)
  1123. m_substitution_string_data->append(m_substitution_code_point.value());
  1124. return Utf32View { m_substitution_string_data->data(), length };
  1125. }
  1126. Gfx::IntRect TextEditor::content_rect_for_position(TextPosition const& position) const
  1127. {
  1128. if (!position.is_valid())
  1129. return {};
  1130. VERIFY(!lines().is_empty());
  1131. VERIFY(position.column() <= (current_line().length() + 1));
  1132. int x = content_x_for_position(position);
  1133. if (is_single_line()) {
  1134. Gfx::IntRect rect { x, 0, 1, line_height() };
  1135. rect.center_vertically_within({ {}, frame_inner_rect().size() });
  1136. return rect;
  1137. }
  1138. Gfx::IntRect rect;
  1139. for_each_visual_line(position.line(), [&](Gfx::IntRect const& visual_line_rect, auto& view, size_t start_of_visual_line, bool is_last_visual_line) {
  1140. auto before_line_end = is_last_visual_line ? ((position.column() - start_of_visual_line) <= view.length()) : ((position.column() - start_of_visual_line) < view.length());
  1141. if (position.column() >= start_of_visual_line && before_line_end) {
  1142. // NOTE: We have to subtract the horizontal padding here since it's part of the visual line rect
  1143. // *and* included in what we get from content_x_for_position().
  1144. rect = {
  1145. visual_line_rect.x() + x - (m_horizontal_content_padding),
  1146. visual_line_rect.y(),
  1147. m_editing_engine->cursor_width() == CursorWidth::WIDE ? 7 : 1,
  1148. line_height()
  1149. };
  1150. return IterationDecision::Break;
  1151. }
  1152. return IterationDecision::Continue;
  1153. });
  1154. return rect;
  1155. }
  1156. Gfx::IntRect TextEditor::cursor_content_rect() const
  1157. {
  1158. return content_rect_for_position(m_cursor);
  1159. }
  1160. Gfx::IntRect TextEditor::line_widget_rect(size_t line_index) const
  1161. {
  1162. auto rect = line_content_rect(line_index);
  1163. rect.set_x(frame_thickness());
  1164. rect.set_width(frame_inner_rect().width());
  1165. rect.translate_by(0, -(vertical_scrollbar().value()));
  1166. rect.translate_by(0, frame_thickness());
  1167. rect.translate_by(0, height_occupied_by_banner_widget());
  1168. rect.intersect(frame_inner_rect());
  1169. return rect;
  1170. }
  1171. void TextEditor::scroll_position_into_view(TextPosition const& position)
  1172. {
  1173. auto rect = content_rect_for_position(position);
  1174. if (position.column() == 0)
  1175. rect.set_x(content_x_for_position({ position.line(), 0 }) - 2);
  1176. else if (position.column() == line(position.line()).length())
  1177. rect.set_x(content_x_for_position({ position.line(), line(position.line()).length() }) + 2);
  1178. scroll_into_view(rect, true, true);
  1179. }
  1180. void TextEditor::scroll_cursor_into_view()
  1181. {
  1182. if (!m_reflow_deferred)
  1183. scroll_position_into_view(m_cursor);
  1184. }
  1185. Gfx::IntRect TextEditor::line_content_rect(size_t line_index) const
  1186. {
  1187. auto& line = this->line(line_index);
  1188. if (is_single_line()) {
  1189. Gfx::IntRect line_rect = { content_x_for_position({ line_index, 0 }), 0, text_width_for_font(line.view(), font()), font().glyph_height() + 4 };
  1190. line_rect.center_vertically_within({ {}, frame_inner_rect().size() });
  1191. return line_rect;
  1192. }
  1193. if (is_wrapping_enabled())
  1194. return m_line_visual_data[line_index].visual_rect;
  1195. return {
  1196. content_x_for_position({ line_index, 0 }),
  1197. (int)line_index * line_height(),
  1198. text_width_for_font(line.view(), font()),
  1199. line_height()
  1200. };
  1201. }
  1202. void TextEditor::set_cursor_and_focus_line(size_t line, size_t column)
  1203. {
  1204. u_int index_max = line_count() - 1;
  1205. set_cursor(line, column);
  1206. if (line > 1 && line < index_max) {
  1207. int headroom = frame_inner_rect().height() / 3;
  1208. do {
  1209. auto line_data = m_line_visual_data[line];
  1210. headroom -= line_data.visual_rect.height();
  1211. line--;
  1212. } while (line > 0 && headroom > 0);
  1213. Gfx::IntRect rect = { 0, line_content_rect(line).y(),
  1214. 1, frame_inner_rect().height() };
  1215. scroll_into_view(rect, false, true);
  1216. }
  1217. }
  1218. void TextEditor::update_cursor()
  1219. {
  1220. update(line_widget_rect(m_cursor.line()));
  1221. }
  1222. void TextEditor::set_cursor(size_t line, size_t column)
  1223. {
  1224. set_cursor({ line, column });
  1225. }
  1226. void TextEditor::set_cursor(TextPosition const& a_position)
  1227. {
  1228. VERIFY(!lines().is_empty());
  1229. TextPosition position = a_position;
  1230. if (position.line() >= line_count())
  1231. position.set_line(line_count() - 1);
  1232. if (position.column() > lines()[position.line()].length())
  1233. position.set_column(lines()[position.line()].length());
  1234. if (m_cursor != position && is_visual_data_up_to_date()) {
  1235. // NOTE: If the old cursor is no longer valid, repaint everything just in case.
  1236. auto old_cursor_line_rect = m_cursor.line() < line_count()
  1237. ? line_widget_rect(m_cursor.line())
  1238. : rect();
  1239. m_cursor = position;
  1240. m_cursor_state = true;
  1241. scroll_cursor_into_view();
  1242. update(old_cursor_line_rect);
  1243. update_cursor();
  1244. } else if (m_cursor != position) {
  1245. m_cursor = position;
  1246. m_cursor_state = true;
  1247. }
  1248. cursor_did_change();
  1249. if (on_cursor_change)
  1250. on_cursor_change();
  1251. if (m_highlighter)
  1252. m_highlighter->cursor_did_change();
  1253. if (m_relative_line_number)
  1254. update();
  1255. }
  1256. void TextEditor::focusin_event(FocusEvent& event)
  1257. {
  1258. if (event.source() == FocusSource::Keyboard)
  1259. select_all();
  1260. m_cursor_state = true;
  1261. update_cursor();
  1262. stop_timer();
  1263. start_timer(500);
  1264. if (on_focusin)
  1265. on_focusin();
  1266. }
  1267. void TextEditor::focusout_event(FocusEvent&)
  1268. {
  1269. if (is_displayonly() && has_selection())
  1270. m_selection.clear();
  1271. stop_timer();
  1272. if (on_focusout)
  1273. on_focusout();
  1274. }
  1275. void TextEditor::timer_event(Core::TimerEvent&)
  1276. {
  1277. m_cursor_state = !m_cursor_state;
  1278. if (is_focused())
  1279. update_cursor();
  1280. }
  1281. bool TextEditor::write_to_file(DeprecatedString const& path)
  1282. {
  1283. auto file = Core::File::construct(path);
  1284. if (!file->open(Core::OpenMode::WriteOnly | Core::OpenMode::Truncate)) {
  1285. warnln("Error opening {}: {}", path, strerror(file->error()));
  1286. return false;
  1287. }
  1288. return write_to_file(*file);
  1289. }
  1290. bool TextEditor::write_to_file(Core::File& file)
  1291. {
  1292. off_t file_size = 0;
  1293. if (line_count() == 1 && line(0).is_empty()) {
  1294. // Truncate to zero.
  1295. } else {
  1296. // Compute the final file size and ftruncate() to make writing fast.
  1297. // FIXME: Remove this once the kernel is smart enough to do this instead.
  1298. for (size_t i = 0; i < line_count(); ++i)
  1299. file_size += line(i).length();
  1300. file_size += line_count();
  1301. }
  1302. if (!file.truncate(file_size)) {
  1303. perror("ftruncate");
  1304. return false;
  1305. }
  1306. if (file_size == 0) {
  1307. // A size 0 file doesn't need a data copy.
  1308. } else {
  1309. for (size_t i = 0; i < line_count(); ++i) {
  1310. auto& line = this->line(i);
  1311. if (line.length()) {
  1312. auto line_as_utf8 = line.to_utf8();
  1313. ssize_t nwritten = file.write(line_as_utf8);
  1314. if (nwritten < 0) {
  1315. perror("write");
  1316. return false;
  1317. }
  1318. }
  1319. char ch = '\n';
  1320. ssize_t nwritten = file.write((u8*)&ch, 1);
  1321. if (nwritten != 1) {
  1322. perror("write");
  1323. return false;
  1324. }
  1325. }
  1326. }
  1327. document().set_unmodified();
  1328. return true;
  1329. }
  1330. DeprecatedString TextEditor::text() const
  1331. {
  1332. return document().text();
  1333. }
  1334. void TextEditor::clear()
  1335. {
  1336. document().remove_all_lines();
  1337. document().append_line(make<TextDocumentLine>(document()));
  1338. m_selection.clear();
  1339. did_update_selection();
  1340. set_cursor(0, 0);
  1341. update();
  1342. }
  1343. DeprecatedString TextEditor::selected_text() const
  1344. {
  1345. if (!has_selection())
  1346. return {};
  1347. return document().text_in_range(m_selection);
  1348. }
  1349. size_t TextEditor::number_of_selected_words() const
  1350. {
  1351. if (!has_selection())
  1352. return 0;
  1353. size_t word_count = 0;
  1354. bool in_word = false;
  1355. auto selected_text = this->selected_text();
  1356. for (char c : selected_text) {
  1357. if (in_word && is_ascii_space(c)) {
  1358. in_word = false;
  1359. word_count++;
  1360. continue;
  1361. }
  1362. if (!in_word && !is_ascii_space(c))
  1363. in_word = true;
  1364. }
  1365. if (in_word)
  1366. word_count++;
  1367. return word_count;
  1368. }
  1369. size_t TextEditor::number_of_words() const
  1370. {
  1371. if (document().is_empty())
  1372. return 0;
  1373. size_t word_count = 0;
  1374. bool in_word = false;
  1375. auto text = this->text();
  1376. for (char c : text) {
  1377. if (in_word && is_ascii_space(c)) {
  1378. in_word = false;
  1379. word_count++;
  1380. continue;
  1381. }
  1382. if (!in_word && !is_ascii_space(c))
  1383. in_word = true;
  1384. }
  1385. if (in_word)
  1386. word_count++;
  1387. return word_count;
  1388. }
  1389. void TextEditor::delete_selection()
  1390. {
  1391. auto selection = normalized_selection();
  1392. auto selected = selected_text();
  1393. m_selection.clear();
  1394. execute<RemoveTextCommand>(selected, selection);
  1395. did_update_selection();
  1396. did_change();
  1397. set_cursor(selection.start());
  1398. update();
  1399. }
  1400. void TextEditor::delete_text_range(TextRange range)
  1401. {
  1402. auto normalized_range = range.normalized();
  1403. execute<RemoveTextCommand>(document().text_in_range(normalized_range), normalized_range);
  1404. did_change();
  1405. set_cursor(normalized_range.start());
  1406. update();
  1407. }
  1408. void TextEditor::insert_at_cursor_or_replace_selection(StringView text)
  1409. {
  1410. ReflowDeferrer defer(*this);
  1411. VERIFY(is_editable());
  1412. if (has_selection())
  1413. delete_selection();
  1414. // Check if adding a newline leaves the previous line as just whitespace.
  1415. auto const clear_length = m_cursor.column();
  1416. auto const should_clear_last_line = text == "\n"
  1417. && clear_length > 0
  1418. && current_line().leading_spaces() == clear_length;
  1419. execute<InsertTextCommand>(text, m_cursor);
  1420. if (should_clear_last_line) { // If it does leave just whitespace, clear it.
  1421. auto const original_cursor_position = cursor();
  1422. TextPosition start(original_cursor_position.line() - 1, 0);
  1423. TextPosition end(original_cursor_position.line() - 1, clear_length);
  1424. TextRange erased_range(start, end);
  1425. execute<RemoveTextCommand>(document().text_in_range(erased_range), erased_range);
  1426. set_cursor(original_cursor_position);
  1427. }
  1428. }
  1429. void TextEditor::replace_all_text_without_resetting_undo_stack(StringView text)
  1430. {
  1431. auto start = GUI::TextPosition(0, 0);
  1432. auto last_line_index = line_count() - 1;
  1433. auto end = GUI::TextPosition(last_line_index, line(last_line_index).length());
  1434. auto range = GUI::TextRange(start, end);
  1435. auto normalized_range = range.normalized();
  1436. execute<ReplaceAllTextCommand>(text, range, "GML Playground Format Text");
  1437. did_change();
  1438. set_cursor(normalized_range.start());
  1439. update();
  1440. }
  1441. void TextEditor::cut()
  1442. {
  1443. if (!is_editable())
  1444. return;
  1445. auto selected_text = this->selected_text();
  1446. dbgln_if(TEXTEDITOR_DEBUG, "Cut: \"{}\"", selected_text);
  1447. Clipboard::the().set_plain_text(selected_text);
  1448. delete_selection();
  1449. }
  1450. void TextEditor::copy()
  1451. {
  1452. auto selected_text = this->selected_text();
  1453. dbgln_if(TEXTEDITOR_DEBUG, "Copy: \"{}\"\n", selected_text);
  1454. Clipboard::the().set_plain_text(selected_text);
  1455. }
  1456. void TextEditor::paste()
  1457. {
  1458. if (!is_editable())
  1459. return;
  1460. auto [data, mime_type, _] = GUI::Clipboard::the().fetch_data_and_type();
  1461. if (!mime_type.starts_with("text/"sv))
  1462. return;
  1463. if (data.is_empty())
  1464. return;
  1465. dbgln_if(TEXTEDITOR_DEBUG, "Paste: \"{}\"", DeprecatedString::copy(data));
  1466. TemporaryChange change(m_automatic_indentation_enabled, false);
  1467. insert_at_cursor_or_replace_selection(data);
  1468. }
  1469. void TextEditor::defer_reflow()
  1470. {
  1471. ++m_reflow_deferred;
  1472. }
  1473. void TextEditor::undefer_reflow()
  1474. {
  1475. VERIFY(m_reflow_deferred);
  1476. if (!--m_reflow_deferred) {
  1477. if (m_reflow_requested) {
  1478. recompute_all_visual_lines();
  1479. scroll_cursor_into_view();
  1480. }
  1481. }
  1482. }
  1483. void TextEditor::try_show_autocomplete(UserRequestedAutocomplete user_requested_autocomplete)
  1484. {
  1485. force_update_autocomplete([&, user_requested_autocomplete = move(user_requested_autocomplete)] {
  1486. if (user_requested_autocomplete == Yes || m_autocomplete_box->has_suggestions()) {
  1487. auto position = content_rect_for_position(cursor()).translated(0, -visible_content_rect().y()).bottom_right().translated(screen_relative_rect().top_left().translated(ruler_width(), 0).translated(10, 5));
  1488. m_autocomplete_box->show(position);
  1489. }
  1490. });
  1491. }
  1492. void TextEditor::try_update_autocomplete(Function<void()> callback)
  1493. {
  1494. if (m_autocomplete_box && m_autocomplete_box->is_visible())
  1495. force_update_autocomplete(move(callback));
  1496. }
  1497. void TextEditor::force_update_autocomplete(Function<void()> callback)
  1498. {
  1499. if (m_autocomplete_provider) {
  1500. m_autocomplete_provider->provide_completions([&, callback = move(callback)](auto completions) {
  1501. m_autocomplete_box->update_suggestions(move(completions));
  1502. if (callback)
  1503. callback();
  1504. });
  1505. }
  1506. }
  1507. void TextEditor::hide_autocomplete_if_needed()
  1508. {
  1509. if (!m_should_keep_autocomplete_box)
  1510. hide_autocomplete();
  1511. }
  1512. void TextEditor::hide_autocomplete()
  1513. {
  1514. if (m_autocomplete_box) {
  1515. m_autocomplete_box->close();
  1516. if (m_autocomplete_timer)
  1517. m_autocomplete_timer->stop();
  1518. }
  1519. }
  1520. void TextEditor::enter_event(Core::Event&)
  1521. {
  1522. m_automatic_selection_scroll_timer->stop();
  1523. }
  1524. void TextEditor::leave_event(Core::Event&)
  1525. {
  1526. if (m_in_drag_select)
  1527. m_automatic_selection_scroll_timer->start();
  1528. }
  1529. void TextEditor::did_change(AllowCallback allow_callback)
  1530. {
  1531. update_content_size();
  1532. recompute_all_visual_lines();
  1533. hide_autocomplete_if_needed();
  1534. m_needs_rehighlight = true;
  1535. if (on_change && allow_callback == AllowCallback::Yes)
  1536. on_change();
  1537. }
  1538. void TextEditor::set_mode(const Mode mode)
  1539. {
  1540. if (m_mode == mode)
  1541. return;
  1542. m_mode = mode;
  1543. switch (mode) {
  1544. case Editable:
  1545. m_cut_action->set_enabled(has_selection() && !text_is_secret());
  1546. m_paste_action->set_enabled(true);
  1547. m_insert_emoji_action->set_enabled(true);
  1548. break;
  1549. case DisplayOnly:
  1550. case ReadOnly:
  1551. m_cut_action->set_enabled(false);
  1552. m_paste_action->set_enabled(false);
  1553. m_insert_emoji_action->set_enabled(false);
  1554. break;
  1555. default:
  1556. VERIFY_NOT_REACHED();
  1557. }
  1558. set_or_clear_emoji_input_callback();
  1559. set_editing_cursor();
  1560. }
  1561. void TextEditor::set_editing_cursor()
  1562. {
  1563. if (!is_displayonly())
  1564. set_override_cursor(Gfx::StandardCursor::IBeam);
  1565. else
  1566. set_override_cursor(Gfx::StandardCursor::None);
  1567. }
  1568. void TextEditor::did_update_selection()
  1569. {
  1570. m_cut_action->set_enabled(is_editable() && has_selection() && !text_is_secret());
  1571. m_copy_action->set_enabled(has_selection() && !text_is_secret());
  1572. if (on_selection_change)
  1573. on_selection_change();
  1574. if (is_wrapping_enabled()) {
  1575. // FIXME: Try to repaint less.
  1576. update();
  1577. }
  1578. }
  1579. void TextEditor::context_menu_event(ContextMenuEvent& event)
  1580. {
  1581. if (is_displayonly())
  1582. return;
  1583. m_insert_emoji_action->set_enabled(on_emoji_input && !window()->blocks_emoji_input());
  1584. if (!m_context_menu) {
  1585. m_context_menu = Menu::construct();
  1586. m_context_menu->add_action(undo_action());
  1587. m_context_menu->add_action(redo_action());
  1588. m_context_menu->add_separator();
  1589. m_context_menu->add_action(cut_action());
  1590. m_context_menu->add_action(copy_action());
  1591. m_context_menu->add_action(paste_action());
  1592. m_context_menu->add_separator();
  1593. m_context_menu->add_action(select_all_action());
  1594. m_context_menu->add_action(insert_emoji_action());
  1595. if (is_multi_line()) {
  1596. m_context_menu->add_separator();
  1597. m_context_menu->add_action(go_to_line_action());
  1598. }
  1599. if (!m_custom_context_menu_actions.is_empty()) {
  1600. m_context_menu->add_separator();
  1601. for (auto& action : m_custom_context_menu_actions) {
  1602. m_context_menu->add_action(action);
  1603. }
  1604. }
  1605. }
  1606. m_context_menu->popup(event.screen_position());
  1607. }
  1608. void TextEditor::set_text_alignment(Gfx::TextAlignment alignment)
  1609. {
  1610. if (m_text_alignment == alignment)
  1611. return;
  1612. m_text_alignment = alignment;
  1613. update();
  1614. }
  1615. void TextEditor::resize_event(ResizeEvent& event)
  1616. {
  1617. AbstractScrollableWidget::resize_event(event);
  1618. update_content_size();
  1619. recompute_all_visual_lines();
  1620. }
  1621. void TextEditor::theme_change_event(ThemeChangeEvent& event)
  1622. {
  1623. AbstractScrollableWidget::theme_change_event(event);
  1624. m_needs_rehighlight = true;
  1625. }
  1626. void TextEditor::set_selection(TextRange const& selection)
  1627. {
  1628. if (m_selection == selection)
  1629. return;
  1630. m_selection = selection;
  1631. set_cursor(m_selection.end());
  1632. scroll_position_into_view(normalized_selection().start());
  1633. update();
  1634. }
  1635. void TextEditor::clear_selection()
  1636. {
  1637. if (!has_selection())
  1638. return;
  1639. m_selection.clear();
  1640. update();
  1641. }
  1642. void TextEditor::recompute_all_visual_lines()
  1643. {
  1644. if (m_reflow_deferred) {
  1645. m_reflow_requested = true;
  1646. return;
  1647. }
  1648. m_reflow_requested = false;
  1649. int y_offset = 0;
  1650. for (size_t line_index = 0; line_index < line_count(); ++line_index) {
  1651. recompute_visual_lines(line_index);
  1652. m_line_visual_data[line_index].visual_rect.set_y(y_offset);
  1653. y_offset += m_line_visual_data[line_index].visual_rect.height();
  1654. }
  1655. update_content_size();
  1656. }
  1657. void TextEditor::ensure_cursor_is_valid()
  1658. {
  1659. auto new_cursor = m_cursor;
  1660. if (new_cursor.line() >= line_count())
  1661. new_cursor.set_line(line_count() - 1);
  1662. if (new_cursor.column() > line(new_cursor.line()).length())
  1663. new_cursor.set_column(line(new_cursor.line()).length());
  1664. if (m_cursor != new_cursor)
  1665. set_cursor(new_cursor);
  1666. }
  1667. size_t TextEditor::visual_line_containing(size_t line_index, size_t column) const
  1668. {
  1669. size_t visual_line_index = 0;
  1670. for_each_visual_line(line_index, [&](Gfx::IntRect const&, auto& view, size_t start_of_visual_line, [[maybe_unused]] bool is_last_visual_line) {
  1671. if (column >= start_of_visual_line && ((column - start_of_visual_line) < view.length()))
  1672. return IterationDecision::Break;
  1673. ++visual_line_index;
  1674. return IterationDecision::Continue;
  1675. });
  1676. return visual_line_index;
  1677. }
  1678. void TextEditor::recompute_visual_lines(size_t line_index)
  1679. {
  1680. auto& line = document().line(line_index);
  1681. auto& visual_data = m_line_visual_data[line_index];
  1682. visual_data.visual_line_breaks.clear_with_capacity();
  1683. int available_width = visible_text_rect_in_inner_coordinates().width();
  1684. if (is_wrapping_enabled()) {
  1685. int line_width_so_far = 0;
  1686. size_t last_whitespace_index = 0;
  1687. size_t line_width_since_last_whitespace = 0;
  1688. auto glyph_spacing = font().glyph_spacing();
  1689. for (size_t i = 0; i < line.length(); ++i) {
  1690. auto code_point = line.code_points()[i];
  1691. if (is_ascii_space(code_point)) {
  1692. last_whitespace_index = i;
  1693. line_width_since_last_whitespace = 0;
  1694. }
  1695. auto glyph_width = font().glyph_or_emoji_width(code_point);
  1696. line_width_since_last_whitespace += glyph_width + glyph_spacing;
  1697. if ((line_width_so_far + glyph_width + glyph_spacing) > available_width) {
  1698. if (m_wrapping_mode == WrappingMode::WrapAtWords && last_whitespace_index != 0) {
  1699. // Plus 1 to get the first letter of the word.
  1700. visual_data.visual_line_breaks.append(last_whitespace_index + 1);
  1701. line_width_so_far = line_width_since_last_whitespace;
  1702. last_whitespace_index = 0;
  1703. line_width_since_last_whitespace = 0;
  1704. } else {
  1705. visual_data.visual_line_breaks.append(i);
  1706. line_width_so_far = glyph_width + glyph_spacing;
  1707. }
  1708. continue;
  1709. }
  1710. line_width_so_far += glyph_width + glyph_spacing;
  1711. }
  1712. }
  1713. visual_data.visual_line_breaks.append(line.length());
  1714. if (is_wrapping_enabled())
  1715. visual_data.visual_rect = { m_horizontal_content_padding, 0, available_width, static_cast<int>(visual_data.visual_line_breaks.size()) * line_height() };
  1716. else
  1717. visual_data.visual_rect = { m_horizontal_content_padding, 0, text_width_for_font(line.view(), font()), line_height() };
  1718. }
  1719. template<typename Callback>
  1720. void TextEditor::for_each_visual_line(size_t line_index, Callback callback) const
  1721. {
  1722. auto editor_visible_text_rect = visible_text_rect_in_inner_coordinates();
  1723. size_t start_of_line = 0;
  1724. size_t visual_line_index = 0;
  1725. auto& line = document().line(line_index);
  1726. auto& visual_data = m_line_visual_data[line_index];
  1727. for (auto visual_line_break : visual_data.visual_line_breaks) {
  1728. auto visual_line_view = Utf32View(line.code_points() + start_of_line, visual_line_break - start_of_line);
  1729. Gfx::IntRect visual_line_rect {
  1730. visual_data.visual_rect.x(),
  1731. visual_data.visual_rect.y() + ((int)visual_line_index * line_height()),
  1732. text_width_for_font(visual_line_view, font()) + font().glyph_spacing(),
  1733. line_height()
  1734. };
  1735. if (is_right_text_alignment(text_alignment()))
  1736. visual_line_rect.set_right_without_resize(editor_visible_text_rect.right());
  1737. if (is_single_line()) {
  1738. visual_line_rect.center_vertically_within(editor_visible_text_rect);
  1739. if (m_icon)
  1740. visual_line_rect.translate_by(icon_size() + icon_padding(), 0);
  1741. }
  1742. if (callback(visual_line_rect, visual_line_view, start_of_line, visual_line_index == visual_data.visual_line_breaks.size() - 1) == IterationDecision::Break)
  1743. break;
  1744. start_of_line = visual_line_break;
  1745. ++visual_line_index;
  1746. }
  1747. }
  1748. void TextEditor::set_wrapping_mode(WrappingMode mode)
  1749. {
  1750. if (m_wrapping_mode == mode)
  1751. return;
  1752. m_wrapping_mode = mode;
  1753. horizontal_scrollbar().set_visible(m_wrapping_mode == WrappingMode::NoWrap);
  1754. update_content_size();
  1755. recompute_all_visual_lines();
  1756. update();
  1757. }
  1758. void TextEditor::add_custom_context_menu_action(Action& action)
  1759. {
  1760. m_custom_context_menu_actions.append(action);
  1761. }
  1762. void TextEditor::did_change_font()
  1763. {
  1764. vertical_scrollbar().set_step(line_height());
  1765. recompute_all_visual_lines();
  1766. update();
  1767. AbstractScrollableWidget::did_change_font();
  1768. }
  1769. void TextEditor::document_did_append_line()
  1770. {
  1771. m_line_visual_data.append(make<LineVisualData>());
  1772. recompute_all_visual_lines();
  1773. update();
  1774. }
  1775. void TextEditor::document_did_remove_line(size_t line_index)
  1776. {
  1777. m_line_visual_data.remove(line_index);
  1778. recompute_all_visual_lines();
  1779. update();
  1780. }
  1781. void TextEditor::document_did_remove_all_lines()
  1782. {
  1783. m_line_visual_data.clear();
  1784. recompute_all_visual_lines();
  1785. update();
  1786. }
  1787. void TextEditor::document_did_insert_line(size_t line_index)
  1788. {
  1789. m_line_visual_data.insert(line_index, make<LineVisualData>());
  1790. recompute_all_visual_lines();
  1791. update();
  1792. }
  1793. void TextEditor::document_did_change(AllowCallback allow_callback)
  1794. {
  1795. did_change(allow_callback);
  1796. update();
  1797. }
  1798. void TextEditor::document_did_update_undo_stack()
  1799. {
  1800. auto make_action_text = [](auto prefix, auto suffix) {
  1801. StringBuilder builder;
  1802. builder.append(prefix);
  1803. if (suffix.has_value()) {
  1804. builder.append(' ');
  1805. builder.append(suffix.value());
  1806. }
  1807. return builder.to_deprecated_string();
  1808. };
  1809. m_undo_action->set_enabled(can_undo() && !text_is_secret());
  1810. m_redo_action->set_enabled(can_redo() && !text_is_secret());
  1811. m_undo_action->set_text(make_action_text("&Undo"sv, document().undo_stack().undo_action_text()));
  1812. m_redo_action->set_text(make_action_text("&Redo"sv, document().undo_stack().redo_action_text()));
  1813. // FIXME: This is currently firing more often than it should.
  1814. // Ideally we'd only send this out when the undo stack modified state actually changes.
  1815. if (on_modified_change)
  1816. on_modified_change(document().is_modified());
  1817. }
  1818. void TextEditor::document_did_set_text(AllowCallback allow_callback)
  1819. {
  1820. m_line_visual_data.clear();
  1821. for (size_t i = 0; i < m_document->line_count(); ++i)
  1822. m_line_visual_data.append(make<LineVisualData>());
  1823. document_did_change(allow_callback);
  1824. }
  1825. void TextEditor::document_did_set_cursor(TextPosition const& position)
  1826. {
  1827. set_cursor(position);
  1828. }
  1829. void TextEditor::cursor_did_change()
  1830. {
  1831. hide_autocomplete_if_needed();
  1832. }
  1833. void TextEditor::clipboard_content_did_change(DeprecatedString const& mime_type)
  1834. {
  1835. m_paste_action->set_enabled(is_editable() && mime_type.starts_with("text/"sv));
  1836. }
  1837. void TextEditor::set_document(TextDocument& document)
  1838. {
  1839. if (m_document.ptr() == &document)
  1840. return;
  1841. if (m_document)
  1842. m_document->unregister_client(*this);
  1843. m_document = document;
  1844. m_line_visual_data.clear();
  1845. for (size_t i = 0; i < m_document->line_count(); ++i) {
  1846. m_line_visual_data.append(make<LineVisualData>());
  1847. }
  1848. set_cursor(0, 0);
  1849. if (has_selection())
  1850. m_selection.clear();
  1851. recompute_all_visual_lines();
  1852. update();
  1853. m_document->register_client(*this);
  1854. }
  1855. void TextEditor::rehighlight_if_needed()
  1856. {
  1857. if (!m_needs_rehighlight)
  1858. return;
  1859. force_rehighlight();
  1860. }
  1861. void TextEditor::force_rehighlight()
  1862. {
  1863. if (m_highlighter)
  1864. m_highlighter->rehighlight(palette());
  1865. m_needs_rehighlight = false;
  1866. }
  1867. Syntax::Highlighter const* TextEditor::syntax_highlighter() const
  1868. {
  1869. return m_highlighter.ptr();
  1870. }
  1871. Syntax::Highlighter* TextEditor::syntax_highlighter()
  1872. {
  1873. return m_highlighter.ptr();
  1874. }
  1875. void TextEditor::set_syntax_highlighter(OwnPtr<Syntax::Highlighter> highlighter)
  1876. {
  1877. if (m_highlighter)
  1878. m_highlighter->detach();
  1879. m_highlighter = move(highlighter);
  1880. if (m_highlighter) {
  1881. m_highlighter->attach(*this);
  1882. m_needs_rehighlight = true;
  1883. } else
  1884. document().set_spans(Syntax::HighlighterClient::span_collection_index, {});
  1885. if (on_highlighter_change)
  1886. on_highlighter_change();
  1887. }
  1888. AutocompleteProvider const* TextEditor::autocomplete_provider() const
  1889. {
  1890. return m_autocomplete_provider.ptr();
  1891. }
  1892. void TextEditor::set_autocomplete_provider(OwnPtr<AutocompleteProvider>&& provider)
  1893. {
  1894. if (m_autocomplete_provider)
  1895. m_autocomplete_provider->detach();
  1896. m_autocomplete_provider = move(provider);
  1897. if (m_autocomplete_provider) {
  1898. m_autocomplete_provider->attach(*this);
  1899. if (!m_autocomplete_box)
  1900. m_autocomplete_box = make<AutocompleteBox>(*this);
  1901. }
  1902. if (m_autocomplete_box)
  1903. hide_autocomplete();
  1904. }
  1905. EditingEngine const* TextEditor::editing_engine() const
  1906. {
  1907. return m_editing_engine.ptr();
  1908. }
  1909. void TextEditor::set_editing_engine(OwnPtr<EditingEngine> editing_engine)
  1910. {
  1911. if (m_editing_engine)
  1912. m_editing_engine->detach();
  1913. m_editing_engine = move(editing_engine);
  1914. VERIFY(m_editing_engine);
  1915. m_editing_engine->attach(*this);
  1916. m_cursor_state = true;
  1917. update_cursor();
  1918. stop_timer();
  1919. start_timer(500);
  1920. }
  1921. int TextEditor::line_height() const
  1922. {
  1923. return font().preferred_line_height();
  1924. }
  1925. int TextEditor::fixed_glyph_width() const
  1926. {
  1927. VERIFY(font().is_fixed_width());
  1928. return font().glyph_width(' ');
  1929. }
  1930. void TextEditor::set_icon(Gfx::Bitmap const* icon)
  1931. {
  1932. if (m_icon == icon)
  1933. return;
  1934. m_icon = icon;
  1935. update();
  1936. }
  1937. void TextEditor::set_visualize_trailing_whitespace(bool enabled)
  1938. {
  1939. if (m_visualize_trailing_whitespace == enabled)
  1940. return;
  1941. m_visualize_trailing_whitespace = enabled;
  1942. update();
  1943. }
  1944. void TextEditor::set_visualize_leading_whitespace(bool enabled)
  1945. {
  1946. if (m_visualize_leading_whitespace == enabled)
  1947. return;
  1948. m_visualize_leading_whitespace = enabled;
  1949. update();
  1950. }
  1951. void TextEditor::set_should_autocomplete_automatically(bool value)
  1952. {
  1953. if (value == should_autocomplete_automatically())
  1954. return;
  1955. if (value) {
  1956. VERIFY(m_autocomplete_provider);
  1957. m_autocomplete_timer = Core::Timer::create_single_shot(m_automatic_autocomplete_delay_ms, [this] {
  1958. if (m_autocomplete_box && !m_autocomplete_box->is_visible())
  1959. try_show_autocomplete(UserRequestedAutocomplete::No);
  1960. });
  1961. return;
  1962. }
  1963. remove_child(*m_autocomplete_timer);
  1964. m_autocomplete_timer = nullptr;
  1965. }
  1966. void TextEditor::set_substitution_code_point(Optional<u32> code_point)
  1967. {
  1968. if (code_point.has_value())
  1969. VERIFY(is_unicode(code_point.value()));
  1970. m_substitution_string_data.clear();
  1971. m_substitution_code_point = move(code_point);
  1972. }
  1973. int TextEditor::number_of_visible_lines() const
  1974. {
  1975. return visible_content_rect().height() / line_height();
  1976. }
  1977. void TextEditor::set_relative_line_number(bool relative)
  1978. {
  1979. if (m_relative_line_number == relative)
  1980. return;
  1981. m_relative_line_number = relative;
  1982. recompute_all_visual_lines();
  1983. update();
  1984. }
  1985. void TextEditor::set_ruler_visible(bool visible)
  1986. {
  1987. if (m_ruler_visible == visible)
  1988. return;
  1989. m_ruler_visible = visible;
  1990. recompute_all_visual_lines();
  1991. update();
  1992. }
  1993. void TextEditor::set_gutter_visible(bool visible)
  1994. {
  1995. if (m_gutter_visible == visible)
  1996. return;
  1997. m_gutter_visible = visible;
  1998. recompute_all_visual_lines();
  1999. update();
  2000. }
  2001. void TextEditor::set_cursor_line_highlighting(bool highlighted)
  2002. {
  2003. if (m_cursor_line_highlighting == highlighted)
  2004. return;
  2005. m_cursor_line_highlighting = highlighted;
  2006. update();
  2007. }
  2008. void TextEditor::undo()
  2009. {
  2010. clear_selection();
  2011. document().undo();
  2012. }
  2013. void TextEditor::redo()
  2014. {
  2015. clear_selection();
  2016. document().redo();
  2017. }
  2018. void TextEditor::set_text_is_secret(bool text_is_secret)
  2019. {
  2020. m_text_is_secret = text_is_secret;
  2021. document_did_update_undo_stack();
  2022. did_update_selection();
  2023. }
  2024. TextRange TextEditor::find_text(StringView needle, SearchDirection direction, GUI::TextDocument::SearchShouldWrap should_wrap, bool use_regex, bool match_case)
  2025. {
  2026. GUI::TextRange range {};
  2027. if (direction == SearchDirection::Forward) {
  2028. range = document().find_next(needle,
  2029. m_search_result_index.has_value() ? m_search_results[*m_search_result_index].end() : GUI::TextPosition {},
  2030. should_wrap, use_regex, match_case);
  2031. } else {
  2032. range = document().find_previous(needle,
  2033. m_search_result_index.has_value() ? m_search_results[*m_search_result_index].start() : GUI::TextPosition {},
  2034. should_wrap, use_regex, match_case);
  2035. }
  2036. if (!range.is_valid()) {
  2037. reset_search_results();
  2038. return {};
  2039. }
  2040. auto all_results = document().find_all(needle, use_regex, match_case);
  2041. on_search_results(range, all_results);
  2042. return range;
  2043. }
  2044. void TextEditor::reset_search_results()
  2045. {
  2046. m_search_result_index.clear();
  2047. m_search_results.clear();
  2048. document().set_spans(search_results_span_collection_index, {});
  2049. update();
  2050. }
  2051. void TextEditor::on_search_results(GUI::TextRange current, Vector<GUI::TextRange> all_results)
  2052. {
  2053. m_search_result_index.clear();
  2054. m_search_results.clear();
  2055. set_cursor(current.start());
  2056. if (auto it = all_results.find(current); it->is_valid())
  2057. m_search_result_index = it.index();
  2058. m_search_results = move(all_results);
  2059. Vector<GUI::TextDocumentSpan> spans;
  2060. for (size_t i = 0; i < m_search_results.size(); ++i) {
  2061. auto& result = m_search_results[i];
  2062. GUI::TextDocumentSpan span;
  2063. span.range = result;
  2064. span.attributes.background_color = palette().hover_highlight();
  2065. span.attributes.color = Color::from_argb(0xff000000); // So text without spans from a highlighter will have color
  2066. if (i == m_search_result_index) {
  2067. span.attributes.bold = true;
  2068. span.attributes.underline = true;
  2069. }
  2070. spans.append(move(span));
  2071. }
  2072. document().set_spans(search_results_span_collection_index, move(spans));
  2073. update();
  2074. }
  2075. }