move export functionality to libuci
[project/uci.git] / uci.h
diff --git a/uci.h b/uci.h
index d18095d..a34a36b 100644 (file)
--- a/uci.h
+++ b/uci.h
@@ -50,6 +50,11 @@ struct uci_parse_context;
 extern struct uci_context *uci_alloc(void);
 
 /**
+ * uci_free: Free the uci context including all of its data
+ */
+extern void uci_free(struct uci_context *ctx);
+
+/**
  * uci_perror: Print the last uci error that occured
  * @ctx: uci context
  * @str: string to print before the error message
@@ -57,45 +62,84 @@ extern struct uci_context *uci_alloc(void);
 extern void uci_perror(struct uci_context *ctx, const char *str);
 
 /**
+ * uci_import: Import uci config data from a stream
+ * @ctx: uci context
+ * @stream: file stream to import from
+ * @name: (optional) assume the config has the given name
+ * @cfg: (optional) store the last parsed config package in this variable
+ *
+ * the name parameter is for config files that don't explicitly use the 'package <...>' keyword
+ */
+extern int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_config **cfg);
+
+/**
+ * uci_export: Export one or all uci config packages
+ * @ctx: uci context
+ * @stream: output stream
+ * @cfg: (optional) uci config package to export
+ */
+extern int uci_export(struct uci_context *ctx, FILE *stream, struct uci_config *cfg);
+
+/**
  * uci_load: Parse an uci config file and store it in the uci context
  *
  * @ctx: uci context
  * @name: name of the config file (relative to the config directory)
  */
-int uci_load(struct uci_context *ctx, const char *name);
+extern int uci_load(struct uci_context *ctx, const char *name, struct uci_config **cfg);
+
+/**
+ * uci_unload: Unload a config file from the uci context
+ *
+ * @ctx: uci context
+ * @name: name of the config file
+ */
+extern int uci_unload(struct uci_context *ctx, const char *name);
 
 /**
  * uci_cleanup: Clean up after an error
  *
  * @ctx: uci context
  */
-int uci_cleanup(struct uci_context *ctx);
+extern int uci_cleanup(struct uci_context *ctx);
 
+/**
+ * uci_list_configs: List available uci config files
+ *
+ * @ctx: uci context
+ */
+extern char **uci_list_configs();
 
 /* UCI data structures */
 
 struct uci_context
 {
+       /* list of config packages */
        struct uci_list root;
 
-       /* for error handling only */
+       /* parser context, use for error handling only */
        struct uci_parse_context *pctx;
 
        /* private: */
        int errno;
        jmp_buf trap;
+       char *buf;
+       int bufsz;
 };
 
 struct uci_parse_context
 {
+       /* error context */
+       const char *reason;
        int line;
        int byte;
 
        /* private: */
        struct uci_config *cfg;
+       struct uci_section *section;
        FILE *file;
+       const char *name;
        char *buf;
-       char *reason;
        int bufsz;
 };
 
@@ -105,6 +149,8 @@ struct uci_config
        struct uci_list sections;
        struct uci_context *ctx;
        char *name;
+       /* private: */
+       int n_section;
 };
 
 struct uci_section
@@ -129,10 +175,28 @@ struct uci_option
 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
 #endif
 
-#define uci_list_empty(list) (list->next == ptr)
+/* returns true if a list is empty */
+#define uci_list_empty(list) ((list)->next == (list))
+
+/**
+ * uci_list_entry: casts an uci_list pointer to the containing struct.
+ * @_type: config, section or option
+ * @_ptr: pointer to the uci_list struct
+ */
 #define uci_list_entry(_type, _ptr) \
        ((struct uci_ ## _type *) ((char *)(_ptr) - offsetof(struct uci_ ## _type,list)))
 
+/**
+ * uci_foreach_entry: loop through a list of configs, sections or options
+ * @_type: see uci_list_entry
+ * @_list: pointer to the uci_list struct
+ * @_ptr: iteration variable
+ *
+ * use like a for loop, e.g:
+ *   uci_foreach(section, &list, p) {
+ *     ...
+ *   }
+ */
 #define uci_foreach_entry(_type, _list, _ptr)          \
        for(_ptr = uci_list_entry(_type, (_list)->next);        \
                &_ptr->list != (_list);                 \