GNU Linux-libre 4.9.332-gnu1
[releases.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[] = "There is no help available for this option.";
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 = 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();
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 }
111
112 void menu_set_type(int type)
113 {
114         struct symbol *sym = current_entry->sym;
115
116         if (sym->type == type)
117                 return;
118         if (sym->type == S_UNKNOWN) {
119                 sym->type = type;
120                 return;
121         }
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));
126 }
127
128 static 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                                 struct expr *dup_expr;
151
152                                 if (!menu->visibility)
153                                         continue;
154                                 /*
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.
162                                  */
163                                 dup_expr = expr_copy(menu->visibility);
164
165                                 prop->visible.expr
166                                         = expr_alloc_and(prop->visible.expr,
167                                                          dup_expr);
168                         }
169                 }
170
171                 current_entry->prompt = prop;
172         }
173         prop->text = prompt;
174
175         return prop;
176 }
177
178 struct property *menu_add_prompt(enum prop_type type, char *prompt, struct expr *dep)
179 {
180         return menu_add_prop(type, prompt, NULL, dep);
181 }
182
183 void menu_add_visibility(struct expr *expr)
184 {
185         current_entry->visibility = expr_alloc_and(current_entry->visibility,
186             expr);
187 }
188
189 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
190 {
191         menu_add_prop(type, NULL, expr, dep);
192 }
193
194 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
195 {
196         menu_add_prop(type, NULL, expr_alloc_symbol(sym), dep);
197 }
198
199 void menu_add_option(int token, char *arg)
200 {
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
208                                     );
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;
223         }
224 }
225
226 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
227 {
228         return sym2->type == S_INT || sym2->type == S_HEX ||
229                (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
230 }
231
232 static void sym_check_prop(struct symbol *sym)
233 {
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);
252                         }
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:
277                         ;
278                 }
279         }
280 }
281
282 void menu_finalize(struct menu *parent)
283 {
284         struct menu *menu, *last_menu;
285         struct symbol *sym;
286         struct property *prop;
287         struct expr *parentdep, *basedep, *dep, *dep2, **ep;
288
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;
299                                         }
300                                 }
301                         }
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);
307                         }
308                         parentdep = expr_alloc_symbol(sym);
309                 } else if (parent->prompt)
310                         parentdep = parent->prompt->visible.expr;
311                 else
312                         parentdep = parent->dep;
313
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)));
336                                 }
337                         }
338                 }
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;
360                         }
361                         expr_free(dep2);
362                 next:
363                         menu_finalize(menu);
364                         menu->parent = parent;
365                         last_menu = menu;
366                 }
367                 expr_free(basedep);
368                 if (last_menu) {
369                         parent->list = parent->next;
370                         parent->next = last_menu->next;
371                         last_menu->next = NULL;
372                 }
373
374                 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
375         }
376         for (menu = parent->list; menu; menu = menu->next) {
377                 if (sym && sym_is_choice(sym) &&
378                     menu->sym && !sym_is_choice_value(menu->sym)) {
379                         current_entry = menu;
380                         menu->sym->flags |= SYMBOL_CHOICEVAL;
381                         if (!menu->prompt)
382                                 menu_warn(menu, "choice value must have a prompt");
383                         for (prop = menu->sym->prop; prop; prop = prop->next) {
384                                 if (prop->type == P_DEFAULT)
385                                         prop_warn(prop, "defaults for choice "
386                                                   "values not supported");
387                                 if (prop->menu == menu)
388                                         continue;
389                                 if (prop->type == P_PROMPT &&
390                                     prop->menu->parent->sym != sym)
391                                         prop_warn(prop, "choice value used outside its choice group");
392                         }
393                         /* Non-tristate choice values of tristate choices must
394                          * depend on the choice being set to Y. The choice
395                          * values' dependencies were propagated to their
396                          * properties above, so the change here must be re-
397                          * propagated.
398                          */
399                         if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
400                                 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
401                                 menu->dep = expr_alloc_and(basedep, menu->dep);
402                                 for (prop = menu->sym->prop; prop; prop = prop->next) {
403                                         if (prop->menu != menu)
404                                                 continue;
405                                         prop->visible.expr = expr_alloc_and(expr_copy(basedep),
406                                                                             prop->visible.expr);
407                                 }
408                         }
409                         menu_add_symbol(P_CHOICE, sym, NULL);
410                         prop = sym_get_choice_prop(sym);
411                         for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
412                                 ;
413                         *ep = expr_alloc_one(E_LIST, NULL);
414                         (*ep)->right.sym = menu->sym;
415                 }
416                 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
417                         for (last_menu = menu->list; ; last_menu = last_menu->next) {
418                                 last_menu->parent = parent;
419                                 if (!last_menu->next)
420                                         break;
421                         }
422                         last_menu->next = menu->next;
423                         menu->next = menu->list;
424                         menu->list = NULL;
425                 }
426         }
427
428         if (sym && !(sym->flags & SYMBOL_WARNED)) {
429                 if (sym->type == S_UNKNOWN)
430                         menu_warn(parent, "config symbol defined without type");
431
432                 if (sym_is_choice(sym) && !parent->prompt)
433                         menu_warn(parent, "choice must have a prompt");
434
435                 /* Check properties connected to this symbol */
436                 sym_check_prop(sym);
437                 sym->flags |= SYMBOL_WARNED;
438         }
439
440         if (sym && !sym_is_optional(sym) && parent->prompt) {
441                 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
442                                 expr_alloc_and(parent->prompt->visible.expr,
443                                         expr_alloc_symbol(&symbol_mod)));
444         }
445 }
446
447 bool menu_has_prompt(struct menu *menu)
448 {
449         if (!menu->prompt)
450                 return false;
451         return true;
452 }
453
454 /*
455  * Determine if a menu is empty.
456  * A menu is considered empty if it contains no or only
457  * invisible entries.
458  */
459 bool menu_is_empty(struct menu *menu)
460 {
461         struct menu *child;
462
463         for (child = menu->list; child; child = child->next) {
464                 if (menu_is_visible(child))
465                         return(false);
466         }
467         return(true);
468 }
469
470 bool menu_is_visible(struct menu *menu)
471 {
472         struct menu *child;
473         struct symbol *sym;
474         tristate visible;
475
476         if (!menu->prompt)
477                 return false;
478
479         if (menu->visibility) {
480                 if (expr_calc_value(menu->visibility) == no)
481                         return false;
482         }
483
484         sym = menu->sym;
485         if (sym) {
486                 sym_calc_value(sym);
487                 visible = menu->prompt->visible.tri;
488         } else
489                 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
490
491         if (visible != no)
492                 return true;
493
494         if (!sym || sym_get_tristate_value(menu->sym) == no)
495                 return false;
496
497         for (child = menu->list; child; child = child->next) {
498                 if (menu_is_visible(child)) {
499                         if (sym)
500                                 sym->flags |= SYMBOL_DEF_USER;
501                         return true;
502                 }
503         }
504
505         return false;
506 }
507
508 const char *menu_get_prompt(struct menu *menu)
509 {
510         if (menu->prompt)
511                 return menu->prompt->text;
512         else if (menu->sym)
513                 return menu->sym->name;
514         return NULL;
515 }
516
517 struct menu *menu_get_root_menu(struct menu *menu)
518 {
519         return &rootmenu;
520 }
521
522 struct menu *menu_get_parent_menu(struct menu *menu)
523 {
524         enum prop_type type;
525
526         for (; menu != &rootmenu; menu = menu->parent) {
527                 type = menu->prompt ? menu->prompt->type : 0;
528                 if (type == P_MENU)
529                         break;
530         }
531         return menu;
532 }
533
534 bool menu_has_help(struct menu *menu)
535 {
536         return menu->help != NULL;
537 }
538
539 const char *menu_get_help(struct menu *menu)
540 {
541         if (menu->help)
542                 return menu->help;
543         else
544                 return "";
545 }
546
547 static void get_prompt_str(struct gstr *r, struct property *prop,
548                            struct list_head *head)
549 {
550         int i, j;
551         struct menu *submenu[8], *menu, *location = NULL;
552         struct jump_key *jump = NULL;
553
554         str_printf(r, _("Prompt: %s\n"), _(prop->text));
555         menu = prop->menu->parent;
556         for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
557                 bool accessible = menu_is_visible(menu);
558
559                 submenu[i++] = menu;
560                 if (location == NULL && accessible)
561                         location = menu;
562         }
563         if (head && location) {
564                 jump = xmalloc(sizeof(struct jump_key));
565
566                 if (menu_is_visible(prop->menu)) {
567                         /*
568                          * There is not enough room to put the hint at the
569                          * beginning of the "Prompt" line. Put the hint on the
570                          * last "Location" line even when it would belong on
571                          * the former.
572                          */
573                         jump->target = prop->menu;
574                 } else
575                         jump->target = location;
576
577                 if (list_empty(head))
578                         jump->index = 0;
579                 else
580                         jump->index = list_entry(head->prev, struct jump_key,
581                                                  entries)->index + 1;
582
583                 list_add_tail(&jump->entries, head);
584         }
585
586         if (i > 0) {
587                 str_printf(r, _("  Location:\n"));
588                 for (j = 4; --i >= 0; j += 2) {
589                         menu = submenu[i];
590                         if (jump && menu == location)
591                                 jump->offset = strlen(r->s);
592                         str_printf(r, "%*c-> %s", j, ' ',
593                                    _(menu_get_prompt(menu)));
594                         if (menu->sym) {
595                                 str_printf(r, " (%s [=%s])", menu->sym->name ?
596                                         menu->sym->name : _("<choice>"),
597                                         sym_get_string_value(menu->sym));
598                         }
599                         str_append(r, "\n");
600                 }
601         }
602 }
603
604 /*
605  * get property of type P_SYMBOL
606  */
607 static struct property *get_symbol_prop(struct symbol *sym)
608 {
609         struct property *prop = NULL;
610
611         for_all_properties(sym, prop, P_SYMBOL)
612                 break;
613         return prop;
614 }
615
616 /*
617  * head is optional and may be NULL
618  */
619 static void get_symbol_str(struct gstr *r, struct symbol *sym,
620                     struct list_head *head)
621 {
622         bool hit;
623         struct property *prop;
624
625         if (sym && sym->name) {
626                 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
627                            sym_get_string_value(sym));
628                 str_printf(r, "Type  : %s\n", sym_type_name(sym->type));
629                 if (sym->type == S_INT || sym->type == S_HEX) {
630                         prop = sym_get_range_prop(sym);
631                         if (prop) {
632                                 str_printf(r, "Range : ");
633                                 expr_gstr_print(prop->expr, r);
634                                 str_append(r, "\n");
635                         }
636                 }
637         }
638         for_all_prompts(sym, prop)
639                 get_prompt_str(r, prop, head);
640
641         prop = get_symbol_prop(sym);
642         if (prop) {
643                 str_printf(r, _("  Defined at %s:%d\n"), prop->menu->file->name,
644                         prop->menu->lineno);
645                 if (!expr_is_yes(prop->visible.expr)) {
646                         str_append(r, _("  Depends on: "));
647                         expr_gstr_print(prop->visible.expr, r);
648                         str_append(r, "\n");
649                 }
650         }
651
652         hit = false;
653         for_all_properties(sym, prop, P_SELECT) {
654                 if (!hit) {
655                         str_append(r, "  Selects: ");
656                         hit = true;
657                 } else
658                         str_printf(r, " && ");
659                 expr_gstr_print(prop->expr, r);
660         }
661         if (hit)
662                 str_append(r, "\n");
663         if (sym->rev_dep.expr) {
664                 str_append(r, _("  Selected by: "));
665                 expr_gstr_print(sym->rev_dep.expr, r);
666                 str_append(r, "\n");
667         }
668         str_append(r, "\n\n");
669 }
670
671 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
672 {
673         struct symbol *sym;
674         struct gstr res = str_new();
675         int i;
676
677         for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
678                 get_symbol_str(&res, sym, head);
679         if (!i)
680                 str_append(&res, _("No matches found.\n"));
681         return res;
682 }
683
684
685 void menu_get_ext_help(struct menu *menu, struct gstr *help)
686 {
687         struct symbol *sym = menu->sym;
688         const char *help_text = nohelp_text;
689
690         if (menu_has_help(menu)) {
691                 if (sym->name)
692                         str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
693                 help_text = menu_get_help(menu);
694         }
695         str_printf(help, "%s\n", _(help_text));
696         if (sym)
697                 get_symbol_str(help, sym, NULL);
698 }