TextDocument.h 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. /*
  2. * Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2022, the SerenityOS developers.
  4. *
  5. * SPDX-License-Identifier: BSD-2-Clause
  6. */
  7. #pragma once
  8. #include <AK/HashTable.h>
  9. #include <AK/NonnullOwnPtrVector.h>
  10. #include <AK/NonnullRefPtr.h>
  11. #include <AK/Optional.h>
  12. #include <AK/RefCounted.h>
  13. #include <AK/Time.h>
  14. #include <AK/Utf32View.h>
  15. #include <LibCore/Forward.h>
  16. #include <LibGUI/Command.h>
  17. #include <LibGUI/Forward.h>
  18. #include <LibGUI/TextRange.h>
  19. #include <LibGUI/UndoStack.h>
  20. #include <LibGUI/Widget.h>
  21. #include <LibGfx/Color.h>
  22. #include <LibGfx/TextAttributes.h>
  23. #include <LibRegex/Regex.h>
  24. namespace GUI {
  25. constexpr Time COMMAND_COMMIT_TIME = Time::from_milliseconds(400);
  26. struct TextDocumentSpan {
  27. TextRange range;
  28. Gfx::TextAttributes attributes;
  29. u64 data { 0 };
  30. bool is_skippable { false };
  31. };
  32. class TextDocument : public RefCounted<TextDocument> {
  33. public:
  34. enum class SearchShouldWrap {
  35. No = 0,
  36. Yes
  37. };
  38. class Client {
  39. public:
  40. virtual ~Client() = default;
  41. virtual void document_did_append_line() = 0;
  42. virtual void document_did_insert_line(size_t) = 0;
  43. virtual void document_did_remove_line(size_t) = 0;
  44. virtual void document_did_remove_all_lines() = 0;
  45. virtual void document_did_change(AllowCallback = AllowCallback::Yes) = 0;
  46. virtual void document_did_set_text(AllowCallback = AllowCallback::Yes) = 0;
  47. virtual void document_did_set_cursor(TextPosition const&) = 0;
  48. virtual void document_did_update_undo_stack() = 0;
  49. virtual bool is_automatic_indentation_enabled() const = 0;
  50. virtual int soft_tab_width() const = 0;
  51. };
  52. static NonnullRefPtr<TextDocument> create(Client* client = nullptr);
  53. virtual ~TextDocument() = default;
  54. size_t line_count() const { return m_lines.size(); }
  55. TextDocumentLine const& line(size_t line_index) const { return m_lines[line_index]; }
  56. TextDocumentLine& line(size_t line_index) { return m_lines[line_index]; }
  57. void set_spans(u32 span_collection_index, Vector<TextDocumentSpan> spans);
  58. bool set_text(StringView, AllowCallback = AllowCallback::Yes);
  59. NonnullOwnPtrVector<TextDocumentLine> const& lines() const { return m_lines; }
  60. NonnullOwnPtrVector<TextDocumentLine>& lines() { return m_lines; }
  61. bool has_spans() const { return !m_spans.is_empty(); }
  62. Vector<TextDocumentSpan>& spans() { return m_spans; }
  63. Vector<TextDocumentSpan> const& spans() const { return m_spans; }
  64. void set_span_at_index(size_t index, TextDocumentSpan span) { m_spans[index] = move(span); }
  65. TextDocumentSpan const* span_at(TextPosition const&) const;
  66. void append_line(NonnullOwnPtr<TextDocumentLine>);
  67. NonnullOwnPtr<TextDocumentLine> take_line(size_t line_index);
  68. void remove_line(size_t line_index);
  69. void remove_all_lines();
  70. void insert_line(size_t line_index, NonnullOwnPtr<TextDocumentLine>);
  71. void register_client(Client&);
  72. void unregister_client(Client&);
  73. void update_views(Badge<TextDocumentLine>);
  74. String text() const;
  75. String text_in_range(TextRange const&) const;
  76. Vector<TextRange> find_all(StringView needle, bool regmatch = false, bool match_case = true);
  77. void update_regex_matches(StringView);
  78. TextRange find_next(StringView, TextPosition const& start = {}, SearchShouldWrap = SearchShouldWrap::Yes, bool regmatch = false, bool match_case = true);
  79. TextRange find_previous(StringView, TextPosition const& start = {}, SearchShouldWrap = SearchShouldWrap::Yes, bool regmatch = false, bool match_case = true);
  80. TextPosition next_position_after(TextPosition const&, SearchShouldWrap = SearchShouldWrap::Yes) const;
  81. TextPosition previous_position_before(TextPosition const&, SearchShouldWrap = SearchShouldWrap::Yes) const;
  82. u32 code_point_at(TextPosition const&) const;
  83. TextRange range_for_entire_line(size_t line_index) const;
  84. Optional<TextDocumentSpan> first_non_skippable_span_before(TextPosition const&) const;
  85. Optional<TextDocumentSpan> first_non_skippable_span_after(TextPosition const&) const;
  86. TextPosition first_word_break_before(TextPosition const&, bool start_at_column_before) const;
  87. TextPosition first_word_break_after(TextPosition const&) const;
  88. TextPosition first_word_before(TextPosition const&, bool start_at_column_before) const;
  89. void add_to_undo_stack(NonnullOwnPtr<TextDocumentUndoCommand>);
  90. bool can_undo() const { return m_undo_stack.can_undo(); }
  91. bool can_redo() const { return m_undo_stack.can_redo(); }
  92. void undo();
  93. void redo();
  94. UndoStack const& undo_stack() const { return m_undo_stack; }
  95. void notify_did_change();
  96. void set_all_cursors(TextPosition const&);
  97. TextPosition insert_at(TextPosition const&, u32, Client const* = nullptr);
  98. TextPosition insert_at(TextPosition const&, StringView, Client const* = nullptr);
  99. void remove(TextRange const&);
  100. virtual bool is_code_document() const { return false; }
  101. bool is_empty() const;
  102. bool is_modified() const { return m_undo_stack.is_current_modified(); }
  103. void set_unmodified();
  104. protected:
  105. explicit TextDocument(Client* client);
  106. private:
  107. void merge_span_collections();
  108. NonnullOwnPtrVector<TextDocumentLine> m_lines;
  109. HashMap<u32, Vector<TextDocumentSpan>> m_span_collections;
  110. Vector<TextDocumentSpan> m_spans;
  111. HashTable<Client*> m_clients;
  112. bool m_client_notifications_enabled { true };
  113. UndoStack m_undo_stack;
  114. RegexResult m_regex_result;
  115. size_t m_regex_result_match_index { 0 };
  116. size_t m_regex_result_match_capture_group_index { 0 };
  117. bool m_regex_needs_update { true };
  118. String m_regex_needle;
  119. };
  120. class TextDocumentLine {
  121. public:
  122. explicit TextDocumentLine(TextDocument&);
  123. explicit TextDocumentLine(TextDocument&, StringView);
  124. String to_utf8() const;
  125. Utf32View view() const { return { code_points(), length() }; }
  126. u32 const* code_points() const { return m_text.data(); }
  127. size_t length() const { return m_text.size(); }
  128. bool set_text(TextDocument&, StringView);
  129. void set_text(TextDocument&, Vector<u32>);
  130. void append(TextDocument&, u32);
  131. void prepend(TextDocument&, u32);
  132. void insert(TextDocument&, size_t index, u32);
  133. void remove(TextDocument&, size_t index);
  134. void append(TextDocument&, u32 const*, size_t);
  135. void truncate(TextDocument&, size_t length);
  136. void clear(TextDocument&);
  137. void remove_range(TextDocument&, size_t start, size_t length);
  138. size_t first_non_whitespace_column() const;
  139. Optional<size_t> last_non_whitespace_column() const;
  140. bool ends_in_whitespace() const;
  141. bool can_select() const;
  142. bool is_empty() const { return length() == 0; }
  143. size_t leading_spaces() const;
  144. private:
  145. // NOTE: This vector is null terminated.
  146. Vector<u32> m_text;
  147. };
  148. class TextDocumentUndoCommand : public Command {
  149. public:
  150. TextDocumentUndoCommand(TextDocument&);
  151. virtual ~TextDocumentUndoCommand() = default;
  152. virtual void perform_formatting(TextDocument::Client const&) { }
  153. void execute_from(TextDocument::Client const& client)
  154. {
  155. m_client = &client;
  156. redo();
  157. m_client = nullptr;
  158. }
  159. protected:
  160. bool commit_time_expired() const { return Time::now_monotonic() - m_timestamp >= COMMAND_COMMIT_TIME; }
  161. Time m_timestamp = Time::now_monotonic();
  162. TextDocument& m_document;
  163. TextDocument::Client const* m_client { nullptr };
  164. };
  165. class InsertTextCommand : public TextDocumentUndoCommand {
  166. public:
  167. InsertTextCommand(TextDocument&, String const&, TextPosition const&);
  168. virtual ~InsertTextCommand() = default;
  169. virtual void perform_formatting(TextDocument::Client const&) override;
  170. virtual void undo() override;
  171. virtual void redo() override;
  172. virtual bool merge_with(GUI::Command const&) override;
  173. virtual String action_text() const override;
  174. String const& text() const { return m_text; }
  175. TextRange const& range() const { return m_range; }
  176. private:
  177. String m_text;
  178. TextRange m_range;
  179. };
  180. class RemoveTextCommand : public TextDocumentUndoCommand {
  181. public:
  182. RemoveTextCommand(TextDocument&, String const&, TextRange const&);
  183. virtual ~RemoveTextCommand() = default;
  184. virtual void undo() override;
  185. virtual void redo() override;
  186. TextRange const& range() const { return m_range; }
  187. virtual bool merge_with(GUI::Command const&) override;
  188. virtual String action_text() const override;
  189. private:
  190. String m_text;
  191. TextRange m_range;
  192. };
  193. class ReplaceAllTextCommand final : public GUI::TextDocumentUndoCommand {
  194. public:
  195. ReplaceAllTextCommand(GUI::TextDocument& document, String const& text, GUI::TextRange const& range, String const& action_text);
  196. virtual ~ReplaceAllTextCommand() = default;
  197. void redo() override;
  198. void undo() override;
  199. bool merge_with(GUI::Command const&) override;
  200. String action_text() const override;
  201. String const& text() const { return m_text; }
  202. TextRange const& range() const { return m_range; }
  203. private:
  204. String m_text;
  205. GUI::TextRange m_range;
  206. String m_action_text;
  207. };
  208. class IndentSelection : public TextDocumentUndoCommand {
  209. public:
  210. IndentSelection(TextDocument&, size_t tab_width, TextRange const&);
  211. virtual void undo() override;
  212. virtual void redo() override;
  213. TextRange const& range() const { return m_range; }
  214. private:
  215. size_t m_tab_width { 0 };
  216. TextRange m_range;
  217. };
  218. class UnindentSelection : public TextDocumentUndoCommand {
  219. public:
  220. UnindentSelection(TextDocument&, size_t tab_width, TextRange const&);
  221. virtual void undo() override;
  222. virtual void redo() override;
  223. TextRange const& range() const { return m_range; }
  224. private:
  225. size_t m_tab_width { 0 };
  226. TextRange m_range;
  227. };
  228. }