2 * $Id: fselect.c,v 1.102 2018/06/21 23:28:04 tom Exp $
4 * fselect.c -- implements the file-selector box
6 * Copyright 2000-2017,2018 Thomas E. Dickey
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.
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.
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.
27 #include <sys/types.h>
32 # define NAMLEN(dirent) strlen((dirent)->d_name)
34 # define dirent direct
35 # define NAMLEN(dirent) (dirent)->d_namlen
37 # include <sys/ndir.h>
47 # if defined(_FILE_OFFSET_BITS) && defined(HAVE_STRUCT_DIRENT64)
48 # if !defined(_LP64) && (_FILE_OFFSET_BITS == 64)
49 # define DIRENT struct dirent64
51 # define DIRENT struct dirent
54 # define DIRENT struct dirent
59 #define BTN_HIGH (1 + 2 * MARGIN) /* Ok/Cancel, also input-box */
60 #define MIN_HIGH (HDR_HIGH - MARGIN + (BTN_HIGH * 2) + 4 * MARGIN)
61 #define MIN_WIDE (2 * MAX(dlg_count_columns(d_label), dlg_count_columns(f_label)) + 6 * MARGIN + 2 * EXT_WIDE)
63 #define MOUSE_D (KEY_MAX + 0)
64 #define MOUSE_F (KEY_MAX + 10000)
65 #define MOUSE_T (KEY_MAX + 20000)
74 WINDOW *par; /* parent window */
75 WINDOW *win; /* this window */
76 int length; /* length of the data[] array */
77 int offset; /* index of first item on screen */
78 int choice; /* index of the selection */
79 int mousex; /* base of mouse-code return-values */
90 init_list(LIST * list, WINDOW *par, WINDOW *win, int mousex)
97 list->mousex = mousex;
100 dlg_mouse_mkbigregion(getbegy(win), getbegx(win),
101 getmaxy(win), getmaxx(win),
102 mousex, 1, 1, 1 /* by lines */ );
108 char *leaf = strrchr(path, '/');
121 return list->data[list->choice];
126 free_list(LIST * list, int reinit)
130 if (list->data != 0) {
131 for (n = 0; list->data[n] != 0; n++)
137 init_list(list, list->par, list->win, list->mousex);
141 add_to_list(LIST * list, char *text)
145 need = (unsigned) (list->length + 1);
146 if (need + 1 > list->allocd) {
147 list->allocd = 2 * (need + 1);
148 if (list->data == 0) {
149 list->data = dlg_malloc(char *, list->allocd);
151 list->data = dlg_realloc(char *, list->allocd, list->data);
153 assert_ptr(list->data, "add_to_list");
155 list->data[list->length++] = dlg_strclone(text);
156 list->data[list->length] = 0;
160 keep_visible(LIST * list)
162 int high = getmaxy(list->win);
164 if (list->choice < list->offset) {
165 list->offset = list->choice;
167 if (list->choice - list->offset >= high)
168 list->offset = list->choice - high + 1;
171 #define Value(c) (int)((c) & 0xff)
174 find_choice(char *target, LIST * list)
177 int choice = list->choice;
178 int len_1, len_2, cmp_1, cmp_2;
183 /* find the match with the longest length. If more than one has the
184 * same length, choose the one with the closest match of the final
189 for (n = 0; n < list->length; n++) {
191 char *b = list->data[n];
194 while ((*a != 0) && (*b != 0) && (*a == *b)) {
199 cmp_2 = Value(*a) - Value(*b);
203 || (len_1 == len_2 && cmp_2 < cmp_1)) {
210 if (choice != list->choice) {
213 return (choice != list->choice);
217 display_list(LIST * list)
225 if (list->win != 0) {
226 dlg_attr_clear(list->win, getmaxy(list->win), getmaxx(list->win), item_attr);
227 for (n = list->offset; n < list->length && list->data[n]; n++) {
228 y = n - list->offset;
229 if (y >= getmaxy(list->win))
231 (void) wmove(list->win, y, 0);
232 if (n == list->choice)
233 dlg_attrset(list->win, item_selected_attr);
234 (void) waddstr(list->win, list->data[n]);
235 dlg_attrset(list->win, item_attr);
237 dlg_attrset(list->win, item_attr);
239 getparyx(list->win, y, x);
242 bottom = y + getmaxy(list->win);
243 dlg_draw_scrollbar(list->par,
246 (long) (list->offset + getmaxy(list->win)),
247 (long) (list->length),
249 x + getmaxx(list->win),
252 menubox_border2_attr,
253 menubox_border_attr);
255 (void) wmove(list->win, list->choice - list->offset, 0);
256 (void) wnoutrefresh(list->win);
260 /* FIXME: see arrows.c
261 * This workaround is used to allow two lists to have scroll-tabs at the same
262 * time, by reassigning their return-values to be different. Just for
263 * readability, we use the names of keys with similar connotations, though all
264 * that is really required is that they're distinct, so we can put them in a
268 fix_arrows(LIST * list)
276 if (list->win != 0) {
277 getparyx(list->win, y, x);
279 right = getmaxx(list->win);
280 bottom = y + getmaxy(list->win);
282 mouse_mkbutton(top, x, right,
283 ((list->mousex == MOUSE_D)
286 mouse_mkbutton(bottom, x, right,
287 ((list->mousex == MOUSE_D)
294 show_list(char *target, LIST * list, bool keep)
296 bool changed = keep || find_choice(target, list);
302 * Highlight the closest match to 'target' in the given list, setting offset
306 show_both_lists(char *input, LIST * d_list, LIST * f_list, bool keep)
308 char *leaf = leaf_of(input);
310 return show_list(leaf, d_list, keep) || show_list(leaf, f_list, keep);
314 * Move up/down in the given list
317 change_list(int choice, LIST * list)
319 if (data_of(list) != 0) {
320 int last = list->length - 1;
322 choice += list->choice;
327 list->choice = choice;
336 scroll_list(int direction, LIST * list)
338 if (data_of(list) != 0) {
339 int length = getmaxy(list->win);
340 if (change_list(direction * length, list))
347 compar(const void *a, const void *b)
349 return strcmp(*(const char *const *) a, *(const char *const *) b);
353 match(char *name, LIST * d_list, LIST * f_list, MATCH * match_list)
355 char *test = leaf_of(name);
356 size_t test_len = strlen(test);
357 char **matches = dlg_malloc(char *, (size_t) (d_list->length + f_list->length));
360 for (i = 2; i < d_list->length; i++) {
361 if (strncmp(test, d_list->data[i], test_len) == 0) {
362 matches[data_len++] = d_list->data[i];
365 for (i = 0; i < f_list->length; i++) {
366 if (strncmp(test, f_list->data[i], test_len) == 0) {
367 matches[data_len++] = f_list->data[i];
370 matches = dlg_realloc(char *, data_len + 1, matches);
371 match_list->data = matches;
372 match_list->length = (int) data_len;
376 free_match(MATCH * match_list)
378 free(match_list->data);
379 match_list->length = 0;
383 complete(char *name, LIST * d_list, LIST * f_list, char **buff_ptr)
392 match(name, d_list, f_list, &match_list);
393 if (match_list.length == 0) {
398 test = match_list.data[0];
399 test_len = strlen(test);
400 buff = dlg_malloc(char, test_len + 2);
401 if (match_list.length == 1) {
404 if (test == data_of(d_list)) {
405 buff[test_len] = '/';
409 for (i = 0; i < test_len; i++) {
410 char test_char = test[i];
411 if (test_char == '\0')
413 for (j = 0; j < match_list.length; j++) {
414 if (match_list.data[j][i] != test_char) {
418 if (j == match_list.length) {
419 (buff)[i] = test_char;
423 buff = dlg_realloc(char, i + 1, buff);
425 free_match(&match_list);
432 fill_lists(char *current, char *input, LIST * d_list, LIST * f_list, bool keep)
440 char path[MAX_LEN + 1];
443 /* check if we've updated the lists */
444 for (n = 0; current[n] && input[n]; n++) {
445 if (current[n] != input[n])
449 if (current[n] == input[n]) {
451 rescan = (n == 0 && d_list->length == 0);
452 } else if (strchr(current + n, '/') == 0
453 && strchr(input + n, '/') == 0) {
454 result = show_both_lists(input, d_list, f_list, keep);
460 size_t have = strlen(input);
464 memcpy(current, input, have);
465 current[have] = '\0';
467 /* refill the lists */
468 free_list(d_list, TRUE);
469 free_list(f_list, TRUE);
470 memcpy(path, current, have);
472 if ((leaf = strrchr(path, '/')) != 0) {
476 leaf = path + strlen(path);
478 DLG_TRACE(("opendir '%s'\n", path));
479 if ((dp = opendir(path)) != 0) {
480 while ((de = readdir(dp)) != 0) {
481 size_t len = NAMLEN(de);
482 if (len == 0 || (len + have + 2) >= MAX_LEN)
484 memcpy(leaf, de->d_name, len);
486 if (stat(path, &sb) == 0) {
487 if ((sb.st_mode & S_IFMT) == S_IFDIR)
488 add_to_list(d_list, leaf);
489 else if (f_list->win)
490 add_to_list(f_list, leaf);
495 if (d_list->data != 0 && d_list->length > 1) {
497 (size_t) d_list->length,
498 sizeof(d_list->data[0]),
501 if (f_list->data != 0 && f_list->length > 1) {
503 (size_t) f_list->length,
504 sizeof(f_list->data[0]),
509 (void) show_both_lists(input, d_list, f_list, FALSE);
510 d_list->offset = d_list->choice;
511 f_list->offset = f_list->choice;
518 usable_state(int state, LIST * dirs, LIST * files)
524 result = (dirs->win != 0) && (data_of(dirs) != 0);
527 result = (files->win != 0) && (data_of(files) != 0);
536 #define which_list() ((state == sFILES) \
538 : ((state == sDIRS) \
541 #define NAVIGATE_BINDINGS \
542 DLG_KEYS_DATA( DLGK_FIELD_NEXT, KEY_RIGHT ), \
543 DLG_KEYS_DATA( DLGK_FIELD_NEXT, TAB ), \
544 DLG_KEYS_DATA( DLGK_FIELD_PREV, KEY_BTAB ), \
545 DLG_KEYS_DATA( DLGK_ITEM_NEXT, KEY_DOWN ), \
546 DLG_KEYS_DATA( DLGK_ITEM_NEXT, CHR_NEXT ), \
547 DLG_KEYS_DATA( DLGK_ITEM_NEXT, KEY_NEXT ), \
548 DLG_KEYS_DATA( DLGK_ITEM_PREV, CHR_PREVIOUS ), \
549 DLG_KEYS_DATA( DLGK_ITEM_PREV, KEY_UP ), \
550 DLG_KEYS_DATA( DLGK_PAGE_NEXT, KEY_NPAGE ), \
551 DLG_KEYS_DATA( DLGK_PAGE_PREV, KEY_PPAGE )
554 * Display a dialog box for entering a filename
557 dlg_fselect(const char *title, const char *path, int height, int width, int dselect)
560 static DLG_KEYS_BINDING binding[] = {
567 static DLG_KEYS_BINDING binding2[] = {
578 int old_height = height;
579 int old_width = width;
580 bool resized = FALSE;
582 int tbox_y, tbox_x, tbox_width, tbox_height;
583 int dbox_y, dbox_x, dbox_width, dbox_height;
584 int fbox_y, fbox_x, fbox_width, fbox_height;
585 int show_buttons = TRUE;
590 int result = DLG_EXIT_UNKNOWN;
591 int state = dialog_vars.default_button >= 0 ? dlg_default_button() : sTEXT;
593 bool first = (state == sTEXT);
594 bool first_trace = TRUE;
597 char current[MAX_LEN + 1];
601 const char **buttons = dlg_ok_labels();
602 const char *d_label = _("Directories");
603 const char *f_label = _("Files");
605 int min_wide = MIN_WIDE;
606 int min_items = height ? 0 : 4;
609 DLG_TRACE(("# %s args:\n", dselect ? "dselect" : "fselect"));
610 DLG_TRACE2S("title", title);
611 DLG_TRACE2S("path", path);
612 DLG_TRACE2N("height", height);
613 DLG_TRACE2N("width", width);
617 /* Set up the initial value */
618 input = dlg_set_result(path);
619 offset = (int) strlen(input);
622 dlg_button_layout(buttons, &min_wide);
627 dlg_auto_size(title, (char *) 0, &height, &width, 6, 25);
628 height += MIN_HIGH + min_items;
629 if (width < min_wide)
631 dlg_print_size(height, width);
632 dlg_ctl_size(height, width);
634 dialog = dlg_new_window(height, width,
635 dlg_box_y_ordinate(height),
636 dlg_box_x_ordinate(width));
637 dlg_register_window(dialog, "fselect", binding);
638 dlg_register_buttons(dialog, "fselect", buttons);
640 dlg_mouse_setbase(0, 0);
642 dlg_draw_box2(dialog, 0, 0, height, width, dialog_attr, border_attr, border2_attr);
643 dlg_draw_bottom_box2(dialog, border_attr, border2_attr, dialog_attr);
644 dlg_draw_title(dialog, title);
646 dlg_attrset(dialog, dialog_attr);
648 /* Draw the input field box */
650 tbox_width = width - (4 * MARGIN + 2);
651 tbox_y = height - (BTN_HIGH * 2) + MARGIN;
652 tbox_x = (width - tbox_width) / 2;
654 w_text = derwin(dialog, tbox_height, tbox_width, tbox_y, tbox_x);
656 result = DLG_EXIT_ERROR;
660 (void) keypad(w_text, TRUE);
661 dlg_draw_box(dialog, tbox_y - MARGIN, tbox_x - MARGIN,
662 (2 * MARGIN + 1), tbox_width + (MARGIN + EXT_WIDE),
663 menubox_border_attr, menubox_border2_attr);
664 dlg_mouse_mkbigregion(getbegy(dialog) + tbox_y - MARGIN,
665 getbegx(dialog) + tbox_x - MARGIN,
667 tbox_width + (MARGIN + EXT_WIDE),
668 MOUSE_T, 1, 1, 3 /* doesn't matter */ );
670 dlg_register_window(w_text, "fselect2", binding2);
672 /* Draw the directory listing box */
674 dbox_width = (width - (6 * MARGIN));
676 dbox_width = (width - (6 * MARGIN + 2 * EXT_WIDE)) / 2;
677 dbox_height = height - MIN_HIGH;
678 dbox_y = (2 * MARGIN + 1);
681 w_work = derwin(dialog, dbox_height, dbox_width, dbox_y, dbox_x);
683 result = DLG_EXIT_ERROR;
687 (void) keypad(w_work, TRUE);
688 (void) mvwaddstr(dialog, dbox_y - (MARGIN + 1), dbox_x - MARGIN, d_label);
690 dbox_y - MARGIN, dbox_x - MARGIN,
691 dbox_height + (MARGIN + 1), dbox_width + (MARGIN + 1),
692 menubox_border_attr, menubox_border2_attr);
693 init_list(&d_list, dialog, w_work, MOUSE_D);
696 /* Draw the filename listing box */
697 fbox_height = dbox_height;
698 fbox_width = dbox_width;
700 fbox_x = tbox_x + dbox_width + (2 * MARGIN);
702 w_work = derwin(dialog, fbox_height, fbox_width, fbox_y, fbox_x);
704 result = DLG_EXIT_ERROR;
708 (void) keypad(w_work, TRUE);
709 (void) mvwaddstr(dialog, fbox_y - (MARGIN + 1), fbox_x - MARGIN, f_label);
711 fbox_y - MARGIN, fbox_x - MARGIN,
712 fbox_height + (MARGIN + 1), fbox_width + (MARGIN + 1),
713 menubox_border_attr, menubox_border2_attr);
714 init_list(&f_list, dialog, w_work, MOUSE_F);
716 memset(&f_list, 0, sizeof(f_list));
719 while (result == DLG_EXIT_UNKNOWN) {
721 if (fill_lists(current, input, &d_list, &f_list, state < sTEXT))
727 dlg_show_string(w_text, input, offset, inputbox_attr,
728 0, 0, tbox_width, FALSE, first);
733 * The last field drawn determines where the cursor is shown:
736 show_buttons = FALSE;
737 button = (state < 0) ? 0 : state;
738 dlg_draw_buttons(dialog, height - 2, 0, buttons, button, FALSE, width);
743 dlg_trace_win(dialog);
749 dlg_set_focus(dialog, w_text);
752 dlg_set_focus(dialog, f_list.win);
755 dlg_set_focus(dialog, d_list.win);
761 (void) wrefresh(dialog);
765 key = dlg_mouse_wgetch((state == sTEXT) ? w_text : dialog, &fkey);
766 if (dlg_result_key(key, fkey, &result))
770 if (key == DLGK_TOGGLE) {
777 case DLGK_MOUSE(KEY_PREVIOUS):
779 scroll_list(-1, which_list());
781 case DLGK_MOUSE(KEY_NEXT):
783 scroll_list(1, which_list());
785 case DLGK_MOUSE(KEY_PPAGE):
787 scroll_list(-1, which_list());
789 case DLGK_MOUSE(KEY_NPAGE):
791 scroll_list(1, which_list());
794 scroll_list(-1, which_list());
797 scroll_list(1, which_list());
800 if (change_list(-1, which_list()))
803 case DLGK_FIELD_PREV:
806 state = dlg_prev_ok_buttonindex(state, sDIRS);
807 } while (!usable_state(state, &d_list, &f_list));
810 if (change_list(1, which_list()))
813 case DLGK_FIELD_NEXT:
816 state = dlg_next_ok_buttonindex(state, sDIRS);
817 } while (!usable_state(state, &d_list, &f_list));
825 if (state == sFILES && !dselect) {
826 completed = data_of(&f_list);
827 } else if (state == sDIRS) {
828 completed = data_of(&d_list);
830 if (complete(input, &d_list, &f_list, &partial)) {
834 if (completed != 0) {
837 strcpy(leaf_of(input), completed);
838 offset = (int) strlen(input);
839 dlg_show_string(w_text, input, offset, inputbox_attr,
840 0, 0, tbox_width, 0, first);
841 if (partial != NULL) {
846 } else { /* if (state < sTEXT) */
852 result = (state > 0) ? dlg_enter_buttoncode(state) : DLG_EXIT_OK;
856 dlg_will_resize(dialog);
865 dlg_del_window(dialog);
867 dlg_mouse_free_regions();
871 if (key >= DLGK_MOUSE(MOUSE_T)) {
874 } else if (key >= DLGK_MOUSE(MOUSE_F)) {
875 if (f_list.win != 0) {
877 f_list.choice = (key - DLGK_MOUSE(MOUSE_F)) + f_list.offset;
878 display_list(&f_list);
881 } else if (key >= DLGK_MOUSE(MOUSE_D)) {
882 if (d_list.win != 0) {
884 d_list.choice = (key - DLGK_MOUSE(MOUSE_D)) + d_list.offset;
885 display_list(&d_list);
888 } else if (is_DLGK_MOUSE(key)
889 && (code = dlg_ok_buttoncode(key - M_EVENT)) >= 0) {
897 if (state < 0) { /* Input box selected if we're editing */
898 int edit = dlg_edit_string(input, &offset, key, fkey, first);
901 dlg_show_string(w_text, input, offset, inputbox_attr,
902 0, 0, tbox_width, 0, first);
906 } else if (state >= 0 &&
907 (code = dlg_char_to_button(key, buttons)) >= 0) {
908 result = dlg_ok_buttoncode(code);
913 dlg_unregister_window(w_text);
914 dlg_del_window(dialog);
915 dlg_mouse_free_regions();
916 free_list(&d_list, FALSE);
917 free_list(&f_list, FALSE);
926 * Display a dialog box for entering a filename
929 dialog_fselect(const char *title, const char *path, int height, int width)
931 return dlg_fselect(title, path, height, width, FALSE);
935 * Display a dialog box for entering a directory
938 dialog_dselect(const char *title, const char *path, int height, int width)
940 return dlg_fselect(title, path, height, width, TRUE);