xref: /openbmc/linux/scripts/kconfig/menu.c (revision d9be8eea)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
4  */
5 
6 #include <ctype.h>
7 #include <stdarg.h>
8 #include <stdlib.h>
9 #include <string.h>
10 
11 #include "lkc.h"
12 #include "internal.h"
13 
14 static const char nohelp_text[] = "There is no help available for this option.";
15 
16 struct menu rootmenu;
17 static struct menu **last_entry_ptr;
18 
19 struct file *file_list;
20 struct file *current_file;
21 
menu_warn(struct menu * menu,const char * fmt,...)22 void menu_warn(struct menu *menu, const char *fmt, ...)
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 
prop_warn(struct property * prop,const char * fmt,...)32 static 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 
_menu_init(void)42 void _menu_init(void)
43 {
44 	current_entry = current_menu = &rootmenu;
45 	last_entry_ptr = &rootmenu.list;
46 }
47 
menu_add_entry(struct symbol * sym)48 void menu_add_entry(struct symbol *sym)
49 {
50 	struct menu *menu;
51 
52 	menu = xmalloc(sizeof(*menu));
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;
62 	if (sym)
63 		menu_add_symbol(P_SYMBOL, sym, NULL);
64 }
65 
menu_add_menu(void)66 struct menu *menu_add_menu(void)
67 {
68 	last_entry_ptr = &current_entry->list;
69 	current_menu = current_entry;
70 	return current_menu;
71 }
72 
menu_end_menu(void)73 void menu_end_menu(void)
74 {
75 	last_entry_ptr = &current_menu->next;
76 	current_menu = current_menu->parent;
77 }
78 
79 /*
80  * Rewrites 'm' to 'm' && MODULES, so that it evaluates to 'n' when running
81  * without modules
82  */
rewrite_m(struct expr * e)83 static struct expr *rewrite_m(struct expr *e)
84 {
85 	if (!e)
86 		return e;
87 
88 	switch (e->type) {
89 	case E_NOT:
90 		e->left.expr = rewrite_m(e->left.expr);
91 		break;
92 	case E_OR:
93 	case E_AND:
94 		e->left.expr = rewrite_m(e->left.expr);
95 		e->right.expr = rewrite_m(e->right.expr);
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 
menu_add_dep(struct expr * dep)108 void menu_add_dep(struct expr *dep)
109 {
110 	current_entry->dep = expr_alloc_and(current_entry->dep, dep);
111 }
112 
menu_set_type(int type)113 void 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 	}
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));
127 }
128 
menu_add_prop(enum prop_type type,struct expr * expr,struct expr * dep)129 static struct property *menu_add_prop(enum prop_type type, struct expr *expr,
130 				      struct expr *dep)
131 {
132 	struct property *prop;
133 
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();
139 	prop->menu = current_entry;
140 	prop->expr = expr;
141 	prop->visible.expr = dep;
142 
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 
154 	return prop;
155 }
156 
menu_add_prompt(enum prop_type type,char * prompt,struct expr * dep)157 struct property *menu_add_prompt(enum prop_type type, char *prompt,
158 				 struct expr *dep)
159 {
160 	struct property *prop = menu_add_prop(type, NULL, dep);
161 
162 	if (isspace(*prompt)) {
163 		prop_warn(prop, "leading whitespace ignored");
164 		while (isspace(*prompt))
165 			prompt++;
166 	}
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;
194 	prop->text = prompt;
195 
196 	return prop;
197 }
198 
menu_add_visibility(struct expr * expr)199 void menu_add_visibility(struct expr *expr)
200 {
201 	current_entry->visibility = expr_alloc_and(current_entry->visibility,
202 	    expr);
203 }
204 
menu_add_expr(enum prop_type type,struct expr * expr,struct expr * dep)205 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
206 {
207 	menu_add_prop(type, expr, dep);
208 }
209 
menu_add_symbol(enum prop_type type,struct symbol * sym,struct expr * dep)210 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
211 {
212 	menu_add_prop(type, expr_alloc_symbol(sym), dep);
213 }
214 
menu_validate_number(struct symbol * sym,struct symbol * sym2)215 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
216 {
217 	return sym2->type == S_INT || sym2->type == S_HEX ||
218 	       (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
219 }
220 
sym_check_prop(struct symbol * sym)221 static void sym_check_prop(struct symbol *sym)
222 {
223 	struct property *prop;
224 	struct symbol *sym2;
225 	char *use;
226 
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,
233 				    "default for config symbol '%s'"
234 				    " must be a single symbol", sym->name);
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 			}
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 			}
254 			break;
255 		case P_SELECT:
256 		case P_IMPLY:
257 			use = prop->type == P_SELECT ? "select" : "imply";
258 			sym2 = prop_get_symbol(prop);
259 			if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
260 				prop_warn(prop,
261 				    "config symbol '%s' uses %s, but is "
262 				    "not bool or tristate", sym->name, use);
263 			else if (sym2->type != S_UNKNOWN &&
264 				 sym2->type != S_BOOLEAN &&
265 				 sym2->type != S_TRISTATE)
266 				prop_warn(prop,
267 				    "'%s' has wrong type. '%s' only "
268 				    "accept arguments of bool and "
269 				    "tristate type", sym2->name, use);
270 			break;
271 		case P_RANGE:
272 			if (sym->type != S_INT && sym->type != S_HEX)
273 				prop_warn(prop, "range is only allowed "
274 						"for int or hex symbols");
275 			if (!menu_validate_number(sym, prop->expr->left.sym) ||
276 			    !menu_validate_number(sym, prop->expr->right.sym))
277 				prop_warn(prop, "range is invalid");
278 			break;
279 		default:
280 			;
281 		}
282 	}
283 }
284 
menu_finalize(struct menu * parent)285 void 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) {
294 		/*
295 		 * This menu node has children. We (recursively) process them
296 		 * and propagate parent dependencies before moving on.
297 		 */
298 
299 		if (sym && sym_is_choice(sym)) {
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) {
305 						menu_set_type(menu->sym->type);
306 						break;
307 					}
308 				}
309 			}
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 			}
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 			 */
323 			parentdep = expr_alloc_symbol(sym);
324 		} else {
325 			/* Menu node for 'menu', 'if' */
326 			parentdep = parent->dep;
327 		}
328 
329 		/* For each child menu node... */
330 		for (menu = parent->list; menu; menu = menu->next) {
331 			/*
332 			 * Propagate parent dependencies to the child menu
333 			 * node, also rewriting and simplifying expressions
334 			 */
335 			basedep = rewrite_m(menu->dep);
336 			basedep = expr_transform(basedep);
337 			basedep = expr_alloc_and(expr_copy(parentdep), basedep);
338 			basedep = expr_eliminate_dups(basedep);
339 			menu->dep = basedep;
340 
341 			if (menu->sym)
342 				/*
343 				 * Note: For symbols, all prompts are included
344 				 * too in the symbol's own property list
345 				 */
346 				prop = menu->sym->prop;
347 			else
348 				/*
349 				 * For non-symbol menu nodes, we just need to
350 				 * handle the prompt
351 				 */
352 				prop = menu->prompt;
353 
354 			/* For each property... */
355 			for (; prop; prop = prop->next) {
356 				if (prop->menu != menu)
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 					 */
372 					continue;
373 
374 				/*
375 				 * Propagate parent dependencies to the
376 				 * property's condition, rewriting and
377 				 * simplifying expressions at the same time
378 				 */
379 				dep = rewrite_m(prop->visible.expr);
380 				dep = expr_transform(dep);
381 				dep = expr_alloc_and(expr_copy(basedep), dep);
382 				dep = expr_eliminate_dups(dep);
383 				prop->visible.expr = dep;
384 
385 				/*
386 				 * Handle selects and implies, which modify the
387 				 * dependencies of the selected/implied symbol
388 				 */
389 				if (prop->type == P_SELECT) {
390 					struct symbol *es = prop_get_symbol(prop);
391 					es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
392 							expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
393 				} else if (prop->type == P_IMPLY) {
394 					struct symbol *es = prop_get_symbol(prop);
395 					es->implied.expr = expr_alloc_or(es->implied.expr,
396 							expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
397 				}
398 			}
399 		}
400 
401 		if (sym && sym_is_choice(sym))
402 			expr_free(parentdep);
403 
404 		/*
405 		 * Recursively process children in the same fashion before
406 		 * moving on
407 		 */
408 		for (menu = parent->list; menu; menu = menu->next)
409 			menu_finalize(menu);
410 	} else if (sym) {
411 		/*
412 		 * Automatic submenu creation. If sym is a symbol and A, B, C,
413 		 * ... are consecutive items (symbols, menus, ifs, etc.) that
414 		 * all depend on sym, then the following menu structure is
415 		 * created:
416 		 *
417 		 *	sym
418 		 *	 +-A
419 		 *	 +-B
420 		 *	 +-C
421 		 *	 ...
422 		 *
423 		 * This also works recursively, giving the following structure
424 		 * if A is a symbol and B depends on A:
425 		 *
426 		 *	sym
427 		 *	 +-A
428 		 *	 | +-B
429 		 *	 +-C
430 		 *	 ...
431 		 */
432 
433 		basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
434 		basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
435 		basedep = expr_eliminate_dups(expr_transform(basedep));
436 
437 		/* Examine consecutive elements after sym */
438 		last_menu = NULL;
439 		for (menu = parent->next; menu; menu = menu->next) {
440 			dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
441 			if (!expr_contains_symbol(dep, sym))
442 				/* No dependency, quit */
443 				break;
444 			if (expr_depends_symbol(dep, sym))
445 				/* Absolute dependency, put in submenu */
446 				goto next;
447 
448 			/*
449 			 * Also consider it a dependency on sym if our
450 			 * dependencies contain sym and are a "superset" of
451 			 * sym's dependencies, e.g. '(sym || Q) && R' when sym
452 			 * depends on R.
453 			 *
454 			 * Note that 'R' might be from an enclosing menu or if,
455 			 * making this a more common case than it might seem.
456 			 */
457 			dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
458 			dep = expr_eliminate_dups(expr_transform(dep));
459 			dep2 = expr_copy(basedep);
460 			expr_eliminate_eq(&dep, &dep2);
461 			expr_free(dep);
462 			if (!expr_is_yes(dep2)) {
463 				/* Not superset, quit */
464 				expr_free(dep2);
465 				break;
466 			}
467 			/* Superset, put in submenu */
468 			expr_free(dep2);
469 		next:
470 			menu_finalize(menu);
471 			menu->parent = parent;
472 			last_menu = menu;
473 		}
474 		expr_free(basedep);
475 		if (last_menu) {
476 			parent->list = parent->next;
477 			parent->next = last_menu->next;
478 			last_menu->next = NULL;
479 		}
480 
481 		sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
482 	}
483 	for (menu = parent->list; menu; menu = menu->next) {
484 		if (sym && sym_is_choice(sym) &&
485 		    menu->sym && !sym_is_choice_value(menu->sym)) {
486 			current_entry = menu;
487 			menu->sym->flags |= SYMBOL_CHOICEVAL;
488 			if (!menu->prompt)
489 				menu_warn(menu, "choice value must have a prompt");
490 			for (prop = menu->sym->prop; prop; prop = prop->next) {
491 				if (prop->type == P_DEFAULT)
492 					prop_warn(prop, "defaults for choice "
493 						  "values not supported");
494 				if (prop->menu == menu)
495 					continue;
496 				if (prop->type == P_PROMPT &&
497 				    prop->menu->parent->sym != sym)
498 					prop_warn(prop, "choice value used outside its choice group");
499 			}
500 			/* Non-tristate choice values of tristate choices must
501 			 * depend on the choice being set to Y. The choice
502 			 * values' dependencies were propagated to their
503 			 * properties above, so the change here must be re-
504 			 * propagated.
505 			 */
506 			if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
507 				basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
508 				menu->dep = expr_alloc_and(basedep, menu->dep);
509 				for (prop = menu->sym->prop; prop; prop = prop->next) {
510 					if (prop->menu != menu)
511 						continue;
512 					prop->visible.expr = expr_alloc_and(expr_copy(basedep),
513 									    prop->visible.expr);
514 				}
515 			}
516 			menu_add_symbol(P_CHOICE, sym, NULL);
517 			prop = sym_get_choice_prop(sym);
518 			for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
519 				;
520 			*ep = expr_alloc_one(E_LIST, NULL);
521 			(*ep)->right.sym = menu->sym;
522 		}
523 
524 		/*
525 		 * This code serves two purposes:
526 		 *
527 		 * (1) Flattening 'if' blocks, which do not specify a submenu
528 		 *     and only add dependencies.
529 		 *
530 		 *     (Automatic submenu creation might still create a submenu
531 		 *     from an 'if' before this code runs.)
532 		 *
533 		 * (2) "Undoing" any automatic submenus created earlier below
534 		 *     promptless symbols.
535 		 *
536 		 * Before:
537 		 *
538 		 *	A
539 		 *	if ... (or promptless symbol)
540 		 *	 +-B
541 		 *	 +-C
542 		 *	D
543 		 *
544 		 * After:
545 		 *
546 		 *	A
547 		 *	if ... (or promptless symbol)
548 		 *	B
549 		 *	C
550 		 *	D
551 		 */
552 		if (menu->list && (!menu->prompt || !menu->prompt->text)) {
553 			for (last_menu = menu->list; ; last_menu = last_menu->next) {
554 				last_menu->parent = parent;
555 				if (!last_menu->next)
556 					break;
557 			}
558 			last_menu->next = menu->next;
559 			menu->next = menu->list;
560 			menu->list = NULL;
561 		}
562 	}
563 
564 	if (sym && !(sym->flags & SYMBOL_WARNED)) {
565 		if (sym->type == S_UNKNOWN)
566 			menu_warn(parent, "config symbol defined without type");
567 
568 		if (sym_is_choice(sym) && !parent->prompt)
569 			menu_warn(parent, "choice must have a prompt");
570 
571 		/* Check properties connected to this symbol */
572 		sym_check_prop(sym);
573 		sym->flags |= SYMBOL_WARNED;
574 	}
575 
576 	/*
577 	 * For non-optional choices, add a reverse dependency (corresponding to
578 	 * a select) of '<visibility> && m'. This prevents the user from
579 	 * setting the choice mode to 'n' when the choice is visible.
580 	 *
581 	 * This would also work for non-choice symbols, but only non-optional
582 	 * choices clear SYMBOL_OPTIONAL as of writing. Choices are implemented
583 	 * as a type of symbol.
584 	 */
585 	if (sym && !sym_is_optional(sym) && parent->prompt) {
586 		sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
587 				expr_alloc_and(parent->prompt->visible.expr,
588 					expr_alloc_symbol(&symbol_mod)));
589 	}
590 }
591 
menu_has_prompt(struct menu * menu)592 bool menu_has_prompt(struct menu *menu)
593 {
594 	if (!menu->prompt)
595 		return false;
596 	return true;
597 }
598 
599 /*
600  * Determine if a menu is empty.
601  * A menu is considered empty if it contains no or only
602  * invisible entries.
603  */
menu_is_empty(struct menu * menu)604 bool menu_is_empty(struct menu *menu)
605 {
606 	struct menu *child;
607 
608 	for (child = menu->list; child; child = child->next) {
609 		if (menu_is_visible(child))
610 			return(false);
611 	}
612 	return(true);
613 }
614 
menu_is_visible(struct menu * menu)615 bool menu_is_visible(struct menu *menu)
616 {
617 	struct menu *child;
618 	struct symbol *sym;
619 	tristate visible;
620 
621 	if (!menu->prompt)
622 		return false;
623 
624 	if (menu->visibility) {
625 		if (expr_calc_value(menu->visibility) == no)
626 			return false;
627 	}
628 
629 	sym = menu->sym;
630 	if (sym) {
631 		sym_calc_value(sym);
632 		visible = menu->prompt->visible.tri;
633 	} else
634 		visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
635 
636 	if (visible != no)
637 		return true;
638 
639 	if (!sym || sym_get_tristate_value(menu->sym) == no)
640 		return false;
641 
642 	for (child = menu->list; child; child = child->next) {
643 		if (menu_is_visible(child)) {
644 			if (sym)
645 				sym->flags |= SYMBOL_DEF_USER;
646 			return true;
647 		}
648 	}
649 
650 	return false;
651 }
652 
menu_get_prompt(struct menu * menu)653 const char *menu_get_prompt(struct menu *menu)
654 {
655 	if (menu->prompt)
656 		return menu->prompt->text;
657 	else if (menu->sym)
658 		return menu->sym->name;
659 	return NULL;
660 }
661 
menu_get_parent_menu(struct menu * menu)662 struct menu *menu_get_parent_menu(struct menu *menu)
663 {
664 	enum prop_type type;
665 
666 	for (; menu != &rootmenu; menu = menu->parent) {
667 		type = menu->prompt ? menu->prompt->type : 0;
668 		if (type == P_MENU)
669 			break;
670 	}
671 	return menu;
672 }
673 
menu_has_help(struct menu * menu)674 bool menu_has_help(struct menu *menu)
675 {
676 	return menu->help != NULL;
677 }
678 
menu_get_help(struct menu * menu)679 const char *menu_get_help(struct menu *menu)
680 {
681 	if (menu->help)
682 		return menu->help;
683 	else
684 		return "";
685 }
686 
get_def_str(struct gstr * r,struct menu * menu)687 static void get_def_str(struct gstr *r, struct menu *menu)
688 {
689 	str_printf(r, "Defined at %s:%d\n",
690 		   menu->file->name, menu->lineno);
691 }
692 
get_dep_str(struct gstr * r,struct expr * expr,const char * prefix)693 static void get_dep_str(struct gstr *r, struct expr *expr, const char *prefix)
694 {
695 	if (!expr_is_yes(expr)) {
696 		str_append(r, prefix);
697 		expr_gstr_print(expr, r);
698 		str_append(r, "\n");
699 	}
700 }
701 
get_jump_key_char(void)702 int __attribute__((weak)) get_jump_key_char(void)
703 {
704 	return -1;
705 }
706 
get_prompt_str(struct gstr * r,struct property * prop,struct list_head * head)707 static void get_prompt_str(struct gstr *r, struct property *prop,
708 			   struct list_head *head)
709 {
710 	int i, j;
711 	struct menu *submenu[8], *menu, *location = NULL;
712 	struct jump_key *jump = NULL;
713 
714 	str_printf(r, "  Prompt: %s\n", prop->text);
715 
716 	get_dep_str(r, prop->menu->dep, "  Depends on: ");
717 	/*
718 	 * Most prompts in Linux have visibility that exactly matches their
719 	 * dependencies. For these, we print only the dependencies to improve
720 	 * readability. However, prompts with inline "if" expressions and
721 	 * prompts with a parent that has a "visible if" expression have
722 	 * differing dependencies and visibility. In these rare cases, we
723 	 * print both.
724 	 */
725 	if (!expr_eq(prop->menu->dep, prop->visible.expr))
726 		get_dep_str(r, prop->visible.expr, "  Visible if: ");
727 
728 	menu = prop->menu;
729 	for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
730 		submenu[i++] = menu;
731 		if (location == NULL && menu_is_visible(menu))
732 			location = menu;
733 	}
734 	if (head && location) {
735 		jump = xmalloc(sizeof(struct jump_key));
736 		jump->target = location;
737 		list_add_tail(&jump->entries, head);
738 	}
739 
740 	str_printf(r, "  Location:\n");
741 	for (j = 0; --i >= 0; j++) {
742 		int jk = -1;
743 		int indent = 2 * j + 4;
744 
745 		menu = submenu[i];
746 		if (jump && menu == location) {
747 			jump->offset = strlen(r->s);
748 			jk = get_jump_key_char();
749 		}
750 
751 		if (jk >= 0) {
752 			str_printf(r, "(%c)", jk);
753 			indent -= 3;
754 		}
755 
756 		str_printf(r, "%*c-> %s", indent, ' ', menu_get_prompt(menu));
757 		if (menu->sym) {
758 			str_printf(r, " (%s [=%s])", menu->sym->name ?
759 				menu->sym->name : "<choice>",
760 				sym_get_string_value(menu->sym));
761 		}
762 		str_append(r, "\n");
763 	}
764 }
765 
get_symbol_props_str(struct gstr * r,struct symbol * sym,enum prop_type tok,const char * prefix)766 static void get_symbol_props_str(struct gstr *r, struct symbol *sym,
767 				 enum prop_type tok, const char *prefix)
768 {
769 	bool hit = false;
770 	struct property *prop;
771 
772 	for_all_properties(sym, prop, tok) {
773 		if (!hit) {
774 			str_append(r, prefix);
775 			hit = true;
776 		} else
777 			str_printf(r, " && ");
778 		expr_gstr_print(prop->expr, r);
779 	}
780 	if (hit)
781 		str_append(r, "\n");
782 }
783 
784 /*
785  * head is optional and may be NULL
786  */
get_symbol_str(struct gstr * r,struct symbol * sym,struct list_head * head)787 static void get_symbol_str(struct gstr *r, struct symbol *sym,
788 		    struct list_head *head)
789 {
790 	struct property *prop;
791 
792 	if (sym && sym->name) {
793 		str_printf(r, "Symbol: %s [=%s]\n", sym->name,
794 			   sym_get_string_value(sym));
795 		str_printf(r, "Type  : %s\n", sym_type_name(sym->type));
796 		if (sym->type == S_INT || sym->type == S_HEX) {
797 			prop = sym_get_range_prop(sym);
798 			if (prop) {
799 				str_printf(r, "Range : ");
800 				expr_gstr_print(prop->expr, r);
801 				str_append(r, "\n");
802 			}
803 		}
804 	}
805 
806 	/* Print the definitions with prompts before the ones without */
807 	for_all_properties(sym, prop, P_SYMBOL) {
808 		if (prop->menu->prompt) {
809 			get_def_str(r, prop->menu);
810 			get_prompt_str(r, prop->menu->prompt, head);
811 		}
812 	}
813 
814 	for_all_properties(sym, prop, P_SYMBOL) {
815 		if (!prop->menu->prompt) {
816 			get_def_str(r, prop->menu);
817 			get_dep_str(r, prop->menu->dep, "  Depends on: ");
818 		}
819 	}
820 
821 	get_symbol_props_str(r, sym, P_SELECT, "Selects: ");
822 	if (sym->rev_dep.expr) {
823 		expr_gstr_print_revdep(sym->rev_dep.expr, r, yes, "Selected by [y]:\n");
824 		expr_gstr_print_revdep(sym->rev_dep.expr, r, mod, "Selected by [m]:\n");
825 		expr_gstr_print_revdep(sym->rev_dep.expr, r, no, "Selected by [n]:\n");
826 	}
827 
828 	get_symbol_props_str(r, sym, P_IMPLY, "Implies: ");
829 	if (sym->implied.expr) {
830 		expr_gstr_print_revdep(sym->implied.expr, r, yes, "Implied by [y]:\n");
831 		expr_gstr_print_revdep(sym->implied.expr, r, mod, "Implied by [m]:\n");
832 		expr_gstr_print_revdep(sym->implied.expr, r, no, "Implied by [n]:\n");
833 	}
834 
835 	str_append(r, "\n\n");
836 }
837 
get_relations_str(struct symbol ** sym_arr,struct list_head * head)838 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
839 {
840 	struct symbol *sym;
841 	struct gstr res = str_new();
842 	int i;
843 
844 	for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
845 		get_symbol_str(&res, sym, head);
846 	if (!i)
847 		str_append(&res, "No matches found.\n");
848 	return res;
849 }
850 
851 
menu_get_ext_help(struct menu * menu,struct gstr * help)852 void menu_get_ext_help(struct menu *menu, struct gstr *help)
853 {
854 	struct symbol *sym = menu->sym;
855 	const char *help_text = nohelp_text;
856 
857 	if (menu_has_help(menu)) {
858 		if (sym->name)
859 			str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
860 		help_text = menu_get_help(menu);
861 	}
862 	str_printf(help, "%s\n", help_text);
863 	if (sym)
864 		get_symbol_str(help, sym, NULL);
865 }
866