projects/linux·blob v6.13 · refs

769 lines · 18.2 KiB

1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (C) 2002 Roman Zippel <[email protected]>
4 */
5
6#include <ctype.h>
7#include <stdarg.h>
8#include <stdlib.h>
9#include <string.h>
10
11#include <list.h>
12#include <xalloc.h>
13#include "lkc.h"
14#include "internal.h"
15
16static const char nohelp_text[] = "There is no help available for this option.";
17
18struct menu rootmenu;
19static struct menu **last_entry_ptr;
20
21/**
22 * menu_next - return the next menu entry with depth-first traversal
23 * @menu: pointer to the current menu
24 * @root: root of the sub-tree to traverse. If NULL is given, the traveral
25 * continues until it reaches the end of the entire menu tree.
26 * return: the menu to visit next, or NULL when it reaches the end.
27 */
28struct menu *menu_next(struct menu *menu, struct menu *root)
29{
30 if (menu->list)
31 return menu->list;
32
33 while (menu != root && !menu->next)
34 menu = menu->parent;
35
36 if (menu == root)
37 return NULL;
38
39 return menu->next;
40}
41
42void menu_warn(const struct menu *menu, const char *fmt, ...)
43{
44 va_list ap;
45 va_start(ap, fmt);
46 fprintf(stderr, "%s:%d:warning: ", menu->filename, menu->lineno);
47 vfprintf(stderr, fmt, ap);
48 fprintf(stderr, "\n");
49 va_end(ap);
50}
51
52static void prop_warn(const struct property *prop, const char *fmt, ...)
53{
54 va_list ap;
55 va_start(ap, fmt);
56 fprintf(stderr, "%s:%d:warning: ", prop->filename, prop->lineno);
57 vfprintf(stderr, fmt, ap);
58 fprintf(stderr, "\n");
59 va_end(ap);
60}
61
62void _menu_init(void)
63{
64 current_entry = current_menu = &rootmenu;
65 last_entry_ptr = &rootmenu.list;
66}
67
68void menu_add_entry(struct symbol *sym)
69{
70 struct menu *menu;
71
72 menu = xmalloc(sizeof(*menu));
73 memset(menu, 0, sizeof(*menu));
74 menu->sym = sym;
75 menu->parent = current_menu;
76 menu->filename = cur_filename;
77 menu->lineno = cur_lineno;
78
79 *last_entry_ptr = menu;
80 last_entry_ptr = &menu->next;
81 current_entry = menu;
82 if (sym)
83 list_add_tail(&menu->link, &sym->menus);
84}
85
86struct menu *menu_add_menu(void)
87{
88 last_entry_ptr = &current_entry->list;
89 current_menu = current_entry;
90 return current_menu;
91}
92
93void menu_end_menu(void)
94{
95 last_entry_ptr = &current_menu->next;
96 current_menu = current_menu->parent;
97}
98
99/*
100 * Rewrites 'm' to 'm' && MODULES, so that it evaluates to 'n' when running
101 * without modules
102 */
103static struct expr *rewrite_m(struct expr *e)
104{
105 if (!e)
106 return e;
107
108 switch (e->type) {
109 case E_NOT:
110 e = expr_alloc_one(E_NOT, rewrite_m(e->left.expr));
111 break;
112 case E_OR:
113 case E_AND:
114 e = expr_alloc_two(e->type,
115 rewrite_m(e->left.expr),
116 rewrite_m(e->right.expr));
117 break;
118 case E_SYMBOL:
119 /* change 'm' into 'm' && MODULES */
120 if (e->left.sym == &symbol_mod)
121 return expr_alloc_and(e, expr_alloc_symbol(modules_sym));
122 break;
123 default:
124 break;
125 }
126 return e;
127}
128
129void menu_add_dep(struct expr *dep)
130{
131 current_entry->dep = expr_alloc_and(current_entry->dep, dep);
132}
133
134void menu_set_type(int type)
135{
136 struct symbol *sym = current_entry->sym;
137
138 if (sym->type == type)
139 return;
140 if (sym->type == S_UNKNOWN) {
141 sym->type = type;
142 return;
143 }
144 menu_warn(current_entry,
145 "ignoring type redefinition of '%s' from '%s' to '%s'",
146 sym->name ? sym->name : "<choice>",
147 sym_type_name(sym->type), sym_type_name(type));
148}
149
150static struct property *menu_add_prop(enum prop_type type, struct expr *expr,
151 struct expr *dep)
152{
153 struct property *prop;
154
155 prop = xmalloc(sizeof(*prop));
156 memset(prop, 0, sizeof(*prop));
157 prop->type = type;
158 prop->filename = cur_filename;
159 prop->lineno = cur_lineno;
160 prop->menu = current_entry;
161 prop->expr = expr;
162 prop->visible.expr = dep;
163
164 /* append property to the prop list of symbol */
165 if (current_entry->sym) {
166 struct property **propp;
167
168 for (propp = &current_entry->sym->prop;
169 *propp;
170 propp = &(*propp)->next)
171 ;
172 *propp = prop;
173 }
174
175 return prop;
176}
177
178struct property *menu_add_prompt(enum prop_type type, const char *prompt,
179 struct expr *dep)
180{
181 struct property *prop = menu_add_prop(type, NULL, dep);
182
183 if (isspace(*prompt)) {
184 prop_warn(prop, "leading whitespace ignored");
185 while (isspace(*prompt))
186 prompt++;
187 }
188 if (current_entry->prompt)
189 prop_warn(prop, "prompt redefined");
190
191 /* Apply all upper menus' visibilities to actual prompts. */
192 if (type == P_PROMPT) {
193 struct menu *menu = current_entry;
194
195 while ((menu = menu->parent) != NULL) {
196
197 if (!menu->visibility)
198 continue;
199 prop->visible.expr = expr_alloc_and(prop->visible.expr,
200 menu->visibility);
201 }
202 }
203
204 current_entry->prompt = prop;
205 prop->text = prompt;
206
207 return prop;
208}
209
210void menu_add_visibility(struct expr *expr)
211{
212 current_entry->visibility = expr_alloc_and(current_entry->visibility,
213 expr);
214}
215
216void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
217{
218 menu_add_prop(type, expr, dep);
219}
220
221void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
222{
223 menu_add_prop(type, expr_alloc_symbol(sym), dep);
224}
225
226static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
227{
228 return sym2->type == S_INT || sym2->type == S_HEX ||
229 (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
230}
231
232static void sym_check_prop(struct symbol *sym)
233{
234 struct property *prop;
235 struct symbol *sym2;
236 char *use;
237
238 for (prop = sym->prop; prop; prop = prop->next) {
239 switch (prop->type) {
240 case P_DEFAULT:
241 if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
242 prop->expr->type != E_SYMBOL)
243 prop_warn(prop,
244 "default for config symbol '%s'"
245 " must be a single symbol", sym->name);
246 if (prop->expr->type != E_SYMBOL)
247 break;
248 sym2 = prop_get_symbol(prop);
249 if (sym->type == S_HEX || sym->type == S_INT) {
250 if (!menu_validate_number(sym, sym2))
251 prop_warn(prop,
252 "'%s': number is invalid",
253 sym->name);
254 }
255 if (sym_is_choice(sym)) {
256 struct menu *choice = sym_get_choice_menu(sym2);
257
258 if (!choice || choice->sym != sym)
259 prop_warn(prop,
260 "choice default symbol '%s' is not contained in the choice",
261 sym2->name);
262 }
263 break;
264 case P_SELECT:
265 case P_IMPLY:
266 use = prop->type == P_SELECT ? "select" : "imply";
267 sym2 = prop_get_symbol(prop);
268 if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
269 prop_warn(prop,
270 "config symbol '%s' uses %s, but is "
271 "not bool or tristate", sym->name, use);
272 else if (sym2->type != S_UNKNOWN &&
273 sym2->type != S_BOOLEAN &&
274 sym2->type != S_TRISTATE)
275 prop_warn(prop,
276 "'%s' has wrong type. '%s' only "
277 "accept arguments of bool and "
278 "tristate type", sym2->name, use);
279 break;
280 case P_RANGE:
281 if (sym->type != S_INT && sym->type != S_HEX)
282 prop_warn(prop, "range is only allowed "
283 "for int or hex symbols");
284 if (!menu_validate_number(sym, prop->expr->left.sym) ||
285 !menu_validate_number(sym, prop->expr->right.sym))
286 prop_warn(prop, "range is invalid");
287 break;
288 default:
289 ;
290 }
291 }
292}
293
294static void _menu_finalize(struct menu *parent, bool inside_choice)
295{
296 struct menu *menu, *last_menu;
297 struct symbol *sym;
298 struct property *prop;
299 struct expr *basedep, *dep, *dep2;
300
301 sym = parent->sym;
302 if (parent->list) {
303 /*
304 * This menu node has children. We (recursively) process them
305 * and propagate parent dependencies before moving on.
306 */
307
308 /* For each child menu node... */
309 for (menu = parent->list; menu; menu = menu->next) {
310 /*
311 * Propagate parent dependencies to the child menu
312 * node, also rewriting and simplifying expressions
313 */
314 basedep = rewrite_m(menu->dep);
315 basedep = expr_transform(basedep);
316 basedep = expr_alloc_and(parent->dep, basedep);
317 basedep = expr_eliminate_dups(basedep);
318 menu->dep = basedep;
319
320 if (menu->sym)
321 /*
322 * Note: For symbols, all prompts are included
323 * too in the symbol's own property list
324 */
325 prop = menu->sym->prop;
326 else
327 /*
328 * For non-symbol menu nodes, we just need to
329 * handle the prompt
330 */
331 prop = menu->prompt;
332
333 /* For each property... */
334 for (; prop; prop = prop->next) {
335 if (prop->menu != menu)
336 /*
337 * Two possibilities:
338 *
339 * 1. The property lacks dependencies
340 * and so isn't location-specific,
341 * e.g. an 'option'
342 *
343 * 2. The property belongs to a symbol
344 * defined in multiple locations and
345 * is from some other location. It
346 * will be handled there in that
347 * case.
348 *
349 * Skip the property.
350 */
351 continue;
352
353 /*
354 * Propagate parent dependencies to the
355 * property's condition, rewriting and
356 * simplifying expressions at the same time
357 */
358 dep = rewrite_m(prop->visible.expr);
359 dep = expr_transform(dep);
360 dep = expr_alloc_and(basedep, dep);
361 dep = expr_eliminate_dups(dep);
362 prop->visible.expr = dep;
363
364 /*
365 * Handle selects and implies, which modify the
366 * dependencies of the selected/implied symbol
367 */
368 if (prop->type == P_SELECT) {
369 struct symbol *es = prop_get_symbol(prop);
370 es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
371 expr_alloc_and(expr_alloc_symbol(menu->sym), dep));
372 } else if (prop->type == P_IMPLY) {
373 struct symbol *es = prop_get_symbol(prop);
374 es->implied.expr = expr_alloc_or(es->implied.expr,
375 expr_alloc_and(expr_alloc_symbol(menu->sym), dep));
376 }
377 }
378 }
379
380 /*
381 * Recursively process children in the same fashion before
382 * moving on
383 */
384 for (menu = parent->list; menu; menu = menu->next)
385 _menu_finalize(menu, sym && sym_is_choice(sym));
386 } else if (!inside_choice && sym) {
387 /*
388 * Automatic submenu creation. If sym is a symbol and A, B, C,
389 * ... are consecutive items (symbols, menus, ifs, etc.) that
390 * all depend on sym, then the following menu structure is
391 * created:
392 *
393 * sym
394 * +-A
395 * +-B
396 * +-C
397 * ...
398 *
399 * This also works recursively, giving the following structure
400 * if A is a symbol and B depends on A:
401 *
402 * sym
403 * +-A
404 * | +-B
405 * +-C
406 * ...
407 */
408
409 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
410 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
411 basedep = expr_eliminate_dups(expr_transform(basedep));
412
413 /* Examine consecutive elements after sym */
414 last_menu = NULL;
415 for (menu = parent->next; menu; menu = menu->next) {
416 dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
417 if (!expr_contains_symbol(dep, sym))
418 /* No dependency, quit */
419 break;
420 if (expr_depends_symbol(dep, sym))
421 /* Absolute dependency, put in submenu */
422 goto next;
423
424 /*
425 * Also consider it a dependency on sym if our
426 * dependencies contain sym and are a "superset" of
427 * sym's dependencies, e.g. '(sym || Q) && R' when sym
428 * depends on R.
429 *
430 * Note that 'R' might be from an enclosing menu or if,
431 * making this a more common case than it might seem.
432 */
433 dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
434 dep = expr_eliminate_dups(expr_transform(dep));
435 dep2 = basedep;
436 expr_eliminate_eq(&dep, &dep2);
437 if (!expr_is_yes(dep2)) {
438 /* Not superset, quit */
439 break;
440 }
441 /* Superset, put in submenu */
442 next:
443 _menu_finalize(menu, false);
444 menu->parent = parent;
445 last_menu = menu;
446 }
447 if (last_menu) {
448 parent->list = parent->next;
449 parent->next = last_menu->next;
450 last_menu->next = NULL;
451 }
452
453 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
454 }
455 for (menu = parent->list; menu; menu = menu->next) {
456 /*
457 * This code serves two purposes:
458 *
459 * (1) Flattening 'if' blocks, which do not specify a submenu
460 * and only add dependencies.
461 *
462 * (Automatic submenu creation might still create a submenu
463 * from an 'if' before this code runs.)
464 *
465 * (2) "Undoing" any automatic submenus created earlier below
466 * promptless symbols.
467 *
468 * Before:
469 *
470 * A
471 * if ... (or promptless symbol)
472 * +-B
473 * +-C
474 * D
475 *
476 * After:
477 *
478 * A
479 * if ... (or promptless symbol)
480 * B
481 * C
482 * D
483 */
484 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
485 for (last_menu = menu->list; ; last_menu = last_menu->next) {
486 last_menu->parent = parent;
487 if (!last_menu->next)
488 break;
489 }
490 last_menu->next = menu->next;
491 menu->next = menu->list;
492 menu->list = NULL;
493 }
494 }
495
496 if (sym && !(sym->flags & SYMBOL_WARNED)) {
497 if (sym->type == S_UNKNOWN)
498 menu_warn(parent, "config symbol defined without type");
499
500 /* Check properties connected to this symbol */
501 sym_check_prop(sym);
502 sym->flags |= SYMBOL_WARNED;
503 }
504}
505
506void menu_finalize(void)
507{
508 _menu_finalize(&rootmenu, false);
509}
510
511bool menu_has_prompt(const struct menu *menu)
512{
513 if (!menu->prompt)
514 return false;
515 return true;
516}
517
518/*
519 * Determine if a menu is empty.
520 * A menu is considered empty if it contains no or only
521 * invisible entries.
522 */
523bool menu_is_empty(struct menu *menu)
524{
525 struct menu *child;
526
527 for (child = menu->list; child; child = child->next) {
528 if (menu_is_visible(child))
529 return(false);
530 }
531 return(true);
532}
533
534bool menu_is_visible(struct menu *menu)
535{
536 struct menu *child;
537 struct symbol *sym;
538 tristate visible;
539
540 if (!menu->prompt)
541 return false;
542
543 if (menu->visibility) {
544 if (expr_calc_value(menu->visibility) == no)
545 return false;
546 }
547
548 sym = menu->sym;
549 if (sym) {
550 sym_calc_value(sym);
551 visible = menu->prompt->visible.tri;
552 } else
553 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
554
555 if (visible != no)
556 return true;
557
558 if (!sym || sym_get_tristate_value(menu->sym) == no)
559 return false;
560
561 for (child = menu->list; child; child = child->next)
562 if (menu_is_visible(child))
563 return true;
564
565 return false;
566}
567
568const char *menu_get_prompt(const struct menu *menu)
569{
570 if (menu->prompt)
571 return menu->prompt->text;
572 else if (menu->sym)
573 return menu->sym->name;
574 return NULL;
575}
576
577struct menu *menu_get_parent_menu(struct menu *menu)
578{
579 enum prop_type type;
580
581 for (; menu != &rootmenu; menu = menu->parent) {
582 type = menu->prompt ? menu->prompt->type : 0;
583 if (type == P_MENU)
584 break;
585 }
586 return menu;
587}
588
589static void get_def_str(struct gstr *r, const struct menu *menu)
590{
591 str_printf(r, "Defined at %s:%d\n",
592 menu->filename, menu->lineno);
593}
594
595static void get_dep_str(struct gstr *r, const struct expr *expr,
596 const char *prefix)
597{
598 if (!expr_is_yes(expr)) {
599 str_append(r, prefix);
600 expr_gstr_print(expr, r);
601 str_append(r, "\n");
602 }
603}
604
605int __attribute__((weak)) get_jump_key_char(void)
606{
607 return -1;
608}
609
610static void get_prompt_str(struct gstr *r, struct property *prop,
611 struct list_head *head)
612{
613 int i, j;
614 struct menu *submenu[8], *menu, *location = NULL;
615 struct jump_key *jump = NULL;
616
617 str_printf(r, " Prompt: %s\n", prop->text);
618
619 get_dep_str(r, prop->menu->dep, " Depends on: ");
620 /*
621 * Most prompts in Linux have visibility that exactly matches their
622 * dependencies. For these, we print only the dependencies to improve
623 * readability. However, prompts with inline "if" expressions and
624 * prompts with a parent that has a "visible if" expression have
625 * differing dependencies and visibility. In these rare cases, we
626 * print both.
627 */
628 if (!expr_eq(prop->menu->dep, prop->visible.expr))
629 get_dep_str(r, prop->visible.expr, " Visible if: ");
630
631 menu = prop->menu;
632 for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
633 submenu[i++] = menu;
634 if (location == NULL && menu_is_visible(menu))
635 location = menu;
636 }
637 if (head && location) {
638 jump = xmalloc(sizeof(struct jump_key));
639 jump->target = location;
640 list_add_tail(&jump->entries, head);
641 }
642
643 str_printf(r, " Location:\n");
644 for (j = 0; --i >= 0; j++) {
645 int jk = -1;
646 int indent = 2 * j + 4;
647
648 menu = submenu[i];
649 if (jump && menu == location) {
650 jump->offset = strlen(r->s);
651 jk = get_jump_key_char();
652 }
653
654 if (jk >= 0) {
655 str_printf(r, "(%c)", jk);
656 indent -= 3;
657 }
658
659 str_printf(r, "%*c-> %s", indent, ' ', menu_get_prompt(menu));
660 if (menu->sym) {
661 str_printf(r, " (%s [=%s])", menu->sym->name ?
662 menu->sym->name : "<choice>",
663 sym_get_string_value(menu->sym));
664 }
665 str_append(r, "\n");
666 }
667}
668
669static void get_symbol_props_str(struct gstr *r, struct symbol *sym,
670 enum prop_type tok, const char *prefix)
671{
672 bool hit = false;
673 struct property *prop;
674
675 for_all_properties(sym, prop, tok) {
676 if (!hit) {
677 str_append(r, prefix);
678 hit = true;
679 } else
680 str_printf(r, " && ");
681 expr_gstr_print(prop->expr, r);
682 }
683 if (hit)
684 str_append(r, "\n");
685}
686
687/*
688 * head is optional and may be NULL
689 */
690static void get_symbol_str(struct gstr *r, struct symbol *sym,
691 struct list_head *head)
692{
693 struct property *prop;
694 struct menu *menu;
695
696 if (sym && sym->name) {
697 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
698 sym_get_string_value(sym));
699 str_printf(r, "Type : %s\n", sym_type_name(sym->type));
700 if (sym->type == S_INT || sym->type == S_HEX) {
701 prop = sym_get_range_prop(sym);
702 if (prop) {
703 str_printf(r, "Range : ");
704 expr_gstr_print(prop->expr, r);
705 str_append(r, "\n");
706 }
707 }
708 }
709
710 /* Print the definitions with prompts before the ones without */
711 list_for_each_entry(menu, &sym->menus, link) {
712 if (menu->prompt) {
713 get_def_str(r, menu);
714 get_prompt_str(r, menu->prompt, head);
715 }
716 }
717
718 list_for_each_entry(menu, &sym->menus, link) {
719 if (!menu->prompt) {
720 get_def_str(r, menu);
721 get_dep_str(r, menu->dep, " Depends on: ");
722 }
723 }
724
725 get_symbol_props_str(r, sym, P_SELECT, "Selects: ");
726 if (sym->rev_dep.expr) {
727 expr_gstr_print_revdep(sym->rev_dep.expr, r, yes, "Selected by [y]:\n");
728 expr_gstr_print_revdep(sym->rev_dep.expr, r, mod, "Selected by [m]:\n");
729 expr_gstr_print_revdep(sym->rev_dep.expr, r, no, "Selected by [n]:\n");
730 }
731
732 get_symbol_props_str(r, sym, P_IMPLY, "Implies: ");
733 if (sym->implied.expr) {
734 expr_gstr_print_revdep(sym->implied.expr, r, yes, "Implied by [y]:\n");
735 expr_gstr_print_revdep(sym->implied.expr, r, mod, "Implied by [m]:\n");
736 expr_gstr_print_revdep(sym->implied.expr, r, no, "Implied by [n]:\n");
737 }
738
739 str_append(r, "\n\n");
740}
741
742struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
743{
744 struct symbol *sym;
745 struct gstr res = str_new();
746 int i;
747
748 for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
749 get_symbol_str(&res, sym, head);
750 if (!i)
751 str_append(&res, "No matches found.\n");
752 return res;
753}
754
755
756void menu_get_ext_help(struct menu *menu, struct gstr *help)
757{
758 struct symbol *sym = menu->sym;
759 const char *help_text = nohelp_text;
760
761 if (menu->help) {
762 if (sym->name)
763 str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
764 help_text = menu->help;
765 }
766 str_printf(help, "%s\n", help_text);
767 if (sym)
768 get_symbol_str(help, sym, NULL);
769}