#include "command_manager.hh" #include "alias_registry.hh" #include "assert.hh" #include "buffer_utils.hh" #include "context.hh" #include "flags.hh" #include "optional.hh" #include "ranges.hh" #include "register_manager.hh" #include "shell_manager.hh" #include "utils.hh" #include namespace Kakoune { bool CommandManager::command_defined(StringView command_name) const { return m_commands.find(command_name) != m_commands.end(); } void CommandManager::register_command(String command_name, Command command, String docstring, ParameterDesc param_desc, CommandFlags flags, CommandHelper helper, CommandCompleter completer) { m_commands[command_name] = { std::move(command), std::move(docstring), std::move(param_desc), flags, std::move(helper), std::move(completer) }; } struct parse_error : runtime_error { parse_error(StringView error) : runtime_error{format("parse error: {}", error)} {} }; namespace { struct Reader { public: Reader(StringView s) : str{s}, pos{}, coord{} {} [[gnu::always_inline]] char operator*() const { kak_assert(pos < str.length()); return str[pos]; } Reader& operator++() { kak_assert(pos < str.length()); if (str[pos++] == '\n') { ++coord.line; coord.column = 0; } else ++coord.column; return *this; } [[gnu::always_inline]] explicit operator bool() const { return pos < str.length(); } [[gnu::always_inline]] StringView substr_from(ByteCount start) const { kak_assert(start <= pos); return str.substr(start, pos - start); } Optional peek_next() const { if (pos+1 != str.length()) return str[pos+1]; return {}; } StringView str; ByteCount pos; DisplayCoord coord; }; bool is_command_separator(char c) { return c == ';' or c == '\n'; } template String get_until_delimiter(Reader& reader, Func is_delimiter) { auto beg = reader.pos; String str; bool was_antislash = false; while (reader) { const char c = *reader; if (is_delimiter(c)) { str += reader.substr_from(beg); if (was_antislash) { str.back() = c; beg = reader.pos+1; } else return str; } was_antislash = c == '\\'; ++reader; } if (beg < reader.str.length()) str += reader.substr_from(beg); return str; } [[gnu::always_inline]] inline String get_until_delimiter(Reader& reader, char c) { return get_until_delimiter(reader, [c](char ch) { return c == ch; }); } StringView get_until_closing_delimiter(Reader& reader, char opening_delimiter, char closing_delimiter) { kak_assert(reader.str[reader.pos-1] == opening_delimiter); int level = 0; auto start = reader.pos; while (reader) { const char c = *reader; if (c == opening_delimiter) ++level; else if (c == closing_delimiter) { if (level > 0) --level; else break; } ++reader; } return reader.substr_from(start); } template Token::Type token_type(StringView type_name) { if (type_name == "") return Token::Type::RawQuoted; else if (type_name == "sh") return Token::Type::ShellExpand; else if (type_name == "reg") return Token::Type::RegisterExpand; else if (type_name == "opt") return Token::Type::OptionExpand; else if (type_name == "val") return Token::Type::ValExpand; else if (type_name == "arg") return Token::Type::ArgExpand; else if (throw_on_invalid) throw parse_error{format("unknown expand '{}'", type_name)}; else return Token::Type::RawQuoted; } void skip_blanks_and_comments(Reader& reader) { while (reader) { const char c = *reader; if (is_horizontal_blank(c)) ++reader; else if (c == '\\' and reader.peek_next().value_or('\0') == '\n') ++(++reader); else if (c == '#') { while (reader and *reader != '\n') ++reader; } else break; } } template Token parse_percent_token(Reader& reader) { ++reader; const ByteCount type_start = reader.pos; while (reader and isalpha(*reader)) ++reader; StringView type_name = reader.substr_from(type_start); if (not reader or is_blank(*reader)) { if (throw_on_unterminated) throw parse_error{format("expected a string delimiter after '%{}'", type_name)}; return {}; } Token::Type type = token_type(type_name); constexpr struct CharPair { char opening; char closing; } matching_pairs[] = { { '(', ')' }, { '[', ']' }, { '{', '}' }, { '<', '>' } }; char opening_delimiter = *reader; auto coord = reader.coord; ++reader; auto start = reader.pos; auto it = find_if(matching_pairs, [opening_delimiter](const CharPair& cp) { return opening_delimiter == cp.opening; }); if (it != std::end(matching_pairs)) { const char closing_delimiter = it->closing; auto token = get_until_closing_delimiter(reader, opening_delimiter, closing_delimiter); if (throw_on_unterminated and not reader) throw parse_error{format("{}:{}: unterminated string '%{}{}...{}'", coord.line, coord.column, type_name, opening_delimiter, closing_delimiter)}; return {type, start, reader.pos, coord, token.str()}; } else { String token = get_until_delimiter(reader, opening_delimiter); if (throw_on_unterminated and not reader) throw parse_error{format("{}:{}: unterminated string '%{}{}...{}'", coord.line, coord.column, type_name, opening_delimiter, opening_delimiter)}; return {type, start, reader.pos, coord, std::move(token)}; } } String expand_token(const Token& token, const Context& context, const ShellContext& shell_context) { auto& content = token.content; switch (token.type) { case Token::Type::ShellExpand: { auto str = ShellManager::instance().eval( content, context, {}, ShellManager::Flags::WaitForStdout, shell_context).first; int trailing_eol_count = 0; for (auto c : str | reverse()) { if (c != '\n') break; ++trailing_eol_count; } str.resize(str.length() - trailing_eol_count, 0); return str; } case Token::Type::RegisterExpand: return context.main_sel_register_value(content).str(); case Token::Type::OptionExpand: return context.options()[content].get_as_string(); case Token::Type::ValExpand: { auto it = shell_context.env_vars.find(content); if (it != shell_context.env_vars.end()) return it->value; return ShellManager::instance().get_val(content, context); } case Token::Type::ArgExpand: { auto& params = shell_context.params; if (content == '@') return join(params, ' '); const int arg = str_to_int(content)-1; if (arg < 0) throw runtime_error("invalid argument index"); return arg < params.size() ? params[arg] : String{}; } case Token::Type::RawEval: return expand(content, context, shell_context); case Token::Type::Raw: case Token::Type::RawQuoted: return content; default: kak_assert(false); } return {}; } } template TokenList parse(StringView line) { TokenList result; Reader reader{line}; while (true) { skip_blanks_and_comments(reader); if (not reader) break; ByteCount start = reader.pos; auto coord = reader.coord; const char c = *reader; if (c == '"' or c == '\'') { start = (++reader).pos; String token = get_until_delimiter(reader, c); if (throw_on_unterminated and not reader) throw parse_error{format("unterminated string {0}...{0}", c)}; result.push_back({c == '"' ? Token::Type::RawEval : Token::Type::RawQuoted, start, reader.pos, coord, std::move(token)}); } else if (c == '%') result.push_back( parse_percent_token(reader)); else { String str = get_until_delimiter(reader, [](char c) { return is_command_separator(c) or is_horizontal_blank(c); }); if (not str.empty()) result.push_back({Token::Type::Raw, start, reader.pos, coord, unescape(str, "%", '\\')}); if (reader and is_command_separator(*reader)) result.push_back({Token::Type::CommandSeparator, reader.pos, reader.pos+1, coord, {}}); } if (not reader) break; ++reader; } return result; } template String expand_impl(StringView str, const Context& context, const ShellContext& shell_context, Postprocess postprocess) { Reader reader{str}; String res; auto beg = 0_byte; while (reader) { char c = *reader; if (c == '\\') { c = *++reader; if (c == '%' or c == '\\') { res += reader.substr_from(beg); res.back() = c; beg = (++reader).pos; } } else if (c == '%') { res += reader.substr_from(beg); res += postprocess(expand_token(parse_percent_token(reader), context, shell_context)); beg = (++reader).pos; } else ++reader; } res += reader.substr_from(beg); return res; } String expand(StringView str, const Context& context, const ShellContext& shell_context) { return expand_impl(str, context, shell_context, [](String s){ return s; }); } String expand(StringView str, const Context& context, const ShellContext& shell_context, const std::function& postprocess) { return expand_impl(str, context, shell_context, [&](String s) { return postprocess(std::move(s)); }); } struct command_not_found : runtime_error { command_not_found(StringView command) : runtime_error(command + " : no such command") {} }; CommandManager::CommandMap::const_iterator CommandManager::find_command(const Context& context, StringView name) const { auto alias = context.aliases()[name]; StringView cmd_name = alias.empty() ? name : alias; return m_commands.find(cmd_name); } void CommandManager::execute_single_command(CommandParameters params, Context& context, const ShellContext& shell_context, DisplayCoord pos) { if (params.empty()) return; constexpr int max_command_depth = 100; if (m_command_depth > max_command_depth) throw runtime_error("maximum nested command depth hit"); ++m_command_depth; auto pop_cmd = on_scope_end([this] { --m_command_depth; }); ParameterList param_view(params.begin()+1, params.end()); auto command_it = find_command(context, params[0]); if (command_it == m_commands.end()) throw command_not_found(params[0]); const DebugFlags debug_flags = context.options()["debug"].get(); if (debug_flags & DebugFlags::Commands) { String repr_parameters; for (auto repr_param : param_view) repr_parameters += " " + repr_param; write_to_debug_buffer(format("command {}{}", params[0], repr_parameters)); } try { ParametersParser parameter_parser(param_view, command_it->value.param_desc); command_it->value.command(parameter_parser, context, shell_context); } catch (runtime_error& error) { throw runtime_error(format("{}:{}: '{}' {}", pos.line+1, pos.column+1, params[0], error.what())); } } void CommandManager::execute(StringView command_line, Context& context, const ShellContext& shell_context) { TokenList tokens = parse(command_line); if (tokens.empty()) return; DisplayCoord command_coord; Vector params; for (auto it = tokens.begin(); it != tokens.end(); ) { if (params.empty()) command_coord = it->coord; if (it->type == Token::Type::CommandSeparator) { execute_single_command(params, context, shell_context, command_coord); params.clear(); } // Shell expand are retokenized else if (it->type == Token::Type::ShellExpand) { auto new_tokens = parse(expand_token(*it, context, shell_context)); it = tokens.insert(tokens.erase(it), std::make_move_iterator(new_tokens.begin()), std::make_move_iterator(new_tokens.end())); continue; // skip incrementing, we already point to next token } else if (it->type == Token::Type::ArgExpand and it->content == '@') params.insert(params.end(), shell_context.params.begin(), shell_context.params.end()); else params.push_back(expand_token(*it, context, shell_context)); ++it; } execute_single_command(params, context, shell_context, command_coord); } Optional CommandManager::command_info(const Context& context, StringView command_line) const { TokenList tokens = parse(command_line); size_t cmd_idx = 0; for (size_t i = 0; i < tokens.size(); ++i) { if (tokens[i].type == Token::Type::CommandSeparator) cmd_idx = i+1; } if (cmd_idx == tokens.size() or (tokens[cmd_idx].type != Token::Type::Raw and tokens[cmd_idx].type != Token::Type::RawQuoted)) return {}; auto cmd = find_command(context, tokens[cmd_idx].content); if (cmd == m_commands.end()) return {}; CommandInfo res; res.name = cmd->key; if (not cmd->value.docstring.empty()) res.info += cmd->value.docstring + "\n"; if (cmd->value.helper) { Vector params; for (auto it = tokens.begin() + cmd_idx + 1; it != tokens.end() and it->type != Token::Type::CommandSeparator; ++it) { if (it->type == Token::Type::Raw or it->type == Token::Type::RawQuoted or it->type == Token::Type::RawEval) params.push_back(it->content); } String helpstr = cmd->value.helper(context, params); if (not helpstr.empty()) res.info += format("{}\n", helpstr); } String aliases; for (auto& alias : context.aliases().aliases_for(cmd->key)) aliases += " " + alias; if (not aliases.empty()) res.info += format("Aliases:{}\n", aliases); auto& switches = cmd->value.param_desc.switches; if (not switches.empty()) res.info += format("Switches:\n{}", indent(generate_switches_doc(switches))); return res; } Completions CommandManager::complete_command_name(const Context& context, StringView query) const { auto commands = m_commands | filter([](const CommandMap::Item& cmd) { return not (cmd.value.flags & CommandFlags::Hidden); }) | transform(std::mem_fn(&CommandMap::Item::key)); return {0, query.length(), Kakoune::complete(query, query.length(), commands)}; } Completions CommandManager::complete(const Context& context, CompletionFlags flags, StringView command_line, ByteCount cursor_pos) { TokenList tokens = parse(command_line); size_t cmd_idx = 0; size_t tok_idx = tokens.size(); for (size_t i = 0; i < tokens.size(); ++i) { if (tokens[i].type == Token::Type::CommandSeparator) cmd_idx = i+1; if (tokens[i].begin <= cursor_pos and tokens[i].end >= cursor_pos) { tok_idx = i; break; } } const bool is_last_token = tok_idx == tokens.size(); // command name completion if (tokens.empty() or (tok_idx == cmd_idx and (is_last_token or tokens[tok_idx].type == Token::Type::Raw or tokens[tok_idx].type == Token::Type::RawQuoted))) { auto cmd_start = is_last_token ? cursor_pos : tokens[tok_idx].begin; StringView query = command_line.substr(cmd_start, cursor_pos - cmd_start); return offset_pos(complete_command_name(context, query), cmd_start); } kak_assert(not tokens.empty()); ByteCount start = tok_idx < tokens.size() ? tokens[tok_idx].begin : cursor_pos; ByteCount cursor_pos_in_token = cursor_pos - start; const Token::Type type = tok_idx < tokens.size() ? tokens[tok_idx].type : Token::Type::Raw; switch (type) { case Token::Type::OptionExpand: return {start , cursor_pos, GlobalScope::instance().option_registry().complete_option_name( tokens[tok_idx].content, cursor_pos_in_token) }; case Token::Type::ShellExpand: return offset_pos(shell_complete(context, flags, tokens[tok_idx].content, cursor_pos_in_token), start); case Token::Type::ValExpand: return {start , cursor_pos, ShellManager::instance().complete_env_var( tokens[tok_idx].content, cursor_pos_in_token) }; case Token::Type::Raw: case Token::Type::RawQuoted: case Token::Type::RawEval: { if (tokens[cmd_idx].type != Token::Type::Raw) return Completions{}; StringView command_name = tokens[cmd_idx].content; if (command_name != m_last_complete_command) { m_last_complete_command = command_name.str(); flags |= CompletionFlags::Start; } auto command_it = find_command(context, command_name); if (command_it == m_commands.end() or not command_it->value.completer) return Completions(); Vector params; for (auto it = tokens.begin() + cmd_idx + 1; it != tokens.end(); ++it) params.push_back(it->content); if (tok_idx == tokens.size()) params.emplace_back(""); Completions completions = offset_pos(command_it->value.completer( context, flags, params, tok_idx - cmd_idx - 1, cursor_pos_in_token), start); if (type != Token::Type::RawQuoted) { StringView to_escape = type == Token::Type::Raw ? "% \t;" : "%"; for (auto& candidate : completions.candidates) candidate = escape(candidate, to_escape, '\\'); } return completions; } default: break; } return Completions{}; } Completions CommandManager::complete(const Context& context, CompletionFlags flags, CommandParameters params, size_t token_to_complete, ByteCount pos_in_token) { StringView prefix = params[token_to_complete].substr(0, pos_in_token); if (token_to_complete == 0) return complete_command_name(context, prefix); else { StringView command_name = params[0]; if (command_name != m_last_complete_command) { m_last_complete_command = command_name.str(); flags |= CompletionFlags::Start; } auto command_it = find_command(context, command_name); if (command_it != m_commands.end() and command_it->value.completer) return command_it->value.completer( context, flags, params.subrange(1), token_to_complete-1, pos_in_token); } return Completions{}; } }