scripts/kconfig/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 <stdlib.h>
   7 #include <string.h>
   8
   9 #define LKC_DIRECT_LINK
  10 #include "lkc.h"
  11
  12 static const char nohelp_text[] = N_(
  13         "There is no help available for this option.\n");
  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 = malloc(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                 current_entry->prompt = prop;
 144         }
 145         prop->text = prompt;
 146
 147         return prop;
 148 }
 149
 150 struct property *menu_add_prompt(enum prop_type type, char *prompt, struct expr *dep)
 151 {
 152         return menu_add_prop(type, prompt, NULL, dep);
 153 }
 154
 155 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
 156 {
 157         menu_add_prop(type, NULL, expr, dep);
 158 }
 159
 160 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
 161 {
 162         menu_add_prop(type, NULL, expr_alloc_symbol(sym), dep);
 163 }
 164
 165 void menu_add_option(int token, char *arg)
 166 {
 167         struct property *prop;
 168
 169         switch (token) {
 170         case T_OPT_MODULES:
 171                 prop = prop_alloc(P_DEFAULT, modules_sym);
 172                 prop->expr = expr_alloc_symbol(current_entry->sym);
 173                 break;
 174         case T_OPT_DEFCONFIG_LIST:
 175                 if (!sym_defconfig_list)
 176                         sym_defconfig_list = current_entry->sym;
 177                 else if (sym_defconfig_list != current_entry->sym)
 178                         zconf_error("trying to redefine defconfig symbol");
 179                 break;
 180         case T_OPT_ENV:
 181                 prop_add_env(arg);
 182                 break;
 183         }
 184 }
 185
 186 static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
 187 {
 188         return sym2->type == S_INT || sym2->type == S_HEX ||
 189                (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
 190 }
 191
 192 static void sym_check_prop(struct symbol *sym)
 193 {
 194         struct property *prop;
 195         struct symbol *sym2;
 196         for (prop = sym->prop; prop; prop = prop->next) {
 197                 switch (prop->type) {
 198                 case P_DEFAULT:
 199                         if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
 200                             prop->expr->type != E_SYMBOL)
 201                                 prop_warn(prop,
 202                                     "default for config symbol '%s'"
 203                                     " must be a single symbol", sym->name);
 204                         if (prop->expr->type != E_SYMBOL)
 205                                 break;
 206                         sym2 = prop_get_symbol(prop);
 207                         if (sym->type == S_HEX || sym->type == S_INT) {
 208                                 if (!menu_validate_number(sym, sym2))
 209                                         prop_warn(prop,
 210                                             "'%s': number is invalid",
 211                                             sym->name);
 212                         }
 213                         break;
 214                 case P_SELECT:
 215                         sym2 = prop_get_symbol(prop);
 216                         if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
 217                                 prop_warn(prop,
 218                                     "config symbol '%s' uses select, but is "
 219                                     "not boolean or tristate", sym->name);
 220                         else if (sym2->type != S_UNKNOWN &&
 221                                  sym2->type != S_BOOLEAN &&
 222                                  sym2->type != S_TRISTATE)
 223                                 prop_warn(prop,
 224                                     "'%s' has wrong type. 'select' only "
 225                                     "accept arguments of boolean and "
 226                                     "tristate type", sym2->name);
 227                         break;
 228                 case P_RANGE:
 229                         if (sym->type != S_INT && sym->type != S_HEX)
 230                                 prop_warn(prop, "range is only allowed "
 231                                                 "for int or hex symbols");
 232                         if (!menu_validate_number(sym, prop->expr->left.sym) ||
 233                             !menu_validate_number(sym, prop->expr->right.sym))
 234                                 prop_warn(prop, "range is invalid");
 235                         break;
 236                 default:
 237                         ;
 238                 }
 239         }
 240 }
 241
 242 void menu_finalize(struct menu *parent)
 243 {
 244         struct menu *menu, *last_menu;
 245         struct symbol *sym;
 246         struct property *prop;
 247         struct expr *parentdep, *basedep, *dep, *dep2, **ep;
 248
 249         sym = parent->sym;
 250         if (parent->list) {
 251                 if (sym && sym_is_choice(sym)) {
 252                         if (sym->type == S_UNKNOWN) {
 253                                 /* find the first choice value to find out choice type */
 254                                 current_entry = parent;
 255                                 for (menu = parent->list; menu; menu = menu->next) {
 256                                         if (menu->sym && menu->sym->type != S_UNKNOWN) {
 257                                                 menu_set_type(menu->sym->type);
 258                                                 break;
 259                                         }
 260                                 }
 261                         }
 262                         /* set the type of the remaining choice values */
 263                         for (menu = parent->list; menu; menu = menu->next) {
 264                                 current_entry = menu;
 265                                 if (menu->sym && menu->sym->type == S_UNKNOWN)
 266                                         menu_set_type(sym->type);
 267                         }
 268                         parentdep = expr_alloc_symbol(sym);
 269                 } else if (parent->prompt)
 270                         parentdep = parent->prompt->visible.expr;
 271                 else
 272                         parentdep = parent->dep;
 273
 274                 for (menu = parent->list; menu; menu = menu->next) {
 275                         basedep = expr_transform(menu->dep);
 276                         basedep = expr_alloc_and(expr_copy(parentdep), basedep);
 277                         basedep = expr_eliminate_dups(basedep);
 278                         menu->dep = basedep;
 279                         if (menu->sym)
 280                                 prop = menu->sym->prop;
 281                         else
 282                                 prop = menu->prompt;
 283                         for (; prop; prop = prop->next) {
 284                                 if (prop->menu != menu)
 285                                         continue;
 286                                 dep = expr_transform(prop->visible.expr);
 287                                 dep = expr_alloc_and(expr_copy(basedep), dep);
 288                                 dep = expr_eliminate_dups(dep);
 289                                 if (menu->sym && menu->sym->type != S_TRISTATE)
 290                                         dep = expr_trans_bool(dep);
 291                                 prop->visible.expr = dep;
 292                                 if (prop->type == P_SELECT) {
 293                                         struct symbol *es = prop_get_symbol(prop);
 294                                         es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
 295                                                         expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
 296                                 }
 297                         }
 298                 }
 299                 for (menu = parent->list; menu; menu = menu->next)
 300                         menu_finalize(menu);
 301         } else if (sym) {
 302                 basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
 303                 basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
 304                 basedep = expr_eliminate_dups(expr_transform(basedep));
 305                 last_menu = NULL;
 306                 for (menu = parent->next; menu; menu = menu->next) {
 307                         dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
 308                         if (!expr_contains_symbol(dep, sym))
 309                                 break;
 310                         if (expr_depends_symbol(dep, sym))
 311                                 goto next;
 312                         dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
 313                         dep = expr_eliminate_dups(expr_transform(dep));
 314                         dep2 = expr_copy(basedep);
 315                         expr_eliminate_eq(&dep, &dep2);
 316                         expr_free(dep);
 317                         if (!expr_is_yes(dep2)) {
 318                                 expr_free(dep2);
 319                                 break;
 320                         }
 321                         expr_free(dep2);
 322                 next:
 323                         menu_finalize(menu);
 324                         menu->parent = parent;
 325                         last_menu = menu;
 326                 }
 327                 if (last_menu) {
 328                         parent->list = parent->next;
 329                         parent->next = last_menu->next;
 330                         last_menu->next = NULL;
 331                 }
 332
 333                 sym->dir_dep.expr = parent->dep;
 334         }
 335         for (menu = parent->list; menu; menu = menu->next) {
 336                 if (sym && sym_is_choice(sym) &&
 337                     menu->sym && !sym_is_choice_value(menu->sym)) {
 338                         current_entry = menu;
 339                         menu->sym->flags |= SYMBOL_CHOICEVAL;
 340                         if (!menu->prompt)
 341                                 menu_warn(menu, "choice value must have a prompt");
 342                         for (prop = menu->sym->prop; prop; prop = prop->next) {
 343                                 if (prop->type == P_DEFAULT)
 344                                         prop_warn(prop, "defaults for choice "
 345                                                   "values not supported");
 346                                 if (prop->menu == menu)
 347                                         continue;
 348                                 if (prop->type == P_PROMPT &&
 349                                     prop->menu->parent->sym != sym)
 350                                         prop_warn(prop, "choice value used outside its choice group");
 351                         }
 352                         /* Non-tristate choice values of tristate choices must
 353                          * depend on the choice being set to Y. The choice
 354                          * values' dependencies were propagated to their
 355                          * properties above, so the change here must be re-
 356                          * propagated.
 357                          */
 358                         if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
 359                                 basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
 360                                 menu->dep = expr_alloc_and(basedep, menu->dep);
 361                                 for (prop = menu->sym->prop; prop; prop = prop->next) {
 362                                         if (prop->menu != menu)
 363                                                 continue;
 364                                         prop->visible.expr = expr_alloc_and(expr_copy(basedep),
 365                                                                             prop->visible.expr);
 366                                 }
 367                         }
 368                         menu_add_symbol(P_CHOICE, sym, NULL);
 369                         prop = sym_get_choice_prop(sym);
 370                         for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
 371                                 ;
 372                         *ep = expr_alloc_one(E_LIST, NULL);
 373                         (*ep)->right.sym = menu->sym;
 374                 }
 375                 if (menu->list && (!menu->prompt || !menu->prompt->text)) {
 376                         for (last_menu = menu->list; ; last_menu = last_menu->next) {
 377                                 last_menu->parent = parent;
 378                                 if (!last_menu->next)
 379                                         break;
 380                         }
 381                         last_menu->next = menu->next;
 382                         menu->next = menu->list;
 383                         menu->list = NULL;
 384                 }
 385         }
 386
 387         if (sym && !(sym->flags & SYMBOL_WARNED)) {
 388                 if (sym->type == S_UNKNOWN)
 389                         menu_warn(parent, "config symbol defined without type");
 390
 391                 if (sym_is_choice(sym) && !parent->prompt)
 392                         menu_warn(parent, "choice must have a prompt");
 393
 394                 /* Check properties connected to this symbol */
 395                 sym_check_prop(sym);
 396                 sym->flags |= SYMBOL_WARNED;
 397         }
 398
 399         if (sym && !sym_is_optional(sym) && parent->prompt) {
 400                 sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
 401                                 expr_alloc_and(parent->prompt->visible.expr,
 402                                         expr_alloc_symbol(&symbol_mod)));
 403         }
 404 }
 405
 406 bool menu_has_prompt(struct menu *menu)
 407 {
 408         if (!menu->prompt)
 409                 return false;
 410         return true;
 411 }
 412
 413 bool menu_is_visible(struct menu *menu)
 414 {
 415         struct menu *child;
 416         struct symbol *sym;
 417         tristate visible;
 418
 419         if (!menu->prompt)
 420                 return false;
 421
 422         sym = menu->sym;
 423         if (sym) {
 424                 sym_calc_value(sym);
 425                 visible = menu->prompt->visible.tri;
 426         } else
 427                 visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
 428
 429         if (visible != no)
 430                 return true;
 431
 432         if (!sym || sym_get_tristate_value(menu->sym) == no)
 433                 return false;
 434
 435         for (child = menu->list; child; child = child->next) {
 436                 if (menu_is_visible(child)) {
 437                         if (sym)
 438                                 sym->flags |= SYMBOL_DEF_USER;
 439                         return true;
 440                 }
 441         }
 442
 443         return false;
 444 }
 445
 446 const char *menu_get_prompt(struct menu *menu)
 447 {
 448         if (menu->prompt)
 449                 return menu->prompt->text;
 450         else if (menu->sym)
 451                 return menu->sym->name;
 452         return NULL;
 453 }
 454
 455 struct menu *menu_get_root_menu(struct menu *menu)
 456 {
 457         return &rootmenu;
 458 }
 459
 460 struct menu *menu_get_parent_menu(struct menu *menu)
 461 {
 462         enum prop_type type;
 463
 464         for (; menu != &rootmenu; menu = menu->parent) {
 465                 type = menu->prompt ? menu->prompt->type : 0;
 466                 if (type == P_MENU)
 467                         break;
 468         }
 469         return menu;
 470 }
 471
 472 bool menu_has_help(struct menu *menu)
 473 {
 474         return menu->help != NULL;
 475 }
 476
 477 const char *menu_get_help(struct menu *menu)
 478 {
 479         if (menu->help)
 480                 return menu->help;
 481         else
 482                 return "";
 483 }
 484
 485 static void get_prompt_str(struct gstr *r, struct property *prop)
 486 {
 487         int i, j;
 488         struct menu *submenu[8], *menu;
 489
 490         str_printf(r, _("Prompt: %s\n"), _(prop->text));
 491         str_printf(r, _("  Defined at %s:%d\n"), prop->menu->file->name,
 492                 prop->menu->lineno);
 493         if (!expr_is_yes(prop->visible.expr)) {
 494                 str_append(r, _("  Depends on: "));
 495                 expr_gstr_print(prop->visible.expr, r);
 496                 str_append(r, "\n");
 497         }
 498         menu = prop->menu->parent;
 499         for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent)
 500                 submenu[i++] = menu;
 501         if (i > 0) {
 502                 str_printf(r, _("  Location:\n"));
 503                 for (j = 4; --i >= 0; j += 2) {
 504                         menu = submenu[i];
 505                         str_printf(r, "%*c-> %s", j, ' ', _(menu_get_prompt(menu)));
 506                         if (menu->sym) {
 507                                 str_printf(r, " (%s [=%s])", menu->sym->name ?
 508                                         menu->sym->name : _("<choice>"),
 509                                         sym_get_string_value(menu->sym));
 510                         }
 511                         str_append(r, "\n");
 512                 }
 513         }
 514 }
 515
 516 void get_symbol_str(struct gstr *r, struct symbol *sym)
 517 {
 518         bool hit;
 519         struct property *prop;
 520
 521         if (sym && sym->name) {
 522                 str_printf(r, "Symbol: %s [=%s]\n", sym->name,
 523                            sym_get_string_value(sym));
 524                 str_printf(r, "Type  : %s\n", sym_type_name(sym->type));
 525                 if (sym->type == S_INT || sym->type == S_HEX) {
 526                         prop = sym_get_range_prop(sym);
 527                         if (prop) {
 528                                 str_printf(r, "Range : ");
 529                                 expr_gstr_print(prop->expr, r);
 530                                 str_append(r, "\n");
 531                         }
 532                 }
 533         }
 534         for_all_prompts(sym, prop)
 535                 get_prompt_str(r, prop);
 536         hit = false;
 537         for_all_properties(sym, prop, P_SELECT) {
 538                 if (!hit) {
 539                         str_append(r, "  Selects: ");
 540                         hit = true;
 541                 } else
 542                         str_printf(r, " && ");
 543                 expr_gstr_print(prop->expr, r);
 544         }
 545         if (hit)
 546                 str_append(r, "\n");
 547         if (sym->rev_dep.expr) {
 548                 str_append(r, _("  Selected by: "));
 549                 expr_gstr_print(sym->rev_dep.expr, r);
 550                 str_append(r, "\n");
 551         }
 552         str_append(r, "\n\n");
 553 }
 554
 555 struct gstr get_relations_str(struct symbol **sym_arr)
 556 {
 557         struct symbol *sym;
 558         struct gstr res = str_new();
 559         int i;
 560
 561         for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
 562                 get_symbol_str(&res, sym);
 563         if (!i)
 564                 str_append(&res, _("No matches found.\n"));
 565         return res;
 566 }
 567
 568
 569 void menu_get_ext_help(struct menu *menu, struct gstr *help)
 570 {
 571         struct symbol *sym = menu->sym;
 572
 573         if (menu_has_help(menu)) {
 574                 if (sym->name) {
 575                         str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
 576                         str_append(help, _(menu_get_help(menu)));
 577                         str_append(help, "\n");
 578                 }
 579         } else {
 580                 str_append(help, nohelp_text);
 581         }
 582         if (sym)
 583                 get_symbol_str(help, sym);
 584 }