summaryrefslogtreecommitdiffstats
path: root/src/readline_context.hh
blob: 99f17421fbc9d701841396e6f334496d20d0613c (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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/**
 * Copyright (c) 2022, Timothy Stack
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * * Neither the name of Timothy Stack nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @file readline_context.hh
 */

#ifndef readline_context_hh
#define readline_context_hh

#include <set>
#include <string>

#include <readline/history.h>

#include "base/lnav.console.hh"
#include "base/result.h"
#include "help_text.hh"

class attr_line_t;
struct exec_context;

using readline_highlighter_t = void (*)(attr_line_t& line, int x);

/**
 * Container for information related to different readline contexts.  Since
 * lnav uses readline for different inputs, we need a way to keep things like
 * history and tab-completions separate.
 */
class readline_context {
public:
    using command_func_t = Result<std::string, lnav::console::user_message> (*)(
        exec_context& ec, std::string cmdline, std::vector<std::string>& args);

    struct prompt_result_t {
        std::string pr_new_prompt;
        std::string pr_suggestion;
    };

    struct stage {
        std::vector<line_range> s_args;
    };

    struct split_result_t {
        std::vector<stage> sr_stages;
    };

    using prompt_func_t
        = prompt_result_t (*)(exec_context& ec, const std::string& cmdline);
    using splitter_func_t
        = split_result_t (*)(readline_context& rc, const std::string& cmdline);
    using command_t = struct _command_t {
        const char* c_name;
        command_func_t c_func;

        struct help_text c_help;
        prompt_func_t c_prompt{nullptr};
        std::string c_provides;
        std::set<std::string> c_dependencies;

        _command_t(const char* name,
                   command_func_t func,
                   help_text help = {},
                   prompt_func_t prompt = nullptr,
                   std::string provides = {},
                   std::set<std::string> deps = {}) noexcept
            : c_name(name), c_func(func), c_help(std::move(help)),
              c_prompt(prompt), c_provides(provides), c_dependencies(deps)
        {
        }

        _command_t(command_func_t func) noexcept : c_name("anon"), c_func(func)
        {
        }
    };
    typedef std::map<std::string, command_t*> command_map_t;

    readline_context(std::string name,
                     command_map_t* commands = nullptr,
                     bool case_sensitive = true);

    const std::string& get_name() const { return this->rc_name; }

    void load();

    void set_history();

    void save();

    void add_possibility(const std::string& type, const std::string& value)
    {
        this->rc_possibilities[type].insert(value);
    }

    void rem_possibility(const std::string& type, const std::string& value)
    {
        this->rc_possibilities[type].erase(value);
    }

    void clear_possibilities(const std::string& type)
    {
        this->rc_possibilities[type].clear();
    }

    bool is_case_sensitive() const { return this->rc_case_sensitive; }

    readline_context& set_append_character(int ch)
    {
        this->rc_append_character = ch;

        return *this;
    }

    int get_append_character() const { return this->rc_append_character; }

    readline_context& set_highlighter(readline_highlighter_t hl)
    {
        this->rc_highlighter = hl;
        return *this;
    }

    readline_context& set_quote_chars(const char* qc)
    {
        this->rc_quote_chars = qc;

        return *this;
    }

    readline_context& with_readline_var(char** var, const char* val)
    {
        this->rc_vars.emplace_back(var, val);

        return *this;
    }

    readline_highlighter_t get_highlighter() const
    {
        return this->rc_highlighter;
    }

    readline_context& with_splitter(splitter_func_t sf)
    {
        this->rc_splitter = sf;
        return *this;
    }

    static int command_complete(int, int);

    std::map<std::string, std::string> rc_prefixes;

private:
    static char** attempted_completion(const char* text, int start, int end);
    static char* completion_generator(const char* text, int state);

    static readline_context* loaded_context;
    static std::set<std::string>* arg_possibilities;

    struct readline_var {
        readline_var(char** dst, const char* val)
        {
            this->rv_dst.ch = dst;
            this->rv_val.ch = val;
        }

        union {
            char** ch;
        } rv_dst;
        union {
            const char* ch;
        } rv_val;
    };

    std::string rc_name;
    HISTORY_STATE rc_history;
    std::map<std::string, std::set<std::string>> rc_possibilities;
    std::map<std::string, std::vector<std::string>> rc_prototypes;
    std::map<std::string, command_t*> rc_commands;
    bool rc_case_sensitive;
    int rc_append_character{' '};
    const char* rc_quote_chars;
    readline_highlighter_t rc_highlighter;
    std::vector<readline_var> rc_vars;
    splitter_func_t rc_splitter{nullptr};
};

#endif