X-Git-Url: http://git.archive.openwrt.org/?p=project%2Fuci.git;a=blobdiff_plain;f=uci.h;h=198ae2a5888a3da88cf69e72b19eb1a54df5cc77;hp=29cd07d0410e7e8c75d79717b87a402dfb2b844a;hb=3bff697cca125a6a4147e3bd1c469b36504e8237;hpb=53726f5dd57ab09a206c96108a71db25e7517caa diff --git a/uci.h b/uci.h index 29cd07d..198ae2a 100644 --- a/uci.h +++ b/uci.h @@ -15,6 +15,8 @@ #ifndef __LIBUCI_H #define __LIBUCI_H +#include "uci_config.h" + /* * you can use these defines to enable debugging behavior for * apps compiled against libuci: @@ -24,18 +26,14 @@ * */ -#ifdef DEBUG_ALL -#define UCI_DEBUG -#define UCI_DEBUG_TYPECAST -#endif - #include #include #include #define UCI_CONFDIR "/etc/config" #define UCI_SAVEDIR "/tmp/.uci" -#define UCI_FILEMODE 0600 +#define UCI_DIRMODE 0700 +#define UCI_FILEMODE 0600 enum { @@ -148,7 +146,25 @@ extern int uci_unload(struct uci_context *ctx, struct uci_package *p); * 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, struct uci_package *package, char *section, char *option); +extern int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *package, const char *section, const char *option); + +/** + * 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, which is a superset of what + * uci_parse_tuple accepts. 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 @@ -157,7 +173,7 @@ 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 */ -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 @@ -168,7 +184,15 @@ extern int uci_add_section(struct uci_context *ctx, struct uci_package *p, char * 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); +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 @@ -179,7 +203,21 @@ extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **e * @value: value (option) or type (section) * @result: store the updated element in this variable (optional) */ -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_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 @@ -205,7 +243,7 @@ extern int uci_delete_element(struct uci_context *ctx, struct uci_element *e); * @section: section name * @option: option name (optional) */ -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_package *p, const char *section, const char *option); /** * uci_save: save change history for a package @@ -264,7 +302,7 @@ extern int uci_add_history_path(struct uci_context *ctx, const char *dir); * @section: section name (optional) * @option option name (optional) */ -extern int uci_revert(struct uci_context *ctx, struct uci_package **p, char *section, char *option); +extern int uci_revert(struct uci_context *ctx, struct uci_package **p, const char *section, const char *option); /** * uci_parse_argument: parse a shell-style argument, with an arbitrary quoting style @@ -284,6 +322,15 @@ 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, @@ -292,6 +339,12 @@ enum uci_type { UCI_TYPE_OPTION = 3, UCI_TYPE_PATH = 4, UCI_TYPE_BACKEND = 5, + UCI_TYPE_ITEM = 6, +}; + +enum uci_option_type { + UCI_TYPE_STRING = 0, + UCI_TYPE_LIST = 1, }; enum uci_flags { @@ -314,6 +367,10 @@ struct uci_backend char **(*list_configs)(struct uci_context *ctx); struct uci_package *(*load)(struct uci_context *ctx, const char *name); void (*commit)(struct uci_context *ctx, struct uci_package **p, bool overwrite); + + /* private: */ + const void *ptr; + void *priv; }; struct uci_context @@ -338,7 +395,7 @@ struct uci_context struct uci_list history_path; /* private: */ - int errno; + int err; const char *func; jmp_buf trap; bool internal; @@ -375,14 +432,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 @@ -393,17 +455,6 @@ struct uci_history char *value; }; -#define UCI_BACKEND(_var, _name, ...) \ -struct uci_backend _var = { \ - .e.list = { \ - .next = &_var.e.list, \ - .prev = &_var.e.list, \ - }, \ - .e.name = _name, \ - .e.type = UCI_TYPE_BACKEND, \ - __VA_ARGS__ \ -} - /* linked list handling */ #ifndef offsetof