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 struct ec_completed *
  89 ec_node_once_complete(const struct ec_node *gen_node,
  90                         const struct ec_strvec *strvec)
  91 {
  92         struct ec_node_once *node = (struct ec_node_once *)gen_node;
  93         struct ec_completed *completed = NULL, *child_completed = NULL;
  94         unsigned int count;
  95
  96         completed = ec_completed();
  97         if (completed == NULL)
  98                 goto fail;
  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(state), node->child); //XXX
 104         count = 1;
 105         if (count > 0)
 106                 return completed;
 107
 108         child_completed = ec_node_complete_strvec(node->child, strvec);
 109         if (child_completed == NULL)
 110                 goto fail;
 111
 112         ec_completed_merge(completed, child_completed);
 113         return completed;
 114
 115 fail:
 116         ec_completed_free(completed);
 117         return NULL;
 118 }
 119
 120 static void ec_node_once_free_priv(struct ec_node *gen_node)
 121 {
 122         struct ec_node_once *node = (struct ec_node_once *)gen_node;
 123
 124         ec_node_free(node->child);
 125 }
 126
 127 static struct ec_node_type ec_node_once_type = {
 128         .name = "once",
 129         .parse = ec_node_once_parse,
 130         .complete = ec_node_once_complete,
 131         .size = sizeof(struct ec_node_once),
 132         .free_priv = ec_node_once_free_priv,
 133 };
 134
 135 EC_NODE_TYPE_REGISTER(ec_node_once_type);
 136
 137 int ec_node_once_set(struct ec_node *gen_node, struct ec_node *child)
 138 {
 139         struct ec_node_once *node = (struct ec_node_once *)gen_node;
 140
 141         // XXX check node type
 142
 143         assert(node != NULL);
 144
 145         if (child == NULL)
 146                 return -EINVAL;
 147
 148         gen_node->flags &= ~EC_NODE_F_BUILT;
 149
 150         node->child = child;
 151
 152         child->parent = gen_node;
 153         TAILQ_INSERT_TAIL(&gen_node->children, child, next); // XXX really needed?
 154
 155         return 0;
 156 }
 157
 158 struct ec_node *ec_node_once(const char *id, struct ec_node *child)
 159 {
 160         struct ec_node *gen_node = NULL;
 161
 162         if (child == NULL)
 163                 return NULL;
 164
 165         gen_node = __ec_node(&ec_node_once_type, id);
 166         if (gen_node == NULL)
 167                 return NULL;
 168
 169         ec_node_once_set(gen_node, child);
 170
 171         return gen_node;
 172 }
 173
 174 static int ec_node_once_testcase(void)
 175 {
 176         struct ec_node *node;
 177         int ret = 0;
 178
 179         node = ec_node_many(NULL,
 180                         EC_NODE_OR(NULL,
 181                                 ec_node_once(NULL, ec_node_str(NULL, "foo")),
 182                                 ec_node_str(NULL, "bar")
 183                                 ), 0, 0
 184                 );
 185         if (node == NULL) {
 186                 ec_log(EC_LOG_ERR, "cannot create node\n");
 187                 return -1;
 188         }
 189         ret |= EC_TEST_CHECK_PARSE(node, 0);
 190         ret |= EC_TEST_CHECK_PARSE(node, 1, "foo");
 191         ret |= EC_TEST_CHECK_PARSE(node, 1, "bar");
 192         ret |= EC_TEST_CHECK_PARSE(node, 2, "foo", "bar");
 193         ret |= EC_TEST_CHECK_PARSE(node, 3, "foo", "bar", "bar");
 194         ret |= EC_TEST_CHECK_PARSE(node, 3, "bar", "foo", "bar");
 195         ret |= EC_TEST_CHECK_PARSE(node, 2, "bar", "foo", "foo");
 196         ret |= EC_TEST_CHECK_PARSE(node, 1, "foo", "foo");
 197         ret |= EC_TEST_CHECK_PARSE(node, 0, "foox");
 198
 199         ec_node_free(node);
 200
 201 #if 0 //XXX no completion test for node_once
 202         /* test completion */
 203         node = EC_NODE_OR(NULL,
 204                 ec_node_str(NULL, "foo"),
 205                 ec_node_str(NULL, "bar"),
 206                 ec_node_str(NULL, "bar2"),
 207                 ec_node_str(NULL, "toto"),
 208                 ec_node_str(NULL, "titi")
 209         );
 210         if (node == NULL) {
 211                 ec_log(EC_LOG_ERR, "cannot create node\n");
 212                 return -1;
 213         }
 214         ret |= EC_TEST_CHECK_COMPLETE(node,
 215                 "", EC_NODE_ENDLIST,
 216                 "foo", "bar", "bar2", "toto", "titi", EC_NODE_ENDLIST,
 217                 "");
 218         ret |= EC_TEST_CHECK_COMPLETE(node,
 219                 "f", EC_NODE_ENDLIST,
 220                 "oo", EC_NODE_ENDLIST,
 221                 "oo");
 222         ec_node_free(node);
 223 #endif
 224         return ret;
 225 }
 226
 227 static struct ec_test ec_node_once_test = {
 228         .name = "node_once",
 229         .test = ec_node_once_testcase,
 230 };
 231
 232 EC_TEST_REGISTER(ec_node_once_test);