2 * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the University of California, Berkeley nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #define _GNU_SOURCE /* for asprintf */
33 #include <readline/readline.h>
34 #include <readline/history.h>
36 #include <ecoli_node.h>
37 #include <ecoli_parsed.h>
38 #include <ecoli_completed.h>
39 #include <ecoli_keyval.h>
40 #include <ecoli_node_str.h>
41 #include <ecoli_node_seq.h>
42 #include <ecoli_node_space.h>
43 #include <ecoli_node_or.h>
44 #include <ecoli_node_sh_lex.h>
45 #include <ecoli_node_int.h>
46 #include <ecoli_node_option.h>
47 #include <ecoli_node_cmd.h>
48 #include <ecoli_node_many.h>
49 #include <ecoli_node_once.h>
50 #include <ecoli_node_file.h>
52 static struct ec_node *commands;
54 static char *my_completion_entry(const char *s, int state)
56 static struct ec_completed *c;
57 static struct ec_completed_iter *iter;
58 static const struct ec_completed_item *item;
62 /* don't append a quote */
63 rl_completion_suppress_quote = 1;
64 rl_basic_quote_characters = "";
71 line = strdup(rl_line_buffer);
74 line[rl_point] = '\0';
76 c = ec_node_complete(commands, line);
81 ec_completed_iter_free(iter);
82 iter = ec_completed_iter(c, EC_MATCH | EC_PARTIAL_MATCH);
87 item = ec_completed_iter_next(iter);
91 if (c->count_match == 1) {
93 /* don't add the trailing space for partial completions */
95 if (item->type == EC_MATCH)
96 rl_completion_suppress_append = 0;
98 rl_completion_suppress_append = 1;
101 return strdup(item->str);
102 } else if (rl_completion_type == '?') {
103 /* on second try only show the display part */
104 return strdup(item->display);
107 return strdup(item->str);
110 static char **my_attempted_completion(const char *text, int start, int end)
115 /* remove default file completion */
116 rl_attempted_completion_over = 1;
118 return rl_completion_matches(text, my_completion_entry);
121 /* this function builds the help string */
122 static char *get_node_help(const struct ec_completed_node *compnode)
124 const struct ec_completed_item *item;
125 const struct ec_node *node;
127 const char *node_help = NULL;
128 const char *node_desc = NULL;
131 /* Since we display only one help per node, only look at the first item
132 * to get the path. The objective is to retrieve the most precise
133 * help for this node. */
134 item = TAILQ_FIRST(&compnode->items);
135 for (i = 0; i < item->pathlen; i++) {
136 node = item->path[i];
137 if (node_help == NULL)
138 node_help = ec_keyval_get(ec_node_attrs(node), "help");
139 if (node_desc == NULL)
140 node_desc = ec_node_desc(node);
143 if (node_help == NULL)
145 if (node_desc == NULL)
148 if (asprintf(&help, "%-20s %s", node_desc, node_help) < 0)
154 static int show_help(int ignore, int invoking_key)
156 const struct ec_completed_node *compnode;
157 struct ec_completed *c;
160 unsigned int count, i;
167 line = strdup(rl_line_buffer);
171 /* check if the current line matches */
172 p = ec_node_parse(commands, line);
173 if (ec_parsed_matches(p))
177 /* complete at current cursor position */
178 line[rl_point] = '\0';
179 c = ec_node_complete(commands, line);
180 //ec_completed_dump(stdout, c);
185 /* let's display one contextual help per node */
187 TAILQ_FOREACH(compnode, &c->nodes, next) {
188 if (TAILQ_EMPTY(&compnode->items))
193 helps = calloc(count + match + 1, sizeof(char *));
198 helps[1] = "<return>";
200 /* strangely, rl_display_match_list() expects first index at 1 */
202 TAILQ_FOREACH(compnode, &c->nodes, next) {
203 if (TAILQ_EMPTY(&compnode->items))
205 helps[i++] = get_node_help(compnode);
208 ec_completed_free(c);
210 rl_display_match_list(helps, count + match, 1000); /* XXX 1000 */
212 rl_forced_update_display();
216 // free helps[n] XXX on error ?
219 static int create_commands(void)
221 struct ec_node *cmdlist = NULL, *cmd = NULL;
223 cmdlist = ec_node("or", NULL);
228 cmd = EC_NODE_SEQ(NULL,
229 ec_node_str(NULL, "hello"),
231 ec_node_str("john", "john"),
232 ec_node_str(NULL, "johnny"),
233 ec_node_str(NULL, "mike")
235 ec_node_option(NULL, ec_node_int("int", 0, 10, 10))
239 ec_keyval_set(ec_node_attrs(cmd), "help",
240 "say hello to someone several times", NULL);
241 ec_keyval_set(ec_node_attrs(ec_node_find(cmd, "john")),
242 "help", "specific help for john", NULL);
243 ec_keyval_set(ec_node_attrs(ec_node_find(cmd, "name")),
244 "help", "the name of the person", NULL);
245 ec_keyval_set(ec_node_attrs(ec_node_find(cmd, "int")),
246 "help", "an integer (0-10)", NULL);
247 if (ec_node_or_add(cmdlist, cmd) < 0)
251 cmd = EC_NODE_CMD(NULL, "good morning name [count]",
252 EC_NODE_CMD("name", "bob|bobby|michael"),
253 ec_node_int("count", 0, 10, 10));
256 ec_keyval_set(ec_node_attrs(cmd), "help",
257 "say good morning to someone several times", NULL);
258 ec_keyval_set(ec_node_attrs(ec_node_find(cmd, "name")), "help",
259 "the person to greet", NULL);
260 ec_keyval_set(ec_node_attrs(ec_node_find(cmd, "count")), "help",
261 "how many times to greet", NULL);
262 if (ec_node_or_add(cmdlist, cmd) < 0)
266 cmd = EC_NODE_CMD(NULL,
267 "buy potatoes,carrots,pumpkins");
270 ec_keyval_set(ec_node_attrs(cmd), "help",
271 "buy some vegetables", NULL);
272 if (ec_node_or_add(cmdlist, cmd) < 0)
276 cmd = EC_NODE_CMD(NULL, "eat vegetables",
277 ec_node_many("vegetables",
279 ec_node_str(NULL, "potatoes"),
281 ec_node_str(NULL, "carrots")),
283 ec_node_str(NULL, "pumpkins"))),
287 ec_keyval_set(ec_node_attrs(cmd), "help",
288 "eat vegetables (take some more potatoes)", NULL);
289 if (ec_node_or_add(cmdlist, cmd) < 0)
293 cmd = EC_NODE_SEQ(NULL,
294 ec_node_str(NULL, "bye")
296 ec_keyval_set(ec_node_attrs(cmd), "help", "say bye", NULL);
297 if (ec_node_or_add(cmdlist, cmd) < 0)
301 cmd = EC_NODE_SEQ(NULL,
302 ec_node_str(NULL, "load"),
303 ec_node("file", NULL)
305 ec_keyval_set(ec_node_attrs(cmd), "help", "load a file", NULL);
306 if (ec_node_or_add(cmdlist, cmd) < 0)
310 commands = ec_node_sh_lex(NULL, cmdlist);
311 if (commands == NULL)
317 fprintf(stderr, "cannot initialize nodes\n");
318 ec_node_free(cmdlist);
327 if (create_commands() < 0)
330 rl_bind_key('?', show_help);
331 rl_attempted_completion_function = my_attempted_completion;
334 line = readline("> ");
338 p = ec_node_parse(commands, line);
339 ec_parsed_dump(stdout, p);
345 ec_node_free(commands);