#ifndef buffer_hh_INCLUDED #define buffer_hh_INCLUDED #include "line_and_column.hh" #include "hook_manager.hh" #include "option_manager.hh" #include "keymap_manager.hh" #include "string.hh" #include "value.hh" #include #include #include #include namespace Kakoune { class Buffer; constexpr time_t InvalidTime = 0; 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: 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, 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; 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 BufferCoord& coord() const { return m_coord; } private: safe_ptr m_buffer; BufferCoord m_coord; }; class BufferChangeListener { public: virtual void on_insert(const Buffer& buffer, BufferCoord begin, BufferCoord end) = 0; virtual void on_erase(const Buffer& buffer, BufferCoord begin, BufferCoord 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 OptionManagerWatcher { public: enum class Flags { None = 0, File = 1, New = 2, Fifo = 4, NoUndo = 8, }; Buffer(String name, Flags flags, std::vector lines = { "\n" }, 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, String content); BufferIterator erase(BufferIterator begin, BufferIterator end); size_t timestamp() const { return m_timestamp; } time_t fs_timestamp() const; void set_fs_timestamp(time_t ts); void commit_undo_group(); bool undo(); bool redo(); String string(BufferCoord begin, BufferCoord end) const; char byte_at(BufferCoord c) const; ByteCount offset(BufferCoord c) const; ByteCount distance(BufferCoord begin, BufferCoord end) const; BufferCoord advance(BufferCoord coord, ByteCount count) const; BufferCoord next(BufferCoord coord) const; BufferCoord prev(BufferCoord coord) const; BufferCoord char_next(BufferCoord coord) const; BufferCoord char_prev(BufferCoord coord) const; BufferCoord back_coord() const { return { line_count() - 1, m_lines.back().length() - 1 }; } BufferCoord end_coord() const { return { line_count() - 1, m_lines.back().length() }; } bool is_valid(BufferCoord c) const; bool is_end(BufferCoord c) const; BufferIterator begin() const; BufferIterator end() const; ByteCount byte_count() const; LineCount line_count() const; const String& operator[](LineCount line) const { return m_lines[line].content; } // returns an iterator at given coordinates. clamp line_and_column BufferIterator iterator_at(BufferCoord coord) const; // returns nearest valid coordinates from given ones BufferCoord clamp(BufferCoord coord) const; BufferCoord offset_coord(BufferCoord coord, CharCount offset); BufferCoord offset_coord(BufferCoord 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(); OptionManager& options() { return m_options; } const OptionManager& options() const { return m_options; } HookManager& hooks() { return m_hooks; } const HookManager& hooks() const { return m_hooks; } KeymapManager& keymaps() { return m_keymaps; } const KeymapManager& keymaps() const { return m_keymaps; } ValueMap& values() const { return m_values; } void run_hook_in_own_context(const String& hook_name, const String& param); std::unordered_set& change_listeners() const { return m_change_listeners; } void reload(std::vector lines, time_t fs_timestamp = InvalidTime); void check_invariant() const; private: void on_option_changed(const Option& option) override; 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; BufferCoord do_insert(BufferCoord pos, const String& content); BufferCoord do_erase(BufferCoord begin, BufferCoord end); String m_name; Flags m_flags; struct Modification; using UndoGroup = std::vector; friend class UndoGroupOptimizer; 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; time_t m_fs_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; KeymapManager m_keymaps; // Values are just data holding by the buffer, so it is part of its // observable state mutable ValueMap m_values; friend constexpr Flags operator|(Flags lhs, Flags rhs) { return (Flags)((int) lhs | (int) rhs); } friend Flags& operator|=(Flags& lhs, Flags rhs) { (int&) lhs |= (int) rhs; return lhs; } friend constexpr bool operator&(Flags lhs, Flags rhs) { return ((int) lhs & (int) rhs) != 0; } friend Flags& operator&=(Flags& lhs, Flags rhs) { (int&) lhs &= (int) rhs; return lhs; } friend constexpr Flags operator~(Flags lhs) { return (Flags)(~(int)lhs); } }; struct BufferListenerRegisterFuncs { static void insert(const Buffer& buffer, BufferChangeListener& listener) { buffer.change_listeners().insert(&listener); } static void remove(const Buffer& buffer, BufferChangeListener& listener) { buffer.change_listeners().erase(&listener); } }; class BufferChangeListener_AutoRegister : public BufferChangeListener, public AutoRegister { public: BufferChangeListener_AutoRegister(Buffer& buffer) : AutoRegister(buffer) {} Buffer& buffer() const { return registry(); } }; } #include "buffer_iterator.inl.hh" #endif // buffer_hh_INCLUDED