kconfig/menu.c
author "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
Sun May 08 15:12:55 2011 +0200 (2011-05-08)
changeset 2450 68cc5a0d3191
parent 2448 a103abae1560
child 2451 d83221161129
permissions -rw-r--r--
kconfig: don't trim spaces with leading pipe

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