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>
25 #include "lxdialog/dialog.h"
26 #include "mnconf-common.h"
28 static const char mconf_readme
[] =
31 "This interface lets you select features and parameters for the build.\n"
32 "Features can either be built-in, modularized, or ignored. Parameters\n"
33 "must be entered in as decimal or hexadecimal numbers or text.\n"
35 "Menu items beginning with following braces represent features that\n"
36 " [ ] can be built in or removed\n"
37 " < > can be built in, modularized or removed\n"
38 " { } can be built in or modularized (selected by other feature)\n"
39 " - - are selected by other feature,\n"
40 "while *, M or whitespace inside braces means to build in, build as\n"
41 "a module or to exclude the feature respectively.\n"
43 "To change any of these features, highlight it with the cursor\n"
44 "keys and press <Y> to build it in, <M> to make it a module or\n"
45 "<N> to remove it. You may also press the <Space Bar> to cycle\n"
46 "through the available options (i.e. Y->N->M->Y).\n"
48 "Some additional keyboard hints:\n"
52 "o Use the Up/Down arrow keys (cursor keys) to highlight the item you\n"
53 " wish to change or the submenu you wish to select and press <Enter>.\n"
54 " Submenus are designated by \"--->\", empty ones by \"----\".\n"
56 " Shortcut: Press the option's highlighted letter (hotkey).\n"
57 " Pressing a hotkey more than once will sequence\n"
58 " through all visible items which use that hotkey.\n"
60 " You may also use the <PAGE UP> and <PAGE DOWN> keys to scroll\n"
61 " unseen options into view.\n"
63 "o To exit a menu use the cursor keys to highlight the <Exit> button\n"
64 " and press <ENTER>.\n"
66 " Shortcut: Press <ESC><ESC> or <E> or <X> if there is no hotkey\n"
67 " using those letters. You may press a single <ESC>, but\n"
68 " there is a delayed response which you may find annoying.\n"
70 " Also, the <TAB> and cursor keys will cycle between <Select>,\n"
71 " <Exit>, <Help>, <Save>, and <Load>.\n"
73 "o To get help with an item, use the cursor keys to highlight <Help>\n"
74 " and press <ENTER>.\n"
76 " Shortcut: Press <H> or <?>.\n"
78 "o To toggle the display of hidden options, press <Z>.\n"
81 "Radiolists (Choice lists)\n"
83 "o Use the cursor keys to select the option you wish to set and press\n"
84 " <S> or the <SPACE BAR>.\n"
86 " Shortcut: Press the first letter of the option you wish to set then\n"
87 " press <S> or <SPACE BAR>.\n"
89 "o To see available help for the item, use the cursor keys to highlight\n"
90 " <Help> and Press <ENTER>.\n"
92 " Shortcut: Press <H> or <?>.\n"
94 " Also, the <TAB> and cursor keys will cycle between <Select> and\n"
100 "o Enter the requested information and press <ENTER>\n"
101 " If you are entering hexadecimal values, it is not necessary to\n"
102 " add the '0x' prefix to the entry.\n"
104 "o For help, use the <TAB> or cursor keys to highlight the help option\n"
105 " and press <ENTER>. You can try <TAB><H> as well.\n"
108 "Text Box (Help Window)\n"
110 "o Use the cursor keys to scroll up/down/left/right. The VI editor\n"
111 " keys h,j,k,l function here as do <u>, <d>, <SPACE BAR> and <B> for\n"
112 " those who are familiar with less and lynx.\n"
114 "o Press <E>, <X>, <q>, <Enter> or <Esc><Esc> to exit.\n"
117 "Alternate Configuration Files\n"
118 "-----------------------------\n"
119 "Menuconfig supports the use of alternate configuration files for\n"
120 "those who, for various reasons, find it necessary to switch\n"
121 "between different configurations.\n"
123 "The <Save> button will let you save the current configuration to\n"
124 "a file of your choosing. Use the <Load> button to load a previously\n"
125 "saved alternate configuration.\n"
127 "Even if you don't use alternate configuration files, but you find\n"
128 "during a Menuconfig session that you have completely messed up your\n"
129 "settings, you may use the <Load> button to restore your previously\n"
130 "saved settings from \".config\" without restarting Menuconfig.\n"
132 "Other information\n"
133 "-----------------\n"
134 "If you use Menuconfig in an XTERM window, make sure you have your\n"
135 "$TERM variable set to point to an xterm definition which supports\n"
136 "color. Otherwise, Menuconfig will look rather bad. Menuconfig will\n"
137 "not display correctly in an RXVT window because rxvt displays only one\n"
138 "intensity of color, bright.\n"
140 "Menuconfig will display larger menus on screens or xterms which are\n"
141 "set to display more than the standard 25 row by 80 column geometry.\n"
142 "In order for this to work, the \"stty size\" command must be able to\n"
143 "display the screen's current row and column geometry. I STRONGLY\n"
144 "RECOMMEND that you make sure you do NOT have the shell variables\n"
145 "LINES and COLUMNS exported into your environment. Some distributions\n"
146 "export those variables via /etc/profile. Some ncurses programs can\n"
147 "become confused when those variables (LINES & COLUMNS) don't reflect\n"
148 "the true screen size.\n"
150 "Optional personality available\n"
151 "------------------------------\n"
152 "If you prefer to have all of the options listed in a single menu,\n"
153 "rather than the default multimenu hierarchy, run the menuconfig with\n"
154 "MENUCONFIG_MODE environment variable set to single_menu. Example:\n"
156 "make MENUCONFIG_MODE=single_menu menuconfig\n"
158 "<Enter> will then unroll the appropriate category, or enfold it if it\n"
159 "is already unrolled.\n"
161 "Note that this mode can eventually be a little more CPU expensive\n"
162 "(especially with a larger number of unrolled categories) than the\n"
168 "Pressing the forward-slash (/) anywhere brings up a search dialog box.\n"
171 "Different color themes available\n"
172 "--------------------------------\n"
173 "It is possible to select different color themes using the variable\n"
174 "MENUCONFIG_COLOR. To select a theme use:\n"
176 "make MENUCONFIG_COLOR=<theme> menuconfig\n"
178 "Available themes are\n"
179 " mono => selects colors suitable for monochrome displays\n"
180 " blackbg => selects a color scheme with black background\n"
181 " classic => theme with blue background. The classic look\n"
182 " bluetitle => an LCD friendly version of classic. (default)\n"
184 menu_instructions
[] =
185 "Arrow keys navigate the menu. "
186 "<Enter> selects submenus ---> (or empty submenus ----). "
187 "Highlighted letters are hotkeys. "
188 "Pressing <Y> includes, <N> excludes, <M> modularizes features. "
189 "Press <Esc><Esc> to exit, <?> for Help, </> for Search. "
190 "Legend: [*] built-in [ ] excluded <M> module < > module capable",
191 radiolist_instructions
[] =
192 "Use the arrow keys to navigate this window or "
193 "press the hotkey of the item you wish to select "
194 "followed by the <SPACE BAR>. "
195 "Press <?> for additional information about this option.",
196 inputbox_instructions_int
[] =
197 "Please enter a decimal value. "
198 "Fractions will not be accepted. "
199 "Use the <TAB> key to move from the input field to the buttons below it.",
200 inputbox_instructions_hex
[] =
201 "Please enter a hexadecimal value. "
202 "Use the <TAB> key to move from the input field to the buttons below it.",
203 inputbox_instructions_string
[] =
204 "Please enter a string value. "
205 "Use the <TAB> key to move from the input field to the buttons below it.",
207 "This feature depends on another which has been configured as a module.\n"
208 "As a result, this feature will be built as a module.",
210 "Enter the name of the configuration file you wish to load. "
211 "Accept the name shown to restore the configuration you "
212 "last retrieved. Leave blank to abort.",
215 "For various reasons, one may wish to keep several different\n"
216 "configurations available on a single machine.\n"
218 "If you have saved a previous configuration in a file other than the\n"
219 "default one, entering its name here will allow you to modify that\n"
222 "If you are uncertain, then you have probably never used alternate\n"
223 "configuration files. You should therefore leave this blank to abort.\n",
225 "Enter a filename to which this configuration should be saved "
226 "as an alternate. Leave blank to abort.",
229 "For various reasons, one may wish to keep different configurations\n"
230 "available on a single machine.\n"
232 "Entering a file name here will allow you to later retrieve, modify\n"
233 "and use the current configuration as an alternate to whatever\n"
234 "configuration options you have selected at that time.\n"
236 "If you are uncertain what all this means then you should probably\n"
237 "leave this blank.\n",
240 "Search for symbols and display their relations.\n"
241 "Regular expressions are allowed.\n"
242 "Example: search for \"^FOO\"\n"
244 "-----------------------------------------------------------------\n"
247 "Prompt: Foo bus is used to drive the bar HW\n"
249 " -> Bus options (PCI, PCMCIA, EISA, ISA)\n"
250 " -> PCI support (PCI [=y])\n"
251 "(1) -> PCI access mode (<choice> [=y])\n"
252 " Defined at drivers/pci/Kconfig:47\n"
253 " Depends on: X86_LOCAL_APIC && X86_IO_APIC\n"
254 " Selects: LIBCRC32\n"
255 " Selected by: BAR [=n]\n"
256 "-----------------------------------------------------------------\n"
257 "o The line 'Type:' shows the type of the configuration option for\n"
258 " this symbol (bool, tristate, string, ...)\n"
259 "o The line 'Prompt:' shows the text used in the menu structure for\n"
261 "o The 'Defined at' line tells at what file / line number the symbol\n"
263 "o The 'Depends on:' line tells what symbols need to be defined for\n"
264 " this symbol to be visible in the menu (selectable)\n"
265 "o The 'Location:' lines tells where in the menu structure this symbol\n"
267 " A location followed by a [=y] indicates that this is a\n"
268 " selectable menu item - and the current value is displayed inside\n"
270 " Press the key in the (#) prefix to jump directly to that\n"
271 " location. You will be returned to the current search results\n"
272 " after exiting this new menu.\n"
273 "o The 'Selects:' line tells what symbols will be automatically\n"
274 " selected if this symbol is selected (y or m)\n"
275 "o The 'Selected by' line tells what symbol has selected this symbol\n"
277 "Only relevant lines are shown.\n"
280 "Examples: USB => find all symbols containing USB\n"
281 " ^USB => find all symbols starting with USB\n"
282 " USB$ => find all symbols ending with USB\n"
286 static struct menu
*current_menu
;
287 static int child_count
;
288 static int single_menu_mode
;
289 static int show_all_options
;
290 static int save_and_exit
;
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
));
383 static void search_conf(void)
385 struct symbol
**sym_arr
;
389 int dres
, vscroll
= 0, hscroll
= 0;
392 struct subtitle_part stpart
;
395 str_printf( &title
, "Enter (sub)string or regexp to search for "
396 "(with or without \"%s\")", CONFIG_
);
400 dres
= dialog_inputbox("Search Configuration Parameter",
407 show_helptext("Search Configuration", search_help
);
414 /* strip the prefix if necessary */
415 dialog_input
= dialog_input_result
;
416 if (strncasecmp(dialog_input_result
, CONFIG_
, strlen(CONFIG_
)) == 0)
417 dialog_input
+= strlen(CONFIG_
);
420 str_printf(&sttext
, "Search (%s)", dialog_input_result
);
421 stpart
.text
= str_get(&sttext
);
422 list_add_tail(&stpart
.entries
, &trail
);
424 sym_arr
= sym_re_search(dialog_input
);
427 struct search_data data
= {
430 struct jump_key
*pos
, *tmp
;
433 res
= get_relations_str(sym_arr
, &head
);
435 dres
= show_textbox_ext("Search Results", str_get(&res
), 0, 0,
437 handle_search_keys
, &data
);
439 if (dres
>= '1' && dres
<= '9') {
440 assert(data
.target
!= NULL
);
441 conf(data
.target
->parent
, data
.target
);
445 list_for_each_entry_safe(pos
, tmp
, &head
, entries
)
450 list_del(trail
.prev
);
454 static void build_conf(struct menu
*menu
)
457 struct property
*prop
;
459 int type
, tmp
, doint
= 2;
465 * note: menu_is_visible() has side effect that it will
466 * recalc the value of the symbol.
468 visible
= menu_is_visible(menu
);
469 if (show_all_options
&& !menu_has_prompt(menu
))
471 else if (!show_all_options
&& !visible
)
477 if (prop
&& menu
!= current_menu
) {
478 const char *prompt
= menu_get_prompt(menu
);
479 switch (prop
->type
) {
482 if (single_menu_mode
) {
484 menu
->data
? "-->" : "++>",
485 indent
+ 1, ' ', prompt
);
487 item_make(" %*c%s %s",
488 indent
+ 1, ' ', prompt
,
489 menu_is_empty(menu
) ? "----" : "--->");
492 if (single_menu_mode
&& menu
->data
)
498 item_make(" %*c*** %s ***", indent
+ 1, ' ', prompt
);
506 item_make("---%*c%s", indent
+ 1, ' ', prompt
);
516 type
= sym_get_type(sym
);
517 if (sym_is_choice(sym
)) {
518 struct symbol
*def_sym
= sym_calc_choice(menu
);
519 struct menu
*def_menu
= NULL
;
522 for (child
= menu
->list
; child
; child
= child
->next
) {
523 if (menu_is_visible(child
) && child
->sym
== def_sym
)
528 item_set_tag(def_menu
? 't' : ':');
531 item_add_str("%*c%s", indent
+ 1, ' ', menu_get_prompt(menu
));
533 item_add_str(" (%s) --->", menu_get_prompt(def_menu
));
536 if (menu
== current_menu
) {
537 item_make("---%*c%s", indent
+ 1, ' ', menu_get_prompt(menu
));
543 val
= sym_get_tristate_value(sym
);
546 if (sym_is_changeable(sym
))
547 item_make("[%c]", val
== no
? ' ' : '*');
549 item_make("-%c-", val
== no
? ' ' : '*');
555 case yes
: ch
= '*'; break;
556 case mod
: ch
= 'M'; break;
557 default: ch
= ' '; break;
559 if (sym_is_changeable(sym
)) {
560 if (sym
->rev_dep
.tri
== mod
)
561 item_make("{%c}", ch
);
563 item_make("<%c>", ch
);
565 item_make("-%c-", ch
);
570 tmp
= 2 + strlen(sym_get_string_value(sym
)); /* () = 2 */
571 item_make("(%s)", sym_get_string_value(sym
));
572 tmp
= indent
- tmp
+ 4;
575 item_add_str("%*c%s%s", tmp
, ' ', menu_get_prompt(menu
),
576 (sym_has_value(sym
) || !sym_is_changeable(sym
)) ?
582 item_add_str("%*c%s%s", indent
+ 1, ' ', menu_get_prompt(menu
),
583 (sym_has_value(sym
) || !sym_is_changeable(sym
)) ?
585 if (menu
->prompt
->type
== P_MENU
) {
586 item_add_str(" %s", menu_is_empty(menu
) ? "----" : "--->");
593 for (child
= menu
->list
; child
; child
= child
->next
)
598 static void conf_choice(struct menu
*menu
)
600 const char *prompt
= menu_get_prompt(menu
);
602 struct symbol
*active
;
604 active
= sym_calc_choice(menu
);
611 for (child
= menu
->list
; child
; child
= child
->next
) {
612 if (!menu_is_visible(child
))
615 item_make("%s", menu_get_prompt(child
));
617 item_make("*** %s ***", menu_get_prompt(child
));
620 item_set_data(child
);
621 if (child
->sym
== active
)
622 item_set_selected(1);
623 if (child
->sym
== sym_calc_choice(menu
))
627 res
= dialog_checklist(prompt
? prompt
: "Main Menu",
628 radiolist_instructions
,
631 CHECKLIST_HEIGHT_MIN
);
632 selected
= item_activate_selected();
640 choice_set_value(menu
, child
->sym
);
653 case -ERRDISPLAYTOOSMALL
:
659 static void conf_string(struct menu
*menu
)
661 const char *prompt
= menu_get_prompt(menu
);
667 switch (sym_get_type(menu
->sym
)) {
669 heading
= inputbox_instructions_int
;
672 heading
= inputbox_instructions_hex
;
675 heading
= inputbox_instructions_string
;
678 heading
= "Internal mconf error!";
681 res
= dialog_inputbox(prompt
? prompt
: "Main Menu",
683 sym_get_string_value(menu
->sym
));
686 if (sym_set_string_value(menu
->sym
, dialog_input_result
))
688 show_textbox(NULL
, "You have made an invalid entry.", 5, 43);
699 static void conf_load(void)
705 res
= dialog_inputbox(NULL
, load_config_text
,
709 if (!dialog_input_result
[0])
711 if (!conf_read(dialog_input_result
)) {
712 set_config_filename(dialog_input_result
);
713 conf_set_changed(true);
716 show_textbox(NULL
, "File does not exist!", 5, 38);
719 show_helptext("Load Alternate Configuration", load_config_help
);
727 static void conf_save(void)
732 res
= dialog_inputbox(NULL
, save_config_text
,
736 if (!dialog_input_result
[0])
738 if (!conf_write(dialog_input_result
)) {
739 set_config_filename(dialog_input_result
);
742 show_textbox(NULL
, "Can't create file!", 5, 60);
745 show_helptext("Save Alternate Configuration", save_config_help
);
753 static void conf(struct menu
*menu
, struct menu
*active_menu
)
755 struct menu
*submenu
;
756 const char *prompt
= menu_get_prompt(menu
);
757 struct subtitle_part stpart
;
762 if (menu
!= &rootmenu
)
763 stpart
.text
= menu_get_prompt(menu
);
766 list_add_tail(&stpart
.entries
, &trail
);
776 res
= dialog_menu(prompt
? prompt
: "Main Menu",
778 active_menu
, &s_scroll
);
779 if (res
== 1 || res
== KEY_ESC
|| res
== -ERRDISPLAYTOOSMALL
)
781 if (item_count() != 0) {
782 if (!item_activate_selected())
787 submenu
= item_data();
788 active_menu
= item_data();
796 switch (item_tag()) {
798 if (single_menu_mode
)
799 submenu
->data
= (void *) (long) !submenu
->data
;
804 if (sym_is_choice(sym
))
805 conf_choice(submenu
);
806 else if (submenu
->prompt
->type
== P_MENU
)
810 conf_string(submenu
);
819 show_helptext("README", mconf_readme
);
831 if (item_is_tag('t')) {
832 if (sym_set_tristate_value(sym
, yes
))
834 if (sym_set_tristate_value(sym
, mod
))
835 show_textbox(NULL
, setmod_text
, 6, 74);
839 if (item_is_tag('t'))
840 sym_set_tristate_value(sym
, no
);
843 if (item_is_tag('t'))
844 sym_set_tristate_value(sym
, mod
);
847 if (item_is_tag('t'))
848 sym_toggle_tristate_value(sym
);
849 else if (item_is_tag('m'))
856 show_all_options
= !show_all_options
;
861 list_del(trail
.prev
);
864 static void conf_message_callback(const char *s
)
870 show_textbox(NULL
, s
, 6, 60);
874 static int handle_exit(void)
881 if (conf_get_changed())
882 res
= dialog_yesno(NULL
,
883 "Do you wish to save your new configuration?\n"
884 "(Press <ESC><ESC> to continue kernel configuration.)",
889 end_dialog(saved_x
, saved_y
);
893 if (conf_write(filename
)) {
894 fprintf(stderr
, "\n\n"
895 "Error while writing of the configuration.\n"
896 "Your configuration changes were NOT saved."
900 conf_write_autoconf(0);
905 "*** End of the configuration.\n"
906 "*** Execute 'make' to start the build or try 'make help'."
912 fprintf(stderr
, "\n\n"
913 "Your configuration changes were NOT saved."
922 static void sig_handler(int signo
)
927 int main(int ac
, char **av
)
932 signal(SIGINT
, sig_handler
);
934 if (ac
> 1 && strcmp(av
[1], "-s") == 0) {
936 /* Silence conf_read() until the real callback is set up */
937 conf_set_message_callback(NULL
);
943 mode
= getenv("MENUCONFIG_MODE");
945 if (!strcasecmp(mode
, "single_menu"))
946 single_menu_mode
= 1;
949 if (init_dialog(NULL
)) {
950 fprintf(stderr
, "Your display is too small to run Menuconfig!\n");
951 fprintf(stderr
, "It must be at least 19 lines by 80 columns.\n");
955 set_config_filename(conf_get_configname());
956 conf_set_message_callback(conf_message_callback
);
958 conf(&rootmenu
, NULL
);
960 } while (res
== KEY_ESC
);