config/menu.c

   1 /*
   2  * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
   3  * Released under the terms of the GNU GPL v2.0.
   4  */
   5
   6 #include <ctype.h>
   7 #include <stdarg.h>
   8 #include <stdlib.h>
   9 #include <string.h>
  10
  11 #include "lkc.h"
  12
  13 static const char nohelp_text[] = "There is no help available for this option.";
  14
  15 struct menu rootmenu;
  16 static struct menu **last_entry_ptr;
  17
  18 struct file *file_list;
  19 struct file *current_file;
  20
  21 void menu_warn(struct menu *menu, const char *fmt, ...)
  22 {
  23         va_list ap;
  24         va_start(ap, fmt);
  25         fprintf(stderr, "%s:%d:warning: ", menu->file->name, menu->lineno);
  26         vfprintf(stderr, fmt, ap);
  27         fprintf(stderr, "\n");
  28         va_end(ap);
  29 }
  30
  31 static void prop_warn(struct property *prop, const char *fmt, ...)
  32 {
  33         va_list ap;
  34         va_start(ap, fmt);
  35         fprintf(stderr, "%s:%d:warning: ", prop->file->name, prop->lineno);
  36         vfprintf(stderr, fmt, ap);
  37         fprintf(stderr, "\n");
  38         va_end(ap);
  39 }
  40
  41 void _menu_init(void)
  42 {
  43         current_entry = current_menu = &rootmenu;
  44         last_entry_ptr = &rootmenu.list;
  45 }
  46
  47 void menu_add_entry(struct symbol *sym)
  48 {
  49         struct menu *menu;
  50
  51         menu = xmalloc(sizeof(*menu));
  52         memset(menu, 0, sizeof(*menu));
  53         menu->sym = sym;
  54         menu->parent = current_menu;
  55         menu->file = current_file;
  56         menu->lineno = zconf_lineno();
  57
  58         *last_entry_ptr = menu;
  59         last_entry_ptr = &menu->next;
  60         current_entry = menu;
  61         if (sym)
  62                 menu_add_symbol(P_SYMBOL, sym, NULL);
  63 }
  64
  65 void menu_end_entry(void)
  66 {
  67 }
  68
  69 struct menu *menu_add_menu(void)
  70 {
  71         menu_end_entry();
  72         last_entry_ptr = &current_entry->list;
  73         return current_menu = current_entry;
  74 }
  75
  76 void menu_end_menu(void)
  77 {
  78         last_entry_ptr = &current_menu->next;
  79         current_menu = current_menu->parent;
  80 }
  81
  82 static struct expr *menu_check_dep(struct expr *e)
  83 {
  84         if (!e)
  85                 return e;
  86
  87         switch (e->type) {
  88         case E_NOT:
  89                 e->left.expr = menu_check_dep(e->left.expr);
  90                 break;
  91         case E_OR:
  92         case E_AND:
  93                 e->left.expr = menu_check_dep(e->left.expr);
  94                 e->right.expr = menu_check_dep(e->right.expr);
  95                 break;
  96         case E_SYMBOL:
  97                 /* change 'm' into 'm' && MODULES */
  98                 if (e->left.sym == &symbol_mod)
  99                         return expr_alloc_and(e, expr_alloc_symbol(modules_sym));
 100                 break;
 101         default:
 102                 break;
 103         }
 104         return e;
 105 }
 106
 107 void menu_add_dep(struct expr *dep)
 108 {
 109         current_entry->dep = expr_alloc_and(current_entry->dep, menu_check_dep(dep));
 110 }
 111
 112 void menu_set_type(int type)
 113 {
 114         struct symbol *sym = current_entry->sym;
 115
 116         if (sym->type == type)
 117                 return;
 118         if (sym->type == S_UNKNOWN) {
 119                 sym->type = type;
 120                 return;
 121         }
 122         menu_warn(current_entry, "type of '%s' redefined from '%s' to '%s'",
 123             sym->name ? sym->name : "<choice>",
 124             sym_type_name(sym->type), sym_type_name(type));
 125 }
 126
 127 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 = menu_check_dep(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                 modules_sym = current_entry->sym;
 203                 break;
 204         case T_OPT_DEFCONFIG_LIST:
 205                 if (!sym_defconfig_list)
 206                         sym_defconfig_list = current_entry->sym;
 207                 else if (sym_defconfig_list != current_entry->sym)
 208                         zconf_error("trying to redefine defconfig symbol");
 209                 break;
 210         case T_OPT_ENV:
 211                 prop_add_env(arg);
 212                 break;
 213         }
 214 }
 215
 216 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
 217 {
 218         return sym2->type == S_INT || sym2->type == S_HEX ||
 219                (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
 220 }
 221
 222 static void sym_check_prop(struct symbol *sym)
 223 {
 224         struct property *prop;
 225         struct symbol *sym2;
 226         for (prop = sym->prop; prop; prop = prop->next) {
 227                 switch (prop->type) {
 228                 case P_DEFAULT:
 229                         if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
 230                             prop->expr->type != E_SYMBOL)
 231                                 prop_warn(prop,
 232                                     "default for config symbol '%s'"
 233                                     " must be a single symbol", sym->name);
 234                         if (prop->expr->type != E_SYMBOL)
 235                                 break;
 236                         sym2 = prop_get_symbol(prop);
 237                         if (sym->type == S_HEX || sym->type == S_INT) {
 238                                 if (!menu_validate_number(sym, sym2))
 239                                         prop_warn(prop,
 240                                             "'%s': number is invalid",
 241                                             sym->name);
 242                         }
 243                         break;
 244                 case P_SELECT:
 245                         sym2 = prop_get_symbol(prop);
 246                         if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
 247                                 prop_warn(prop,
 248                                     "config symbol '%s' uses select, but is "
 249                                     "not boolean or tristate", sym->name);
 250                         else if (sym2->type != S_UNKNOWN &&
 251                                  sym2->type != S_BOOLEAN &&
 252                                  sym2->type != S_TRISTATE)
 253                                 prop_warn(prop,
 254                                     "'%s' has wrong type. 'select' only "
 255                                     "accept arguments of boolean and "
 256                                     "tristate type", sym2->name);
 257                         break;
 258                 case P_RANGE:
 259                         if (sym->type != S_INT && sym->type != S_HEX)
 260                                 prop_warn(prop, "range is only allowed "
 261                                                 "for int or hex symbols");
 262                         if (!menu_validate_number(sym, prop->expr->left.sym) ||
 263                             !menu_validate_number(sym, prop->expr->right.sym))
 264                                 prop_warn(prop, "range is invalid");
 265                         break;
 266                 default:
 267                         ;
 268                 }
 269         }
 270 }
 271
 272 void menu_finalize(struct menu *parent)
 273 {
 274         struct menu *menu, *last_menu;
 275         struct symbol *sym;
 276         struct property *prop;
 277         struct expr *parentdep, *basedep, *dep, *dep2, **ep;
 278
 279         sym = parent->sym;
 280         if (parent->list) {
 281                 if (sym && sym_is_choice(sym)) {
 282                         if (sym->type == S_UNKNOWN) {
 283                                 /* find the first choice value to find out choice type */
 284                                 current_entry = parent;
 285                                 for (menu = parent->list; menu; menu = menu->next) {
 286                                         if (menu->sym && menu->sym->type != S_UNKNOWN) {
 287                                                 menu_set_type(menu->sym->type);
 288                                                 break;
 289                                         }
 290                                 }
 291                         }
 292                         /* set the type of the remaining choice values */
 293                         for (menu = parent->list; menu; menu = menu->next) {
 294                                 current_entry = menu;
 295                                 if (menu->sym && menu->sym->type == S_UNKNOWN)
 296                                         menu_set_type(sym->type);
 297                         }
 298                         parentdep = expr_alloc_symbol(sym);
 299                 } else if (parent->prompt)
 300                         parentdep = parent->prompt->visible.expr;
 301                 else
 302                         parentdep = parent->dep;
 303
 304                 for (menu = parent->list; menu; menu = menu->next) {
 305                         basedep = expr_transform(menu->dep);
 306                         basedep = expr_alloc_and(expr_copy(parentdep), basedep);
 307                         basedep = expr_eliminate_dups(basedep);
 308                         menu->dep = basedep;
 309                         if (menu->sym)
 310                                 prop = menu->sym->prop;
 311                         else
 312                                 prop = menu->prompt;
 313                         for (; prop; prop = prop->next) {
 314                                 if (prop->menu != menu)
 315                                         continue;
 316                                 dep = expr_transform(prop->visible.expr);
 317                                 dep = expr_alloc_and(expr_copy(basedep), dep);
 318                                 dep = expr_eliminate_dups(dep);
 319                                 if (menu->sym && menu->sym->type != S_TRISTATE)
 320                                         dep = expr_trans_bool(dep);
 321                                 prop->visible.expr = dep;
 322                                 if (prop->type == P_SELECT) {
 323                                         struct symbol *es = prop_get_symbol(prop);
 324                                         es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
 325                                                         expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
 326                                 }
 327                         }
 328                 }
 329                 for (menu = parent->list; menu; menu = menu->next)
 330                         menu_finalize(menu);
 331         } else if (sym) {
 332                 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
 333                 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
 334                 basedep = expr_eliminate_dups(expr_transform(basedep));
 335                 last_menu = NULL;
 336                 for (menu = parent->next; menu; menu = menu->next) {
 337                         dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
 338                         if (!expr_contains_symbol(dep, sym))
 339                                 break;
 340                         if (expr_depends_symbol(dep, sym))
 341                                 goto next;
 342                         dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
 343                         dep = expr_eliminate_dups(expr_transform(dep));
 344                         dep2 = expr_copy(basedep);
 345                         expr_eliminate_eq(&dep, &dep2);
 346                         expr_free(dep);
 347                         if (!expr_is_yes(dep2)) {
 348                                 expr_free(dep2);
 349                                 break;
 350                         }
 351                         expr_free(dep2);
 352                 next:
 353                         menu_finalize(menu);
 354                         menu->parent = parent;
 355                         last_menu = menu;
 356                 }
 357                 if (last_menu) {
 358                         parent->list = parent->next;
 359                         parent->next = last_menu->next;
 360                         last_menu->next = NULL;
 361                 }
 362
 363                 sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
 364         }
 365         for (menu = parent->list; menu; menu = menu->next) {
 366                 if (sym && sym_is_choice(sym) &&
 367                     menu->sym && !sym_is_choice_value(menu->sym)) {
 368                         current_entry = menu;
 369                         menu->sym->flags |= SYMBOL_CHOICEVAL;
 370                         if (!menu->prompt)
 371                                 menu_warn(menu, "choice value must have a prompt");
 372                         for (prop = menu->sym->prop; prop; prop = prop->next) {
 373                                 if (prop->type == P_DEFAULT)
 374                                         prop_warn(prop, "defaults for choice "
 375                                                   "values not supported");
 376                                 if (prop->menu == menu)
 377                                         continue;
 378                                 if (prop->type == P_PROMPT &&
 379                                     prop->menu->parent->sym != sym)
 380                                         prop_warn(prop, "choice value used outside its choice group");
 381                         }
 382                         /* Non-tristate choice values of tristate choices must
 383                          * depend on the choice being set to Y. The choice
 384                          * values' dependencies were propagated to their
 385                          * properties above, so the change here must be re-
 386                          * propagated.
 387                          */
 388                         if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
 389                                 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
 390                                 menu->dep = expr_alloc_and(basedep, menu->dep);
 391                                 for (prop = menu->sym->prop; prop; prop = prop->next) {
 392                                         if (prop->menu != menu)
 393                                                 continue;
 394                                         prop->visible.expr = expr_alloc_and(expr_copy(basedep),
 395                                                                             prop->visible.expr);
 396                                 }
 397                         }
 398                         menu_add_symbol(P_CHOICE, sym, NULL);
 399                         prop = sym_get_choice_prop(sym);
 400                         for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
 401                                 ;
 402                         *ep = expr_alloc_one(E_LIST, NULL);
 403                         (*ep)->right.sym = menu->sym;
 404                 }
 405                 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
 406                         for (last_menu = menu->list; ; last_menu = last_menu->next) {
 407                                 last_menu->parent = parent;
 408                                 if (!last_menu->next)
 409                                         break;
 410                         }
 411                         last_menu->next = menu->next;
 412                         menu->next = menu->list;
 413                         menu->list = NULL;
 414                 }
 415         }
 416
 417         if (sym && !(sym->flags & SYMBOL_WARNED)) {
 418                 if (sym->type == S_UNKNOWN)
 419                         menu_warn(parent, "config symbol defined without type");
 420
 421                 if (sym_is_choice(sym) && !parent->prompt)
 422                         menu_warn(parent, "choice must have a prompt");
 423
 424                 /* Check properties connected to this symbol */
 425                 sym_check_prop(sym);
 426                 sym->flags |= SYMBOL_WARNED;
 427         }
 428
 429         if (sym && !sym_is_optional(sym) && parent->prompt) {
 430                 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
 431                                 expr_alloc_and(parent->prompt->visible.expr,
 432                                         expr_alloc_symbol(&symbol_mod)));
 433         }
 434 }
 435
 436 bool menu_has_prompt(struct menu *menu)
 437 {
 438         if (!menu->prompt)
 439                 return false;
 440         return true;
 441 }
 442
 443 /*
 444  * Determine if a menu is empty.
 445  * A menu is considered empty if it contains no or only
 446  * invisible entries.
 447  */
 448 bool menu_is_empty(struct menu *menu)
 449 {
 450         struct menu *child;
 451
 452         for (child = menu->list; child; child = child->next) {
 453                 if (menu_is_visible(child))
 454                         return(false);
 455         }
 456         return(true);
 457 }
 458
 459 bool menu_is_visible(struct menu *menu)
 460 {
 461         struct menu *child;
 462         struct symbol *sym;
 463         tristate visible;
 464
 465         if (!menu->prompt)
 466                 return false;
 467
 468         if (menu->visibility) {
 469                 if (expr_calc_value(menu->visibility) == no)
 470                         return no;
 471         }
 472
 473         sym = menu->sym;
 474         if (sym) {
 475                 sym_calc_value(sym);
 476                 visible = menu->prompt->visible.tri;
 477         } else
 478                 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
 479
 480         if (visible != no)
 481                 return true;
 482
 483         if (!sym || sym_get_tristate_value(menu->sym) == no)
 484                 return false;
 485
 486         for (child = menu->list; child; child = child->next) {
 487                 if (menu_is_visible(child)) {
 488                         if (sym)
 489                                 sym->flags |= SYMBOL_DEF_USER;
 490                         return true;
 491                 }
 492         }
 493
 494         return false;
 495 }
 496
 497 const char *menu_get_prompt(struct menu *menu)
 498 {
 499         if (menu->prompt)
 500                 return menu->prompt->text;
 501         else if (menu->sym)
 502                 return menu->sym->name;
 503         return NULL;
 504 }
 505
 506 struct menu *menu_get_root_menu(struct menu *menu)
 507 {
 508         return &rootmenu;
 509 }
 510
 511 struct menu *menu_get_parent_menu(struct menu *menu)
 512 {
 513         enum prop_type type;
 514
 515         for (; menu != &rootmenu; menu = menu->parent) {
 516                 type = menu->prompt ? menu->prompt->type : 0;
 517                 if (type == P_MENU)
 518                         break;
 519         }
 520         return menu;
 521 }
 522
 523 bool menu_has_help(struct menu *menu)
 524 {
 525         return menu->help != NULL;
 526 }
 527
 528 const char *menu_get_help(struct menu *menu)
 529 {
 530         if (menu->help)
 531                 return menu->help;
 532         else
 533                 return "";
 534 }
 535
 536 static void get_prompt_str(struct gstr *r, struct property *prop,
 537                            struct list_head *head)
 538 {
 539         int i, j;
 540         struct menu *submenu[8], *menu, *location = NULL;
 541         struct jump_key *jump;
 542
 543         str_printf(r, _("Prompt: %s\n"), _(prop->text));
 544         menu = prop->menu->parent;
 545         for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
 546                 bool accessible = menu_is_visible(menu);
 547
 548                 submenu[i++] = menu;
 549                 if (location == NULL && accessible)
 550                         location = menu;
 551         }
 552         if (head && location) {
 553                 jump = xmalloc(sizeof(struct jump_key));
 554
 555                 if (menu_is_visible(prop->menu)) {
 556                         /*
 557                          * There is not enough room to put the hint at the
 558                          * beginning of the "Prompt" line. Put the hint on the
 559                          * last "Location" line even when it would belong on
 560                          * the former.
 561                          */
 562                         jump->target = prop->menu;
 563                 } else
 564                         jump->target = location;
 565
 566                 if (list_empty(head))
 567                         jump->index = 0;
 568                 else
 569                         jump->index = list_entry(head->prev, struct jump_key,
 570                                                  entries)->index + 1;
 571
 572                 list_add_tail(&jump->entries, head);
 573         }
 574
 575         if (i > 0) {
 576                 str_printf(r, _("  Location:\n"));
 577                 for (j = 4; --i >= 0; j += 2) {
 578                         menu = submenu[i];
 579                         if (head && location && menu == location)
 580                                 jump->offset = r->len - 1;
 581                         str_printf(r, "%*c-> %s", j, ' ',
 582                                    _(menu_get_prompt(menu)));
 583                         if (menu->sym) {
 584                                 str_printf(r, " (%s [=%s])", menu->sym->name ?
 585                                         menu->sym->name : _("<choice>"),
 586                                         sym_get_string_value(menu->sym));
 587                         }
 588                         str_append(r, "\n");
 589                 }
 590         }
 591 }
 592
 593 /*
 594  * get peoperty of type P_SYMBOL
 595  */
 596 static struct property *get_symbol_prop(struct symbol *sym)
 597 {
 598         struct property *prop = NULL;
 599
 600         for_all_properties(sym, prop, P_SYMBOL)
 601                 break;
 602         return prop;
 603 }
 604
 605 /*
 606  * head is optional and may be NULL
 607  */
 608 void get_symbol_str(struct gstr *r, struct symbol *sym,
 609                     struct list_head *head)
 610 {
 611         bool hit;
 612         struct property *prop;
 613
 614         if (sym && sym->name) {
 615                 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
 616                            sym_get_string_value(sym));
 617                 str_printf(r, "Type  : %s\n", sym_type_name(sym->type));
 618                 if (sym->type == S_INT || sym->type == S_HEX) {
 619                         prop = sym_get_range_prop(sym);
 620                         if (prop) {
 621                                 str_printf(r, "Range : ");
 622                                 expr_gstr_print(prop->expr, r);
 623                                 str_append(r, "\n");
 624                         }
 625                 }
 626         }
 627         for_all_prompts(sym, prop)
 628                 get_prompt_str(r, prop, head);
 629
 630         prop = get_symbol_prop(sym);
 631         if (prop) {
 632                 str_printf(r, _("  Defined at %s:%d\n"), prop->menu->file->name,
 633                         prop->menu->lineno);
 634                 if (!expr_is_yes(prop->visible.expr)) {
 635                         str_append(r, _("  Depends on: "));
 636                         expr_gstr_print(prop->visible.expr, r);
 637                         str_append(r, "\n");
 638                 }
 639         }
 640
 641         hit = false;
 642         for_all_properties(sym, prop, P_SELECT) {
 643                 if (!hit) {
 644                         str_append(r, "  Selects: ");
 645                         hit = true;
 646                 } else
 647                         str_printf(r, " && ");
 648                 expr_gstr_print(prop->expr, r);
 649         }
 650         if (hit)
 651                 str_append(r, "\n");
 652         if (sym->rev_dep.expr) {
 653                 str_append(r, _("  Selected by: "));
 654                 expr_gstr_print(sym->rev_dep.expr, r);
 655                 str_append(r, "\n");
 656         }
 657         str_append(r, "\n\n");
 658 }
 659
 660 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
 661 {
 662         struct symbol *sym;
 663         struct gstr res = str_new();
 664         int i;
 665
 666         for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
 667                 get_symbol_str(&res, sym, head);
 668         if (!i)
 669                 str_append(&res, _("No matches found.\n"));
 670         return res;
 671 }
 672
 673
 674 void menu_get_ext_help(struct menu *menu, struct gstr *help)
 675 {
 676         struct symbol *sym = menu->sym;
 677         const char *help_text = nohelp_text;
 678
 679         if (menu_has_help(menu)) {
 680                 if (sym->name)
 681                         str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
 682                 help_text = menu_get_help(menu);
 683         }
 684         str_printf(help, "%s\n", _(help_text));
 685         if (sym)
 686                 get_symbol_str(help, sym, NULL);
 687 }