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';
314 struct subtitle_part {
315 struct list_head entries;
318 static LIST_HEAD(trail);
320 static struct subtitle_list *subtitles;
321 static void set_subtitle(void)
323 struct subtitle_part *sp;
324 struct subtitle_list *pos, *tmp;
326 for (pos = subtitles; pos != NULL; pos = tmp) {
332 list_for_each_entry(sp, &trail, entries) {
335 pos->next = xcalloc(sizeof(*pos), 1);
338 subtitles = pos = xcalloc(sizeof(*pos), 1);
340 pos->text = sp->text;
344 set_dialog_subtitles(subtitles);
347 static void reset_subtitle(void)
349 struct subtitle_list *pos, *tmp;
351 for (pos = subtitles; pos != NULL; pos = tmp) {
356 set_dialog_subtitles(subtitles);
360 struct list_head *head;
361 struct menu **targets;
365 static void update_text(char *buf, size_t start, size_t end, void *_data)
367 struct search_data *data = _data;
368 struct jump_key *pos;
371 list_for_each_entry(pos, data->head, entries) {
372 if (pos->offset >= start && pos->offset < end) {
376 int key = '0' + (pos->index % JUMP_NB) + 1;
378 sprintf(header, "(%c)", key);
380 data->targets[k] = pos->target;
383 sprintf(header, " ");
386 memcpy(buf + pos->offset, header, sizeof(header) - 1);
392 static void search_conf(void)
394 struct symbol **sym_arr;
398 int dres, vscroll = 0, hscroll = 0;
401 struct subtitle_part stpart;
404 str_printf( &title, _("Enter %s (sub)string to search for "
405 "(with or without \"%s\")"), CONFIG_, CONFIG_);
409 dres = dialog_inputbox(_("Search Configuration Parameter"),
416 show_helptext(_("Search Configuration"), search_help);
423 /* strip the prefix if necessary */
424 dialog_input = dialog_input_result;
425 if (strncasecmp(dialog_input_result, CONFIG_, strlen(CONFIG_)) == 0)
426 dialog_input += strlen(CONFIG_);
429 str_printf(&sttext, "Search (%s)", dialog_input_result);
430 stpart.text = str_get(&sttext);
431 list_add_tail(&stpart.entries, &trail);
433 sym_arr = sym_re_search(dialog_input);
436 struct menu *targets[JUMP_NB];
437 int keys[JUMP_NB + 1], i;
438 struct search_data data = {
443 struct jump_key *pos, *tmp;
445 res = get_relations_str(sym_arr, &head);
447 dres = show_textbox_ext(_("Search Results"), (char *)
448 str_get(&res), 0, 0, keys, &vscroll,
449 &hscroll, &update_text, (void *)
452 for (i = 0; i < JUMP_NB && keys[i]; i++)
453 if (dres == keys[i]) {
454 conf(targets[i]->parent, targets[i]);
458 list_for_each_entry_safe(pos, tmp, &head, entries)
463 list_del(trail.prev);
467 static void build_conf(struct menu *menu)
470 struct property *prop;
472 int type, tmp, doint = 2;
478 * note: menu_is_visible() has side effect that it will
479 * recalc the value of the symbol.
481 visible = menu_is_visible(menu);
482 if (show_all_options && !menu_has_prompt(menu))
484 else if (!show_all_options && !visible)
490 if (prop && menu != current_menu) {
491 const char *prompt = menu_get_prompt(menu);
492 switch (prop->type) {
496 if (single_menu_mode) {
498 menu->data ? "-->" : "++>",
499 indent + 1, ' ', prompt);
501 item_make(" %*c%s --->", indent + 1, ' ', prompt);
505 if (single_menu_mode && menu->data)
511 item_make(" %*c*** %s ***", indent + 1, ' ', _(prompt));
519 item_make("---%*c%s", indent + 1, ' ', _(prompt));
529 type = sym_get_type(sym);
530 if (sym_is_choice(sym)) {
531 struct symbol *def_sym = sym_get_choice_value(sym);
532 struct menu *def_menu = NULL;
535 for (child = menu->list; child; child = child->next) {
536 if (menu_is_visible(child) && child->sym == def_sym)
540 val = sym_get_tristate_value(sym);
541 if (sym_is_changable(sym)) {
544 item_make("[%c]", val == no ? ' ' : '*');
548 case yes: ch = '*'; break;
549 case mod: ch = 'M'; break;
550 default: ch = ' '; break;
552 item_make("<%c>", ch);
559 item_set_tag(def_menu ? 't' : ':');
563 item_add_str("%*c%s", indent + 1, ' ', _(menu_get_prompt(menu)));
566 item_add_str(" (%s)", _(menu_get_prompt(def_menu)));
567 item_add_str(" --->");
568 if (def_menu->list) {
570 build_conf(def_menu);
577 if (menu == current_menu) {
578 item_make("---%*c%s", indent + 1, ' ', _(menu_get_prompt(menu)));
584 val = sym_get_tristate_value(sym);
585 if (sym_is_choice_value(sym) && val == yes) {
592 if (sym_is_changable(sym))
593 item_make("[%c]", val == no ? ' ' : '*');
595 item_make("-%c-", val == no ? ' ' : '*');
601 case yes: ch = '*'; break;
602 case mod: ch = 'M'; break;
603 default: ch = ' '; break;
605 if (sym_is_changable(sym)) {
606 if (sym->rev_dep.tri == mod)
607 item_make("{%c}", ch);
609 item_make("<%c>", ch);
611 item_make("-%c-", ch);
616 tmp = 2 + strlen(sym_get_string_value(sym)); /* () = 2 */
617 item_make("(%s)", sym_get_string_value(sym));
618 tmp = indent - tmp + 4;
621 item_add_str("%*c%s%s", tmp, ' ', _(menu_get_prompt(menu)),
622 (sym_has_value(sym) || !sym_is_changable(sym)) ?
629 item_add_str("%*c%s%s", indent + 1, ' ', _(menu_get_prompt(menu)),
630 (sym_has_value(sym) || !sym_is_changable(sym)) ?
632 if (menu->prompt->type == P_MENU) {
633 item_add_str(" --->");
640 for (child = menu->list; child; child = child->next)
645 static void conf(struct menu *menu, struct menu *active_menu)
647 struct menu *submenu;
648 const char *prompt = menu_get_prompt(menu);
649 struct subtitle_part stpart;
654 if (menu != &rootmenu)
655 stpart.text = menu_get_prompt(menu);
658 list_add_tail(&stpart.entries, &trail);
668 res = dialog_menu(prompt ? _(prompt) : _("Main Menu"),
669 _(menu_instructions),
670 active_menu, &s_scroll);
671 if (res == 1 || res == KEY_ESC || res == -ERRDISPLAYTOOSMALL)
673 if (item_count() != 0) {
674 if (!item_activate_selected())
679 submenu = item_data();
680 active_menu = item_data();
688 switch (item_tag()) {
690 if (single_menu_mode)
691 submenu->data = (void *) (long) !submenu->data;
696 if (sym_is_choice(sym) && sym_get_tristate_value(sym) == yes)
697 conf_choice(submenu);
698 else if (submenu->prompt->type == P_MENU)
702 conf_string(submenu);
711 show_helptext(_("README"), _(mconf_readme));
723 if (item_is_tag('t')) {
724 if (sym_set_tristate_value(sym, yes))
726 if (sym_set_tristate_value(sym, mod))
727 show_textbox(NULL, setmod_text, 6, 74);
731 if (item_is_tag('t'))
732 sym_set_tristate_value(sym, no);
735 if (item_is_tag('t'))
736 sym_set_tristate_value(sym, mod);
739 if (item_is_tag('t'))
740 sym_toggle_tristate_value(sym);
741 else if (item_is_tag('m'))
748 show_all_options = !show_all_options;
753 list_del(trail.prev);
756 static int show_textbox_ext(const char *title, char *text, int r, int c, int
757 *keys, int *vscroll, int *hscroll, update_text_fn
758 update_text, void *data)
761 return dialog_textbox(title, text, r, c, keys, vscroll, hscroll,
765 static void show_textbox(const char *title, const char *text, int r, int c)
767 show_textbox_ext(title, (char *) text, r, c, (int []) {0}, NULL, NULL,
771 static void show_helptext(const char *title, const char *text)
773 show_textbox(title, text, 0, 0);
776 static void conf_message_callback(const char *fmt, va_list ap)
778 char buf[PATH_MAX+1];
780 vsnprintf(buf, sizeof(buf), fmt, ap);
784 show_textbox(NULL, buf, 6, 60);
787 static void show_help(struct menu *menu)
789 struct gstr help = str_new();
791 help.max_width = getmaxx(stdscr) - 10;
792 menu_get_ext_help(menu, &help);
794 show_helptext(_(menu_get_prompt(menu)), str_get(&help));
798 static void conf_choice(struct menu *menu)
800 const char *prompt = _(menu_get_prompt(menu));
802 struct symbol *active;
804 active = sym_get_choice_value(menu->sym);
811 for (child = menu->list; child; child = child->next) {
812 if (!menu_is_visible(child))
815 item_make("%s", _(menu_get_prompt(child)));
817 item_make("*** %s ***", _(menu_get_prompt(child)));
820 item_set_data(child);
821 if (child->sym == active)
822 item_set_selected(1);
823 if (child->sym == sym_get_choice_value(menu->sym))
827 res = dialog_checklist(prompt ? _(prompt) : _("Main Menu"),
828 _(radiolist_instructions),
830 selected = item_activate_selected();
838 sym_set_tristate_value(child->sym, yes);
851 case -ERRDISPLAYTOOSMALL:
857 static void conf_string(struct menu *menu)
859 const char *prompt = menu_get_prompt(menu);
865 switch (sym_get_type(menu->sym)) {
867 heading = _(inputbox_instructions_int);
870 heading = _(inputbox_instructions_hex);
873 heading = _(inputbox_instructions_string);
876 heading = _("Internal mconf error!");
879 res = dialog_inputbox(prompt ? _(prompt) : _("Main Menu"),
881 sym_get_string_value(menu->sym));
884 if (sym_set_string_value(menu->sym, dialog_input_result))
886 show_textbox(NULL, _("You have made an invalid entry."), 5, 43);
897 static void conf_load(void)
903 res = dialog_inputbox(NULL, load_config_text,
907 if (!dialog_input_result[0])
909 if (!conf_read(dialog_input_result)) {
910 set_config_filename(dialog_input_result);
911 sym_set_change_count(1);
914 show_textbox(NULL, _("File does not exist!"), 5, 38);
917 show_helptext(_("Load Alternate Configuration"), load_config_help);
925 static void conf_save(void)
930 res = dialog_inputbox(NULL, save_config_text,
934 if (!dialog_input_result[0])
936 if (!conf_write(dialog_input_result)) {
937 set_config_filename(dialog_input_result);
940 show_textbox(NULL, _("Can't create file! Probably a nonexistent directory."), 5, 60);
943 show_helptext(_("Save Alternate Configuration"), save_config_help);
951 static int handle_exit(void)
958 if (conf_get_changed())
959 res = dialog_yesno(NULL,
960 _("Do you wish to save your new configuration ?\n"
961 "<ESC><ESC> to continue."),
966 end_dialog(saved_x, saved_y);
970 if (conf_write(filename)) {
971 fprintf(stderr, _("\n\n"
972 "Error while writing of the configuration.\n"
973 "Your configuration changes were NOT saved."
980 "*** End of the configuration.\n"
981 "*** Execute 'make' to start the build or try 'make help'."
986 fprintf(stderr, _("\n\n"
987 "Your configuration changes were NOT saved."
996 static void sig_handler(int signo)
1001 int main(int ac, char **av)
1006 setlocale(LC_ALL, "");
1007 bindtextdomain(PACKAGE, LOCALEDIR);
1008 textdomain(PACKAGE);
1010 signal(SIGINT, sig_handler);
1015 mode = getenv("MENUCONFIG_MODE");
1017 if (!strcasecmp(mode, "single_menu"))
1018 single_menu_mode = 1;
1021 if (init_dialog(NULL)) {
1022 fprintf(stderr, N_("Your display is too small to run Menuconfig!\n"));
1023 fprintf(stderr, N_("It must be at least 19 lines by 80 columns.\n"));
1027 set_config_filename(conf_get_configname());
1028 conf_set_message_callback(conf_message_callback);
1030 conf(&rootmenu, NULL);
1031 res = handle_exit();
1032 } while (res == KEY_ESC);