configparser: rename BOOL, document types
authorPekka Paalanen <ppaalanen@gmail.com>
Thu, 8 Dec 2011 07:24:24 +0000 (09:24 +0200)
committerPekka Paalanen <ppaalanen@gmail.com>
Thu, 8 Dec 2011 08:25:54 +0000 (10:25 +0200)
Rename CONFIG_KEY_BOOL to CONFIG_KEY_BOOLEAN, just like
CONFIG_KEY_INTEGER is not CONFIG_KEY_INT, for consistency.

Document the types expected for the void* and name the enum in the
header, so it is clear what config_key::type means.

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
shared/configparser.c
shared/configparser.h

index c48fe4c..3deb89d 100644 (file)
@@ -53,7 +53,7 @@ handle_key(const struct config_key *key, const char *value)
                *(char **)key->data = s;
                return 0;
 
-       case CONFIG_KEY_BOOL:
+       case CONFIG_KEY_BOOLEAN:
                if (strcmp(value, "false\n") == 0)
                        *(int *)key->data = 0;
                else if (strcmp(value, "true\n") == 0)
index 93b335c..34f5c31 100644 (file)
 #ifndef CONFIGPARSER_H
 #define CONFIGPARSER_H
 
-enum {
-       CONFIG_KEY_INTEGER,
-       CONFIG_KEY_STRING,
-       CONFIG_KEY_BOOL
+enum config_key_type {
+       CONFIG_KEY_INTEGER,     /* typeof data = int */
+       CONFIG_KEY_STRING,      /* typeof data = char* */
+       CONFIG_KEY_BOOLEAN      /* typeof data = int */
 };
 
 struct config_key {
        const char *name;
-       int type;
+       enum config_key_type type;
        void *data;
 };