xref: /linux/scripts/kconfig/lxdialog/checklist.c (revision 4b660dbd9ee2059850fd30e0df420ca7a38a1856)
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  *  checklist.c -- implements the checklist box
4  *
5  *  ORIGINAL AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
6  *     Stuart Herbert - S.Herbert@sheffield.ac.uk: radiolist extension
7  *     Alessandro Rubini - rubini@ipvvis.unipv.it: merged the two
8  *  MODIFIED FOR LINUX KERNEL CONFIG BY: William Roadcap (roadcap@cfw.com)
9  */
10 
11 #include "dialog.h"
12 
13 static int list_width, check_x, item_x;
14 
15 /*
16  * Print list item
17  */
18 static void print_item(WINDOW * win, int choice, int selected)
19 {
20 	int i;
21 	char *list_item = malloc(list_width + 1);
22 
23 	strncpy(list_item, item_str(), list_width - item_x);
24 	list_item[list_width - item_x] = '\0';
25 
26 	/* Clear 'residue' of last item */
27 	wattrset(win, dlg.menubox.atr);
28 	wmove(win, choice, 0);
29 	for (i = 0; i < list_width; i++)
30 		waddch(win, ' ');
31 
32 	wmove(win, choice, check_x);
33 	wattrset(win, selected ? dlg.check_selected.atr
34 		 : dlg.check.atr);
35 	if (!item_is_tag(':'))
36 		wprintw(win, "(%c)", item_is_tag('X') ? 'X' : ' ');
37 
38 	wattrset(win, selected ? dlg.tag_selected.atr : dlg.tag.atr);
39 	mvwaddch(win, choice, item_x, list_item[0]);
40 	wattrset(win, selected ? dlg.item_selected.atr : dlg.item.atr);
41 	waddstr(win, list_item + 1);
42 	if (selected) {
43 		wmove(win, choice, check_x + 1);
44 		wrefresh(win);
45 	}
46 	free(list_item);
47 }
48 
49 /*
50  * Print the scroll indicators.
51  */
52 static void print_arrows(WINDOW * win, int choice, int item_no, int scroll,
53 	     int y, int x, int height)
54 {
55 	wmove(win, y, x);
56 
57 	if (scroll > 0) {
58 		wattrset(win, dlg.uarrow.atr);
59 		waddch(win, ACS_UARROW);
60 		waddstr(win, "(-)");
61 	} else {
62 		wattrset(win, dlg.menubox.atr);
63 		waddch(win, ACS_HLINE);
64 		waddch(win, ACS_HLINE);
65 		waddch(win, ACS_HLINE);
66 		waddch(win, ACS_HLINE);
67 	}
68 
69 	y = y + height + 1;
70 	wmove(win, y, x);
71 
72 	if ((height < item_no) && (scroll + choice < item_no - 1)) {
73 		wattrset(win, dlg.darrow.atr);
74 		waddch(win, ACS_DARROW);
75 		waddstr(win, "(+)");
76 	} else {
77 		wattrset(win, dlg.menubox_border.atr);
78 		waddch(win, ACS_HLINE);
79 		waddch(win, ACS_HLINE);
80 		waddch(win, ACS_HLINE);
81 		waddch(win, ACS_HLINE);
82 	}
83 }
84 
85 /*
86  *  Display the termination buttons
87  */
88 static void print_buttons(WINDOW * dialog, int height, int width, int selected)
89 {
90 	int x = width / 2 - 11;
91 	int y = height - 2;
92 
93 	print_button(dialog, "Select", y, x, selected == 0);
94 	print_button(dialog, " Help ", y, x + 14, selected == 1);
95 
96 	wmove(dialog, y, x + 1 + 14 * selected);
97 	wrefresh(dialog);
98 }
99 
100 /*
101  * Display a dialog box with a list of options that can be turned on or off
102  * in the style of radiolist (only one option turned on at a time).
103  */
104 int dialog_checklist(const char *title, const char *prompt, int height,
105 		     int width, int list_height)
106 {
107 	int i, x, y, box_x, box_y;
108 	int key = 0, button = 0, choice = 0, scroll = 0, max_choice;
109 	WINDOW *dialog, *list;
110 
111 	/* which item to highlight */
112 	item_foreach() {
113 		if (item_is_tag('X'))
114 			choice = item_n();
115 		if (item_is_selected()) {
116 			choice = item_n();
117 			break;
118 		}
119 	}
120 
121 do_resize:
122 	if (getmaxy(stdscr) < (height + CHECKLIST_HEIGTH_MIN))
123 		return -ERRDISPLAYTOOSMALL;
124 	if (getmaxx(stdscr) < (width + CHECKLIST_WIDTH_MIN))
125 		return -ERRDISPLAYTOOSMALL;
126 
127 	max_choice = MIN(list_height, item_count());
128 
129 	/* center dialog box on screen */
130 	x = (getmaxx(stdscr) - width) / 2;
131 	y = (getmaxy(stdscr) - height) / 2;
132 
133 	draw_shadow(stdscr, y, x, height, width);
134 
135 	dialog = newwin(height, width, y, x);
136 	keypad(dialog, TRUE);
137 
138 	draw_box(dialog, 0, 0, height, width,
139 		 dlg.dialog.atr, dlg.border.atr);
140 	wattrset(dialog, dlg.border.atr);
141 	mvwaddch(dialog, height - 3, 0, ACS_LTEE);
142 	for (i = 0; i < width - 2; i++)
143 		waddch(dialog, ACS_HLINE);
144 	wattrset(dialog, dlg.dialog.atr);
145 	waddch(dialog, ACS_RTEE);
146 
147 	print_title(dialog, title, width);
148 
149 	wattrset(dialog, dlg.dialog.atr);
150 	print_autowrap(dialog, prompt, width - 2, 1, 3);
151 
152 	list_width = width - 6;
153 	box_y = height - list_height - 5;
154 	box_x = (width - list_width) / 2 - 1;
155 
156 	/* create new window for the list */
157 	list = subwin(dialog, list_height, list_width, y + box_y + 1,
158 		      x + box_x + 1);
159 
160 	keypad(list, TRUE);
161 
162 	/* draw a box around the list items */
163 	draw_box(dialog, box_y, box_x, list_height + 2, list_width + 2,
164 		 dlg.menubox_border.atr, dlg.menubox.atr);
165 
166 	/* Find length of longest item in order to center checklist */
167 	check_x = 0;
168 	item_foreach()
169 		check_x = MAX(check_x, strlen(item_str()) + 4);
170 	check_x = MIN(check_x, list_width);
171 
172 	check_x = (list_width - check_x) / 2;
173 	item_x = check_x + 4;
174 
175 	if (choice >= list_height) {
176 		scroll = choice - list_height + 1;
177 		choice -= scroll;
178 	}
179 
180 	/* Print the list */
181 	for (i = 0; i < max_choice; i++) {
182 		item_set(scroll + i);
183 		print_item(list, i, i == choice);
184 	}
185 
186 	print_arrows(dialog, choice, item_count(), scroll,
187 		     box_y, box_x + check_x + 5, list_height);
188 
189 	print_buttons(dialog, height, width, 0);
190 
191 	wmove(list, choice, check_x + 1);
192 	wrefresh(list);
193 
194 	while (key != KEY_ESC) {
195 		key = wgetch(dialog);
196 
197 		for (i = 0; i < max_choice; i++) {
198 			item_set(i + scroll);
199 			if (toupper(key) == toupper(item_str()[0]))
200 				break;
201 		}
202 
203 		if (i < max_choice || key == KEY_UP || key == KEY_DOWN ||
204 		    key == '+' || key == '-') {
205 			if (key == KEY_UP || key == '-') {
206 				if (!choice) {
207 					if (!scroll)
208 						continue;
209 					/* Scroll list down */
210 					if (list_height > 1) {
211 						/* De-highlight current first item */
212 						item_set(scroll);
213 						print_item(list, 0, FALSE);
214 						scrollok(list, TRUE);
215 						wscrl(list, -1);
216 						scrollok(list, FALSE);
217 					}
218 					scroll--;
219 					item_set(scroll);
220 					print_item(list, 0, TRUE);
221 					print_arrows(dialog, choice, item_count(),
222 						     scroll, box_y, box_x + check_x + 5, list_height);
223 
224 					wnoutrefresh(dialog);
225 					wrefresh(list);
226 
227 					continue;	/* wait for another key press */
228 				} else
229 					i = choice - 1;
230 			} else if (key == KEY_DOWN || key == '+') {
231 				if (choice == max_choice - 1) {
232 					if (scroll + choice >= item_count() - 1)
233 						continue;
234 					/* Scroll list up */
235 					if (list_height > 1) {
236 						/* De-highlight current last item before scrolling up */
237 						item_set(scroll + max_choice - 1);
238 						print_item(list,
239 							    max_choice - 1,
240 							    FALSE);
241 						scrollok(list, TRUE);
242 						wscrl(list, 1);
243 						scrollok(list, FALSE);
244 					}
245 					scroll++;
246 					item_set(scroll + max_choice - 1);
247 					print_item(list, max_choice - 1, TRUE);
248 
249 					print_arrows(dialog, choice, item_count(),
250 						     scroll, box_y, box_x + check_x + 5, list_height);
251 
252 					wnoutrefresh(dialog);
253 					wrefresh(list);
254 
255 					continue;	/* wait for another key press */
256 				} else
257 					i = choice + 1;
258 			}
259 			if (i != choice) {
260 				/* De-highlight current item */
261 				item_set(scroll + choice);
262 				print_item(list, choice, FALSE);
263 				/* Highlight new item */
264 				choice = i;
265 				item_set(scroll + choice);
266 				print_item(list, choice, TRUE);
267 				wnoutrefresh(dialog);
268 				wrefresh(list);
269 			}
270 			continue;	/* wait for another key press */
271 		}
272 		switch (key) {
273 		case 'H':
274 		case 'h':
275 		case '?':
276 			button = 1;
277 			/* fall-through */
278 		case 'S':
279 		case 's':
280 		case ' ':
281 		case '\n':
282 			item_foreach()
283 				item_set_selected(0);
284 			item_set(scroll + choice);
285 			item_set_selected(1);
286 			delwin(list);
287 			delwin(dialog);
288 			return button;
289 		case TAB:
290 		case KEY_LEFT:
291 		case KEY_RIGHT:
292 			button = ((key == KEY_LEFT ? --button : ++button) < 0)
293 			    ? 1 : (button > 1 ? 0 : button);
294 
295 			print_buttons(dialog, height, width, button);
296 			wrefresh(dialog);
297 			break;
298 		case 'X':
299 		case 'x':
300 			key = KEY_ESC;
301 			break;
302 		case KEY_ESC:
303 			key = on_key_esc(dialog);
304 			break;
305 		case KEY_RESIZE:
306 			delwin(list);
307 			delwin(dialog);
308 			on_key_resize();
309 			goto do_resize;
310 		}
311 
312 		/* Now, update everything... */
313 		doupdate();
314 	}
315 	delwin(list);
316 	delwin(dialog);
317 	return key;		/* ESC pressed */
318 }
319