1/* 2 * $Id: checklist.c,v 1.153 2013/09/02 17:01:02 tom Exp $ 3 * 4 * checklist.c -- implements the checklist box 5 * 6 * Copyright 2000-2012,2013 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 * Savio Lam (lam836@cs.cuhk.hk) 25 * Stuart Herbert - S.Herbert@sheffield.ac.uk: radiolist extension 26 * Alessandro Rubini - rubini@ipvvis.unipv.it: merged the two 27 */ 28 29#include <dialog.h> 30#include <dlg_keys.h> 31 32#define MIN_HIGH (1 + (5 * MARGIN)) 33 34typedef struct { 35 /* the outer-window */ 36 WINDOW *dialog; 37 int box_y; 38 int box_x; 39 int check_x; 40 int item_x; 41 int checkflag; 42 int use_height; 43 int use_width; 44 /* the inner-window */ 45 WINDOW *list; 46 DIALOG_LISTITEM *items; 47 int item_no; 48 const char *states; 49} ALL_DATA; 50 51/* 52 * Print list item. The 'selected' parameter is true if 'choice' is the 53 * current item. That one is colored differently from the other items. 54 */ 55static void 56print_item(ALL_DATA * data, 57 WINDOW *win, 58 DIALOG_LISTITEM * item, 59 const char *states, 60 int choice, 61 int selected) 62{ 63 chtype save = dlg_get_attrs(win); 64 int i; 65 bool both = (!dialog_vars.no_tags && !dialog_vars.no_items); 66 bool first = TRUE; 67 int climit = (getmaxx(win) - data->check_x + 1); 68 const char *show = (dialog_vars.no_items 69 ? item->name 70 : item->text); 71 72 /* Clear 'residue' of last item */ 73 (void) wattrset(win, menubox_attr); 74 (void) wmove(win, choice, 0); 75 for (i = 0; i < data->use_width; i++) 76 (void) waddch(win, ' '); 77 78 (void) wmove(win, choice, data->check_x); 79 (void) wattrset(win, selected ? check_selected_attr : check_attr); 80 (void) wprintw(win, 81 (data->checkflag == FLAG_CHECK) ? "[%c]" : "(%c)", 82 states[item->state]); 83 (void) wattrset(win, menubox_attr); 84 (void) waddch(win, ' '); 85 86 if (both) { 87 dlg_print_listitem(win, item->name, climit, first, selected); 88 first = FALSE; 89 } 90 91 (void) wmove(win, choice, data->item_x); 92 dlg_print_listitem(win, show, climit, first, selected); 93 94 if (selected) { 95 dlg_item_help(item->help); 96 } 97 (void) wattrset(win, save); 98} 99 100static void 101print_list(ALL_DATA * data, int choice, int scrollamt, int max_choice) 102{ 103 int i; 104 int cur_y, cur_x; 105 106 getyx(data->dialog, cur_y, cur_x); 107 for (i = 0; i < max_choice; i++) { 108 print_item(data, 109 data->list, 110 &data->items[i + scrollamt], 111 data->states, 112 i, i == choice); 113 } 114 (void) wnoutrefresh(data->list); 115 116 dlg_draw_scrollbar(data->dialog, 117 (long) (scrollamt), 118 (long) (scrollamt), 119 (long) (scrollamt + max_choice), 120 (long) (data->item_no), 121 data->box_x + data->check_x, 122 data->box_x + data->use_width, 123 data->box_y, 124 data->box_y + data->use_height + 1, 125 menubox_border2_attr, 126 menubox_border_attr); 127 128 (void) wmove(data->dialog, cur_y, cur_x); 129} 130 131static bool 132check_hotkey(DIALOG_LISTITEM * items, int choice) 133{ 134 bool result = FALSE; 135 136 if (dlg_match_char(dlg_last_getc(), 137 (dialog_vars.no_tags 138 ? items[choice].text 139 : items[choice].name))) { 140 result = TRUE; 141 } 142 return result; 143} 144 145/* 146 * This is an alternate interface to 'checklist' which allows the application 147 * to read the list item states back directly without putting them in the 148 * output buffer. It also provides for more than two states over which the 149 * check/radio box can display. 150 */ 151int 152dlg_checklist(const char *title, 153 const char *cprompt, 154 int height, 155 int width, 156 int list_height, 157 int item_no, 158 DIALOG_LISTITEM * items, 159 const char *states, 160 int flag, 161 int *current_item) 162{ 163 /* *INDENT-OFF* */ 164 static DLG_KEYS_BINDING binding[] = { 165 HELPKEY_BINDINGS, 166 ENTERKEY_BINDINGS, 167 DLG_KEYS_DATA( DLGK_FIELD_NEXT, KEY_RIGHT ), 168 DLG_KEYS_DATA( DLGK_FIELD_NEXT, TAB ), 169 DLG_KEYS_DATA( DLGK_FIELD_PREV, KEY_BTAB ), 170 DLG_KEYS_DATA( DLGK_FIELD_PREV, KEY_LEFT ), 171 DLG_KEYS_DATA( DLGK_ITEM_FIRST, KEY_HOME ), 172 DLG_KEYS_DATA( DLGK_ITEM_LAST, KEY_END ), 173 DLG_KEYS_DATA( DLGK_ITEM_LAST, KEY_LL ), 174 DLG_KEYS_DATA( DLGK_ITEM_NEXT, '+' ), 175 DLG_KEYS_DATA( DLGK_ITEM_NEXT, KEY_DOWN ), 176 DLG_KEYS_DATA( DLGK_ITEM_NEXT, CHR_NEXT ), 177 DLG_KEYS_DATA( DLGK_ITEM_PREV, '-' ), 178 DLG_KEYS_DATA( DLGK_ITEM_PREV, KEY_UP ), 179 DLG_KEYS_DATA( DLGK_ITEM_PREV, CHR_PREVIOUS ), 180 DLG_KEYS_DATA( DLGK_PAGE_NEXT, KEY_NPAGE ), 181 DLG_KEYS_DATA( DLGK_PAGE_NEXT, DLGK_MOUSE(KEY_NPAGE) ), 182 DLG_KEYS_DATA( DLGK_PAGE_PREV, KEY_PPAGE ), 183 DLG_KEYS_DATA( DLGK_PAGE_PREV, DLGK_MOUSE(KEY_PPAGE) ), 184 END_KEYS_BINDING 185 }; 186 /* *INDENT-ON* */ 187 188#ifdef KEY_RESIZE 189 int old_height = height; 190 int old_width = width; 191#endif 192 ALL_DATA all; 193 int i, j, key2, found, x, y, cur_x, cur_y; 194 int key = 0, fkey; 195 int button = dialog_state.visit_items ? -1 : dlg_default_button(); 196 int choice = dlg_default_listitem(items); 197 int scrollamt = 0; 198 int max_choice; 199 int was_mouse; 200 int use_width, list_width, name_width, text_width; 201 int result = DLG_EXIT_UNKNOWN; 202 int num_states; 203 WINDOW *dialog; 204 char *prompt = dlg_strclone(cprompt); 205 const char **buttons = dlg_ok_labels(); 206 const char *widget_name; 207 208 memset(&all, 0, sizeof(all)); 209 all.items = items; 210 all.item_no = item_no; 211 212 dlg_does_output(); 213 dlg_tab_correct_str(prompt); 214 215 /* 216 * If this is a radiobutton list, ensure that no more than one item is 217 * selected initially. Allow none to be selected, since some users may 218 * wish to provide this flavor. 219 */ 220 if (flag == FLAG_RADIO) { 221 bool first = TRUE; 222 223 for (i = 0; i < item_no; i++) { 224 if (items[i].state) { 225 if (first) { 226 first = FALSE; 227 } else { 228 items[i].state = 0; 229 } 230 } 231 } 232 widget_name = "radiolist"; 233 } else { 234 widget_name = "checklist"; 235 } 236#ifdef KEY_RESIZE 237 retry: 238#endif 239 240 all.use_height = list_height; 241 use_width = dlg_calc_list_width(item_no, items) + 10; 242 use_width = MAX(26, use_width); 243 if (all.use_height == 0) { 244 /* calculate height without items (4) */ 245 dlg_auto_size(title, prompt, &height, &width, MIN_HIGH, use_width); 246 dlg_calc_listh(&height, &all.use_height, item_no); 247 } else { 248 dlg_auto_size(title, prompt, 249 &height, &width, 250 MIN_HIGH + all.use_height, use_width); 251 } 252 dlg_button_layout(buttons, &width); 253 dlg_print_size(height, width); 254 dlg_ctl_size(height, width); 255 256 /* we need at least two states */ 257 if (states == 0 || strlen(states) < 2) 258 states = " *"; 259 num_states = (int) strlen(states); 260 all.states = states; 261 262 all.checkflag = flag; 263 264 x = dlg_box_x_ordinate(width); 265 y = dlg_box_y_ordinate(height); 266 267 dialog = dlg_new_window(height, width, y, x); 268 all.dialog = dialog; 269 dlg_register_window(dialog, widget_name, binding); 270 dlg_register_buttons(dialog, widget_name, buttons); 271 272 dlg_mouse_setbase(x, y); 273 274 dlg_draw_box2(dialog, 0, 0, height, width, dialog_attr, border_attr, border2_attr); 275 dlg_draw_bottom_box2(dialog, border_attr, border2_attr, dialog_attr); 276 dlg_draw_title(dialog, title); 277 278 (void) wattrset(dialog, dialog_attr); 279 dlg_print_autowrap(dialog, prompt, height, width); 280 281 all.use_width = width - 6; 282 getyx(dialog, cur_y, cur_x); 283 all.box_y = cur_y + 1; 284 all.box_x = (width - all.use_width) / 2 - 1; 285 286 /* 287 * After displaying the prompt, we know how much space we really have. 288 * Limit the list to avoid overwriting the ok-button. 289 */ 290 if (all.use_height + MIN_HIGH > height - cur_y) 291 all.use_height = height - MIN_HIGH - cur_y; 292 if (all.use_height <= 0) 293 all.use_height = 1; 294 295 max_choice = MIN(all.use_height, item_no); 296 max_choice = MAX(max_choice, 1); 297 298 /* create new window for the list */ 299 all.list = dlg_sub_window(dialog, all.use_height, all.use_width, 300 y + all.box_y + 1, x + all.box_x + 1); 301 302 /* draw a box around the list items */ 303 dlg_draw_box(dialog, all.box_y, all.box_x, 304 all.use_height + 2 * MARGIN, 305 all.use_width + 2 * MARGIN, 306 menubox_border_attr, menubox_border2_attr); 307 308 text_width = 0; 309 name_width = 0; 310 /* Find length of longest item to center checklist */ 311 for (i = 0; i < item_no; i++) { 312 text_width = MAX(text_width, dlg_count_columns(items[i].text)); 313 name_width = MAX(name_width, dlg_count_columns(items[i].name)); 314 } 315 316 /* If the name+text is wider than the list is allowed, then truncate 317 * one or both of them. If the name is no wider than 1/4 of the list, 318 * leave it intact. 319 */ 320 use_width = (all.use_width - 6); 321 if (dialog_vars.no_tags) { 322 list_width = MIN(all.use_width, text_width); 323 } else if (dialog_vars.no_items) { 324 list_width = MIN(all.use_width, name_width); 325 } else { 326 if (text_width >= 0 327 && name_width >= 0 328 && use_width > 0 329 && text_width + name_width > use_width) { 330 int need = (int) (0.25 * use_width); 331 if (name_width > need) { 332 int want = (int) (use_width * ((double) name_width) / 333 (text_width + name_width)); 334 name_width = (want > need) ? want : need; 335 } 336 text_width = use_width - name_width; 337 } 338 list_width = (text_width + name_width); 339 } 340 341 all.check_x = (use_width - list_width) / 2; 342 all.item_x = ((dialog_vars.no_tags 343 ? 0 344 : (dialog_vars.no_items 345 ? 0 346 : (2 + name_width))) 347 + all.check_x + 4); 348 349 /* ensure we are scrolled to show the current choice */ 350 scrollamt = MIN(scrollamt, max_choice + item_no - 1); 351 if (choice >= (max_choice + scrollamt - 1)) { 352 scrollamt = MAX(0, choice - max_choice + 1); 353 choice = max_choice - 1; 354 } 355 print_list(&all, choice, scrollamt, max_choice); 356 357 /* register the new window, along with its borders */ 358 dlg_mouse_mkbigregion(all.box_y + 1, all.box_x, 359 all.use_height, all.use_width + 2, 360 KEY_MAX, 1, 1, 1 /* by lines */ ); 361 362 dlg_draw_buttons(dialog, height - 2, 0, buttons, button, FALSE, width); 363 364 dlg_trace_win(dialog); 365 while (result == DLG_EXIT_UNKNOWN) { 366 if (button < 0) /* --visit-items */ 367 wmove(dialog, all.box_y + choice + 1, all.box_x + all.check_x + 2); 368 369 key = dlg_mouse_wgetch(dialog, &fkey); 370 if (dlg_result_key(key, fkey, &result)) 371 break; 372 373 was_mouse = (fkey && is_DLGK_MOUSE(key)); 374 if (was_mouse) 375 key -= M_EVENT; 376 377 if (was_mouse && (key >= KEY_MAX)) { 378 getyx(dialog, cur_y, cur_x); 379 i = (key - KEY_MAX); 380 if (i < max_choice) { 381 choice = (key - KEY_MAX); 382 print_list(&all, choice, scrollamt, max_choice); 383 384 key = ' '; /* force the selected item to toggle */ 385 } else { 386 beep(); 387 continue; 388 } 389 fkey = FALSE; 390 } else if (was_mouse && key >= KEY_MIN) { 391 key = dlg_lookup_key(dialog, key, &fkey); 392 } 393 394 /* 395 * A space toggles the item status. We handle either a checklist 396 * (any number of items can be selected) or radio list (zero or one 397 * items can be selected). 398 */ 399 if (key == ' ') { 400 int current = scrollamt + choice; 401 int next = items[current].state + 1; 402 403 if (next >= num_states) 404 next = 0; 405 406 if (flag == FLAG_CHECK) { /* checklist? */ 407 getyx(dialog, cur_y, cur_x); 408 items[current].state = next; 409 print_item(&all, all.list, 410 &items[scrollamt + choice], 411 states, 412 choice, TRUE); 413 (void) wnoutrefresh(all.list); 414 (void) wmove(dialog, cur_y, cur_x); 415 } else { /* radiolist */ 416 for (i = 0; i < item_no; i++) { 417 if (i != current) { 418 items[i].state = 0; 419 } 420 } 421 if (items[current].state) { 422 getyx(dialog, cur_y, cur_x); 423 items[current].state = next ? next : 1; 424 print_item(&all, all.list, 425 &items[current], 426 states, 427 choice, TRUE); 428 (void) wnoutrefresh(all.list); 429 (void) wmove(dialog, cur_y, cur_x); 430 } else { 431 items[current].state = 1; 432 print_list(&all, choice, scrollamt, max_choice); 433 } 434 } 435 continue; /* wait for another key press */ 436 } 437 438 /* 439 * Check if key pressed matches first character of any item tag in 440 * list. If there is more than one match, we will cycle through 441 * each one as the same key is pressed repeatedly. 442 */ 443 found = FALSE; 444 if (!fkey) { 445 if (button < 0 || !dialog_state.visit_items) { 446 for (j = scrollamt + choice + 1; j < item_no; j++) { 447 if (check_hotkey(items, j)) { 448 found = TRUE; 449 i = j - scrollamt; 450 break; 451 } 452 } 453 if (!found) { 454 for (j = 0; j <= scrollamt + choice; j++) { 455 if (check_hotkey(items, j)) { 456 found = TRUE; 457 i = j - scrollamt; 458 break; 459 } 460 } 461 } 462 if (found) 463 dlg_flush_getc(); 464 } else if ((j = dlg_char_to_button(key, buttons)) >= 0) { 465 button = j; 466 ungetch('\n'); 467 continue; 468 } 469 } 470 471 /* 472 * A single digit (1-9) positions the selection to that line in the 473 * current screen. 474 */ 475 if (!found 476 && (key <= '9') 477 && (key > '0') 478 && (key - '1' < max_choice)) { 479 found = TRUE; 480 i = key - '1'; 481 } 482 483 if (!found) { 484 if (fkey) { 485 found = TRUE; 486 switch (key) { 487 case DLGK_ITEM_FIRST: 488 i = -scrollamt; 489 break; 490 case DLGK_ITEM_LAST: 491 i = item_no - 1 - scrollamt; 492 break; 493 case DLGK_PAGE_PREV: 494 if (choice) 495 i = 0; 496 else if (scrollamt != 0) 497 i = -MIN(scrollamt, max_choice); 498 else 499 continue; 500 break; 501 case DLGK_PAGE_NEXT: 502 i = MIN(choice + max_choice, item_no - scrollamt - 1); 503 break; 504 case DLGK_ITEM_PREV: 505 i = choice - 1; 506 if (choice == 0 && scrollamt == 0) 507 continue; 508 break; 509 case DLGK_ITEM_NEXT: 510 i = choice + 1; 511 if (scrollamt + choice >= item_no - 1) 512 continue; 513 break; 514 default: 515 found = FALSE; 516 break; 517 } 518 } 519 } 520 521 if (found) { 522 if (i != choice) { 523 getyx(dialog, cur_y, cur_x); 524 if (i < 0 || i >= max_choice) { 525 if (i < 0) { 526 scrollamt += i; 527 choice = 0; 528 } else { 529 choice = max_choice - 1; 530 scrollamt += (i - max_choice + 1); 531 } 532 print_list(&all, choice, scrollamt, max_choice); 533 } else { 534 choice = i; 535 print_list(&all, choice, scrollamt, max_choice); 536 } 537 } 538 continue; /* wait for another key press */ 539 } 540 541 if (fkey) { 542 switch (key) { 543 case DLGK_ENTER: 544 result = dlg_enter_buttoncode(button); 545 break; 546 case DLGK_FIELD_PREV: 547 button = dlg_prev_button(buttons, button); 548 dlg_draw_buttons(dialog, height - 2, 0, buttons, button, 549 FALSE, width); 550 break; 551 case DLGK_FIELD_NEXT: 552 button = dlg_next_button(buttons, button); 553 dlg_draw_buttons(dialog, height - 2, 0, buttons, button, 554 FALSE, width); 555 break; 556#ifdef KEY_RESIZE 557 case KEY_RESIZE: 558 /* reset data */ 559 height = old_height; 560 width = old_width; 561 /* repaint */ 562 dlg_clear(); 563 dlg_del_window(dialog); 564 refresh(); 565 dlg_mouse_free_regions(); 566 goto retry; 567#endif 568 default: 569 if (was_mouse) { 570 if ((key2 = dlg_ok_buttoncode(key)) >= 0) { 571 result = key2; 572 break; 573 } 574 beep(); 575 } 576 } 577 } else { 578 beep(); 579 } 580 } 581 582 dlg_del_window(dialog); 583 dlg_mouse_free_regions(); 584 free(prompt); 585 *current_item = (scrollamt + choice); 586 return result; 587} 588 589/* 590 * Display a dialog box with a list of options that can be turned on or off 591 * The `flag' parameter is used to select between radiolist and checklist. 592 */ 593int 594dialog_checklist(const char *title, 595 const char *cprompt, 596 int height, 597 int width, 598 int list_height, 599 int item_no, 600 char **items, 601 int flag) 602{ 603 int result; 604 int i, j; 605 DIALOG_LISTITEM *listitems; 606 bool separate_output = ((flag == FLAG_CHECK) 607 && (dialog_vars.separate_output)); 608 bool show_status = FALSE; 609 int current = 0; 610 char *help_result; 611 612 listitems = dlg_calloc(DIALOG_LISTITEM, (size_t) item_no + 1); 613 assert_ptr(listitems, "dialog_checklist"); 614 615 for (i = j = 0; i < item_no; ++i) { 616 listitems[i].name = items[j++]; 617 listitems[i].text = (dialog_vars.no_items 618 ? dlg_strempty() 619 : items[j++]); 620 listitems[i].state = !dlg_strcmp(items[j++], "on"); 621 listitems[i].help = ((dialog_vars.item_help) 622 ? items[j++] 623 : dlg_strempty()); 624 } 625 dlg_align_columns(&listitems[0].text, (int) sizeof(DIALOG_LISTITEM), item_no); 626 627 result = dlg_checklist(title, 628 cprompt, 629 height, 630 width, 631 list_height, 632 item_no, 633 listitems, 634 NULL, 635 flag, 636 ¤t); 637 638 switch (result) { 639 case DLG_EXIT_OK: /* FALLTHRU */ 640 case DLG_EXIT_EXTRA: 641 show_status = TRUE; 642 break; 643 case DLG_EXIT_HELP: 644 dlg_add_help_listitem(&result, &help_result, &listitems[current]); 645 if ((show_status = dialog_vars.help_status)) { 646 if (separate_output) { 647 dlg_add_string(help_result); 648 dlg_add_separator(); 649 } else { 650 dlg_add_quoted(help_result); 651 } 652 } else { 653 dlg_add_string(help_result); 654 } 655 break; 656 } 657 658 if (show_status) { 659 for (i = 0; i < item_no; i++) { 660 if (listitems[i].state) { 661 if (separate_output) { 662 dlg_add_string(listitems[i].name); 663 dlg_add_separator(); 664 } else { 665 if (dlg_need_separator()) 666 dlg_add_separator(); 667 if (flag == FLAG_CHECK) 668 dlg_add_quoted(listitems[i].name); 669 else 670 dlg_add_string(listitems[i].name); 671 } 672 } 673 } 674 dlg_add_last_key(separate_output); 675 } 676 677 dlg_free_columns(&listitems[0].text, (int) sizeof(DIALOG_LISTITEM), item_no); 678 free(listitems); 679 return result; 680} 681