guage.c revision 6633bf70ed24c304037f64ca2f28e6ea8d2a0b47
1/*
2 *  $Id: guage.c,v 1.68 2013/09/22 19:10:22 tom Exp $
3 *
4 *  guage.c -- implements the gauge dialog
5 *
6 *  Copyright 2000-2012,2013	Thomas E. Dickey
7 *
8 *  This program is free software; you can redistribute it and/or modify
9 *  it under the terms of the GNU Lesser General Public License, version 2.1
10 *  as published by the Free Software Foundation.
11 *
12 *  This program is distributed in the hope that it will be useful, but
13 *  WITHOUT ANY WARRANTY; without even the implied warranty of
14 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 *  Lesser General Public License for more details.
16 *
17 *  You should have received a copy of the GNU Lesser General Public
18 *  License along with this program; if not, write to
19 *	Free Software Foundation, Inc.
20 *	51 Franklin St., Fifth Floor
21 *	Boston, MA 02110, USA.
22 *
23 *  An earlier version of this program lists as authors
24 *	Marc Ewing, Red Hat Software
25 */
26
27#include <dialog.h>
28
29#include <errno.h>
30
31#define MY_LEN (MAX_LEN)/2
32
33#define MIN_HIGH (4)
34#define MIN_WIDE (10 + 2 * (2 + MARGIN))
35
36#define isMarker(buf) !strncmp(buf, "XXX", (size_t) 3)
37
38typedef struct _my_obj {
39    DIALOG_CALLBACK obj;	/* has to be first in struct */
40    struct _my_obj *next;
41    WINDOW *text;
42    char *title;
43    char *prompt;
44    char prompt_buf[MY_LEN];
45    int percent;
46    int height;
47    int width;
48    char line[MAX_LEN + 1];
49} MY_OBJ;
50
51static MY_OBJ *all_objects;
52
53static int
54valid(MY_OBJ * obj)
55{
56    MY_OBJ *list = all_objects;
57    int result = 0;
58
59    while (list != 0) {
60	if (list == obj) {
61	    result = 1;
62	    break;
63	}
64	list = list->next;
65    }
66    return result;
67}
68
69static void
70delink(MY_OBJ * obj)
71{
72    MY_OBJ *p = all_objects;
73    MY_OBJ *q = 0;
74    while (p != 0) {
75	if (p == obj) {
76	    if (q != 0) {
77		q->next = p->next;
78	    } else {
79		all_objects = p->next;
80	    }
81	    break;
82	}
83	q = p;
84	p = p->next;
85    }
86}
87
88static int
89read_data(char *buffer, FILE *fp)
90{
91    int result;
92
93    if (feof(fp)) {
94	result = 0;
95    } else if (fgets(buffer, MY_LEN, fp) != 0) {
96	DLG_TRACE(("read_data:%s", buffer));
97	buffer[MY_LEN] = '\0';
98	dlg_trim_string(buffer);
99	result = 1;
100    } else {
101	result = -1;
102    }
103    return result;
104}
105
106static int
107decode_percent(char *buffer)
108{
109    char *tmp = 0;
110    long value = strtol(buffer, &tmp, 10);
111
112    if (tmp != 0 && (*tmp == 0 || isspace(UCH(*tmp))) && value >= 0) {
113	return TRUE;
114    }
115    return FALSE;
116}
117
118static void
119repaint_text(MY_OBJ * obj)
120{
121    WINDOW *dialog = obj->obj.win;
122    int i, x;
123
124    if (dialog != 0 && obj->obj.input != 0) {
125	(void) werase(dialog);
126	dlg_draw_box2(dialog, 0, 0, obj->height, obj->width, dialog_attr,
127		      border_attr, border2_attr);
128
129	dlg_draw_title(dialog, obj->title);
130
131	(void) wattrset(dialog, dialog_attr);
132	dlg_draw_helpline(dialog, FALSE);
133	dlg_print_autowrap(dialog, obj->prompt, obj->height, obj->width);
134
135	dlg_draw_box2(dialog,
136		      obj->height - 4, 2 + MARGIN,
137		      2 + MARGIN, obj->width - 2 * (2 + MARGIN),
138		      dialog_attr,
139		      border_attr,
140		      border2_attr);
141
142	/*
143	 * Clear the area for the progress bar by filling it with spaces
144	 * in the gauge-attribute, and write the percentage with that
145	 * attribute.
146	 */
147	(void) wmove(dialog, obj->height - 3, 4);
148	(void) wattrset(dialog, gauge_attr);
149
150	for (i = 0; i < (obj->width - 2 * (3 + MARGIN)); i++)
151	    (void) waddch(dialog, ' ');
152
153	(void) wmove(dialog, obj->height - 3, (obj->width / 2) - 2);
154	(void) wprintw(dialog, "%3d%%", obj->percent);
155
156	/*
157	 * Now draw a bar in reverse, relative to the background.
158	 * The window attribute was useful for painting the background,
159	 * but requires some tweaks to reverse it.
160	 */
161	x = (obj->percent * (obj->width - 2 * (3 + MARGIN))) / 100;
162	if ((gauge_attr & A_REVERSE) != 0) {
163	    wattroff(dialog, A_REVERSE);
164	} else {
165	    (void) wattrset(dialog, A_REVERSE);
166	}
167	(void) wmove(dialog, obj->height - 3, 4);
168	for (i = 0; i < x; i++) {
169	    chtype ch2 = winch(dialog);
170	    if (gauge_attr & A_REVERSE) {
171		ch2 &= ~A_REVERSE;
172	    }
173	    (void) waddch(dialog, ch2);
174	}
175
176	(void) wrefresh(dialog);
177    }
178}
179
180static bool
181handle_input(DIALOG_CALLBACK * cb)
182{
183    MY_OBJ *obj = (MY_OBJ *) cb;
184    bool result;
185    int status;
186    char buf[MY_LEN + 1];
187
188    if (dialog_state.pipe_input == 0) {
189	status = -1;
190    } else if ((status = read_data(buf, dialog_state.pipe_input)) > 0) {
191
192	if (isMarker(buf)) {
193	    /*
194	     * Historically, next line should be percentage, but one of the
195	     * worse-written clones of 'dialog' assumes the number is missing.
196	     * (Gresham's Law applied to software).
197	     */
198	    if ((status = read_data(buf, dialog_state.pipe_input)) > 0) {
199
200		obj->prompt_buf[0] = '\0';
201		if (decode_percent(buf))
202		    obj->percent = atoi(buf);
203		else
204		    strcpy(obj->prompt_buf, buf);
205
206		/* Rest is message text */
207		while ((status = read_data(buf, dialog_state.pipe_input)) > 0
208		       && !isMarker(buf)) {
209		    if (strlen(obj->prompt_buf) + strlen(buf) <
210			sizeof(obj->prompt_buf) - 1) {
211			strcat(obj->prompt_buf, buf);
212		    }
213		}
214
215		if (obj->prompt != obj->prompt_buf)
216		    free(obj->prompt);
217		obj->prompt = obj->prompt_buf;
218	    }
219	} else if (decode_percent(buf)) {
220	    obj->percent = atoi(buf);
221	}
222    } else {
223	if (feof(dialog_state.pipe_input) ||
224	    (ferror(dialog_state.pipe_input) && errno != EINTR)) {
225	    delink(obj);
226	    dlg_remove_callback(cb);
227	}
228    }
229
230    if (status > 0) {
231	result = TRUE;
232	repaint_text(obj);
233    } else {
234	result = FALSE;
235    }
236
237    return result;
238}
239
240static bool
241handle_my_getc(DIALOG_CALLBACK * cb, int ch, int fkey, int *result)
242{
243    int status = TRUE;
244
245    *result = DLG_EXIT_OK;
246    if (cb != 0) {
247	if (!fkey && (ch == ERR)) {
248	    (void) handle_input(cb);
249	    /* cb might be freed in handle_input */
250	    status = (valid((MY_OBJ *) cb) && (cb->input != 0));
251	}
252    } else {
253	status = FALSE;
254    }
255    return status;
256}
257
258static void
259my_cleanup(DIALOG_CALLBACK * cb)
260{
261    MY_OBJ *obj = (MY_OBJ *) cb;
262
263    if (valid(obj)) {
264	if (obj->prompt != obj->prompt_buf) {
265	    free(obj->prompt);
266	    obj->prompt = obj->prompt_buf;
267	}
268	delink(obj);
269    }
270}
271
272void
273dlg_update_gauge(void *objptr, int percent)
274{
275    MY_OBJ *obj = (MY_OBJ *) objptr;
276    bool save_finish_string = dialog_state.finish_string;
277
278    dialog_state.finish_string = TRUE;
279    curs_set(0);
280    obj->percent = percent;
281    repaint_text(obj);
282    dialog_state.finish_string = save_finish_string;
283}
284
285/*
286 * (Re)Allocates an object and fills it as per the arguments
287 */
288void *
289dlg_reallocate_gauge(void *objptr,
290		     const char *title,
291		     const char *cprompt,
292		     int height,
293		     int width,
294		     int percent)
295{
296    char *prompt = dlg_strclone(cprompt);
297    MY_OBJ *obj = objptr;
298    bool save_finish_string = dialog_state.finish_string;
299
300    dialog_state.finish_string = TRUE;
301    dlg_tab_correct_str(prompt);
302
303    if (objptr == 0) {
304	/* create a new object */
305	obj = dlg_calloc(MY_OBJ, 1);
306	assert_ptr(obj, "dialog_gauge");
307
308	dlg_auto_size(title, prompt, &height, &width, MIN_HIGH, MIN_WIDE);
309	dlg_print_size(height, width);
310	dlg_ctl_size(height, width);
311
312    } else {
313	/* reuse an existing object */
314	obj = objptr;
315	height = obj->height;
316	width = obj->width;
317    }
318
319    if (obj->obj.win == 0) {
320	/* center dialog box on screen */
321	int x = dlg_box_x_ordinate(width);
322	int y = dlg_box_y_ordinate(height);
323	WINDOW *dialog = dlg_new_window(height, width, y, x);
324	obj->obj.win = dialog;
325    }
326
327    obj->obj.input = dialog_state.pipe_input;
328    obj->obj.keep_win = TRUE;
329    obj->obj.bg_task = TRUE;
330    obj->obj.handle_getc = handle_my_getc;
331    obj->obj.handle_input = handle_input;
332
333    if (obj->title == 0 || strcmp(obj->title, title)) {
334	dlg_finish_string(obj->title);
335	free(obj->title);
336	obj->title = dlg_strclone(title);
337    }
338
339    dlg_finish_string(obj->prompt);
340    free(obj->prompt);
341
342    obj->prompt = prompt;
343    obj->percent = percent;
344    obj->height = height;
345    obj->width = width;
346
347    /* if this was a new object, link it into the list */
348    if (objptr == 0) {
349	obj->next = all_objects;
350	all_objects = obj;
351    }
352
353    dialog_state.finish_string = save_finish_string;
354    return (void *) obj;
355}
356
357void *
358dlg_allocate_gauge(const char *title,
359		   const char *cprompt,
360		   int height,
361		   int width,
362		   int percent)
363{
364    return dlg_reallocate_gauge(NULL, title, cprompt, height, width, percent);
365}
366
367void
368dlg_free_gauge(void *objptr)
369{
370    MY_OBJ *obj = (MY_OBJ *) objptr;
371
372    curs_set(1);
373    if (valid(obj)) {
374	delink(obj);
375	obj->obj.keep_win = FALSE;
376	dlg_remove_callback(&(obj->obj));
377    }
378}
379
380/*
381 * Display a gauge, or progress meter.  Starts at percent% and reads stdin.  If
382 * stdin is not XXX, then it is interpreted as a percentage, and the display is
383 * updated accordingly.  Otherwise the next line is the percentage, and
384 * subsequent lines up to another XXX are used for the new prompt.  Note that
385 * the size of the window never changes, so the prompt can not get any larger
386 * than the height and width specified.
387 */
388int
389dialog_gauge(const char *title,
390	     const char *cprompt,
391	     int height,
392	     int width,
393	     int percent)
394{
395    int fkey;
396    int ch, result;
397    void *objptr = dlg_allocate_gauge(title, cprompt, height, width, percent);
398    MY_OBJ *obj = (MY_OBJ *) objptr;
399
400    dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup);
401    dlg_update_gauge(obj, percent);
402
403    dlg_trace_win(obj->obj.win);
404    do {
405	ch = dlg_getc(obj->obj.win, &fkey);
406#ifdef KEY_RESIZE
407	if (fkey && ch == KEY_RESIZE) {
408	    MY_OBJ *oldobj = obj;
409
410	    dlg_mouse_free_regions();
411
412	    obj = dlg_allocate_gauge(title,
413				     cprompt,
414				     height,
415				     width,
416				     oldobj->percent);
417
418	    /* avoid breaking new window in dlg_remove_callback */
419	    oldobj->obj.caller = 0;
420	    oldobj->obj.input = 0;
421	    oldobj->obj.keep_win = FALSE;
422
423	    /* remove the old version of the gauge */
424	    dlg_clear();
425	    dlg_remove_callback(&(oldobj->obj));
426	    refresh();
427
428	    dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup);
429	    dlg_update_gauge(obj, obj->percent);
430	}
431#endif
432    }
433    while (valid(obj) && handle_my_getc(&(obj->obj), ch, fkey, &result));
434
435    dlg_free_gauge(obj);
436
437    return (DLG_EXIT_OK);
438}
439