xref: /linux/scripts/kconfig/menu.c (revision 6ee738610f41b59733f63718f0bdbcba7d3a3f12)
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 <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 kernel 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 }
62 
63 void menu_end_entry(void)
64 {
65 }
66 
67 struct menu *menu_add_menu(void)
68 {
69 	menu_end_entry();
70 	last_entry_ptr = &current_entry->list;
71 	return current_menu = current_entry;
72 }
73 
74 void menu_end_menu(void)
75 {
76 	last_entry_ptr = &current_menu->next;
77 	current_menu = current_menu->parent;
78 }
79 
80 static struct expr *menu_check_dep(struct expr *e)
81 {
82 	if (!e)
83 		return e;
84 
85 	switch (e->type) {
86 	case E_NOT:
87 		e->left.expr = menu_check_dep(e->left.expr);
88 		break;
89 	case E_OR:
90 	case E_AND:
91 		e->left.expr = menu_check_dep(e->left.expr);
92 		e->right.expr = menu_check_dep(e->right.expr);
93 		break;
94 	case E_SYMBOL:
95 		/* change 'm' into 'm' && MODULES */
96 		if (e->left.sym == &symbol_mod)
97 			return expr_alloc_and(e, expr_alloc_symbol(modules_sym));
98 		break;
99 	default:
100 		break;
101 	}
102 	return e;
103 }
104 
105 void menu_add_dep(struct expr *dep)
106 {
107 	current_entry->dep = expr_alloc_and(current_entry->dep, menu_check_dep(dep));
108 }
109 
110 void menu_set_type(int type)
111 {
112 	struct symbol *sym = current_entry->sym;
113 
114 	if (sym->type == type)
115 		return;
116 	if (sym->type == S_UNKNOWN) {
117 		sym->type = type;
118 		return;
119 	}
120 	menu_warn(current_entry, "type of '%s' redefined from '%s' to '%s'",
121 	    sym->name ? sym->name : "<choice>",
122 	    sym_type_name(sym->type), sym_type_name(type));
123 }
124 
125 struct property *menu_add_prop(enum prop_type type, char *prompt, struct expr *expr, struct expr *dep)
126 {
127 	struct property *prop = prop_alloc(type, current_entry->sym);
128 
129 	prop->menu = current_entry;
130 	prop->expr = expr;
131 	prop->visible.expr = menu_check_dep(dep);
132 
133 	if (prompt) {
134 		if (isspace(*prompt)) {
135 			prop_warn(prop, "leading whitespace ignored");
136 			while (isspace(*prompt))
137 				prompt++;
138 		}
139 		if (current_entry->prompt)
140 			prop_warn(prop, "prompt redefined");
141 		current_entry->prompt = prop;
142 	}
143 	prop->text = prompt;
144 
145 	return prop;
146 }
147 
148 struct property *menu_add_prompt(enum prop_type type, char *prompt, struct expr *dep)
149 {
150 	return menu_add_prop(type, prompt, NULL, dep);
151 }
152 
153 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
154 {
155 	menu_add_prop(type, NULL, expr, dep);
156 }
157 
158 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
159 {
160 	menu_add_prop(type, NULL, expr_alloc_symbol(sym), dep);
161 }
162 
163 void menu_add_option(int token, char *arg)
164 {
165 	struct property *prop;
166 
167 	switch (token) {
168 	case T_OPT_MODULES:
169 		prop = prop_alloc(P_DEFAULT, modules_sym);
170 		prop->expr = expr_alloc_symbol(current_entry->sym);
171 		break;
172 	case T_OPT_DEFCONFIG_LIST:
173 		if (!sym_defconfig_list)
174 			sym_defconfig_list = current_entry->sym;
175 		else if (sym_defconfig_list != current_entry->sym)
176 			zconf_error("trying to redefine defconfig symbol");
177 		break;
178 	case T_OPT_ENV:
179 		prop_add_env(arg);
180 		break;
181 	}
182 }
183 
184 static int menu_range_valid_sym(struct symbol *sym, struct symbol *sym2)
185 {
186 	return sym2->type == S_INT || sym2->type == S_HEX ||
187 	       (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
188 }
189 
190 static void sym_check_prop(struct symbol *sym)
191 {
192 	struct property *prop;
193 	struct symbol *sym2;
194 	for (prop = sym->prop; prop; prop = prop->next) {
195 		switch (prop->type) {
196 		case P_DEFAULT:
197 			if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
198 			    prop->expr->type != E_SYMBOL)
199 				prop_warn(prop,
200 				    "default for config symbol '%'"
201 				    " must be a single symbol", sym->name);
202 			break;
203 		case P_SELECT:
204 			sym2 = prop_get_symbol(prop);
205 			if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
206 				prop_warn(prop,
207 				    "config symbol '%s' uses select, but is "
208 				    "not boolean or tristate", sym->name);
209 			else if (sym2->type != S_UNKNOWN &&
210 			         sym2->type != S_BOOLEAN &&
211 			         sym2->type != S_TRISTATE)
212 				prop_warn(prop,
213 				    "'%s' has wrong type. 'select' only "
214 				    "accept arguments of boolean and "
215 				    "tristate type", sym2->name);
216 			break;
217 		case P_RANGE:
218 			if (sym->type != S_INT && sym->type != S_HEX)
219 				prop_warn(prop, "range is only allowed "
220 				                "for int or hex symbols");
221 			if (!menu_range_valid_sym(sym, prop->expr->left.sym) ||
222 			    !menu_range_valid_sym(sym, prop->expr->right.sym))
223 				prop_warn(prop, "range is invalid");
224 			break;
225 		default:
226 			;
227 		}
228 	}
229 }
230 
231 void menu_finalize(struct menu *parent)
232 {
233 	struct menu *menu, *last_menu;
234 	struct symbol *sym;
235 	struct property *prop;
236 	struct expr *parentdep, *basedep, *dep, *dep2, **ep;
237 
238 	sym = parent->sym;
239 	if (parent->list) {
240 		if (sym && sym_is_choice(sym)) {
241 			if (sym->type == S_UNKNOWN) {
242 				/* find the first choice value to find out choice type */
243 				current_entry = parent;
244 				for (menu = parent->list; menu; menu = menu->next) {
245 					if (menu->sym && menu->sym->type != S_UNKNOWN) {
246 						menu_set_type(menu->sym->type);
247 						break;
248 					}
249 				}
250 			}
251 			/* set the type of the remaining choice values */
252 			for (menu = parent->list; menu; menu = menu->next) {
253 				current_entry = menu;
254 				if (menu->sym && menu->sym->type == S_UNKNOWN)
255 					menu_set_type(sym->type);
256 			}
257 			parentdep = expr_alloc_symbol(sym);
258 		} else if (parent->prompt)
259 			parentdep = parent->prompt->visible.expr;
260 		else
261 			parentdep = parent->dep;
262 
263 		for (menu = parent->list; menu; menu = menu->next) {
264 			basedep = expr_transform(menu->dep);
265 			basedep = expr_alloc_and(expr_copy(parentdep), basedep);
266 			basedep = expr_eliminate_dups(basedep);
267 			menu->dep = basedep;
268 			if (menu->sym)
269 				prop = menu->sym->prop;
270 			else
271 				prop = menu->prompt;
272 			for (; prop; prop = prop->next) {
273 				if (prop->menu != menu)
274 					continue;
275 				dep = expr_transform(prop->visible.expr);
276 				dep = expr_alloc_and(expr_copy(basedep), dep);
277 				dep = expr_eliminate_dups(dep);
278 				if (menu->sym && menu->sym->type != S_TRISTATE)
279 					dep = expr_trans_bool(dep);
280 				prop->visible.expr = dep;
281 				if (prop->type == P_SELECT) {
282 					struct symbol *es = prop_get_symbol(prop);
283 					es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
284 							expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
285 				}
286 			}
287 		}
288 		for (menu = parent->list; menu; menu = menu->next)
289 			menu_finalize(menu);
290 	} else if (sym) {
291 		basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
292 		basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
293 		basedep = expr_eliminate_dups(expr_transform(basedep));
294 		last_menu = NULL;
295 		for (menu = parent->next; menu; menu = menu->next) {
296 			dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
297 			if (!expr_contains_symbol(dep, sym))
298 				break;
299 			if (expr_depends_symbol(dep, sym))
300 				goto next;
301 			dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
302 			dep = expr_eliminate_dups(expr_transform(dep));
303 			dep2 = expr_copy(basedep);
304 			expr_eliminate_eq(&dep, &dep2);
305 			expr_free(dep);
306 			if (!expr_is_yes(dep2)) {
307 				expr_free(dep2);
308 				break;
309 			}
310 			expr_free(dep2);
311 		next:
312 			menu_finalize(menu);
313 			menu->parent = parent;
314 			last_menu = menu;
315 		}
316 		if (last_menu) {
317 			parent->list = parent->next;
318 			parent->next = last_menu->next;
319 			last_menu->next = NULL;
320 		}
321 	}
322 	for (menu = parent->list; menu; menu = menu->next) {
323 		if (sym && sym_is_choice(sym) &&
324 		    menu->sym && !sym_is_choice_value(menu->sym)) {
325 			current_entry = menu;
326 			menu->sym->flags |= SYMBOL_CHOICEVAL;
327 			if (!menu->prompt)
328 				menu_warn(menu, "choice value must have a prompt");
329 			for (prop = menu->sym->prop; prop; prop = prop->next) {
330 				if (prop->type == P_DEFAULT)
331 					prop_warn(prop, "defaults for choice "
332 						  "values not supported");
333 				if (prop->menu == menu)
334 					continue;
335 				if (prop->type == P_PROMPT &&
336 				    prop->menu->parent->sym != sym)
337 					prop_warn(prop, "choice value used outside its choice group");
338 			}
339 			/* Non-tristate choice values of tristate choices must
340 			 * depend on the choice being set to Y. The choice
341 			 * values' dependencies were propagated to their
342 			 * properties above, so the change here must be re-
343 			 * propagated.
344 			 */
345 			if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
346 				basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
347 				menu->dep = expr_alloc_and(basedep, menu->dep);
348 				for (prop = menu->sym->prop; prop; prop = prop->next) {
349 					if (prop->menu != menu)
350 						continue;
351 					prop->visible.expr = expr_alloc_and(expr_copy(basedep),
352 									    prop->visible.expr);
353 				}
354 			}
355 			menu_add_symbol(P_CHOICE, sym, NULL);
356 			prop = sym_get_choice_prop(sym);
357 			for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
358 				;
359 			*ep = expr_alloc_one(E_LIST, NULL);
360 			(*ep)->right.sym = menu->sym;
361 		}
362 		if (menu->list && (!menu->prompt || !menu->prompt->text)) {
363 			for (last_menu = menu->list; ; last_menu = last_menu->next) {
364 				last_menu->parent = parent;
365 				if (!last_menu->next)
366 					break;
367 			}
368 			last_menu->next = menu->next;
369 			menu->next = menu->list;
370 			menu->list = NULL;
371 		}
372 	}
373 
374 	if (sym && !(sym->flags & SYMBOL_WARNED)) {
375 		if (sym->type == S_UNKNOWN)
376 			menu_warn(parent, "config symbol defined without type");
377 
378 		if (sym_is_choice(sym) && !parent->prompt)
379 			menu_warn(parent, "choice must have a prompt");
380 
381 		/* Check properties connected to this symbol */
382 		sym_check_prop(sym);
383 		sym->flags |= SYMBOL_WARNED;
384 	}
385 
386 	if (sym && !sym_is_optional(sym) && parent->prompt) {
387 		sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
388 				expr_alloc_and(parent->prompt->visible.expr,
389 					expr_alloc_symbol(&symbol_mod)));
390 	}
391 }
392 
393 bool menu_is_visible(struct menu *menu)
394 {
395 	struct menu *child;
396 	struct symbol *sym;
397 	tristate visible;
398 
399 	if (!menu->prompt)
400 		return false;
401 	sym = menu->sym;
402 	if (sym) {
403 		sym_calc_value(sym);
404 		visible = menu->prompt->visible.tri;
405 	} else
406 		visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
407 
408 	if (visible != no)
409 		return true;
410 	if (!sym || sym_get_tristate_value(menu->sym) == no)
411 		return false;
412 
413 	for (child = menu->list; child; child = child->next)
414 		if (menu_is_visible(child))
415 			return true;
416 	return false;
417 }
418 
419 const char *menu_get_prompt(struct menu *menu)
420 {
421 	if (menu->prompt)
422 		return menu->prompt->text;
423 	else if (menu->sym)
424 		return menu->sym->name;
425 	return NULL;
426 }
427 
428 struct menu *menu_get_root_menu(struct menu *menu)
429 {
430 	return &rootmenu;
431 }
432 
433 struct menu *menu_get_parent_menu(struct menu *menu)
434 {
435 	enum prop_type type;
436 
437 	for (; menu != &rootmenu; menu = menu->parent) {
438 		type = menu->prompt ? menu->prompt->type : 0;
439 		if (type == P_MENU)
440 			break;
441 	}
442 	return menu;
443 }
444 
445 bool menu_has_help(struct menu *menu)
446 {
447 	return menu->help != NULL;
448 }
449 
450 const char *menu_get_help(struct menu *menu)
451 {
452 	if (menu->help)
453 		return menu->help;
454 	else
455 		return "";
456 }
457 
458 static void get_prompt_str(struct gstr *r, struct property *prop)
459 {
460 	int i, j;
461 	struct menu *submenu[8], *menu;
462 
463 	str_printf(r, _("Prompt: %s\n"), _(prop->text));
464 	str_printf(r, _("  Defined at %s:%d\n"), prop->menu->file->name,
465 		prop->menu->lineno);
466 	if (!expr_is_yes(prop->visible.expr)) {
467 		str_append(r, _("  Depends on: "));
468 		expr_gstr_print(prop->visible.expr, r);
469 		str_append(r, "\n");
470 	}
471 	menu = prop->menu->parent;
472 	for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent)
473 		submenu[i++] = menu;
474 	if (i > 0) {
475 		str_printf(r, _("  Location:\n"));
476 		for (j = 4; --i >= 0; j += 2) {
477 			menu = submenu[i];
478 			str_printf(r, "%*c-> %s", j, ' ', _(menu_get_prompt(menu)));
479 			if (menu->sym) {
480 				str_printf(r, " (%s [=%s])", menu->sym->name ?
481 					menu->sym->name : _("<choice>"),
482 					sym_get_string_value(menu->sym));
483 			}
484 			str_append(r, "\n");
485 		}
486 	}
487 }
488 
489 void get_symbol_str(struct gstr *r, struct symbol *sym)
490 {
491 	bool hit;
492 	struct property *prop;
493 
494 	if (sym && sym->name)
495 		str_printf(r, "Symbol: %s [=%s]\n", sym->name,
496 			   sym_get_string_value(sym));
497 	for_all_prompts(sym, prop)
498 		get_prompt_str(r, prop);
499 	hit = false;
500 	for_all_properties(sym, prop, P_SELECT) {
501 		if (!hit) {
502 			str_append(r, "  Selects: ");
503 			hit = true;
504 		} else
505 			str_printf(r, " && ");
506 		expr_gstr_print(prop->expr, r);
507 	}
508 	if (hit)
509 		str_append(r, "\n");
510 	if (sym->rev_dep.expr) {
511 		str_append(r, _("  Selected by: "));
512 		expr_gstr_print(sym->rev_dep.expr, r);
513 		str_append(r, "\n");
514 	}
515 	str_append(r, "\n\n");
516 }
517 
518 void menu_get_ext_help(struct menu *menu, struct gstr *help)
519 {
520 	struct symbol *sym = menu->sym;
521 
522 	if (menu_has_help(menu)) {
523 		if (sym->name) {
524 			str_printf(help, "CONFIG_%s:\n\n", sym->name);
525 			str_append(help, _(menu_get_help(menu)));
526 			str_append(help, "\n");
527 		}
528 	} else {
529 		str_append(help, nohelp_text);
530 	}
531 	if (sym)
532 		get_symbol_str(help, sym);
533 }
534