2011-11-26 19:32:57 +01:00
|
|
|
#ifndef context_hh_INCLUDED
|
|
|
|
#define context_hh_INCLUDED
|
|
|
|
|
2014-05-14 01:59:36 +02:00
|
|
|
#include "selection.hh"
|
2014-06-27 20:34:26 +02:00
|
|
|
#include "optional.hh"
|
2014-12-19 00:12:58 +01:00
|
|
|
#include "flags.hh"
|
2013-12-20 21:10:08 +01:00
|
|
|
|
2011-11-26 19:32:57 +01:00
|
|
|
namespace Kakoune
|
|
|
|
{
|
|
|
|
|
2013-04-09 19:39:03 +02:00
|
|
|
class Window;
|
|
|
|
class Buffer;
|
2013-09-12 23:47:23 +02:00
|
|
|
class Client;
|
2014-10-30 15:00:42 +01:00
|
|
|
class Scope;
|
2013-11-14 19:09:15 +01:00
|
|
|
class InputHandler;
|
2013-04-09 19:39:03 +02:00
|
|
|
class UserInterface;
|
|
|
|
class DisplayLine;
|
2013-10-25 01:01:17 +02:00
|
|
|
class KeymapManager;
|
2014-10-30 00:22:54 +01:00
|
|
|
class AliasRegistry;
|
2013-01-28 13:48:34 +01:00
|
|
|
|
2015-08-19 00:16:53 +02:00
|
|
|
// bool that can be set (to true) multiple times, and will
|
|
|
|
// be false only when unset the same time;
|
|
|
|
struct NestedBool
|
2014-12-05 14:47:09 +01:00
|
|
|
{
|
2015-08-19 00:16:53 +02:00
|
|
|
void set() { m_count++; }
|
|
|
|
void unset() { kak_assert(m_count > 0); m_count--; }
|
|
|
|
|
2015-08-19 22:20:34 +02:00
|
|
|
operator bool() const { return m_count > 0; }
|
2014-12-05 14:47:09 +01:00
|
|
|
private:
|
2015-08-19 00:16:53 +02:00
|
|
|
int m_count = 0;
|
2014-12-05 14:47:09 +01:00
|
|
|
};
|
|
|
|
|
2015-08-19 00:16:53 +02:00
|
|
|
struct ScopedSetBool
|
2014-12-05 15:01:07 +01:00
|
|
|
{
|
2015-08-19 00:16:53 +02:00
|
|
|
ScopedSetBool(NestedBool& nested_bool, bool condition = true)
|
|
|
|
: m_nested_bool(nested_bool), m_condition(condition)
|
2014-12-05 15:01:07 +01:00
|
|
|
{
|
|
|
|
if (m_condition)
|
2015-08-19 00:16:53 +02:00
|
|
|
m_nested_bool.set();
|
2014-12-05 15:01:07 +01:00
|
|
|
}
|
|
|
|
|
2015-08-19 00:16:53 +02:00
|
|
|
~ScopedSetBool()
|
2014-12-05 15:01:07 +01:00
|
|
|
{
|
|
|
|
if (m_condition)
|
2015-08-19 00:16:53 +02:00
|
|
|
m_nested_bool.unset();
|
2014-12-05 15:01:07 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
2015-08-19 00:16:53 +02:00
|
|
|
NestedBool& m_nested_bool;
|
2014-12-05 15:01:07 +01:00
|
|
|
bool m_condition;
|
|
|
|
};
|
|
|
|
|
2015-12-23 02:56:54 +01:00
|
|
|
struct JumpList
|
|
|
|
{
|
|
|
|
void push(SelectionList jump);
|
|
|
|
void drop();
|
|
|
|
const SelectionList& forward();
|
|
|
|
const SelectionList& backward(const SelectionList& current);
|
|
|
|
void forget_buffer(Buffer& buffer);
|
|
|
|
|
|
|
|
private:
|
|
|
|
using Contents = Vector<SelectionList, MemoryDomain::Selections>;
|
|
|
|
Contents m_jumps;
|
2015-12-23 03:31:03 +01:00
|
|
|
size_t m_current = 0;
|
2015-12-23 02:56:54 +01:00
|
|
|
};
|
|
|
|
|
2012-10-10 13:57:15 +02:00
|
|
|
// A Context is used to access non singleton objects for various services
|
|
|
|
// in commands.
|
|
|
|
//
|
2014-03-20 09:10:31 +01:00
|
|
|
// 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.
|
2013-11-11 20:10:49 +01:00
|
|
|
class Context
|
2011-11-26 19:32:57 +01:00
|
|
|
{
|
2013-11-11 20:10:49 +01:00
|
|
|
public:
|
2014-12-19 00:12:58 +01:00
|
|
|
enum class Flags
|
|
|
|
{
|
|
|
|
None = 0,
|
|
|
|
Transient = 1,
|
|
|
|
};
|
|
|
|
|
2014-05-13 00:25:15 +02:00
|
|
|
Context(InputHandler& input_handler, SelectionList selections,
|
2014-12-19 00:12:58 +01:00
|
|
|
Flags flags, String name = "");
|
2015-04-19 19:47:52 +02:00
|
|
|
|
|
|
|
struct EmptyContextFlag {};
|
|
|
|
explicit Context(EmptyContextFlag);
|
2013-04-09 19:39:03 +02:00
|
|
|
~Context();
|
2012-01-15 22:33:35 +01:00
|
|
|
|
2012-09-26 14:27:23 +02:00
|
|
|
Context(const Context&) = delete;
|
2012-08-15 22:36:45 +02:00
|
|
|
Context& operator=(const Context&) = delete;
|
|
|
|
|
2013-04-09 19:39:03 +02:00
|
|
|
Buffer& buffer() const;
|
2014-06-27 20:34:26 +02:00
|
|
|
bool has_buffer() const { return (bool)m_selections; }
|
2012-08-05 18:23:37 +02:00
|
|
|
|
2013-04-09 19:39:03 +02:00
|
|
|
Window& window() const;
|
2013-12-20 21:10:08 +01:00
|
|
|
bool has_window() const { return (bool)m_window; }
|
2013-04-09 19:39:03 +02:00
|
|
|
|
2013-09-12 23:47:23 +02:00
|
|
|
Client& client() const;
|
|
|
|
bool has_client() const { return (bool)m_client; }
|
2012-08-15 22:36:45 +02:00
|
|
|
|
2013-11-14 19:09:15 +01:00
|
|
|
InputHandler& input_handler() const;
|
|
|
|
bool has_input_handler() const { return (bool)m_input_handler; }
|
|
|
|
|
2013-04-09 19:39:03 +02:00
|
|
|
UserInterface& ui() const;
|
2013-11-14 19:09:15 +01:00
|
|
|
bool has_ui() const { return has_client(); }
|
2012-09-26 14:13:04 +02:00
|
|
|
|
2013-12-15 15:25:23 +01:00
|
|
|
SelectionList& selections();
|
|
|
|
const SelectionList& selections() const;
|
2015-01-12 14:58:41 +01:00
|
|
|
Vector<String> selections_content() const;
|
2013-12-15 15:25:23 +01:00
|
|
|
|
2015-04-19 16:12:16 +02:00
|
|
|
// Return potentially out of date selections
|
|
|
|
SelectionList& selections_write_only();
|
|
|
|
|
2013-12-20 21:10:08 +01:00
|
|
|
void change_buffer(Buffer& buffer);
|
2013-04-09 19:39:03 +02:00
|
|
|
|
2013-11-14 19:09:15 +01:00
|
|
|
void set_client(Client& client);
|
2013-12-20 21:10:08 +01:00
|
|
|
void set_window(Window& window);
|
2013-11-14 19:09:15 +01:00
|
|
|
|
2014-10-30 15:00:42 +01:00
|
|
|
Scope& scope() const;
|
|
|
|
|
2015-07-13 14:43:52 +02:00
|
|
|
OptionManager& options() const { return scope().options(); }
|
|
|
|
HookManager& hooks() const { return scope().hooks(); }
|
|
|
|
KeymapManager& keymaps() const { return scope().keymaps(); }
|
|
|
|
AliasRegistry& aliases() const { return scope().aliases(); }
|
2013-04-09 19:39:03 +02:00
|
|
|
|
2013-09-16 20:15:13 +02:00
|
|
|
void print_status(DisplayLine status) const;
|
2013-04-09 19:39:03 +02:00
|
|
|
|
2014-06-21 12:31:08 +02:00
|
|
|
StringView main_sel_register_value(StringView reg) const;
|
|
|
|
|
2013-11-14 21:51:25 +01:00
|
|
|
const String& name() const { return m_name; }
|
|
|
|
void set_name(String name) { m_name = std::move(name); }
|
|
|
|
|
2013-12-15 19:07:51 +01:00
|
|
|
bool is_editing() const { return m_edition_level!= 0; }
|
2014-01-06 21:07:08 +01:00
|
|
|
void disable_undo_handling() { m_edition_level = -1; }
|
2014-07-24 20:18:39 +02:00
|
|
|
|
2015-08-19 00:16:53 +02:00
|
|
|
NestedBool& user_hooks_disabled() { return m_user_hooks_disabled; }
|
|
|
|
const NestedBool& user_hooks_disabled() const { return m_user_hooks_disabled; }
|
2014-07-27 21:18:09 +02:00
|
|
|
|
2015-08-19 00:16:53 +02:00
|
|
|
NestedBool& keymaps_disabled() { return m_keymaps_disabled; }
|
|
|
|
const NestedBool& keymaps_disabled() const { return m_keymaps_disabled; }
|
2014-07-27 21:18:09 +02:00
|
|
|
|
2015-08-19 00:16:53 +02:00
|
|
|
NestedBool& history_disabled() { return m_history_disabled; }
|
|
|
|
const NestedBool& history_disabled() const { return m_history_disabled; }
|
2014-12-05 15:01:07 +01:00
|
|
|
|
2014-12-19 00:12:58 +01:00
|
|
|
Flags flags() const { return m_flags; }
|
|
|
|
|
2015-12-23 02:56:54 +01:00
|
|
|
JumpList& jump_list() { return m_jump_list; }
|
|
|
|
void push_jump() { m_jump_list.push(selections()); }
|
|
|
|
|
2012-09-26 20:07:06 +02:00
|
|
|
private:
|
2013-12-15 19:07:51 +01:00
|
|
|
void begin_edition();
|
|
|
|
void end_edition();
|
|
|
|
int m_edition_level = 0;
|
|
|
|
|
|
|
|
friend struct ScopedEdition;
|
|
|
|
|
2014-12-19 00:12:58 +01:00
|
|
|
Flags m_flags;
|
|
|
|
|
2015-02-19 14:58:25 +01:00
|
|
|
SafePtr<InputHandler> m_input_handler;
|
|
|
|
SafePtr<Window> m_window;
|
|
|
|
SafePtr<Client> m_client;
|
2012-09-26 20:07:06 +02:00
|
|
|
|
2014-06-27 20:34:26 +02:00
|
|
|
Optional<SelectionList> m_selections;
|
2013-12-20 21:10:08 +01:00
|
|
|
|
2013-11-14 21:51:25 +01:00
|
|
|
String m_name;
|
|
|
|
|
2015-12-23 02:56:54 +01:00
|
|
|
JumpList m_jump_list;
|
2014-07-24 20:18:39 +02:00
|
|
|
|
2015-08-19 00:16:53 +02:00
|
|
|
NestedBool m_user_hooks_disabled;
|
|
|
|
NestedBool m_keymaps_disabled;
|
|
|
|
NestedBool m_history_disabled;
|
2011-11-26 19:32:57 +01:00
|
|
|
};
|
|
|
|
|
2014-12-19 00:12:58 +01:00
|
|
|
template<>
|
|
|
|
struct WithBitOps<Context::Flags> : std::true_type {};
|
|
|
|
|
2013-12-15 19:07:51 +01:00
|
|
|
struct ScopedEdition
|
|
|
|
{
|
|
|
|
ScopedEdition(Context& context)
|
2014-10-10 15:00:24 +02:00
|
|
|
: m_context(context), m_buffer(&context.buffer())
|
2013-12-15 19:07:51 +01:00
|
|
|
{ m_context.begin_edition(); }
|
|
|
|
|
2014-11-21 19:56:39 +01:00
|
|
|
~ScopedEdition() { m_context.end_edition(); }
|
2013-12-15 19:07:51 +01:00
|
|
|
|
|
|
|
Context& context() const { return m_context; }
|
|
|
|
private:
|
|
|
|
Context& m_context;
|
2015-02-19 14:58:25 +01:00
|
|
|
SafePtr<Buffer> m_buffer;
|
2013-12-15 19:07:51 +01:00
|
|
|
};
|
|
|
|
|
2011-11-26 19:32:57 +01:00
|
|
|
}
|
|
|
|
#endif // context_hh_INCLUDED
|