xref: /openbmc/linux/scripts/kconfig/menu.c (revision 7b6d864b)
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 void menu_end_entry(void)
66 {
67 }
68 
69 struct menu *menu_add_menu(void)
70 {
71 	menu_end_entry();
72 	last_entry_ptr = &current_entry->list;
73 	return current_menu = current_entry;
74 }
75 
76 void menu_end_menu(void)
77 {
78 	last_entry_ptr = &current_menu->next;
79 	current_menu = current_menu->parent;
80 }
81 
82 static struct expr *menu_check_dep(struct expr *e)
83 {
84 	if (!e)
85 		return e;
86 
87 	switch (e->type) {
88 	case E_NOT:
89 		e->left.expr = menu_check_dep(e->left.expr);
90 		break;
91 	case E_OR:
92 	case E_AND:
93 		e->left.expr = menu_check_dep(e->left.expr);
94 		e->right.expr = menu_check_dep(e->right.expr);
95 		break;
96 	case E_SYMBOL:
97 		/* change 'm' into 'm' && MODULES */
98 		if (e->left.sym == &symbol_mod)
99 			return expr_alloc_and(e, expr_alloc_symbol(modules_sym));
100 		break;
101 	default:
102 		break;
103 	}
104 	return e;
105 }
106 
107 void menu_add_dep(struct expr *dep)
108 {
109 	current_entry->dep = expr_alloc_and(current_entry->dep, menu_check_dep(dep));
110 }
111 
112 void menu_set_type(int type)
113 {
114 	struct symbol *sym = current_entry->sym;
115 
116 	if (sym->type == type)
117 		return;
118 	if (sym->type == S_UNKNOWN) {
119 		sym->type = type;
120 		return;
121 	}
122 	menu_warn(current_entry, "type of '%s' redefined from '%s' to '%s'",
123 	    sym->name ? sym->name : "<choice>",
124 	    sym_type_name(sym->type), sym_type_name(type));
125 }
126 
127 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 = menu_check_dep(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 	struct property *prop;
201 
202 	switch (token) {
203 	case T_OPT_MODULES:
204 		prop = prop_alloc(P_DEFAULT, modules_sym);
205 		prop->expr = expr_alloc_symbol(current_entry->sym);
206 		break;
207 	case T_OPT_DEFCONFIG_LIST:
208 		if (!sym_defconfig_list)
209 			sym_defconfig_list = current_entry->sym;
210 		else if (sym_defconfig_list != current_entry->sym)
211 			zconf_error("trying to redefine defconfig symbol");
212 		break;
213 	case T_OPT_ENV:
214 		prop_add_env(arg);
215 		break;
216 	}
217 }
218 
219 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
220 {
221 	return sym2->type == S_INT || sym2->type == S_HEX ||
222 	       (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
223 }
224 
225 static void sym_check_prop(struct symbol *sym)
226 {
227 	struct property *prop;
228 	struct symbol *sym2;
229 	for (prop = sym->prop; prop; prop = prop->next) {
230 		switch (prop->type) {
231 		case P_DEFAULT:
232 			if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
233 			    prop->expr->type != E_SYMBOL)
234 				prop_warn(prop,
235 				    "default for config symbol '%s'"
236 				    " must be a single symbol", sym->name);
237 			if (prop->expr->type != E_SYMBOL)
238 				break;
239 			sym2 = prop_get_symbol(prop);
240 			if (sym->type == S_HEX || sym->type == S_INT) {
241 				if (!menu_validate_number(sym, sym2))
242 					prop_warn(prop,
243 					    "'%s': number is invalid",
244 					    sym->name);
245 			}
246 			break;
247 		case P_SELECT:
248 			sym2 = prop_get_symbol(prop);
249 			if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
250 				prop_warn(prop,
251 				    "config symbol '%s' uses select, but is "
252 				    "not boolean or tristate", sym->name);
253 			else if (sym2->type != S_UNKNOWN &&
254 			         sym2->type != S_BOOLEAN &&
255 			         sym2->type != S_TRISTATE)
256 				prop_warn(prop,
257 				    "'%s' has wrong type. 'select' only "
258 				    "accept arguments of boolean and "
259 				    "tristate type", sym2->name);
260 			break;
261 		case P_RANGE:
262 			if (sym->type != S_INT && sym->type != S_HEX)
263 				prop_warn(prop, "range is only allowed "
264 				                "for int or hex symbols");
265 			if (!menu_validate_number(sym, prop->expr->left.sym) ||
266 			    !menu_validate_number(sym, prop->expr->right.sym))
267 				prop_warn(prop, "range is invalid");
268 			break;
269 		default:
270 			;
271 		}
272 	}
273 }
274 
275 void menu_finalize(struct menu *parent)
276 {
277 	struct menu *menu, *last_menu;
278 	struct symbol *sym;
279 	struct property *prop;
280 	struct expr *parentdep, *basedep, *dep, *dep2, **ep;
281 
282 	sym = parent->sym;
283 	if (parent->list) {
284 		if (sym && sym_is_choice(sym)) {
285 			if (sym->type == S_UNKNOWN) {
286 				/* find the first choice value to find out choice type */
287 				current_entry = parent;
288 				for (menu = parent->list; menu; menu = menu->next) {
289 					if (menu->sym && menu->sym->type != S_UNKNOWN) {
290 						menu_set_type(menu->sym->type);
291 						break;
292 					}
293 				}
294 			}
295 			/* set the type of the remaining choice values */
296 			for (menu = parent->list; menu; menu = menu->next) {
297 				current_entry = menu;
298 				if (menu->sym && menu->sym->type == S_UNKNOWN)
299 					menu_set_type(sym->type);
300 			}
301 			parentdep = expr_alloc_symbol(sym);
302 		} else if (parent->prompt)
303 			parentdep = parent->prompt->visible.expr;
304 		else
305 			parentdep = parent->dep;
306 
307 		for (menu = parent->list; menu; menu = menu->next) {
308 			basedep = expr_transform(menu->dep);
309 			basedep = expr_alloc_and(expr_copy(parentdep), basedep);
310 			basedep = expr_eliminate_dups(basedep);
311 			menu->dep = basedep;
312 			if (menu->sym)
313 				prop = menu->sym->prop;
314 			else
315 				prop = menu->prompt;
316 			for (; prop; prop = prop->next) {
317 				if (prop->menu != menu)
318 					continue;
319 				dep = expr_transform(prop->visible.expr);
320 				dep = expr_alloc_and(expr_copy(basedep), dep);
321 				dep = expr_eliminate_dups(dep);
322 				if (menu->sym && menu->sym->type != S_TRISTATE)
323 					dep = expr_trans_bool(dep);
324 				prop->visible.expr = dep;
325 				if (prop->type == P_SELECT) {
326 					struct symbol *es = prop_get_symbol(prop);
327 					es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
328 							expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
329 				}
330 			}
331 		}
332 		for (menu = parent->list; menu; menu = menu->next)
333 			menu_finalize(menu);
334 	} else if (sym) {
335 		basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
336 		basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
337 		basedep = expr_eliminate_dups(expr_transform(basedep));
338 		last_menu = NULL;
339 		for (menu = parent->next; menu; menu = menu->next) {
340 			dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
341 			if (!expr_contains_symbol(dep, sym))
342 				break;
343 			if (expr_depends_symbol(dep, sym))
344 				goto next;
345 			dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
346 			dep = expr_eliminate_dups(expr_transform(dep));
347 			dep2 = expr_copy(basedep);
348 			expr_eliminate_eq(&dep, &dep2);
349 			expr_free(dep);
350 			if (!expr_is_yes(dep2)) {
351 				expr_free(dep2);
352 				break;
353 			}
354 			expr_free(dep2);
355 		next:
356 			menu_finalize(menu);
357 			menu->parent = parent;
358 			last_menu = menu;
359 		}
360 		if (last_menu) {
361 			parent->list = parent->next;
362 			parent->next = last_menu->next;
363 			last_menu->next = NULL;
364 		}
365 
366 		sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
367 	}
368 	for (menu = parent->list; menu; menu = menu->next) {
369 		if (sym && sym_is_choice(sym) &&
370 		    menu->sym && !sym_is_choice_value(menu->sym)) {
371 			current_entry = menu;
372 			menu->sym->flags |= SYMBOL_CHOICEVAL;
373 			if (!menu->prompt)
374 				menu_warn(menu, "choice value must have a prompt");
375 			for (prop = menu->sym->prop; prop; prop = prop->next) {
376 				if (prop->type == P_DEFAULT)
377 					prop_warn(prop, "defaults for choice "
378 						  "values not supported");
379 				if (prop->menu == menu)
380 					continue;
381 				if (prop->type == P_PROMPT &&
382 				    prop->menu->parent->sym != sym)
383 					prop_warn(prop, "choice value used outside its choice group");
384 			}
385 			/* Non-tristate choice values of tristate choices must
386 			 * depend on the choice being set to Y. The choice
387 			 * values' dependencies were propagated to their
388 			 * properties above, so the change here must be re-
389 			 * propagated.
390 			 */
391 			if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
392 				basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
393 				menu->dep = expr_alloc_and(basedep, menu->dep);
394 				for (prop = menu->sym->prop; prop; prop = prop->next) {
395 					if (prop->menu != menu)
396 						continue;
397 					prop->visible.expr = expr_alloc_and(expr_copy(basedep),
398 									    prop->visible.expr);
399 				}
400 			}
401 			menu_add_symbol(P_CHOICE, sym, NULL);
402 			prop = sym_get_choice_prop(sym);
403 			for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
404 				;
405 			*ep = expr_alloc_one(E_LIST, NULL);
406 			(*ep)->right.sym = menu->sym;
407 		}
408 		if (menu->list && (!menu->prompt || !menu->prompt->text)) {
409 			for (last_menu = menu->list; ; last_menu = last_menu->next) {
410 				last_menu->parent = parent;
411 				if (!last_menu->next)
412 					break;
413 			}
414 			last_menu->next = menu->next;
415 			menu->next = menu->list;
416 			menu->list = NULL;
417 		}
418 	}
419 
420 	if (sym && !(sym->flags & SYMBOL_WARNED)) {
421 		if (sym->type == S_UNKNOWN)
422 			menu_warn(parent, "config symbol defined without type");
423 
424 		if (sym_is_choice(sym) && !parent->prompt)
425 			menu_warn(parent, "choice must have a prompt");
426 
427 		/* Check properties connected to this symbol */
428 		sym_check_prop(sym);
429 		sym->flags |= SYMBOL_WARNED;
430 	}
431 
432 	if (sym && !sym_is_optional(sym) && parent->prompt) {
433 		sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
434 				expr_alloc_and(parent->prompt->visible.expr,
435 					expr_alloc_symbol(&symbol_mod)));
436 	}
437 }
438 
439 bool menu_has_prompt(struct menu *menu)
440 {
441 	if (!menu->prompt)
442 		return false;
443 	return true;
444 }
445 
446 bool menu_is_visible(struct menu *menu)
447 {
448 	struct menu *child;
449 	struct symbol *sym;
450 	tristate visible;
451 
452 	if (!menu->prompt)
453 		return false;
454 
455 	if (menu->visibility) {
456 		if (expr_calc_value(menu->visibility) == no)
457 			return no;
458 	}
459 
460 	sym = menu->sym;
461 	if (sym) {
462 		sym_calc_value(sym);
463 		visible = menu->prompt->visible.tri;
464 	} else
465 		visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
466 
467 	if (visible != no)
468 		return true;
469 
470 	if (!sym || sym_get_tristate_value(menu->sym) == no)
471 		return false;
472 
473 	for (child = menu->list; child; child = child->next) {
474 		if (menu_is_visible(child)) {
475 			if (sym)
476 				sym->flags |= SYMBOL_DEF_USER;
477 			return true;
478 		}
479 	}
480 
481 	return false;
482 }
483 
484 const char *menu_get_prompt(struct menu *menu)
485 {
486 	if (menu->prompt)
487 		return menu->prompt->text;
488 	else if (menu->sym)
489 		return menu->sym->name;
490 	return NULL;
491 }
492 
493 struct menu *menu_get_root_menu(struct menu *menu)
494 {
495 	return &rootmenu;
496 }
497 
498 struct menu *menu_get_parent_menu(struct menu *menu)
499 {
500 	enum prop_type type;
501 
502 	for (; menu != &rootmenu; menu = menu->parent) {
503 		type = menu->prompt ? menu->prompt->type : 0;
504 		if (type == P_MENU)
505 			break;
506 	}
507 	return menu;
508 }
509 
510 bool menu_has_help(struct menu *menu)
511 {
512 	return menu->help != NULL;
513 }
514 
515 const char *menu_get_help(struct menu *menu)
516 {
517 	if (menu->help)
518 		return menu->help;
519 	else
520 		return "";
521 }
522 
523 static void get_prompt_str(struct gstr *r, struct property *prop,
524 			   struct list_head *head)
525 {
526 	int i, j;
527 	struct menu *submenu[8], *menu, *location = NULL;
528 	struct jump_key *jump;
529 
530 	str_printf(r, _("Prompt: %s\n"), _(prop->text));
531 	menu = prop->menu->parent;
532 	for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
533 		bool accessible = menu_is_visible(menu);
534 
535 		submenu[i++] = menu;
536 		if (location == NULL && accessible)
537 			location = menu;
538 	}
539 	if (head && location) {
540 		jump = xmalloc(sizeof(struct jump_key));
541 
542 		if (menu_is_visible(prop->menu)) {
543 			/*
544 			 * There is not enough room to put the hint at the
545 			 * beginning of the "Prompt" line. Put the hint on the
546 			 * last "Location" line even when it would belong on
547 			 * the former.
548 			 */
549 			jump->target = prop->menu;
550 		} else
551 			jump->target = location;
552 
553 		if (list_empty(head))
554 			jump->index = 0;
555 		else
556 			jump->index = list_entry(head->prev, struct jump_key,
557 						 entries)->index + 1;
558 
559 		list_add_tail(&jump->entries, head);
560 	}
561 
562 	if (i > 0) {
563 		str_printf(r, _("  Location:\n"));
564 		for (j = 4; --i >= 0; j += 2) {
565 			menu = submenu[i];
566 			if (head && location && menu == location)
567 				jump->offset = r->len - 1;
568 			str_printf(r, "%*c-> %s", j, ' ',
569 				   _(menu_get_prompt(menu)));
570 			if (menu->sym) {
571 				str_printf(r, " (%s [=%s])", menu->sym->name ?
572 					menu->sym->name : _("<choice>"),
573 					sym_get_string_value(menu->sym));
574 			}
575 			str_append(r, "\n");
576 		}
577 	}
578 }
579 
580 /*
581  * get peoperty of type P_SYMBOL
582  */
583 static struct property *get_symbol_prop(struct symbol *sym)
584 {
585 	struct property *prop = NULL;
586 
587 	for_all_properties(sym, prop, P_SYMBOL)
588 		break;
589 	return prop;
590 }
591 
592 /*
593  * head is optional and may be NULL
594  */
595 void get_symbol_str(struct gstr *r, struct symbol *sym,
596 		    struct list_head *head)
597 {
598 	bool hit;
599 	struct property *prop;
600 
601 	if (sym && sym->name) {
602 		str_printf(r, "Symbol: %s [=%s]\n", sym->name,
603 			   sym_get_string_value(sym));
604 		str_printf(r, "Type  : %s\n", sym_type_name(sym->type));
605 		if (sym->type == S_INT || sym->type == S_HEX) {
606 			prop = sym_get_range_prop(sym);
607 			if (prop) {
608 				str_printf(r, "Range : ");
609 				expr_gstr_print(prop->expr, r);
610 				str_append(r, "\n");
611 			}
612 		}
613 	}
614 	for_all_prompts(sym, prop)
615 		get_prompt_str(r, prop, head);
616 
617 	prop = get_symbol_prop(sym);
618 	if (prop) {
619 		str_printf(r, _("  Defined at %s:%d\n"), prop->menu->file->name,
620 			prop->menu->lineno);
621 		if (!expr_is_yes(prop->visible.expr)) {
622 			str_append(r, _("  Depends on: "));
623 			expr_gstr_print(prop->visible.expr, r);
624 			str_append(r, "\n");
625 		}
626 	}
627 
628 	hit = false;
629 	for_all_properties(sym, prop, P_SELECT) {
630 		if (!hit) {
631 			str_append(r, "  Selects: ");
632 			hit = true;
633 		} else
634 			str_printf(r, " && ");
635 		expr_gstr_print(prop->expr, r);
636 	}
637 	if (hit)
638 		str_append(r, "\n");
639 	if (sym->rev_dep.expr) {
640 		str_append(r, _("  Selected by: "));
641 		expr_gstr_print(sym->rev_dep.expr, r);
642 		str_append(r, "\n");
643 	}
644 	str_append(r, "\n\n");
645 }
646 
647 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
648 {
649 	struct symbol *sym;
650 	struct gstr res = str_new();
651 	int i;
652 
653 	for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
654 		get_symbol_str(&res, sym, head);
655 	if (!i)
656 		str_append(&res, _("No matches found.\n"));
657 	return res;
658 }
659 
660 
661 void menu_get_ext_help(struct menu *menu, struct gstr *help)
662 {
663 	struct symbol *sym = menu->sym;
664 	const char *help_text = nohelp_text;
665 
666 	if (menu_has_help(menu)) {
667 		if (sym->name)
668 			str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
669 		help_text = menu_get_help(menu);
670 	}
671 	str_printf(help, "%s\n", _(help_text));
672 	if (sym)
673 		get_symbol_str(help, sym, NULL);
674 }
675