xref: /linux-6.15/scripts/kconfig/menu.c (revision facb4edc)
1 /*
2  * Copyright (C) 2002 Roman Zippel <[email protected]>
3  * Released under the terms of the GNU GPL v2.0.
4  */
5 
6 #include <stdlib.h>
7 #include <string.h>
8 
9 #define LKC_DIRECT_LINK
10 #include "lkc.h"
11 
12 static const char nohelp_text[] = N_(
13 	"There is no help available for this option.\n");
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 = malloc(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 				if (!menu->visibility)
150 					continue;
151 				prop->visible.expr
152 					= expr_alloc_and(prop->visible.expr,
153 							 menu->visibility);
154 			}
155 		}
156 
157 		current_entry->prompt = prop;
158 	}
159 	prop->text = prompt;
160 
161 	return prop;
162 }
163 
164 struct property *menu_add_prompt(enum prop_type type, char *prompt, struct expr *dep)
165 {
166 	return menu_add_prop(type, prompt, NULL, dep);
167 }
168 
169 void menu_add_visibility(struct expr *expr)
170 {
171 	current_entry->visibility = expr_alloc_and(current_entry->visibility,
172 	    expr);
173 }
174 
175 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
176 {
177 	menu_add_prop(type, NULL, expr, dep);
178 }
179 
180 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
181 {
182 	menu_add_prop(type, NULL, expr_alloc_symbol(sym), dep);
183 }
184 
185 void menu_add_option(int token, char *arg)
186 {
187 	struct property *prop;
188 
189 	switch (token) {
190 	case T_OPT_MODULES:
191 		prop = prop_alloc(P_DEFAULT, modules_sym);
192 		prop->expr = expr_alloc_symbol(current_entry->sym);
193 		break;
194 	case T_OPT_DEFCONFIG_LIST:
195 		if (!sym_defconfig_list)
196 			sym_defconfig_list = current_entry->sym;
197 		else if (sym_defconfig_list != current_entry->sym)
198 			zconf_error("trying to redefine defconfig symbol");
199 		break;
200 	case T_OPT_ENV:
201 		prop_add_env(arg);
202 		break;
203 	}
204 }
205 
206 static int menu_range_valid_sym(struct symbol *sym, struct symbol *sym2)
207 {
208 	return sym2->type == S_INT || sym2->type == S_HEX ||
209 	       (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
210 }
211 
212 static void sym_check_prop(struct symbol *sym)
213 {
214 	struct property *prop;
215 	struct symbol *sym2;
216 	for (prop = sym->prop; prop; prop = prop->next) {
217 		switch (prop->type) {
218 		case P_DEFAULT:
219 			if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
220 			    prop->expr->type != E_SYMBOL)
221 				prop_warn(prop,
222 				    "default for config symbol '%s'"
223 				    " must be a single symbol", sym->name);
224 			break;
225 		case P_SELECT:
226 			sym2 = prop_get_symbol(prop);
227 			if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
228 				prop_warn(prop,
229 				    "config symbol '%s' uses select, but is "
230 				    "not boolean or tristate", sym->name);
231 			else if (sym2->type != S_UNKNOWN &&
232 			         sym2->type != S_BOOLEAN &&
233 			         sym2->type != S_TRISTATE)
234 				prop_warn(prop,
235 				    "'%s' has wrong type. 'select' only "
236 				    "accept arguments of boolean and "
237 				    "tristate type", sym2->name);
238 			break;
239 		case P_RANGE:
240 			if (sym->type != S_INT && sym->type != S_HEX)
241 				prop_warn(prop, "range is only allowed "
242 				                "for int or hex symbols");
243 			if (!menu_range_valid_sym(sym, prop->expr->left.sym) ||
244 			    !menu_range_valid_sym(sym, prop->expr->right.sym))
245 				prop_warn(prop, "range is invalid");
246 			break;
247 		default:
248 			;
249 		}
250 	}
251 }
252 
253 void menu_finalize(struct menu *parent)
254 {
255 	struct menu *menu, *last_menu;
256 	struct symbol *sym;
257 	struct property *prop;
258 	struct expr *parentdep, *basedep, *dep, *dep2, **ep;
259 
260 	sym = parent->sym;
261 	if (parent->list) {
262 		if (sym && sym_is_choice(sym)) {
263 			if (sym->type == S_UNKNOWN) {
264 				/* find the first choice value to find out choice type */
265 				current_entry = parent;
266 				for (menu = parent->list; menu; menu = menu->next) {
267 					if (menu->sym && menu->sym->type != S_UNKNOWN) {
268 						menu_set_type(menu->sym->type);
269 						break;
270 					}
271 				}
272 			}
273 			/* set the type of the remaining choice values */
274 			for (menu = parent->list; menu; menu = menu->next) {
275 				current_entry = menu;
276 				if (menu->sym && menu->sym->type == S_UNKNOWN)
277 					menu_set_type(sym->type);
278 			}
279 			parentdep = expr_alloc_symbol(sym);
280 		} else if (parent->prompt)
281 			parentdep = parent->prompt->visible.expr;
282 		else
283 			parentdep = parent->dep;
284 
285 		for (menu = parent->list; menu; menu = menu->next) {
286 			basedep = expr_transform(menu->dep);
287 			basedep = expr_alloc_and(expr_copy(parentdep), basedep);
288 			basedep = expr_eliminate_dups(basedep);
289 			menu->dep = basedep;
290 			if (menu->sym)
291 				prop = menu->sym->prop;
292 			else
293 				prop = menu->prompt;
294 			for (; prop; prop = prop->next) {
295 				if (prop->menu != menu)
296 					continue;
297 				dep = expr_transform(prop->visible.expr);
298 				dep = expr_alloc_and(expr_copy(basedep), dep);
299 				dep = expr_eliminate_dups(dep);
300 				if (menu->sym && menu->sym->type != S_TRISTATE)
301 					dep = expr_trans_bool(dep);
302 				prop->visible.expr = dep;
303 				if (prop->type == P_SELECT) {
304 					struct symbol *es = prop_get_symbol(prop);
305 					es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
306 							expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
307 				}
308 			}
309 		}
310 		for (menu = parent->list; menu; menu = menu->next)
311 			menu_finalize(menu);
312 	} else if (sym) {
313 		basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
314 		basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
315 		basedep = expr_eliminate_dups(expr_transform(basedep));
316 		last_menu = NULL;
317 		for (menu = parent->next; menu; menu = menu->next) {
318 			dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
319 			if (!expr_contains_symbol(dep, sym))
320 				break;
321 			if (expr_depends_symbol(dep, sym))
322 				goto next;
323 			dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
324 			dep = expr_eliminate_dups(expr_transform(dep));
325 			dep2 = expr_copy(basedep);
326 			expr_eliminate_eq(&dep, &dep2);
327 			expr_free(dep);
328 			if (!expr_is_yes(dep2)) {
329 				expr_free(dep2);
330 				break;
331 			}
332 			expr_free(dep2);
333 		next:
334 			menu_finalize(menu);
335 			menu->parent = parent;
336 			last_menu = menu;
337 		}
338 		if (last_menu) {
339 			parent->list = parent->next;
340 			parent->next = last_menu->next;
341 			last_menu->next = NULL;
342 		}
343 
344 		sym->dir_dep.expr = parent->dep;
345 	}
346 	for (menu = parent->list; menu; menu = menu->next) {
347 		if (sym && sym_is_choice(sym) &&
348 		    menu->sym && !sym_is_choice_value(menu->sym)) {
349 			current_entry = menu;
350 			menu->sym->flags |= SYMBOL_CHOICEVAL;
351 			if (!menu->prompt)
352 				menu_warn(menu, "choice value must have a prompt");
353 			for (prop = menu->sym->prop; prop; prop = prop->next) {
354 				if (prop->type == P_DEFAULT)
355 					prop_warn(prop, "defaults for choice "
356 						  "values not supported");
357 				if (prop->menu == menu)
358 					continue;
359 				if (prop->type == P_PROMPT &&
360 				    prop->menu->parent->sym != sym)
361 					prop_warn(prop, "choice value used outside its choice group");
362 			}
363 			/* Non-tristate choice values of tristate choices must
364 			 * depend on the choice being set to Y. The choice
365 			 * values' dependencies were propagated to their
366 			 * properties above, so the change here must be re-
367 			 * propagated.
368 			 */
369 			if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
370 				basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
371 				menu->dep = expr_alloc_and(basedep, menu->dep);
372 				for (prop = menu->sym->prop; prop; prop = prop->next) {
373 					if (prop->menu != menu)
374 						continue;
375 					prop->visible.expr = expr_alloc_and(expr_copy(basedep),
376 									    prop->visible.expr);
377 				}
378 			}
379 			menu_add_symbol(P_CHOICE, sym, NULL);
380 			prop = sym_get_choice_prop(sym);
381 			for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
382 				;
383 			*ep = expr_alloc_one(E_LIST, NULL);
384 			(*ep)->right.sym = menu->sym;
385 		}
386 		if (menu->list && (!menu->prompt || !menu->prompt->text)) {
387 			for (last_menu = menu->list; ; last_menu = last_menu->next) {
388 				last_menu->parent = parent;
389 				if (!last_menu->next)
390 					break;
391 			}
392 			last_menu->next = menu->next;
393 			menu->next = menu->list;
394 			menu->list = NULL;
395 		}
396 	}
397 
398 	if (sym && !(sym->flags & SYMBOL_WARNED)) {
399 		if (sym->type == S_UNKNOWN)
400 			menu_warn(parent, "config symbol defined without type");
401 
402 		if (sym_is_choice(sym) && !parent->prompt)
403 			menu_warn(parent, "choice must have a prompt");
404 
405 		/* Check properties connected to this symbol */
406 		sym_check_prop(sym);
407 		sym->flags |= SYMBOL_WARNED;
408 	}
409 
410 	if (sym && !sym_is_optional(sym) && parent->prompt) {
411 		sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
412 				expr_alloc_and(parent->prompt->visible.expr,
413 					expr_alloc_symbol(&symbol_mod)));
414 	}
415 }
416 
417 bool menu_has_prompt(struct menu *menu)
418 {
419 	if (!menu->prompt)
420 		return false;
421 	return true;
422 }
423 
424 bool menu_is_visible(struct menu *menu)
425 {
426 	struct menu *child;
427 	struct symbol *sym;
428 	tristate visible;
429 
430 	if (!menu->prompt)
431 		return false;
432 
433 	if (menu->visibility) {
434 		if (expr_calc_value(menu->visibility) == no)
435 			return no;
436 	}
437 
438 	sym = menu->sym;
439 	if (sym) {
440 		sym_calc_value(sym);
441 		visible = menu->prompt->visible.tri;
442 	} else
443 		visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
444 
445 	if (visible != no)
446 		return true;
447 
448 	if (!sym || sym_get_tristate_value(menu->sym) == no)
449 		return false;
450 
451 	for (child = menu->list; child; child = child->next) {
452 		if (menu_is_visible(child)) {
453 			if (sym)
454 				sym->flags |= SYMBOL_DEF_USER;
455 			return true;
456 		}
457 	}
458 
459 	return false;
460 }
461 
462 const char *menu_get_prompt(struct menu *menu)
463 {
464 	if (menu->prompt)
465 		return menu->prompt->text;
466 	else if (menu->sym)
467 		return menu->sym->name;
468 	return NULL;
469 }
470 
471 struct menu *menu_get_root_menu(struct menu *menu)
472 {
473 	return &rootmenu;
474 }
475 
476 struct menu *menu_get_parent_menu(struct menu *menu)
477 {
478 	enum prop_type type;
479 
480 	for (; menu != &rootmenu; menu = menu->parent) {
481 		type = menu->prompt ? menu->prompt->type : 0;
482 		if (type == P_MENU)
483 			break;
484 	}
485 	return menu;
486 }
487 
488 bool menu_has_help(struct menu *menu)
489 {
490 	return menu->help != NULL;
491 }
492 
493 const char *menu_get_help(struct menu *menu)
494 {
495 	if (menu->help)
496 		return menu->help;
497 	else
498 		return "";
499 }
500 
501 static void get_prompt_str(struct gstr *r, struct property *prop)
502 {
503 	int i, j;
504 	struct menu *submenu[8], *menu;
505 
506 	str_printf(r, _("Prompt: %s\n"), _(prop->text));
507 	str_printf(r, _("  Defined at %s:%d\n"), prop->menu->file->name,
508 		prop->menu->lineno);
509 	if (!expr_is_yes(prop->visible.expr)) {
510 		str_append(r, _("  Depends on: "));
511 		expr_gstr_print(prop->visible.expr, r);
512 		str_append(r, "\n");
513 	}
514 	menu = prop->menu->parent;
515 	for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent)
516 		submenu[i++] = menu;
517 	if (i > 0) {
518 		str_printf(r, _("  Location:\n"));
519 		for (j = 4; --i >= 0; j += 2) {
520 			menu = submenu[i];
521 			str_printf(r, "%*c-> %s", j, ' ', _(menu_get_prompt(menu)));
522 			if (menu->sym) {
523 				str_printf(r, " (%s [=%s])", menu->sym->name ?
524 					menu->sym->name : _("<choice>"),
525 					sym_get_string_value(menu->sym));
526 			}
527 			str_append(r, "\n");
528 		}
529 	}
530 }
531 
532 void get_symbol_str(struct gstr *r, struct symbol *sym)
533 {
534 	bool hit;
535 	struct property *prop;
536 
537 	if (sym && sym->name) {
538 		str_printf(r, "Symbol: %s [=%s]\n", sym->name,
539 			   sym_get_string_value(sym));
540 		str_printf(r, "Type  : %s\n", sym_type_name(sym->type));
541 		if (sym->type == S_INT || sym->type == S_HEX) {
542 			prop = sym_get_range_prop(sym);
543 			if (prop) {
544 				str_printf(r, "Range : ");
545 				expr_gstr_print(prop->expr, r);
546 				str_append(r, "\n");
547 			}
548 		}
549 	}
550 	for_all_prompts(sym, prop)
551 		get_prompt_str(r, prop);
552 	hit = false;
553 	for_all_properties(sym, prop, P_SELECT) {
554 		if (!hit) {
555 			str_append(r, "  Selects: ");
556 			hit = true;
557 		} else
558 			str_printf(r, " && ");
559 		expr_gstr_print(prop->expr, r);
560 	}
561 	if (hit)
562 		str_append(r, "\n");
563 	if (sym->rev_dep.expr) {
564 		str_append(r, _("  Selected by: "));
565 		expr_gstr_print(sym->rev_dep.expr, r);
566 		str_append(r, "\n");
567 	}
568 	str_append(r, "\n\n");
569 }
570 
571 struct gstr get_relations_str(struct symbol **sym_arr)
572 {
573 	struct symbol *sym;
574 	struct gstr res = str_new();
575 	int i;
576 
577 	for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
578 		get_symbol_str(&res, sym);
579 	if (!i)
580 		str_append(&res, _("No matches found.\n"));
581 	return res;
582 }
583 
584 
585 void menu_get_ext_help(struct menu *menu, struct gstr *help)
586 {
587 	struct symbol *sym = menu->sym;
588 
589 	if (menu_has_help(menu)) {
590 		if (sym->name) {
591 			str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
592 			str_append(help, _(menu_get_help(menu)));
593 			str_append(help, "\n");
594 		}
595 	} else {
596 		str_append(help, nohelp_text);
597 	}
598 	if (sym)
599 		get_symbol_str(help, sym);
600 }
601