protect ucimap.h against multiple inclusions
[project/uci.git] / uci.h
diff --git a/uci.h b/uci.h
index be816fd..74bbdff 100644 (file)
--- a/uci.h
+++ b/uci.h
@@ -55,6 +55,9 @@ struct uci_list
        struct uci_list *prev;
 };
 
        struct uci_list *prev;
 };
 
+struct uci_ptr;
+struct uci_plugin;
+struct uci_hook_ops;
 struct uci_element;
 struct uci_package;
 struct uci_section;
 struct uci_element;
 struct uci_package;
 struct uci_section;
@@ -65,19 +68,6 @@ struct uci_backend;
 struct uci_parse_context;
 
 
 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
  */
 /**
  * uci_alloc_context: Allocate a new uci context
  */
@@ -95,6 +85,16 @@ extern void uci_free_context(struct uci_context *ctx);
  */
 extern void uci_perror(struct uci_context *ctx, const char *str);
 
  */
 extern void uci_perror(struct uci_context *ctx, const char *str);
 
+/**
+ * uci_geterror: Get an error string for the last uci error
+ * @ctx: uci context
+ * @dest: target pointer for the string
+ * @str: prefix for the error message
+ *
+ * Note: string must be freed by the caller
+ */
+extern void uci_get_errorstr(struct uci_context *ctx, char **dest, const char *str);
+
 /**
  * uci_import: Import uci config data from a stream
  * @ctx: uci context
 /**
  * uci_import: Import uci config data from a stream
  * @ctx: uci context
@@ -135,18 +135,21 @@ extern int uci_load(struct uci_context *ctx, const char *name, struct uci_packag
 extern int uci_unload(struct uci_context *ctx, struct uci_package *p);
 
 /**
 extern int uci_unload(struct uci_context *ctx, struct uci_package *p);
 
 /**
- * uci_lookup: Look up an uci element
- *
+ * uci_lookup_ptr: Split an uci tuple string and look up an element tree
  * @ctx: uci context
  * @ctx: uci context
- * @res: where to store the result
- * @package: uci_package struct 
- * @section: config section (optional)
- * @option: option to search for (optional)
+ * @ptr: lookup result struct
+ * @str: uci tuple string to look up
+ * @extended: allow extended syntax lookup
  *
  *
- * 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
+ * if extended is set to true, uci_lookup_ptr supports the following 
+ * extended syntax:
+ *
+ * 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(struct uci_context *ctx, struct uci_element **res, struct uci_package *package, const char *section, const char *option);
+extern int uci_lookup_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str, bool extended);
 
 /**
  * uci_add_section: Add an unnamed section
 
 /**
  * uci_add_section: Add an unnamed section
@@ -155,55 +158,48 @@ extern int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct
  * @type: section type
  * @res: pointer to store a reference to the new section in
  */
  * @type: section type
  * @res: pointer to store a reference to the new section in
  */
-extern int uci_add_section(struct uci_context *ctx, struct uci_package *p, char *type, struct uci_section **res);
+extern int uci_add_section(struct uci_context *ctx, struct uci_package *p, const char *type, struct uci_section **res);
 
 /**
 
 /**
- * uci_set_element_value: Replace an element's value with a new one
+ * uci_set: Set an element's value; create the element if necessary
  * @ctx: uci context
  * @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
+ * @ptr: uci pointer 
+ *
+ * The updated/created element is stored in ptr->last
  */
  */
-extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value);
+extern int uci_set(struct uci_context *ctx, struct uci_ptr *ptr);
 
 /**
 
 /**
- * uci_set: Set an element's value; create the element if necessary
+ * uci_add_list: Append a string to an element list
  * @ctx: uci context
  * @ctx: uci context
- * @package: package name
- * @section: section name
- * @option: option name
- * @value: value (option) or type (section)
- * @result: store the updated element in this variable (optional)
+ * @ptr: uci pointer (with value)
+ *
+ * Note: if the given option already contains a string value,
+ * it will be converted to an 1-element-list before appending the next element
  */
  */
-extern int uci_set(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *value, struct uci_element **result);
+extern int uci_add_list(struct uci_context *ctx, struct uci_ptr *ptr);
 
 /**
 
 /**
- * uci_rename: Rename an element
+ * uci_reorder: Reposition a section
  * @ctx: uci context
  * @ctx: uci context
- * @package: package name
- * @section: section name
- * @option: option name
- * @name: new name
+ * @s: uci section to reposition
+ * @pos: new position in the section list
  */
  */
-extern int uci_rename(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *name);
+extern int uci_reorder_section(struct uci_context *ctx, struct uci_section *s, int pos);
 
 /**
 
 /**
- * uci_delete_element: Delete a section or option
+ * uci_rename: Rename an element
  * @ctx: uci context
  * @ctx: uci context
- * @e: element (section or option)
+ * @ptr: uci pointer (with value)
  */
  */
-extern int uci_delete_element(struct uci_context *ctx, struct uci_element *e);
+extern int uci_rename(struct uci_context *ctx, struct uci_ptr *ptr);
 
 /**
  * uci_delete: Delete a section or option
  * @ctx: uci context
 
 /**
  * uci_delete: Delete a section or option
  * @ctx: uci context
- * @p: uci package
- * @section: section name
- * @option: option name (optional)
+ * @ptr: uci pointer 
  */
  */
-extern int uci_delete(struct uci_context *ctx, struct uci_package *p, char *section, char *option);
+extern int uci_delete(struct uci_context *ctx, struct uci_ptr *ptr);
 
 /**
  * uci_save: save change history for a package
 
 /**
  * uci_save: save change history for a package
@@ -258,11 +254,9 @@ extern int uci_add_history_path(struct uci_context *ctx, const char *dir);
 /**
  * uci_revert: revert all changes to a config item
  * @ctx: uci context
 /**
  * uci_revert: revert all changes to a config item
  * @ctx: uci context
- * @p: pointer to a uci_package struct ptr (will be replaced by the revert)
- * @section: section name (optional)
- * @option option name (optional)
+ * @ptr: uci pointer
  */
  */
-extern int uci_revert(struct uci_context *ctx, struct uci_package **p, const char *section, const char *option);
+extern int uci_revert(struct uci_context *ctx, struct uci_ptr *ptr);
 
 /**
  * uci_parse_argument: parse a shell-style argument, with an arbitrary quoting style
 
 /**
  * uci_parse_argument: parse a shell-style argument, with an arbitrary quoting style
@@ -282,14 +276,69 @@ 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);
 
  */
 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_add_hook: add a uci hook
+ * @ctx: uci context
+ * @ops: uci hook ops
+ *
+ * NB: allocated and freed by the caller
+ */
+extern int uci_add_hook(struct uci_context *ctx, const struct uci_hook_ops *ops);
+
+/**
+ * uci_remove_hook: remove a uci hook
+ * @ctx: uci context
+ * @ops: uci hook ops
+ */
+extern int uci_remove_hook(struct uci_context *ctx, const struct uci_hook_ops *ops);
+
+/**
+ * uci_load_plugin: load an uci plugin
+ * @ctx: uci context
+ * @filename: path to the uci plugin
+ *
+ * NB: plugin will be unloaded automatically when the context is freed
+ */
+int uci_load_plugin(struct uci_context *ctx, const char *filename);
+
+/**
+ * uci_load_plugins: load all uci plugins from a directory
+ * @ctx: uci context
+ * @pattern: pattern of uci plugin files (optional)
+ *
+ * if pattern is NULL, then uci_load_plugins will call uci_load_plugin
+ * for uci_*.so in <prefix>/lib/
+ */
+int uci_load_plugins(struct uci_context *ctx, const char *pattern);
+
+
 /* UCI data structures */
 enum uci_type {
 /* 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,
+       UCI_TYPE_HOOK = 8,
+       UCI_TYPE_PLUGIN = 9,
+};
+
+enum uci_option_type {
+       UCI_TYPE_STRING = 0,
+       UCI_TYPE_LIST = 1,
 };
 
 enum uci_flags {
 };
 
 enum uci_flags {
@@ -343,9 +392,12 @@ struct uci_context
        int err;
        const char *func;
        jmp_buf trap;
        int err;
        const char *func;
        jmp_buf trap;
-       bool internal;
+       bool internal, nested;
        char *buf;
        int bufsz;
        char *buf;
        int bufsz;
+
+       struct uci_list hooks;
+       struct uci_list plugins;
 };
 
 struct uci_package
 };
 
 struct uci_package
@@ -377,14 +429,20 @@ struct uci_option
 {
        struct uci_element e;
        struct uci_section *section;
 {
        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,
 };
 
 enum uci_command {
        UCI_CMD_ADD,
        UCI_CMD_REMOVE,
        UCI_CMD_CHANGE,
-       UCI_CMD_RENAME
+       UCI_CMD_RENAME,
+       UCI_CMD_REORDER,
+       UCI_CMD_LIST_ADD,
 };
 
 struct uci_history
 };
 
 struct uci_history
@@ -395,6 +453,51 @@ struct uci_history
        char *value;
 };
 
        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;
+       struct uci_element *last;
+
+       const char *package;
+       const char *section;
+       const char *option;
+       const char *value;
+};
+
+struct uci_hook_ops
+{
+       void (*load)(const struct uci_hook_ops *ops, struct uci_package *p);
+       void (*set)(const struct uci_hook_ops *ops, struct uci_package *p, struct uci_history *e);
+};
+
+struct uci_hook
+{
+       struct uci_element e;
+       const struct uci_hook_ops *ops;
+};
+
+struct uci_plugin_ops
+{
+       int (*attach)(struct uci_context *ctx);
+       void (*detach)(struct uci_context *ctx);
+};
+
+struct uci_plugin
+{
+       struct uci_element e;
+       const struct uci_plugin_ops *ops;
+       void *dlh;
+};
+
 
 /* linked list handling */
 #ifndef offsetof
 
 /* linked list handling */
 #ifndef offsetof
@@ -407,8 +510,10 @@ struct uci_history
  * @type:   the type of the container struct this is embedded in.
  * @member: the name of the member within the struct.
  */
  * @type:   the type of the container struct this is embedded in.
  * @member: the name of the member within the struct.
  */
+#ifndef container_of
 #define container_of(ptr, type, member) \
        ((type *) ((char *)ptr - offsetof(type,member)))
 #define container_of(ptr, type, member) \
        ((type *) ((char *)ptr - offsetof(type,member)))
+#endif
 
 
 /**
 
 
 /**
@@ -463,6 +568,8 @@ struct uci_history
 #define uci_type_package UCI_TYPE_PACKAGE
 #define uci_type_section UCI_TYPE_SECTION
 #define uci_type_option UCI_TYPE_OPTION
 #define uci_type_package UCI_TYPE_PACKAGE
 #define uci_type_section UCI_TYPE_SECTION
 #define uci_type_option UCI_TYPE_OPTION
+#define uci_type_hook UCI_TYPE_HOOK
+#define uci_type_plugin UCI_TYPE_PLUGIN
 
 /* element typecasting */
 #ifdef UCI_DEBUG_TYPECAST
 
 /* element typecasting */
 #ifdef UCI_DEBUG_TYPECAST
@@ -472,6 +579,8 @@ static const char *uci_typestr[] = {
        [uci_type_package] = "package",
        [uci_type_section] = "section",
        [uci_type_option] = "option",
        [uci_type_package] = "package",
        [uci_type_section] = "section",
        [uci_type_option] = "option",
+       [uci_type_hook] = "hook",
+       [uci_type_plugin] = "plugin",
 };
 
 static void uci_typecast_error(int from, int to)
 };
 
 static void uci_typecast_error(int from, int to)
@@ -493,6 +602,8 @@ BUILD_CAST(history)
 BUILD_CAST(package)
 BUILD_CAST(section)
 BUILD_CAST(option)
 BUILD_CAST(package)
 BUILD_CAST(section)
 BUILD_CAST(option)
+BUILD_CAST(hook)
+BUILD_CAST(plugin)
 
 #else
 #define uci_to_backend(ptr) container_of(ptr, struct uci_backend, e)
 
 #else
 #define uci_to_backend(ptr) container_of(ptr, struct uci_backend, e)
@@ -500,6 +611,8 @@ BUILD_CAST(option)
 #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)
 #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)
+#define uci_to_hook(ptr)    container_of(ptr, struct uci_hook, e)
+#define uci_to_plugin(ptr)  container_of(ptr, struct uci_plugin, e)
 #endif
 
 /**
 #endif
 
 /**