2 * $Id: guage.c,v 1.68 2013/09/22 19:10:22 tom Exp $
4 * guage.c -- implements the gauge dialog
6 * Copyright 2000-2012,2013 Thomas E. Dickey
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.
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.
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.
23 * An earlier version of this program lists as authors
24 * Marc Ewing, Red Hat Software
31 #define MY_LEN (MAX_LEN)/2
34 #define MIN_WIDE (10 + 2 * (2 + MARGIN))
36 #define isMarker(buf) !strncmp(buf, "XXX", (size_t) 3)
38 typedef struct _my_obj {
39 DIALOG_CALLBACK obj; /* has to be first in struct */
44 char prompt_buf[MY_LEN];
48 char line[MAX_LEN + 1];
51 static MY_OBJ *all_objects;
56 MY_OBJ *list = all_objects;
72 MY_OBJ *p = all_objects;
79 all_objects = p->next;
89 read_data(char *buffer, FILE *fp)
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);
107 decode_percent(char *buffer)
110 long value = strtol(buffer, &tmp, 10);
112 if (tmp != 0 && (*tmp == 0 || isspace(UCH(*tmp))) && value >= 0) {
119 repaint_text(MY_OBJ * obj)
121 WINDOW *dialog = obj->obj.win;
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);
129 dlg_draw_title(dialog, obj->title);
131 (void) wattrset(dialog, dialog_attr);
132 dlg_draw_helpline(dialog, FALSE);
133 dlg_print_autowrap(dialog, obj->prompt, obj->height, obj->width);
135 dlg_draw_box2(dialog,
136 obj->height - 4, 2 + MARGIN,
137 2 + MARGIN, obj->width - 2 * (2 + MARGIN),
143 * Clear the area for the progress bar by filling it with spaces
144 * in the gauge-attribute, and write the percentage with that
147 (void) wmove(dialog, obj->height - 3, 4);
148 (void) wattrset(dialog, gauge_attr);
150 for (i = 0; i < (obj->width - 2 * (3 + MARGIN)); i++)
151 (void) waddch(dialog, ' ');
153 (void) wmove(dialog, obj->height - 3, (obj->width / 2) - 2);
154 (void) wprintw(dialog, "%3d%%", obj->percent);
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.
161 x = (obj->percent * (obj->width - 2 * (3 + MARGIN))) / 100;
162 if ((gauge_attr & A_REVERSE) != 0) {
163 wattroff(dialog, A_REVERSE);
165 (void) wattrset(dialog, A_REVERSE);
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) {
173 (void) waddch(dialog, ch2);
176 (void) wrefresh(dialog);
181 handle_input(DIALOG_CALLBACK * cb)
183 MY_OBJ *obj = (MY_OBJ *) cb;
186 char buf[MY_LEN + 1];
188 if (dialog_state.pipe_input == 0) {
190 } else if ((status = read_data(buf, dialog_state.pipe_input)) > 0) {
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).
198 if ((status = read_data(buf, dialog_state.pipe_input)) > 0) {
200 obj->prompt_buf[0] = '\0';
201 if (decode_percent(buf))
202 obj->percent = atoi(buf);
204 strcpy(obj->prompt_buf, buf);
206 /* Rest is message text */
207 while ((status = read_data(buf, dialog_state.pipe_input)) > 0
209 if (strlen(obj->prompt_buf) + strlen(buf) <
210 sizeof(obj->prompt_buf) - 1) {
211 strcat(obj->prompt_buf, buf);
215 if (obj->prompt != obj->prompt_buf)
217 obj->prompt = obj->prompt_buf;
219 } else if (decode_percent(buf)) {
220 obj->percent = atoi(buf);
223 if (feof(dialog_state.pipe_input) ||
224 (ferror(dialog_state.pipe_input) && errno != EINTR)) {
226 dlg_remove_callback(cb);
241 handle_my_getc(DIALOG_CALLBACK * cb, int ch, int fkey, int *result)
245 *result = DLG_EXIT_OK;
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));
259 my_cleanup(DIALOG_CALLBACK * cb)
261 MY_OBJ *obj = (MY_OBJ *) cb;
264 if (obj->prompt != obj->prompt_buf) {
266 obj->prompt = obj->prompt_buf;
273 dlg_update_gauge(void *objptr, int percent)
275 MY_OBJ *obj = (MY_OBJ *) objptr;
276 bool save_finish_string = dialog_state.finish_string;
278 dialog_state.finish_string = TRUE;
280 obj->percent = percent;
282 dialog_state.finish_string = save_finish_string;
286 * (Re)Allocates an object and fills it as per the arguments
289 dlg_reallocate_gauge(void *objptr,
296 char *prompt = dlg_strclone(cprompt);
297 MY_OBJ *obj = objptr;
298 bool save_finish_string = dialog_state.finish_string;
300 dialog_state.finish_string = TRUE;
301 dlg_tab_correct_str(prompt);
304 /* create a new object */
305 obj = dlg_calloc(MY_OBJ, 1);
306 assert_ptr(obj, "dialog_gauge");
308 dlg_auto_size(title, prompt, &height, &width, MIN_HIGH, MIN_WIDE);
309 dlg_print_size(height, width);
310 dlg_ctl_size(height, width);
313 /* reuse an existing object */
315 height = obj->height;
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;
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;
333 if (obj->title == 0 || strcmp(obj->title, title)) {
334 dlg_finish_string(obj->title);
336 obj->title = dlg_strclone(title);
339 dlg_finish_string(obj->prompt);
342 obj->prompt = prompt;
343 obj->percent = percent;
344 obj->height = height;
347 /* if this was a new object, link it into the list */
349 obj->next = all_objects;
353 dialog_state.finish_string = save_finish_string;
358 dlg_allocate_gauge(const char *title,
364 return dlg_reallocate_gauge(NULL, title, cprompt, height, width, percent);
368 dlg_free_gauge(void *objptr)
370 MY_OBJ *obj = (MY_OBJ *) objptr;
375 obj->obj.keep_win = FALSE;
376 dlg_remove_callback(&(obj->obj));
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.
389 dialog_gauge(const char *title,
397 void *objptr = dlg_allocate_gauge(title, cprompt, height, width, percent);
398 MY_OBJ *obj = (MY_OBJ *) objptr;
400 dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup);
401 dlg_update_gauge(obj, percent);
403 dlg_trace_win(obj->obj.win);
405 ch = dlg_getc(obj->obj.win, &fkey);
407 if (fkey && ch == KEY_RESIZE) {
408 MY_OBJ *oldobj = obj;
410 dlg_mouse_free_regions();
412 obj = dlg_allocate_gauge(title,
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;
423 /* remove the old version of the gauge */
425 dlg_remove_callback(&(oldobj->obj));
428 dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup);
429 dlg_update_gauge(obj, obj->percent);
433 while (valid(obj) && handle_my_getc(&(obj->obj), ch, fkey, &result));
437 return (DLG_EXIT_OK);