2 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
3 * Released under the terms of the GNU GPL v2.0.
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
[] = N_(
28 "This interface let 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 removed it. You may also press the <Space Bar> to cycle\n"
43 "through the available options (ie. 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\n"
50 " you wish to change or submenu wish to select and press <Enter>.\n"
51 " Submenus are designated 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> and <Help>.\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 "At the end of the main menu you will find two options. One is\n"
121 "for saving the current configuration to a file of your choosing.\n"
122 "The other option is for loading a previously saved alternate\n"
125 "Even if you don't use alternate configuration files, but you\n"
126 "find during a Menuconfig session that you have completely messed\n"
127 "up your settings, you may use the \"Load Alternate...\" option to\n"
128 "restore your previously saved settings from \".config\" without\n"
129 "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 a xterm definition which supports color.\n"
135 "Otherwise, Menuconfig will look rather bad. Menuconfig will not\n"
136 "display correctly in a 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, rather\n"
152 "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 => a LCD friendly version of classic. (default)\n"
177 menu_instructions
[] = N_(
178 "Arrow keys navigate the menu. "
179 "<Enter> selects 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
[] = N_(
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
[] = N_(
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
[] = N_(
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
[] = N_(
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."),
202 load_config_text
[] = N_(
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."),
206 load_config_help
[] = N_(
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"),
217 save_config_text
[] = N_(
218 "Enter a filename to which this configuration should be saved "
219 "as an alternate. Leave blank to abort."),
220 save_config_help
[] = N_(
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"
241 " Defined at drivers/pci/Kconfig:47\n"
242 " Depends on: X86_LOCAL_APIC && X86_IO_APIC || IA64\n"
244 " -> Bus options (PCI, PCMCIA, EISA, ISA)\n"
245 " -> PCI support (PCI [=y])\n"
246 "(1) -> PCI access mode (<choice> [=y])\n"
247 " Selects: LIBCRC32\n"
248 " Selected by: BAR\n"
249 "-----------------------------------------------------------------\n"
250 "o The line 'Type:' shows the type of the configuration option for\n"
251 " this symbol (boolean, tristate, string, ...)\n"
252 "o The line 'Prompt:' shows the text used in the menu structure for\n"
254 "o The 'Defined at' line tell at what file / line number the symbol\n"
256 "o The 'Depends on:' line tell what symbols needs to be defined for\n"
257 " this symbol to be visible in the menu (selectable)\n"
258 "o The 'Location:' lines tell 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 tell what symbol will be automatically\n"
267 " selected if this symbol is selected (y or m)\n"
268 "o The 'Selected by' line tell 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
;
284 static void conf(struct menu
*menu
, struct menu
*active_menu
);
285 static void conf_choice(struct menu
*menu
);
286 static void conf_string(struct menu
*menu
);
287 static void conf_load(void);
288 static void conf_save(void);
289 static int show_textbox_ext(const char *title
, char *text
, int r
, int c
,
290 int *keys
, int *vscroll
, int *hscroll
,
291 update_text_fn update_text
, void *data
);
292 static void show_textbox(const char *title
, const char *text
, int r
, int c
);
293 static void show_helptext(const char *title
, const char *text
);
294 static void show_help(struct menu
*menu
);
296 static char filename
[PATH_MAX
+1];
297 static void set_config_filename(const char *config_filename
)
299 static char menu_backtitle
[PATH_MAX
+128];
302 size
= snprintf(menu_backtitle
, sizeof(menu_backtitle
),
303 "%s - %s", config_filename
, rootmenu
.prompt
->text
);
304 if (size
>= sizeof(menu_backtitle
))
305 menu_backtitle
[sizeof(menu_backtitle
)-1] = '\0';
306 set_dialog_backtitle(menu_backtitle
);
308 size
= snprintf(filename
, sizeof(filename
), "%s", config_filename
);
309 if (size
>= sizeof(filename
))
310 filename
[sizeof(filename
)-1] = '\0';
315 struct list_head
*head
;
316 struct menu
**targets
;
320 static void update_text(char *buf
, size_t start
, size_t end
, void *_data
)
322 struct search_data
*data
= _data
;
323 struct jump_key
*pos
;
326 list_for_each_entry(pos
, data
->head
, entries
) {
327 if (pos
->offset
>= start
&& pos
->offset
< end
) {
331 int key
= '0' + (pos
->index
% JUMP_NB
) + 1;
333 sprintf(header
, "(%c)", key
);
335 data
->targets
[k
] = pos
->target
;
338 sprintf(header
, " ");
341 memcpy(buf
+ pos
->offset
, header
, sizeof(header
) - 1);
347 static void search_conf(void)
349 struct symbol
**sym_arr
;
352 int dres
, vscroll
= 0, hscroll
= 0;
357 dres
= dialog_inputbox(_("Search Configuration Parameter"),
358 _("Enter " CONFIG_
" (sub)string to search for "
359 "(with or without \"" CONFIG_
"\")"),
365 show_helptext(_("Search Configuration"), search_help
);
371 /* strip the prefix if necessary */
372 dialog_input
= dialog_input_result
;
373 if (strncasecmp(dialog_input_result
, CONFIG_
, strlen(CONFIG_
)) == 0)
374 dialog_input
+= strlen(CONFIG_
);
376 sym_arr
= sym_re_search(dialog_input
);
379 struct menu
*targets
[JUMP_NB
];
380 int keys
[JUMP_NB
+ 1], i
;
381 struct search_data data
= {
387 res
= get_relations_str(sym_arr
, &head
);
388 dres
= show_textbox_ext(_("Search Results"), (char *)
389 str_get(&res
), 0, 0, keys
, &vscroll
,
390 &hscroll
, &update_text
, (void *)
393 for (i
= 0; i
< JUMP_NB
&& keys
[i
]; i
++)
394 if (dres
== keys
[i
]) {
395 conf(targets
[i
]->parent
, targets
[i
]);
403 static void build_conf(struct menu
*menu
)
406 struct property
*prop
;
408 int type
, tmp
, doint
= 2;
414 * note: menu_is_visible() has side effect that it will
415 * recalc the value of the symbol.
417 visible
= menu_is_visible(menu
);
418 if (show_all_options
&& !menu_has_prompt(menu
))
420 else if (!show_all_options
&& !visible
)
426 if (prop
&& menu
!= current_menu
) {
427 const char *prompt
= menu_get_prompt(menu
);
428 switch (prop
->type
) {
432 if (single_menu_mode
) {
434 menu
->data
? "-->" : "++>",
435 indent
+ 1, ' ', prompt
);
437 item_make(" %*c%s --->", indent
+ 1, ' ', prompt
);
441 if (single_menu_mode
&& menu
->data
)
447 item_make(" %*c*** %s ***", indent
+ 1, ' ', _(prompt
));
455 item_make("---%*c%s", indent
+ 1, ' ', _(prompt
));
465 type
= sym_get_type(sym
);
466 if (sym_is_choice(sym
)) {
467 struct symbol
*def_sym
= sym_get_choice_value(sym
);
468 struct menu
*def_menu
= NULL
;
471 for (child
= menu
->list
; child
; child
= child
->next
) {
472 if (menu_is_visible(child
) && child
->sym
== def_sym
)
476 val
= sym_get_tristate_value(sym
);
477 if (sym_is_changable(sym
)) {
480 item_make("[%c]", val
== no
? ' ' : '*');
484 case yes
: ch
= '*'; break;
485 case mod
: ch
= 'M'; break;
486 default: ch
= ' '; break;
488 item_make("<%c>", ch
);
495 item_set_tag(def_menu
? 't' : ':');
499 item_add_str("%*c%s", indent
+ 1, ' ', _(menu_get_prompt(menu
)));
502 item_add_str(" (%s)", _(menu_get_prompt(def_menu
)));
503 item_add_str(" --->");
504 if (def_menu
->list
) {
506 build_conf(def_menu
);
513 if (menu
== current_menu
) {
514 item_make("---%*c%s", indent
+ 1, ' ', _(menu_get_prompt(menu
)));
520 val
= sym_get_tristate_value(sym
);
521 if (sym_is_choice_value(sym
) && val
== yes
) {
528 if (sym_is_changable(sym
))
529 item_make("[%c]", val
== no
? ' ' : '*');
531 item_make("-%c-", val
== no
? ' ' : '*');
537 case yes
: ch
= '*'; break;
538 case mod
: ch
= 'M'; break;
539 default: ch
= ' '; break;
541 if (sym_is_changable(sym
)) {
542 if (sym
->rev_dep
.tri
== mod
)
543 item_make("{%c}", ch
);
545 item_make("<%c>", ch
);
547 item_make("-%c-", ch
);
552 tmp
= 2 + strlen(sym_get_string_value(sym
)); /* () = 2 */
553 item_make("(%s)", sym_get_string_value(sym
));
554 tmp
= indent
- tmp
+ 4;
557 item_add_str("%*c%s%s", tmp
, ' ', _(menu_get_prompt(menu
)),
558 (sym_has_value(sym
) || !sym_is_changable(sym
)) ?
565 item_add_str("%*c%s%s", indent
+ 1, ' ', _(menu_get_prompt(menu
)),
566 (sym_has_value(sym
) || !sym_is_changable(sym
)) ?
568 if (menu
->prompt
->type
== P_MENU
) {
569 item_add_str(" --->");
576 for (child
= menu
->list
; child
; child
= child
->next
)
581 static void conf(struct menu
*menu
, struct menu
*active_menu
)
583 struct menu
*submenu
;
584 const char *prompt
= menu_get_prompt(menu
);
595 if (menu
== &rootmenu
) {
598 item_make(_(" Load an Alternate Configuration File"));
600 item_make(_(" Save an Alternate Configuration File"));
604 res
= dialog_menu(prompt
? _(prompt
) : _("Main Menu"),
605 _(menu_instructions
),
606 active_menu
, &s_scroll
);
607 if (res
== 1 || res
== KEY_ESC
|| res
== -ERRDISPLAYTOOSMALL
)
609 if (!item_activate_selected())
614 submenu
= item_data();
615 active_menu
= item_data();
623 switch (item_tag()) {
625 if (single_menu_mode
)
626 submenu
->data
= (void *) (long) !submenu
->data
;
631 if (sym_is_choice(sym
) && sym_get_tristate_value(sym
) == yes
)
632 conf_choice(submenu
);
633 else if (submenu
->prompt
->type
== P_MENU
)
637 conf_string(submenu
);
651 show_helptext(_("README"), _(mconf_readme
));
654 if (item_is_tag('t')) {
655 if (sym_set_tristate_value(sym
, yes
))
657 if (sym_set_tristate_value(sym
, mod
))
658 show_textbox(NULL
, setmod_text
, 6, 74);
662 if (item_is_tag('t'))
663 sym_set_tristate_value(sym
, no
);
666 if (item_is_tag('t'))
667 sym_set_tristate_value(sym
, mod
);
670 if (item_is_tag('t'))
671 sym_toggle_tristate_value(sym
);
672 else if (item_is_tag('m'))
679 show_all_options
= !show_all_options
;
685 static int show_textbox_ext(const char *title
, char *text
, int r
, int c
, int
686 *keys
, int *vscroll
, int *hscroll
, update_text_fn
687 update_text
, void *data
)
690 return dialog_textbox(title
, text
, r
, c
, keys
, vscroll
, hscroll
,
694 static void show_textbox(const char *title
, const char *text
, int r
, int c
)
696 show_textbox_ext(title
, (char *) text
, r
, c
, (int []) {0}, NULL
, NULL
,
700 static void show_helptext(const char *title
, const char *text
)
702 show_textbox(title
, text
, 0, 0);
705 static void show_help(struct menu
*menu
)
707 struct gstr help
= str_new();
709 help
.max_width
= getmaxx(stdscr
) - 10;
710 menu_get_ext_help(menu
, &help
);
712 show_helptext(_(menu_get_prompt(menu
)), str_get(&help
));
716 static void conf_choice(struct menu
*menu
)
718 const char *prompt
= _(menu_get_prompt(menu
));
720 struct symbol
*active
;
722 active
= sym_get_choice_value(menu
->sym
);
729 for (child
= menu
->list
; child
; child
= child
->next
) {
730 if (!menu_is_visible(child
))
733 item_make("%s", _(menu_get_prompt(child
)));
735 item_make("*** %s ***", _(menu_get_prompt(child
)));
738 item_set_data(child
);
739 if (child
->sym
== active
)
740 item_set_selected(1);
741 if (child
->sym
== sym_get_choice_value(menu
->sym
))
745 res
= dialog_checklist(prompt
? _(prompt
) : _("Main Menu"),
746 _(radiolist_instructions
),
748 selected
= item_activate_selected();
756 sym_set_tristate_value(child
->sym
, yes
);
769 case -ERRDISPLAYTOOSMALL
:
775 static void conf_string(struct menu
*menu
)
777 const char *prompt
= menu_get_prompt(menu
);
783 switch (sym_get_type(menu
->sym
)) {
785 heading
= _(inputbox_instructions_int
);
788 heading
= _(inputbox_instructions_hex
);
791 heading
= _(inputbox_instructions_string
);
794 heading
= _("Internal mconf error!");
797 res
= dialog_inputbox(prompt
? _(prompt
) : _("Main Menu"),
799 sym_get_string_value(menu
->sym
));
802 if (sym_set_string_value(menu
->sym
, dialog_input_result
))
804 show_textbox(NULL
, _("You have made an invalid entry."), 5, 43);
815 static void conf_load(void)
821 res
= dialog_inputbox(NULL
, load_config_text
,
825 if (!dialog_input_result
[0])
827 if (!conf_read(dialog_input_result
)) {
828 set_config_filename(dialog_input_result
);
829 sym_set_change_count(1);
832 show_textbox(NULL
, _("File does not exist!"), 5, 38);
835 show_helptext(_("Load Alternate Configuration"), load_config_help
);
843 static void conf_save(void)
848 res
= dialog_inputbox(NULL
, save_config_text
,
852 if (!dialog_input_result
[0])
854 if (!conf_write(dialog_input_result
)) {
855 set_config_filename(dialog_input_result
);
858 show_textbox(NULL
, _("Can't create file! Probably a nonexistent directory."), 5, 60);
861 show_helptext(_("Save Alternate Configuration"), save_config_help
);
869 static int handle_exit(void)
874 if (conf_get_changed())
875 res
= dialog_yesno(NULL
,
876 _("Do you wish to save your new configuration ?\n"
877 "<ESC><ESC> to continue."),
882 end_dialog(saved_x
, saved_y
);
886 if (conf_write(filename
)) {
887 fprintf(stderr
, _("\n\n"
888 "Error while writing of the configuration.\n"
889 "Your configuration changes were NOT saved."
896 "*** End of the configuration.\n"
897 "*** Execute 'make' to start the build or try 'make help'."
902 fprintf(stderr
, _("\n\n"
903 "Your configuration changes were NOT saved."
912 static void sig_handler(int signo
)
917 int main(int ac
, char **av
)
922 setlocale(LC_ALL
, "");
923 bindtextdomain(PACKAGE
, LOCALEDIR
);
926 signal(SIGINT
, sig_handler
);
931 mode
= getenv("MENUCONFIG_MODE");
933 if (!strcasecmp(mode
, "single_menu"))
934 single_menu_mode
= 1;
937 if (init_dialog(NULL
)) {
938 fprintf(stderr
, N_("Your display is too small to run Menuconfig!\n"));
939 fprintf(stderr
, N_("It must be at least 19 lines by 80 columns.\n"));
943 set_config_filename(conf_get_configname());
945 conf(&rootmenu
, NULL
);
947 } while (res
== KEY_ESC
);