29a7cd3ab4
This change is useful when using `set scope completers word=buffer`, instead of the default word=all. If candidates all come from the same buffer, then the path/filename information is the same and therefore unnecessary. This change prevents the same path from being repeated, and the buffer's source code is less obscured. More generally, there could be an option to disable the path information entirely in all cases, but for now this change seems a reasonable solution until any such option exists.
594 lines
20 KiB
C++
594 lines
20 KiB
C++
#include "insert_completer.hh"
|
|
|
|
#include "buffer_manager.hh"
|
|
#include "buffer_utils.hh"
|
|
#include "client.hh"
|
|
#include "changes.hh"
|
|
#include "context.hh"
|
|
#include "display_buffer.hh"
|
|
#include "face_registry.hh"
|
|
#include "file.hh"
|
|
#include "regex.hh"
|
|
#include "window.hh"
|
|
#include "word_db.hh"
|
|
#include "utf8_iterator.hh"
|
|
#include "user_interface.hh"
|
|
|
|
#include <numeric>
|
|
#include <utility>
|
|
|
|
namespace Kakoune
|
|
{
|
|
|
|
using StringList = Vector<String, MemoryDomain::Options>;
|
|
|
|
String option_to_string(const InsertCompleterDesc& opt)
|
|
{
|
|
switch (opt.mode)
|
|
{
|
|
case InsertCompleterDesc::Word:
|
|
return "word=" + (opt.param ? *opt.param : "");
|
|
case InsertCompleterDesc::Filename:
|
|
return "filename";
|
|
case InsertCompleterDesc::Option:
|
|
return "option=" + (opt.param ? *opt.param : "");
|
|
case InsertCompleterDesc::Line:
|
|
return "line";
|
|
}
|
|
kak_assert(false);
|
|
return "";
|
|
}
|
|
|
|
void option_from_string(StringView str, InsertCompleterDesc& opt)
|
|
{
|
|
if (str.substr(0_byte, 7_byte) == "option=")
|
|
{
|
|
opt.mode = InsertCompleterDesc::Option;
|
|
opt.param = str.substr(7_byte).str();
|
|
return;
|
|
}
|
|
else if (str.substr(0_byte, 5_byte) == "word=")
|
|
{
|
|
auto param = str.substr(5_byte);
|
|
if (param == "all" or param == "buffer")
|
|
{
|
|
opt.mode = InsertCompleterDesc::Word;
|
|
opt.param = param.str();
|
|
return;
|
|
}
|
|
}
|
|
else if (str == "filename")
|
|
{
|
|
opt.mode = InsertCompleterDesc::Filename;
|
|
opt.param = Optional<String>{};
|
|
return;
|
|
}
|
|
else if (str == "line")
|
|
{
|
|
opt.mode = InsertCompleterDesc::Line;
|
|
opt.param = Optional<String>{};
|
|
return;
|
|
}
|
|
throw runtime_error(format("invalid completer description: '{}'", str));
|
|
}
|
|
|
|
namespace
|
|
{
|
|
|
|
WordDB& get_word_db(const Buffer& buffer)
|
|
{
|
|
static const ValueId word_db_id = get_free_value_id();
|
|
Value& cache_val = buffer.values()[word_db_id];
|
|
if (not cache_val)
|
|
cache_val = Value(WordDB{buffer});
|
|
return cache_val.as<WordDB>();
|
|
}
|
|
|
|
template<bool other_buffers>
|
|
InsertCompletion complete_word(const SelectionList& sels, const OptionManager& options)
|
|
{
|
|
ConstArrayView<Codepoint> extra_word_chars = options["extra_word_chars"].get<Vector<Codepoint, MemoryDomain::Options>>();
|
|
auto is_word_pred = [extra_word_chars](Codepoint c) { return is_word(c, extra_word_chars); };
|
|
|
|
const Buffer& buffer = sels.buffer();
|
|
BufferCoord cursor_pos = sels.main().cursor();
|
|
|
|
using Utf8It = utf8::iterator<BufferIterator>;
|
|
Utf8It pos{buffer.iterator_at(cursor_pos), buffer};
|
|
if (pos == buffer.begin() or not is_word_pred(*(pos-1)))
|
|
return {};
|
|
|
|
BufferCoord word_begin;
|
|
StringView prefix;
|
|
HashMap<StringView, int> sel_word_counts;
|
|
for (int i = 0; i < sels.size(); ++i)
|
|
{
|
|
Utf8It end{buffer.iterator_at(sels[i].cursor()), buffer};
|
|
Utf8It begin = end-1;
|
|
if (not skip_while_reverse(begin, buffer.begin(), is_word_pred) and
|
|
begin < end) // (begin might == end if end == buffer.begin())
|
|
++begin;
|
|
|
|
if (i == sels.main_index())
|
|
{
|
|
word_begin = begin.base().coord();
|
|
prefix = buffer.substr(word_begin, end.base().coord());
|
|
}
|
|
|
|
skip_while(end, buffer.end(), is_word_pred);
|
|
|
|
StringView word = buffer.substr(begin.base().coord(), end.base().coord());
|
|
++sel_word_counts[word];
|
|
}
|
|
|
|
struct RankedMatchAndBuffer : RankedMatch
|
|
{
|
|
RankedMatchAndBuffer(RankedMatch m, const Buffer* b)
|
|
: RankedMatch{std::move(m)}, buffer{b} {}
|
|
|
|
using RankedMatch::operator==;
|
|
using RankedMatch::operator<;
|
|
bool operator==(StringView other) const { return candidate() == other; }
|
|
|
|
const Buffer* buffer;
|
|
};
|
|
Vector<RankedMatchAndBuffer> matches;
|
|
|
|
auto& word_db = get_word_db(buffer);
|
|
for (auto& m : word_db.find_matching(prefix))
|
|
matches.push_back({ m, &buffer });
|
|
|
|
// Remove words that are being edited
|
|
for (auto& word_count : sel_word_counts)
|
|
{
|
|
if (word_db.get_word_occurences(word_count.key) <= word_count.value)
|
|
unordered_erase(matches, word_count.key);
|
|
}
|
|
|
|
if (other_buffers)
|
|
{
|
|
for (const auto& buf : BufferManager::instance())
|
|
{
|
|
if (buf.get() == &buffer or buf->flags() & Buffer::Flags::Debug)
|
|
continue;
|
|
for (auto& m : get_word_db(*buf).find_matching(prefix) |
|
|
// filter out words that are not considered words for the current buffer
|
|
filter([&](auto& rm) { return std::all_of(rm.candidate().begin(), rm.candidate().end(),
|
|
is_word_pred); }))
|
|
matches.push_back({ m, buf.get() });
|
|
}
|
|
}
|
|
|
|
using StaticWords = Vector<String, MemoryDomain::Options>;
|
|
for (auto& word : options["static_words"].get<StaticWords>())
|
|
if (RankedMatch match{word, prefix})
|
|
matches.emplace_back(match, nullptr);
|
|
|
|
unordered_erase(matches, prefix);
|
|
const auto longest = accumulate(matches, 0_char,
|
|
[](const CharCount& lhs, const RankedMatchAndBuffer& rhs)
|
|
{ return std::max(lhs, rhs.candidate().char_length()); });
|
|
|
|
constexpr size_t max_count = 100;
|
|
// Gather best max_count matches
|
|
auto greater = [](auto& lhs, auto& rhs) { return rhs < lhs; };
|
|
auto first = matches.begin(), last = matches.end();
|
|
std::make_heap(first, last, greater);
|
|
InsertCompletion::CandidateList candidates;
|
|
candidates.reserve(std::min(matches.size(), max_count));
|
|
while (candidates.size() < max_count and first != last)
|
|
{
|
|
if (candidates.empty() or candidates.back().completion != first->candidate())
|
|
{
|
|
DisplayLine menu_entry;
|
|
if (other_buffers && first->buffer)
|
|
{
|
|
const auto pad_len = longest + 1 - first->candidate().char_length();
|
|
menu_entry.push_back(first->candidate().str());
|
|
menu_entry.push_back(String{' ', pad_len});
|
|
menu_entry.push_back({ first->buffer->display_name(), get_face("MenuInfo") });
|
|
}
|
|
else
|
|
menu_entry.push_back(first->candidate().str());
|
|
|
|
candidates.push_back({first->candidate().str(), "", std::move(menu_entry)});
|
|
}
|
|
std::pop_heap(first, last--, greater);
|
|
}
|
|
|
|
return { std::move(candidates), word_begin, cursor_pos, buffer.timestamp() };
|
|
}
|
|
|
|
template<bool require_slash>
|
|
InsertCompletion complete_filename(const SelectionList& sels,
|
|
const OptionManager& options)
|
|
{
|
|
const Buffer& buffer = sels.buffer();
|
|
auto pos = buffer.iterator_at(sels.main().cursor());
|
|
auto begin = pos;
|
|
|
|
auto is_filename = [](char c)
|
|
{
|
|
return isalnum(c) or c == '/' or c == '.' or c == '_' or c == '-';
|
|
};
|
|
while (begin != buffer.begin() and is_filename(*(begin-1)))
|
|
--begin;
|
|
|
|
if (begin != buffer.begin() and *begin == '/' and *(begin-1) == '~')
|
|
--begin;
|
|
|
|
if (begin == pos)
|
|
return {};
|
|
|
|
StringView prefix = buffer.substr(begin.coord(), pos.coord());
|
|
if (require_slash and not contains(prefix, '/'))
|
|
return {};
|
|
|
|
// Do not try to complete in that case as its unlikely to be a filename,
|
|
// and triggers network host search of cygwin.
|
|
if (prefix.substr(0_byte, 2_byte) == "//")
|
|
return {};
|
|
|
|
InsertCompletion::CandidateList candidates;
|
|
if (prefix.front() == '/' or prefix.front() == '~')
|
|
{
|
|
for (auto& filename : Kakoune::complete_filename(prefix,
|
|
options["ignored_files"].get<Regex>()))
|
|
candidates.push_back({ filename, "", filename });
|
|
}
|
|
else
|
|
{
|
|
for (auto dir : options["path"].get<StringList>())
|
|
{
|
|
if (not dir.empty() and dir.back() != '/')
|
|
dir += '/';
|
|
for (auto& filename : Kakoune::complete_filename(dir + prefix,
|
|
options["ignored_files"].get<Regex>()))
|
|
{
|
|
StringView candidate = filename.substr(dir.length());
|
|
candidates.push_back({ candidate.str(), "", candidate.str() });
|
|
}
|
|
}
|
|
}
|
|
if (candidates.empty())
|
|
return {};
|
|
return { std::move(candidates), begin.coord(), pos.coord(), buffer.timestamp() };
|
|
}
|
|
|
|
InsertCompletion complete_option(const SelectionList& sels,
|
|
const OptionManager& options,
|
|
StringView option_name)
|
|
{
|
|
const Buffer& buffer = sels.buffer();
|
|
BufferCoord cursor_pos = sels.main().cursor();
|
|
|
|
const CompletionList& opt = options[option_name].get<CompletionList>();
|
|
if (opt.list.empty())
|
|
return {};
|
|
|
|
auto& desc = opt.prefix;
|
|
static const Regex re(R"((\d+)\.(\d+)(?:\+(\d+))?@(\d+))");
|
|
MatchResults<String::const_iterator> match;
|
|
if (regex_match(desc.begin(), desc.end(), match, re))
|
|
{
|
|
BufferCoord coord{ str_to_int({match[1].first, match[1].second}) - 1,
|
|
str_to_int({match[2].first, match[2].second}) - 1 };
|
|
if (not buffer.is_valid(coord))
|
|
return {};
|
|
auto end = cursor_pos;
|
|
if (match[3].matched)
|
|
{
|
|
ByteCount len = str_to_int({match[3].first, match[3].second});
|
|
end = buffer.advance(coord, len);
|
|
}
|
|
size_t timestamp = (size_t)str_to_int({match[4].first, match[4].second});
|
|
auto changes = buffer.changes_since(timestamp);
|
|
if (contains_that(changes, [&](const Buffer::Change& change)
|
|
{ return change.begin < coord; }))
|
|
return {};
|
|
|
|
if (cursor_pos.line == coord.line and cursor_pos.column >= coord.column)
|
|
{
|
|
StringView query = buffer.substr(coord, cursor_pos);
|
|
|
|
const ColumnCount tabstop = options["tabstop"].get<int>();
|
|
const ColumnCount column = get_column(buffer, tabstop, cursor_pos);
|
|
|
|
struct RankedMatchAndInfo : RankedMatch
|
|
{
|
|
using RankedMatch::RankedMatch;
|
|
using RankedMatch::operator==;
|
|
using RankedMatch::operator<;
|
|
|
|
StringView docstring;
|
|
DisplayLine menu_entry;
|
|
};
|
|
|
|
Vector<RankedMatchAndInfo> matches;
|
|
|
|
for (auto& candidate : opt.list)
|
|
{
|
|
if (RankedMatchAndInfo match{std::get<0>(candidate), query})
|
|
{
|
|
match.docstring = std::get<1>(candidate);
|
|
auto& menu = std::get<2>(candidate);
|
|
match.menu_entry = not menu.empty() ?
|
|
parse_display_line(expand_tabs(menu, tabstop, column))
|
|
: DisplayLine{ expand_tabs(menu, tabstop, column) };
|
|
|
|
matches.push_back(std::move(match));
|
|
}
|
|
}
|
|
|
|
constexpr size_t max_count = 100;
|
|
// Gather best max_count matches
|
|
auto greater = [](auto& lhs, auto& rhs) { return rhs < lhs; };
|
|
auto first = matches.begin(), last = matches.end();
|
|
std::make_heap(first, last, greater);
|
|
InsertCompletion::CandidateList candidates;
|
|
candidates.reserve(std::min(matches.size(), max_count));
|
|
candidates.reserve(matches.size());
|
|
while (candidates.size() < max_count and first != last)
|
|
{
|
|
if (candidates.empty() or candidates.back().completion != first->candidate())
|
|
candidates.push_back({ first->candidate().str(), first->docstring.str(),
|
|
std::move(first->menu_entry) });
|
|
std::pop_heap(first, last--, greater);
|
|
}
|
|
|
|
return { std::move(candidates), coord, end, timestamp };
|
|
}
|
|
}
|
|
return {};
|
|
}
|
|
|
|
InsertCompletion complete_line(const SelectionList& sels, const OptionManager& options)
|
|
{
|
|
const Buffer& buffer = sels.buffer();
|
|
BufferCoord cursor_pos = sels.main().cursor();
|
|
|
|
const ColumnCount tabstop = options["tabstop"].get<int>();
|
|
const ColumnCount column = get_column(buffer, tabstop, cursor_pos);
|
|
|
|
StringView prefix = buffer[cursor_pos.line].substr(0_byte, cursor_pos.column);
|
|
InsertCompletion::CandidateList candidates;
|
|
for (LineCount l = 0_line; l < buffer.line_count(); ++l)
|
|
{
|
|
if (l == cursor_pos.line)
|
|
continue;
|
|
ByteCount len = buffer[l].length();
|
|
if (len > cursor_pos.column and std::equal(prefix.begin(), prefix.end(), buffer[l].begin()))
|
|
{
|
|
StringView candidate = buffer[l].substr(0_byte, len-1);
|
|
candidates.push_back({candidate.str(), "",
|
|
expand_tabs(candidate, tabstop, column)});
|
|
}
|
|
}
|
|
if (candidates.empty())
|
|
return {};
|
|
std::sort(candidates.begin(), candidates.end());
|
|
candidates.erase(std::unique(candidates.begin(), candidates.end()), candidates.end());
|
|
return { std::move(candidates), cursor_pos.line, cursor_pos, buffer.timestamp() };
|
|
}
|
|
|
|
}
|
|
|
|
InsertCompleter::InsertCompleter(Context& context)
|
|
: m_context(context), m_options(context.options())
|
|
{
|
|
m_options.register_watcher(*this);
|
|
}
|
|
|
|
InsertCompleter::~InsertCompleter()
|
|
{
|
|
m_options.unregister_watcher(*this);
|
|
}
|
|
|
|
void InsertCompleter::select(int offset, Vector<Key>& keystrokes)
|
|
{
|
|
if (not setup_ifn())
|
|
return;
|
|
|
|
auto& buffer = m_context.buffer();
|
|
m_current_candidate = (m_current_candidate + offset) % (int)m_completions.candidates.size();
|
|
if (m_current_candidate < 0)
|
|
m_current_candidate += m_completions.candidates.size();
|
|
const InsertCompletion::Candidate& candidate = m_completions.candidates[m_current_candidate];
|
|
auto& selections = m_context.selections();
|
|
const auto& cursor_pos = selections.main().cursor();
|
|
const auto prefix_len = buffer.distance(m_completions.begin, cursor_pos);
|
|
const auto suffix_len = std::max(0_byte, buffer.distance(cursor_pos, m_completions.end));
|
|
|
|
auto ref = buffer.string(m_completions.begin, m_completions.end);
|
|
ForwardChangesTracker changes_tracker;
|
|
size_t timestamp = buffer.timestamp();
|
|
Vector<BufferCoord> positions;
|
|
for (auto& sel : selections)
|
|
{
|
|
auto pos = buffer.iterator_at(changes_tracker.get_new_coord_tolerant(sel.cursor()));
|
|
if (pos.coord().column >= prefix_len and (pos + suffix_len) != buffer.end() and
|
|
std::equal(ref.begin(), ref.end(), pos - prefix_len))
|
|
{
|
|
positions.push_back(buffer.erase((pos - prefix_len).coord(),
|
|
(pos + suffix_len).coord()));
|
|
changes_tracker.update(buffer, timestamp);
|
|
}
|
|
}
|
|
|
|
changes_tracker = ForwardChangesTracker{};
|
|
for (auto pos : positions)
|
|
{
|
|
buffer.insert(changes_tracker.get_new_coord_tolerant(pos), candidate.completion);
|
|
changes_tracker.update(buffer, timestamp);
|
|
}
|
|
|
|
selections.update();
|
|
m_completions.end = cursor_pos;
|
|
m_completions.begin = buffer.advance(cursor_pos, -candidate.completion.length());
|
|
m_completions.timestamp = buffer.timestamp();
|
|
if (m_context.has_client())
|
|
{
|
|
m_context.client().menu_select(m_current_candidate);
|
|
if (not candidate.docstring.empty())
|
|
m_context.client().info_show(candidate.completion, candidate.docstring,
|
|
{}, InfoStyle::MenuDoc);
|
|
else
|
|
m_context.client().info_hide();
|
|
}
|
|
|
|
for (auto i = 0_byte; i < prefix_len; ++i)
|
|
keystrokes.emplace_back(Key::Backspace);
|
|
for (auto i = 0_byte; i < suffix_len; ++i)
|
|
keystrokes.emplace_back(Key::Delete);
|
|
for (auto& c : candidate.completion)
|
|
keystrokes.emplace_back(c);
|
|
|
|
if (m_context.has_client())
|
|
{
|
|
const auto param = (m_current_candidate == m_completions.candidates.size() - 1) ?
|
|
StringView{} : candidate.completion;
|
|
m_context.hooks().run_hook("InsertCompletionSelect", param, m_context);
|
|
}
|
|
}
|
|
|
|
void InsertCompleter::update()
|
|
{
|
|
if (m_explicit_completer and try_complete(m_explicit_completer))
|
|
return;
|
|
|
|
reset();
|
|
setup_ifn();
|
|
}
|
|
|
|
void InsertCompleter::reset()
|
|
{
|
|
if (m_explicit_completer or m_completions.is_valid())
|
|
{
|
|
m_explicit_completer = nullptr;
|
|
m_completions = InsertCompletion{};
|
|
if (m_context.has_client())
|
|
{
|
|
m_context.client().menu_hide();
|
|
m_context.client().info_hide();
|
|
m_context.hooks().run_hook("InsertCompletionHide", "", m_context);
|
|
}
|
|
}
|
|
}
|
|
|
|
bool InsertCompleter::setup_ifn()
|
|
{
|
|
using namespace std::placeholders;
|
|
if (not m_completions.is_valid())
|
|
{
|
|
auto& completers = m_options["completers"].get<InsertCompleterDescList>();
|
|
for (auto& completer : completers)
|
|
{
|
|
if (completer.mode == InsertCompleterDesc::Filename and
|
|
try_complete(complete_filename<true>))
|
|
return true;
|
|
if (completer.mode == InsertCompleterDesc::Option and
|
|
try_complete([&](const SelectionList& sels, const OptionManager& options) {
|
|
return complete_option(sels, options, *completer.param);
|
|
}))
|
|
return true;
|
|
if (completer.mode == InsertCompleterDesc::Word and
|
|
*completer.param == "buffer" and
|
|
try_complete(complete_word<false>))
|
|
return true;
|
|
if (completer.mode == InsertCompleterDesc::Word and
|
|
*completer.param == "all" and
|
|
try_complete(complete_word<true>))
|
|
return true;
|
|
if (completer.mode == InsertCompleterDesc::Line and
|
|
try_complete(complete_line))
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
void InsertCompleter::menu_show()
|
|
{
|
|
if (not m_context.has_client())
|
|
return;
|
|
|
|
Vector<DisplayLine> menu_entries;
|
|
for (auto& candidate : m_completions.candidates)
|
|
menu_entries.push_back(candidate.menu_entry);
|
|
|
|
m_context.client().menu_show(std::move(menu_entries), m_completions.begin,
|
|
MenuStyle::Inline);
|
|
m_context.client().menu_select(m_current_candidate);
|
|
m_context.hooks().run_hook("InsertCompletionShow", "", m_context);
|
|
}
|
|
|
|
void InsertCompleter::on_option_changed(const Option& opt)
|
|
{
|
|
// Do not reset the menu if the user has selected an entry
|
|
if (not m_completions.candidates.empty() and
|
|
m_current_candidate != m_completions.candidates.size() - 1)
|
|
return;
|
|
|
|
auto& completers = m_options["completers"].get<InsertCompleterDescList>();
|
|
for (auto& completer : completers)
|
|
{
|
|
if (completer.mode == InsertCompleterDesc::Option and
|
|
*completer.param == opt.name())
|
|
{
|
|
reset();
|
|
setup_ifn();
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
template<typename Func>
|
|
bool InsertCompleter::try_complete(Func complete_func)
|
|
{
|
|
auto& sels = m_context.selections();
|
|
try
|
|
{
|
|
m_completions = complete_func(sels, m_options);
|
|
}
|
|
catch (runtime_error& e)
|
|
{
|
|
write_to_debug_buffer(format("error while trying to run completer: {}", e.what()));
|
|
return false;
|
|
}
|
|
if (not m_completions.is_valid())
|
|
return false;
|
|
|
|
kak_assert(m_completions.begin <= sels.main().cursor());
|
|
m_current_candidate = m_completions.candidates.size();
|
|
menu_show();
|
|
m_completions.candidates.push_back({sels.buffer().string(m_completions.begin, m_completions.end), "", {}});
|
|
return true;
|
|
}
|
|
|
|
void InsertCompleter::explicit_file_complete()
|
|
{
|
|
try_complete(complete_filename<false>);
|
|
m_explicit_completer = complete_filename<false>;
|
|
}
|
|
|
|
void InsertCompleter::explicit_word_buffer_complete()
|
|
{
|
|
try_complete(complete_word<false>);
|
|
m_explicit_completer = complete_word<false>;
|
|
}
|
|
|
|
void InsertCompleter::explicit_word_all_complete()
|
|
{
|
|
try_complete(complete_word<true>);
|
|
m_explicit_completer = complete_word<true>;
|
|
}
|
|
|
|
void InsertCompleter::explicit_line_complete()
|
|
{
|
|
try_complete(complete_line);
|
|
m_explicit_completer = complete_line;
|
|
}
|
|
|
|
}
|