X-Git-Url: https://git.archive.openwrt.org/?p=project%2Fuci.git;a=blobdiff_plain;f=uci.h;h=687454f6989a68549b4d4fcfcb87898ddb918bce;hp=d18095d988bdf1356dc2702e17e765a68d67359b;hb=a1f1ee31878c71cb460126d07429eab07587d170;hpb=3db7aea5f1e65b8b97b8a73ee19ae907e75a4b48

diff --git a/uci.h b/uci.h
index d18095d..687454f 100644
--- a/uci.h
+++ b/uci.h
@@ -38,9 +38,10 @@ struct uci_list
 	void *prev;
 };
 
-struct uci_config;
+struct uci_package;
 struct uci_section;
 struct uci_option;
+struct uci_history;
 struct uci_parse_context;
 
 
@@ -50,6 +51,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,61 +63,103 @@ 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
+ * @package: (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_package **package);
+
+/**
+ * uci_export: Export one or all uci config packages
+ * @ctx: uci context
+ * @stream: output stream
+ * @package: (optional) uci config package to export
+ */
+extern int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package);
+
+/**
  * 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)
+ * @package: store the loaded config package in this variable
+ */
+extern int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package);
+
+/**
+ * uci_unload: Unload a config file from the uci context
+ *
+ * @ctx: uci context
+ * @name: name of the config file
  */
-int uci_load(struct uci_context *ctx, const char *name);
+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(struct uci_context *ctx);
 
 /* 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_package *package;
+	struct uci_section *section;
 	FILE *file;
+	const char *name;
 	char *buf;
-	char *reason;
 	int bufsz;
 };
 
-struct uci_config
+struct uci_package
 {
 	struct uci_list list;
 	struct uci_list sections;
 	struct uci_context *ctx;
 	char *name;
+	/* private: */
+	int n_section;
 };
 
 struct uci_section
 {
 	struct uci_list list;
 	struct uci_list options;
-	struct uci_config *config;
+	struct uci_package *package;
 	char *type;
 	char *name;
 };
@@ -124,15 +172,65 @@ struct uci_option
 	char *value;
 };
 
+enum uci_type {
+	UCI_TYPE_PACKAGE,
+	UCI_TYPE_SECTION,
+	UCI_TYPE_OPTION
+};
+
+enum uci_command {
+	UCI_CMD_ADD,
+	UCI_CMD_REMOVE,
+	UCI_CMD_CHANGE
+};
+
+struct uci_history
+{
+	struct uci_list list;
+	enum uci_command cmd;
+	enum uci_type type;
+	union {
+		struct {
+			char *name;
+		} p;
+		struct {
+			char *type;
+			char *name;
+		} c;
+		struct {
+			char *name;
+			char *value;
+		} o;
+	} data;
+};
+
 /* linked list handling */
 #ifndef offsetof
 #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);			\