2 * libuci - Library for the Unified Configuration Interface
3 * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
5 * this program is free software; you can redistribute it and/or modify
6 * it under the terms of the gnu lesser general public license version 2.1
7 * as published by the free software foundation
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
21 #define UCI_CONFDIR "/etc/config"
44 struct uci_parse_context;
48 * uci_alloc: Allocate a new uci context
50 extern struct uci_context *uci_alloc(void);
53 * uci_free: Free the uci context including all of its data
55 extern void uci_free(struct uci_context *ctx);
58 * uci_perror: Print the last uci error that occured
60 * @str: string to print before the error message
62 extern void uci_perror(struct uci_context *ctx, const char *str);
65 * uci_load: Parse an uci config file and store it in the uci context
68 * @name: name of the config file (relative to the config directory)
70 extern int uci_load(struct uci_context *ctx, const char *name, struct uci_config **cfg);
73 * uci_unload: Unload a config file from the uci context
76 * @name: name of the config file
78 extern int uci_unload(struct uci_context *ctx, const char *name);
81 * uci_cleanup: Clean up after an error
85 extern int uci_cleanup(struct uci_context *ctx);
88 * uci_list_configs: List available uci config files
92 extern char **uci_list_configs(struct uci_context *ctx);
94 /* UCI data structures */
100 /* for error handling only */
101 struct uci_parse_context *pctx;
108 struct uci_parse_context
114 struct uci_config *cfg;
115 struct uci_section *section;
124 struct uci_list list;
125 struct uci_list sections;
126 struct uci_context *ctx;
132 struct uci_list list;
133 struct uci_list options;
134 struct uci_config *config;
141 struct uci_list list;
142 struct uci_section *section;
147 /* linked list handling */
149 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
152 #define uci_list_empty(list) ((list)->next == (list))
153 #define uci_list_entry(_type, _ptr) \
154 ((struct uci_ ## _type *) ((char *)(_ptr) - offsetof(struct uci_ ## _type,list)))
156 #define uci_foreach_entry(_type, _list, _ptr) \
157 for(_ptr = uci_list_entry(_type, (_list)->next); \
158 &_ptr->list != (_list); \
159 _ptr = uci_list_entry(_type, _ptr->list.next))