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, struct expr *expr,
130 struct property *prop = prop_alloc(type, current_entry->sym);
132 prop->menu = current_entry;
134 prop->visible.expr = dep;
139 struct property *menu_add_prompt(enum prop_type type, char *prompt,
142 struct property *prop = menu_add_prop(type, NULL, dep);
144 if (isspace(*prompt)) {
145 prop_warn(prop, "leading whitespace ignored");
146 while (isspace(*prompt))
149 if (current_entry->prompt)
150 prop_warn(prop, "prompt redefined");
152 /* Apply all upper menus' visibilities to actual prompts. */
153 if (type == P_PROMPT) {
154 struct menu *menu = current_entry;
156 while ((menu = menu->parent) != NULL) {
157 struct expr *dup_expr;
159 if (!menu->visibility)
162 * Do not add a reference to the menu's visibility
163 * expression but use a copy of it. Otherwise the
164 * expression reduction functions will modify
165 * expressions that have multiple references which
166 * can cause unwanted side effects.
168 dup_expr = expr_copy(menu->visibility);
170 prop->visible.expr = expr_alloc_and(prop->visible.expr,
175 current_entry->prompt = prop;
181 void menu_add_visibility(struct expr *expr)
183 current_entry->visibility = expr_alloc_and(current_entry->visibility,
187 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
189 menu_add_prop(type, expr, dep);
192 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
194 menu_add_prop(type, expr_alloc_symbol(sym), dep);
197 void menu_add_option_modules(void)
200 zconf_error("symbol '%s' redefines option 'modules' already defined by symbol '%s'",
201 current_entry->sym->name, modules_sym->name);
202 modules_sym = current_entry->sym;
205 void menu_add_option_defconfig_list(void)
207 if (!sym_defconfig_list)
208 sym_defconfig_list = current_entry->sym;
209 else if (sym_defconfig_list != current_entry->sym)
210 zconf_error("trying to redefine defconfig symbol");
211 sym_defconfig_list->flags |= SYMBOL_NO_WRITE;
214 void menu_add_option_allnoconfig_y(void)
216 current_entry->sym->flags |= SYMBOL_ALLNOCONFIG_Y;
219 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
221 return sym2->type == S_INT || sym2->type == S_HEX ||
222 (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
225 static void sym_check_prop(struct symbol *sym)
227 struct property *prop;
231 for (prop = sym->prop; prop; prop = prop->next) {
232 switch (prop->type) {
234 if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
235 prop->expr->type != E_SYMBOL)
237 "default for config symbol '%s'"
238 " must be a single symbol", sym->name);
239 if (prop->expr->type != E_SYMBOL)
241 sym2 = prop_get_symbol(prop);
242 if (sym->type == S_HEX || sym->type == S_INT) {
243 if (!menu_validate_number(sym, sym2))
245 "'%s': number is invalid",
248 if (sym_is_choice(sym)) {
249 struct property *choice_prop =
250 sym_get_choice_prop(sym2);
253 prop_get_symbol(choice_prop) != sym)
255 "choice default symbol '%s' is not contained in the choice",
261 use = prop->type == P_SELECT ? "select" : "imply";
262 sym2 = prop_get_symbol(prop);
263 if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
265 "config symbol '%s' uses %s, but is "
266 "not bool or tristate", sym->name, use);
267 else if (sym2->type != S_UNKNOWN &&
268 sym2->type != S_BOOLEAN &&
269 sym2->type != S_TRISTATE)
271 "'%s' has wrong type. '%s' only "
272 "accept arguments of bool and "
273 "tristate type", sym2->name, use);
276 if (sym->type != S_INT && sym->type != S_HEX)
277 prop_warn(prop, "range is only allowed "
278 "for int or hex symbols");
279 if (!menu_validate_number(sym, prop->expr->left.sym) ||
280 !menu_validate_number(sym, prop->expr->right.sym))
281 prop_warn(prop, "range is invalid");
289 void menu_finalize(struct menu *parent)
291 struct menu *menu, *last_menu;
293 struct property *prop;
294 struct expr *parentdep, *basedep, *dep, *dep2, **ep;
299 * This menu node has children. We (recursively) process them
300 * and propagate parent dependencies before moving on.
303 if (sym && sym_is_choice(sym)) {
304 if (sym->type == S_UNKNOWN) {
305 /* find the first choice value to find out choice type */
306 current_entry = parent;
307 for (menu = parent->list; menu; menu = menu->next) {
308 if (menu->sym && menu->sym->type != S_UNKNOWN) {
309 menu_set_type(menu->sym->type);
314 /* set the type of the remaining choice values */
315 for (menu = parent->list; menu; menu = menu->next) {
316 current_entry = menu;
317 if (menu->sym && menu->sym->type == S_UNKNOWN)
318 menu_set_type(sym->type);
322 * Use the choice itself as the parent dependency of
323 * the contained items. This turns the mode of the
324 * choice into an upper bound on the visibility of the
325 * choice value symbols.
327 parentdep = expr_alloc_symbol(sym);
329 /* Menu node for 'menu', 'if' */
330 parentdep = parent->dep;
333 /* For each child menu node... */
334 for (menu = parent->list; menu; menu = menu->next) {
336 * Propagate parent dependencies to the child menu
337 * node, also rewriting and simplifying expressions
339 basedep = rewrite_m(menu->dep);
340 basedep = expr_transform(basedep);
341 basedep = expr_alloc_and(expr_copy(parentdep), basedep);
342 basedep = expr_eliminate_dups(basedep);
347 * Note: For symbols, all prompts are included
348 * too in the symbol's own property list
350 prop = menu->sym->prop;
353 * For non-symbol menu nodes, we just need to
358 /* For each property... */
359 for (; prop; prop = prop->next) {
360 if (prop->menu != menu)
364 * 1. The property lacks dependencies
365 * and so isn't location-specific,
368 * 2. The property belongs to a symbol
369 * defined in multiple locations and
370 * is from some other location. It
371 * will be handled there in that
379 * Propagate parent dependencies to the
380 * property's condition, rewriting and
381 * simplifying expressions at the same time
383 dep = rewrite_m(prop->visible.expr);
384 dep = expr_transform(dep);
385 dep = expr_alloc_and(expr_copy(basedep), dep);
386 dep = expr_eliminate_dups(dep);
387 if (menu->sym && menu->sym->type != S_TRISTATE)
388 dep = expr_trans_bool(dep);
389 prop->visible.expr = dep;
392 * Handle selects and implies, which modify the
393 * dependencies of the selected/implied symbol
395 if (prop->type == P_SELECT) {
396 struct symbol *es = prop_get_symbol(prop);
397 es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
398 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
399 } else if (prop->type == P_IMPLY) {
400 struct symbol *es = prop_get_symbol(prop);
401 es->implied.expr = expr_alloc_or(es->implied.expr,
402 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
407 if (sym && sym_is_choice(sym))
408 expr_free(parentdep);
411 * Recursively process children in the same fashion before
414 for (menu = parent->list; menu; menu = menu->next)
418 * Automatic submenu creation. If sym is a symbol and A, B, C,
419 * ... are consecutive items (symbols, menus, ifs, etc.) that
420 * all depend on sym, then the following menu structure is
429 * This also works recursively, giving the following structure
430 * if A is a symbol and B depends on A:
439 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
440 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
441 basedep = expr_eliminate_dups(expr_transform(basedep));
443 /* Examine consecutive elements after sym */
445 for (menu = parent->next; menu; menu = menu->next) {
446 dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
447 if (!expr_contains_symbol(dep, sym))
448 /* No dependency, quit */
450 if (expr_depends_symbol(dep, sym))
451 /* Absolute dependency, put in submenu */
455 * Also consider it a dependency on sym if our
456 * dependencies contain sym and are a "superset" of
457 * sym's dependencies, e.g. '(sym || Q) && R' when sym
460 * Note that 'R' might be from an enclosing menu or if,
461 * making this a more common case than it might seem.
463 dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
464 dep = expr_eliminate_dups(expr_transform(dep));
465 dep2 = expr_copy(basedep);
466 expr_eliminate_eq(&dep, &dep2);
468 if (!expr_is_yes(dep2)) {
469 /* Not superset, quit */
473 /* Superset, put in submenu */
477 menu->parent = parent;
482 parent->list = parent->next;
483 parent->next = last_menu->next;
484 last_menu->next = NULL;
487 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
489 for (menu = parent->list; menu; menu = menu->next) {
490 if (sym && sym_is_choice(sym) &&
491 menu->sym && !sym_is_choice_value(menu->sym)) {
492 current_entry = menu;
493 menu->sym->flags |= SYMBOL_CHOICEVAL;
495 menu_warn(menu, "choice value must have a prompt");
496 for (prop = menu->sym->prop; prop; prop = prop->next) {
497 if (prop->type == P_DEFAULT)
498 prop_warn(prop, "defaults for choice "
499 "values not supported");
500 if (prop->menu == menu)
502 if (prop->type == P_PROMPT &&
503 prop->menu->parent->sym != sym)
504 prop_warn(prop, "choice value used outside its choice group");
506 /* Non-tristate choice values of tristate choices must
507 * depend on the choice being set to Y. The choice
508 * values' dependencies were propagated to their
509 * properties above, so the change here must be re-
512 if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
513 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
514 menu->dep = expr_alloc_and(basedep, menu->dep);
515 for (prop = menu->sym->prop; prop; prop = prop->next) {
516 if (prop->menu != menu)
518 prop->visible.expr = expr_alloc_and(expr_copy(basedep),
522 menu_add_symbol(P_CHOICE, sym, NULL);
523 prop = sym_get_choice_prop(sym);
524 for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
526 *ep = expr_alloc_one(E_LIST, NULL);
527 (*ep)->right.sym = menu->sym;
531 * This code serves two purposes:
533 * (1) Flattening 'if' blocks, which do not specify a submenu
534 * and only add dependencies.
536 * (Automatic submenu creation might still create a submenu
537 * from an 'if' before this code runs.)
539 * (2) "Undoing" any automatic submenus created earlier below
540 * promptless symbols.
545 * if ... (or promptless symbol)
553 * if ... (or promptless symbol)
558 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
559 for (last_menu = menu->list; ; last_menu = last_menu->next) {
560 last_menu->parent = parent;
561 if (!last_menu->next)
564 last_menu->next = menu->next;
565 menu->next = menu->list;
570 if (sym && !(sym->flags & SYMBOL_WARNED)) {
571 if (sym->type == S_UNKNOWN)
572 menu_warn(parent, "config symbol defined without type");
574 if (sym_is_choice(sym) && !parent->prompt)
575 menu_warn(parent, "choice must have a prompt");
577 /* Check properties connected to this symbol */
579 sym->flags |= SYMBOL_WARNED;
583 * For non-optional choices, add a reverse dependency (corresponding to
584 * a select) of '<visibility> && m'. This prevents the user from
585 * setting the choice mode to 'n' when the choice is visible.
587 * This would also work for non-choice symbols, but only non-optional
588 * choices clear SYMBOL_OPTIONAL as of writing. Choices are implemented
589 * as a type of symbol.
591 if (sym && !sym_is_optional(sym) && parent->prompt) {
592 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
593 expr_alloc_and(parent->prompt->visible.expr,
594 expr_alloc_symbol(&symbol_mod)));
598 bool menu_has_prompt(struct menu *menu)
606 * Determine if a menu is empty.
607 * A menu is considered empty if it contains no or only
610 bool menu_is_empty(struct menu *menu)
614 for (child = menu->list; child; child = child->next) {
615 if (menu_is_visible(child))
621 bool menu_is_visible(struct menu *menu)
630 if (menu->visibility) {
631 if (expr_calc_value(menu->visibility) == no)
638 visible = menu->prompt->visible.tri;
640 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
645 if (!sym || sym_get_tristate_value(menu->sym) == no)
648 for (child = menu->list; child; child = child->next) {
649 if (menu_is_visible(child)) {
651 sym->flags |= SYMBOL_DEF_USER;
659 const char *menu_get_prompt(struct menu *menu)
662 return menu->prompt->text;
664 return menu->sym->name;
668 struct menu *menu_get_root_menu(struct menu *menu)
673 struct menu *menu_get_parent_menu(struct menu *menu)
677 for (; menu != &rootmenu; menu = menu->parent) {
678 type = menu->prompt ? menu->prompt->type : 0;
685 bool menu_has_help(struct menu *menu)
687 return menu->help != NULL;
690 const char *menu_get_help(struct menu *menu)
698 static void get_prompt_str(struct gstr *r, struct property *prop,
699 struct list_head *head)
702 struct menu *submenu[8], *menu, *location = NULL;
703 struct jump_key *jump = NULL;
705 str_printf(r, "Prompt: %s\n", prop->text);
706 menu = prop->menu->parent;
707 for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
708 bool accessible = menu_is_visible(menu);
711 if (location == NULL && accessible)
714 if (head && location) {
715 jump = xmalloc(sizeof(struct jump_key));
717 if (menu_is_visible(prop->menu)) {
719 * There is not enough room to put the hint at the
720 * beginning of the "Prompt" line. Put the hint on the
721 * last "Location" line even when it would belong on
724 jump->target = prop->menu;
726 jump->target = location;
728 if (list_empty(head))
731 jump->index = list_entry(head->prev, struct jump_key,
734 list_add_tail(&jump->entries, head);
738 str_printf(r, " Location:\n");
739 for (j = 4; --i >= 0; j += 2) {
741 if (jump && menu == location)
742 jump->offset = strlen(r->s);
743 str_printf(r, "%*c-> %s", j, ' ',
744 menu_get_prompt(menu));
746 str_printf(r, " (%s [=%s])", menu->sym->name ?
747 menu->sym->name : "<choice>",
748 sym_get_string_value(menu->sym));
756 * get property of type P_SYMBOL
758 static struct property *get_symbol_prop(struct symbol *sym)
760 struct property *prop = NULL;
762 for_all_properties(sym, prop, P_SYMBOL)
767 static void get_symbol_props_str(struct gstr *r, struct symbol *sym,
768 enum prop_type tok, const char *prefix)
771 struct property *prop;
773 for_all_properties(sym, prop, tok) {
775 str_append(r, prefix);
778 str_printf(r, " && ");
779 expr_gstr_print(prop->expr, r);
786 * head is optional and may be NULL
788 static void get_symbol_str(struct gstr *r, struct symbol *sym,
789 struct list_head *head)
791 struct property *prop;
793 if (sym && sym->name) {
794 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
795 sym_get_string_value(sym));
796 str_printf(r, "Type : %s\n", sym_type_name(sym->type));
797 if (sym->type == S_INT || sym->type == S_HEX) {
798 prop = sym_get_range_prop(sym);
800 str_printf(r, "Range : ");
801 expr_gstr_print(prop->expr, r);
806 for_all_prompts(sym, prop)
807 get_prompt_str(r, prop, head);
809 prop = get_symbol_prop(sym);
811 str_printf(r, " Defined at %s:%d\n", prop->menu->file->name,
813 if (!expr_is_yes(prop->visible.expr)) {
814 str_append(r, " Depends on: ");
815 expr_gstr_print(prop->visible.expr, r);
820 get_symbol_props_str(r, sym, P_SELECT, " Selects: ");
821 if (sym->rev_dep.expr) {
822 expr_gstr_print_revdep(sym->rev_dep.expr, r, yes, " Selected by [y]:\n");
823 expr_gstr_print_revdep(sym->rev_dep.expr, r, mod, " Selected by [m]:\n");
824 expr_gstr_print_revdep(sym->rev_dep.expr, r, no, " Selected by [n]:\n");
827 get_symbol_props_str(r, sym, P_IMPLY, " Implies: ");
828 if (sym->implied.expr) {
829 expr_gstr_print_revdep(sym->implied.expr, r, yes, " Implied by [y]:\n");
830 expr_gstr_print_revdep(sym->implied.expr, r, mod, " Implied by [m]:\n");
831 expr_gstr_print_revdep(sym->implied.expr, r, no, " Implied by [n]:\n");
834 str_append(r, "\n\n");
837 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
840 struct gstr res = str_new();
843 for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
844 get_symbol_str(&res, sym, head);
846 str_append(&res, "No matches found.\n");
851 void menu_get_ext_help(struct menu *menu, struct gstr *help)
853 struct symbol *sym = menu->sym;
854 const char *help_text = nohelp_text;
856 if (menu_has_help(menu)) {
858 str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
859 help_text = menu_get_help(menu);
861 str_printf(help, "%s\n", help_text);
863 get_symbol_str(help, sym, NULL);