for (i = 0; i < schema_len; i++) {
if (schema[i].key == NULL) {
errno = EINVAL;
- EC_LOG(EC_LOG_ERR, "dict schema key should not be NULL\n");
+ EC_LOG(EC_LOG_ERR,
+ "dict schema key should not be NULL\n");
return -1;
}
}
size_t i;
for (i = 0; i < schema_len; i++) {
- fprintf(out, "%*s" "%s%s(%s): %s\n",
+ fprintf(out, "%*s" "%s%s%stype=%s desc='%s'\n",
(int)indent * 4, "",
+ schema[i].key ? "key=": "",
schema[i].key ? : "",
schema[i].key ? " ": "",
ec_config_type_str(schema[i].type),
return NULL;
}
+static int
+ec_config_set_schema(struct ec_config *dict,
+ const struct ec_config_schema *schema,
+ size_t schema_len)
+{
+ if (dict->type != EC_CONFIG_TYPE_DICT) {
+ errno = EINVAL;
+ goto fail;
+ }
+
+ if (ec_config_schema_validate(schema, schema_len) < 0)
+ goto fail;
+
+ dict->schema = schema;
+ dict->schema_len = schema_len;
+
+ return 0;
+
+fail:
+ return -1;
+}
+
struct ec_config *
-ec_config_dict(void)
+ec_config_dict(const struct ec_config_schema *schema,
+ size_t schema_len)
{
struct ec_config *value = NULL;
struct ec_keyval *dict = NULL;
value->type = EC_CONFIG_TYPE_DICT;
value->dict = dict;
+ if (ec_config_set_schema(value, schema, schema_len) < 0)
+ goto fail;
+
return value;
fail:
return value;
}
-int
-ec_config_set_schema(struct ec_config *dict,
- const struct ec_config_schema *schema,
- size_t schema_len)
-{
- if (dict->type != EC_CONFIG_TYPE_DICT) {
- errno = EINVAL;
- goto fail;
- }
-
- if (ec_config_schema_validate(schema, schema_len) < 0)
- goto fail;
-
- dict->schema = schema;
- dict->schema_len = schema_len;
-
- return 0;
-
-fail:
- return -1;
-}
-
-const struct ec_config_schema *
+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)
return -1;
}
-
-const struct ec_config *
-ec_config_get(const struct ec_config *config, const char *key)
+struct ec_config *
+ec_config_get(struct ec_config *config, const char *key)
{
if (config == NULL)
return NULL;
return ec_keyval_get(config->dict, key);
}
+struct ec_config *
+ec_config_list_first(struct ec_config *list)
+{
+ if (list == NULL || list->type != EC_CONFIG_TYPE_LIST) {
+ errno = EINVAL;
+ return NULL;
+ }
+
+ return TAILQ_FIRST(&list->list);
+}
+
+struct ec_config *
+ec_config_list_next(struct ec_config *list, struct ec_config *config)
+{
+ (void)list;
+ return TAILQ_NEXT(config, next);
+}
+
/* value is consumed */
int ec_config_set(struct ec_config *config, const char *key,
struct ec_config *value)
return -1;
}
+void ec_config_del(struct ec_config *list, struct ec_config *config)
+{
+ TAILQ_REMOVE(&list->list, config, next);
+ ec_config_free(config);
+}
static int
ec_config_list_dump(FILE *out, const struct ec_config_list *list,
}
/* LCOV_EXCL_START */
-static const struct ec_config_schema intlist_elt[] = {
+static const struct ec_config_schema sch_intlist_elt[] = {
{
.desc = "This is a description for int",
.type = EC_CONFIG_TYPE_INT64,
},
};
-static const struct ec_config_schema dict[] = {
+static const struct ec_config_schema sch_dict[] = {
{
- .key = "int",
+ .key = "my_int",
.desc = "This is a description for int",
.type = EC_CONFIG_TYPE_INT64,
},
{
- .key = "int2",
+ .key = "my_int2",
.desc = "This is a description for int2",
.type = EC_CONFIG_TYPE_INT64,
},
};
-static const struct ec_config_schema dictlist_elt[] = {
+static const struct ec_config_schema sch_dictlist_elt[] = {
{
.desc = "This is a description for dict",
.type = EC_CONFIG_TYPE_DICT,
- .subschema = dict,
- .subschema_len = EC_COUNT_OF(dict),
+ .subschema = sch_dict,
+ .subschema_len = EC_COUNT_OF(sch_dict),
},
};
-static const struct ec_config_schema baseconfig[] = {
+static const struct ec_config_schema sch_baseconfig[] = {
{
- .key = "bool",
+ .key = "my_bool",
.desc = "This is a description for bool",
.type = EC_CONFIG_TYPE_BOOL,
},
{
- .key = "int",
+ .key = "my_int",
.desc = "This is a description for int",
.type = EC_CONFIG_TYPE_INT64,
},
{
- .key = "string",
+ .key = "my_string",
.desc = "This is a description for string",
.type = EC_CONFIG_TYPE_STRING,
},
{
- .key = "node",
+ .key = "my_node",
.desc = "This is a description for node",
.type = EC_CONFIG_TYPE_NODE,
},
{
- .key = "intlist",
+ .key = "my_intlist",
.desc = "This is a description for list",
.type = EC_CONFIG_TYPE_LIST,
- .subschema = intlist_elt,
- .subschema_len = EC_COUNT_OF(intlist_elt),
+ .subschema = sch_intlist_elt,
+ .subschema_len = EC_COUNT_OF(sch_intlist_elt),
},
{
- .key = "dictlist",
+ .key = "my_dictlist",
.desc = "This is a description for list",
.type = EC_CONFIG_TYPE_LIST,
- .subschema = dictlist_elt,
- .subschema_len = EC_COUNT_OF(dictlist_elt),
+ .subschema = sch_dictlist_elt,
+ .subschema_len = EC_COUNT_OF(sch_dictlist_elt),
},
};
struct ec_keyval *dict = NULL;
const struct ec_config *value = NULL;
struct ec_config *config = NULL, *list = NULL, *subconfig = NULL;
- //const struct ec_config *pvalue;
+ struct ec_config *list_, *config_;
int testres = 0;
int ret;
if (node == NULL)
goto fail;
- if (ec_config_schema_validate(baseconfig,
- EC_COUNT_OF(baseconfig)) < 0) {
+ if (ec_config_schema_validate(sch_baseconfig,
+ EC_COUNT_OF(sch_baseconfig)) < 0) {
EC_LOG(EC_LOG_ERR, "invalid config schema\n");
goto fail;
}
- ec_config_schema_dump(stdout, baseconfig, EC_COUNT_OF(baseconfig));
+ ec_config_schema_dump(stdout, sch_baseconfig,
+ EC_COUNT_OF(sch_baseconfig));
- config = ec_config_dict();
+ config = ec_config_dict(sch_baseconfig, EC_COUNT_OF(sch_baseconfig));
if (config == NULL)
goto fail;
- if (ec_config_set_schema(config, baseconfig,
- EC_COUNT_OF(baseconfig)) < 0)
- goto fail;
- ret = ec_config_set(config, "bool", ec_config_bool(true));
+ ret = ec_config_set(config, "my_bool", ec_config_bool(true));
testres |= EC_TEST_CHECK(ret == 0, "cannot set boolean");
- value = ec_config_get(config, "bool");
+ value = ec_config_get(config, "my_bool");
testres |= EC_TEST_CHECK(
value != NULL &&
value->type == EC_CONFIG_TYPE_BOOL &&
value->boolean == true,
"unexpected boolean value");
- ret = ec_config_set(config, "int", ec_config_i64(1234));
+ ret = ec_config_set(config, "my_int", ec_config_i64(1234));
testres |= EC_TEST_CHECK(ret == 0, "cannot set int");
- value = ec_config_get(config, "int");
+ value = ec_config_get(config, "my_int");
testres |= EC_TEST_CHECK(
value != NULL &&
value->type == EC_CONFIG_TYPE_INT64 &&
ec_config_validate(config) == 0,
"cannot validate config\n");
- ret = ec_config_set(config, "string", ec_config_string("toto"));
+ ret = ec_config_set(config, "my_string", ec_config_string("toto"));
testres |= EC_TEST_CHECK(ret == 0, "cannot set string");
- value = ec_config_get(config, "string");
+ value = ec_config_get(config, "my_string");
testres |= EC_TEST_CHECK(
value != NULL &&
value->type == EC_CONFIG_TYPE_STRING &&
if (list == NULL)
goto fail;
- subconfig = ec_config_dict();
+ subconfig = ec_config_dict(sch_dict, EC_COUNT_OF(sch_dict));
if (subconfig == NULL)
goto fail;
- ret = ec_config_set(subconfig, "int", ec_config_i64(1));
+ ret = ec_config_set(subconfig, "my_int", ec_config_i64(1));
testres |= EC_TEST_CHECK(ret == 0, "cannot set int");
- value = ec_config_get(subconfig, "int");
+ value = ec_config_get(subconfig, "my_int");
testres |= EC_TEST_CHECK(
value != NULL &&
value->type == EC_CONFIG_TYPE_INT64 &&
value->i64 == 1,
"unexpected int value");
- ret = ec_config_set(subconfig, "int2", ec_config_i64(2));
+ ret = ec_config_set(subconfig, "my_int2", ec_config_i64(2));
testres |= EC_TEST_CHECK(ret == 0, "cannot set int");
- value = ec_config_get(subconfig, "int2");
+ value = ec_config_get(subconfig, "my_int2");
testres |= EC_TEST_CHECK(
value != NULL &&
value->type == EC_CONFIG_TYPE_INT64 &&
value->i64 == 2,
"unexpected int value");
+ testres |= EC_TEST_CHECK(
+ ec_config_validate(subconfig) == 0,
+ "cannot validate subconfig\n");
+
ret = ec_config_add(list, subconfig);
subconfig = NULL; /* freed */
testres |= EC_TEST_CHECK(ret == 0, "cannot add in list");
- subconfig = ec_config_dict();
+ subconfig = ec_config_dict(sch_dict, EC_COUNT_OF(sch_dict));
if (subconfig == NULL)
goto fail;
- ret = ec_config_set(subconfig, "int", ec_config_i64(3));
+ ret = ec_config_set(subconfig, "my_int", ec_config_i64(3));
testres |= EC_TEST_CHECK(ret == 0, "cannot set int");
- value = ec_config_get(subconfig, "int");
+ value = ec_config_get(subconfig, "my_int");
testres |= EC_TEST_CHECK(
value != NULL &&
value->type == EC_CONFIG_TYPE_INT64 &&
value->i64 == 3,
"unexpected int value");
- ret = ec_config_set(subconfig, "int2", ec_config_i64(4));
+ ret = ec_config_set(subconfig, "my_int2", ec_config_i64(4));
testres |= EC_TEST_CHECK(ret == 0, "cannot set int");
- value = ec_config_get(subconfig, "int2");
+ value = ec_config_get(subconfig, "my_int2");
testres |= EC_TEST_CHECK(
value != NULL &&
value->type == EC_CONFIG_TYPE_INT64 &&
value->i64 == 4,
"unexpected int value");
+ testres |= EC_TEST_CHECK(
+ ec_config_validate(subconfig) == 0,
+ "cannot validate subconfig\n");
+
ret = ec_config_add(list, subconfig);
subconfig = NULL; /* freed */
testres |= EC_TEST_CHECK(ret == 0, "cannot add in list");
- ret = ec_config_set(config, "dictlist", list);
+ ret = ec_config_set(config, "my_dictlist", list);
list = NULL;
testres |= EC_TEST_CHECK(ret == 0, "cannot set list");
ec_config_validate(config) == 0,
"cannot validate config\n");
-#if 0
- /* api */
- config = ec_config(schema);
- value = ec_config_bool(true);
- ec_config_set(config, "key", value);
- value = ec_config_get(config, "key");
- /* check value->type and value->bool */
-
- value = ec_config_string("xxx");
- ec_config_set(config, "key", value);
- value = ec_config_get(config, "key");
- /* check value->type and value->string */
+ list_ = ec_config_get(config, "my_dictlist");
+ printf("list = %p\n", list_);
+ for (config_ = ec_config_list_first(list_); config_ != NULL;
+ config_ = ec_config_list_next(list_, config_)) {
+ ec_config_dump(stdout, config_);
+ }
- list = ec_config_list();
- value = ec_config_string("xxx");
- ec_config_add(list, value);
- value = ec_config_string("yyy");
- ec_config_add(list, value);
- value = ec_config_remove(list, 0);
- ec_config_set(config, "key", list);
+ ec_config_dump(stdout, config);
-#endif
+ /* remove the first element */
+ ec_config_del(list_, ec_config_list_first(list_));
+ testres |= EC_TEST_CHECK(
+ ec_config_validate(config) == 0,
+ "cannot validate config\n");
#if 0
value.type = EC_CONFIG_TYPE_NODE;
TAILQ_HEAD(ec_config_list, ec_config);
/**
- * Structure storing data.
+ * Structure storing the configuration data.
*/
struct ec_config {
/** type of value stored in the union */
enum ec_config_type type;
union {
- bool boolean;
- int64_t i64;
- uint64_t u64;
- char *string;
- struct ec_node *node;
- struct ec_keyval *dict;
- struct ec_config_list list;
+ bool boolean; /** Boolean value */
+ int64_t i64; /** Signed integer value */
+ uint64_t u64; /** Unsigned integer value */
+ char *string; /** String value */
+ struct ec_node *node; /** Node value */
+ struct ec_keyval *dict; /** Hash table value */
+ struct ec_config_list list; /** List value */
};
/**
- * Valid if type is list.
+ * Next in list, only valid if type is list.
*/
TAILQ_ENTRY(ec_config) next;
- /** Associated schema. Can be set if type is dict. */
+ /** Associated schema. Only valid if type is dict. */
const struct ec_config_schema *schema;
size_t schema_len; /**< Schema length. */
};
/* schema */
+/**
+ * Validate a configuration schema array.
+ *
+ * @param schema
+ * Pointer to the first element of the schema array.
+ * @param schema_len
+ * Length of the schema array.
+ * @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);
+/**
+ * Dump a configuration schema array.
+ *
+ * @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.
+ */
void ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema,
size_t schema_len);
/* config */
+/**
+ * Create a boolean configuration value.
+ *
+ * @param boolean
+ * The boolean value to be set.
+ * @return
+ * The configuration object, or NULL on error (errno is set).
+ */
struct ec_config *ec_config_bool(bool boolean);
+
+/**
+ * Create a signed integer configuration value.
+ *
+ * @param i64
+ * The signed integer value to be set.
+ * @return
+ * The configuration object, or NULL on error (errno is set).
+ */
struct ec_config *ec_config_i64(int64_t i64);
+
+/**
+ * Create an unsigned configuration value.
+ *
+ * @param u64
+ * The unsigned integer value to be set.
+ * @return
+ * The configuration object, or NULL on error (errno is set).
+ */
struct ec_config *ec_config_u64(uint64_t u64);
-/* duplicate string */
+
+/**
+ * Create a string configuration value.
+ *
+ * @param string
+ * The string value to be set. The string is copied into the
+ * configuration object.
+ * @return
+ * The configuration object, or NULL on error (errno is set).
+ */
struct ec_config *ec_config_string(const char *string);
-/* "consume" the node */
+
+/**
+ * Create a node configuration value.
+ *
+ * @param node
+ * The node pointer to be set. The node is "consumed" by
+ * the function and should not be used by the caller, even
+ * on error. The caller can use ec_node_clone() to keep a
+ * reference on the node.
+ * @return
+ * The configuration object, or NULL on error (errno is set).
+ */
struct ec_config *ec_config_node(struct ec_node *node);
-/* "consume" the dict */
-struct ec_config *ec_config_dict(void);
+
+/**
+ * Create a hash table configuration value.
+ *
+ * @param schema
+ * Optional pointer to the first element of the schema array. Set
+ * it to NULL if no schema should be attached.
+ * @param schema_len
+ * Length of the schema array. Set to 0 if no schema.
+ * @return
+ * The configuration object containing an empty hash table, or NULL on
+ * error (errno is set).
+ */
+struct ec_config *ec_config_dict(const struct ec_config_schema *schema,
+ size_t schema_len);
+
+/**
+ * Create a list configuration value.
+ *
+ * @return
+ * The configuration object containing an empty list, or NULL on
+ * error (errno is set).
+ */
struct ec_config *ec_config_list(void);
+/**
+ * Add a config object into a list.
+ *
+ * @param list
+ * The list configuration in which the value will be added.
+ * @param value
+ * The value configuration to add in the list. The value object
+ * will be freed when freeing the list object. On error, the
+ * value object is freed.
+ * @return
+ * 0 on success, else -1 (errno is set).
+ */
int ec_config_add(struct ec_config *list, struct ec_config *value);
-int ec_config_set_schema(struct ec_config *dict,
- const struct ec_config_schema *schema,
- size_t schema_len);
-
void ec_config_free(struct ec_config *config);
int ec_config_validate(const struct ec_config *dict);
/**
* Get configuration value.
*/
-const struct ec_config *ec_config_get(const struct ec_config *config,
+struct ec_config *ec_config_get(struct ec_config *config,
const char *key);
-/* */
+/**
+ * Get the first element of a list.
+ *
+ * Example of use:
+ * for (config = ec_config_list_iter(list);
+ * config != NULL;
+ * config = ec_config_list_next(list, config)) {
+ * ...
+ * }
+ *
+ * @param list
+ * The list configuration to iterate.
+ * @return
+ * The first configuration element, or NULL on error (errno is set).
+ */
+struct ec_config *ec_config_list_first(struct ec_config *list);
-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);
+/**
+ * Get next element in list.
+ *
+ * @param list
+ * The list configuration beeing iterated.
+ * @param config
+ * The current configuration element.
+ * @return
+ * The next configuration element, or NULL if there is no more element.
+ */
+struct ec_config *
+ec_config_list_next(struct ec_config *list, struct ec_config *config);
-void ec_config_free(struct ec_config *value);
+/**
+ * Remove an element from a list.
+ *
+ * The element is freed and should not be accessed.
+ *
+ * @param list
+ * The list configuration.
+ * @param config
+ * The element to remove from the list.
+ */
+void ec_config_del(struct ec_config *list, struct ec_config *config);
+
+/**
+ * Free a configuration.
+ *
+ * @param config
+ * The element to free.
+ */
+void ec_config_free(struct ec_config *config);
+/**
+ * Compare two configurations.
+ *
+ * @return
+ * 0 if the configurations are equal, else -1.
+ */
int ec_config_cmp(const struct ec_config *value1,
const struct ec_config *value2);
-char *ec_config_str(const struct ec_config *value);
-
+/**
+ * Dump a configuration.
+ *
+ * @param out
+ * Output stream on which the dump will be sent.
+ * @param config
+ * The configuration to dump.
+ */
void ec_config_dump(FILE *out, const struct ec_config *config);
#endif
git.droids-corp.org / protos / libecoli.git / commitdiff