]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - scripts/kconfig/menu.c
Merge tag 'kbuild-v5.14' of git://git.kernel.org/pub/scm/linux/kernel/git/masahiroy...
[mirror_ubuntu-jammy-kernel.git] / scripts / kconfig / menu.c
CommitLineData
0c874100 1// SPDX-License-Identifier: GPL-2.0
1da177e4
LT
2/*
3 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
1da177e4
LT
4 */
5
dd003306 6#include <ctype.h>
10a4b277 7#include <stdarg.h>
1da177e4
LT
8#include <stdlib.h>
9#include <string.h>
10
1da177e4 11#include "lkc.h"
a77a05dc 12#include "internal.h"
1da177e4 13
57e6292d 14static const char nohelp_text[] = "There is no help available for this option.";
6bd5999d 15
1da177e4
LT
16struct menu rootmenu;
17static struct menu **last_entry_ptr;
18
19struct file *file_list;
20struct file *current_file;
21
93449082 22void menu_warn(struct menu *menu, const char *fmt, ...)
1da177e4
LT
23{
24 va_list ap;
25 va_start(ap, fmt);
26 fprintf(stderr, "%s:%d:warning: ", menu->file->name, menu->lineno);
27 vfprintf(stderr, fmt, ap);
28 fprintf(stderr, "\n");
29 va_end(ap);
30}
31
32static void prop_warn(struct property *prop, const char *fmt, ...)
33{
34 va_list ap;
35 va_start(ap, fmt);
36 fprintf(stderr, "%s:%d:warning: ", prop->file->name, prop->lineno);
37 vfprintf(stderr, fmt, ap);
38 fprintf(stderr, "\n");
39 va_end(ap);
40}
41
692d97c3 42void _menu_init(void)
1da177e4
LT
43{
44 current_entry = current_menu = &rootmenu;
45 last_entry_ptr = &rootmenu.list;
46}
47
48void menu_add_entry(struct symbol *sym)
49{
50 struct menu *menu;
51
177acf78 52 menu = xmalloc(sizeof(*menu));
1da177e4
LT
53 memset(menu, 0, sizeof(*menu));
54 menu->sym = sym;
55 menu->parent = current_menu;
56 menu->file = current_file;
57 menu->lineno = zconf_lineno();
58
59 *last_entry_ptr = menu;
60 last_entry_ptr = &menu->next;
61 current_entry = menu;
59e89e3d
SR
62 if (sym)
63 menu_add_symbol(P_SYMBOL, sym, NULL);
1da177e4
LT
64}
65
a02f0570 66struct menu *menu_add_menu(void)
1da177e4 67{
1da177e4 68 last_entry_ptr = &current_entry->list;
644a4b6c
MY
69 current_menu = current_entry;
70 return current_menu;
1da177e4
LT
71}
72
73void menu_end_menu(void)
74{
75 last_entry_ptr = &current_menu->next;
76 current_menu = current_menu->parent;
77}
78
9a826842
UM
79/*
80 * Rewrites 'm' to 'm' && MODULES, so that it evaluates to 'n' when running
81 * without modules
82 */
83static struct expr *rewrite_m(struct expr *e)
1da177e4
LT
84{
85 if (!e)
86 return e;
87
88 switch (e->type) {
89 case E_NOT:
9a826842 90 e->left.expr = rewrite_m(e->left.expr);
1da177e4
LT
91 break;
92 case E_OR:
93 case E_AND:
9a826842
UM
94 e->left.expr = rewrite_m(e->left.expr);
95 e->right.expr = rewrite_m(e->right.expr);
1da177e4
LT
96 break;
97 case E_SYMBOL:
98 /* change 'm' into 'm' && MODULES */
99 if (e->left.sym == &symbol_mod)
100 return expr_alloc_and(e, expr_alloc_symbol(modules_sym));
101 break;
102 default:
103 break;
104 }
105 return e;
106}
107
108void menu_add_dep(struct expr *dep)
109{
f77850d3 110 current_entry->dep = expr_alloc_and(current_entry->dep, dep);
1da177e4
LT
111}
112
113void menu_set_type(int type)
114{
115 struct symbol *sym = current_entry->sym;
116
117 if (sym->type == type)
118 return;
119 if (sym->type == S_UNKNOWN) {
120 sym->type = type;
121 return;
122 }
57540f1d
MW
123 menu_warn(current_entry,
124 "ignoring type redefinition of '%s' from '%s' to '%s'",
125 sym->name ? sym->name : "<choice>",
126 sym_type_name(sym->type), sym_type_name(type));
1da177e4
LT
127}
128
2ffeef61
MY
129static struct property *menu_add_prop(enum prop_type type, struct expr *expr,
130 struct expr *dep)
1da177e4 131{
adf7c5bd 132 struct property *prop;
1da177e4 133
adf7c5bd
MY
134 prop = xmalloc(sizeof(*prop));
135 memset(prop, 0, sizeof(*prop));
136 prop->type = type;
137 prop->file = current_file;
138 prop->lineno = zconf_lineno();
1da177e4 139 prop->menu = current_entry;
1da177e4 140 prop->expr = expr;
f77850d3 141 prop->visible.expr = dep;
1da177e4 142
adf7c5bd
MY
143 /* append property to the prop list of symbol */
144 if (current_entry->sym) {
145 struct property **propp;
146
147 for (propp = &current_entry->sym->prop;
148 *propp;
149 propp = &(*propp)->next)
150 ;
151 *propp = prop;
152 }
153
024352ff
MY
154 return prop;
155}
156
157struct property *menu_add_prompt(enum prop_type type, char *prompt,
158 struct expr *dep)
159{
2ffeef61 160 struct property *prop = menu_add_prop(type, NULL, dep);
7ad12278 161
024352ff
MY
162 if (isspace(*prompt)) {
163 prop_warn(prop, "leading whitespace ignored");
164 while (isspace(*prompt))
165 prompt++;
1da177e4 166 }
024352ff
MY
167 if (current_entry->prompt)
168 prop_warn(prop, "prompt redefined");
169
170 /* Apply all upper menus' visibilities to actual prompts. */
171 if (type == P_PROMPT) {
172 struct menu *menu = current_entry;
173
174 while ((menu = menu->parent) != NULL) {
175 struct expr *dup_expr;
176
177 if (!menu->visibility)
178 continue;
179 /*
180 * Do not add a reference to the menu's visibility
181 * expression but use a copy of it. Otherwise the
182 * expression reduction functions will modify
183 * expressions that have multiple references which
184 * can cause unwanted side effects.
185 */
186 dup_expr = expr_copy(menu->visibility);
187
188 prop->visible.expr = expr_alloc_and(prop->visible.expr,
189 dup_expr);
190 }
191 }
192
193 current_entry->prompt = prop;
f001f7f8 194 prop->text = prompt;
1da177e4
LT
195
196 return prop;
197}
198
86e187ff
AL
199void menu_add_visibility(struct expr *expr)
200{
201 current_entry->visibility = expr_alloc_and(current_entry->visibility,
202 expr);
203}
204
1da177e4
LT
205void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
206{
2ffeef61 207 menu_add_prop(type, expr, dep);
1da177e4
LT
208}
209
210void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
211{
2ffeef61 212 menu_add_prop(type, expr_alloc_symbol(sym), dep);
1da177e4
LT
213}
214
ab60bd0b 215static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
4cf3cbe2
RZ
216{
217 return sym2->type == S_INT || sym2->type == S_HEX ||
218 (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
219}
220
4356f489 221static void sym_check_prop(struct symbol *sym)
1da177e4
LT
222{
223 struct property *prop;
224 struct symbol *sym2;
237e3ad0
NP
225 char *use;
226
1da177e4
LT
227 for (prop = sym->prop; prop; prop = prop->next) {
228 switch (prop->type) {
229 case P_DEFAULT:
230 if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
231 prop->expr->type != E_SYMBOL)
232 prop_warn(prop,
4280eae0 233 "default for config symbol '%s'"
1da177e4 234 " must be a single symbol", sym->name);
ab60bd0b
AL
235 if (prop->expr->type != E_SYMBOL)
236 break;
237 sym2 = prop_get_symbol(prop);
238 if (sym->type == S_HEX || sym->type == S_INT) {
239 if (!menu_validate_number(sym, sym2))
240 prop_warn(prop,
241 "'%s': number is invalid",
242 sym->name);
243 }
2c37e084
UM
244 if (sym_is_choice(sym)) {
245 struct property *choice_prop =
246 sym_get_choice_prop(sym2);
247
248 if (!choice_prop ||
249 prop_get_symbol(choice_prop) != sym)
250 prop_warn(prop,
251 "choice default symbol '%s' is not contained in the choice",
252 sym2->name);
253 }
1da177e4
LT
254 break;
255 case P_SELECT:
237e3ad0
NP
256 case P_IMPLY:
257 use = prop->type == P_SELECT ? "select" : "imply";
1da177e4
LT
258 sym2 = prop_get_symbol(prop);
259 if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
260 prop_warn(prop,
237e3ad0 261 "config symbol '%s' uses %s, but is "
b92d804a 262 "not bool or tristate", sym->name, use);
603d4988 263 else if (sym2->type != S_UNKNOWN &&
bb66fc67
MY
264 sym2->type != S_BOOLEAN &&
265 sym2->type != S_TRISTATE)
1da177e4 266 prop_warn(prop,
237e3ad0 267 "'%s' has wrong type. '%s' only "
b92d804a 268 "accept arguments of bool and "
237e3ad0 269 "tristate type", sym2->name, use);
1da177e4
LT
270 break;
271 case P_RANGE:
272 if (sym->type != S_INT && sym->type != S_HEX)
273 prop_warn(prop, "range is only allowed "
bb66fc67 274 "for int or hex symbols");
ab60bd0b
AL
275 if (!menu_validate_number(sym, prop->expr->left.sym) ||
276 !menu_validate_number(sym, prop->expr->right.sym))
1da177e4
LT
277 prop_warn(prop, "range is invalid");
278 break;
279 default:
280 ;
281 }
282 }
283}
284
285void menu_finalize(struct menu *parent)
286{
287 struct menu *menu, *last_menu;
288 struct symbol *sym;
289 struct property *prop;
290 struct expr *parentdep, *basedep, *dep, *dep2, **ep;
291
292 sym = parent->sym;
293 if (parent->list) {
fa8cedae
UM
294 /*
295 * This menu node has children. We (recursively) process them
296 * and propagate parent dependencies before moving on.
297 */
298
1da177e4 299 if (sym && sym_is_choice(sym)) {
5a1aa8a1
RZ
300 if (sym->type == S_UNKNOWN) {
301 /* find the first choice value to find out choice type */
302 current_entry = parent;
303 for (menu = parent->list; menu; menu = menu->next) {
304 if (menu->sym && menu->sym->type != S_UNKNOWN) {
f5eaa323 305 menu_set_type(menu->sym->type);
5a1aa8a1
RZ
306 break;
307 }
1da177e4
LT
308 }
309 }
5a1aa8a1
RZ
310 /* set the type of the remaining choice values */
311 for (menu = parent->list; menu; menu = menu->next) {
312 current_entry = menu;
313 if (menu->sym && menu->sym->type == S_UNKNOWN)
314 menu_set_type(sym->type);
315 }
d3465af6
UM
316
317 /*
318 * Use the choice itself as the parent dependency of
319 * the contained items. This turns the mode of the
320 * choice into an upper bound on the visibility of the
321 * choice value symbols.
322 */
1da177e4 323 parentdep = expr_alloc_symbol(sym);
de026ca9
MY
324 } else {
325 /* Menu node for 'menu', 'if' */
1da177e4 326 parentdep = parent->dep;
de026ca9 327 }
1da177e4 328
fa8cedae 329 /* For each child menu node... */
1da177e4 330 for (menu = parent->list; menu; menu = menu->next) {
fa8cedae
UM
331 /*
332 * Propagate parent dependencies to the child menu
333 * node, also rewriting and simplifying expressions
334 */
f77850d3
UM
335 basedep = rewrite_m(menu->dep);
336 basedep = expr_transform(basedep);
e8b8c977 337 basedep = expr_alloc_and(expr_copy(parentdep), basedep);
1da177e4
LT
338 basedep = expr_eliminate_dups(basedep);
339 menu->dep = basedep;
fa8cedae 340
1da177e4 341 if (menu->sym)
fa8cedae
UM
342 /*
343 * Note: For symbols, all prompts are included
344 * too in the symbol's own property list
345 */
1da177e4
LT
346 prop = menu->sym->prop;
347 else
fa8cedae
UM
348 /*
349 * For non-symbol menu nodes, we just need to
350 * handle the prompt
351 */
1da177e4 352 prop = menu->prompt;
fa8cedae
UM
353
354 /* For each property... */
1da177e4
LT
355 for (; prop; prop = prop->next) {
356 if (prop->menu != menu)
fa8cedae
UM
357 /*
358 * Two possibilities:
359 *
360 * 1. The property lacks dependencies
361 * and so isn't location-specific,
362 * e.g. an 'option'
363 *
364 * 2. The property belongs to a symbol
365 * defined in multiple locations and
366 * is from some other location. It
367 * will be handled there in that
368 * case.
369 *
370 * Skip the property.
371 */
1da177e4 372 continue;
fa8cedae
UM
373
374 /*
375 * Propagate parent dependencies to the
376 * property's condition, rewriting and
377 * simplifying expressions at the same time
378 */
f77850d3
UM
379 dep = rewrite_m(prop->visible.expr);
380 dep = expr_transform(dep);
1da177e4
LT
381 dep = expr_alloc_and(expr_copy(basedep), dep);
382 dep = expr_eliminate_dups(dep);
383 if (menu->sym && menu->sym->type != S_TRISTATE)
384 dep = expr_trans_bool(dep);
385 prop->visible.expr = dep;
fa8cedae
UM
386
387 /*
388 * Handle selects and implies, which modify the
389 * dependencies of the selected/implied symbol
390 */
1da177e4
LT
391 if (prop->type == P_SELECT) {
392 struct symbol *es = prop_get_symbol(prop);
393 es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
394 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
237e3ad0
NP
395 } else if (prop->type == P_IMPLY) {
396 struct symbol *es = prop_get_symbol(prop);
397 es->implied.expr = expr_alloc_or(es->implied.expr,
398 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
1da177e4
LT
399 }
400 }
401 }
fa8cedae 402
7cf33f88
UM
403 if (sym && sym_is_choice(sym))
404 expr_free(parentdep);
405
fa8cedae
UM
406 /*
407 * Recursively process children in the same fashion before
408 * moving on
409 */
1da177e4
LT
410 for (menu = parent->list; menu; menu = menu->next)
411 menu_finalize(menu);
412 } else if (sym) {
05cccce5
UM
413 /*
414 * Automatic submenu creation. If sym is a symbol and A, B, C,
415 * ... are consecutive items (symbols, menus, ifs, etc.) that
416 * all depend on sym, then the following menu structure is
417 * created:
418 *
419 * sym
420 * +-A
421 * +-B
422 * +-C
423 * ...
424 *
425 * This also works recursively, giving the following structure
426 * if A is a symbol and B depends on A:
427 *
428 * sym
429 * +-A
430 * | +-B
431 * +-C
432 * ...
433 */
434
1da177e4
LT
435 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
436 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
437 basedep = expr_eliminate_dups(expr_transform(basedep));
05cccce5
UM
438
439 /* Examine consecutive elements after sym */
1da177e4
LT
440 last_menu = NULL;
441 for (menu = parent->next; menu; menu = menu->next) {
442 dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
443 if (!expr_contains_symbol(dep, sym))
05cccce5 444 /* No dependency, quit */
1da177e4
LT
445 break;
446 if (expr_depends_symbol(dep, sym))
05cccce5 447 /* Absolute dependency, put in submenu */
1da177e4 448 goto next;
05cccce5
UM
449
450 /*
451 * Also consider it a dependency on sym if our
452 * dependencies contain sym and are a "superset" of
453 * sym's dependencies, e.g. '(sym || Q) && R' when sym
454 * depends on R.
455 *
456 * Note that 'R' might be from an enclosing menu or if,
457 * making this a more common case than it might seem.
458 */
1da177e4
LT
459 dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
460 dep = expr_eliminate_dups(expr_transform(dep));
461 dep2 = expr_copy(basedep);
462 expr_eliminate_eq(&dep, &dep2);
463 expr_free(dep);
464 if (!expr_is_yes(dep2)) {
05cccce5 465 /* Not superset, quit */
1da177e4
LT
466 expr_free(dep2);
467 break;
468 }
05cccce5 469 /* Superset, put in submenu */
1da177e4
LT
470 expr_free(dep2);
471 next:
472 menu_finalize(menu);
473 menu->parent = parent;
474 last_menu = menu;
475 }
ae7440ef 476 expr_free(basedep);
1da177e4
LT
477 if (last_menu) {
478 parent->list = parent->next;
479 parent->next = last_menu->next;
480 last_menu->next = NULL;
481 }
ff5ff606 482
ec6452a5 483 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
1da177e4
LT
484 }
485 for (menu = parent->list; menu; menu = menu->next) {
5a1aa8a1
RZ
486 if (sym && sym_is_choice(sym) &&
487 menu->sym && !sym_is_choice_value(menu->sym)) {
488 current_entry = menu;
1da177e4
LT
489 menu->sym->flags |= SYMBOL_CHOICEVAL;
490 if (!menu->prompt)
491 menu_warn(menu, "choice value must have a prompt");
492 for (prop = menu->sym->prop; prop; prop = prop->next) {
1da177e4
LT
493 if (prop->type == P_DEFAULT)
494 prop_warn(prop, "defaults for choice "
5a1aa8a1
RZ
495 "values not supported");
496 if (prop->menu == menu)
497 continue;
498 if (prop->type == P_PROMPT &&
499 prop->menu->parent->sym != sym)
500 prop_warn(prop, "choice value used outside its choice group");
1da177e4 501 }
f5eaa323
JB
502 /* Non-tristate choice values of tristate choices must
503 * depend on the choice being set to Y. The choice
504 * values' dependencies were propagated to their
505 * properties above, so the change here must be re-
5a1aa8a1
RZ
506 * propagated.
507 */
f5eaa323
JB
508 if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
509 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
5a1aa8a1 510 menu->dep = expr_alloc_and(basedep, menu->dep);
f5eaa323
JB
511 for (prop = menu->sym->prop; prop; prop = prop->next) {
512 if (prop->menu != menu)
513 continue;
5a1aa8a1
RZ
514 prop->visible.expr = expr_alloc_and(expr_copy(basedep),
515 prop->visible.expr);
f5eaa323
JB
516 }
517 }
1da177e4
LT
518 menu_add_symbol(P_CHOICE, sym, NULL);
519 prop = sym_get_choice_prop(sym);
520 for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
521 ;
7a962923 522 *ep = expr_alloc_one(E_LIST, NULL);
1da177e4
LT
523 (*ep)->right.sym = menu->sym;
524 }
9d1a9e8b
UM
525
526 /*
527 * This code serves two purposes:
528 *
529 * (1) Flattening 'if' blocks, which do not specify a submenu
530 * and only add dependencies.
531 *
532 * (Automatic submenu creation might still create a submenu
533 * from an 'if' before this code runs.)
534 *
535 * (2) "Undoing" any automatic submenus created earlier below
536 * promptless symbols.
537 *
538 * Before:
539 *
540 * A
541 * if ... (or promptless symbol)
542 * +-B
543 * +-C
544 * D
545 *
546 * After:
547 *
548 * A
549 * if ... (or promptless symbol)
550 * B
551 * C
552 * D
553 */
1da177e4
LT
554 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
555 for (last_menu = menu->list; ; last_menu = last_menu->next) {
556 last_menu->parent = parent;
557 if (!last_menu->next)
558 break;
559 }
560 last_menu->next = menu->next;
561 menu->next = menu->list;
562 menu->list = NULL;
563 }
564 }
565
566 if (sym && !(sym->flags & SYMBOL_WARNED)) {
567 if (sym->type == S_UNKNOWN)
f001f7f8 568 menu_warn(parent, "config symbol defined without type");
1da177e4
LT
569
570 if (sym_is_choice(sym) && !parent->prompt)
f001f7f8 571 menu_warn(parent, "choice must have a prompt");
1da177e4
LT
572
573 /* Check properties connected to this symbol */
574 sym_check_prop(sym);
575 sym->flags |= SYMBOL_WARNED;
576 }
577
3e41ba05
UM
578 /*
579 * For non-optional choices, add a reverse dependency (corresponding to
580 * a select) of '<visibility> && m'. This prevents the user from
581 * setting the choice mode to 'n' when the choice is visible.
582 *
583 * This would also work for non-choice symbols, but only non-optional
584 * choices clear SYMBOL_OPTIONAL as of writing. Choices are implemented
585 * as a type of symbol.
586 */
1da177e4
LT
587 if (sym && !sym_is_optional(sym) && parent->prompt) {
588 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
589 expr_alloc_and(parent->prompt->visible.expr,
590 expr_alloc_symbol(&symbol_mod)));
591 }
592}
593
22c7eca6
LZ
594bool menu_has_prompt(struct menu *menu)
595{
596 if (!menu->prompt)
597 return false;
598 return true;
599}
600
1278ebdb
DG
601/*
602 * Determine if a menu is empty.
603 * A menu is considered empty if it contains no or only
604 * invisible entries.
605 */
606bool menu_is_empty(struct menu *menu)
607{
608 struct menu *child;
609
610 for (child = menu->list; child; child = child->next) {
611 if (menu_is_visible(child))
612 return(false);
613 }
614 return(true);
615}
616
1da177e4
LT
617bool menu_is_visible(struct menu *menu)
618{
619 struct menu *child;
620 struct symbol *sym;
621 tristate visible;
622
623 if (!menu->prompt)
624 return false;
22c7eca6 625
86e187ff
AL
626 if (menu->visibility) {
627 if (expr_calc_value(menu->visibility) == no)
aab24a89 628 return false;
86e187ff
AL
629 }
630
1da177e4
LT
631 sym = menu->sym;
632 if (sym) {
633 sym_calc_value(sym);
634 visible = menu->prompt->visible.tri;
635 } else
636 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
637
638 if (visible != no)
639 return true;
22c7eca6 640
1da177e4
LT
641 if (!sym || sym_get_tristate_value(menu->sym) == no)
642 return false;
643
3fb9acb3
LZ
644 for (child = menu->list; child; child = child->next) {
645 if (menu_is_visible(child)) {
646 if (sym)
647 sym->flags |= SYMBOL_DEF_USER;
1da177e4 648 return true;
3fb9acb3
LZ
649 }
650 }
22c7eca6 651
1da177e4
LT
652 return false;
653}
654
655const char *menu_get_prompt(struct menu *menu)
656{
657 if (menu->prompt)
01771b0f 658 return menu->prompt->text;
1da177e4 659 else if (menu->sym)
01771b0f 660 return menu->sym->name;
1da177e4
LT
661 return NULL;
662}
663
664struct menu *menu_get_root_menu(struct menu *menu)
665{
666 return &rootmenu;
667}
668
669struct menu *menu_get_parent_menu(struct menu *menu)
670{
671 enum prop_type type;
672
673 for (; menu != &rootmenu; menu = menu->parent) {
674 type = menu->prompt ? menu->prompt->type : 0;
675 if (type == P_MENU)
676 break;
677 }
678 return menu;
679}
680
03d29122
SR
681bool menu_has_help(struct menu *menu)
682{
683 return menu->help != NULL;
684}
685
686const char *menu_get_help(struct menu *menu)
687{
688 if (menu->help)
689 return menu->help;
690 else
691 return "";
692}
6bd5999d 693
edda15f2
TH
694static void get_def_str(struct gstr *r, struct menu *menu)
695{
696 str_printf(r, "Defined at %s:%d\n",
697 menu->file->name, menu->lineno);
698}
699
700static void get_dep_str(struct gstr *r, struct expr *expr, const char *prefix)
701{
702 if (!expr_is_yes(expr)) {
703 str_append(r, prefix);
704 expr_gstr_print(expr, r);
705 str_append(r, "\n");
706 }
707}
708
95ac9b3b 709static void get_prompt_str(struct gstr *r, struct property *prop,
bad9955d 710 struct list_head *head)
6bd5999d
CR
711{
712 int i, j;
5e609add 713 struct menu *submenu[8], *menu, *location = NULL;
2d560306 714 struct jump_key *jump = NULL;
6bd5999d 715
edda15f2
TH
716 str_printf(r, " Prompt: %s\n", prop->text);
717
718 get_dep_str(r, prop->menu->dep, " Depends on: ");
3460d0bc
TH
719 /*
720 * Most prompts in Linux have visibility that exactly matches their
721 * dependencies. For these, we print only the dependencies to improve
722 * readability. However, prompts with inline "if" expressions and
723 * prompts with a parent that has a "visible if" expression have
724 * differing dependencies and visibility. In these rare cases, we
725 * print both.
726 */
727 if (!expr_eq(prop->menu->dep, prop->visible.expr))
728 get_dep_str(r, prop->visible.expr, " Visible if: ");
729
6bd5999d 730 menu = prop->menu->parent;
5e609add
BP
731 for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
732 bool accessible = menu_is_visible(menu);
733
6bd5999d 734 submenu[i++] = menu;
5e609add
BP
735 if (location == NULL && accessible)
736 location = menu;
737 }
95ac9b3b 738 if (head && location) {
177acf78 739 jump = xmalloc(sizeof(struct jump_key));
95ac9b3b 740
5e609add
BP
741 if (menu_is_visible(prop->menu)) {
742 /*
743 * There is not enough room to put the hint at the
744 * beginning of the "Prompt" line. Put the hint on the
745 * last "Location" line even when it would belong on
746 * the former.
747 */
95ac9b3b 748 jump->target = prop->menu;
5e609add 749 } else
95ac9b3b
BP
750 jump->target = location;
751
bad9955d 752 if (list_empty(head))
95ac9b3b
BP
753 jump->index = 0;
754 else
bad9955d
BP
755 jump->index = list_entry(head->prev, struct jump_key,
756 entries)->index + 1;
95ac9b3b 757
bad9955d 758 list_add_tail(&jump->entries, head);
95ac9b3b 759 }
5e609add 760
6bd5999d 761 if (i > 0) {
694c49a7 762 str_printf(r, " Location:\n");
95ac9b3b 763 for (j = 4; --i >= 0; j += 2) {
6bd5999d 764 menu = submenu[i];
2d560306 765 if (jump && menu == location)
503c8230 766 jump->offset = strlen(r->s);
95ac9b3b 767 str_printf(r, "%*c-> %s", j, ' ',
694c49a7 768 menu_get_prompt(menu));
6bd5999d
CR
769 if (menu->sym) {
770 str_printf(r, " (%s [=%s])", menu->sym->name ?
694c49a7 771 menu->sym->name : "<choice>",
6bd5999d
CR
772 sym_get_string_value(menu->sym));
773 }
774 str_append(r, "\n");
775 }
776 }
777}
778
237e3ad0
NP
779static void get_symbol_props_str(struct gstr *r, struct symbol *sym,
780 enum prop_type tok, const char *prefix)
781{
782 bool hit = false;
783 struct property *prop;
784
785 for_all_properties(sym, prop, tok) {
786 if (!hit) {
787 str_append(r, prefix);
788 hit = true;
789 } else
790 str_printf(r, " && ");
791 expr_gstr_print(prop->expr, r);
792 }
793 if (hit)
794 str_append(r, "\n");
795}
796
5e609add 797/*
95ac9b3b 798 * head is optional and may be NULL
5e609add 799 */
ad8d40cd 800static void get_symbol_str(struct gstr *r, struct symbol *sym,
bad9955d 801 struct list_head *head)
6bd5999d 802{
6bd5999d
CR
803 struct property *prop;
804
b040b44c 805 if (sym && sym->name) {
6bd5999d
CR
806 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
807 sym_get_string_value(sym));
b040b44c 808 str_printf(r, "Type : %s\n", sym_type_name(sym->type));
70ed0747
LZ
809 if (sym->type == S_INT || sym->type == S_HEX) {
810 prop = sym_get_range_prop(sym);
811 if (prop) {
812 str_printf(r, "Range : ");
813 expr_gstr_print(prop->expr, r);
814 str_append(r, "\n");
815 }
816 }
b040b44c 817 }
edda15f2
TH
818
819 /* Print the definitions with prompts before the ones without */
820 for_all_properties(sym, prop, P_SYMBOL) {
821 if (prop->menu->prompt) {
822 get_def_str(r, prop->menu);
823 get_prompt_str(r, prop->menu->prompt, head);
824 }
825 }
826
827 for_all_properties(sym, prop, P_SYMBOL) {
828 if (!prop->menu->prompt) {
829 get_def_str(r, prop->menu);
830 get_dep_str(r, prop->menu->dep, " Depends on: ");
383da76f 831 }
bcdedcc1 832 }
383da76f 833
a9609686 834 get_symbol_props_str(r, sym, P_SELECT, "Selects: ");
6bd5999d 835 if (sym->rev_dep.expr) {
a9609686
TH
836 expr_gstr_print_revdep(sym->rev_dep.expr, r, yes, "Selected by [y]:\n");
837 expr_gstr_print_revdep(sym->rev_dep.expr, r, mod, "Selected by [m]:\n");
838 expr_gstr_print_revdep(sym->rev_dep.expr, r, no, "Selected by [n]:\n");
6bd5999d 839 }
237e3ad0 840
a9609686 841 get_symbol_props_str(r, sym, P_IMPLY, "Implies: ");
237e3ad0 842 if (sym->implied.expr) {
a9609686
TH
843 expr_gstr_print_revdep(sym->implied.expr, r, yes, "Implied by [y]:\n");
844 expr_gstr_print_revdep(sym->implied.expr, r, mod, "Implied by [m]:\n");
845 expr_gstr_print_revdep(sym->implied.expr, r, no, "Implied by [n]:\n");
237e3ad0
NP
846 }
847
6bd5999d
CR
848 str_append(r, "\n\n");
849}
850
bad9955d 851struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
692d97c3 852{
853 struct symbol *sym;
854 struct gstr res = str_new();
95ac9b3b 855 int i;
692d97c3 856
857 for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
95ac9b3b 858 get_symbol_str(&res, sym, head);
692d97c3 859 if (!i)
694c49a7 860 str_append(&res, "No matches found.\n");
692d97c3 861 return res;
862}
863
864
6bd5999d
CR
865void menu_get_ext_help(struct menu *menu, struct gstr *help)
866{
867 struct symbol *sym = menu->sym;
57e6292d 868 const char *help_text = nohelp_text;
6bd5999d
CR
869
870 if (menu_has_help(menu)) {
3f198dfe 871 if (sym->name)
ffb5957b 872 str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
57e6292d 873 help_text = menu_get_help(menu);
6bd5999d 874 }
694c49a7 875 str_printf(help, "%s\n", help_text);
4779105e 876 if (sym)
95ac9b3b 877 get_symbol_str(help, sym, NULL);
6bd5999d 878}