kakoune/src/buffer.hh

218 lines
6.2 KiB
C++
Raw Normal View History

2011-09-02 18:51:20 +02:00
#ifndef buffer_hh_INCLUDED
#define buffer_hh_INCLUDED
#include "coord.hh"
#include "flags.hh"
#include "safe_ptr.hh"
#include "scope.hh"
#include "interned_string.hh"
#include "value.hh"
2015-01-12 14:58:41 +01:00
#include "vector.hh"
2013-04-09 20:05:40 +02:00
2011-09-02 18:51:20 +02:00
namespace Kakoune
{
class Buffer;
constexpr time_t InvalidTime = 0;
// A BufferIterator permits to iterate over the characters of a buffer
2011-09-02 18:51:20 +02:00
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;
2011-09-02 18:51:20 +02:00
BufferIterator() : m_buffer(nullptr) {}
BufferIterator(const Buffer& buffer, ByteCoord coord);
2011-09-02 18:51:20 +02:00
bool operator== (const BufferIterator& iterator) const;
bool operator!= (const BufferIterator& iterator) const;
bool operator< (const BufferIterator& iterator) const;
bool operator<= (const BufferIterator& iterator) const;
2011-09-28 22:53:29 +02:00
bool operator> (const BufferIterator& iterator) const;
bool operator>= (const BufferIterator& iterator) const;
2011-09-02 18:51:20 +02:00
char operator* () const;
char operator[](size_t n) const;
size_t operator- (const BufferIterator& iterator) const;
2011-09-02 18:51:20 +02:00
BufferIterator operator+ (ByteCount size) const;
BufferIterator operator- (ByteCount size) const;
2011-09-02 18:51:20 +02:00
BufferIterator& operator+= (ByteCount size);
BufferIterator& operator-= (ByteCount size);
2011-09-02 18:51:20 +02:00
BufferIterator& operator++ ();
BufferIterator& operator-- ();
BufferIterator operator++ (int);
BufferIterator operator-- (int);
const ByteCoord& coord() const { return m_coord; }
private:
safe_ptr<const Buffer> m_buffer;
ByteCoord m_coord;
2011-09-02 18:51:20 +02:00
};
// 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
2011-09-02 18:51:20 +02:00
{
public:
enum class Flags
2011-10-07 16:15:55 +02:00
{
None = 0,
File = 1,
New = 2,
Fifo = 4,
NoUndo = 8,
2011-10-07 16:15:55 +02:00
};
2015-01-12 14:58:41 +01:00
Buffer(String name, Flags flags, Vector<String> lines = { "\n" },
time_t fs_timestamp = InvalidTime);
2011-10-24 16:23:13 +02:00
Buffer(const Buffer&) = delete;
Buffer& operator= (const Buffer&) = delete;
~Buffer();
2011-09-02 18:51:20 +02:00
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);
2014-04-01 19:54:46 +02:00
size_t timestamp() const;
time_t fs_timestamp() const;
void set_fs_timestamp(time_t ts);
2012-08-15 17:07:53 +02:00
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;
2014-05-10 17:25:07 +02:00
ByteCoord advance(ByteCoord coord, ByteCount count) const;
ByteCoord next(ByteCoord coord) const;
ByteCoord prev(ByteCoord coord) const;
2014-05-10 17:25:07 +02:00
ByteCoord char_next(ByteCoord coord) const;
ByteCoord char_prev(ByteCoord coord) const;
2014-05-10 17:25:07 +02:00
ByteCoord back_coord() const;
ByteCoord end_coord() const;
bool is_valid(ByteCoord c) const;
bool is_end(ByteCoord c) const;
2014-05-10 17:25:07 +02:00
ByteCoord last_modification_coord() const;
2011-09-02 18:51:20 +02:00
BufferIterator begin() const;
BufferIterator end() const;
LineCount line_count() const;
const InternedString& operator[](LineCount line) const
{ return m_lines[line]; }
2011-09-02 18:51:20 +02:00
// returns an iterator at given coordinates. clamp line_and_column
BufferIterator iterator_at(ByteCoord coord) const;
2011-09-02 18:51:20 +02:00
2011-12-05 20:21:11 +01:00
// returns nearest valid coordinates from given ones
2014-05-10 17:25:07 +02:00
ByteCoord clamp(ByteCoord coord) const;
2011-09-02 18:51:20 +02:00
ByteCoord offset_coord(ByteCoord coord, CharCount offset);
ByteCoordAndTarget offset_coord(ByteCoordAndTarget coord, LineCount offset);
2013-12-15 15:14:52 +01:00
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(const String& hook_name, StringView param);
2015-01-12 14:58:41 +01:00
void reload(Vector<String> lines, time_t fs_timestamp = InvalidTime);
void check_invariant() const;
struct Change
{
enum Type { Insert, Erase };
Type type;
ByteCoord begin;
ByteCoord end;
bool at_end;
};
2015-01-06 14:40:56 +01:00
ArrayView<Change> changes_since(size_t timestamp) const;
String debug_description() const;
private:
2013-11-12 21:36:42 +01:00
void on_option_changed(const Option& option) override;
2015-01-10 13:56:09 +01:00
using LineListBase = Vector<InternedString, MemoryDomain::BufferContent>;
struct LineList : LineListBase
{
[[gnu::always_inline]]
InternedString& operator[](LineCount line)
2015-01-10 13:56:09 +01:00
{ return LineListBase::operator[]((int)line); }
2012-03-30 14:00:40 +02:00
[[gnu::always_inline]]
const InternedString& operator[](LineCount line) const
2015-01-10 13:56:09 +01:00
{ return LineListBase::operator[]((int)line); }
};
LineList m_lines;
ByteCoord do_insert(ByteCoord pos, StringView content);
ByteCoord do_erase(ByteCoord begin, ByteCoord end);
2011-09-02 18:51:20 +02:00
String m_name;
Flags m_flags;
struct Modification;
2015-01-12 14:58:41 +01:00
using UndoGroup = Vector<Modification>;
friend class UndoGroupOptimizer;
2015-01-10 13:56:09 +01:00
using History = Vector<UndoGroup, MemoryDomain::BufferMeta>;
History m_history;
History::iterator m_history_cursor;
UndoGroup m_current_undo_group;
void apply_modification(const Modification& modification);
void revert_modification(const Modification& modification);
2011-11-03 14:44:02 +01:00
size_t m_last_save_undo_index;
2015-01-10 13:56:09 +01:00
Vector<Change, MemoryDomain::BufferMeta> m_changes;
time_t m_fs_timestamp;
// Values are just data holding by the buffer, so it is part of its
// observable state
mutable ValueMap m_values;
};
template<> struct WithBitOps<Buffer::Flags> : std::true_type {};
2011-09-02 18:51:20 +02:00
}
#include "buffer.inl.hh"
2011-09-02 18:51:20 +02:00
#endif // buffer_hh_INCLUDED