TextEditor.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #pragma once
  7. #include <AK/Function.h>
  8. #include <AK/NonnullOwnPtrVector.h>
  9. #include <AK/NonnullRefPtrVector.h>
  10. #include <LibCore/ElapsedTimer.h>
  11. #include <LibCore/Timer.h>
  12. #include <LibGUI/AbstractScrollableWidget.h>
  13. #include <LibGUI/Forward.h>
  14. #include <LibGUI/TextDocument.h>
  15. #include <LibGUI/TextRange.h>
  16. #include <LibGfx/TextAlignment.h>
  17. #include <LibSyntax/Forward.h>
  18. #include <LibSyntax/HighlighterClient.h>
  19. namespace GUI {
  20. class TextEditor
  21. : public AbstractScrollableWidget
  22. , public TextDocument::Client
  23. , public Syntax::HighlighterClient {
  24. C_OBJECT(TextEditor);
  25. public:
  26. enum Type {
  27. MultiLine,
  28. SingleLine
  29. };
  30. enum Mode {
  31. Editable,
  32. ReadOnly,
  33. DisplayOnly
  34. };
  35. enum WrappingMode {
  36. NoWrap,
  37. WrapAnywhere,
  38. WrapAtWords
  39. };
  40. virtual ~TextEditor() override;
  41. const TextDocument& document() const { return *m_document; }
  42. TextDocument& document() { return *m_document; }
  43. virtual void set_document(TextDocument&);
  44. const String& placeholder() const { return m_placeholder; }
  45. void set_placeholder(const StringView& placeholder) { m_placeholder = placeholder; }
  46. TextDocumentLine& current_line() { return line(m_cursor.line()); }
  47. const TextDocumentLine& current_line() const { return line(m_cursor.line()); }
  48. void set_visualize_trailing_whitespace(bool);
  49. bool visualize_trailing_whitespace() const { return m_visualize_trailing_whitespace; }
  50. void set_visualize_leading_whitespace(bool);
  51. bool visualize_leading_whitespace() const { return m_visualize_leading_whitespace; }
  52. virtual bool is_automatic_indentation_enabled() const final { return m_automatic_indentation_enabled; }
  53. void set_automatic_indentation_enabled(bool enabled) { m_automatic_indentation_enabled = enabled; }
  54. virtual int soft_tab_width() const final { return m_soft_tab_width; }
  55. void set_soft_tab_width(int width) { m_soft_tab_width = width; };
  56. WrappingMode wrapping_mode() const { return m_wrapping_mode; }
  57. bool is_wrapping_enabled() const { return m_wrapping_mode != WrappingMode::NoWrap; }
  58. void set_wrapping_mode(WrappingMode);
  59. Gfx::TextAlignment text_alignment() const { return m_text_alignment; }
  60. void set_text_alignment(Gfx::TextAlignment);
  61. Type type() const { return m_type; }
  62. bool is_single_line() const { return m_type == SingleLine; }
  63. bool is_multi_line() const { return m_type == MultiLine; }
  64. Mode mode() const { return m_mode; }
  65. bool is_editable() const { return m_mode == Editable; }
  66. bool is_readonly() const { return m_mode == ReadOnly; }
  67. bool is_displayonly() const { return m_mode == DisplayOnly; }
  68. void set_mode(const Mode);
  69. bool is_ruler_visible() const { return m_ruler_visible; }
  70. void set_ruler_visible(bool);
  71. void set_icon(const Gfx::Bitmap*);
  72. const Gfx::Bitmap* icon() const { return m_icon; }
  73. Function<void()> on_cursor_change;
  74. Function<void()> on_selection_change;
  75. Function<void()> on_focusin;
  76. Function<void()> on_focusout;
  77. void set_text(const StringView&);
  78. void scroll_cursor_into_view();
  79. void scroll_position_into_view(const TextPosition&);
  80. size_t line_count() const { return document().line_count(); }
  81. TextDocumentLine& line(size_t index) { return document().line(index); }
  82. const TextDocumentLine& line(size_t index) const { return document().line(index); }
  83. NonnullOwnPtrVector<TextDocumentLine>& lines() { return document().lines(); }
  84. const NonnullOwnPtrVector<TextDocumentLine>& lines() const { return document().lines(); }
  85. int line_spacing() const { return m_line_spacing; }
  86. int line_height() const;
  87. TextPosition cursor() const { return m_cursor; }
  88. TextRange normalized_selection() const { return m_selection.normalized(); }
  89. void insert_at_cursor_or_replace_selection(const StringView&);
  90. bool write_to_file(const String& path);
  91. bool has_selection() const { return m_selection.is_valid(); }
  92. String selected_text() const;
  93. void set_selection(const TextRange&);
  94. void clear_selection();
  95. bool can_undo() const { return document().can_undo(); }
  96. bool can_redo() const { return document().can_redo(); }
  97. String text() const;
  98. void clear();
  99. void cut();
  100. void copy();
  101. void paste();
  102. void do_delete();
  103. void delete_current_line();
  104. void select_all();
  105. virtual void undo() { document().undo(); }
  106. virtual void redo() { document().redo(); }
  107. Function<void()> on_change;
  108. Function<void(bool modified)> on_modified_change;
  109. Function<void()> on_mousedown;
  110. Function<void()> on_return_pressed;
  111. Function<void()> on_escape_pressed;
  112. Function<void()> on_up_pressed;
  113. Function<void()> on_down_pressed;
  114. Function<void()> on_pageup_pressed;
  115. Function<void()> on_pagedown_pressed;
  116. Action& undo_action() { return *m_undo_action; }
  117. Action& redo_action() { return *m_redo_action; }
  118. Action& cut_action() { return *m_cut_action; }
  119. Action& copy_action() { return *m_copy_action; }
  120. Action& paste_action() { return *m_paste_action; }
  121. Action& delete_action() { return *m_delete_action; }
  122. Action& go_to_line_action() { return *m_go_to_line_action; }
  123. Action& select_all_action() { return *m_select_all_action; }
  124. void add_custom_context_menu_action(Action&);
  125. void set_cursor_and_focus_line(size_t line, size_t column);
  126. void set_cursor(size_t line, size_t column);
  127. virtual void set_cursor(const TextPosition&);
  128. const Syntax::Highlighter* syntax_highlighter() const;
  129. void set_syntax_highlighter(OwnPtr<Syntax::Highlighter>);
  130. const AutocompleteProvider* autocomplete_provider() const;
  131. void set_autocomplete_provider(OwnPtr<AutocompleteProvider>&&);
  132. const EditingEngine* editing_engine() const;
  133. void set_editing_engine(OwnPtr<EditingEngine>);
  134. bool should_autocomplete_automatically() const { return m_autocomplete_timer; }
  135. void set_should_autocomplete_automatically(bool);
  136. bool is_in_drag_select() const { return m_in_drag_select; }
  137. TextRange* selection() { return &m_selection; };
  138. void did_update_selection();
  139. void did_change();
  140. void update_cursor();
  141. void add_code_point(u32 code_point);
  142. void reset_cursor_blink();
  143. void update_selection(bool is_selecting);
  144. int number_of_visible_lines() const;
  145. Gfx::IntRect cursor_content_rect() const;
  146. TextPosition text_position_at_content_position(const Gfx::IntPoint&) const;
  147. void delete_text_range(TextRange);
  148. protected:
  149. explicit TextEditor(Type = Type::MultiLine);
  150. virtual void did_change_font() override;
  151. virtual void paint_event(PaintEvent&) override;
  152. virtual void mousedown_event(MouseEvent&) override;
  153. virtual void mouseup_event(MouseEvent&) override;
  154. virtual void mousemove_event(MouseEvent&) override;
  155. virtual void doubleclick_event(MouseEvent&) override;
  156. virtual void keydown_event(KeyEvent&) override;
  157. virtual void focusin_event(FocusEvent&) override;
  158. virtual void focusout_event(FocusEvent&) override;
  159. virtual void timer_event(Core::TimerEvent&) override;
  160. virtual void enter_event(Core::Event&) override;
  161. virtual void leave_event(Core::Event&) override;
  162. virtual void context_menu_event(ContextMenuEvent&) override;
  163. virtual void resize_event(ResizeEvent&) override;
  164. virtual void theme_change_event(ThemeChangeEvent&) override;
  165. virtual void cursor_did_change() { }
  166. Gfx::IntRect ruler_content_rect(size_t line) const;
  167. TextPosition text_position_at(const Gfx::IntPoint&) const;
  168. bool ruler_visible() const { return m_ruler_visible; }
  169. Gfx::IntRect content_rect_for_position(const TextPosition&) const;
  170. int ruler_width() const;
  171. private:
  172. friend class TextDocumentLine;
  173. // ^TextDocument::Client
  174. virtual void document_did_append_line() override;
  175. virtual void document_did_insert_line(size_t) override;
  176. virtual void document_did_remove_line(size_t) override;
  177. virtual void document_did_remove_all_lines() override;
  178. virtual void document_did_change() override;
  179. virtual void document_did_set_text() override;
  180. virtual void document_did_set_cursor(const TextPosition&) override;
  181. virtual void document_did_update_undo_stack() override;
  182. // ^Syntax::HighlighterClient
  183. virtual Vector<TextDocumentSpan>& spans() final { return document().spans(); }
  184. virtual const Vector<TextDocumentSpan>& spans() const final { return document().spans(); }
  185. virtual void highlighter_did_set_spans(Vector<TextDocumentSpan> spans) final { document().set_spans(move(spans)); }
  186. virtual void set_span_at_index(size_t index, TextDocumentSpan span) final { document().set_span_at_index(index, move(span)); }
  187. virtual void highlighter_did_request_update() final { update(); }
  188. virtual String highlighter_did_request_text() const final { return text(); }
  189. virtual GUI::TextDocument& highlighter_did_request_document() final { return document(); }
  190. virtual GUI::TextPosition highlighter_did_request_cursor() const final { return m_cursor; }
  191. void create_actions();
  192. void paint_ruler(Painter&);
  193. void update_content_size();
  194. int fixed_glyph_width() const;
  195. void defer_reflow();
  196. void undefer_reflow();
  197. void try_show_autocomplete();
  198. int icon_size() const { return 16; }
  199. int icon_padding() const { return 2; }
  200. class ReflowDeferrer {
  201. public:
  202. ReflowDeferrer(TextEditor& editor)
  203. : m_editor(editor)
  204. {
  205. m_editor.defer_reflow();
  206. }
  207. ~ReflowDeferrer()
  208. {
  209. m_editor.undefer_reflow();
  210. }
  211. private:
  212. TextEditor& m_editor;
  213. };
  214. Gfx::IntRect line_content_rect(size_t item_index) const;
  215. Gfx::IntRect line_widget_rect(size_t line_index) const;
  216. void delete_selection();
  217. int content_x_for_position(const TextPosition&) const;
  218. Gfx::IntRect ruler_rect_in_inner_coordinates() const;
  219. Gfx::IntRect visible_text_rect_in_inner_coordinates() const;
  220. void recompute_all_visual_lines();
  221. void ensure_cursor_is_valid();
  222. void flush_pending_change_notification_if_needed();
  223. size_t visual_line_containing(size_t line_index, size_t column) const;
  224. void recompute_visual_lines(size_t line_index);
  225. void automatic_selection_scroll_timer_fired();
  226. template<class T, class... Args>
  227. inline void execute(Args&&... args)
  228. {
  229. auto command = make<T>(*m_document, forward<Args>(args)...);
  230. command->perform_formatting(*this);
  231. on_edit_action(*command);
  232. command->execute_from(*this);
  233. m_document->add_to_undo_stack(move(command));
  234. }
  235. virtual void on_edit_action(const Command&) { }
  236. Type m_type { MultiLine };
  237. Mode m_mode { Editable };
  238. TextPosition m_cursor;
  239. Gfx::TextAlignment m_text_alignment { Gfx::TextAlignment::CenterLeft };
  240. bool m_cursor_state { true };
  241. bool m_in_drag_select { false };
  242. bool m_ruler_visible { false };
  243. bool m_has_pending_change_notification { false };
  244. bool m_automatic_indentation_enabled { false };
  245. WrappingMode m_wrapping_mode { WrappingMode::NoWrap };
  246. bool m_visualize_trailing_whitespace { true };
  247. bool m_visualize_leading_whitespace { false };
  248. int m_line_spacing { 4 };
  249. size_t m_soft_tab_width { 4 };
  250. int m_horizontal_content_padding { 3 };
  251. TextRange m_selection;
  252. RefPtr<Menu> m_context_menu;
  253. RefPtr<Action> m_undo_action;
  254. RefPtr<Action> m_redo_action;
  255. RefPtr<Action> m_cut_action;
  256. RefPtr<Action> m_copy_action;
  257. RefPtr<Action> m_paste_action;
  258. RefPtr<Action> m_delete_action;
  259. RefPtr<Action> m_go_to_line_action;
  260. RefPtr<Action> m_select_all_action;
  261. Core::ElapsedTimer m_triple_click_timer;
  262. NonnullRefPtrVector<Action> m_custom_context_menu_actions;
  263. size_t m_reflow_deferred { 0 };
  264. bool m_reflow_requested { false };
  265. bool is_visual_data_up_to_date() const { return !m_reflow_requested; }
  266. RefPtr<TextDocument> m_document;
  267. String m_placeholder { "" };
  268. template<typename Callback>
  269. void for_each_visual_line(size_t line_index, Callback) const;
  270. struct LineVisualData {
  271. Vector<size_t, 1> visual_line_breaks;
  272. Gfx::IntRect visual_rect;
  273. };
  274. NonnullOwnPtrVector<LineVisualData> m_line_visual_data;
  275. OwnPtr<Syntax::Highlighter> m_highlighter;
  276. OwnPtr<AutocompleteProvider> m_autocomplete_provider;
  277. OwnPtr<AutocompleteBox> m_autocomplete_box;
  278. bool m_should_keep_autocomplete_box { false };
  279. size_t m_automatic_autocomplete_delay_ms { 800 };
  280. RefPtr<Core::Timer> m_automatic_selection_scroll_timer;
  281. RefPtr<Core::Timer> m_autocomplete_timer;
  282. OwnPtr<EditingEngine> m_editing_engine;
  283. Gfx::IntPoint m_last_mousemove_position;
  284. RefPtr<Gfx::Bitmap> m_icon;
  285. };
  286. }