1 /* 2 * $Id: mixedgauge.c,v 1.36 2020/03/26 03:22:44 tom Exp $ 3 * 4 * mixedgauge.c -- implements the mixedgauge dialog 5 * 6 * Copyright 2007-2019,2020 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 * This is inspired by a patch from Kiran Cherupally 24 * (but different interface design). 25 */ 26 27 #include <dialog.h> 28 29 #define LLEN(n) ((n) * MIXEDGAUGE_TAGS) 30 #define ItemData(i) &items[LLEN(i)] 31 #define ItemName(i) items[LLEN(i)] 32 #define ItemText(i) items[LLEN(i) + 1] 33 34 #define MIN_HIGH (4) 35 #define MIN_WIDE (10 + 2 * (2 + MARGIN)) 36 37 typedef struct { 38 WINDOW *dialog; 39 WINDOW *caption; 40 const char *title; 41 char *prompt; 42 int height, old_height, min_height; 43 int width, old_width, min_width; 44 int len_name, len_text; 45 int item_no; 46 DIALOG_LISTITEM *list; 47 } DIALOG_MIXEDGAUGE; 48 49 static const char * 50 status_string(char *given, char **freeMe) 51 { 52 const char *result; 53 54 *freeMe = 0; 55 if (isdigit(UCH(*given))) { 56 switch (*given) { 57 case '0': 58 result = _("Succeeded"); 59 break; 60 case '1': 61 result = _("Failed"); 62 break; 63 case '2': 64 result = _("Passed"); 65 break; 66 case '3': 67 result = _("Completed"); 68 break; 69 case '4': 70 result = _("Checked"); 71 break; 72 case '5': 73 result = _("Done"); 74 break; 75 case '6': 76 result = _("Skipped"); 77 break; 78 case '7': 79 result = _("In Progress"); 80 break; 81 case '8': 82 result = ""; 83 break; 84 case '9': 85 result = _("N/A"); 86 break; 87 default: 88 result = "?"; 89 break; 90 } 91 } else if (*given == '-') { 92 size_t need = strlen(++given) + 4; 93 char *temp = dlg_malloc(char, need); 94 *freeMe = temp; 95 sprintf(temp, "%3s%%", given); 96 result = temp; 97 } else if (!isspace(UCH(*given))) { 98 result = given; 99 } else { 100 result = 0; 101 } 102 return result; 103 } 104 105 /* This function displays status messages */ 106 static void 107 myprint_status(DIALOG_MIXEDGAUGE * dlg) 108 { 109 WINDOW *win = dlg->dialog; 110 int limit_y = dlg->height; 111 int limit_x = dlg->width; 112 113 int item; 114 int cells = dlg->len_text - 2; 115 int lm = limit_x - dlg->len_text - 1; 116 int bm = limit_y; /* bottom margin */ 117 int last_y = 0, last_x = 0; 118 int j, xxx; 119 float percent; 120 char *freeMe = 0; 121 122 bm -= (2 * MARGIN); 123 getyx(win, last_y, last_x); 124 for (item = 0; item < dlg->item_no; ++item) { 125 const char *status = ""; 126 chtype attr = A_NORMAL; 127 int y = item + MARGIN + 1; 128 129 if (y > bm) 130 break; 131 132 status = status_string(dlg->list[item].text, &freeMe); 133 if (status == 0 || *status == 0) 134 continue; 135 136 (void) wmove(win, y, 2 * MARGIN); 137 dlg_attrset(win, dialog_attr); 138 dlg_print_text(win, dlg->list[item].name, lm, &attr); 139 140 (void) wmove(win, y, lm); 141 (void) waddch(win, '['); 142 (void) wmove(win, y, lm + (cells - (int) strlen(status)) / 2); 143 if (freeMe) { 144 (void) wmove(win, y, lm + 1); 145 dlg_attrset(win, title_attr); 146 for (j = 0; j < cells; j++) 147 (void) waddch(win, ' '); 148 149 (void) wmove(win, y, lm + (cells - (int) strlen(status)) / 2); 150 (void) waddstr(win, status); 151 152 if ((title_attr & A_REVERSE) != 0) { 153 dlg_attroff(win, A_REVERSE); 154 } else { 155 dlg_attrset(win, A_REVERSE); 156 } 157 (void) wmove(win, y, lm + 1); 158 159 if (sscanf(status, "%f%%", &percent) != 1) 160 percent = 0.0; 161 xxx = (int) ((cells * (percent + 0.5)) / 100.0); 162 for (j = 0; j < xxx; j++) { 163 chtype ch1 = winch(win); 164 if (title_attr & A_REVERSE) { 165 ch1 &= ~A_REVERSE; 166 } 167 (void) waddch(win, ch1); 168 } 169 free(freeMe); 170 171 } else { 172 (void) wmove(win, y, lm + (cells - (int) strlen(status)) / 2); 173 (void) waddstr(win, status); 174 } 175 (void) wmove(win, y, limit_x - 3); 176 dlg_attrset(win, dialog_attr); 177 (void) waddch(win, ']'); 178 (void) wnoutrefresh(win); 179 } 180 if (win != 0) 181 wmove(win, last_y, last_x); 182 } 183 184 static void 185 mydraw_mixed_box(WINDOW *win, int y, int x, int height, int width, 186 chtype boxchar, chtype borderchar) 187 { 188 dlg_draw_box(win, y, x, height, width, boxchar, borderchar); 189 { 190 chtype attr = A_NORMAL; 191 const char *message = _("Overall Progress"); 192 chtype save2 = dlg_get_attrs(win); 193 dlg_attrset(win, title_attr); 194 (void) wmove(win, y, x + 2); 195 dlg_print_text(win, message, width, &attr); 196 dlg_attrset(win, save2); 197 } 198 } 199 200 static char * 201 clean_copy(const char *string) 202 { 203 char *result = dlg_strclone(string); 204 205 dlg_trim_string(result); 206 dlg_tab_correct_str(result); 207 return result; 208 } 209 210 /* 211 * Update mixed-gauge dialog (may be from pipe, may be via direct calls). 212 */ 213 static void 214 dlg_update_mixedgauge(DIALOG_MIXEDGAUGE * dlg, int percent) 215 { 216 int i, x; 217 218 /* 219 * Clear the area for the progress bar by filling it with spaces 220 * in the title-attribute, and write the percentage with that 221 * attribute. 222 */ 223 (void) wmove(dlg->dialog, dlg->height - 3, 4); 224 dlg_attrset(dlg->dialog, gauge_attr); 225 226 for (i = 0; i < (dlg->width - 2 * (3 + MARGIN)); i++) 227 (void) waddch(dlg->dialog, ' '); 228 229 (void) wmove(dlg->dialog, dlg->height - 3, (dlg->width / 2) - 2); 230 (void) wprintw(dlg->dialog, "%3d%%", percent); 231 232 /* 233 * Now draw a bar in reverse, relative to the background. 234 * The window attribute was useful for painting the background, 235 * but requires some tweaks to reverse it. 236 */ 237 x = (percent * (dlg->width - 2 * (3 + MARGIN))) / 100; 238 if ((title_attr & A_REVERSE) != 0) { 239 dlg_attroff(dlg->dialog, A_REVERSE); 240 } else { 241 dlg_attrset(dlg->dialog, A_REVERSE); 242 } 243 (void) wmove(dlg->dialog, dlg->height - 3, 4); 244 for (i = 0; i < x; i++) { 245 chtype ch = winch(dlg->dialog); 246 if (title_attr & A_REVERSE) { 247 ch &= ~A_REVERSE; 248 } 249 (void) waddch(dlg->dialog, ch); 250 } 251 myprint_status(dlg); 252 dlg_trace_win(dlg->dialog); 253 } 254 255 /* 256 * Setup dialog. 257 */ 258 static void 259 dlg_begin_mixedgauge(DIALOG_MIXEDGAUGE * dlg, 260 int *began, 261 const char *aTitle, 262 const char *aPrompt, 263 int aHeight, 264 int aWidth, 265 int aItemNo, 266 char **items) 267 { 268 int y, x; 269 270 if (!*began) { 271 int n; 272 273 curs_set(0); 274 275 memset(dlg, 0, sizeof(*dlg)); 276 dlg->title = aTitle; 277 dlg->prompt = clean_copy(aPrompt); 278 dlg->height = dlg->old_height = aHeight; 279 dlg->width = dlg->old_width = aWidth; 280 dlg->item_no = aItemNo; 281 282 dlg->list = dlg_calloc(DIALOG_LISTITEM, (size_t) aItemNo); 283 assert_ptr(dlg->list, "dialog_mixedgauge"); 284 285 dlg->len_name = 0; 286 dlg->len_text = 15; 287 288 for (n = 0; n < aItemNo; ++n) { 289 int thisWidth = (int) strlen(ItemName(n)); 290 if (dlg->len_name < thisWidth) 291 dlg->len_name = thisWidth; 292 dlg->list[n].name = ItemName(n); 293 dlg->list[n].text = ItemText(n); 294 } 295 296 dlg->min_height = MIN_HIGH + aItemNo; 297 dlg->min_width = MIN_WIDE + dlg->len_name + GUTTER + dlg->len_text; 298 299 if (dlg->prompt != 0 && *(dlg->prompt) != 0) 300 dlg->min_height += (2 * MARGIN); 301 #ifdef KEY_RESIZE 302 nodelay(stdscr, TRUE); 303 #endif 304 } 305 #ifdef KEY_RESIZE 306 else { 307 dlg_del_window(dlg->dialog); 308 dlg->height = dlg->old_height; 309 dlg->width = dlg->old_width; 310 } 311 #endif 312 313 dlg_auto_size(dlg->title, dlg->prompt, 314 &(dlg->height), 315 &(dlg->width), 316 dlg->min_height, 317 dlg->min_width); 318 dlg_print_size(dlg->height, dlg->width); 319 dlg_ctl_size(dlg->height, dlg->width); 320 321 /* center dialog box on screen */ 322 x = dlg_box_x_ordinate(dlg->width); 323 y = dlg_box_y_ordinate(dlg->height); 324 325 dlg->dialog = dlg_new_window(dlg->height, dlg->width, y, x); 326 327 (void) werase(dlg->dialog); 328 dlg_draw_box2(dlg->dialog, 329 0, 0, 330 dlg->height, 331 dlg->width, 332 dialog_attr, border_attr, border2_attr); 333 334 dlg_draw_title(dlg->dialog, dlg->title); 335 dlg_draw_helpline(dlg->dialog, FALSE); 336 337 if ((dlg->prompt != 0 && *(dlg->prompt) != 0) 338 && wmove(dlg->dialog, dlg->item_no, 0) != ERR) { 339 dlg->caption = dlg_sub_window(dlg->dialog, 340 dlg->height - dlg->item_no - (2 * MARGIN), 341 dlg->width, 342 y + dlg->item_no + (2 * MARGIN), 343 x); 344 dlg_attrset(dlg->caption, dialog_attr); 345 dlg_print_autowrap(dlg->caption, dlg->prompt, dlg->height, dlg->width); 346 } 347 348 mydraw_mixed_box(dlg->dialog, 349 dlg->height - 4, 350 2 + MARGIN, 351 2 + MARGIN, 352 dlg->width - 2 * (2 + MARGIN), 353 dialog_attr, 354 border_attr); 355 356 *began += 1; 357 } 358 359 /* 360 * Discard the mixed-gauge dialog. 361 */ 362 static int 363 dlg_finish_mixedgauge(DIALOG_MIXEDGAUGE * dlg, int status) 364 { 365 (void) wrefresh(dlg->dialog); 366 #ifdef KEY_RESIZE 367 nodelay(stdscr, FALSE); 368 #endif 369 curs_set(1); 370 dlg_del_window(dlg->dialog); 371 free(dlg->prompt); 372 free(dlg->list); 373 return status; 374 } 375 376 /* 377 * Setup dialog, read mixed-gauge data from pipe. 378 */ 379 int 380 dialog_mixedgauge(const char *title, 381 const char *cprompt, 382 int height, 383 int width, 384 int percent, 385 int item_no, 386 char **items) 387 { 388 DIALOG_MIXEDGAUGE dlg; 389 int began = 0; 390 391 DLG_TRACE(("# mixedgauge args:\n")); 392 DLG_TRACE2S("title", title); 393 DLG_TRACE2S("message", cprompt); 394 DLG_TRACE2N("height", height); 395 DLG_TRACE2N("width", width); 396 DLG_TRACE2N("percent", percent); 397 DLG_TRACE2N("llength", item_no); 398 /* FIXME dump the items[][] too */ 399 400 dlg_begin_mixedgauge(&dlg, &began, title, cprompt, height, 401 width, item_no, items); 402 403 dlg_update_mixedgauge(&dlg, percent); 404 405 return dlg_finish_mixedgauge(&dlg, DLG_EXIT_OK); 406 } 407