1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
13 static const char nohelp_text[] = "There is no help available for this option.";
16 static struct menu **last_entry_ptr;
18 struct file *file_list;
19 struct file *current_file;
21 void menu_warn(struct menu *menu, const char *fmt, ...)
25 fprintf(stderr, "%s:%d:warning: ", menu->file->name, menu->lineno);
26 vfprintf(stderr, fmt, ap);
27 fprintf(stderr, "\n");
31 static void prop_warn(struct property *prop, const char *fmt, ...)
35 fprintf(stderr, "%s:%d:warning: ", prop->file->name, prop->lineno);
36 vfprintf(stderr, fmt, ap);
37 fprintf(stderr, "\n");
43 current_entry = current_menu = &rootmenu;
44 last_entry_ptr = &rootmenu.list;
47 void menu_add_entry(struct symbol *sym)
51 menu = xmalloc(sizeof(*menu));
52 memset(menu, 0, sizeof(*menu));
54 menu->parent = current_menu;
55 menu->file = current_file;
56 menu->lineno = zconf_lineno();
58 *last_entry_ptr = menu;
59 last_entry_ptr = &menu->next;
62 menu_add_symbol(P_SYMBOL, sym, NULL);
65 struct menu *menu_add_menu(void)
67 last_entry_ptr = ¤t_entry->list;
68 return current_menu = current_entry;
71 void menu_end_menu(void)
73 last_entry_ptr = ¤t_menu->next;
74 current_menu = current_menu->parent;
78 * Rewrites 'm' to 'm' && MODULES, so that it evaluates to 'n' when running
81 static struct expr *rewrite_m(struct expr *e)
88 e->left.expr = rewrite_m(e->left.expr);
92 e->left.expr = rewrite_m(e->left.expr);
93 e->right.expr = rewrite_m(e->right.expr);
96 /* change 'm' into 'm' && MODULES */
97 if (e->left.sym == &symbol_mod)
98 return expr_alloc_and(e, expr_alloc_symbol(modules_sym));
106 void menu_add_dep(struct expr *dep)
108 current_entry->dep = expr_alloc_and(current_entry->dep, dep);
111 void menu_set_type(int type)
113 struct symbol *sym = current_entry->sym;
115 if (sym->type == type)
117 if (sym->type == S_UNKNOWN) {
121 menu_warn(current_entry,
122 "ignoring type redefinition of '%s' from '%s' to '%s'",
123 sym->name ? sym->name : "<choice>",
124 sym_type_name(sym->type), sym_type_name(type));
127 static struct property *menu_add_prop(enum prop_type type, char *prompt, struct expr *expr, struct expr *dep)
129 struct property *prop = prop_alloc(type, current_entry->sym);
131 prop->menu = current_entry;
133 prop->visible.expr = dep;
136 if (isspace(*prompt)) {
137 prop_warn(prop, "leading whitespace ignored");
138 while (isspace(*prompt))
141 if (current_entry->prompt)
142 prop_warn(prop, "prompt redefined");
144 /* Apply all upper menus' visibilities to actual prompts. */
145 if(type == P_PROMPT) {
146 struct menu *menu = current_entry;
148 while ((menu = menu->parent) != NULL) {
149 struct expr *dup_expr;
151 if (!menu->visibility)
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.
162 dup_expr = expr_copy(menu->visibility);
165 = expr_alloc_and(prop->visible.expr,
170 current_entry->prompt = prop;
177 struct property *menu_add_prompt(enum prop_type type, char *prompt, struct expr *dep)
179 return menu_add_prop(type, prompt, NULL, dep);
182 void menu_add_visibility(struct expr *expr)
184 current_entry->visibility = expr_alloc_and(current_entry->visibility,
188 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
190 menu_add_prop(type, NULL, expr, dep);
193 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
195 menu_add_prop(type, NULL, expr_alloc_symbol(sym), dep);
198 void menu_add_option_modules(void)
201 zconf_error("symbol '%s' redefines option 'modules' already defined by symbol '%s'",
202 current_entry->sym->name, modules_sym->name);
203 modules_sym = current_entry->sym;
206 void menu_add_option_defconfig_list(void)
208 if (!sym_defconfig_list)
209 sym_defconfig_list = current_entry->sym;
210 else if (sym_defconfig_list != current_entry->sym)
211 zconf_error("trying to redefine defconfig symbol");
212 sym_defconfig_list->flags |= SYMBOL_NO_WRITE;
215 void menu_add_option_allnoconfig_y(void)
217 current_entry->sym->flags |= SYMBOL_ALLNOCONFIG_Y;
220 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
222 return sym2->type == S_INT || sym2->type == S_HEX ||
223 (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
226 static void sym_check_prop(struct symbol *sym)
228 struct property *prop;
232 for (prop = sym->prop; prop; prop = prop->next) {
233 switch (prop->type) {
235 if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
236 prop->expr->type != E_SYMBOL)
238 "default for config symbol '%s'"
239 " must be a single symbol", sym->name);
240 if (prop->expr->type != E_SYMBOL)
242 sym2 = prop_get_symbol(prop);
243 if (sym->type == S_HEX || sym->type == S_INT) {
244 if (!menu_validate_number(sym, sym2))
246 "'%s': number is invalid",
249 if (sym_is_choice(sym)) {
250 struct property *choice_prop =
251 sym_get_choice_prop(sym2);
254 prop_get_symbol(choice_prop) != sym)
256 "choice default symbol '%s' is not contained in the choice",
262 use = prop->type == P_SELECT ? "select" : "imply";
263 sym2 = prop_get_symbol(prop);
264 if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
266 "config symbol '%s' uses %s, but is "
267 "not bool or tristate", sym->name, use);
268 else if (sym2->type != S_UNKNOWN &&
269 sym2->type != S_BOOLEAN &&
270 sym2->type != S_TRISTATE)
272 "'%s' has wrong type. '%s' only "
273 "accept arguments of bool and "
274 "tristate type", sym2->name, use);
277 if (sym->type != S_INT && sym->type != S_HEX)
278 prop_warn(prop, "range is only allowed "
279 "for int or hex symbols");
280 if (!menu_validate_number(sym, prop->expr->left.sym) ||
281 !menu_validate_number(sym, prop->expr->right.sym))
282 prop_warn(prop, "range is invalid");
290 void menu_finalize(struct menu *parent)
292 struct menu *menu, *last_menu;
294 struct property *prop;
295 struct expr *parentdep, *basedep, *dep, *dep2, **ep;
300 * This menu node has children. We (recursively) process them
301 * and propagate parent dependencies before moving on.
304 if (sym && sym_is_choice(sym)) {
305 if (sym->type == S_UNKNOWN) {
306 /* find the first choice value to find out choice type */
307 current_entry = parent;
308 for (menu = parent->list; menu; menu = menu->next) {
309 if (menu->sym && menu->sym->type != S_UNKNOWN) {
310 menu_set_type(menu->sym->type);
315 /* set the type of the remaining choice values */
316 for (menu = parent->list; menu; menu = menu->next) {
317 current_entry = menu;
318 if (menu->sym && menu->sym->type == S_UNKNOWN)
319 menu_set_type(sym->type);
323 * Use the choice itself as the parent dependency of
324 * the contained items. This turns the mode of the
325 * choice into an upper bound on the visibility of the
326 * choice value symbols.
328 parentdep = expr_alloc_symbol(sym);
330 /* Menu node for 'menu', 'if' */
331 parentdep = parent->dep;
334 /* For each child menu node... */
335 for (menu = parent->list; menu; menu = menu->next) {
337 * Propagate parent dependencies to the child menu
338 * node, also rewriting and simplifying expressions
340 basedep = rewrite_m(menu->dep);
341 basedep = expr_transform(basedep);
342 basedep = expr_alloc_and(expr_copy(parentdep), basedep);
343 basedep = expr_eliminate_dups(basedep);
348 * Note: For symbols, all prompts are included
349 * too in the symbol's own property list
351 prop = menu->sym->prop;
354 * For non-symbol menu nodes, we just need to
359 /* For each property... */
360 for (; prop; prop = prop->next) {
361 if (prop->menu != menu)
365 * 1. The property lacks dependencies
366 * and so isn't location-specific,
369 * 2. The property belongs to a symbol
370 * defined in multiple locations and
371 * is from some other location. It
372 * will be handled there in that
380 * Propagate parent dependencies to the
381 * property's condition, rewriting and
382 * simplifying expressions at the same time
384 dep = rewrite_m(prop->visible.expr);
385 dep = expr_transform(dep);
386 dep = expr_alloc_and(expr_copy(basedep), dep);
387 dep = expr_eliminate_dups(dep);
388 if (menu->sym && menu->sym->type != S_TRISTATE)
389 dep = expr_trans_bool(dep);
390 prop->visible.expr = dep;
393 * Handle selects and implies, which modify the
394 * dependencies of the selected/implied symbol
396 if (prop->type == P_SELECT) {
397 struct symbol *es = prop_get_symbol(prop);
398 es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
399 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
400 } else if (prop->type == P_IMPLY) {
401 struct symbol *es = prop_get_symbol(prop);
402 es->implied.expr = expr_alloc_or(es->implied.expr,
403 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
408 if (sym && sym_is_choice(sym))
409 expr_free(parentdep);
412 * Recursively process children in the same fashion before
415 for (menu = parent->list; menu; menu = menu->next)
419 * Automatic submenu creation. If sym is a symbol and A, B, C,
420 * ... are consecutive items (symbols, menus, ifs, etc.) that
421 * all depend on sym, then the following menu structure is
430 * This also works recursively, giving the following structure
431 * if A is a symbol and B depends on A:
440 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
441 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
442 basedep = expr_eliminate_dups(expr_transform(basedep));
444 /* Examine consecutive elements after sym */
446 for (menu = parent->next; menu; menu = menu->next) {
447 dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
448 if (!expr_contains_symbol(dep, sym))
449 /* No dependency, quit */
451 if (expr_depends_symbol(dep, sym))
452 /* Absolute dependency, put in submenu */
456 * Also consider it a dependency on sym if our
457 * dependencies contain sym and are a "superset" of
458 * sym's dependencies, e.g. '(sym || Q) && R' when sym
461 * Note that 'R' might be from an enclosing menu or if,
462 * making this a more common case than it might seem.
464 dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
465 dep = expr_eliminate_dups(expr_transform(dep));
466 dep2 = expr_copy(basedep);
467 expr_eliminate_eq(&dep, &dep2);
469 if (!expr_is_yes(dep2)) {
470 /* Not superset, quit */
474 /* Superset, put in submenu */
478 menu->parent = parent;
483 parent->list = parent->next;
484 parent->next = last_menu->next;
485 last_menu->next = NULL;
488 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
490 for (menu = parent->list; menu; menu = menu->next) {
491 if (sym && sym_is_choice(sym) &&
492 menu->sym && !sym_is_choice_value(menu->sym)) {
493 current_entry = menu;
494 menu->sym->flags |= SYMBOL_CHOICEVAL;
496 menu_warn(menu, "choice value must have a prompt");
497 for (prop = menu->sym->prop; prop; prop = prop->next) {
498 if (prop->type == P_DEFAULT)
499 prop_warn(prop, "defaults for choice "
500 "values not supported");
501 if (prop->menu == menu)
503 if (prop->type == P_PROMPT &&
504 prop->menu->parent->sym != sym)
505 prop_warn(prop, "choice value used outside its choice group");
507 /* Non-tristate choice values of tristate choices must
508 * depend on the choice being set to Y. The choice
509 * values' dependencies were propagated to their
510 * properties above, so the change here must be re-
513 if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
514 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
515 menu->dep = expr_alloc_and(basedep, menu->dep);
516 for (prop = menu->sym->prop; prop; prop = prop->next) {
517 if (prop->menu != menu)
519 prop->visible.expr = expr_alloc_and(expr_copy(basedep),
523 menu_add_symbol(P_CHOICE, sym, NULL);
524 prop = sym_get_choice_prop(sym);
525 for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
527 *ep = expr_alloc_one(E_LIST, NULL);
528 (*ep)->right.sym = menu->sym;
532 * This code serves two purposes:
534 * (1) Flattening 'if' blocks, which do not specify a submenu
535 * and only add dependencies.
537 * (Automatic submenu creation might still create a submenu
538 * from an 'if' before this code runs.)
540 * (2) "Undoing" any automatic submenus created earlier below
541 * promptless symbols.
546 * if ... (or promptless symbol)
554 * if ... (or promptless symbol)
559 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
560 for (last_menu = menu->list; ; last_menu = last_menu->next) {
561 last_menu->parent = parent;
562 if (!last_menu->next)
565 last_menu->next = menu->next;
566 menu->next = menu->list;
571 if (sym && !(sym->flags & SYMBOL_WARNED)) {
572 if (sym->type == S_UNKNOWN)
573 menu_warn(parent, "config symbol defined without type");
575 if (sym_is_choice(sym) && !parent->prompt)
576 menu_warn(parent, "choice must have a prompt");
578 /* Check properties connected to this symbol */
580 sym->flags |= SYMBOL_WARNED;
584 * For non-optional choices, add a reverse dependency (corresponding to
585 * a select) of '<visibility> && m'. This prevents the user from
586 * setting the choice mode to 'n' when the choice is visible.
588 * This would also work for non-choice symbols, but only non-optional
589 * choices clear SYMBOL_OPTIONAL as of writing. Choices are implemented
590 * as a type of symbol.
592 if (sym && !sym_is_optional(sym) && parent->prompt) {
593 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
594 expr_alloc_and(parent->prompt->visible.expr,
595 expr_alloc_symbol(&symbol_mod)));
599 bool menu_has_prompt(struct menu *menu)
607 * Determine if a menu is empty.
608 * A menu is considered empty if it contains no or only
611 bool menu_is_empty(struct menu *menu)
615 for (child = menu->list; child; child = child->next) {
616 if (menu_is_visible(child))
622 bool menu_is_visible(struct menu *menu)
631 if (menu->visibility) {
632 if (expr_calc_value(menu->visibility) == no)
639 visible = menu->prompt->visible.tri;
641 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
646 if (!sym || sym_get_tristate_value(menu->sym) == no)
649 for (child = menu->list; child; child = child->next) {
650 if (menu_is_visible(child)) {
652 sym->flags |= SYMBOL_DEF_USER;
660 const char *menu_get_prompt(struct menu *menu)
663 return menu->prompt->text;
665 return menu->sym->name;
669 struct menu *menu_get_root_menu(struct menu *menu)
674 struct menu *menu_get_parent_menu(struct menu *menu)
678 for (; menu != &rootmenu; menu = menu->parent) {
679 type = menu->prompt ? menu->prompt->type : 0;
686 bool menu_has_help(struct menu *menu)
688 return menu->help != NULL;
691 const char *menu_get_help(struct menu *menu)
699 static void get_prompt_str(struct gstr *r, struct property *prop,
700 struct list_head *head)
703 struct menu *submenu[8], *menu, *location = NULL;
704 struct jump_key *jump = NULL;
706 str_printf(r, "Prompt: %s\n", prop->text);
707 menu = prop->menu->parent;
708 for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
709 bool accessible = menu_is_visible(menu);
712 if (location == NULL && accessible)
715 if (head && location) {
716 jump = xmalloc(sizeof(struct jump_key));
718 if (menu_is_visible(prop->menu)) {
720 * There is not enough room to put the hint at the
721 * beginning of the "Prompt" line. Put the hint on the
722 * last "Location" line even when it would belong on
725 jump->target = prop->menu;
727 jump->target = location;
729 if (list_empty(head))
732 jump->index = list_entry(head->prev, struct jump_key,
735 list_add_tail(&jump->entries, head);
739 str_printf(r, " Location:\n");
740 for (j = 4; --i >= 0; j += 2) {
742 if (jump && menu == location)
743 jump->offset = strlen(r->s);
744 str_printf(r, "%*c-> %s", j, ' ',
745 menu_get_prompt(menu));
747 str_printf(r, " (%s [=%s])", menu->sym->name ?
748 menu->sym->name : "<choice>",
749 sym_get_string_value(menu->sym));
757 * get property of type P_SYMBOL
759 static struct property *get_symbol_prop(struct symbol *sym)
761 struct property *prop = NULL;
763 for_all_properties(sym, prop, P_SYMBOL)
768 static void get_symbol_props_str(struct gstr *r, struct symbol *sym,
769 enum prop_type tok, const char *prefix)
772 struct property *prop;
774 for_all_properties(sym, prop, tok) {
776 str_append(r, prefix);
779 str_printf(r, " && ");
780 expr_gstr_print(prop->expr, r);
787 * head is optional and may be NULL
789 static void get_symbol_str(struct gstr *r, struct symbol *sym,
790 struct list_head *head)
792 struct property *prop;
794 if (sym && sym->name) {
795 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
796 sym_get_string_value(sym));
797 str_printf(r, "Type : %s\n", sym_type_name(sym->type));
798 if (sym->type == S_INT || sym->type == S_HEX) {
799 prop = sym_get_range_prop(sym);
801 str_printf(r, "Range : ");
802 expr_gstr_print(prop->expr, r);
807 for_all_prompts(sym, prop)
808 get_prompt_str(r, prop, head);
810 prop = get_symbol_prop(sym);
812 str_printf(r, " Defined at %s:%d\n", prop->menu->file->name,
814 if (!expr_is_yes(prop->visible.expr)) {
815 str_append(r, " Depends on: ");
816 expr_gstr_print(prop->visible.expr, r);
821 get_symbol_props_str(r, sym, P_SELECT, " Selects: ");
822 if (sym->rev_dep.expr) {
823 expr_gstr_print_revdep(sym->rev_dep.expr, r, yes, " Selected by [y]:\n");
824 expr_gstr_print_revdep(sym->rev_dep.expr, r, mod, " Selected by [m]:\n");
825 expr_gstr_print_revdep(sym->rev_dep.expr, r, no, " Selected by [n]:\n");
828 get_symbol_props_str(r, sym, P_IMPLY, " Implies: ");
829 if (sym->implied.expr) {
830 expr_gstr_print_revdep(sym->implied.expr, r, yes, " Implied by [y]:\n");
831 expr_gstr_print_revdep(sym->implied.expr, r, mod, " Implied by [m]:\n");
832 expr_gstr_print_revdep(sym->implied.expr, r, no, " Implied by [n]:\n");
835 str_append(r, "\n\n");
838 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
841 struct gstr res = str_new();
844 for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
845 get_symbol_str(&res, sym, head);
847 str_append(&res, "No matches found.\n");
852 void menu_get_ext_help(struct menu *menu, struct gstr *help)
854 struct symbol *sym = menu->sym;
855 const char *help_text = nohelp_text;
857 if (menu_has_help(menu)) {
859 str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
860 help_text = menu_get_help(menu);
862 str_printf(help, "%s\n", help_text);
864 get_symbol_str(help, sym, NULL);