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