#ifndef context_hh_INCLUDED #define context_hh_INCLUDED #include "selection.hh" #include "optional.hh" #include "utils.hh" namespace Kakoune { class Window; class Buffer; class Client; class Scope; class InputHandler; class DisplayLine; class KeymapManager; class AliasRegistry; struct JumpList { void push(SelectionList jump); const SelectionList& forward(Context& context, int count); const SelectionList& backward(Context& context, int count); void forget_buffer(Buffer& buffer); friend bool operator==(const JumpList& lhs, const JumpList& rhs) { return lhs.m_jumps == rhs.m_jumps and lhs.m_current == rhs.m_current; } friend bool operator!=(const JumpList& lhs, const JumpList& rhs) { return not (lhs == rhs); } private: using Contents = Vector; Contents m_jumps; size_t m_current = 0; }; using LastSelectFunc = std::function; // A Context is used to access non singleton objects for various services // in commands. // // The Context object links a Client, a Window, an InputHandler and a // SelectionList. It may represent an interactive user window, a hook // execution or a macro replay context. class Context { public: enum class Flags { None = 0, Transient = 1, }; friend constexpr bool with_bit_ops(Meta::Type) { return true; } Context(InputHandler& input_handler, SelectionList selections, Flags flags, String name = ""); struct EmptyContextFlag {}; explicit Context(EmptyContextFlag); ~Context(); Context(const Context&) = delete; Context& operator=(const Context&) = delete; Buffer& buffer() const; bool has_buffer() const { return (bool)m_selections; } Window& window() const; bool has_window() const { return (bool)m_window; } Client& client() const; bool has_client() const { return (bool)m_client; } InputHandler& input_handler() const; bool has_input_handler() const { return (bool)m_input_handler; } SelectionList& selections(); const SelectionList& selections() const; Vector selections_content() const; // Return potentially out of date selections SelectionList& selections_write_only(); void change_buffer(Buffer& buffer); void set_client(Client& client); void set_window(Window& window); Scope& scope() const; OptionManager& options() const { return scope().options(); } HookManager& hooks() const { return scope().hooks(); } KeymapManager& keymaps() const { return scope().keymaps(); } AliasRegistry& aliases() const { return scope().aliases(); } FaceRegistry& faces() const { return scope().faces(); } void print_status(DisplayLine status) const; StringView main_sel_register_value(StringView reg) const; const String& name() const { return m_name; } void set_name(String name) { m_name = std::move(name); } bool is_editing() const { return m_edition_level!= 0; } void disable_undo_handling() { m_edition_level = -1; } NestedBool& hooks_disabled() { return m_hooks_disabled; } const NestedBool& hooks_disabled() const { return m_hooks_disabled; } NestedBool& keymaps_disabled() { return m_keymaps_disabled; } const NestedBool& keymaps_disabled() const { return m_keymaps_disabled; } NestedBool& history_disabled() { return m_history_disabled; } const NestedBool& history_disabled() const { return m_history_disabled; } Flags flags() const { return m_flags; } JumpList& jump_list() { return m_jump_list; } void push_jump(bool force = false) { if (force or not (m_flags & Flags::Transient)) m_jump_list.push(selections()); } template void set_last_select(Func&& last_select) { m_last_select = std::forward(last_select); } void repeat_last_select() { if (m_last_select) m_last_select(*this); } private: void begin_edition(); void end_edition(); int m_edition_level = 0; friend struct ScopedEdition; Flags m_flags; SafePtr m_input_handler; SafePtr m_window; SafePtr m_client; Optional m_selections; String m_name; JumpList m_jump_list; LastSelectFunc m_last_select; NestedBool m_hooks_disabled; NestedBool m_keymaps_disabled; NestedBool m_history_disabled; }; struct ScopedEdition { ScopedEdition(Context& context) : m_context(context), m_buffer(&context.buffer()) { m_context.begin_edition(); } ~ScopedEdition() { m_context.end_edition(); } Context& context() const { return m_context; } private: Context& m_context; SafePtr m_buffer; }; } #endif // context_hh_INCLUDED