1 /*
2  *  $Id: progressbox.c,v 1.21 2012/07/03 00:12:52 tom Exp $
3  *
4  *  progressbox.c -- implements the progress box
5  *
6  *  Copyright 2005	Valery Reznic
7  *  Copyright 2006-2011	Thomas E. Dickey
8  *
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU Lesser General Public License as
11  *  published by the Free Software Foundation; either version 2.1 of the
12  *  License, or (at your option) any later version.
13  *
14  *  This program is distributed in the hope that it will be useful, but
15  *  WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  *  Lesser General Public License for more details.
18  *
19  *  You should have received a copy of the GNU Lesser General Public
20  *  License along with this program; if not, write to
21  *	Free Software Foundation, Inc.
22  *	51 Franklin St., Fifth Floor
23  *	Boston, MA 02110, USA.
24  */
25 
26 #include <dialog.h>
27 #include <dlg_keys.h>
28 
29 #define MIN_HIGH (4)
30 #define MIN_WIDE (10 + 2 * (2 + MARGIN))
31 
32 typedef struct {
33     DIALOG_CALLBACK obj;
34     WINDOW *text;
35     char line[MAX_LEN + 1];
36     int is_eof;
37 } MY_OBJ;
38 
39 /*
40  * Return current line of text.
41  */
42 static char *
get_line(MY_OBJ * obj)43 get_line(MY_OBJ * obj)
44 {
45     FILE *fp = obj->obj.input;
46     int col = 0;
47     int j, tmpint, ch;
48 
49     while (1) {
50 	if ((ch = getc(fp)) == EOF) {
51 	    obj->is_eof = 1;
52 	    if (col) {
53 		break;
54 	    } else {
55 		return NULL;
56 	    }
57 	}
58 	if (ch == '\n')
59 	    break;
60 	if (ch == '\r')
61 	    break;
62 	if ((ch == TAB) && (dialog_vars.tab_correct)) {
63 	    tmpint = dialog_state.tab_len
64 		- (col % dialog_state.tab_len);
65 	    for (j = 0; j < tmpint; j++) {
66 		if (col < MAX_LEN)
67 		    obj->line[col] = ' ';
68 		++col;
69 	    }
70 	} else {
71 	    obj->line[col] = (char) ch;
72 	    ++col;
73 	}
74 	if (col >= MAX_LEN)
75 	    break;
76     }
77 
78     obj->line[col] = '\0';
79 
80     return obj->line;
81 }
82 
83 /*
84  * Print a new line of text.
85  */
86 static void
print_line(MY_OBJ * obj,WINDOW * win,int row,int width)87 print_line(MY_OBJ * obj, WINDOW *win, int row, int width)
88 {
89     int i, y, x;
90     char *line = obj->line;
91 
92     (void) wmove(win, row, 0);	/* move cursor to correct line */
93     (void) waddch(win, ' ');
94 #ifdef NCURSES_VERSION
95     (void) waddnstr(win, line, MIN((int) strlen(line), width - 2));
96 #else
97     line[MIN((int) strlen(line), width - 2)] = '\0';
98     waddstr(win, line);
99 #endif
100 
101     getyx(win, y, x);
102     (void) y;
103     /* Clear 'residue' of previous line */
104     for (i = 0; i < width - x; i++)
105 	(void) waddch(win, ' ');
106 }
107 
108 static int
pause_for_ok(WINDOW * dialog,int height,int width)109 pause_for_ok(WINDOW *dialog, int height, int width)
110 {
111     /* *INDENT-OFF* */
112     static DLG_KEYS_BINDING binding[] = {
113 	HELPKEY_BINDINGS,
114 	ENTERKEY_BINDINGS,
115 	TRAVERSE_BINDINGS,
116 	END_KEYS_BINDING
117     };
118     /* *INDENT-ON* */
119 
120     int button;
121     int key = 0, fkey;
122     int result = DLG_EXIT_UNKNOWN;
123     const char **buttons = dlg_ok_label();
124     int check;
125     int save_nocancel = dialog_vars.nocancel;
126     bool redraw = TRUE;
127 
128     dialog_vars.nocancel = TRUE;
129     button = dlg_default_button();
130 
131     dlg_register_window(dialog, "progressbox", binding);
132     dlg_register_buttons(dialog, "progressbox", buttons);
133 
134     dlg_draw_bottom_box2(dialog, border_attr, border2_attr, dialog_attr);
135     mouse_mkbutton(height - 2, width / 2 - 4, 6, '\n');
136 
137     while (result == DLG_EXIT_UNKNOWN) {
138 	if (redraw) {
139 	    redraw = FALSE;
140 	    if (button < 0)
141 		button = 0;
142 	    dlg_draw_buttons(dialog,
143 			     height - 2, 0,
144 			     buttons, button,
145 			     FALSE, width);
146 	}
147 
148 	key = dlg_mouse_wgetch(dialog, &fkey);
149 	if (dlg_result_key(key, fkey, &result))
150 	    break;
151 
152 	if (!fkey && (check = dlg_char_to_button(key, buttons)) >= 0) {
153 	    result = dlg_ok_buttoncode(check);
154 	    break;
155 	}
156 
157 	if (fkey) {
158 	    switch (key) {
159 	    case DLGK_FIELD_NEXT:
160 		button = dlg_next_button(buttons, button);
161 		redraw = TRUE;
162 		break;
163 	    case DLGK_FIELD_PREV:
164 		button = dlg_prev_button(buttons, button);
165 		redraw = TRUE;
166 		break;
167 	    case DLGK_ENTER:
168 		result = dlg_ok_buttoncode(button);
169 		break;
170 	    default:
171 		if (is_DLGK_MOUSE(key)) {
172 		    result = dlg_ok_buttoncode(key - M_EVENT);
173 		    if (result < 0)
174 			result = DLG_EXIT_OK;
175 		} else {
176 		    beep();
177 		}
178 		break;
179 	    }
180 
181 	} else {
182 	    beep();
183 	}
184     }
185     dlg_unregister_window(dialog);
186 
187     dialog_vars.nocancel = save_nocancel;
188     return result;
189 }
190 
191 int
dlg_progressbox(const char * title,const char * cprompt,int height,int width,int pauseopt,FILE * fp)192 dlg_progressbox(const char *title,
193 		const char *cprompt,
194 		int height,
195 		int width,
196 		int pauseopt,
197 		FILE *fp)
198 {
199     int i;
200     int x, y, thigh;
201     WINDOW *dialog, *text;
202     MY_OBJ *obj;
203     char *prompt = dlg_strclone(cprompt);
204     int result;
205 
206     dlg_tab_correct_str(prompt);
207     dlg_auto_size(title, prompt, &height, &width, MIN_HIGH, MIN_WIDE);
208     dlg_print_size(height, width);
209     dlg_ctl_size(height, width);
210 
211     x = dlg_box_x_ordinate(width);
212     y = dlg_box_y_ordinate(height);
213     thigh = height - (2 * MARGIN);
214 
215     dialog = dlg_new_window(height, width, y, x);
216 
217     dlg_draw_box2(dialog, 0, 0, height, width, dialog_attr, border_attr, border2_attr);
218     dlg_draw_title(dialog, title);
219     dlg_draw_helpline(dialog, FALSE);
220 
221     if (*prompt != '\0') {
222 	int y2, x2;
223 
224 	(void) wattrset(dialog, dialog_attr);
225 	dlg_print_autowrap(dialog, prompt, height, width);
226 	getyx(dialog, y2, x2);
227 	(void) x2;
228 	++y2;
229 	wmove(dialog, y2, MARGIN);
230 	for (i = 0; i < getmaxx(dialog) - 2 * MARGIN; i++)
231 	    (void) waddch(dialog, dlg_boxchar(ACS_HLINE));
232 	y += y2;
233 	thigh -= y2;
234     }
235 
236     /* Create window for text region, used for scrolling text */
237     text = dlg_sub_window(dialog,
238 			  thigh,
239 			  width - (2 * MARGIN),
240 			  y + MARGIN,
241 			  x + MARGIN);
242 
243     (void) wrefresh(dialog);
244 
245     (void) wmove(dialog, thigh, (MARGIN + 1));
246     (void) wnoutrefresh(dialog);
247 
248     obj = dlg_calloc(MY_OBJ, 1);
249     assert_ptr(obj, "dlg_progressbox");
250 
251     obj->obj.input = fp;
252     obj->obj.win = dialog;
253     obj->text = text;
254 
255     dlg_attr_clear(text, thigh, getmaxx(text), dialog_attr);
256     for (i = 0; get_line(obj); i++) {
257 	if (i < thigh) {
258 	    print_line(obj, text, i, width - (2 * MARGIN));
259 	} else {
260 	    scrollok(text, TRUE);
261 	    scroll(text);
262 	    scrollok(text, FALSE);
263 	    print_line(obj, text, thigh - 1, width - (2 * MARGIN));
264 	}
265 	(void) wrefresh(text);
266 	dlg_trace_win(dialog);
267 	if (obj->is_eof)
268 	    break;
269     }
270 
271     if (pauseopt) {
272 	scrollok(text, TRUE);
273 	wscrl(text, 1 + MARGIN);
274 	(void) wrefresh(text);
275 	result = pause_for_ok(dialog, height, width);
276     } else {
277 	wrefresh(dialog);
278 	result = DLG_EXIT_OK;
279     }
280 
281     dlg_del_window(dialog);
282     free(prompt);
283     free(obj);
284 
285     return result;
286 }
287 
288 /*
289  * Display text from a stdin in a scrolling window.
290  */
291 int
dialog_progressbox(const char * title,const char * cprompt,int height,int width)292 dialog_progressbox(const char *title, const char *cprompt, int height, int width)
293 {
294     int result;
295     result = dlg_progressbox(title,
296 			     cprompt,
297 			     height,
298 			     width,
299 			     FALSE,
300 			     dialog_state.pipe_input);
301     dialog_state.pipe_input = 0;
302     return result;
303 }
304