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>
22 #include "lxdialog/dialog.h"
24 static const char mconf_readme[] =
27 "This interface lets you select features and parameters for the build.\n"
28 "Features can either be built-in, modularized, or ignored. Parameters\n"
29 "must be entered in as decimal or hexadecimal numbers or text.\n"
31 "Menu items beginning with following braces represent features that\n"
32 " [ ] can be built in or removed\n"
33 " < > can be built in, modularized or removed\n"
34 " { } can be built in or modularized (selected by other feature)\n"
35 " - - are selected by other feature,\n"
36 "while *, M or whitespace inside braces means to build in, build as\n"
37 "a module or to exclude the feature respectively.\n"
39 "To change any of these features, highlight it with the cursor\n"
40 "keys and press <Y> to build it in, <M> to make it a module or\n"
41 "<N> to remove it. You may also press the <Space Bar> to cycle\n"
42 "through the available options (i.e. Y->N->M->Y).\n"
44 "Some additional keyboard hints:\n"
48 "o Use the Up/Down arrow keys (cursor keys) to highlight the item you\n"
49 " wish to change or the submenu you wish to select and press <Enter>.\n"
50 " Submenus are designated by \"--->\", empty ones by \"----\".\n"
52 " Shortcut: Press the option's highlighted letter (hotkey).\n"
53 " Pressing a hotkey more than once will sequence\n"
54 " through all visible items which use that hotkey.\n"
56 " You may also use the <PAGE UP> and <PAGE DOWN> keys to scroll\n"
57 " unseen options into view.\n"
59 "o To exit a menu use the cursor keys to highlight the <Exit> button\n"
60 " and press <ENTER>.\n"
62 " Shortcut: Press <ESC><ESC> or <E> or <X> if there is no hotkey\n"
63 " using those letters. You may press a single <ESC>, but\n"
64 " there is a delayed response which you may find annoying.\n"
66 " Also, the <TAB> and cursor keys will cycle between <Select>,\n"
67 " <Exit>, <Help>, <Save>, and <Load>.\n"
69 "o To get help with an item, use the cursor keys to highlight <Help>\n"
70 " and press <ENTER>.\n"
72 " Shortcut: Press <H> or <?>.\n"
74 "o To toggle the display of hidden options, press <Z>.\n"
77 "Radiolists (Choice lists)\n"
79 "o Use the cursor keys to select the option you wish to set and press\n"
80 " <S> or the <SPACE BAR>.\n"
82 " Shortcut: Press the first letter of the option you wish to set then\n"
83 " press <S> or <SPACE BAR>.\n"
85 "o To see available help for the item, use the cursor keys to highlight\n"
86 " <Help> and Press <ENTER>.\n"
88 " Shortcut: Press <H> or <?>.\n"
90 " Also, the <TAB> and cursor keys will cycle between <Select> and\n"
96 "o Enter the requested information and press <ENTER>\n"
97 " If you are entering hexadecimal values, it is not necessary to\n"
98 " add the '0x' prefix to the entry.\n"
100 "o For help, use the <TAB> or cursor keys to highlight the help option\n"
101 " and press <ENTER>. You can try <TAB><H> as well.\n"
104 "Text Box (Help Window)\n"
106 "o Use the cursor keys to scroll up/down/left/right. The VI editor\n"
107 " keys h,j,k,l function here as do <u>, <d>, <SPACE BAR> and <B> for\n"
108 " those who are familiar with less and lynx.\n"
110 "o Press <E>, <X>, <q>, <Enter> or <Esc><Esc> to exit.\n"
113 "Alternate Configuration Files\n"
114 "-----------------------------\n"
115 "Menuconfig supports the use of alternate configuration files for\n"
116 "those who, for various reasons, find it necessary to switch\n"
117 "between different configurations.\n"
119 "The <Save> button will let you save the current configuration to\n"
120 "a file of your choosing. Use the <Load> button to load a previously\n"
121 "saved alternate configuration.\n"
123 "Even if you don't use alternate configuration files, but you find\n"
124 "during a Menuconfig session that you have completely messed up your\n"
125 "settings, you may use the <Load> button to restore your previously\n"
126 "saved settings from \".config\" without restarting Menuconfig.\n"
128 "Other information\n"
129 "-----------------\n"
130 "If you use Menuconfig in an XTERM window, make sure you have your\n"
131 "$TERM variable set to point to an xterm definition which supports\n"
132 "color. Otherwise, Menuconfig will look rather bad. Menuconfig will\n"
133 "not display correctly in an RXVT window because rxvt displays only one\n"
134 "intensity of color, bright.\n"
136 "Menuconfig will display larger menus on screens or xterms which are\n"
137 "set to display more than the standard 25 row by 80 column geometry.\n"
138 "In order for this to work, the \"stty size\" command must be able to\n"
139 "display the screen's current row and column geometry. I STRONGLY\n"
140 "RECOMMEND that you make sure you do NOT have the shell variables\n"
141 "LINES and COLUMNS exported into your environment. Some distributions\n"
142 "export those variables via /etc/profile. Some ncurses programs can\n"
143 "become confused when those variables (LINES & COLUMNS) don't reflect\n"
144 "the true screen size.\n"
146 "Optional personality available\n"
147 "------------------------------\n"
148 "If you prefer to have all of the options listed in a single menu,\n"
149 "rather than the default multimenu hierarchy, run the menuconfig with\n"
150 "MENUCONFIG_MODE environment variable set to single_menu. Example:\n"
152 "make MENUCONFIG_MODE=single_menu menuconfig\n"
154 "<Enter> will then unroll the appropriate category, or enfold it if it\n"
155 "is already unrolled.\n"
157 "Note that this mode can eventually be a little more CPU expensive\n"
158 "(especially with a larger number of unrolled categories) than the\n"
161 "Different color themes available\n"
162 "--------------------------------\n"
163 "It is possible to select different color themes using the variable\n"
164 "MENUCONFIG_COLOR. To select a theme use:\n"
166 "make MENUCONFIG_COLOR=<theme> menuconfig\n"
168 "Available themes are\n"
169 " mono => selects colors suitable for monochrome displays\n"
170 " blackbg => selects a color scheme with black background\n"
171 " classic => theme with blue background. The classic look\n"
172 " bluetitle => an LCD friendly version of classic. (default)\n"
174 menu_instructions[] =
175 "Arrow keys navigate the menu. "
176 "<Enter> selects submenus ---> (or empty submenus ----). "
177 "Highlighted letters are hotkeys. "
178 "Pressing <Y> includes, <N> excludes, <M> modularizes features. "
179 "Press <Esc><Esc> to exit, <?> for Help, </> for Search. "
180 "Legend: [*] built-in [ ] excluded <M> module < > module capable",
181 radiolist_instructions[] =
182 "Use the arrow keys to navigate this window or "
183 "press the hotkey of the item you wish to select "
184 "followed by the <SPACE BAR>. "
185 "Press <?> for additional information about this option.",
186 inputbox_instructions_int[] =
187 "Please enter a decimal value. "
188 "Fractions will not be accepted. "
189 "Use the <TAB> key to move from the input field to the buttons below it.",
190 inputbox_instructions_hex[] =
191 "Please enter a hexadecimal value. "
192 "Use the <TAB> key to move from the input field to the buttons below it.",
193 inputbox_instructions_string[] =
194 "Please enter a string value. "
195 "Use the <TAB> key to move from the input field to the buttons below it.",
197 "This feature depends on another which has been configured as a module.\n"
198 "As a result, this feature will be built as a module.",
200 "Enter the name of the configuration file you wish to load. "
201 "Accept the name shown to restore the configuration you "
202 "last retrieved. Leave blank to abort.",
205 "For various reasons, one may wish to keep several different\n"
206 "configurations available on a single machine.\n"
208 "If you have saved a previous configuration in a file other than the\n"
209 "default one, entering its name here will allow you to modify that\n"
212 "If you are uncertain, then you have probably never used alternate\n"
213 "configuration files. You should therefore leave this blank to abort.\n",
215 "Enter a filename to which this configuration should be saved "
216 "as an alternate. Leave blank to abort.",
219 "For various reasons, one may wish to keep different configurations\n"
220 "available on a single machine.\n"
222 "Entering a file name here will allow you to later retrieve, modify\n"
223 "and use the current configuration as an alternate to whatever\n"
224 "configuration options you have selected at that time.\n"
226 "If you are uncertain what all this means then you should probably\n"
227 "leave this blank.\n",
230 "Search for symbols and display their relations.\n"
231 "Regular expressions are allowed.\n"
232 "Example: search for \"^FOO\"\n"
234 "-----------------------------------------------------------------\n"
237 "Prompt: Foo bus is used to drive the bar HW\n"
239 " -> Bus options (PCI, PCMCIA, EISA, ISA)\n"
240 " -> PCI support (PCI [=y])\n"
241 "(1) -> PCI access mode (<choice> [=y])\n"
242 " Defined at drivers/pci/Kconfig:47\n"
243 " Depends on: X86_LOCAL_APIC && X86_IO_APIC || IA64\n"
244 " Selects: LIBCRC32\n"
245 " Selected by: BAR [=n]\n"
246 "-----------------------------------------------------------------\n"
247 "o The line 'Type:' shows the type of the configuration option for\n"
248 " this symbol (bool, tristate, string, ...)\n"
249 "o The line 'Prompt:' shows the text used in the menu structure for\n"
251 "o The 'Defined at' line tells at what file / line number the symbol\n"
253 "o The 'Depends on:' line tells what symbols need to be defined for\n"
254 " this symbol to be visible in the menu (selectable)\n"
255 "o The 'Location:' lines tells where in the menu structure this symbol\n"
257 " A location followed by a [=y] indicates that this is a\n"
258 " selectable menu item - and the current value is displayed inside\n"
260 " Press the key in the (#) prefix to jump directly to that\n"
261 " location. You will be returned to the current search results\n"
262 " after exiting this new menu.\n"
263 "o The 'Selects:' line tells what symbols will be automatically\n"
264 " selected if this symbol is selected (y or m)\n"
265 "o The 'Selected by' line tells what symbol has selected this symbol\n"
267 "Only relevant lines are shown.\n"
270 "Examples: USB => find all symbols containing USB\n"
271 " ^USB => find all symbols starting with USB\n"
272 " USB$ => find all symbols ending with USB\n"
276 static struct menu *current_menu;
277 static int child_count;
278 static int single_menu_mode;
279 static int show_all_options;
280 static int save_and_exit;
283 static void conf(struct menu *menu, struct menu *active_menu);
284 static void conf_choice(struct menu *menu);
285 static void conf_string(struct menu *menu);
286 static void conf_load(void);
287 static void conf_save(void);
288 static int show_textbox_ext(const char *title, char *text, int r, int c,
289 int *keys, int *vscroll, int *hscroll,
290 update_text_fn update_text, void *data);
291 static void show_textbox(const char *title, const char *text, int r, int c);
292 static void show_helptext(const char *title, const char *text);
293 static void show_help(struct menu *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];
301 size = snprintf(menu_backtitle, sizeof(menu_backtitle),
302 "%s - %s", config_filename, rootmenu.prompt->text);
303 if (size >= sizeof(menu_backtitle))
304 menu_backtitle[sizeof(menu_backtitle)-1] = '\0';
305 set_dialog_backtitle(menu_backtitle);
307 size = snprintf(filename, sizeof(filename), "%s", config_filename);
308 if (size >= sizeof(filename))
309 filename[sizeof(filename)-1] = '\0';
312 struct subtitle_part {
313 struct list_head entries;
316 static LIST_HEAD(trail);
318 static struct subtitle_list *subtitles;
319 static void set_subtitle(void)
321 struct subtitle_part *sp;
322 struct subtitle_list *pos, *tmp;
324 for (pos = subtitles; pos != NULL; pos = tmp) {
330 list_for_each_entry(sp, &trail, entries) {
333 pos->next = xcalloc(1, sizeof(*pos));
336 subtitles = pos = xcalloc(1, sizeof(*pos));
338 pos->text = sp->text;
342 set_dialog_subtitles(subtitles);
345 static void reset_subtitle(void)
347 struct subtitle_list *pos, *tmp;
349 for (pos = subtitles; pos != NULL; pos = tmp) {
354 set_dialog_subtitles(subtitles);
358 struct list_head *head;
359 struct menu **targets;
363 static void update_text(char *buf, size_t start, size_t end, void *_data)
365 struct search_data *data = _data;
366 struct jump_key *pos;
369 list_for_each_entry(pos, data->head, entries) {
370 if (pos->offset >= start && pos->offset < end) {
374 int key = '0' + (pos->index % JUMP_NB) + 1;
376 sprintf(header, "(%c)", key);
378 data->targets[k] = pos->target;
381 sprintf(header, " ");
384 memcpy(buf + pos->offset, header, sizeof(header) - 1);
390 static void search_conf(void)
392 struct symbol **sym_arr;
396 int dres, vscroll = 0, hscroll = 0;
399 struct subtitle_part stpart;
402 str_printf( &title, "Enter (sub)string or regexp to search for "
403 "(with or without \"%s\")", CONFIG_);
407 dres = dialog_inputbox("Search Configuration Parameter",
414 show_helptext("Search Configuration", search_help);
421 /* strip the prefix if necessary */
422 dialog_input = dialog_input_result;
423 if (strncasecmp(dialog_input_result, CONFIG_, strlen(CONFIG_)) == 0)
424 dialog_input += strlen(CONFIG_);
427 str_printf(&sttext, "Search (%s)", dialog_input_result);
428 stpart.text = str_get(&sttext);
429 list_add_tail(&stpart.entries, &trail);
431 sym_arr = sym_re_search(dialog_input);
434 struct menu *targets[JUMP_NB];
435 int keys[JUMP_NB + 1], i;
436 struct search_data data = {
441 struct jump_key *pos, *tmp;
443 res = get_relations_str(sym_arr, &head);
445 dres = show_textbox_ext("Search Results", (char *)
446 str_get(&res), 0, 0, keys, &vscroll,
447 &hscroll, &update_text, (void *)
450 for (i = 0; i < JUMP_NB && keys[i]; i++)
451 if (dres == keys[i]) {
452 conf(targets[i]->parent, targets[i]);
456 list_for_each_entry_safe(pos, tmp, &head, entries)
461 list_del(trail.prev);
465 static void build_conf(struct menu *menu)
468 struct property *prop;
470 int type, tmp, doint = 2;
476 * note: menu_is_visible() has side effect that it will
477 * recalc the value of the symbol.
479 visible = menu_is_visible(menu);
480 if (show_all_options && !menu_has_prompt(menu))
482 else if (!show_all_options && !visible)
488 if (prop && menu != current_menu) {
489 const char *prompt = menu_get_prompt(menu);
490 switch (prop->type) {
493 if (single_menu_mode) {
495 menu->data ? "-->" : "++>",
496 indent + 1, ' ', prompt);
498 item_make(" %*c%s %s",
499 indent + 1, ' ', prompt,
500 menu_is_empty(menu) ? "----" : "--->");
503 if (single_menu_mode && menu->data)
509 item_make(" %*c*** %s ***", indent + 1, ' ', prompt);
517 item_make("---%*c%s", indent + 1, ' ', prompt);
527 type = sym_get_type(sym);
528 if (sym_is_choice(sym)) {
529 struct symbol *def_sym = sym_get_choice_value(sym);
530 struct menu *def_menu = NULL;
533 for (child = menu->list; child; child = child->next) {
534 if (menu_is_visible(child) && child->sym == def_sym)
538 val = sym_get_tristate_value(sym);
539 if (sym_is_changable(sym)) {
542 item_make("[%c]", val == no ? ' ' : '*');
546 case yes: ch = '*'; break;
547 case mod: ch = 'M'; break;
548 default: ch = ' '; break;
550 item_make("<%c>", ch);
557 item_set_tag(def_menu ? 't' : ':');
561 item_add_str("%*c%s", indent + 1, ' ', menu_get_prompt(menu));
564 item_add_str(" (%s)", menu_get_prompt(def_menu));
565 item_add_str(" --->");
566 if (def_menu->list) {
568 build_conf(def_menu);
575 if (menu == current_menu) {
576 item_make("---%*c%s", indent + 1, ' ', menu_get_prompt(menu));
582 val = sym_get_tristate_value(sym);
583 if (sym_is_choice_value(sym) && val == yes) {
590 if (sym_is_changable(sym))
591 item_make("[%c]", val == no ? ' ' : '*');
593 item_make("-%c-", val == no ? ' ' : '*');
599 case yes: ch = '*'; break;
600 case mod: ch = 'M'; break;
601 default: ch = ' '; break;
603 if (sym_is_changable(sym)) {
604 if (sym->rev_dep.tri == mod)
605 item_make("{%c}", ch);
607 item_make("<%c>", ch);
609 item_make("-%c-", ch);
614 tmp = 2 + strlen(sym_get_string_value(sym)); /* () = 2 */
615 item_make("(%s)", sym_get_string_value(sym));
616 tmp = indent - tmp + 4;
619 item_add_str("%*c%s%s", tmp, ' ', menu_get_prompt(menu),
620 (sym_has_value(sym) || !sym_is_changable(sym)) ?
627 item_add_str("%*c%s%s", indent + 1, ' ', menu_get_prompt(menu),
628 (sym_has_value(sym) || !sym_is_changable(sym)) ?
630 if (menu->prompt->type == P_MENU) {
631 item_add_str(" %s", menu_is_empty(menu) ? "----" : "--->");
638 for (child = menu->list; child; child = child->next)
643 static void conf(struct menu *menu, struct menu *active_menu)
645 struct menu *submenu;
646 const char *prompt = menu_get_prompt(menu);
647 struct subtitle_part stpart;
652 if (menu != &rootmenu)
653 stpart.text = menu_get_prompt(menu);
656 list_add_tail(&stpart.entries, &trail);
666 res = dialog_menu(prompt ? prompt : "Main Menu",
668 active_menu, &s_scroll);
669 if (res == 1 || res == KEY_ESC || res == -ERRDISPLAYTOOSMALL)
671 if (item_count() != 0) {
672 if (!item_activate_selected())
677 submenu = item_data();
678 active_menu = item_data();
686 switch (item_tag()) {
688 if (single_menu_mode)
689 submenu->data = (void *) (long) !submenu->data;
694 if (sym_is_choice(sym) && sym_get_tristate_value(sym) == yes)
695 conf_choice(submenu);
696 else if (submenu->prompt->type == P_MENU)
700 conf_string(submenu);
709 show_helptext("README", mconf_readme);
721 if (item_is_tag('t')) {
722 if (sym_set_tristate_value(sym, yes))
724 if (sym_set_tristate_value(sym, mod))
725 show_textbox(NULL, setmod_text, 6, 74);
729 if (item_is_tag('t'))
730 sym_set_tristate_value(sym, no);
733 if (item_is_tag('t'))
734 sym_set_tristate_value(sym, mod);
737 if (item_is_tag('t'))
738 sym_toggle_tristate_value(sym);
739 else if (item_is_tag('m'))
746 show_all_options = !show_all_options;
751 list_del(trail.prev);
754 static int show_textbox_ext(const char *title, char *text, int r, int c, int
755 *keys, int *vscroll, int *hscroll, update_text_fn
756 update_text, void *data)
759 return dialog_textbox(title, text, r, c, keys, vscroll, hscroll,
763 static void show_textbox(const char *title, const char *text, int r, int c)
765 show_textbox_ext(title, (char *) text, r, c, (int []) {0}, NULL, NULL,
769 static void show_helptext(const char *title, const char *text)
771 show_textbox(title, text, 0, 0);
774 static void conf_message_callback(const char *s)
780 show_textbox(NULL, s, 6, 60);
784 static void show_help(struct menu *menu)
786 struct gstr help = str_new();
788 help.max_width = getmaxx(stdscr) - 10;
789 menu_get_ext_help(menu, &help);
791 show_helptext(menu_get_prompt(menu), str_get(&help));
795 static void conf_choice(struct menu *menu)
797 const char *prompt = menu_get_prompt(menu);
799 struct symbol *active;
801 active = sym_get_choice_value(menu->sym);
808 for (child = menu->list; child; child = child->next) {
809 if (!menu_is_visible(child))
812 item_make("%s", menu_get_prompt(child));
814 item_make("*** %s ***", menu_get_prompt(child));
817 item_set_data(child);
818 if (child->sym == active)
819 item_set_selected(1);
820 if (child->sym == sym_get_choice_value(menu->sym))
824 res = dialog_checklist(prompt ? prompt : "Main Menu",
825 radiolist_instructions,
828 CHECKLIST_HEIGTH_MIN);
829 selected = item_activate_selected();
837 sym_set_tristate_value(child->sym, yes);
850 case -ERRDISPLAYTOOSMALL:
856 static void conf_string(struct menu *menu)
858 const char *prompt = menu_get_prompt(menu);
864 switch (sym_get_type(menu->sym)) {
866 heading = inputbox_instructions_int;
869 heading = inputbox_instructions_hex;
872 heading = inputbox_instructions_string;
875 heading = "Internal mconf error!";
878 res = dialog_inputbox(prompt ? prompt : "Main Menu",
880 sym_get_string_value(menu->sym));
883 if (sym_set_string_value(menu->sym, dialog_input_result))
885 show_textbox(NULL, "You have made an invalid entry.", 5, 43);
896 static void conf_load(void)
902 res = dialog_inputbox(NULL, load_config_text,
906 if (!dialog_input_result[0])
908 if (!conf_read(dialog_input_result)) {
909 set_config_filename(dialog_input_result);
910 sym_set_change_count(1);
913 show_textbox(NULL, "File does not exist!", 5, 38);
916 show_helptext("Load Alternate Configuration", load_config_help);
924 static void conf_save(void)
929 res = dialog_inputbox(NULL, save_config_text,
933 if (!dialog_input_result[0])
935 if (!conf_write(dialog_input_result)) {
936 set_config_filename(dialog_input_result);
939 show_textbox(NULL, "Can't create file! Probably a nonexistent directory.", 5, 60);
942 show_helptext("Save Alternate Configuration", save_config_help);
950 static int handle_exit(void)
957 if (conf_get_changed())
958 res = dialog_yesno(NULL,
959 "Do you wish to save your new configuration?\n"
960 "(Press <ESC><ESC> to continue kernel configuration.)",
965 end_dialog(saved_x, saved_y);
969 if (conf_write(filename)) {
970 fprintf(stderr, "\n\n"
971 "Error while writing of the configuration.\n"
972 "Your configuration changes were NOT saved."
976 conf_write_autoconf(0);
981 "*** End of the configuration.\n"
982 "*** Execute 'make' to start the build or try 'make help'."
988 fprintf(stderr, "\n\n"
989 "Your configuration changes were NOT saved."
998 static void sig_handler(int signo)
1000 exit(handle_exit());
1003 int main(int ac, char **av)
1008 signal(SIGINT, sig_handler);
1010 if (ac > 1 && strcmp(av[1], "-s") == 0) {
1012 /* Silence conf_read() until the real callback is set up */
1013 conf_set_message_callback(NULL);
1019 mode = getenv("MENUCONFIG_MODE");
1021 if (!strcasecmp(mode, "single_menu"))
1022 single_menu_mode = 1;
1025 if (init_dialog(NULL)) {
1026 fprintf(stderr, "Your display is too small to run Menuconfig!\n");
1027 fprintf(stderr, "It must be at least 19 lines by 80 columns.\n");
1031 set_config_filename(conf_get_configname());
1032 conf_set_message_callback(conf_message_callback);
1034 conf(&rootmenu, NULL);
1035 res = handle_exit();
1036 } while (res == KEY_ESC);