f479c3ffff5992716f0b531c12e1608d8c45f2d1
[protos/libecoli.git] / lib / ecoli_node_cmd.c
1 /*
2  * Copyright (c) 2016-2017, Olivier MATZ <zer0@droids-corp.org>
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
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.
15  *
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.
26  */
27
28 #include <sys/queue.h>
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <assert.h>
33 #include <stdarg.h>
34 #include <errno.h>
35 #include <limits.h>
36
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>
55
56 EC_LOG_TYPE_REGISTER(node_cmd);
57
58 struct ec_node_cmd {
59         struct ec_node gen;
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. */
66 };
67
68 static int
69 ec_node_cmd_eval_var(void **result, void *userctx,
70         const struct ec_parsed *var)
71 {
72         const struct ec_strvec *vec;
73         struct ec_node_cmd *node = userctx;
74         struct ec_node *eval = NULL;
75         const char *str, *id;
76         unsigned int i;
77
78         (void)userctx;
79
80         /* get parsed string vector, it should contain only one str */
81         vec = ec_parsed_strvec(var);
82         if (ec_strvec_len(vec) != 1)
83                 return -EINVAL;
84         str = ec_strvec_val(vec, 0);
85
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);
89                 if (id == NULL)
90                         continue;
91                 if (strcmp(str, id))
92                         continue;
93                 /* if id matches, use a node provided by the user... */
94                 eval = ec_node_clone(node->table[i]);
95                 if (eval == NULL)
96                         return -ENOMEM;
97                 break;
98         }
99
100         /* ...or create a string node */
101         if (eval == NULL) {
102                 eval = ec_node_str(EC_NO_ID, str);
103                 if (eval == NULL)
104                         return -ENOMEM;
105         }
106
107         //printf("eval var %s %p\n", str, eval);
108         *result = eval;
109
110         return 0;
111 }
112
113 static int
114 ec_node_cmd_eval_pre_op(void **result, void *userctx, void *operand,
115         const struct ec_parsed *operator)
116 {
117         (void)result;
118         (void)userctx;
119         (void)operand;
120         (void)operator;
121
122         return -EINVAL;
123 }
124
125 static int
126 ec_node_cmd_eval_post_op(void **result, void *userctx, void *operand,
127         const struct ec_parsed *operator)
128 {
129         const struct ec_strvec *vec;
130         struct ec_node *in = operand;;
131         struct ec_node *out = NULL;;
132
133         (void)userctx;
134
135         /* get parsed string vector, it should contain only one str */
136         vec = ec_parsed_strvec(operator);
137         if (ec_strvec_len(vec) != 1)
138                 return -EINVAL;
139
140         if (!strcmp(ec_strvec_val(vec, 0), "*")) {
141                 out = ec_node_many(EC_NO_ID,
142                                 ec_node_clone(in), 0, 0);
143                 if (out == NULL)
144                         return -EINVAL;
145                 ec_node_free(in);
146                 *result = out;
147         } else {
148                 return -EINVAL;
149         }
150
151         return 0;
152 }
153
154 static int
155 ec_node_cmd_eval_bin_op(void **result, void *userctx, void *operand1,
156         const struct ec_parsed *operator, void *operand2)
157
158 {
159         const struct ec_strvec *vec;
160         struct ec_node *out = NULL;
161         struct ec_node *in1 = operand1;
162         struct ec_node *in2 = operand2;
163
164         (void)userctx;
165
166         /* get parsed string vector, it should contain only one str */
167         vec = ec_parsed_strvec(operator);
168         if (ec_strvec_len(vec) != 1)
169                 return -EINVAL;
170
171         if (!strcmp(ec_strvec_val(vec, 0), "|")) {
172                 out = EC_NODE_OR(EC_NO_ID, ec_node_clone(in1), ec_node_clone(in2));
173                 if (out == NULL)
174                         return -EINVAL;
175                 ec_node_free(in1);
176                 ec_node_free(in2);
177                 *result = out;
178         } else if (!strcmp(ec_strvec_val(vec, 0), ",")) {
179                 if (!strcmp(in2->type->name, "subset")) {
180                         if (ec_node_subset_add(in2, ec_node_clone(in1)) < 0)
181                                 return -EINVAL;
182                         ec_node_free(in1);
183                         *result = in2;
184                 } else {
185                         out = EC_NODE_SUBSET(EC_NO_ID, ec_node_clone(in1),
186                                         ec_node_clone(in2));
187                         if (out == NULL)
188                                 return -EINVAL;
189                         ec_node_free(in1);
190                         ec_node_free(in2);
191                         *result = out;
192                 }
193         } else {
194                 return -EINVAL;
195         }
196
197         return 0;
198 }
199
200 static int
201 ec_node_cmd_eval_parenthesis(void **result, void *userctx,
202         const struct ec_parsed *open_paren,
203         const struct ec_parsed *close_paren,
204         void *value)
205 {
206         const struct ec_strvec *vec;
207         struct ec_node *in = value;;
208         struct ec_node *out = NULL;;
209
210         (void)userctx;
211         (void)close_paren;
212
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)
216                 return -EINVAL;
217
218         if (!strcmp(ec_strvec_val(vec, 0), "[")) {
219                 out = ec_node_option(EC_NO_ID, ec_node_clone(in));
220                 if (out == NULL)
221                         return -EINVAL;
222                 ec_node_free(in);
223         } else if (!strcmp(ec_strvec_val(vec, 0), "(")) {
224                 out = in;
225         } else {
226                 return -EINVAL;
227         }
228
229         *result = out;
230
231         return 0;
232 }
233
234 static void
235 ec_node_cmd_eval_free(void *result, void *userctx)
236 {
237         (void)userctx;
238         ec_free(result);
239 }
240
241 static const struct ec_node_expr_eval_ops test_ops = {
242         .eval_var = ec_node_cmd_eval_var,
243         .eval_pre_op = ec_node_cmd_eval_pre_op,
244         .eval_post_op = ec_node_cmd_eval_post_op,
245         .eval_bin_op = ec_node_cmd_eval_bin_op,
246         .eval_parenthesis = ec_node_cmd_eval_parenthesis,
247         .eval_free = ec_node_cmd_eval_free,
248 };
249
250 static int ec_node_cmd_build(struct ec_node_cmd *node)
251 {
252         struct ec_node *expr = NULL, *lex = NULL, *cmd = NULL;
253         struct ec_parsed *p = NULL, *child;
254         void *result;
255         int ret;
256
257         ec_node_free(node->expr);
258         node->expr = NULL;
259         ec_node_free(node->lex);
260         node->lex = NULL;
261         ec_node_free(node->cmd);
262         node->cmd = NULL;
263
264         /* build the expression parser */
265         ret = -ENOMEM;
266         expr = ec_node("expr", "expr");
267         if (expr == NULL)
268                 goto fail;
269         ret = ec_node_expr_set_val_node(expr, ec_node_re(EC_NO_ID, "[a-zA-Z0-9]+"));
270         if (ret < 0)
271                 goto fail;
272         ret = ec_node_expr_add_bin_op(expr, ec_node_str(EC_NO_ID, ","));
273         if (ret < 0)
274                 goto fail;
275         ret = ec_node_expr_add_bin_op(expr, ec_node_str(EC_NO_ID, "|"));
276         if (ret < 0)
277                 goto fail;
278         ret = ec_node_expr_add_post_op(expr, ec_node_str(EC_NO_ID, "+"));
279         if (ret < 0)
280                 goto fail;
281         ret = ec_node_expr_add_post_op(expr, ec_node_str(EC_NO_ID, "*"));
282         if (ret < 0)
283                 goto fail;
284         ret = ec_node_expr_add_parenthesis(expr, ec_node_str(EC_NO_ID, "["),
285                 ec_node_str(EC_NO_ID, "]"));
286         if (ret < 0)
287                 goto fail;
288         ec_node_expr_add_parenthesis(expr, ec_node_str(EC_NO_ID, "("),
289                 ec_node_str(EC_NO_ID, ")"));
290         if (ret < 0)
291                 goto fail;
292
293         /* prepend a lexer and a "many" to the expression node */
294         ret = -ENOMEM;
295         lex = ec_node_re_lex(EC_NO_ID,
296                 ec_node_many(EC_NO_ID, ec_node_clone(expr), 1, 0));
297         if (lex == NULL)
298                 goto fail;
299
300         ret = ec_node_re_lex_add(lex, "[a-zA-Z0-9]+", 1);
301         if (ret < 0)
302                 goto fail;
303         ret = ec_node_re_lex_add(lex, "[*|,()]", 1);
304         if (ret < 0)
305                 goto fail;
306         ret = ec_node_re_lex_add(lex, "\\[", 1);
307         if (ret < 0)
308                 goto fail;
309         ret = ec_node_re_lex_add(lex, "\\]", 1);
310         if (ret < 0)
311                 goto fail;
312         ret = ec_node_re_lex_add(lex, "[         ]+", 0);
313         if (ret < 0)
314                 goto fail;
315
316         /* parse the command expression */
317         ret = -ENOMEM;
318         p = ec_node_parse(lex, node->cmd_str);
319         if (p == NULL)
320                 goto fail;
321
322         ret = -EINVAL;
323         if (!ec_parsed_matches(p))
324                 goto fail;
325         if (!ec_parsed_has_child(p))
326                 goto fail;
327         if (!ec_parsed_has_child(ec_parsed_get_first_child(p)))
328                 goto fail;
329
330         ret = -ENOMEM;
331         cmd = ec_node("seq", EC_NO_ID);
332         if (cmd == NULL)
333                 goto fail;
334
335         EC_PARSED_FOREACH_CHILD(child, ec_parsed_get_first_child(p)) {
336                 ret = ec_node_expr_eval(&result, expr, child,
337                         &test_ops, node);
338                 if (ret < 0)
339                         goto fail;
340                 ret = ec_node_seq_add(cmd, result);
341                 if (ret < 0)
342                         goto fail;
343         }
344         ec_parsed_free(p);
345         p = NULL;
346
347         node->expr = expr;
348         node->lex = lex;
349         node->cmd = cmd;
350
351         return 0;
352
353 fail:
354         ec_parsed_free(p);
355         ec_node_free(expr);
356         ec_node_free(lex);
357         ec_node_free(cmd);
358         return ret;
359 }
360
361 static int
362 ec_node_cmd_parse(const struct ec_node *gen_node, struct ec_parsed *state,
363                 const struct ec_strvec *strvec)
364 {
365         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
366
367         if (node->cmd == NULL)
368                 return -ENOENT;
369         return ec_node_parse_child(node->cmd, state, strvec);
370 }
371
372 static int
373 ec_node_cmd_complete(const struct ec_node *gen_node,
374                 struct ec_completed *completed,
375                 const struct ec_strvec *strvec)
376 {
377         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
378
379         if (node->cmd == NULL)
380                 return -ENOENT;
381         return ec_node_complete_child(node->cmd, completed, strvec);
382 }
383
384 static void ec_node_cmd_free_priv(struct ec_node *gen_node)
385 {
386         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
387         unsigned int i;
388
389         ec_free(node->cmd_str);
390         ec_node_free(node->cmd);
391         ec_node_free(node->expr);
392         ec_node_free(node->lex);
393         for (i = 0; i < node->len; i++)
394                 ec_node_free(node->table[i]);
395         ec_free(node->table);
396 }
397
398
399 static struct ec_node_type ec_node_cmd_type = {
400         .name = "cmd",
401         .parse = ec_node_cmd_parse,
402         .complete = ec_node_cmd_complete,
403         .size = sizeof(struct ec_node_cmd),
404         .free_priv = ec_node_cmd_free_priv,
405 };
406
407 EC_NODE_TYPE_REGISTER(ec_node_cmd_type);
408
409 int ec_node_cmd_add_child(struct ec_node *gen_node, struct ec_node *child)
410 {
411         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
412         struct ec_node **table;
413         int ret;
414
415         assert(node != NULL);
416
417         if (child == NULL) {
418                 errno = EINVAL;
419                 goto fail;
420         }
421
422         if (ec_node_check_type(gen_node, &ec_node_cmd_type) < 0)
423                 goto fail;
424
425         if (node->cmd == NULL) {
426                 ret = ec_node_cmd_build(node);
427                 if (ret < 0)
428                         return ret;
429         }
430
431         table = ec_realloc(node->table, (node->len + 1) * sizeof(*node->table));
432         if (table == NULL)
433                 goto fail;
434
435         node->table = table;
436
437         if (ec_node_add_child(gen_node, child) < 0)
438                 goto fail;
439
440         table[node->len] = child;
441         node->len++;
442
443         return 0;
444
445 fail:
446         ec_node_free(child);
447         return -1;
448 }
449
450 struct ec_node *__ec_node_cmd(const char *id, const char *cmd, ...)
451 {
452         struct ec_node *gen_node = NULL;
453         struct ec_node_cmd *node = NULL;
454         struct ec_node *child;
455         va_list ap;
456         int fail = 0;
457
458         gen_node = __ec_node(&ec_node_cmd_type, id);
459         if (gen_node == NULL)
460                 fail = 1;
461
462         if (fail == 0) {
463                 node = (struct ec_node_cmd *)gen_node;
464                 node->cmd_str = ec_strdup(cmd);
465                 if (node->cmd_str == NULL)
466                         fail = 1;
467         }
468
469         va_start(ap, cmd);
470
471         for (child = va_arg(ap, struct ec_node *);
472              child != EC_NODE_ENDLIST;
473              child = va_arg(ap, struct ec_node *)) {
474
475                 /* on error, don't quit the loop to avoid leaks */
476                 if (fail == 1 || child == NULL ||
477                                 ec_node_cmd_add_child(&node->gen, child) < 0) {
478                         fail = 1;
479                         ec_node_free(child);
480                 }
481         }
482
483         va_end(ap);
484
485         if (fail == 1)
486                 goto fail;
487
488         if (ec_node_cmd_build(node) < 0)
489                 goto fail;
490
491         return gen_node;
492
493 fail:
494         ec_node_free(gen_node); /* will also free children */
495         return NULL;
496 }
497
498 struct ec_node *ec_node_cmd(const char *id, const char *cmd_str)
499 {
500         return __ec_node_cmd(id, cmd_str, EC_NODE_ENDLIST);
501 }
502
503 /* LCOV_EXCL_START */
504 static int ec_node_cmd_testcase(void)
505 {
506         struct ec_node *node;
507         int ret = 0;
508
509         node = EC_NODE_CMD(EC_NO_ID,
510                 "command [option] (subset1, subset2, subset3) x|y z*",
511                 ec_node_int("x", 0, 10, 10),
512                 ec_node_int("y", 20, 30, 10)
513         );
514         if (node == NULL) {
515                 EC_LOG(EC_LOG_ERR, "cannot create node\n");
516                 return -1;
517         }
518         ret |= EC_TEST_CHECK_PARSE(node, 2, "command", "1");
519         ret |= EC_TEST_CHECK_PARSE(node, 2, "command", "23");
520         ret |= EC_TEST_CHECK_PARSE(node, 3, "command", "option", "23");
521         ret |= EC_TEST_CHECK_PARSE(node, 5, "command", "option", "23",
522                                 "z", "z");
523         ret |= EC_TEST_CHECK_PARSE(node, -1, "command", "15");
524         ret |= EC_TEST_CHECK_PARSE(node, -1, "foo");
525         ec_node_free(node);
526
527         node = EC_NODE_CMD(EC_NO_ID, "good morning [count] bob|bobby|michael",
528                         ec_node_int("count", 0, 10, 10));
529         if (node == NULL) {
530                 EC_LOG(EC_LOG_ERR, "cannot create node\n");
531                 return -1;
532         }
533         ret |= EC_TEST_CHECK_PARSE(node, 4, "good", "morning", "1", "bob");
534
535         ret |= EC_TEST_CHECK_COMPLETE(node,
536                 "", EC_NODE_ENDLIST,
537                 "good", EC_NODE_ENDLIST);
538         ret |= EC_TEST_CHECK_COMPLETE(node,
539                 "g", EC_NODE_ENDLIST,
540                 "good", EC_NODE_ENDLIST);
541         ret |= EC_TEST_CHECK_COMPLETE(node,
542                 "good", "morning", "", EC_NODE_ENDLIST,
543                 "bob", "bobby", "michael", EC_NODE_ENDLIST);
544
545         ec_node_free(node);
546
547         return ret;
548 }
549 /* LCOV_EXCL_STOP */
550
551 static struct ec_test ec_node_cmd_test = {
552         .name = "node_cmd",
553         .test = ec_node_cmd_testcase,
554 };
555
556 EC_TEST_REGISTER(ec_node_cmd_test);