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

diff --git a/uci.h b/uci.h
index 687454f..6a6db67 100644
--- a/uci.h
+++ b/uci.h
@@ -15,6 +15,20 @@
 #ifndef __LIBUCI_H
 #define __LIBUCI_H
 
+/*
+ * you can use these defines to enable debugging behavior for
+ * apps compiled against libuci:
+ *
+ * #define UCI_DEBUG_TYPECAST:
+ *   enable uci_element typecast checking at run time
+ *
+ */
+
+#ifdef DEBUG_ALL
+#define UCI_DEBUG
+#define UCI_DEBUG_TYPECAST
+#endif
+
 #include <setjmp.h>
 #include <stdio.h>
 
@@ -32,12 +46,14 @@ enum
 	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;
@@ -46,14 +62,14 @@ struct uci_parse_context;
 
 
 /**
- * uci_alloc: Allocate a new uci context
+ * uci_alloc_context: Allocate a new uci context
  */
-extern struct uci_context *uci_alloc(void);
+extern struct uci_context *uci_alloc_context(void);
 
 /**
- * uci_free: Free the uci context including all of its data
+ * uci_free_context: Free the uci context including all of its data
  */
-extern void uci_free(struct uci_context *ctx);
+extern void uci_free_context(struct uci_context *ctx);
 
 /**
  * uci_perror: Print the last uci error that occured
@@ -106,6 +122,41 @@ 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: config package
+ * @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);
+
+/**
+ * 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_list_configs: List available uci config files
  *
  * @ctx: uci context
@@ -113,6 +164,18 @@ extern int uci_cleanup(struct uci_context *ctx);
 extern char **uci_list_configs(struct uci_context *ctx);
 
 /* UCI data structures */
+enum uci_type {
+	UCI_TYPE_PACKAGE = 0,
+	UCI_TYPE_SECTION = 1,
+	UCI_TYPE_OPTION = 2
+};
+
+struct uci_element
+{
+	struct uci_list list;
+	enum uci_type type;
+	char *name;
+};
 
 struct uci_context
 {
@@ -124,6 +187,7 @@ struct uci_context
 
 	/* private: */
 	int errno;
+	const char *func;
 	jmp_buf trap;
 	char *buf;
 	int bufsz;
@@ -147,37 +211,29 @@ struct uci_parse_context
 
 struct uci_package
 {
-	struct uci_list list;
+	struct uci_element e;
 	struct uci_list sections;
 	struct uci_context *ctx;
-	char *name;
 	/* private: */
 	int n_section;
+	struct uci_list history;
 };
 
 struct uci_section
 {
-	struct uci_list list;
+	struct uci_element e;
 	struct uci_list options;
 	struct uci_package *package;
 	char *type;
-	char *name;
 };
 
 struct uci_option
 {
-	struct uci_list list;
+	struct uci_element e;
 	struct uci_section *section;
-	char *name;
 	char *value;
 };
 
-enum uci_type {
-	UCI_TYPE_PACKAGE,
-	UCI_TYPE_SECTION,
-	UCI_TYPE_OPTION
-};
-
 enum uci_command {
 	UCI_CMD_ADD,
 	UCI_CMD_REMOVE,
@@ -188,20 +244,9 @@ 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;
+	char *section;
+	char *option;
+	char *value;
 };
 
 /* linked list handling */
@@ -209,31 +254,110 @@ struct uci_history
 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
 #endif
 
-/* returns true if a list is empty */
-#define uci_list_empty(list) ((list)->next == (list))
+/**
+ * container_of - cast a member of a structure out to the containing structure
+ * @ptr:    the pointer to the member.
+ * @type:   the type of the container struct this is embedded in.
+ * @member: the name of the member within the struct.
+ */
+#define container_of(ptr, type, member) \
+	((type *) ((char *)ptr - offsetof(type,member)))
+
 
 /**
  * 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)))
+#define element_to(type, ptr) \
+	container_of(ptr, struct uci_ ## type, e)
+
+#define list_to_element(ptr) \
+	container_of(ptr, struct uci_element, list)
+
+/**
+ * uci_foreach_entry: loop through a list of uci elements
+ * @_list: pointer to the uci_list struct
+ * @_ptr: iteration variable, struct uci_element
+ *
+ * use like a for loop, e.g:
+ *   uci_foreach(&list, p) {
+ *   	...
+ *   }
+ */
+#define uci_foreach_element(_list, _ptr)		\
+	for(_ptr = list_to_element((_list)->next);	\
+		&_ptr->list != (_list);			\
+		_ptr = list_to_element(_ptr->list.next))
 
 /**
- * uci_foreach_entry: loop through a list of configs, sections or options
- * @_type: see uci_list_entry
+ * uci_foreach_entry_safe: like uci_foreach_safe, but safe for deletion
  * @_list: pointer to the uci_list struct
- * @_ptr: iteration variable
+ * @_tmp: temporary variable, struct uci_element *
+ * @_ptr: iteration variable, struct uci_element *
  *
  * use like a for loop, e.g:
- *   uci_foreach(section, &list, p) {
+ *   uci_foreach(&list, p) {
  *   	...
  *   }
  */
-#define uci_foreach_entry(_type, _list, _ptr)		\
-	for(_ptr = uci_list_entry(_type, (_list)->next);	\
+#define uci_foreach_element_safe(_list, _tmp, _ptr)		\
+	for(_ptr = list_to_element((_list)->next),		\
+		_tmp = list_to_element(_ptr->list.next);	\
 		&_ptr->list != (_list);			\
-		_ptr = uci_list_entry(_type, _ptr->list.next))
+		_ptr = _tmp, _tmp = list_to_element(_ptr->list.next))
+
+/* returns true if a list is empty */
+#define uci_list_empty(list) ((list)->next == (list))
+
+/* wrappers for dynamic type handling */
+#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"
+};
+
+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) \
+	static inline struct uci_ ## _type *uci_to_ ## _type (struct uci_element *e) \
+	{ \
+		if (e->type != uci_type_ ## _type) { \
+			uci_typecast_error(e->type, uci_type_ ## _type); \
+		} \
+		return (struct uci_ ## _type *) e; \
+	}
+
+BUILD_CAST(package)
+BUILD_CAST(section)
+BUILD_CAST(option)
+
+#else
+#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)
+#endif
+
+/**
+ * uci_alloc_element: allocate a generic uci_element, reserve a buffer and typecast
+ * @ctx: uci context
+ * @type: {package,section,option}
+ * @name: string containing the name of the element
+ * @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, uci_type_ ## type, name, sizeof(struct uci_ ## type) + datasize))
+
+#define uci_dataptr(ptr) \
+	(((char *) ptr) + sizeof(*ptr))
 
 #endif