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