2 * $Id: guage.c,v 1.76 2018/06/21 08:23:43 tom Exp $
4 * guage.c -- implements the gauge dialog
6 * Copyright 2000-2015,2018 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;
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 dlg_attrset(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 dlg_attrset(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 dlg_attroff(dialog, A_REVERSE);
165 dlg_attrset(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;
185 bool cleanup = FALSE;
187 char buf[MY_LEN + 1];
189 if (dialog_state.pipe_input == 0) {
192 } else if ((status = read_data(buf, dialog_state.pipe_input)) > 0) {
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).
200 if ((status = read_data(buf, dialog_state.pipe_input)) > 0) {
202 obj->prompt_buf[0] = '\0';
203 if (decode_percent(buf))
204 obj->percent = atoi(buf);
206 strcpy(obj->prompt_buf, buf);
208 /* Rest is message text */
209 while ((status = read_data(buf, dialog_state.pipe_input)) > 0
211 if (strlen(obj->prompt_buf) + strlen(buf) <
212 sizeof(obj->prompt_buf) - 1) {
213 strcat(obj->prompt_buf, buf);
217 if (obj->prompt != obj->prompt_buf)
219 obj->prompt = obj->prompt_buf;
221 } else if (decode_percent(buf)) {
222 obj->percent = atoi(buf);
225 if (feof(dialog_state.pipe_input) ||
226 (ferror(dialog_state.pipe_input) && errno != EINTR)) {
237 dlg_remove_callback(cb);
246 handle_my_getc(DIALOG_CALLBACK * cb, int ch, int fkey, int *result)
250 *result = DLG_EXIT_OK;
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));
264 my_cleanup(DIALOG_CALLBACK * cb)
266 MY_OBJ *obj = (MY_OBJ *) cb;
269 if (obj->prompt != obj->prompt_buf) {
271 obj->prompt = obj->prompt_buf;
274 dlg_del_window(obj->obj.win);
280 dlg_update_gauge(void *objptr, int percent)
282 MY_OBJ *obj = (MY_OBJ *) objptr;
283 bool save_finish_string = dialog_state.finish_string;
285 dialog_state.finish_string = TRUE;
287 obj->percent = percent;
289 dialog_state.finish_string = save_finish_string;
293 * (Re)Allocates an object and fills it as per the arguments
296 dlg_reallocate_gauge(void *objptr,
303 char *prompt = dlg_strclone(cprompt);
304 MY_OBJ *obj = objptr;
305 bool save_finish_string = dialog_state.finish_string;
307 dialog_state.finish_string = TRUE;
308 dlg_tab_correct_str(prompt);
311 /* create a new object */
312 obj = dlg_calloc(MY_OBJ, 1);
313 assert_ptr(obj, "dialog_gauge");
315 dlg_auto_size(title, prompt, &height, &width, MIN_HIGH, MIN_WIDE);
316 dlg_print_size(height, width);
317 dlg_ctl_size(height, width);
320 /* reuse an existing object */
322 height = obj->height;
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;
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;
340 if (obj->title == 0 || strcmp(obj->title, title)) {
341 dlg_finish_string(obj->title);
343 obj->title = dlg_strclone(title);
346 dlg_finish_string(obj->prompt);
349 obj->prompt = prompt;
350 obj->percent = percent;
351 obj->height = height;
354 /* if this was a new object, link it into the list */
356 obj->next = all_objects;
360 dialog_state.finish_string = save_finish_string;
365 dlg_allocate_gauge(const char *title,
371 return dlg_reallocate_gauge(NULL, title, cprompt, height, width, percent);
375 dlg_free_gauge(void *objptr)
377 MY_OBJ *obj = (MY_OBJ *) objptr;
380 obj->obj.keep_win = FALSE;
381 dlg_remove_callback(&(obj->obj));
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.
396 dialog_gauge(const char *title,
404 void *objptr = dlg_allocate_gauge(title, cprompt, height, width, percent);
405 MY_OBJ *obj = (MY_OBJ *) objptr;
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);
414 dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup);
415 dlg_update_gauge(obj, percent);
417 dlg_trace_win(obj->obj.win);
419 ch = dlg_getc(obj->obj.win, &fkey);
421 if (fkey && ch == KEY_RESIZE) {
422 MY_OBJ *oldobj = obj;
424 dlg_will_resize(obj->obj.win);
425 dlg_mouse_free_regions();
427 obj = dlg_allocate_gauge(title,
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;
438 /* remove the old version of the gauge */
440 dlg_remove_callback(&(oldobj->obj));
443 dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup);
444 dlg_update_gauge(obj, obj->percent);
448 while (valid(obj) && handle_my_getc(&(obj->obj), ch, fkey, &result));
452 return (DLG_EXIT_OK);