jupp: update to latest
[openadk.git] / adk / config / menu.c
blobcd3a754518c1efe46f8da9f39dbf3a6b398bff6c
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 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_select(struct symbol *sym, struct expr *value, struct expr *dep)
201 struct property *p;
203 p = menu_add_prop(P_SELECT, NULL, expr_alloc_symbol(sym), dep);
204 p->value = value;
207 void menu_add_option(int token, char *arg)
209 switch (token) {
210 case T_OPT_MODULES:
211 if (modules_sym)
212 zconf_error("symbol '%s' redefines option 'modules'"
213 " already defined by symbol '%s'",
214 current_entry->sym->name,
215 modules_sym->name
217 modules_sym = current_entry->sym;
218 break;
219 case T_OPT_DEFCONFIG_LIST:
220 if (!sym_defconfig_list)
221 sym_defconfig_list = current_entry->sym;
222 else if (sym_defconfig_list != current_entry->sym)
223 zconf_error("trying to redefine defconfig symbol");
224 break;
225 case T_OPT_ENV:
226 prop_add_env(arg);
227 break;
228 case T_OPT_ALLNOCONFIG_Y:
229 current_entry->sym->flags |= SYMBOL_ALLNOCONFIG_Y;
230 break;
234 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
236 return sym2->type == S_INT || sym2->type == S_HEX ||
237 (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
240 static void sym_check_prop(struct symbol *sym)
242 struct property *prop;
243 struct symbol *sym2;
244 for (prop = sym->prop; prop; prop = prop->next) {
245 switch (prop->type) {
246 case P_DEFAULT:
247 if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
248 prop->expr->type != E_SYMBOL)
249 prop_warn(prop,
250 "default for config symbol '%s'"
251 " must be a single symbol", sym->name);
252 if (prop->expr->type != E_SYMBOL)
253 break;
254 sym2 = prop_get_symbol(prop);
255 if (sym->type == S_HEX || sym->type == S_INT) {
256 if (!menu_validate_number(sym, sym2))
257 prop_warn(prop,
258 "'%s': number is invalid",
259 sym->name);
261 break;
262 case P_SELECT:
263 sym2 = prop_get_symbol(prop);
264 if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
265 prop_warn(prop,
266 "config symbol '%s' uses select, but is "
267 "not boolean or tristate", sym->name);
268 else if (prop->value == NULL &&
269 sym2->type != S_UNKNOWN &&
270 sym2->type != S_BOOLEAN &&
271 sym2->type != S_TRISTATE)
272 prop_warn(prop,
273 "'%s' has wrong type. 'select' without a "
274 "value only accepts arguments of boolean "
275 "and tristate type", sym2->name);
276 else if (prop->value != NULL &&
277 (sym2->type == S_INT ||
278 sym2->type == S_HEX ||
279 sym2->type == S_STRING) &&
280 prop->value->type != E_SYMBOL)
281 prop_warn(prop,
282 "select value for config symbol '%s'"
283 " must be a single symbol", sym2->name);
284 break;
285 case P_RANGE:
286 if (sym->type != S_INT && sym->type != S_HEX)
287 prop_warn(prop, "range is only allowed "
288 "for int or hex symbols");
289 if (!menu_validate_number(sym, prop->expr->left.sym) ||
290 !menu_validate_number(sym, prop->expr->right.sym))
291 prop_warn(prop, "range is invalid");
292 break;
293 default:
299 static void finalize_select(struct symbol *sym, struct property *prop,
300 struct expr *dep)
302 struct symbol *es = prop_get_symbol(prop);
303 struct expr_select_value *esv;
305 if (prop->value) {
306 esv = malloc(sizeof *esv);
307 esv->expr = expr_alloc_and(expr_alloc_symbol(sym),
308 expr_copy(dep));
309 esv->value = prop->value;
310 esv->next = es->val_dep;
311 es->val_dep = esv;
312 } else {
313 es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
314 expr_alloc_and(expr_alloc_symbol(sym), expr_copy(dep)));
318 void menu_finalize(struct menu *parent)
320 struct menu *menu, *last_menu;
321 struct symbol *sym;
322 struct property *prop;
323 struct expr *parentdep, *basedep, *dep, *dep2, **ep;
325 sym = parent->sym;
326 if (parent->list) {
327 if (sym && sym_is_choice(sym)) {
328 if (sym->type == S_UNKNOWN) {
329 /* find the first choice value to find out choice type */
330 current_entry = parent;
331 for (menu = parent->list; menu; menu = menu->next) {
332 if (menu->sym && menu->sym->type != S_UNKNOWN) {
333 menu_set_type(menu->sym->type);
334 break;
338 /* set the type of the remaining choice values */
339 for (menu = parent->list; menu; menu = menu->next) {
340 current_entry = menu;
341 if (menu->sym && menu->sym->type == S_UNKNOWN)
342 menu_set_type(sym->type);
344 parentdep = expr_alloc_symbol(sym);
345 } else if (parent->prompt)
346 parentdep = parent->prompt->visible.expr;
347 else
348 parentdep = parent->dep;
350 for (menu = parent->list; menu; menu = menu->next) {
351 basedep = expr_transform(menu->dep);
352 basedep = expr_alloc_and(expr_copy(parentdep), basedep);
353 basedep = expr_eliminate_dups(basedep);
354 menu->dep = basedep;
355 if (menu->sym)
356 prop = menu->sym->prop;
357 else
358 prop = menu->prompt;
359 for (; prop; prop = prop->next) {
360 if (prop->menu != menu)
361 continue;
362 dep = expr_transform(prop->visible.expr);
363 dep = expr_alloc_and(expr_copy(basedep), dep);
364 dep = expr_eliminate_dups(dep);
365 if (menu->sym && menu->sym->type != S_TRISTATE)
366 dep = expr_trans_bool(dep);
367 prop->visible.expr = dep;
368 if (prop->type == P_SELECT)
369 finalize_select(menu->sym, prop, dep);
372 for (menu = parent->list; menu; menu = menu->next)
373 menu_finalize(menu);
374 } else if (sym) {
375 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
376 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
377 basedep = expr_eliminate_dups(expr_transform(basedep));
378 last_menu = NULL;
379 for (menu = parent->next; menu; menu = menu->next) {
380 dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
381 if (!expr_contains_symbol(dep, sym))
382 break;
383 if (expr_depends_symbol(dep, sym))
384 goto next;
385 dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
386 dep = expr_eliminate_dups(expr_transform(dep));
387 dep2 = expr_copy(basedep);
388 expr_eliminate_eq(&dep, &dep2);
389 expr_free(dep);
390 if (!expr_is_yes(dep2)) {
391 expr_free(dep2);
392 break;
394 expr_free(dep2);
395 next:
396 menu_finalize(menu);
397 menu->parent = parent;
398 last_menu = menu;
400 if (last_menu) {
401 parent->list = parent->next;
402 parent->next = last_menu->next;
403 last_menu->next = NULL;
406 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
408 for (menu = parent->list; menu; menu = menu->next) {
409 if (sym && sym_is_choice(sym) &&
410 menu->sym && !sym_is_choice_value(menu->sym)) {
411 current_entry = menu;
412 menu->sym->flags |= SYMBOL_CHOICEVAL;
413 if (!menu->prompt)
414 menu_warn(menu, "choice value must have a prompt");
415 for (prop = menu->sym->prop; prop; prop = prop->next) {
416 if (prop->type == P_DEFAULT)
417 prop_warn(prop, "defaults for choice "
418 "values not supported");
419 if (prop->menu == menu)
420 continue;
421 if (prop->type == P_PROMPT &&
422 prop->menu->parent->sym != sym)
423 prop_warn(prop, "choice value used outside its choice group");
425 /* Non-tristate choice values of tristate choices must
426 * depend on the choice being set to Y. The choice
427 * values' dependencies were propagated to their
428 * properties above, so the change here must be re-
429 * propagated.
431 if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
432 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
433 menu->dep = expr_alloc_and(basedep, menu->dep);
434 for (prop = menu->sym->prop; prop; prop = prop->next) {
435 if (prop->menu != menu)
436 continue;
437 prop->visible.expr = expr_alloc_and(expr_copy(basedep),
438 prop->visible.expr);
441 menu_add_symbol(P_CHOICE, sym, NULL);
442 prop = sym_get_choice_prop(sym);
443 for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
445 *ep = expr_alloc_one(E_LIST, NULL);
446 (*ep)->right.sym = menu->sym;
448 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
449 for (last_menu = menu->list; ; last_menu = last_menu->next) {
450 last_menu->parent = parent;
451 if (!last_menu->next)
452 break;
454 last_menu->next = menu->next;
455 menu->next = menu->list;
456 menu->list = NULL;
460 if (sym && !(sym->flags & SYMBOL_WARNED)) {
461 if (sym->type == S_UNKNOWN)
462 menu_warn(parent, "config symbol defined without type");
464 if (sym_is_choice(sym) && !parent->prompt)
465 menu_warn(parent, "choice must have a prompt");
467 /* Check properties connected to this symbol */
468 sym_check_prop(sym);
469 sym->flags |= SYMBOL_WARNED;
472 if (sym && !sym_is_optional(sym) && parent->prompt) {
473 struct expr_select_value *esv;
475 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
476 expr_alloc_and(parent->prompt->visible.expr,
477 expr_alloc_symbol(&symbol_mod)));
478 for (esv = sym->val_dep; esv; esv = esv->next)
479 esv->expr = expr_alloc_or(esv->expr,
480 expr_alloc_and(parent->prompt->visible.expr,
481 expr_alloc_symbol(&symbol_mod)));
485 bool menu_has_prompt(struct menu *menu)
487 if (!menu->prompt)
488 return false;
489 return true;
493 * Determine if a menu is empty.
494 * A menu is considered empty if it contains no or only
495 * invisible entries.
497 bool menu_is_empty(struct menu *menu)
499 struct menu *child;
501 for (child = menu->list; child; child = child->next) {
502 if (menu_is_visible(child))
503 return(false);
505 return(true);
508 bool menu_is_visible(struct menu *menu)
510 struct menu *child;
511 struct symbol *sym;
512 tristate visible;
514 if (!menu->prompt)
515 return false;
517 if (menu->visibility) {
518 if (expr_calc_value(menu->visibility) == no)
519 return no;
522 sym = menu->sym;
523 if (sym) {
524 sym_calc_value(sym);
525 visible = menu->prompt->visible.tri;
526 } else
527 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
529 if (visible != no)
530 return true;
532 if (!sym || sym_get_tristate_value(menu->sym) == no)
533 return false;
535 for (child = menu->list; child; child = child->next) {
536 if (menu_is_visible(child)) {
537 if (sym)
538 sym->flags |= SYMBOL_DEF_USER;
539 return true;
543 return false;
546 const char *menu_get_prompt(struct menu *menu)
548 if (menu->prompt)
549 return menu->prompt->text;
550 else if (menu->sym)
551 return menu->sym->name;
552 return NULL;
555 struct menu *menu_get_root_menu(struct menu *menu)
557 return &rootmenu;
560 struct menu *menu_get_parent_menu(struct menu *menu)
562 enum prop_type type;
564 for (; menu != &rootmenu; menu = menu->parent) {
565 type = menu->prompt ? menu->prompt->type : 0;
566 if (type == P_MENU)
567 break;
569 return menu;
572 bool menu_has_help(struct menu *menu)
574 return menu->help != NULL;
577 const char *menu_get_help(struct menu *menu)
579 if (menu->help)
580 return menu->help;
581 else
582 return "";
585 static void get_prompt_str(struct gstr *r, struct property *prop,
586 struct list_head *head)
588 int i, j;
589 struct menu *submenu[8], *menu, *location = NULL;
590 struct jump_key *jump;
592 str_printf(r, _("Prompt: %s\n"), _(prop->text));
593 menu = prop->menu->parent;
594 for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
595 bool accessible = menu_is_visible(menu);
597 submenu[i++] = menu;
598 if (location == NULL && accessible)
599 location = menu;
601 if (head && location) {
602 jump = xmalloc(sizeof(struct jump_key));
604 if (menu_is_visible(prop->menu)) {
606 * There is not enough room to put the hint at the
607 * beginning of the "Prompt" line. Put the hint on the
608 * last "Location" line even when it would belong on
609 * the former.
611 jump->target = prop->menu;
612 } else
613 jump->target = location;
615 if (list_empty(head))
616 jump->index = 0;
617 else
618 jump->index = list_entry(head->prev, struct jump_key,
619 entries)->index + 1;
621 list_add_tail(&jump->entries, head);
624 if (i > 0) {
625 str_printf(r, _(" Location:\n"));
626 for (j = 4; --i >= 0; j += 2) {
627 menu = submenu[i];
628 if (head && location && menu == location)
629 jump->offset = strlen(r->s);
630 str_printf(r, "%*c-> %s", j, ' ',
631 _(menu_get_prompt(menu)));
632 if (menu->sym) {
633 str_printf(r, " (%s [=%s])", menu->sym->name ?
634 menu->sym->name : _("<choice>"),
635 sym_get_string_value(menu->sym));
637 str_append(r, "\n");
643 * get property of type P_SYMBOL
645 static struct property *get_symbol_prop(struct symbol *sym)
647 struct property *prop = NULL;
649 for_all_properties(sym, prop, P_SYMBOL)
650 break;
651 return prop;
655 * head is optional and may be NULL
657 void get_symbol_str(struct gstr *r, struct symbol *sym,
658 struct list_head *head)
660 bool hit;
661 struct property *prop;
662 struct expr_select_value *esv;
664 if (sym && sym->name) {
665 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
666 sym_get_string_value(sym));
667 str_printf(r, "Type : %s\n", sym_type_name(sym->type));
668 if (sym->type == S_INT || sym->type == S_HEX) {
669 prop = sym_get_range_prop(sym);
670 if (prop) {
671 str_printf(r, "Range : ");
672 expr_gstr_print(prop->expr, r);
673 str_append(r, "\n");
677 for_all_prompts(sym, prop)
678 get_prompt_str(r, prop, head);
680 prop = get_symbol_prop(sym);
681 if (prop) {
682 str_printf(r, _(" Defined at %s:%d\n"), prop->menu->file->name,
683 prop->menu->lineno);
684 if (!expr_is_yes(prop->visible.expr)) {
685 str_append(r, _(" Depends on: "));
686 expr_gstr_print(prop->visible.expr, r);
687 str_append(r, "\n");
691 hit = false;
692 for_all_properties(sym, prop, P_SELECT) {
693 if (!hit) {
694 str_append(r, " Selects: ");
695 hit = true;
696 } else
697 str_printf(r, " && ");
698 expr_gstr_print(prop->expr, r);
699 if (prop->value) {
700 str_printf(r, " (value=");
701 expr_gstr_print(prop->value, r);
702 str_printf(r, ")");
705 if (hit)
706 str_append(r, "\n");
707 if (sym->rev_dep.expr) {
708 str_append(r, _(" Selected by: "));
709 expr_gstr_print(sym->rev_dep.expr, r);
710 str_append(r, "\n");
712 for (esv = sym->val_dep; esv; esv = esv->next) {
713 str_append(r, " Selected by: ");
714 expr_gstr_print(esv->expr, r);
715 str_append(r, " with value: ");
716 expr_gstr_print(esv->value, r);
717 str_append(r, "\n");
719 str_append(r, "\n\n");
722 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
724 struct symbol *sym;
725 struct gstr res = str_new();
726 int i;
728 for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
729 get_symbol_str(&res, sym, head);
730 if (!i)
731 str_append(&res, _("No matches found.\n"));
732 return res;
736 void menu_get_ext_help(struct menu *menu, struct gstr *help)
738 struct symbol *sym = menu->sym;
739 const char *help_text = nohelp_text;
741 if (menu_has_help(menu)) {
742 if (sym->name)
743 str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
744 help_text = menu_get_help(menu);
746 str_printf(help, "%s\n", _(help_text));
747 if (sym)
748 get_symbol_str(help, sym, NULL);