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