[thirdparty/u-boot.git] / scripts / kconfig / lxdialog / dialog.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 *  dialog.h -- common declarations for all dialog modules
 *
 *  AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
 */

#include <sys/types.h>
#include <fcntl.h>
#include <unistd.h>
#include <ctype.h>
#include <stdlib.h>
#include <string.h>
#include <stdbool.h>

#ifndef KBUILD_NO_NLS
# include <libintl.h>
#else
# define gettext(Msgid) ((const char *) (Msgid))
#endif

#ifdef __sun__
#define CURS_MACROS
#endif
#include CURSES_LOC

/*
 * Colors in ncurses 1.9.9e do not work properly since foreground and
 * background colors are OR'd rather than separately masked.  This version
 * of dialog was hacked to work with ncurses 1.9.9e, making it incompatible
 * with standard curses.  The simplest fix (to make this work with standard
 * curses) uses the wbkgdset() function, not used in the original hack.
 * Turn it off if we're building with 1.9.9e, since it just confuses things.
 */
#if defined(NCURSES_VERSION) && defined(_NEED_WRAP) && !defined(GCC_PRINTFLIKE)
#define OLD_NCURSES 1
#undef  wbkgdset
#define wbkgdset(w,p)		/*nothing */
#else
#define OLD_NCURSES 0
#endif

#define TR(params) _tracef params

#define KEY_ESC 27
#define TAB 9
#define MAX_LEN 2048
#define BUF_SIZE (10*1024)
#define MIN(x,y) (x < y ? x : y)
#define MAX(x,y) (x > y ? x : y)

#ifndef ACS_ULCORNER
#define ACS_ULCORNER '+'
#endif
#ifndef ACS_LLCORNER
#define ACS_LLCORNER '+'
#endif
#ifndef ACS_URCORNER
#define ACS_URCORNER '+'
#endif
#ifndef ACS_LRCORNER
#define ACS_LRCORNER '+'
#endif
#ifndef ACS_HLINE
#define ACS_HLINE '-'
#endif
#ifndef ACS_VLINE
#define ACS_VLINE '|'
#endif
#ifndef ACS_LTEE
#define ACS_LTEE '+'
#endif
#ifndef ACS_RTEE
#define ACS_RTEE '+'
#endif
#ifndef ACS_UARROW
#define ACS_UARROW '^'
#endif
#ifndef ACS_DARROW
#define ACS_DARROW 'v'
#endif

/* error return codes */
#define ERRDISPLAYTOOSMALL (KEY_MAX + 1)

/*
 *   Color definitions
 */
struct dialog_color {
	chtype atr;	/* Color attribute */
	int fg;		/* foreground */
	int bg;		/* background */
	int hl;		/* highlight this item */
};

struct subtitle_list {
	struct subtitle_list *next;
	const char *text;
};

struct dialog_info {
	const char *backtitle;
	struct subtitle_list *subtitles;
	struct dialog_color screen;
	struct dialog_color shadow;
	struct dialog_color dialog;
	struct dialog_color title;
	struct dialog_color border;
	struct dialog_color button_active;
	struct dialog_color button_inactive;
	struct dialog_color button_key_active;
	struct dialog_color button_key_inactive;
	struct dialog_color button_label_active;
	struct dialog_color button_label_inactive;
	struct dialog_color inputbox;
	struct dialog_color inputbox_border;
	struct dialog_color searchbox;
	struct dialog_color searchbox_title;
	struct dialog_color searchbox_border;
	struct dialog_color position_indicator;
	struct dialog_color menubox;
	struct dialog_color menubox_border;
	struct dialog_color item;
	struct dialog_color item_selected;
	struct dialog_color tag;
	struct dialog_color tag_selected;
	struct dialog_color tag_key;
	struct dialog_color tag_key_selected;
	struct dialog_color check;
	struct dialog_color check_selected;
	struct dialog_color uarrow;
	struct dialog_color darrow;
};

/*
 * Global variables
 */
extern struct dialog_info dlg;
extern char dialog_input_result[];
extern int saved_x, saved_y;		/* Needed in signal handler in mconf.c */

/*
 * Function prototypes
 */

/* item list as used by checklist and menubox */
void item_reset(void);
void item_make(const char *fmt, ...);
void item_add_str(const char *fmt, ...);
void item_set_tag(char tag);
void item_set_data(void *p);
void item_set_selected(int val);
int item_activate_selected(void);
void *item_data(void);
char item_tag(void);

/* item list manipulation for lxdialog use */
#define MAXITEMSTR 200
struct dialog_item {
	char str[MAXITEMSTR];	/* prompt displayed */
	char tag;
	void *data;	/* pointer to menu item - used by menubox+checklist */
	int selected;	/* Set to 1 by dialog_*() function if selected. */
};

/* list of lialog_items */
struct dialog_list {
	struct dialog_item node;
	struct dialog_list *next;
};

extern struct dialog_list *item_cur;
extern struct dialog_list item_nil;
extern struct dialog_list *item_head;

int item_count(void);
void item_set(int n);
int item_n(void);
const char *item_str(void);
int item_is_selected(void);
int item_is_tag(char tag);
#define item_foreach() \
	for (item_cur = item_head ? item_head: item_cur; \
	     item_cur && (item_cur != &item_nil); item_cur = item_cur->next)

/* generic key handlers */
int on_key_esc(WINDOW *win);
int on_key_resize(void);

/* minimum (re)size values */
#define CHECKLIST_HEIGTH_MIN 6	/* For dialog_checklist() */
#define CHECKLIST_WIDTH_MIN 6
#define INPUTBOX_HEIGTH_MIN 2	/* For dialog_inputbox() */
#define INPUTBOX_WIDTH_MIN 2
#define MENUBOX_HEIGTH_MIN 15	/* For dialog_menu() */
#define MENUBOX_WIDTH_MIN 65
#define TEXTBOX_HEIGTH_MIN 8	/* For dialog_textbox() */
#define TEXTBOX_WIDTH_MIN 8
#define YESNO_HEIGTH_MIN 4	/* For dialog_yesno() */
#define YESNO_WIDTH_MIN 4
#define WINDOW_HEIGTH_MIN 19	/* For init_dialog() */
#define WINDOW_WIDTH_MIN 80

int init_dialog(const char *backtitle);
void set_dialog_backtitle(const char *backtitle);
void set_dialog_subtitles(struct subtitle_list *subtitles);
void end_dialog(int x, int y);
void attr_clear(WINDOW * win, int height, int width, chtype attr);
void dialog_clear(void);
void print_autowrap(WINDOW * win, const char *prompt, int width, int y, int x);
void print_button(WINDOW * win, const char *label, int y, int x, int selected);
void print_title(WINDOW *dialog, const char *title, int width);
void draw_box(WINDOW * win, int y, int x, int height, int width, chtype box,
	      chtype border);
void draw_shadow(WINDOW * win, int y, int x, int height, int width);

int first_alpha(const char *string, const char *exempt);
int dialog_yesno(const char *title, const char *prompt, int height, int width);
int dialog_msgbox(const char *title, const char *prompt, int height,
		  int width, int pause);


typedef void (*update_text_fn)(char *buf, size_t start, size_t end, void
			       *_data);
int dialog_textbox(const char *title, char *tbuf, int initial_height,
		   int initial_width, int *keys, int *_vscroll, int *_hscroll,
		   update_text_fn update_text, void *data);
int dialog_menu(const char *title, const char *prompt,
		const void *selected, int *s_scroll);
int dialog_checklist(const char *title, const char *prompt, int height,
		     int width, int list_height);
int dialog_inputbox(const char *title, const char *prompt, int height,
		    int width, const char *init);

/*
 * This is the base for fictitious keys, which activate
 * the buttons.
 *
 * Mouse-generated keys are the following:
 *   -- the first 32 are used as numbers, in addition to '0'-'9'
 *   -- the lowercase are used to signal mouse-enter events (M_EVENT + 'o')
 *   -- uppercase chars are used to invoke the button (M_EVENT + 'O')
 */
#define M_EVENT (KEY_MAX+1)
Commit	Line	Data
83d290c5	1	/* SPDX-License-Identifier: GPL-2.0+ */
0a9064fb MY	2	/*
	3	* dialog.h -- common declarations for all dialog modules
	4	*
	5	* AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
0a9064fb MY	6	*/
	7
	8	#include <sys/types.h>
	9	#include <fcntl.h>
	10	#include <unistd.h>
	11	#include <ctype.h>
	12	#include <stdlib.h>
	13	#include <string.h>
	14	#include <stdbool.h>
	15
	16	#ifndef KBUILD_NO_NLS
	17	# include <libintl.h>
	18	#else
	19	# define gettext(Msgid) ((const char *) (Msgid))
	20	#endif
	21
	22	#ifdef __sun__
	23	#define CURS_MACROS
	24	#endif
	25	#include CURSES_LOC
	26
	27	/*
	28	* Colors in ncurses 1.9.9e do not work properly since foreground and
	29	* background colors are OR'd rather than separately masked. This version
	30	* of dialog was hacked to work with ncurses 1.9.9e, making it incompatible
	31	* with standard curses. The simplest fix (to make this work with standard
	32	* curses) uses the wbkgdset() function, not used in the original hack.
	33	* Turn it off if we're building with 1.9.9e, since it just confuses things.
	34	*/
	35	#if defined(NCURSES_VERSION) && defined(_NEED_WRAP) && !defined(GCC_PRINTFLIKE)
	36	#define OLD_NCURSES 1
	37	#undef wbkgdset
	38	#define wbkgdset(w,p) /nothing /
	39	#else
	40	#define OLD_NCURSES 0
	41	#endif
	42
	43	#define TR(params) _tracef params
	44
	45	#define KEY_ESC 27
	46	#define TAB 9
	47	#define MAX_LEN 2048
	48	#define BUF_SIZE (10*1024)
	49	#define MIN(x,y) (x < y ? x : y)
	50	#define MAX(x,y) (x > y ? x : y)
	51
	52	#ifndef ACS_ULCORNER
	53	#define ACS_ULCORNER '+'
	54	#endif
	55	#ifndef ACS_LLCORNER
	56	#define ACS_LLCORNER '+'
	57	#endif
	58	#ifndef ACS_URCORNER
	59	#define ACS_URCORNER '+'
	60	#endif
	61	#ifndef ACS_LRCORNER
	62	#define ACS_LRCORNER '+'
	63	#endif
	64	#ifndef ACS_HLINE
	65	#define ACS_HLINE '-'
	66	#endif
	67	#ifndef ACS_VLINE
	68	#define ACS_VLINE '\|'
	69	#endif
70	#ifndef ACS_LTEE
71	#define ACS_LTEE '+'
72	#endif
73	#ifndef ACS_RTEE
74	#define ACS_RTEE '+'
75	#endif
76	#ifndef ACS_UARROW
77	#define ACS_UARROW '^'
78	#endif
79	#ifndef ACS_DARROW
80	#define ACS_DARROW 'v'
81	#endif
82
83	/* error return codes */
84	#define ERRDISPLAYTOOSMALL (KEY_MAX + 1)
85
86	/*
87	* Color definitions
88	*/
89	struct dialog_color {
90	chtype atr; /* Color attribute */
91	int fg; /* foreground */
92	int bg; /* background */
93	int hl; /* highlight this item */
94	};
95
96	struct subtitle_list {
97	struct subtitle_list *next;
98	const char *text;
99	};
100
101	struct dialog_info {
102	const char *backtitle;
103	struct subtitle_list *subtitles;
104	struct dialog_color screen;
105	struct dialog_color shadow;
106	struct dialog_color dialog;
107	struct dialog_color title;
108	struct dialog_color border;
109	struct dialog_color button_active;
110	struct dialog_color button_inactive;
111	struct dialog_color button_key_active;
112	struct dialog_color button_key_inactive;
113	struct dialog_color button_label_active;
114	struct dialog_color button_label_inactive;
115	struct dialog_color inputbox;
116	struct dialog_color inputbox_border;
117	struct dialog_color searchbox;
118	struct dialog_color searchbox_title;
119	struct dialog_color searchbox_border;
120	struct dialog_color position_indicator;
121	struct dialog_color menubox;
122	struct dialog_color menubox_border;
123	struct dialog_color item;
124	struct dialog_color item_selected;
125	struct dialog_color tag;
126	struct dialog_color tag_selected;
127	struct dialog_color tag_key;
128	struct dialog_color tag_key_selected;
129	struct dialog_color check;
130	struct dialog_color check_selected;
131	struct dialog_color uarrow;
132	struct dialog_color darrow;
133	};
134
135	/*
136	* Global variables
137	*/
138	extern struct dialog_info dlg;
139	extern char dialog_input_result[];
140	extern int saved_x, saved_y; /* Needed in signal handler in mconf.c */
141
142	/*
143	* Function prototypes
144	*/
145
146	/* item list as used by checklist and menubox */
147	void item_reset(void);
148	void item_make(const char *fmt, ...);
149	void item_add_str(const char *fmt, ...);
150	void item_set_tag(char tag);
151	void item_set_data(void *p);
152	void item_set_selected(int val);
153	int item_activate_selected(void);
154	void *item_data(void);
155	char item_tag(void);
156
157	/* item list manipulation for lxdialog use */
158	#define MAXITEMSTR 200
159	struct dialog_item {
ad618992	160	char str[MAXITEMSTR]; /* prompt displayed */
0a9064fb MY	161	char tag;
	162	void data; / pointer to menu item - used by menubox+checklist */
	163	int selected; /* Set to 1 by dialog_() function if selected. /
	164	};
	165
	166	/* list of lialog_items */
	167	struct dialog_list {
	168	struct dialog_item node;
	169	struct dialog_list *next;
	170	};
	171
	172	extern struct dialog_list *item_cur;
	173	extern struct dialog_list item_nil;
	174	extern struct dialog_list *item_head;
	175
	176	int item_count(void);
	177	void item_set(int n);
	178	int item_n(void);
	179	const char *item_str(void);
	180	int item_is_selected(void);
	181	int item_is_tag(char tag);
	182	#define item_foreach() \
	183	for (item_cur = item_head ? item_head: item_cur; \
	184	item_cur && (item_cur != &item_nil); item_cur = item_cur->next)
	185
	186	/* generic key handlers */
	187	int on_key_esc(WINDOW *win);
	188	int on_key_resize(void);
	189
	190	/* minimum (re)size values */
	191	#define CHECKLIST_HEIGTH_MIN 6 /* For dialog_checklist() */
	192	#define CHECKLIST_WIDTH_MIN 6
	193	#define INPUTBOX_HEIGTH_MIN 2 /* For dialog_inputbox() */
	194	#define INPUTBOX_WIDTH_MIN 2
	195	#define MENUBOX_HEIGTH_MIN 15 /* For dialog_menu() */
	196	#define MENUBOX_WIDTH_MIN 65
	197	#define TEXTBOX_HEIGTH_MIN 8 /* For dialog_textbox() */
	198	#define TEXTBOX_WIDTH_MIN 8
	199	#define YESNO_HEIGTH_MIN 4 /* For dialog_yesno() */
	200	#define YESNO_WIDTH_MIN 4
	201	#define WINDOW_HEIGTH_MIN 19 /* For init_dialog() */
	202	#define WINDOW_WIDTH_MIN 80
	203
	204	int init_dialog(const char *backtitle);
	205	void set_dialog_backtitle(const char *backtitle);
	206	void set_dialog_subtitles(struct subtitle_list *subtitles);
	207	void end_dialog(int x, int y);
	208	void attr_clear(WINDOW * win, int height, int width, chtype attr);
	209	void dialog_clear(void);
	210	void print_autowrap(WINDOW * win, const char *prompt, int width, int y, int x);
	211	void print_button(WINDOW * win, const char *label, int y, int x, int selected);
	212	void print_title(WINDOW dialog, const char title, int width);
	213	void draw_box(WINDOW * win, int y, int x, int height, int width, chtype box,
	214	chtype border);
	215	void draw_shadow(WINDOW * win, int y, int x, int height, int width);
	216
	217	int first_alpha(const char string, const char exempt);
	218	int dialog_yesno(const char title, const char prompt, int height, int width);
	219	int dialog_msgbox(const char title, const char prompt, int height,
	220	int width, int pause);
	221
	222
	223	typedef void (update_text_fn)(char buf, size_t start, size_t end, void
	224	*_data);
225	int dialog_textbox(const char title, char tbuf, int initial_height,
226	int initial_width, int keys, int _vscroll, int *_hscroll,
227	update_text_fn update_text, void *data);
228	int dialog_menu(const char title, const char prompt,
229	const void selected, int s_scroll);
230	int dialog_checklist(const char title, const char prompt, int height,
231	int width, int list_height);
232	int dialog_inputbox(const char title, const char prompt, int height,
233	int width, const char *init);
234
235	/*
236	* This is the base for fictitious keys, which activate
237	* the buttons.
238	*
239	* Mouse-generated keys are the following:
240	* -- the first 32 are used as numbers, in addition to '0'-'9'
241	* -- the lowercase are used to signal mouse-enter events (M_EVENT + 'o')
242	* -- uppercase chars are used to invoke the button (M_EVENT + 'O')
243	*/
244	#define M_EVENT (KEY_MAX+1)