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"
25 static const char mconf_readme[] =
28 "This interface lets 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 remove it. You may also press the <Space Bar> to cycle\n"
43 "through the available options (i.e. 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 you\n"
50 " wish to change or the submenu you wish to select and press <Enter>.\n"
51 " Submenus are designated by \"--->\", empty ones 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>, <Help>, <Save>, and <Load>.\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 "The <Save> button will let you save the current configuration to\n"
121 "a file of your choosing. Use the <Load> button to load a previously\n"
122 "saved alternate configuration.\n"
124 "Even if you don't use alternate configuration files, but you find\n"
125 "during a Menuconfig session that you have completely messed up your\n"
126 "settings, you may use the <Load> button to restore your previously\n"
127 "saved settings from \".config\" without restarting Menuconfig.\n"
129 "Other information\n"
130 "-----------------\n"
131 "If you use Menuconfig in an XTERM window, make sure you have your\n"
132 "$TERM variable set to point to an xterm definition which supports\n"
133 "color. Otherwise, Menuconfig will look rather bad. Menuconfig will\n"
134 "not display correctly in an RXVT window because rxvt displays only one\n"
135 "intensity of color, bright.\n"
137 "Menuconfig will display larger menus on screens or xterms which are\n"
138 "set to display more than the standard 25 row by 80 column geometry.\n"
139 "In order for this to work, the \"stty size\" command must be able to\n"
140 "display the screen's current row and column geometry. I STRONGLY\n"
141 "RECOMMEND that you make sure you do NOT have the shell variables\n"
142 "LINES and COLUMNS exported into your environment. Some distributions\n"
143 "export those variables via /etc/profile. Some ncurses programs can\n"
144 "become confused when those variables (LINES & COLUMNS) don't reflect\n"
145 "the true screen size.\n"
147 "Optional personality available\n"
148 "------------------------------\n"
149 "If you prefer to have all of the options listed in a single menu,\n"
150 "rather than the default multimenu hierarchy, run the menuconfig with\n"
151 "MENUCONFIG_MODE environment variable set to single_menu. Example:\n"
153 "make MENUCONFIG_MODE=single_menu menuconfig\n"
155 "<Enter> will then unroll the appropriate category, or enfold it if it\n"
156 "is already unrolled.\n"
158 "Note that this mode can eventually be a little more CPU expensive\n"
159 "(especially with a larger number of unrolled categories) than the\n"
165 "Pressing the forward-slash (/) anywhere brings up a search dialog box.\n"
168 "Different color themes available\n"
169 "--------------------------------\n"
170 "It is possible to select different color themes using the variable\n"
171 "MENUCONFIG_COLOR. To select a theme use:\n"
173 "make MENUCONFIG_COLOR=<theme> menuconfig\n"
175 "Available themes are\n"
176 " mono => selects colors suitable for monochrome displays\n"
177 " blackbg => selects a color scheme with black background\n"
178 " classic => theme with blue background. The classic look\n"
179 " bluetitle => an LCD friendly version of classic. (default)\n"
181 menu_instructions[] =
182 "Arrow keys navigate the menu. "
183 "<Enter> selects submenus ---> (or empty submenus ----). "
184 "Highlighted letters are hotkeys. "
185 "Pressing <Y> includes, <N> excludes, <M> modularizes features. "
186 "Press <Esc><Esc> to exit, <?> for Help, </> for Search. "
187 "Legend: [*] built-in [ ] excluded <M> module < > module capable",
188 radiolist_instructions[] =
189 "Use the arrow keys to navigate this window or "
190 "press the hotkey of the item you wish to select "
191 "followed by the <SPACE BAR>. "
192 "Press <?> for additional information about this option.",
193 inputbox_instructions_int[] =
194 "Please enter a decimal value. "
195 "Fractions will not be accepted. "
196 "Use the <TAB> key to move from the input field to the buttons below it.",
197 inputbox_instructions_hex[] =
198 "Please enter a hexadecimal value. "
199 "Use the <TAB> key to move from the input field to the buttons below it.",
200 inputbox_instructions_string[] =
201 "Please enter a string value. "
202 "Use the <TAB> key to move from the input field to the buttons below it.",
204 "This feature depends on another which has been configured as a module.\n"
205 "As a result, this feature will be built as a module.",
207 "Enter the name of the configuration file you wish to load. "
208 "Accept the name shown to restore the configuration you "
209 "last retrieved. Leave blank to abort.",
212 "For various reasons, one may wish to keep several different\n"
213 "configurations available on a single machine.\n"
215 "If you have saved a previous configuration in a file other than the\n"
216 "default one, entering its name here will allow you to modify that\n"
219 "If you are uncertain, then you have probably never used alternate\n"
220 "configuration files. You should therefore leave this blank to abort.\n",
222 "Enter a filename to which this configuration should be saved "
223 "as an alternate. Leave blank to abort.",
226 "For various reasons, one may wish to keep different configurations\n"
227 "available on a single machine.\n"
229 "Entering a file name here will allow you to later retrieve, modify\n"
230 "and use the current configuration as an alternate to whatever\n"
231 "configuration options you have selected at that time.\n"
233 "If you are uncertain what all this means then you should probably\n"
234 "leave this blank.\n",
237 "Search for symbols and display their relations.\n"
238 "Regular expressions are allowed.\n"
239 "Example: search for \"^FOO\"\n"
241 "-----------------------------------------------------------------\n"
244 "Prompt: Foo bus is used to drive the bar HW\n"
246 " -> Bus options (PCI, PCMCIA, EISA, ISA)\n"
247 " -> PCI support (PCI [=y])\n"
248 "(1) -> PCI access mode (<choice> [=y])\n"
249 " Defined at drivers/pci/Kconfig:47\n"
250 " Depends on: X86_LOCAL_APIC && X86_IO_APIC || IA64\n"
251 " Selects: LIBCRC32\n"
252 " Selected by: BAR [=n]\n"
253 "-----------------------------------------------------------------\n"
254 "o The line 'Type:' shows the type of the configuration option for\n"
255 " this symbol (bool, tristate, string, ...)\n"
256 "o The line 'Prompt:' shows the text used in the menu structure for\n"
258 "o The 'Defined at' line tells at what file / line number the symbol\n"
260 "o The 'Depends on:' line tells what symbols need to be defined for\n"
261 " this symbol to be visible in the menu (selectable)\n"
262 "o The 'Location:' lines tells where in the menu structure this symbol\n"
264 " A location followed by a [=y] indicates that this is a\n"
265 " selectable menu item - and the current value is displayed inside\n"
267 " Press the key in the (#) prefix to jump directly to that\n"
268 " location. You will be returned to the current search results\n"
269 " after exiting this new menu.\n"
270 "o The 'Selects:' line tells what symbols will be automatically\n"
271 " selected if this symbol is selected (y or m)\n"
272 "o The 'Selected by' line tells what symbol has selected this symbol\n"
274 "Only relevant lines are shown.\n"
277 "Examples: USB => find all symbols containing USB\n"
278 " ^USB => find all symbols starting with USB\n"
279 " USB$ => find all symbols ending with USB\n"
283 static struct menu *current_menu;
284 static int child_count;
285 static int single_menu_mode;
286 static int show_all_options;
287 static int save_and_exit;
289 static int jump_key_char;
291 static void conf(struct menu *menu, struct menu *active_menu);
293 static char filename[PATH_MAX+1];
294 static void set_config_filename(const char *config_filename)
296 static char menu_backtitle[PATH_MAX+128];
298 snprintf(menu_backtitle, sizeof(menu_backtitle), "%s - %s",
299 config_filename, rootmenu.prompt->text);
300 set_dialog_backtitle(menu_backtitle);
302 snprintf(filename, sizeof(filename), "%s", config_filename);
305 struct subtitle_part {
306 struct list_head entries;
309 static LIST_HEAD(trail);
311 static struct subtitle_list *subtitles;
312 static void set_subtitle(void)
314 struct subtitle_part *sp;
315 struct subtitle_list *pos, *tmp;
317 for (pos = subtitles; pos != NULL; pos = tmp) {
323 list_for_each_entry(sp, &trail, entries) {
326 pos->next = xcalloc(1, sizeof(*pos));
329 subtitles = pos = xcalloc(1, sizeof(*pos));
331 pos->text = sp->text;
335 set_dialog_subtitles(subtitles);
338 static void reset_subtitle(void)
340 struct subtitle_list *pos, *tmp;
342 for (pos = subtitles; pos != NULL; pos = tmp) {
347 set_dialog_subtitles(subtitles);
350 static int show_textbox_ext(const char *title, const char *text, int r, int c,
351 int *vscroll, int *hscroll,
352 int (*extra_key_cb)(int, size_t, size_t, void *),
356 return dialog_textbox(title, text, r, c, vscroll, hscroll,
360 static void show_textbox(const char *title, const char *text, int r, int c)
362 show_textbox_ext(title, text, r, c, NULL, NULL, NULL, NULL);
365 static void show_helptext(const char *title, const char *text)
367 show_textbox(title, text, 0, 0);
370 static void show_help(struct menu *menu)
372 struct gstr help = str_new();
374 help.max_width = getmaxx(stdscr) - 10;
375 menu_get_ext_help(menu, &help);
377 show_helptext(menu_get_prompt(menu), str_get(&help));
382 struct list_head *head;
386 static int next_jump_key(int key)
388 if (key < '1' || key > '9')
399 static int handle_search_keys(int key, size_t start, size_t end, void *_data)
401 struct search_data *data = _data;
402 struct jump_key *pos;
405 if (key < '1' || key > '9')
408 list_for_each_entry(pos, data->head, entries) {
409 index = next_jump_key(index);
411 if (pos->offset < start)
414 if (pos->offset >= end)
418 data->target = pos->target;
426 int get_jump_key_char(void)
428 jump_key_char = next_jump_key(jump_key_char);
430 return jump_key_char;
433 static void search_conf(void)
435 struct symbol **sym_arr;
439 int dres, vscroll = 0, hscroll = 0;
442 struct subtitle_part stpart;
445 str_printf( &title, "Enter (sub)string or regexp to search for "
446 "(with or without \"%s\")", CONFIG_);
450 dres = dialog_inputbox("Search Configuration Parameter",
457 show_helptext("Search Configuration", search_help);
464 /* strip the prefix if necessary */
465 dialog_input = dialog_input_result;
466 if (strncasecmp(dialog_input_result, CONFIG_, strlen(CONFIG_)) == 0)
467 dialog_input += strlen(CONFIG_);
470 str_printf(&sttext, "Search (%s)", dialog_input_result);
471 stpart.text = str_get(&sttext);
472 list_add_tail(&stpart.entries, &trail);
474 sym_arr = sym_re_search(dialog_input);
477 struct search_data data = {
480 struct jump_key *pos, *tmp;
483 res = get_relations_str(sym_arr, &head);
485 dres = show_textbox_ext("Search Results", str_get(&res), 0, 0,
487 handle_search_keys, &data);
489 if (dres >= '1' && dres <= '9') {
490 assert(data.target != NULL);
491 conf(data.target->parent, data.target);
495 list_for_each_entry_safe(pos, tmp, &head, entries)
500 list_del(trail.prev);
504 static void build_conf(struct menu *menu)
507 struct property *prop;
509 int type, tmp, doint = 2;
515 * note: menu_is_visible() has side effect that it will
516 * recalc the value of the symbol.
518 visible = menu_is_visible(menu);
519 if (show_all_options && !menu_has_prompt(menu))
521 else if (!show_all_options && !visible)
527 if (prop && menu != current_menu) {
528 const char *prompt = menu_get_prompt(menu);
529 switch (prop->type) {
532 if (single_menu_mode) {
534 menu->data ? "-->" : "++>",
535 indent + 1, ' ', prompt);
537 item_make(" %*c%s %s",
538 indent + 1, ' ', prompt,
539 menu_is_empty(menu) ? "----" : "--->");
542 if (single_menu_mode && menu->data)
548 item_make(" %*c*** %s ***", indent + 1, ' ', prompt);
556 item_make("---%*c%s", indent + 1, ' ', prompt);
566 type = sym_get_type(sym);
567 if (sym_is_choice(sym)) {
568 struct symbol *def_sym = sym_get_choice_value(sym);
569 struct menu *def_menu = NULL;
572 for (child = menu->list; child; child = child->next) {
573 if (menu_is_visible(child) && child->sym == def_sym)
577 val = sym_get_tristate_value(sym);
578 if (sym_is_changeable(sym)) {
581 item_make("[%c]", val == no ? ' ' : '*');
585 case yes: ch = '*'; break;
586 case mod: ch = 'M'; break;
587 default: ch = ' '; break;
589 item_make("<%c>", ch);
596 item_set_tag(def_menu ? 't' : ':');
600 item_add_str("%*c%s", indent + 1, ' ', menu_get_prompt(menu));
603 item_add_str(" (%s)", menu_get_prompt(def_menu));
604 item_add_str(" --->");
605 if (def_menu->list) {
607 build_conf(def_menu);
614 if (menu == current_menu) {
615 item_make("---%*c%s", indent + 1, ' ', menu_get_prompt(menu));
621 val = sym_get_tristate_value(sym);
622 if (sym_is_choice_value(sym) && val == yes) {
629 if (sym_is_changeable(sym))
630 item_make("[%c]", val == no ? ' ' : '*');
632 item_make("-%c-", val == no ? ' ' : '*');
638 case yes: ch = '*'; break;
639 case mod: ch = 'M'; break;
640 default: ch = ' '; break;
642 if (sym_is_changeable(sym)) {
643 if (sym->rev_dep.tri == mod)
644 item_make("{%c}", ch);
646 item_make("<%c>", ch);
648 item_make("-%c-", ch);
653 tmp = 2 + strlen(sym_get_string_value(sym)); /* () = 2 */
654 item_make("(%s)", sym_get_string_value(sym));
655 tmp = indent - tmp + 4;
658 item_add_str("%*c%s%s", tmp, ' ', menu_get_prompt(menu),
659 (sym_has_value(sym) || !sym_is_changeable(sym)) ?
666 item_add_str("%*c%s%s", indent + 1, ' ', menu_get_prompt(menu),
667 (sym_has_value(sym) || !sym_is_changeable(sym)) ?
669 if (menu->prompt->type == P_MENU) {
670 item_add_str(" %s", menu_is_empty(menu) ? "----" : "--->");
677 for (child = menu->list; child; child = child->next)
682 static void conf_choice(struct menu *menu)
684 const char *prompt = menu_get_prompt(menu);
686 struct symbol *active;
688 active = sym_get_choice_value(menu->sym);
695 for (child = menu->list; child; child = child->next) {
696 if (!menu_is_visible(child))
699 item_make("%s", menu_get_prompt(child));
701 item_make("*** %s ***", menu_get_prompt(child));
704 item_set_data(child);
705 if (child->sym == active)
706 item_set_selected(1);
707 if (child->sym == sym_get_choice_value(menu->sym))
711 res = dialog_checklist(prompt ? prompt : "Main Menu",
712 radiolist_instructions,
715 CHECKLIST_HEIGTH_MIN);
716 selected = item_activate_selected();
724 sym_set_tristate_value(child->sym, yes);
737 case -ERRDISPLAYTOOSMALL:
743 static void conf_string(struct menu *menu)
745 const char *prompt = menu_get_prompt(menu);
751 switch (sym_get_type(menu->sym)) {
753 heading = inputbox_instructions_int;
756 heading = inputbox_instructions_hex;
759 heading = inputbox_instructions_string;
762 heading = "Internal mconf error!";
765 res = dialog_inputbox(prompt ? prompt : "Main Menu",
767 sym_get_string_value(menu->sym));
770 if (sym_set_string_value(menu->sym, dialog_input_result))
772 show_textbox(NULL, "You have made an invalid entry.", 5, 43);
783 static void conf_load(void)
789 res = dialog_inputbox(NULL, load_config_text,
793 if (!dialog_input_result[0])
795 if (!conf_read(dialog_input_result)) {
796 set_config_filename(dialog_input_result);
797 conf_set_changed(true);
800 show_textbox(NULL, "File does not exist!", 5, 38);
803 show_helptext("Load Alternate Configuration", load_config_help);
811 static void conf_save(void)
816 res = dialog_inputbox(NULL, save_config_text,
820 if (!dialog_input_result[0])
822 if (!conf_write(dialog_input_result)) {
823 set_config_filename(dialog_input_result);
826 show_textbox(NULL, "Can't create file!", 5, 60);
829 show_helptext("Save Alternate Configuration", save_config_help);
837 static void conf(struct menu *menu, struct menu *active_menu)
839 struct menu *submenu;
840 const char *prompt = menu_get_prompt(menu);
841 struct subtitle_part stpart;
846 if (menu != &rootmenu)
847 stpart.text = menu_get_prompt(menu);
850 list_add_tail(&stpart.entries, &trail);
860 res = dialog_menu(prompt ? prompt : "Main Menu",
862 active_menu, &s_scroll);
863 if (res == 1 || res == KEY_ESC || res == -ERRDISPLAYTOOSMALL)
865 if (item_count() != 0) {
866 if (!item_activate_selected())
871 submenu = item_data();
872 active_menu = item_data();
880 switch (item_tag()) {
882 if (single_menu_mode)
883 submenu->data = (void *) (long) !submenu->data;
888 if (sym_is_choice(sym) && sym_get_tristate_value(sym) == yes)
889 conf_choice(submenu);
890 else if (submenu->prompt->type == P_MENU)
894 conf_string(submenu);
903 show_helptext("README", mconf_readme);
915 if (item_is_tag('t')) {
916 if (sym_set_tristate_value(sym, yes))
918 if (sym_set_tristate_value(sym, mod))
919 show_textbox(NULL, setmod_text, 6, 74);
923 if (item_is_tag('t'))
924 sym_set_tristate_value(sym, no);
927 if (item_is_tag('t'))
928 sym_set_tristate_value(sym, mod);
931 if (item_is_tag('t'))
932 sym_toggle_tristate_value(sym);
933 else if (item_is_tag('m'))
940 show_all_options = !show_all_options;
945 list_del(trail.prev);
948 static void conf_message_callback(const char *s)
954 show_textbox(NULL, s, 6, 60);
958 static int handle_exit(void)
965 if (conf_get_changed())
966 res = dialog_yesno(NULL,
967 "Do you wish to save your new configuration?\n"
968 "(Press <ESC><ESC> to continue kernel configuration.)",
973 end_dialog(saved_x, saved_y);
977 if (conf_write(filename)) {
978 fprintf(stderr, "\n\n"
979 "Error while writing of the configuration.\n"
980 "Your configuration changes were NOT saved."
984 conf_write_autoconf(0);
989 "*** End of the configuration.\n"
990 "*** Execute 'make' to start the build or try 'make help'."
996 fprintf(stderr, "\n\n"
997 "Your configuration changes were NOT saved."
1006 static void sig_handler(int signo)
1008 exit(handle_exit());
1011 int main(int ac, char **av)
1016 signal(SIGINT, sig_handler);
1018 if (ac > 1 && strcmp(av[1], "-s") == 0) {
1020 /* Silence conf_read() until the real callback is set up */
1021 conf_set_message_callback(NULL);
1027 mode = getenv("MENUCONFIG_MODE");
1029 if (!strcasecmp(mode, "single_menu"))
1030 single_menu_mode = 1;
1033 if (init_dialog(NULL)) {
1034 fprintf(stderr, "Your display is too small to run Menuconfig!\n");
1035 fprintf(stderr, "It must be at least 19 lines by 80 columns.\n");
1039 set_config_filename(conf_get_configname());
1040 conf_set_message_callback(conf_message_callback);
1042 conf(&rootmenu, NULL);
1043 res = handle_exit();
1044 } while (res == KEY_ESC);