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