remove uci_parse_tuple, preparation for adding a new api for lookups

[project/uci.git] / uci.h

diff --git a/uci.h b/uci.h
index cb9fd66..fe05bb3 100644 (file)
--- a/uci.h
+++ b/uci.h
@@ -55,6 +55,7 @@ struct uci_list
        struct uci_list *prev;
 };
 
+struct uci_ptr;
 struct uci_element;
 struct uci_package;
 struct uci_section;
@@ -66,19 +67,6 @@ struct uci_parse_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 int uci_parse_tuple(struct uci_context *ctx, char *str, char **package, char **section, char **option, char **value);
-
-/**
  * uci_alloc_context: Allocate a new uci context
  */
 extern struct uci_context *uci_alloc_context(void);
@@ -149,6 +137,32 @@ extern int uci_unload(struct uci_context *ctx, struct uci_package *p);
 extern int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *package, const char *section, const char *option);
 
 /**
+ * uci_lookup_ptr: Split an uci tuple string and look up elements
+ * @ctx: uci context
+ * @ptr: lookup result struct
+ * @str: uci tuple string to look up
+ * @extended: allow extended syntax lookup
+ */
+extern int uci_lookup_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str, bool extended);
+
+/**
+ * uci_lookup_ext: Extended lookup for an uci element
+ *
+ * @ctx: uci context
+ * @res: where to store the result
+ * @ptr: uci pointer tuple
+ *
+ * Looks up an element using the extended syntax.
+ * It can look up sections by an index with an optional type.
+ *
+ * Examples:
+ *   network.@interface[0].ifname ('ifname' option of the first interface section)
+ *   network.@interface[-1]       (last interface section)
+ * Note: uci_lookup_ext will automatically load a config package if necessary
+ */
+extern int uci_lookup_ext(struct uci_context *ctx, struct uci_element **res, char *ptr);
+
+/**
  * uci_add_section: Add an unnamed section
  * @ctx: uci context
  * @p: package to add the section to
@@ -169,6 +183,14 @@ extern int uci_add_section(struct uci_context *ctx, struct uci_package *p, const
 extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, const char *value);
 
 /**
+ * uci_add_element_list: Append a string to a list option
+ * @ctx: uci context
+ * @option: pointer to the uci option element
+ * @value: string to append
+ */
+extern int uci_add_element_list(struct uci_context *ctx, struct uci_option *o, const char *value);
+
+/**
  * uci_set: Set an element's value; create the element if necessary
  * @ctx: uci context
  * @package: package name
@@ -180,6 +202,20 @@ extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **e
 extern int uci_set(struct uci_context *ctx, struct uci_package *p, const char *section, const char *option, const char *value, struct uci_element **result);
 
 /**
+ * uci_add_list: Append a string to an element list
+ * @ctx: uci context
+ * @package: package name
+ * @section: section name
+ * @option: option name
+ * @value: string value
+ * @result: store the updated element in this variable (optional)
+ *
+ * Note: if the given option already contains a string, convert it to an 1-element-list
+ * before appending the next element
+ */
+extern int uci_add_list(struct uci_context *ctx, struct uci_package *p, const char *section, const char *option, const char *value, struct uci_option **result);
+
+/**
  * uci_rename: Rename an element
  * @ctx: uci context
  * @package: package name
@@ -282,14 +318,30 @@ extern int uci_parse_argument(struct uci_context *ctx, FILE *stream, char **str,
  */
 extern int uci_set_backend(struct uci_context *ctx, const char *name);
 
+/**
+ * uci_validate_text: validate a value string for uci options
+ * @str: value
+ *
+ * this function checks whether a given string is acceptable as value
+ * for uci options
+ */
+extern bool uci_validate_text(const char *str);
+
 /* UCI data structures */
 enum uci_type {
-       UCI_TYPE_HISTORY = 0,
-       UCI_TYPE_PACKAGE = 1,
-       UCI_TYPE_SECTION = 2,
-       UCI_TYPE_OPTION = 3,
-       UCI_TYPE_PATH = 4,
-       UCI_TYPE_BACKEND = 5,
+       UCI_TYPE_UNSPEC = 0,
+       UCI_TYPE_HISTORY = 1,
+       UCI_TYPE_PACKAGE = 2,
+       UCI_TYPE_SECTION = 3,
+       UCI_TYPE_OPTION = 4,
+       UCI_TYPE_PATH = 5,
+       UCI_TYPE_BACKEND = 6,
+       UCI_TYPE_ITEM = 7,
+};
+
+enum uci_option_type {
+       UCI_TYPE_STRING = 0,
+       UCI_TYPE_LIST = 1,
 };
 
 enum uci_flags {
@@ -377,14 +429,19 @@ struct uci_option
 {
        struct uci_element e;
        struct uci_section *section;
-       char *value;
+       enum uci_option_type type;
+       union {
+               struct uci_list list;
+               char *string;
+       } v;
 };
 
 enum uci_command {
        UCI_CMD_ADD,
        UCI_CMD_REMOVE,
        UCI_CMD_CHANGE,
-       UCI_CMD_RENAME
+       UCI_CMD_RENAME,
+       UCI_CMD_LIST_ADD,
 };
 
 struct uci_history
@@ -395,6 +452,25 @@ struct uci_history
        char *value;
 };
 
+struct uci_ptr
+{
+       enum uci_type target;
+       enum {
+               UCI_LOOKUP_DONE =     (1 << 0),
+               UCI_LOOKUP_COMPLETE = (1 << 1),
+               UCI_LOOKUP_EXTENDED = (1 << 2),
+       } flags;
+
+       struct uci_package *p;
+       struct uci_section *s;
+       struct uci_option *o;
+
+       char *package;
+       char *section;
+       char *option;
+       char *value;
+};
+
 
 /* linked list handling */
 #ifndef offsetof