#include "commands.hh" #include "command_manager.hh" #include "buffer_manager.hh" #include "option_manager.hh" #include "context.hh" #include "buffer.hh" #include "window.hh" #include "file.hh" #include "input_handler.hh" #include "string.hh" #include "highlighter_registry.hh" #include "filter_registry.hh" #include "register_manager.hh" #include "completion.hh" #include "shell_manager.hh" #include "event_manager.hh" #include "color_registry.hh" #include "client_manager.hh" #include #include #include namespace Kakoune { using namespace std::placeholders; // berk extern bool quit_requested; namespace { struct wrong_argument_count : runtime_error { wrong_argument_count() : runtime_error("wrong argument count") {} }; struct unknown_option : public runtime_error { unknown_option(const String& name) : runtime_error("unknown option '" + name + "'") {} }; struct missing_option_value: public runtime_error { missing_option_value(const String& name) : runtime_error("missing value for option '" + name + "'") {} }; // ParameterParser provides tools to parse command parameters. // There are 3 types of parameters: // * unnamed options, which are accessed by position (ignoring named ones) // * named boolean options, which are enabled using '-name' syntax // * named string options, which are defined using '-name value' syntax struct ParametersParser { // the options defines named options, if they map to true, then // they are understood as string options, else they are understood as // boolean option. ParametersParser(const CommandParameters& params, std::unordered_map options) : m_params(params), m_positional(params.size(), true), m_options(options) { for (size_t i = 0; i < params.size(); ++i) { if (params[i][0] == '-') { auto it = options.find(params[i].substr(1_byte)); if (it == options.end()) throw unknown_option(params[i]); if (it->second) { if (i + 1 == params.size() or params[i+1][0] == '-') throw missing_option_value(params[i]); m_positional[i+1] = false; } m_positional[i] = false; } // all options following -- are positional if (params[i] == "--") break; } } // check if a named option (either string or boolean) is specified bool has_option(const String& name) const { assert(m_options.find(name) != m_options.end()); for (auto& param : m_params) { if (param[0] == '-' and param.substr(1_byte) == name) return true; if (param == "--") break; } return false; } // get a string option value, returns an empty string if the option // is not defined const String& option_value(const String& name) const { auto it = m_options.find(name); assert(it != m_options.end()); assert(it->second == true); for (size_t i = 0; i < m_params.size(); ++i) { if (m_params[i][0] == '-' and m_params[i].substr(1_byte) == name) return m_params[i+1]; if (m_params[i] == "--") break; } static String empty; return empty; } size_t positional_count() const { size_t res = 0; for (bool positional : m_positional) { if (positional) ++res; } return res; } struct iterator { public: typedef String value_type; typedef const value_type* pointer; typedef const value_type& reference; typedef size_t difference_type; typedef std::forward_iterator_tag iterator_category; iterator(const ParametersParser& parser, size_t index) : m_parser(parser), m_index(index) {} const String& operator*() const { assert(m_parser.m_positional[m_index]); return m_parser.m_params[m_index]; } const String* operator->() const { assert(m_parser.m_positional[m_index]); return &m_parser.m_params[m_index]; } iterator& operator++() { while (m_index < m_parser.m_positional.size() and not m_parser.m_positional[++m_index]) {} return *this; } bool operator==(const iterator& other) const { return &m_parser == &other.m_parser and m_index == other.m_index; } bool operator!=(const iterator& other) const { return &m_parser != &other.m_parser or m_index != other.m_index; } bool operator<(const iterator& other) const { assert(&m_parser == &other.m_parser); return m_index < other.m_index; } private: const ParametersParser& m_parser; size_t m_index; }; // positional parameter begin iterator begin() const { int index = 0; while (index < m_positional.size() and not m_positional[index]) ++index; return iterator(*this, index); } // positional parameter end iterator end() const { return iterator(*this, m_params.size()); } // access positional parameter by index const String& operator[] (size_t index) const { assert(index < positional_count()); iterator it = begin(); while (index) { ++it; --index; } return *it; } private: const CommandParameters& m_params; std::vector m_positional; std::unordered_map m_options; }; Buffer* open_or_create(const String& filename, Context& context) { Buffer* buffer = create_buffer_from_file(filename); if (not buffer) { context.print_status("new file " + filename); buffer = new Buffer(filename, Buffer::Flags::File | Buffer::Flags::New); } return buffer; } Buffer* open_fifo(const String& name , const String& filename, Context& context) { int fd = open(filename.c_str(), O_RDONLY | O_CLOEXEC); if (fd < 0) throw runtime_error("unable to open " + filename); Buffer* buffer = new Buffer(name, Buffer::Flags::Fifo | Buffer::Flags::NoUndo); buffer->hook_manager().add_hook("BufClose", [fd, buffer](const String&, const Context&) { // Check if fifo is still alive, else fd may // refer to another file/socket if (buffer->flags() & Buffer::Flags::Fifo) { EventManager::instance().unwatch(fd); close(fd); } }); EventManager::instance().watch(fd, [buffer](int fd) { char data[4096]; ssize_t count = read(fd, data, 4096); buffer->insert(buffer->end()-1, count > 0 ? String(data, data+count) : "*** kak: fifo closed ***\n"); ClientManager::instance().redraw_clients(); if (count <= 0) { assert(buffer->flags() & Buffer::Flags::Fifo); buffer->flags() &= ~Buffer::Flags::Fifo; // after that this closure will be dead, do not access // any captured data. EventManager::instance().unwatch(fd); close(fd); } }); return buffer; } template void edit(const CommandParameters& params, Context& context) { ParametersParser parser(params, { { "scratch", false }, { "fifo", true } }); const size_t param_count = parser.positional_count(); if (param_count == 0 or param_count > 3) throw wrong_argument_count(); const String& name = parser[0]; Buffer* buffer = nullptr; if (not force_reload) buffer = BufferManager::instance().get_buffer(name); if (not buffer) { if (parser.has_option("scratch")) buffer = new Buffer(name, Buffer::Flags::None); else if (parser.has_option("fifo")) buffer = open_fifo(name, parser.option_value("fifo"), context); else buffer = open_or_create(name, context); } BufferManager::instance().set_last_used_buffer(*buffer); if (buffer != &context.buffer() or param_count > 1) context.push_jump(); if (buffer != &context.buffer()) { auto& manager = ClientManager::instance(); context.change_editor(manager.get_unused_window_for_buffer(*buffer)); } if (param_count > 1) { int line = std::max(0, str_to_int(parser[1]) - 1); int column = param_count > 2 ? std::max(0, str_to_int(parser[2]) - 1) : 0; context.editor().select(context.buffer().iterator_at({ line, column })); if (context.has_window()) context.window().center_selection(); } } void write_buffer(const CommandParameters& params, Context& context) { if (params.size() > 1) throw wrong_argument_count(); Buffer& buffer = context.buffer(); if (params.empty() and !(buffer.flags() & Buffer::Flags::File)) throw runtime_error("cannot write a non file buffer without a filename"); String filename = params.empty() ? buffer.name() : parse_filename(params[0]); write_buffer_to_file(buffer, filename); buffer.notify_saved(); } void write_all_buffers(const CommandParameters& params, Context& context) { if (params.size() != 0) throw wrong_argument_count(); for (auto& buffer : BufferManager::instance()) { if ((buffer->flags() & Buffer::Flags::File) and buffer->is_modified()) { write_buffer_to_file(*buffer, buffer->name()); buffer->notify_saved(); } } } template void quit(const CommandParameters& params, Context& context) { if (params.size() != 0) throw wrong_argument_count(); if (not force and ClientManager::instance().count() == 1) { std::vector names; for (auto& buffer : BufferManager::instance()) { if (buffer->flags() != Buffer::Flags::File and buffer->is_modified()) names.push_back(buffer->name()); } if (not names.empty()) { String message = "modified buffers remaining: ["; for (auto it = names.begin(); it != names.end(); ++it) { if (it != names.begin()) message += ", "; message += *it; } message += "]"; throw runtime_error(message); } } // unwind back to this client event handler. throw client_removed{}; } template void write_and_quit(const CommandParameters& params, Context& context) { write_buffer(params, context); quit(CommandParameters(), context); } void show_buffer(const CommandParameters& params, Context& context) { if (params.size() != 1) throw wrong_argument_count(); const String& buffer_name = params[0]; Buffer* buffer = BufferManager::instance().get_buffer(buffer_name); if (not buffer) throw runtime_error("buffer " + buffer_name + " does not exists"); BufferManager::instance().set_last_used_buffer(*buffer); if (buffer != &context.buffer()) { context.push_jump(); auto& manager = ClientManager::instance(); context.change_editor(manager.get_unused_window_for_buffer(*buffer)); } } void delete_buffer(const CommandParameters& params, Context& context) { if (params.size() > 1) throw wrong_argument_count(); BufferManager& manager = BufferManager::instance(); Buffer* buffer = nullptr; if (params.empty()) buffer = &context.buffer(); else { const String& buffer_name = params[0]; buffer = manager.get_buffer(buffer_name); if (not buffer) throw runtime_error("buffer " + buffer_name + " does not exists"); } if (buffer->flags() & Buffer::Flags::File and buffer->is_modified()) throw runtime_error("buffer " + buffer->name() + " is modified"); if (manager.count() == 1) throw runtime_error("buffer " + buffer->name() + " is the last one"); ClientManager::instance().ensure_no_client_uses_buffer(*buffer); delete buffer; } void add_highlighter(const CommandParameters& params, Context& context) { ParametersParser parser(params, { { "group", true } }); if (parser.positional_count() < 1) throw wrong_argument_count(); HighlighterRegistry& registry = HighlighterRegistry::instance(); auto begin = parser.begin(); const String& name = *begin; std::vector highlighter_params; for (++begin; begin != parser.end(); ++begin) highlighter_params.push_back(*begin); Window& window = context.window(); HighlighterGroup& group = parser.has_option("group") ? window.highlighters().get_group(parser.option_value("group")) : window.highlighters(); registry.add_highlighter_to_group(window, group, name, highlighter_params); } void rm_highlighter(const CommandParameters& params, Context& context) { ParametersParser parser(params, { { "group", true } }); if (parser.positional_count() != 1) throw wrong_argument_count(); Window& window = context.window(); HighlighterGroup& group = parser.has_option("group") ? window.highlighters().get_group(parser.option_value("group")) : window.highlighters(); group.remove(parser[0]); } void add_filter(const CommandParameters& params, Context& context) { ParametersParser parser(params, { { "group", true } }); if (parser.positional_count() < 1) throw wrong_argument_count(); FilterRegistry& registry = FilterRegistry::instance(); auto begin = parser.begin(); const String& name = *begin; std::vector filter_params; for (++begin; begin != parser.end(); ++begin) filter_params.push_back(*begin); Editor& editor = context.editor(); FilterGroup& group = parser.has_option("group") ? editor.filters().get_group(parser.option_value("group")) : editor.filters(); registry.add_filter_to_group(group, name, filter_params); } void rm_filter(const CommandParameters& params, Context& context) { ParametersParser parser(params, { { "group", true } }); if (parser.positional_count() != 1) throw wrong_argument_count(); Editor& editor = context.editor(); FilterGroup& group = parser.has_option("group") ? editor.filters().get_group(parser.option_value("group")) : editor.filters(); group.remove(parser[0]); } void add_hook(const CommandParameters& params, Context& context) { if (params.size() != 4) throw wrong_argument_count(); // copy so that the lambda gets a copy as well Regex regex(params[2].begin(), params[2].end()); String command = params[3]; auto hook_func = [=](const String& param, const Context& context) { if (boost::regex_match(param.begin(), param.end(), regex)) { Context new_context(context.editor()); CommandManager::instance().execute(command, new_context); } }; const String& scope = params[0]; const String& name = params[1]; if (scope == "global") GlobalHookManager::instance().add_hook(name, hook_func); else if (scope == "buffer") context.buffer().hook_manager().add_hook(name, hook_func); else if (scope == "window") context.window().hook_manager().add_hook(name , hook_func); else throw runtime_error("error: no such hook container " + scope); } EnvVarMap params_to_env_var_map(const CommandParameters& params) { std::unordered_map vars; char param_name[] = "param0"; for (size_t i = 0; i < params.size(); ++i) { param_name[sizeof(param_name) - 2] = '0' + i; vars[param_name] = params[i]; } return vars; } void define_command(const CommandParameters& params, Context& context) { ParametersParser parser(params, { { "env-params", false }, { "shell-params", false }, { "allow-override", false }, { "file-completion", false }, { "shell-completion", true } }); if (parser.positional_count() != 2) throw wrong_argument_count(); auto begin = parser.begin(); const String& cmd_name = *begin; if (CommandManager::instance().command_defined(cmd_name) and not parser.has_option("allow-override")) throw runtime_error("command '" + cmd_name + "' already defined"); String commands = parser[1]; Command cmd; if (parser.has_option("env-params")) { cmd = [=](const CommandParameters& params, Context& context) { CommandManager::instance().execute(commands, context, {}, params_to_env_var_map(params)); }; } if (parser.has_option("shell-params")) { cmd = [=](const CommandParameters& params, Context& context) { CommandManager::instance().execute(commands, context, params, {}); }; } else { cmd = [=](const CommandParameters& params, Context& context) { if (not params.empty()) throw wrong_argument_count(); CommandManager::instance().execute(commands, context); }; } CommandCompleter completer; if (parser.has_option("file-completion")) { completer = [](const Context& context, const CommandParameters& params, size_t token_to_complete, ByteCount pos_in_token) { const String& prefix = token_to_complete < params.size() ? params[token_to_complete] : String(); return complete_filename(context, prefix, pos_in_token); }; } else if (parser.has_option("shell-completion")) { String shell_cmd = parser.option_value("shell-completion"); completer = [=](const Context& context, const CommandParameters& params, size_t token_to_complete, ByteCount pos_in_token) { EnvVarMap vars = { {"token_to_complete", int_to_str(token_to_complete) }, { "pos_in_token", int_to_str((int)pos_in_token) } }; String output = ShellManager::instance().eval(shell_cmd, context, params, vars); return split(output, '\n'); }; } CommandManager::instance().register_command(cmd_name, cmd, completer); } void echo_message(const CommandParameters& params, Context& context) { String message; for (auto& param : params) message += param + " "; context.print_status(message); } void exec_commands_in_file(const CommandParameters& params, Context& context) { if (params.size() != 1) throw wrong_argument_count(); String file_content = read_file(parse_filename(params[0])); CommandManager::instance().execute(file_content, context); } void set_option(OptionManager& option_manager, const CommandParameters& params, Context& context) { if (params.size() != 2) throw wrong_argument_count(); option_manager.set_option(params[0], Option(params[1])); } class RegisterRestorer { public: RegisterRestorer(char name, const Context& context) : m_name(name) { memoryview save = RegisterManager::instance()[name].values(context); m_save = std::vector(save.begin(), save.end()); } ~RegisterRestorer() { RegisterManager::instance()[m_name] = m_save; } private: std::vector m_save; char m_name; }; class BatchUI : public UserInterface { public: BatchUI(const KeyList& keys) : m_keys(keys), m_pos(0) {} Key get_key() override { assert(m_pos < m_keys.size()); return m_keys[m_pos++]; } bool is_key_available() override { return m_pos < m_keys.size(); } void print_status(const String& , CharCount) override {} void draw(const DisplayBuffer&, const String&) override {} void menu_show(const memoryview&, const DisplayCoord&, MenuStyle) override {} void menu_select(int) override {} void menu_hide() override {} DisplayCoord dimensions() override { return { 0, 0 }; } private: const KeyList& m_keys; size_t m_pos; }; void exec_keys(const KeyList& keys, Context& context) { RegisterRestorer quote('"', context); RegisterRestorer slash('/', context); BatchUI batch_ui(keys); InputHandler batch_input_handler; scoped_edition edition(context.editor()); Context new_context(batch_input_handler, context.editor(), batch_ui); batch_input_handler.handle_available_inputs(new_context); context.change_editor(new_context.editor()); } void exec_string(const CommandParameters& params, Context& context) { if (params.empty()) throw wrong_argument_count(); KeyList keys; for (auto& param : params) { KeyList param_keys = parse_keys(param); keys.insert(keys.end(), param_keys.begin(), param_keys.end()); } exec_keys(keys, context); } void menu(const CommandParameters& params, Context& context) { ParametersParser parser(params, { { "auto-single", false } }); size_t count = parser.positional_count(); if (count == 0 or (count % 2) != 0) throw wrong_argument_count(); if (count == 2 and parser.has_option("auto-single")) { CommandManager::instance().execute(parser[1], context); return; } std::vector choices; std::vector commands; for (int i = 0; i < count; i += 2) { choices.push_back(parser[i]); commands.push_back(parser[i+1]); } context.input_handler().menu(choices, [=](int choice, Context& context) { if (choice >= 0 and choice < commands.size()) CommandManager::instance().execute(commands[choice], context); }, context); } void try_catch(const CommandParameters& params, Context& context) { if (params.size() != 3) throw wrong_argument_count(); if (params[1] != "catch") throw runtime_error("try needs a catch"); CommandManager& command_manager = CommandManager::instance(); try { command_manager.execute(params[0], context); } catch (Kakoune::runtime_error& e) { command_manager.execute(params[2], context); } } void define_color_alias(const CommandParameters& params, Context& context) { ParametersParser parser(params, { { "allow-override", false } }); if (parser.positional_count() != 2) throw wrong_argument_count(); ColorRegistry::instance().register_alias( parser[0], parser[1], parser.has_option("allow-override")); } } void register_commands() { CommandManager& cm = CommandManager::instance(); PerArgumentCommandCompleter filename_completer({ complete_filename }); cm.register_commands({ "e", "edit" }, edit, filename_completer); cm.register_commands({ "e!", "edit!" }, edit, filename_completer); cm.register_commands({ "w", "write" }, write_buffer, filename_completer); cm.register_commands({ "wa", "writeall" }, write_all_buffers); cm.register_commands({ "q", "quit" }, quit); cm.register_commands({ "q!", "quit!" }, quit); cm.register_command("wq", write_and_quit); cm.register_command("wq!", write_and_quit); PerArgumentCommandCompleter buffer_completer({ [](const Context& context, const String& prefix, ByteCount cursor_pos) { return BufferManager::instance().complete_buffername(prefix, cursor_pos); } }); cm.register_commands({ "b", "buffer" }, show_buffer, buffer_completer); cm.register_commands({ "db", "delbuf" }, delete_buffer, buffer_completer); cm.register_commands({ "ah", "addhl" }, add_highlighter, [](const Context& context, const CommandParameters& params, size_t token_to_complete, ByteCount pos_in_token) { Window& w = context.window(); const String& arg = token_to_complete < params.size() ? params[token_to_complete] : String(); if (token_to_complete == 1 and params[0] == "-group") return w.highlighters().complete_group_id(arg, pos_in_token); else if (token_to_complete == 0 or (token_to_complete == 2 and params[0] == "-group")) return HighlighterRegistry::instance().complete_highlighter(arg, pos_in_token); else return CandidateList(); }); cm.register_commands({ "rh", "rmhl" }, rm_highlighter, [](const Context& context, const CommandParameters& params, size_t token_to_complete, ByteCount pos_in_token) { Window& w = context.window(); const String& arg = token_to_complete < params.size() ? params[token_to_complete] : String(); if (token_to_complete == 1 and params[0] == "-group") return w.highlighters().complete_group_id(arg, pos_in_token); else if (token_to_complete == 2 and params[0] == "-group") return w.highlighters().get_group(params[1]).complete_id(arg, pos_in_token); else return w.highlighters().complete_id(arg, pos_in_token); }); cm.register_commands({ "af", "addfilter" }, add_filter, [](const Context& context, const CommandParameters& params, size_t token_to_complete, ByteCount pos_in_token) { Window& w = context.window(); const String& arg = token_to_complete < params.size() ? params[token_to_complete] : String(); if (token_to_complete == 1 and params[0] == "-group") return w.filters().complete_group_id(arg, pos_in_token); else if (token_to_complete == 0 or (token_to_complete == 2 and params[0] == "-group")) return FilterRegistry::instance().complete_filter(arg, pos_in_token); else return CandidateList(); }); cm.register_commands({ "rf", "rmfilter" }, rm_filter, [](const Context& context, const CommandParameters& params, size_t token_to_complete, ByteCount pos_in_token) { Window& w = context.window(); const String& arg = token_to_complete < params.size() ? params[token_to_complete] : String(); if (token_to_complete == 1 and params[0] == "-group") return w.filters().complete_group_id(arg, pos_in_token); else if (token_to_complete == 2 and params[0] == "-group") return w.filters().get_group(params[1]).complete_id(arg, pos_in_token); else return w.filters().complete_id(arg, pos_in_token); }); cm.register_command("hook", add_hook); cm.register_command("source", exec_commands_in_file, filename_completer); cm.register_command("exec", exec_string); cm.register_command("menu", menu); cm.register_command("try", try_catch); cm.register_command("def", define_command); cm.register_command("echo", echo_message); cm.register_commands({ "setg", "setglobal" }, [](const CommandParameters& params, Context& context) { set_option(GlobalOptionManager::instance(), params, context); }, PerArgumentCommandCompleter({ [](const Context& context, const String& prefix, ByteCount cursor_pos) { return GlobalOptionManager::instance().complete_option_name(prefix, cursor_pos); } })); cm.register_commands({ "setb", "setbuffer" }, [](const CommandParameters& params, Context& context) { set_option(context.buffer().option_manager(), params, context); }, PerArgumentCommandCompleter({ [](const Context& context, const String& prefix, ByteCount cursor_pos) { return context.buffer().option_manager().complete_option_name(prefix, cursor_pos); } })); cm.register_commands({ "setw", "setwindow" }, [](const CommandParameters& params, Context& context) { set_option(context.window().option_manager(), params, context); }, PerArgumentCommandCompleter({ [](const Context& context, const String& prefix, ByteCount cursor_pos) { return context.window().option_manager().complete_option_name(prefix, cursor_pos); } })); cm.register_commands({"ca", "colalias"}, define_color_alias); } }