Comments, FIXMEs, name changes.

diff --git a/WHATS_NEW_DM b/WHATS_NEW_DM
index 91ca84ac15518ce61857bfaf89d2d4102a1e44ad..b05f4f0eb1ba454a174ba017735b726e9a9dc5a9 100644 (file)
--- a/WHATS_NEW_DM
+++ b/WHATS_NEW_DM
@@ -1,5 +1,6 @@
 Version 1.02.68 -
 ==================================
+  Add dm_config and string character escaping functions to libdevmapper.
   Mark unreleased memory pools as internal error.
 
 Version 1.02.67 - 19th August 2011

diff --git a/lib/config/config.c b/lib/config/config.c
index 5a7190c3fab105d13f0f8157db7808ec0fe3c89b..340b4b5436f9e6c811d0acb5cbb2bf58c5e80abb 100644 (file)
--- a/lib/config/config.c
+++ b/lib/config/config.c
@@ -120,7 +120,7 @@ int read_config_file(struct dm_config_tree *cft)
        int r;
 
        if (!dm_config_check_file(cft, &filename, &info))
-               return 0;
+               return_0;
 
        if (!dev) {
                if (!(dev = dev_create_file(filename, NULL, NULL, 1)))
@@ -142,16 +142,17 @@ int read_config_file(struct dm_config_tree *cft)
        return r;
 }
 
+// FIXME AGK Move to override_config_tree_from_string before next release
 static struct dm_config_tree *_setup_context_tree(struct cmd_context *cmd)
 {
-       struct dm_config_tree *r = cmd->cft_override;
+       struct dm_config_tree *cft = cmd->cft_override;
 
-       if (r)
-               r->cascade = cmd->cft;
+       if (cft)
+               cft->cascade = cmd->cft;
        else
-               r = cmd->cft;
+               cft = cmd->cft;
 
-       return r;
+       return cft;
 }
 
 const struct dm_config_node *find_config_tree_node(struct cmd_context *cmd,

diff --git a/libdm/libdevmapper.h b/libdm/libdevmapper.h
index 71b4caa11e5fd5d1c2b8d843c5ada2b1373f1519..6dbf1102eaa250a4a9c6ebe95421790ff42e5076 100644 (file)
--- a/libdm/libdevmapper.h
+++ b/libdm/libdevmapper.h
@@ -1016,10 +1016,7 @@ int dm_snprintf(char *buf, size_t bufsize, const char *format, ...)
 const char *dm_basename(const char *path);
 
 /*
- * Count occurences of 'c' in 'str' of length 'size'.
- *
- * Returns:
- *   Number of occurrences of 'c'
+ * Returns number of occurrences of 'c' in 'str' of length 'size'.
  */
 unsigned dm_count_chars(const char *str, size_t len, const int c);
 
@@ -1223,9 +1220,10 @@ void dm_report_field_set_value(struct dm_report_field *field, const void *value,
                               const void *sortvalue);
 
 
-/*********************************
- * config file parse/prettyprint
- *********************************/
+/*************************
+ * config file parse/print
+ *************************/
+// FIXME AGK Review this interface before inclusion in a release.
 enum {
        DM_CFG_STRING,
        DM_CFG_FLOAT,
@@ -1237,10 +1235,11 @@ struct dm_config_value {
        int type;
        union {
                int64_t i;
-               float r;
+               float f;
+               double d;       /* For completeness.  (Unused.) */
                const char *str;
        } v;
-       struct dm_config_value *next;   /* for arrays */
+       struct dm_config_value *next;   /* For arrays */
 };
 
 struct dm_config_node {
@@ -1281,8 +1280,7 @@ const char *dm_config_find_str(const struct dm_config_node *cn, const char *path
 int dm_config_find_int(const struct dm_config_node *cn, const char *path, int fail);
 float dm_config_find_float(const struct dm_config_node *cn, const char *path, float fail);
 
-const struct dm_config_node *dm_config_tree_find_node(
-       const struct dm_config_tree *cft, const char *path);
+const struct dm_config_node *dm_config_tree_find_node(const struct dm_config_tree *cft, const char *path);
 const char *dm_config_tree_find_str(const struct dm_config_tree *cft,
                                    const char *path, const char *fail);
 int dm_config_tree_find_int(const struct dm_config_tree *cft,

diff --git a/libdm/libdm-config.c b/libdm/libdm-config.c
index 7b06ca915255b5843ca5125bef7ca0b984ceff74..af1aec18af0644cce8acde7efee56d61ec694ae7 100644 (file)
--- a/libdm/libdm-config.c
+++ b/libdm/libdm-config.c
@@ -57,7 +57,7 @@ struct cs {
        off_t st_size;
        char *filename;
        int exists;
-       int keep_open;
+       int keep_open; // FIXME AGK Remove this before release
        void *custom; /* LVM uses this for a device pointer */
 };
 
@@ -135,18 +135,21 @@ struct dm_config_tree *dm_config_create(const char *filename, int keep_open)
 void dm_config_set_custom(struct dm_config_tree *cft, void *custom)
 {
        struct cs *c = (struct cs *) cft;
+
        c->custom = custom;
 }
 
 void *dm_config_get_custom(struct dm_config_tree *cft)
 {
        struct cs *c = (struct cs *) cft;
+
        return c->custom;
 }
 
 int dm_config_keep_open(struct dm_config_tree *cft)
 {
        struct cs *c = (struct cs *) cft;
+
        return c->keep_open;
 }
 
@@ -228,6 +231,7 @@ int dm_config_check_file(struct dm_config_tree *cft, const char **filename, stru
 time_t dm_config_timestamp(struct dm_config_tree *cft)
 {
        struct cs *c = (struct cs *) cft;
+
        return c->timestamp;
 }
 
@@ -345,7 +349,7 @@ static int _write_value(struct output_line *outline, const struct dm_config_valu
                break;
 
        case DM_CFG_FLOAT:
-               line_append("%f", v->v.r);
+               line_append("%f", v->v.f);
                break;
 
        case DM_CFG_INT:
@@ -442,6 +446,7 @@ int dm_config_write(struct dm_config_tree *cft, const char *file,
        outline.fp = NULL;
        outline.putline = NULL;
 
+// FIXME AGK remove the fopen from libdm before release
        if (!file)
                file = "stdout";
        else if (!(outline.fp = fopen(file, "w"))) {
@@ -593,7 +598,7 @@ static struct dm_config_value *_type(struct parser *p)
 
        case TOK_FLOAT:
                v->type = DM_CFG_FLOAT;
-               v->v.r = strtod(p->tb, NULL);   /* FIXME: check error */
+               v->v.f = strtod(p->tb, NULL);   /* FIXME: check error */
                match(TOK_FLOAT);
                break;
 
@@ -807,8 +812,19 @@ static char *_dup_tok(struct parser *p)
 }
 
 /*
- * utility functions
+ * Utility functions
+ */
+
+/*
+ * node_lookup_fn is either:
+ *   _find_config_node to perform a lookup starting from a given config_node 
+ *   in a config_tree;
+ * or
+ *   _find_first_config_node to find the first config_node in a set of 
+ *   cascaded trees.
  */
+typedef const struct dm_config_node *node_lookup_fn(const void *start, const char *path);
+
 static const struct dm_config_node *_find_config_node(const void *start,
                                                      const char *path)
 {
@@ -851,8 +867,6 @@ static const struct dm_config_node *_find_config_node(const void *start,
        return cn_found;
 }
 
-typedef const struct dm_config_node *_node_lookup_fn(const void *start, const char *path);
-
 static const struct dm_config_node *_find_first_config_node(const void *start, const char *path)
 {
        const struct dm_config_tree *cft = start;
@@ -867,10 +881,10 @@ static const struct dm_config_node *_find_first_config_node(const void *start, c
        return NULL;
 }
 
-static const char *_find_config_str(const void *start, _node_lookup_fn find,
+static const char *_find_config_str(const void *start, node_lookup_fn find_fn,
                                    const char *path, const char *fail)
 {
-       const struct dm_config_node *n = find(start, path);
+       const struct dm_config_node *n = find_fn(start, path);
 
        /* Empty strings are ignored */
        if ((n && n->v && n->v->type == DM_CFG_STRING) && (*n->v->v.str)) {
@@ -890,7 +904,7 @@ const char *dm_config_find_str(const struct dm_config_node *cn,
        return _find_config_str(cn, _find_config_node, path, fail);
 }
 
-static int64_t _find_config_int64(const void *start, _node_lookup_fn find,
+static int64_t _find_config_int64(const void *start, node_lookup_fn find,
                                  const char *path, int64_t fail)
 {
        const struct dm_config_node *n = find(start, path);
@@ -905,14 +919,14 @@ static int64_t _find_config_int64(const void *start, _node_lookup_fn find,
        return fail;
 }
 
-static float _find_config_float(const void *start, _node_lookup_fn find,
+static float _find_config_float(const void *start, node_lookup_fn find,
                                const char *path, float fail)
 {
        const struct dm_config_node *n = find(start, path);
 
        if (n && n->v && n->v->type == DM_CFG_FLOAT) {
-               log_very_verbose("Setting %s to %f", path, n->v->v.r);
-               return n->v->v.r;
+               log_very_verbose("Setting %s to %f", path, n->v->v.f);
+               return n->v->v.f;
        }
 
        log_very_verbose("%s not found in config: defaulting to %f",
@@ -947,7 +961,7 @@ static int _str_to_bool(const char *str, int fail)
        return fail;
 }
 
-static int _find_config_bool(const void *start, _node_lookup_fn find,
+static int _find_config_bool(const void *start, node_lookup_fn find,
                             const char *path, int fail)
 {
        const struct dm_config_node *n = find(start, path);