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