X-Git-Url: http://git.openwrt.org/?p=project%2Fuci.git;a=blobdiff_plain;f=uci.h;h=198ae2a5888a3da88cf69e72b19eb1a54df5cc77;hp=0850ad69fff7b2e862eb871d67bdc12091e9ba99;hb=3bff697cca125a6a4147e3bd1c469b36504e8237;hpb=51b60a322aff3fd1045fb6c9eb289ade2de54e71 diff --git a/uci.h b/uci.h index 0850ad6..198ae2a 100644 --- a/uci.h +++ b/uci.h @@ -146,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 @@ -155,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 @@ -166,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 @@ -177,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 @@ -203,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 @@ -262,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 @@ -282,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, @@ -290,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 { @@ -377,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