2 * $Id: dialog.c,v 1.240 2015/09/20 23:48:54 tom Exp $
4 * cdialog - Display simple dialog boxes from shell scripts
6 * Copyright 2000-2014,2015 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 * An earlier version of this program lists as authors
24 * Savio Lam (lam836@cs.cuhk.hk)
29 #include <sys/types.h>
36 #define PASSARGS t, av, offset_add
37 #define CALLARGS const char *t, char *av[], int *offset_add
38 typedef int (callerFn
) (CALLARGS
);
160 #if defined(HAVE_XDIALOG2) || defined(HAVE_WHIPTAIL)
164 #ifdef HAVE_DLG_TRACE
170 * The bits in 'pass' are used to decide which options are applicable at
171 * different stages in the program:
172 * 1 flags before widgets
174 * 4 non-widget options
179 int pass
; /* 1,2,4 or combination */
180 const char *help
; /* NULL to suppress, non-empty to display params */
189 static bool *dialog_opts
;
190 static char **dialog_argv
;
192 static bool ignore_unknown
= FALSE
;
194 static const char *program
= "dialog";
197 * The options[] table is organized this way to make it simple to maintain
198 * a sorted list of options for the help-message.
201 static const Options options
[] = {
202 { "allow-close", o_allow_close
, 1, NULL
},
203 { "and-widget", o_and_widget
, 4, NULL
},
204 { "ascii-lines", o_ascii_lines
, 1, "" },
205 { "aspect", o_aspect
, 1, "<ratio>" },
206 { "auto-placement", o_auto_placement
, 1, NULL
},
207 { "backtitle", o_backtitle
, 1, "<backtitle>" },
208 { "beep", o_beep
, 1, "" },
209 { "beep-after", o_beep_after
, 1, "" },
210 { "begin", o_begin
, 1, "<y> <x>" },
211 { "cancel-label", o_cancel_label
, 1, "<str>" },
212 { "checklist", o_checklist
, 2, "<text> <height> <width> <list height> <tag1> <item1> <status1>..." },
213 { "clear", o_clear
, 1, "" },
214 { "colors", o_colors
, 1, "" },
215 { "column-separator",o_column_separator
, 1, "<str>" },
216 { "cr-wrap", o_cr_wrap
, 1, "" },
217 { "create-rc", o_create_rc
, 1, NULL
},
218 { "date-format", o_date_format
, 1, "<str>" },
219 { "default-button", o_default_button
, 1, "<str>" },
220 { "default-item", o_default_item
, 1, "<str>" },
221 { "defaultno", o_defaultno
, 1, "" },
222 { "exit-label", o_exit_label
, 1, "<str>" },
223 { "extra-button", o_extra_button
, 1, "" },
224 { "extra-label", o_extra_label
, 1, "<str>" },
225 { "fixed-font", o_fixed_font
, 1, NULL
},
226 { "form", o_form
, 2, "<text> <height> <width> <form height> <label1> <l_y1> <l_x1> <item1> <i_y1> <i_x1> <flen1> <ilen1>..." },
227 { "gauge", o_gauge
, 2, "<text> <height> <width> [<percent>]" },
228 { "guage", o_gauge
, 2, NULL
},
229 { "help", o_help
, 4, "" },
230 { "help-button", o_help_button
, 1, "" },
231 { "help-label", o_help_label
, 1, "<str>" },
232 { "help-status", o_help_status
, 1, "" },
233 { "help-tags", o_help_tags
, 1, "" },
234 { "hfile", o_help_file
, 1, "<str>" },
235 { "hline", o_help_line
, 1, "<str>" },
236 { "icon", o_icon
, 1, NULL
},
237 { "ignore", o_ignore
, 1, "" },
238 { "infobox", o_infobox
, 2, "<text> <height> <width>" },
239 { "input-fd", o_input_fd
, 1, "<fd>" },
240 { "inputbox", o_inputbox
, 2, "<text> <height> <width> [<init>]" },
241 { "inputmenu", o_inputmenu
, 2, "<text> <height> <width> <menu height> <tag1> <item1>..." },
242 { "insecure", o_insecure
, 1, "" },
243 { "item-help", o_item_help
, 1, "" },
244 { "keep-colors", o_keep_colors
, 1, NULL
},
245 { "keep-tite", o_keep_tite
, 1, "" },
246 { "keep-window", o_keep_window
, 1, "" },
247 { "last-key", o_last_key
, 1, "" },
248 { "max-input", o_max_input
, 1, "<n>" },
249 { "menu", o_menu
, 2, "<text> <height> <width> <menu height> <tag1> <item1>..." },
250 { "mixedform", o_mixedform
, 2, "<text> <height> <width> <form height> <label1> <l_y1> <l_x1> <item1> <i_y1> <i_x1> <flen1> <ilen1> <itype>..." },
251 { "mixedgauge", o_mixedgauge
, 2, "<text> <height> <width> <percent> <tag1> <item1>..." },
252 { "msgbox", o_msgbox
, 2, "<text> <height> <width>" },
253 { "no-cancel", o_nocancel
, 1, "" },
254 { "no-close", o_no_close
, 1, NULL
},
255 { "no-collapse", o_no_collapse
, 1, "" },
256 { "no-cr-wrap", o_no_cr_wrap
, 1, "" },
257 { "no-kill", o_no_kill
, 1, "" },
258 { "no-label", o_no_label
, 1, "<str>" },
259 { "no-lines", o_no_lines
, 1, "" },
260 { "no-mouse", o_no_mouse
, 1, "" },
261 { "no-nl-expand", o_no_nl_expand
, 1, "" },
262 { "no-ok", o_nook
, 1, "" },
263 { "no-shadow", o_no_shadow
, 1, "" },
264 { "nocancel", o_nocancel
, 1, NULL
}, /* see --no-cancel */
265 { "nook", o_nook
, 1, "" }, /* See no-ok */
266 { "ok-label", o_ok_label
, 1, "<str>" },
267 { "output-fd", o_output_fd
, 1, "<fd>" },
268 { "output-separator",o_output_separator
, 1, "<str>" },
269 { "passwordbox", o_passwordbox
, 2, "<text> <height> <width> [<init>]" },
270 { "passwordform", o_passwordform
, 2, "<text> <height> <width> <form height> <label1> <l_y1> <l_x1> <item1> <i_y1> <i_x1> <flen1> <ilen1>..." },
271 { "pause", o_pause
, 2, "<text> <height> <width> <seconds>" },
272 { "prgbox", o_prgbox
, 2, "<text> <command> <height> <width>" },
273 { "print-maxsize", o_print_maxsize
, 1, "" },
274 { "print-size", o_print_size
, 1, "" },
275 { "print-version", o_print_version
, 5, "" },
276 { "programbox", o_programbox
, 2, "<text> <height> <width>" },
277 { "progressbox", o_progressbox
, 2, "<text> <height> <width>" },
278 { "quoted", o_quoted
, 1, "" },
279 { "radiolist", o_radiolist
, 2, "<text> <height> <width> <list height> <tag1> <item1> <status1>..." },
280 { "screen-center", o_screen_center
, 1, NULL
},
281 { "scrollbar", o_scrollbar
, 1, "" },
282 { "separate-output",o_separate_output
, 1, "" },
283 { "separate-widget",o_separate_widget
, 1, "<str>" },
284 { "separator", o_separator
, 1, NULL
},
285 { "shadow", o_shadow
, 1, "" },
286 { "single-quoted", o_single_quoted
, 1, "" },
287 { "size-err", o_size_err
, 1, "" },
288 { "sleep", o_sleep
, 1, "<secs>" },
289 { "smooth", o_smooth
, 1, NULL
},
290 { "stderr", o_stderr
, 1, "" },
291 { "stdout", o_stdout
, 1, "" },
292 { "tab-correct", o_tab_correct
, 1, "" },
293 { "tab-len", o_tab_len
, 1, "<n>" },
294 { "tailbox", o_tailbox
, 2, "<file> <height> <width>" },
295 { "tailboxbg", o_tailboxbg
, 2, "<file> <height> <width>" },
296 { "textbox", o_textbox
, 2, "<file> <height> <width>" },
297 { "time-format", o_time_format
, 1, "<str>" },
298 { "timeout", o_timeout
, 1, "<secs>" },
299 { "title", o_title
, 1, "<title>" },
300 { "trim", o_trim
, 1, "" },
301 { "under-mouse", o_under_mouse
, 1, NULL
},
302 { "version", o_version
, 5, "" },
303 { "visit-items", o_visit_items
, 1, "" },
304 { "wmclass", o_wmclass
, 1, NULL
},
305 { "yes-label", o_yes_label
, 1, "<str>" },
306 { "yesno", o_yesno
, 2, "<text> <height> <width>" },
308 { "cancel-button", o_cancel_label
, 1, NULL
},
309 { "fb", o_fullbutton
, 1, NULL
},
310 { "fullbutton", o_fullbutton
, 1, NULL
},
311 { "no-button", o_no_label
, 1, NULL
},
312 { "ok-button", o_ok_label
, 1, NULL
},
313 { "scrolltext", o_scrollbar
, 1, NULL
},
314 { "topleft", o_topleft
, 1, NULL
},
315 { "yes-button", o_yes_label
, 1, NULL
},
318 { "calendar", o_calendar
, 2, "<text> <height> <width> <day> <month> <year>" },
319 { "dselect", o_dselect
, 2, "<directory> <height> <width>" },
320 { "editbox", o_editbox
, 2, "<file> <height> <width>" },
321 { "fselect", o_fselect
, 2, "<filepath> <height> <width>" },
322 { "timebox", o_timebox
, 2, "<text> <height> <width> <hour> <minute> <second>" },
325 { "buildlist", o_buildlist
, 2, "<text> <height> <width> <tag1> <item1> <status1>..." },
326 { "no-items", o_no_items
, 1, "" },
327 { "no-tags", o_no_tags
, 1, "" },
328 { "rangebox", o_rangebox
, 2, "<text> <height> <width> <min-value> <max-value> <default-value>" },
329 { "treeview", o_treeview
, 2, "<text> <height> <width> <list-height> <tag1> <item1> <status1> <depth1>..." },
331 #if defined(HAVE_XDIALOG2) || defined(HAVE_WHIPTAIL)
332 { "noitem", o_no_items
, 1, NULL
},
333 { "notags", o_no_tags
, 1, NULL
},
335 #ifdef HAVE_DLG_TRACE
336 { "trace", o_trace
, 1, "<file>" },
342 * Make an array showing which argv[] entries are options. Use "--" as a
343 * special token to escape the next argument, allowing it to begin with "--".
344 * When we find a "--" argument, also remove it from argv[] and adjust argc.
345 * That appears to be an undocumented feature of the popt library.
347 * Also, if we see a "--file", expand it into the parameter list by reading the
348 * text from the given file and stripping quotes, treating whitespace outside
349 * quotes as a parameter delimiter.
351 * Finally, if we see a "--args", dump the current list of arguments to the
352 * standard error. This is used for debugging complex --file combinations.
355 unescape_argv(int *argcp
, char ***argvp
)
358 int limit_includes
= 20 + *argcp
;
359 int count_includes
= 0;
360 bool changed
= FALSE
;
361 bool doalloc
= FALSE
;
364 dialog_opts
= dlg_calloc(bool, (size_t) *argcp
+ 1);
365 assert_ptr(dialog_opts
, "unescape_argv");
367 for (j
= 1; j
< *argcp
; j
++) {
368 bool escaped
= FALSE
;
369 if (!strcmp((*argvp
)[j
], "--")) {
371 changed
= dlg_eat_argv(argcp
, argvp
, j
, 1);
372 } else if (!strcmp((*argvp
)[j
], "--args")) {
373 fprintf(stderr
, "Showing arguments at arg%d\n", j
);
374 for (k
= 0; k
< *argcp
; ++k
) {
375 fprintf(stderr
, " arg%d:%s\n", k
, (*argvp
)[k
]);
377 changed
= dlg_eat_argv(argcp
, argvp
, j
, 1);
379 } else if (!strcmp((*argvp
)[j
], "--file")) {
380 if (++count_includes
> limit_includes
)
381 dlg_exiterr("Too many --file options");
383 if ((filename
= (*argvp
)[j
+ 1]) != 0) {
392 if (*filename
== '&') {
393 fp
= fdopen(atoi(filename
+ sizeof(char)), "r");
395 fp
= fopen(filename
, "r");
402 blob
= dlg_realloc(char, length
+ BUFSIZ
+ 1, blob
);
403 assert_ptr(blob
, "unescape_argv");
404 bytes_read
= fread(blob
+ length
,
408 length
+= bytes_read
;
410 dlg_exiterr("error on filehandle in unescape_argv");
411 } while (bytes_read
== BUFSIZ
);
416 list
= dlg_string_to_argv(blob
);
417 added
= dlg_count_argv(list
);
419 /* *argcp arguments before the expansion of --file
420 - 2 for the removal of '--file <filepath>'
421 + added for the arguments contained in <filepath>
422 + 1 for the terminating NULL pointer */
423 size_t need
= (size_t) (*argcp
+ added
- 1);
425 *argvp
= dlg_realloc(char *, need
, *argvp
);
426 assert_ptr(*argvp
, "unescape_argv");
428 char **newp
= dlg_malloc(char *, need
);
429 assert_ptr(newp
, "unescape_argv");
430 for (n
= 0; n
< *argcp
; ++n
) {
431 newp
[n
] = (*argvp
)[n
];
433 /* The new array is not NULL-terminated yet. */
437 dialog_opts
= dlg_realloc(bool, need
, dialog_opts
);
438 assert_ptr(dialog_opts
, "unescape_argv");
440 /* Shift the arguments after '--file <filepath>'
441 right by (added - 2) positions */
442 for (n
= *argcp
- 1; n
>= j
+ 2; --n
) {
443 (*argvp
)[n
+ added
- 2] = (*argvp
)[n
];
444 dialog_opts
[n
+ added
- 2] = dialog_opts
[n
];
446 } else if (added
< 2) {
447 /* 0 or 1 argument read from the included file
448 -> shift the arguments after '--file <filepath>'
449 left by (2 - added) positions */
450 for (n
= j
+ added
; n
+ 2 - added
< *argcp
; ++n
) {
451 (*argvp
)[n
] = (*argvp
)[n
+ 2 - added
];
452 dialog_opts
[n
] = dialog_opts
[n
+ 2 - added
];
455 /* Copy the inserted arguments to *argvp */
456 for (n
= 0; n
< added
; ++n
) {
457 (*argvp
)[n
+ j
] = list
[n
];
458 dialog_opts
[n
+ j
] = FALSE
;
461 (*argvp
)[*argcp
] = 0; /* Write the NULL terminator */
462 free(list
); /* No-op if 'list' is NULL */
463 /* Force rescan starting from the first inserted argument */
467 dlg_exiterr("Cannot open --file %s", filename
);
470 dlg_exiterr("No value given for --file");
475 && !strncmp((*argvp
)[j
], "--", (size_t) 2)
476 && isalpha(UCH((*argvp
)[j
][2]))) {
477 dialog_opts
[j
] = TRUE
;
481 /* if we didn't find any "--" tokens, there's no reason to do the table
482 * lookup in isOption()
488 dialog_argv
= (*argvp
);
491 #define OptionChars "\
494 abcdefghijklmnopqrstuvwxyz\
498 * Check if the given string from main's argv is an option.
501 isOption(const char *arg
)
506 if (dialog_opts
!= 0) {
508 for (n
= 1; dialog_argv
[n
] != 0; ++n
) {
509 if (dialog_argv
[n
] == arg
) {
510 result
= dialog_opts
[n
];
514 } else if (!strncmp(arg
, "--", (size_t) 2) && isalpha(UCH(arg
[2]))) {
515 if (strlen(arg
) == (strspn
) (arg
, OptionChars
)) {
518 dlg_exiterr("Invalid option \"%s\"", arg
);
526 lookupOption(const char *name
, int pass
)
529 eOptions result
= o_unknown
;
531 if (isOption(name
)) {
533 for (n
= 0; n
< sizeof(options
) / sizeof(options
[0]); n
++) {
534 if ((pass
& options
[n
].pass
) != 0
535 && !strcmp(name
, options
[n
].name
)) {
536 result
= options
[n
].code
;
545 Usage(const char *msg
)
547 dlg_exiterr("Error: %s.\nUse --help to list options.\n\n", msg
);
551 * Count arguments, stopping at the end of the argument list, or on any of our
555 arg_rest(char *argv
[])
557 int i
= 1; /* argv[0] points to a "--" token */
560 && (!isOption(argv
[i
]) || lookupOption(argv
[i
], 7) == o_unknown
))
566 * In MultiWidget this function is needed to count how many tags
567 * a widget (menu, checklist, radiolist) has
570 howmany_tags(char *argv
[], int group
)
574 const char *format
= "Expected %d arguments, found only %d";
577 while (argv
[0] != 0) {
578 if (isOption(argv
[0]))
580 if ((have
= arg_rest(argv
)) < group
) {
581 sprintf(temp
, format
, group
, have
);
593 numeric_arg(char **av
, int n
)
597 if (n
< dlg_count_argv(av
)) {
600 result
= (int) strtol(av
[n
], &last
, 10);
602 if (last
== 0 || *last
!= 0) {
603 sprintf(msg
, "Expected a number for token %d of %.20s", n
, av
[0]);
611 optional_str(char **av
, int n
, char *dft
)
614 if (arg_rest(av
) > n
)
619 #if defined(HAVE_DLG_GAUGE) || defined(HAVE_XDIALOG)
621 optional_num(char **av
, int n
, int dft
)
624 if (arg_rest(av
) > n
)
625 ret
= numeric_arg(av
, n
);
631 * On AIX 4.x, we have to flush the output right away since there is a bug in
632 * the curses package which discards stdout even when we've used newterm to
633 * redirect output to /dev/tty.
644 case DLG_EXIT_ITEM_HELP
:
645 if ((dialog_state
.output_count
> 1) && !dialog_vars
.separate_output
) {
646 fputs((dialog_state
.separate_str
647 ? dialog_state
.separate_str
648 : DEFAULT_SEPARATE_STR
),
649 dialog_state
.output
);
652 if (dialog_vars
.input_result
!= 0
653 && dialog_vars
.input_result
[0] != '\0') {
654 fputs(dialog_vars
.input_result
, dialog_state
.output
);
658 fflush(dialog_state
.output
);
666 * These are the widget callers.
673 return dialog_yesno(t
,
680 call_msgbox(CALLARGS
)
683 return dialog_msgbox(t
,
686 numeric_arg(av
, 3), 1);
690 call_infobox(CALLARGS
)
693 return dialog_msgbox(t
,
696 numeric_arg(av
, 3), 0);
700 call_textbox(CALLARGS
)
703 return dialog_textbox(t
,
712 int tags
= howmany_tags(av
+ 5, MENUBOX_TAGS
);
713 *offset_add
= 5 + tags
* MENUBOX_TAGS
;
715 return dialog_menu(t
,
724 call_inputmenu(CALLARGS
)
726 int tags
= howmany_tags(av
+ 5, MENUBOX_TAGS
);
727 bool free_extra_label
= FALSE
;
730 dialog_vars
.input_menu
= TRUE
;
732 if (dialog_vars
.max_input
== 0)
733 dialog_vars
.max_input
= MAX_LEN
/ 2;
735 if (dialog_vars
.extra_label
== 0) {
736 free_extra_label
= TRUE
;
737 dialog_vars
.extra_label
= dlg_strclone(_("Rename"));
740 dialog_vars
.extra_button
= TRUE
;
742 *offset_add
= 5 + tags
* MENUBOX_TAGS
;
743 result
= dialog_menu(t
,
749 if (free_extra_label
) {
750 free(dialog_vars
.extra_label
);
751 dialog_vars
.extra_label
= 0;
757 call_checklist(CALLARGS
)
759 int tags
= howmany_tags(av
+ 5, CHECKBOX_TAGS
);
762 *offset_add
= 5 + tags
* CHECKBOX_TAGS
;
763 code
= dialog_checklist(t
,
768 tags
, av
+ 5, FLAG_CHECK
);
773 call_radiolist(CALLARGS
)
775 int tags
= howmany_tags(av
+ 5, CHECKBOX_TAGS
);
776 *offset_add
= 5 + tags
* CHECKBOX_TAGS
;
777 return dialog_checklist(t
,
782 tags
, av
+ 5, FLAG_RADIO
);
786 call_inputbox(CALLARGS
)
788 *offset_add
= arg_rest(av
);
789 return dialog_inputbox(t
,
793 optional_str(av
, 4, 0), 0);
797 call_passwordbox(CALLARGS
)
799 *offset_add
= arg_rest(av
);
800 return dialog_inputbox(t
,
804 optional_str(av
, 4, 0), 1);
809 call_calendar(CALLARGS
)
811 *offset_add
= arg_rest(av
);
812 return dialog_calendar(t
,
816 optional_num(av
, 4, -1),
817 optional_num(av
, 5, -1),
818 optional_num(av
, 6, -1));
822 call_dselect(CALLARGS
)
824 *offset_add
= arg_rest(av
);
825 return dialog_dselect(t
,
832 call_editbox(CALLARGS
)
835 return dialog_editbox(t
,
842 call_fselect(CALLARGS
)
844 *offset_add
= arg_rest(av
);
845 return dialog_fselect(t
,
852 call_timebox(CALLARGS
)
854 *offset_add
= arg_rest(av
);
855 return dialog_timebox(t
,
859 optional_num(av
, 4, -1),
860 optional_num(av
, 5, -1),
861 optional_num(av
, 6, -1));
863 #endif /* HAVE_XDIALOG */
865 /* dialog 1.2 widgets */
868 #define DisableNoTags() \
869 bool save_no_tags = dialog_vars.no_tags; \
870 bool save_no_items = dialog_vars.no_items; \
871 dialog_vars.no_tags = TRUE; \
872 dialog_vars.no_items = FALSE
874 #define RestoreNoTags() \
875 dialog_vars.no_tags = save_no_tags; \
876 dialog_vars.no_items = save_no_items
879 call_buildlist(CALLARGS
)
881 int tags
= howmany_tags(av
+ 5, CHECKBOX_TAGS
);
886 *offset_add
= 5 + tags
* CHECKBOX_TAGS
;
887 result
= dialog_buildlist(t
,
899 call_rangebox(CALLARGS
)
903 *offset_add
= arg_rest(av
);
904 min_value
= numeric_arg(av
, 4);
905 return dialog_rangebox(t
,
911 (*offset_add
> 6) ? numeric_arg(av
, 6) : min_value
);
915 call_treeview(CALLARGS
)
917 int tags
= howmany_tags(av
+ 5, TREEVIEW_TAGS
);
922 *offset_add
= arg_rest(av
);
923 result
= dialog_treeview(t
,
928 tags
, av
+ 5, FLAG_RADIO
);
932 #endif /* HAVE_XDIALOG */
934 #ifdef HAVE_DLG_FORMBOX
938 int group
= FORMBOX_TAGS
;
939 int tags
= howmany_tags(av
+ 5, group
);
940 *offset_add
= 5 + tags
* group
;
942 return dialog_form(t
,
951 call_password_form(CALLARGS
)
953 unsigned save
= dialog_vars
.formitem_type
;
956 dialog_vars
.formitem_type
= 1;
957 result
= call_form(PASSARGS
);
958 dialog_vars
.formitem_type
= save
;
962 #endif /* HAVE_DLG_FORMBOX */
964 #ifdef HAVE_DLG_MIXEDFORM
966 call_mixed_form(CALLARGS
)
968 int group
= MIXEDFORM_TAGS
;
969 int tags
= howmany_tags(av
+ 5, group
);
970 *offset_add
= 5 + tags
* group
;
972 return dialog_mixedform(t
,
979 #endif /* HAVE_DLG_MIXEDFORM */
981 #ifdef HAVE_DLG_GAUGE
985 *offset_add
= arg_rest(av
);
986 return dialog_gauge(t
,
990 optional_num(av
, 4, 0));
996 *offset_add
= arg_rest(av
);
997 return dialog_pause(t
,
1001 numeric_arg(av
, 4));
1005 #ifdef HAVE_MIXEDGAUGE
1007 call_mixed_gauge(CALLARGS
)
1009 #define MIXEDGAUGE_BASE 5
1010 int tags
= howmany_tags(av
+ MIXEDGAUGE_BASE
, MIXEDGAUGE_TAGS
);
1011 *offset_add
= MIXEDGAUGE_BASE
+ tags
* MIXEDGAUGE_TAGS
;
1012 return dialog_mixedgauge(t
,
1017 tags
, av
+ MIXEDGAUGE_BASE
);
1021 #ifdef HAVE_DLG_GAUGE
1023 call_prgbox(CALLARGS
)
1025 *offset_add
= arg_rest(av
);
1026 /* the original version does not accept a prompt string, but for
1027 * consistency we allow it.
1029 return ((*offset_add
== 5)
1034 numeric_arg(av
, 4), TRUE
)
1039 numeric_arg(av
, 3), TRUE
));
1043 #ifdef HAVE_DLG_GAUGE
1045 call_programbox(CALLARGS
)
1049 *offset_add
= arg_rest(av
);
1050 /* this function is a compromise between --prgbox and --progressbox.
1052 result
= ((*offset_add
== 4)
1053 ? dlg_progressbox(t
,
1058 dialog_state
.pipe_input
)
1059 : dlg_progressbox(t
,
1064 dialog_state
.pipe_input
));
1065 dialog_state
.pipe_input
= 0;
1070 #ifdef HAVE_DLG_GAUGE
1072 call_progressbox(CALLARGS
)
1074 *offset_add
= arg_rest(av
);
1075 /* the original version does not accept a prompt string, but for
1076 * consistency we allow it.
1078 return ((*offset_add
== 4)
1079 ? dialog_progressbox(t
,
1083 : dialog_progressbox(t
,
1086 numeric_arg(av
, 2)));
1090 #ifdef HAVE_DLG_TAILBOX
1092 call_tailbox(CALLARGS
)
1095 return dialog_tailbox(t
,
1103 call_tailboxbg(CALLARGS
)
1106 return dialog_tailbox(t
,
1114 static const Mode modes
[] =
1116 {o_yesno
, 4, 4, call_yesno
},
1117 {o_msgbox
, 4, 4, call_msgbox
},
1118 {o_infobox
, 4, 4, call_infobox
},
1119 {o_textbox
, 4, 4, call_textbox
},
1120 {o_menu
, 6, 0, call_menu
},
1121 {o_inputmenu
, 6, 0, call_inputmenu
},
1122 {o_checklist
, 7, 0, call_checklist
},
1123 {o_radiolist
, 7, 0, call_radiolist
},
1124 {o_inputbox
, 4, 5, call_inputbox
},
1125 {o_passwordbox
, 4, 5, call_passwordbox
},
1126 #ifdef HAVE_DLG_GAUGE
1127 {o_gauge
, 4, 5, call_gauge
},
1128 {o_pause
, 5, 5, call_pause
},
1129 {o_prgbox
, 4, 5, call_prgbox
},
1130 {o_programbox
, 3, 4, call_programbox
},
1131 {o_progressbox
, 3, 4, call_progressbox
},
1133 #ifdef HAVE_DLG_FORMBOX
1134 {o_passwordform
, 13, 0, call_password_form
},
1135 {o_form
, 13, 0, call_form
},
1137 #ifdef HAVE_MIXEDGAUGE
1138 {o_mixedgauge
, MIXEDGAUGE_BASE
, 0, call_mixed_gauge
},
1140 #ifdef HAVE_DLG_MIXEDFORM
1141 {o_mixedform
, 13, 0, call_mixed_form
},
1143 #ifdef HAVE_DLG_TAILBOX
1144 {o_tailbox
, 4, 4, call_tailbox
},
1145 {o_tailboxbg
, 4, 4, call_tailboxbg
},
1148 {o_buildlist
, 4, 0, call_buildlist
},
1149 {o_calendar
, 4, 7, call_calendar
},
1150 {o_dselect
, 4, 5, call_dselect
},
1151 {o_editbox
, 4, 4, call_editbox
},
1152 {o_fselect
, 4, 5, call_fselect
},
1153 {o_rangebox
, 5, 7, call_rangebox
},
1154 {o_timebox
, 4, 7, call_timebox
},
1155 {o_treeview
, 4, 0, call_treeview
},
1161 optionString(char **argv
, int *num
)
1163 int next
= *num
+ 1;
1164 char *result
= argv
[next
];
1167 sprintf(temp
, "Expected a string-parameter for %.20s", argv
[*num
]);
1175 optionValue(char **argv
, int *num
)
1177 int next
= *num
+ 1;
1178 char *src
= argv
[next
];
1183 result
= (int) strtol(src
, &tmp
, 0);
1184 if (tmp
== 0 || *tmp
!= 0)
1190 sprintf(temp
, "Expected a numeric-parameter for %.20s", argv
[*num
]);
1197 /* Return exit-code for a named button */
1199 button_code(const char *name
)
1206 { "ok", DLG_EXIT_OK
},
1207 { "yes", DLG_EXIT_OK
},
1208 { "cancel", DLG_EXIT_CANCEL
},
1209 { "no", DLG_EXIT_CANCEL
},
1210 { "help", DLG_EXIT_HELP
},
1211 { "extra", DLG_EXIT_EXTRA
},
1215 int code
= DLG_EXIT_ERROR
;
1218 for (i
= 0; i
< (sizeof(table
) / sizeof(table
[0])); i
++) {
1219 if (!dlg_strcmp(name
, table
[i
].name
)) {
1220 code
= table
[i
].code
;
1225 if (code
== DLG_EXIT_ERROR
) {
1227 sprintf(temp
, "Button name \"%.20s\" unknown", name
);
1235 * Print parts of a message
1238 PrintList(const char *const *list
)
1240 const char *leaf
= strrchr(program
, '/');
1248 while (*list
!= 0) {
1249 fprintf(dialog_state
.output
, *list
, n
? leaf
: dialog_version());
1250 (void) fputc('\n', dialog_state
.output
);
1257 lookupMode(eOptions code
)
1259 const Mode
*modePtr
= 0;
1262 for (n
= 0; n
< sizeof(modes
) / sizeof(modes
[0]); n
++) {
1263 if (modes
[n
].code
== code
) {
1264 modePtr
= &modes
[n
];
1272 compare_opts(const void *a
, const void *b
)
1274 Options
*const *p
= (Options
* const *) a
;
1275 Options
*const *q
= (Options
* const *) b
;
1276 return strcmp((*p
)->name
, (*q
)->name
);
1280 * Print program's version.
1283 PrintVersion(FILE *fp
)
1285 fprintf(fp
, "Version: %s\n", dialog_version());
1289 * Print program help-message
1294 static const char *const tbl_1
[] =
1296 "cdialog (ComeOn Dialog!) version %s",
1297 "Copyright 2000-2014,2015 Thomas E. Dickey",
1298 "This is free software; see the source for copying conditions. There is NO",
1299 "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.",
1301 "* Display dialog boxes from shell scripts *",
1303 "Usage: %s <options> { --and-widget <options> }",
1304 "where options are \"common\" options, followed by \"box\" options",
1308 " [--create-rc \"file\"]",
1314 "Auto-size with height and width = 0. Maximize with height and width = -1.",
1315 "Global-auto-size if also menu_height/list_height = 0.",
1318 size_t limit
= sizeof(options
) / sizeof(options
[0]);
1320 const Options
**opts
;
1323 dialog_state
.output
= stdout
;
1325 opts
= dlg_calloc(const Options
*, limit
);
1326 assert_ptr(opts
, "Help");
1327 for (j
= 0; j
< limit
; ++j
) {
1328 opts
[j
] = &(options
[j
]);
1330 qsort(opts
, limit
, sizeof(Options
*), compare_opts
);
1333 fprintf(dialog_state
.output
, "Common options:\n ");
1334 for (j
= k
= 0; j
< limit
; j
++) {
1335 if ((opts
[j
]->pass
& 1)
1336 && opts
[j
]->help
!= 0) {
1337 size_t len
= 6 + strlen(opts
[j
]->name
) + strlen(opts
[j
]->help
);
1340 fprintf(dialog_state
.output
, "\n ");
1343 fprintf(dialog_state
.output
, " [--%s%s%s]", opts
[j
]->name
,
1344 *(opts
[j
]->help
) ? " " : "", opts
[j
]->help
);
1347 fprintf(dialog_state
.output
, "\nBox options:\n");
1348 for (j
= 0; j
< limit
; j
++) {
1349 if ((opts
[j
]->pass
& 2) != 0
1350 && opts
[j
]->help
!= 0
1351 && lookupMode(opts
[j
]->code
))
1352 fprintf(dialog_state
.output
, " --%-12s %s\n", opts
[j
]->name
,
1358 dlg_exit(DLG_EXIT_OK
);
1361 #ifdef HAVE_DLG_TRACE
1363 * Only the first call to dlg_trace will open a trace file. But each time
1364 * --trace is parsed, we show the whole parameter list as it is at that moment,
1365 * counting discarded parameters. The only way to capture the whole parameter
1366 * list is if --trace is the first option.
1369 process_trace_option(char **argv
, int *offset
)
1373 if (dialog_state
.trace_output
== 0) {
1374 dlg_trace(optionString(argv
, offset
));
1376 dlg_trace_msg("# ignore extra --trace option\n");
1380 dlg_trace_msg("# Parameters:\n");
1381 for (j
= 0; argv
[j
] != 0; ++j
) {
1382 dlg_trace_msg("# argv[%d] = %s\n", j
, argv
[j
]);
1388 * "Common" options apply to all widgets more/less. Most of the common options
1389 * set values in dialog_vars, a few set dialog_state and a couple write to the
1393 process_common_options(int argc
, char **argv
, int offset
, bool output
)
1397 dlg_trace_msg("# process_common_options, offset %d\n", offset
);
1399 while (offset
< argc
&& !done
) { /* Common options */
1400 dlg_trace_msg("#\targv[%d] = %s\n", offset
, argv
[offset
]);
1401 switch (lookupOption(argv
[offset
], 1)) {
1403 dialog_vars
.title
= optionString(argv
, &offset
);
1406 dialog_vars
.backtitle
= optionString(argv
, &offset
);
1408 case o_separate_widget
:
1409 dialog_state
.separate_str
= optionString(argv
, &offset
);
1411 case o_separate_output
:
1412 dialog_vars
.separate_output
= TRUE
;
1415 dialog_vars
.colors
= TRUE
;
1418 dialog_vars
.cr_wrap
= TRUE
;
1420 case o_no_nl_expand
:
1421 dialog_vars
.no_nl_expand
= TRUE
;
1424 dialog_vars
.nocollapse
= TRUE
;
1427 dialog_vars
.cant_kill
= TRUE
;
1430 dialog_vars
.nocancel
= TRUE
;
1433 dialog_vars
.nook
= TRUE
;
1436 dialog_vars
.quoted
= TRUE
;
1438 case o_single_quoted
:
1439 dialog_vars
.single_quoted
= TRUE
;
1442 dialog_vars
.size_err
= TRUE
;
1445 dialog_vars
.beep_signal
= TRUE
;
1448 dialog_vars
.beep_after_signal
= TRUE
;
1451 dialog_state
.use_scrollbar
= TRUE
;
1454 dialog_state
.use_shadow
= TRUE
;
1457 dialog_vars
.defaultno
= TRUE
;
1458 dialog_vars
.default_button
= DLG_EXIT_CANCEL
;
1460 case o_default_button
:
1461 dialog_vars
.default_button
= button_code(optionString(argv
, &offset
));
1462 dialog_vars
.defaultno
= dialog_vars
.default_button
== DLG_EXIT_CANCEL
;
1464 case o_default_item
:
1465 dialog_vars
.default_item
= optionString(argv
, &offset
);
1468 dialog_vars
.insecure
= TRUE
;
1471 dialog_vars
.item_help
= TRUE
;
1474 dialog_vars
.help_line
= optionString(argv
, &offset
);
1477 dialog_vars
.help_file
= optionString(argv
, &offset
);
1480 dialog_vars
.help_button
= TRUE
;
1483 dialog_vars
.help_status
= TRUE
;
1486 dialog_vars
.help_tags
= TRUE
;
1488 case o_extra_button
:
1489 dialog_vars
.extra_button
= TRUE
;
1492 ignore_unknown
= TRUE
;
1495 dialog_vars
.keep_window
= TRUE
;
1498 dialog_vars
.last_key
= TRUE
;
1501 dialog_state
.use_shadow
= FALSE
;
1504 dialog_vars
.print_siz
= TRUE
;
1506 case o_print_maxsize
:
1509 * If this is the last option, we do not want any error
1510 * messages - just our output. Calling end_dialog() cancels
1511 * the refresh() at the end of the program as well.
1513 if (argv
[offset
+ 1] == 0) {
1514 ignore_unknown
= TRUE
;
1517 fflush(dialog_state
.output
);
1518 fprintf(dialog_state
.output
, "MaxSize: %d, %d\n", SLINES
, SCOLS
);
1521 case o_print_version
:
1523 PrintVersion(dialog_state
.output
);
1527 case o_output_separator
:
1528 dialog_vars
.output_separator
= optionString(argv
, &offset
);
1530 case o_column_separator
:
1531 dialog_vars
.column_separator
= optionString(argv
, &offset
);
1534 dialog_vars
.tab_correct
= TRUE
;
1537 dialog_vars
.sleep_secs
= optionValue(argv
, &offset
);
1540 dialog_vars
.timeout_secs
= optionValue(argv
, &offset
);
1543 dialog_vars
.max_input
= optionValue(argv
, &offset
);
1546 dialog_state
.tab_len
= optionValue(argv
, &offset
);
1549 dialog_vars
.trim_whitespace
= TRUE
;
1552 dialog_state
.visit_items
= TRUE
;
1553 dialog_state
.visit_cols
= 1;
1556 dialog_state
.aspect_ratio
= optionValue(argv
, &offset
);
1559 dialog_vars
.begin_set
= TRUE
;
1560 dialog_vars
.begin_y
= optionValue(argv
, &offset
);
1561 dialog_vars
.begin_x
= optionValue(argv
, &offset
);
1564 dialog_vars
.dlg_clear_screen
= TRUE
;
1567 dialog_vars
.yes_label
= optionString(argv
, &offset
);
1570 dialog_vars
.no_label
= optionString(argv
, &offset
);
1573 dialog_vars
.ok_label
= optionString(argv
, &offset
);
1575 case o_cancel_label
:
1576 dialog_vars
.cancel_label
= optionString(argv
, &offset
);
1579 dialog_vars
.extra_label
= optionString(argv
, &offset
);
1582 dialog_vars
.exit_label
= optionString(argv
, &offset
);
1585 dialog_vars
.help_label
= optionString(argv
, &offset
);
1588 dialog_vars
.date_format
= optionString(argv
, &offset
);
1591 dialog_vars
.time_format
= optionString(argv
, &offset
);
1594 dialog_vars
.keep_tite
= TRUE
;
1597 dialog_vars
.ascii_lines
= TRUE
;
1598 dialog_vars
.no_lines
= FALSE
;
1601 dialog_vars
.no_lines
= TRUE
;
1602 dialog_vars
.ascii_lines
= FALSE
;
1605 dialog_state
.no_mouse
= TRUE
;
1608 #ifdef HAVE_WHIPTAIL
1610 dialog_vars
.begin_set
= TRUE
;
1611 dialog_vars
.begin_y
= 0;
1612 dialog_vars
.begin_x
= 0;
1618 /* options of Xdialog which we ignore */
1621 (void) optionString(argv
, &offset
);
1624 case o_auto_placement
:
1629 case o_screen_center
:
1637 default: /* no more common options */
1640 #ifdef HAVE_DLG_TRACE
1642 process_trace_option(argv
, &offset
);
1645 #if defined(HAVE_XDIALOG2) || defined(HAVE_WHIPTAIL)
1647 dialog_vars
.no_items
= TRUE
;
1650 dialog_vars
.no_tags
= TRUE
;
1661 * Initialize options at the start of a series of common options culminating
1665 init_result(char *buffer
)
1667 static bool first
= TRUE
;
1668 static char **special_argv
= 0;
1669 static int special_argc
= 0;
1671 dlg_trace_msg("# init_result\n");
1673 /* clear everything we do not save for the next widget */
1674 memset(&dialog_vars
, 0, sizeof(dialog_vars
));
1676 dialog_vars
.input_result
= buffer
;
1677 dialog_vars
.input_result
[0] = '\0';
1679 dialog_vars
.default_button
= -1;
1682 * The first time this is called, check for common options given by an
1683 * environment variable.
1686 char *env
= getenv("DIALOGOPTS");
1688 env
= dlg_strclone(env
);
1690 special_argv
= dlg_string_to_argv(env
);
1691 special_argc
= dlg_count_argv(special_argv
);
1697 * If we are not checking memory leaks, just do the parse of the
1700 if (special_argv
!= 0) {
1701 process_common_options(special_argc
, special_argv
, 0, FALSE
);
1703 free(special_argv
[0]);
1713 main(int argc
, char *argv
[])
1716 bool esc_pressed
= FALSE
;
1717 bool keep_tite
= FALSE
;
1720 int retval
= DLG_EXIT_OK
;
1723 const Mode
*modePtr
;
1724 char my_buffer
[MAX_LEN
+ 1];
1726 memset(&dialog_state
, 0, sizeof(dialog_state
));
1727 memset(&dialog_vars
, 0, sizeof(dialog_vars
));
1729 #if defined(ENABLE_NLS)
1730 /* initialize locale support */
1731 setlocale(LC_ALL
, "");
1732 bindtextdomain(NLS_TEXTDOMAIN
, LOCALEDIR
);
1733 textdomain(NLS_TEXTDOMAIN
);
1734 #elif defined(HAVE_SETLOCALE)
1735 (void) setlocale(LC_ALL
, "");
1738 unescape_argv(&argc
, &argv
);
1740 dialog_state
.output
= stderr
;
1741 dialog_state
.input
= stdin
;
1744 * Look for the last --stdout, --stderr or --output-fd option, and use
1745 * that. We can only write to one of them. If --stdout is used, that
1746 * can interfere with initializing the curses library, so we want to
1747 * know explicitly if it is used.
1749 * Also, look for any --version or --help message, processing those
1752 while (offset
< argc
) {
1754 switch (lookupOption(argv
[offset
], 7)) {
1756 dialog_state
.output
= stdout
;
1759 dialog_state
.output
= stderr
;
1762 if ((j
= optionValue(argv
, &offset
)) < 0
1763 || (dialog_state
.input
= fdopen(j
, "r")) == 0)
1764 dlg_exiterr("Cannot open input-fd\n");
1767 if ((j
= optionValue(argv
, &offset
)) < 0
1768 || (dialog_state
.output
= fdopen(j
, "w")) == 0)
1769 dlg_exiterr("Cannot open output-fd\n");
1775 dialog_state
.output
= stdout
;
1776 PrintVersion(dialog_state
.output
);
1782 #ifdef HAVE_DLG_TRACE
1785 * Process/remove the --trace option if it is the first option.
1786 * Otherwise, process it in more/less expected order as a
1790 process_trace_option(argv
, &offset
);
1801 dlg_trace_msg("# discarding %d parameters starting with argv[%d] (%s)\n",
1802 1 + offset
- base
, base
,
1804 for (j
= base
; j
< argc
; ++j
) {
1805 dialog_argv
[j
] = dialog_argv
[j
+ 1 + (offset
- base
)];
1806 if (dialog_opts
!= 0)
1807 dialog_opts
[j
] = dialog_opts
[j
+ 1 + (offset
- base
)];
1809 argc
-= (1 + offset
- base
);
1813 init_result(my_buffer
);
1816 * Dialog's output may be redirected (see above). Handle the special
1817 * case of options that only report information without interaction.
1820 switch (lookupOption(argv
[1], 7)) {
1821 case o_print_maxsize
:
1824 fflush(dialog_state
.output
);
1825 fprintf(dialog_state
.output
, "MaxSize: %d, %d\n", SLINES
, SCOLS
);
1827 case o_print_version
:
1828 PrintVersion(dialog_state
.output
);
1848 if (lookupOption(argv
[1], 7) == o_create_rc
) {
1850 sprintf(temp
, "Expected a filename for %.50s", argv
[1]);
1853 if (dlg_parse_rc() == -1) /* Read the configuration file */
1854 dlg_exiterr("dialog: dlg_parse_rc");
1855 dlg_create_rc(argv
[2]);
1860 dialog_vars
.keep_tite
= keep_tite
; /* init_result() cleared global */
1862 init_dialog(dialog_state
.input
, dialog_state
.output
);
1864 while (offset
< argc
&& !esc_pressed
) {
1865 init_result(my_buffer
);
1867 offset
= process_common_options(argc
, argv
, offset
, TRUE
);
1869 if (argv
[offset
] == NULL
) {
1872 Usage("Expected a box option");
1875 if (dialog_vars
.separate_output
) {
1876 switch (lookupOption(argv
[offset
], 2)) {
1877 #ifdef HAVE_XDIALOG2
1885 "Unexpected widget with --separate-output %.20s",
1891 if (dialog_state
.aspect_ratio
== 0)
1892 dialog_state
.aspect_ratio
= DEFAULT_ASPECT_RATIO
;
1894 dlg_put_backtitle();
1896 /* use a table to look for the requested mode, to avoid code duplication */
1899 if ((code
= lookupOption(argv
[offset
], 2)) != o_unknown
)
1900 modePtr
= lookupMode(code
);
1902 sprintf(temp
, "%s option %.20s",
1903 lookupOption(argv
[offset
], 7) != o_unknown
1910 have
= arg_rest(&argv
[offset
]);
1911 if (have
< modePtr
->argmin
) {
1912 sprintf(temp
, "Expected at least %d tokens for %.20s, have %d",
1913 modePtr
->argmin
- 1, argv
[offset
],
1917 if (modePtr
->argmax
&& have
> modePtr
->argmax
) {
1919 "Expected no more than %d tokens for %.20s, have %d",
1920 modePtr
->argmax
- 1, argv
[offset
],
1926 * Trim whitespace from non-title option values, e.g., the ones that
1927 * will be used as captions or prompts. Do that only for the widget
1928 * we are about to process, since the "--trim" option is reset before
1929 * accumulating options for each widget.
1931 for (j
= offset
+ 1; j
<= offset
+ have
; j
++) {
1932 switch (lookupOption(argv
[j
- 1], 7)) {
1941 char *argv_j
= strdup(argv
[j
]);
1943 dlg_trim_string(argv_j
);
1946 argv
[j
] = strdup("?");
1953 retval
= show_result((*(modePtr
->jumper
)) (dialog_vars
.title
,
1956 dlg_trace_msg("# widget returns %d\n", retval
);
1957 offset
+= offset_add
;
1959 if (dialog_vars
.input_result
!= my_buffer
) {
1960 free(dialog_vars
.input_result
);
1961 dialog_vars
.input_result
= 0;
1964 if (retval
== DLG_EXIT_ESC
) {
1968 if (dialog_vars
.beep_after_signal
)
1971 if (dialog_vars
.sleep_secs
)
1972 (void) napms(dialog_vars
.sleep_secs
* 1000);
1974 if (offset
< argc
) {
1975 switch (lookupOption(argv
[offset
], 7)) {
1980 sprintf(temp
, "Expected --and-widget, not %.20s",
1985 /* if we got a cancel, etc., stop chaining */
1986 if (retval
!= DLG_EXIT_OK
)
1989 dialog_vars
.dlg_clear_screen
= TRUE
;
1993 if (dialog_vars
.dlg_clear_screen
)
1998 dlg_killall_bg(&retval
);
1999 if (dialog_state
.screen_initialized
) {