support config in node_or
[protos/libecoli.git] / lib / ecoli_node_or.c
index 963f970..2bf8fc7 100644 (file)
@@ -1,28 +1,5 @@
-/*
- * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in the
- *       documentation and/or other materials provided with the distribution.
- *     * Neither the name of the University of California, Berkeley nor the
- *       names of its contributors may be used to endorse or promote products
- *       derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
  */
 
 #include <stdio.h>
 #include <ecoli_log.h>
 #include <ecoli_strvec.h>
 #include <ecoli_node.h>
-#include <ecoli_parsed.h>
-#include <ecoli_completed.h>
+#include <ecoli_parse.h>
+#include <ecoli_complete.h>
+#include <ecoli_node.h>
+#include <ecoli_config.h>
+#include <ecoli_node_helper.h>
 #include <ecoli_node_or.h>
 #include <ecoli_node_str.h>
 #include <ecoli_test.h>
@@ -47,12 +27,12 @@ EC_LOG_TYPE_REGISTER(node_or);
 struct ec_node_or {
        struct ec_node gen;
        struct ec_node **table;
-       unsigned int len;
+       size_t len;
 };
 
 static int
 ec_node_or_parse(const struct ec_node *gen_node,
-               struct ec_parsed *state,
+               struct ec_parse *state,
                const struct ec_strvec *strvec)
 {
        struct ec_node_or *node = (struct ec_node_or *)gen_node;
@@ -61,18 +41,17 @@ ec_node_or_parse(const struct ec_node *gen_node,
 
        for (i = 0; i < node->len; i++) {
                ret = ec_node_parse_child(node->table[i], state, strvec);
-               if (ret == EC_PARSED_NOMATCH)
+               if (ret == EC_PARSE_NOMATCH)
                        continue;
                return ret;
        }
 
-       return EC_PARSED_NOMATCH;
+       return EC_PARSE_NOMATCH;
 }
 
 static int
 ec_node_or_complete(const struct ec_node *gen_node,
-               struct ec_completed *completed,
-               struct ec_parsed *parsed,
+               struct ec_comp *comp,
                const struct ec_strvec *strvec)
 {
        struct ec_node_or *node = (struct ec_node_or *)gen_node;
@@ -81,7 +60,7 @@ ec_node_or_complete(const struct ec_node *gen_node,
 
        for (n = 0; n < node->len; n++) {
                ret = ec_node_complete_child(node->table[n],
-                                       completed, parsed, strvec);
+                                       comp, strvec);
                if (ret < 0)
                        return ret;
        }
@@ -89,105 +68,212 @@ ec_node_or_complete(const struct ec_node *gen_node,
        return 0;
 }
 
-static size_t ec_node_or_get_max_parse_len(const struct ec_node *gen_node)
+static void ec_node_or_free_priv(struct ec_node *gen_node)
 {
        struct ec_node_or *node = (struct ec_node_or *)gen_node;
-       size_t i, ret = 0, len;
-
-       for (i = 0; i < node->len; i++) {
-               len = ec_node_get_max_parse_len(node->table[i]);
-               if (len > ret)
-                       ret = len;
-       }
+       size_t i;
 
-       return ret;
+       for (i = 0; i < node->len; i++)
+               ec_node_free(node->table[i]);
+       ec_free(node->table);
+       node->table = NULL;
+       node->len = 0;
 }
 
-static void ec_node_or_free_priv(struct ec_node *gen_node)
+static const struct ec_config_schema ec_node_or_subschema[] = {
+       {
+               .desc = "A child node which is part of the choice.",
+               .type = EC_CONFIG_TYPE_NODE,
+       },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
+       },
+};
+
+static const struct ec_config_schema ec_node_or_schema[] = {
+       {
+               .key = "children",
+               .desc = "The list of children nodes defining the choice "
+               "elements.",
+               .type = EC_CONFIG_TYPE_LIST,
+               .subschema = ec_node_or_subschema,
+       },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
+       },
+};
+
+static int ec_node_or_set_config(struct ec_node *gen_node,
+                               const struct ec_config *config)
 {
        struct ec_node_or *node = (struct ec_node_or *)gen_node;
-       unsigned int i;
+       struct ec_node **table = NULL;
+       size_t i, len = 0;
+
+       table = ec_node_config_node_list_to_table(
+               ec_config_dict_get(config, "children"), &len);
+       if (table == NULL)
+               goto fail;
 
        for (i = 0; i < node->len; i++)
                ec_node_free(node->table[i]);
        ec_free(node->table);
+       node->table = table;
+       node->len = len;
+
+       return 0;
+
+fail:
+       for (i = 0; i < len; i++)
+               ec_node_free(table[i]);
+       ec_free(table);
+       return -1;
 }
 
-int ec_node_or_add(struct ec_node *gen_node, struct ec_node *child)
+static size_t
+ec_node_or_get_children_count(const struct ec_node *gen_node)
 {
        struct ec_node_or *node = (struct ec_node_or *)gen_node;
-       struct ec_node **table;
-
-       assert(node != NULL);
-
-       if (child == NULL)
-               return -EINVAL;
+       return node->len;
+}
 
-       gen_node->flags &= ~EC_NODE_F_BUILT;
+static int
+ec_node_or_get_child(const struct ec_node *gen_node, size_t i,
+               struct ec_node **child, unsigned int *refs)
+{
+       struct ec_node_or *node = (struct ec_node_or *)gen_node;
 
-       table = ec_realloc(node->table, (node->len + 1) * sizeof(*node->table));
-       if (table == NULL) {
-               ec_node_free(child);
+       if (i >= node->len)
                return -1;
-       }
-
-       node->table = table;
-       table[node->len] = child;
-       node->len++;
-
-       child->parent = gen_node;
-       TAILQ_INSERT_TAIL(&gen_node->children, child, next);
 
+       *child = node->table[i];
+       /* each child node is referenced twice: once in the config and
+        * once in the node->table[] */
+       *refs = 2;
        return 0;
 }
 
 static struct ec_node_type ec_node_or_type = {
        .name = "or",
+       .schema = ec_node_or_schema,
+       .set_config = ec_node_or_set_config,
        .parse = ec_node_or_parse,
        .complete = ec_node_or_complete,
-       .get_max_parse_len = ec_node_or_get_max_parse_len,
        .size = sizeof(struct ec_node_or),
        .free_priv = ec_node_or_free_priv,
+       .get_children_count = ec_node_or_get_children_count,
+       .get_child = ec_node_or_get_child,
 };
 
 EC_NODE_TYPE_REGISTER(ec_node_or_type);
 
+int ec_node_or_add(struct ec_node *gen_node, struct ec_node *child)
+{
+       struct ec_node_or *node = (struct ec_node_or *)gen_node;
+       const struct ec_config *cur_config = NULL;
+       struct ec_config *config = NULL, *children;
+       int ret;
+
+       assert(node != NULL);
+
+       /* XXX factorize this code in a helper */
+
+       if (ec_node_check_type(gen_node, &ec_node_or_type) < 0)
+               goto fail;
+
+       cur_config = ec_node_get_config(gen_node);
+       if (cur_config == NULL)
+               config = ec_config_dict();
+       else
+               config = ec_config_dup(cur_config);
+       if (config == NULL)
+               goto fail;
+
+       children = ec_config_dict_get(config, "children");
+       if (children == NULL) {
+               children = ec_config_list();
+               if (children == NULL)
+                       goto fail;
+
+               if (ec_config_dict_set(config, "children", children) < 0)
+                       goto fail; /* children list is freed on error */
+       }
+
+       if (ec_config_list_add(children, ec_config_node(child)) < 0) {
+               child = NULL;
+               goto fail;
+       }
+
+       ret = ec_node_set_config(gen_node, config);
+       config = NULL; /* freed */
+       if (ret < 0)
+               goto fail;
+
+       return 0;
+
+fail:
+       ec_config_free(config);
+       ec_node_free(child);
+       return -1;
+}
+
 struct ec_node *__ec_node_or(const char *id, ...)
 {
+       struct ec_config *config = NULL, *children = NULL;
        struct ec_node *gen_node = NULL;
-       struct ec_node_or *node = NULL;
        struct ec_node *child;
        va_list ap;
-       int fail = 0;
+       int ret;
 
        va_start(ap, id);
+       child = va_arg(ap, struct ec_node *);
 
-       gen_node = __ec_node(&ec_node_or_type, id);
-       node = (struct ec_node_or *)gen_node;
-       if (node == NULL)
-               fail = 1;;
+       gen_node = ec_node_from_type(&ec_node_or_type, id);
+       if (gen_node == NULL)
+               goto fail_free_children;
 
-       for (child = va_arg(ap, struct ec_node *);
-            child != EC_NODE_ENDLIST;
-            child = va_arg(ap, struct ec_node *)) {
+       config = ec_config_dict();
+       if (config == NULL)
+               goto fail_free_children;
 
-               /* on error, don't quit the loop to avoid leaks */
-               if (fail == 1 || child == NULL ||
-                               ec_node_or_add(gen_node, child) < 0) {
-                       fail = 1;
-                       ec_node_free(child);
+       children = ec_config_list();
+       if (children == NULL)
+               goto fail_free_children;
+
+       for (; child != EC_NODE_ENDLIST; child = va_arg(ap, struct ec_node *)) {
+               if (child == NULL)
+                       goto fail_free_children;
+
+               if (ec_config_list_add(children, ec_config_node(child)) < 0) {
+                       child = NULL;
+                       goto fail_free_children;
                }
        }
 
-       if (fail == 1)
+       if (ec_config_dict_set(config, "children", children) < 0) {
+               children = NULL; /* freed */
+               goto fail;
+       }
+       children = NULL;
+
+       ret = ec_node_set_config(gen_node, config);
+       config = NULL; /* freed */
+       if (ret < 0)
                goto fail;
 
        va_end(ap);
+
        return gen_node;
 
+fail_free_children:
+       for (; child != EC_NODE_ENDLIST; child = va_arg(ap, struct ec_node *))
+               ec_node_free(child);
 fail:
-       ec_node_free(gen_node); /* will also free children */
+       ec_node_free(gen_node); /* will also free added children */
+       ec_config_free(children);
+       ec_config_free(config);
        va_end(ap);
+
        return NULL;
 }
 
@@ -195,61 +281,61 @@ fail:
 static int ec_node_or_testcase(void)
 {
        struct ec_node *node;
-       int ret = 0;
+       int testres = 0;
 
-       node = EC_NODE_OR(NULL,
-               ec_node_str(NULL, "foo"),
-               ec_node_str(NULL, "bar")
+       node = EC_NODE_OR(EC_NO_ID,
+               ec_node_str(EC_NO_ID, "foo"),
+               ec_node_str(EC_NO_ID, "bar")
        );
        if (node == NULL) {
                EC_LOG(EC_LOG_ERR, "cannot create node\n");
                return -1;
        }
-       ret |= EC_TEST_CHECK_PARSE(node, 1, "foo");
-       ret |= EC_TEST_CHECK_PARSE(node, 1, "bar");
-       ret |= EC_TEST_CHECK_PARSE(node, 1, "foo", "bar");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, " ");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "foox");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "toto");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "foo");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "bar");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "foo", "bar");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, " ");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "foox");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "toto");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "");
        ec_node_free(node);
 
        /* test completion */
-       node = EC_NODE_OR(NULL,
-               ec_node_str(NULL, "foo"),
-               ec_node_str(NULL, "bar"),
-               ec_node_str(NULL, "bar2"),
-               ec_node_str(NULL, "toto"),
-               ec_node_str(NULL, "titi")
+       node = EC_NODE_OR(EC_NO_ID,
+               ec_node_str(EC_NO_ID, "foo"),
+               ec_node_str(EC_NO_ID, "bar"),
+               ec_node_str(EC_NO_ID, "bar2"),
+               ec_node_str(EC_NO_ID, "toto"),
+               ec_node_str(EC_NO_ID, "titi")
        );
        if (node == NULL) {
                EC_LOG(EC_LOG_ERR, "cannot create node\n");
                return -1;
        }
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "", EC_NODE_ENDLIST,
                "foo", "bar", "bar2", "toto", "titi", EC_NODE_ENDLIST);
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "f", EC_NODE_ENDLIST,
                "foo", EC_NODE_ENDLIST);
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "b", EC_NODE_ENDLIST,
                "bar", "bar2", EC_NODE_ENDLIST);
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "bar", EC_NODE_ENDLIST,
                "bar", "bar2", EC_NODE_ENDLIST);
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "t", EC_NODE_ENDLIST,
                "toto", "titi", EC_NODE_ENDLIST);
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "to", EC_NODE_ENDLIST,
                "toto", EC_NODE_ENDLIST);
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "x", EC_NODE_ENDLIST,
                EC_NODE_ENDLIST);
        ec_node_free(node);
 
-       return ret;
+       return testres;
 }
 /* LCOV_EXCL_STOP */