1 /* 2 * $Id: guage.c,v 1.69 2015/02/26 02:07:12 tom Exp $ 3 * 4 * guage.c -- implements the gauge dialog 5 * 6 * Copyright 2000-2013,2015 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 38 typedef 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 51 static MY_OBJ *all_objects; 52 53 static int 54 valid(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 69 static void 70 delink(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 88 static int 89 read_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 106 static int 107 decode_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 118 static void 119 repaint_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 (void) wattrset(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 (void) wattrset(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 wattroff(dialog, A_REVERSE); 164 } else { 165 (void) wattrset(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 180 static bool 181 handle_input(DIALOG_CALLBACK * cb) 182 { 183 MY_OBJ *obj = (MY_OBJ *) cb; 184 bool result; 185 int status; 186 char buf[MY_LEN + 1]; 187 188 if (dialog_state.pipe_input == 0) { 189 status = -1; 190 delink(obj); 191 dlg_remove_callback(cb); 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 delink(obj); 228 dlg_remove_callback(cb); 229 } 230 } 231 232 if (status > 0) { 233 result = TRUE; 234 repaint_text(obj); 235 } else { 236 repaint_text(obj); 237 result = FALSE; 238 } 239 240 return result; 241 } 242 243 static bool 244 handle_my_getc(DIALOG_CALLBACK * cb, int ch, int fkey, int *result) 245 { 246 int status = TRUE; 247 248 *result = DLG_EXIT_OK; 249 if (cb != 0) { 250 if (!fkey && (ch == ERR)) { 251 (void) handle_input(cb); 252 /* cb might be freed in handle_input */ 253 status = (valid((MY_OBJ *) cb) && (cb->input != 0)); 254 } 255 } else { 256 status = FALSE; 257 } 258 return status; 259 } 260 261 static void 262 my_cleanup(DIALOG_CALLBACK * cb) 263 { 264 MY_OBJ *obj = (MY_OBJ *) cb; 265 266 if (valid(obj)) { 267 if (obj->prompt != obj->prompt_buf) { 268 free(obj->prompt); 269 obj->prompt = obj->prompt_buf; 270 } 271 delink(obj); 272 } 273 } 274 275 void 276 dlg_update_gauge(void *objptr, int percent) 277 { 278 MY_OBJ *obj = (MY_OBJ *) objptr; 279 bool save_finish_string = dialog_state.finish_string; 280 281 dialog_state.finish_string = TRUE; 282 curs_set(0); 283 obj->percent = percent; 284 repaint_text(obj); 285 dialog_state.finish_string = save_finish_string; 286 } 287 288 /* 289 * (Re)Allocates an object and fills it as per the arguments 290 */ 291 void * 292 dlg_reallocate_gauge(void *objptr, 293 const char *title, 294 const char *cprompt, 295 int height, 296 int width, 297 int percent) 298 { 299 char *prompt = dlg_strclone(cprompt); 300 MY_OBJ *obj = objptr; 301 bool save_finish_string = dialog_state.finish_string; 302 303 dialog_state.finish_string = TRUE; 304 dlg_tab_correct_str(prompt); 305 306 if (objptr == 0) { 307 /* create a new object */ 308 obj = dlg_calloc(MY_OBJ, 1); 309 assert_ptr(obj, "dialog_gauge"); 310 311 dlg_auto_size(title, prompt, &height, &width, MIN_HIGH, MIN_WIDE); 312 dlg_print_size(height, width); 313 dlg_ctl_size(height, width); 314 315 } else { 316 /* reuse an existing object */ 317 obj = objptr; 318 height = obj->height; 319 width = obj->width; 320 } 321 322 if (obj->obj.win == 0) { 323 /* center dialog box on screen */ 324 int x = dlg_box_x_ordinate(width); 325 int y = dlg_box_y_ordinate(height); 326 WINDOW *dialog = dlg_new_window(height, width, y, x); 327 obj->obj.win = dialog; 328 } 329 330 obj->obj.input = dialog_state.pipe_input; 331 obj->obj.keep_win = TRUE; 332 obj->obj.bg_task = TRUE; 333 obj->obj.handle_getc = handle_my_getc; 334 obj->obj.handle_input = handle_input; 335 336 if (obj->title == 0 || strcmp(obj->title, title)) { 337 dlg_finish_string(obj->title); 338 free(obj->title); 339 obj->title = dlg_strclone(title); 340 } 341 342 dlg_finish_string(obj->prompt); 343 free(obj->prompt); 344 345 obj->prompt = prompt; 346 obj->percent = percent; 347 obj->height = height; 348 obj->width = width; 349 350 /* if this was a new object, link it into the list */ 351 if (objptr == 0) { 352 obj->next = all_objects; 353 all_objects = obj; 354 } 355 356 dialog_state.finish_string = save_finish_string; 357 return (void *) obj; 358 } 359 360 void * 361 dlg_allocate_gauge(const char *title, 362 const char *cprompt, 363 int height, 364 int width, 365 int percent) 366 { 367 return dlg_reallocate_gauge(NULL, title, cprompt, height, width, percent); 368 } 369 370 void 371 dlg_free_gauge(void *objptr) 372 { 373 MY_OBJ *obj = (MY_OBJ *) objptr; 374 375 curs_set(1); 376 if (valid(obj)) { 377 delink(obj); 378 obj->obj.keep_win = FALSE; 379 dlg_remove_callback(&(obj->obj)); 380 } 381 } 382 383 /* 384 * Display a gauge, or progress meter. Starts at percent% and reads stdin. If 385 * stdin is not XXX, then it is interpreted as a percentage, and the display is 386 * updated accordingly. Otherwise the next line is the percentage, and 387 * subsequent lines up to another XXX are used for the new prompt. Note that 388 * the size of the window never changes, so the prompt can not get any larger 389 * than the height and width specified. 390 */ 391 int 392 dialog_gauge(const char *title, 393 const char *cprompt, 394 int height, 395 int width, 396 int percent) 397 { 398 int fkey; 399 int ch, result; 400 void *objptr = dlg_allocate_gauge(title, cprompt, height, width, percent); 401 MY_OBJ *obj = (MY_OBJ *) objptr; 402 403 dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup); 404 dlg_update_gauge(obj, percent); 405 406 dlg_trace_win(obj->obj.win); 407 do { 408 ch = dlg_getc(obj->obj.win, &fkey); 409 #ifdef KEY_RESIZE 410 if (fkey && ch == KEY_RESIZE) { 411 MY_OBJ *oldobj = obj; 412 413 dlg_mouse_free_regions(); 414 415 obj = dlg_allocate_gauge(title, 416 cprompt, 417 height, 418 width, 419 oldobj->percent); 420 421 /* avoid breaking new window in dlg_remove_callback */ 422 oldobj->obj.caller = 0; 423 oldobj->obj.input = 0; 424 oldobj->obj.keep_win = FALSE; 425 426 /* remove the old version of the gauge */ 427 dlg_clear(); 428 dlg_remove_callback(&(oldobj->obj)); 429 refresh(); 430 431 dlg_add_callback_ref((DIALOG_CALLBACK **) & obj, my_cleanup); 432 dlg_update_gauge(obj, obj->percent); 433 } 434 #endif 435 } 436 while (valid(obj) && handle_my_getc(&(obj->obj), ch, fkey, &result)); 437 438 dlg_free_gauge(obj); 439 440 return (DLG_EXIT_OK); 441 } 442