#ifndef buffer_hh_INCLUDED #define buffer_hh_INCLUDED #include #include #include #include #include "line_and_column.hh" #include "option_manager.hh" #include "hook_manager.hh" #include "string.hh" #include "units.hh" namespace Kakoune { class Buffer; struct BufferCoord : LineAndColumn { constexpr BufferCoord(LineCount line = 0, ByteCount column = 0) : LineAndColumn(line, column) {} }; // A BufferIterator permits to iterate over the characters of a buffer class BufferIterator { public: typedef char value_type; typedef size_t difference_type; typedef const value_type* pointer; typedef const value_type& reference; typedef std::bidirectional_iterator_tag iterator_category; BufferIterator() : m_buffer(nullptr) {} BufferIterator(const Buffer& buffer, BufferCoord 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; 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); BufferIterator& operator=(const BufferCoord& coord); void clamp(bool avoid_eol); bool is_begin() const; bool is_end() const; bool is_valid() const; const Buffer& buffer() const; const BufferCoord& coord() const { return m_coord; } LineCount line() const { return m_coord.line; } ByteCount column() const { return m_coord.column; } ByteCount offset() const; private: safe_ptr m_buffer; BufferCoord m_coord; }; class BufferChangeListener { public: virtual void on_insert(const BufferIterator& begin, const BufferIterator& end) = 0; virtual void on_erase(const BufferIterator& begin, const BufferIterator& end) = 0; }; // 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: enum class Flags { None = 0, File = 1, New = 2, Fifo = 4, NoUndo = 8, }; Buffer(String name, Flags flags, std::vector lines = { "\n" }); Buffer(const Buffer&) = delete; Buffer& operator= (const Buffer&) = delete; ~Buffer(); Flags flags() const { return m_flags; } Flags& flags() { return m_flags; } void insert(BufferIterator pos, String content); void erase(BufferIterator begin, BufferIterator end); size_t timestamp() const { return m_timestamp; } void commit_undo_group(); bool undo(); bool redo(); String string(const BufferIterator& begin, const BufferIterator& end) const; BufferIterator begin() const; BufferIterator end() const; ByteCount character_count() const; LineCount line_count() const; ByteCount line_length(LineCount line) const; const String& line_content(LineCount line) const { return m_lines[line].content; } // returns an iterator at given coordinates. line_and_column is // clamped according to avoid_eol. BufferIterator iterator_at(const BufferCoord& line_and_column, bool avoid_eol = false) const; // returns nearest valid coordinates from given ones // if avoid_eol, clamp to character before eol if line is not empty BufferCoord clamp(const BufferCoord& line_and_column, bool avoid_eol = false) const; // returns an iterator pointing to the first character of the line // iterator is on BufferIterator iterator_at_line_begin(const BufferIterator& iterator) const; // the same but taking a line number instead of an iterator BufferIterator iterator_at_line_begin(LineCount line) const; // returns an iterator pointing to the character after the last of the // line iterator is on (which is the first of the next line if iterator is // not on the last one) BufferIterator iterator_at_line_end(const BufferIterator& iterator) const; // the same but taking a line number instead of an iterator BufferIterator iterator_at_line_end(LineCount line) const; 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(); OptionManager& options() { return m_options; } const OptionManager& options() const { return m_options; } HookManager& hooks() { return m_hooks; } const HookManager& hooks() const { return m_hooks; } std::unordered_set& change_listeners() const { return m_change_listeners; } private: friend class BufferIterator; void check_invariant() const; struct Line { ByteCount start; String content; ByteCount length() const { return content.length(); } }; struct LineList : std::vector { Line& operator[](LineCount line) { return std::vector::operator[]((int)line); } const Line& operator[](LineCount line) const { return std::vector::operator[]((int)line); } }; LineList m_lines; void do_insert(const BufferIterator& pos, const String& content); void do_erase(const BufferIterator& begin, const BufferIterator& end); String m_name; Flags m_flags; struct Modification; typedef std::vector UndoGroup; std::vector m_history; std::vector::iterator m_history_cursor; UndoGroup m_current_undo_group; void apply_modification(const Modification& modification); void revert_modification(const Modification& modification); size_t m_last_save_undo_index; size_t m_timestamp; // this is mutable as adding or removing listeners is not muting the // buffer observable state. mutable std::unordered_set m_change_listeners; OptionManager m_options; HookManager m_hooks; }; constexpr Buffer::Flags operator|(Buffer::Flags lhs, Buffer::Flags rhs) { return (Buffer::Flags)((int) lhs | (int) rhs); } inline Buffer::Flags& operator|=(Buffer::Flags& lhs, Buffer::Flags rhs) { (int&) lhs |= (int) rhs; return lhs; } constexpr bool operator&(Buffer::Flags lhs, Buffer::Flags rhs) { return ((int) lhs & (int) rhs) != 0; } inline Buffer::Flags& operator&=(Buffer::Flags& lhs, Buffer::Flags rhs) { (int&) lhs &= (int) rhs; return lhs; } constexpr Buffer::Flags operator~(Buffer::Flags lhs) { return (Buffer::Flags)(~(int)lhs); } class BufferChangeListener_AutoRegister : public BufferChangeListener { public: BufferChangeListener_AutoRegister(const Buffer& buffer) : m_buffer(&buffer) { m_buffer->change_listeners().insert(this); } BufferChangeListener_AutoRegister(const BufferChangeListener_AutoRegister& other) : m_buffer(other.m_buffer) { m_buffer->change_listeners().insert(this); } BufferChangeListener_AutoRegister(BufferChangeListener_AutoRegister&& other) : m_buffer(other.m_buffer) { m_buffer->change_listeners().insert(this); } ~BufferChangeListener_AutoRegister() { m_buffer->change_listeners().erase(this); } BufferChangeListener_AutoRegister& operator=(const BufferChangeListener_AutoRegister& other) { if (m_buffer != other.m_buffer) { m_buffer->change_listeners().erase(this); m_buffer = other.m_buffer; m_buffer->change_listeners().insert(this); } return *this; } BufferChangeListener_AutoRegister& operator=(BufferChangeListener_AutoRegister&& other) { if (m_buffer != other.m_buffer) { m_buffer->change_listeners().erase(this); m_buffer = other.m_buffer; m_buffer->change_listeners().insert(this); } return *this; } const Buffer& buffer() const { return *m_buffer; } private: const Buffer* m_buffer; }; } #include "buffer_iterator.inl.hh" #endif // buffer_hh_INCLUDED