blk: rq_data_dir() should not return a boolean
[cris-mirror.git] / scripts / kconfig / menu.c
blobb05cc3d4a9bea0fff7e4902e848372bb587be5cb
1 /*
2 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
3 * Released under the terms of the GNU GPL v2.0.
4 */
6 #include <ctype.h>
7 #include <stdarg.h>
8 #include <stdlib.h>
9 #include <string.h>
11 #include "lkc.h"
13 static const char nohelp_text[] = "There is no help available for this option.";
15 struct menu rootmenu;
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, ...)
23 va_list ap;
24 va_start(ap, fmt);
25 fprintf(stderr, "%s:%d:warning: ", menu->file->name, menu->lineno);
26 vfprintf(stderr, fmt, ap);
27 fprintf(stderr, "\n");
28 va_end(ap);
31 static void prop_warn(struct property *prop, const char *fmt, ...)
33 va_list ap;
34 va_start(ap, fmt);
35 fprintf(stderr, "%s:%d:warning: ", prop->file->name, prop->lineno);
36 vfprintf(stderr, fmt, ap);
37 fprintf(stderr, "\n");
38 va_end(ap);
41 void _menu_init(void)
43 current_entry = current_menu = &rootmenu;
44 last_entry_ptr = &rootmenu.list;
47 void menu_add_entry(struct symbol *sym)
49 struct menu *menu;
51 menu = xmalloc(sizeof(*menu));
52 memset(menu, 0, sizeof(*menu));
53 menu->sym = sym;
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;
60 current_entry = menu;
61 if (sym)
62 menu_add_symbol(P_SYMBOL, sym, NULL);
65 void menu_end_entry(void)
69 struct menu *menu_add_menu(void)
71 menu_end_entry();
72 last_entry_ptr = &current_entry->list;
73 return current_menu = current_entry;
76 void menu_end_menu(void)
78 last_entry_ptr = &current_menu->next;
79 current_menu = current_menu->parent;
82 static struct expr *menu_check_dep(struct expr *e)
84 if (!e)
85 return e;
87 switch (e->type) {
88 case E_NOT:
89 e->left.expr = menu_check_dep(e->left.expr);
90 break;
91 case E_OR:
92 case E_AND:
93 e->left.expr = menu_check_dep(e->left.expr);
94 e->right.expr = menu_check_dep(e->right.expr);
95 break;
96 case E_SYMBOL:
97 /* change 'm' into 'm' && MODULES */
98 if (e->left.sym == &symbol_mod)
99 return expr_alloc_and(e, expr_alloc_symbol(modules_sym));
100 break;
101 default:
102 break;
104 return e;
107 void menu_add_dep(struct expr *dep)
109 current_entry->dep = expr_alloc_and(current_entry->dep, menu_check_dep(dep));
112 void menu_set_type(int type)
114 struct symbol *sym = current_entry->sym;
116 if (sym->type == type)
117 return;
118 if (sym->type == S_UNKNOWN) {
119 sym->type = type;
120 return;
122 menu_warn(current_entry,
123 "ignoring type redefinition of '%s' from '%s' to '%s'",
124 sym->name ? sym->name : "<choice>",
125 sym_type_name(sym->type), sym_type_name(type));
128 static struct property *menu_add_prop(enum prop_type type, char *prompt, struct expr *expr, struct expr *dep)
130 struct property *prop = prop_alloc(type, current_entry->sym);
132 prop->menu = current_entry;
133 prop->expr = expr;
134 prop->visible.expr = menu_check_dep(dep);
136 if (prompt) {
137 if (isspace(*prompt)) {
138 prop_warn(prop, "leading whitespace ignored");
139 while (isspace(*prompt))
140 prompt++;
142 if (current_entry->prompt && current_entry != &rootmenu)
143 prop_warn(prop, "prompt redefined");
145 /* Apply all upper menus' visibilities to actual prompts. */
146 if(type == P_PROMPT) {
147 struct menu *menu = current_entry;
149 while ((menu = menu->parent) != NULL) {
150 struct expr *dup_expr;
152 if (!menu->visibility)
153 continue;
155 * Do not add a reference to the
156 * menu's visibility expression but
157 * use a copy of it. Otherwise the
158 * expression reduction functions
159 * will modify expressions that have
160 * multiple references which can
161 * cause unwanted side effects.
163 dup_expr = expr_copy(menu->visibility);
165 prop->visible.expr
166 = expr_alloc_and(prop->visible.expr,
167 dup_expr);
171 current_entry->prompt = prop;
173 prop->text = prompt;
175 return prop;
178 struct property *menu_add_prompt(enum prop_type type, char *prompt, struct expr *dep)
180 return menu_add_prop(type, prompt, NULL, dep);
183 void menu_add_visibility(struct expr *expr)
185 current_entry->visibility = expr_alloc_and(current_entry->visibility,
186 expr);
189 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
191 menu_add_prop(type, NULL, expr, dep);
194 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
196 menu_add_prop(type, NULL, expr_alloc_symbol(sym), dep);
199 void menu_add_option(int token, char *arg)
201 switch (token) {
202 case T_OPT_MODULES:
203 if (modules_sym)
204 zconf_error("symbol '%s' redefines option 'modules'"
205 " already defined by symbol '%s'",
206 current_entry->sym->name,
207 modules_sym->name
209 modules_sym = current_entry->sym;
210 break;
211 case T_OPT_DEFCONFIG_LIST:
212 if (!sym_defconfig_list)
213 sym_defconfig_list = current_entry->sym;
214 else if (sym_defconfig_list != current_entry->sym)
215 zconf_error("trying to redefine defconfig symbol");
216 break;
217 case T_OPT_ENV:
218 prop_add_env(arg);
219 break;
220 case T_OPT_ALLNOCONFIG_Y:
221 current_entry->sym->flags |= SYMBOL_ALLNOCONFIG_Y;
222 break;
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;
235 struct symbol *sym2;
236 for (prop = sym->prop; prop; prop = prop->next) {
237 switch (prop->type) {
238 case P_DEFAULT:
239 if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
240 prop->expr->type != E_SYMBOL)
241 prop_warn(prop,
242 "default for config symbol '%s'"
243 " must be a single symbol", sym->name);
244 if (prop->expr->type != E_SYMBOL)
245 break;
246 sym2 = prop_get_symbol(prop);
247 if (sym->type == S_HEX || sym->type == S_INT) {
248 if (!menu_validate_number(sym, sym2))
249 prop_warn(prop,
250 "'%s': number is invalid",
251 sym->name);
253 break;
254 case P_SELECT:
255 sym2 = prop_get_symbol(prop);
256 if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
257 prop_warn(prop,
258 "config symbol '%s' uses select, but is "
259 "not boolean or tristate", sym->name);
260 else if (sym2->type != S_UNKNOWN &&
261 sym2->type != S_BOOLEAN &&
262 sym2->type != S_TRISTATE)
263 prop_warn(prop,
264 "'%s' has wrong type. 'select' only "
265 "accept arguments of boolean and "
266 "tristate type", sym2->name);
267 break;
268 case P_RANGE:
269 if (sym->type != S_INT && sym->type != S_HEX)
270 prop_warn(prop, "range is only allowed "
271 "for int or hex symbols");
272 if (!menu_validate_number(sym, prop->expr->left.sym) ||
273 !menu_validate_number(sym, prop->expr->right.sym))
274 prop_warn(prop, "range is invalid");
275 break;
276 default:
282 void menu_finalize(struct menu *parent)
284 struct menu *menu, *last_menu;
285 struct symbol *sym;
286 struct property *prop;
287 struct expr *parentdep, *basedep, *dep, *dep2, **ep;
289 sym = parent->sym;
290 if (parent->list) {
291 if (sym && sym_is_choice(sym)) {
292 if (sym->type == S_UNKNOWN) {
293 /* find the first choice value to find out choice type */
294 current_entry = parent;
295 for (menu = parent->list; menu; menu = menu->next) {
296 if (menu->sym && menu->sym->type != S_UNKNOWN) {
297 menu_set_type(menu->sym->type);
298 break;
302 /* set the type of the remaining choice values */
303 for (menu = parent->list; menu; menu = menu->next) {
304 current_entry = menu;
305 if (menu->sym && menu->sym->type == S_UNKNOWN)
306 menu_set_type(sym->type);
308 parentdep = expr_alloc_symbol(sym);
309 } else if (parent->prompt)
310 parentdep = parent->prompt->visible.expr;
311 else
312 parentdep = parent->dep;
314 for (menu = parent->list; menu; menu = menu->next) {
315 basedep = expr_transform(menu->dep);
316 basedep = expr_alloc_and(expr_copy(parentdep), basedep);
317 basedep = expr_eliminate_dups(basedep);
318 menu->dep = basedep;
319 if (menu->sym)
320 prop = menu->sym->prop;
321 else
322 prop = menu->prompt;
323 for (; prop; prop = prop->next) {
324 if (prop->menu != menu)
325 continue;
326 dep = expr_transform(prop->visible.expr);
327 dep = expr_alloc_and(expr_copy(basedep), dep);
328 dep = expr_eliminate_dups(dep);
329 if (menu->sym && menu->sym->type != S_TRISTATE)
330 dep = expr_trans_bool(dep);
331 prop->visible.expr = dep;
332 if (prop->type == P_SELECT) {
333 struct symbol *es = prop_get_symbol(prop);
334 es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
335 expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
339 for (menu = parent->list; menu; menu = menu->next)
340 menu_finalize(menu);
341 } else if (sym) {
342 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
343 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
344 basedep = expr_eliminate_dups(expr_transform(basedep));
345 last_menu = NULL;
346 for (menu = parent->next; menu; menu = menu->next) {
347 dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
348 if (!expr_contains_symbol(dep, sym))
349 break;
350 if (expr_depends_symbol(dep, sym))
351 goto next;
352 dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
353 dep = expr_eliminate_dups(expr_transform(dep));
354 dep2 = expr_copy(basedep);
355 expr_eliminate_eq(&dep, &dep2);
356 expr_free(dep);
357 if (!expr_is_yes(dep2)) {
358 expr_free(dep2);
359 break;
361 expr_free(dep2);
362 next:
363 menu_finalize(menu);
364 menu->parent = parent;
365 last_menu = menu;
367 if (last_menu) {
368 parent->list = parent->next;
369 parent->next = last_menu->next;
370 last_menu->next = NULL;
373 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
375 for (menu = parent->list; menu; menu = menu->next) {
376 if (sym && sym_is_choice(sym) &&
377 menu->sym && !sym_is_choice_value(menu->sym)) {
378 current_entry = menu;
379 menu->sym->flags |= SYMBOL_CHOICEVAL;
380 if (!menu->prompt)
381 menu_warn(menu, "choice value must have a prompt");
382 for (prop = menu->sym->prop; prop; prop = prop->next) {
383 if (prop->type == P_DEFAULT)
384 prop_warn(prop, "defaults for choice "
385 "values not supported");
386 if (prop->menu == menu)
387 continue;
388 if (prop->type == P_PROMPT &&
389 prop->menu->parent->sym != sym)
390 prop_warn(prop, "choice value used outside its choice group");
392 /* Non-tristate choice values of tristate choices must
393 * depend on the choice being set to Y. The choice
394 * values' dependencies were propagated to their
395 * properties above, so the change here must be re-
396 * propagated.
398 if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
399 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
400 menu->dep = expr_alloc_and(basedep, menu->dep);
401 for (prop = menu->sym->prop; prop; prop = prop->next) {
402 if (prop->menu != menu)
403 continue;
404 prop->visible.expr = expr_alloc_and(expr_copy(basedep),
405 prop->visible.expr);
408 menu_add_symbol(P_CHOICE, sym, NULL);
409 prop = sym_get_choice_prop(sym);
410 for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
412 *ep = expr_alloc_one(E_LIST, NULL);
413 (*ep)->right.sym = menu->sym;
415 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
416 for (last_menu = menu->list; ; last_menu = last_menu->next) {
417 last_menu->parent = parent;
418 if (!last_menu->next)
419 break;
421 last_menu->next = menu->next;
422 menu->next = menu->list;
423 menu->list = NULL;
427 if (sym && !(sym->flags & SYMBOL_WARNED)) {
428 if (sym->type == S_UNKNOWN)
429 menu_warn(parent, "config symbol defined without type");
431 if (sym_is_choice(sym) && !parent->prompt)
432 menu_warn(parent, "choice must have a prompt");
434 /* Check properties connected to this symbol */
435 sym_check_prop(sym);
436 sym->flags |= SYMBOL_WARNED;
439 if (sym && !sym_is_optional(sym) && parent->prompt) {
440 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
441 expr_alloc_and(parent->prompt->visible.expr,
442 expr_alloc_symbol(&symbol_mod)));
446 bool menu_has_prompt(struct menu *menu)
448 if (!menu->prompt)
449 return false;
450 return true;
454 * Determine if a menu is empty.
455 * A menu is considered empty if it contains no or only
456 * invisible entries.
458 bool menu_is_empty(struct menu *menu)
460 struct menu *child;
462 for (child = menu->list; child; child = child->next) {
463 if (menu_is_visible(child))
464 return(false);
466 return(true);
469 bool menu_is_visible(struct menu *menu)
471 struct menu *child;
472 struct symbol *sym;
473 tristate visible;
475 if (!menu->prompt)
476 return false;
478 if (menu->visibility) {
479 if (expr_calc_value(menu->visibility) == no)
480 return no;
483 sym = menu->sym;
484 if (sym) {
485 sym_calc_value(sym);
486 visible = menu->prompt->visible.tri;
487 } else
488 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
490 if (visible != no)
491 return true;
493 if (!sym || sym_get_tristate_value(menu->sym) == no)
494 return false;
496 for (child = menu->list; child; child = child->next) {
497 if (menu_is_visible(child)) {
498 if (sym)
499 sym->flags |= SYMBOL_DEF_USER;
500 return true;
504 return false;
507 const char *menu_get_prompt(struct menu *menu)
509 if (menu->prompt)
510 return menu->prompt->text;
511 else if (menu->sym)
512 return menu->sym->name;
513 return NULL;
516 struct menu *menu_get_root_menu(struct menu *menu)
518 return &rootmenu;
521 struct menu *menu_get_parent_menu(struct menu *menu)
523 enum prop_type type;
525 for (; menu != &rootmenu; menu = menu->parent) {
526 type = menu->prompt ? menu->prompt->type : 0;
527 if (type == P_MENU)
528 break;
530 return menu;
533 bool menu_has_help(struct menu *menu)
535 return menu->help != NULL;
538 const char *menu_get_help(struct menu *menu)
540 if (menu->help)
541 return menu->help;
542 else
543 return "";
546 static void get_prompt_str(struct gstr *r, struct property *prop,
547 struct list_head *head)
549 int i, j;
550 struct menu *submenu[8], *menu, *location = NULL;
551 struct jump_key *jump = NULL;
553 str_printf(r, _("Prompt: %s\n"), _(prop->text));
554 menu = prop->menu->parent;
555 for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
556 bool accessible = menu_is_visible(menu);
558 submenu[i++] = menu;
559 if (location == NULL && accessible)
560 location = menu;
562 if (head && location) {
563 jump = xmalloc(sizeof(struct jump_key));
565 if (menu_is_visible(prop->menu)) {
567 * There is not enough room to put the hint at the
568 * beginning of the "Prompt" line. Put the hint on the
569 * last "Location" line even when it would belong on
570 * the former.
572 jump->target = prop->menu;
573 } else
574 jump->target = location;
576 if (list_empty(head))
577 jump->index = 0;
578 else
579 jump->index = list_entry(head->prev, struct jump_key,
580 entries)->index + 1;
582 list_add_tail(&jump->entries, head);
585 if (i > 0) {
586 str_printf(r, _(" Location:\n"));
587 for (j = 4; --i >= 0; j += 2) {
588 menu = submenu[i];
589 if (jump && menu == location)
590 jump->offset = strlen(r->s);
591 str_printf(r, "%*c-> %s", j, ' ',
592 _(menu_get_prompt(menu)));
593 if (menu->sym) {
594 str_printf(r, " (%s [=%s])", menu->sym->name ?
595 menu->sym->name : _("<choice>"),
596 sym_get_string_value(menu->sym));
598 str_append(r, "\n");
604 * get property of type P_SYMBOL
606 static struct property *get_symbol_prop(struct symbol *sym)
608 struct property *prop = NULL;
610 for_all_properties(sym, prop, P_SYMBOL)
611 break;
612 return prop;
616 * head is optional and may be NULL
618 static void get_symbol_str(struct gstr *r, struct symbol *sym,
619 struct list_head *head)
621 bool hit;
622 struct property *prop;
624 if (sym && sym->name) {
625 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
626 sym_get_string_value(sym));
627 str_printf(r, "Type : %s\n", sym_type_name(sym->type));
628 if (sym->type == S_INT || sym->type == S_HEX) {
629 prop = sym_get_range_prop(sym);
630 if (prop) {
631 str_printf(r, "Range : ");
632 expr_gstr_print(prop->expr, r);
633 str_append(r, "\n");
637 for_all_prompts(sym, prop)
638 get_prompt_str(r, prop, head);
640 prop = get_symbol_prop(sym);
641 if (prop) {
642 str_printf(r, _(" Defined at %s:%d\n"), prop->menu->file->name,
643 prop->menu->lineno);
644 if (!expr_is_yes(prop->visible.expr)) {
645 str_append(r, _(" Depends on: "));
646 expr_gstr_print(prop->visible.expr, r);
647 str_append(r, "\n");
651 hit = false;
652 for_all_properties(sym, prop, P_SELECT) {
653 if (!hit) {
654 str_append(r, " Selects: ");
655 hit = true;
656 } else
657 str_printf(r, " && ");
658 expr_gstr_print(prop->expr, r);
660 if (hit)
661 str_append(r, "\n");
662 if (sym->rev_dep.expr) {
663 str_append(r, _(" Selected by: "));
664 expr_gstr_print(sym->rev_dep.expr, r);
665 str_append(r, "\n");
667 str_append(r, "\n\n");
670 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
672 struct symbol *sym;
673 struct gstr res = str_new();
674 int i;
676 for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
677 get_symbol_str(&res, sym, head);
678 if (!i)
679 str_append(&res, _("No matches found.\n"));
680 return res;
684 void menu_get_ext_help(struct menu *menu, struct gstr *help)
686 struct symbol *sym = menu->sym;
687 const char *help_text = nohelp_text;
689 if (menu_has_help(menu)) {
690 if (sym->name)
691 str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
692 help_text = menu_get_help(menu);
694 str_printf(help, "%s\n", _(help_text));
695 if (sym)
696 get_symbol_str(help, sym, NULL);