config/menu.c

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