contrib/dialog/checklist.c

   1 /*
   2  *  $Id: checklist.c,v 1.154 2015/01/25 23:53:06 tom Exp $
   3  *
   4  *  checklist.c -- implements the checklist box
   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  *      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
  34 typedef 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  */
  55 static void
  56 print_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
 100 static void
 101 print_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
 131 static bool
 132 check_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  */
 151 int
 152 dlg_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     dialog_state.plain_buttons = TRUE;
 209
 210     memset(&all, 0, sizeof(all));
 211     all.items = items;
 212     all.item_no = item_no;
 213
 214     dlg_does_output();
 215     dlg_tab_correct_str(prompt);
 216
 217     /*
 218      * If this is a radiobutton list, ensure that no more than one item is
 219      * selected initially.  Allow none to be selected, since some users may
 220      * wish to provide this flavor.
 221      */
 222     if (flag == FLAG_RADIO) {
 223         bool first = TRUE;
 224
 225         for (i = 0; i < item_no; i++) {
 226             if (items[i].state) {
 227                 if (first) {
 228                     first = FALSE;
 229                 } else {
 230                     items[i].state = 0;
 231                 }
 232             }
 233         }
 234         widget_name = "radiolist";
 235     } else {
 236         widget_name = "checklist";
 237     }
 238 #ifdef KEY_RESIZE
 239   retry:
 240 #endif
 241
 242     all.use_height = list_height;
 243     use_width = dlg_calc_list_width(item_no, items) + 10;
 244     use_width = MAX(26, use_width);
 245     if (all.use_height == 0) {
 246         /* calculate height without items (4) */
 247         dlg_auto_size(title, prompt, &height, &width, MIN_HIGH, use_width);
 248         dlg_calc_listh(&height, &all.use_height, item_no);
 249     } else {
 250         dlg_auto_size(title, prompt,
 251                       &height, &width,
 252                       MIN_HIGH + all.use_height, use_width);
 253     }
 254     dlg_button_layout(buttons, &width);
 255     dlg_print_size(height, width);
 256     dlg_ctl_size(height, width);
 257
 258     /* we need at least two states */
 259     if (states == 0 || strlen(states) < 2)
 260         states = " *";
 261     num_states = (int) strlen(states);
 262     all.states = states;
 263
 264     all.checkflag = flag;
 265
 266     x = dlg_box_x_ordinate(width);
 267     y = dlg_box_y_ordinate(height);
 268
 269     dialog = dlg_new_window(height, width, y, x);
 270     all.dialog = dialog;
 271     dlg_register_window(dialog, widget_name, binding);
 272     dlg_register_buttons(dialog, widget_name, buttons);
 273
 274     dlg_mouse_setbase(x, y);
 275
 276     dlg_draw_box2(dialog, 0, 0, height, width, dialog_attr, border_attr, border2_attr);
 277     dlg_draw_bottom_box2(dialog, border_attr, border2_attr, dialog_attr);
 278     dlg_draw_title(dialog, title);
 279
 280     (void) wattrset(dialog, dialog_attr);
 281     dlg_print_autowrap(dialog, prompt, height, width);
 282
 283     all.use_width = width - 6;
 284     getyx(dialog, cur_y, cur_x);
 285     all.box_y = cur_y + 1;
 286     all.box_x = (width - all.use_width) / 2 - 1;
 287
 288     /*
 289      * After displaying the prompt, we know how much space we really have.
 290      * Limit the list to avoid overwriting the ok-button.
 291      */
 292     if (all.use_height + MIN_HIGH > height - cur_y)
 293         all.use_height = height - MIN_HIGH - cur_y;
 294     if (all.use_height <= 0)
 295         all.use_height = 1;
 296
 297     max_choice = MIN(all.use_height, item_no);
 298     max_choice = MAX(max_choice, 1);
 299
 300     /* create new window for the list */
 301     all.list = dlg_sub_window(dialog, all.use_height, all.use_width,
 302                               y + all.box_y + 1, x + all.box_x + 1);
 303
 304     /* draw a box around the list items */
 305     dlg_draw_box(dialog, all.box_y, all.box_x,
 306                  all.use_height + 2 * MARGIN,
 307                  all.use_width + 2 * MARGIN,
 308                  menubox_border_attr, menubox_border2_attr);
 309
 310     text_width = 0;
 311     name_width = 0;
 312     /* Find length of longest item to center checklist */
 313     for (i = 0; i < item_no; i++) {
 314         text_width = MAX(text_width, dlg_count_columns(items[i].text));
 315         name_width = MAX(name_width, dlg_count_columns(items[i].name));
 316     }
 317
 318     /* If the name+text is wider than the list is allowed, then truncate
 319      * one or both of them.  If the name is no wider than 1/4 of the list,
 320      * leave it intact.
 321      */
 322     use_width = (all.use_width - 6);
 323     if (dialog_vars.no_tags) {
 324         list_width = MIN(all.use_width, text_width);
 325     } else if (dialog_vars.no_items) {
 326         list_width = MIN(all.use_width, name_width);
 327     } else {
 328         if (text_width >= 0
 329             && name_width >= 0
 330             && use_width > 0
 331             && text_width + name_width > use_width) {
 332             int need = (int) (0.25 * use_width);
 333             if (name_width > need) {
 334                 int want = (int) (use_width * ((double) name_width) /
 335                                   (text_width + name_width));
 336                 name_width = (want > need) ? want : need;
 337             }
 338             text_width = use_width - name_width;
 339         }
 340         list_width = (text_width + name_width);
 341     }
 342
 343     all.check_x = (use_width - list_width) / 2;
 344     all.item_x = ((dialog_vars.no_tags
 345                    ? 0
 346                    : (dialog_vars.no_items
 347                       ? 0
 348                       : (2 + name_width)))
 349                   + all.check_x + 4);
 350
 351     /* ensure we are scrolled to show the current choice */
 352     scrollamt = MIN(scrollamt, max_choice + item_no - 1);
 353     if (choice >= (max_choice + scrollamt - 1)) {
 354         scrollamt = MAX(0, choice - max_choice + 1);
 355         choice = max_choice - 1;
 356     }
 357     print_list(&all, choice, scrollamt, max_choice);
 358
 359     /* register the new window, along with its borders */
 360     dlg_mouse_mkbigregion(all.box_y + 1, all.box_x,
 361                           all.use_height, all.use_width + 2,
 362                           KEY_MAX, 1, 1, 1 /* by lines */ );
 363
 364     dlg_draw_buttons(dialog, height - 2, 0, buttons, button, FALSE, width);
 365
 366     dlg_trace_win(dialog);
 367     while (result == DLG_EXIT_UNKNOWN) {
 368         if (button < 0)         /* --visit-items */
 369             wmove(dialog, all.box_y + choice + 1, all.box_x + all.check_x + 2);
 370
 371         key = dlg_mouse_wgetch(dialog, &fkey);
 372         if (dlg_result_key(key, fkey, &result))
 373             break;
 374
 375         was_mouse = (fkey && is_DLGK_MOUSE(key));
 376         if (was_mouse)
 377             key -= M_EVENT;
 378
 379         if (was_mouse && (key >= KEY_MAX)) {
 380             getyx(dialog, cur_y, cur_x);
 381             i = (key - KEY_MAX);
 382             if (i < max_choice) {
 383                 choice = (key - KEY_MAX);
 384                 print_list(&all, choice, scrollamt, max_choice);
 385
 386                 key = ' ';      /* force the selected item to toggle */
 387             } else {
 388                 beep();
 389                 continue;
 390             }
 391             fkey = FALSE;
 392         } else if (was_mouse && key >= KEY_MIN) {
 393             key = dlg_lookup_key(dialog, key, &fkey);
 394         }
 395
 396         /*
 397          * A space toggles the item status.  We handle either a checklist
 398          * (any number of items can be selected) or radio list (zero or one
 399          * items can be selected).
 400          */
 401         if (key == ' ') {
 402             int current = scrollamt + choice;
 403             int next = items[current].state + 1;
 404
 405             if (next >= num_states)
 406                 next = 0;
 407
 408             if (flag == FLAG_CHECK) {   /* checklist? */
 409                 getyx(dialog, cur_y, cur_x);
 410                 items[current].state = next;
 411                 print_item(&all, all.list,
 412                            &items[scrollamt + choice],
 413                            states,
 414                            choice, TRUE);
 415                 (void) wnoutrefresh(all.list);
 416                 (void) wmove(dialog, cur_y, cur_x);
 417             } else {            /* radiolist */
 418                 for (i = 0; i < item_no; i++) {
 419                     if (i != current) {
 420                         items[i].state = 0;
 421                     }
 422                 }
 423                 if (items[current].state) {
 424                     getyx(dialog, cur_y, cur_x);
 425                     items[current].state = next ? next : 1;
 426                     print_item(&all, all.list,
 427                                &items[current],
 428                                states,
 429                                choice, TRUE);
 430                     (void) wnoutrefresh(all.list);
 431                     (void) wmove(dialog, cur_y, cur_x);
 432                 } else {
 433                     items[current].state = 1;
 434                     print_list(&all, choice, scrollamt, max_choice);
 435                 }
 436             }
 437             continue;           /* wait for another key press */
 438         }
 439
 440         /*
 441          * Check if key pressed matches first character of any item tag in
 442          * list.  If there is more than one match, we will cycle through
 443          * each one as the same key is pressed repeatedly.
 444          */
 445         found = FALSE;
 446         if (!fkey) {
 447             if (button < 0 || !dialog_state.visit_items) {
 448                 for (j = scrollamt + choice + 1; j < item_no; j++) {
 449                     if (check_hotkey(items, j)) {
 450                         found = TRUE;
 451                         i = j - scrollamt;
 452                         break;
 453                     }
 454                 }
 455                 if (!found) {
 456                     for (j = 0; j <= scrollamt + choice; j++) {
 457                         if (check_hotkey(items, j)) {
 458                             found = TRUE;
 459                             i = j - scrollamt;
 460                             break;
 461                         }
 462                     }
 463                 }
 464                 if (found)
 465                     dlg_flush_getc();
 466             } else if ((j = dlg_char_to_button(key, buttons)) >= 0) {
 467                 button = j;
 468                 ungetch('\n');
 469                 continue;
 470             }
 471         }
 472
 473         /*
 474          * A single digit (1-9) positions the selection to that line in the
 475          * current screen.
 476          */
 477         if (!found
 478             && (key <= '9')
 479             && (key > '0')
 480             && (key - '1' < max_choice)) {
 481             found = TRUE;
 482             i = key - '1';
 483         }
 484
 485         if (!found) {
 486             if (fkey) {
 487                 found = TRUE;
 488                 switch (key) {
 489                 case DLGK_ITEM_FIRST:
 490                     i = -scrollamt;
 491                     break;
 492                 case DLGK_ITEM_LAST:
 493                     i = item_no - 1 - scrollamt;
 494                     break;
 495                 case DLGK_PAGE_PREV:
 496                     if (choice)
 497                         i = 0;
 498                     else if (scrollamt != 0)
 499                         i = -MIN(scrollamt, max_choice);
 500                     else
 501                         continue;
 502                     break;
 503                 case DLGK_PAGE_NEXT:
 504                     i = MIN(choice + max_choice, item_no - scrollamt - 1);
 505                     break;
 506                 case DLGK_ITEM_PREV:
 507                     i = choice - 1;
 508                     if (choice == 0 && scrollamt == 0)
 509                         continue;
 510                     break;
 511                 case DLGK_ITEM_NEXT:
 512                     i = choice + 1;
 513                     if (scrollamt + choice >= item_no - 1)
 514                         continue;
 515                     break;
 516                 default:
 517                     found = FALSE;
 518                     break;
 519                 }
 520             }
 521         }
 522
 523         if (found) {
 524             if (i != choice) {
 525                 getyx(dialog, cur_y, cur_x);
 526                 if (i < 0 || i >= max_choice) {
 527                     if (i < 0) {
 528                         scrollamt += i;
 529                         choice = 0;
 530                     } else {
 531                         choice = max_choice - 1;
 532                         scrollamt += (i - max_choice + 1);
 533                     }
 534                     print_list(&all, choice, scrollamt, max_choice);
 535                 } else {
 536                     choice = i;
 537                     print_list(&all, choice, scrollamt, max_choice);
 538                 }
 539             }
 540             continue;           /* wait for another key press */
 541         }
 542
 543         if (fkey) {
 544             switch (key) {
 545             case DLGK_ENTER:
 546                 result = dlg_enter_buttoncode(button);
 547                 break;
 548             case DLGK_FIELD_PREV:
 549                 button = dlg_prev_button(buttons, button);
 550                 dlg_draw_buttons(dialog, height - 2, 0, buttons, button,
 551                                  FALSE, width);
 552                 break;
 553             case DLGK_FIELD_NEXT:
 554                 button = dlg_next_button(buttons, button);
 555                 dlg_draw_buttons(dialog, height - 2, 0, buttons, button,
 556                                  FALSE, width);
 557                 break;
 558 #ifdef KEY_RESIZE
 559             case KEY_RESIZE:
 560                 /* reset data */
 561                 height = old_height;
 562                 width = old_width;
 563                 /* repaint */
 564                 dlg_clear();
 565                 dlg_del_window(dialog);
 566                 refresh();
 567                 dlg_mouse_free_regions();
 568                 goto retry;
 569 #endif
 570             default:
 571                 if (was_mouse) {
 572                     if ((key2 = dlg_ok_buttoncode(key)) >= 0) {
 573                         result = key2;
 574                         break;
 575                     }
 576                     beep();
 577                 }
 578             }
 579         } else {
 580             beep();
 581         }
 582     }
 583
 584     dlg_del_window(dialog);
 585     dlg_mouse_free_regions();
 586     free(prompt);
 587     *current_item = (scrollamt + choice);
 588     return result;
 589 }
 590
 591 /*
 592  * Display a dialog box with a list of options that can be turned on or off
 593  * The `flag' parameter is used to select between radiolist and checklist.
 594  */
 595 int
 596 dialog_checklist(const char *title,
 597                  const char *cprompt,
 598                  int height,
 599                  int width,
 600                  int list_height,
 601                  int item_no,
 602                  char **items,
 603                  int flag)
 604 {
 605     int result;
 606     int i, j;
 607     DIALOG_LISTITEM *listitems;
 608     bool separate_output = ((flag == FLAG_CHECK)
 609                             && (dialog_vars.separate_output));
 610     bool show_status = FALSE;
 611     int current = 0;
 612     char *help_result;
 613
 614     listitems = dlg_calloc(DIALOG_LISTITEM, (size_t) item_no + 1);
 615     assert_ptr(listitems, "dialog_checklist");
 616
 617     for (i = j = 0; i < item_no; ++i) {
 618         listitems[i].name = items[j++];
 619         listitems[i].text = (dialog_vars.no_items
 620                              ? dlg_strempty()
 621                              : items[j++]);
 622         listitems[i].state = !dlg_strcmp(items[j++], "on");
 623         listitems[i].help = ((dialog_vars.item_help)
 624                              ? items[j++]
 625                              : dlg_strempty());
 626     }
 627     dlg_align_columns(&listitems[0].text, (int) sizeof(DIALOG_LISTITEM), item_no);
 628
 629     result = dlg_checklist(title,
 630                            cprompt,
 631                            height,
 632                            width,
 633                            list_height,
 634                            item_no,
 635                            listitems,
 636                            NULL,
 637                            flag,
 638                            &current);
 639
 640     switch (result) {
 641     case DLG_EXIT_OK:           /* FALLTHRU */
 642     case DLG_EXIT_EXTRA:
 643         show_status = TRUE;
 644         break;
 645     case DLG_EXIT_HELP:
 646         dlg_add_help_listitem(&result, &help_result, &listitems[current]);
 647         if ((show_status = dialog_vars.help_status)) {
 648             if (separate_output) {
 649                 dlg_add_string(help_result);
 650                 dlg_add_separator();
 651             } else {
 652                 dlg_add_quoted(help_result);
 653             }
 654         } else {
 655             dlg_add_string(help_result);
 656         }
 657         break;
 658     }
 659
 660     if (show_status) {
 661         for (i = 0; i < item_no; i++) {
 662             if (listitems[i].state) {
 663                 if (separate_output) {
 664                     dlg_add_string(listitems[i].name);
 665                     dlg_add_separator();
 666                 } else {
 667                     if (dlg_need_separator())
 668                         dlg_add_separator();
 669                     if (flag == FLAG_CHECK)
 670                         dlg_add_quoted(listitems[i].name);
 671                     else
 672                         dlg_add_string(listitems[i].name);
 673                 }
 674             }
 675         }
 676         dlg_add_last_key(separate_output);
 677     }
 678
 679     dlg_free_columns(&listitems[0].text, (int) sizeof(DIALOG_LISTITEM), item_no);
 680     free(listitems);
 681     return result;
 682 }