2 * Copyright (c) 2016-2017, 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 #include <sys/queue.h>
37 #include <ecoli_malloc.h>
38 #include <ecoli_log.h>
39 #include <ecoli_test.h>
40 #include <ecoli_strvec.h>
41 #include <ecoli_node.h>
42 #include <ecoli_parsed.h>
43 #include <ecoli_completed.h>
44 #include <ecoli_node_expr.h>
45 #include <ecoli_node_str.h>
46 #include <ecoli_node_or.h>
47 #include <ecoli_node_subset.h>
48 #include <ecoli_node_int.h>
49 #include <ecoli_node_many.h>
50 #include <ecoli_node_seq.h>
51 #include <ecoli_node_option.h>
52 #include <ecoli_node_re.h>
53 #include <ecoli_node_re_lex.h>
54 #include <ecoli_node_cmd.h>
56 EC_LOG_TYPE_REGISTER(node_cmd);
60 char *cmd_str; /* the command string. */
61 struct ec_node *cmd; /* the command node. */
62 struct ec_node *lex; /* the lexer node. */
63 struct ec_node *expr; /* the expression parser. */
64 struct ec_node **table; /* table of node referenced in command. */
65 unsigned int len; /* len of the table. */
69 ec_node_cmd_eval_var(void **result, void *userctx,
70 const struct ec_parsed *var)
72 const struct ec_strvec *vec;
73 struct ec_node_cmd *node = userctx;
74 struct ec_node *eval = NULL;
80 /* get parsed string vector, it should contain only one str */
81 vec = ec_parsed_strvec(var);
82 if (ec_strvec_len(vec) != 1)
84 str = ec_strvec_val(vec, 0);
86 for (i = 0; i < node->len; i++) {
87 id = ec_node_id(node->table[i]);
88 //printf("i=%d id=%s\n", i, id);
93 /* if id matches, use a node provided by the user... */
94 eval = ec_node_clone(node->table[i]);
100 /* ...or create a string node */
102 eval = ec_node_str(NULL, str);
107 //printf("eval var %s %p\n", str, eval);
114 ec_node_cmd_eval_pre_op(void **result, void *userctx, void *operand,
115 const struct ec_parsed *operator)
126 ec_node_cmd_eval_post_op(void **result, void *userctx, void *operand,
127 const struct ec_parsed *operator)
129 const struct ec_strvec *vec;
130 struct ec_node *eval = operand;;
134 /* get parsed string vector, it should contain only one str */
135 vec = ec_parsed_strvec(operator);
136 if (ec_strvec_len(vec) != 1)
139 if (!strcmp(ec_strvec_val(vec, 0), "*"))
144 //printf("eval post_op %p\n", eval);
151 ec_node_cmd_eval_bin_op(void **result, void *userctx, void *operand1,
152 const struct ec_parsed *operator, void *operand2)
155 const struct ec_strvec *vec;
156 struct ec_node *out = NULL;
157 struct ec_node *in1 = operand1;
158 struct ec_node *in2 = operand2;
162 //printf("eval bin_op %p %p\n", in1, in2);
164 /* get parsed string vector, it should contain only one str */
165 vec = ec_parsed_strvec(operator);
166 if (ec_strvec_len(vec) != 1)
169 if (!strcmp(ec_strvec_val(vec, 0), "|")) {
170 out = EC_NODE_OR(NULL, ec_node_clone(in1), ec_node_clone(in2));
176 } else if (!strcmp(ec_strvec_val(vec, 0), ",")) {
177 if (!strcmp(in2->type->name, "subset")) {
178 if (ec_node_subset_add(in2, ec_node_clone(in1)) < 0)
183 out = EC_NODE_SUBSET(NULL, ec_node_clone(in1),
195 //printf("eval bin_op out %p\n", *result);
201 ec_node_cmd_eval_parenthesis(void **result, void *userctx,
202 const struct ec_parsed *open_paren,
203 const struct ec_parsed *close_paren,
206 const struct ec_strvec *vec;
207 struct ec_node *in = value;;
208 struct ec_node *out = NULL;;
213 /* get parsed string vector, it should contain only one str */
214 vec = ec_parsed_strvec(open_paren);
215 if (ec_strvec_len(vec) != 1)
218 if (!strcmp(ec_strvec_val(vec, 0), "[")) {
219 out = ec_node_option(NULL, ec_node_clone(in));
223 } else if (!strcmp(ec_strvec_val(vec, 0), "(")) {
229 //printf("eval paren\n");
236 ec_node_cmd_eval_free(void *result, void *userctx)
242 static const struct ec_node_expr_eval_ops test_ops = {
243 .eval_var = ec_node_cmd_eval_var,
244 .eval_pre_op = ec_node_cmd_eval_pre_op,
245 .eval_post_op = ec_node_cmd_eval_post_op,
246 .eval_bin_op = ec_node_cmd_eval_bin_op,
247 .eval_parenthesis = ec_node_cmd_eval_parenthesis,
248 .eval_free = ec_node_cmd_eval_free,
252 ec_node_cmd_parse(const struct ec_node *gen_node, struct ec_parsed *state,
253 const struct ec_strvec *strvec)
255 struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
257 return ec_node_parse_child(node->cmd, state, strvec);
261 ec_node_cmd_complete(const struct ec_node *gen_node,
262 struct ec_completed *completed,
263 struct ec_parsed *parsed,
264 const struct ec_strvec *strvec)
266 struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
268 return ec_node_complete_child(node->cmd, completed, parsed, strvec);
271 static void ec_node_cmd_free_priv(struct ec_node *gen_node)
273 struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
276 ec_free(node->cmd_str);
277 ec_node_free(node->cmd);
278 ec_node_free(node->expr);
279 ec_node_free(node->lex);
280 for (i = 0; i < node->len; i++)
281 ec_node_free(node->table[i]);
282 ec_free(node->table);
285 static int ec_node_cmd_build(struct ec_node *gen_node)
287 struct ec_node *expr = NULL, *lex = NULL, *cmd = NULL;
288 struct ec_parsed *p, *child;
289 struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
293 /* XXX the expr parser can be moved in the node init */
295 /* build the expression parser */
297 expr = ec_node("expr", "expr");
300 ret = ec_node_expr_set_val_node(expr, ec_node_re(NULL, "[a-zA-Z0-9]+"));
303 ret = ec_node_expr_add_bin_op(expr, ec_node_str(NULL, ","));
306 ret = ec_node_expr_add_bin_op(expr, ec_node_str(NULL, "|"));
309 ret = ec_node_expr_add_post_op(expr, ec_node_str(NULL, "+"));
312 ret = ec_node_expr_add_post_op(expr, ec_node_str(NULL, "*"));
315 ret = ec_node_expr_add_parenthesis(expr, ec_node_str(NULL, "["),
316 ec_node_str(NULL, "]"));
319 ec_node_expr_add_parenthesis(expr, ec_node_str(NULL, "("),
320 ec_node_str(NULL, ")"));
324 /* prepend a lexer and a "many" to the expression node */
326 lex = ec_node_re_lex(NULL,
327 ec_node_many(NULL, ec_node_clone(expr), 1, 0));
331 ret = ec_node_re_lex_add(lex, "[a-zA-Z0-9]+", 1);
334 ret = ec_node_re_lex_add(lex, "[*|,()]", 1);
337 ret = ec_node_re_lex_add(lex, "\\[", 1);
340 ret = ec_node_re_lex_add(lex, "\\]", 1);
343 ret = ec_node_re_lex_add(lex, "[ ]+", 0);
347 /* parse the command expression */
349 p = ec_node_parse(lex, node->cmd_str);
354 if (!ec_parsed_matches(p))
356 if (TAILQ_EMPTY(&p->children))
358 if (TAILQ_EMPTY(&TAILQ_FIRST(&p->children)->children))
362 cmd = ec_node("seq", NULL);
366 TAILQ_FOREACH(child, &TAILQ_FIRST(&p->children)->children, next) {
367 ret = ec_node_expr_eval(&result, expr, child,
371 ret = ec_node_seq_add(cmd, result);
377 //ec_node_dump(stdout, cmd);
379 ec_node_free(node->expr);
381 ec_node_free(node->lex);
383 ec_node_free(node->cmd);
396 static struct ec_node_type ec_node_cmd_type = {
398 .build = ec_node_cmd_build,
399 .parse = ec_node_cmd_parse,
400 .complete = ec_node_cmd_complete,
401 .size = sizeof(struct ec_node_cmd),
402 .free_priv = ec_node_cmd_free_priv,
405 EC_NODE_TYPE_REGISTER(ec_node_cmd_type);
407 int ec_node_cmd_add_child(struct ec_node *gen_node, struct ec_node *child)
409 struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
410 struct ec_node **table;
412 // XXX check node type
414 assert(node != NULL);
419 gen_node->flags &= ~EC_NODE_F_BUILT;
421 table = ec_realloc(node->table, (node->len + 1) * sizeof(*node->table));
428 table[node->len] = child;
431 child->parent = gen_node;
432 TAILQ_INSERT_TAIL(&gen_node->children, child, next); // XXX really needed?
437 struct ec_node *ec_node_cmd(const char *id, const char *cmd_str)
439 struct ec_node *gen_node = NULL;
440 struct ec_node_cmd *node = NULL;
442 gen_node = __ec_node(&ec_node_cmd_type, id);
443 if (gen_node == NULL)
446 node = (struct ec_node_cmd *)gen_node;
447 node->cmd_str = ec_strdup(cmd_str);
448 if (node->cmd_str == NULL)
454 ec_node_free(gen_node);
458 struct ec_node *__ec_node_cmd(const char *id, const char *cmd, ...)
460 struct ec_node *gen_node = NULL;
461 struct ec_node_cmd *node = NULL;
462 struct ec_node *child;
468 gen_node = ec_node_cmd(id, cmd);
469 node = (struct ec_node_cmd *)gen_node;
473 for (child = va_arg(ap, struct ec_node *);
474 child != EC_NODE_ENDLIST;
475 child = va_arg(ap, struct ec_node *)) {
477 /* on error, don't quit the loop to avoid leaks */
478 if (fail == 1 || child == NULL ||
479 ec_node_cmd_add_child(&node->gen, child) < 0) {
492 ec_node_free(gen_node); /* will also free children */
497 /* LCOV_EXCL_START */
498 static int ec_node_cmd_testcase(void)
500 struct ec_node *node;
503 node = EC_NODE_CMD(NULL,
504 "command [option] (subset1, subset2, subset3) x|y",
505 ec_node_int("x", 0, 10, 10),
506 ec_node_int("y", 20, 30, 10)
509 EC_LOG(EC_LOG_ERR, "cannot create node\n");
512 ret |= EC_TEST_CHECK_PARSE(node, 2, "command", "1");
513 ret |= EC_TEST_CHECK_PARSE(node, 2, "command", "23");
514 ret |= EC_TEST_CHECK_PARSE(node, 3, "command", "option", "23");
515 ret |= EC_TEST_CHECK_PARSE(node, -1, "command", "15");
516 ret |= EC_TEST_CHECK_PARSE(node, -1, "foo");
519 node = EC_NODE_CMD(NULL, "good morning [count] bob|bobby|michael",
520 ec_node_int("count", 0, 10, 10));
522 EC_LOG(EC_LOG_ERR, "cannot create node\n");
525 ret |= EC_TEST_CHECK_PARSE(node, 4, "good", "morning", "1", "bob");
527 ret |= EC_TEST_CHECK_COMPLETE(node,
529 "good", EC_NODE_ENDLIST);
530 ret |= EC_TEST_CHECK_COMPLETE(node,
531 "g", EC_NODE_ENDLIST,
532 "good", EC_NODE_ENDLIST);
533 ret |= EC_TEST_CHECK_COMPLETE(node,
534 "good", "morning", "", EC_NODE_ENDLIST,
535 "bob", "bobby", "michael", EC_NODE_ENDLIST);
543 static struct ec_test ec_node_cmd_test = {
545 .test = ec_node_cmd_testcase,
548 EC_TEST_REGISTER(ec_node_cmd_test);