1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
4 */
5
6 #ifndef EXPR_H
7 #define EXPR_H
8
9 #ifdef __cplusplus
10 extern "C" {
11 #endif
12
13 #include <assert.h>
14 #include <stdio.h>
15 #ifndef __cplusplus
16 #include <stdbool.h>
17 #endif
18
19 #include <list_types.h>
20
21 typedef enum tristate {
22 no, mod, yes
23 } tristate;
24
25 enum expr_type {
26 E_NONE, E_OR, E_AND, E_NOT,
27 E_EQUAL, E_UNEQUAL, E_LTH, E_LEQ, E_GTH, E_GEQ,
28 E_SYMBOL, E_RANGE
29 };
30
31 union expr_data {
32 struct expr *expr;
33 struct symbol *sym;
34 };
35
36 struct expr {
37 enum expr_type type;
38 union expr_data left, right;
39 };
40
41 #define EXPR_OR(dep1, dep2) (((dep1)>(dep2))?(dep1):(dep2))
42 #define EXPR_AND(dep1, dep2) (((dep1)<(dep2))?(dep1):(dep2))
43 #define EXPR_NOT(dep) (2-(dep))
44
45 struct expr_value {
46 struct expr *expr;
47 tristate tri;
48 };
49
50 struct symbol_value {
51 void *val;
52 tristate tri;
53 };
54
55 enum symbol_type {
56 S_UNKNOWN, S_BOOLEAN, S_TRISTATE, S_INT, S_HEX, S_STRING
57 };
58
59 /* enum values are used as index to symbol.def[] */
60 enum {
61 S_DEF_USER, /* main user value */
62 S_DEF_AUTO, /* values read from auto.conf */
63 S_DEF_DEF3, /* Reserved for UI usage */
64 S_DEF_DEF4, /* Reserved for UI usage */
65 S_DEF_COUNT
66 };
67
68 /*
69 * Represents a configuration symbol.
70 *
71 * Choices are represented as a special kind of symbol with null name.
72 *
73 * @choice_link: linked to menu::choice_members
74 */
75 struct symbol {
76 /* link node for the hash table */
77 struct hlist_node node;
78
79 /* The name of the symbol, e.g. "FOO" for 'config FOO' */
80 char *name;
81
82 /* S_BOOLEAN, S_TRISTATE, ... */
83 enum symbol_type type;
84
85 /*
86 * The calculated value of the symbol. The SYMBOL_VALID bit is set in
87 * 'flags' when this is up to date. Note that this value might differ
88 * from the user value set in e.g. a .config file, due to visibility.
89 */
90 struct symbol_value curr;
91
92 /*
93 * Values for the symbol provided from outside. def[S_DEF_USER] holds
94 * the .config value.
95 */
96 struct symbol_value def[S_DEF_COUNT];
97
98 /*
99 * An upper bound on the tristate value the user can set for the symbol
100 * if it is a boolean or tristate. Calculated from prompt dependencies,
101 * which also inherit dependencies from enclosing menus, choices, and
102 * ifs. If 'n', the user value will be ignored.
103 *
104 * Symbols lacking prompts always have visibility 'n'.
105 */
106 tristate visible;
107
108 /* config entries associated with this symbol */
109 struct list_head menus;
110
111 struct list_head choice_link;
112
113 /* SYMBOL_* flags */
114 int flags;
115
116 /* List of properties. See prop_type. */
117 struct property *prop;
118
119 /* Dependencies from enclosing menus, choices, and ifs */
120 struct expr_value dir_dep;
121
122 /* Reverse dependencies through being selected by other symbols */
123 struct expr_value rev_dep;
124
125 /*
126 * "Weak" reverse dependencies through being implied by other symbols
127 */
128 struct expr_value implied;
129 };
130
131 #define SYMBOL_CONST 0x0001 /* symbol is const */
132 #define SYMBOL_CHECK 0x0008 /* used during dependency checking */
133 #define SYMBOL_VALID 0x0080 /* set when symbol.curr is calculated */
134 #define SYMBOL_WRITE 0x0200 /* write symbol to file (KCONFIG_CONFIG) */
135 #define SYMBOL_WRITTEN 0x0800 /* track info to avoid double-write to .config */
136 #define SYMBOL_CHECKED 0x2000 /* used during dependency checking */
137 #define SYMBOL_WARNED 0x8000 /* warning has been issued */
138
139 /* Set when symbol.def[] is used */
140 #define SYMBOL_DEF 0x10000 /* First bit of SYMBOL_DEF */
141 #define SYMBOL_DEF_USER 0x10000 /* symbol.def[S_DEF_USER] is valid */
142 #define SYMBOL_DEF_AUTO 0x20000 /* symbol.def[S_DEF_AUTO] is valid */
143 #define SYMBOL_DEF3 0x40000 /* symbol.def[S_DEF_3] is valid */
144 #define SYMBOL_DEF4 0x80000 /* symbol.def[S_DEF_4] is valid */
145
146 #define SYMBOL_MAXLENGTH 256
147
148 /* A property represent the config options that can be associated
149 * with a config "symbol".
150 * Sample:
151 * config FOO
152 * default y
153 * prompt "foo prompt"
154 * select BAR
155 * config BAZ
156 * int "BAZ Value"
157 * range 1..255
158 *
159 * Please, also check parser.y:print_symbol() when modifying the
160 * list of property types!
161 */
162 enum prop_type {
163 P_UNKNOWN,
164 P_PROMPT, /* prompt "foo prompt" or "BAZ Value" */
165 P_COMMENT, /* text associated with a comment */
166 P_MENU, /* prompt associated with a menu or menuconfig symbol */
167 P_DEFAULT, /* default y */
168 P_SELECT, /* select BAR */
169 P_IMPLY, /* imply BAR */
170 P_RANGE, /* range 7..100 (for a symbol) */
171 P_SYMBOL, /* where a symbol is defined */
172 };
173
174 struct property {
175 struct property *next; /* next property - null if last */
176 enum prop_type type; /* type of property */
177 const char *text; /* the prompt value - P_PROMPT, P_MENU, P_COMMENT */
178 struct expr_value visible;
179 struct expr *expr; /* the optional conditional part of the property */
180 struct menu *menu; /* the menu the property are associated with
181 * valid for: P_SELECT, P_RANGE,
182 * P_PROMPT, P_DEFAULT, P_MENU, P_COMMENT */
183 const char *filename; /* what file was this property defined */
184 int lineno; /* what lineno was this property defined */
185 };
186
187 #define for_all_properties(sym, st, tok) \
188 for (st = sym->prop; st; st = st->next) \
189 if (st->type == (tok))
190 #define for_all_defaults(sym, st) for_all_properties(sym, st, P_DEFAULT)
191 #define for_all_prompts(sym, st) \
192 for (st = sym->prop; st; st = st->next) \
193 if (st->text)
194
195 /*
196 * Represents a node in the menu tree, as seen in e.g. menuconfig (though used
197 * for all front ends). Each symbol, menu, etc. defined in the Kconfig files
198 * gets a node. A symbol defined in multiple locations gets one node at each
199 * location.
200 *
201 * @choice_members: list of choice members with priority.
202 */
203 struct menu {
204 /* The next menu node at the same level */
205 struct menu *next;
206
207 /* The parent menu node, corresponding to e.g. a menu or choice */
208 struct menu *parent;
209
210 /* The first child menu node, for e.g. menus and choices */
211 struct menu *list;
212
213 /*
214 * The symbol associated with the menu node. Choices are implemented as
215 * a special kind of symbol. NULL for menus, comments, and ifs.
216 */
217 struct symbol *sym;
218
219 struct list_head link; /* link to symbol::menus */
220
221 struct list_head choice_members;
222
223 /*
224 * The prompt associated with the node. This holds the prompt for a
225 * symbol as well as the text for a menu or comment, along with the
226 * type (P_PROMPT, P_MENU, etc.)
227 */
228 struct property *prompt;
229
230 /*
231 * 'visible if' dependencies. If more than one is given, they will be
232 * ANDed together.
233 */
234 struct expr *visibility;
235
236 /*
237 * Ordinary dependencies from e.g. 'depends on' and 'if', ANDed
238 * together
239 */
240 struct expr *dep;
241
242 /* MENU_* flags */
243 unsigned int flags;
244
245 /* Any help text associated with the node */
246 char *help;
247
248 /* The location where the menu node appears in the Kconfig files */
249 const char *filename;
250 int lineno;
251
252 /* For use by front ends that need to store auxiliary data */
253 void *data;
254 };
255
256 /*
257 * Set on a menu node when the corresponding symbol changes state in some way.
258 * Can be checked by front ends.
259 */
260 #define MENU_CHANGED 0x0001
261
262 #define MENU_ROOT 0x0002
263
264 struct jump_key {
265 struct list_head entries;
266 size_t offset;
267 struct menu *target;
268 };
269
270 extern struct symbol symbol_yes, symbol_no, symbol_mod;
271 extern struct symbol *modules_sym;
272 extern int cdebug;
273 struct expr *expr_alloc_symbol(struct symbol *sym);
274 struct expr *expr_alloc_one(enum expr_type type, struct expr *ce);
275 struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2);
276 struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2);
277 struct expr *expr_alloc_and(struct expr *e1, struct expr *e2);
278 struct expr *expr_alloc_or(struct expr *e1, struct expr *e2);
279 struct expr *expr_copy(const struct expr *org);
280 void expr_free(struct expr *e);
281 void expr_eliminate_eq(struct expr **ep1, struct expr **ep2);
282 int expr_eq(struct expr *e1, struct expr *e2);
283 tristate expr_calc_value(struct expr *e);
284 struct expr *expr_eliminate_dups(struct expr *e);
285 struct expr *expr_transform(struct expr *e);
286 int expr_contains_symbol(struct expr *dep, struct symbol *sym);
287 bool expr_depends_symbol(struct expr *dep, struct symbol *sym);
288 struct expr *expr_trans_compare(struct expr *e, enum expr_type type, struct symbol *sym);
289
290 void expr_fprint(struct expr *e, FILE *out);
291 struct gstr; /* forward */
292 void expr_gstr_print(const struct expr *e, struct gstr *gs);
293 void expr_gstr_print_revdep(struct expr *e, struct gstr *gs,
294 tristate pr_type, const char *title);
295
expr_is_yes(const struct expr * e)296 static inline int expr_is_yes(const struct expr *e)
297 {
298 return !e || (e->type == E_SYMBOL && e->left.sym == &symbol_yes);
299 }
300
301 #ifdef __cplusplus
302 }
303 #endif
304
305 #endif /* EXPR_H */
306