1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  *  dialog.h -- common declarations for all dialog modules
4  *
5  *  AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
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 #ifdef __sun__
17 #define CURS_MACROS
18 #endif
19 #include <ncurses.h>
20 
21 #define TR(params) _tracef params
22 
23 #define KEY_ESC 27
24 #define TAB 9
25 #define MAX_LEN 2048
26 #define BUF_SIZE (10*1024)
27 #define MIN(x,y) (x < y ? x : y)
28 #define MAX(x,y) (x > y ? x : y)
29 
30 #ifndef ACS_ULCORNER
31 #define ACS_ULCORNER '+'
32 #endif
33 #ifndef ACS_LLCORNER
34 #define ACS_LLCORNER '+'
35 #endif
36 #ifndef ACS_URCORNER
37 #define ACS_URCORNER '+'
38 #endif
39 #ifndef ACS_LRCORNER
40 #define ACS_LRCORNER '+'
41 #endif
42 #ifndef ACS_HLINE
43 #define ACS_HLINE '-'
44 #endif
45 #ifndef ACS_VLINE
46 #define ACS_VLINE '|'
47 #endif
48 #ifndef ACS_LTEE
49 #define ACS_LTEE '+'
50 #endif
51 #ifndef ACS_RTEE
52 #define ACS_RTEE '+'
53 #endif
54 #ifndef ACS_UARROW
55 #define ACS_UARROW '^'
56 #endif
57 #ifndef ACS_DARROW
58 #define ACS_DARROW 'v'
59 #endif
60 
61 /* error return codes */
62 #define ERRDISPLAYTOOSMALL (KEY_MAX + 1)
63 
64 /*
65  *   Color definitions
66  */
67 struct dialog_color {
68 	chtype atr;	/* Color attribute */
69 	int fg;		/* foreground */
70 	int bg;		/* background */
71 	int hl;		/* highlight this item */
72 };
73 
74 struct subtitle_list {
75 	struct subtitle_list *next;
76 	const char *text;
77 };
78 
79 struct dialog_info {
80 	const char *backtitle;
81 	struct subtitle_list *subtitles;
82 	struct dialog_color screen;
83 	struct dialog_color shadow;
84 	struct dialog_color dialog;
85 	struct dialog_color title;
86 	struct dialog_color border;
87 	struct dialog_color button_active;
88 	struct dialog_color button_inactive;
89 	struct dialog_color button_key_active;
90 	struct dialog_color button_key_inactive;
91 	struct dialog_color button_label_active;
92 	struct dialog_color button_label_inactive;
93 	struct dialog_color inputbox;
94 	struct dialog_color inputbox_border;
95 	struct dialog_color searchbox;
96 	struct dialog_color searchbox_title;
97 	struct dialog_color searchbox_border;
98 	struct dialog_color position_indicator;
99 	struct dialog_color menubox;
100 	struct dialog_color menubox_border;
101 	struct dialog_color item;
102 	struct dialog_color item_selected;
103 	struct dialog_color tag;
104 	struct dialog_color tag_selected;
105 	struct dialog_color tag_key;
106 	struct dialog_color tag_key_selected;
107 	struct dialog_color check;
108 	struct dialog_color check_selected;
109 	struct dialog_color uarrow;
110 	struct dialog_color darrow;
111 };
112 
113 /*
114  * Global variables
115  */
116 extern struct dialog_info dlg;
117 extern char dialog_input_result[];
118 extern int saved_x, saved_y;		/* Needed in signal handler in mconf.c */
119 
120 /*
121  * Function prototypes
122  */
123 
124 /* item list as used by checklist and menubox */
125 void item_reset(void);
126 void item_make(const char *fmt, ...);
127 void item_add_str(const char *fmt, ...);
128 void item_set_tag(char tag);
129 void item_set_data(void *p);
130 void item_set_selected(int val);
131 int item_activate_selected(void);
132 void *item_data(void);
133 char item_tag(void);
134 
135 /* item list manipulation for lxdialog use */
136 #define MAXITEMSTR 200
137 struct dialog_item {
138 	char str[MAXITEMSTR];	/* prompt displayed */
139 	char tag;
140 	void *data;	/* pointer to menu item - used by menubox+checklist */
141 	int selected;	/* Set to 1 by dialog_*() function if selected. */
142 };
143 
144 /* list of lialog_items */
145 struct dialog_list {
146 	struct dialog_item node;
147 	struct dialog_list *next;
148 };
149 
150 extern struct dialog_list *item_cur;
151 extern struct dialog_list item_nil;
152 extern struct dialog_list *item_head;
153 
154 int item_count(void);
155 void item_set(int n);
156 int item_n(void);
157 const char *item_str(void);
158 int item_is_selected(void);
159 int item_is_tag(char tag);
160 #define item_foreach() \
161 	for (item_cur = item_head ? item_head: item_cur; \
162 	     item_cur && (item_cur != &item_nil); item_cur = item_cur->next)
163 
164 /* generic key handlers */
165 int on_key_esc(WINDOW *win);
166 int on_key_resize(void);
167 
168 /* minimum (re)size values */
169 #define CHECKLIST_HEIGTH_MIN 6	/* For dialog_checklist() */
170 #define CHECKLIST_WIDTH_MIN 6
171 #define INPUTBOX_HEIGTH_MIN 2	/* For dialog_inputbox() */
172 #define INPUTBOX_WIDTH_MIN 2
173 #define MENUBOX_HEIGTH_MIN 15	/* For dialog_menu() */
174 #define MENUBOX_WIDTH_MIN 65
175 #define TEXTBOX_HEIGTH_MIN 8	/* For dialog_textbox() */
176 #define TEXTBOX_WIDTH_MIN 8
177 #define YESNO_HEIGTH_MIN 4	/* For dialog_yesno() */
178 #define YESNO_WIDTH_MIN 4
179 #define WINDOW_HEIGTH_MIN 19	/* For init_dialog() */
180 #define WINDOW_WIDTH_MIN 80
181 
182 int init_dialog(const char *backtitle);
183 void set_dialog_backtitle(const char *backtitle);
184 void set_dialog_subtitles(struct subtitle_list *subtitles);
185 void end_dialog(int x, int y);
186 void attr_clear(WINDOW * win, int height, int width, chtype attr);
187 void dialog_clear(void);
188 void print_autowrap(WINDOW * win, const char *prompt, int width, int y, int x);
189 void print_button(WINDOW * win, const char *label, int y, int x, int selected);
190 void print_title(WINDOW *dialog, const char *title, int width);
191 void draw_box(WINDOW * win, int y, int x, int height, int width, chtype box,
192 	      chtype border);
193 void draw_shadow(WINDOW * win, int y, int x, int height, int width);
194 
195 int first_alpha(const char *string, const char *exempt);
196 int dialog_yesno(const char *title, const char *prompt, int height, int width);
197 int dialog_msgbox(const char *title, const char *prompt, int height,
198 		  int width, int pause);
199 int dialog_textbox(const char *title, const char *tbuf, int initial_height,
200 		   int initial_width, int *_vscroll, int *_hscroll,
201 		   int (*extra_key_cb)(int, size_t, size_t, void *), void *data);
202 int dialog_menu(const char *title, const char *prompt,
203 		const void *selected, int *s_scroll);
204 int dialog_checklist(const char *title, const char *prompt, int height,
205 		     int width, int list_height);
206 int dialog_inputbox(const char *title, const char *prompt, int height,
207 		    int width, const char *init);
208