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 *eval = operand;;
 131
 132         (void)userctx;
 133
 134         /* get parsed string vector, it should contain only one str */
 135         vec = ec_parsed_strvec(operator);
 136         if (ec_strvec_len(vec) != 1)
 137                 return -EINVAL;
 138
 139         if (!strcmp(ec_strvec_val(vec, 0), "*"))
 140                 eval = NULL; //XXX
 141         else
 142                 return -EINVAL;
 143
 144         //printf("eval post_op %p\n", eval);
 145         *result = eval;
 146
 147         return 0;
 148 }
 149
 150 static int
 151 ec_node_cmd_eval_bin_op(void **result, void *userctx, void *operand1,
 152         const struct ec_parsed *operator, void *operand2)
 153
 154 {
 155         const struct ec_strvec *vec;
 156         struct ec_node *out = NULL;
 157         struct ec_node *in1 = operand1;
 158         struct ec_node *in2 = operand2;
 159
 160         (void)userctx;
 161
 162         //printf("eval bin_op %p %p\n", in1, in2);
 163
 164         /* get parsed string vector, it should contain only one str */
 165         vec = ec_parsed_strvec(operator);
 166         if (ec_strvec_len(vec) != 1)
 167                 return -EINVAL;
 168
 169         if (!strcmp(ec_strvec_val(vec, 0), "|")) {
 170                 out = EC_NODE_OR(EC_NO_ID, ec_node_clone(in1), ec_node_clone(in2));
 171                 if (out == NULL)
 172                         return -EINVAL;
 173                 ec_node_free(in1);
 174                 ec_node_free(in2);
 175                 *result = out;
 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)
 179                                 return -EINVAL;
 180                         ec_node_free(in1);
 181                         *result = in2;
 182                 } else {
 183                         out = EC_NODE_SUBSET(EC_NO_ID, ec_node_clone(in1),
 184                                         ec_node_clone(in2));
 185                         if (out == NULL)
 186                                 return -EINVAL;
 187                         ec_node_free(in1);
 188                         ec_node_free(in2);
 189                         *result = out;
 190                 }
 191         } else {
 192                 return -EINVAL;
 193         }
 194
 195         //printf("eval bin_op out %p\n", *result);
 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         //printf("eval paren\n");
 230         *result = out;
 231
 232         return 0;
 233 }
 234
 235 static void
 236 ec_node_cmd_eval_free(void *result, void *userctx)
 237 {
 238         (void)userctx;
 239         ec_free(result);
 240 }
 241
 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,
 249 };
 250
 251 static int
 252 ec_node_cmd_parse(const struct ec_node *gen_node, struct ec_parsed *state,
 253                 const struct ec_strvec *strvec)
 254 {
 255         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
 256
 257         return ec_node_parse_child(node->cmd, state, strvec);
 258 }
 259
 260 static int
 261 ec_node_cmd_complete(const struct ec_node *gen_node,
 262                 struct ec_completed *completed,
 263                 const struct ec_strvec *strvec)
 264 {
 265         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
 266
 267         return ec_node_complete_child(node->cmd, completed, strvec);
 268 }
 269
 270 static void ec_node_cmd_free_priv(struct ec_node *gen_node)
 271 {
 272         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
 273         unsigned int i;
 274
 275         ec_free(node->cmd_str);
 276         ec_node_free(node->cmd);
 277         ec_node_free(node->expr);
 278         ec_node_free(node->lex);
 279         for (i = 0; i < node->len; i++)
 280                 ec_node_free(node->table[i]);
 281         ec_free(node->table);
 282 }
 283
 284 static int ec_node_cmd_build(struct ec_node *gen_node)
 285 {
 286         struct ec_node *expr = NULL, *lex = NULL, *cmd = NULL;
 287         struct ec_parsed *p, *child;
 288         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
 289         void *result;
 290         int ret;
 291
 292         /* XXX the expr parser can be moved in the node init */
 293
 294         /* build the expression parser */
 295         ret = -ENOMEM;
 296         expr = ec_node("expr", "expr");
 297         if (expr == NULL)
 298                 goto fail;
 299         ret = ec_node_expr_set_val_node(expr, ec_node_re(EC_NO_ID, "[a-zA-Z0-9]+"));
 300         if (ret < 0)
 301                 goto fail;
 302         ret = ec_node_expr_add_bin_op(expr, ec_node_str(EC_NO_ID, ","));
 303         if (ret < 0)
 304                 goto fail;
 305         ret = ec_node_expr_add_bin_op(expr, ec_node_str(EC_NO_ID, "|"));
 306         if (ret < 0)
 307                 goto fail;
 308         ret = ec_node_expr_add_post_op(expr, ec_node_str(EC_NO_ID, "+"));
 309         if (ret < 0)
 310                 goto fail;
 311         ret = ec_node_expr_add_post_op(expr, ec_node_str(EC_NO_ID, "*"));
 312         if (ret < 0)
 313                 goto fail;
 314         ret = ec_node_expr_add_parenthesis(expr, ec_node_str(EC_NO_ID, "["),
 315                 ec_node_str(EC_NO_ID, "]"));
 316         if (ret < 0)
 317                 goto fail;
 318         ec_node_expr_add_parenthesis(expr, ec_node_str(EC_NO_ID, "("),
 319                 ec_node_str(EC_NO_ID, ")"));
 320         if (ret < 0)
 321                 goto fail;
 322
 323         /* prepend a lexer and a "many" to the expression node */
 324         ret = -ENOMEM;
 325         lex = ec_node_re_lex(EC_NO_ID,
 326                 ec_node_many(EC_NO_ID, ec_node_clone(expr), 1, 0));
 327         if (lex == NULL)
 328                 goto fail;
 329
 330         ret = ec_node_re_lex_add(lex, "[a-zA-Z0-9]+", 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, "\\]", 1);
 340         if (ret < 0)
 341                 goto fail;
 342         ret = ec_node_re_lex_add(lex, "[         ]+", 0);
 343         if (ret < 0)
 344                 goto fail;
 345
 346         /* parse the command expression */
 347         ret = -ENOMEM;
 348         p = ec_node_parse(lex, node->cmd_str);
 349         if (p == NULL)
 350                 goto fail;
 351
 352         ret = -EINVAL;
 353         if (!ec_parsed_matches(p))
 354                 goto fail;
 355         if (!ec_parsed_has_child(p))
 356                 goto fail;
 357         if (!ec_parsed_has_child(ec_parsed_get_first_child(p)))
 358                 goto fail;
 359
 360         ret = -ENOMEM;
 361         cmd = ec_node("seq", EC_NO_ID);
 362         if (cmd == NULL)
 363                 goto fail;
 364
 365         EC_PARSED_FOREACH_CHILD(child, ec_parsed_get_first_child(p)) {
 366                 ret = ec_node_expr_eval(&result, expr, child,
 367                         &test_ops, node);
 368                 if (ret < 0)
 369                         goto fail;
 370                 ret = ec_node_seq_add(cmd, result);
 371                 if (ret < 0)
 372                         goto fail;
 373         }
 374         ec_parsed_free(p);
 375         p = NULL;
 376         //ec_node_dump(stdout, cmd);
 377
 378         ec_node_free(node->expr);
 379         node->expr = expr;
 380         ec_node_free(node->lex);
 381         node->lex = lex;
 382         ec_node_free(node->cmd);
 383         node->cmd = cmd;
 384
 385         return 0;
 386
 387 fail:
 388         ec_parsed_free(p);
 389         ec_node_free(expr);
 390         ec_node_free(lex);
 391         ec_node_free(cmd);
 392         return ret;
 393 }
 394
 395 static struct ec_node_type ec_node_cmd_type = {
 396         .name = "cmd",
 397         .build = ec_node_cmd_build,
 398         .parse = ec_node_cmd_parse,
 399         .complete = ec_node_cmd_complete,
 400         .size = sizeof(struct ec_node_cmd),
 401         .free_priv = ec_node_cmd_free_priv,
 402 };
 403
 404 EC_NODE_TYPE_REGISTER(ec_node_cmd_type);
 405
 406 int ec_node_cmd_add_child(struct ec_node *gen_node, struct ec_node *child)
 407 {
 408         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
 409         struct ec_node **table;
 410
 411         // XXX check node type
 412
 413         assert(node != NULL);
 414
 415         if (child == NULL)
 416                 return -EINVAL;
 417
 418         gen_node->flags &= ~EC_NODE_F_BUILT;
 419
 420         table = ec_realloc(node->table, (node->len + 1) * sizeof(*node->table));
 421         if (table == NULL) {
 422                 ec_node_free(child);
 423                 return -ENOMEM;
 424         }
 425
 426         node->table = table;
 427         table[node->len] = child;
 428         node->len++;
 429
 430         child->parent = gen_node;
 431         TAILQ_INSERT_TAIL(&gen_node->children, child, next); // XXX really needed?
 432
 433         return 0;
 434 }
 435
 436 struct ec_node *ec_node_cmd(const char *id, const char *cmd_str)
 437 {
 438         struct ec_node *gen_node = NULL;
 439         struct ec_node_cmd *node = NULL;
 440
 441         gen_node = __ec_node(&ec_node_cmd_type, id);
 442         if (gen_node == NULL)
 443                 goto fail;
 444
 445         node = (struct ec_node_cmd *)gen_node;
 446         node->cmd_str = ec_strdup(cmd_str);
 447         if (node->cmd_str == NULL)
 448                 goto fail;
 449
 450         return gen_node;
 451
 452 fail:
 453         ec_node_free(gen_node);
 454         return NULL;
 455 }
 456
 457 struct ec_node *__ec_node_cmd(const char *id, const char *cmd, ...)
 458 {
 459         struct ec_node *gen_node = NULL;
 460         struct ec_node_cmd *node = NULL;
 461         struct ec_node *child;
 462         va_list ap;
 463         int fail = 0;
 464
 465         va_start(ap, cmd);
 466
 467         gen_node = ec_node_cmd(id, cmd);
 468         node = (struct ec_node_cmd *)gen_node;
 469         if (node == NULL)
 470                 fail = 1;;
 471
 472         for (child = va_arg(ap, struct ec_node *);
 473              child != EC_NODE_ENDLIST;
 474              child = va_arg(ap, struct ec_node *)) {
 475
 476                 /* on error, don't quit the loop to avoid leaks */
 477                 if (fail == 1 || child == NULL ||
 478                                 ec_node_cmd_add_child(&node->gen, child) < 0) {
 479                         fail = 1;
 480                         ec_node_free(child);
 481                 }
 482         }
 483
 484         if (fail == 1)
 485                 goto fail;
 486
 487         va_end(ap);
 488         return gen_node;
 489
 490 fail:
 491         ec_node_free(gen_node); /* will also free children */
 492         va_end(ap);
 493         return NULL;
 494 }
 495
 496 /* LCOV_EXCL_START */
 497 static int ec_node_cmd_testcase(void)
 498 {
 499         struct ec_node *node;
 500         int ret = 0;
 501
 502         node = EC_NODE_CMD(EC_NO_ID,
 503                 "command [option] (subset1, subset2, subset3) x|y",
 504                 ec_node_int("x", 0, 10, 10),
 505                 ec_node_int("y", 20, 30, 10)
 506         );
 507         if (node == NULL) {
 508                 EC_LOG(EC_LOG_ERR, "cannot create node\n");
 509                 return -1;
 510         }
 511         ret |= EC_TEST_CHECK_PARSE(node, 2, "command", "1");
 512         ret |= EC_TEST_CHECK_PARSE(node, 2, "command", "23");
 513         ret |= EC_TEST_CHECK_PARSE(node, 3, "command", "option", "23");
 514         ret |= EC_TEST_CHECK_PARSE(node, -1, "command", "15");
 515         ret |= EC_TEST_CHECK_PARSE(node, -1, "foo");
 516         ec_node_free(node);
 517
 518         node = EC_NODE_CMD(EC_NO_ID, "good morning [count] bob|bobby|michael",
 519                         ec_node_int("count", 0, 10, 10));
 520         if (node == NULL) {
 521                 EC_LOG(EC_LOG_ERR, "cannot create node\n");
 522                 return -1;
 523         }
 524         ret |= EC_TEST_CHECK_PARSE(node, 4, "good", "morning", "1", "bob");
 525
 526         ret |= EC_TEST_CHECK_COMPLETE(node,
 527                 "", EC_NODE_ENDLIST,
 528                 "good", EC_NODE_ENDLIST);
 529         ret |= EC_TEST_CHECK_COMPLETE(node,
 530                 "g", EC_NODE_ENDLIST,
 531                 "good", EC_NODE_ENDLIST);
 532         ret |= EC_TEST_CHECK_COMPLETE(node,
 533                 "good", "morning", "", EC_NODE_ENDLIST,
 534                 "bob", "bobby", "michael", EC_NODE_ENDLIST);
 535
 536         ec_node_free(node);
 537
 538         return ret;
 539 }
 540 /* LCOV_EXCL_STOP */
 541
 542 static struct ec_test ec_node_cmd_test = {
 543         .name = "node_cmd",
 544         .test = ec_node_cmd_testcase,
 545 };
 546
 547 EC_TEST_REGISTER(ec_node_cmd_test);