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
|
#ifndef buffer_hh_INCLUDED
#define buffer_hh_INCLUDED
#include "coord.hh"
#include "flags.hh"
#include "safe_ptr.hh"
#include "scope.hh"
#include "shared_string.hh"
#include "value.hh"
#include "vector.hh"
namespace Kakoune
{
class Buffer;
constexpr time_t InvalidTime = 0;
// A BufferIterator permits to iterate over the characters of a buffer
class BufferIterator
{
public:
using value_type = char;
using difference_type = size_t;
using pointer = const value_type*;
using reference = const value_type&;
using iterator_category = std::random_access_iterator_tag;
BufferIterator() : m_buffer(nullptr) {}
BufferIterator(const Buffer& buffer, ByteCoord coord);
bool operator== (const BufferIterator& iterator) const;
bool operator!= (const BufferIterator& iterator) const;
bool operator< (const BufferIterator& iterator) const;
bool operator<= (const BufferIterator& iterator) const;
bool operator> (const BufferIterator& iterator) const;
bool operator>= (const BufferIterator& iterator) const;
char operator* () const;
char operator[](size_t n) const;
size_t operator- (const BufferIterator& iterator) const;
BufferIterator operator+ (ByteCount size) const;
BufferIterator operator- (ByteCount size) const;
BufferIterator& operator+= (ByteCount size);
BufferIterator& operator-= (ByteCount size);
BufferIterator& operator++ ();
BufferIterator& operator-- ();
BufferIterator operator++ (int);
BufferIterator operator-- (int);
const ByteCoord& coord() const { return m_coord; }
private:
SafePtr<const Buffer> m_buffer;
ByteCoord m_coord;
};
using BufferLines = Vector<StringDataPtr, MemoryDomain::BufferContent>;
// A Buffer is a in-memory representation of a file
//
// The Buffer class permits to read and mutate this file
// representation. It also manage modifications undo/redo and
// provides tools to deal with the line/column nature of text.
class Buffer : public SafeCountable, public OptionManagerWatcher, public Scope
{
public:
enum class Flags
{
None = 0,
File = 1,
New = 2,
Fifo = 4,
NoUndo = 8,
};
Buffer(String name, Flags flags, BufferLines lines = {},
time_t fs_timestamp = InvalidTime);
Buffer(const Buffer&) = delete;
Buffer& operator= (const Buffer&) = delete;
~Buffer();
Flags flags() const { return m_flags; }
Flags& flags() { return m_flags; }
bool set_name(String name);
BufferIterator insert(const BufferIterator& pos, StringView content);
BufferIterator erase(BufferIterator begin, BufferIterator end);
size_t timestamp() const;
time_t fs_timestamp() const;
void set_fs_timestamp(time_t ts);
void commit_undo_group();
bool undo();
bool redo();
String string(ByteCoord begin, ByteCoord end) const;
char byte_at(ByteCoord c) const;
ByteCount distance(ByteCoord begin, ByteCoord end) const;
ByteCoord advance(ByteCoord coord, ByteCount count) const;
ByteCoord next(ByteCoord coord) const;
ByteCoord prev(ByteCoord coord) const;
ByteCoord char_next(ByteCoord coord) const;
ByteCoord char_prev(ByteCoord coord) const;
ByteCoord back_coord() const;
ByteCoord end_coord() const;
bool is_valid(ByteCoord c) const;
bool is_end(ByteCoord c) const;
ByteCoord last_modification_coord() const;
BufferIterator begin() const;
BufferIterator end() const;
LineCount line_count() const;
StringView operator[](LineCount line) const
{ return m_lines[line]; }
StringDataPtr line_storage(LineCount line) const
{ return m_lines.get_storage(line); }
// returns an iterator at given coordinates. clamp line_and_column
BufferIterator iterator_at(ByteCoord coord) const;
// returns nearest valid coordinates from given ones
ByteCoord clamp(ByteCoord coord) const;
ByteCoord offset_coord(ByteCoord coord, CharCount offset);
ByteCoordAndTarget offset_coord(ByteCoordAndTarget coord, LineCount offset);
const String& name() const { return m_name; }
String display_name() const;
// returns true if the buffer is in a different state than
// the last time it was saved
bool is_modified() const;
// notify the buffer that it was saved in the current state
void notify_saved();
ValueMap& values() const { return m_values; }
void run_hook_in_own_context(StringView hook_name, StringView param);
void reload(BufferLines lines, time_t fs_timestamp = InvalidTime);
void check_invariant() const;
struct Change
{
enum Type : char { Insert, Erase };
Type type;
bool at_end;
ByteCoord begin;
ByteCoord end;
};
ConstArrayView<Change> changes_since(size_t timestamp) const;
String debug_description() const;
private:
void on_option_changed(const Option& option) override;
ByteCoord do_insert(ByteCoord pos, StringView content);
ByteCoord do_erase(ByteCoord begin, ByteCoord end);
struct Modification;
void apply_modification(const Modification& modification);
void revert_modification(const Modification& modification);
struct LineList : BufferLines
{
[[gnu::always_inline]]
StringDataPtr& get_storage(LineCount line)
{ return BufferLines::operator[]((int)line); }
[[gnu::always_inline]]
const StringDataPtr& get_storage(LineCount line) const
{ return BufferLines::operator[]((int)line); }
[[gnu::always_inline]]
StringView operator[](LineCount line) const
{ return get_storage(line)->strview(); }
StringView front() const { return BufferLines::front()->strview(); }
StringView back() const { return BufferLines::back()->strview(); }
};
LineList m_lines;
String m_name;
Flags m_flags;
using UndoGroup = Vector<Modification, MemoryDomain::BufferMeta>;
using History = Vector<UndoGroup, MemoryDomain::BufferMeta>;
History m_history;
History::iterator m_history_cursor;
UndoGroup m_current_undo_group;
size_t m_last_save_undo_index;
Vector<Change, MemoryDomain::BufferMeta> m_changes;
time_t m_fs_timestamp;
// Values are just data holding by the buffer, they are not part of its
// observable state
mutable ValueMap m_values;
};
template<> struct WithBitOps<Buffer::Flags> : std::true_type {};
}
#include "buffer.inl.hh"
#endif // buffer_hh_INCLUDED
|
