2 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
3 * Released under the terms of the GNU GPL v2.0.
5 * Introduced single menu mode (show all sub-menus in one large tree).
6 * 2002-11-06 Petr Baudis <pasky@ucw.cz>
8 * i18n, 2005, Arnaldo Carvalho de Melo <acme@conectiva.com.br>
23 #include "lxdialog/dialog.h"
25 static const char mconf_readme[] = N_(
28 "This interface let you select features and parameters for the build.\n"
29 "Features can either be built-in, modularized, or ignored. Parameters\n"
30 "must be entered in as decimal or hexadecimal numbers or text.\n"
32 "Menu items beginning with following braces represent features that\n"
33 " [ ] can be built in or removed\n"
34 " < > can be built in, modularized or removed\n"
35 " { } can be built in or modularized (selected by other feature)\n"
36 " - - are selected by other feature,\n"
37 "while *, M or whitespace inside braces means to build in, build as\n"
38 "a module or to exclude the feature respectively.\n"
40 "To change any of these features, highlight it with the cursor\n"
41 "keys and press <Y> to build it in, <M> to make it a module or\n"
42 "<N> to removed it. You may also press the <Space Bar> to cycle\n"
43 "through the available options (ie. Y->N->M->Y).\n"
45 "Some additional keyboard hints:\n"
49 "o Use the Up/Down arrow keys (cursor keys) to highlight the item\n"
50 " you wish to change or submenu wish to select and press <Enter>.\n"
51 " Submenus are designated by \"--->\".\n"
53 " Shortcut: Press the option's highlighted letter (hotkey).\n"
54 " Pressing a hotkey more than once will sequence\n"
55 " through all visible items which use that hotkey.\n"
57 " You may also use the <PAGE UP> and <PAGE DOWN> keys to scroll\n"
58 " unseen options into view.\n"
60 "o To exit a menu use the cursor keys to highlight the <Exit> button\n"
61 " and press <ENTER>.\n"
63 " Shortcut: Press <ESC><ESC> or <E> or <X> if there is no hotkey\n"
64 " using those letters. You may press a single <ESC>, but\n"
65 " there is a delayed response which you may find annoying.\n"
67 " Also, the <TAB> and cursor keys will cycle between <Select>,\n"
68 " <Exit> and <Help>.\n"
70 "o To get help with an item, use the cursor keys to highlight <Help>\n"
71 " and press <ENTER>.\n"
73 " Shortcut: Press <H> or <?>.\n"
75 "o To toggle the display of hidden options, press <Z>.\n"
78 "Radiolists (Choice lists)\n"
80 "o Use the cursor keys to select the option you wish to set and press\n"
81 " <S> or the <SPACE BAR>.\n"
83 " Shortcut: Press the first letter of the option you wish to set then\n"
84 " press <S> or <SPACE BAR>.\n"
86 "o To see available help for the item, use the cursor keys to highlight\n"
87 " <Help> and Press <ENTER>.\n"
89 " Shortcut: Press <H> or <?>.\n"
91 " Also, the <TAB> and cursor keys will cycle between <Select> and\n"
97 "o Enter the requested information and press <ENTER>\n"
98 " If you are entering hexadecimal values, it is not necessary to\n"
99 " add the '0x' prefix to the entry.\n"
101 "o For help, use the <TAB> or cursor keys to highlight the help option\n"
102 " and press <ENTER>. You can try <TAB><H> as well.\n"
105 "Text Box (Help Window)\n"
107 "o Use the cursor keys to scroll up/down/left/right. The VI editor\n"
108 " keys h,j,k,l function here as do <u>, <d>, <SPACE BAR> and <B> for \n"
109 " those who are familiar with less and lynx.\n"
111 "o Press <E>, <X>, <q>, <Enter> or <Esc><Esc> to exit.\n"
114 "Alternate Configuration Files\n"
115 "-----------------------------\n"
116 "Menuconfig supports the use of alternate configuration files for\n"
117 "those who, for various reasons, find it necessary to switch\n"
118 "between different configurations.\n"
120 "At the end of the main menu you will find two options. One is\n"
121 "for saving the current configuration to a file of your choosing.\n"
122 "The other option is for loading a previously saved alternate\n"
125 "Even if you don't use alternate configuration files, but you\n"
126 "find during a Menuconfig session that you have completely messed\n"
127 "up your settings, you may use the \"Load Alternate...\" option to\n"
128 "restore your previously saved settings from \".config\" without\n"
129 "restarting Menuconfig.\n"
131 "Other information\n"
132 "-----------------\n"
133 "If you use Menuconfig in an XTERM window make sure you have your\n"
134 "$TERM variable set to point to a xterm definition which supports color.\n"
135 "Otherwise, Menuconfig will look rather bad. Menuconfig will not\n"
136 "display correctly in a RXVT window because rxvt displays only one\n"
137 "intensity of color, bright.\n"
139 "Menuconfig will display larger menus on screens or xterms which are\n"
140 "set to display more than the standard 25 row by 80 column geometry.\n"
141 "In order for this to work, the \"stty size\" command must be able to\n"
142 "display the screen's current row and column geometry. I STRONGLY\n"
143 "RECOMMEND that you make sure you do NOT have the shell variables\n"
144 "LINES and COLUMNS exported into your environment. Some distributions\n"
145 "export those variables via /etc/profile. Some ncurses programs can\n"
146 "become confused when those variables (LINES & COLUMNS) don't reflect\n"
147 "the true screen size.\n"
149 "Optional personality available\n"
150 "------------------------------\n"
151 "If you prefer to have all of the options listed in a single menu, rather\n"
152 "than the default multimenu hierarchy, run the menuconfig with\n"
153 "MENUCONFIG_MODE environment variable set to single_menu. Example:\n"
155 "make MENUCONFIG_MODE=single_menu menuconfig\n"
157 "<Enter> will then unroll the appropriate category, or enfold it if it\n"
158 "is already unrolled.\n"
160 "Note that this mode can eventually be a little more CPU expensive\n"
161 "(especially with a larger number of unrolled categories) than the\n"
164 "Different color themes available\n"
165 "--------------------------------\n"
166 "It is possible to select different color themes using the variable\n"
167 "MENUCONFIG_COLOR. To select a theme use:\n"
169 "make MENUCONFIG_COLOR=<theme> menuconfig\n"
171 "Available themes are\n"
172 " mono => selects colors suitable for monochrome displays\n"
173 " blackbg => selects a color scheme with black background\n"
174 " classic => theme with blue background. The classic look\n"
175 " bluetitle => a LCD friendly version of classic. (default)\n"
177 menu_instructions[] = N_(
178 "Arrow keys navigate the menu. "
179 "<Enter> selects submenus --->. "
180 "Highlighted letters are hotkeys. "
181 "Pressing <Y> includes, <N> excludes, <M> modularizes features. "
182 "Press <Esc><Esc> to exit, <?> for Help, </> for Search. "
183 "Legend: [*] built-in [ ] excluded <M> module < > module capable"),
184 radiolist_instructions[] = N_(
185 "Use the arrow keys to navigate this window or "
186 "press the hotkey of the item you wish to select "
187 "followed by the <SPACE BAR>. "
188 "Press <?> for additional information about this option."),
189 inputbox_instructions_int[] = N_(
190 "Please enter a decimal value. "
191 "Fractions will not be accepted. "
192 "Use the <TAB> key to move from the input field to the buttons below it."),
193 inputbox_instructions_hex[] = N_(
194 "Please enter a hexadecimal value. "
195 "Use the <TAB> key to move from the input field to the buttons below it."),
196 inputbox_instructions_string[] = N_(
197 "Please enter a string value. "
198 "Use the <TAB> key to move from the input field to the buttons below it."),
200 "This feature depends on another which has been configured as a module.\n"
201 "As a result, this feature will be built as a module."),
202 load_config_text[] = N_(
203 "Enter the name of the configuration file you wish to load. "
204 "Accept the name shown to restore the configuration you "
205 "last retrieved. Leave blank to abort."),
206 load_config_help[] = N_(
208 "For various reasons, one may wish to keep several different\n"
209 "configurations available on a single machine.\n"
211 "If you have saved a previous configuration in a file other than the\n"
212 "default one, entering its name here will allow you to modify that\n"
215 "If you are uncertain, then you have probably never used alternate\n"
216 "configuration files. You should therefore leave this blank to abort.\n"),
217 save_config_text[] = N_(
218 "Enter a filename to which this configuration should be saved "
219 "as an alternate. Leave blank to abort."),
220 save_config_help[] = N_(
222 "For various reasons, one may wish to keep different configurations\n"
223 "available on a single machine.\n"
225 "Entering a file name here will allow you to later retrieve, modify\n"
226 "and use the current configuration as an alternate to whatever\n"
227 "configuration options you have selected at that time.\n"
229 "If you are uncertain what all this means then you should probably\n"
230 "leave this blank.\n"),
233 "Search for symbols and display their relations.\n"
234 "Regular expressions are allowed.\n"
235 "Example: search for \"^FOO\"\n"
237 "-----------------------------------------------------------------\n"
240 "Prompt: Foo bus is used to drive the bar HW\n"
241 " Defined at drivers/pci/Kconfig:47\n"
242 " Depends on: X86_LOCAL_APIC && X86_IO_APIC || IA64\n"
244 " -> Bus options (PCI, PCMCIA, EISA, ISA)\n"
245 " -> PCI support (PCI [=y])\n"
246 "(1) -> PCI access mode (<choice> [=y])\n"
247 " Selects: LIBCRC32\n"
248 " Selected by: BAR\n"
249 "-----------------------------------------------------------------\n"
250 "o The line 'Type:' shows the type of the configuration option for\n"
251 " this symbol (boolean, tristate, string, ...)\n"
252 "o The line 'Prompt:' shows the text used in the menu structure for\n"
254 "o The 'Defined at' line tell at what file / line number the symbol\n"
256 "o The 'Depends on:' line tell what symbols needs to be defined for\n"
257 " this symbol to be visible in the menu (selectable)\n"
258 "o The 'Location:' lines tell where in the menu structure this symbol\n"
260 " A location followed by a [=y] indicates that this is a\n"
261 " selectable menu item - and the current value is displayed inside\n"
263 " Press the key in the (#) prefix to jump directly to that\n"
264 " location. You will be returned to the current search results\n"
265 " after exiting this new menu.\n"
266 "o The 'Selects:' line tell what symbol will be automatically\n"
267 " selected if this symbol is selected (y or m)\n"
268 "o The 'Selected by' line tell what symbol has selected this symbol\n"
270 "Only relevant lines are shown.\n"
273 "Examples: USB => find all symbols containing USB\n"
274 " ^USB => find all symbols starting with USB\n"
275 " USB$ => find all symbols ending with USB\n"
279 static struct menu *current_menu;
280 static int child_count;
281 static int single_menu_mode;
282 static int show_all_options;
283 static int save_and_exit;
285 static void conf(struct menu *menu, struct menu *active_menu);
286 static void conf_choice(struct menu *menu);
287 static void conf_string(struct menu *menu);
288 static void conf_load(void);
289 static void conf_save(void);
290 static int show_textbox_ext(const char *title, char *text, int r, int c,
291 int *keys, int *vscroll, int *hscroll,
292 update_text_fn update_text, void *data);
293 static void show_textbox(const char *title, const char *text, int r, int c);
294 static void show_helptext(const char *title, const char *text);
295 static void show_help(struct menu *menu);
297 static char filename[PATH_MAX+1];
298 static void set_config_filename(const char *config_filename)
300 static char menu_backtitle[PATH_MAX+128];
303 size = snprintf(menu_backtitle, sizeof(menu_backtitle),
304 "%s - %s", config_filename, rootmenu.prompt->text);
305 if (size >= sizeof(menu_backtitle))
306 menu_backtitle[sizeof(menu_backtitle)-1] = '\0';
307 set_dialog_backtitle(menu_backtitle);
309 size = snprintf(filename, sizeof(filename), "%s", config_filename);
310 if (size >= sizeof(filename))
311 filename[sizeof(filename)-1] = '\0';
316 struct list_head *head;
317 struct menu **targets;
321 static void update_text(char *buf, size_t start, size_t end, void *_data)
323 struct search_data *data = _data;
324 struct jump_key *pos;
327 list_for_each_entry(pos, data->head, entries) {
328 if (pos->offset >= start && pos->offset < end) {
332 int key = '0' + (pos->index % JUMP_NB) + 1;
334 sprintf(header, "(%c)", key);
336 data->targets[k] = pos->target;
339 sprintf(header, " ");
342 memcpy(buf + pos->offset, header, sizeof(header) - 1);
348 static void search_conf(void)
350 struct symbol **sym_arr;
354 int dres, vscroll = 0, hscroll = 0;
358 str_printf( &title, _("Enter %s (sub)string to search for "
359 "(with or without \"%s\")"), CONFIG_, CONFIG_);
363 dres = dialog_inputbox(_("Search Configuration Parameter"),
370 show_helptext(_("Search Configuration"), search_help);
377 /* strip the prefix if necessary */
378 dialog_input = dialog_input_result;
379 if (strncasecmp(dialog_input_result, CONFIG_, strlen(CONFIG_)) == 0)
380 dialog_input += strlen(CONFIG_);
382 sym_arr = sym_re_search(dialog_input);
385 struct menu *targets[JUMP_NB];
386 int keys[JUMP_NB + 1], i;
387 struct search_data data = {
392 struct jump_key *pos, *tmp;
394 res = get_relations_str(sym_arr, &head);
395 dres = show_textbox_ext(_("Search Results"), (char *)
396 str_get(&res), 0, 0, keys, &vscroll,
397 &hscroll, &update_text, (void *)
400 for (i = 0; i < JUMP_NB && keys[i]; i++)
401 if (dres == keys[i]) {
402 conf(targets[i]->parent, targets[i]);
406 list_for_each_entry_safe(pos, tmp, &head, entries)
413 static void build_conf(struct menu *menu)
416 struct property *prop;
418 int type, tmp, doint = 2;
424 * note: menu_is_visible() has side effect that it will
425 * recalc the value of the symbol.
427 visible = menu_is_visible(menu);
428 if (show_all_options && !menu_has_prompt(menu))
430 else if (!show_all_options && !visible)
436 if (prop && menu != current_menu) {
437 const char *prompt = menu_get_prompt(menu);
438 switch (prop->type) {
442 if (single_menu_mode) {
444 menu->data ? "-->" : "++>",
445 indent + 1, ' ', prompt);
447 item_make(" %*c%s --->", indent + 1, ' ', prompt);
451 if (single_menu_mode && menu->data)
457 item_make(" %*c*** %s ***", indent + 1, ' ', _(prompt));
465 item_make("---%*c%s", indent + 1, ' ', _(prompt));
475 type = sym_get_type(sym);
476 if (sym_is_choice(sym)) {
477 struct symbol *def_sym = sym_get_choice_value(sym);
478 struct menu *def_menu = NULL;
481 for (child = menu->list; child; child = child->next) {
482 if (menu_is_visible(child) && child->sym == def_sym)
486 val = sym_get_tristate_value(sym);
487 if (sym_is_changable(sym)) {
490 item_make("[%c]", val == no ? ' ' : '*');
494 case yes: ch = '*'; break;
495 case mod: ch = 'M'; break;
496 default: ch = ' '; break;
498 item_make("<%c>", ch);
505 item_set_tag(def_menu ? 't' : ':');
509 item_add_str("%*c%s", indent + 1, ' ', _(menu_get_prompt(menu)));
512 item_add_str(" (%s)", _(menu_get_prompt(def_menu)));
513 item_add_str(" --->");
514 if (def_menu->list) {
516 build_conf(def_menu);
523 if (menu == current_menu) {
524 item_make("---%*c%s", indent + 1, ' ', _(menu_get_prompt(menu)));
530 val = sym_get_tristate_value(sym);
531 if (sym_is_choice_value(sym) && val == yes) {
538 if (sym_is_changable(sym))
539 item_make("[%c]", val == no ? ' ' : '*');
541 item_make("-%c-", val == no ? ' ' : '*');
547 case yes: ch = '*'; break;
548 case mod: ch = 'M'; break;
549 default: ch = ' '; break;
551 if (sym_is_changable(sym)) {
552 if (sym->rev_dep.tri == mod)
553 item_make("{%c}", ch);
555 item_make("<%c>", ch);
557 item_make("-%c-", ch);
562 tmp = 2 + strlen(sym_get_string_value(sym)); /* () = 2 */
563 item_make("(%s)", sym_get_string_value(sym));
564 tmp = indent - tmp + 4;
567 item_add_str("%*c%s%s", tmp, ' ', _(menu_get_prompt(menu)),
568 (sym_has_value(sym) || !sym_is_changable(sym)) ?
575 item_add_str("%*c%s%s", indent + 1, ' ', _(menu_get_prompt(menu)),
576 (sym_has_value(sym) || !sym_is_changable(sym)) ?
578 if (menu->prompt->type == P_MENU) {
579 item_add_str(" --->");
586 for (child = menu->list; child; child = child->next)
591 static void conf(struct menu *menu, struct menu *active_menu)
593 struct menu *submenu;
594 const char *prompt = menu_get_prompt(menu);
606 res = dialog_menu(prompt ? _(prompt) : _("Main Menu"),
607 _(menu_instructions),
608 active_menu, &s_scroll);
609 if (res == 1 || res == KEY_ESC || res == -ERRDISPLAYTOOSMALL)
611 if (!item_activate_selected())
616 submenu = item_data();
617 active_menu = item_data();
625 switch (item_tag()) {
627 if (single_menu_mode)
628 submenu->data = (void *) (long) !submenu->data;
633 if (sym_is_choice(sym) && sym_get_tristate_value(sym) == yes)
634 conf_choice(submenu);
635 else if (submenu->prompt->type == P_MENU)
639 conf_string(submenu);
647 show_helptext(_("README"), _(mconf_readme));
656 if (item_is_tag('t')) {
657 if (sym_set_tristate_value(sym, yes))
659 if (sym_set_tristate_value(sym, mod))
660 show_textbox(NULL, setmod_text, 6, 74);
664 if (item_is_tag('t'))
665 sym_set_tristate_value(sym, no);
668 if (item_is_tag('t'))
669 sym_set_tristate_value(sym, mod);
672 if (item_is_tag('t'))
673 sym_toggle_tristate_value(sym);
674 else if (item_is_tag('m'))
681 show_all_options = !show_all_options;
687 static int show_textbox_ext(const char *title, char *text, int r, int c, int
688 *keys, int *vscroll, int *hscroll, update_text_fn
689 update_text, void *data)
692 return dialog_textbox(title, text, r, c, keys, vscroll, hscroll,
696 static void show_textbox(const char *title, const char *text, int r, int c)
698 show_textbox_ext(title, (char *) text, r, c, (int []) {0}, NULL, NULL,
702 static void show_helptext(const char *title, const char *text)
704 show_textbox(title, text, 0, 0);
707 static void conf_message_callback(const char *fmt, va_list ap)
709 char buf[PATH_MAX+1];
711 vsnprintf(buf, sizeof(buf), fmt, ap);
715 show_textbox(NULL, buf, 6, 60);
718 static void show_help(struct menu *menu)
720 struct gstr help = str_new();
722 help.max_width = getmaxx(stdscr) - 10;
723 menu_get_ext_help(menu, &help);
725 show_helptext(_(menu_get_prompt(menu)), str_get(&help));
729 static void conf_choice(struct menu *menu)
731 const char *prompt = _(menu_get_prompt(menu));
733 struct symbol *active;
735 active = sym_get_choice_value(menu->sym);
742 for (child = menu->list; child; child = child->next) {
743 if (!menu_is_visible(child))
746 item_make("%s", _(menu_get_prompt(child)));
748 item_make("*** %s ***", _(menu_get_prompt(child)));
751 item_set_data(child);
752 if (child->sym == active)
753 item_set_selected(1);
754 if (child->sym == sym_get_choice_value(menu->sym))
758 res = dialog_checklist(prompt ? _(prompt) : _("Main Menu"),
759 _(radiolist_instructions),
761 selected = item_activate_selected();
769 sym_set_tristate_value(child->sym, yes);
782 case -ERRDISPLAYTOOSMALL:
788 static void conf_string(struct menu *menu)
790 const char *prompt = menu_get_prompt(menu);
796 switch (sym_get_type(menu->sym)) {
798 heading = _(inputbox_instructions_int);
801 heading = _(inputbox_instructions_hex);
804 heading = _(inputbox_instructions_string);
807 heading = _("Internal mconf error!");
810 res = dialog_inputbox(prompt ? _(prompt) : _("Main Menu"),
812 sym_get_string_value(menu->sym));
815 if (sym_set_string_value(menu->sym, dialog_input_result))
817 show_textbox(NULL, _("You have made an invalid entry."), 5, 43);
828 static void conf_load(void)
834 res = dialog_inputbox(NULL, load_config_text,
838 if (!dialog_input_result[0])
840 if (!conf_read(dialog_input_result)) {
841 set_config_filename(dialog_input_result);
842 sym_set_change_count(1);
845 show_textbox(NULL, _("File does not exist!"), 5, 38);
848 show_helptext(_("Load Alternate Configuration"), load_config_help);
856 static void conf_save(void)
861 res = dialog_inputbox(NULL, save_config_text,
865 if (!dialog_input_result[0])
867 if (!conf_write(dialog_input_result)) {
868 set_config_filename(dialog_input_result);
871 show_textbox(NULL, _("Can't create file! Probably a nonexistent directory."), 5, 60);
874 show_helptext(_("Save Alternate Configuration"), save_config_help);
882 static int handle_exit(void)
888 if (conf_get_changed())
889 res = dialog_yesno(NULL,
890 _("Do you wish to save your new configuration ?\n"
891 "<ESC><ESC> to continue."),
896 end_dialog(saved_x, saved_y);
900 if (conf_write(filename)) {
901 fprintf(stderr, _("\n\n"
902 "Error while writing of the configuration.\n"
903 "Your configuration changes were NOT saved."
910 "*** End of the configuration.\n"
911 "*** Execute 'make' to start the build or try 'make help'."
916 fprintf(stderr, _("\n\n"
917 "Your configuration changes were NOT saved."
926 static void sig_handler(int signo)
931 int main(int ac, char **av)
936 setlocale(LC_ALL, "");
937 bindtextdomain(PACKAGE, LOCALEDIR);
940 signal(SIGINT, sig_handler);
945 mode = getenv("MENUCONFIG_MODE");
947 if (!strcasecmp(mode, "single_menu"))
948 single_menu_mode = 1;
951 if (init_dialog(NULL)) {
952 fprintf(stderr, N_("Your display is too small to run Menuconfig!\n"));
953 fprintf(stderr, N_("It must be at least 19 lines by 80 columns.\n"));
957 set_config_filename(conf_get_configname());
958 conf_set_message_callback(conf_message_callback);
960 conf(&rootmenu, NULL);
962 } while (res == KEY_ESC);