lib/ecoli_node_once.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_test.h>
  38 #include <ecoli_strvec.h>
  39 #include <ecoli_node.h>
  40 #include <ecoli_parsed.h>
  41 #include <ecoli_completed.h>
  42 #include <ecoli_node_str.h>
  43 #include <ecoli_node_or.h>
  44 #include <ecoli_node_many.h>
  45 #include <ecoli_node_once.h>
  46
  47 EC_LOG_TYPE_REGISTER(node_once);
  48
  49 struct ec_node_once {
  50         struct ec_node gen;
  51         struct ec_node *child;
  52 };
  53
  54 static unsigned int
  55 count_node(struct ec_parsed *parsed, const struct ec_node *node)
  56 {
  57         struct ec_parsed *child;
  58         unsigned int count = 0;
  59
  60         if (parsed == NULL)
  61                 return 0;
  62
  63         if (ec_parsed_get_node(parsed) == node)
  64                 count++;
  65
  66         EC_PARSED_FOREACH_CHILD(child, parsed)
  67                 count += count_node(child, node);
  68
  69         return count;
  70 }
  71
  72 static int
  73 ec_node_once_parse(const struct ec_node *gen_node,
  74                 struct ec_parsed *state,
  75                 const struct ec_strvec *strvec)
  76 {
  77         struct ec_node_once *node = (struct ec_node_once *)gen_node;
  78         unsigned int count;
  79
  80         /* count the number of occurences of the node: if already parsed,
  81          * do not match
  82          */
  83         count = count_node(ec_parsed_get_root(state), node->child);
  84         if (count > 0)
  85                 return EC_PARSED_NOMATCH;
  86
  87         return ec_node_parse_child(node->child, state, strvec);
  88 }
  89
  90 static int
  91 ec_node_once_complete(const struct ec_node *gen_node,
  92                 struct ec_completed *completed,
  93                 const struct ec_strvec *strvec)
  94 {
  95         struct ec_node_once *node = (struct ec_node_once *)gen_node;
  96         struct ec_parsed *parsed = ec_completed_get_state(completed);
  97         unsigned int count;
  98         int ret;
  99
 100         /* count the number of occurences of the node: if already parsed,
 101          * do not match
 102          */
 103         count = count_node(ec_parsed_get_root(parsed), node->child); //XXX
 104         if (count > 0)
 105                 return 0;
 106
 107         ret = ec_node_complete_child(node->child, completed, strvec);
 108         if (ret < 0)
 109                 return ret;
 110
 111         return 0;
 112 }
 113
 114 static void ec_node_once_free_priv(struct ec_node *gen_node)
 115 {
 116         struct ec_node_once *node = (struct ec_node_once *)gen_node;
 117
 118         ec_node_free(node->child);
 119 }
 120
 121 static struct ec_node_type ec_node_once_type = {
 122         .name = "once",
 123         .parse = ec_node_once_parse,
 124         .complete = ec_node_once_complete,
 125         .size = sizeof(struct ec_node_once),
 126         .free_priv = ec_node_once_free_priv,
 127 };
 128
 129 EC_NODE_TYPE_REGISTER(ec_node_once_type);
 130
 131 int ec_node_once_set(struct ec_node *gen_node, struct ec_node *child)
 132 {
 133         struct ec_node_once *node = (struct ec_node_once *)gen_node;
 134         int ret;
 135
 136         if (gen_node == NULL || child == NULL)
 137                 return -EINVAL;
 138
 139         ret = ec_node_check_type(gen_node, &ec_node_once_type);
 140         if (ret < 0)
 141                 return ret;
 142
 143         gen_node->flags &= ~EC_NODE_F_BUILT;
 144
 145         node->child = child;
 146
 147         child->parent = gen_node;
 148         TAILQ_INSERT_TAIL(&gen_node->children, child, next); // XXX really needed?
 149
 150         return 0;
 151 }
 152
 153 struct ec_node *ec_node_once(const char *id, struct ec_node *child)
 154 {
 155         struct ec_node *gen_node = NULL;
 156
 157         if (child == NULL)
 158                 return NULL;
 159
 160         gen_node = __ec_node(&ec_node_once_type, id);
 161         if (gen_node == NULL)
 162                 return NULL;
 163
 164         ec_node_once_set(gen_node, child);
 165
 166         return gen_node;
 167 }
 168
 169 /* LCOV_EXCL_START */
 170 static int ec_node_once_testcase(void)
 171 {
 172         struct ec_node *node;
 173         int ret = 0;
 174
 175         node = ec_node_many(NULL,
 176                         EC_NODE_OR(NULL,
 177                                 ec_node_once(NULL, ec_node_str(NULL, "foo")),
 178                                 ec_node_str(NULL, "bar")
 179                                 ), 0, 0
 180                 );
 181         if (node == NULL) {
 182                 EC_LOG(EC_LOG_ERR, "cannot create node\n");
 183                 return -1;
 184         }
 185         ret |= EC_TEST_CHECK_PARSE(node, 0);
 186         ret |= EC_TEST_CHECK_PARSE(node, 1, "foo");
 187         ret |= EC_TEST_CHECK_PARSE(node, 1, "bar");
 188         ret |= EC_TEST_CHECK_PARSE(node, 2, "foo", "bar");
 189         ret |= EC_TEST_CHECK_PARSE(node, 3, "foo", "bar", "bar");
 190         ret |= EC_TEST_CHECK_PARSE(node, 3, "bar", "foo", "bar");
 191         ret |= EC_TEST_CHECK_PARSE(node, 2, "bar", "foo", "foo");
 192         ret |= EC_TEST_CHECK_PARSE(node, 1, "foo", "foo");
 193         ret |= EC_TEST_CHECK_PARSE(node, 0, "foox");
 194
 195         ec_node_free(node);
 196
 197 #if 0 //XXX no completion test for node_once
 198         /* test completion */
 199         node = EC_NODE_OR(NULL,
 200                 ec_node_str(NULL, "foo"),
 201                 ec_node_str(NULL, "bar"),
 202                 ec_node_str(NULL, "bar2"),
 203                 ec_node_str(NULL, "toto"),
 204                 ec_node_str(NULL, "titi")
 205         );
 206         if (node == NULL) {
 207                 EC_LOG(EC_LOG_ERR, "cannot create node\n");
 208                 return -1;
 209         }
 210         ret |= EC_TEST_CHECK_COMPLETE(node,
 211                 "", EC_NODE_ENDLIST,
 212                 "foo", "bar", "bar2", "toto", "titi", EC_NODE_ENDLIST);
 213         ret |= EC_TEST_CHECK_COMPLETE(node,
 214                 "f", EC_NODE_ENDLIST,
 215                 "foo", EC_NODE_ENDLIST);
 216         ec_node_free(node);
 217 #endif
 218         return ret;
 219 }
 220 /* LCOV_EXCL_STOP */
 221
 222 static struct ec_test ec_node_once_test = {
 223         .name = "node_once",
 224         .test = ec_node_once_testcase,
 225 };
 226
 227 EC_TEST_REGISTER(ec_node_once_test);