1 // SPDX-License-Identifier: GPL-2.0
16 static const char nohelp_text[] = "There is no help available for this option.";
19 static struct menu **last_entry_ptr;
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.
28 struct menu *menu_next(struct menu *menu, struct menu *root)
33 while (menu != root && !menu->next)
42 void menu_warn(const struct menu *menu, const char *fmt, ...)
46 fprintf(stderr, "%s:%d:warning: ", menu->filename, menu->lineno);
47 vfprintf(stderr, fmt, ap);
48 fprintf(stderr, "\n");
52 static void prop_warn(const struct property *prop, const char *fmt, ...)
56 fprintf(stderr, "%s:%d:warning: ", prop->filename, prop->lineno);
57 vfprintf(stderr, fmt, ap);
58 fprintf(stderr, "\n");
64 current_entry = current_menu = &rootmenu;
65 last_entry_ptr = &rootmenu.list;
68 void menu_add_entry(struct symbol *sym)
72 menu = xmalloc(sizeof(*menu));
73 memset(menu, 0, sizeof(*menu));
75 menu->parent = current_menu;
76 menu->filename = cur_filename;
77 menu->lineno = cur_lineno;
79 *last_entry_ptr = menu;
80 last_entry_ptr = &menu->next;
83 list_add_tail(&menu->link, &sym->menus);
86 struct menu *menu_add_menu(void)
88 last_entry_ptr = ¤t_entry->list;
89 current_menu = current_entry;
93 void menu_end_menu(void)
95 last_entry_ptr = ¤t_menu->next;
96 current_menu = current_menu->parent;
100 * Rewrites 'm' to 'm' && MODULES, so that it evaluates to 'n' when running
103 static struct expr *rewrite_m(struct expr *e)
110 e = expr_alloc_one(E_NOT, rewrite_m(e->left.expr));
114 e = expr_alloc_two(e->type,
115 rewrite_m(e->left.expr),
116 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) {
197 if (!menu->visibility)
199 prop->visible.expr = expr_alloc_and(prop->visible.expr,
204 current_entry->prompt = prop;
210 void menu_add_visibility(struct expr *expr)
212 current_entry->visibility = expr_alloc_and(current_entry->visibility,
216 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
218 menu_add_prop(type, expr, dep);
221 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
223 menu_add_prop(type, expr_alloc_symbol(sym), dep);
226 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
228 return sym2->type == S_INT || sym2->type == S_HEX ||
229 (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
232 static void sym_check_prop(struct symbol *sym)
234 struct property *prop;
238 for (prop = sym->prop; prop; prop = prop->next) {
239 switch (prop->type) {
241 if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
242 prop->expr->type != E_SYMBOL)
244 "default for config symbol '%s'"
245 " must be a single symbol", sym->name);
246 if (prop->expr->type != E_SYMBOL)
248 sym2 = prop_get_symbol(prop);
249 if (sym->type == S_HEX || sym->type == S_INT) {
250 if (!menu_validate_number(sym, sym2))
252 "'%s': number is invalid",
255 if (sym_is_choice(sym)) {
256 struct menu *choice = sym_get_choice_menu(sym2);
258 if (!choice || choice->sym != sym)
260 "choice default symbol '%s' is not contained in the choice",
266 use = prop->type == P_SELECT ? "select" : "imply";
267 sym2 = prop_get_symbol(prop);
268 if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
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)
276 "'%s' has wrong type. '%s' only "
277 "accept arguments of bool and "
278 "tristate type", sym2->name, use);
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");
294 static void _menu_finalize(struct menu *parent, bool inside_choice)
296 struct menu *menu, *last_menu;
298 struct property *prop;
299 struct expr *basedep, *dep, *dep2;
304 * This menu node has children. We (recursively) process them
305 * and propagate parent dependencies before moving on.
308 /* For each child menu node... */
309 for (menu = parent->list; menu; menu = menu->next) {
311 * Propagate parent dependencies to the child menu
312 * node, also rewriting and simplifying expressions
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);
322 * Note: For symbols, all prompts are included
323 * too in the symbol's own property list
325 prop = menu->sym->prop;
328 * For non-symbol menu nodes, we just need to
333 /* For each property... */
334 for (; prop; prop = prop->next) {
335 if (prop->menu != menu)
339 * 1. The property lacks dependencies
340 * and so isn't location-specific,
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
354 * Propagate parent dependencies to the
355 * property's condition, rewriting and
356 * simplifying expressions at the same time
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;
365 * Handle selects and implies, which modify the
366 * dependencies of the selected/implied symbol
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));
381 * Recursively process children in the same fashion before
384 for (menu = parent->list; menu; menu = menu->next)
385 _menu_finalize(menu, sym && sym_is_choice(sym));
386 } else if (!inside_choice && sym) {
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
399 * This also works recursively, giving the following structure
400 * if A is a symbol and B depends on A:
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));
413 /* Examine consecutive elements after sym */
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 */
420 if (expr_depends_symbol(dep, sym))
421 /* Absolute dependency, put in submenu */
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
430 * Note that 'R' might be from an enclosing menu or if,
431 * making this a more common case than it might seem.
433 dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
434 dep = expr_eliminate_dups(expr_transform(dep));
436 expr_eliminate_eq(&dep, &dep2);
437 if (!expr_is_yes(dep2)) {
438 /* Not superset, quit */
441 /* Superset, put in submenu */
443 _menu_finalize(menu, false);
444 menu->parent = parent;
448 parent->list = parent->next;
449 parent->next = last_menu->next;
450 last_menu->next = NULL;
453 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
455 for (menu = parent->list; menu; menu = menu->next) {
457 * This code serves two purposes:
459 * (1) Flattening 'if' blocks, which do not specify a submenu
460 * and only add dependencies.
462 * (Automatic submenu creation might still create a submenu
463 * from an 'if' before this code runs.)
465 * (2) "Undoing" any automatic submenus created earlier below
466 * promptless symbols.
471 * if ... (or promptless symbol)
479 * if ... (or promptless symbol)
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)
490 last_menu->next = menu->next;
491 menu->next = menu->list;
496 if (sym && !(sym->flags & SYMBOL_WARNED)) {
497 if (sym->type == S_UNKNOWN)
498 menu_warn(parent, "config symbol defined without type");
500 /* Check properties connected to this symbol */
502 sym->flags |= SYMBOL_WARNED;
506 void menu_finalize(void)
508 _menu_finalize(&rootmenu, false);
511 bool menu_has_prompt(const struct menu *menu)
519 * Determine if a menu is empty.
520 * A menu is considered empty if it contains no or only
523 bool menu_is_empty(struct menu *menu)
527 for (child = menu->list; child; child = child->next) {
528 if (menu_is_visible(child))
534 bool menu_is_visible(struct menu *menu)
543 if (menu->visibility) {
544 if (expr_calc_value(menu->visibility) == no)
551 visible = menu->prompt->visible.tri;
553 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
558 if (!sym || sym_get_tristate_value(menu->sym) == no)
561 for (child = menu->list; child; child = child->next)
562 if (menu_is_visible(child))
568 const char *menu_get_prompt(const struct menu *menu)
571 return menu->prompt->text;
573 return menu->sym->name;
577 struct menu *menu_get_parent_menu(struct menu *menu)
581 for (; menu != &rootmenu; menu = menu->parent) {
582 type = menu->prompt ? menu->prompt->type : 0;
589 static void get_def_str(struct gstr *r, const struct menu *menu)
591 str_printf(r, "Defined at %s:%d\n",
592 menu->filename, menu->lineno);
595 static void get_dep_str(struct gstr *r, const struct expr *expr,
598 if (!expr_is_yes(expr)) {
599 str_append(r, prefix);
600 expr_gstr_print(expr, r);
605 int __attribute__((weak)) get_jump_key_char(void)
610 static void get_prompt_str(struct gstr *r, struct property *prop,
611 struct list_head *head)
614 struct menu *submenu[8], *menu, *location = NULL;
615 struct jump_key *jump = NULL;
617 str_printf(r, " Prompt: %s\n", prop->text);
619 get_dep_str(r, prop->menu->dep, " Depends on: ");
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
628 if (!expr_eq(prop->menu->dep, prop->visible.expr))
629 get_dep_str(r, prop->visible.expr, " Visible if: ");
632 for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
634 if (location == NULL && menu_is_visible(menu))
637 if (head && location) {
638 jump = xmalloc(sizeof(struct jump_key));
639 jump->target = location;
640 list_add_tail(&jump->entries, head);
643 str_printf(r, " Location:\n");
644 for (j = 0; --i >= 0; j++) {
646 int indent = 2 * j + 4;
649 if (jump && menu == location) {
650 jump->offset = strlen(r->s);
651 jk = get_jump_key_char();
655 str_printf(r, "(%c)", jk);
659 str_printf(r, "%*c-> %s", indent, ' ', menu_get_prompt(menu));
661 str_printf(r, " (%s [=%s])", menu->sym->name ?
662 menu->sym->name : "<choice>",
663 sym_get_string_value(menu->sym));
669 static void get_symbol_props_str(struct gstr *r, struct symbol *sym,
670 enum prop_type tok, const char *prefix)
673 struct property *prop;
675 for_all_properties(sym, prop, tok) {
677 str_append(r, prefix);
680 str_printf(r, " && ");
681 expr_gstr_print(prop->expr, r);
688 * head is optional and may be NULL
690 static void get_symbol_str(struct gstr *r, struct symbol *sym,
691 struct list_head *head)
693 struct property *prop;
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);
703 str_printf(r, "Range : ");
704 expr_gstr_print(prop->expr, r);
710 /* Print the definitions with prompts before the ones without */
711 list_for_each_entry(menu, &sym->menus, link) {
713 get_def_str(r, menu);
714 get_prompt_str(r, menu->prompt, head);
718 list_for_each_entry(menu, &sym->menus, link) {
720 get_def_str(r, menu);
721 get_dep_str(r, menu->dep, " Depends on: ");
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");
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");
739 str_append(r, "\n\n");
742 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
745 struct gstr res = str_new();
748 for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
749 get_symbol_str(&res, sym, head);
751 str_append(&res, "No matches found.\n");
756 void menu_get_ext_help(struct menu *menu, struct gstr *help)
758 struct symbol *sym = menu->sym;
759 const char *help_text = nohelp_text;
763 str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
764 help_text = menu->help;
766 str_printf(help, "%s\n", help_text);
768 get_symbol_str(help, sym, NULL);