TextEditor.cpp 82 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353
  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. painter.draw_text(
  430. ruler_line_rect.shrunken(2, 0),
  431. DeprecatedString::number(i + 1),
  432. is_current_line ? font().bold_variant() : font(),
  433. Gfx::TextAlignment::CenterRight,
  434. is_current_line ? palette().ruler_active_text() : palette().ruler_inactive_text());
  435. }
  436. }
  437. auto gutter_ruler_width = gutter_width() + ruler_width();
  438. Gfx::IntRect text_clip_rect { 0, 0, widget_inner_rect().width() - gutter_ruler_width, widget_inner_rect().height() };
  439. text_clip_rect.translate_by(horizontal_scrollbar().value(), vertical_scrollbar().value());
  440. painter.add_clip_rect(text_clip_rect);
  441. size_t span_index = 0;
  442. if (document().has_spans()) {
  443. for (;;) {
  444. if (span_index >= document().spans().size() || document().spans()[span_index].range.end().line() >= first_visible_line) {
  445. break;
  446. }
  447. ++span_index;
  448. }
  449. }
  450. for (size_t line_index = first_visible_line; line_index <= last_visible_line; ++line_index) {
  451. auto& line = this->line(line_index);
  452. bool physical_line_has_selection = has_selection && line_index >= selection.start().line() && line_index <= selection.end().line();
  453. size_t first_visual_line_with_selection = 0;
  454. size_t last_visual_line_with_selection = 0;
  455. if (physical_line_has_selection) {
  456. if (selection.start().line() < line_index)
  457. first_visual_line_with_selection = 0;
  458. else
  459. first_visual_line_with_selection = visual_line_containing(line_index, selection.start().column());
  460. if (selection.end().line() > line_index)
  461. last_visual_line_with_selection = m_line_visual_data[line_index].visual_line_breaks.size();
  462. else
  463. last_visual_line_with_selection = visual_line_containing(line_index, selection.end().column());
  464. }
  465. size_t selection_start_column_within_line = selection.start().line() == line_index ? selection.start().column() : 0;
  466. size_t selection_end_column_within_line = selection.end().line() == line_index ? selection.end().column() : line.length();
  467. size_t visual_line_index = 0;
  468. size_t last_start_of_visual_line = 0;
  469. Optional<size_t> multiline_trailing_space_offset {};
  470. 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) {
  471. ScopeGuard update_last_start_of_visual_line { [&]() { last_start_of_visual_line = start_of_visual_line; } };
  472. if (is_focused() && is_multi_line() && line_index == m_cursor.line() && is_cursor_line_highlighted()) {
  473. Gfx::IntRect visible_content_line_rect {
  474. visible_content_rect().x(),
  475. visual_line_rect.y(),
  476. widget_inner_rect().width() - gutter_ruler_width,
  477. line_height()
  478. };
  479. painter.fill_rect(visible_content_line_rect, widget_background_color.darkened(0.9f));
  480. }
  481. if constexpr (TEXTEDITOR_DEBUG)
  482. painter.draw_rect(visual_line_rect, Color::Cyan);
  483. if (!placeholder().is_empty() && document().is_empty() && line_index == 0) {
  484. auto line_rect = visual_line_rect;
  485. line_rect.set_width(text_width_for_font(placeholder(), font()));
  486. draw_text(line_rect, placeholder(), font(), m_text_alignment, { palette().color(Gfx::ColorRole::PlaceholderText) }, false);
  487. } else if (!document().has_spans()) {
  488. // Fast-path for plain text
  489. auto color = palette().color(is_enabled() ? foreground_role() : Gfx::ColorRole::DisabledText);
  490. if (is_displayonly() && is_focused())
  491. color = palette().color(is_enabled() ? Gfx::ColorRole::SelectionText : Gfx::ColorRole::DisabledText);
  492. draw_text(visual_line_rect, visual_line_text, font(), m_text_alignment, { color });
  493. } else {
  494. auto unspanned_color = palette().color(is_enabled() ? foreground_role() : Gfx::ColorRole::DisabledText);
  495. if (is_displayonly() && is_focused())
  496. unspanned_color = palette().color(is_enabled() ? Gfx::ColorRole::SelectionText : Gfx::ColorRole::DisabledText);
  497. RefPtr<Gfx::Font> unspanned_font = this->font();
  498. size_t next_column = 0;
  499. Gfx::IntRect span_rect = { visual_line_rect.location(), { 0, line_height() } };
  500. auto draw_text_helper = [&](size_t start, size_t end, RefPtr<Gfx::Font>& font, Gfx::TextAttributes text_attributes) {
  501. size_t length = end - start;
  502. if (length == 0)
  503. return;
  504. auto text = visual_line_text.substring_view(start, length);
  505. span_rect.set_width(font->width(text));
  506. if (text_attributes.background_color.has_value()) {
  507. painter.fill_rect(span_rect, text_attributes.background_color.value());
  508. }
  509. draw_text(span_rect, text, *font, m_text_alignment, text_attributes);
  510. span_rect.translate_by(span_rect.width(), 0);
  511. };
  512. for (;;) {
  513. if (span_index >= document().spans().size()) {
  514. break;
  515. }
  516. auto& span = document().spans()[span_index];
  517. if (!span.range.is_valid()) {
  518. ++span_index;
  519. continue;
  520. }
  521. if (span.range.end().line() < line_index) {
  522. dbgln_if(TEXTEDITOR_DEBUG, "spans not sorted (span end {}:{} is before current line {}) => ignoring", span.range.end().line(), span.range.end().column(), line_index);
  523. ++span_index;
  524. continue;
  525. }
  526. if (span.range.start().line() > line_index
  527. || (span.range.start().line() == line_index && span.range.start().column() >= start_of_visual_line + visual_line_text.length())) {
  528. // no more spans in this line, moving on
  529. break;
  530. }
  531. if (span.range.start().line() == span.range.end().line() && span.range.end().column() < span.range.start().column()) {
  532. 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());
  533. ++span_index;
  534. continue;
  535. }
  536. if (span.range.end().line() == line_index && span.range.end().column() < start_of_visual_line + next_column) {
  537. dbgln_if(TEXTEDITOR_DEBUG, "spans not sorted (span end {}:{} is before current position {}:{}) => ignoring",
  538. span.range.end().line(), span.range.end().column(), line_index, start_of_visual_line + next_column);
  539. ++span_index;
  540. continue;
  541. }
  542. size_t span_start;
  543. if (span.range.start().line() < line_index || span.range.start().column() < start_of_visual_line) {
  544. span_start = 0;
  545. } else {
  546. span_start = span.range.start().column() - start_of_visual_line;
  547. }
  548. if (span_start < next_column) {
  549. 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);
  550. ++span_index;
  551. continue;
  552. }
  553. size_t span_end;
  554. bool span_consumned;
  555. if (span.range.end().line() > line_index || span.range.end().column() > start_of_visual_line + visual_line_text.length()) {
  556. span_end = visual_line_text.length();
  557. span_consumned = false;
  558. } else {
  559. span_end = span.range.end().column() - start_of_visual_line;
  560. span_consumned = true;
  561. }
  562. if (span_start != next_column) {
  563. // draw unspanned text between spans
  564. draw_text_helper(next_column, span_start, unspanned_font, { unspanned_color });
  565. }
  566. auto font = unspanned_font;
  567. if (span.attributes.bold) {
  568. if (auto bold_font = Gfx::FontDatabase::the().get(font->family(), font->presentation_size(), 700, 0))
  569. font = bold_font;
  570. }
  571. draw_text_helper(span_start, span_end, font, span.attributes);
  572. next_column = span_end;
  573. if (!span_consumned) {
  574. // continue with same span on next line
  575. break;
  576. } else {
  577. ++span_index;
  578. }
  579. }
  580. // draw unspanned text after last span
  581. if (next_column < visual_line_text.length()) {
  582. draw_text_helper(next_column, visual_line_text.length(), unspanned_font, { unspanned_color });
  583. }
  584. // consume all spans that should end this line
  585. // this is necessary since the spans can include the new line character
  586. while (is_last_visual_line && span_index < document().spans().size()) {
  587. auto& span = document().spans()[span_index];
  588. if (span.range.end().line() == line_index) {
  589. ++span_index;
  590. } else {
  591. break;
  592. }
  593. }
  594. }
  595. if (m_visualize_trailing_whitespace && line.ends_in_whitespace()) {
  596. size_t physical_column;
  597. auto last_non_whitespace_column = line.last_non_whitespace_column();
  598. if (last_non_whitespace_column.has_value())
  599. physical_column = last_non_whitespace_column.value() + 1;
  600. else
  601. physical_column = 0;
  602. size_t end_of_visual_line = (start_of_visual_line + visual_line_text.length());
  603. if (physical_column < end_of_visual_line) {
  604. physical_column -= multiline_trailing_space_offset.value_or(0);
  605. size_t visual_column = physical_column > start_of_visual_line ? (physical_column - start_of_visual_line) : 0;
  606. Gfx::IntRect whitespace_rect {
  607. content_x_for_position({ line_index, physical_column }),
  608. visual_line_rect.y(),
  609. text_width_for_font(visual_line_text.substring_view(visual_column, visual_line_text.length() - visual_column), font()),
  610. visual_line_rect.height()
  611. };
  612. painter.fill_rect_with_dither_pattern(whitespace_rect, Color(), Color(255, 192, 192));
  613. if (!multiline_trailing_space_offset.has_value())
  614. multiline_trailing_space_offset = physical_column - last_start_of_visual_line;
  615. }
  616. }
  617. if (m_visualize_leading_whitespace && line.leading_spaces() > 0) {
  618. size_t physical_column = line.leading_spaces();
  619. if (start_of_visual_line < physical_column) {
  620. size_t end_of_leading_whitespace = min(physical_column - start_of_visual_line, visual_line_text.length());
  621. Gfx::IntRect whitespace_rect {
  622. content_x_for_position({ line_index, start_of_visual_line }),
  623. visual_line_rect.y(),
  624. text_width_for_font(visual_line_text.substring_view(0, end_of_leading_whitespace), font()),
  625. visual_line_rect.height()
  626. };
  627. painter.fill_rect_with_dither_pattern(whitespace_rect, Color(), Color(192, 255, 192));
  628. }
  629. }
  630. if (physical_line_has_selection && window()->focused_widget() == this) {
  631. size_t const start_of_selection_within_visual_line = (size_t)max(0, (int)selection_start_column_within_line - (int)start_of_visual_line);
  632. size_t const end_of_selection_within_visual_line = min(selection_end_column_within_line - start_of_visual_line, visual_line_text.length());
  633. bool current_visual_line_has_selection = start_of_selection_within_visual_line != end_of_selection_within_visual_line
  634. && ((line_index != selection.start().line() && line_index != selection.end().line())
  635. || (visual_line_index >= first_visual_line_with_selection && visual_line_index <= last_visual_line_with_selection));
  636. if (current_visual_line_has_selection) {
  637. bool selection_begins_on_current_visual_line = visual_line_index == first_visual_line_with_selection;
  638. bool selection_ends_on_current_visual_line = visual_line_index == last_visual_line_with_selection;
  639. int selection_left = selection_begins_on_current_visual_line
  640. ? content_x_for_position({ line_index, (size_t)selection_start_column_within_line })
  641. : m_horizontal_content_padding;
  642. int selection_right = selection_ends_on_current_visual_line
  643. ? content_x_for_position({ line_index, (size_t)selection_end_column_within_line })
  644. : visual_line_rect.right() + 1;
  645. Gfx::IntRect selection_rect {
  646. selection_left,
  647. visual_line_rect.y(),
  648. selection_right - selection_left,
  649. visual_line_rect.height()
  650. };
  651. Color background_color = is_focused() ? palette().selection() : palette().inactive_selection();
  652. Color text_color = is_focused() ? palette().selection_text() : palette().inactive_selection_text();
  653. painter.fill_rect(selection_rect, background_color);
  654. if (visual_line_text.code_points()) {
  655. Utf32View visual_selected_text {
  656. visual_line_text.code_points() + start_of_selection_within_visual_line,
  657. end_of_selection_within_visual_line - start_of_selection_within_visual_line
  658. };
  659. draw_text(selection_rect, visual_selected_text, font(), Gfx::TextAlignment::CenterLeft, { text_color });
  660. }
  661. }
  662. }
  663. ++visual_line_index;
  664. return IterationDecision::Continue;
  665. });
  666. }
  667. if (is_enabled() && is_focused() && !focus_preempted() && m_cursor_state && !is_displayonly())
  668. painter.fill_rect(cursor_content_rect(), palette().text_cursor());
  669. }
  670. Optional<UISize> TextEditor::calculated_min_size() const
  671. {
  672. if (is_multi_line())
  673. return AbstractScrollableWidget::calculated_min_size();
  674. auto m = content_margins();
  675. return UISize { m.left() + m.right(), m.top() + m.bottom() };
  676. }
  677. void TextEditor::select_all()
  678. {
  679. TextPosition start_of_document { 0, 0 };
  680. TextPosition end_of_document { line_count() - 1, line(line_count() - 1).length() };
  681. m_selection.set(end_of_document, start_of_document);
  682. did_update_selection();
  683. set_cursor(start_of_document);
  684. update();
  685. }
  686. void TextEditor::insert_emoji()
  687. {
  688. if (!on_emoji_input || window()->blocks_emoji_input())
  689. return;
  690. auto emoji_input_dialog = EmojiInputDialog::construct(window());
  691. if (emoji_input_dialog->exec() != EmojiInputDialog::ExecResult::OK)
  692. return;
  693. auto emoji_code_point = emoji_input_dialog->selected_emoji_text();
  694. insert_at_cursor_or_replace_selection(emoji_code_point);
  695. }
  696. void TextEditor::set_or_clear_emoji_input_callback()
  697. {
  698. switch (m_mode) {
  699. case Editable:
  700. on_emoji_input = [this](auto emoji) {
  701. insert_at_cursor_or_replace_selection(emoji);
  702. };
  703. break;
  704. case DisplayOnly:
  705. case ReadOnly:
  706. on_emoji_input = {};
  707. break;
  708. default:
  709. VERIFY_NOT_REACHED();
  710. }
  711. }
  712. void TextEditor::keydown_event(KeyEvent& event)
  713. {
  714. if (!is_editable() && event.key() == KeyCode::Key_Tab)
  715. return AbstractScrollableWidget::keydown_event(event);
  716. if (m_autocomplete_box && m_autocomplete_box->is_visible() && (event.key() == KeyCode::Key_Return || event.key() == KeyCode::Key_Tab)) {
  717. TemporaryChange change { m_should_keep_autocomplete_box, true };
  718. if (m_autocomplete_box->apply_suggestion() == CodeComprehension::AutocompleteResultEntry::HideAutocompleteAfterApplying::Yes)
  719. hide_autocomplete();
  720. else
  721. try_update_autocomplete();
  722. return;
  723. }
  724. if (m_autocomplete_box && m_autocomplete_box->is_visible() && event.key() == KeyCode::Key_Escape) {
  725. hide_autocomplete();
  726. return;
  727. }
  728. if (m_autocomplete_box && m_autocomplete_box->is_visible() && event.key() == KeyCode::Key_Up) {
  729. m_autocomplete_box->previous_suggestion();
  730. return;
  731. }
  732. if (m_autocomplete_box && m_autocomplete_box->is_visible() && event.key() == KeyCode::Key_Down) {
  733. m_autocomplete_box->next_suggestion();
  734. return;
  735. }
  736. if (is_single_line()) {
  737. if (event.key() == KeyCode::Key_Tab)
  738. return AbstractScrollableWidget::keydown_event(event);
  739. if (event.modifiers() == KeyModifier::Mod_Shift && event.key() == KeyCode::Key_Return) {
  740. if (on_shift_return_pressed)
  741. on_shift_return_pressed();
  742. return;
  743. }
  744. if (event.modifiers() == KeyModifier::Mod_Ctrl && event.key() == KeyCode::Key_Return) {
  745. if (on_ctrl_return_pressed)
  746. on_ctrl_return_pressed();
  747. return;
  748. }
  749. if (event.key() == KeyCode::Key_Return) {
  750. if (on_return_pressed)
  751. on_return_pressed();
  752. return;
  753. }
  754. if (event.key() == KeyCode::Key_Up) {
  755. if (on_up_pressed)
  756. on_up_pressed();
  757. return;
  758. }
  759. if (event.key() == KeyCode::Key_Down) {
  760. if (on_down_pressed)
  761. on_down_pressed();
  762. return;
  763. }
  764. if (event.key() == KeyCode::Key_PageUp) {
  765. if (on_pageup_pressed)
  766. on_pageup_pressed();
  767. return;
  768. }
  769. if (event.key() == KeyCode::Key_PageDown) {
  770. if (on_pagedown_pressed)
  771. on_pagedown_pressed();
  772. return;
  773. }
  774. } else if (!is_multi_line()) {
  775. VERIFY_NOT_REACHED();
  776. }
  777. ArmedScopeGuard update_autocomplete { [&] {
  778. try_update_autocomplete();
  779. } };
  780. if (is_multi_line() && !event.shift() && !event.alt() && event.ctrl() && event.key() == KeyCode::Key_Space) {
  781. if (m_autocomplete_provider) {
  782. try_show_autocomplete(UserRequestedAutocomplete::Yes);
  783. update_autocomplete.disarm();
  784. return;
  785. }
  786. }
  787. if (is_multi_line() && !event.shift() && !event.alt() && event.ctrl() && event.key() == KeyCode::Key_F) {
  788. m_search_banner->show();
  789. return;
  790. }
  791. if (m_editing_engine->on_key(event))
  792. return;
  793. if (event.key() == KeyCode::Key_Escape) {
  794. if (on_escape_pressed)
  795. on_escape_pressed();
  796. return;
  797. }
  798. if (event.modifiers() == Mod_Shift && event.key() == KeyCode::Key_Delete) {
  799. if (m_autocomplete_box)
  800. hide_autocomplete();
  801. return;
  802. }
  803. if (event.key() == KeyCode::Key_Tab) {
  804. if (has_selection()) {
  805. if (event.modifiers() == Mod_Shift) {
  806. unindent_selection();
  807. return;
  808. }
  809. if (is_indenting_selection()) {
  810. indent_selection();
  811. return;
  812. }
  813. } else {
  814. if (event.modifiers() == Mod_Shift) {
  815. unindent_line();
  816. return;
  817. }
  818. }
  819. }
  820. if (event.key() == KeyCode::Key_Delete) {
  821. if (!is_editable())
  822. return;
  823. if (m_autocomplete_box)
  824. hide_autocomplete();
  825. if (has_selection()) {
  826. delete_selection();
  827. did_update_selection();
  828. return;
  829. }
  830. if (m_cursor.column() < current_line().length()) {
  831. // Delete within line
  832. int erase_count = 1;
  833. if (event.modifiers() == Mod_Ctrl) {
  834. auto word_break_pos = document().first_word_break_after(m_cursor);
  835. erase_count = word_break_pos.column() - m_cursor.column();
  836. }
  837. TextRange erased_range(m_cursor, { m_cursor.line(), m_cursor.column() + erase_count });
  838. execute<RemoveTextCommand>(document().text_in_range(erased_range), erased_range);
  839. return;
  840. }
  841. if (m_cursor.column() == current_line().length() && m_cursor.line() != line_count() - 1) {
  842. // Delete at end of line; merge with next line
  843. size_t erase_count = 0;
  844. if (event.modifiers() == Mod_Ctrl) {
  845. erase_count = document().first_word_break_after({ m_cursor.line() + 1, 0 }).column();
  846. }
  847. TextRange erased_range(m_cursor, { m_cursor.line() + 1, erase_count });
  848. execute<RemoveTextCommand>(document().text_in_range(erased_range), erased_range);
  849. return;
  850. }
  851. return;
  852. }
  853. if (event.key() == KeyCode::Key_Backspace) {
  854. if (!is_editable())
  855. return;
  856. if (m_autocomplete_box)
  857. hide_autocomplete();
  858. if (has_selection()) {
  859. delete_selection();
  860. did_update_selection();
  861. return;
  862. }
  863. if (m_cursor.column() > 0) {
  864. int erase_count = 1;
  865. if (event.modifiers() == Mod_Ctrl) {
  866. auto word_break_pos = document().first_word_break_before(m_cursor, true);
  867. erase_count = m_cursor.column() - word_break_pos.column();
  868. } else if (current_line().first_non_whitespace_column() >= m_cursor.column()) {
  869. int new_column;
  870. if (m_cursor.column() % m_soft_tab_width == 0)
  871. new_column = m_cursor.column() - m_soft_tab_width;
  872. else
  873. new_column = (m_cursor.column() / m_soft_tab_width) * m_soft_tab_width;
  874. erase_count = m_cursor.column() - new_column;
  875. }
  876. // Backspace within line
  877. TextRange erased_range({ m_cursor.line(), m_cursor.column() - erase_count }, m_cursor);
  878. auto erased_text = document().text_in_range(erased_range);
  879. execute<RemoveTextCommand>(erased_text, erased_range);
  880. return;
  881. }
  882. if (m_cursor.column() == 0 && m_cursor.line() != 0) {
  883. // Backspace at column 0; merge with previous line
  884. size_t previous_length = line(m_cursor.line() - 1).length();
  885. TextRange erased_range({ m_cursor.line() - 1, previous_length }, m_cursor);
  886. execute<RemoveTextCommand>("\n", erased_range);
  887. return;
  888. }
  889. return;
  890. }
  891. // AltGr is emulated as Ctrl+Alt; if Ctrl is set check if it's not for AltGr
  892. if ((!event.ctrl() || event.altgr()) && !event.alt() && event.code_point() != 0) {
  893. TemporaryChange change { m_should_keep_autocomplete_box, true };
  894. add_code_point(event.code_point());
  895. return;
  896. }
  897. if (event.ctrl() && event.key() == KeyCode::Key_Slash) {
  898. if (m_highlighter != nullptr) {
  899. auto prefix = m_highlighter->comment_prefix().value_or(""sv);
  900. auto suffix = m_highlighter->comment_suffix().value_or(""sv);
  901. auto range = has_selection() ? selection().normalized() : TextRange { { m_cursor.line(), m_cursor.column() }, { m_cursor.line(), m_cursor.column() } };
  902. auto is_already_commented = true;
  903. for (size_t i = range.start().line(); i <= range.end().line(); i++) {
  904. auto text = m_document->line(i).to_utf8().trim_whitespace();
  905. if (!(text.starts_with(prefix) && text.ends_with(suffix))) {
  906. is_already_commented = false;
  907. break;
  908. }
  909. }
  910. if (is_already_commented)
  911. execute<UncommentSelection>(prefix, suffix, range);
  912. else
  913. execute<CommentSelection>(prefix, suffix, range);
  914. return;
  915. }
  916. }
  917. event.ignore();
  918. }
  919. bool TextEditor::is_indenting_selection()
  920. {
  921. auto const selection_start = m_selection.start() > m_selection.end() ? m_selection.end() : m_selection.start();
  922. auto const selection_end = m_selection.end() > m_selection.start() ? m_selection.end() : m_selection.start();
  923. auto const whole_line_selected = selection_end.column() - selection_start.column() >= current_line().length() - current_line().first_non_whitespace_column();
  924. auto const on_same_line = selection_start.line() == selection_end.line();
  925. if (has_selection() && (whole_line_selected || !on_same_line)) {
  926. return true;
  927. }
  928. return false;
  929. }
  930. void TextEditor::indent_selection()
  931. {
  932. auto const selection_start = m_selection.start() > m_selection.end() ? m_selection.end() : m_selection.start();
  933. auto const selection_end = m_selection.end() > m_selection.start() ? m_selection.end() : m_selection.start();
  934. if (is_indenting_selection()) {
  935. execute<IndentSelection>(m_soft_tab_width, TextRange(selection_start, selection_end));
  936. m_selection.set_start({ selection_start.line(), selection_start.column() + m_soft_tab_width });
  937. m_selection.set_end({ selection_end.line(), selection_end.column() + m_soft_tab_width });
  938. set_cursor({ m_cursor.line(), m_cursor.column() + m_soft_tab_width });
  939. }
  940. }
  941. void TextEditor::unindent_selection()
  942. {
  943. auto const selection_start = m_selection.start() > m_selection.end() ? m_selection.end() : m_selection.start();
  944. auto const selection_end = m_selection.end() > m_selection.start() ? m_selection.end() : m_selection.start();
  945. if (current_line().first_non_whitespace_column() != 0) {
  946. if (current_line().first_non_whitespace_column() > m_soft_tab_width && selection_start.column() != 0) {
  947. m_selection.set_start({ selection_start.line(), selection_start.column() - m_soft_tab_width });
  948. m_selection.set_end({ selection_end.line(), selection_end.column() - m_soft_tab_width });
  949. } else if (selection_start.column() != 0) {
  950. m_selection.set_start({ selection_start.line(), selection_start.column() - current_line().leading_spaces() });
  951. m_selection.set_end({ selection_end.line(), selection_end.column() - current_line().leading_spaces() });
  952. }
  953. execute<UnindentSelection>(m_soft_tab_width, TextRange(selection_start, selection_end));
  954. }
  955. }
  956. void TextEditor::unindent_line()
  957. {
  958. if (current_line().first_non_whitespace_column() != 0) {
  959. auto const unindent_size = current_line().leading_spaces() < m_soft_tab_width ? current_line().leading_spaces() : m_soft_tab_width;
  960. auto const temp_column = m_cursor.column();
  961. execute<UnindentSelection>(unindent_size, TextRange({ m_cursor.line(), 0 }, { m_cursor.line(), line(m_cursor.line()).length() }));
  962. set_cursor({ m_cursor.line(), temp_column <= unindent_size ? 0 : temp_column - unindent_size });
  963. }
  964. }
  965. void TextEditor::delete_previous_word()
  966. {
  967. TextRange to_erase(document().first_word_before(m_cursor, true), m_cursor);
  968. execute<RemoveTextCommand>(document().text_in_range(to_erase), to_erase);
  969. }
  970. void TextEditor::delete_current_line()
  971. {
  972. if (has_selection())
  973. return delete_selection();
  974. TextPosition start;
  975. TextPosition end;
  976. if (m_cursor.line() == 0 && line_count() == 1) {
  977. start = { 0, 0 };
  978. end = { 0, line(0).length() };
  979. } else if (m_cursor.line() == line_count() - 1) {
  980. start = { m_cursor.line() - 1, line(m_cursor.line() - 1).length() };
  981. end = { m_cursor.line(), line(m_cursor.line()).length() };
  982. } else {
  983. start = { m_cursor.line(), 0 };
  984. end = { m_cursor.line() + 1, 0 };
  985. }
  986. TextRange erased_range(start, end);
  987. execute<RemoveTextCommand>(document().text_in_range(erased_range), erased_range);
  988. }
  989. void TextEditor::delete_previous_char()
  990. {
  991. if (!is_editable())
  992. return;
  993. if (has_selection())
  994. return delete_selection();
  995. TextRange to_erase({ m_cursor.line(), m_cursor.column() - 1 }, m_cursor);
  996. if (m_cursor.column() == 0 && m_cursor.line() != 0) {
  997. size_t prev_line_len = line(m_cursor.line() - 1).length();
  998. to_erase.set_start({ m_cursor.line() - 1, prev_line_len });
  999. }
  1000. execute<RemoveTextCommand>(document().text_in_range(to_erase), to_erase);
  1001. }
  1002. void TextEditor::delete_from_line_start_to_cursor()
  1003. {
  1004. TextPosition start(m_cursor.line(), current_line().first_non_whitespace_column());
  1005. TextRange to_erase(start, m_cursor);
  1006. execute<RemoveTextCommand>(document().text_in_range(to_erase), to_erase);
  1007. }
  1008. void TextEditor::do_delete()
  1009. {
  1010. if (!is_editable())
  1011. return;
  1012. if (has_selection())
  1013. return delete_selection();
  1014. if (m_cursor.column() < current_line().length()) {
  1015. // Delete within line
  1016. TextRange erased_range(m_cursor, { m_cursor.line(), m_cursor.column() + 1 });
  1017. execute<RemoveTextCommand>(document().text_in_range(erased_range), erased_range);
  1018. return;
  1019. }
  1020. if (m_cursor.column() == current_line().length() && m_cursor.line() != line_count() - 1) {
  1021. // Delete at end of line; merge with next line
  1022. TextRange erased_range(m_cursor, { m_cursor.line() + 1, 0 });
  1023. execute<RemoveTextCommand>(document().text_in_range(erased_range), erased_range);
  1024. return;
  1025. }
  1026. }
  1027. void TextEditor::add_code_point(u32 code_point)
  1028. {
  1029. if (!is_editable())
  1030. return;
  1031. StringBuilder sb;
  1032. sb.append_code_point(code_point);
  1033. if (should_autocomplete_automatically()) {
  1034. if (sb.string_view().is_whitespace())
  1035. m_autocomplete_timer->stop();
  1036. else
  1037. m_autocomplete_timer->start();
  1038. }
  1039. insert_at_cursor_or_replace_selection(sb.to_deprecated_string());
  1040. };
  1041. void TextEditor::reset_cursor_blink()
  1042. {
  1043. m_cursor_state = true;
  1044. update_cursor();
  1045. stop_timer();
  1046. start_timer(500);
  1047. }
  1048. void TextEditor::update_selection(bool is_selecting)
  1049. {
  1050. if (is_selecting && !selection().is_valid()) {
  1051. selection().set(cursor(), {});
  1052. did_update_selection();
  1053. update();
  1054. return;
  1055. }
  1056. if (!is_selecting && selection().is_valid()) {
  1057. selection().clear();
  1058. did_update_selection();
  1059. update();
  1060. return;
  1061. }
  1062. if (is_selecting && selection().start().is_valid()) {
  1063. selection().set_end(cursor());
  1064. did_update_selection();
  1065. update();
  1066. return;
  1067. }
  1068. }
  1069. int TextEditor::content_x_for_position(TextPosition const& position) const
  1070. {
  1071. auto& line = this->line(position.line());
  1072. int x_offset = 0;
  1073. switch (m_text_alignment) {
  1074. case Gfx::TextAlignment::CenterLeft:
  1075. for_each_visual_line(position.line(), [&](Gfx::IntRect const&, auto& visual_line_view, size_t start_of_visual_line, bool is_last_visual_line) {
  1076. size_t offset_in_visual_line = position.column() - start_of_visual_line;
  1077. auto before_line_end = is_last_visual_line ? (offset_in_visual_line <= visual_line_view.length()) : (offset_in_visual_line < visual_line_view.length());
  1078. if (position.column() >= start_of_visual_line && before_line_end) {
  1079. if (offset_in_visual_line == 0) {
  1080. x_offset = 0;
  1081. } else {
  1082. x_offset = text_width_for_font(visual_line_view.substring_view(0, offset_in_visual_line), font());
  1083. x_offset += font().glyph_spacing();
  1084. }
  1085. return IterationDecision::Break;
  1086. }
  1087. return IterationDecision::Continue;
  1088. });
  1089. return m_horizontal_content_padding + ((is_single_line() && icon()) ? (icon_size() + icon_padding()) : 0) + x_offset;
  1090. case Gfx::TextAlignment::CenterRight:
  1091. // FIXME
  1092. VERIFY(!is_wrapping_enabled());
  1093. return content_width() - m_horizontal_content_padding - (line.length() * fixed_glyph_width()) + (position.column() * fixed_glyph_width());
  1094. default:
  1095. VERIFY_NOT_REACHED();
  1096. }
  1097. }
  1098. int TextEditor::text_width_for_font(auto const& text, Gfx::Font const& font) const
  1099. {
  1100. if (m_substitution_code_point.has_value())
  1101. return font.width(substitution_code_point_view(text.length()));
  1102. else
  1103. return font.width(text);
  1104. }
  1105. Utf32View TextEditor::substitution_code_point_view(size_t length) const
  1106. {
  1107. VERIFY(m_substitution_code_point.has_value());
  1108. if (!m_substitution_string_data)
  1109. m_substitution_string_data = make<Vector<u32>>();
  1110. if (!m_substitution_string_data->is_empty())
  1111. VERIFY(m_substitution_string_data->first() == m_substitution_code_point);
  1112. while (m_substitution_string_data->size() < length)
  1113. m_substitution_string_data->append(m_substitution_code_point.value());
  1114. return Utf32View { m_substitution_string_data->data(), length };
  1115. }
  1116. Gfx::IntRect TextEditor::content_rect_for_position(TextPosition const& position) const
  1117. {
  1118. if (!position.is_valid())
  1119. return {};
  1120. VERIFY(!lines().is_empty());
  1121. VERIFY(position.column() <= (current_line().length() + 1));
  1122. int x = content_x_for_position(position);
  1123. if (is_single_line()) {
  1124. Gfx::IntRect rect { x, 0, 1, line_height() };
  1125. rect.center_vertically_within({ {}, frame_inner_rect().size() });
  1126. return rect;
  1127. }
  1128. Gfx::IntRect rect;
  1129. 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) {
  1130. auto before_line_end = is_last_visual_line ? ((position.column() - start_of_visual_line) <= view.length()) : ((position.column() - start_of_visual_line) < view.length());
  1131. if (position.column() >= start_of_visual_line && before_line_end) {
  1132. // NOTE: We have to subtract the horizontal padding here since it's part of the visual line rect
  1133. // *and* included in what we get from content_x_for_position().
  1134. rect = {
  1135. visual_line_rect.x() + x - (m_horizontal_content_padding),
  1136. visual_line_rect.y(),
  1137. m_editing_engine->cursor_width() == CursorWidth::WIDE ? 7 : 1,
  1138. line_height()
  1139. };
  1140. return IterationDecision::Break;
  1141. }
  1142. return IterationDecision::Continue;
  1143. });
  1144. return rect;
  1145. }
  1146. Gfx::IntRect TextEditor::cursor_content_rect() const
  1147. {
  1148. return content_rect_for_position(m_cursor);
  1149. }
  1150. Gfx::IntRect TextEditor::line_widget_rect(size_t line_index) const
  1151. {
  1152. auto rect = line_content_rect(line_index);
  1153. rect.set_x(frame_thickness());
  1154. rect.set_width(frame_inner_rect().width());
  1155. rect.translate_by(0, -(vertical_scrollbar().value()));
  1156. rect.translate_by(0, frame_thickness());
  1157. rect.translate_by(0, height_occupied_by_banner_widget());
  1158. rect.intersect(frame_inner_rect());
  1159. return rect;
  1160. }
  1161. void TextEditor::scroll_position_into_view(TextPosition const& position)
  1162. {
  1163. auto rect = content_rect_for_position(position);
  1164. if (position.column() == 0)
  1165. rect.set_x(content_x_for_position({ position.line(), 0 }) - 2);
  1166. else if (position.column() == line(position.line()).length())
  1167. rect.set_x(content_x_for_position({ position.line(), line(position.line()).length() }) + 2);
  1168. scroll_into_view(rect, true, true);
  1169. }
  1170. void TextEditor::scroll_cursor_into_view()
  1171. {
  1172. if (!m_reflow_deferred)
  1173. scroll_position_into_view(m_cursor);
  1174. }
  1175. Gfx::IntRect TextEditor::line_content_rect(size_t line_index) const
  1176. {
  1177. auto& line = this->line(line_index);
  1178. if (is_single_line()) {
  1179. Gfx::IntRect line_rect = { content_x_for_position({ line_index, 0 }), 0, text_width_for_font(line.view(), font()), font().glyph_height() + 4 };
  1180. line_rect.center_vertically_within({ {}, frame_inner_rect().size() });
  1181. return line_rect;
  1182. }
  1183. if (is_wrapping_enabled())
  1184. return m_line_visual_data[line_index].visual_rect;
  1185. return {
  1186. content_x_for_position({ line_index, 0 }),
  1187. (int)line_index * line_height(),
  1188. text_width_for_font(line.view(), font()),
  1189. line_height()
  1190. };
  1191. }
  1192. void TextEditor::set_cursor_and_focus_line(size_t line, size_t column)
  1193. {
  1194. u_int index_max = line_count() - 1;
  1195. set_cursor(line, column);
  1196. if (line > 1 && line < index_max) {
  1197. int headroom = frame_inner_rect().height() / 3;
  1198. do {
  1199. auto line_data = m_line_visual_data[line];
  1200. headroom -= line_data.visual_rect.height();
  1201. line--;
  1202. } while (line > 0 && headroom > 0);
  1203. Gfx::IntRect rect = { 0, line_content_rect(line).y(),
  1204. 1, frame_inner_rect().height() };
  1205. scroll_into_view(rect, false, true);
  1206. }
  1207. }
  1208. void TextEditor::update_cursor()
  1209. {
  1210. update(line_widget_rect(m_cursor.line()));
  1211. }
  1212. void TextEditor::set_cursor(size_t line, size_t column)
  1213. {
  1214. set_cursor({ line, column });
  1215. }
  1216. void TextEditor::set_cursor(TextPosition const& a_position)
  1217. {
  1218. VERIFY(!lines().is_empty());
  1219. TextPosition position = a_position;
  1220. if (position.line() >= line_count())
  1221. position.set_line(line_count() - 1);
  1222. if (position.column() > lines()[position.line()].length())
  1223. position.set_column(lines()[position.line()].length());
  1224. if (m_cursor != position && is_visual_data_up_to_date()) {
  1225. // NOTE: If the old cursor is no longer valid, repaint everything just in case.
  1226. auto old_cursor_line_rect = m_cursor.line() < line_count()
  1227. ? line_widget_rect(m_cursor.line())
  1228. : rect();
  1229. m_cursor = position;
  1230. m_cursor_state = true;
  1231. scroll_cursor_into_view();
  1232. update(old_cursor_line_rect);
  1233. update_cursor();
  1234. } else if (m_cursor != position) {
  1235. m_cursor = position;
  1236. m_cursor_state = true;
  1237. }
  1238. cursor_did_change();
  1239. if (on_cursor_change)
  1240. on_cursor_change();
  1241. if (m_highlighter)
  1242. m_highlighter->cursor_did_change();
  1243. }
  1244. void TextEditor::focusin_event(FocusEvent& event)
  1245. {
  1246. if (event.source() == FocusSource::Keyboard)
  1247. select_all();
  1248. m_cursor_state = true;
  1249. update_cursor();
  1250. stop_timer();
  1251. start_timer(500);
  1252. if (on_focusin)
  1253. on_focusin();
  1254. }
  1255. void TextEditor::focusout_event(FocusEvent&)
  1256. {
  1257. if (is_displayonly() && has_selection())
  1258. m_selection.clear();
  1259. stop_timer();
  1260. if (on_focusout)
  1261. on_focusout();
  1262. }
  1263. void TextEditor::timer_event(Core::TimerEvent&)
  1264. {
  1265. m_cursor_state = !m_cursor_state;
  1266. if (is_focused())
  1267. update_cursor();
  1268. }
  1269. bool TextEditor::write_to_file(DeprecatedString const& path)
  1270. {
  1271. auto file = Core::File::construct(path);
  1272. if (!file->open(Core::OpenMode::WriteOnly | Core::OpenMode::Truncate)) {
  1273. warnln("Error opening {}: {}", path, strerror(file->error()));
  1274. return false;
  1275. }
  1276. return write_to_file(*file);
  1277. }
  1278. bool TextEditor::write_to_file(Core::File& file)
  1279. {
  1280. off_t file_size = 0;
  1281. if (line_count() == 1 && line(0).is_empty()) {
  1282. // Truncate to zero.
  1283. } else {
  1284. // Compute the final file size and ftruncate() to make writing fast.
  1285. // FIXME: Remove this once the kernel is smart enough to do this instead.
  1286. for (size_t i = 0; i < line_count(); ++i)
  1287. file_size += line(i).length();
  1288. file_size += line_count();
  1289. }
  1290. if (!file.truncate(file_size)) {
  1291. perror("ftruncate");
  1292. return false;
  1293. }
  1294. if (file_size == 0) {
  1295. // A size 0 file doesn't need a data copy.
  1296. } else {
  1297. for (size_t i = 0; i < line_count(); ++i) {
  1298. auto& line = this->line(i);
  1299. if (line.length()) {
  1300. auto line_as_utf8 = line.to_utf8();
  1301. ssize_t nwritten = file.write(line_as_utf8);
  1302. if (nwritten < 0) {
  1303. perror("write");
  1304. return false;
  1305. }
  1306. }
  1307. char ch = '\n';
  1308. ssize_t nwritten = file.write((u8*)&ch, 1);
  1309. if (nwritten != 1) {
  1310. perror("write");
  1311. return false;
  1312. }
  1313. }
  1314. }
  1315. document().set_unmodified();
  1316. return true;
  1317. }
  1318. DeprecatedString TextEditor::text() const
  1319. {
  1320. return document().text();
  1321. }
  1322. void TextEditor::clear()
  1323. {
  1324. document().remove_all_lines();
  1325. document().append_line(make<TextDocumentLine>(document()));
  1326. m_selection.clear();
  1327. did_update_selection();
  1328. set_cursor(0, 0);
  1329. update();
  1330. }
  1331. DeprecatedString TextEditor::selected_text() const
  1332. {
  1333. if (!has_selection())
  1334. return {};
  1335. return document().text_in_range(m_selection);
  1336. }
  1337. size_t TextEditor::number_of_selected_words() const
  1338. {
  1339. if (!has_selection())
  1340. return 0;
  1341. size_t word_count = 0;
  1342. bool in_word = false;
  1343. auto selected_text = this->selected_text();
  1344. for (char c : selected_text) {
  1345. if (in_word && is_ascii_space(c)) {
  1346. in_word = false;
  1347. word_count++;
  1348. continue;
  1349. }
  1350. if (!in_word && !is_ascii_space(c))
  1351. in_word = true;
  1352. }
  1353. if (in_word)
  1354. word_count++;
  1355. return word_count;
  1356. }
  1357. size_t TextEditor::number_of_words() const
  1358. {
  1359. if (document().is_empty())
  1360. return 0;
  1361. size_t word_count = 0;
  1362. bool in_word = false;
  1363. auto text = this->text();
  1364. for (char c : text) {
  1365. if (in_word && is_ascii_space(c)) {
  1366. in_word = false;
  1367. word_count++;
  1368. continue;
  1369. }
  1370. if (!in_word && !is_ascii_space(c))
  1371. in_word = true;
  1372. }
  1373. if (in_word)
  1374. word_count++;
  1375. return word_count;
  1376. }
  1377. void TextEditor::delete_selection()
  1378. {
  1379. auto selection = normalized_selection();
  1380. auto selected = selected_text();
  1381. m_selection.clear();
  1382. execute<RemoveTextCommand>(selected, selection);
  1383. did_update_selection();
  1384. did_change();
  1385. set_cursor(selection.start());
  1386. update();
  1387. }
  1388. void TextEditor::delete_text_range(TextRange range)
  1389. {
  1390. auto normalized_range = range.normalized();
  1391. execute<RemoveTextCommand>(document().text_in_range(normalized_range), normalized_range);
  1392. did_change();
  1393. set_cursor(normalized_range.start());
  1394. update();
  1395. }
  1396. void TextEditor::insert_at_cursor_or_replace_selection(StringView text)
  1397. {
  1398. ReflowDeferrer defer(*this);
  1399. VERIFY(is_editable());
  1400. if (has_selection())
  1401. delete_selection();
  1402. // Check if adding a newline leaves the previous line as just whitespace.
  1403. auto const clear_length = m_cursor.column();
  1404. auto const should_clear_last_line = text == "\n"
  1405. && clear_length > 0
  1406. && current_line().leading_spaces() == clear_length;
  1407. execute<InsertTextCommand>(text, m_cursor);
  1408. if (should_clear_last_line) { // If it does leave just whitespace, clear it.
  1409. auto const original_cursor_position = cursor();
  1410. TextPosition start(original_cursor_position.line() - 1, 0);
  1411. TextPosition end(original_cursor_position.line() - 1, clear_length);
  1412. TextRange erased_range(start, end);
  1413. execute<RemoveTextCommand>(document().text_in_range(erased_range), erased_range);
  1414. set_cursor(original_cursor_position);
  1415. }
  1416. }
  1417. void TextEditor::replace_all_text_without_resetting_undo_stack(StringView text)
  1418. {
  1419. auto start = GUI::TextPosition(0, 0);
  1420. auto last_line_index = line_count() - 1;
  1421. auto end = GUI::TextPosition(last_line_index, line(last_line_index).length());
  1422. auto range = GUI::TextRange(start, end);
  1423. auto normalized_range = range.normalized();
  1424. execute<ReplaceAllTextCommand>(text, range, "GML Playground Format Text");
  1425. did_change();
  1426. set_cursor(normalized_range.start());
  1427. update();
  1428. }
  1429. void TextEditor::cut()
  1430. {
  1431. if (!is_editable())
  1432. return;
  1433. auto selected_text = this->selected_text();
  1434. dbgln_if(TEXTEDITOR_DEBUG, "Cut: \"{}\"", selected_text);
  1435. Clipboard::the().set_plain_text(selected_text);
  1436. delete_selection();
  1437. }
  1438. void TextEditor::copy()
  1439. {
  1440. auto selected_text = this->selected_text();
  1441. dbgln_if(TEXTEDITOR_DEBUG, "Copy: \"{}\"\n", selected_text);
  1442. Clipboard::the().set_plain_text(selected_text);
  1443. }
  1444. void TextEditor::paste()
  1445. {
  1446. if (!is_editable())
  1447. return;
  1448. auto [data, mime_type, _] = GUI::Clipboard::the().fetch_data_and_type();
  1449. if (!mime_type.starts_with("text/"sv))
  1450. return;
  1451. if (data.is_empty())
  1452. return;
  1453. dbgln_if(TEXTEDITOR_DEBUG, "Paste: \"{}\"", DeprecatedString::copy(data));
  1454. TemporaryChange change(m_automatic_indentation_enabled, false);
  1455. insert_at_cursor_or_replace_selection(data);
  1456. }
  1457. void TextEditor::defer_reflow()
  1458. {
  1459. ++m_reflow_deferred;
  1460. }
  1461. void TextEditor::undefer_reflow()
  1462. {
  1463. VERIFY(m_reflow_deferred);
  1464. if (!--m_reflow_deferred) {
  1465. if (m_reflow_requested) {
  1466. recompute_all_visual_lines();
  1467. scroll_cursor_into_view();
  1468. }
  1469. }
  1470. }
  1471. void TextEditor::try_show_autocomplete(UserRequestedAutocomplete user_requested_autocomplete)
  1472. {
  1473. force_update_autocomplete([&, user_requested_autocomplete = move(user_requested_autocomplete)] {
  1474. if (user_requested_autocomplete == Yes || m_autocomplete_box->has_suggestions()) {
  1475. 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));
  1476. m_autocomplete_box->show(position);
  1477. }
  1478. });
  1479. }
  1480. void TextEditor::try_update_autocomplete(Function<void()> callback)
  1481. {
  1482. if (m_autocomplete_box && m_autocomplete_box->is_visible())
  1483. force_update_autocomplete(move(callback));
  1484. }
  1485. void TextEditor::force_update_autocomplete(Function<void()> callback)
  1486. {
  1487. if (m_autocomplete_provider) {
  1488. m_autocomplete_provider->provide_completions([&, callback = move(callback)](auto completions) {
  1489. m_autocomplete_box->update_suggestions(move(completions));
  1490. if (callback)
  1491. callback();
  1492. });
  1493. }
  1494. }
  1495. void TextEditor::hide_autocomplete_if_needed()
  1496. {
  1497. if (!m_should_keep_autocomplete_box)
  1498. hide_autocomplete();
  1499. }
  1500. void TextEditor::hide_autocomplete()
  1501. {
  1502. if (m_autocomplete_box) {
  1503. m_autocomplete_box->close();
  1504. if (m_autocomplete_timer)
  1505. m_autocomplete_timer->stop();
  1506. }
  1507. }
  1508. void TextEditor::enter_event(Core::Event&)
  1509. {
  1510. m_automatic_selection_scroll_timer->stop();
  1511. }
  1512. void TextEditor::leave_event(Core::Event&)
  1513. {
  1514. if (m_in_drag_select)
  1515. m_automatic_selection_scroll_timer->start();
  1516. }
  1517. void TextEditor::did_change(AllowCallback allow_callback)
  1518. {
  1519. update_content_size();
  1520. recompute_all_visual_lines();
  1521. hide_autocomplete_if_needed();
  1522. m_needs_rehighlight = true;
  1523. if (on_change && allow_callback == AllowCallback::Yes)
  1524. on_change();
  1525. }
  1526. void TextEditor::set_mode(const Mode mode)
  1527. {
  1528. if (m_mode == mode)
  1529. return;
  1530. m_mode = mode;
  1531. switch (mode) {
  1532. case Editable:
  1533. m_cut_action->set_enabled(has_selection() && !text_is_secret());
  1534. m_paste_action->set_enabled(true);
  1535. m_insert_emoji_action->set_enabled(true);
  1536. break;
  1537. case DisplayOnly:
  1538. case ReadOnly:
  1539. m_cut_action->set_enabled(false);
  1540. m_paste_action->set_enabled(false);
  1541. m_insert_emoji_action->set_enabled(false);
  1542. break;
  1543. default:
  1544. VERIFY_NOT_REACHED();
  1545. }
  1546. set_or_clear_emoji_input_callback();
  1547. set_editing_cursor();
  1548. }
  1549. void TextEditor::set_editing_cursor()
  1550. {
  1551. if (!is_displayonly())
  1552. set_override_cursor(Gfx::StandardCursor::IBeam);
  1553. else
  1554. set_override_cursor(Gfx::StandardCursor::None);
  1555. }
  1556. void TextEditor::did_update_selection()
  1557. {
  1558. m_cut_action->set_enabled(is_editable() && has_selection() && !text_is_secret());
  1559. m_copy_action->set_enabled(has_selection() && !text_is_secret());
  1560. if (on_selection_change)
  1561. on_selection_change();
  1562. if (is_wrapping_enabled()) {
  1563. // FIXME: Try to repaint less.
  1564. update();
  1565. }
  1566. }
  1567. void TextEditor::context_menu_event(ContextMenuEvent& event)
  1568. {
  1569. if (is_displayonly())
  1570. return;
  1571. m_insert_emoji_action->set_enabled(on_emoji_input && !window()->blocks_emoji_input());
  1572. if (!m_context_menu) {
  1573. m_context_menu = Menu::construct();
  1574. m_context_menu->add_action(undo_action());
  1575. m_context_menu->add_action(redo_action());
  1576. m_context_menu->add_separator();
  1577. m_context_menu->add_action(cut_action());
  1578. m_context_menu->add_action(copy_action());
  1579. m_context_menu->add_action(paste_action());
  1580. m_context_menu->add_separator();
  1581. m_context_menu->add_action(select_all_action());
  1582. m_context_menu->add_action(insert_emoji_action());
  1583. if (is_multi_line()) {
  1584. m_context_menu->add_separator();
  1585. m_context_menu->add_action(go_to_line_action());
  1586. }
  1587. if (!m_custom_context_menu_actions.is_empty()) {
  1588. m_context_menu->add_separator();
  1589. for (auto& action : m_custom_context_menu_actions) {
  1590. m_context_menu->add_action(action);
  1591. }
  1592. }
  1593. }
  1594. m_context_menu->popup(event.screen_position());
  1595. }
  1596. void TextEditor::set_text_alignment(Gfx::TextAlignment alignment)
  1597. {
  1598. if (m_text_alignment == alignment)
  1599. return;
  1600. m_text_alignment = alignment;
  1601. update();
  1602. }
  1603. void TextEditor::resize_event(ResizeEvent& event)
  1604. {
  1605. AbstractScrollableWidget::resize_event(event);
  1606. update_content_size();
  1607. recompute_all_visual_lines();
  1608. }
  1609. void TextEditor::theme_change_event(ThemeChangeEvent& event)
  1610. {
  1611. AbstractScrollableWidget::theme_change_event(event);
  1612. m_needs_rehighlight = true;
  1613. }
  1614. void TextEditor::set_selection(TextRange const& selection)
  1615. {
  1616. if (m_selection == selection)
  1617. return;
  1618. m_selection = selection;
  1619. set_cursor(m_selection.end());
  1620. scroll_position_into_view(normalized_selection().start());
  1621. update();
  1622. }
  1623. void TextEditor::clear_selection()
  1624. {
  1625. if (!has_selection())
  1626. return;
  1627. m_selection.clear();
  1628. update();
  1629. }
  1630. void TextEditor::recompute_all_visual_lines()
  1631. {
  1632. if (m_reflow_deferred) {
  1633. m_reflow_requested = true;
  1634. return;
  1635. }
  1636. m_reflow_requested = false;
  1637. int y_offset = 0;
  1638. for (size_t line_index = 0; line_index < line_count(); ++line_index) {
  1639. recompute_visual_lines(line_index);
  1640. m_line_visual_data[line_index].visual_rect.set_y(y_offset);
  1641. y_offset += m_line_visual_data[line_index].visual_rect.height();
  1642. }
  1643. update_content_size();
  1644. }
  1645. void TextEditor::ensure_cursor_is_valid()
  1646. {
  1647. auto new_cursor = m_cursor;
  1648. if (new_cursor.line() >= line_count())
  1649. new_cursor.set_line(line_count() - 1);
  1650. if (new_cursor.column() > line(new_cursor.line()).length())
  1651. new_cursor.set_column(line(new_cursor.line()).length());
  1652. if (m_cursor != new_cursor)
  1653. set_cursor(new_cursor);
  1654. }
  1655. size_t TextEditor::visual_line_containing(size_t line_index, size_t column) const
  1656. {
  1657. size_t visual_line_index = 0;
  1658. for_each_visual_line(line_index, [&](Gfx::IntRect const&, auto& view, size_t start_of_visual_line, [[maybe_unused]] bool is_last_visual_line) {
  1659. if (column >= start_of_visual_line && ((column - start_of_visual_line) < view.length()))
  1660. return IterationDecision::Break;
  1661. ++visual_line_index;
  1662. return IterationDecision::Continue;
  1663. });
  1664. return visual_line_index;
  1665. }
  1666. void TextEditor::recompute_visual_lines(size_t line_index)
  1667. {
  1668. auto& line = document().line(line_index);
  1669. auto& visual_data = m_line_visual_data[line_index];
  1670. visual_data.visual_line_breaks.clear_with_capacity();
  1671. int available_width = visible_text_rect_in_inner_coordinates().width();
  1672. if (is_wrapping_enabled()) {
  1673. int line_width_so_far = 0;
  1674. size_t last_whitespace_index = 0;
  1675. size_t line_width_since_last_whitespace = 0;
  1676. auto glyph_spacing = font().glyph_spacing();
  1677. for (size_t i = 0; i < line.length(); ++i) {
  1678. auto code_point = line.code_points()[i];
  1679. if (is_ascii_space(code_point)) {
  1680. last_whitespace_index = i;
  1681. line_width_since_last_whitespace = 0;
  1682. }
  1683. auto glyph_width = font().glyph_or_emoji_width(code_point);
  1684. line_width_since_last_whitespace += glyph_width + glyph_spacing;
  1685. if ((line_width_so_far + glyph_width + glyph_spacing) > available_width) {
  1686. if (m_wrapping_mode == WrappingMode::WrapAtWords && last_whitespace_index != 0) {
  1687. // Plus 1 to get the first letter of the word.
  1688. visual_data.visual_line_breaks.append(last_whitespace_index + 1);
  1689. line_width_so_far = line_width_since_last_whitespace;
  1690. last_whitespace_index = 0;
  1691. line_width_since_last_whitespace = 0;
  1692. } else {
  1693. visual_data.visual_line_breaks.append(i);
  1694. line_width_so_far = glyph_width + glyph_spacing;
  1695. }
  1696. continue;
  1697. }
  1698. line_width_so_far += glyph_width + glyph_spacing;
  1699. }
  1700. }
  1701. visual_data.visual_line_breaks.append(line.length());
  1702. if (is_wrapping_enabled())
  1703. visual_data.visual_rect = { m_horizontal_content_padding, 0, available_width, static_cast<int>(visual_data.visual_line_breaks.size()) * line_height() };
  1704. else
  1705. visual_data.visual_rect = { m_horizontal_content_padding, 0, text_width_for_font(line.view(), font()), line_height() };
  1706. }
  1707. template<typename Callback>
  1708. void TextEditor::for_each_visual_line(size_t line_index, Callback callback) const
  1709. {
  1710. auto editor_visible_text_rect = visible_text_rect_in_inner_coordinates();
  1711. size_t start_of_line = 0;
  1712. size_t visual_line_index = 0;
  1713. auto& line = document().line(line_index);
  1714. auto& visual_data = m_line_visual_data[line_index];
  1715. for (auto visual_line_break : visual_data.visual_line_breaks) {
  1716. auto visual_line_view = Utf32View(line.code_points() + start_of_line, visual_line_break - start_of_line);
  1717. Gfx::IntRect visual_line_rect {
  1718. visual_data.visual_rect.x(),
  1719. visual_data.visual_rect.y() + ((int)visual_line_index * line_height()),
  1720. text_width_for_font(visual_line_view, font()) + font().glyph_spacing(),
  1721. line_height()
  1722. };
  1723. if (is_right_text_alignment(text_alignment()))
  1724. visual_line_rect.set_right_without_resize(editor_visible_text_rect.right());
  1725. if (is_single_line()) {
  1726. visual_line_rect.center_vertically_within(editor_visible_text_rect);
  1727. if (m_icon)
  1728. visual_line_rect.translate_by(icon_size() + icon_padding(), 0);
  1729. }
  1730. if (callback(visual_line_rect, visual_line_view, start_of_line, visual_line_index == visual_data.visual_line_breaks.size() - 1) == IterationDecision::Break)
  1731. break;
  1732. start_of_line = visual_line_break;
  1733. ++visual_line_index;
  1734. }
  1735. }
  1736. void TextEditor::set_wrapping_mode(WrappingMode mode)
  1737. {
  1738. if (m_wrapping_mode == mode)
  1739. return;
  1740. m_wrapping_mode = mode;
  1741. horizontal_scrollbar().set_visible(m_wrapping_mode == WrappingMode::NoWrap);
  1742. update_content_size();
  1743. recompute_all_visual_lines();
  1744. update();
  1745. }
  1746. void TextEditor::add_custom_context_menu_action(Action& action)
  1747. {
  1748. m_custom_context_menu_actions.append(action);
  1749. }
  1750. void TextEditor::did_change_font()
  1751. {
  1752. vertical_scrollbar().set_step(line_height());
  1753. recompute_all_visual_lines();
  1754. update();
  1755. AbstractScrollableWidget::did_change_font();
  1756. }
  1757. void TextEditor::document_did_append_line()
  1758. {
  1759. m_line_visual_data.append(make<LineVisualData>());
  1760. recompute_all_visual_lines();
  1761. update();
  1762. }
  1763. void TextEditor::document_did_remove_line(size_t line_index)
  1764. {
  1765. m_line_visual_data.remove(line_index);
  1766. recompute_all_visual_lines();
  1767. update();
  1768. }
  1769. void TextEditor::document_did_remove_all_lines()
  1770. {
  1771. m_line_visual_data.clear();
  1772. recompute_all_visual_lines();
  1773. update();
  1774. }
  1775. void TextEditor::document_did_insert_line(size_t line_index)
  1776. {
  1777. m_line_visual_data.insert(line_index, make<LineVisualData>());
  1778. recompute_all_visual_lines();
  1779. update();
  1780. }
  1781. void TextEditor::document_did_change(AllowCallback allow_callback)
  1782. {
  1783. did_change(allow_callback);
  1784. update();
  1785. }
  1786. void TextEditor::document_did_update_undo_stack()
  1787. {
  1788. auto make_action_text = [](auto prefix, auto suffix) {
  1789. StringBuilder builder;
  1790. builder.append(prefix);
  1791. if (suffix.has_value()) {
  1792. builder.append(' ');
  1793. builder.append(suffix.value());
  1794. }
  1795. return builder.to_deprecated_string();
  1796. };
  1797. m_undo_action->set_enabled(can_undo() && !text_is_secret());
  1798. m_redo_action->set_enabled(can_redo() && !text_is_secret());
  1799. m_undo_action->set_text(make_action_text("&Undo"sv, document().undo_stack().undo_action_text()));
  1800. m_redo_action->set_text(make_action_text("&Redo"sv, document().undo_stack().redo_action_text()));
  1801. // FIXME: This is currently firing more often than it should.
  1802. // Ideally we'd only send this out when the undo stack modified state actually changes.
  1803. if (on_modified_change)
  1804. on_modified_change(document().is_modified());
  1805. }
  1806. void TextEditor::document_did_set_text(AllowCallback allow_callback)
  1807. {
  1808. m_line_visual_data.clear();
  1809. for (size_t i = 0; i < m_document->line_count(); ++i)
  1810. m_line_visual_data.append(make<LineVisualData>());
  1811. document_did_change(allow_callback);
  1812. }
  1813. void TextEditor::document_did_set_cursor(TextPosition const& position)
  1814. {
  1815. set_cursor(position);
  1816. }
  1817. void TextEditor::cursor_did_change()
  1818. {
  1819. hide_autocomplete_if_needed();
  1820. }
  1821. void TextEditor::clipboard_content_did_change(DeprecatedString const& mime_type)
  1822. {
  1823. m_paste_action->set_enabled(is_editable() && mime_type.starts_with("text/"sv));
  1824. }
  1825. void TextEditor::set_document(TextDocument& document)
  1826. {
  1827. if (m_document.ptr() == &document)
  1828. return;
  1829. if (m_document)
  1830. m_document->unregister_client(*this);
  1831. m_document = document;
  1832. m_line_visual_data.clear();
  1833. for (size_t i = 0; i < m_document->line_count(); ++i) {
  1834. m_line_visual_data.append(make<LineVisualData>());
  1835. }
  1836. set_cursor(0, 0);
  1837. if (has_selection())
  1838. m_selection.clear();
  1839. recompute_all_visual_lines();
  1840. update();
  1841. m_document->register_client(*this);
  1842. }
  1843. void TextEditor::rehighlight_if_needed()
  1844. {
  1845. if (!m_needs_rehighlight)
  1846. return;
  1847. force_rehighlight();
  1848. }
  1849. void TextEditor::force_rehighlight()
  1850. {
  1851. if (m_highlighter)
  1852. m_highlighter->rehighlight(palette());
  1853. m_needs_rehighlight = false;
  1854. }
  1855. Syntax::Highlighter const* TextEditor::syntax_highlighter() const
  1856. {
  1857. return m_highlighter.ptr();
  1858. }
  1859. Syntax::Highlighter* TextEditor::syntax_highlighter()
  1860. {
  1861. return m_highlighter.ptr();
  1862. }
  1863. void TextEditor::set_syntax_highlighter(OwnPtr<Syntax::Highlighter> highlighter)
  1864. {
  1865. if (m_highlighter)
  1866. m_highlighter->detach();
  1867. m_highlighter = move(highlighter);
  1868. if (m_highlighter) {
  1869. m_highlighter->attach(*this);
  1870. m_needs_rehighlight = true;
  1871. } else
  1872. document().set_spans(Syntax::HighlighterClient::span_collection_index, {});
  1873. if (on_highlighter_change)
  1874. on_highlighter_change();
  1875. }
  1876. AutocompleteProvider const* TextEditor::autocomplete_provider() const
  1877. {
  1878. return m_autocomplete_provider.ptr();
  1879. }
  1880. void TextEditor::set_autocomplete_provider(OwnPtr<AutocompleteProvider>&& provider)
  1881. {
  1882. if (m_autocomplete_provider)
  1883. m_autocomplete_provider->detach();
  1884. m_autocomplete_provider = move(provider);
  1885. if (m_autocomplete_provider) {
  1886. m_autocomplete_provider->attach(*this);
  1887. if (!m_autocomplete_box)
  1888. m_autocomplete_box = make<AutocompleteBox>(*this);
  1889. }
  1890. if (m_autocomplete_box)
  1891. hide_autocomplete();
  1892. }
  1893. EditingEngine const* TextEditor::editing_engine() const
  1894. {
  1895. return m_editing_engine.ptr();
  1896. }
  1897. void TextEditor::set_editing_engine(OwnPtr<EditingEngine> editing_engine)
  1898. {
  1899. if (m_editing_engine)
  1900. m_editing_engine->detach();
  1901. m_editing_engine = move(editing_engine);
  1902. VERIFY(m_editing_engine);
  1903. m_editing_engine->attach(*this);
  1904. m_cursor_state = true;
  1905. update_cursor();
  1906. stop_timer();
  1907. start_timer(500);
  1908. }
  1909. int TextEditor::line_height() const
  1910. {
  1911. return font().preferred_line_height();
  1912. }
  1913. int TextEditor::fixed_glyph_width() const
  1914. {
  1915. VERIFY(font().is_fixed_width());
  1916. return font().glyph_width(' ');
  1917. }
  1918. void TextEditor::set_icon(Gfx::Bitmap const* icon)
  1919. {
  1920. if (m_icon == icon)
  1921. return;
  1922. m_icon = icon;
  1923. update();
  1924. }
  1925. void TextEditor::set_visualize_trailing_whitespace(bool enabled)
  1926. {
  1927. if (m_visualize_trailing_whitespace == enabled)
  1928. return;
  1929. m_visualize_trailing_whitespace = enabled;
  1930. update();
  1931. }
  1932. void TextEditor::set_visualize_leading_whitespace(bool enabled)
  1933. {
  1934. if (m_visualize_leading_whitespace == enabled)
  1935. return;
  1936. m_visualize_leading_whitespace = enabled;
  1937. update();
  1938. }
  1939. void TextEditor::set_should_autocomplete_automatically(bool value)
  1940. {
  1941. if (value == should_autocomplete_automatically())
  1942. return;
  1943. if (value) {
  1944. VERIFY(m_autocomplete_provider);
  1945. m_autocomplete_timer = Core::Timer::create_single_shot(m_automatic_autocomplete_delay_ms, [this] {
  1946. if (m_autocomplete_box && !m_autocomplete_box->is_visible())
  1947. try_show_autocomplete(UserRequestedAutocomplete::No);
  1948. });
  1949. return;
  1950. }
  1951. remove_child(*m_autocomplete_timer);
  1952. m_autocomplete_timer = nullptr;
  1953. }
  1954. void TextEditor::set_substitution_code_point(Optional<u32> code_point)
  1955. {
  1956. if (code_point.has_value())
  1957. VERIFY(is_unicode(code_point.value()));
  1958. m_substitution_string_data.clear();
  1959. m_substitution_code_point = move(code_point);
  1960. }
  1961. int TextEditor::number_of_visible_lines() const
  1962. {
  1963. return visible_content_rect().height() / line_height();
  1964. }
  1965. void TextEditor::set_ruler_visible(bool visible)
  1966. {
  1967. if (m_ruler_visible == visible)
  1968. return;
  1969. m_ruler_visible = visible;
  1970. recompute_all_visual_lines();
  1971. update();
  1972. }
  1973. void TextEditor::set_gutter_visible(bool visible)
  1974. {
  1975. if (m_gutter_visible == visible)
  1976. return;
  1977. m_gutter_visible = visible;
  1978. recompute_all_visual_lines();
  1979. update();
  1980. }
  1981. void TextEditor::set_cursor_line_highlighting(bool highlighted)
  1982. {
  1983. if (m_cursor_line_highlighting == highlighted)
  1984. return;
  1985. m_cursor_line_highlighting = highlighted;
  1986. update();
  1987. }
  1988. void TextEditor::undo()
  1989. {
  1990. clear_selection();
  1991. document().undo();
  1992. }
  1993. void TextEditor::redo()
  1994. {
  1995. clear_selection();
  1996. document().redo();
  1997. }
  1998. void TextEditor::set_text_is_secret(bool text_is_secret)
  1999. {
  2000. m_text_is_secret = text_is_secret;
  2001. document_did_update_undo_stack();
  2002. did_update_selection();
  2003. }
  2004. TextRange TextEditor::find_text(StringView needle, SearchDirection direction, GUI::TextDocument::SearchShouldWrap should_wrap, bool use_regex, bool match_case)
  2005. {
  2006. GUI::TextRange range {};
  2007. if (direction == SearchDirection::Forward) {
  2008. range = document().find_next(needle,
  2009. m_search_result_index.has_value() ? m_search_results[*m_search_result_index].end() : GUI::TextPosition {},
  2010. should_wrap, use_regex, match_case);
  2011. } else {
  2012. range = document().find_previous(needle,
  2013. m_search_result_index.has_value() ? m_search_results[*m_search_result_index].start() : GUI::TextPosition {},
  2014. should_wrap, use_regex, match_case);
  2015. }
  2016. if (!range.is_valid()) {
  2017. reset_search_results();
  2018. return {};
  2019. }
  2020. auto all_results = document().find_all(needle, use_regex, match_case);
  2021. on_search_results(range, all_results);
  2022. return range;
  2023. }
  2024. void TextEditor::reset_search_results()
  2025. {
  2026. m_search_result_index.clear();
  2027. m_search_results.clear();
  2028. document().set_spans(search_results_span_collection_index, {});
  2029. update();
  2030. }
  2031. void TextEditor::on_search_results(GUI::TextRange current, Vector<GUI::TextRange> all_results)
  2032. {
  2033. m_search_result_index.clear();
  2034. m_search_results.clear();
  2035. set_cursor(current.start());
  2036. if (auto it = all_results.find(current); it->is_valid())
  2037. m_search_result_index = it.index();
  2038. m_search_results = move(all_results);
  2039. Vector<GUI::TextDocumentSpan> spans;
  2040. for (size_t i = 0; i < m_search_results.size(); ++i) {
  2041. auto& result = m_search_results[i];
  2042. GUI::TextDocumentSpan span;
  2043. span.range = result;
  2044. span.attributes.background_color = palette().hover_highlight();
  2045. span.attributes.color = Color::from_argb(0xff000000); // So text without spans from a highlighter will have color
  2046. if (i == m_search_result_index) {
  2047. span.attributes.bold = true;
  2048. span.attributes.underline = true;
  2049. }
  2050. spans.append(move(span));
  2051. }
  2052. document().set_spans(search_results_span_collection_index, move(spans));
  2053. update();
  2054. }
  2055. }