X-Git-Url: http://git.openwrt.org/?p=project%2Fuci.git;a=blobdiff_plain;f=uci.h;h=c5583ed0f798a081e964ba120760c59d179b36e2;hp=fe5e31443d820520111a86ab1f88b5b4ee467483;hb=13d32e6df1c3949459c8821b7a03ec13d92e9bf1;hpb=3fa65a20ae0fc77b951515bc5de7a0041adc9be1 diff --git a/uci.h b/uci.h index fe5e314..c5583ed 100644 --- a/uci.h +++ b/uci.h @@ -9,12 +9,16 @@ * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * GNU Lesser General Public License for more details. */ #ifndef __LIBUCI_H #define __LIBUCI_H +#ifdef __cplusplus +extern "C" { +#endif + #include "uci_config.h" /* @@ -29,6 +33,7 @@ #include #include #include +#include #define UCI_CONFDIR "/etc/config" #define UCI_SAVEDIR "/tmp/.uci" @@ -56,8 +61,6 @@ struct uci_list }; struct uci_ptr; -struct uci_plugin; -struct uci_hook_ops; struct uci_element; struct uci_package; struct uci_section; @@ -65,6 +68,7 @@ struct uci_option; struct uci_delta; struct uci_context; struct uci_backend; +struct uci_parse_option; struct uci_parse_context; @@ -150,6 +154,13 @@ extern int uci_unload(struct uci_context *ctx, struct uci_package *p); * Note: uci_lookup_ptr will automatically load a config package if necessary * @str must not be constant, as it will be modified and used for the strings inside @ptr, * thus it must also be available as long as @ptr is in use. + * + * This function returns UCI_ERR_NOTFOUND if the package specified in the tuple + * string cannot be found. Otherwise it will return UCI_OK. + * + * Note that failures in looking up other parts, if they are also specfied, + * including section and option, will also have a return value UCI_OK but with + * ptr->flags * UCI_LOOKUP_COMPLETE not set. */ extern int uci_lookup_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str, bool extended); @@ -181,6 +192,14 @@ extern int uci_set(struct uci_context *ctx, struct uci_ptr *ptr); */ extern int uci_add_list(struct uci_context *ctx, struct uci_ptr *ptr); +/** + * uci_del_list: Remove a string from an element list + * @ctx: uci context + * @ptr: uci pointer (with value) + * + */ +extern int uci_del_list(struct uci_context *ctx, struct uci_ptr *ptr); + /** * uci_reorder: Reposition a section * @ctx: uci context @@ -233,6 +252,8 @@ extern int uci_list_configs(struct uci_context *ctx, char ***list); * uci_set_savedir: override the default delta save directory * @ctx: uci context * @dir: directory name + * + * This will also try adding the specified dir to the end of delta pathes. */ extern int uci_set_savedir(struct uci_context *ctx, const char *dir); @@ -250,6 +271,8 @@ extern int uci_set_confdir(struct uci_context *ctx, const char *dir); * * This function allows you to add directories, which contain 'overlays' * for the active config, that will never be committed. + * + * Adding a duplicate directory will cause UCI_ERR_DUPLICATE be returned. */ extern int uci_add_delta_path(struct uci_context *ctx, const char *dir); @@ -287,42 +310,6 @@ extern int uci_set_backend(struct uci_context *ctx, const char *name); */ 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 /lib/ - */ -int uci_load_plugins(struct uci_context *ctx, const char *pattern); - /** * uci_parse_ptr: parse a uci string into a uci_ptr * @ctx: uci context @@ -344,6 +331,23 @@ int uci_parse_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str); */ int uci_lookup_next(struct uci_context *ctx, struct uci_element **e, struct uci_list *list, const char *name); +/** + * uci_parse_section: look up a set of options + * @s: uci section + * @opts: list of options to look up + * @n_opts: number of options to look up + * @tb: array of pointers to found options + */ +void uci_parse_section(struct uci_section *s, const struct uci_parse_option *opts, + int n_opts, struct uci_option **tb); + +/** + * uci_hash_options: build a hash over a list of options + * @tb: list of option pointers + * @n_opts: number of options + */ +uint32_t uci_hash_options(struct uci_option **tb, int n_opts); + /* UCI data structures */ enum uci_type { @@ -356,7 +360,6 @@ enum uci_type { UCI_TYPE_BACKEND = 6, UCI_TYPE_ITEM = 7, UCI_TYPE_HOOK = 8, - UCI_TYPE_PLUGIN = 9, }; enum uci_option_type { @@ -418,9 +421,6 @@ struct uci_context bool internal, nested; char *buf; int bufsz; - - struct uci_list hooks; - struct uci_list plugins; }; struct uci_package @@ -459,6 +459,9 @@ struct uci_option } v; }; +/* + * UCI_CMD_ADD is used for anonymous sections or list values + */ enum uci_command { UCI_CMD_ADD, UCI_CMD_REMOVE, @@ -466,7 +469,11 @@ enum uci_command { UCI_CMD_RENAME, UCI_CMD_REORDER, UCI_CMD_LIST_ADD, + UCI_CMD_LIST_DEL, + __UCI_CMD_MAX, + __UCI_CMD_LAST = __UCI_CMD_MAX - 1 }; +extern char const uci_command_char[]; struct uci_delta { @@ -496,29 +503,9 @@ struct uci_ptr 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_delta *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; +struct uci_parse_option { + const char *name; + enum uci_option_type type; }; @@ -591,8 +578,6 @@ struct uci_plugin #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 @@ -602,8 +587,6 @@ static const char *uci_typestr[] = { [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) @@ -625,8 +608,6 @@ BUILD_CAST(delta) 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) @@ -634,8 +615,6 @@ BUILD_CAST(plugin) #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 /** @@ -710,4 +689,8 @@ uci_lookup_option_string(struct uci_context *ctx, struct uci_section *s, const c return o->v.string; } +#ifdef __cplusplus +} +#endif + #endif