2 * $Id: guage.c,v 1.83 2020/03/27 20:54:43 tom Exp $
4 * guage.c -- implements the gauge dialog
6 * Copyright 2000-2019,2020 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;
126 (void) werase(dialog);
127 dlg_draw_box2(dialog, 0, 0, obj->height, obj->width, dialog_attr,
128 border_attr, border2_attr);
130 dlg_draw_title(dialog, obj->title);
132 dlg_attrset(dialog, dialog_attr);
133 dlg_draw_helpline(dialog, FALSE);
134 dlg_print_autowrap(dialog, obj->prompt, obj->height, obj->width);
136 dlg_draw_box2(dialog,
137 obj->height - 4, 2 + MARGIN,
138 2 + MARGIN, obj->width - 2 * (2 + MARGIN),
144 * Clear the area for the progress bar by filling it with spaces
145 * in the gauge-attribute, and write the percentage with that
148 (void) wmove(dialog, obj->height - 3, 4);
149 dlg_attrset(dialog, gauge_attr);
151 for (i = 0; i < (obj->width - 2 * (3 + MARGIN)); i++)
152 (void) waddch(dialog, ' ');
154 (void) wmove(dialog, obj->height - 3, (obj->width / 2) - 2);
155 (void) wprintw(dialog, "%3d%%", obj->percent);
158 * Now draw a bar in reverse, relative to the background.
159 * The window attribute was useful for painting the background,
160 * but requires some tweaks to reverse it.
162 x = (obj->percent * (obj->width - 2 * (3 + MARGIN))) / 100;
163 if ((gauge_attr & A_REVERSE) != 0) {
164 dlg_attroff(dialog, A_REVERSE);
166 dlg_attrset(dialog, A_REVERSE);
168 (void) wmove(dialog, obj->height - 3, 4);
169 for (i = 0; i < x; i++) {
170 chtype ch2 = winch(dialog);
171 if (gauge_attr & A_REVERSE) {
174 (void) waddch(dialog, ch2);
177 (void) wrefresh(dialog);
182 handle_input(DIALOG_CALLBACK * cb)
184 MY_OBJ *obj = (MY_OBJ *) cb;
186 bool cleanup = FALSE;
188 char buf[MY_LEN + 1];
190 if (dialog_state.pipe_input == 0) {
193 } else if ((status = read_data(buf, dialog_state.pipe_input)) > 0) {
197 * Historically, next line should be percentage, but one of the
198 * worse-written clones of 'dialog' assumes the number is missing.
199 * (Gresham's Law applied to software).
201 if ((status = read_data(buf, dialog_state.pipe_input)) > 0) {
203 obj->prompt_buf[0] = '\0';
204 if (decode_percent(buf))
205 obj->percent = atoi(buf);
207 strcpy(obj->prompt_buf, buf);
209 /* Rest is message text */
210 while ((status = read_data(buf, dialog_state.pipe_input)) > 0
212 if (strlen(obj->prompt_buf) + strlen(buf) <
213 sizeof(obj->prompt_buf) - 1) {
214 strcat(obj->prompt_buf, buf);
218 if (obj->prompt != obj->prompt_buf)
220 obj->prompt = obj->prompt_buf;
222 } else if (decode_percent(buf)) {
223 obj->percent = atoi(buf);
226 if (feof(dialog_state.pipe_input) ||
227 (ferror(dialog_state.pipe_input) && errno != EINTR)) {
238 dlg_remove_callback(cb);
247 handle_my_getc(DIALOG_CALLBACK * cb, int ch, int fkey, int *result)
251 *result = DLG_EXIT_OK;
253 if (!fkey && (ch == ERR)) {
254 (void) handle_input(cb);
255 /* cb might be freed in handle_input */
256 status = (valid((MY_OBJ *) cb) && (cb->input != 0));
265 my_cleanup(DIALOG_CALLBACK * cb)
267 MY_OBJ *obj = (MY_OBJ *) cb;
270 if (obj->prompt != obj->prompt_buf) {
272 obj->prompt = obj->prompt_buf;
275 dlg_del_window(obj->obj.win);
281 dlg_update_gauge(void *objptr, int percent)
283 MY_OBJ *obj = (MY_OBJ *) objptr;
284 bool save_finish_string = dialog_state.finish_string;
286 dialog_state.finish_string = TRUE;
288 obj->percent = percent;
290 dialog_state.finish_string = save_finish_string;
294 * (Re)Allocates an object and fills it as per the arguments
297 dlg_reallocate_gauge(void *objptr,
304 char *prompt = dlg_strclone(cprompt);
306 bool save_finish_string = dialog_state.finish_string;
308 dialog_state.finish_string = TRUE;
309 dlg_tab_correct_str(prompt);
312 /* create a new object */
313 obj = dlg_calloc(MY_OBJ, 1);
314 assert_ptr(obj, "dialog_gauge");
316 dlg_auto_size(title, prompt, &height, &width, MIN_HIGH, MIN_WIDE);
317 dlg_print_size(height, width);
318 dlg_ctl_size(height, width);
321 /* reuse an existing object */
323 height = obj->height;
327 if (obj->obj.win == 0) {
328 /* center dialog box on screen */
329 int x = dlg_box_x_ordinate(width);
330 int y = dlg_box_y_ordinate(height);
331 WINDOW *dialog = dlg_new_window(height, width, y, x);
332 obj->obj.win = dialog;
335 obj->obj.input = dialog_state.pipe_input;
336 obj->obj.keep_win = TRUE;
337 obj->obj.bg_task = TRUE;
338 obj->obj.handle_getc = handle_my_getc;
339 obj->obj.handle_input = handle_input;
341 if (obj->title == 0 || strcmp(obj->title, title)) {
342 dlg_finish_string(obj->title);
344 obj->title = dlg_strclone(title);
347 dlg_finish_string(obj->prompt);
350 obj->prompt = prompt;
351 obj->percent = percent;
352 obj->height = height;
355 /* if this was a new object, link it into the list */
357 obj->next = all_objects;
361 dialog_state.finish_string = save_finish_string;
366 dlg_allocate_gauge(const char *title,
372 return dlg_reallocate_gauge(NULL, title, cprompt, height, width, percent);
376 dlg_free_gauge(void *objptr)
378 MY_OBJ *obj = (MY_OBJ *) objptr;
385 obj->obj.keep_win = FALSE;
386 dlg_remove_callback(&(obj->obj));
393 * Display a gauge, or progress meter. Starts at percent% and reads stdin. If
394 * stdin is not XXX, then it is interpreted as a percentage, and the display is
395 * updated accordingly. Otherwise the next line is the percentage, and
396 * subsequent lines up to another XXX are used for the new prompt. Note that
397 * the size of the window never changes, so the prompt can not get any larger
398 * than the height and width specified.
401 dialog_gauge(const char *title,
409 void *objptr = dlg_allocate_gauge(title, cprompt, height, width, percent);
410 MY_OBJ *obj = (MY_OBJ *) objptr;
412 DLG_TRACE(("# gauge args:\n"));
413 DLG_TRACE2S("title", title);
414 DLG_TRACE2S("message", cprompt);
415 DLG_TRACE2N("height", height);
416 DLG_TRACE2N("width", width);
417 DLG_TRACE2N("percent", percent);
419 dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup);
420 dlg_update_gauge(obj, percent);
422 dlg_trace_win(obj->obj.win);
424 ch = dlg_getc(obj->obj.win, &fkey);
426 if (fkey && ch == KEY_RESIZE) {
427 MY_OBJ *oldobj = obj;
429 dlg_will_resize(obj->obj.win);
431 obj = dlg_allocate_gauge(title,
437 /* avoid breaking new window in dlg_remove_callback */
438 oldobj->obj.caller = 0;
439 oldobj->obj.input = 0;
440 oldobj->obj.keep_win = FALSE;
442 /* remove the old version of the gauge */
443 _dlg_resize_cleanup(oldobj->obj.win);
444 dlg_remove_callback(&(oldobj->obj));
446 dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup);
447 dlg_update_gauge(obj, obj->percent);
451 while (valid(obj) && handle_my_getc(&(obj->obj), ch, fkey, &result));
455 return (DLG_EXIT_OK);