#include "insert_completer.hh" #include "buffer_manager.hh" #include "buffer_utils.hh" #include "client.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 namespace Kakoune { using StringList = Vector; 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 : ""); } 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{}; return; } throw runtime_error(format("invalid completer description: '{}'", str)); } namespace { WordDB& get_word_db(const Buffer& buffer) { static const ValueId word_db_id = ValueId::get_free_id(); Value& cache_val = buffer.values()[word_db_id]; if (not cache_val) cache_val = Value(WordDB{buffer}); return cache_val.as(); } template InsertCompletion complete_word(const SelectionList& sels, const OptionManager& options) { const Buffer& buffer = sels.buffer(); ByteCoord cursor_pos = sels.main().cursor(); using Utf8It = utf8::iterator; Utf8It pos{buffer.iterator_at(cursor_pos), buffer}; if (pos == buffer.begin() or not is_word(*(pos-1))) return {}; ByteCoord word_begin; String prefix; IdMap 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(), [](Codepoint c) { return is_word(c); })) ++begin; if (i == sels.main_index()) { word_begin = begin.base().coord(); prefix = buffer.string(word_begin, end.base().coord()); } skip_while(end, buffer.end(), [](Codepoint c) { return is_word(c); }); auto word = buffer.string(begin.base().coord(), end.base().coord()); ++sel_word_counts[word]; } struct RankedMatchAndBuffer : RankedMatch { RankedMatchAndBuffer(const RankedMatch& m, const Buffer* b) : RankedMatch{m}, buffer{b} {} using RankedMatch::operator==; using RankedMatch::operator<; bool operator==(StringView other) const { return candidate() == other; } const Buffer* buffer; }; Vector matches; auto add_matches = [&](const Buffer& buf) { auto& word_db = get_word_db(buf); auto bufmatches = word_db.find_matching(prefix); for (auto& m : bufmatches) matches.push_back({ m, &buf }); }; add_matches(buffer); // Remove words that are being edited for (auto& word_count : sel_word_counts) { if (get_word_db(buffer).get_word_occurences(word_count.key) <= word_count.value) unordered_erase(matches, StringView{word_count.key}); } if (other_buffers) { for (const auto& buf : BufferManager::instance()) { if (buf.get() == &buffer or buf->flags() & Buffer::Flags::Debug) continue; add_matches(*buf); } } using StaticWords = Vector; for (auto& word : options["static_words"].get()) if (RankedMatch match{word, prefix}) matches.emplace_back(match, nullptr); unordered_erase(matches, StringView{prefix}); std::sort(matches.begin(), matches.end()); matches.erase(std::unique(matches.begin(), matches.end()), matches.end()); const auto longest = std::accumulate(matches.begin(), matches.end(), 0_char, [](const CharCount& lhs, const RankedMatchAndBuffer& rhs) { return std::max(lhs, rhs.candidate().char_length()); }); InsertCompletion::CandidateList candidates; candidates.reserve(matches.size()); for (auto& m : matches) { DisplayLine menu_entry; if (m.buffer) { const auto pad_len = longest + 1 - m.candidate().char_length(); menu_entry.push_back(m.candidate().str()); menu_entry.push_back(String{' ', pad_len}); menu_entry.push_back({ m.buffer->display_name(), get_face("MenuInfo") }); } else menu_entry.push_back(m.candidate().str()); candidates.push_back({m.candidate().str(), "", std::move(menu_entry)}); } return { word_begin, cursor_pos, std::move(candidates), buffer.timestamp() }; } template 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 {}; auto prefix = buffer.string(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, Regex{})) candidates.push_back({ filename, "", filename }); } else { for (auto dir : options["path"].get()) { if (not dir.empty() and dir.back() != '/') dir += '/'; for (auto& filename : Kakoune::complete_filename(dir + prefix, Regex{})) { StringView candidate = filename.substr(dir.length()); candidates.push_back({ candidate.str(), "", candidate.str() }); } } } if (candidates.empty()) return {}; return { begin.coord(), pos.coord(), std::move(candidates), buffer.timestamp() }; } InsertCompletion complete_option(const SelectionList& sels, const OptionManager& options, StringView option_name) { const Buffer& buffer = sels.buffer(); ByteCoord cursor_pos = sels.main().cursor(); const CompletionList& opt = options[option_name].get(); if (opt.list.empty()) return {}; auto& desc = opt.prefix; static const Regex re(R"((\d+)\.(\d+)(?:\+(\d+))?@(\d+))"); MatchResults match; if (regex_match(desc.begin(), desc.end(), match, re)) { ByteCoord 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[coord.line].substr( coord.column, cursor_pos.column - coord.column); const CharCount tabstop = options["tabstop"].get(); const CharCount 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 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)); } } std::sort(matches.begin(), matches.end()); InsertCompletion::CandidateList candidates; candidates.reserve(matches.size()); for (auto& match : matches) candidates.push_back({ match.candidate().str(), match.docstring.str(), std::move(match.menu_entry) }); return { coord, end, std::move(candidates), timestamp }; } } return {}; } InsertCompletion complete_line(const SelectionList& sels, const OptionManager& options) { const Buffer& buffer = sels.buffer(); ByteCoord cursor_pos = sels.main().cursor(); const CharCount tabstop = options["tabstop"].get(); const CharCount 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 { cursor_pos.line, cursor_pos, std::move(candidates), buffer.timestamp() }; } } InsertCompleter::InsertCompleter(const 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& 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); for (auto& sel : selections) { const auto& cursor = sel.cursor(); auto pos = buffer.iterator_at(cursor); if (cursor.column >= prefix_len and (pos + suffix_len) != buffer.end() and std::equal(ref.begin(), ref.end(), pos - prefix_len)) { buffer.replace((pos - prefix_len).coord(), (pos + suffix_len).coord(), candidate.completion); const_cast(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.push_back(Key::Backspace); for (auto i = 0_byte; i < suffix_len; ++i) keystrokes.push_back(Key::Delete); for (auto& c : candidate.completion) keystrokes.push_back(c); } void InsertCompleter::update() { if (m_explicit_completer and try_complete(m_explicit_completer)) return; reset(); setup_ifn(); } void InsertCompleter::reset() { m_completions = InsertCompletion{}; m_explicit_completer = nullptr; if (m_context.has_client()) { m_context.client().menu_hide(); m_context.client().info_hide(); } } bool InsertCompleter::setup_ifn() { using namespace std::placeholders; if (not m_completions.is_valid()) { auto& completers = m_options["completers"].get(); for (auto& completer : completers) { if (completer.mode == InsertCompleterDesc::Filename and try_complete(complete_filename)) return true; if (completer.mode == InsertCompleterDesc::Option and try_complete([&,this](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)) return true; if (completer.mode == InsertCompleterDesc::Word and *completer.param == "all" and try_complete(complete_word)) return true; } return false; } return true; } void InsertCompleter::menu_show() { if (not m_context.has_client()) return; Vector 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); } 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(); for (auto& completer : completers) { if (completer.mode == InsertCompleterDesc::Option and *completer.param == opt.name()) { reset(); setup_ifn(); break; } } } template 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); m_explicit_completer = complete_filename; } void InsertCompleter::explicit_word_complete() { try_complete(complete_word); m_explicit_completer = complete_word; } void InsertCompleter::explicit_line_complete() { try_complete(complete_line); m_explicit_completer = complete_line; } }