1 // SPDX-License-Identifier: GPL-2.0
15 static const char nohelp_text[] = "There is no help available for this option.";
18 static struct menu **last_entry_ptr;
21 * menu_next - return the next menu entry with depth-first traversal
22 * @menu: pointer to the current menu
23 * @root: root of the sub-tree to traverse. If NULL is given, the traveral
24 * continues until it reaches the end of the entire menu tree.
25 * return: the menu to visit next, or NULL when it reaches the end.
27 struct menu *menu_next(struct menu *menu, struct menu *root)
32 while (menu != root && !menu->next)
41 void menu_warn(const struct menu *menu, const char *fmt, ...)
45 fprintf(stderr, "%s:%d:warning: ", menu->filename, menu->lineno);
46 vfprintf(stderr, fmt, ap);
47 fprintf(stderr, "\n");
51 static void prop_warn(const struct property *prop, const char *fmt, ...)
55 fprintf(stderr, "%s:%d:warning: ", prop->filename, prop->lineno);
56 vfprintf(stderr, fmt, ap);
57 fprintf(stderr, "\n");
63 current_entry = current_menu = &rootmenu;
64 last_entry_ptr = &rootmenu.list;
67 void menu_add_entry(struct symbol *sym)
71 menu = xmalloc(sizeof(*menu));
72 memset(menu, 0, sizeof(*menu));
74 menu->parent = current_menu;
75 menu->filename = cur_filename;
76 menu->lineno = cur_lineno;
78 *last_entry_ptr = menu;
79 last_entry_ptr = &menu->next;
82 menu_add_symbol(P_SYMBOL, sym, NULL);
83 list_add_tail(&menu->link, &sym->menus);
87 struct menu *menu_add_menu(void)
89 last_entry_ptr = ¤t_entry->list;
90 current_menu = current_entry;
94 void menu_end_menu(void)
96 last_entry_ptr = ¤t_menu->next;
97 current_menu = current_menu->parent;
101 * Rewrites 'm' to 'm' && MODULES, so that it evaluates to 'n' when running
104 static struct expr *rewrite_m(struct expr *e)
111 e->left.expr = rewrite_m(e->left.expr);
115 e->left.expr = rewrite_m(e->left.expr);
116 e->right.expr = rewrite_m(e->right.expr);
119 /* change 'm' into 'm' && MODULES */
120 if (e->left.sym == &symbol_mod)
121 return expr_alloc_and(e, expr_alloc_symbol(modules_sym));
129 void menu_add_dep(struct expr *dep)
131 current_entry->dep = expr_alloc_and(current_entry->dep, dep);
134 void menu_set_type(int type)
136 struct symbol *sym = current_entry->sym;
138 if (sym->type == type)
140 if (sym->type == S_UNKNOWN) {
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));
150 static struct property *menu_add_prop(enum prop_type type, struct expr *expr,
153 struct property *prop;
155 prop = xmalloc(sizeof(*prop));
156 memset(prop, 0, sizeof(*prop));
158 prop->filename = cur_filename;
159 prop->lineno = cur_lineno;
160 prop->menu = current_entry;
162 prop->visible.expr = dep;
164 /* append property to the prop list of symbol */
165 if (current_entry->sym) {
166 struct property **propp;
168 for (propp = ¤t_entry->sym->prop;
170 propp = &(*propp)->next)
178 struct property *menu_add_prompt(enum prop_type type, const char *prompt,
181 struct property *prop = menu_add_prop(type, NULL, dep);
183 if (isspace(*prompt)) {
184 prop_warn(prop, "leading whitespace ignored");
185 while (isspace(*prompt))
188 if (current_entry->prompt)
189 prop_warn(prop, "prompt redefined");
191 /* Apply all upper menus' visibilities to actual prompts. */
192 if (type == P_PROMPT) {
193 struct menu *menu = current_entry;
195 while ((menu = menu->parent) != NULL) {
196 struct expr *dup_expr;
198 if (!menu->visibility)
201 * Do not add a reference to the menu's visibility
202 * expression but use a copy of it. Otherwise the
203 * expression reduction functions will modify
204 * expressions that have multiple references which
205 * can cause unwanted side effects.
207 dup_expr = expr_copy(menu->visibility);
209 prop->visible.expr = expr_alloc_and(prop->visible.expr,
214 current_entry->prompt = prop;
220 void menu_add_visibility(struct expr *expr)
222 current_entry->visibility = expr_alloc_and(current_entry->visibility,
226 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
228 menu_add_prop(type, expr, dep);
231 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
233 menu_add_prop(type, expr_alloc_symbol(sym), dep);
236 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
238 return sym2->type == S_INT || sym2->type == S_HEX ||
239 (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
242 static void sym_check_prop(struct symbol *sym)
244 struct property *prop;
248 for (prop = sym->prop; prop; prop = prop->next) {
249 switch (prop->type) {
251 if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
252 prop->expr->type != E_SYMBOL)
254 "default for config symbol '%s'"
255 " must be a single symbol", sym->name);
256 if (prop->expr->type != E_SYMBOL)
258 sym2 = prop_get_symbol(prop);
259 if (sym->type == S_HEX || sym->type == S_INT) {
260 if (!menu_validate_number(sym, sym2))
262 "'%s': number is invalid",
265 if (sym_is_choice(sym)) {
266 struct menu *choice = sym_get_choice_menu(sym2);
268 if (!choice || choice->sym != sym)
270 "choice default symbol '%s' is not contained in the choice",
276 use = prop->type == P_SELECT ? "select" : "imply";
277 sym2 = prop_get_symbol(prop);
278 if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
280 "config symbol '%s' uses %s, but is "
281 "not bool or tristate", sym->name, use);
282 else if (sym2->type != S_UNKNOWN &&
283 sym2->type != S_BOOLEAN &&
284 sym2->type != S_TRISTATE)
286 "'%s' has wrong type. '%s' only "
287 "accept arguments of bool and "
288 "tristate type", sym2->name, use);
291 if (sym->type != S_INT && sym->type != S_HEX)
292 prop_warn(prop, "range is only allowed "
293 "for int or hex symbols");
294 if (!menu_validate_number(sym, prop->expr->left.sym) ||
295 !menu_validate_number(sym, prop->expr->right.sym))
296 prop_warn(prop, "range is invalid");
304 static void _menu_finalize(struct menu *parent, bool inside_choice)
306 struct menu *menu, *last_menu;
308 struct property *prop;
309 struct expr *basedep, *dep, *dep2;
314 * This menu node has children. We (recursively) process them
315 * and propagate parent dependencies before moving on.
318 /* For each child menu node... */
319 for (menu = parent->list; menu; menu = menu->next) {
321 * Propagate parent dependencies to the child menu
322 * node, also rewriting and simplifying expressions
324 basedep = rewrite_m(menu->dep);
325 basedep = expr_transform(basedep);
326 basedep = expr_alloc_and(expr_copy(parent->dep), basedep);
327 basedep = expr_eliminate_dups(basedep);
332 * Note: For symbols, all prompts are included
333 * too in the symbol's own property list
335 prop = menu->sym->prop;
338 * For non-symbol menu nodes, we just need to
343 /* For each property... */
344 for (; prop; prop = prop->next) {
345 if (prop->menu != menu)
349 * 1. The property lacks dependencies
350 * and so isn't location-specific,
353 * 2. The property belongs to a symbol
354 * defined in multiple locations and
355 * is from some other location. It
356 * will be handled there in that
364 * Propagate parent dependencies to the
365 * property's condition, rewriting and
366 * simplifying expressions at the same time
368 dep = rewrite_m(prop->visible.expr);
369 dep = expr_transform(dep);
370 dep = expr_alloc_and(expr_copy(basedep), dep);
371 dep = expr_eliminate_dups(dep);
372 prop->visible.expr = dep;
375 * Handle selects and implies, which modify the
376 * dependencies of the selected/implied symbol
378 if (prop->type == P_SELECT) {
379 struct symbol *es = prop_get_symbol(prop);
380 es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
381 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
382 } else if (prop->type == P_IMPLY) {
383 struct symbol *es = prop_get_symbol(prop);
384 es->implied.expr = expr_alloc_or(es->implied.expr,
385 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
391 * Recursively process children in the same fashion before
394 for (menu = parent->list; menu; menu = menu->next)
395 _menu_finalize(menu, sym && sym_is_choice(sym));
396 } else if (!inside_choice && sym) {
398 * Automatic submenu creation. If sym is a symbol and A, B, C,
399 * ... are consecutive items (symbols, menus, ifs, etc.) that
400 * all depend on sym, then the following menu structure is
409 * This also works recursively, giving the following structure
410 * if A is a symbol and B depends on A:
419 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
420 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
421 basedep = expr_eliminate_dups(expr_transform(basedep));
423 /* Examine consecutive elements after sym */
425 for (menu = parent->next; menu; menu = menu->next) {
426 dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
427 if (!expr_contains_symbol(dep, sym))
428 /* No dependency, quit */
430 if (expr_depends_symbol(dep, sym))
431 /* Absolute dependency, put in submenu */
435 * Also consider it a dependency on sym if our
436 * dependencies contain sym and are a "superset" of
437 * sym's dependencies, e.g. '(sym || Q) && R' when sym
440 * Note that 'R' might be from an enclosing menu or if,
441 * making this a more common case than it might seem.
443 dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
444 dep = expr_eliminate_dups(expr_transform(dep));
445 dep2 = expr_copy(basedep);
446 expr_eliminate_eq(&dep, &dep2);
448 if (!expr_is_yes(dep2)) {
449 /* Not superset, quit */
453 /* Superset, put in submenu */
456 _menu_finalize(menu, false);
457 menu->parent = parent;
462 parent->list = parent->next;
463 parent->next = last_menu->next;
464 last_menu->next = NULL;
467 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
469 for (menu = parent->list; menu; menu = menu->next) {
471 * This code serves two purposes:
473 * (1) Flattening 'if' blocks, which do not specify a submenu
474 * and only add dependencies.
476 * (Automatic submenu creation might still create a submenu
477 * from an 'if' before this code runs.)
479 * (2) "Undoing" any automatic submenus created earlier below
480 * promptless symbols.
485 * if ... (or promptless symbol)
493 * if ... (or promptless symbol)
498 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
499 for (last_menu = menu->list; ; last_menu = last_menu->next) {
500 last_menu->parent = parent;
501 if (!last_menu->next)
504 last_menu->next = menu->next;
505 menu->next = menu->list;
510 if (sym && !(sym->flags & SYMBOL_WARNED)) {
511 if (sym->type == S_UNKNOWN)
512 menu_warn(parent, "config symbol defined without type");
514 /* Check properties connected to this symbol */
516 sym->flags |= SYMBOL_WARNED;
520 void menu_finalize(void)
522 _menu_finalize(&rootmenu, false);
525 bool menu_has_prompt(const struct menu *menu)
533 * Determine if a menu is empty.
534 * A menu is considered empty if it contains no or only
537 bool menu_is_empty(struct menu *menu)
541 for (child = menu->list; child; child = child->next) {
542 if (menu_is_visible(child))
548 bool menu_is_visible(struct menu *menu)
556 if (menu->visibility) {
557 if (expr_calc_value(menu->visibility) == no)
564 visible = menu->prompt->visible.tri;
566 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
568 return visible != no;
571 const char *menu_get_prompt(const struct menu *menu)
574 return menu->prompt->text;
576 return menu->sym->name;
580 struct menu *menu_get_parent_menu(struct menu *menu)
584 for (; menu != &rootmenu; menu = menu->parent) {
585 type = menu->prompt ? menu->prompt->type : 0;
592 static void get_def_str(struct gstr *r, const struct menu *menu)
594 str_printf(r, "Defined at %s:%d\n",
595 menu->filename, menu->lineno);
598 static void get_dep_str(struct gstr *r, const struct expr *expr,
601 if (!expr_is_yes(expr)) {
602 str_append(r, prefix);
603 expr_gstr_print(expr, r);
608 int __attribute__((weak)) get_jump_key_char(void)
613 static void get_prompt_str(struct gstr *r, struct property *prop,
614 struct list_head *head)
617 struct menu *submenu[8], *menu, *location = NULL;
618 struct jump_key *jump = NULL;
620 str_printf(r, " Prompt: %s\n", prop->text);
622 get_dep_str(r, prop->menu->dep, " Depends on: ");
624 * Most prompts in Linux have visibility that exactly matches their
625 * dependencies. For these, we print only the dependencies to improve
626 * readability. However, prompts with inline "if" expressions and
627 * prompts with a parent that has a "visible if" expression have
628 * differing dependencies and visibility. In these rare cases, we
631 if (!expr_eq(prop->menu->dep, prop->visible.expr))
632 get_dep_str(r, prop->visible.expr, " Visible if: ");
635 for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
637 if (location == NULL && menu_is_visible(menu))
640 if (head && location) {
641 jump = xmalloc(sizeof(struct jump_key));
642 jump->target = location;
643 list_add_tail(&jump->entries, head);
646 str_printf(r, " Location:\n");
647 for (j = 0; --i >= 0; j++) {
649 int indent = 2 * j + 4;
652 if (jump && menu == location) {
653 jump->offset = strlen(r->s);
654 jk = get_jump_key_char();
658 str_printf(r, "(%c)", jk);
662 str_printf(r, "%*c-> %s", indent, ' ', menu_get_prompt(menu));
664 str_printf(r, " (%s [=%s])", menu->sym->name ?
665 menu->sym->name : "<choice>",
666 sym_get_string_value(menu->sym));
672 static void get_symbol_props_str(struct gstr *r, struct symbol *sym,
673 enum prop_type tok, const char *prefix)
676 struct property *prop;
678 for_all_properties(sym, prop, tok) {
680 str_append(r, prefix);
683 str_printf(r, " && ");
684 expr_gstr_print(prop->expr, r);
691 * head is optional and may be NULL
693 static void get_symbol_str(struct gstr *r, struct symbol *sym,
694 struct list_head *head)
696 struct property *prop;
699 if (sym && sym->name) {
700 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
701 sym_get_string_value(sym));
702 str_printf(r, "Type : %s\n", sym_type_name(sym->type));
703 if (sym->type == S_INT || sym->type == S_HEX) {
704 prop = sym_get_range_prop(sym);
706 str_printf(r, "Range : ");
707 expr_gstr_print(prop->expr, r);
713 /* Print the definitions with prompts before the ones without */
714 list_for_each_entry(menu, &sym->menus, link) {
716 get_def_str(r, menu);
717 get_prompt_str(r, menu->prompt, head);
721 list_for_each_entry(menu, &sym->menus, link) {
723 get_def_str(r, menu);
724 get_dep_str(r, menu->dep, " Depends on: ");
728 get_symbol_props_str(r, sym, P_SELECT, "Selects: ");
729 if (sym->rev_dep.expr) {
730 expr_gstr_print_revdep(sym->rev_dep.expr, r, yes, "Selected by [y]:\n");
731 expr_gstr_print_revdep(sym->rev_dep.expr, r, mod, "Selected by [m]:\n");
732 expr_gstr_print_revdep(sym->rev_dep.expr, r, no, "Selected by [n]:\n");
735 get_symbol_props_str(r, sym, P_IMPLY, "Implies: ");
736 if (sym->implied.expr) {
737 expr_gstr_print_revdep(sym->implied.expr, r, yes, "Implied by [y]:\n");
738 expr_gstr_print_revdep(sym->implied.expr, r, mod, "Implied by [m]:\n");
739 expr_gstr_print_revdep(sym->implied.expr, r, no, "Implied by [n]:\n");
742 str_append(r, "\n\n");
745 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
748 struct gstr res = str_new();
751 for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
752 get_symbol_str(&res, sym, head);
754 str_append(&res, "No matches found.\n");
759 void menu_get_ext_help(struct menu *menu, struct gstr *help)
761 struct symbol *sym = menu->sym;
762 const char *help_text = nohelp_text;
766 str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
767 help_text = menu->help;
769 str_printf(help, "%s\n", help_text);
771 get_symbol_str(help, sym, NULL);