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"
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 => an LCD friendly version of classic. (default)\n"
177 menu_instructions[] =
178 "Arrow keys navigate the menu. "
179 "<Enter> selects submenus ---> (or empty 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[] =
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[] =
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[] =
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[] =
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.",
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.",
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",
218 "Enter a filename to which this configuration should be saved "
219 "as an alternate. Leave blank to abort.",
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"
242 " -> Bus options (PCI, PCMCIA, EISA, ISA)\n"
243 " -> PCI support (PCI [=y])\n"
244 "(1) -> PCI access mode (<choice> [=y])\n"
245 " Defined at drivers/pci/Kconfig:47\n"
246 " Depends on: X86_LOCAL_APIC && X86_IO_APIC || IA64\n"
247 " Selects: LIBCRC32\n"
248 " Selected by: BAR [=n]\n"
249 "-----------------------------------------------------------------\n"
250 "o The line 'Type:' shows the type of the configuration option for\n"
251 " this symbol (bool, tristate, string, ...)\n"
252 "o The line 'Prompt:' shows the text used in the menu structure for\n"
254 "o The 'Defined at' line tells at what file / line number the symbol\n"
256 "o The 'Depends on:' line tells what symbols need to be defined for\n"
257 " this symbol to be visible in the menu (selectable)\n"
258 "o The 'Location:' lines tells 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 tells what symbols will be automatically\n"
267 " selected if this symbol is selected (y or m)\n"
268 "o The 'Selected by' line tells 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;
286 static void conf(struct menu *menu, struct menu *active_menu);
287 static void conf_choice(struct menu *menu);
288 static void conf_string(struct menu *menu);
289 static void conf_load(void);
290 static void conf_save(void);
291 static int show_textbox_ext(const char *title, char *text, int r, int c,
292 int *keys, int *vscroll, int *hscroll,
293 update_text_fn update_text, void *data);
294 static void show_textbox(const char *title, const char *text, int r, int c);
295 static void show_helptext(const char *title, const char *text);
296 static void show_help(struct menu *menu);
298 static char filename[PATH_MAX+1];
299 static void set_config_filename(const char *config_filename)
301 static char menu_backtitle[PATH_MAX+128];
303 snprintf(menu_backtitle, sizeof(menu_backtitle), "%s - %s",
304 config_filename, rootmenu.prompt->text);
305 set_dialog_backtitle(menu_backtitle);
307 snprintf(filename, sizeof(filename), "%s", config_filename);
310 struct subtitle_part {
311 struct list_head entries;
314 static LIST_HEAD(trail);
316 static struct subtitle_list *subtitles;
317 static void set_subtitle(void)
319 struct subtitle_part *sp;
320 struct subtitle_list *pos, *tmp;
322 for (pos = subtitles; pos != NULL; pos = tmp) {
328 list_for_each_entry(sp, &trail, entries) {
331 pos->next = xcalloc(1, sizeof(*pos));
334 subtitles = pos = xcalloc(1, sizeof(*pos));
336 pos->text = sp->text;
340 set_dialog_subtitles(subtitles);
343 static void reset_subtitle(void)
345 struct subtitle_list *pos, *tmp;
347 for (pos = subtitles; pos != NULL; pos = tmp) {
352 set_dialog_subtitles(subtitles);
356 struct list_head *head;
357 struct menu **targets;
361 static void update_text(char *buf, size_t start, size_t end, void *_data)
363 struct search_data *data = _data;
364 struct jump_key *pos;
367 list_for_each_entry(pos, data->head, entries) {
368 if (pos->offset >= start && pos->offset < end) {
372 int key = '0' + (pos->index % JUMP_NB) + 1;
374 sprintf(header, "(%c)", key);
376 data->targets[k] = pos->target;
379 sprintf(header, " ");
382 memcpy(buf + pos->offset, header, sizeof(header) - 1);
388 static void search_conf(void)
390 struct symbol **sym_arr;
394 int dres, vscroll = 0, hscroll = 0;
397 struct subtitle_part stpart;
400 str_printf( &title, "Enter (sub)string or regexp to search for "
401 "(with or without \"%s\")", CONFIG_);
405 dres = dialog_inputbox("Search Configuration Parameter",
412 show_helptext("Search Configuration", search_help);
419 /* strip the prefix if necessary */
420 dialog_input = dialog_input_result;
421 if (strncasecmp(dialog_input_result, CONFIG_, strlen(CONFIG_)) == 0)
422 dialog_input += strlen(CONFIG_);
425 str_printf(&sttext, "Search (%s)", dialog_input_result);
426 stpart.text = str_get(&sttext);
427 list_add_tail(&stpart.entries, &trail);
429 sym_arr = sym_re_search(dialog_input);
432 struct menu *targets[JUMP_NB];
433 int keys[JUMP_NB + 1], i;
434 struct search_data data = {
439 struct jump_key *pos, *tmp;
441 res = get_relations_str(sym_arr, &head);
443 dres = show_textbox_ext("Search Results", (char *)
444 str_get(&res), 0, 0, keys, &vscroll,
445 &hscroll, &update_text, (void *)
448 for (i = 0; i < JUMP_NB && keys[i]; i++)
449 if (dres == keys[i]) {
450 conf(targets[i]->parent, targets[i]);
454 list_for_each_entry_safe(pos, tmp, &head, entries)
459 list_del(trail.prev);
463 static void build_conf(struct menu *menu)
466 struct property *prop;
468 int type, tmp, doint = 2;
474 * note: menu_is_visible() has side effect that it will
475 * recalc the value of the symbol.
477 visible = menu_is_visible(menu);
478 if (show_all_options && !menu_has_prompt(menu))
480 else if (!show_all_options && !visible)
486 if (prop && menu != current_menu) {
487 const char *prompt = menu_get_prompt(menu);
488 switch (prop->type) {
491 if (single_menu_mode) {
493 menu->data ? "-->" : "++>",
494 indent + 1, ' ', prompt);
496 item_make(" %*c%s %s",
497 indent + 1, ' ', prompt,
498 menu_is_empty(menu) ? "----" : "--->");
501 if (single_menu_mode && menu->data)
507 item_make(" %*c*** %s ***", indent + 1, ' ', prompt);
515 item_make("---%*c%s", indent + 1, ' ', prompt);
525 type = sym_get_type(sym);
526 if (sym_is_choice(sym)) {
527 struct symbol *def_sym = sym_get_choice_value(sym);
528 struct menu *def_menu = NULL;
531 for (child = menu->list; child; child = child->next) {
532 if (menu_is_visible(child) && child->sym == def_sym)
536 val = sym_get_tristate_value(sym);
537 if (sym_is_changeable(sym)) {
540 item_make("[%c]", val == no ? ' ' : '*');
544 case yes: ch = '*'; break;
545 case mod: ch = 'M'; break;
546 default: ch = ' '; break;
548 item_make("<%c>", ch);
555 item_set_tag(def_menu ? 't' : ':');
559 item_add_str("%*c%s", indent + 1, ' ', menu_get_prompt(menu));
562 item_add_str(" (%s)", menu_get_prompt(def_menu));
563 item_add_str(" --->");
564 if (def_menu->list) {
566 build_conf(def_menu);
573 if (menu == current_menu) {
574 item_make("---%*c%s", indent + 1, ' ', menu_get_prompt(menu));
580 val = sym_get_tristate_value(sym);
581 if (sym_is_choice_value(sym) && val == yes) {
588 if (sym_is_changeable(sym))
589 item_make("[%c]", val == no ? ' ' : '*');
591 item_make("-%c-", val == no ? ' ' : '*');
597 case yes: ch = '*'; break;
598 case mod: ch = 'M'; break;
599 default: ch = ' '; break;
601 if (sym_is_changeable(sym)) {
602 if (sym->rev_dep.tri == mod)
603 item_make("{%c}", ch);
605 item_make("<%c>", ch);
607 item_make("-%c-", ch);
612 tmp = 2 + strlen(sym_get_string_value(sym)); /* () = 2 */
613 item_make("(%s)", sym_get_string_value(sym));
614 tmp = indent - tmp + 4;
617 item_add_str("%*c%s%s", tmp, ' ', menu_get_prompt(menu),
618 (sym_has_value(sym) || !sym_is_changeable(sym)) ?
625 item_add_str("%*c%s%s", indent + 1, ' ', menu_get_prompt(menu),
626 (sym_has_value(sym) || !sym_is_changeable(sym)) ?
628 if (menu->prompt->type == P_MENU) {
629 item_add_str(" %s", menu_is_empty(menu) ? "----" : "--->");
636 for (child = menu->list; child; child = child->next)
641 static void conf(struct menu *menu, struct menu *active_menu)
643 struct menu *submenu;
644 const char *prompt = menu_get_prompt(menu);
645 struct subtitle_part stpart;
650 if (menu != &rootmenu)
651 stpart.text = menu_get_prompt(menu);
654 list_add_tail(&stpart.entries, &trail);
664 res = dialog_menu(prompt ? prompt : "Main Menu",
666 active_menu, &s_scroll);
667 if (res == 1 || res == KEY_ESC || res == -ERRDISPLAYTOOSMALL)
669 if (item_count() != 0) {
670 if (!item_activate_selected())
675 submenu = item_data();
676 active_menu = item_data();
684 switch (item_tag()) {
686 if (single_menu_mode)
687 submenu->data = (void *) (long) !submenu->data;
692 if (sym_is_choice(sym) && sym_get_tristate_value(sym) == yes)
693 conf_choice(submenu);
694 else if (submenu->prompt->type == P_MENU)
698 conf_string(submenu);
707 show_helptext("README", mconf_readme);
719 if (item_is_tag('t')) {
720 if (sym_set_tristate_value(sym, yes))
722 if (sym_set_tristate_value(sym, mod))
723 show_textbox(NULL, setmod_text, 6, 74);
727 if (item_is_tag('t'))
728 sym_set_tristate_value(sym, no);
731 if (item_is_tag('t'))
732 sym_set_tristate_value(sym, mod);
735 if (item_is_tag('t'))
736 sym_toggle_tristate_value(sym);
737 else if (item_is_tag('m'))
744 show_all_options = !show_all_options;
749 list_del(trail.prev);
752 static int show_textbox_ext(const char *title, char *text, int r, int c, int
753 *keys, int *vscroll, int *hscroll, update_text_fn
754 update_text, void *data)
757 return dialog_textbox(title, text, r, c, keys, vscroll, hscroll,
761 static void show_textbox(const char *title, const char *text, int r, int c)
763 show_textbox_ext(title, (char *) text, r, c, (int []) {0}, NULL, NULL,
767 static void show_helptext(const char *title, const char *text)
769 show_textbox(title, text, 0, 0);
772 static void conf_message_callback(const char *s)
778 show_textbox(NULL, s, 6, 60);
782 static void show_help(struct menu *menu)
784 struct gstr help = str_new();
786 help.max_width = getmaxx(stdscr) - 10;
787 menu_get_ext_help(menu, &help);
789 show_helptext(menu_get_prompt(menu), str_get(&help));
793 static void conf_choice(struct menu *menu)
795 const char *prompt = menu_get_prompt(menu);
797 struct symbol *active;
799 active = sym_get_choice_value(menu->sym);
806 for (child = menu->list; child; child = child->next) {
807 if (!menu_is_visible(child))
810 item_make("%s", menu_get_prompt(child));
812 item_make("*** %s ***", menu_get_prompt(child));
815 item_set_data(child);
816 if (child->sym == active)
817 item_set_selected(1);
818 if (child->sym == sym_get_choice_value(menu->sym))
822 res = dialog_checklist(prompt ? prompt : "Main Menu",
823 radiolist_instructions,
826 CHECKLIST_HEIGTH_MIN);
827 selected = item_activate_selected();
835 sym_set_tristate_value(child->sym, yes);
848 case -ERRDISPLAYTOOSMALL:
854 static void conf_string(struct menu *menu)
856 const char *prompt = menu_get_prompt(menu);
862 switch (sym_get_type(menu->sym)) {
864 heading = inputbox_instructions_int;
867 heading = inputbox_instructions_hex;
870 heading = inputbox_instructions_string;
873 heading = "Internal mconf error!";
876 res = dialog_inputbox(prompt ? prompt : "Main Menu",
878 sym_get_string_value(menu->sym));
881 if (sym_set_string_value(menu->sym, dialog_input_result))
883 show_textbox(NULL, "You have made an invalid entry.", 5, 43);
894 static void conf_load(void)
900 res = dialog_inputbox(NULL, load_config_text,
904 if (!dialog_input_result[0])
906 if (!conf_read(dialog_input_result)) {
907 set_config_filename(dialog_input_result);
908 conf_set_changed(true);
911 show_textbox(NULL, "File does not exist!", 5, 38);
914 show_helptext("Load Alternate Configuration", load_config_help);
922 static void conf_save(void)
927 res = dialog_inputbox(NULL, save_config_text,
931 if (!dialog_input_result[0])
933 if (!conf_write(dialog_input_result)) {
934 set_config_filename(dialog_input_result);
937 show_textbox(NULL, "Can't create file!", 5, 60);
940 show_helptext("Save Alternate Configuration", save_config_help);
948 static int handle_exit(void)
955 if (conf_get_changed())
956 res = dialog_yesno(NULL,
957 "Do you wish to save your new configuration?\n"
958 "(Press <ESC><ESC> to continue kernel configuration.)",
963 end_dialog(saved_x, saved_y);
967 if (conf_write(filename)) {
968 fprintf(stderr, "\n\n"
969 "Error while writing of the configuration.\n"
970 "Your configuration changes were NOT saved."
974 conf_write_autoconf(0);
979 "*** End of the configuration.\n"
980 "*** 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 signal(SIGINT, sig_handler);
1008 if (ac > 1 && strcmp(av[1], "-s") == 0) {
1010 /* Silence conf_read() until the real callback is set up */
1011 conf_set_message_callback(NULL);
1017 mode = getenv("MENUCONFIG_MODE");
1019 if (!strcasecmp(mode, "single_menu"))
1020 single_menu_mode = 1;
1023 if (init_dialog(NULL)) {
1024 fprintf(stderr, "Your display is too small to run Menuconfig!\n");
1025 fprintf(stderr, "It must be at least 19 lines by 80 columns.\n");
1029 set_config_filename(conf_get_configname());
1030 conf_set_message_callback(conf_message_callback);
1032 conf(&rootmenu, NULL);
1033 res = handle_exit();
1034 } while (res == KEY_ESC);