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