doc
[protos/libecoli.git] / lib / ecoli_node_int.c
index 2ba1b28..c72ee04 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_malloc.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_int.h>
 #include <ecoli_test.h>
 
-struct ec_node_int {
+EC_LOG_TYPE_REGISTER(node_int);
+
+/* common to int and uint */
+struct ec_node_int_uint {
        struct ec_node gen;
+       bool is_signed;
        bool check_min;
-       long long int min;
        bool check_max;
-       long long int max;
+       union {
+               int64_t min;
+               uint64_t umin;
+       };
+       union {
+               int64_t max;
+               uint64_t umax;
+       };
        unsigned int base;
 };
 
-static int parse_llint(struct ec_node_int *node, const char *str,
-       long long *val)
+static int parse_llint(struct ec_node_int_uint *node, const char *str,
+       int64_t *val)
 {
        char *endptr;
+       int save_errno = errno;
 
        errno = 0;
        *val = strtoll(str, &endptr, node->base);
 
-       /* out of range */
        if ((errno == ERANGE && (*val == LLONG_MAX || *val == LLONG_MIN)) ||
                        (errno != 0 && *val == 0))
                return -1;
 
-       if (node->check_min && *val < node->min)
+       if (node->check_min && *val < node->min) {
+               errno = ERANGE;
+               return -1;
+       }
+
+       if (node->check_max && *val > node->max) {
+               errno = ERANGE;
+               return -1;
+       }
+
+       if (*endptr != 0) {
+               errno = EINVAL;
+               return -1;
+       }
+
+       errno = save_errno;
+       return 0;
+}
+
+static int parse_ullint(struct ec_node_int_uint *node, const char *str,
+                       uint64_t *val)
+{
+       char *endptr;
+       int save_errno = errno;
+
+       /* since a negative input is silently converted to a positive
+        * one by strtoull(), first check that it is positive */
+       if (strchr(str, '-'))
+               return -1;
+
+       errno = 0;
+       *val = strtoull(str, &endptr, node->base);
+
+       if ((errno == ERANGE && *val == ULLONG_MAX) ||
+                       (errno != 0 && *val == 0))
+               return -1;
+
+       if (node->check_min && *val < node->umin)
                return -1;
 
-       if (node->check_max && *val > node->max)
+       if (node->check_max && *val > node->umax)
                return -1;
 
        if (*endptr != 0)
                return -1;
 
+       errno = save_errno;
        return 0;
 }
 
-static int ec_node_int_parse(const struct ec_node *gen_node,
-                       struct ec_parsed *state,
+static int ec_node_int_uint_parse(const struct ec_node *gen_node,
+                       struct ec_parse *state,
                        const struct ec_strvec *strvec)
 {
-       struct ec_node_int *node = (struct ec_node_int *)gen_node;
+       struct ec_node_int_uint *node = (struct ec_node_int_uint *)gen_node;
        const char *str;
-       long long val;
+       uint64_t u64;
+       int64_t i64;
 
        (void)state;
 
        if (ec_strvec_len(strvec) == 0)
-               return EC_PARSED_NOMATCH;
+               return EC_PARSE_NOMATCH;
 
        str = ec_strvec_val(strvec, 0);
-       if (parse_llint(node, str, &val) < 0)
-               return EC_PARSED_NOMATCH;
-
+       if (node->is_signed) {
+               if (parse_llint(node, str, &i64) < 0)
+                       return EC_PARSE_NOMATCH;
+       } else {
+               if (parse_ullint(node, str, &u64) < 0)
+                       return EC_PARSE_NOMATCH;
+       }
        return 1;
 }
 
+static int
+ec_node_uint_init_priv(struct ec_node *gen_node)
+{
+       struct ec_node_int_uint *node = (struct ec_node_int_uint *)gen_node;
+
+       node->is_signed = true;
+
+       return 0;
+}
+
 static struct ec_node_type ec_node_int_type = {
        .name = "int",
-       .parse = ec_node_int_parse,
-       .complete = ec_node_default_complete,
-       .size = sizeof(struct ec_node_int),
+       .parse = ec_node_int_uint_parse,
+       .complete = ec_node_complete_unknown,
+       .size = sizeof(struct ec_node_int_uint),
+       .init_priv = ec_node_uint_init_priv,
 };
 
 EC_NODE_TYPE_REGISTER(ec_node_int_type);
 
-struct ec_node *ec_node_int(const char *id, long long int min,
-       long long int max, unsigned int base)
+struct ec_node *ec_node_int(const char *id, int64_t min,
+       int64_t max, unsigned int base)
 {
        struct ec_node *gen_node = NULL;
-       struct ec_node_int *node = NULL;
 
        gen_node = __ec_node(&ec_node_int_type, id);
        if (gen_node == NULL)
                return NULL;
-       node = (struct ec_node_int *)gen_node;
+
+       if (ec_node_int_set_limits(gen_node, min, max) < 0)
+               goto fail;
+       if (ec_node_int_set_base(gen_node, base) < 0)
+               goto fail;
+
+       return gen_node;
+
+fail:
+       ec_node_free(gen_node);
+       return NULL;
+}
+
+static struct ec_node_type ec_node_uint_type = {
+       .name = "uint",
+       .parse = ec_node_int_uint_parse,
+       .complete = ec_node_complete_unknown,
+       .size = sizeof(struct ec_node_int_uint),
+};
+
+EC_NODE_TYPE_REGISTER(ec_node_uint_type);
+
+struct ec_node *ec_node_uint(const char *id, uint64_t min,
+       uint64_t max, unsigned int base)
+{
+       struct ec_node *gen_node = NULL;
+
+       gen_node = __ec_node(&ec_node_uint_type, id);
+       if (gen_node == NULL)
+               return NULL;
+
+       if (ec_node_uint_set_limits(gen_node, min, max) < 0)
+               goto fail;
+       if (ec_node_uint_set_base(gen_node, base) < 0)
+               goto fail;
+
+       return gen_node;
+
+fail:
+       ec_node_free(gen_node);
+       return NULL;
+}
+
+int ec_node_int_disable_limits(struct ec_node *gen_node)
+{
+       struct ec_node_int_uint *node = (struct ec_node_int_uint *)gen_node;
+       int ret;
+
+       ret = ec_node_check_type(gen_node, &ec_node_int_type);
+       if (ret < 0)
+               return ret;
+
+       node->check_min = false;
+       node->check_max = false;
+
+       return 0;
+}
+
+int ec_node_int_set_limits(struct ec_node *gen_node, int64_t min,
+                       int64_t max)
+{
+       struct ec_node_int_uint *node = (struct ec_node_int_uint *)gen_node;
+       int ret;
+
+       ret = ec_node_check_type(gen_node, &ec_node_int_type);
+       if (ret < 0)
+               return ret;
+
+       if (min > max) {
+               errno = EINVAL;
+               return -1;
+       }
+
+       node->check_min = true;
+       node->min = min;
+       node->check_max = true;
+       node->max = max;
+
+       return 0;
+}
+
+int ec_node_int_set_base(struct ec_node *gen_node, unsigned int base)
+{
+       struct ec_node_int_uint *node = (struct ec_node_int_uint *)gen_node;
+       int ret;
+
+       ret = ec_node_check_type(gen_node, &ec_node_int_type);
+       if (ret < 0)
+               return ret;
+
+       node->base = base;
+
+       return 0;
+
+}
+
+int ec_node_uint_disable_limits(struct ec_node *gen_node)
+{
+       struct ec_node_int_uint *node = (struct ec_node_int_uint *)gen_node;
+       int ret;
+
+       ret = ec_node_check_type(gen_node, &ec_node_uint_type);
+       if (ret < 0)
+               return ret;
+
+       node->check_min = false;
+       node->check_max = false;
+
+       return 0;
+}
+
+int ec_node_uint_set_limits(struct ec_node *gen_node, uint64_t min,
+                       uint64_t max)
+{
+       struct ec_node_int_uint *node = (struct ec_node_int_uint *)gen_node;
+       int ret;
+
+       ret = ec_node_check_type(gen_node, &ec_node_uint_type);
+       if (ret < 0)
+               return ret;
+
+       if (min > max) {
+               errno = EINVAL;
+               return -1;
+       }
 
        node->check_min = true;
        node->min = min;
        node->check_max = true;
        node->max = max;
+
+       return 0;
+}
+
+int ec_node_uint_set_base(struct ec_node *gen_node, unsigned int base)
+{
+       struct ec_node_int_uint *node = (struct ec_node_int_uint *)gen_node;
+       int ret;
+
+       ret = ec_node_check_type(gen_node, &ec_node_uint_type);
+       if (ret < 0)
+               return ret;
+
        node->base = base;
 
-       return &node->gen;
+       return 0;
 }
 
-long long ec_node_int_getval(struct ec_node *gen_node, const char *str)
+int ec_node_int_getval(const struct ec_node *gen_node, const char *str,
+                       int64_t *result)
 {
-       struct ec_node_int *node = (struct ec_node_int *)gen_node;
-       long long val = 0;
+       struct ec_node_int_uint *node = (struct ec_node_int_uint *)gen_node;
+       int ret;
 
-       // XXX check type here
-       // if gen_node->type != int fail
+       ret = ec_node_check_type(gen_node, &ec_node_int_type);
+       if (ret < 0)
+               return ret;
 
-       parse_llint(node, str, &val);
+       if (parse_llint(node, str, result) < 0)
+               return -1;
+
+       return 0;
+}
 
-       return val;
+int ec_node_uint_getval(const struct ec_node *gen_node, const char *str,
+                       uint64_t *result)
+{
+       struct ec_node_int_uint *node = (struct ec_node_int_uint *)gen_node;
+       int ret;
+
+       ret = ec_node_check_type(gen_node, &ec_node_uint_type);
+       if (ret < 0)
+               return ret;
+
+       if (parse_ullint(node, str, result) < 0)
+               return -1;
+
+       return 0;
 }
 
+/* LCOV_EXCL_START */
 static int ec_node_int_testcase(void)
 {
-       struct ec_parsed *p;
+       struct ec_parse *p;
        struct ec_node *node;
        const char *s;
-       int ret = 0;
+       int testres = 0, ret;
+       uint64_t u64;
+       int64_t i64;
 
-       node = ec_node_int(NULL, 0, 256, 0);
+       node = ec_node_uint(EC_NO_ID, 1, 256, 0);
        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, 1, "0");
-       ret |= EC_TEST_CHECK_PARSE(node, 1, "256", "foo");
-       ret |= EC_TEST_CHECK_PARSE(node, 1, "0x100");
-       ret |= EC_TEST_CHECK_PARSE(node, 1, " 1");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "-1");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "0x101");
-
-       p = ec_node_parse(node, "0");
-       s = ec_strvec_val(ec_parsed_strvec(p), 0);
-       EC_TEST_ASSERT(s != NULL && ec_node_int_getval(node, s) == 0);
-       ec_parsed_free(p);
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "0");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "1");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "256", "foo");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "0x100");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, " 1");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "-1");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "0x101");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "zzz");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "0x100000000000000000");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "4r");
+       ret = ec_node_uint_disable_limits(node);
+       testres |= EC_TEST_CHECK(ret == 0, "cannot disable limits");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "0");
+
+       p = ec_node_parse(node, "1");
+       s = ec_strvec_val(ec_parse_strvec(p), 0);
+       testres |= EC_TEST_CHECK(s != NULL &&
+               ec_node_uint_getval(node, s, &u64) == 0 &&
+               u64 == 1, "bad integer value");
+       ec_parse_free(p);
 
        p = ec_node_parse(node, "10");
-       s = ec_strvec_val(ec_parsed_strvec(p), 0);
-       EC_TEST_ASSERT(s != NULL && ec_node_int_getval(node, s) == 10);
-       ec_parsed_free(p);
+       s = ec_strvec_val(ec_parse_strvec(p), 0);
+       testres |= EC_TEST_CHECK(s != NULL &&
+               ec_node_uint_getval(node, s, &u64) == 0 &&
+               u64 == 10, "bad integer value");
+       ec_parse_free(p);
        ec_node_free(node);
 
-       node = ec_node_int(NULL, -1, LLONG_MAX, 16);
+       node = ec_node_int(EC_NO_ID, -1, LLONG_MAX, 16);
        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, 1, "0");
-       ret |= EC_TEST_CHECK_PARSE(node, 1, "-1");
-       ret |= EC_TEST_CHECK_PARSE(node, 1, "7fffffffffffffff");
-       ret |= EC_TEST_CHECK_PARSE(node, 1, "0x7fffffffffffffff");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "-2");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "0");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "-1");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "7fffffffffffffff");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "0x7fffffffffffffff");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "0x8000000000000000");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "-2");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "zzz");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "4r");
+       ret = ec_node_int_disable_limits(node);
+       testres |= EC_TEST_CHECK(ret == 0, "cannot disable limits");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "-2");
 
        p = ec_node_parse(node, "10");
-       s = ec_strvec_val(ec_parsed_strvec(p), 0);
-       EC_TEST_ASSERT(s != NULL && ec_node_int_getval(node, s) == 16);
-       ec_parsed_free(p);
+       s = ec_strvec_val(ec_parse_strvec(p), 0);
+       testres |= EC_TEST_CHECK(s != NULL &&
+               ec_node_int_getval(node, s, &i64) == 0 &&
+               i64 == 16, "bad integer value");
+       ec_parse_free(p);
        ec_node_free(node);
 
-       node = ec_node_int(NULL, LLONG_MIN, 0, 10);
+       node = ec_node_int(EC_NO_ID, LLONG_MIN, 0, 10);
        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, 1, "0");
-       ret |= EC_TEST_CHECK_PARSE(node, 1, "-1");
-       ret |= EC_TEST_CHECK_PARSE(node, 1, "-9223372036854775808");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "0x0");
-       ret |= EC_TEST_CHECK_PARSE(node, -1, "1");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "0");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "-1");
+       testres |= EC_TEST_CHECK_PARSE(node, 1, "-9223372036854775808");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "0x0");
+       testres |= EC_TEST_CHECK_PARSE(node, -1, "1");
        ec_node_free(node);
 
        /* test completion */
-       node = ec_node_int(NULL, 0, 10, 0);
+       node = ec_node_int(EC_NO_ID, 0, 10, 0);
        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,
-               EC_NODE_ENDLIST,
-               "");
-       ret |= EC_TEST_CHECK_COMPLETE(node,
+               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,
                "1", 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_int_test = {
        .name = "node_int",