X-Git-Url: http://git.archive.openwrt.org/?p=project%2Fuci.git;a=blobdiff_plain;f=uci.h;h=474998505a3fa89ca259281a1708dc2b8b537027;hp=5e6baf648f47e1dd04189864e924ad80ca8e1b39;hb=4c95913eae05b8a0b1c8e8e6ff219b9d710d564a;hpb=fe3c9bb5107ddf3fb4d9add373ccfa0075153b30 diff --git a/uci.h b/uci.h index 5e6baf6..4749985 100644 --- a/uci.h +++ b/uci.h @@ -15,6 +15,21 @@ #ifndef __LIBUCI_H #define __LIBUCI_H +/* + * you can use these defines to enable debugging behavior for + * apps compiled against libuci: + * + * #define UCI_DEBUG_TYPECAST: + * enable uci_element typecast checking at run time + * + */ + +#ifdef DEBUG_ALL +#define UCI_DEBUG +#define UCI_DEBUG_TYPECAST +#endif + +#include #include #include @@ -32,27 +47,30 @@ enum UCI_ERR_LAST }; +struct uci_list; struct uci_list { - void *next; - void *prev; + struct uci_list *next; + struct uci_list *prev; }; -struct uci_config; +struct uci_element; +struct uci_package; struct uci_section; struct uci_option; +struct uci_history; struct uci_parse_context; /** - * uci_alloc: Allocate a new uci context + * uci_alloc_context: Allocate a new uci context */ -extern struct uci_context *uci_alloc(void); +extern struct uci_context *uci_alloc_context(void); /** - * uci_free: Free the uci context including all of its data + * uci_free_context: Free the uci context including all of its data */ -extern void uci_free(struct uci_context *ctx); +extern void uci_free_context(struct uci_context *ctx); /** * uci_perror: Print the last uci error that occured @@ -62,20 +80,41 @@ extern void uci_free(struct uci_context *ctx); extern void uci_perror(struct uci_context *ctx, const char *str); /** + * uci_import: Import uci config data from a stream + * @ctx: uci context + * @stream: file stream to import from + * @name: (optional) assume the config has the given name + * @package: (optional) store the last parsed config package in this variable + * + * the name parameter is for config files that don't explicitly use the 'package <...>' keyword + */ +extern int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package); + +/** + * uci_export: Export one or all uci config packages + * @ctx: uci context + * @stream: output stream + * @package: (optional) uci config package to export + * @header: include the package header + */ +extern int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header); + +/** * uci_load: Parse an uci config file and store it in the uci context * * @ctx: uci context * @name: name of the config file (relative to the config directory) + * @package: store the loaded config package in this variable */ -extern int uci_load(struct uci_context *ctx, const char *name, struct uci_config **cfg); +extern int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package); /** * uci_unload: Unload a config file from the uci context * * @ctx: uci context - * @name: name of the config file + * @package: pointer to the uci_package struct */ -extern int uci_unload(struct uci_context *ctx, const char *name); +extern int uci_unload(struct uci_context *ctx, struct uci_package *p); /** * uci_cleanup: Clean up after an error @@ -85,6 +124,48 @@ extern int uci_unload(struct uci_context *ctx, const char *name); extern int uci_cleanup(struct uci_context *ctx); /** + * uci_lookup: Look up an uci element + * + * @ctx: uci context + * @res: where to store the result + * @package: uci_package struct + * @section: config section (optional) + * @option: option to search for (optional) + * + * 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); + +/** + * uci_set_element_value: Replace an element's value with a new one + * @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 + */ +extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value); + +/** + * uci_set: Set an element's value; create the element if necessary + * @ctx: uci context + * @package: package name + * @section: section name + * @option: option name + * @value: value (option) or type (section) + */ +extern int uci_set(struct uci_context *ctx, char *package, char *section, char *option, char *value); + +/** + * uci_commit: commit changes to a package + * @ctx: uci context + * @p: uci_package struct + */ +extern int uci_commit(struct uci_context *ctx, struct uci_package *p); + +/** * uci_list_configs: List available uci config files * * @ctx: uci context @@ -92,55 +173,91 @@ extern int uci_cleanup(struct uci_context *ctx); extern char **uci_list_configs(struct uci_context *ctx); /* UCI data structures */ +enum uci_type { + UCI_TYPE_PACKAGE = 0, + UCI_TYPE_SECTION = 1, + UCI_TYPE_OPTION = 2 +}; + +struct uci_element +{ + struct uci_list list; + enum uci_type type; + char *name; +}; struct uci_context { + /* list of config packages */ struct uci_list root; - /* for error handling only */ + /* parser context, use for error handling only */ struct uci_parse_context *pctx; /* private: */ int errno; + const char *func; jmp_buf trap; + char *buf; + int bufsz; }; struct uci_parse_context { + /* error context */ + const char *reason; int line; int byte; /* private: */ - struct uci_config *cfg; + struct uci_package *package; struct uci_section *section; FILE *file; + const char *name; char *buf; - char *reason; int bufsz; }; -struct uci_config +struct uci_package { - struct uci_list list; + struct uci_element e; struct uci_list sections; struct uci_context *ctx; - char *name; + bool confdir; + char *path; + + /* private: */ + int n_section; + struct uci_list history; }; struct uci_section { - struct uci_list list; + struct uci_element e; struct uci_list options; - struct uci_config *config; + struct uci_package *package; char *type; - char *name; }; struct uci_option { - struct uci_list list; + struct uci_element e; struct uci_section *section; - char *name; + char *value; +}; + +enum uci_command { + UCI_CMD_ADD, + UCI_CMD_REMOVE, + UCI_CMD_CHANGE +}; + +struct uci_history +{ + struct uci_list list; + enum uci_command cmd; + char *section; + char *option; char *value; }; @@ -149,13 +266,113 @@ struct uci_option #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER) #endif -#define uci_list_empty(list) ((list)->next == (list)) -#define uci_list_entry(_type, _ptr) \ - ((struct uci_ ## _type *) ((char *)(_ptr) - offsetof(struct uci_ ## _type,list))) +/** + * container_of - cast a member of a structure out to the containing structure + * @ptr: the pointer to the member. + * @type: the type of the container struct this is embedded in. + * @member: the name of the member within the struct. + */ +#define container_of(ptr, type, member) \ + ((type *) ((char *)ptr - offsetof(type,member))) + + +/** + * uci_list_entry: casts an uci_list pointer to the containing struct. + * @_type: config, section or option + * @_ptr: pointer to the uci_list struct + */ +#define element_to(type, ptr) \ + container_of(ptr, struct uci_ ## type, e) -#define uci_foreach_entry(_type, _list, _ptr) \ - for(_ptr = uci_list_entry(_type, (_list)->next); \ +#define list_to_element(ptr) \ + container_of(ptr, struct uci_element, list) + +/** + * uci_foreach_entry: loop through a list of uci elements + * @_list: pointer to the uci_list struct + * @_ptr: iteration variable, struct uci_element + * + * use like a for loop, e.g: + * uci_foreach(&list, p) { + * ... + * } + */ +#define uci_foreach_element(_list, _ptr) \ + for(_ptr = list_to_element((_list)->next); \ &_ptr->list != (_list); \ - _ptr = uci_list_entry(_type, _ptr->list.next)) + _ptr = list_to_element(_ptr->list.next)) + +/** + * uci_foreach_entry_safe: like uci_foreach_safe, but safe for deletion + * @_list: pointer to the uci_list struct + * @_tmp: temporary variable, struct uci_element * + * @_ptr: iteration variable, struct uci_element * + * + * use like a for loop, e.g: + * uci_foreach(&list, p) { + * ... + * } + */ +#define uci_foreach_element_safe(_list, _tmp, _ptr) \ + for(_ptr = list_to_element((_list)->next), \ + _tmp = list_to_element(_ptr->list.next); \ + &_ptr->list != (_list); \ + _ptr = _tmp, _tmp = list_to_element(_ptr->list.next)) + +/** + * uci_list_empty: returns true if a list is empty + * @list: list head + */ +#define uci_list_empty(list) ((list)->next == (list)) + +/* wrappers for dynamic type handling */ +#define uci_type_package UCI_TYPE_PACKAGE +#define uci_type_section UCI_TYPE_SECTION +#define uci_type_option UCI_TYPE_OPTION + +/* element typecasting */ +#ifdef UCI_DEBUG_TYPECAST +static const char *uci_typestr[] = { + [uci_type_package] = "package", + [uci_type_section] = "section", + [uci_type_option] = "option" +}; + +static void uci_typecast_error(int from, int to) +{ + fprintf(stderr, "Invalid typecast from '%s' to '%s'\n", uci_typestr[from], uci_typestr[to]); +} + +#define BUILD_CAST(_type) \ + static inline struct uci_ ## _type *uci_to_ ## _type (struct uci_element *e) \ + { \ + if (e->type != uci_type_ ## _type) { \ + uci_typecast_error(e->type, uci_type_ ## _type); \ + } \ + return (struct uci_ ## _type *) e; \ + } + +BUILD_CAST(package) +BUILD_CAST(section) +BUILD_CAST(option) + +#else +#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) +#endif + +/** + * uci_alloc_element: allocate a generic uci_element, reserve a buffer and typecast + * @ctx: uci context + * @type: {package,section,option} + * @name: string containing the name of the element + * @datasize: additional buffer size to reserve at the end of the struct + */ +#define uci_alloc_element(ctx, type, name, datasize) \ + uci_to_ ## type (uci_alloc_generic(ctx, uci_type_ ## type, name, sizeof(struct uci_ ## type) + datasize)) + +#define uci_dataptr(ptr) \ + (((char *) ptr) + sizeof(*ptr)) #endif