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 */
34 #include <readline/readline.h>
35 #include <readline/history.h>
37 #include <ecoli_init.h>
38 #include <ecoli_node.h>
39 #include <ecoli_parsed.h>
40 #include <ecoli_completed.h>
41 #include <ecoli_keyval.h>
42 #include <ecoli_node_str.h>
43 #include <ecoli_node_seq.h>
44 #include <ecoli_node_space.h>
45 #include <ecoli_node_or.h>
46 #include <ecoli_node_sh_lex.h>
47 #include <ecoli_node_int.h>
48 #include <ecoli_node_option.h>
49 #include <ecoli_node_cmd.h>
50 #include <ecoli_node_many.h>
51 #include <ecoli_node_once.h>
52 #include <ecoli_node_file.h>
54 static struct ec_node *commands;
56 static char *my_completion_entry(const char *s, int state)
58 static struct ec_completed *c;
59 static struct ec_completed_iter *iter;
60 const struct ec_completed_item *item;
61 enum ec_completed_type item_type;
62 const char *item_str, *item_display;
66 /* Don't append a quote. Note: there are still some bugs when
67 * completing a quoted token. */
68 rl_completion_suppress_quote = 1;
69 rl_completer_quote_characters = "\"'";
75 line = strdup(rl_line_buffer);
78 line[rl_point] = '\0';
80 c = ec_node_complete(commands, line);
85 ec_completed_iter_free(iter);
86 iter = ec_completed_iter(c, EC_COMP_FULL | EC_COMP_PARTIAL);
91 item = ec_completed_iter_next(iter);
95 item_str = ec_completed_item_get_str(item);
96 if (c->count_full == 1) {
98 /* don't add the trailing space for partial completions */
100 item_type = ec_completed_item_get_type(item);
101 if (item_type == EC_COMP_FULL)
102 rl_completion_suppress_append = 0;
104 rl_completion_suppress_append = 1;
107 return strdup(item_str);
108 } else if (rl_completion_type == '?') {
109 /* on second try only show the display part */
110 item_display = ec_completed_item_get_display(item);
111 return strdup(item_display);
114 return strdup(item_str);
117 static char **my_attempted_completion(const char *text, int start, int end)
122 /* remove default file completion */
123 rl_attempted_completion_over = 1;
125 return rl_completion_matches(text, my_completion_entry);
128 /* this function builds the help string */
129 static char *get_node_help(const struct ec_completed_item *item)
131 const struct ec_completed_group *grp;
132 struct ec_parsed *state; // XXX keep const with macro
133 const struct ec_node *node;
135 const char *node_help = NULL;
136 const char *node_desc = NULL;
138 grp = ec_completed_item_get_grp(item);
140 ec_parsed_dump(stdout, ec_parsed_get_root(state));
141 for (state = grp->state; state != NULL;
142 state = ec_parsed_get_parent(state)) {
143 node = ec_parsed_get_node(state);
144 if (node_help == NULL)
145 node_help = ec_keyval_get(ec_node_attrs(node), "help");
146 if (node_desc == NULL)
147 node_desc = ec_node_desc(node);
150 if (node_help == NULL)
152 if (node_desc == NULL)
155 if (asprintf(&help, "%-20s %s", node_desc, node_help) < 0)
161 static int show_help(int ignore, int invoking_key)
163 struct ec_completed_iter *iter;
164 const struct ec_completed_group *grp, *prev_grp = NULL;
165 const struct ec_completed_item *item;
166 struct ec_completed *c;
176 line = strdup(rl_line_buffer);
180 /* check if the current line matches */
181 p = ec_node_parse(commands, line);
182 if (ec_parsed_matches(p))
187 /* complete at current cursor position */
188 line[rl_point] = '\0';
189 c = ec_node_complete(commands, line);
195 ec_completed_dump(stdout, c);
197 /* let's display one contextual help per node */
199 iter = ec_completed_iter(c,
200 EC_COMP_UNKNOWN | EC_COMP_FULL | EC_COMP_PARTIAL);
204 /* strangely, rl_display_match_list() expects first index at 1 */
205 helps = calloc(match + 1, sizeof(char *));
209 helps[1] = "<return>";
211 while ((item = ec_completed_iter_next(iter)) != NULL) {
214 /* keep one help per group, skip other items */
215 grp = ec_completed_item_get_grp(item);
221 tmp = realloc(helps, (count + match + 2) * sizeof(char *));
225 helps[count + match + 1] = get_node_help(item);
229 ec_completed_iter_free(iter);
230 ec_completed_free(c);
231 rl_display_match_list(helps, count + match, 1000); /* XXX 1000 */
232 rl_forced_update_display();
237 ec_completed_iter_free(iter);
240 ec_completed_free(c);
243 free(helps[count + match + 1]);
250 static int create_commands(void)
252 struct ec_node *cmdlist = NULL, *cmd = NULL;
254 cmdlist = ec_node("or", EC_NO_ID);
259 cmd = EC_NODE_SEQ(EC_NO_ID,
260 ec_node_str(EC_NO_ID, "hello"),
262 ec_node_str("john", "john"),
263 ec_node_str(EC_NO_ID, "johnny"),
264 ec_node_str(EC_NO_ID, "mike")
266 ec_node_option(EC_NO_ID, ec_node_int("int", 0, 10, 10))
270 ec_keyval_set(ec_node_attrs(cmd), "help",
271 "say hello to someone several times", NULL);
272 ec_keyval_set(ec_node_attrs(ec_node_find(cmd, "john")),
273 "help", "specific help for john", NULL);
274 ec_keyval_set(ec_node_attrs(ec_node_find(cmd, "name")),
275 "help", "the name of the person", NULL);
276 ec_keyval_set(ec_node_attrs(ec_node_find(cmd, "int")),
277 "help", "an integer (0-10)", NULL);
278 if (ec_node_or_add(cmdlist, cmd) < 0)
282 cmd = EC_NODE_CMD(EC_NO_ID, "good morning name [count]",
283 EC_NODE_CMD("name", "bob|bobby|michael"),
284 ec_node_int("count", 0, 10, 10));
287 ec_keyval_set(ec_node_attrs(cmd), "help",
288 "say good morning to someone several times", NULL);
289 ec_keyval_set(ec_node_attrs(ec_node_find(cmd, "name")), "help",
290 "the person to greet", NULL);
291 ec_keyval_set(ec_node_attrs(ec_node_find(cmd, "count")), "help",
292 "how many times to greet (0-10)", NULL);
293 if (ec_node_or_add(cmdlist, cmd) < 0)
297 cmd = EC_NODE_CMD(EC_NO_ID,
298 "buy potatoes,carrots,pumpkins");
301 ec_keyval_set(ec_node_attrs(cmd), "help",
302 "buy some vegetables", NULL);
303 if (ec_node_or_add(cmdlist, cmd) < 0)
307 cmd = EC_NODE_CMD(EC_NO_ID, "eat vegetables",
308 ec_node_many("vegetables",
310 ec_node_str(EC_NO_ID, "potatoes"),
311 ec_node_once(EC_NO_ID,
312 ec_node_str(EC_NO_ID, "carrots")),
313 ec_node_once(EC_NO_ID,
314 ec_node_str(EC_NO_ID, "pumpkins"))),
318 ec_keyval_set(ec_node_attrs(cmd), "help",
319 "eat vegetables (take some more potatoes)", NULL);
320 if (ec_node_or_add(cmdlist, cmd) < 0)
324 cmd = EC_NODE_SEQ(EC_NO_ID,
325 ec_node_str(EC_NO_ID, "bye")
327 ec_keyval_set(ec_node_attrs(cmd), "help", "say bye", NULL);
328 if (ec_node_or_add(cmdlist, cmd) < 0)
332 cmd = EC_NODE_SEQ(EC_NO_ID,
333 ec_node_str(EC_NO_ID, "load"),
334 ec_node("file", EC_NO_ID)
336 ec_keyval_set(ec_node_attrs(cmd), "help", "load a file", NULL);
337 if (ec_node_or_add(cmdlist, cmd) < 0)
341 commands = ec_node_sh_lex(EC_NO_ID, cmdlist);
342 if (commands == NULL)
348 fprintf(stderr, "cannot initialize nodes\n");
349 ec_node_free(cmdlist);
359 fprintf(stderr, "cannot init ecoli: %s\n", strerror(errno));
363 if (create_commands() < 0)
366 rl_bind_key('?', show_help);
367 rl_attempted_completion_function = my_attempted_completion;
370 line = readline("> ");
374 p = ec_node_parse(commands, line);
375 ec_parsed_dump(stdout, p);
381 ec_node_free(commands);