kconfig: Document automatic submenu creation code
[carl9170fw.git] / 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 /*
83  * Rewrites 'm' to 'm' && MODULES, so that it evaluates to 'n' when running
84  * without modules
85  */
86 static struct expr *rewrite_m(struct expr *e)
87 {
88         if (!e)
89                 return e;
90
91         switch (e->type) {
92         case E_NOT:
93                 e->left.expr = rewrite_m(e->left.expr);
94                 break;
95         case E_OR:
96         case E_AND:
97                 e->left.expr = rewrite_m(e->left.expr);
98                 e->right.expr = rewrite_m(e->right.expr);
99                 break;
100         case E_SYMBOL:
101                 /* change 'm' into 'm' && MODULES */
102                 if (e->left.sym == &symbol_mod)
103                         return expr_alloc_and(e, expr_alloc_symbol(modules_sym));
104                 break;
105         default:
106                 break;
107         }
108         return e;
109 }
110
111 void menu_add_dep(struct expr *dep)
112 {
113         current_entry->dep = expr_alloc_and(current_entry->dep, dep);
114 }
115
116 void menu_set_type(int type)
117 {
118         struct symbol *sym = current_entry->sym;
119
120         if (sym->type == type)
121                 return;
122         if (sym->type == S_UNKNOWN) {
123                 sym->type = type;
124                 return;
125         }
126         menu_warn(current_entry,
127                 "ignoring type redefinition of '%s' from '%s' to '%s'",
128                 sym->name ? sym->name : "<choice>",
129                 sym_type_name(sym->type), sym_type_name(type));
130 }
131
132 static struct property *menu_add_prop(enum prop_type type, char *prompt, struct expr *expr, struct expr *dep)
133 {
134         struct property *prop = prop_alloc(type, current_entry->sym);
135
136         prop->menu = current_entry;
137         prop->expr = expr;
138         prop->visible.expr = dep;
139
140         if (prompt) {
141                 if (isspace(*prompt)) {
142                         prop_warn(prop, "leading whitespace ignored");
143                         while (isspace(*prompt))
144                                 prompt++;
145                 }
146                 if (current_entry->prompt && current_entry != &rootmenu)
147                         prop_warn(prop, "prompt redefined");
148
149                 /* Apply all upper menus' visibilities to actual prompts. */
150                 if(type == P_PROMPT) {
151                         struct menu *menu = current_entry;
152
153                         while ((menu = menu->parent) != NULL) {
154                                 struct expr *dup_expr;
155
156                                 if (!menu->visibility)
157                                         continue;
158                                 /*
159                                  * Do not add a reference to the
160                                  * menu's visibility expression but
161                                  * use a copy of it.  Otherwise the
162                                  * expression reduction functions
163                                  * will modify expressions that have
164                                  * multiple references which can
165                                  * cause unwanted side effects.
166                                  */
167                                 dup_expr = expr_copy(menu->visibility);
168
169                                 prop->visible.expr
170                                         = expr_alloc_and(prop->visible.expr,
171                                                          dup_expr);
172                         }
173                 }
174
175                 current_entry->prompt = prop;
176         }
177         prop->text = prompt;
178
179         return prop;
180 }
181
182 struct property *menu_add_prompt(enum prop_type type, char *prompt, struct expr *dep)
183 {
184         return menu_add_prop(type, prompt, NULL, dep);
185 }
186
187 void menu_add_visibility(struct expr *expr)
188 {
189         current_entry->visibility = expr_alloc_and(current_entry->visibility,
190             expr);
191 }
192
193 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
194 {
195         menu_add_prop(type, NULL, expr, dep);
196 }
197
198 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
199 {
200         menu_add_prop(type, NULL, expr_alloc_symbol(sym), dep);
201 }
202
203 void menu_add_option(int token, char *arg)
204 {
205         switch (token) {
206         case T_OPT_MODULES:
207                 if (modules_sym)
208                         zconf_error("symbol '%s' redefines option 'modules'"
209                                     " already defined by symbol '%s'",
210                                     current_entry->sym->name,
211                                     modules_sym->name
212                                     );
213                 modules_sym = current_entry->sym;
214                 break;
215         case T_OPT_DEFCONFIG_LIST:
216                 if (!sym_defconfig_list)
217                         sym_defconfig_list = current_entry->sym;
218                 else if (sym_defconfig_list != current_entry->sym)
219                         zconf_error("trying to redefine defconfig symbol");
220                 break;
221         case T_OPT_ENV:
222                 prop_add_env(arg);
223                 break;
224         case T_OPT_ALLNOCONFIG_Y:
225                 current_entry->sym->flags |= SYMBOL_ALLNOCONFIG_Y;
226                 break;
227         }
228 }
229
230 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
231 {
232         return sym2->type == S_INT || sym2->type == S_HEX ||
233                (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
234 }
235
236 static void sym_check_prop(struct symbol *sym)
237 {
238         struct property *prop;
239         struct symbol *sym2;
240         char *use;
241
242         for (prop = sym->prop; prop; prop = prop->next) {
243                 switch (prop->type) {
244                 case P_DEFAULT:
245                         if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
246                             prop->expr->type != E_SYMBOL)
247                                 prop_warn(prop,
248                                     "default for config symbol '%s'"
249                                     " must be a single symbol", sym->name);
250                         if (prop->expr->type != E_SYMBOL)
251                                 break;
252                         sym2 = prop_get_symbol(prop);
253                         if (sym->type == S_HEX || sym->type == S_INT) {
254                                 if (!menu_validate_number(sym, sym2))
255                                         prop_warn(prop,
256                                             "'%s': number is invalid",
257                                             sym->name);
258                         }
259                         if (sym_is_choice(sym)) {
260                                 struct property *choice_prop =
261                                         sym_get_choice_prop(sym2);
262
263                                 if (!choice_prop ||
264                                     prop_get_symbol(choice_prop) != sym)
265                                         prop_warn(prop,
266                                                   "choice default symbol '%s' is not contained in the choice",
267                                                   sym2->name);
268                         }
269                         break;
270                 case P_SELECT:
271                 case P_IMPLY:
272                         use = prop->type == P_SELECT ? "select" : "imply";
273                         sym2 = prop_get_symbol(prop);
274                         if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
275                                 prop_warn(prop,
276                                     "config symbol '%s' uses %s, but is "
277                                     "not boolean or tristate", sym->name, use);
278                         else if (sym2->type != S_UNKNOWN &&
279                                  sym2->type != S_BOOLEAN &&
280                                  sym2->type != S_TRISTATE)
281                                 prop_warn(prop,
282                                     "'%s' has wrong type. '%s' only "
283                                     "accept arguments of boolean and "
284                                     "tristate type", sym2->name, use);
285                         break;
286                 case P_RANGE:
287                         if (sym->type != S_INT && sym->type != S_HEX)
288                                 prop_warn(prop, "range is only allowed "
289                                                 "for int or hex symbols");
290                         if (!menu_validate_number(sym, prop->expr->left.sym) ||
291                             !menu_validate_number(sym, prop->expr->right.sym))
292                                 prop_warn(prop, "range is invalid");
293                         break;
294                 default:
295                         ;
296                 }
297         }
298 }
299
300 void menu_finalize(struct menu *parent)
301 {
302         struct menu *menu, *last_menu;
303         struct symbol *sym;
304         struct property *prop;
305         struct expr *parentdep, *basedep, *dep, *dep2, **ep;
306
307         sym = parent->sym;
308         if (parent->list) {
309                 /*
310                  * This menu node has children. We (recursively) process them
311                  * and propagate parent dependencies before moving on.
312                  */
313
314                 if (sym && sym_is_choice(sym)) {
315                         if (sym->type == S_UNKNOWN) {
316                                 /* find the first choice value to find out choice type */
317                                 current_entry = parent;
318                                 for (menu = parent->list; menu; menu = menu->next) {
319                                         if (menu->sym && menu->sym->type != S_UNKNOWN) {
320                                                 menu_set_type(menu->sym->type);
321                                                 break;
322                                         }
323                                 }
324                         }
325                         /* set the type of the remaining choice values */
326                         for (menu = parent->list; menu; menu = menu->next) {
327                                 current_entry = menu;
328                                 if (menu->sym && menu->sym->type == S_UNKNOWN)
329                                         menu_set_type(sym->type);
330                         }
331                         parentdep = expr_alloc_symbol(sym);
332                 } else if (parent->prompt)
333                         parentdep = parent->prompt->visible.expr;
334                 else
335                         parentdep = parent->dep;
336
337                 /* For each child menu node... */
338                 for (menu = parent->list; menu; menu = menu->next) {
339                         /*
340                          * Propagate parent dependencies to the child menu
341                          * node, also rewriting and simplifying expressions
342                          */
343                         basedep = rewrite_m(menu->dep);
344                         basedep = expr_transform(basedep);
345                         basedep = expr_alloc_and(expr_copy(parentdep), basedep);
346                         basedep = expr_eliminate_dups(basedep);
347                         menu->dep = basedep;
348
349                         if (menu->sym)
350                                 /*
351                                  * Note: For symbols, all prompts are included
352                                  * too in the symbol's own property list
353                                  */
354                                 prop = menu->sym->prop;
355                         else
356                                 /*
357                                  * For non-symbol menu nodes, we just need to
358                                  * handle the prompt
359                                  */
360                                 prop = menu->prompt;
361
362                         /* For each property... */
363                         for (; prop; prop = prop->next) {
364                                 if (prop->menu != menu)
365                                         /*
366                                          * Two possibilities:
367                                          *
368                                          * 1. The property lacks dependencies
369                                          *    and so isn't location-specific,
370                                          *    e.g. an 'option'
371                                          *
372                                          * 2. The property belongs to a symbol
373                                          *    defined in multiple locations and
374                                          *    is from some other location. It
375                                          *    will be handled there in that
376                                          *    case.
377                                          *
378                                          * Skip the property.
379                                          */
380                                         continue;
381
382                                 /*
383                                  * Propagate parent dependencies to the
384                                  * property's condition, rewriting and
385                                  * simplifying expressions at the same time
386                                  */
387                                 dep = rewrite_m(prop->visible.expr);
388                                 dep = expr_transform(dep);
389                                 dep = expr_alloc_and(expr_copy(basedep), dep);
390                                 dep = expr_eliminate_dups(dep);
391                                 if (menu->sym && menu->sym->type != S_TRISTATE)
392                                         dep = expr_trans_bool(dep);
393                                 prop->visible.expr = dep;
394
395                                 /*
396                                  * Handle selects and implies, which modify the
397                                  * dependencies of the selected/implied symbol
398                                  */
399                                 if (prop->type == P_SELECT) {
400                                         struct symbol *es = prop_get_symbol(prop);
401                                         es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
402                                                         expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
403                                 } else if (prop->type == P_IMPLY) {
404                                         struct symbol *es = prop_get_symbol(prop);
405                                         es->implied.expr = expr_alloc_or(es->implied.expr,
406                                                         expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
407                                 }
408                         }
409                 }
410
411                 if (sym && sym_is_choice(sym))
412                         expr_free(parentdep);
413
414                 /*
415                  * Recursively process children in the same fashion before
416                  * moving on
417                  */
418                 for (menu = parent->list; menu; menu = menu->next)
419                         menu_finalize(menu);
420         } else if (sym) {
421                 /*
422                  * Automatic submenu creation. If sym is a symbol and A, B, C,
423                  * ... are consecutive items (symbols, menus, ifs, etc.) that
424                  * all depend on sym, then the following menu structure is
425                  * created:
426                  *
427                  *      sym
428                  *       +-A
429                  *       +-B
430                  *       +-C
431                  *       ...
432                  *
433                  * This also works recursively, giving the following structure
434                  * if A is a symbol and B depends on A:
435                  *
436                  *      sym
437                  *       +-A
438                  *       | +-B
439                  *       +-C
440                  *       ...
441                  */
442
443                 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
444                 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
445                 basedep = expr_eliminate_dups(expr_transform(basedep));
446
447                 /* Examine consecutive elements after sym */
448                 last_menu = NULL;
449                 for (menu = parent->next; menu; menu = menu->next) {
450                         dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
451                         if (!expr_contains_symbol(dep, sym))
452                                 /* No dependency, quit */
453                                 break;
454                         if (expr_depends_symbol(dep, sym))
455                                 /* Absolute dependency, put in submenu */
456                                 goto next;
457
458                         /*
459                          * Also consider it a dependency on sym if our
460                          * dependencies contain sym and are a "superset" of
461                          * sym's dependencies, e.g. '(sym || Q) && R' when sym
462                          * depends on R.
463                          *
464                          * Note that 'R' might be from an enclosing menu or if,
465                          * making this a more common case than it might seem.
466                          */
467                         dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
468                         dep = expr_eliminate_dups(expr_transform(dep));
469                         dep2 = expr_copy(basedep);
470                         expr_eliminate_eq(&dep, &dep2);
471                         expr_free(dep);
472                         if (!expr_is_yes(dep2)) {
473                                 /* Not superset, quit */
474                                 expr_free(dep2);
475                                 break;
476                         }
477                         /* Superset, put in submenu */
478                         expr_free(dep2);
479                 next:
480                         menu_finalize(menu);
481                         menu->parent = parent;
482                         last_menu = menu;
483                 }
484                 expr_free(basedep);
485                 if (last_menu) {
486                         parent->list = parent->next;
487                         parent->next = last_menu->next;
488                         last_menu->next = NULL;
489                 }
490
491                 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
492         }
493         for (menu = parent->list; menu; menu = menu->next) {
494                 if (sym && sym_is_choice(sym) &&
495                     menu->sym && !sym_is_choice_value(menu->sym)) {
496                         current_entry = menu;
497                         menu->sym->flags |= SYMBOL_CHOICEVAL;
498                         if (!menu->prompt)
499                                 menu_warn(menu, "choice value must have a prompt");
500                         for (prop = menu->sym->prop; prop; prop = prop->next) {
501                                 if (prop->type == P_DEFAULT)
502                                         prop_warn(prop, "defaults for choice "
503                                                   "values not supported");
504                                 if (prop->menu == menu)
505                                         continue;
506                                 if (prop->type == P_PROMPT &&
507                                     prop->menu->parent->sym != sym)
508                                         prop_warn(prop, "choice value used outside its choice group");
509                         }
510                         /* Non-tristate choice values of tristate choices must
511                          * depend on the choice being set to Y. The choice
512                          * values' dependencies were propagated to their
513                          * properties above, so the change here must be re-
514                          * propagated.
515                          */
516                         if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
517                                 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
518                                 menu->dep = expr_alloc_and(basedep, menu->dep);
519                                 for (prop = menu->sym->prop; prop; prop = prop->next) {
520                                         if (prop->menu != menu)
521                                                 continue;
522                                         prop->visible.expr = expr_alloc_and(expr_copy(basedep),
523                                                                             prop->visible.expr);
524                                 }
525                         }
526                         menu_add_symbol(P_CHOICE, sym, NULL);
527                         prop = sym_get_choice_prop(sym);
528                         for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
529                                 ;
530                         *ep = expr_alloc_one(E_LIST, NULL);
531                         (*ep)->right.sym = menu->sym;
532                 }
533                 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
534                         for (last_menu = menu->list; ; last_menu = last_menu->next) {
535                                 last_menu->parent = parent;
536                                 if (!last_menu->next)
537                                         break;
538                         }
539                         last_menu->next = menu->next;
540                         menu->next = menu->list;
541                         menu->list = NULL;
542                 }
543         }
544
545         if (sym && !(sym->flags & SYMBOL_WARNED)) {
546                 if (sym->type == S_UNKNOWN)
547                         menu_warn(parent, "config symbol defined without type");
548
549                 if (sym_is_choice(sym) && !parent->prompt)
550                         menu_warn(parent, "choice must have a prompt");
551
552                 /* Check properties connected to this symbol */
553                 sym_check_prop(sym);
554                 sym->flags |= SYMBOL_WARNED;
555         }
556
557         if (sym && !sym_is_optional(sym) && parent->prompt) {
558                 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
559                                 expr_alloc_and(parent->prompt->visible.expr,
560                                         expr_alloc_symbol(&symbol_mod)));
561         }
562 }
563
564 bool menu_has_prompt(struct menu *menu)
565 {
566         if (!menu->prompt)
567                 return false;
568         return true;
569 }
570
571 /*
572  * Determine if a menu is empty.
573  * A menu is considered empty if it contains no or only
574  * invisible entries.
575  */
576 bool menu_is_empty(struct menu *menu)
577 {
578         struct menu *child;
579
580         for (child = menu->list; child; child = child->next) {
581                 if (menu_is_visible(child))
582                         return(false);
583         }
584         return(true);
585 }
586
587 bool menu_is_visible(struct menu *menu)
588 {
589         struct menu *child;
590         struct symbol *sym;
591         tristate visible;
592
593         if (!menu->prompt)
594                 return false;
595
596         if (menu->visibility) {
597                 if (expr_calc_value(menu->visibility) == no)
598                         return false;
599         }
600
601         sym = menu->sym;
602         if (sym) {
603                 sym_calc_value(sym);
604                 visible = menu->prompt->visible.tri;
605         } else
606                 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
607
608         if (visible != no)
609                 return true;
610
611         if (!sym || sym_get_tristate_value(menu->sym) == no)
612                 return false;
613
614         for (child = menu->list; child; child = child->next) {
615                 if (menu_is_visible(child)) {
616                         if (sym)
617                                 sym->flags |= SYMBOL_DEF_USER;
618                         return true;
619                 }
620         }
621
622         return false;
623 }
624
625 const char *menu_get_prompt(struct menu *menu)
626 {
627         if (menu->prompt)
628                 return menu->prompt->text;
629         else if (menu->sym)
630                 return menu->sym->name;
631         return NULL;
632 }
633
634 struct menu *menu_get_root_menu(struct menu *menu)
635 {
636         return &rootmenu;
637 }
638
639 struct menu *menu_get_parent_menu(struct menu *menu)
640 {
641         enum prop_type type;
642
643         for (; menu != &rootmenu; menu = menu->parent) {
644                 type = menu->prompt ? menu->prompt->type : 0;
645                 if (type == P_MENU)
646                         break;
647         }
648         return menu;
649 }
650
651 bool menu_has_help(struct menu *menu)
652 {
653         return menu->help != NULL;
654 }
655
656 const char *menu_get_help(struct menu *menu)
657 {
658         if (menu->help)
659                 return menu->help;
660         else
661                 return "";
662 }
663
664 static void get_prompt_str(struct gstr *r, struct property *prop,
665                            struct list_head *head)
666 {
667         int i, j;
668         struct menu *submenu[8], *menu, *location = NULL;
669         struct jump_key *jump = NULL;
670
671         str_printf(r, _("Prompt: %s\n"), _(prop->text));
672         menu = prop->menu->parent;
673         for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
674                 bool accessible = menu_is_visible(menu);
675
676                 submenu[i++] = menu;
677                 if (location == NULL && accessible)
678                         location = menu;
679         }
680         if (head && location) {
681                 jump = xmalloc(sizeof(struct jump_key));
682
683                 if (menu_is_visible(prop->menu)) {
684                         /*
685                          * There is not enough room to put the hint at the
686                          * beginning of the "Prompt" line. Put the hint on the
687                          * last "Location" line even when it would belong on
688                          * the former.
689                          */
690                         jump->target = prop->menu;
691                 } else
692                         jump->target = location;
693
694                 if (list_empty(head))
695                         jump->index = 0;
696                 else
697                         jump->index = list_entry(head->prev, struct jump_key,
698                                                  entries)->index + 1;
699
700                 list_add_tail(&jump->entries, head);
701         }
702
703         if (i > 0) {
704                 str_printf(r, _("  Location:\n"));
705                 for (j = 4; --i >= 0; j += 2) {
706                         menu = submenu[i];
707                         if (jump && menu == location)
708                                 jump->offset = strlen(r->s);
709                         str_printf(r, "%*c-> %s", j, ' ',
710                                    _(menu_get_prompt(menu)));
711                         if (menu->sym) {
712                                 str_printf(r, " (%s [=%s])", menu->sym->name ?
713                                         menu->sym->name : _("<choice>"),
714                                         sym_get_string_value(menu->sym));
715                         }
716                         str_append(r, "\n");
717                 }
718         }
719 }
720
721 /*
722  * get property of type P_SYMBOL
723  */
724 static struct property *get_symbol_prop(struct symbol *sym)
725 {
726         struct property *prop = NULL;
727
728         for_all_properties(sym, prop, P_SYMBOL)
729                 break;
730         return prop;
731 }
732
733 static void get_symbol_props_str(struct gstr *r, struct symbol *sym,
734                                  enum prop_type tok, const char *prefix)
735 {
736         bool hit = false;
737         struct property *prop;
738
739         for_all_properties(sym, prop, tok) {
740                 if (!hit) {
741                         str_append(r, prefix);
742                         hit = true;
743                 } else
744                         str_printf(r, " && ");
745                 expr_gstr_print(prop->expr, r);
746         }
747         if (hit)
748                 str_append(r, "\n");
749 }
750
751 /*
752  * head is optional and may be NULL
753  */
754 static void get_symbol_str(struct gstr *r, struct symbol *sym,
755                     struct list_head *head)
756 {
757         struct property *prop;
758
759         if (sym && sym->name) {
760                 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
761                            sym_get_string_value(sym));
762                 str_printf(r, "Type  : %s\n", sym_type_name(sym->type));
763                 if (sym->type == S_INT || sym->type == S_HEX) {
764                         prop = sym_get_range_prop(sym);
765                         if (prop) {
766                                 str_printf(r, "Range : ");
767                                 expr_gstr_print(prop->expr, r);
768                                 str_append(r, "\n");
769                         }
770                 }
771         }
772         for_all_prompts(sym, prop)
773                 get_prompt_str(r, prop, head);
774
775         prop = get_symbol_prop(sym);
776         if (prop) {
777                 str_printf(r, _("  Defined at %s:%d\n"), prop->menu->file->name,
778                         prop->menu->lineno);
779                 if (!expr_is_yes(prop->visible.expr)) {
780                         str_append(r, _("  Depends on: "));
781                         expr_gstr_print(prop->visible.expr, r);
782                         str_append(r, "\n");
783                 }
784         }
785
786         get_symbol_props_str(r, sym, P_SELECT, _("  Selects: "));
787         if (sym->rev_dep.expr) {
788                 str_append(r, _("  Selected by: "));
789                 expr_gstr_print(sym->rev_dep.expr, r);
790                 str_append(r, "\n");
791         }
792
793         get_symbol_props_str(r, sym, P_IMPLY, _("  Implies: "));
794         if (sym->implied.expr) {
795                 str_append(r, _("  Implied by: "));
796                 expr_gstr_print(sym->implied.expr, r);
797                 str_append(r, "\n");
798         }
799
800         str_append(r, "\n\n");
801 }
802
803 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
804 {
805         struct symbol *sym;
806         struct gstr res = str_new();
807         int i;
808
809         for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
810                 get_symbol_str(&res, sym, head);
811         if (!i)
812                 str_append(&res, _("No matches found.\n"));
813         return res;
814 }
815
816
817 void menu_get_ext_help(struct menu *menu, struct gstr *help)
818 {
819         struct symbol *sym = menu->sym;
820         const char *help_text = nohelp_text;
821
822         if (menu_has_help(menu)) {
823                 if (sym->name)
824                         str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
825                 help_text = menu_get_help(menu);
826         }
827         str_printf(help, "%s\n", _(help_text));
828         if (sym)
829                 get_symbol_str(help, sym, NULL);
830 }