lib/ecoli_node_or.c

   1 /*
   2  * Copyright (c) 2016, 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 <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <assert.h>
  32 #include <stdarg.h>
  33 #include <errno.h>
  34
  35 #include <ecoli_malloc.h>
  36 #include <ecoli_log.h>
  37 #include <ecoli_strvec.h>
  38 #include <ecoli_node.h>
  39 #include <ecoli_parsed.h>
  40 #include <ecoli_completed.h>
  41 #include <ecoli_node_or.h>
  42 #include <ecoli_node_str.h>
  43 #include <ecoli_test.h>
  44
  45 struct ec_node_or {
  46         struct ec_node gen;
  47         struct ec_node **table;
  48         unsigned int len;
  49 };
  50
  51 static int
  52 ec_node_or_parse(const struct ec_node *gen_node,
  53                 struct ec_parsed *state,
  54                 const struct ec_strvec *strvec)
  55 {
  56         struct ec_node_or *node = (struct ec_node_or *)gen_node;
  57         unsigned int i;
  58         int ret;
  59
  60         for (i = 0; i < node->len; i++) {
  61                 ret = ec_node_parse_child(node->table[i], state, strvec);
  62                 if (ret == EC_PARSED_NOMATCH)
  63                         continue;
  64                 return ret;
  65         }
  66
  67         return EC_PARSED_NOMATCH;
  68 }
  69
  70 static int
  71 ec_node_or_complete(const struct ec_node *gen_node,
  72                 struct ec_completed *completed,
  73                 struct ec_parsed *parsed,
  74                 const struct ec_strvec *strvec)
  75 {
  76         struct ec_node_or *node = (struct ec_node_or *)gen_node;
  77         int ret;
  78         size_t n;
  79
  80         for (n = 0; n < node->len; n++) {
  81                 ret = ec_node_complete_child(node->table[n],
  82                                         completed, parsed, strvec);
  83                 if (ret < 0)
  84                         return ret;
  85         }
  86
  87         return 0;
  88 }
  89
  90 static size_t ec_node_or_get_max_parse_len(const struct ec_node *gen_node)
  91 {
  92         struct ec_node_or *node = (struct ec_node_or *)gen_node;
  93         size_t i, ret = 0, len;
  94
  95         for (i = 0; i < node->len; i++) {
  96                 len = ec_node_get_max_parse_len(node->table[i]);
  97                 if (len > ret)
  98                         ret = len;
  99         }
 100
 101         return ret;
 102 }
 103
 104 static void ec_node_or_free_priv(struct ec_node *gen_node)
 105 {
 106         struct ec_node_or *node = (struct ec_node_or *)gen_node;
 107         unsigned int i;
 108
 109         for (i = 0; i < node->len; i++)
 110                 ec_node_free(node->table[i]);
 111         ec_free(node->table);
 112 }
 113
 114 int ec_node_or_add(struct ec_node *gen_node, struct ec_node *child)
 115 {
 116         struct ec_node_or *node = (struct ec_node_or *)gen_node;
 117         struct ec_node **table;
 118
 119         assert(node != NULL);
 120
 121         if (child == NULL)
 122                 return -EINVAL;
 123
 124         gen_node->flags &= ~EC_NODE_F_BUILT;
 125
 126         table = ec_realloc(node->table, (node->len + 1) * sizeof(*node->table));
 127         if (table == NULL) {
 128                 ec_node_free(child);
 129                 return -1;
 130         }
 131
 132         node->table = table;
 133         table[node->len] = child;
 134         node->len++;
 135
 136         child->parent = gen_node;
 137         TAILQ_INSERT_TAIL(&gen_node->children, child, next);
 138
 139         return 0;
 140 }
 141
 142 static struct ec_node_type ec_node_or_type = {
 143         .name = "or",
 144         .parse = ec_node_or_parse,
 145         .complete = ec_node_or_complete,
 146         .get_max_parse_len = ec_node_or_get_max_parse_len,
 147         .size = sizeof(struct ec_node_or),
 148         .free_priv = ec_node_or_free_priv,
 149 };
 150
 151 EC_NODE_TYPE_REGISTER(ec_node_or_type);
 152
 153 struct ec_node *__ec_node_or(const char *id, ...)
 154 {
 155         struct ec_node *gen_node = NULL;
 156         struct ec_node_or *node = NULL;
 157         struct ec_node *child;
 158         va_list ap;
 159         int fail = 0;
 160
 161         va_start(ap, id);
 162
 163         gen_node = __ec_node(&ec_node_or_type, id);
 164         node = (struct ec_node_or *)gen_node;
 165         if (node == NULL)
 166                 fail = 1;;
 167
 168         for (child = va_arg(ap, struct ec_node *);
 169              child != EC_NODE_ENDLIST;
 170              child = va_arg(ap, struct ec_node *)) {
 171
 172                 /* on error, don't quit the loop to avoid leaks */
 173                 if (fail == 1 || child == NULL ||
 174                                 ec_node_or_add(gen_node, child) < 0) {
 175                         fail = 1;
 176                         ec_node_free(child);
 177                 }
 178         }
 179
 180         if (fail == 1)
 181                 goto fail;
 182
 183         va_end(ap);
 184         return gen_node;
 185
 186 fail:
 187         ec_node_free(gen_node); /* will also free children */
 188         va_end(ap);
 189         return NULL;
 190 }
 191
 192 /* LCOV_EXCL_START */
 193 static int ec_node_or_testcase(void)
 194 {
 195         struct ec_node *node;
 196         int ret = 0;
 197
 198         node = EC_NODE_OR(NULL,
 199                 ec_node_str(NULL, "foo"),
 200                 ec_node_str(NULL, "bar")
 201         );
 202         if (node == NULL) {
 203                 ec_log(EC_LOG_ERR, "cannot create node\n");
 204                 return -1;
 205         }
 206         ret |= EC_TEST_CHECK_PARSE(node, 1, "foo");
 207         ret |= EC_TEST_CHECK_PARSE(node, 1, "bar");
 208         ret |= EC_TEST_CHECK_PARSE(node, 1, "foo", "bar");
 209         ret |= EC_TEST_CHECK_PARSE(node, -1, " ");
 210         ret |= EC_TEST_CHECK_PARSE(node, -1, "foox");
 211         ret |= EC_TEST_CHECK_PARSE(node, -1, "toto");
 212         ret |= EC_TEST_CHECK_PARSE(node, -1, "");
 213         ec_node_free(node);
 214
 215         /* test completion */
 216         node = EC_NODE_OR(NULL,
 217                 ec_node_str(NULL, "foo"),
 218                 ec_node_str(NULL, "bar"),
 219                 ec_node_str(NULL, "bar2"),
 220                 ec_node_str(NULL, "toto"),
 221                 ec_node_str(NULL, "titi")
 222         );
 223         if (node == NULL) {
 224                 ec_log(EC_LOG_ERR, "cannot create node\n");
 225                 return -1;
 226         }
 227         ret |= EC_TEST_CHECK_COMPLETE(node,
 228                 "", EC_NODE_ENDLIST,
 229                 "foo", "bar", "bar2", "toto", "titi", EC_NODE_ENDLIST,
 230                 "");
 231         ret |= EC_TEST_CHECK_COMPLETE(node,
 232                 "f", EC_NODE_ENDLIST,
 233                 "oo", EC_NODE_ENDLIST,
 234                 "oo");
 235         ret |= EC_TEST_CHECK_COMPLETE(node,
 236                 "b", EC_NODE_ENDLIST,
 237                 "ar", "ar2", EC_NODE_ENDLIST,
 238                 "ar");
 239         ret |= EC_TEST_CHECK_COMPLETE(node,
 240                 "bar", EC_NODE_ENDLIST,
 241                 "", "2", EC_NODE_ENDLIST,
 242                 "");
 243         ret |= EC_TEST_CHECK_COMPLETE(node,
 244                 "t", EC_NODE_ENDLIST,
 245                 "oto", "iti", EC_NODE_ENDLIST,
 246                 "");
 247         ret |= EC_TEST_CHECK_COMPLETE(node,
 248                 "to", EC_NODE_ENDLIST,
 249                 "to", EC_NODE_ENDLIST,
 250                 "to");
 251         ret |= EC_TEST_CHECK_COMPLETE(node,
 252                 "x", EC_NODE_ENDLIST,
 253                 EC_NODE_ENDLIST,
 254                 "");
 255         ec_node_free(node);
 256
 257         return ret;
 258 }
 259 /* LCOV_EXCL_STOP */
 260
 261 static struct ec_test ec_node_or_test = {
 262         .name = "node_or",
 263         .test = ec_node_or_testcase,
 264 };
 265
 266 EC_TEST_REGISTER(ec_node_or_test);