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                 out = EC_NODE_SUBSET(NULL, ec_node_clone(in1), ec_node_clone(in2));
 176                 if (out == NULL)
 177                         return -EINVAL;
 178                 ec_node_free(in1);
 179                 ec_node_free(in2);
 180                 *result = out;
 181         } else {
 182                 return -EINVAL;
 183         }
 184
 185         return 0;
 186 }
 187
 188 static int
 189 ec_node_cmd_eval_parenthesis(void **result, void *userctx,
 190         const struct ec_parsed *open_paren,
 191         const struct ec_parsed *close_paren,
 192         void *value)
 193 {
 194         const struct ec_strvec *vec;
 195         struct ec_node *in = value;;
 196         struct ec_node *out = NULL;;
 197
 198         (void)userctx;
 199         (void)close_paren;
 200
 201         /* get parsed string vector, it should contain only one str */
 202         vec = ec_parsed_strvec(open_paren);
 203         if (ec_strvec_len(vec) != 1)
 204                 return -EINVAL;
 205
 206         if (!strcmp(ec_strvec_val(vec, 0), "[")) {
 207                 out = ec_node_option(NULL, ec_node_clone(in));
 208                 if (out == NULL)
 209                         return -EINVAL;
 210                 ec_node_free(in);
 211         } else if (!strcmp(ec_strvec_val(vec, 0), "(")) {
 212                 out = in;
 213         } else {
 214                 return -EINVAL;
 215         }
 216
 217         printf("eval paren\n");
 218         *result = out;
 219
 220         return 0;
 221 }
 222
 223 static void
 224 ec_node_cmd_eval_free(void *result, void *userctx)
 225 {
 226         (void)userctx;
 227         ec_free(result);
 228 }
 229
 230 static const struct ec_node_expr_eval_ops test_ops = {
 231         .eval_var = ec_node_cmd_eval_var,
 232         .eval_pre_op = ec_node_cmd_eval_pre_op,
 233         .eval_post_op = ec_node_cmd_eval_post_op,
 234         .eval_bin_op = ec_node_cmd_eval_bin_op,
 235         .eval_parenthesis = ec_node_cmd_eval_parenthesis,
 236         .eval_free = ec_node_cmd_eval_free,
 237 };
 238
 239 static int ec_node_cmd_parse(const struct ec_node *gen_node,
 240                         struct ec_parsed *state,
 241                         const struct ec_strvec *strvec)
 242 {
 243         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
 244
 245         return ec_node_parse_child(node->cmd, state, strvec);
 246 }
 247
 248 static struct ec_completed *ec_node_cmd_complete(const struct ec_node *gen_node,
 249         const struct ec_strvec *strvec)
 250 {
 251         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
 252
 253         return ec_node_complete_strvec(node->cmd, strvec);
 254 }
 255
 256 static void ec_node_cmd_free_priv(struct ec_node *gen_node)
 257 {
 258         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
 259         unsigned int i;
 260
 261         ec_free(node->cmd_str);
 262         ec_node_free(node->cmd);
 263         ec_node_free(node->expr);
 264         ec_node_free(node->lex);
 265         for (i = 0; i < node->len; i++)
 266                 ec_node_free(node->table[i]);
 267         ec_free(node->table);
 268 }
 269
 270 static int ec_node_cmd_build(struct ec_node *gen_node)
 271 {
 272         struct ec_node *expr = NULL, *lex = NULL, *cmd = NULL;
 273         struct ec_parsed *p, *child;
 274         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
 275         void *result;
 276         int ret;
 277
 278         /* XXX the expr parser can be moved in the node init */
 279
 280         /* build the expression parser */
 281         ret = -ENOMEM;
 282         expr = ec_node("expr", "expr");
 283         if (expr == NULL)
 284                 goto fail;
 285         ret = ec_node_expr_set_val_node(expr, ec_node_re(NULL, "[a-zA-Z0-9]+"));
 286         if (ret < 0)
 287                 goto fail;
 288         ret = ec_node_expr_add_bin_op(expr, ec_node_str(NULL, ","));
 289         if (ret < 0)
 290                 goto fail;
 291         ret = ec_node_expr_add_bin_op(expr, ec_node_str(NULL, "|"));
 292         if (ret < 0)
 293                 goto fail;
 294         ret = ec_node_expr_add_post_op(expr, ec_node_str(NULL, "+"));
 295         if (ret < 0)
 296                 goto fail;
 297         ret = ec_node_expr_add_post_op(expr, ec_node_str(NULL, "*"));
 298         if (ret < 0)
 299                 goto fail;
 300         ret = ec_node_expr_add_parenthesis(expr, ec_node_str(NULL, "["),
 301                 ec_node_str(NULL, "]"));
 302         if (ret < 0)
 303                 goto fail;
 304         ec_node_expr_add_parenthesis(expr, ec_node_str(NULL, "("),
 305                 ec_node_str(NULL, ")"));
 306         if (ret < 0)
 307                 goto fail;
 308
 309         /* prepend a lexer and a "many" to the expression node */
 310         ret = -ENOMEM;
 311         lex = ec_node_re_lex(NULL,
 312                 ec_node_many(NULL, ec_node_clone(expr), 1, 0));
 313         if (lex == NULL)
 314                 goto fail;
 315
 316         ret = ec_node_re_lex_add(lex, "[a-zA-Z0-9]+", 1);
 317         if (ret < 0)
 318                 goto fail;
 319         ret = ec_node_re_lex_add(lex, "[*|,()]", 1);
 320         if (ret < 0)
 321                 goto fail;
 322         ret = ec_node_re_lex_add(lex, "\\[", 1);
 323         if (ret < 0)
 324                 goto fail;
 325         ret = ec_node_re_lex_add(lex, "\\]", 1);
 326         if (ret < 0)
 327                 goto fail;
 328         ret = ec_node_re_lex_add(lex, "[         ]+", 0);
 329         if (ret < 0)
 330                 goto fail;
 331
 332         /* parse the command expression */
 333         ret = -ENOMEM;
 334         p = ec_node_parse(lex, node->cmd_str);
 335         if (p == NULL)
 336                 goto fail;
 337
 338         ret = -EINVAL;
 339         if (!ec_parsed_matches(p))
 340                 goto fail;
 341         if (TAILQ_EMPTY(&p->children))
 342                 goto fail;
 343         if (TAILQ_EMPTY(&TAILQ_FIRST(&p->children)->children))
 344                 goto fail;
 345
 346         ret = -ENOMEM;
 347         cmd = ec_node("seq", NULL);
 348         if (cmd == NULL)
 349                 goto fail;
 350
 351         TAILQ_FOREACH(child, &TAILQ_FIRST(&p->children)->children, next) {
 352                 ret = ec_node_expr_eval(&result, expr, child,
 353                         &test_ops, node);
 354                 if (ret < 0)
 355                         goto fail;
 356                 ret = ec_node_seq_add(cmd, result);
 357                 if (ret < 0)
 358                         goto fail;
 359         }
 360         ec_parsed_free(p);
 361         p = NULL;
 362         ec_node_dump(stdout, cmd);
 363
 364         ec_node_free(node->expr);
 365         node->expr = expr;
 366         ec_node_free(node->lex);
 367         node->lex = lex;
 368         ec_node_free(node->cmd);
 369         node->cmd = cmd;
 370
 371         return 0;
 372
 373 fail:
 374         ec_parsed_free(p);
 375         ec_node_free(expr);
 376         ec_node_free(lex);
 377         ec_node_free(cmd);
 378         return ret;
 379 }
 380
 381 static struct ec_node_type ec_node_cmd_type = {
 382         .name = "cmd",
 383         .build = ec_node_cmd_build,
 384         .parse = ec_node_cmd_parse,
 385         .complete = ec_node_cmd_complete,
 386         .size = sizeof(struct ec_node_cmd),
 387         .free_priv = ec_node_cmd_free_priv,
 388 };
 389
 390 EC_NODE_TYPE_REGISTER(ec_node_cmd_type);
 391
 392 int ec_node_cmd_add_child(struct ec_node *gen_node, struct ec_node *child)
 393 {
 394         struct ec_node_cmd *node = (struct ec_node_cmd *)gen_node;
 395         struct ec_node **table;
 396
 397         // XXX check node type
 398
 399         assert(node != NULL);
 400
 401         printf("add child %s\n", child->id);
 402         if (child == NULL)
 403                 return -EINVAL;
 404
 405         gen_node->flags &= ~EC_NODE_F_BUILT;
 406
 407         table = ec_realloc(node->table, (node->len + 1) * sizeof(*node->table));
 408         if (table == NULL) {
 409                 ec_node_free(child);
 410                 return -ENOMEM;
 411         }
 412
 413         node->table = table;
 414         table[node->len] = child;
 415         node->len++;
 416
 417         child->parent = gen_node;
 418         TAILQ_INSERT_TAIL(&gen_node->children, child, next); // XXX really needed?
 419
 420         return 0;
 421 }
 422
 423 struct ec_node *ec_node_cmd(const char *id, const char *cmd_str)
 424 {
 425         struct ec_node *gen_node = NULL;
 426         struct ec_node_cmd *node = NULL;
 427
 428         gen_node = __ec_node(&ec_node_cmd_type, id);
 429         if (gen_node == NULL)
 430                 goto fail;
 431
 432         node = (struct ec_node_cmd *)gen_node;
 433         node->cmd_str = ec_strdup(cmd_str);
 434         if (node->cmd_str == NULL)
 435                 goto fail;
 436
 437         return gen_node;
 438
 439 fail:
 440         ec_node_free(gen_node);
 441         return NULL;
 442 }
 443
 444 struct ec_node *__ec_node_cmd(const char *id, const char *cmd, ...)
 445 {
 446         struct ec_node *gen_node = NULL;
 447         struct ec_node_cmd *node = NULL;
 448         struct ec_node *child;
 449         va_list ap;
 450         int fail = 0;
 451
 452         va_start(ap, cmd);
 453
 454         gen_node = ec_node_cmd(id, cmd);
 455         node = (struct ec_node_cmd *)gen_node;
 456         if (node == NULL)
 457                 fail = 1;;
 458
 459         for (child = va_arg(ap, struct ec_node *);
 460              child != EC_NODE_ENDLIST;
 461              child = va_arg(ap, struct ec_node *)) {
 462
 463                 /* on error, don't quit the loop to avoid leaks */
 464                 if (fail == 1 || child == NULL ||
 465                                 ec_node_cmd_add_child(&node->gen, child) < 0) {
 466                         fail = 1;
 467                         ec_node_free(child);
 468                 }
 469         }
 470
 471         if (fail == 1)
 472                 goto fail;
 473
 474         va_end(ap);
 475         return gen_node;
 476
 477 fail:
 478         ec_node_free(gen_node); /* will also free children */
 479         va_end(ap);
 480         return NULL;
 481 }
 482
 483 static int ec_node_cmd_testcase(void)
 484 {
 485         struct ec_node *node;
 486         int ret = 0;
 487
 488         node = EC_NODE_CMD(NULL,
 489                 "command [option] (subset1, subset2) x | y",
 490                 ec_node_int("x", 0, 10, 10),
 491                 ec_node_int("y", 20, 30, 10)
 492         );
 493         if (node == NULL) {
 494                 ec_log(EC_LOG_ERR, "cannot create node\n");
 495                 return -1;
 496         }
 497         ret |= EC_TEST_CHECK_PARSE(node, 2, "command", "1");
 498         ret |= EC_TEST_CHECK_PARSE(node, 2, "command", "23");
 499         ret |= EC_TEST_CHECK_PARSE(node, 3, "command", "option", "23");
 500         ret |= EC_TEST_CHECK_PARSE(node, -1, "command", "15");
 501         ret |= EC_TEST_CHECK_PARSE(node, -1, "foo");
 502         ec_node_free(node);
 503
 504         node = EC_NODE_CMD(NULL, "good morning bob|bobby|michael [count]",
 505                         ec_node_int("count", 0, 10, 10));
 506         if (node == NULL) {
 507                 ec_log(EC_LOG_ERR, "cannot create node\n");
 508                 return -1;
 509         }
 510         ret |= EC_TEST_CHECK_PARSE(node, 4, "good", "morning", "bob", "1");
 511         ec_node_free(node);
 512
 513         // XXX completion
 514
 515         return ret;
 516 }
 517
 518 static struct ec_test ec_node_cmd_test = {
 519         .name = "node_cmd",
 520         .test = ec_node_cmd_testcase,
 521 };
 522
 523 EC_TEST_REGISTER(ec_node_cmd_test);