util.c

  1// SPDX-License-Identifier: GPL-2.0+
  2/*
  3 *  util.c
  4 *
  5 *  ORIGINAL AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
  6 *  MODIFIED FOR LINUX KERNEL CONFIG BY: William Roadcap (roadcap@cfw.com)
  7 */
  8
  9#include <stdarg.h>
 10
 11#include "dialog.h"
 12
 13/* Needed in signal handler in mconf.c */
 14int saved_x, saved_y;
 15
 16struct dialog_info dlg;
 17
 18static void set_mono_theme(void)
 19{
 20	dlg.title.atr = A_BOLD;
 21	dlg.button_active.atr = A_REVERSE;
 22	dlg.button_inactive.atr = A_DIM;
 23	dlg.button_key_active.atr = A_REVERSE;
 24	dlg.button_key_inactive.atr = A_BOLD;
 25	dlg.button_label_active.atr = A_REVERSE;
 26	dlg.position_indicator.atr = A_BOLD;
 27	dlg.item_selected.atr = A_REVERSE;
 28	dlg.tag.atr = A_BOLD;
 29	dlg.tag_selected.atr = A_REVERSE;
 30	dlg.tag_key.atr = A_BOLD;
 31	dlg.tag_key_selected.atr = A_REVERSE;
 32	dlg.check.atr = A_BOLD;
 33	dlg.check_selected.atr = A_REVERSE;
 34	dlg.uarrow.atr = A_BOLD;
 35	dlg.darrow.atr = A_BOLD;
 36}
 37
 38#define DLG_COLOR(dialog, f, b, h) \
 39do {                               \
 40	dlg.dialog.fg = (f);       \
 41	dlg.dialog.bg = (b);       \
 42	dlg.dialog.hl = (h);       \
 43} while (0)
 44
 45static void set_classic_theme(void)
 46{
 47	DLG_COLOR(screen,                COLOR_CYAN,   COLOR_BLUE,   true);
 48	DLG_COLOR(shadow,                COLOR_BLACK,  COLOR_BLACK,  true);
 49	DLG_COLOR(dialog,                COLOR_BLACK,  COLOR_WHITE,  false);
 50	DLG_COLOR(title,                 COLOR_YELLOW, COLOR_WHITE,  true);
 51	DLG_COLOR(border,                COLOR_WHITE,  COLOR_WHITE,  true);
 52	DLG_COLOR(button_active,         COLOR_WHITE,  COLOR_BLUE,   true);
 53	DLG_COLOR(button_inactive,       COLOR_BLACK,  COLOR_WHITE,  false);
 54	DLG_COLOR(button_key_active,     COLOR_WHITE,  COLOR_BLUE,   true);
 55	DLG_COLOR(button_key_inactive,   COLOR_RED,    COLOR_WHITE,  false);
 56	DLG_COLOR(button_label_active,   COLOR_YELLOW, COLOR_BLUE,   true);
 57	DLG_COLOR(button_label_inactive, COLOR_BLACK,  COLOR_WHITE,  true);
 58	DLG_COLOR(inputbox,              COLOR_BLACK,  COLOR_WHITE,  false);
 59	DLG_COLOR(position_indicator,    COLOR_YELLOW, COLOR_WHITE,  true);
 60	DLG_COLOR(menubox,               COLOR_BLACK,  COLOR_WHITE,  false);
 61	DLG_COLOR(menubox_border,        COLOR_WHITE,  COLOR_WHITE,  true);
 62	DLG_COLOR(item,                  COLOR_BLACK,  COLOR_WHITE,  false);
 63	DLG_COLOR(item_selected,         COLOR_WHITE,  COLOR_BLUE,   true);
 64	DLG_COLOR(tag,                   COLOR_YELLOW, COLOR_WHITE,  true);
 65	DLG_COLOR(tag_selected,          COLOR_YELLOW, COLOR_BLUE,   true);
 66	DLG_COLOR(tag_key,               COLOR_YELLOW, COLOR_WHITE,  true);
 67	DLG_COLOR(tag_key_selected,      COLOR_YELLOW, COLOR_BLUE,   true);
 68	DLG_COLOR(check,                 COLOR_BLACK,  COLOR_WHITE,  false);
 69	DLG_COLOR(check_selected,        COLOR_WHITE,  COLOR_BLUE,   true);
 70	DLG_COLOR(uarrow,                COLOR_GREEN,  COLOR_WHITE,  true);
 71	DLG_COLOR(darrow,                COLOR_GREEN,  COLOR_WHITE,  true);
 72}
 73
 74static void set_blackbg_theme(void)
 75{
 76	DLG_COLOR(screen, COLOR_RED,   COLOR_BLACK, true);
 77	DLG_COLOR(shadow, COLOR_BLACK, COLOR_BLACK, false);
 78	DLG_COLOR(dialog, COLOR_WHITE, COLOR_BLACK, false);
 79	DLG_COLOR(title,  COLOR_RED,   COLOR_BLACK, false);
 80	DLG_COLOR(border, COLOR_BLACK, COLOR_BLACK, true);
 81
 82	DLG_COLOR(button_active,         COLOR_YELLOW, COLOR_RED,   false);
 83	DLG_COLOR(button_inactive,       COLOR_YELLOW, COLOR_BLACK, false);
 84	DLG_COLOR(button_key_active,     COLOR_YELLOW, COLOR_RED,   true);
 85	DLG_COLOR(button_key_inactive,   COLOR_RED,    COLOR_BLACK, false);
 86	DLG_COLOR(button_label_active,   COLOR_WHITE,  COLOR_RED,   false);
 87	DLG_COLOR(button_label_inactive, COLOR_WHITE,  COLOR_BLACK, false);
 88
 89	DLG_COLOR(inputbox,         COLOR_YELLOW, COLOR_BLACK, false);
 90
 91	DLG_COLOR(position_indicator, COLOR_RED, COLOR_BLACK,  false);
 92
 93	DLG_COLOR(menubox,          COLOR_YELLOW, COLOR_BLACK, false);
 94	DLG_COLOR(menubox_border,   COLOR_BLACK,  COLOR_BLACK, true);
 95
 96	DLG_COLOR(item,             COLOR_WHITE, COLOR_BLACK, false);
 97	DLG_COLOR(item_selected,    COLOR_WHITE, COLOR_RED,   false);
 98
 99	DLG_COLOR(tag,              COLOR_RED,    COLOR_BLACK, false);
100	DLG_COLOR(tag_selected,     COLOR_YELLOW, COLOR_RED,   true);
101	DLG_COLOR(tag_key,          COLOR_RED,    COLOR_BLACK, false);
102	DLG_COLOR(tag_key_selected, COLOR_YELLOW, COLOR_RED,   true);
103
104	DLG_COLOR(check,            COLOR_YELLOW, COLOR_BLACK, false);
105	DLG_COLOR(check_selected,   COLOR_YELLOW, COLOR_RED,   true);
106
107	DLG_COLOR(uarrow, COLOR_RED, COLOR_BLACK, false);
108	DLG_COLOR(darrow, COLOR_RED, COLOR_BLACK, false);
109}
110
111static void set_bluetitle_theme(void)
112{
113	set_classic_theme();
114	DLG_COLOR(title,               COLOR_BLUE,   COLOR_WHITE, true);
115	DLG_COLOR(button_key_active,   COLOR_YELLOW, COLOR_BLUE,  true);
116	DLG_COLOR(button_label_active, COLOR_WHITE,  COLOR_BLUE,  true);
117	DLG_COLOR(position_indicator,  COLOR_BLUE,   COLOR_WHITE, true);
118	DLG_COLOR(tag,                 COLOR_BLUE,   COLOR_WHITE, true);
119	DLG_COLOR(tag_key,             COLOR_BLUE,   COLOR_WHITE, true);
120
121}
122
123/*
124 * Select color theme
125 */
126static int set_theme(const char *theme)
127{
128	int use_color = 1;
129	if (!theme)
130		set_bluetitle_theme();
131	else if (strcmp(theme, "classic") == 0)
132		set_classic_theme();
133	else if (strcmp(theme, "bluetitle") == 0)
134		set_bluetitle_theme();
135	else if (strcmp(theme, "blackbg") == 0)
136		set_blackbg_theme();
137	else if (strcmp(theme, "mono") == 0)
138		use_color = 0;
139
140	return use_color;
141}
142
143static void init_one_color(struct dialog_color *color)
144{
145	static int pair = 0;
146
147	pair++;
148	init_pair(pair, color->fg, color->bg);
149	if (color->hl)
150		color->atr = A_BOLD | COLOR_PAIR(pair);
151	else
152		color->atr = COLOR_PAIR(pair);
153}
154
155static void init_dialog_colors(void)
156{
157	init_one_color(&dlg.screen);
158	init_one_color(&dlg.shadow);
159	init_one_color(&dlg.dialog);
160	init_one_color(&dlg.title);
161	init_one_color(&dlg.border);
162	init_one_color(&dlg.button_active);
163	init_one_color(&dlg.button_inactive);
164	init_one_color(&dlg.button_key_active);
165	init_one_color(&dlg.button_key_inactive);
166	init_one_color(&dlg.button_label_active);
167	init_one_color(&dlg.button_label_inactive);
168	init_one_color(&dlg.inputbox);
169	init_one_color(&dlg.position_indicator);
170	init_one_color(&dlg.menubox);
171	init_one_color(&dlg.menubox_border);
172	init_one_color(&dlg.item);
173	init_one_color(&dlg.item_selected);
174	init_one_color(&dlg.tag);
175	init_one_color(&dlg.tag_selected);
176	init_one_color(&dlg.tag_key);
177	init_one_color(&dlg.tag_key_selected);
178	init_one_color(&dlg.check);
179	init_one_color(&dlg.check_selected);
180	init_one_color(&dlg.uarrow);
181	init_one_color(&dlg.darrow);
182}
183
184/*
185 * Setup for color display
186 */
187static void color_setup(const char *theme)
188{
189	int use_color;
190
191	use_color = set_theme(theme);
192	if (use_color && has_colors()) {
193		start_color();
194		init_dialog_colors();
195	} else
196		set_mono_theme();
197}
198
199/*
200 * Set window to attribute 'attr'
201 */
202void attr_clear(WINDOW * win, int height, int width, chtype attr)
203{
204	int i, j;
205
206	wattrset(win, attr);
207	for (i = 0; i < height; i++) {
208		wmove(win, i, 0);
209		for (j = 0; j < width; j++)
210			waddch(win, ' ');
211	}
212	touchwin(win);
213}
214
215void dialog_clear(void)
216{
217	int lines, columns;
218
219	lines = getmaxy(stdscr);
220	columns = getmaxx(stdscr);
221
222	attr_clear(stdscr, lines, columns, dlg.screen.atr);
223	/* Display background title if it exists ... - SLH */
224	if (dlg.backtitle != NULL) {
225		int i, len = 0, skip = 0;
226		struct subtitle_list *pos;
227
228		wattrset(stdscr, dlg.screen.atr);
229		mvwaddstr(stdscr, 0, 1, (char *)dlg.backtitle);
230
231		for (pos = dlg.subtitles; pos != NULL; pos = pos->next) {
232			/* 3 is for the arrow and spaces */
233			len += strlen(pos->text) + 3;
234		}
235
236		wmove(stdscr, 1, 1);
237		if (len > columns - 2) {
238			const char *ellipsis = "[...] ";
239			waddstr(stdscr, ellipsis);
240			skip = len - (columns - 2 - strlen(ellipsis));
241		}
242
243		for (pos = dlg.subtitles; pos != NULL; pos = pos->next) {
244			if (skip == 0)
245				waddch(stdscr, ACS_RARROW);
246			else
247				skip--;
248
249			if (skip == 0)
250				waddch(stdscr, ' ');
251			else
252				skip--;
253
254			if (skip < strlen(pos->text)) {
255				waddstr(stdscr, pos->text + skip);
256				skip = 0;
257			} else
258				skip -= strlen(pos->text);
259
260			if (skip == 0)
261				waddch(stdscr, ' ');
262			else
263				skip--;
264		}
265
266		for (i = len + 1; i < columns - 1; i++)
267			waddch(stdscr, ACS_HLINE);
268	}
269	wnoutrefresh(stdscr);
270}
271
272/*
273 * Do some initialization for dialog
274 */
275int init_dialog(const char *backtitle)
276{
277	int height, width;
278
279	initscr();		/* Init curses */
280
281	/* Get current cursor position for signal handler in mconf.c */
282	getyx(stdscr, saved_y, saved_x);
283
284	getmaxyx(stdscr, height, width);
285	if (height < WINDOW_HEIGHT_MIN || width < WINDOW_WIDTH_MIN) {
286		endwin();
287		return -ERRDISPLAYTOOSMALL;
288	}
289
290	dlg.backtitle = backtitle;
291	color_setup(getenv("MENUCONFIG_COLOR"));
292
293	keypad(stdscr, TRUE);
294	cbreak();
295	noecho();
296	dialog_clear();
297
298	return 0;
299}
300
301void set_dialog_backtitle(const char *backtitle)
302{
303	dlg.backtitle = backtitle;
304}
305
306void set_dialog_subtitles(struct subtitle_list *subtitles)
307{
308	dlg.subtitles = subtitles;
309}
310
311/*
312 * End using dialog functions.
313 */
314void end_dialog(int x, int y)
315{
316	/* move cursor back to original position */
317	move(y, x);
318	refresh();
319	endwin();
320}
321
322/* Print the title of the dialog. Center the title and truncate
323 * tile if wider than dialog (- 2 chars).
324 **/
325void print_title(WINDOW *dialog, const char *title, int width)
326{
327	if (title) {
328		int tlen = MIN(width - 2, strlen(title));
329		wattrset(dialog, dlg.title.atr);
330		mvwaddch(dialog, 0, (width - tlen) / 2 - 1, ' ');
331		mvwaddnstr(dialog, 0, (width - tlen)/2, title, tlen);
332		waddch(dialog, ' ');
333	}
334}
335
336/*
337 * Print a string of text in a window, automatically wrap around to the
338 * next line if the string is too long to fit on one line. Newline
339 * characters '\n' are properly processed.  We start on a new line
340 * if there is no room for at least 4 nonblanks following a double-space.
341 */
342void print_autowrap(WINDOW * win, const char *prompt, int width, int y, int x)
343{
344	int newl, cur_x, cur_y;
345	int prompt_len, room, wlen;
346	char tempstr[MAX_LEN + 1], *word, *sp, *sp2, *newline_separator = 0;
347
348	snprintf(tempstr, sizeof(tempstr), "%s", prompt);
349	prompt_len = strlen(tempstr);
350
351	if (prompt_len <= width - x * 2) {	/* If prompt is short */
352		wmove(win, y, (width - prompt_len) / 2);
353		waddstr(win, tempstr);
354	} else {
355		cur_x = x;
356		cur_y = y;
357		newl = 1;
358		word = tempstr;
359		while (word && *word) {
360			sp = strpbrk(word, "\n ");
361			if (sp && *sp == '\n')
362				newline_separator = sp;
363
364			if (sp)
365				*sp++ = 0;
366
367			/* Wrap to next line if either the word does not fit,
368			   or it is the first word of a new sentence, and it is
369			   short, and the next word does not fit. */
370			room = width - cur_x;
371			wlen = strlen(word);
372			if (wlen > room ||
373			    (newl && wlen < 4 && sp
374			     && wlen + 1 + strlen(sp) > room
375			     && (!(sp2 = strpbrk(sp, "\n "))
376				 || wlen + 1 + (sp2 - sp) > room))) {
377				cur_y++;
378				cur_x = x;
379			}
380			wmove(win, cur_y, cur_x);
381			waddstr(win, word);
382			getyx(win, cur_y, cur_x);
383
384			/* Move to the next line if the word separator was a newline */
385			if (newline_separator) {
386				cur_y++;
387				cur_x = x;
388				newline_separator = 0;
389			} else
390				cur_x++;
391
392			if (sp && *sp == ' ') {
393				cur_x++;	/* double space */
394				while (*++sp == ' ') ;
395				newl = 1;
396			} else
397				newl = 0;
398			word = sp;
399		}
400	}
401}
402
403/*
404 * Print a button
405 */
406void print_button(WINDOW * win, const char *label, int y, int x, int selected)
407{
408	int i, temp;
409
410	wmove(win, y, x);
411	wattrset(win, selected ? dlg.button_active.atr
412		 : dlg.button_inactive.atr);
413	waddstr(win, "<");
414	temp = strspn(label, " ");
415	label += temp;
416	wattrset(win, selected ? dlg.button_label_active.atr
417		 : dlg.button_label_inactive.atr);
418	for (i = 0; i < temp; i++)
419		waddch(win, ' ');
420	wattrset(win, selected ? dlg.button_key_active.atr
421		 : dlg.button_key_inactive.atr);
422	waddch(win, label[0]);
423	wattrset(win, selected ? dlg.button_label_active.atr
424		 : dlg.button_label_inactive.atr);
425	waddstr(win, (char *)label + 1);
426	wattrset(win, selected ? dlg.button_active.atr
427		 : dlg.button_inactive.atr);
428	waddstr(win, ">");
429	wmove(win, y, x + temp + 1);
430}
431
432/*
433 * Draw a rectangular box with line drawing characters
434 */
435void
436draw_box(WINDOW * win, int y, int x, int height, int width,
437	 chtype box, chtype border)
438{
439	int i, j;
440
441	wattrset(win, 0);
442	for (i = 0; i < height; i++) {
443		wmove(win, y + i, x);
444		for (j = 0; j < width; j++)
445			if (!i && !j)
446				waddch(win, border | ACS_ULCORNER);
447			else if (i == height - 1 && !j)
448				waddch(win, border | ACS_LLCORNER);
449			else if (!i && j == width - 1)
450				waddch(win, box | ACS_URCORNER);
451			else if (i == height - 1 && j == width - 1)
452				waddch(win, box | ACS_LRCORNER);
453			else if (!i)
454				waddch(win, border | ACS_HLINE);
455			else if (i == height - 1)
456				waddch(win, box | ACS_HLINE);
457			else if (!j)
458				waddch(win, border | ACS_VLINE);
459			else if (j == width - 1)
460				waddch(win, box | ACS_VLINE);
461			else
462				waddch(win, box | ' ');
463	}
464}
465
466/*
467 * Draw shadows along the right and bottom edge to give a more 3D look
468 * to the boxes
469 */
470void draw_shadow(WINDOW * win, int y, int x, int height, int width)
471{
472	int i;
473
474	if (has_colors()) {	/* Whether terminal supports color? */
475		wattrset(win, dlg.shadow.atr);
476		wmove(win, y + height, x + 2);
477		for (i = 0; i < width; i++)
478			waddch(win, winch(win) & A_CHARTEXT);
479		for (i = y + 1; i < y + height + 1; i++) {
480			wmove(win, i, x + width);
481			waddch(win, winch(win) & A_CHARTEXT);
482			waddch(win, winch(win) & A_CHARTEXT);
483		}
484		wnoutrefresh(win);
485	}
486}
487
488/*
489 *  Return the position of the first alphabetic character in a string.
490 */
491int first_alpha(const char *string, const char *exempt)
492{
493	int i, in_paren = 0, c;
494
495	for (i = 0; i < strlen(string); i++) {
496		c = tolower(string[i]);
497
498		if (strchr("<[(", c))
499			++in_paren;
500		if (strchr(">])", c) && in_paren > 0)
501			--in_paren;
502
503		if ((!in_paren) && isalpha(c) && strchr(exempt, c) == 0)
504			return i;
505	}
506
507	return 0;
508}
509
510/*
511 * ncurses uses ESC to detect escaped char sequences. This resutl in
512 * a small timeout before ESC is actually delivered to the application.
513 * lxdialog suggest <ESC> <ESC> which is correctly translated to two
514 * times esc. But then we need to ignore the second esc to avoid stepping
515 * out one menu too much. Filter away all escaped key sequences since
516 * keypad(FALSE) turn off ncurses support for escape sequences - and that's
517 * needed to make notimeout() do as expected.
518 */
519int on_key_esc(WINDOW *win)
520{
521	int key;
522	int key2;
523	int key3;
524
525	nodelay(win, TRUE);
526	keypad(win, FALSE);
527	key = wgetch(win);
528	key2 = wgetch(win);
529	do {
530		key3 = wgetch(win);
531	} while (key3 != ERR);
532	nodelay(win, FALSE);
533	keypad(win, TRUE);
534	if (key == KEY_ESC && key2 == ERR)
535		return KEY_ESC;
536	else if (key != ERR && key != KEY_ESC && key2 == ERR)
537		ungetch(key);
538
539	return -1;
540}
541
542/* redraw screen in new size */
543int on_key_resize(void)
544{
545	dialog_clear();
546	return KEY_RESIZE;
547}
548
549struct dialog_list *item_cur;
550struct dialog_list item_nil;
551struct dialog_list *item_head;
552
553void item_reset(void)
554{
555	struct dialog_list *p, *next;
556
557	for (p = item_head; p; p = next) {
558		next = p->next;
559		free(p);
560	}
561	item_head = NULL;
562	item_cur = &item_nil;
563}
564
565void item_make(const char *fmt, ...)
566{
567	va_list ap;
568	struct dialog_list *p = malloc(sizeof(*p));
569
570	if (item_head)
571		item_cur->next = p;
572	else
573		item_head = p;
574	item_cur = p;
575	memset(p, 0, sizeof(*p));
576
577	va_start(ap, fmt);
578	vsnprintf(item_cur->node.str, sizeof(item_cur->node.str), fmt, ap);
579	va_end(ap);
580}
581
582void item_add_str(const char *fmt, ...)
583{
584	va_list ap;
585	size_t avail;
586
587	avail = sizeof(item_cur->node.str) - strlen(item_cur->node.str);
588
589	va_start(ap, fmt);
590	vsnprintf(item_cur->node.str + strlen(item_cur->node.str),
591		  avail, fmt, ap);
592	item_cur->node.str[sizeof(item_cur->node.str) - 1] = '\0';
593	va_end(ap);
594}
595
596void item_set_tag(char tag)
597{
598	item_cur->node.tag = tag;
599}
600void item_set_data(void *ptr)
601{
602	item_cur->node.data = ptr;
603}
604
605void item_set_selected(int val)
606{
607	item_cur->node.selected = val;
608}
609
610int item_activate_selected(void)
611{
612	item_foreach()
613		if (item_is_selected())
614			return 1;
615	return 0;
616}
617
618void *item_data(void)
619{
620	return item_cur->node.data;
621}
622
623char item_tag(void)
624{
625	return item_cur->node.tag;
626}
627
628int item_count(void)
629{
630	int n = 0;
631	struct dialog_list *p;
632
633	for (p = item_head; p; p = p->next)
634		n++;
635	return n;
636}
637
638void item_set(int n)
639{
640	int i = 0;
641	item_foreach()
642		if (i++ == n)
643			return;
644}
645
646int item_n(void)
647{
648	int n = 0;
649	struct dialog_list *p;
650
651	for (p = item_head; p; p = p->next) {
652		if (p == item_cur)
653			return n;
654		n++;
655	}
656	return 0;
657}
658
659const char *item_str(void)
660{
661	return item_cur->node.str;
662}
663
664int item_is_selected(void)
665{
666	return (item_cur->node.selected != 0);
667}
668
669int item_is_tag(char tag)
670{
671	return (item_cur->node.tag == tag);
672}