2 * ucimap - library for mapping uci sections into data structures
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 General Public License version 2
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.
22 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
25 #define BITFIELD_SIZE(_fields) (((_fields) / 8) + 1)
27 #define CLR_BIT(_name, _bit) do { \
28 _name[(_bit) / 8] &= ~(1 << ((_bit) % 8)); \
31 #define SET_BIT(_name, _bit) do { \
32 _name[(_bit) / 8] |= (1 << ((_bit) % 8)); \
35 #define TEST_BIT(_name, _bit) \
36 (_name[(_bit) / 8] & (1 << ((_bit) % 8)))
38 #define UCIMAP_OPTION(_type, _field) \
39 .type = UCIMAP_CUSTOM, \
41 .offset = offsetof(_type, _field)
44 #define UCIMAP_SECTION(_name, _field) \
45 .alloc_len = sizeof(_name), \
46 .smap_offset = offsetof(_name, _field)
48 struct uci_sectionmap;
53 struct uci_sectionmap **sections;
54 unsigned int n_sections;
55 struct list_head sdata;
56 struct list_head fixup;
58 void *priv; /* user data */
65 UCIMAP_TYPE = 0xf0, /* type mask */
73 UCIMAP_SUBTYPE = 0xf, /* subtype mask */
75 /* automatically create lists from
76 * options with space-separated items */
77 UCIMAP_LIST_AUTO = 0x0100,
78 UCIMAP_FLAGS = 0xff00, /* flags mask */
86 struct ucimap_list *list;
89 struct ucimap_section_data {
90 struct list_head list;
92 struct uci_sectionmap *sm;
93 const char *section_name;
95 /* list of allocations done by ucimap */
96 struct uci_alloc *allocmap;
97 unsigned long allocmap_len;
99 /* map for changed fields */
106 struct list_head list;
107 union ucimap_data data;
110 struct uci_sectionmap {
111 /* type string for the uci section */
114 /* length of the struct to map into, filled in by macro */
115 unsigned int alloc_len;
117 /* sectionmap offset, filled in by macro */
118 unsigned int smap_offset;
120 /* return a pointer to the section map data (allocate if necessary) */
121 struct ucimap_section_data *(*alloc)(struct uci_map *map,
122 struct uci_sectionmap *sm, struct uci_section *s);
124 /* give the caller time to initialize the preallocated struct */
125 int (*init)(struct uci_map *map, void *section, struct uci_section *s);
127 /* pass the fully processed struct to the callback after the section end */
128 int (*add)(struct uci_map *map, void *section);
130 /* let the callback clean up its own stuff in the section */
131 int (*free)(struct uci_map *map, void *section);
133 /* list of option mappings for this section */
134 struct uci_optmap *options;
135 unsigned int n_options;
136 unsigned int options_size;
142 enum ucimap_type type;
143 int (*parse)(void *section, struct uci_optmap *om, union ucimap_data *data, const char *string);
144 int (*format)(void *section, struct uci_optmap *om, union ucimap_data *data, char **string);
154 struct uci_sectionmap *sm;
160 union ucimap_data item[];
163 extern int ucimap_init(struct uci_map *map);
164 extern void ucimap_cleanup(struct uci_map *map);
165 extern void ucimap_set_changed(struct ucimap_section_data *sd, void *field);
166 extern int ucimap_store_section(struct uci_map *map, struct uci_package *p, struct ucimap_section_data *sd);
167 extern void ucimap_parse(struct uci_map *map, struct uci_package *pkg);
168 extern int ucimap_parse_section(struct uci_map *map, struct uci_sectionmap *sm, struct ucimap_section_data *sd, struct uci_section *s);