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;
138 struct property *menu_add_prompt(enum prop_type type, char *prompt,
141 struct property *prop = menu_add_prop(type, prompt, NULL, dep);
143 if (isspace(*prompt)) {
144 prop_warn(prop, "leading whitespace ignored");
145 while (isspace(*prompt))
148 if (current_entry->prompt)
149 prop_warn(prop, "prompt redefined");
151 /* Apply all upper menus' visibilities to actual prompts. */
152 if (type == P_PROMPT) {
153 struct menu *menu = current_entry;
155 while ((menu = menu->parent) != NULL) {
156 struct expr *dup_expr;
158 if (!menu->visibility)
161 * Do not add a reference to the menu's visibility
162 * expression but use a copy of it. Otherwise the
163 * expression reduction functions will modify
164 * expressions that have multiple references which
165 * can cause unwanted side effects.
167 dup_expr = expr_copy(menu->visibility);
169 prop->visible.expr = expr_alloc_and(prop->visible.expr,
174 current_entry->prompt = prop;
180 void menu_add_visibility(struct expr *expr)
182 current_entry->visibility = expr_alloc_and(current_entry->visibility,
186 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
188 menu_add_prop(type, NULL, expr, dep);
191 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
193 menu_add_prop(type, NULL, expr_alloc_symbol(sym), dep);
196 void menu_add_option_modules(void)
199 zconf_error("symbol '%s' redefines option 'modules' already defined by symbol '%s'",
200 current_entry->sym->name, modules_sym->name);
201 modules_sym = current_entry->sym;
204 void menu_add_option_defconfig_list(void)
206 if (!sym_defconfig_list)
207 sym_defconfig_list = current_entry->sym;
208 else if (sym_defconfig_list != current_entry->sym)
209 zconf_error("trying to redefine defconfig symbol");
210 sym_defconfig_list->flags |= SYMBOL_NO_WRITE;
213 void menu_add_option_allnoconfig_y(void)
215 current_entry->sym->flags |= SYMBOL_ALLNOCONFIG_Y;
218 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
220 return sym2->type == S_INT || sym2->type == S_HEX ||
221 (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
224 static void sym_check_prop(struct symbol *sym)
226 struct property *prop;
230 for (prop = sym->prop; prop; prop = prop->next) {
231 switch (prop->type) {
233 if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
234 prop->expr->type != E_SYMBOL)
236 "default for config symbol '%s'"
237 " must be a single symbol", sym->name);
238 if (prop->expr->type != E_SYMBOL)
240 sym2 = prop_get_symbol(prop);
241 if (sym->type == S_HEX || sym->type == S_INT) {
242 if (!menu_validate_number(sym, sym2))
244 "'%s': number is invalid",
247 if (sym_is_choice(sym)) {
248 struct property *choice_prop =
249 sym_get_choice_prop(sym2);
252 prop_get_symbol(choice_prop) != sym)
254 "choice default symbol '%s' is not contained in the choice",
260 use = prop->type == P_SELECT ? "select" : "imply";
261 sym2 = prop_get_symbol(prop);
262 if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
264 "config symbol '%s' uses %s, but is "
265 "not bool or tristate", sym->name, use);
266 else if (sym2->type != S_UNKNOWN &&
267 sym2->type != S_BOOLEAN &&
268 sym2->type != S_TRISTATE)
270 "'%s' has wrong type. '%s' only "
271 "accept arguments of bool and "
272 "tristate type", sym2->name, use);
275 if (sym->type != S_INT && sym->type != S_HEX)
276 prop_warn(prop, "range is only allowed "
277 "for int or hex symbols");
278 if (!menu_validate_number(sym, prop->expr->left.sym) ||
279 !menu_validate_number(sym, prop->expr->right.sym))
280 prop_warn(prop, "range is invalid");
288 void menu_finalize(struct menu *parent)
290 struct menu *menu, *last_menu;
292 struct property *prop;
293 struct expr *parentdep, *basedep, *dep, *dep2, **ep;
298 * This menu node has children. We (recursively) process them
299 * and propagate parent dependencies before moving on.
302 if (sym && sym_is_choice(sym)) {
303 if (sym->type == S_UNKNOWN) {
304 /* find the first choice value to find out choice type */
305 current_entry = parent;
306 for (menu = parent->list; menu; menu = menu->next) {
307 if (menu->sym && menu->sym->type != S_UNKNOWN) {
308 menu_set_type(menu->sym->type);
313 /* set the type of the remaining choice values */
314 for (menu = parent->list; menu; menu = menu->next) {
315 current_entry = menu;
316 if (menu->sym && menu->sym->type == S_UNKNOWN)
317 menu_set_type(sym->type);
321 * Use the choice itself as the parent dependency of
322 * the contained items. This turns the mode of the
323 * choice into an upper bound on the visibility of the
324 * choice value symbols.
326 parentdep = expr_alloc_symbol(sym);
328 /* Menu node for 'menu', 'if' */
329 parentdep = parent->dep;
332 /* For each child menu node... */
333 for (menu = parent->list; menu; menu = menu->next) {
335 * Propagate parent dependencies to the child menu
336 * node, also rewriting and simplifying expressions
338 basedep = rewrite_m(menu->dep);
339 basedep = expr_transform(basedep);
340 basedep = expr_alloc_and(expr_copy(parentdep), basedep);
341 basedep = expr_eliminate_dups(basedep);
346 * Note: For symbols, all prompts are included
347 * too in the symbol's own property list
349 prop = menu->sym->prop;
352 * For non-symbol menu nodes, we just need to
357 /* For each property... */
358 for (; prop; prop = prop->next) {
359 if (prop->menu != menu)
363 * 1. The property lacks dependencies
364 * and so isn't location-specific,
367 * 2. The property belongs to a symbol
368 * defined in multiple locations and
369 * is from some other location. It
370 * will be handled there in that
378 * Propagate parent dependencies to the
379 * property's condition, rewriting and
380 * simplifying expressions at the same time
382 dep = rewrite_m(prop->visible.expr);
383 dep = expr_transform(dep);
384 dep = expr_alloc_and(expr_copy(basedep), dep);
385 dep = expr_eliminate_dups(dep);
386 if (menu->sym && menu->sym->type != S_TRISTATE)
387 dep = expr_trans_bool(dep);
388 prop->visible.expr = dep;
391 * Handle selects and implies, which modify the
392 * dependencies of the selected/implied symbol
394 if (prop->type == P_SELECT) {
395 struct symbol *es = prop_get_symbol(prop);
396 es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
397 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
398 } else if (prop->type == P_IMPLY) {
399 struct symbol *es = prop_get_symbol(prop);
400 es->implied.expr = expr_alloc_or(es->implied.expr,
401 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
406 if (sym && sym_is_choice(sym))
407 expr_free(parentdep);
410 * Recursively process children in the same fashion before
413 for (menu = parent->list; menu; menu = menu->next)
417 * Automatic submenu creation. If sym is a symbol and A, B, C,
418 * ... are consecutive items (symbols, menus, ifs, etc.) that
419 * all depend on sym, then the following menu structure is
428 * This also works recursively, giving the following structure
429 * if A is a symbol and B depends on A:
438 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
439 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
440 basedep = expr_eliminate_dups(expr_transform(basedep));
442 /* Examine consecutive elements after sym */
444 for (menu = parent->next; menu; menu = menu->next) {
445 dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
446 if (!expr_contains_symbol(dep, sym))
447 /* No dependency, quit */
449 if (expr_depends_symbol(dep, sym))
450 /* Absolute dependency, put in submenu */
454 * Also consider it a dependency on sym if our
455 * dependencies contain sym and are a "superset" of
456 * sym's dependencies, e.g. '(sym || Q) && R' when sym
459 * Note that 'R' might be from an enclosing menu or if,
460 * making this a more common case than it might seem.
462 dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
463 dep = expr_eliminate_dups(expr_transform(dep));
464 dep2 = expr_copy(basedep);
465 expr_eliminate_eq(&dep, &dep2);
467 if (!expr_is_yes(dep2)) {
468 /* Not superset, quit */
472 /* Superset, put in submenu */
476 menu->parent = parent;
481 parent->list = parent->next;
482 parent->next = last_menu->next;
483 last_menu->next = NULL;
486 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
488 for (menu = parent->list; menu; menu = menu->next) {
489 if (sym && sym_is_choice(sym) &&
490 menu->sym && !sym_is_choice_value(menu->sym)) {
491 current_entry = menu;
492 menu->sym->flags |= SYMBOL_CHOICEVAL;
494 menu_warn(menu, "choice value must have a prompt");
495 for (prop = menu->sym->prop; prop; prop = prop->next) {
496 if (prop->type == P_DEFAULT)
497 prop_warn(prop, "defaults for choice "
498 "values not supported");
499 if (prop->menu == menu)
501 if (prop->type == P_PROMPT &&
502 prop->menu->parent->sym != sym)
503 prop_warn(prop, "choice value used outside its choice group");
505 /* Non-tristate choice values of tristate choices must
506 * depend on the choice being set to Y. The choice
507 * values' dependencies were propagated to their
508 * properties above, so the change here must be re-
511 if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
512 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
513 menu->dep = expr_alloc_and(basedep, menu->dep);
514 for (prop = menu->sym->prop; prop; prop = prop->next) {
515 if (prop->menu != menu)
517 prop->visible.expr = expr_alloc_and(expr_copy(basedep),
521 menu_add_symbol(P_CHOICE, sym, NULL);
522 prop = sym_get_choice_prop(sym);
523 for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
525 *ep = expr_alloc_one(E_LIST, NULL);
526 (*ep)->right.sym = menu->sym;
530 * This code serves two purposes:
532 * (1) Flattening 'if' blocks, which do not specify a submenu
533 * and only add dependencies.
535 * (Automatic submenu creation might still create a submenu
536 * from an 'if' before this code runs.)
538 * (2) "Undoing" any automatic submenus created earlier below
539 * promptless symbols.
544 * if ... (or promptless symbol)
552 * if ... (or promptless symbol)
557 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
558 for (last_menu = menu->list; ; last_menu = last_menu->next) {
559 last_menu->parent = parent;
560 if (!last_menu->next)
563 last_menu->next = menu->next;
564 menu->next = menu->list;
569 if (sym && !(sym->flags & SYMBOL_WARNED)) {
570 if (sym->type == S_UNKNOWN)
571 menu_warn(parent, "config symbol defined without type");
573 if (sym_is_choice(sym) && !parent->prompt)
574 menu_warn(parent, "choice must have a prompt");
576 /* Check properties connected to this symbol */
578 sym->flags |= SYMBOL_WARNED;
582 * For non-optional choices, add a reverse dependency (corresponding to
583 * a select) of '<visibility> && m'. This prevents the user from
584 * setting the choice mode to 'n' when the choice is visible.
586 * This would also work for non-choice symbols, but only non-optional
587 * choices clear SYMBOL_OPTIONAL as of writing. Choices are implemented
588 * as a type of symbol.
590 if (sym && !sym_is_optional(sym) && parent->prompt) {
591 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
592 expr_alloc_and(parent->prompt->visible.expr,
593 expr_alloc_symbol(&symbol_mod)));
597 bool menu_has_prompt(struct menu *menu)
605 * Determine if a menu is empty.
606 * A menu is considered empty if it contains no or only
609 bool menu_is_empty(struct menu *menu)
613 for (child = menu->list; child; child = child->next) {
614 if (menu_is_visible(child))
620 bool menu_is_visible(struct menu *menu)
629 if (menu->visibility) {
630 if (expr_calc_value(menu->visibility) == no)
637 visible = menu->prompt->visible.tri;
639 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
644 if (!sym || sym_get_tristate_value(menu->sym) == no)
647 for (child = menu->list; child; child = child->next) {
648 if (menu_is_visible(child)) {
650 sym->flags |= SYMBOL_DEF_USER;
658 const char *menu_get_prompt(struct menu *menu)
661 return menu->prompt->text;
663 return menu->sym->name;
667 struct menu *menu_get_root_menu(struct menu *menu)
672 struct menu *menu_get_parent_menu(struct menu *menu)
676 for (; menu != &rootmenu; menu = menu->parent) {
677 type = menu->prompt ? menu->prompt->type : 0;
684 bool menu_has_help(struct menu *menu)
686 return menu->help != NULL;
689 const char *menu_get_help(struct menu *menu)
697 static void get_prompt_str(struct gstr *r, struct property *prop,
698 struct list_head *head)
701 struct menu *submenu[8], *menu, *location = NULL;
702 struct jump_key *jump = NULL;
704 str_printf(r, "Prompt: %s\n", prop->text);
705 menu = prop->menu->parent;
706 for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
707 bool accessible = menu_is_visible(menu);
710 if (location == NULL && accessible)
713 if (head && location) {
714 jump = xmalloc(sizeof(struct jump_key));
716 if (menu_is_visible(prop->menu)) {
718 * There is not enough room to put the hint at the
719 * beginning of the "Prompt" line. Put the hint on the
720 * last "Location" line even when it would belong on
723 jump->target = prop->menu;
725 jump->target = location;
727 if (list_empty(head))
730 jump->index = list_entry(head->prev, struct jump_key,
733 list_add_tail(&jump->entries, head);
737 str_printf(r, " Location:\n");
738 for (j = 4; --i >= 0; j += 2) {
740 if (jump && menu == location)
741 jump->offset = strlen(r->s);
742 str_printf(r, "%*c-> %s", j, ' ',
743 menu_get_prompt(menu));
745 str_printf(r, " (%s [=%s])", menu->sym->name ?
746 menu->sym->name : "<choice>",
747 sym_get_string_value(menu->sym));
755 * get property of type P_SYMBOL
757 static struct property *get_symbol_prop(struct symbol *sym)
759 struct property *prop = NULL;
761 for_all_properties(sym, prop, P_SYMBOL)
766 static void get_symbol_props_str(struct gstr *r, struct symbol *sym,
767 enum prop_type tok, const char *prefix)
770 struct property *prop;
772 for_all_properties(sym, prop, tok) {
774 str_append(r, prefix);
777 str_printf(r, " && ");
778 expr_gstr_print(prop->expr, r);
785 * head is optional and may be NULL
787 static void get_symbol_str(struct gstr *r, struct symbol *sym,
788 struct list_head *head)
790 struct property *prop;
792 if (sym && sym->name) {
793 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
794 sym_get_string_value(sym));
795 str_printf(r, "Type : %s\n", sym_type_name(sym->type));
796 if (sym->type == S_INT || sym->type == S_HEX) {
797 prop = sym_get_range_prop(sym);
799 str_printf(r, "Range : ");
800 expr_gstr_print(prop->expr, r);
805 for_all_prompts(sym, prop)
806 get_prompt_str(r, prop, head);
808 prop = get_symbol_prop(sym);
810 str_printf(r, " Defined at %s:%d\n", prop->menu->file->name,
812 if (!expr_is_yes(prop->visible.expr)) {
813 str_append(r, " Depends on: ");
814 expr_gstr_print(prop->visible.expr, r);
819 get_symbol_props_str(r, sym, P_SELECT, " Selects: ");
820 if (sym->rev_dep.expr) {
821 expr_gstr_print_revdep(sym->rev_dep.expr, r, yes, " Selected by [y]:\n");
822 expr_gstr_print_revdep(sym->rev_dep.expr, r, mod, " Selected by [m]:\n");
823 expr_gstr_print_revdep(sym->rev_dep.expr, r, no, " Selected by [n]:\n");
826 get_symbol_props_str(r, sym, P_IMPLY, " Implies: ");
827 if (sym->implied.expr) {
828 expr_gstr_print_revdep(sym->implied.expr, r, yes, " Implied by [y]:\n");
829 expr_gstr_print_revdep(sym->implied.expr, r, mod, " Implied by [m]:\n");
830 expr_gstr_print_revdep(sym->implied.expr, r, no, " Implied by [n]:\n");
833 str_append(r, "\n\n");
836 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
839 struct gstr res = str_new();
842 for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
843 get_symbol_str(&res, sym, head);
845 str_append(&res, "No matches found.\n");
850 void menu_get_ext_help(struct menu *menu, struct gstr *help)
852 struct symbol *sym = menu->sym;
853 const char *help_text = nohelp_text;
855 if (menu_has_help(menu)) {
857 str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
858 help_text = menu_get_help(menu);
860 str_printf(help, "%s\n", help_text);
862 get_symbol_str(help, sym, NULL);