home/src/context.cc
Johannes Altmanninger c2ab5d4694 Allow to undo and redo selection changes
From the issue:

> It often happens to me that I carefully craft a selection with multiple
> cursors, ready to make changes elegantly, only to completely mess it
> up by pressing a wrong key (by merging the cursors for example). Being
> able to undo the last selection change (even if only until the previous
> buffer change) would make this much less painful.

Fix this by recording selection changes and allowing simple linear
undo/redo of selection changes.

The preliminary key bindings are <c-h> and <c-k>.
Here are some other vacant normal mode keys I considered

	X Y
	<backspace> <minus>
	# ^ =
	<plus> '

unfortunately none of them is super convenient to type.  Maybe we
can kick out some other normal mode command?

---

This feature has some overlap with the jump list (<c-o>/<c-i>) and
with undo (u) but each of the three features have their moment.

Currently there's no special integration with either peer feature;
the three histories are completely independent.  In future we might
want to synchronize them so we can implement Sublime Text's "Soft
undo" feature.

Note that it is possible to restore selections that predate a buffer
modification. Depending on the buffer modification, the selections
might look different of course. (When trying to apply an old buffer's
selection to the new buffer, Kakoune computes a diff of the buffers
and updates the selection accordingly. This works quite well for
many practical examples.)

This makes us record the full history of all selections for each
client. This seems wasteful, we could set a limit. I don't expect
excessive memory usage in practice (we also keep the full history of
buffer changes) but I could be wrong.

Closes #898
2022-09-02 02:59:47 +02:00

438 lines
12 KiB
C++

#include "context.hh"
#include "alias_registry.hh"
#include "client.hh"
#include "face_registry.hh"
#include "buffer_manager.hh"
#include "register_manager.hh"
#include "window.hh"
namespace Kakoune
{
Context::~Context() = default;
Context::Context(InputHandler& input_handler, SelectionList selections,
Flags flags, String name)
: m_flags(flags),
m_input_handler{&input_handler},
m_selection_history{*this, std::move(selections)},
m_name(std::move(name))
{}
Context::Context(EmptyContextFlag) : m_selection_history{*this} {}
Buffer& Context::buffer() const
{
if (not has_buffer())
throw runtime_error("no buffer in context");
return const_cast<Buffer&>(selections(false).buffer());
}
Window& Context::window() const
{
if (not has_window())
throw runtime_error("no window in context");
return *m_window;
}
InputHandler& Context::input_handler() const
{
if (not has_input_handler())
throw runtime_error("no input handler in context");
return *m_input_handler;
}
Client& Context::client() const
{
if (not has_client())
throw runtime_error("no client in context");
return *m_client;
}
Scope& Context::scope() const
{
if (has_window())
return window();
if (has_buffer())
return buffer();
return GlobalScope::instance();
}
void Context::set_client(Client& client)
{
kak_assert(not has_client());
m_client.reset(&client);
}
void Context::set_window(Window& window)
{
kak_assert(&window.buffer() == &buffer());
m_window.reset(&window);
}
void Context::print_status(DisplayLine status) const
{
if (has_client())
client().print_status(std::move(status));
}
void JumpList::push(SelectionList jump, Optional<size_t> index)
{
if (index)
{
m_current = *index;
kak_assert(m_current <= m_jumps.size());
}
if (m_current != m_jumps.size())
m_jumps.erase(m_jumps.begin()+m_current+1, m_jumps.end());
m_jumps.erase(std::remove(begin(m_jumps), end(m_jumps), jump),
end(m_jumps));
m_jumps.push_back(jump);
m_current = m_jumps.size();
}
const SelectionList& JumpList::forward(Context& context, int count)
{
if (m_current != m_jumps.size() and
m_current + count < m_jumps.size())
{
m_current += count;
SelectionList& res = m_jumps[m_current];
res.update();
context.print_status({ format("jumped to #{} ({})",
m_current, m_jumps.size() - 1),
context.faces()["Information"] });
return res;
}
throw runtime_error("no next jump");
}
const SelectionList& JumpList::backward(Context& context, int count)
{
if ((int)m_current - count < 0)
throw runtime_error("no previous jump");
const SelectionList& current = context.selections();
if (m_current != m_jumps.size() and
m_jumps[m_current] != current)
{
push(current);
m_current -= count;
SelectionList& res = m_jumps[m_current];
res.update();
context.print_status({ format("jumped to #{} ({})",
m_current, m_jumps.size() - 1),
context.faces()["Information"] });
return res;
}
if (m_current != 0)
{
if (m_current == m_jumps.size())
{
push(current);
if (--m_current == 0)
throw runtime_error("no previous jump");
}
m_current -= count;
SelectionList& res = m_jumps[m_current];
res.update();
context.print_status({ format("jumped to #{} ({})",
m_current, m_jumps.size() - 1),
context.faces()["Information"] });
return res;
}
throw runtime_error("no previous jump");
}
void JumpList::forget_buffer(Buffer& buffer)
{
for (size_t i = 0; i < m_jumps.size();)
{
if (&m_jumps[i].buffer() == &buffer)
{
if (i < m_current)
--m_current;
else if (i == m_current)
m_current = m_jumps.size()-1;
m_jumps.erase(m_jumps.begin() + i);
}
else
++i;
}
}
Context::SelectionHistory::SelectionHistory(Context& context) : m_context(context) {}
Context::SelectionHistory::SelectionHistory(Context& context, SelectionList selections)
: m_context(context),
m_history{HistoryNode{std::move(selections), HistoryId::Invalid}},
m_history_id(HistoryId::First) {}
void Context::SelectionHistory::initialize(SelectionList selections)
{
kak_assert(empty());
m_history = {HistoryNode{std::move(selections), HistoryId::Invalid}};
m_history_id = HistoryId::First;
}
SelectionList& Context::SelectionHistory::selections(bool update)
{
if (empty())
throw runtime_error("no selections in context");
auto& sels = m_staging ? m_staging->selections : current_history_node().selections;
if (update)
sels.update();
return sels;
}
void Context::SelectionHistory::begin_edition()
{
if (not in_edition())
m_staging = HistoryNode{selections(), m_history_id};
m_in_edition.set();
}
void Context::SelectionHistory::end_edition()
{
kak_assert(in_edition());
m_in_edition.unset();
if (in_edition())
return;
if (m_history_id != HistoryId::Invalid and current_history_node().selections == m_staging->selections)
{
auto& sels = m_history[(size_t)m_history_id].selections;
sels.force_timestamp(m_staging->selections.timestamp());
sels.set_main_index(m_staging->selections.main_index());
}
else
{
m_history_id = next_history_id();
m_history.push_back(std::move(*m_staging));
}
m_staging.reset();
}
void Context::SelectionHistory::undo()
{
if (in_edition())
throw runtime_error("selection undo is only supported at top-level");
kak_assert(not empty());
begin_edition();
auto end = on_scope_end([&] {
kak_assert(current_history_node().selections == m_staging->selections);
end_edition();
});
HistoryId parent = current_history_node().parent;
if (parent == HistoryId::Invalid)
throw runtime_error("no selection change to undo");
auto select_parent = [&, parent] {
HistoryId before_undo = m_history_id;
m_history_id = parent;
current_history_node().redo_child = before_undo;
m_staging = current_history_node();
};
if (&history_node(parent).selections.buffer() == &m_context.buffer())
select_parent();
else
m_context.change_buffer(history_node(parent).selections.buffer(), { std::move(select_parent) });
// });
}
void Context::SelectionHistory::redo()
{
if (in_edition())
throw runtime_error("selection redo is only supported at top-level");
kak_assert(not empty());
begin_edition();
auto end = on_scope_end([&] {
kak_assert(current_history_node().selections == m_staging->selections);
end_edition();
});
HistoryId child = current_history_node().redo_child;
if (child == HistoryId::Invalid)
throw runtime_error("no selection change to redo");
auto select_child = [&, child] {
m_history_id = child;
m_staging = current_history_node();
};
if (&history_node(child).selections.buffer() == &m_context.buffer())
select_child();
else
m_context.change_buffer(history_node(child).selections.buffer(), { std::move(select_child) });
}
void Context::SelectionHistory::forget_buffer(Buffer& buffer)
{
Vector<HistoryId, MemoryDomain::Selections> new_ids;
size_t bias = 0;
for (size_t i = 0; i < m_history.size(); ++i)
{
auto& node = history_node((HistoryId)i);
HistoryId id;
if (&node.selections.buffer() == &buffer)
{
id = HistoryId::Invalid;
++bias;
}
else
id = (HistoryId)(i - bias);
new_ids.push_back(id);
}
auto new_id = [&new_ids](HistoryId old_id) -> HistoryId {
return old_id == HistoryId::Invalid ? HistoryId::Invalid : new_ids[(size_t)old_id];
};
m_history.erase(remove_if(m_history, [&buffer](const auto& node) {
return &node.selections.buffer() == &buffer;
}), m_history.end());
for (auto& node : m_history)
{
node.parent = new_id(node.parent);
node.redo_child = new_id(node.redo_child);
}
m_history_id = new_id(m_history_id);
if (m_staging)
{
m_staging->parent = new_id(m_staging->parent);
kak_assert(m_staging->redo_child == HistoryId::Invalid);
}
kak_assert(m_history_id != HistoryId::Invalid or m_staging);
}
void Context::change_buffer(Buffer& buffer, Optional<FunctionRef<void()>> set_selections)
{
if (has_buffer() and &buffer == &this->buffer())
return;
if (has_buffer() and m_edition_level > 0)
this->buffer().commit_undo_group();
if (has_client())
{
client().info_hide();
client().menu_hide();
client().change_buffer(buffer, std::move(set_selections));
}
else
{
m_window.reset();
if (m_selection_history.empty())
m_selection_history.initialize(SelectionList{buffer, Selection{}});
else
{
ScopedSelectionEdition selection_edition{*this};
selections_write_only() = SelectionList{buffer, Selection{}};
}
}
if (has_input_handler())
input_handler().reset_normal_mode();
}
void Context::forget_buffer(Buffer& buffer)
{
m_jump_list.forget_buffer(buffer);
if (&this->buffer() == &buffer)
{
if (is_editing() && has_input_handler())
input_handler().reset_normal_mode();
auto last_buffer = this->last_buffer();
change_buffer(last_buffer ? *last_buffer : BufferManager::instance().get_first_buffer());
}
m_selection_history.forget_buffer(buffer);
}
Buffer* Context::last_buffer() const
{
const auto jump_list = m_jump_list.get_as_list();
if (jump_list.empty())
return nullptr;
auto predicate = [this](const auto& sels) {
return &sels.buffer() != &this->buffer();
};
auto next_buffer = find_if(jump_list.subrange(m_jump_list.current_index()-1),
predicate);
if (next_buffer != jump_list.end())
return &next_buffer->buffer();
auto previous_buffer = find_if(jump_list.subrange(0, m_jump_list.current_index()) | reverse(),
predicate);
return previous_buffer != jump_list.rend() ? &previous_buffer->buffer() : nullptr;
}
SelectionList& Context::selections(bool update)
{
return m_selection_history.selections(update);
}
void Context::undo_selection_change()
{
m_selection_history.undo();
}
void Context::redo_selection_change()
{
m_selection_history.redo();
}
SelectionList& Context::selections_write_only()
{
return selections(false);
}
const SelectionList& Context::selections(bool update) const
{
return const_cast<Context&>(*this).selections(update);
}
Vector<String> Context::selections_content() const
{
auto& buf = buffer();
Vector<String> contents;
for (auto& sel : selections())
contents.push_back(buf.string(sel.min(), buf.char_next(sel.max())));
return contents;
}
void Context::begin_edition()
{
if (m_edition_level >= 0)
{
if (m_edition_level == 0)
m_edition_timestamp = buffer().timestamp();
++m_edition_level;
}
}
void Context::end_edition()
{
if (m_edition_level < 0)
return;
kak_assert(m_edition_level != 0);
if (m_edition_level == 1 and
buffer().timestamp() != m_edition_timestamp)
buffer().commit_undo_group();
--m_edition_level;
}
StringView Context::main_sel_register_value(StringView reg) const
{
size_t index = has_buffer() ? selections(false).main_index() : 0;
return RegisterManager::instance()[reg].get_main(*this, index);
}
}