1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
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"
27 static const char mconf_readme[] =
30 "This interface lets you select features and parameters for the build.\n"
31 "Features can either be built-in, modularized, or ignored. Parameters\n"
32 "must be entered in as decimal or hexadecimal numbers or text.\n"
34 "Menu items beginning with following braces represent features that\n"
35 " [ ] can be built in or removed\n"
36 " < > can be built in, modularized or removed\n"
37 " { } can be built in or modularized (selected by other feature)\n"
38 " - - are selected by other feature,\n"
39 "while *, M or whitespace inside braces means to build in, build as\n"
40 "a module or to exclude the feature respectively.\n"
42 "To change any of these features, highlight it with the cursor\n"
43 "keys and press <Y> to build it in, <M> to make it a module or\n"
44 "<N> to remove it. You may also press the <Space Bar> to cycle\n"
45 "through the available options (i.e. Y->N->M->Y).\n"
47 "Some additional keyboard hints:\n"
51 "o Use the Up/Down arrow keys (cursor keys) to highlight the item you\n"
52 " wish to change or the submenu you wish to select and press <Enter>.\n"
53 " Submenus are designated by \"--->\", empty ones by \"----\".\n"
55 " Shortcut: Press the option's highlighted letter (hotkey).\n"
56 " Pressing a hotkey more than once will sequence\n"
57 " through all visible items which use that hotkey.\n"
59 " You may also use the <PAGE UP> and <PAGE DOWN> keys to scroll\n"
60 " unseen options into view.\n"
62 "o To exit a menu use the cursor keys to highlight the <Exit> button\n"
63 " and press <ENTER>.\n"
65 " Shortcut: Press <ESC><ESC> or <E> or <X> if there is no hotkey\n"
66 " using those letters. You may press a single <ESC>, but\n"
67 " there is a delayed response which you may find annoying.\n"
69 " Also, the <TAB> and cursor keys will cycle between <Select>,\n"
70 " <Exit>, <Help>, <Save>, and <Load>.\n"
72 "o To get help with an item, use the cursor keys to highlight <Help>\n"
73 " and press <ENTER>.\n"
75 " Shortcut: Press <H> or <?>.\n"
77 "o To toggle the display of hidden options, press <Z>.\n"
80 "Radiolists (Choice lists)\n"
82 "o Use the cursor keys to select the option you wish to set and press\n"
83 " <S> or the <SPACE BAR>.\n"
85 " Shortcut: Press the first letter of the option you wish to set then\n"
86 " press <S> or <SPACE BAR>.\n"
88 "o To see available help for the item, use the cursor keys to highlight\n"
89 " <Help> and Press <ENTER>.\n"
91 " Shortcut: Press <H> or <?>.\n"
93 " Also, the <TAB> and cursor keys will cycle between <Select> and\n"
99 "o Enter the requested information and press <ENTER>\n"
100 " If you are entering hexadecimal values, it is not necessary to\n"
101 " add the '0x' prefix to the entry.\n"
103 "o For help, use the <TAB> or cursor keys to highlight the help option\n"
104 " and press <ENTER>. You can try <TAB><H> as well.\n"
107 "Text Box (Help Window)\n"
109 "o Use the cursor keys to scroll up/down/left/right. The VI editor\n"
110 " keys h,j,k,l function here as do <u>, <d>, <SPACE BAR> and <B> for\n"
111 " those who are familiar with less and lynx.\n"
113 "o Press <E>, <X>, <q>, <Enter> or <Esc><Esc> to exit.\n"
116 "Alternate Configuration Files\n"
117 "-----------------------------\n"
118 "Menuconfig supports the use of alternate configuration files for\n"
119 "those who, for various reasons, find it necessary to switch\n"
120 "between different configurations.\n"
122 "The <Save> button will let you save the current configuration to\n"
123 "a file of your choosing. Use the <Load> button to load a previously\n"
124 "saved alternate configuration.\n"
126 "Even if you don't use alternate configuration files, but you find\n"
127 "during a Menuconfig session that you have completely messed up your\n"
128 "settings, you may use the <Load> button to restore your previously\n"
129 "saved settings from \".config\" without 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 an xterm definition which supports\n"
135 "color. Otherwise, Menuconfig will look rather bad. Menuconfig will\n"
136 "not display correctly in an 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,\n"
152 "rather 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"
167 "Pressing the forward-slash (/) anywhere brings up a search dialog box.\n"
170 "Different color themes available\n"
171 "--------------------------------\n"
172 "It is possible to select different color themes using the variable\n"
173 "MENUCONFIG_COLOR. To select a theme use:\n"
175 "make MENUCONFIG_COLOR=<theme> menuconfig\n"
177 "Available themes are\n"
178 " mono => selects colors suitable for monochrome displays\n"
179 " blackbg => selects a color scheme with black background\n"
180 " classic => theme with blue background. The classic look\n"
181 " bluetitle => an LCD friendly version of classic. (default)\n"
183 menu_instructions[] =
184 "Arrow keys navigate the menu. "
185 "<Enter> selects submenus ---> (or empty submenus ----). "
186 "Highlighted letters are hotkeys. "
187 "Pressing <Y> includes, <N> excludes, <M> modularizes features. "
188 "Press <Esc><Esc> to exit, <?> for Help, </> for Search. "
189 "Legend: [*] built-in [ ] excluded <M> module < > module capable",
190 radiolist_instructions[] =
191 "Use the arrow keys to navigate this window or "
192 "press the hotkey of the item you wish to select "
193 "followed by the <SPACE BAR>. "
194 "Press <?> for additional information about this option.",
195 inputbox_instructions_int[] =
196 "Please enter a decimal value. "
197 "Fractions will not be accepted. "
198 "Use the <TAB> key to move from the input field to the buttons below it.",
199 inputbox_instructions_hex[] =
200 "Please enter a hexadecimal value. "
201 "Use the <TAB> key to move from the input field to the buttons below it.",
202 inputbox_instructions_string[] =
203 "Please enter a string value. "
204 "Use the <TAB> key to move from the input field to the buttons below it.",
206 "This feature depends on another which has been configured as a module.\n"
207 "As a result, this feature will be built as a module.",
209 "Enter the name of the configuration file you wish to load. "
210 "Accept the name shown to restore the configuration you "
211 "last retrieved. Leave blank to abort.",
214 "For various reasons, one may wish to keep several different\n"
215 "configurations available on a single machine.\n"
217 "If you have saved a previous configuration in a file other than the\n"
218 "default one, entering its name here will allow you to modify that\n"
221 "If you are uncertain, then you have probably never used alternate\n"
222 "configuration files. You should therefore leave this blank to abort.\n",
224 "Enter a filename to which this configuration should be saved "
225 "as an alternate. Leave blank to abort.",
228 "For various reasons, one may wish to keep different configurations\n"
229 "available on a single machine.\n"
231 "Entering a file name here will allow you to later retrieve, modify\n"
232 "and use the current configuration as an alternate to whatever\n"
233 "configuration options you have selected at that time.\n"
235 "If you are uncertain what all this means then you should probably\n"
236 "leave this blank.\n",
239 "Search for symbols and display their relations.\n"
240 "Regular expressions are allowed.\n"
241 "Example: search for \"^FOO\"\n"
243 "-----------------------------------------------------------------\n"
246 "Prompt: Foo bus is used to drive the bar HW\n"
248 " -> Bus options (PCI, PCMCIA, EISA, ISA)\n"
249 " -> PCI support (PCI [=y])\n"
250 "(1) -> PCI access mode (<choice> [=y])\n"
251 " Defined at drivers/pci/Kconfig:47\n"
252 " Depends on: X86_LOCAL_APIC && X86_IO_APIC || IA64\n"
253 " Selects: LIBCRC32\n"
254 " Selected by: BAR [=n]\n"
255 "-----------------------------------------------------------------\n"
256 "o The line 'Type:' shows the type of the configuration option for\n"
257 " this symbol (bool, tristate, string, ...)\n"
258 "o The line 'Prompt:' shows the text used in the menu structure for\n"
260 "o The 'Defined at' line tells at what file / line number the symbol\n"
262 "o The 'Depends on:' line tells what symbols need to be defined for\n"
263 " this symbol to be visible in the menu (selectable)\n"
264 "o The 'Location:' lines tells where in the menu structure this symbol\n"
266 " A location followed by a [=y] indicates that this is a\n"
267 " selectable menu item - and the current value is displayed inside\n"
269 " Press the key in the (#) prefix to jump directly to that\n"
270 " location. You will be returned to the current search results\n"
271 " after exiting this new menu.\n"
272 "o The 'Selects:' line tells what symbols will be automatically\n"
273 " selected if this symbol is selected (y or m)\n"
274 "o The 'Selected by' line tells what symbol has selected this symbol\n"
276 "Only relevant lines are shown.\n"
279 "Examples: USB => find all symbols containing USB\n"
280 " ^USB => find all symbols starting with USB\n"
281 " USB$ => find all symbols ending with USB\n"
285 static struct menu *current_menu;
286 static int child_count;
287 static int single_menu_mode;
288 static int show_all_options;
289 static int save_and_exit;
291 static int jump_key_char;
293 static void conf(struct menu *menu, struct menu *active_menu);
295 static char filename[PATH_MAX+1];
296 static void set_config_filename(const char *config_filename)
298 static char menu_backtitle[PATH_MAX+128];
300 snprintf(menu_backtitle, sizeof(menu_backtitle), "%s - %s",
301 config_filename, rootmenu.prompt->text);
302 set_dialog_backtitle(menu_backtitle);
304 snprintf(filename, sizeof(filename), "%s", config_filename);
307 struct subtitle_part {
308 struct list_head entries;
311 static LIST_HEAD(trail);
313 static struct subtitle_list *subtitles;
314 static void set_subtitle(void)
316 struct subtitle_part *sp;
317 struct subtitle_list *pos, *tmp;
319 for (pos = subtitles; pos != NULL; pos = tmp) {
325 list_for_each_entry(sp, &trail, entries) {
328 pos->next = xcalloc(1, sizeof(*pos));
331 subtitles = pos = xcalloc(1, sizeof(*pos));
333 pos->text = sp->text;
337 set_dialog_subtitles(subtitles);
340 static void reset_subtitle(void)
342 struct subtitle_list *pos, *tmp;
344 for (pos = subtitles; pos != NULL; pos = tmp) {
349 set_dialog_subtitles(subtitles);
352 static int show_textbox_ext(const char *title, const char *text, int r, int c,
353 int *vscroll, int *hscroll,
354 int (*extra_key_cb)(int, size_t, size_t, void *),
358 return dialog_textbox(title, text, r, c, vscroll, hscroll,
362 static void show_textbox(const char *title, const char *text, int r, int c)
364 show_textbox_ext(title, text, r, c, NULL, NULL, NULL, NULL);
367 static void show_helptext(const char *title, const char *text)
369 show_textbox(title, text, 0, 0);
372 static void show_help(struct menu *menu)
374 struct gstr help = str_new();
376 help.max_width = getmaxx(stdscr) - 10;
377 menu_get_ext_help(menu, &help);
379 show_helptext(menu_get_prompt(menu), str_get(&help));
384 struct list_head *head;
388 static int next_jump_key(int key)
390 if (key < '1' || key > '9')
401 static int handle_search_keys(int key, size_t start, size_t end, void *_data)
403 struct search_data *data = _data;
404 struct jump_key *pos;
406 if (key < '1' || key > '9')
409 list_for_each_entry(pos, data->head, entries) {
410 if (pos->offset < start)
413 if (pos->offset >= end)
416 if (key == '1' + (pos->index % JUMP_NB)) {
417 data->target = pos->target;
425 int get_jump_key_char(void)
427 jump_key_char = next_jump_key(jump_key_char);
429 return jump_key_char;
432 static void search_conf(void)
434 struct symbol **sym_arr;
438 int dres, vscroll = 0, hscroll = 0;
441 struct subtitle_part stpart;
444 str_printf( &title, "Enter (sub)string or regexp to search for "
445 "(with or without \"%s\")", CONFIG_);
449 dres = dialog_inputbox("Search Configuration Parameter",
456 show_helptext("Search Configuration", search_help);
463 /* strip the prefix if necessary */
464 dialog_input = dialog_input_result;
465 if (strncasecmp(dialog_input_result, CONFIG_, strlen(CONFIG_)) == 0)
466 dialog_input += strlen(CONFIG_);
469 str_printf(&sttext, "Search (%s)", dialog_input_result);
470 stpart.text = str_get(&sttext);
471 list_add_tail(&stpart.entries, &trail);
473 sym_arr = sym_re_search(dialog_input);
476 struct search_data data = {
479 struct jump_key *pos, *tmp;
482 res = get_relations_str(sym_arr, &head);
484 dres = show_textbox_ext("Search Results", str_get(&res), 0, 0,
486 handle_search_keys, &data);
488 if (dres >= '1' && dres <= '9') {
489 assert(data.target != NULL);
490 conf(data.target->parent, data.target);
494 list_for_each_entry_safe(pos, tmp, &head, entries)
499 list_del(trail.prev);
503 static void build_conf(struct menu *menu)
506 struct property *prop;
508 int type, tmp, doint = 2;
514 * note: menu_is_visible() has side effect that it will
515 * recalc the value of the symbol.
517 visible = menu_is_visible(menu);
518 if (show_all_options && !menu_has_prompt(menu))
520 else if (!show_all_options && !visible)
526 if (prop && menu != current_menu) {
527 const char *prompt = menu_get_prompt(menu);
528 switch (prop->type) {
531 if (single_menu_mode) {
533 menu->data ? "-->" : "++>",
534 indent + 1, ' ', prompt);
536 item_make(" %*c%s %s",
537 indent + 1, ' ', prompt,
538 menu_is_empty(menu) ? "----" : "--->");
541 if (single_menu_mode && menu->data)
547 item_make(" %*c*** %s ***", indent + 1, ' ', prompt);
555 item_make("---%*c%s", indent + 1, ' ', prompt);
565 type = sym_get_type(sym);
566 if (sym_is_choice(sym)) {
567 struct symbol *def_sym = sym_get_choice_value(sym);
568 struct menu *def_menu = NULL;
571 for (child = menu->list; child; child = child->next) {
572 if (menu_is_visible(child) && child->sym == def_sym)
576 val = sym_get_tristate_value(sym);
577 if (sym_is_changeable(sym)) {
580 item_make("[%c]", val == no ? ' ' : '*');
584 case yes: ch = '*'; break;
585 case mod: ch = 'M'; break;
586 default: ch = ' '; break;
588 item_make("<%c>", ch);
595 item_set_tag(def_menu ? 't' : ':');
599 item_add_str("%*c%s", indent + 1, ' ', menu_get_prompt(menu));
602 item_add_str(" (%s)", menu_get_prompt(def_menu));
603 item_add_str(" --->");
604 if (def_menu->list) {
606 build_conf(def_menu);
613 if (menu == current_menu) {
614 item_make("---%*c%s", indent + 1, ' ', menu_get_prompt(menu));
620 val = sym_get_tristate_value(sym);
621 if (sym_is_choice_value(sym) && val == yes) {
628 if (sym_is_changeable(sym))
629 item_make("[%c]", val == no ? ' ' : '*');
631 item_make("-%c-", val == no ? ' ' : '*');
637 case yes: ch = '*'; break;
638 case mod: ch = 'M'; break;
639 default: ch = ' '; break;
641 if (sym_is_changeable(sym)) {
642 if (sym->rev_dep.tri == mod)
643 item_make("{%c}", ch);
645 item_make("<%c>", ch);
647 item_make("-%c-", ch);
652 tmp = 2 + strlen(sym_get_string_value(sym)); /* () = 2 */
653 item_make("(%s)", sym_get_string_value(sym));
654 tmp = indent - tmp + 4;
657 item_add_str("%*c%s%s", tmp, ' ', menu_get_prompt(menu),
658 (sym_has_value(sym) || !sym_is_changeable(sym)) ?
665 item_add_str("%*c%s%s", indent + 1, ' ', menu_get_prompt(menu),
666 (sym_has_value(sym) || !sym_is_changeable(sym)) ?
668 if (menu->prompt->type == P_MENU) {
669 item_add_str(" %s", menu_is_empty(menu) ? "----" : "--->");
676 for (child = menu->list; child; child = child->next)
681 static void conf_choice(struct menu *menu)
683 const char *prompt = menu_get_prompt(menu);
685 struct symbol *active;
687 active = sym_get_choice_value(menu->sym);
694 for (child = menu->list; child; child = child->next) {
695 if (!menu_is_visible(child))
698 item_make("%s", menu_get_prompt(child));
700 item_make("*** %s ***", menu_get_prompt(child));
703 item_set_data(child);
704 if (child->sym == active)
705 item_set_selected(1);
706 if (child->sym == sym_get_choice_value(menu->sym))
710 res = dialog_checklist(prompt ? prompt : "Main Menu",
711 radiolist_instructions,
714 CHECKLIST_HEIGTH_MIN);
715 selected = item_activate_selected();
723 sym_set_tristate_value(child->sym, yes);
736 case -ERRDISPLAYTOOSMALL:
742 static void conf_string(struct menu *menu)
744 const char *prompt = menu_get_prompt(menu);
750 switch (sym_get_type(menu->sym)) {
752 heading = inputbox_instructions_int;
755 heading = inputbox_instructions_hex;
758 heading = inputbox_instructions_string;
761 heading = "Internal mconf error!";
764 res = dialog_inputbox(prompt ? prompt : "Main Menu",
766 sym_get_string_value(menu->sym));
769 if (sym_set_string_value(menu->sym, dialog_input_result))
771 show_textbox(NULL, "You have made an invalid entry.", 5, 43);
782 static void conf_load(void)
788 res = dialog_inputbox(NULL, load_config_text,
792 if (!dialog_input_result[0])
794 if (!conf_read(dialog_input_result)) {
795 set_config_filename(dialog_input_result);
796 conf_set_changed(true);
799 show_textbox(NULL, "File does not exist!", 5, 38);
802 show_helptext("Load Alternate Configuration", load_config_help);
810 static void conf_save(void)
815 res = dialog_inputbox(NULL, save_config_text,
819 if (!dialog_input_result[0])
821 if (!conf_write(dialog_input_result)) {
822 set_config_filename(dialog_input_result);
825 show_textbox(NULL, "Can't create file!", 5, 60);
828 show_helptext("Save Alternate Configuration", save_config_help);
836 static void conf(struct menu *menu, struct menu *active_menu)
838 struct menu *submenu;
839 const char *prompt = menu_get_prompt(menu);
840 struct subtitle_part stpart;
845 if (menu != &rootmenu)
846 stpart.text = menu_get_prompt(menu);
849 list_add_tail(&stpart.entries, &trail);
859 res = dialog_menu(prompt ? prompt : "Main Menu",
861 active_menu, &s_scroll);
862 if (res == 1 || res == KEY_ESC || res == -ERRDISPLAYTOOSMALL)
864 if (item_count() != 0) {
865 if (!item_activate_selected())
870 submenu = item_data();
871 active_menu = item_data();
879 switch (item_tag()) {
881 if (single_menu_mode)
882 submenu->data = (void *) (long) !submenu->data;
887 if (sym_is_choice(sym) && sym_get_tristate_value(sym) == yes)
888 conf_choice(submenu);
889 else if (submenu->prompt->type == P_MENU)
893 conf_string(submenu);
902 show_helptext("README", mconf_readme);
914 if (item_is_tag('t')) {
915 if (sym_set_tristate_value(sym, yes))
917 if (sym_set_tristate_value(sym, mod))
918 show_textbox(NULL, setmod_text, 6, 74);
922 if (item_is_tag('t'))
923 sym_set_tristate_value(sym, no);
926 if (item_is_tag('t'))
927 sym_set_tristate_value(sym, mod);
930 if (item_is_tag('t'))
931 sym_toggle_tristate_value(sym);
932 else if (item_is_tag('m'))
939 show_all_options = !show_all_options;
944 list_del(trail.prev);
947 static void conf_message_callback(const char *s)
953 show_textbox(NULL, s, 6, 60);
957 static int handle_exit(void)
964 if (conf_get_changed())
965 res = dialog_yesno(NULL,
966 "Do you wish to save your new configuration?\n"
967 "(Press <ESC><ESC> to continue kernel configuration.)",
972 end_dialog(saved_x, saved_y);
976 if (conf_write(filename)) {
977 fprintf(stderr, "\n\n"
978 "Error while writing of the configuration.\n"
979 "Your configuration changes were NOT saved."
983 conf_write_autoconf(0);
988 "*** End of the configuration.\n"
989 "*** Execute 'make' to start the build or try 'make help'."
995 fprintf(stderr, "\n\n"
996 "Your configuration changes were NOT saved."
1005 static void sig_handler(int signo)
1007 exit(handle_exit());
1010 int main(int ac, char **av)
1015 signal(SIGINT, sig_handler);
1017 if (ac > 1 && strcmp(av[1], "-s") == 0) {
1019 /* Silence conf_read() until the real callback is set up */
1020 conf_set_message_callback(NULL);
1026 mode = getenv("MENUCONFIG_MODE");
1028 if (!strcasecmp(mode, "single_menu"))
1029 single_menu_mode = 1;
1032 if (init_dialog(NULL)) {
1033 fprintf(stderr, "Your display is too small to run Menuconfig!\n");
1034 fprintf(stderr, "It must be at least 19 lines by 80 columns.\n");
1038 set_config_filename(conf_get_configname());
1039 conf_set_message_callback(conf_message_callback);
1041 conf(&rootmenu, NULL);
1042 res = handle_exit();
1043 } while (res == KEY_ESC);