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