TextEditor.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. *
  8. * 1. Redistributions of source code must retain the above copyright notice, this
  9. * list of conditions and the following disclaimer.
  10. *
  11. * 2. Redistributions in binary form must reproduce the above copyright notice,
  12. * this list of conditions and the following disclaimer in the documentation
  13. * and/or other materials provided with the distribution.
  14. *
  15. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  16. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  19. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  23. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25. */
  26. #pragma once
  27. #include <AK/Function.h>
  28. #include <AK/NonnullOwnPtrVector.h>
  29. #include <AK/NonnullRefPtrVector.h>
  30. #include <LibCore/ElapsedTimer.h>
  31. #include <LibCore/Timer.h>
  32. #include <LibGUI/Forward.h>
  33. #include <LibGUI/ScrollableWidget.h>
  34. #include <LibGUI/TextDocument.h>
  35. #include <LibGUI/TextRange.h>
  36. #include <LibGfx/TextAlignment.h>
  37. namespace GUI {
  38. class TextEditor
  39. : public ScrollableWidget
  40. , public TextDocument::Client {
  41. C_OBJECT(TextEditor)
  42. public:
  43. enum Type {
  44. MultiLine,
  45. SingleLine
  46. };
  47. enum Mode {
  48. Editable,
  49. ReadOnly,
  50. DisplayOnly
  51. };
  52. virtual ~TextEditor() override;
  53. const TextDocument& document() const { return *m_document; }
  54. TextDocument& document() { return *m_document; }
  55. virtual void set_document(TextDocument&);
  56. const String& placeholder() const { return m_placeholder; }
  57. void set_placeholder(const StringView& placeholder) { m_placeholder = placeholder; }
  58. TextDocumentLine& current_line() { return line(m_cursor.line()); }
  59. const TextDocumentLine& current_line() const { return line(m_cursor.line()); }
  60. void set_visualize_trailing_whitespace(bool);
  61. bool visualize_trailing_whitespace() const { return m_visualize_trailing_whitespace; }
  62. bool has_visible_list() const { return m_has_visible_list; }
  63. void set_has_visible_list(bool);
  64. virtual bool is_automatic_indentation_enabled() const final { return m_automatic_indentation_enabled; }
  65. void set_automatic_indentation_enabled(bool enabled) { m_automatic_indentation_enabled = enabled; }
  66. virtual int soft_tab_width() const final { return m_soft_tab_width; }
  67. bool is_line_wrapping_enabled() const { return m_line_wrapping_enabled; }
  68. void set_line_wrapping_enabled(bool);
  69. Gfx::TextAlignment text_alignment() const { return m_text_alignment; }
  70. void set_text_alignment(Gfx::TextAlignment);
  71. Type type() const { return m_type; }
  72. bool is_single_line() const { return m_type == SingleLine; }
  73. bool is_multi_line() const { return m_type == MultiLine; }
  74. Mode mode() const { return m_mode; }
  75. bool is_editable() const { return m_mode == Editable; }
  76. bool is_readonly() const { return m_mode == ReadOnly; }
  77. bool is_displayonly() const { return m_mode == DisplayOnly; }
  78. void set_mode(const Mode);
  79. bool is_ruler_visible() const { return m_ruler_visible; }
  80. void set_ruler_visible(bool b) { m_ruler_visible = b; }
  81. void set_icon(const Gfx::Bitmap*);
  82. const Gfx::Bitmap* icon() const { return m_icon; }
  83. Function<void()> on_cursor_change;
  84. Function<void()> on_selection_change;
  85. Function<void()> on_focusin;
  86. Function<void()> on_focusout;
  87. void set_text(const StringView&);
  88. void scroll_cursor_into_view();
  89. void scroll_position_into_view(const TextPosition&);
  90. size_t line_count() const { return document().line_count(); }
  91. TextDocumentLine& line(size_t index) { return document().line(index); }
  92. const TextDocumentLine& line(size_t index) const { return document().line(index); }
  93. NonnullOwnPtrVector<TextDocumentLine>& lines() { return document().lines(); }
  94. const NonnullOwnPtrVector<TextDocumentLine>& lines() const { return document().lines(); }
  95. int line_spacing() const { return m_line_spacing; }
  96. int line_height() const;
  97. TextPosition cursor() const { return m_cursor; }
  98. TextRange normalized_selection() const { return m_selection.normalized(); }
  99. void insert_at_cursor_or_replace_selection(const StringView&);
  100. bool write_to_file(const String& path);
  101. bool has_selection() const { return m_selection.is_valid(); }
  102. String selected_text() const;
  103. void set_selection(const TextRange&);
  104. void clear_selection();
  105. bool can_undo() const { return document().can_undo(); }
  106. bool can_redo() const { return document().can_redo(); }
  107. String text() const;
  108. void clear();
  109. void cut();
  110. void copy();
  111. void paste();
  112. void do_delete();
  113. void delete_current_line();
  114. void select_all();
  115. virtual void undo() { document().undo(); }
  116. virtual void redo() { document().redo(); }
  117. Function<void()> on_change;
  118. Function<void()> on_mousedown;
  119. Function<void()> on_return_pressed;
  120. Function<void()> on_escape_pressed;
  121. Function<void()> on_up_pressed;
  122. Function<void()> on_down_pressed;
  123. Function<void()> on_pageup_pressed;
  124. Function<void()> on_pagedown_pressed;
  125. Action& undo_action() { return *m_undo_action; }
  126. Action& redo_action() { return *m_redo_action; }
  127. Action& cut_action() { return *m_cut_action; }
  128. Action& copy_action() { return *m_copy_action; }
  129. Action& paste_action() { return *m_paste_action; }
  130. Action& delete_action() { return *m_delete_action; }
  131. Action& go_to_line_action() { return *m_go_to_line_action; }
  132. Action& select_all_action() { return *m_select_all_action; }
  133. void add_custom_context_menu_action(Action&);
  134. void set_cursor_and_focus_line(size_t line, size_t column);
  135. void set_cursor(size_t line, size_t column);
  136. void set_cursor(const TextPosition&);
  137. const SyntaxHighlighter* syntax_highlighter() const;
  138. void set_syntax_highlighter(OwnPtr<SyntaxHighlighter>);
  139. const AutocompleteProvider* autocomplete_provider() const;
  140. void set_autocomplete_provider(OwnPtr<AutocompleteProvider>&&);
  141. const EditingEngine* editing_engine() const;
  142. void set_editing_engine(OwnPtr<EditingEngine>);
  143. bool should_autocomplete_automatically() const { return m_autocomplete_timer; }
  144. void set_should_autocomplete_automatically(bool);
  145. bool is_in_drag_select() const { return m_in_drag_select; }
  146. TextRange* selection() { return &m_selection; };
  147. void did_update_selection();
  148. void did_change();
  149. void update_cursor();
  150. void add_code_point(u32 code_point);
  151. void reset_cursor_blink();
  152. void toggle_selection_if_needed_for_event(bool is_selecting);
  153. int number_of_visible_lines() const;
  154. Gfx::IntRect cursor_content_rect() const;
  155. TextPosition text_position_at_content_position(const Gfx::IntPoint&) const;
  156. void delete_text_range(TextRange);
  157. protected:
  158. explicit TextEditor(Type = Type::MultiLine);
  159. virtual void did_change_font() override;
  160. virtual void paint_event(PaintEvent&) override;
  161. virtual void mousedown_event(MouseEvent&) override;
  162. virtual void mouseup_event(MouseEvent&) override;
  163. virtual void mousemove_event(MouseEvent&) override;
  164. virtual void doubleclick_event(MouseEvent&) override;
  165. virtual void keydown_event(KeyEvent&) override;
  166. virtual void focusin_event(FocusEvent&) override;
  167. virtual void focusout_event(FocusEvent&) override;
  168. virtual void timer_event(Core::TimerEvent&) override;
  169. virtual void enter_event(Core::Event&) override;
  170. virtual void leave_event(Core::Event&) override;
  171. virtual void context_menu_event(ContextMenuEvent&) override;
  172. virtual void resize_event(ResizeEvent&) override;
  173. virtual void theme_change_event(ThemeChangeEvent&) override;
  174. virtual void cursor_did_change() { }
  175. Gfx::IntRect ruler_content_rect(size_t line) const;
  176. TextPosition text_position_at(const Gfx::IntPoint&) const;
  177. bool ruler_visible() const { return m_ruler_visible; }
  178. Gfx::IntRect content_rect_for_position(const TextPosition&) const;
  179. int ruler_width() const;
  180. private:
  181. friend class TextDocumentLine;
  182. // ^TextDocument::Client
  183. virtual void document_did_append_line() override;
  184. virtual void document_did_insert_line(size_t) override;
  185. virtual void document_did_remove_line(size_t) override;
  186. virtual void document_did_remove_all_lines() override;
  187. virtual void document_did_change() override;
  188. virtual void document_did_set_text() override;
  189. virtual void document_did_set_cursor(const TextPosition&) override;
  190. void create_actions();
  191. void paint_ruler(Painter&);
  192. void update_content_size();
  193. int fixed_glyph_width() const;
  194. void defer_reflow();
  195. void undefer_reflow();
  196. void try_show_autocomplete();
  197. int icon_size() const { return 16; }
  198. int icon_padding() const { return 2; }
  199. class ReflowDeferrer {
  200. public:
  201. ReflowDeferrer(TextEditor& editor)
  202. : m_editor(editor)
  203. {
  204. m_editor.defer_reflow();
  205. }
  206. ~ReflowDeferrer()
  207. {
  208. m_editor.undefer_reflow();
  209. }
  210. private:
  211. TextEditor& m_editor;
  212. };
  213. Gfx::IntRect line_content_rect(size_t item_index) const;
  214. Gfx::IntRect line_widget_rect(size_t line_index) const;
  215. void delete_selection();
  216. int content_x_for_position(const TextPosition&) const;
  217. Gfx::IntRect ruler_rect_in_inner_coordinates() const;
  218. Gfx::IntRect visible_text_rect_in_inner_coordinates() const;
  219. void recompute_all_visual_lines();
  220. void ensure_cursor_is_valid();
  221. void flush_pending_change_notification_if_needed();
  222. size_t visual_line_containing(size_t line_index, size_t column) const;
  223. void recompute_visual_lines(size_t line_index);
  224. void automatic_selection_scroll_timer_fired();
  225. template<class T, class... Args>
  226. inline void execute(Args&&... args)
  227. {
  228. auto command = make<T>(*m_document, forward<Args>(args)...);
  229. command->perform_formatting(*this);
  230. on_edit_action(*command);
  231. command->execute_from(*this);
  232. m_document->add_to_undo_stack(move(command));
  233. }
  234. virtual void on_edit_action(const Command&) { }
  235. Type m_type { MultiLine };
  236. Mode m_mode { Editable };
  237. TextPosition m_cursor;
  238. Gfx::TextAlignment m_text_alignment { Gfx::TextAlignment::CenterLeft };
  239. bool m_cursor_state { true };
  240. bool m_in_drag_select { false };
  241. bool m_ruler_visible { false };
  242. bool m_has_pending_change_notification { false };
  243. bool m_automatic_indentation_enabled { false };
  244. bool m_line_wrapping_enabled { false };
  245. bool m_has_visible_list { false };
  246. bool m_visualize_trailing_whitespace { true };
  247. int m_line_spacing { 4 };
  248. size_t m_soft_tab_width { 4 };
  249. int m_horizontal_content_padding { 3 };
  250. TextRange m_selection;
  251. RefPtr<Menu> m_context_menu;
  252. RefPtr<Action> m_undo_action;
  253. RefPtr<Action> m_redo_action;
  254. RefPtr<Action> m_cut_action;
  255. RefPtr<Action> m_copy_action;
  256. RefPtr<Action> m_paste_action;
  257. RefPtr<Action> m_delete_action;
  258. RefPtr<Action> m_go_to_line_action;
  259. RefPtr<Action> m_select_all_action;
  260. Core::ElapsedTimer m_triple_click_timer;
  261. NonnullRefPtrVector<Action> m_custom_context_menu_actions;
  262. size_t m_reflow_deferred { 0 };
  263. bool m_reflow_requested { false };
  264. bool is_visual_data_up_to_date() const { return !m_reflow_requested; }
  265. RefPtr<TextDocument> m_document;
  266. String m_placeholder { "" };
  267. template<typename Callback>
  268. void for_each_visual_line(size_t line_index, Callback) const;
  269. struct LineVisualData {
  270. Vector<size_t, 1> visual_line_breaks;
  271. Gfx::IntRect visual_rect;
  272. };
  273. NonnullOwnPtrVector<LineVisualData> m_line_visual_data;
  274. OwnPtr<SyntaxHighlighter> m_highlighter;
  275. OwnPtr<AutocompleteProvider> m_autocomplete_provider;
  276. OwnPtr<AutocompleteBox> m_autocomplete_box;
  277. bool m_should_keep_autocomplete_box { false };
  278. size_t m_automatic_autocomplete_delay_ms { 800 };
  279. RefPtr<Core::Timer> m_automatic_selection_scroll_timer;
  280. RefPtr<Core::Timer> m_autocomplete_timer;
  281. OwnPtr<EditingEngine> m_editing_engine;
  282. Gfx::IntPoint m_last_mousemove_position;
  283. RefPtr<Gfx::Bitmap> m_icon;
  284. };
  285. }