summaryrefslogtreecommitdiff
path: root/src/command_manager.hh
blob: 601629cbcb4bd8d19ef9b978484cac30e3a51a62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
#ifndef command_manager_hh_INCLUDED
#define command_manager_hh_INCLUDED

#include "coord.hh"
#include "completion.hh"
#include "flags.hh"
#include "array_view.hh"
#include "shell_manager.hh"
#include "parameters_parser.hh"
#include "string.hh"
#include "utils.hh"
#include "unordered_map.hh"

#include <functional>
#include <initializer_list>

namespace Kakoune
{

class Context;
using CommandParameters = ConstArrayView<String>;
using Command = std::function<void (const ParametersParser& parser,
                                    Context& context,
                                    const ShellContext& shell_context)>;

using CommandCompleter = std::function<Completions (const Context& context,
                                                    CompletionFlags,
                                                    CommandParameters,
                                                    size_t, ByteCount)>;

using CommandHelper = std::function<String (const Context& context, CommandParameters)>;

enum class CommandFlags
{
    None   = 0,
    Hidden = 1,
};

template<> struct WithBitOps<CommandFlags> : std::true_type {};

class PerArgumentCommandCompleter
{
public:
    using ArgumentCompleter = std::function<Completions (const Context&,
                                            CompletionFlags flags,
                                            const String&, ByteCount)>;
    using ArgumentCompleterList = ConstArrayView<ArgumentCompleter>;

    PerArgumentCommandCompleter(ArgumentCompleterList completers)
        : m_completers(completers.begin(), completers.end()) {}

    Completions operator()(const Context& context,
                           CompletionFlags flags,
                           CommandParameters params,
                           size_t token_to_complete,
                           ByteCount pos_in_token) const;

private:
    Vector<ArgumentCompleter, MemoryDomain::Commands> m_completers;
};

using CommandInfo = std::pair<String, String>;

struct Token
{
    enum class Type
    {
        Raw,
        RawQuoted,
        RawEval,
        ShellExpand,
        RegisterExpand,
        OptionExpand,
        ValExpand,
        ArgExpand,
        CommandSeparator
    };
    Token() : m_type(Type::Raw) {}

    Token(Type type, ByteCount b, ByteCount e, CharCoord coord, String str = "")
        : m_type(type), m_begin(b), m_end(e), m_coord(coord), m_content(std::move(str)) {}

    Type type() const { return m_type; }
    ByteCount begin() const { return m_begin; }
    ByteCount end() const { return m_end; }
    CharCoord coord() const { return m_coord; }
    const String& content() const { return m_content; }

private:
    Type   m_type;
    ByteCount m_begin;
    ByteCount m_end;
    CharCoord m_coord;
    String m_content;
};

using TokenList = Vector<Token>;

template<bool throw_on_unterminated>
TokenList parse(StringView line);

class CommandManager : public Singleton<CommandManager>
{
public:
    void execute(StringView command_line, Context& context,
                 const ShellContext& shell_context = ShellContext{});

    Completions complete(const Context& context, CompletionFlags flags,
                         StringView command_line, ByteCount cursor_pos);

    Completions complete(const Context& context, CompletionFlags flags,
                         CommandParameters params,
                         size_t token_to_complete, ByteCount pos_in_token);

    CommandInfo command_info(const Context& context,
                             StringView command_line) const;

    bool command_defined(const String& command_name) const;

    void register_command(String command_name, Command command,
                          String docstring,
                          ParameterDesc param_desc,
                          CommandFlags flags = CommandFlags::None,
                          CommandHelper helper = CommandHelper(),
                          CommandCompleter completer = CommandCompleter());

    Completions complete_command_name(const Context& context, StringView query, bool with_aliases) const;

    void clear_last_complete_command() { m_last_complete_command = String{}; }

private:
    void execute_single_command(CommandParameters params,
                                Context& context,
                                const ShellContext& shell_context,
                                CharCoord pos) const;

    struct CommandDescriptor
    {
        Command command;
        String docstring;
        ParameterDesc param_desc;
        CommandFlags flags;
        CommandHelper helper;
        CommandCompleter completer;
    };
    using CommandMap = UnorderedMap<String, CommandDescriptor, MemoryDomain::Commands>;
    CommandMap m_commands;
    String m_last_complete_command;

    CommandMap::const_iterator find_command(const Context& context,
                                            const String& name) const;
};

String expand(StringView str, const Context& context,
              const ShellContext& shell_context = ShellContext{});

}

#endif // command_manager_hh_INCLUDED