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