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