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_import: Import uci config data from a stream
67 * @stream: file stream to import from
68 * @name: (optional) assume the config has the given name
69 * @cfg: (optional) store the last parsed config package in this variable
71 * the name parameter is for config files that don't explicitly use the 'package <...>' keyword
73 extern int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_config **cfg);
76 * uci_export: Export one or all uci config packages
78 * @stream: output stream
79 * @cfg: (optional) uci config package to export
81 extern int uci_export(struct uci_context *ctx, FILE *stream, struct uci_config *cfg);
84 * uci_load: Parse an uci config file and store it in the uci context
87 * @name: name of the config file (relative to the config directory)
89 extern int uci_load(struct uci_context *ctx, const char *name, struct uci_config **cfg);
92 * uci_unload: Unload a config file from the uci context
95 * @name: name of the config file
97 extern int uci_unload(struct uci_context *ctx, const char *name);
100 * uci_cleanup: Clean up after an error
104 extern int uci_cleanup(struct uci_context *ctx);
107 * uci_list_configs: List available uci config files
111 extern char **uci_list_configs();
113 /* UCI data structures */
117 /* list of config packages */
118 struct uci_list root;
120 /* parser context, use for error handling only */
121 struct uci_parse_context *pctx;
130 struct uci_parse_context
138 struct uci_config *cfg;
139 struct uci_section *section;
148 struct uci_list list;
149 struct uci_list sections;
150 struct uci_context *ctx;
158 struct uci_list list;
159 struct uci_list options;
160 struct uci_config *config;
167 struct uci_list list;
168 struct uci_section *section;
173 /* linked list handling */
175 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
178 /* returns true if a list is empty */
179 #define uci_list_empty(list) ((list)->next == (list))
182 * uci_list_entry: casts an uci_list pointer to the containing struct.
183 * @_type: config, section or option
184 * @_ptr: pointer to the uci_list struct
186 #define uci_list_entry(_type, _ptr) \
187 ((struct uci_ ## _type *) ((char *)(_ptr) - offsetof(struct uci_ ## _type,list)))
190 * uci_foreach_entry: loop through a list of configs, sections or options
191 * @_type: see uci_list_entry
192 * @_list: pointer to the uci_list struct
193 * @_ptr: iteration variable
195 * use like a for loop, e.g:
196 * uci_foreach(section, &list, p) {
200 #define uci_foreach_entry(_type, _list, _ptr) \
201 for(_ptr = uci_list_entry(_type, (_list)->next); \
202 &_ptr->list != (_list); \
203 _ptr = uci_list_entry(_type, _ptr->list.next))