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]);
92 /* if id matches, use a node provided by the user... */
93 eval = ec_node_clone(node->table[i]);
99 /* ...or create a string node */
101 eval = ec_node_str(EC_NO_ID, str);
112 ec_node_cmd_eval_pre_op(void **result, void *userctx, void *operand,
113 const struct ec_parsed *operator)
124 ec_node_cmd_eval_post_op(void **result, void *userctx, void *operand,
125 const struct ec_parsed *operator)
127 const struct ec_strvec *vec;
128 struct ec_node *in = operand;;
129 struct ec_node *out = NULL;;
133 /* get parsed string vector, it should contain only one str */
134 vec = ec_parsed_strvec(operator);
135 if (ec_strvec_len(vec) != 1)
138 if (!strcmp(ec_strvec_val(vec, 0), "*")) {
139 out = ec_node_many(EC_NO_ID,
140 ec_node_clone(in), 0, 0);
153 ec_node_cmd_eval_bin_op(void **result, void *userctx, void *operand1,
154 const struct ec_parsed *operator, void *operand2)
157 const struct ec_strvec *vec;
158 struct ec_node *out = NULL;
159 struct ec_node *in1 = operand1;
160 struct ec_node *in2 = operand2;
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 (ec_strvec_len(vec) == 0) {
170 if (!strcmp(in1->type->name, "seq")) {
171 if (ec_node_seq_add(in1, ec_node_clone(in2)) < 0)
176 out = EC_NODE_SEQ(EC_NO_ID, ec_node_clone(in1),
184 } else if (!strcmp(ec_strvec_val(vec, 0), "|")) {
185 if (!strcmp(in2->type->name, "or")) {
186 if (ec_node_or_add(in2, ec_node_clone(in1)) < 0)
190 } else if (!strcmp(in1->type->name, "or")) {
191 if (ec_node_or_add(in1, ec_node_clone(in2)) < 0)
196 out = EC_NODE_OR(EC_NO_ID, ec_node_clone(in1),
204 } else if (!strcmp(ec_strvec_val(vec, 0), ",")) {
205 if (!strcmp(in2->type->name, "subset")) {
206 if (ec_node_subset_add(in2, ec_node_clone(in1)) < 0)
210 } else if (!strcmp(in1->type->name, "subset")) {
211 if (ec_node_subset_add(in1, ec_node_clone(in2)) < 0)
216 out = EC_NODE_SUBSET(EC_NO_ID, ec_node_clone(in1),
232 ec_node_cmd_eval_parenthesis(void **result, void *userctx,
233 const struct ec_parsed *open_paren,
234 const struct ec_parsed *close_paren,
237 const struct ec_strvec *vec;
238 struct ec_node *in = value;;
239 struct ec_node *out = NULL;;
244 /* get parsed string vector, it should contain only one str */
245 vec = ec_parsed_strvec(open_paren);
246 if (ec_strvec_len(vec) != 1)
249 if (!strcmp(ec_strvec_val(vec, 0), "[")) {
250 out = ec_node_option(EC_NO_ID, ec_node_clone(in));
254 } else if (!strcmp(ec_strvec_val(vec, 0), "(")) {
266 ec_node_cmd_eval_free(void *result, void *userctx)
272 static const struct ec_node_expr_eval_ops test_ops = {
273 .eval_var = ec_node_cmd_eval_var,
274 .eval_pre_op = ec_node_cmd_eval_pre_op,
275 .eval_post_op = ec_node_cmd_eval_post_op,
276 .eval_bin_op = ec_node_cmd_eval_bin_op,
277 .eval_parenthesis = ec_node_cmd_eval_parenthesis,
278 .eval_free = ec_node_cmd_eval_free,
281 static int ec_node_cmd_build(struct ec_node_cmd *node)
283 struct ec_node *expr = NULL, *lex = NULL, *cmd = NULL;
284 struct ec_parsed *p = NULL;
288 ec_node_free(node->expr);
290 ec_node_free(node->lex);
292 ec_node_free(node->cmd);
295 /* build the expression parser */
297 expr = ec_node("expr", "expr");
300 ret = ec_node_expr_set_val_node(expr, ec_node_re(EC_NO_ID, "[a-zA-Z0-9]+"));
303 ret = ec_node_expr_add_bin_op(expr, ec_node_str(EC_NO_ID, ","));
306 ret = ec_node_expr_add_bin_op(expr, ec_node_str(EC_NO_ID, "|"));
309 ret = ec_node_expr_add_bin_op(expr, ec_node("empty", EC_NO_ID));
312 ret = ec_node_expr_add_post_op(expr, ec_node_str(EC_NO_ID, "+"));
315 ret = ec_node_expr_add_post_op(expr, ec_node_str(EC_NO_ID, "*"));
318 ret = ec_node_expr_add_parenthesis(expr, ec_node_str(EC_NO_ID, "["),
319 ec_node_str(EC_NO_ID, "]"));
322 ec_node_expr_add_parenthesis(expr, ec_node_str(EC_NO_ID, "("),
323 ec_node_str(EC_NO_ID, ")"));
327 /* prepend a lexer to the expression node */
329 lex = ec_node_re_lex(EC_NO_ID, ec_node_clone(expr));
333 ret = ec_node_re_lex_add(lex, "[a-zA-Z0-9]+", 1);
336 ret = ec_node_re_lex_add(lex, "[*|,()]", 1);
339 ret = ec_node_re_lex_add(lex, "\\[", 1);
342 ret = ec_node_re_lex_add(lex, "\\]", 1);
345 ret = ec_node_re_lex_add(lex, "[ ]+", 0);
349 /* parse the command expression */
351 p = ec_node_parse(lex, node->cmd_str);
356 if (!ec_parsed_matches(p))
358 if (!ec_parsed_has_child(p))
361 ret = ec_node_expr_eval(&result, expr, ec_parsed_get_first_child(p),
384 ec_node_cmd_parse(const struct ec_node *gen_node, struct ec_parsed *state,
385 const struct ec_strvec *strvec)
387 struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
389 if (node->cmd == NULL)
391 return ec_node_parse_child(node->cmd, state, strvec);
395 ec_node_cmd_complete(const struct ec_node *gen_node,
396 struct ec_completed *completed,
397 const struct ec_strvec *strvec)
399 struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
401 if (node->cmd == NULL)
403 return ec_node_complete_child(node->cmd, completed, strvec);
406 static void ec_node_cmd_free_priv(struct ec_node *gen_node)
408 struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
411 ec_free(node->cmd_str);
412 ec_node_free(node->cmd);
413 ec_node_free(node->expr);
414 ec_node_free(node->lex);
415 for (i = 0; i < node->len; i++)
416 ec_node_free(node->table[i]);
417 ec_free(node->table);
421 static struct ec_node_type ec_node_cmd_type = {
423 .parse = ec_node_cmd_parse,
424 .complete = ec_node_cmd_complete,
425 .size = sizeof(struct ec_node_cmd),
426 .free_priv = ec_node_cmd_free_priv,
429 EC_NODE_TYPE_REGISTER(ec_node_cmd_type);
431 int ec_node_cmd_add_child(struct ec_node *gen_node, struct ec_node *child)
433 struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
434 struct ec_node **table;
437 assert(node != NULL);
444 if (ec_node_check_type(gen_node, &ec_node_cmd_type) < 0)
447 if (node->cmd == NULL) {
448 ret = ec_node_cmd_build(node);
453 table = ec_realloc(node->table, (node->len + 1) * sizeof(*node->table));
459 if (ec_node_add_child(gen_node, child) < 0)
462 table[node->len] = child;
472 struct ec_node *__ec_node_cmd(const char *id, const char *cmd, ...)
474 struct ec_node *gen_node = NULL;
475 struct ec_node_cmd *node = NULL;
476 struct ec_node *child;
480 gen_node = __ec_node(&ec_node_cmd_type, id);
481 if (gen_node == NULL)
485 node = (struct ec_node_cmd *)gen_node;
486 node->cmd_str = ec_strdup(cmd);
487 if (node->cmd_str == NULL)
493 for (child = va_arg(ap, struct ec_node *);
494 child != EC_NODE_ENDLIST;
495 child = va_arg(ap, struct ec_node *)) {
497 /* on error, don't quit the loop to avoid leaks */
498 if (fail == 1 || child == NULL ||
499 ec_node_cmd_add_child(&node->gen, child) < 0) {
510 if (ec_node_cmd_build(node) < 0)
516 ec_node_free(gen_node); /* will also free children */
520 struct ec_node *ec_node_cmd(const char *id, const char *cmd_str)
522 return __ec_node_cmd(id, cmd_str, EC_NODE_ENDLIST);
525 /* LCOV_EXCL_START */
526 static int ec_node_cmd_testcase(void)
528 struct ec_node *node;
531 node = EC_NODE_CMD(EC_NO_ID,
532 "command [option] (subset1, subset2, subset3, subset4) x|y z*",
533 ec_node_int("x", 0, 10, 10),
534 ec_node_int("y", 20, 30, 10)
537 EC_LOG(EC_LOG_ERR, "cannot create node\n");
540 testres |= EC_TEST_CHECK_PARSE(node, 2, "command", "1");
541 testres |= EC_TEST_CHECK_PARSE(node, 3, "command", "subset1", "1");
542 testres |= EC_TEST_CHECK_PARSE(node, 4, "command", "subset3", "subset2",
544 testres |= EC_TEST_CHECK_PARSE(node, 5, "command", "subset2", "subset3",
546 testres |= EC_TEST_CHECK_PARSE(node, 6, "command", "subset3", "subset1",
547 "subset4", "subset2", "4");
548 testres |= EC_TEST_CHECK_PARSE(node, 2, "command", "23");
549 testres |= EC_TEST_CHECK_PARSE(node, 3, "command", "option", "23");
550 testres |= EC_TEST_CHECK_PARSE(node, 5, "command", "option", "23",
552 testres |= EC_TEST_CHECK_PARSE(node, -1, "command", "15");
553 testres |= EC_TEST_CHECK_PARSE(node, -1, "foo");
556 node = EC_NODE_CMD(EC_NO_ID, "good morning [count] bob|bobby|michael",
557 ec_node_int("count", 0, 10, 10));
559 EC_LOG(EC_LOG_ERR, "cannot create node\n");
562 testres |= EC_TEST_CHECK_PARSE(node, 4, "good", "morning", "1", "bob");
564 testres |= EC_TEST_CHECK_COMPLETE(node,
566 "good", EC_NODE_ENDLIST);
567 testres |= EC_TEST_CHECK_COMPLETE(node,
568 "g", EC_NODE_ENDLIST,
569 "good", EC_NODE_ENDLIST);
570 testres |= EC_TEST_CHECK_COMPLETE(node,
571 "good", "morning", "", EC_NODE_ENDLIST,
572 "bob", "bobby", "michael", EC_NODE_ENDLIST);
576 node = EC_NODE_CMD(EC_NO_ID, "[foo [bar]]");
578 EC_LOG(EC_LOG_ERR, "cannot create node\n");
581 testres |= EC_TEST_CHECK_PARSE(node, 0);
582 testres |= EC_TEST_CHECK_PARSE(node, 1, "foo");
583 testres |= EC_TEST_CHECK_PARSE(node, 2, "foo", "bar");
584 testres |= EC_TEST_CHECK_PARSE(node, 0, "x");
591 static struct ec_test ec_node_cmd_test = {
593 .test = ec_node_cmd_testcase,
596 EC_TEST_REGISTER(ec_node_cmd_test);