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