jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2023, Andreas Kling <kling@serenityos.org>
3 * Copyright (c) 2022, the SerenityOS developers.
4 * Copyright (c) 2023, Sam Atkins <atkinssj@serenityos.org>
5 *
6 * SPDX-License-Identifier: BSD-2-Clause
7 */
8
9#pragma once
10
11#include <AK/Function.h>
12#include <LibCore/ElapsedTimer.h>
13#include <LibCore/Timer.h>
14#include <LibGUI/AbstractScrollableWidget.h>
15#include <LibGUI/Action.h>
16#include <LibGUI/Clipboard.h>
17#include <LibGUI/Forward.h>
18#include <LibGUI/TextDocument.h>
19#include <LibGUI/TextRange.h>
20#include <LibGfx/TextAlignment.h>
21#include <LibSyntax/Forward.h>
22#include <LibSyntax/HighlighterClient.h>
23
24namespace GUI {
25
26class TextEditor
27 : public AbstractScrollableWidget
28 , public TextDocument::Client
29 , public Syntax::HighlighterClient
30 , public Clipboard::ClipboardClient {
31 C_OBJECT(TextEditor);
32
33public:
34 enum Type {
35 MultiLine,
36 SingleLine
37 };
38
39 enum Mode {
40 Editable,
41 ReadOnly,
42 DisplayOnly
43 };
44
45 enum WrappingMode {
46 NoWrap,
47 WrapAnywhere,
48 WrapAtWords
49 };
50
51 virtual ~TextEditor() override;
52
53 TextDocument const& document() const { return *m_document; }
54 TextDocument& document() { return *m_document; }
55 bool has_document() const { return !!m_document; }
56
57 virtual void set_document(TextDocument&);
58
59 DeprecatedString const& placeholder() const { return m_placeholder; }
60 void set_placeholder(StringView placeholder) { m_placeholder = placeholder; }
61
62 TextDocumentLine& current_line() { return line(m_cursor.line()); }
63 TextDocumentLine const& current_line() const { return line(m_cursor.line()); }
64
65 void set_visualize_trailing_whitespace(bool);
66 bool visualize_trailing_whitespace() const { return m_visualize_trailing_whitespace; }
67
68 void set_visualize_leading_whitespace(bool);
69 bool visualize_leading_whitespace() const { return m_visualize_leading_whitespace; }
70
71 bool is_cursor_line_highlighted() const { return m_cursor_line_highlighting; }
72 void set_cursor_line_highlighting(bool);
73
74 virtual bool is_automatic_indentation_enabled() const final { return m_automatic_indentation_enabled; }
75 void set_automatic_indentation_enabled(bool enabled) { m_automatic_indentation_enabled = enabled; }
76
77 virtual int soft_tab_width() const final { return m_soft_tab_width; }
78 void set_soft_tab_width(int width) { m_soft_tab_width = width; };
79
80 WrappingMode wrapping_mode() const { return m_wrapping_mode; }
81 bool is_wrapping_enabled() const { return m_wrapping_mode != WrappingMode::NoWrap; }
82 void set_wrapping_mode(WrappingMode);
83
84 Gfx::TextAlignment text_alignment() const { return m_text_alignment; }
85 void set_text_alignment(Gfx::TextAlignment);
86
87 Type type() const { return m_type; }
88 bool is_single_line() const { return m_type == SingleLine; }
89 bool is_multi_line() const { return m_type == MultiLine; }
90
91 Mode mode() const { return m_mode; }
92 bool is_editable() const { return m_mode == Editable; }
93 bool is_readonly() const { return m_mode == ReadOnly; }
94 bool is_displayonly() const { return m_mode == DisplayOnly; }
95 void set_mode(const Mode);
96
97 void set_editing_cursor();
98
99 bool is_relative_line_number() const { return m_relative_line_number; }
100 void set_relative_line_number(bool);
101
102 bool is_ruler_visible() const { return m_ruler_visible; }
103 void set_ruler_visible(bool);
104
105 bool is_gutter_visible() const { return m_gutter_visible; }
106 void set_gutter_visible(bool);
107
108 void set_icon(Gfx::Bitmap const*);
109 Gfx::Bitmap const* icon() const { return m_icon; }
110
111 Function<void()> on_cursor_change;
112 Function<void()> on_selection_change;
113 Function<void()> on_focusin;
114 Function<void()> on_focusout;
115 Function<void()> on_highlighter_change;
116
117 void set_text(StringView, AllowCallback = AllowCallback::Yes);
118 void scroll_cursor_into_view();
119 void scroll_position_into_view(TextPosition const&);
120 size_t line_count() const { return document().line_count(); }
121 TextDocumentLine& line(size_t index) { return document().line(index); }
122 TextDocumentLine const& line(size_t index) const { return document().line(index); }
123 Vector<NonnullOwnPtr<TextDocumentLine>>& lines() { return document().lines(); }
124 Vector<NonnullOwnPtr<TextDocumentLine>> const& lines() const { return document().lines(); }
125 int line_height() const;
126 TextPosition cursor() const { return m_cursor; }
127 TextRange normalized_selection() const { return m_selection.normalized(); }
128
129 void insert_at_cursor_or_replace_selection(StringView);
130 void replace_all_text_without_resetting_undo_stack(StringView text);
131 ErrorOr<void> write_to_file(StringView path);
132 ErrorOr<void> write_to_file(Core::File&);
133 bool has_selection() const { return m_selection.is_valid(); }
134 DeprecatedString selected_text() const;
135 size_t number_of_words() const;
136 size_t number_of_selected_words() const;
137 void set_selection(TextRange const&);
138 void clear_selection();
139 bool can_undo() const { return document().can_undo(); }
140 bool can_redo() const { return document().can_redo(); }
141
142 DeprecatedString text() const;
143
144 void clear();
145
146 void cut();
147 void copy();
148 void paste();
149 void do_delete();
150 void delete_current_line();
151 void delete_previous_word();
152 void delete_previous_char();
153 void delete_from_line_start_to_cursor();
154 void select_all();
155 void insert_emoji();
156 void set_or_clear_emoji_input_callback();
157 void select_current_line();
158 virtual void undo();
159 virtual void redo();
160 bool is_indenting_selection();
161 void indent_selection();
162 void unindent_selection();
163 void unindent_line();
164
165 Function<void()> on_change;
166 Function<void(bool modified)> on_modified_change;
167 Function<void()> on_mousedown;
168 Function<void()> on_return_pressed;
169 Function<void()> on_shift_return_pressed;
170 Function<void()> on_ctrl_return_pressed;
171 Function<void()> on_escape_pressed;
172 Function<void()> on_up_pressed;
173 Function<void()> on_down_pressed;
174 Function<void()> on_pageup_pressed;
175 Function<void()> on_pagedown_pressed;
176
177 Action& undo_action() { return *m_undo_action; }
178 Action& redo_action() { return *m_redo_action; }
179 Action& cut_action() { return *m_cut_action; }
180 Action& copy_action() { return *m_copy_action; }
181 Action& paste_action() { return *m_paste_action; }
182 Action& go_to_line_action() { return *m_go_to_line_action; }
183 Action& select_all_action() { return *m_select_all_action; }
184 Action& insert_emoji_action() { return *m_insert_emoji_action; }
185
186 void add_custom_context_menu_action(Action&);
187
188 void set_cursor_and_focus_line(size_t line, size_t column);
189 void set_cursor(size_t line, size_t column);
190 virtual void set_cursor(TextPosition const&);
191 void set_cursor_to_text_position(Gfx::IntPoint);
192 void set_cursor_to_end_of_visual_line();
193
194 Syntax::Highlighter* syntax_highlighter();
195 Syntax::Highlighter const* syntax_highlighter() const;
196 void set_syntax_highlighter(OwnPtr<Syntax::Highlighter>);
197
198 AutocompleteProvider const* autocomplete_provider() const;
199 void set_autocomplete_provider(OwnPtr<AutocompleteProvider>&&);
200
201 EditingEngine const* editing_engine() const;
202 void set_editing_engine(OwnPtr<EditingEngine>);
203
204 bool should_autocomplete_automatically() const { return m_autocomplete_timer; }
205 void set_should_autocomplete_automatically(bool);
206 void hide_autocomplete();
207
208 Optional<u32> const& substitution_code_point() const { return m_substitution_code_point; }
209 void set_substitution_code_point(Optional<u32> code_point);
210
211 bool is_in_drag_select() const { return m_in_drag_select; }
212
213 TextRange& selection() { return m_selection; };
214 void did_update_selection();
215 void did_change(AllowCallback = AllowCallback::Yes);
216 void update_cursor();
217
218 void add_code_point(u32 code_point);
219 void reset_cursor_blink();
220 void update_selection(bool is_selecting);
221
222 int number_of_visible_lines() const;
223 Gfx::IntRect cursor_content_rect() const;
224 TextPosition text_position_at_content_position(Gfx::IntPoint) const;
225
226 void delete_text_range(TextRange);
227
228 bool text_is_secret() const { return m_text_is_secret; }
229 void set_text_is_secret(bool text_is_secret);
230 void force_rehighlight();
231
232 enum class SearchDirection {
233 Forward,
234 Backward,
235 };
236 TextRange find_text(StringView needle, SearchDirection, GUI::TextDocument::SearchShouldWrap, bool use_regex, bool match_case);
237 void reset_search_results();
238 Optional<size_t> search_result_index() const { return m_search_result_index; }
239 Vector<TextRange> const& search_results() const { return m_search_results; }
240
241 virtual Optional<UISize> calculated_min_size() const override;
242
243 template<class T, class... Args>
244 inline void execute(Badge<EditingEngine>, Args&&... args)
245 {
246 execute<T>(forward<Args>(args)...);
247 }
248
249protected:
250 explicit TextEditor(Type = Type::MultiLine);
251
252 virtual void did_change_font() override;
253 virtual void paint_event(PaintEvent&) override;
254 virtual void mousedown_event(MouseEvent&) override;
255 virtual void mouseup_event(MouseEvent&) override;
256 virtual void mousemove_event(MouseEvent&) override;
257 virtual void doubleclick_event(MouseEvent&) override;
258 virtual void keydown_event(KeyEvent&) override;
259 virtual void focusin_event(FocusEvent&) override;
260 virtual void focusout_event(FocusEvent&) override;
261 virtual void timer_event(Core::TimerEvent&) override;
262 virtual void enter_event(Core::Event&) override;
263 virtual void leave_event(Core::Event&) override;
264 virtual void context_menu_event(ContextMenuEvent&) override;
265 virtual void resize_event(ResizeEvent&) override;
266 virtual void theme_change_event(ThemeChangeEvent&) override;
267 virtual void cursor_did_change();
268 Gfx::IntRect gutter_content_rect(size_t line) const;
269 Gfx::IntRect ruler_content_rect(size_t line) const;
270 Gfx::IntRect folding_indicator_rect(size_t line) const;
271
272 TextPosition text_position_at(Gfx::IntPoint) const;
273 bool ruler_visible() const { return m_ruler_visible; }
274 bool gutter_visible() const { return m_gutter_visible; }
275 Gfx::IntRect content_rect_for_position(TextPosition const&) const;
276 int gutter_width() const;
277 int ruler_width() const;
278 int folding_indicator_width() const;
279 int fixed_elements_width() const { return gutter_width() + ruler_width() + folding_indicator_width(); }
280
281 virtual void highlighter_did_set_spans(Vector<TextDocumentSpan> spans) final { document().set_spans(Syntax::HighlighterClient::span_collection_index, move(spans)); }
282 virtual void highlighter_did_set_folding_regions(Vector<TextDocumentFoldingRegion> folding_regions) final;
283
284private:
285 friend class TextDocumentLine;
286
287 // ^TextDocument::Client
288 virtual void document_did_append_line() override;
289 virtual void document_did_insert_line(size_t) override;
290 virtual void document_did_remove_line(size_t) override;
291 virtual void document_did_remove_all_lines() override;
292 virtual void document_did_change(AllowCallback = AllowCallback::Yes) override;
293 virtual void document_did_set_text(AllowCallback = AllowCallback::Yes) override;
294 virtual void document_did_set_cursor(TextPosition const&) override;
295 virtual void document_did_update_undo_stack() override;
296
297 // ^Syntax::HighlighterClient
298 virtual Vector<TextDocumentSpan>& spans() final { return document().spans(); }
299 virtual Vector<TextDocumentSpan> const& spans() const final { return document().spans(); }
300 virtual void set_span_at_index(size_t index, TextDocumentSpan span) final { document().set_span_at_index(index, move(span)); }
301 virtual Vector<GUI::TextDocumentFoldingRegion>& folding_regions() final { return document().folding_regions(); };
302 virtual Vector<GUI::TextDocumentFoldingRegion> const& folding_regions() const final { return document().folding_regions(); };
303 virtual void highlighter_did_request_update() final { update(); }
304 virtual DeprecatedString highlighter_did_request_text() const final { return text(); }
305 virtual GUI::TextDocument& highlighter_did_request_document() final { return document(); }
306 virtual GUI::TextPosition highlighter_did_request_cursor() const final { return m_cursor; }
307
308 // ^Clipboard::ClipboardClient
309 virtual void clipboard_content_did_change(DeprecatedString const& mime_type) override;
310
311 // ^GUI::AbstractScrollableWidget
312 virtual void automatic_scrolling_timer_did_fire() override;
313
314 void create_actions();
315 void update_content_size();
316 int fixed_glyph_width() const;
317
318 void defer_reflow();
319 void undefer_reflow();
320
321 enum UserRequestedAutocomplete {
322 No,
323 Yes
324 };
325 void try_show_autocomplete(UserRequestedAutocomplete);
326 void try_update_autocomplete(Function<void()> callback = {});
327 void force_update_autocomplete(Function<void()> callback = {});
328 void hide_autocomplete_if_needed();
329
330 int icon_size() const { return 16; }
331 int icon_padding() const { return 2; }
332
333 class ReflowDeferrer {
334 public:
335 ReflowDeferrer(TextEditor& editor)
336 : m_editor(editor)
337 {
338 m_editor.defer_reflow();
339 }
340 ~ReflowDeferrer()
341 {
342 m_editor.undefer_reflow();
343 }
344
345 private:
346 TextEditor& m_editor;
347 };
348
349 int text_width_for_font(auto const& text_view, Gfx::Font const&) const;
350 Utf32View substitution_code_point_view(size_t length) const;
351
352 Gfx::IntRect line_content_rect(size_t item_index) const;
353 Gfx::IntRect line_widget_rect(size_t line_index) const;
354 void delete_selection();
355 int content_x_for_position(TextPosition const&) const;
356 Gfx::IntRect gutter_rect_in_inner_coordinates() const;
357 Gfx::IntRect ruler_rect_in_inner_coordinates() const;
358 Gfx::IntRect folding_indicator_rect_in_inner_coordinates() const;
359 Gfx::IntRect visible_text_rect_in_inner_coordinates() const;
360 void recompute_all_visual_lines();
361 void ensure_cursor_is_valid();
362 void rehighlight_if_needed();
363
364 size_t visual_line_containing(size_t line_index, size_t column) const;
365 void recompute_visual_lines(size_t line_index, Vector<TextDocumentFoldingRegion const&>::Iterator& folded_region_iterator);
366
367 template<class T, class... Args>
368 inline void execute(Args&&... args)
369 {
370 auto command = make<T>(*m_document, forward<Args>(args)...);
371 command->perform_formatting(*this);
372 will_execute(*command);
373 command->execute_from(*this);
374 m_document->add_to_undo_stack(move(command));
375 }
376
377 virtual void will_execute(TextDocumentUndoCommand const&) { }
378 void on_search_results(GUI::TextRange current, Vector<GUI::TextRange> all_results);
379
380 static constexpr auto search_results_span_collection_index = 1;
381
382 Type m_type { MultiLine };
383 Mode m_mode { Editable };
384
385 TextPosition m_cursor;
386 Gfx::TextAlignment m_text_alignment { Gfx::TextAlignment::CenterLeft };
387 bool m_cursor_state { true };
388 bool m_in_drag_select { false };
389 bool m_relative_line_number { false };
390 bool m_ruler_visible { false };
391 bool m_gutter_visible { false };
392 bool m_needs_rehighlight { false };
393 bool m_automatic_indentation_enabled { false };
394 WrappingMode m_wrapping_mode { WrappingMode::NoWrap };
395 bool m_visualize_trailing_whitespace { true };
396 bool m_visualize_leading_whitespace { false };
397 bool m_cursor_line_highlighting { true };
398 size_t m_soft_tab_width { 4 };
399 int m_horizontal_content_padding { 3 };
400 TextRange m_selection {};
401
402 Optional<u32> m_substitution_code_point;
403 mutable OwnPtr<Vector<u32>> m_substitution_string_data; // Used to avoid repeated String construction.
404
405 RefPtr<Menu> m_context_menu;
406 RefPtr<Action> m_undo_action;
407 RefPtr<Action> m_redo_action;
408 RefPtr<Action> m_cut_action;
409 RefPtr<Action> m_copy_action;
410 RefPtr<Action> m_paste_action;
411 RefPtr<Action> m_go_to_line_action;
412 RefPtr<Action> m_select_all_action;
413 RefPtr<Action> m_insert_emoji_action;
414 Core::ElapsedTimer m_triple_click_timer;
415 Vector<NonnullRefPtr<Action>> m_custom_context_menu_actions;
416
417 size_t m_reflow_deferred { 0 };
418 bool m_reflow_requested { false };
419
420 bool is_visual_data_up_to_date() const { return !m_reflow_requested; }
421
422 RefPtr<TextDocument> m_document;
423
424 DeprecatedString m_placeholder { "" };
425
426 template<typename Callback>
427 void for_each_visual_line(size_t line_index, Callback) const;
428
429 struct LineVisualData {
430 Vector<Utf32View> visual_lines;
431 Gfx::IntRect visual_rect;
432 };
433
434 Vector<NonnullOwnPtr<LineVisualData>> m_line_visual_data;
435
436 OwnPtr<Syntax::Highlighter> m_highlighter;
437 OwnPtr<AutocompleteProvider> m_autocomplete_provider;
438 OwnPtr<AutocompleteBox> m_autocomplete_box;
439 bool m_should_keep_autocomplete_box { false };
440 size_t m_automatic_autocomplete_delay_ms { 800 };
441 RefPtr<Core::Timer> m_autocomplete_timer;
442
443 OwnPtr<EditingEngine> m_editing_engine;
444
445 Gfx::IntPoint m_last_mousemove_position;
446
447 RefPtr<Gfx::Bitmap const> m_icon;
448
449 bool m_text_is_secret { false };
450
451 Optional<size_t> m_search_result_index;
452 Vector<GUI::TextRange> m_search_results;
453 RefPtr<IncrementalSearchBanner> m_search_banner;
454};
455
456}