1/*
2 *  $Id: guage.c,v 1.76 2018/06/21 08:23:43 tom Exp $
3 *
4 *  guage.c -- implements the gauge dialog
5 *
6 *  Copyright 2000-2015,2018	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) {
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	dlg_attrset(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	dlg_attrset(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	    dlg_attroff(dialog, A_REVERSE);
164	} else {
165	    dlg_attrset(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    bool cleanup = FALSE;
186    int status;
187    char buf[MY_LEN + 1];
188
189    if (dialog_state.pipe_input == 0) {
190	status = -1;
191	cleanup = TRUE;
192    } else if ((status = read_data(buf, dialog_state.pipe_input)) > 0) {
193
194	if (isMarker(buf)) {
195	    /*
196	     * Historically, next line should be percentage, but one of the
197	     * worse-written clones of 'dialog' assumes the number is missing.
198	     * (Gresham's Law applied to software).
199	     */
200	    if ((status = read_data(buf, dialog_state.pipe_input)) > 0) {
201
202		obj->prompt_buf[0] = '\0';
203		if (decode_percent(buf))
204		    obj->percent = atoi(buf);
205		else
206		    strcpy(obj->prompt_buf, buf);
207
208		/* Rest is message text */
209		while ((status = read_data(buf, dialog_state.pipe_input)) > 0
210		       && !isMarker(buf)) {
211		    if (strlen(obj->prompt_buf) + strlen(buf) <
212			sizeof(obj->prompt_buf) - 1) {
213			strcat(obj->prompt_buf, buf);
214		    }
215		}
216
217		if (obj->prompt != obj->prompt_buf)
218		    free(obj->prompt);
219		obj->prompt = obj->prompt_buf;
220	    }
221	} else if (decode_percent(buf)) {
222	    obj->percent = atoi(buf);
223	}
224    } else {
225	if (feof(dialog_state.pipe_input) ||
226	    (ferror(dialog_state.pipe_input) && errno != EINTR)) {
227	    cleanup = TRUE;
228	}
229    }
230
231    repaint_text(obj);
232    if (status > 0) {
233	result = TRUE;
234    } else {
235	result = FALSE;
236	if (cleanup) {
237	    dlg_remove_callback(cb);
238	    delink(obj);
239	}
240    }
241
242    return result;
243}
244
245static bool
246handle_my_getc(DIALOG_CALLBACK * cb, int ch, int fkey, int *result)
247{
248    bool status = TRUE;
249
250    *result = DLG_EXIT_OK;
251    if (cb != 0) {
252	if (!fkey && (ch == ERR)) {
253	    (void) handle_input(cb);
254	    /* cb might be freed in handle_input */
255	    status = (valid((MY_OBJ *) cb) && (cb->input != 0));
256	}
257    } else {
258	status = FALSE;
259    }
260    return status;
261}
262
263static void
264my_cleanup(DIALOG_CALLBACK * cb)
265{
266    MY_OBJ *obj = (MY_OBJ *) cb;
267
268    if (valid(obj)) {
269	if (obj->prompt != obj->prompt_buf) {
270	    free(obj->prompt);
271	    obj->prompt = obj->prompt_buf;
272	}
273	free(obj->title);
274	dlg_del_window(obj->obj.win);
275	delink(obj);
276    }
277}
278
279void
280dlg_update_gauge(void *objptr, int percent)
281{
282    MY_OBJ *obj = (MY_OBJ *) objptr;
283    bool save_finish_string = dialog_state.finish_string;
284
285    dialog_state.finish_string = TRUE;
286    curs_set(0);
287    obj->percent = percent;
288    repaint_text(obj);
289    dialog_state.finish_string = save_finish_string;
290}
291
292/*
293 * (Re)Allocates an object and fills it as per the arguments
294 */
295void *
296dlg_reallocate_gauge(void *objptr,
297		     const char *title,
298		     const char *cprompt,
299		     int height,
300		     int width,
301		     int percent)
302{
303    char *prompt = dlg_strclone(cprompt);
304    MY_OBJ *obj = objptr;
305    bool save_finish_string = dialog_state.finish_string;
306
307    dialog_state.finish_string = TRUE;
308    dlg_tab_correct_str(prompt);
309
310    if (objptr == 0) {
311	/* create a new object */
312	obj = dlg_calloc(MY_OBJ, 1);
313	assert_ptr(obj, "dialog_gauge");
314
315	dlg_auto_size(title, prompt, &height, &width, MIN_HIGH, MIN_WIDE);
316	dlg_print_size(height, width);
317	dlg_ctl_size(height, width);
318
319    } else {
320	/* reuse an existing object */
321	obj = objptr;
322	height = obj->height;
323	width = obj->width;
324    }
325
326    if (obj->obj.win == 0) {
327	/* center dialog box on screen */
328	int x = dlg_box_x_ordinate(width);
329	int y = dlg_box_y_ordinate(height);
330	WINDOW *dialog = dlg_new_window(height, width, y, x);
331	obj->obj.win = dialog;
332    }
333
334    obj->obj.input = dialog_state.pipe_input;
335    obj->obj.keep_win = TRUE;
336    obj->obj.bg_task = TRUE;
337    obj->obj.handle_getc = handle_my_getc;
338    obj->obj.handle_input = handle_input;
339
340    if (obj->title == 0 || strcmp(obj->title, title)) {
341	dlg_finish_string(obj->title);
342	free(obj->title);
343	obj->title = dlg_strclone(title);
344    }
345
346    dlg_finish_string(obj->prompt);
347    free(obj->prompt);
348
349    obj->prompt = prompt;
350    obj->percent = percent;
351    obj->height = height;
352    obj->width = width;
353
354    /* if this was a new object, link it into the list */
355    if (objptr == 0) {
356	obj->next = all_objects;
357	all_objects = obj;
358    }
359
360    dialog_state.finish_string = save_finish_string;
361    return (void *) obj;
362}
363
364void *
365dlg_allocate_gauge(const char *title,
366		   const char *cprompt,
367		   int height,
368		   int width,
369		   int percent)
370{
371    return dlg_reallocate_gauge(NULL, title, cprompt, height, width, percent);
372}
373
374void
375dlg_free_gauge(void *objptr)
376{
377    MY_OBJ *obj = (MY_OBJ *) objptr;
378
379    if (valid(obj)) {
380	obj->obj.keep_win = FALSE;
381	dlg_remove_callback(&(obj->obj));
382	delink(obj);
383    }
384    curs_set(1);
385}
386
387/*
388 * Display a gauge, or progress meter.  Starts at percent% and reads stdin.  If
389 * stdin is not XXX, then it is interpreted as a percentage, and the display is
390 * updated accordingly.  Otherwise the next line is the percentage, and
391 * subsequent lines up to another XXX are used for the new prompt.  Note that
392 * the size of the window never changes, so the prompt can not get any larger
393 * than the height and width specified.
394 */
395int
396dialog_gauge(const char *title,
397	     const char *cprompt,
398	     int height,
399	     int width,
400	     int percent)
401{
402    int fkey;
403    int ch, result;
404    void *objptr = dlg_allocate_gauge(title, cprompt, height, width, percent);
405    MY_OBJ *obj = (MY_OBJ *) objptr;
406
407    DLG_TRACE(("# gauge args:\n"));
408    DLG_TRACE2S("title", title);
409    DLG_TRACE2S("message", cprompt);
410    DLG_TRACE2N("height", height);
411    DLG_TRACE2N("width", width);
412    DLG_TRACE2N("percent", percent);
413
414    dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup);
415    dlg_update_gauge(obj, percent);
416
417    dlg_trace_win(obj->obj.win);
418    do {
419	ch = dlg_getc(obj->obj.win, &fkey);
420#ifdef KEY_RESIZE
421	if (fkey && ch == KEY_RESIZE) {
422	    MY_OBJ *oldobj = obj;
423
424	    dlg_will_resize(obj->obj.win);
425	    dlg_mouse_free_regions();
426
427	    obj = dlg_allocate_gauge(title,
428				     cprompt,
429				     height,
430				     width,
431				     oldobj->percent);
432
433	    /* avoid breaking new window in dlg_remove_callback */
434	    oldobj->obj.caller = 0;
435	    oldobj->obj.input = 0;
436	    oldobj->obj.keep_win = FALSE;
437
438	    /* remove the old version of the gauge */
439	    dlg_clear();
440	    dlg_remove_callback(&(oldobj->obj));
441	    refresh();
442
443	    dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup);
444	    dlg_update_gauge(obj, obj->percent);
445	}
446#endif
447    }
448    while (valid(obj) && handle_my_getc(&(obj->obj), ch, fkey, &result));
449
450    dlg_free_gauge(obj);
451
452    return (DLG_EXIT_OK);
453}
454