better cleanup priv
[protos/libecoli.git] / lib / ecoli_node_seq.c
index 8b7b2ee..ff0c5de 100644 (file)
@@ -1,32 +1,10 @@
-/*
- * 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 <stdlib.h>
+#include <stdint.h>
 #include <string.h>
 #include <assert.h>
 #include <stdarg.h>
 #include <ecoli_test.h>
 #include <ecoli_strvec.h>
 #include <ecoli_node.h>
-#include <ecoli_parsed.h>
-#include <ecoli_completed.h>
+#include <ecoli_config.h>
+#include <ecoli_parse.h>
+#include <ecoli_complete.h>
+#include <ecoli_node_helper.h>
 #include <ecoli_node_str.h>
 #include <ecoli_node_option.h>
+#include <ecoli_node_or.h>
+#include <ecoli_node_many.h>
 #include <ecoli_node_seq.h>
 
+EC_LOG_TYPE_REGISTER(node_seq);
+
 struct ec_node_seq {
        struct ec_node gen;
        struct ec_node **table;
-       unsigned int len;
+       size_t len;
 };
 
 static int
 ec_node_seq_parse(const struct ec_node *gen_node,
-               struct ec_parsed *state,
+               struct ec_parse *state,
                const struct ec_strvec *strvec)
 {
        struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
@@ -63,19 +47,19 @@ ec_node_seq_parse(const struct ec_node *gen_node,
        for (i = 0; i < node->len; i++) {
                childvec = ec_strvec_ndup(strvec, len,
                        ec_strvec_len(strvec) - len);
-               if (childvec == NULL) {
-                       ret = -ENOMEM;
+               if (childvec == NULL)
                        goto fail;
-               }
 
                ret = ec_node_parse_child(node->table[i], state, childvec);
+               if (ret < 0)
+                       goto fail;
+
                ec_strvec_free(childvec);
                childvec = NULL;
-               if (ret == EC_PARSED_NOMATCH) {
-                       ec_parsed_free_children(state);
-                       return EC_PARSED_NOMATCH;
-               } else if (ret < 0) {
-                       goto fail;
+
+               if (ret == EC_PARSE_NOMATCH) {
+                       ec_parse_free_children(state);
+                       return EC_PARSE_NOMATCH;
                }
 
                len += ret;
@@ -85,24 +69,21 @@ ec_node_seq_parse(const struct ec_node *gen_node,
 
 fail:
        ec_strvec_free(childvec);
-       return ret;
+       return -1;
 }
 
-static struct ec_completed *
+static int
 __ec_node_seq_complete(struct ec_node **table, size_t table_len,
-               struct ec_parsed *state, const struct ec_strvec *strvec)
+               struct ec_comp *comp,
+               const struct ec_strvec *strvec)
 {
-       struct ec_completed *completed, *child_completed;
+       struct ec_parse *parse = ec_comp_get_state(comp);
        struct ec_strvec *childvec = NULL;
        unsigned int i;
        int ret;
 
-       completed = ec_completed();
-       if (completed == NULL)
-               return NULL;
-
        if (table_len == 0)
-               return completed;
+               return 0;
 
        /*
         * Example of completion for a sequence node = [n1,n2] and an
@@ -116,13 +97,10 @@ __ec_node_seq_complete(struct ec_node **table, size_t table_len,
         */
 
        /* first, try to complete with the first node of the table */
-       child_completed = ec_node_complete_child(table[0], state, strvec);
-       if (child_completed == NULL)
+       ret = ec_node_complete_child(table[0], comp, strvec);
+       if (ret < 0)
                goto fail;
 
-       ec_completed_merge(completed, child_completed);
-       child_completed = NULL;
-
        /* then, if the first node of the table matches the beginning of the
         * strvec, try to complete the rest */
        for (i = 0; i < ec_strvec_len(strvec); i++) {
@@ -130,74 +108,148 @@ __ec_node_seq_complete(struct ec_node **table, size_t table_len,
                if (childvec == NULL)
                        goto fail;
 
-               ret = ec_node_parse_child(table[0], state, childvec);
-               if (ret < 0 && ret != EC_PARSED_NOMATCH)
+               ret = ec_node_parse_child(table[0], parse, childvec);
+               if (ret < 0)
                        goto fail;
 
                ec_strvec_free(childvec);
                childvec = NULL;
 
                if ((unsigned int)ret != i) {
-                       if (ret != EC_PARSED_NOMATCH)
-                               ec_parsed_del_last_child(state);
+                       if (ret != EC_PARSE_NOMATCH)
+                               ec_parse_del_last_child(parse);
                        continue;
                }
 
                childvec = ec_strvec_ndup(strvec, i, ec_strvec_len(strvec) - i);
                if (childvec == NULL) {
-                       ec_parsed_del_last_child(state);
+                       ec_parse_del_last_child(parse);
                        goto fail;
                }
 
-               child_completed = __ec_node_seq_complete(&table[1],
-                                                       table_len - 1,
-                                                       state, childvec);
-               ec_parsed_del_last_child(state);
+               ret = __ec_node_seq_complete(&table[1],
+                                       table_len - 1,
+                                       comp, childvec);
+               ec_parse_del_last_child(parse);
                ec_strvec_free(childvec);
                childvec = NULL;
 
-               if (child_completed == NULL)
+               if (ret < 0)
                        goto fail;
-
-               ec_completed_merge(completed, child_completed);
-               child_completed = NULL;
        }
 
-       return completed;
+       return 0;
 
 fail:
        ec_strvec_free(childvec);
-       ec_completed_free(child_completed);
-       ec_completed_free(completed);
-       return NULL;
+       return -1;
 }
 
-static struct ec_completed *
+static int
 ec_node_seq_complete(const struct ec_node *gen_node,
-               struct ec_parsed *state,
+               struct ec_comp *comp,
                const struct ec_strvec *strvec)
 {
        struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
 
-       return __ec_node_seq_complete(node->table, node->len, state, strvec);
+       return __ec_node_seq_complete(node->table, node->len, comp,
+                               strvec);
 }
 
 static void ec_node_seq_free_priv(struct ec_node *gen_node)
 {
        struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
-       unsigned int i;
+       size_t i;
+
+       for (i = 0; i < node->len; i++)
+               ec_node_free(node->table[i]);
+       ec_free(node->table);
+       node->table = NULL;
+       node->len = 0;
+}
+
+static const struct ec_config_schema ec_node_seq_subschema[] = {
+       {
+               .desc = "A child node which is part of the sequence.",
+               .type = EC_CONFIG_TYPE_NODE,
+       },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
+       },
+};
+
+static const struct ec_config_schema ec_node_seq_schema[] = {
+       {
+               .key = "children",
+               .desc = "The list of children nodes, to be parsed in sequence.",
+               .type = EC_CONFIG_TYPE_LIST,
+               .subschema = ec_node_seq_subschema,
+       },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
+       },
+};
+
+static int ec_node_seq_set_config(struct ec_node *gen_node,
+                               const struct ec_config *config)
+{
+       struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
+       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;
+}
+
+static size_t
+ec_node_seq_get_children_count(const struct ec_node *gen_node)
+{
+       struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
+       return node->len;
+}
+
+static int
+ec_node_seq_get_child(const struct ec_node *gen_node, size_t i,
+               struct ec_node **child, unsigned int *refs)
+{
+       struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
+
+       if (i >= node->len)
+               return -1;
+
+       *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_seq_type = {
        .name = "seq",
+       .schema = ec_node_seq_schema,
+       .set_config = ec_node_seq_set_config,
        .parse = ec_node_seq_parse,
        .complete = ec_node_seq_complete,
        .size = sizeof(struct ec_node_seq),
        .free_priv = ec_node_seq_free_priv,
+       .get_children_count = ec_node_seq_get_children_count,
+       .get_child = ec_node_seq_get_child,
 };
 
 EC_NODE_TYPE_REGISTER(ec_node_seq_type);
@@ -205,144 +257,182 @@ EC_NODE_TYPE_REGISTER(ec_node_seq_type);
 int ec_node_seq_add(struct ec_node *gen_node, struct ec_node *child)
 {
        struct ec_node_seq *node = (struct ec_node_seq *)gen_node;
-       struct ec_node **table;
-
-       // XXX check node type
+       const struct ec_config *cur_config = NULL;
+       struct ec_config *config = NULL, *children;
+       int ret;
 
        assert(node != NULL);
 
-       if (child == NULL)
-               return -EINVAL;
+       /* XXX factorize this code in a helper */
 
-       gen_node->flags &= ~EC_NODE_F_BUILT;
+       if (ec_node_check_type(gen_node, &ec_node_seq_type) < 0)
+               goto fail;
 
-       table = ec_realloc(node->table, (node->len + 1) * sizeof(*node->table));
-       if (table == NULL) {
-               ec_node_free(child);
-               return -1;
+       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 */
        }
 
-       node->table = table;
-       table[node->len] = child;
-       node->len++;
+       if (ec_config_list_add(children, ec_config_node(child)) < 0) {
+               child = NULL;
+               goto fail;
+       }
 
-       child->parent = gen_node;
-       TAILQ_INSERT_TAIL(&gen_node->children, child, next); // XXX really needed?
+       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_seq(const char *id, ...)
 {
+       struct ec_config *config = NULL, *children = NULL;
        struct ec_node *gen_node = NULL;
-       struct ec_node_seq *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_from_type(&ec_node_seq_type, id);
+       if (gen_node == NULL)
+               goto fail_free_children;
+
+       config = ec_config_dict();
+       if (config == NULL)
+               goto fail_free_children;
 
-       gen_node = __ec_node(&ec_node_seq_type, id);
-       node = (struct ec_node_seq *)gen_node;
-       if (node == NULL)
-               fail = 1;;
+       children = ec_config_list();
+       if (children == NULL)
+               goto fail_free_children;
 
-       for (child = va_arg(ap, struct ec_node *);
-            child != EC_NODE_ENDLIST;
-            child = va_arg(ap, struct ec_node *)) {
+       for (; child != EC_NODE_ENDLIST; child = va_arg(ap, struct ec_node *)) {
+               if (child == NULL)
+                       goto fail_free_children;
 
-               /* on error, don't quit the loop to avoid leaks */
-               if (fail == 1 || child == NULL ||
-                               ec_node_seq_add(&node->gen, child) < 0) {
-                       fail = 1;
-                       ec_node_free(child);
+               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;
 }
 
+/* LCOV_EXCL_START */
 static int ec_node_seq_testcase(void)
 {
-       struct ec_node *node;
-       int ret = 0;
+       struct ec_node *node = NULL;
+       int testres = 0;
 
-       node = EC_NODE_SEQ(NULL,
-               ec_node_str(NULL, "foo"),
-               ec_node_str(NULL, "bar")
+       node = EC_NODE_SEQ(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");
+               EC_LOG(EC_LOG_ERR, "cannot create node\n");
                return -1;
        }
-       ret |= EC_TEST_CHECK_PARSE(node, 2, "foo", "bar");
-       ret |= EC_TEST_CHECK_PARSE(node, 2, "foo", "bar", "toto");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "foo");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "foox", "bar");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "foo", "barx");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "bar", "foo");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "", "foo");
+       testres |= EC_TEST_CHECK_PARSE(node, 2, "foo", "bar");
+       testres |= EC_TEST_CHECK_PARSE(node, 2, "foo", "bar", "toto");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "foo");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "foox", "bar");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "foo", "barx");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "bar", "foo");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "", "foo");
+
+       testres |= (ec_node_seq_add(node, ec_node_str(EC_NO_ID, "grr")) < 0);
+       testres |= EC_TEST_CHECK_PARSE(node, 3, "foo", "bar", "grr");
+
        ec_node_free(node);
 
        /* test completion */
-       node = EC_NODE_SEQ(NULL,
-               ec_node_str(NULL, "foo"),
-               ec_node_option(NULL, ec_node_str(NULL, "toto")),
-               ec_node_str(NULL, "bar")
+       node = EC_NODE_SEQ(EC_NO_ID,
+               ec_node_str(EC_NO_ID, "foo"),
+               ec_node_option(EC_NO_ID, ec_node_str(EC_NO_ID, "toto")),
+               ec_node_str(EC_NO_ID, "bar")
        );
        if (node == NULL) {
-               ec_log(EC_LOG_ERR, "cannot create node\n");
+               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", EC_NODE_ENDLIST,
-               "foo");
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+               "foo", EC_NODE_ENDLIST);
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "f", EC_NODE_ENDLIST,
-               "oo", EC_NODE_ENDLIST,
-               "oo");
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+               "foo", EC_NODE_ENDLIST);
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "foo", EC_NODE_ENDLIST,
-               "", EC_NODE_ENDLIST,
-               "");
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+               "foo", EC_NODE_ENDLIST);
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "foo", "", EC_NODE_ENDLIST,
-               "bar", "toto", EC_NODE_ENDLIST,
-               "");
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+               "bar", "toto", EC_NODE_ENDLIST);
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "foo", "t", EC_NODE_ENDLIST,
-               "oto", EC_NODE_ENDLIST,
-               "oto");
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+               "toto", EC_NODE_ENDLIST);
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "foo", "b", EC_NODE_ENDLIST,
-               "ar", EC_NODE_ENDLIST,
-               "ar");
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+               "bar", EC_NODE_ENDLIST);
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "foo", "bar", EC_NODE_ENDLIST,
-               "", EC_NODE_ENDLIST,
-               "");
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+               "bar", EC_NODE_ENDLIST);
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "x", EC_NODE_ENDLIST,
-               EC_NODE_ENDLIST,
-               "");
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+               EC_NODE_ENDLIST);
+       testres |= EC_TEST_CHECK_COMPLETE(node,
                "foobarx", EC_NODE_ENDLIST,
-               EC_NODE_ENDLIST,
-               "");
+               EC_NODE_ENDLIST);
        ec_node_free(node);
 
-       return ret;
+       return testres;
 }
+/* LCOV_EXCL_STOP */
 
 static struct ec_test ec_node_seq_test = {
        .name = "node_seq",