save some space
[project/uci.git] / uci.h
diff --git a/uci.h b/uci.h
index 96bebf5..e921269 100644 (file)
--- a/uci.h
+++ b/uci.h
  *
  */
 
+#ifdef DEBUG_ALL
+#define UCI_DEBUG
+#define UCI_DEBUG_TYPECAST
+#endif
 
+#include <stdbool.h>
 #include <setjmp.h>
 #include <stdio.h>
 
 #define UCI_CONFDIR "/etc/config"
+#define UCI_SAVEDIR "/tmp/.uci"
+#define UCI_FILEMODE   0600
 
 enum
 {
@@ -38,32 +45,49 @@ enum
        UCI_ERR_NOTFOUND,
        UCI_ERR_IO,
        UCI_ERR_PARSE,
+       UCI_ERR_DUPLICATE,
        UCI_ERR_UNKNOWN,
        UCI_ERR_LAST
 };
 
+struct uci_list;
 struct uci_list
 {
-       void *next;
-       void *prev;
+       struct uci_list *next;
+       struct uci_list *prev;
 };
 
+struct uci_element;
 struct uci_package;
 struct uci_section;
 struct uci_option;
 struct uci_history;
+struct uci_context;
 struct uci_parse_context;
 
 
 /**
- * uci_alloc: Allocate a new uci context
+ * uci_parse_tuple: Parse an uci tuple
+ * @ctx: uci context
+ * @str: input string
+ * @package: output package pointer
+ * @section: output section pointer
+ * @option: output option pointer
+ * @value: output value pointer
+ *
+ * format: <package>[.<section>[.<option>]][=<value>]
  */
-extern struct uci_context *uci_alloc(void);
+extern int uci_parse_tuple(struct uci_context *ctx, char *str, char **package, char **section, char **option, char **value);
 
 /**
- * uci_free: Free the uci context including all of its data
+ * uci_alloc_context: Allocate a new uci context
  */
-extern void uci_free(struct uci_context *ctx);
+extern struct uci_context *uci_alloc_context(void);
+
+/**
+ * uci_free_context: Free the uci context including all of its data
+ */
+extern void uci_free_context(struct uci_context *ctx);
 
 /**
  * uci_perror: Print the last uci error that occured
@@ -78,18 +102,21 @@ extern void uci_perror(struct uci_context *ctx, const char *str);
  * @stream: file stream to import from
  * @name: (optional) assume the config has the given name
  * @package: (optional) store the last parsed config package in this variable
+ * @single: ignore the 'package' keyword and parse everything into a single package
  *
  * the name parameter is for config files that don't explicitly use the 'package <...>' keyword
+ * if 'package' points to a non-null struct pointer, enable history tracking and merge 
  */
-extern int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package);
+extern int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single);
 
 /**
  * uci_export: Export one or all uci config packages
  * @ctx: uci context
  * @stream: output stream
  * @package: (optional) uci config package to export
+ * @header: include the package header
  */
-extern int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package);
+extern int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header);
 
 /**
  * uci_load: Parse an uci config file and store it in the uci context
@@ -104,9 +131,9 @@ extern int uci_load(struct uci_context *ctx, const char *name, struct uci_packag
  * uci_unload: Unload a config file from the uci context
  *
  * @ctx: uci context
- * @name: name of the config file
+ * @package: pointer to the uci_package struct
  */
-extern int uci_unload(struct uci_context *ctx, const char *name);
+extern int uci_unload(struct uci_context *ctx, struct uci_package *p);
 
 /**
  * uci_cleanup: Clean up after an error
@@ -116,17 +143,103 @@ extern int uci_unload(struct uci_context *ctx, const char *name);
 extern int uci_cleanup(struct uci_context *ctx);
 
 /**
+ * uci_lookup: Look up an uci element
+ *
+ * @ctx: uci context
+ * @res: where to store the result
+ * @package: uci_package struct 
+ * @section: config section (optional)
+ * @option: option to search for (optional)
+ *
+ * If section is omitted, then a pointer to the config package is returned
+ * If option is omitted, then a pointer to the config section is returned
+ */
+extern int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *package, char *section, char *option);
+
+/**
+ * uci_set_element_value: Replace an element's value with a new one
+ * @ctx: uci context
+ * @element: pointer to an uci_element struct pointer
+ * @value: new value
+ * 
+ * Only valid for uci_option and uci_section. Will replace the type string
+ * when used with an uci_section
+ */
+extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value);
+
+/**
+ * uci_set: Set an element's value; create the element if necessary
+ * @ctx: uci context
+ * @package: package name
+ * @section: section name
+ * @option: option name
+ * @value: value (option) or type (section)
+ */
+extern int uci_set(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *value);
+
+/**
+ * uci_rename: Rename an element
+ * @ctx: uci context
+ * @package: package name
+ * @section: section name
+ * @option: option name
+ * @name: new name
+ */
+extern int uci_rename(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *name);
+
+/**
+ * uci_delete_element: Delete a section or option
+ * @ctx: uci context
+ * @e: element (section or option)
+ */
+extern int uci_delete_element(struct uci_context *ctx, struct uci_element *e);
+
+/**
+ * uci_delete: Delete a section or option
+ * @ctx: uci context
+ * @p: uci package
+ * @section: section name
+ * @option: option name (optional)
+ */
+extern int uci_delete(struct uci_context *ctx, struct uci_package *p, char *section, char *option);
+
+/**
+ * uci_save: save change history for a package
+ * @ctx: uci context
+ * @p: uci_package struct
+ */
+extern int uci_save(struct uci_context *ctx, struct uci_package *p);
+
+/**
+ * uci_commit: commit changes to a package
+ * @ctx: uci context
+ * @p: uci_package struct pointer
+ * @overwrite: overwrite existing config data and flush history
+ *
+ * committing may reload the whole uci_package data,
+ * the supplied pointer is updated accordingly
+ */
+extern int uci_commit(struct uci_context *ctx, struct uci_package **p, bool overwrite);
+
+/**
  * uci_list_configs: List available uci config files
  *
  * @ctx: uci context
  */
-extern char **uci_list_configs(struct uci_context *ctx);
+extern int uci_list_configs(struct uci_context *ctx, char ***list);
 
 /* UCI data structures */
 enum uci_type {
-       UCI_TYPE_PACKAGE,
-       UCI_TYPE_SECTION,
-       UCI_TYPE_OPTION
+       UCI_TYPE_HISTORY = 0,
+       UCI_TYPE_PACKAGE = 1,
+       UCI_TYPE_SECTION = 2,
+       UCI_TYPE_OPTION = 3
+};
+
+enum uci_flags {
+       UCI_FLAG_STRICT =      (1 << 0), /* strict mode for the parser */
+       UCI_FLAG_PERROR =      (1 << 1), /* print parser error messages */
+       UCI_FLAG_EXPORT_NAME = (1 << 2), /* when exporting, name unnamed sections */
 };
 
 struct uci_element
@@ -144,9 +257,14 @@ struct uci_context
        /* parser context, use for error handling only */
        struct uci_parse_context *pctx;
 
+       /* uci runtime flags */
+       enum uci_flags flags;
+
        /* private: */
        int errno;
+       const char *func;
        jmp_buf trap;
+       bool internal;
        char *buf;
        int bufsz;
 };
@@ -161,6 +279,7 @@ struct uci_parse_context
        /* private: */
        struct uci_package *package;
        struct uci_section *section;
+       bool merge;
        FILE *file;
        const char *name;
        char *buf;
@@ -172,8 +291,12 @@ struct uci_package
        struct uci_element e;
        struct uci_list sections;
        struct uci_context *ctx;
+       bool confdir;
+       char *path;
+
        /* private: */
        int n_section;
+       struct uci_list history;
 };
 
 struct uci_section
@@ -181,6 +304,7 @@ struct uci_section
        struct uci_element e;
        struct uci_list options;
        struct uci_package *package;
+       bool anonymous;
        char *type;
 };
 
@@ -194,19 +318,16 @@ struct uci_option
 enum uci_command {
        UCI_CMD_ADD,
        UCI_CMD_REMOVE,
-       UCI_CMD_CHANGE
+       UCI_CMD_CHANGE,
+       UCI_CMD_RENAME
 };
 
 struct uci_history
 {
-       struct uci_list list;
+       struct uci_element e;
        enum uci_command cmd;
-       union {
-               struct uci_element element;
-               struct uci_package package;
-               struct uci_section section;
-               struct uci_option option;
-       } data;
+       char *section;
+       char *value;
 };
 
 /* linked list handling */
@@ -267,36 +388,48 @@ struct uci_history
                &_ptr->list != (_list);                 \
                _ptr = _tmp, _tmp = list_to_element(_ptr->list.next))
 
-/* returns true if a list is empty */
+/**
+ * uci_list_empty: returns true if a list is empty
+ * @list: list head
+ */
 #define uci_list_empty(list) ((list)->next == (list))
 
+/* wrappers for dynamic type handling */
+#define uci_type_history UCI_TYPE_HISTORY
+#define uci_type_package UCI_TYPE_PACKAGE
+#define uci_type_section UCI_TYPE_SECTION
+#define uci_type_option UCI_TYPE_OPTION
+
 /* element typecasting */
 #ifdef UCI_DEBUG_TYPECAST
 static const char *uci_typestr[] = {
-       [UCI_TYPE_PACKAGE] = "package",
-       [UCI_TYPE_SECTION] = "section",
-       [UCI_TYPE_OPTION] = "option"
-}
+       [uci_type_history] = "history",
+       [uci_type_package] = "package",
+       [uci_type_section] = "section",
+       [uci_type_option] = "option",
+};
 
 static void uci_typecast_error(int from, int to)
 {
        fprintf(stderr, "Invalid typecast from '%s' to '%s'\n", uci_typestr[from], uci_typestr[to]);
 }
 
-#define BUILD_CAST(type, val) \
-       static inline struct uci_ ## type *uci_to_ ## type (struct uci_element *e) \
+#define BUILD_CAST(_type) \
+       static inline struct uci_ ## _type *uci_to_ ## _type (struct uci_element *e) \
        { \
-               if (e->type != val) { \
-                       uci_typecast_error(e->type, val); \
+               if (e->type != uci_type_ ## _type) { \
+                       uci_typecast_error(e->type, uci_type_ ## _type); \
                } \
-               return (struct uci_ ## type *) e; \
+               return (struct uci_ ## _type *) e; \
        }
 
-BUILD_CAST(package, UCI_TYPE_PACKAGE)
-BUILD_CAST(section, UCI_TYPE_SECTION)
-BUILD_CAST(option,  UCI_TYPE_OPTION)
+BUILD_CAST(history)
+BUILD_CAST(package)
+BUILD_CAST(section)
+BUILD_CAST(option)
 
 #else
+#define uci_to_history(ptr) container_of(ptr, struct uci_history, e)
 #define uci_to_package(ptr) container_of(ptr, struct uci_package, e)
 #define uci_to_section(ptr) container_of(ptr, struct uci_section, e)
 #define uci_to_option(ptr)  container_of(ptr, struct uci_option, e)
@@ -310,7 +443,7 @@ BUILD_CAST(option,  UCI_TYPE_OPTION)
  * @datasize: additional buffer size to reserve at the end of the struct
  */
 #define uci_alloc_element(ctx, type, name, datasize) \
-       uci_to_ ## type (uci_alloc_generic(ctx, name, sizeof(struct uci_ ## type) + datasize))
+       uci_to_ ## type (uci_alloc_generic(ctx, uci_type_ ## type, name, sizeof(struct uci_ ## type) + datasize))
 
 #define uci_dataptr(ptr) \
        (((char *) ptr) + sizeof(*ptr))