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