]> git.droids-corp.org - protos/libecoli.git/commitdiff
remove schema_len, use a sentinel
authorOlivier Matz <zer0@droids-corp.org>
Thu, 9 Aug 2018 13:42:33 +0000 (15:42 +0200)
committerOlivier Matz <zer0@droids-corp.org>
Thu, 9 Aug 2018 13:42:33 +0000 (15:42 +0200)
lib/ecoli_config.c
lib/ecoli_config.h
lib/ecoli_node.c
lib/ecoli_node.h
lib/ecoli_node_cmd.c
lib/ecoli_node_int.c
lib/ecoli_node_seq.c
lib/ecoli_node_str.c

index fd709f20f4c860e40123caa111a8fd241fe6a90f..838438ea50720480463e427d07f8733a0a29aff7 100644 (file)
@@ -23,8 +23,7 @@ __ec_config_dump(FILE *out, const char *key, const struct ec_config *config,
        size_t indent);
 static int
 ec_config_dict_validate(const struct ec_keyval *dict,
-                       const struct ec_config_schema *schema,
-                       size_t schema_len);
+                       const struct ec_config_schema *schema);
 
 /* return ec_value type as a string */
 static const char *
@@ -42,9 +41,21 @@ ec_config_type_str(enum ec_config_type type)
        }
 }
 
+static size_t
+ec_config_schema_len(const struct ec_config_schema *schema)
+{
+       size_t i;
+
+       if (schema == NULL)
+               return 0;
+       for (i = 0; schema[i].type != EC_CONFIG_TYPE_NONE; i++)
+               ;
+       return i;
+}
+
 static int
 __ec_config_schema_validate(const struct ec_config_schema *schema,
-                       size_t schema_len, enum ec_config_type type)
+                       enum ec_config_type type)
 {
        size_t i, j;
        int ret;
@@ -56,7 +67,7 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
                        return -1;
                }
        } else if (type == EC_CONFIG_TYPE_DICT) {
-               for (i = 0; i < schema_len; i++) {
+               for (i = 0; schema[i].type != EC_CONFIG_TYPE_NONE; i++) {
                        if (schema[i].key == NULL) {
                                errno = EINVAL;
                                EC_LOG(EC_LOG_ERR,
@@ -70,9 +81,9 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
                return -1;
        }
 
-       for (i = 0; i < schema_len; i++) {
+       for (i = 0; schema[i].type != EC_CONFIG_TYPE_NONE; i++) {
                /* check for duplicate name if more than one element */
-               for (j = i + 1; j < schema_len; j++) {
+               for (j = i + 1; schema[j].type != EC_CONFIG_TYPE_NONE; j++) {
                        if (!strcmp(schema[i].key, schema[j].key)) {
                                errno = EEXIST;
                                EC_LOG(EC_LOG_ERR,
@@ -88,8 +99,8 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
                case EC_CONFIG_TYPE_UINT64:
                case EC_CONFIG_TYPE_STRING:
                case EC_CONFIG_TYPE_NODE:
-                       if (schema[i].subschema != NULL ||
-                                       schema[i].subschema_len != 0) {
+                       if (schema[i].subschema != NULL || ec_config_schema_len(
+                                       schema[i].subschema) != 0) {
                                errno = EINVAL;
                                EC_LOG(EC_LOG_ERR,
                                        "key <%s> should not have subtype/subschema\n",
@@ -98,8 +109,8 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
                        }
                        break;
                case EC_CONFIG_TYPE_LIST:
-                       if (schema[i].subschema == NULL ||
-                                       schema[i].subschema_len != 1) {
+                       if (schema[i].subschema == NULL || ec_config_schema_len(
+                                       schema[i].subschema) != 1) {
                                errno = EINVAL;
                                EC_LOG(EC_LOG_ERR,
                                        "key <%s> must have subschema of length 1\n",
@@ -108,8 +119,8 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
                        }
                        break;
                case EC_CONFIG_TYPE_DICT:
-                       if (schema[i].subschema == NULL ||
-                                       schema[i].subschema_len == 0) {
+                       if (schema[i].subschema == NULL || ec_config_schema_len(
+                                       schema[i].subschema) == 0) {
                                errno = EINVAL;
                                EC_LOG(EC_LOG_ERR,
                                        "key <%s> must have subschema\n",
@@ -128,7 +139,6 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
                        continue;
 
                ret = __ec_config_schema_validate(schema[i].subschema,
-                                               schema[i].subschema_len,
                                                schema[i].type);
                if (ret < 0) {
                        EC_LOG(EC_LOG_ERR, "cannot parse subschema %s%s\n",
@@ -142,20 +152,18 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
 }
 
 int
-ec_config_schema_validate(const struct ec_config_schema *schema,
-                       size_t schema_len)
+ec_config_schema_validate(const struct ec_config_schema *schema)
 {
-       return __ec_config_schema_validate(schema, schema_len,
-                                       EC_CONFIG_TYPE_DICT);
+       return __ec_config_schema_validate(schema, EC_CONFIG_TYPE_DICT);
 }
 
 static void
 __ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema,
-                       size_t schema_len, size_t indent)
+                       size_t indent)
 {
        size_t i;
 
-       for (i = 0; i < schema_len; i++) {
+       for (i = 0; schema[i].type != EC_CONFIG_TYPE_NONE; i++) {
                fprintf(out, "%*s" "%s%s%stype=%s desc='%s'\n",
                        (int)indent * 4, "",
                        schema[i].key ? "key=": "",
@@ -166,22 +174,21 @@ __ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema,
                if (schema[i].subschema == NULL)
                        continue;
                __ec_config_schema_dump(out, schema[i].subschema,
-                                       schema[i].subschema_len, indent + 1);
+                                       indent + 1);
        }
 }
 
 void
-ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema,
-               size_t schema_len)
+ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema)
 {
        fprintf(out, "------------------- schema dump:\n");
 
-       if (schema == NULL || schema_len == 0) {
+       if (schema == NULL) {
                fprintf(out, "no schema\n");
                return;
        }
 
-       __ec_config_schema_dump(out, schema, schema_len, 0);
+       __ec_config_schema_dump(out, schema, 0);
 }
 
 enum ec_config_type ec_config_get_type(const struct ec_config *config)
@@ -329,12 +336,11 @@ ec_config_list(void)
 
 static const struct ec_config_schema *
 ec_config_schema_lookup(const struct ec_config_schema *schema,
-                       size_t schema_len, const char *key,
-                       enum ec_config_type type)
+                       const char *key, enum ec_config_type type)
 {
        size_t i;
 
-       for (i = 0; i < schema_len; i++) {
+       for (i = 0; schema[i].type != EC_CONFIG_TYPE_NONE; i++) {
                if (!strcmp(key, schema[i].key) &&
                                type == schema[i].type)
                        return &schema[i];
@@ -481,7 +487,7 @@ ec_config_list_validate(const struct ec_config_list *list,
                                return -1;
                } else if (value->type == EC_CONFIG_TYPE_DICT) {
                        if (ec_config_dict_validate(value->dict,
-                                       sch->subschema, sch->subschema_len) < 0)
+                                       sch->subschema) < 0)
                                return -1;
                }
        }
@@ -491,8 +497,7 @@ ec_config_list_validate(const struct ec_config_list *list,
 
 static int
 ec_config_dict_validate(const struct ec_keyval *dict,
-                       const struct ec_config_schema *schema,
-                       size_t schema_len)
+                       const struct ec_config_schema *schema)
 {
        const struct ec_config *value;
        struct ec_keyval_iter *iter = NULL;
@@ -505,8 +510,7 @@ ec_config_dict_validate(const struct ec_keyval *dict,
 
                key = ec_keyval_iter_get_key(iter);
                value = ec_keyval_iter_get_val(iter);
-               sch = ec_config_schema_lookup(schema, schema_len,
-                                       key, value->type);
+               sch = ec_config_schema_lookup(schema, key, value->type);
                if (sch == NULL) {
                        errno = EBADMSG;
                        goto fail;
@@ -518,7 +522,7 @@ ec_config_dict_validate(const struct ec_keyval *dict,
                                goto fail;
                } else if (value->type == EC_CONFIG_TYPE_DICT) {
                        if (ec_config_dict_validate(value->dict,
-                                       sch->subschema, sch->subschema_len) < 0)
+                                       sch->subschema) < 0)
                                goto fail;
                }
        }
@@ -533,15 +537,14 @@ fail:
 
 int
 ec_config_validate(const struct ec_config *dict,
-               const struct ec_config_schema *schema,
-               size_t schema_len)
+               const struct ec_config_schema *schema)
 {
        if (dict->type != EC_CONFIG_TYPE_DICT || schema == NULL) {
                errno = EINVAL;
                goto fail;
        }
 
-       if (ec_config_dict_validate(dict->dict, schema, schema_len) < 0)
+       if (ec_config_dict_validate(dict->dict, schema) < 0)
                goto fail;
 
        return 0
@@ -851,6 +854,9 @@ static const struct ec_config_schema sch_intlist_elt[] = {
                .desc = "This is a description for int",
                .type = EC_CONFIG_TYPE_INT64,
        },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
+       },
 };
 
 static const struct ec_config_schema sch_dict[] = {
@@ -864,6 +870,9 @@ static const struct ec_config_schema sch_dict[] = {
                .desc = "This is a description for int2",
                .type = EC_CONFIG_TYPE_INT64,
        },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
+       },
 };
 
 static const struct ec_config_schema sch_dictlist_elt[] = {
@@ -871,7 +880,9 @@ static const struct ec_config_schema sch_dictlist_elt[] = {
                .desc = "This is a description for dict",
                .type = EC_CONFIG_TYPE_DICT,
                .subschema = sch_dict,
-               .subschema_len = EC_COUNT_OF(sch_dict),
+       },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
        },
 };
 
@@ -901,14 +912,15 @@ static const struct ec_config_schema sch_baseconfig[] = {
                .desc = "This is a description for list",
                .type = EC_CONFIG_TYPE_LIST,
                .subschema = sch_intlist_elt,
-               .subschema_len = EC_COUNT_OF(sch_intlist_elt),
        },
        {
                .key = "my_dictlist",
                .desc = "This is a description for list",
                .type = EC_CONFIG_TYPE_LIST,
                .subschema = sch_dictlist_elt,
-               .subschema_len = EC_COUNT_OF(sch_dictlist_elt),
+       },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
        },
 };
 
@@ -927,14 +939,12 @@ static int ec_config_testcase(void)
        if (node == NULL)
                goto fail;
 
-       if (ec_config_schema_validate(sch_baseconfig,
-                                       EC_COUNT_OF(sch_baseconfig)) < 0) {
+       if (ec_config_schema_validate(sch_baseconfig) < 0) {
                EC_LOG(EC_LOG_ERR, "invalid config schema\n");
                goto fail;
        }
 
-       ec_config_schema_dump(stdout, sch_baseconfig,
-                       EC_COUNT_OF(sch_baseconfig));
+       ec_config_schema_dump(stdout, sch_baseconfig);
 
        config = ec_config_dict();
        if (config == NULL)
@@ -959,8 +969,7 @@ static int ec_config_testcase(void)
                "unexpected int value");
 
        testres |= EC_TEST_CHECK(
-               ec_config_validate(config, sch_baseconfig,
-                               EC_COUNT_OF(sch_baseconfig)) == 0,
+               ec_config_validate(config, sch_baseconfig) == 0,
                "cannot validate config\n");
 
        ret = ec_config_dict_set(config, "my_string", ec_config_string("toto"));
@@ -999,8 +1008,7 @@ static int ec_config_testcase(void)
                "unexpected int value");
 
        testres |= EC_TEST_CHECK(
-               ec_config_validate(subconfig, sch_dict,
-                               EC_COUNT_OF(sch_dict)) == 0,
+               ec_config_validate(subconfig, sch_dict) == 0,
                "cannot validate subconfig\n");
 
        ret = ec_config_list_add(list, subconfig);
@@ -1030,8 +1038,7 @@ static int ec_config_testcase(void)
                "unexpected int value");
 
        testres |= EC_TEST_CHECK(
-               ec_config_validate(subconfig, sch_dict,
-                               EC_COUNT_OF(sch_dict)) == 0,
+               ec_config_validate(subconfig, sch_dict) == 0,
                "cannot validate subconfig\n");
 
        ret = ec_config_list_add(list, subconfig);
@@ -1043,8 +1050,7 @@ static int ec_config_testcase(void)
        testres |= EC_TEST_CHECK(ret == 0, "cannot set list");
 
        testres |= EC_TEST_CHECK(
-               ec_config_validate(config, sch_baseconfig,
-                               EC_COUNT_OF(sch_baseconfig)) == 0,
+               ec_config_validate(config, sch_baseconfig) == 0,
                "cannot validate config\n");
 
        list_ = ec_config_dict_get(config, "my_dictlist");
@@ -1066,8 +1072,7 @@ static int ec_config_testcase(void)
        /* remove the first element */
        ec_config_list_del(list_, ec_config_list_first(list_));
        testres |= EC_TEST_CHECK(
-               ec_config_validate(config, sch_baseconfig,
-                               EC_COUNT_OF(sch_baseconfig)) == 0,
+               ec_config_validate(config, sch_baseconfig) == 0,
                "cannot validate config\n");
 
        ec_config_dump(stdout, config);
index 96e47b322cdcc2454effbcee229426e1d1cf276a..866a67a8bf0ae302712c03b6211e4e2ba5c287ac 100644 (file)
@@ -47,11 +47,6 @@ struct ec_config_schema {
        /** If type is dict or list, the schema of the dict or list
         * elements. Else must be NULL. */
        const struct ec_config_schema *subschema;
-
-       /** The subschema array len in case of dict (> 0) or list (set
-        * to 1). Else must be 0. */
-       size_t subschema_len;
-
 };
 
 TAILQ_HEAD(ec_config_list, ec_config);
@@ -85,14 +80,12 @@ struct ec_config {
  * Validate a configuration schema array.
  *
  * @param schema
- *   Pointer to the first element of the schema array.
- * @param schema_len
- *   Length of the schema array.
+ *   Pointer to the first element of the schema array. The array
+ *   must be terminated by a sentinel entry (type == EC_CONFIG_TYPE_NONE).
  * @return
  *   0 if the schema is valid, or -1 on error (errno is set).
  */
-int ec_config_schema_validate(const struct ec_config_schema *schema,
-                       size_t schema_len);
+int ec_config_schema_validate(const struct ec_config_schema *schema);
 
 /**
  * Dump a configuration schema array.
@@ -100,12 +93,10 @@ int ec_config_schema_validate(const struct ec_config_schema *schema,
  * @param out
  *   Output stream on which the dump will be sent.
  * @param schema
- *   Pointer to the first element of the schema array.
- * @param schema_len
- *   Length of the schema array.
+ *   Pointer to the first element of the schema array. The array
+ *   must be terminated by a sentinel entry (type == EC_CONFIG_TYPE_NONE).
  */
-void ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema,
-                       size_t schema_len);
+void ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema);
 
 
 /* config */
@@ -226,15 +217,13 @@ int ec_config_list_del(struct ec_config *list, struct ec_config *config);
  * @param dict
  *   A hash table configuration to validate.
  * @param schema
- *   Pointer to the first element of the schema array.
- * @param schema_len
- *   Length of the schema array.
+ *   Pointer to the first element of the schema array. The array
+ *   must be terminated by a sentinel entry (type == EC_CONFIG_TYPE_NONE).
  * @return
  *   0 on success, -1 on error (errno is set).
  */
 int ec_config_validate(const struct ec_config *dict,
-               const struct ec_config_schema *schema,
-               size_t schema_len);
+               const struct ec_config_schema *schema);
 
 /**
  * Set a value in a hash table configuration
index 878aded7b6387a8c78e348ee00f4cdd20b65e0fb..46bd9d85dc38d115af13d505d78530c60a887e5f 100644 (file)
@@ -275,8 +275,7 @@ ec_node_set_config(struct ec_node *node, struct ec_config *config)
                errno = EINVAL;
                goto fail;
        }
-       if (ec_config_validate(config, node->type->schema,
-                               node->type->schema_len) < 0)
+       if (ec_config_validate(config, node->type->schema) < 0)
                goto fail;
        if (node->type->set_config != NULL) {
                if (node->type->set_config(node, config) < 0)
index 3501361c32db2abd753222f533a4f9cc810e5439..0867525798a746477208ee16cb845a038b5bd86b 100644 (file)
@@ -92,9 +92,9 @@ typedef int (*ec_node_get_child_t)(const struct ec_node *,
 struct ec_node_type {
        TAILQ_ENTRY(ec_node_type) next;  /**< Next in list. */
        const char *name;                /**< Node type name. */
-       /** Generic configuration schema. */
+       /** Configuration schema array, must be terminated by a sentinel
+        *  (.type = EC_CONFIG_TYPE_NONE). */
        const struct ec_config_schema *schema;
-       size_t schema_len;               /**< Number of elts in schema array. */
        ec_node_set_config_t set_config; /* validate/ack a config change */
        ec_node_parse_t parse;
        ec_node_complete_t complete;
index b745fd8fbd007f8d86edafb895751f9afcf2e41f..428f453e5def5fb7845d92573cf2cbc3140110ba 100644 (file)
@@ -428,6 +428,9 @@ static const struct ec_config_schema ec_node_cmd_subschema[] = {
                .desc = "A child node whose id is referenced in the expression.",
                .type = EC_CONFIG_TYPE_NODE,
        },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
+       },
 };
 
 static const struct ec_config_schema ec_node_cmd_schema[] = {
@@ -446,7 +449,9 @@ static const struct ec_config_schema ec_node_cmd_schema[] = {
                .desc = "The list of children nodes.",
                .type = EC_CONFIG_TYPE_LIST,
                .subschema = ec_node_cmd_subschema,
-               .subschema_len = EC_COUNT_OF(ec_node_cmd_subschema),
+       },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
        },
 };
 
@@ -530,7 +535,6 @@ ec_node_cmd_get_child(const struct ec_node *gen_node, size_t i,
 static struct ec_node_type ec_node_cmd_type = {
        .name = "cmd",
        .schema = ec_node_cmd_schema,
-       .schema_len = EC_COUNT_OF(ec_node_cmd_schema),
        .set_config = ec_node_cmd_set_config,
        .parse = ec_node_cmd_parse,
        .complete = ec_node_cmd_complete,
index b42a9126590eab7fd83dfd3dfc1046f2eea5bc40..1b620b77b21f8681da51c9c4d82b5e8dc459af36 100644 (file)
@@ -154,6 +154,9 @@ static const struct ec_config_schema ec_node_int_schema[] = {
                .desc = "The base to use. If unset or 0, try to guess.",
                .type = EC_CONFIG_TYPE_UINT64,
        },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
+       },
 };
 
 static int ec_node_int_set_config(struct ec_node *gen_node,
@@ -201,7 +204,6 @@ fail:
 static struct ec_node_type ec_node_int_type = {
        .name = "int",
        .schema = ec_node_int_schema,
-       .schema_len = EC_COUNT_OF(ec_node_int_schema),
        .set_config = ec_node_int_set_config,
        .parse = ec_node_int_uint_parse,
        .complete = ec_node_complete_unknown,
@@ -265,6 +267,9 @@ static const struct ec_config_schema ec_node_uint_schema[] = {
                .desc = "The base to use. If unset or 0, try to guess.",
                .type = EC_CONFIG_TYPE_UINT64,
        },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
+       },
 };
 
 static int ec_node_uint_set_config(struct ec_node *gen_node,
@@ -312,7 +317,6 @@ fail:
 static struct ec_node_type ec_node_uint_type = {
        .name = "uint",
        .schema = ec_node_uint_schema,
-       .schema_len = EC_COUNT_OF(ec_node_uint_schema),
        .set_config = ec_node_uint_set_config,
        .parse = ec_node_int_uint_parse,
        .complete = ec_node_complete_unknown,
index fa9eaacb11e07531478f8d8291ddca80b23072b0..dc6954d8a963701733042e9161cb96b553b9b1f4 100644 (file)
@@ -171,6 +171,9 @@ 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[] = {
@@ -179,7 +182,9 @@ static const struct ec_config_schema ec_node_seq_schema[] = {
                .desc = "The list of children nodes, to be parsed in sequence.",
                .type = EC_CONFIG_TYPE_LIST,
                .subschema = ec_node_seq_subschema,
-               .subschema_len = EC_COUNT_OF(ec_node_seq_subschema),
+       },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
        },
 };
 
@@ -236,7 +241,6 @@ ec_node_seq_get_child(const struct ec_node *gen_node, size_t i,
 static struct ec_node_type ec_node_seq_type = {
        .name = "seq",
        .schema = ec_node_seq_schema,
-       .schema_len = EC_COUNT_OF(ec_node_seq_schema),
        .set_config = ec_node_seq_set_config,
        .parse = ec_node_seq_parse,
        .complete = ec_node_seq_complete,
index 991f7e0ab2a0b051f22978afc54621030ee5c529..d53ea394222db6c1222a14d59eb06b8e5909870a 100644 (file)
@@ -99,6 +99,9 @@ static const struct ec_config_schema ec_node_str_schema[] = {
                .desc = "The string to match.",
                .type = EC_CONFIG_TYPE_STRING,
        },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
+       },
 };
 
 static int ec_node_str_set_config(struct ec_node *gen_node,
@@ -132,7 +135,6 @@ fail:
 static struct ec_node_type ec_node_str_type = {
        .name = "str",
        .schema = ec_node_str_schema,
-       .schema_len = EC_COUNT_OF(ec_node_str_schema),
        .set_config = ec_node_str_set_config,
        .parse = ec_node_str_parse,
        .complete = ec_node_str_complete,