aab5a1fee5a89e9d995369dd8a07b33ee7734929
[linux-2.6.git] / scripts / kconfig / menu.c
1 /*
2  * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
3  * Released under the terms of the GNU GPL v2.0.
4  */
5
6 #include <ctype.h>
7 #include <stdarg.h>
8 #include <stdlib.h>
9 #include <string.h>
10
11 #include "lkc.h"
12
13 static const char nohelp_text[] = N_(
14         "There is no help available for this option.\n");
15
16 struct menu rootmenu;
17 static struct menu **last_entry_ptr;
18
19 struct file *file_list;
20 struct file *current_file;
21
22 void menu_warn(struct menu *menu, const char *fmt, ...)
23 {
24         va_list ap;
25         va_start(ap, fmt);
26         fprintf(stderr, "%s:%d:warning: ", menu->file->name, menu->lineno);
27         vfprintf(stderr, fmt, ap);
28         fprintf(stderr, "\n");
29         va_end(ap);
30 }
31
32 static void prop_warn(struct property *prop, const char *fmt, ...)
33 {
34         va_list ap;
35         va_start(ap, fmt);
36         fprintf(stderr, "%s:%d:warning: ", prop->file->name, prop->lineno);
37         vfprintf(stderr, fmt, ap);
38         fprintf(stderr, "\n");
39         va_end(ap);
40 }
41
42 void _menu_init(void)
43 {
44         current_entry = current_menu = &rootmenu;
45         last_entry_ptr = &rootmenu.list;
46 }
47
48 void menu_add_entry(struct symbol *sym)
49 {
50         struct menu *menu;
51
52         menu = malloc(sizeof(*menu));
53         memset(menu, 0, sizeof(*menu));
54         menu->sym = sym;
55         menu->parent = current_menu;
56         menu->file = current_file;
57         menu->lineno = zconf_lineno();
58
59         *last_entry_ptr = menu;
60         last_entry_ptr = &menu->next;
61         current_entry = menu;
62         if (sym)
63                 menu_add_symbol(P_SYMBOL, sym, NULL);
64 }
65
66 void menu_end_entry(void)
67 {
68 }
69
70 struct menu *menu_add_menu(void)
71 {
72         menu_end_entry();
73         last_entry_ptr = &current_entry->list;
74         return current_menu = current_entry;
75 }
76
77 void menu_end_menu(void)
78 {
79         last_entry_ptr = &current_menu->next;
80         current_menu = current_menu->parent;
81 }
82
83 static struct expr *menu_check_dep(struct expr *e)
84 {
85         if (!e)
86                 return e;
87
88         switch (e->type) {
89         case E_NOT:
90                 e->left.expr = menu_check_dep(e->left.expr);
91                 break;
92         case E_OR:
93         case E_AND:
94                 e->left.expr = menu_check_dep(e->left.expr);
95                 e->right.expr = menu_check_dep(e->right.expr);
96                 break;
97         case E_SYMBOL:
98                 /* change 'm' into 'm' && MODULES */
99                 if (e->left.sym == &symbol_mod)
100                         return expr_alloc_and(e, expr_alloc_symbol(modules_sym));
101                 break;
102         default:
103                 break;
104         }
105         return e;
106 }
107
108 void menu_add_dep(struct expr *dep)
109 {
110         current_entry->dep = expr_alloc_and(current_entry->dep, menu_check_dep(dep));
111 }
112
113 void menu_set_type(int type)
114 {
115         struct symbol *sym = current_entry->sym;
116
117         if (sym->type == type)
118                 return;
119         if (sym->type == S_UNKNOWN) {
120                 sym->type = type;
121                 return;
122         }
123         menu_warn(current_entry, "type of '%s' redefined from '%s' to '%s'",
124             sym->name ? sym->name : "<choice>",
125             sym_type_name(sym->type), sym_type_name(type));
126 }
127
128 struct property *menu_add_prop(enum prop_type type, char *prompt, struct expr *expr, struct expr *dep)
129 {
130         struct property *prop = prop_alloc(type, current_entry->sym);
131
132         prop->menu = current_entry;
133         prop->expr = expr;
134         prop->visible.expr = menu_check_dep(dep);
135
136         if (prompt) {
137                 if (isspace(*prompt)) {
138                         prop_warn(prop, "leading whitespace ignored");
139                         while (isspace(*prompt))
140                                 prompt++;
141                 }
142                 if (current_entry->prompt && current_entry != &rootmenu)
143                         prop_warn(prop, "prompt redefined");
144
145                 /* Apply all upper menus' visibilities to actual prompts. */
146                 if(type == P_PROMPT) {
147                         struct menu *menu = current_entry;
148
149                         while ((menu = menu->parent) != NULL) {
150                                 if (!menu->visibility)
151                                         continue;
152                                 prop->visible.expr
153                                         = expr_alloc_and(prop->visible.expr,
154                                                          menu->visibility);
155                         }
156                 }
157
158                 current_entry->prompt = prop;
159         }
160         prop->text = prompt;
161
162         return prop;
163 }
164
165 struct property *menu_add_prompt(enum prop_type type, char *prompt, struct expr *dep)
166 {
167         return menu_add_prop(type, prompt, NULL, dep);
168 }
169
170 void menu_add_visibility(struct expr *expr)
171 {
172         current_entry->visibility = expr_alloc_and(current_entry->visibility,
173             expr);
174 }
175
176 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
177 {
178         menu_add_prop(type, NULL, expr, dep);
179 }
180
181 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
182 {
183         menu_add_prop(type, NULL, expr_alloc_symbol(sym), dep);
184 }
185
186 void menu_add_option(int token, char *arg)
187 {
188         struct property *prop;
189
190         switch (token) {
191         case T_OPT_MODULES:
192                 prop = prop_alloc(P_DEFAULT, modules_sym);
193                 prop->expr = expr_alloc_symbol(current_entry->sym);
194                 break;
195         case T_OPT_DEFCONFIG_LIST:
196                 if (!sym_defconfig_list)
197                         sym_defconfig_list = current_entry->sym;
198                 else if (sym_defconfig_list != current_entry->sym)
199                         zconf_error("trying to redefine defconfig symbol");
200                 break;
201         case T_OPT_ENV:
202                 prop_add_env(arg);
203                 break;
204         }
205 }
206
207 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
208 {
209         return sym2->type == S_INT || sym2->type == S_HEX ||
210                (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
211 }
212
213 static void sym_check_prop(struct symbol *sym)
214 {
215         struct property *prop;
216         struct symbol *sym2;
217         for (prop = sym->prop; prop; prop = prop->next) {
218                 switch (prop->type) {
219                 case P_DEFAULT:
220                         if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
221                             prop->expr->type != E_SYMBOL)
222                                 prop_warn(prop,
223                                     "default for config symbol '%s'"
224                                     " must be a single symbol", sym->name);
225                         if (prop->expr->type != E_SYMBOL)
226                                 break;
227                         sym2 = prop_get_symbol(prop);
228                         if (sym->type == S_HEX || sym->type == S_INT) {
229                                 if (!menu_validate_number(sym, sym2))
230                                         prop_warn(prop,
231                                             "'%s': number is invalid",
232                                             sym->name);
233                         }
234                         break;
235                 case P_SELECT:
236                         sym2 = prop_get_symbol(prop);
237                         if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
238                                 prop_warn(prop,
239                                     "config symbol '%s' uses select, but is "
240                                     "not boolean or tristate", sym->name);
241                         else if (sym2->type != S_UNKNOWN &&
242                                  sym2->type != S_BOOLEAN &&
243                                  sym2->type != S_TRISTATE)
244                                 prop_warn(prop,
245                                     "'%s' has wrong type. 'select' only "
246                                     "accept arguments of boolean and "
247                                     "tristate type", sym2->name);
248                         break;
249                 case P_RANGE:
250                         if (sym->type != S_INT && sym->type != S_HEX)
251                                 prop_warn(prop, "range is only allowed "
252                                                 "for int or hex symbols");
253                         if (!menu_validate_number(sym, prop->expr->left.sym) ||
254                             !menu_validate_number(sym, prop->expr->right.sym))
255                                 prop_warn(prop, "range is invalid");
256                         break;
257                 default:
258                         ;
259                 }
260         }
261 }
262
263 void menu_finalize(struct menu *parent)
264 {
265         struct menu *menu, *last_menu;
266         struct symbol *sym;
267         struct property *prop;
268         struct expr *parentdep, *basedep, *dep, *dep2, **ep;
269
270         sym = parent->sym;
271         if (parent->list) {
272                 if (sym && sym_is_choice(sym)) {
273                         if (sym->type == S_UNKNOWN) {
274                                 /* find the first choice value to find out choice type */
275                                 current_entry = parent;
276                                 for (menu = parent->list; menu; menu = menu->next) {
277                                         if (menu->sym && menu->sym->type != S_UNKNOWN) {
278                                                 menu_set_type(menu->sym->type);
279                                                 break;
280                                         }
281                                 }
282                         }
283                         /* set the type of the remaining choice values */
284                         for (menu = parent->list; menu; menu = menu->next) {
285                                 current_entry = menu;
286                                 if (menu->sym && menu->sym->type == S_UNKNOWN)
287                                         menu_set_type(sym->type);
288                         }
289                         parentdep = expr_alloc_symbol(sym);
290                 } else if (parent->prompt)
291                         parentdep = parent->prompt->visible.expr;
292                 else
293                         parentdep = parent->dep;
294
295                 for (menu = parent->list; menu; menu = menu->next) {
296                         basedep = expr_transform(menu->dep);
297                         basedep = expr_alloc_and(expr_copy(parentdep), basedep);
298                         basedep = expr_eliminate_dups(basedep);
299                         menu->dep = basedep;
300                         if (menu->sym)
301                                 prop = menu->sym->prop;
302                         else
303                                 prop = menu->prompt;
304                         for (; prop; prop = prop->next) {
305                                 if (prop->menu != menu)
306                                         continue;
307                                 dep = expr_transform(prop->visible.expr);
308                                 dep = expr_alloc_and(expr_copy(basedep), dep);
309                                 dep = expr_eliminate_dups(dep);
310                                 if (menu->sym && menu->sym->type != S_TRISTATE)
311                                         dep = expr_trans_bool(dep);
312                                 prop->visible.expr = dep;
313                                 if (prop->type == P_SELECT) {
314                                         struct symbol *es = prop_get_symbol(prop);
315                                         es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
316                                                         expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
317                                 }
318                         }
319                 }
320                 for (menu = parent->list; menu; menu = menu->next)
321                         menu_finalize(menu);
322         } else if (sym) {
323                 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
324                 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
325                 basedep = expr_eliminate_dups(expr_transform(basedep));
326                 last_menu = NULL;
327                 for (menu = parent->next; menu; menu = menu->next) {
328                         dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
329                         if (!expr_contains_symbol(dep, sym))
330                                 break;
331                         if (expr_depends_symbol(dep, sym))
332                                 goto next;
333                         dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
334                         dep = expr_eliminate_dups(expr_transform(dep));
335                         dep2 = expr_copy(basedep);
336                         expr_eliminate_eq(&dep, &dep2);
337                         expr_free(dep);
338                         if (!expr_is_yes(dep2)) {
339                                 expr_free(dep2);
340                                 break;
341                         }
342                         expr_free(dep2);
343                 next:
344                         menu_finalize(menu);
345                         menu->parent = parent;
346                         last_menu = menu;
347                 }
348                 if (last_menu) {
349                         parent->list = parent->next;
350                         parent->next = last_menu->next;
351                         last_menu->next = NULL;
352                 }
353
354                 sym->dir_dep.expr = parent->dep;
355         }
356         for (menu = parent->list; menu; menu = menu->next) {
357                 if (sym && sym_is_choice(sym) &&
358                     menu->sym && !sym_is_choice_value(menu->sym)) {
359                         current_entry = menu;
360                         menu->sym->flags |= SYMBOL_CHOICEVAL;
361                         if (!menu->prompt)
362                                 menu_warn(menu, "choice value must have a prompt");
363                         for (prop = menu->sym->prop; prop; prop = prop->next) {
364                                 if (prop->type == P_DEFAULT)
365                                         prop_warn(prop, "defaults for choice "
366                                                   "values not supported");
367                                 if (prop->menu == menu)
368                                         continue;
369                                 if (prop->type == P_PROMPT &&
370                                     prop->menu->parent->sym != sym)
371                                         prop_warn(prop, "choice value used outside its choice group");
372                         }
373                         /* Non-tristate choice values of tristate choices must
374                          * depend on the choice being set to Y. The choice
375                          * values' dependencies were propagated to their
376                          * properties above, so the change here must be re-
377                          * propagated.
378                          */
379                         if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
380                                 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
381                                 menu->dep = expr_alloc_and(basedep, menu->dep);
382                                 for (prop = menu->sym->prop; prop; prop = prop->next) {
383                                         if (prop->menu != menu)
384                                                 continue;
385                                         prop->visible.expr = expr_alloc_and(expr_copy(basedep),
386                                                                             prop->visible.expr);
387                                 }
388                         }
389                         menu_add_symbol(P_CHOICE, sym, NULL);
390                         prop = sym_get_choice_prop(sym);
391                         for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
392                                 ;
393                         *ep = expr_alloc_one(E_LIST, NULL);
394                         (*ep)->right.sym = menu->sym;
395                 }
396                 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
397                         for (last_menu = menu->list; ; last_menu = last_menu->next) {
398                                 last_menu->parent = parent;
399                                 if (!last_menu->next)
400                                         break;
401                         }
402                         last_menu->next = menu->next;
403                         menu->next = menu->list;
404                         menu->list = NULL;
405                 }
406         }
407
408         if (sym && !(sym->flags & SYMBOL_WARNED)) {
409                 if (sym->type == S_UNKNOWN)
410                         menu_warn(parent, "config symbol defined without type");
411
412                 if (sym_is_choice(sym) && !parent->prompt)
413                         menu_warn(parent, "choice must have a prompt");
414
415                 /* Check properties connected to this symbol */
416                 sym_check_prop(sym);
417                 sym->flags |= SYMBOL_WARNED;
418         }
419
420         if (sym && !sym_is_optional(sym) && parent->prompt) {
421                 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
422                                 expr_alloc_and(parent->prompt->visible.expr,
423                                         expr_alloc_symbol(&symbol_mod)));
424         }
425 }
426
427 bool menu_has_prompt(struct menu *menu)
428 {
429         if (!menu->prompt)
430                 return false;
431         return true;
432 }
433
434 bool menu_is_visible(struct menu *menu)
435 {
436         struct menu *child;
437         struct symbol *sym;
438         tristate visible;
439
440         if (!menu->prompt)
441                 return false;
442
443         if (menu->visibility) {
444                 if (expr_calc_value(menu->visibility) == no)
445                         return no;
446         }
447
448         sym = menu->sym;
449         if (sym) {
450                 sym_calc_value(sym);
451                 visible = menu->prompt->visible.tri;
452         } else
453                 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
454
455         if (visible != no)
456                 return true;
457
458         if (!sym || sym_get_tristate_value(menu->sym) == no)
459                 return false;
460
461         for (child = menu->list; child; child = child->next) {
462                 if (menu_is_visible(child)) {
463                         if (sym)
464                                 sym->flags |= SYMBOL_DEF_USER;
465                         return true;
466                 }
467         }
468
469         return false;
470 }
471
472 const char *menu_get_prompt(struct menu *menu)
473 {
474         if (menu->prompt)
475                 return menu->prompt->text;
476         else if (menu->sym)
477                 return menu->sym->name;
478         return NULL;
479 }
480
481 struct menu *menu_get_root_menu(struct menu *menu)
482 {
483         return &rootmenu;
484 }
485
486 struct menu *menu_get_parent_menu(struct menu *menu)
487 {
488         enum prop_type type;
489
490         for (; menu != &rootmenu; menu = menu->parent) {
491                 type = menu->prompt ? menu->prompt->type : 0;
492                 if (type == P_MENU)
493                         break;
494         }
495         return menu;
496 }
497
498 bool menu_has_help(struct menu *menu)
499 {
500         return menu->help != NULL;
501 }
502
503 const char *menu_get_help(struct menu *menu)
504 {
505         if (menu->help)
506                 return menu->help;
507         else
508                 return "";
509 }
510
511 static void get_prompt_str(struct gstr *r, struct property *prop)
512 {
513         int i, j;
514         struct menu *submenu[8], *menu;
515
516         str_printf(r, _("Prompt: %s\n"), _(prop->text));
517         str_printf(r, _("  Defined at %s:%d\n"), prop->menu->file->name,
518                 prop->menu->lineno);
519         if (!expr_is_yes(prop->visible.expr)) {
520                 str_append(r, _("  Depends on: "));
521                 expr_gstr_print(prop->visible.expr, r);
522                 str_append(r, "\n");
523         }
524         menu = prop->menu->parent;
525         for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent)
526                 submenu[i++] = menu;
527         if (i > 0) {
528                 str_printf(r, _("  Location:\n"));
529                 for (j = 4; --i >= 0; j += 2) {
530                         menu = submenu[i];
531                         str_printf(r, "%*c-> %s", j, ' ', _(menu_get_prompt(menu)));
532                         if (menu->sym) {
533                                 str_printf(r, " (%s [=%s])", menu->sym->name ?
534                                         menu->sym->name : _("<choice>"),
535                                         sym_get_string_value(menu->sym));
536                         }
537                         str_append(r, "\n");
538                 }
539         }
540 }
541
542 void get_symbol_str(struct gstr *r, struct symbol *sym)
543 {
544         bool hit;
545         struct property *prop;
546
547         if (sym && sym->name) {
548                 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
549                            sym_get_string_value(sym));
550                 str_printf(r, "Type  : %s\n", sym_type_name(sym->type));
551                 if (sym->type == S_INT || sym->type == S_HEX) {
552                         prop = sym_get_range_prop(sym);
553                         if (prop) {
554                                 str_printf(r, "Range : ");
555                                 expr_gstr_print(prop->expr, r);
556                                 str_append(r, "\n");
557                         }
558                 }
559         }
560         for_all_prompts(sym, prop)
561                 get_prompt_str(r, prop);
562         hit = false;
563         for_all_properties(sym, prop, P_SELECT) {
564                 if (!hit) {
565                         str_append(r, "  Selects: ");
566                         hit = true;
567                 } else
568                         str_printf(r, " && ");
569                 expr_gstr_print(prop->expr, r);
570         }
571         if (hit)
572                 str_append(r, "\n");
573         if (sym->rev_dep.expr) {
574                 str_append(r, _("  Selected by: "));
575                 expr_gstr_print(sym->rev_dep.expr, r);
576                 str_append(r, "\n");
577         }
578         str_append(r, "\n\n");
579 }
580
581 struct gstr get_relations_str(struct symbol **sym_arr)
582 {
583         struct symbol *sym;
584         struct gstr res = str_new();
585         int i;
586
587         for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
588                 get_symbol_str(&res, sym);
589         if (!i)
590                 str_append(&res, _("No matches found.\n"));
591         return res;
592 }
593
594
595 void menu_get_ext_help(struct menu *menu, struct gstr *help)
596 {
597         struct symbol *sym = menu->sym;
598
599         if (menu_has_help(menu)) {
600                 if (sym->name) {
601                         str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
602                         str_append(help, _(menu_get_help(menu)));
603                         str_append(help, "\n");
604                 }
605         } else {
606                 str_append(help, nohelp_text);
607         }
608         if (sym)
609                 get_symbol_str(help, sym);
610 }