Add missing word "the" to the CONTRIBUTING guide
[linux-libre-firmware.git] / carl9170fw / config / 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         char *use;
237
238         for (prop = sym->prop; prop; prop = prop->next) {
239                 switch (prop->type) {
240                 case P_DEFAULT:
241                         if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
242                             prop->expr->type != E_SYMBOL)
243                                 prop_warn(prop,
244                                     "default for config symbol '%s'"
245                                     " must be a single symbol", sym->name);
246                         if (prop->expr->type != E_SYMBOL)
247                                 break;
248                         sym2 = prop_get_symbol(prop);
249                         if (sym->type == S_HEX || sym->type == S_INT) {
250                                 if (!menu_validate_number(sym, sym2))
251                                         prop_warn(prop,
252                                             "'%s': number is invalid",
253                                             sym->name);
254                         }
255                         break;
256                 case P_SELECT:
257                 case P_IMPLY:
258                         use = prop->type == P_SELECT ? "select" : "imply";
259                         sym2 = prop_get_symbol(prop);
260                         if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
261                                 prop_warn(prop,
262                                     "config symbol '%s' uses %s, but is "
263                                     "not boolean or tristate", sym->name, use);
264                         else if (sym2->type != S_UNKNOWN &&
265                                  sym2->type != S_BOOLEAN &&
266                                  sym2->type != S_TRISTATE)
267                                 prop_warn(prop,
268                                     "'%s' has wrong type. '%s' only "
269                                     "accept arguments of boolean and "
270                                     "tristate type", sym2->name, use);
271                         break;
272                 case P_RANGE:
273                         if (sym->type != S_INT && sym->type != S_HEX)
274                                 prop_warn(prop, "range is only allowed "
275                                                 "for int or hex symbols");
276                         if (!menu_validate_number(sym, prop->expr->left.sym) ||
277                             !menu_validate_number(sym, prop->expr->right.sym))
278                                 prop_warn(prop, "range is invalid");
279                         break;
280                 default:
281                         ;
282                 }
283         }
284 }
285
286 void menu_finalize(struct menu *parent)
287 {
288         struct menu *menu, *last_menu;
289         struct symbol *sym;
290         struct property *prop;
291         struct expr *parentdep, *basedep, *dep, *dep2, **ep;
292
293         sym = parent->sym;
294         if (parent->list) {
295                 if (sym && sym_is_choice(sym)) {
296                         if (sym->type == S_UNKNOWN) {
297                                 /* find the first choice value to find out choice type */
298                                 current_entry = parent;
299                                 for (menu = parent->list; menu; menu = menu->next) {
300                                         if (menu->sym && menu->sym->type != S_UNKNOWN) {
301                                                 menu_set_type(menu->sym->type);
302                                                 break;
303                                         }
304                                 }
305                         }
306                         /* set the type of the remaining choice values */
307                         for (menu = parent->list; menu; menu = menu->next) {
308                                 current_entry = menu;
309                                 if (menu->sym && menu->sym->type == S_UNKNOWN)
310                                         menu_set_type(sym->type);
311                         }
312                         parentdep = expr_alloc_symbol(sym);
313                 } else if (parent->prompt)
314                         parentdep = parent->prompt->visible.expr;
315                 else
316                         parentdep = parent->dep;
317
318                 for (menu = parent->list; menu; menu = menu->next) {
319                         basedep = expr_transform(menu->dep);
320                         basedep = expr_alloc_and(expr_copy(parentdep), basedep);
321                         basedep = expr_eliminate_dups(basedep);
322                         menu->dep = basedep;
323                         if (menu->sym)
324                                 prop = menu->sym->prop;
325                         else
326                                 prop = menu->prompt;
327                         for (; prop; prop = prop->next) {
328                                 if (prop->menu != menu)
329                                         continue;
330                                 dep = expr_transform(prop->visible.expr);
331                                 dep = expr_alloc_and(expr_copy(basedep), dep);
332                                 dep = expr_eliminate_dups(dep);
333                                 if (menu->sym && menu->sym->type != S_TRISTATE)
334                                         dep = expr_trans_bool(dep);
335                                 prop->visible.expr = dep;
336                                 if (prop->type == P_SELECT) {
337                                         struct symbol *es = prop_get_symbol(prop);
338                                         es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
339                                                         expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
340                                 } else if (prop->type == P_IMPLY) {
341                                         struct symbol *es = prop_get_symbol(prop);
342                                         es->implied.expr = expr_alloc_or(es->implied.expr,
343                                                         expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
344                                 }
345                         }
346                 }
347                 for (menu = parent->list; menu; menu = menu->next)
348                         menu_finalize(menu);
349         } else if (sym) {
350                 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
351                 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
352                 basedep = expr_eliminate_dups(expr_transform(basedep));
353                 last_menu = NULL;
354                 for (menu = parent->next; menu; menu = menu->next) {
355                         dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
356                         if (!expr_contains_symbol(dep, sym))
357                                 break;
358                         if (expr_depends_symbol(dep, sym))
359                                 goto next;
360                         dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
361                         dep = expr_eliminate_dups(expr_transform(dep));
362                         dep2 = expr_copy(basedep);
363                         expr_eliminate_eq(&dep, &dep2);
364                         expr_free(dep);
365                         if (!expr_is_yes(dep2)) {
366                                 expr_free(dep2);
367                                 break;
368                         }
369                         expr_free(dep2);
370                 next:
371                         menu_finalize(menu);
372                         menu->parent = parent;
373                         last_menu = menu;
374                 }
375                 if (last_menu) {
376                         parent->list = parent->next;
377                         parent->next = last_menu->next;
378                         last_menu->next = NULL;
379                 }
380
381                 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
382         }
383         for (menu = parent->list; menu; menu = menu->next) {
384                 if (sym && sym_is_choice(sym) &&
385                     menu->sym && !sym_is_choice_value(menu->sym)) {
386                         current_entry = menu;
387                         menu->sym->flags |= SYMBOL_CHOICEVAL;
388                         if (!menu->prompt)
389                                 menu_warn(menu, "choice value must have a prompt");
390                         for (prop = menu->sym->prop; prop; prop = prop->next) {
391                                 if (prop->type == P_DEFAULT)
392                                         prop_warn(prop, "defaults for choice "
393                                                   "values not supported");
394                                 if (prop->menu == menu)
395                                         continue;
396                                 if (prop->type == P_PROMPT &&
397                                     prop->menu->parent->sym != sym)
398                                         prop_warn(prop, "choice value used outside its choice group");
399                         }
400                         /* Non-tristate choice values of tristate choices must
401                          * depend on the choice being set to Y. The choice
402                          * values' dependencies were propagated to their
403                          * properties above, so the change here must be re-
404                          * propagated.
405                          */
406                         if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
407                                 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
408                                 menu->dep = expr_alloc_and(basedep, menu->dep);
409                                 for (prop = menu->sym->prop; prop; prop = prop->next) {
410                                         if (prop->menu != menu)
411                                                 continue;
412                                         prop->visible.expr = expr_alloc_and(expr_copy(basedep),
413                                                                             prop->visible.expr);
414                                 }
415                         }
416                         menu_add_symbol(P_CHOICE, sym, NULL);
417                         prop = sym_get_choice_prop(sym);
418                         for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
419                                 ;
420                         *ep = expr_alloc_one(E_LIST, NULL);
421                         (*ep)->right.sym = menu->sym;
422                 }
423                 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
424                         for (last_menu = menu->list; ; last_menu = last_menu->next) {
425                                 last_menu->parent = parent;
426                                 if (!last_menu->next)
427                                         break;
428                         }
429                         last_menu->next = menu->next;
430                         menu->next = menu->list;
431                         menu->list = NULL;
432                 }
433         }
434
435         if (sym && !(sym->flags & SYMBOL_WARNED)) {
436                 if (sym->type == S_UNKNOWN)
437                         menu_warn(parent, "config symbol defined without type");
438
439                 if (sym_is_choice(sym) && !parent->prompt)
440                         menu_warn(parent, "choice must have a prompt");
441
442                 /* Check properties connected to this symbol */
443                 sym_check_prop(sym);
444                 sym->flags |= SYMBOL_WARNED;
445         }
446
447         if (sym && !sym_is_optional(sym) && parent->prompt) {
448                 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
449                                 expr_alloc_and(parent->prompt->visible.expr,
450                                         expr_alloc_symbol(&symbol_mod)));
451         }
452 }
453
454 bool menu_has_prompt(struct menu *menu)
455 {
456         if (!menu->prompt)
457                 return false;
458         return true;
459 }
460
461 /*
462  * Determine if a menu is empty.
463  * A menu is considered empty if it contains no or only
464  * invisible entries.
465  */
466 bool menu_is_empty(struct menu *menu)
467 {
468         struct menu *child;
469
470         for (child = menu->list; child; child = child->next) {
471                 if (menu_is_visible(child))
472                         return(false);
473         }
474         return(true);
475 }
476
477 bool menu_is_visible(struct menu *menu)
478 {
479         struct menu *child;
480         struct symbol *sym;
481         tristate visible;
482
483         if (!menu->prompt)
484                 return false;
485
486         if (menu->visibility) {
487                 if (expr_calc_value(menu->visibility) == no)
488                         return false;
489         }
490
491         sym = menu->sym;
492         if (sym) {
493                 sym_calc_value(sym);
494                 visible = menu->prompt->visible.tri;
495         } else
496                 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
497
498         if (visible != no)
499                 return true;
500
501         if (!sym || sym_get_tristate_value(menu->sym) == no)
502                 return false;
503
504         for (child = menu->list; child; child = child->next) {
505                 if (menu_is_visible(child)) {
506                         if (sym)
507                                 sym->flags |= SYMBOL_DEF_USER;
508                         return true;
509                 }
510         }
511
512         return false;
513 }
514
515 const char *menu_get_prompt(struct menu *menu)
516 {
517         if (menu->prompt)
518                 return menu->prompt->text;
519         else if (menu->sym)
520                 return menu->sym->name;
521         return NULL;
522 }
523
524 struct menu *menu_get_root_menu(struct menu *menu)
525 {
526         return &rootmenu;
527 }
528
529 struct menu *menu_get_parent_menu(struct menu *menu)
530 {
531         enum prop_type type;
532
533         for (; menu != &rootmenu; menu = menu->parent) {
534                 type = menu->prompt ? menu->prompt->type : 0;
535                 if (type == P_MENU)
536                         break;
537         }
538         return menu;
539 }
540
541 bool menu_has_help(struct menu *menu)
542 {
543         return menu->help != NULL;
544 }
545
546 const char *menu_get_help(struct menu *menu)
547 {
548         if (menu->help)
549                 return menu->help;
550         else
551                 return "";
552 }
553
554 static void get_prompt_str(struct gstr *r, struct property *prop,
555                            struct list_head *head)
556 {
557         int i, j;
558         struct menu *submenu[8], *menu, *location = NULL;
559         struct jump_key *jump = NULL;
560
561         str_printf(r, _("Prompt: %s\n"), _(prop->text));
562         menu = prop->menu->parent;
563         for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
564                 bool accessible = menu_is_visible(menu);
565
566                 submenu[i++] = menu;
567                 if (location == NULL && accessible)
568                         location = menu;
569         }
570         if (head && location) {
571                 jump = xmalloc(sizeof(struct jump_key));
572
573                 if (menu_is_visible(prop->menu)) {
574                         /*
575                          * There is not enough room to put the hint at the
576                          * beginning of the "Prompt" line. Put the hint on the
577                          * last "Location" line even when it would belong on
578                          * the former.
579                          */
580                         jump->target = prop->menu;
581                 } else
582                         jump->target = location;
583
584                 if (list_empty(head))
585                         jump->index = 0;
586                 else
587                         jump->index = list_entry(head->prev, struct jump_key,
588                                                  entries)->index + 1;
589
590                 list_add_tail(&jump->entries, head);
591         }
592
593         if (i > 0) {
594                 str_printf(r, _("  Location:\n"));
595                 for (j = 4; --i >= 0; j += 2) {
596                         menu = submenu[i];
597                         if (jump && menu == location)
598                                 jump->offset = strlen(r->s);
599                         str_printf(r, "%*c-> %s", j, ' ',
600                                    _(menu_get_prompt(menu)));
601                         if (menu->sym) {
602                                 str_printf(r, " (%s [=%s])", menu->sym->name ?
603                                         menu->sym->name : _("<choice>"),
604                                         sym_get_string_value(menu->sym));
605                         }
606                         str_append(r, "\n");
607                 }
608         }
609 }
610
611 /*
612  * get property of type P_SYMBOL
613  */
614 static struct property *get_symbol_prop(struct symbol *sym)
615 {
616         struct property *prop = NULL;
617
618         for_all_properties(sym, prop, P_SYMBOL)
619                 break;
620         return prop;
621 }
622
623 static void get_symbol_props_str(struct gstr *r, struct symbol *sym,
624                                  enum prop_type tok, const char *prefix)
625 {
626         bool hit = false;
627         struct property *prop;
628
629         for_all_properties(sym, prop, tok) {
630                 if (!hit) {
631                         str_append(r, prefix);
632                         hit = true;
633                 } else
634                         str_printf(r, " && ");
635                 expr_gstr_print(prop->expr, r);
636         }
637         if (hit)
638                 str_append(r, "\n");
639 }
640
641 /*
642  * head is optional and may be NULL
643  */
644 static void get_symbol_str(struct gstr *r, struct symbol *sym,
645                     struct list_head *head)
646 {
647         struct property *prop;
648
649         if (sym && sym->name) {
650                 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
651                            sym_get_string_value(sym));
652                 str_printf(r, "Type  : %s\n", sym_type_name(sym->type));
653                 if (sym->type == S_INT || sym->type == S_HEX) {
654                         prop = sym_get_range_prop(sym);
655                         if (prop) {
656                                 str_printf(r, "Range : ");
657                                 expr_gstr_print(prop->expr, r);
658                                 str_append(r, "\n");
659                         }
660                 }
661         }
662         for_all_prompts(sym, prop)
663                 get_prompt_str(r, prop, head);
664
665         prop = get_symbol_prop(sym);
666         if (prop) {
667                 str_printf(r, _("  Defined at %s:%d\n"), prop->menu->file->name,
668                         prop->menu->lineno);
669                 if (!expr_is_yes(prop->visible.expr)) {
670                         str_append(r, _("  Depends on: "));
671                         expr_gstr_print(prop->visible.expr, r);
672                         str_append(r, "\n");
673                 }
674         }
675
676         get_symbol_props_str(r, sym, P_SELECT, _("  Selects: "));
677         if (sym->rev_dep.expr) {
678                 str_append(r, _("  Selected by: "));
679                 expr_gstr_print(sym->rev_dep.expr, r);
680                 str_append(r, "\n");
681         }
682
683         get_symbol_props_str(r, sym, P_IMPLY, _("  Implies: "));
684         if (sym->implied.expr) {
685                 str_append(r, _("  Implied by: "));
686                 expr_gstr_print(sym->implied.expr, r);
687                 str_append(r, "\n");
688         }
689
690         str_append(r, "\n\n");
691 }
692
693 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
694 {
695         struct symbol *sym;
696         struct gstr res = str_new();
697         int i;
698
699         for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
700                 get_symbol_str(&res, sym, head);
701         if (!i)
702                 str_append(&res, _("No matches found.\n"));
703         return res;
704 }
705
706
707 void menu_get_ext_help(struct menu *menu, struct gstr *help)
708 {
709         struct symbol *sym = menu->sym;
710         const char *help_text = nohelp_text;
711
712         if (menu_has_help(menu)) {
713                 if (sym->name)
714                         str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
715                 help_text = menu_get_help(menu);
716         }
717         str_printf(help, "%s\n", _(help_text));
718         if (sym)
719                 get_symbol_str(help, sym, NULL);
720 }