2 * $Id: formbox.c,v 1.103 2021/01/17 22:19:05 tom Exp $
4 * formbox.c -- implements the form (i.e., some pairs label/editbox)
6 * Copyright 2003-2020,2021 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.
23 * This is adapted from source contributed by
24 * Valery Reznic (valery_reznic@users.sourceforge.net)
30 #define LLEN(n) ((n) * FORMBOX_TAGS)
32 #define ItemName(i) items[LLEN(i) + 0]
33 #define ItemNameY(i) items[LLEN(i) + 1]
34 #define ItemNameX(i) items[LLEN(i) + 2]
35 #define ItemText(i) items[LLEN(i) + 3]
36 #define ItemTextY(i) items[LLEN(i) + 4]
37 #define ItemTextX(i) items[LLEN(i) + 5]
38 #define ItemTextFLen(i) items[LLEN(i) + 6]
39 #define ItemTextILen(i) items[LLEN(i) + 7]
40 #define ItemHelp(i) (dialog_vars.item_help ? items[LLEN(i) + 8] : dlg_strempty())
43 is_readonly(DIALOG_FORMITEM * item)
45 return ((item->type & 2) != 0) || (item->text_flen <= 0);
49 is_hidden(DIALOG_FORMITEM * item)
51 return ((item->type & 1) != 0);
55 in_window(WINDOW *win, int scrollamt, int y)
57 return (y >= scrollamt && y - scrollamt < getmaxy(win));
61 ok_move(WINDOW *win, int scrollamt, int y, int x)
63 return in_window(win, scrollamt, y)
64 && (wmove(win, y - scrollamt, x) != ERR);
68 move_past(WINDOW *win, int y, int x)
70 if (wmove(win, y, x) == ERR)
71 wmove(win, y, getmaxx(win) - 1);
78 print_item(WINDOW *win, DIALOG_FORMITEM * item, int scrollamt, bool choice)
83 if (ok_move(win, scrollamt, item->name_y, item->name_x)) {
85 len = MIN(len, getmaxx(win) - item->name_x);
91 item->name_y - scrollamt,
96 move_past(win, item->name_y - scrollamt, item->name_x + len);
100 if (item->text_len && ok_move(win, scrollamt, item->text_y, item->text_x)) {
101 chtype this_item_attribute;
103 len = item->text_len;
104 len = MIN(len, getmaxx(win) - item->text_x);
106 if (!is_readonly(item)) {
107 this_item_attribute = choice
108 ? form_active_text_attr
111 this_item_attribute = form_item_readonly_attr;
119 item->text_y - scrollamt,
124 move_past(win, item->text_y - scrollamt, item->text_x + len);
132 * Print the entire form.
135 print_form(WINDOW *win, DIALOG_FORMITEM * item, int total, int scrollamt, int choice)
140 for (n = 0; n < total; ++n) {
141 count += print_item(win, item + n, scrollamt, n == choice);
144 wbkgdset(win, menubox_attr | ' ');
146 (void) wnoutrefresh(win);
151 set_choice(DIALOG_FORMITEM item[], int choice, int item_no, bool * noneditable)
155 *noneditable = FALSE;
156 if (!is_readonly(&item[choice])) {
161 for (i = 0; i < item_no; i++) {
162 if (!is_readonly(&(item[i]))) {
176 * Find the last y-value in the form.
179 form_limit(DIALOG_FORMITEM item[])
183 for (n = 0; item[n].name != 0; ++n) {
184 if (limit < item[n].name_y)
185 limit = item[n].name_y;
186 if (limit < item[n].text_y)
187 limit = item[n].text_y;
193 is_first_field(DIALOG_FORMITEM item[], int choice)
196 while (choice >= 0) {
197 if (item[choice].text_flen > 0) {
207 is_last_field(DIALOG_FORMITEM item[], int choice, int item_no)
210 while (choice < item_no) {
211 if (item[choice].text_flen > 0) {
221 * Tab to the next field.
224 tab_next(WINDOW *win,
225 DIALOG_FORMITEM item[],
231 int old_choice = *choice;
232 int old_scroll = *scrollamt;
233 bool wrapped = FALSE;
239 *choice = item_no - 1;
241 } else if (*choice >= item_no) {
245 } while ((*choice != old_choice) && is_readonly(&(item[*choice])));
247 if (item[*choice].text_flen > 0) {
248 int lo = MIN(item[*choice].name_y, item[*choice].text_y);
249 int hi = MAX(item[*choice].name_y, item[*choice].text_y);
251 if (old_choice == *choice)
253 print_item(win, item + old_choice, *scrollamt, FALSE);
255 if (*scrollamt < lo + 1 - getmaxy(win))
256 *scrollamt = lo + 1 - getmaxy(win);
260 * If we have to scroll to show a wrap-around, it does get
261 * confusing. Just give up rather than scroll. Tab'ing to the
262 * next field in a multi-column form is a different matter. Scroll
265 if (*scrollamt != old_scroll) {
268 *scrollamt = old_scroll;
269 *choice = old_choice;
272 wscrl(win, *scrollamt - old_scroll);
273 scrollok(win, FALSE);
278 } while (*choice != old_choice);
280 return (old_choice != *choice) || (old_scroll != *scrollamt);
284 * Scroll to the next page, putting the choice at the first editable field
285 * in that page. Note that fields are not necessarily in top-to-bottom order,
286 * nor is there necessarily a field on each row of the window.
289 scroll_next(WINDOW *win, DIALOG_FORMITEM item[], int stepsize, int *choice, int *scrollamt)
292 int old_choice = *choice;
293 int old_scroll = *scrollamt;
294 int old_row = MIN(item[old_choice].text_y, item[old_choice].name_y);
295 int target = old_scroll + stepsize;
298 if (old_row != old_scroll)
301 target = old_scroll + stepsize;
306 if (target > form_limit(item)) {
314 for (n = 0; item[n].name != 0; ++n) {
315 if (item[n].text_flen > 0) {
316 int new_row = MIN(item[n].text_y, item[n].name_y);
317 if (abs(new_row - target) < abs(old_row - target)) {
324 if (old_choice != *choice)
325 print_item(win, item + old_choice, *scrollamt, FALSE);
327 *scrollamt = *choice;
328 if (*scrollamt != old_scroll) {
330 wscrl(win, *scrollamt - old_scroll);
331 scrollok(win, FALSE);
333 result = (old_choice != *choice) || (old_scroll != *scrollamt);
341 * Do a sanity check on the field length, and return the "right" value.
344 real_length(DIALOG_FORMITEM * item)
346 return (item->text_flen > 0
348 : (item->text_flen < 0
354 * Compute the form size, setup field buffers.
357 make_FORM_ELTs(DIALOG_FORMITEM * item,
366 for (i = 0; i < item_no; ++i) {
367 int real_len = real_length(item + i);
370 * Special value '0' for text_flen: no input allowed
371 * Special value '0' for text_ilen: 'be the same as text_flen'
373 if (item[i].text_ilen == 0)
374 item[i].text_ilen = real_len;
376 min_h = MAX(min_h, item[i].name_y + 1);
377 min_h = MAX(min_h, item[i].text_y + 1);
378 min_w = MAX(min_w, item[i].name_x + 1 + item[i].name_len);
379 min_w = MAX(min_w, item[i].text_x + 1 + real_len);
381 item[i].text_len = real_length(item + i);
384 * We do not know the actual length of .text, so we allocate it here
385 * to ensure it is big enough.
387 if (item[i].text_flen > 0) {
388 int max_len = dlg_max_input(MAX(item[i].text_ilen + 1, MAX_LEN));
389 char *old_text = item[i].text;
391 item[i].text = dlg_malloc(char, (size_t) max_len + 1);
392 assert_ptr(item[i].text, "make_FORM_ELTs");
394 sprintf(item[i].text, "%.*s", item[i].text_ilen, old_text);
396 if (item[i].text_free) {
399 item[i].text_free = TRUE;
408 dlg_default_formitem(DIALOG_FORMITEM * items)
412 if (dialog_vars.default_item != 0) {
414 while (items->name != 0) {
415 if (!strcmp(dialog_vars.default_item, items->name)) {
429 next_valid_buttonindex(int state, int extra, bool non_editable)
431 state = dlg_next_ok_buttonindex(state, extra);
432 while (non_editable && state == sTEXT)
433 state = dlg_next_ok_buttonindex(state, sTEXT);
438 prev_valid_buttonindex(int state, int extra, bool non_editable)
440 state = dlg_prev_ok_buttonindex(state, extra);
441 while (non_editable && state == sTEXT)
442 state = dlg_prev_ok_buttonindex(state, sTEXT);
446 #define NAVIGATE_BINDINGS \
447 DLG_KEYS_DATA( DLGK_FIELD_NEXT, TAB ), \
448 DLG_KEYS_DATA( DLGK_FIELD_PREV, KEY_BTAB ), \
449 DLG_KEYS_DATA( DLGK_ITEM_NEXT, CHR_NEXT ), \
450 DLG_KEYS_DATA( DLGK_ITEM_NEXT, KEY_DOWN ), \
451 DLG_KEYS_DATA( DLGK_ITEM_NEXT, KEY_RIGHT ), \
452 DLG_KEYS_DATA( DLGK_ITEM_NEXT, KEY_NEXT ), \
453 DLG_KEYS_DATA( DLGK_ITEM_PREV, CHR_PREVIOUS ), \
454 DLG_KEYS_DATA( DLGK_ITEM_PREV, KEY_PREVIOUS ), \
455 DLG_KEYS_DATA( DLGK_ITEM_PREV, KEY_LEFT ), \
456 DLG_KEYS_DATA( DLGK_ITEM_PREV, KEY_UP ), \
457 DLG_KEYS_DATA( DLGK_PAGE_NEXT, KEY_NPAGE ), \
458 DLG_KEYS_DATA( DLGK_PAGE_PREV, KEY_PPAGE )
460 * Display a form for entering a number of fields
463 dlg_form(const char *title,
469 DIALOG_FORMITEM * items,
473 static DLG_KEYS_BINDING binding[] = {
480 static DLG_KEYS_BINDING binding2[] = {
485 /* no TOGGLEKEY_BINDINGS, since that includes space... */
491 int old_height = height;
492 int old_width = width;
497 bool first_trace = TRUE;
499 int state = (dialog_vars.default_button >= 0
500 ? dlg_default_button()
502 int x, y, cur_x, cur_y, box_x, box_y;
505 int choice = dlg_default_formitem(items);
506 int new_choice, new_scroll;
508 int result = DLG_EXIT_UNKNOWN;
509 int min_width = 0, min_height = 0;
510 bool was_autosize = (height == 0 || width == 0);
511 bool show_buttons = FALSE;
512 bool scroll_changed = FALSE;
513 bool field_changed = FALSE;
514 bool non_editable = FALSE;
515 WINDOW *dialog, *form;
517 const char **buttons = dlg_ok_labels();
518 DIALOG_FORMITEM *current;
520 DLG_TRACE(("# %sform args:\n", (dialog_vars.formitem_type
523 DLG_TRACE2S("title", title);
524 DLG_TRACE2S("message", cprompt);
525 DLG_TRACE2N("height", height);
526 DLG_TRACE2N("width", width);
527 DLG_TRACE2N("lheight", form_height);
528 DLG_TRACE2N("llength", item_no);
529 /* FIXME dump the items[][] too */
530 DLG_TRACE2N("current", *current_item);
532 make_FORM_ELTs(items, item_no, &min_height, &min_width);
533 dlg_button_layout(buttons, &min_width);
540 prompt = dlg_strclone(cprompt);
541 dlg_tab_correct_str(prompt);
542 dlg_auto_size(title, prompt, &height, &width,
544 MAX(26, 2 + min_width));
546 if (form_height == 0)
547 form_height = min_height;
550 form_height = MIN(SLINES - height, form_height);
551 height += form_height;
555 dlg_auto_size(title, prompt, &thigh, &twide, 0, width);
556 thigh = SLINES - (height - (thigh + 1 + 3 * MARGIN));
557 form_height = MIN(thigh, form_height);
560 dlg_print_size(height, width);
561 dlg_ctl_size(height, width);
563 x = dlg_box_x_ordinate(width);
564 y = dlg_box_y_ordinate(height);
566 dialog = dlg_new_window(height, width, y, x);
567 dlg_register_window(dialog, "formbox", binding);
568 dlg_register_buttons(dialog, "formbox", buttons);
570 dlg_mouse_setbase(x, y);
572 dlg_draw_box2(dialog, 0, 0, height, width, dialog_attr, border_attr, border2_attr);
573 dlg_draw_bottom_box2(dialog, border_attr, border2_attr, dialog_attr);
574 dlg_draw_title(dialog, title);
576 dlg_attrset(dialog, dialog_attr);
577 dlg_print_autowrap(dialog, prompt, height, width);
579 form_width = width - 6;
580 getyx(dialog, cur_y, cur_x);
583 box_x = (width - form_width) / 2 - 1;
585 /* create new window for the form */
586 form = dlg_sub_window(dialog, form_height, form_width, y + box_y + 1,
588 dlg_register_window(form, "formfield", binding2);
590 /* draw a box around the form items */
591 dlg_draw_box(dialog, box_y, box_x, form_height + 2, form_width + 2,
592 menubox_border_attr, menubox_border2_attr);
594 /* register the new window, along with its borders */
595 dlg_mouse_mkbigregion(getbegy(form) - getbegy(dialog),
596 getbegx(form) - getbegx(dialog),
599 KEY_MAX, 1, 1, 3 /* by cells */ );
602 scroll_changed = TRUE;
604 choice = set_choice(items, choice, item_no, &non_editable);
605 current = &items[choice];
607 state = next_valid_buttonindex(state, sTEXT, non_editable);
609 while (result == DLG_EXIT_UNKNOWN) {
613 if (scroll_changed) {
614 print_form(form, items, item_no, scrollamt, choice);
615 dlg_draw_scrollbar(dialog,
618 scrollamt + form_height + 1,
623 box_y + form_height + 1,
624 menubox_border2_attr,
625 menubox_border_attr);
626 scroll_changed = FALSE;
631 dlg_draw_buttons(dialog, height - 2, 0, buttons,
633 ? 1000 /* no such button, not highlighted */
636 show_buttons = FALSE;
641 dlg_trace_win(dialog);
644 if (field_changed || state == sTEXT) {
647 current = &items[choice];
648 dialog_vars.max_input = current->text_ilen;
649 dlg_item_help(current->help);
650 dlg_show_string(form, current->text, chr_offset,
651 form_active_text_attr,
652 current->text_y - scrollamt,
655 is_hidden(current), first);
658 field_changed = FALSE;
661 key = dlg_mouse_wgetch((state == sTEXT) ? form : dialog, &fkey);
662 if (dlg_result_key(key, fkey, &result)) {
666 /* handle non-functionkeys */
668 if (state != sTEXT) {
669 code = dlg_char_to_button(key, buttons);
671 dlg_del_window(dialog);
672 result = dlg_ok_buttoncode(code);
678 /* handle functionkeys */
680 bool do_scroll = FALSE;
685 case DLGK_MOUSE(KEY_PPAGE):
688 move_by = -form_height;
691 case DLGK_MOUSE(KEY_NPAGE):
694 move_by = form_height;
699 dlg_del_window(dialog);
700 result = (state >= 0) ? dlg_enter_buttoncode(state) : DLG_EXIT_OK;
704 result = dlg_ok_buttoncode(state);
712 if (state == sTEXT) {
717 state = prev_valid_buttonindex(state, 0, non_editable);
723 if (state == sTEXT && !is_first_field(items, choice)) {
728 int old_state = state;
729 state = prev_valid_buttonindex(state, sTEXT, non_editable);
731 if (old_state >= 0 && state == sTEXT) {
732 new_choice = item_no - 1;
733 if (choice != new_choice) {
734 print_item(form, items + choice, scrollamt, FALSE);
741 case DLGK_FIELD_PREV:
742 state = prev_valid_buttonindex(state, sTEXT, non_editable);
746 case DLGK_FIELD_NEXT:
747 state = next_valid_buttonindex(state, sTEXT, non_editable);
751 case DLGK_GRID_RIGHT:
757 if (state == sTEXT) {
762 state = next_valid_buttonindex(state, 0, non_editable);
768 if (state == sTEXT && !is_last_field(items, choice, item_no)) {
773 state = next_valid_buttonindex(state, sTEXT, non_editable);
775 if (state == sTEXT && choice) {
776 print_item(form, items + choice, scrollamt, FALSE);
784 dlg_will_resize(dialog);
789 _dlg_resize_cleanup(dialog);
790 dlg_unregister_window(form);
796 if (is_DLGK_MOUSE(key)) {
797 if (key >= DLGK_MOUSE(KEY_MAX)) {
798 int cell = key - DLGK_MOUSE(KEY_MAX);
799 int row = (cell / getmaxx(form)) + scrollamt;
800 int col = (cell % getmaxx(form));
803 for (n = 0; n < item_no; ++n) {
804 if (items[n].name_y == row
805 && items[n].name_x <= col
806 && (items[n].name_x + items[n].name_len > col
807 || (items[n].name_y == items[n].text_y
808 && items[n].text_x > col))) {
809 if (!is_readonly(&(items[n]))) {
810 field_changed = TRUE;
814 if (items[n].text_y == row
815 && items[n].text_x <= col
816 && items[n].text_x + items[n].text_ilen > col) {
817 if (!is_readonly(&(items[n]))) {
818 field_changed = TRUE;
824 print_item(form, items + choice, scrollamt, FALSE);
829 } else if ((code = dlg_ok_buttoncode(key - M_EVENT)) >= 0) {
838 new_scroll = scrollamt;
841 if (scroll_next(form, items, move_by, &new_choice, &new_scroll)) {
842 if (choice != new_choice) {
844 field_changed = TRUE;
846 if (scrollamt != new_scroll) {
847 scrollamt = new_scroll;
848 scroll_changed = TRUE;
854 if (tab_next(form, items, item_no, move_by, &new_choice, &new_scroll)) {
855 if (choice != new_choice) {
857 field_changed = TRUE;
859 if (scrollamt != new_scroll) {
860 scrollamt = new_scroll;
861 scroll_changed = TRUE;
868 if (state == sTEXT) { /* Input box selected */
869 if (!is_readonly(current))
870 edit = dlg_edit_string(current->text, &chr_offset, key,
873 dlg_show_string(form, current->text, chr_offset,
874 form_active_text_attr,
875 current->text_y - scrollamt,
878 is_hidden(current), first);
885 dlg_mouse_free_regions();
886 dlg_unregister_window(form);
887 dlg_del_window(dialog);
890 *current_item = choice;
895 * Free memory owned by a list of DIALOG_FORMITEM's.
898 dlg_free_formitems(DIALOG_FORMITEM * items)
901 for (n = 0; items[n].name != 0; ++n) {
902 if (items[n].name_free)
904 if (items[n].text_free)
906 if (items[n].help_free && items[n].help != dlg_strempty())
913 * The script accepts values beginning at 1, while curses starts at 0.
916 dlg_ordinate(const char *s)
918 int result = atoi(s);
927 dialog_form(const char *title,
938 DIALOG_FORMITEM *listitems;
939 DIALOG_VARS save_vars;
940 bool show_status = FALSE;
943 dlg_save_vars(&save_vars);
944 dialog_vars.separate_output = TRUE;
946 listitems = dlg_calloc(DIALOG_FORMITEM, (size_t) item_no + 1);
947 assert_ptr(listitems, "dialog_form");
949 for (i = 0; i < item_no; ++i) {
950 listitems[i].type = dialog_vars.formitem_type;
951 listitems[i].name = ItemName(i);
952 listitems[i].name_len = (int) strlen(ItemName(i));
953 listitems[i].name_y = dlg_ordinate(ItemNameY(i));
954 listitems[i].name_x = dlg_ordinate(ItemNameX(i));
955 listitems[i].text = ItemText(i);
956 listitems[i].text_len = (int) strlen(ItemText(i));
957 listitems[i].text_y = dlg_ordinate(ItemTextY(i));
958 listitems[i].text_x = dlg_ordinate(ItemTextX(i));
959 listitems[i].text_flen = atoi(ItemTextFLen(i));
960 listitems[i].text_ilen = atoi(ItemTextILen(i));
961 listitems[i].help = ((dialog_vars.item_help)
966 result = dlg_form(title,
976 case DLG_EXIT_OK: /* FALLTHRU */
981 dlg_add_help_formitem(&result, &help_result, &listitems[choice]);
982 show_status = dialog_vars.help_status;
983 dlg_add_string(help_result);
989 for (i = 0; i < item_no; i++) {
990 if (listitems[i].text_flen > 0) {
991 dlg_add_string(listitems[i].text);
995 dlg_add_last_key(-1);
998 dlg_free_formitems(listitems);
999 dlg_restore_vars(&save_vars);