2 * $Id: formbox.c,v 1.87 2013/09/02 17:02:05 tom Exp $
4 * formbox.c -- implements the form (i.e, some pairs label/editbox)
6 * Copyright 2003-2012,2013 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
)
156 *noneditable
= FALSE
;
157 if (!is_readonly(&item
[choice
])) {
160 for (i
= 0; i
< item_no
; i
++) {
161 if (!is_readonly(&(item
[i
]))) {
175 * Find the last y-value in the form.
178 form_limit(DIALOG_FORMITEM item
[])
182 for (n
= 0; item
[n
].name
!= 0; ++n
) {
183 if (limit
< item
[n
].name_y
)
184 limit
= item
[n
].name_y
;
185 if (limit
< item
[n
].text_y
)
186 limit
= item
[n
].text_y
;
192 is_first_field(DIALOG_FORMITEM item
[], int choice
)
195 while (choice
>= 0) {
196 if (item
[choice
].text_flen
> 0) {
206 is_last_field(DIALOG_FORMITEM item
[], int choice
, int item_no
)
209 while (choice
< item_no
) {
210 if (item
[choice
].text_flen
> 0) {
220 * Tab to the next field.
223 tab_next(WINDOW
*win
,
224 DIALOG_FORMITEM item
[],
230 int old_choice
= *choice
;
231 int old_scroll
= *scrollamt
;
232 bool wrapped
= FALSE
;
238 *choice
= item_no
- 1;
240 } else if (*choice
>= item_no
) {
244 } while ((*choice
!= old_choice
) && is_readonly(&(item
[*choice
])));
246 if (item
[*choice
].text_flen
> 0) {
247 int lo
= MIN(item
[*choice
].name_y
, item
[*choice
].text_y
);
248 int hi
= MAX(item
[*choice
].name_y
, item
[*choice
].text_y
);
250 if (old_choice
== *choice
)
252 print_item(win
, item
+ old_choice
, *scrollamt
, FALSE
);
254 if (*scrollamt
< lo
+ 1 - getmaxy(win
))
255 *scrollamt
= lo
+ 1 - getmaxy(win
);
259 * If we have to scroll to show a wrap-around, it does get
260 * confusing. Just give up rather than scroll. Tab'ing to the
261 * next field in a multi-column form is a different matter. Scroll
264 if (*scrollamt
!= old_scroll
) {
267 *scrollamt
= old_scroll
;
268 *choice
= old_choice
;
271 wscrl(win
, *scrollamt
- old_scroll
);
272 scrollok(win
, FALSE
);
277 } while (*choice
!= old_choice
);
279 return (old_choice
!= *choice
) || (old_scroll
!= *scrollamt
);
283 * Scroll to the next page, putting the choice at the first editable field
284 * in that page. Note that fields are not necessarily in top-to-bottom order,
285 * nor is there necessarily a field on each row of the window.
288 scroll_next(WINDOW
*win
, DIALOG_FORMITEM item
[], int stepsize
, int *choice
, int *scrollamt
)
291 int old_choice
= *choice
;
292 int old_scroll
= *scrollamt
;
293 int old_row
= MIN(item
[old_choice
].text_y
, item
[old_choice
].name_y
);
294 int target
= old_scroll
+ stepsize
;
298 if (old_row
!= old_scroll
)
301 target
= old_scroll
+ stepsize
;
306 if (target
> form_limit(item
)) {
312 for (n
= 0; item
[n
].name
!= 0; ++n
) {
313 if (item
[n
].text_flen
> 0) {
314 int new_row
= MIN(item
[n
].text_y
, item
[n
].name_y
);
315 if (abs(new_row
- target
) < abs(old_row
- target
)) {
322 if (old_choice
!= *choice
)
323 print_item(win
, item
+ old_choice
, *scrollamt
, FALSE
);
325 *scrollamt
= *choice
;
326 if (*scrollamt
!= old_scroll
) {
328 wscrl(win
, *scrollamt
- old_scroll
);
329 scrollok(win
, FALSE
);
331 result
= (old_choice
!= *choice
) || (old_scroll
!= *scrollamt
);
339 * Do a sanity check on the field length, and return the "right" value.
342 real_length(DIALOG_FORMITEM
* item
)
344 return (item
->text_flen
> 0
346 : (item
->text_flen
< 0
352 * Compute the form size, setup field buffers.
355 make_FORM_ELTs(DIALOG_FORMITEM
* item
,
364 for (i
= 0; i
< item_no
; ++i
) {
365 int real_len
= real_length(item
+ i
);
368 * Special value '0' for text_flen: no input allowed
369 * Special value '0' for text_ilen: 'be the same as text_flen'
371 if (item
[i
].text_ilen
== 0)
372 item
[i
].text_ilen
= real_len
;
374 min_h
= MAX(min_h
, item
[i
].name_y
+ 1);
375 min_h
= MAX(min_h
, item
[i
].text_y
+ 1);
376 min_w
= MAX(min_w
, item
[i
].name_x
+ 1 + item
[i
].name_len
);
377 min_w
= MAX(min_w
, item
[i
].text_x
+ 1 + real_len
);
379 item
[i
].text_len
= real_length(item
+ i
);
382 * We do not know the actual length of .text, so we allocate it here
383 * to ensure it is big enough.
385 if (item
[i
].text_flen
> 0) {
386 int max_len
= dlg_max_input(MAX(item
[i
].text_ilen
+ 1, MAX_LEN
));
387 char *old_text
= item
[i
].text
;
389 item
[i
].text
= dlg_malloc(char, (size_t) max_len
+ 1);
390 assert_ptr(item
[i
].text
, "make_FORM_ELTs");
392 sprintf(item
[i
].text
, "%.*s", item
[i
].text_ilen
, old_text
);
394 if (item
[i
].text_free
) {
395 item
[i
].text_free
= FALSE
;
398 item
[i
].text_free
= TRUE
;
407 dlg_default_formitem(DIALOG_FORMITEM
* items
)
411 if (dialog_vars
.default_item
!= 0) {
413 while (items
->name
!= 0) {
414 if (!strcmp(dialog_vars
.default_item
, items
->name
)) {
428 next_valid_buttonindex(int state
, int extra
, bool non_editable
)
430 state
= dlg_next_ok_buttonindex(state
, extra
);
431 while (non_editable
&& state
== sTEXT
)
432 state
= dlg_next_ok_buttonindex(state
, sTEXT
);
437 prev_valid_buttonindex(int state
, int extra
, bool non_editable
)
439 state
= dlg_prev_ok_buttonindex(state
, extra
);
440 while (non_editable
&& state
== sTEXT
)
441 state
= dlg_prev_ok_buttonindex(state
, sTEXT
);
445 #define NAVIGATE_BINDINGS \
446 DLG_KEYS_DATA( DLGK_FIELD_NEXT, TAB ), \
447 DLG_KEYS_DATA( DLGK_FIELD_PREV, KEY_BTAB ), \
448 DLG_KEYS_DATA( DLGK_ITEM_NEXT, CHR_NEXT ), \
449 DLG_KEYS_DATA( DLGK_ITEM_NEXT, KEY_DOWN ), \
450 DLG_KEYS_DATA( DLGK_ITEM_NEXT, KEY_NEXT ), \
451 DLG_KEYS_DATA( DLGK_ITEM_PREV, CHR_PREVIOUS ), \
452 DLG_KEYS_DATA( DLGK_ITEM_PREV, KEY_PREVIOUS ), \
453 DLG_KEYS_DATA( DLGK_ITEM_PREV, KEY_UP ), \
454 DLG_KEYS_DATA( DLGK_PAGE_NEXT, KEY_NPAGE ), \
455 DLG_KEYS_DATA( DLGK_PAGE_PREV, KEY_PPAGE )
457 * Display a form for entering a number of fields
460 dlg_form(const char *title
,
466 DIALOG_FORMITEM
* items
,
470 static DLG_KEYS_BINDING binding
[] = {
476 static DLG_KEYS_BINDING binding2
[] = {
486 int old_height
= height
;
487 int old_width
= width
;
492 int first_trace
= TRUE
;
494 int state
= dialog_vars
.default_button
>= 0 ? dlg_default_button() : sTEXT
;
495 int x
, y
, cur_x
, cur_y
, box_x
, box_y
;
499 int choice
= dlg_default_formitem(items
);
500 int new_choice
, new_scroll
;
502 int result
= DLG_EXIT_UNKNOWN
;
503 int min_width
= 0, min_height
= 0;
504 bool was_autosize
= (height
== 0 || width
== 0);
505 bool show_buttons
= FALSE
;
506 bool scroll_changed
= FALSE
;
507 bool field_changed
= FALSE
;
508 bool non_editable
= FALSE
;
509 WINDOW
*dialog
, *form
;
510 char *prompt
= dlg_strclone(cprompt
);
511 const char **buttons
= dlg_ok_labels();
512 DIALOG_FORMITEM
*current
;
514 make_FORM_ELTs(items
, item_no
, &min_height
, &min_width
);
515 dlg_button_layout(buttons
, &min_width
);
517 dlg_tab_correct_str(prompt
);
523 dlg_auto_size(title
, prompt
, &height
, &width
,
525 MAX(26, 2 + min_width
));
527 if (form_height
== 0)
528 form_height
= min_height
;
531 form_height
= MIN(SLINES
- height
, form_height
);
532 height
+= form_height
;
536 dlg_auto_size(title
, prompt
, &thigh
, &twide
, 0, width
);
537 thigh
= SLINES
- (height
- (thigh
+ 1 + 3 * MARGIN
));
538 form_height
= MIN(thigh
, form_height
);
541 dlg_print_size(height
, width
);
542 dlg_ctl_size(height
, width
);
544 x
= dlg_box_x_ordinate(width
);
545 y
= dlg_box_y_ordinate(height
);
547 dialog
= dlg_new_window(height
, width
, y
, x
);
548 dlg_register_window(dialog
, "formbox", binding
);
549 dlg_register_buttons(dialog
, "formbox", buttons
);
551 dlg_mouse_setbase(x
, y
);
553 dlg_draw_box2(dialog
, 0, 0, height
, width
, dialog_attr
, border_attr
, border2_attr
);
554 dlg_draw_bottom_box2(dialog
, border_attr
, border2_attr
, dialog_attr
);
555 dlg_draw_title(dialog
, title
);
557 (void) wattrset(dialog
, dialog_attr
);
558 dlg_print_autowrap(dialog
, prompt
, height
, width
);
560 form_width
= width
- 6;
561 getyx(dialog
, cur_y
, cur_x
);
564 box_x
= (width
- form_width
) / 2 - 1;
566 /* create new window for the form */
567 form
= dlg_sub_window(dialog
, form_height
, form_width
, y
+ box_y
+ 1,
569 dlg_register_window(form
, "formfield", binding2
);
571 /* draw a box around the form items */
572 dlg_draw_box(dialog
, box_y
, box_x
, form_height
+ 2, form_width
+ 2,
573 menubox_border_attr
, menubox_border2_attr
);
575 /* register the new window, along with its borders */
576 dlg_mouse_mkbigregion(getbegy(form
) - getbegy(dialog
),
577 getbegx(form
) - getbegx(dialog
),
580 KEY_MAX
, 1, 1, 3 /* by cells */ );
583 scroll_changed
= TRUE
;
585 choice
= set_choice(items
, choice
, item_no
, &non_editable
);
586 current
= &items
[choice
];
588 state
= next_valid_buttonindex(state
, sTEXT
, non_editable
);
590 while (result
== DLG_EXIT_UNKNOWN
) {
593 if (scroll_changed
) {
594 print_form(form
, items
, item_no
, scrollamt
, choice
);
595 dlg_draw_scrollbar(dialog
,
598 scrollamt
+ form_height
+ 1,
603 box_y
+ form_height
+ 1,
604 menubox_border2_attr
,
605 menubox_border_attr
);
606 scroll_changed
= FALSE
;
611 dlg_draw_buttons(dialog
, height
- 2, 0, buttons
,
613 ? 1000 /* no such button, not highlighted */
616 show_buttons
= FALSE
;
621 dlg_trace_win(dialog
);
624 if (field_changed
|| state
== sTEXT
) {
627 current
= &items
[choice
];
628 dialog_vars
.max_input
= current
->text_ilen
;
629 dlg_item_help(current
->help
);
630 dlg_show_string(form
, current
->text
, chr_offset
,
631 form_active_text_attr
,
632 current
->text_y
- scrollamt
,
635 is_hidden(current
), first
);
638 field_changed
= FALSE
;
641 key
= dlg_mouse_wgetch((state
== sTEXT
) ? form
: dialog
, &fkey
);
642 if (dlg_result_key(key
, fkey
, &result
))
645 /* handle non-functionkeys */
647 if (state
!= sTEXT
) {
648 code
= dlg_char_to_button(key
, buttons
);
650 dlg_del_window(dialog
);
651 result
= dlg_ok_buttoncode(code
);
661 /* handle functionkeys */
663 bool do_scroll
= FALSE
;
668 case DLGK_MOUSE(KEY_PPAGE
):
671 move_by
= -form_height
;
674 case DLGK_MOUSE(KEY_NPAGE
):
677 move_by
= form_height
;
681 dlg_del_window(dialog
);
682 result
= (state
>= 0) ? dlg_enter_buttoncode(state
) : DLG_EXIT_OK
;
690 if (state
== sTEXT
) {
695 state
= prev_valid_buttonindex(state
, 0, non_editable
);
701 if (state
== sTEXT
&& !is_first_field(items
, choice
)) {
706 int old_state
= state
;
707 state
= prev_valid_buttonindex(state
, sTEXT
, non_editable
);
709 if (old_state
>= 0 && state
== sTEXT
) {
710 new_choice
= item_no
- 1;
711 if (choice
!= new_choice
) {
712 print_item(form
, items
+ choice
, scrollamt
, FALSE
);
719 case DLGK_FIELD_PREV
:
720 state
= prev_valid_buttonindex(state
, sTEXT
, non_editable
);
724 case DLGK_FIELD_NEXT
:
725 state
= next_valid_buttonindex(state
, sTEXT
, non_editable
);
729 case DLGK_GRID_RIGHT
:
735 if (state
== sTEXT
) {
740 state
= next_valid_buttonindex(state
, 0, non_editable
);
746 if (state
== sTEXT
&& !is_last_field(items
, choice
, item_no
)) {
751 state
= next_valid_buttonindex(state
, sTEXT
, non_editable
);
753 if (state
== sTEXT
&& choice
) {
754 print_item(form
, items
+ choice
, scrollamt
, FALSE
);
767 dlg_del_window(dialog
);
769 dlg_mouse_free_regions();
774 if (is_DLGK_MOUSE(key
)) {
775 if (key
>= DLGK_MOUSE(KEY_MAX
)) {
776 int cell
= key
- DLGK_MOUSE(KEY_MAX
);
777 int row
= (cell
/ getmaxx(form
)) + scrollamt
;
778 int col
= (cell
% getmaxx(form
));
781 for (n
= 0; n
< item_no
; ++n
) {
782 if (items
[n
].name_y
== row
783 && items
[n
].name_x
<= col
784 && (items
[n
].name_x
+ items
[n
].name_len
> col
785 || (items
[n
].name_y
== items
[n
].text_y
786 && items
[n
].text_x
> col
))) {
787 if (!is_readonly(&(items
[n
]))) {
788 field_changed
= TRUE
;
792 if (items
[n
].text_y
== row
793 && items
[n
].text_x
<= col
794 && items
[n
].text_x
+ items
[n
].text_ilen
> col
) {
795 if (!is_readonly(&(items
[n
]))) {
796 field_changed
= TRUE
;
802 print_item(form
, items
+ choice
, scrollamt
, FALSE
);
807 } else if ((code
= dlg_ok_buttoncode(key
- M_EVENT
)) >= 0) {
816 new_scroll
= scrollamt
;
819 if (scroll_next(form
, items
, move_by
, &new_choice
, &new_scroll
)) {
820 if (choice
!= new_choice
) {
822 field_changed
= TRUE
;
824 if (scrollamt
!= new_scroll
) {
825 scrollamt
= new_scroll
;
826 scroll_changed
= TRUE
;
832 if (tab_next(form
, items
, item_no
, move_by
, &new_choice
, &new_scroll
)) {
833 if (choice
!= new_choice
) {
835 field_changed
= TRUE
;
837 if (scrollamt
!= new_scroll
) {
838 scrollamt
= new_scroll
;
839 scroll_changed
= TRUE
;
846 if (state
== sTEXT
) { /* Input box selected */
847 if (!is_readonly(current
))
848 edit
= dlg_edit_string(current
->text
, &chr_offset
, key
,
851 dlg_show_string(form
, current
->text
, chr_offset
,
852 form_active_text_attr
,
853 current
->text_y
- scrollamt
,
856 is_hidden(current
), first
);
863 dlg_mouse_free_regions();
864 dlg_del_window(dialog
);
867 *current_item
= choice
;
872 * Free memory owned by a list of DIALOG_FORMITEM's.
875 dlg_free_formitems(DIALOG_FORMITEM
* items
)
878 for (n
= 0; items
[n
].name
!= 0; ++n
) {
879 if (items
[n
].name_free
)
881 if (items
[n
].text_free
)
883 if (items
[n
].help_free
&& items
[n
].help
!= dlg_strempty())
890 * The script accepts values beginning at 1, while curses starts at 0.
893 dlg_ordinate(const char *s
)
895 int result
= atoi(s
);
904 dialog_form(const char *title
,
915 DIALOG_FORMITEM
*listitems
;
916 DIALOG_VARS save_vars
;
917 bool show_status
= FALSE
;
920 dlg_save_vars(&save_vars
);
921 dialog_vars
.separate_output
= TRUE
;
923 listitems
= dlg_calloc(DIALOG_FORMITEM
, (size_t) item_no
+ 1);
924 assert_ptr(listitems
, "dialog_form");
926 for (i
= 0; i
< item_no
; ++i
) {
927 listitems
[i
].type
= dialog_vars
.formitem_type
;
928 listitems
[i
].name
= ItemName(i
);
929 listitems
[i
].name_len
= (int) strlen(ItemName(i
));
930 listitems
[i
].name_y
= dlg_ordinate(ItemNameY(i
));
931 listitems
[i
].name_x
= dlg_ordinate(ItemNameX(i
));
932 listitems
[i
].text
= ItemText(i
);
933 listitems
[i
].text_len
= (int) strlen(ItemText(i
));
934 listitems
[i
].text_y
= dlg_ordinate(ItemTextY(i
));
935 listitems
[i
].text_x
= dlg_ordinate(ItemTextX(i
));
936 listitems
[i
].text_flen
= atoi(ItemTextFLen(i
));
937 listitems
[i
].text_ilen
= atoi(ItemTextILen(i
));
938 listitems
[i
].help
= ((dialog_vars
.item_help
)
943 result
= dlg_form(title
,
953 case DLG_EXIT_OK
: /* FALLTHRU */
958 dlg_add_help_formitem(&result
, &help_result
, &listitems
[choice
]);
959 show_status
= dialog_vars
.help_status
;
960 dlg_add_string(help_result
);
966 for (i
= 0; i
< item_no
; i
++) {
967 if (listitems
[i
].text_flen
> 0) {
968 dlg_add_string(listitems
[i
].text
);
972 dlg_add_last_key(-1);
975 dlg_free_formitems(listitems
);
976 dlg_restore_vars(&save_vars
);