ignore the package keyword for uci_load()
[project/uci.git] / uci.h
diff --git a/uci.h b/uci.h
index 021e5b3..3b597db 100644 (file)
--- a/uci.h
+++ b/uci.h
@@ -29,6 +29,7 @@
 #define UCI_DEBUG_TYPECAST
 #endif
 
+#include <stdbool.h>
 #include <setjmp.h>
 #include <stdio.h>
 
@@ -84,18 +85,20 @@ 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
  */
-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
@@ -110,9 +113,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
@@ -126,14 +129,42 @@ extern int uci_cleanup(struct uci_context *ctx);
  *
  * @ctx: uci context
  * @res: where to store the result
- * @package: config package
+ * @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, char *package, char *section, char *option);
+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, char *package, char *section, char *option, char *value);
+
+/**
+ * uci_commit: commit changes to a package
+ * @ctx: uci context
+ * @p: uci_package struct
+ */
+extern int uci_commit(struct uci_context *ctx, struct uci_package *p);
 
 /**
  * uci_list_configs: List available uci config files
@@ -166,6 +197,7 @@ struct uci_context
 
        /* private: */
        int errno;
+       const char *func;
        jmp_buf trap;
        char *buf;
        int bufsz;
@@ -192,8 +224,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
@@ -221,12 +257,9 @@ struct uci_history
 {
        struct uci_list list;
        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 *option;
+       char *value;
 };
 
 /* linked list handling */
@@ -287,7 +320,10 @@ 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 */