1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include <AK/HashTable.h>
#include <AK/NonnullOwnPtrVector.h>
#include <AK/NonnullRefPtr.h>
#include <AK/Optional.h>
#include <AK/RefCounted.h>
#include <AK/Utf32View.h>
#include <LibCore/Forward.h>
#include <LibGUI/Command.h>
#include <LibGUI/Forward.h>
#include <LibGUI/TextRange.h>
#include <LibGUI/UndoStack.h>
#include <LibGfx/Color.h>
#include <LibGfx/Forward.h>
namespace GUI {
struct TextDocumentSpan {
TextRange range;
Color color;
Optional<Color> background_color;
bool is_skippable { false };
bool is_underlined { false };
const Gfx::Font* font { nullptr };
void* data { nullptr };
};
class TextDocument : public RefCounted<TextDocument> {
public:
enum class SearchShouldWrap {
No = 0,
Yes
};
class Client {
public:
virtual ~Client();
virtual void document_did_append_line() = 0;
virtual void document_did_insert_line(size_t) = 0;
virtual void document_did_remove_line(size_t) = 0;
virtual void document_did_remove_all_lines() = 0;
virtual void document_did_change() = 0;
virtual void document_did_set_text() = 0;
virtual void document_did_set_cursor(const TextPosition&) = 0;
virtual bool is_automatic_indentation_enabled() const = 0;
virtual int soft_tab_width() const = 0;
};
static NonnullRefPtr<TextDocument> create(Client* client = nullptr);
virtual ~TextDocument();
size_t line_count() const { return m_lines.size(); }
const TextDocumentLine& line(size_t line_index) const { return m_lines[line_index]; }
TextDocumentLine& line(size_t line_index) { return m_lines[line_index]; }
void set_spans(const Vector<TextDocumentSpan>& spans) { m_spans = spans; }
void set_text(const StringView&);
const NonnullOwnPtrVector<TextDocumentLine>& lines() const { return m_lines; }
NonnullOwnPtrVector<TextDocumentLine>& lines() { return m_lines; }
bool has_spans() const { return !m_spans.is_empty(); }
Vector<TextDocumentSpan>& spans() { return m_spans; }
const Vector<TextDocumentSpan>& spans() const { return m_spans; }
void set_span_at_index(size_t index, TextDocumentSpan span) { m_spans[index] = move(span); }
const TextDocumentSpan* span_at(const TextPosition&) const;
void append_line(NonnullOwnPtr<TextDocumentLine>);
void remove_line(size_t line_index);
void remove_all_lines();
void insert_line(size_t line_index, NonnullOwnPtr<TextDocumentLine>);
void register_client(Client&);
void unregister_client(Client&);
void update_views(Badge<TextDocumentLine>);
String text() const;
String text_in_range(const TextRange&) const;
Vector<TextRange> find_all(const StringView& needle) const;
TextRange find_next(const StringView&, const TextPosition& start = {}, SearchShouldWrap = SearchShouldWrap::Yes) const;
TextRange find_previous(const StringView&, const TextPosition& start = {}, SearchShouldWrap = SearchShouldWrap::Yes) const;
TextPosition next_position_after(const TextPosition&, SearchShouldWrap = SearchShouldWrap::Yes) const;
TextPosition previous_position_before(const TextPosition&, SearchShouldWrap = SearchShouldWrap::Yes) const;
u32 code_point_at(const TextPosition&) const;
TextRange range_for_entire_line(size_t line_index) const;
Optional<TextDocumentSpan> first_non_skippable_span_before(const TextPosition&) const;
Optional<TextDocumentSpan> first_non_skippable_span_after(const TextPosition&) const;
TextPosition first_word_break_before(const TextPosition&, bool start_at_column_before) const;
TextPosition first_word_break_after(const TextPosition&) const;
void add_to_undo_stack(NonnullOwnPtr<TextDocumentUndoCommand>);
bool can_undo() const { return m_undo_stack.can_undo(); }
bool can_redo() const { return m_undo_stack.can_redo(); }
void undo();
void redo();
void notify_did_change();
void set_all_cursors(const TextPosition&);
TextPosition insert_at(const TextPosition&, u32, const Client* = nullptr);
TextPosition insert_at(const TextPosition&, const StringView&, const Client* = nullptr);
void remove(const TextRange&);
virtual bool is_code_document() const { return false; }
bool is_empty() const;
protected:
explicit TextDocument(Client* client);
private:
void update_undo_timer();
NonnullOwnPtrVector<TextDocumentLine> m_lines;
Vector<TextDocumentSpan> m_spans;
HashTable<Client*> m_clients;
bool m_client_notifications_enabled { true };
UndoStack m_undo_stack;
RefPtr<Core::Timer> m_undo_timer;
};
class TextDocumentLine {
public:
explicit TextDocumentLine(TextDocument&);
explicit TextDocumentLine(TextDocument&, const StringView&);
String to_utf8() const;
Utf32View view() const { return { code_points(), length() }; }
const u32* code_points() const { return m_text.data(); }
size_t length() const { return m_text.size(); }
void set_text(TextDocument&, const StringView&);
void set_text(TextDocument&, Vector<u32>);
void append(TextDocument&, u32);
void prepend(TextDocument&, u32);
void insert(TextDocument&, size_t index, u32);
void remove(TextDocument&, size_t index);
void append(TextDocument&, const u32*, size_t);
void truncate(TextDocument&, size_t length);
void clear(TextDocument&);
void remove_range(TextDocument&, size_t start, size_t length);
size_t first_non_whitespace_column() const;
Optional<size_t> last_non_whitespace_column() const;
bool ends_in_whitespace() const;
bool is_empty() const { return length() == 0; }
private:
// NOTE: This vector is null terminated.
Vector<u32> m_text;
};
class TextDocumentUndoCommand : public Command {
public:
TextDocumentUndoCommand(TextDocument&);
virtual ~TextDocumentUndoCommand();
void execute_from(const TextDocument::Client& client)
{
m_client = &client;
redo();
m_client = nullptr;
}
protected:
TextDocument& m_document;
const TextDocument::Client* m_client { nullptr };
};
class InsertTextCommand : public TextDocumentUndoCommand {
public:
InsertTextCommand(TextDocument&, const String&, const TextPosition&);
virtual void undo() override;
virtual void redo() override;
virtual bool is_insert_text() const override { return true; }
const String& text() const { return m_text; }
const TextRange& range() const { return m_range; }
private:
String m_text;
TextRange m_range;
};
class RemoveTextCommand : public TextDocumentUndoCommand {
public:
RemoveTextCommand(TextDocument&, const String&, const TextRange&);
virtual void undo() override;
virtual void redo() override;
virtual bool is_remove_text() const override { return true; }
const TextRange& range() const { return m_range; }
private:
String m_text;
TextRange m_range;
};
}
|
