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