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