2 * $Id: guage.c,v 1.60 2011/06/27 00:52:28 tom Exp $
4 * guage.c -- implements the gauge dialog
6 * Copyright 2000-2010,2011 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 dlg_trim_string(buffer);
106 decode_percent(char *buffer)
109 long value = strtol(buffer, &tmp, 10);
111 if (tmp != 0 && (*tmp == 0 || isspace(UCH(*tmp))) && value >= 0) {
118 repaint_text(MY_OBJ * obj)
120 WINDOW *dialog = obj->obj.win;
123 if (dialog != 0 && obj->obj.input != 0) {
124 (void) werase(dialog);
125 dlg_draw_box(dialog, 0, 0, obj->height, obj->width, dialog_attr, border_attr);
127 dlg_draw_title(dialog, obj->title);
129 wattrset(dialog, dialog_attr);
130 dlg_draw_helpline(dialog, FALSE);
131 dlg_print_autowrap(dialog, obj->prompt, obj->height, obj->width);
134 obj->height - 4, 2 + MARGIN,
135 2 + MARGIN, obj->width - 2 * (2 + MARGIN),
140 * Clear the area for the progress bar by filling it with spaces
141 * in the title-attribute, and write the percentage with that
144 (void) wmove(dialog, obj->height - 3, 4);
145 wattrset(dialog, gauge_attr);
147 for (i = 0; i < (obj->width - 2 * (3 + MARGIN)); i++)
148 (void) waddch(dialog, ' ');
150 (void) wmove(dialog, obj->height - 3, (obj->width / 2) - 2);
151 (void) wprintw(dialog, "%3d%%", obj->percent);
154 * Now draw a bar in reverse, relative to the background.
155 * The window attribute was useful for painting the background,
156 * but requires some tweaks to reverse it.
158 x = (obj->percent * (obj->width - 2 * (3 + MARGIN))) / 100;
159 if ((title_attr & A_REVERSE) != 0) {
160 wattroff(dialog, A_REVERSE);
162 wattrset(dialog, A_REVERSE);
164 (void) wmove(dialog, obj->height - 3, 4);
165 for (i = 0; i < x; i++) {
166 chtype ch2 = winch(dialog);
167 if (title_attr & A_REVERSE) {
170 (void) waddch(dialog, ch2);
173 (void) wrefresh(dialog);
178 handle_input(DIALOG_CALLBACK * cb)
180 MY_OBJ *obj = (MY_OBJ *) cb;
185 if (dialog_state.pipe_input == 0) {
187 } else if ((status = read_data(buf, dialog_state.pipe_input)) > 0) {
191 * Historically, next line should be percentage, but one of the
192 * worse-written clones of 'dialog' assumes the number is missing.
193 * (Gresham's Law applied to software).
195 if ((status = read_data(buf, dialog_state.pipe_input)) > 0) {
197 obj->prompt_buf[0] = '\0';
198 if (decode_percent(buf))
199 obj->percent = atoi(buf);
201 strcpy(obj->prompt_buf, buf);
203 /* Rest is message text */
204 while ((status = read_data(buf, dialog_state.pipe_input)) > 0
206 if (strlen(obj->prompt_buf) + strlen(buf) <
207 sizeof(obj->prompt_buf) - 1) {
208 strcat(obj->prompt_buf, buf);
212 if (obj->prompt != obj->prompt_buf)
214 obj->prompt = obj->prompt_buf;
216 } else if (decode_percent(buf)) {
217 obj->percent = atoi(buf);
220 if (feof(dialog_state.pipe_input) ||
221 (ferror(dialog_state.pipe_input) && errno != EINTR)) {
223 dlg_remove_callback(cb);
238 handle_my_getc(DIALOG_CALLBACK * cb, int ch, int fkey, int *result)
242 *result = DLG_EXIT_OK;
244 if (!fkey && (ch == ERR)) {
245 (void) handle_input(cb);
246 /* cb might be freed in handle_input */
247 status = (valid((MY_OBJ *) cb) && (cb->input != 0));
256 my_cleanup(DIALOG_CALLBACK * cb)
258 MY_OBJ *obj = (MY_OBJ *) cb;
261 if (obj->prompt != obj->prompt_buf) {
263 obj->prompt = obj->prompt_buf;
270 dlg_update_gauge(void *objptr, int percent)
272 MY_OBJ *obj = (MY_OBJ *) objptr;
275 obj->percent = percent;
280 * Allocates a new object and fills it as per the arguments
283 dlg_allocate_gauge(const char *title,
290 char *prompt = dlg_strclone(cprompt);
294 dlg_tab_correct_str(prompt);
296 dlg_auto_size(title, prompt, &height, &width, MIN_HIGH, MIN_WIDE);
297 dlg_print_size(height, width);
298 dlg_ctl_size(height, width);
300 /* center dialog box on screen */
301 x = dlg_box_x_ordinate(width);
302 y = dlg_box_y_ordinate(height);
304 dialog = dlg_new_window(height, width, y, x);
306 obj = dlg_calloc(MY_OBJ, 1);
307 assert_ptr(obj, "dialog_gauge");
309 obj->obj.input = dialog_state.pipe_input;
310 obj->obj.win = dialog;
311 obj->obj.keep_win = TRUE;
312 obj->obj.bg_task = TRUE;
313 obj->obj.handle_getc = handle_my_getc;
314 obj->obj.handle_input = handle_input;
317 obj->prompt = prompt;
318 obj->percent = percent;
319 obj->height = height;
322 obj->next = all_objects;
329 dlg_free_gauge(void *objptr)
331 MY_OBJ *obj = (MY_OBJ *) objptr;
336 obj->obj.keep_win = FALSE;
337 dlg_remove_callback(&(obj->obj));
343 * Display a gauge, or progress meter. Starts at percent% and reads stdin. If
344 * stdin is not XXX, then it is interpreted as a percentage, and the display is
345 * updated accordingly. Otherwise the next line is the percentage, and
346 * subsequent lines up to another XXX are used for the new prompt. Note that
347 * the size of the window never changes, so the prompt can not get any larger
348 * than the height and width specified.
351 dialog_gauge(const char *title,
359 void *objptr = dlg_allocate_gauge(title, cprompt, height, width, percent);
360 MY_OBJ *obj = (MY_OBJ *) objptr;
362 dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup);
363 dlg_update_gauge(obj, percent);
366 ch = dlg_getc(obj->obj.win, &fkey);
368 if (fkey && ch == KEY_RESIZE) {
369 MY_OBJ *oldobj = obj;
371 dlg_mouse_free_regions();
373 obj = dlg_allocate_gauge(title,
379 /* avoid breaking new window in dlg_remove_callback */
380 oldobj->obj.caller = 0;
381 oldobj->obj.input = 0;
382 oldobj->obj.keep_win = FALSE;
384 /* remove the old version of the gauge */
386 dlg_remove_callback(&(oldobj->obj));
389 dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup);
390 dlg_update_gauge(obj, obj->percent);
394 while (valid(obj) && handle_my_getc(&(obj->obj), ch, fkey, &result));
398 return (DLG_EXIT_OK);