blob: e436ba44c9c5fd89ddb7c3152a4b6969d9fe9a91 [file] [log] [blame]
Masahiro Yamada0c874102018-12-18 21:13:35 +09001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 */
5
Arnaud Lacombedd003302011-06-01 16:06:22 -04006#include <ctype.h>
Arnaud Lacombe10a4b272011-06-01 16:00:46 -04007#include <stdarg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#include <stdlib.h>
9#include <string.h>
10
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include "lkc.h"
12
Arnaud Lacombe57e62922011-08-03 21:52:07 -040013static const char nohelp_text[] = "There is no help available for this option.";
Cheng Renquan6bd59992009-07-12 16:11:44 +080014
Linus Torvalds1da177e2005-04-16 15:20:36 -070015struct menu rootmenu;
16static struct menu **last_entry_ptr;
17
18struct file *file_list;
19struct file *current_file;
20
Roman Zippel93449082008-01-14 04:50:54 +010021void menu_warn(struct menu *menu, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -070022{
23 va_list ap;
24 va_start(ap, fmt);
25 fprintf(stderr, "%s:%d:warning: ", menu->file->name, menu->lineno);
26 vfprintf(stderr, fmt, ap);
27 fprintf(stderr, "\n");
28 va_end(ap);
29}
30
31static void prop_warn(struct property *prop, const char *fmt, ...)
32{
33 va_list ap;
34 va_start(ap, fmt);
35 fprintf(stderr, "%s:%d:warning: ", prop->file->name, prop->lineno);
36 vfprintf(stderr, fmt, ap);
37 fprintf(stderr, "\n");
38 va_end(ap);
39}
40
nir.tzachar@gmail.com692d97c2009-11-25 12:28:43 +020041void _menu_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -070042{
43 current_entry = current_menu = &rootmenu;
44 last_entry_ptr = &rootmenu.list;
45}
46
47void menu_add_entry(struct symbol *sym)
48{
49 struct menu *menu;
50
Alan Cox177acf72012-11-06 14:32:08 +000051 menu = xmalloc(sizeof(*menu));
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 memset(menu, 0, sizeof(*menu));
53 menu->sym = sym;
54 menu->parent = current_menu;
55 menu->file = current_file;
56 menu->lineno = zconf_lineno();
57
58 *last_entry_ptr = menu;
59 last_entry_ptr = &menu->next;
60 current_entry = menu;
Sam Ravnborg59e89e32010-07-31 23:35:29 +020061 if (sym)
62 menu_add_symbol(P_SYMBOL, sym, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063}
64
Roman Zippela02f0572005-11-08 21:34:53 -080065struct menu *menu_add_menu(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066{
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 last_entry_ptr = &current_entry->list;
Roman Zippela02f0572005-11-08 21:34:53 -080068 return current_menu = current_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069}
70
71void menu_end_menu(void)
72{
73 last_entry_ptr = &current_menu->next;
74 current_menu = current_menu->parent;
75}
76
Ulf Magnusson9a826842017-10-05 14:01:13 +020077/*
78 * Rewrites 'm' to 'm' && MODULES, so that it evaluates to 'n' when running
79 * without modules
80 */
81static struct expr *rewrite_m(struct expr *e)
Linus Torvalds1da177e2005-04-16 15:20:36 -070082{
83 if (!e)
84 return e;
85
86 switch (e->type) {
87 case E_NOT:
Ulf Magnusson9a826842017-10-05 14:01:13 +020088 e->left.expr = rewrite_m(e->left.expr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 break;
90 case E_OR:
91 case E_AND:
Ulf Magnusson9a826842017-10-05 14:01:13 +020092 e->left.expr = rewrite_m(e->left.expr);
93 e->right.expr = rewrite_m(e->right.expr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 break;
95 case E_SYMBOL:
96 /* change 'm' into 'm' && MODULES */
97 if (e->left.sym == &symbol_mod)
98 return expr_alloc_and(e, expr_alloc_symbol(modules_sym));
99 break;
100 default:
101 break;
102 }
103 return e;
104}
105
106void menu_add_dep(struct expr *dep)
107{
Ulf Magnussonf77850d2017-10-05 14:01:15 +0200108 current_entry->dep = expr_alloc_and(current_entry->dep, dep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109}
110
111void menu_set_type(int type)
112{
113 struct symbol *sym = current_entry->sym;
114
115 if (sym->type == type)
116 return;
117 if (sym->type == S_UNKNOWN) {
118 sym->type = type;
119 return;
120 }
Martin Walch57540f1d2013-10-03 18:32:02 +0200121 menu_warn(current_entry,
122 "ignoring type redefinition of '%s' from '%s' to '%s'",
123 sym->name ? sym->name : "<choice>",
124 sym_type_name(sym->type), sym_type_name(type));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125}
126
Masahiro Yamada2ffeef62019-12-17 13:14:21 +0900127static struct property *menu_add_prop(enum prop_type type, struct expr *expr,
128 struct expr *dep)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129{
Masahiro Yamadaadf7c5b2019-12-17 13:14:23 +0900130 struct property *prop;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
Masahiro Yamadaadf7c5b2019-12-17 13:14:23 +0900132 prop = xmalloc(sizeof(*prop));
133 memset(prop, 0, sizeof(*prop));
134 prop->type = type;
135 prop->file = current_file;
136 prop->lineno = zconf_lineno();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 prop->menu = current_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 prop->expr = expr;
Ulf Magnussonf77850d2017-10-05 14:01:15 +0200139 prop->visible.expr = dep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Masahiro Yamadaadf7c5b2019-12-17 13:14:23 +0900141 /* append property to the prop list of symbol */
142 if (current_entry->sym) {
143 struct property **propp;
144
145 for (propp = &current_entry->sym->prop;
146 *propp;
147 propp = &(*propp)->next)
148 ;
149 *propp = prop;
150 }
151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 return prop;
153}
154
Masahiro Yamada024352ff2019-12-17 13:14:20 +0900155struct property *menu_add_prompt(enum prop_type type, char *prompt,
156 struct expr *dep)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157{
Masahiro Yamada2ffeef62019-12-17 13:14:21 +0900158 struct property *prop = menu_add_prop(type, NULL, dep);
Masahiro Yamada024352ff2019-12-17 13:14:20 +0900159
160 if (isspace(*prompt)) {
161 prop_warn(prop, "leading whitespace ignored");
162 while (isspace(*prompt))
163 prompt++;
164 }
165 if (current_entry->prompt)
166 prop_warn(prop, "prompt redefined");
167
168 /* Apply all upper menus' visibilities to actual prompts. */
169 if (type == P_PROMPT) {
170 struct menu *menu = current_entry;
171
172 while ((menu = menu->parent) != NULL) {
173 struct expr *dup_expr;
174
175 if (!menu->visibility)
176 continue;
177 /*
178 * Do not add a reference to the menu's visibility
179 * expression but use a copy of it. Otherwise the
180 * expression reduction functions will modify
181 * expressions that have multiple references which
182 * can cause unwanted side effects.
183 */
184 dup_expr = expr_copy(menu->visibility);
185
186 prop->visible.expr = expr_alloc_and(prop->visible.expr,
187 dup_expr);
188 }
189 }
190
191 current_entry->prompt = prop;
192 prop->text = prompt;
193
194 return prop;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195}
196
Arnaud Lacombe86e187f2010-11-06 18:30:23 -0300197void menu_add_visibility(struct expr *expr)
198{
199 current_entry->visibility = expr_alloc_and(current_entry->visibility,
200 expr);
201}
202
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
204{
Masahiro Yamada2ffeef62019-12-17 13:14:21 +0900205 menu_add_prop(type, expr, dep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206}
207
208void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
209{
Masahiro Yamada2ffeef62019-12-17 13:14:21 +0900210 menu_add_prop(type, expr_alloc_symbol(sym), dep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211}
212
Masahiro Yamadace2164a2018-12-11 20:01:00 +0900213void menu_add_option_modules(void)
Roman Zippelf6a88aa2006-06-08 22:12:44 -0700214{
Masahiro Yamadace2164a2018-12-11 20:01:00 +0900215 if (modules_sym)
216 zconf_error("symbol '%s' redefines option 'modules' already defined by symbol '%s'",
217 current_entry->sym->name, modules_sym->name);
218 modules_sym = current_entry->sym;
219}
220
221void menu_add_option_defconfig_list(void)
222{
223 if (!sym_defconfig_list)
224 sym_defconfig_list = current_entry->sym;
225 else if (sym_defconfig_list != current_entry->sym)
226 zconf_error("trying to redefine defconfig symbol");
227 sym_defconfig_list->flags |= SYMBOL_NO_WRITE;
228}
229
230void menu_add_option_allnoconfig_y(void)
231{
232 current_entry->sym->flags |= SYMBOL_ALLNOCONFIG_Y;
Roman Zippelf6a88aa2006-06-08 22:12:44 -0700233}
234
Arnaud Lacombeab60bd02010-12-05 01:29:25 -0500235static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
Roman Zippel4cf3cbe2005-11-08 21:34:49 -0800236{
237 return sym2->type == S_INT || sym2->type == S_HEX ||
238 (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
239}
240
Trevor Keith4356f482009-09-18 12:49:23 -0700241static void sym_check_prop(struct symbol *sym)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242{
243 struct property *prop;
244 struct symbol *sym2;
Nicolas Pitre237e3ad2016-11-11 00:10:05 -0500245 char *use;
246
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 for (prop = sym->prop; prop; prop = prop->next) {
248 switch (prop->type) {
249 case P_DEFAULT:
250 if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
251 prop->expr->type != E_SYMBOL)
252 prop_warn(prop,
Li Zefan4280eae2010-04-14 11:44:05 +0800253 "default for config symbol '%s'"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 " must be a single symbol", sym->name);
Arnaud Lacombeab60bd02010-12-05 01:29:25 -0500255 if (prop->expr->type != E_SYMBOL)
256 break;
257 sym2 = prop_get_symbol(prop);
258 if (sym->type == S_HEX || sym->type == S_INT) {
259 if (!menu_validate_number(sym, sym2))
260 prop_warn(prop,
261 "'%s': number is invalid",
262 sym->name);
263 }
Ulf Magnusson2c37e082017-10-04 01:25:46 +0200264 if (sym_is_choice(sym)) {
265 struct property *choice_prop =
266 sym_get_choice_prop(sym2);
267
268 if (!choice_prop ||
269 prop_get_symbol(choice_prop) != sym)
270 prop_warn(prop,
271 "choice default symbol '%s' is not contained in the choice",
272 sym2->name);
273 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 break;
275 case P_SELECT:
Nicolas Pitre237e3ad2016-11-11 00:10:05 -0500276 case P_IMPLY:
277 use = prop->type == P_SELECT ? "select" : "imply";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 sym2 = prop_get_symbol(prop);
279 if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
280 prop_warn(prop,
Nicolas Pitre237e3ad2016-11-11 00:10:05 -0500281 "config symbol '%s' uses %s, but is "
Masahiro Yamadab92d8042017-12-16 00:38:02 +0900282 "not bool or tristate", sym->name, use);
Sam Ravnborg603d4982008-02-02 21:09:57 +0100283 else if (sym2->type != S_UNKNOWN &&
Masahiro Yamadabb66fc62014-06-10 19:08:13 +0900284 sym2->type != S_BOOLEAN &&
285 sym2->type != S_TRISTATE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 prop_warn(prop,
Nicolas Pitre237e3ad2016-11-11 00:10:05 -0500287 "'%s' has wrong type. '%s' only "
Masahiro Yamadab92d8042017-12-16 00:38:02 +0900288 "accept arguments of bool and "
Nicolas Pitre237e3ad2016-11-11 00:10:05 -0500289 "tristate type", sym2->name, use);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 break;
291 case P_RANGE:
292 if (sym->type != S_INT && sym->type != S_HEX)
293 prop_warn(prop, "range is only allowed "
Masahiro Yamadabb66fc62014-06-10 19:08:13 +0900294 "for int or hex symbols");
Arnaud Lacombeab60bd02010-12-05 01:29:25 -0500295 if (!menu_validate_number(sym, prop->expr->left.sym) ||
296 !menu_validate_number(sym, prop->expr->right.sym))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 prop_warn(prop, "range is invalid");
298 break;
299 default:
300 ;
301 }
302 }
303}
304
305void menu_finalize(struct menu *parent)
306{
307 struct menu *menu, *last_menu;
308 struct symbol *sym;
309 struct property *prop;
310 struct expr *parentdep, *basedep, *dep, *dep2, **ep;
311
312 sym = parent->sym;
313 if (parent->list) {
Ulf Magnussonfa8ceda2017-10-05 14:01:14 +0200314 /*
315 * This menu node has children. We (recursively) process them
316 * and propagate parent dependencies before moving on.
317 */
318
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 if (sym && sym_is_choice(sym)) {
Roman Zippel5a1aa8a2008-02-29 05:11:50 +0100320 if (sym->type == S_UNKNOWN) {
321 /* find the first choice value to find out choice type */
322 current_entry = parent;
323 for (menu = parent->list; menu; menu = menu->next) {
324 if (menu->sym && menu->sym->type != S_UNKNOWN) {
Jan Beulichf5eaa322008-01-24 11:54:23 +0000325 menu_set_type(menu->sym->type);
Roman Zippel5a1aa8a2008-02-29 05:11:50 +0100326 break;
327 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 }
329 }
Roman Zippel5a1aa8a2008-02-29 05:11:50 +0100330 /* set the type of the remaining choice values */
331 for (menu = parent->list; menu; menu = menu->next) {
332 current_entry = menu;
333 if (menu->sym && menu->sym->type == S_UNKNOWN)
334 menu_set_type(sym->type);
335 }
Ulf Magnussond3465af2018-01-14 15:12:05 +0100336
337 /*
338 * Use the choice itself as the parent dependency of
339 * the contained items. This turns the mode of the
340 * choice into an upper bound on the visibility of the
341 * choice value symbols.
342 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 parentdep = expr_alloc_symbol(sym);
Masahiro Yamadade026ca2019-12-17 13:14:17 +0900344 } else {
345 /* Menu node for 'menu', 'if' */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 parentdep = parent->dep;
Masahiro Yamadade026ca2019-12-17 13:14:17 +0900347 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
Ulf Magnussonfa8ceda2017-10-05 14:01:14 +0200349 /* For each child menu node... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 for (menu = parent->list; menu; menu = menu->next) {
Ulf Magnussonfa8ceda2017-10-05 14:01:14 +0200351 /*
352 * Propagate parent dependencies to the child menu
353 * node, also rewriting and simplifying expressions
354 */
Ulf Magnussonf77850d2017-10-05 14:01:15 +0200355 basedep = rewrite_m(menu->dep);
356 basedep = expr_transform(basedep);
Linus Torvaldse8b8c972007-10-19 21:25:45 -0700357 basedep = expr_alloc_and(expr_copy(parentdep), basedep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 basedep = expr_eliminate_dups(basedep);
359 menu->dep = basedep;
Ulf Magnussonfa8ceda2017-10-05 14:01:14 +0200360
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 if (menu->sym)
Ulf Magnussonfa8ceda2017-10-05 14:01:14 +0200362 /*
363 * Note: For symbols, all prompts are included
364 * too in the symbol's own property list
365 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 prop = menu->sym->prop;
367 else
Ulf Magnussonfa8ceda2017-10-05 14:01:14 +0200368 /*
369 * For non-symbol menu nodes, we just need to
370 * handle the prompt
371 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 prop = menu->prompt;
Ulf Magnussonfa8ceda2017-10-05 14:01:14 +0200373
374 /* For each property... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 for (; prop; prop = prop->next) {
376 if (prop->menu != menu)
Ulf Magnussonfa8ceda2017-10-05 14:01:14 +0200377 /*
378 * Two possibilities:
379 *
380 * 1. The property lacks dependencies
381 * and so isn't location-specific,
382 * e.g. an 'option'
383 *
384 * 2. The property belongs to a symbol
385 * defined in multiple locations and
386 * is from some other location. It
387 * will be handled there in that
388 * case.
389 *
390 * Skip the property.
391 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 continue;
Ulf Magnussonfa8ceda2017-10-05 14:01:14 +0200393
394 /*
395 * Propagate parent dependencies to the
396 * property's condition, rewriting and
397 * simplifying expressions at the same time
398 */
Ulf Magnussonf77850d2017-10-05 14:01:15 +0200399 dep = rewrite_m(prop->visible.expr);
400 dep = expr_transform(dep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 dep = expr_alloc_and(expr_copy(basedep), dep);
402 dep = expr_eliminate_dups(dep);
403 if (menu->sym && menu->sym->type != S_TRISTATE)
404 dep = expr_trans_bool(dep);
405 prop->visible.expr = dep;
Ulf Magnussonfa8ceda2017-10-05 14:01:14 +0200406
407 /*
408 * Handle selects and implies, which modify the
409 * dependencies of the selected/implied symbol
410 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 if (prop->type == P_SELECT) {
412 struct symbol *es = prop_get_symbol(prop);
413 es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
414 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
Nicolas Pitre237e3ad2016-11-11 00:10:05 -0500415 } else if (prop->type == P_IMPLY) {
416 struct symbol *es = prop_get_symbol(prop);
417 es->implied.expr = expr_alloc_or(es->implied.expr,
418 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 }
420 }
421 }
Ulf Magnussonfa8ceda2017-10-05 14:01:14 +0200422
Ulf Magnusson7cf33f82017-10-08 19:35:46 +0200423 if (sym && sym_is_choice(sym))
424 expr_free(parentdep);
425
Ulf Magnussonfa8ceda2017-10-05 14:01:14 +0200426 /*
427 * Recursively process children in the same fashion before
428 * moving on
429 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 for (menu = parent->list; menu; menu = menu->next)
431 menu_finalize(menu);
432 } else if (sym) {
Ulf Magnusson05cccce2017-10-08 19:42:18 +0200433 /*
434 * Automatic submenu creation. If sym is a symbol and A, B, C,
435 * ... are consecutive items (symbols, menus, ifs, etc.) that
436 * all depend on sym, then the following menu structure is
437 * created:
438 *
439 * sym
440 * +-A
441 * +-B
442 * +-C
443 * ...
444 *
445 * This also works recursively, giving the following structure
446 * if A is a symbol and B depends on A:
447 *
448 * sym
449 * +-A
450 * | +-B
451 * +-C
452 * ...
453 */
454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
456 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
457 basedep = expr_eliminate_dups(expr_transform(basedep));
Ulf Magnusson05cccce2017-10-08 19:42:18 +0200458
459 /* Examine consecutive elements after sym */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 last_menu = NULL;
461 for (menu = parent->next; menu; menu = menu->next) {
462 dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
463 if (!expr_contains_symbol(dep, sym))
Ulf Magnusson05cccce2017-10-08 19:42:18 +0200464 /* No dependency, quit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 break;
466 if (expr_depends_symbol(dep, sym))
Ulf Magnusson05cccce2017-10-08 19:42:18 +0200467 /* Absolute dependency, put in submenu */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 goto next;
Ulf Magnusson05cccce2017-10-08 19:42:18 +0200469
470 /*
471 * Also consider it a dependency on sym if our
472 * dependencies contain sym and are a "superset" of
473 * sym's dependencies, e.g. '(sym || Q) && R' when sym
474 * depends on R.
475 *
476 * Note that 'R' might be from an enclosing menu or if,
477 * making this a more common case than it might seem.
478 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
480 dep = expr_eliminate_dups(expr_transform(dep));
481 dep2 = expr_copy(basedep);
482 expr_eliminate_eq(&dep, &dep2);
483 expr_free(dep);
484 if (!expr_is_yes(dep2)) {
Ulf Magnusson05cccce2017-10-08 19:42:18 +0200485 /* Not superset, quit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 expr_free(dep2);
487 break;
488 }
Ulf Magnusson05cccce2017-10-08 19:42:18 +0200489 /* Superset, put in submenu */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 expr_free(dep2);
491 next:
492 menu_finalize(menu);
493 menu->parent = parent;
494 last_menu = menu;
495 }
Ulf Magnussonae7440e2017-10-08 19:35:44 +0200496 expr_free(basedep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 if (last_menu) {
498 parent->list = parent->next;
499 parent->next = last_menu->next;
500 last_menu->next = NULL;
501 }
Arnaud Lacombeff5ff602010-09-26 16:22:03 -0400502
Arnaud Lacombeec6452a2011-06-08 01:42:11 -0400503 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 }
505 for (menu = parent->list; menu; menu = menu->next) {
Roman Zippel5a1aa8a2008-02-29 05:11:50 +0100506 if (sym && sym_is_choice(sym) &&
507 menu->sym && !sym_is_choice_value(menu->sym)) {
508 current_entry = menu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 menu->sym->flags |= SYMBOL_CHOICEVAL;
510 if (!menu->prompt)
511 menu_warn(menu, "choice value must have a prompt");
512 for (prop = menu->sym->prop; prop; prop = prop->next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 if (prop->type == P_DEFAULT)
514 prop_warn(prop, "defaults for choice "
Roman Zippel5a1aa8a2008-02-29 05:11:50 +0100515 "values not supported");
516 if (prop->menu == menu)
517 continue;
518 if (prop->type == P_PROMPT &&
519 prop->menu->parent->sym != sym)
520 prop_warn(prop, "choice value used outside its choice group");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 }
Jan Beulichf5eaa322008-01-24 11:54:23 +0000522 /* Non-tristate choice values of tristate choices must
523 * depend on the choice being set to Y. The choice
524 * values' dependencies were propagated to their
525 * properties above, so the change here must be re-
Roman Zippel5a1aa8a2008-02-29 05:11:50 +0100526 * propagated.
527 */
Jan Beulichf5eaa322008-01-24 11:54:23 +0000528 if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
529 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
Roman Zippel5a1aa8a2008-02-29 05:11:50 +0100530 menu->dep = expr_alloc_and(basedep, menu->dep);
Jan Beulichf5eaa322008-01-24 11:54:23 +0000531 for (prop = menu->sym->prop; prop; prop = prop->next) {
532 if (prop->menu != menu)
533 continue;
Roman Zippel5a1aa8a2008-02-29 05:11:50 +0100534 prop->visible.expr = expr_alloc_and(expr_copy(basedep),
535 prop->visible.expr);
Jan Beulichf5eaa322008-01-24 11:54:23 +0000536 }
537 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 menu_add_symbol(P_CHOICE, sym, NULL);
539 prop = sym_get_choice_prop(sym);
540 for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
541 ;
Roman Zippel7a962922008-01-14 04:50:23 +0100542 *ep = expr_alloc_one(E_LIST, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 (*ep)->right.sym = menu->sym;
544 }
Ulf Magnusson9d1a9e82018-01-14 15:49:26 +0100545
546 /*
547 * This code serves two purposes:
548 *
549 * (1) Flattening 'if' blocks, which do not specify a submenu
550 * and only add dependencies.
551 *
552 * (Automatic submenu creation might still create a submenu
553 * from an 'if' before this code runs.)
554 *
555 * (2) "Undoing" any automatic submenus created earlier below
556 * promptless symbols.
557 *
558 * Before:
559 *
560 * A
561 * if ... (or promptless symbol)
562 * +-B
563 * +-C
564 * D
565 *
566 * After:
567 *
568 * A
569 * if ... (or promptless symbol)
570 * B
571 * C
572 * D
573 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
575 for (last_menu = menu->list; ; last_menu = last_menu->next) {
576 last_menu->parent = parent;
577 if (!last_menu->next)
578 break;
579 }
580 last_menu->next = menu->next;
581 menu->next = menu->list;
582 menu->list = NULL;
583 }
584 }
585
586 if (sym && !(sym->flags & SYMBOL_WARNED)) {
587 if (sym->type == S_UNKNOWN)
Roman Zippelf001f7f2006-06-08 22:12:48 -0700588 menu_warn(parent, "config symbol defined without type");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
590 if (sym_is_choice(sym) && !parent->prompt)
Roman Zippelf001f7f2006-06-08 22:12:48 -0700591 menu_warn(parent, "choice must have a prompt");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
593 /* Check properties connected to this symbol */
594 sym_check_prop(sym);
595 sym->flags |= SYMBOL_WARNED;
596 }
597
Ulf Magnusson3e41ba02018-01-14 10:56:20 +0100598 /*
599 * For non-optional choices, add a reverse dependency (corresponding to
600 * a select) of '<visibility> && m'. This prevents the user from
601 * setting the choice mode to 'n' when the choice is visible.
602 *
603 * This would also work for non-choice symbols, but only non-optional
604 * choices clear SYMBOL_OPTIONAL as of writing. Choices are implemented
605 * as a type of symbol.
606 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 if (sym && !sym_is_optional(sym) && parent->prompt) {
608 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
609 expr_alloc_and(parent->prompt->visible.expr,
610 expr_alloc_symbol(&symbol_mod)));
611 }
612}
613
Li Zefan22c7eca2010-04-14 11:46:02 +0800614bool menu_has_prompt(struct menu *menu)
615{
616 if (!menu->prompt)
617 return false;
618 return true;
619}
620
Dirk Gouders1278ebd2013-05-19 21:49:34 +0200621/*
622 * Determine if a menu is empty.
623 * A menu is considered empty if it contains no or only
624 * invisible entries.
625 */
626bool menu_is_empty(struct menu *menu)
627{
628 struct menu *child;
629
630 for (child = menu->list; child; child = child->next) {
631 if (menu_is_visible(child))
632 return(false);
633 }
634 return(true);
635}
636
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637bool menu_is_visible(struct menu *menu)
638{
639 struct menu *child;
640 struct symbol *sym;
641 tristate visible;
642
643 if (!menu->prompt)
644 return false;
Li Zefan22c7eca2010-04-14 11:46:02 +0800645
Arnaud Lacombe86e187f2010-11-06 18:30:23 -0300646 if (menu->visibility) {
647 if (expr_calc_value(menu->visibility) == no)
Vegard Nossumaab24a82016-01-01 17:34:05 +0100648 return false;
Arnaud Lacombe86e187f2010-11-06 18:30:23 -0300649 }
650
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 sym = menu->sym;
652 if (sym) {
653 sym_calc_value(sym);
654 visible = menu->prompt->visible.tri;
655 } else
656 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
657
658 if (visible != no)
659 return true;
Li Zefan22c7eca2010-04-14 11:46:02 +0800660
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 if (!sym || sym_get_tristate_value(menu->sym) == no)
662 return false;
663
Li Zefan3fb9acb2010-05-07 13:57:07 +0800664 for (child = menu->list; child; child = child->next) {
665 if (menu_is_visible(child)) {
666 if (sym)
667 sym->flags |= SYMBOL_DEF_USER;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 return true;
Li Zefan3fb9acb2010-05-07 13:57:07 +0800669 }
670 }
Li Zefan22c7eca2010-04-14 11:46:02 +0800671
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 return false;
673}
674
675const char *menu_get_prompt(struct menu *menu)
676{
677 if (menu->prompt)
EGRY Gabor01771b02008-01-11 23:53:43 +0100678 return menu->prompt->text;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 else if (menu->sym)
EGRY Gabor01771b02008-01-11 23:53:43 +0100680 return menu->sym->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 return NULL;
682}
683
684struct menu *menu_get_root_menu(struct menu *menu)
685{
686 return &rootmenu;
687}
688
689struct menu *menu_get_parent_menu(struct menu *menu)
690{
691 enum prop_type type;
692
693 for (; menu != &rootmenu; menu = menu->parent) {
694 type = menu->prompt ? menu->prompt->type : 0;
695 if (type == P_MENU)
696 break;
697 }
698 return menu;
699}
700
Sam Ravnborg03d29122007-07-21 00:00:36 +0200701bool menu_has_help(struct menu *menu)
702{
703 return menu->help != NULL;
704}
705
706const char *menu_get_help(struct menu *menu)
707{
708 if (menu->help)
709 return menu->help;
710 else
711 return "";
712}
Cheng Renquan6bd59992009-07-12 16:11:44 +0800713
Thomas Hebbedda15f2019-12-17 08:15:43 -0800714static void get_def_str(struct gstr *r, struct menu *menu)
715{
716 str_printf(r, "Defined at %s:%d\n",
717 menu->file->name, menu->lineno);
718}
719
720static void get_dep_str(struct gstr *r, struct expr *expr, const char *prefix)
721{
722 if (!expr_is_yes(expr)) {
723 str_append(r, prefix);
724 expr_gstr_print(expr, r);
725 str_append(r, "\n");
726 }
727}
728
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400729static void get_prompt_str(struct gstr *r, struct property *prop,
Benjamin Poirierbad99552012-10-21 05:27:53 -0400730 struct list_head *head)
Cheng Renquan6bd59992009-07-12 16:11:44 +0800731{
732 int i, j;
Benjamin Poirier5e609ad2012-08-23 14:55:06 -0400733 struct menu *submenu[8], *menu, *location = NULL;
Peter Kümmel2d560302014-11-04 12:01:59 +0100734 struct jump_key *jump = NULL;
Cheng Renquan6bd59992009-07-12 16:11:44 +0800735
Thomas Hebbedda15f2019-12-17 08:15:43 -0800736 str_printf(r, " Prompt: %s\n", prop->text);
737
738 get_dep_str(r, prop->menu->dep, " Depends on: ");
Thomas Hebb3460d0bc2019-12-17 08:15:44 -0800739 /*
740 * Most prompts in Linux have visibility that exactly matches their
741 * dependencies. For these, we print only the dependencies to improve
742 * readability. However, prompts with inline "if" expressions and
743 * prompts with a parent that has a "visible if" expression have
744 * differing dependencies and visibility. In these rare cases, we
745 * print both.
746 */
747 if (!expr_eq(prop->menu->dep, prop->visible.expr))
748 get_dep_str(r, prop->visible.expr, " Visible if: ");
749
Cheng Renquan6bd59992009-07-12 16:11:44 +0800750 menu = prop->menu->parent;
Benjamin Poirier5e609ad2012-08-23 14:55:06 -0400751 for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
752 bool accessible = menu_is_visible(menu);
753
Cheng Renquan6bd59992009-07-12 16:11:44 +0800754 submenu[i++] = menu;
Benjamin Poirier5e609ad2012-08-23 14:55:06 -0400755 if (location == NULL && accessible)
756 location = menu;
757 }
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400758 if (head && location) {
Alan Cox177acf72012-11-06 14:32:08 +0000759 jump = xmalloc(sizeof(struct jump_key));
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400760
Benjamin Poirier5e609ad2012-08-23 14:55:06 -0400761 if (menu_is_visible(prop->menu)) {
762 /*
763 * There is not enough room to put the hint at the
764 * beginning of the "Prompt" line. Put the hint on the
765 * last "Location" line even when it would belong on
766 * the former.
767 */
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400768 jump->target = prop->menu;
Benjamin Poirier5e609ad2012-08-23 14:55:06 -0400769 } else
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400770 jump->target = location;
771
Benjamin Poirierbad99552012-10-21 05:27:53 -0400772 if (list_empty(head))
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400773 jump->index = 0;
774 else
Benjamin Poirierbad99552012-10-21 05:27:53 -0400775 jump->index = list_entry(head->prev, struct jump_key,
776 entries)->index + 1;
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400777
Benjamin Poirierbad99552012-10-21 05:27:53 -0400778 list_add_tail(&jump->entries, head);
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400779 }
Benjamin Poirier5e609ad2012-08-23 14:55:06 -0400780
Cheng Renquan6bd59992009-07-12 16:11:44 +0800781 if (i > 0) {
Sam Ravnborg694c49a2018-05-22 21:36:12 +0200782 str_printf(r, " Location:\n");
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400783 for (j = 4; --i >= 0; j += 2) {
Cheng Renquan6bd59992009-07-12 16:11:44 +0800784 menu = submenu[i];
Peter Kümmel2d560302014-11-04 12:01:59 +0100785 if (jump && menu == location)
Martin Walch503c8232013-10-03 18:35:16 +0200786 jump->offset = strlen(r->s);
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400787 str_printf(r, "%*c-> %s", j, ' ',
Sam Ravnborg694c49a2018-05-22 21:36:12 +0200788 menu_get_prompt(menu));
Cheng Renquan6bd59992009-07-12 16:11:44 +0800789 if (menu->sym) {
790 str_printf(r, " (%s [=%s])", menu->sym->name ?
Sam Ravnborg694c49a2018-05-22 21:36:12 +0200791 menu->sym->name : "<choice>",
Cheng Renquan6bd59992009-07-12 16:11:44 +0800792 sym_get_string_value(menu->sym));
793 }
794 str_append(r, "\n");
795 }
796 }
797}
798
Nicolas Pitre237e3ad2016-11-11 00:10:05 -0500799static void get_symbol_props_str(struct gstr *r, struct symbol *sym,
800 enum prop_type tok, const char *prefix)
801{
802 bool hit = false;
803 struct property *prop;
804
805 for_all_properties(sym, prop, tok) {
806 if (!hit) {
807 str_append(r, prefix);
808 hit = true;
809 } else
810 str_printf(r, " && ");
811 expr_gstr_print(prop->expr, r);
812 }
813 if (hit)
814 str_append(r, "\n");
815}
816
Wengmeilingbcdedcc2013-04-30 15:28:46 -0700817/*
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400818 * head is optional and may be NULL
Benjamin Poirier5e609ad2012-08-23 14:55:06 -0400819 */
Michal Marekad8d40c2015-02-24 16:37:13 +0100820static void get_symbol_str(struct gstr *r, struct symbol *sym,
Benjamin Poirierbad99552012-10-21 05:27:53 -0400821 struct list_head *head)
Cheng Renquan6bd59992009-07-12 16:11:44 +0800822{
Cheng Renquan6bd59992009-07-12 16:11:44 +0800823 struct property *prop;
824
Li Zefanb040b442010-05-07 13:56:33 +0800825 if (sym && sym->name) {
Cheng Renquan6bd59992009-07-12 16:11:44 +0800826 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
827 sym_get_string_value(sym));
Li Zefanb040b442010-05-07 13:56:33 +0800828 str_printf(r, "Type : %s\n", sym_type_name(sym->type));
Li Zefan70ed0742010-05-07 13:56:50 +0800829 if (sym->type == S_INT || sym->type == S_HEX) {
830 prop = sym_get_range_prop(sym);
831 if (prop) {
832 str_printf(r, "Range : ");
833 expr_gstr_print(prop->expr, r);
834 str_append(r, "\n");
835 }
836 }
Li Zefanb040b442010-05-07 13:56:33 +0800837 }
Li Zefan383da762013-05-07 15:56:54 +0200838
Thomas Hebbedda15f2019-12-17 08:15:43 -0800839 /* Print the definitions with prompts before the ones without */
840 for_all_properties(sym, prop, P_SYMBOL) {
841 if (prop->menu->prompt) {
842 get_def_str(r, prop->menu);
843 get_prompt_str(r, prop->menu->prompt, head);
844 }
845 }
846
847 for_all_properties(sym, prop, P_SYMBOL) {
848 if (!prop->menu->prompt) {
849 get_def_str(r, prop->menu);
850 get_dep_str(r, prop->menu->dep, " Depends on: ");
Li Zefan383da762013-05-07 15:56:54 +0200851 }
Wengmeilingbcdedcc2013-04-30 15:28:46 -0700852 }
Li Zefan383da762013-05-07 15:56:54 +0200853
Thomas Hebba9609682019-12-17 08:15:45 -0800854 get_symbol_props_str(r, sym, P_SELECT, "Selects: ");
Cheng Renquan6bd59992009-07-12 16:11:44 +0800855 if (sym->rev_dep.expr) {
Thomas Hebba9609682019-12-17 08:15:45 -0800856 expr_gstr_print_revdep(sym->rev_dep.expr, r, yes, "Selected by [y]:\n");
857 expr_gstr_print_revdep(sym->rev_dep.expr, r, mod, "Selected by [m]:\n");
858 expr_gstr_print_revdep(sym->rev_dep.expr, r, no, "Selected by [n]:\n");
Cheng Renquan6bd59992009-07-12 16:11:44 +0800859 }
Nicolas Pitre237e3ad2016-11-11 00:10:05 -0500860
Thomas Hebba9609682019-12-17 08:15:45 -0800861 get_symbol_props_str(r, sym, P_IMPLY, "Implies: ");
Nicolas Pitre237e3ad2016-11-11 00:10:05 -0500862 if (sym->implied.expr) {
Thomas Hebba9609682019-12-17 08:15:45 -0800863 expr_gstr_print_revdep(sym->implied.expr, r, yes, "Implied by [y]:\n");
864 expr_gstr_print_revdep(sym->implied.expr, r, mod, "Implied by [m]:\n");
865 expr_gstr_print_revdep(sym->implied.expr, r, no, "Implied by [n]:\n");
Nicolas Pitre237e3ad2016-11-11 00:10:05 -0500866 }
867
Cheng Renquan6bd59992009-07-12 16:11:44 +0800868 str_append(r, "\n\n");
869}
870
Benjamin Poirierbad99552012-10-21 05:27:53 -0400871struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
nir.tzachar@gmail.com692d97c2009-11-25 12:28:43 +0200872{
873 struct symbol *sym;
874 struct gstr res = str_new();
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400875 int i;
nir.tzachar@gmail.com692d97c2009-11-25 12:28:43 +0200876
877 for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400878 get_symbol_str(&res, sym, head);
nir.tzachar@gmail.com692d97c2009-11-25 12:28:43 +0200879 if (!i)
Sam Ravnborg694c49a2018-05-22 21:36:12 +0200880 str_append(&res, "No matches found.\n");
nir.tzachar@gmail.com692d97c2009-11-25 12:28:43 +0200881 return res;
882}
883
884
Cheng Renquan6bd59992009-07-12 16:11:44 +0800885void menu_get_ext_help(struct menu *menu, struct gstr *help)
886{
887 struct symbol *sym = menu->sym;
Arnaud Lacombe57e62922011-08-03 21:52:07 -0400888 const char *help_text = nohelp_text;
Cheng Renquan6bd59992009-07-12 16:11:44 +0800889
890 if (menu_has_help(menu)) {
Srinivas Kandagatla3f198df2011-08-02 18:49:52 +0100891 if (sym->name)
Arnaud Lacombeffb59572010-08-14 23:57:43 -0400892 str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
Arnaud Lacombe57e62922011-08-03 21:52:07 -0400893 help_text = menu_get_help(menu);
Cheng Renquan6bd59992009-07-12 16:11:44 +0800894 }
Sam Ravnborg694c49a2018-05-22 21:36:12 +0200895 str_printf(help, "%s\n", help_text);
Cheng Renquan47791052009-07-12 16:11:46 +0800896 if (sym)
Benjamin Poirier95ac9b32012-08-23 14:55:08 -0400897 get_symbol_str(help, sym, NULL);
Cheng Renquan6bd59992009-07-12 16:11:44 +0800898}