1 if [ ! "$_DIALOG_SUBR" ]; then _DIALOG_SUBR=1
3 # Copyright (c) 2006-2015 Devin Teske
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
9 # 1. Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
11 # 2. Redistributions in binary form must reproduce the above copyright
12 # notice, this list of conditions and the following disclaimer in the
13 # documentation and/or other materials provided with the distribution.
15 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 ############################################################ INCLUDES
31 BSDCFG_SHARE="/usr/share/bsdconfig"
32 . $BSDCFG_SHARE/common.subr || exit 1
33 f_dprintf "%s: loading includes..." dialog.subr
34 f_include $BSDCFG_SHARE/strings.subr
35 f_include $BSDCFG_SHARE/variable.subr
37 BSDCFG_LIBE="/usr/libexec/bsdconfig"
38 f_include_lang $BSDCFG_LIBE/include/messages.subr
40 ############################################################ CONFIGURATION
43 # Default file descriptor to link to stdout for dialog(1) passthru allowing
44 # execution of dialog from within a sub-shell (so-long as its standard output
45 # is explicitly redirected to this file descriptor).
47 : ${DIALOG_TERMINAL_PASSTHRU_FD:=${TERMINAL_STDOUT_PASSTHRU:-3}}
49 ############################################################ GLOBALS
52 # Default name of dialog(1) utility
53 # NOTE: This is changed to "Xdialog" by the optional `-X' argument
58 # Default dialog(1) title and backtitle text
61 DIALOG_BACKTITLE="bsdconfig"
64 # Settings used while interacting with dialog(1)
66 DIALOG_MENU_TAGS="123456789ABCDEFGHIJKLMNOPQRSTUVWYZabcdefghijklmnopqrstuvwxyz"
69 # Declare that we are fully-compliant with Xdialog(1) by unset'ing all
70 # compatibility settings.
72 unset XDIALOG_HIGH_DIALOG_COMPAT
73 unset XDIALOG_FORCE_AUTOSIZE
74 unset XDIALOG_INFOBOX_TIMEOUT
77 # Exit codes for [X]dialog(1)
79 DIALOG_OK=${SUCCESS:-0}
80 DIALOG_CANCEL=${FAILURE:-1}
85 export DIALOG_ERROR=254 # sh(1) can't handle the default of `-1'
89 # Default behavior is to call f_dialog_init() automatically when loaded.
91 : ${DIALOG_SELF_INITIALIZE=1}
94 # Default terminal size (used if/when running without a controlling terminal)
96 : ${DEFAULT_TERMINAL_SIZE:=24 80}
99 # Minimum width(s) for various dialog(1) implementations (sensible global
100 # default(s) for all widgets of a given variant)
102 : ${DIALOG_MIN_WIDTH:=24}
103 : ${XDIALOG_MIN_WIDTH:=35}
106 # When manually sizing Xdialog(1) widgets such as calendar and timebox, you'll
107 # need to know the size of the embedded GUI objects because the height passed
108 # to Xdialog(1) for these widgets has to be tall enough to accomodate them.
110 # These values are helpful when manually sizing with dialog(1) too, but in a
111 # different way. dialog(1) does not make you accomodate the custom items in the
112 # height (but does for width) -- a height of 3 will display three lines and a
113 # full calendar, for example (whereas Xdialog will truncate the calendar if
114 # given a height of 3). For dialog(1), use these values for making sure that
115 # the height does not exceed max_height (obtained by f_dialog_max_size()).
117 DIALOG_CALENDAR_HEIGHT=15
118 DIALOG_TIMEBOX_HEIGHT=6
120 ############################################################ GENERIC FUNCTIONS
122 # f_dialog_data_sanitize $var_to_edit ...
124 # When using dialog(1) or Xdialog(1) sometimes unintended warnings or errors
125 # are generated from underlying libraries. For example, if $LANG is set to an
126 # invalid or unknown locale, the warnings from the Xdialog(1) libraries will
127 # clutter the output. This function helps by providing a centralied function
128 # that removes spurious warnings from the dialog(1) (or Xdialog(1)) response.
130 # Simply pass the name of one or more variables that need to be sanitized.
131 # After execution, the variables will hold their newly-sanitized data.
133 f_dialog_data_sanitize()
135 if [ "$#" -eq 0 ]; then
136 f_dprintf "%s: called with zero arguments" \
137 f_dialog_response_sanitize
142 for __var_to_edit in $*; do
143 # Skip warnings and trim leading/trailing whitespace
144 setvar $__var_to_edit "$( f_getvar $__var_to_edit | awk '
149 if ( $0 ~ /^$/ ) next
150 if ( $0 ~ /^Gdk-WARNING \*\*:/ ) next
159 # f_dialog_line_sanitize $var_to_edit ...
161 # When using dialog(1) or Xdialog(1) sometimes unintended warnings or errors
162 # are generated from underlying libraries. For example, if $LANG is set to an
163 # invalid or unknown locale, the warnings from the Xdialog(1) libraries will
164 # clutter the output. This function helps by providing a centralied function
165 # that removes spurious warnings from the dialog(1) (or Xdialog(1)) response.
167 # Simply pass the name of one or more variables that need to be sanitized.
168 # After execution, the variables will hold their newly-sanitized data.
170 # This function, unlike f_dialog_data_sanitize(), also removes leading/trailing
171 # whitespace from each line.
173 f_dialog_line_sanitize()
175 if [ "$#" -eq 0 ]; then
176 f_dprintf "%s: called with zero arguments" \
177 f_dialog_response_sanitize
182 for __var_to_edit in $*; do
183 # Skip warnings and trim leading/trailing whitespace
184 setvar $__var_to_edit "$( f_getvar $__var_to_edit | awk '
189 if ( $0 ~ /^$/ ) next
190 if ( $0 ~ /^Gdk-WARNING \*\*:/ ) next
193 sub(/^[[:space:]]*/, "")
194 sub(/[[:space:]]*$/, "")
201 ############################################################ TITLE FUNCTIONS
203 # f_dialog_title [$new_title]
205 # Set the title of future dialog(1) ($DIALOG_TITLE) or backtitle of Xdialog(1)
206 # ($DIALOG_BACKTITLE) invocations. If no arguments are given or the first
207 # argument is NULL, the current title is returned.
209 # Each time this function is called, a backup of the current values is made
210 # allowing a one-time (single-level) restoration of the previous title using
211 # the f_dialog_title_restore() function (below).
217 if [ "${1+set}" ]; then
218 if [ "$USE_XDIALOG" ]; then
219 _DIALOG_BACKTITLE="$DIALOG_BACKTITLE"
220 DIALOG_BACKTITLE="$new_title"
222 _DIALOG_TITLE="$DIALOG_TITLE"
223 DIALOG_TITLE="$new_title"
226 if [ "$USE_XDIALOG" ]; then
227 echo "$DIALOG_BACKTITLE"
234 # f_dialog_title_restore
236 # Restore the previous title set by the last call to f_dialog_title().
237 # Restoration is non-recursive and only works to restore the most-recent title.
239 f_dialog_title_restore()
241 if [ "$USE_XDIALOG" ]; then
242 DIALOG_BACKTITLE="$_DIALOG_BACKTITLE"
244 DIALOG_TITLE="$_DIALOG_TITLE"
248 # f_dialog_backtitle [$new_backtitle]
250 # Set the backtitle of future dialog(1) ($DIALOG_BACKTITLE) or title of
251 # Xdialog(1) ($DIALOG_TITLE) invocations. If no arguments are given or the
252 # first argument is NULL, the current backtitle is returned.
256 local new_backtitle="$1"
258 if [ "${1+set}" ]; then
259 if [ "$USE_XDIALOG" ]; then
260 _DIALOG_TITLE="$DIALOG_TITLE"
261 DIALOG_TITLE="$new_backtitle"
263 _DIALOG_BACKTITLE="$DIALOG_BACKTITLE"
264 DIALOG_BACKTITLE="$new_backtitle"
267 if [ "$USE_XDIALOG" ]; then
270 echo "$DIALOG_BACKTITLE"
275 # f_dialog_backtitle_restore
277 # Restore the previous backtitle set by the last call to f_dialog_backtitle().
278 # Restoration is non-recursive and only works to restore the most-recent
281 f_dialog_backtitle_restore()
283 if [ "$USE_XDIALOG" ]; then
284 DIALOG_TITLE="$_DIALOG_TITLE"
286 DIALOG_BACKTITLE="$_DIALOG_BACKTITLE"
290 ############################################################ SIZE FUNCTIONS
292 # f_dialog_max_size $var_height $var_width
294 # Get the maximum height and width for a dialog widget and store the values in
295 # $var_height and $var_width (respectively).
299 local funcname=f_dialog_max_size
300 local __var_height="$1" __var_width="$2" __max_size
301 [ "$__var_height" -o "$__var_width" ] || return $FAILURE
302 if [ "$USE_XDIALOG" ]; then
303 __max_size="$XDIALOG_MAXSIZE" # see CONFIGURATION
305 if __max_size=$( $DIALOG --print-maxsize \
306 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD )
308 f_dprintf "$funcname: %s --print-maxsize = [%s]" \
309 "$DIALOG" "$__max_size"
310 # usually "MaxSize: 24, 80"
311 __max_size="${__max_size#*: }"
312 f_replaceall "$__max_size" "," "" __max_size
314 f_eval_catch -dk __max_size $funcname stty \
315 'stty size' || __max_size=
318 : ${__max_size:=$DEFAULT_TERMINAL_SIZE}
320 if [ "$__var_height" ]; then
321 local __height="${__max_size%%[$IFS]*}"
323 # If we're not using Xdialog(1), we should assume that $DIALOG
324 # will render --backtitle behind the widget. In such a case, we
325 # should prevent a widget from obscuring the backtitle (unless
326 # $NO_BACKTITLE is set and non-NULL, allowing a trap-door).
328 if [ ! "$USE_XDIALOG" ] && [ ! "$NO_BACKTITLE" ]; then
330 # If use_shadow (in ~/.dialogrc) is OFF, we need to
331 # subtract 4, otherwise 5. However, don't check this
332 # every time, rely on an initialization variable set
333 # by f_dialog_init().
336 [ "$NO_SHADOW" ] && __adjust=4
338 # Don't adjust height if already too small (allowing
339 # obscured backtitle for small values of __height).
340 [ ${__height:-0} -gt 11 ] &&
341 __height=$(( $__height - $__adjust ))
343 setvar "$__var_height" "$__height"
345 [ "$__var_width" ] && setvar "$__var_width" "${__max_size##*[$IFS]}"
348 # f_dialog_size_constrain $var_height $var_width [$min_height [$min_width]]
350 # Modify $var_height to be no-less-than $min_height (if given; zero otherwise)
351 # and no-greater-than terminal height (or screen height if $USE_XDIALOG is
354 # Also modify $var_width to be no-less-than $XDIALOG_MIN_WIDTH (or
355 # $XDIALOG_MIN_WIDTH if $_USE_XDIALOG is set) and no-greater-than terminal
356 # or screen width. The use of $[X]DIALOG_MIN_WIDTH can be overridden by
357 # passing $min_width.
359 # Return status is success unless one of the passed arguments is invalid
360 # or all of the $var_* arguments are either NULL or missing.
362 f_dialog_size_constrain()
364 local __var_height="$1" __var_width="$2"
365 local __min_height="$3" __min_width="$4"
366 local __retval=$SUCCESS
368 # Return failure unless at least one var_* argument is passed
369 [ "$__var_height" -o "$__var_width" ] || return $FAILURE
372 # Print debug warnings if any given (non-NULL) argument are invalid
373 # NOTE: Don't change the name of $__{var,min,}{height,width}
375 local __height __width
376 local __arg __cp __fname=f_dialog_size_constrain
377 for __arg in height width; do
378 debug= f_getvar __var_$__arg __cp
379 [ "$__cp" ] || continue
380 if ! debug= f_getvar "$__cp" __$__arg; then
381 f_dprintf "%s: var_%s variable \`%s' not set" \
382 $__fname $__arg "$__cp"
384 elif ! eval f_isinteger \$__$__arg; then
385 f_dprintf "%s: var_%s variable value not a number" \
390 for __arg in height width; do
391 debug= f_getvar __min_$__arg __cp
392 [ "$__cp" ] || continue
393 f_isinteger "$__cp" && continue
394 f_dprintf "%s: min_%s value not a number" $__fname $__arg
396 setvar __min_$__arg ""
399 # Obtain maximum height and width values
400 # NOTE: Function name appended to prevent __var_{height,width} values
401 # from becoming local (and thus preventing setvar from working).
402 local __max_height_size_constain __max_width_size_constrain
404 __max_height_size_constrain __max_width_size_constrain
406 # Adjust height if desired
407 if [ "$__var_height" ]; then
408 if [ $__height -lt ${__min_height:-0} ]; then
409 setvar "$__var_height" $__min_height
410 elif [ $__height -gt $__max_height_size_constrain ]; then
411 setvar "$__var_height" $__max_height_size_constrain
415 # Adjust width if desired
416 if [ "$__var_width" ]; then
417 if [ "$USE_XDIALOG" ]; then
418 : ${__min_width:=${XDIALOG_MIN_WIDTH:-35}}
420 : ${__min_width:=${DIALOG_MIN_WIDTH:-24}}
422 if [ $__width -lt $__min_width ]; then
423 setvar "$__var_width" $__min_width
424 elif [ $__width -gt $__max_width_size_constrain ]; then
425 setvar "$__var_width" $__max_width_size_constrain
429 if [ "$debug" ]; then
430 # Print final constrained values to debugging
431 [ "$__var_height" ] && f_quietly f_getvar "$__var_height"
432 [ "$__var_width" ] && f_quietly f_getvar "$__var_width"
435 return $__retval # success if no debug warnings were printed
438 # f_dialog_menu_constrain $var_height $var_width $var_rows "$prompt" \
439 # [$min_height [$min_width [$min_rows]]]
441 # Modify $var_height to be no-less-than $min_height (if given; zero otherwise)
442 # and no-greater-than terminal height (or screen height if $USE_XDIALOG is
445 # Also modify $var_width to be no-less-than $XDIALOG_MIN_WIDTH (or
446 # $XDIALOG_MIN_WIDTH if $_USE_XDIALOG is set) and no-greater-than terminal
447 # or screen width. The use of $[X]DIALOG_MIN_WIDTH can be overridden by
448 # passing $min_width.
450 # Last, modify $var_rows to be no-less-than $min_rows (if specified; zero
451 # otherwise) and no-greater-than (max_height - 8) where max_height is the
452 # terminal height (or screen height if $USE_XDIALOG is set). If $prompt is NULL
453 # or missing, dialog(1) allows $var_rows to be (max_height - 7), maximizing the
454 # number of visible rows.
456 # Return status is success unless one of the passed arguments is invalid
457 # or all of the $var_* arguments are either NULL or missing.
459 f_dialog_menu_constrain()
461 local __var_height="$1" __var_width="$2" __var_rows="$3" __prompt="$4"
462 local __min_height="$5" __min_width="$6" __min_rows="$7"
464 # Return failure unless at least one var_* argument is passed
465 [ "$__var_height" -o "$__var_width" -o "$__var_rows" ] ||
469 # Print debug warnings if any given (non-NULL) argument are invalid
470 # NOTE: Don't change the name of $__{var,min,}{height,width,rows}
472 local __height_menu_constrain __width_menu_constrain
473 local __rows_menu_constrain
474 local __arg __cp __fname=f_dialog_menu_constrain
475 for __arg in height width rows; do
476 debug= f_getvar __var_$__arg __cp
477 [ "$__cp" ] || continue
478 if ! debug= f_getvar "$__cp" __${__arg}_menu_constrain; then
479 f_dprintf "%s: var_%s variable \`%s' not set" \
480 $__fname $__arg "$__cp"
482 elif ! eval f_isinteger \$__${__arg}_menu_constrain; then
483 f_dprintf "%s: var_%s variable value not a number" \
488 for __arg in height width rows; do
489 debug= f_getvar __min_$__arg __cp
490 [ "$__cp" ] || continue
491 f_isinteger "$__cp" && continue
492 f_dprintf "%s: min_%s value not a number" $__fname $__arg
494 setvar __min_$__arg ""
497 # Obtain maximum height and width values
498 # NOTE: Function name appended to prevent __var_{height,width} values
499 # from becoming local (and thus preventing setvar from working).
500 local __max_height_menu_constrain __max_width_menu_constrain
502 __max_height_menu_constrain __max_width_menu_constrain
504 # Adjust height if desired
505 if [ "$__var_height" ]; then
506 if [ $__height_menu_constrain -lt ${__min_height:-0} ]; then
507 setvar "$__var_height" $__min_height
508 elif [ $__height_menu_constrain -gt \
509 $__max_height_menu_constrain ]
511 setvar "$__var_height" $__max_height_menu_constrain
515 # Adjust width if desired
516 if [ "$__var_width" ]; then
517 if [ "$USE_XDIALOG" ]; then
518 : ${__min_width:=${XDIALOG_MIN_WIDTH:-35}}
520 : ${__min_width:=${DIALOG_MIN_WIDTH:-24}}
522 if [ $__width_menu_constrain -lt $__min_width ]; then
523 setvar "$__var_width" $__min_width
524 elif [ $__width_menu_constrain -gt \
525 $__max_width_menu_constrain ]
527 setvar "$__var_width" $__max_width_menu_constrain
531 # Adjust rows if desired
532 if [ "$__var_rows" ]; then
533 if [ "$USE_XDIALOG" ]; then
539 local __max_rows_menu_constrain=$((
540 $__max_height_menu_constrain - 7
542 # If prompt_len is zero (no prompt), bump the max-rows by 1
543 # Default assumption is (if no argument) that there's no prompt
544 [ ${__prompt_len:-0} -gt 0 ] || __max_rows_menu_constrain=$((
545 $__max_rows_menu_constrain + 1
548 if [ $__rows_menu_constrain -lt $__min_rows ]; then
549 setvar "$__var_rows" $__min_rows
550 elif [ $__rows_menu_constrain -gt $__max_rows_menu_constrain ]
552 setvar "$__var_rows" $__max_rows_menu_constrain
556 if [ "$debug" ]; then
557 # Print final constrained values to debugging
558 [ "$__var_height" ] && f_quietly f_getvar "$__var_height"
559 [ "$__var_width" ] && f_quietly f_getvar "$__var_width"
560 [ "$__var_rows" ] && f_quietly f_getvar "$__var_rows"
563 return $__retval # success if no debug warnings were printed
566 # f_dialog_infobox_size [-n] $var_height $var_width \
567 # $title $backtitle $prompt [$hline]
569 # Not all versions of dialog(1) perform auto-sizing of the width and height of
570 # `--infobox' boxes sensibly.
572 # This function helps solve this issue by taking two sets of sequential
573 # arguments. The first set of arguments are the variable names to use when
574 # storing the calculated height and width. The second set of arguments are the
575 # title, backtitle, prompt, and [optionally] hline. The optimal height and
576 # width for the described widget (not exceeding the actual terminal height or
577 # width) is stored in $var_height and $var_width (respectively).
579 # If the first argument is `-n', the calculated sizes ($var_height and
580 # $var_width) are not constrained to minimum/maximum values.
582 # Newline character sequences (``\n'') in $prompt are expanded as-is done by
585 f_dialog_infobox_size()
588 [ "$1" = "-n" ] && __constrain= && shift 1 # -n
589 local __var_height="$1" __var_width="$2"
590 local __title="$3" __btitle="$4" __prompt="$5" __hline="$6"
592 # Return unless at least one size aspect has been requested
593 [ "$__var_height" -o "$__var_width" ] || return $FAILURE
595 # Default height/width of zero for auto-sizing
596 local __height=0 __width=0 __n
598 # Adjust height if desired
599 if [ "$__var_height" ]; then
601 # Set height based on number of rows in prompt
603 __n=$( echo -n "$__prompt" | f_number_of_lines )
605 [ $__n -gt $__height ] && __height=$__n
608 # For Xdialog(1) bump height if backtitle is enabled (displayed
609 # in the X11 window with a separator line between the backtitle
612 if [ "$USE_XDIALOG" -a "$__btitle" ]; then
613 __n=$( echo "$__btitle" | f_number_of_lines )
614 __height=$(( $__height + $__n + 2 ))
617 setvar "$__var_height" $__height
620 # Adjust width if desired
621 if [ "$__var_width" ]; then
623 # Bump width for long titles
625 __n=$(( ${#__title} + 4 ))
626 [ $__n -gt $__width ] && __width=$__n
629 # If using Xdialog(1), bump width for long backtitles (which
630 # appear within the window).
632 if [ "$USE_XDIALOG" ]; then
633 __n=$(( ${#__btitle} + 4 ))
634 [ $__n -gt $__width ] && __width=$__n
638 # Bump width for long prompts
640 __n=$( echo "$__prompt" | f_longest_line_length )
641 __n=$(( $__n + 4 )) # add width for border
642 [ $__n -gt $__width ] && __width=$__n
645 # Bump width for long hlines. Xdialog(1) supports `--hline' but
646 # it's currently not used (so don't do anything here if using
649 if [ ! "$USE_XDIALOG" ]; then
650 __n=$(( ${#__hline} + 10 ))
651 [ $__n -gt $__width ] && __width=$__n
654 # Bump width by 16.6% if using Xdialog(1)
655 [ "$USE_XDIALOG" ] && __width=$(( $__width + $__width / 6 ))
657 setvar "$__var_width" $__width
660 # Constrain values to sensible minimums/maximums unless `-n' was passed
661 # Return success if no-constrain, else return status from constrain
662 [ ! "$__constrain" ] ||
663 f_dialog_size_constrain "$__var_height" "$__var_width"
666 # f_dialog_buttonbox_size [-n] $var_height $var_width \
667 # $title $backtitle $prompt [$hline]
669 # Not all versions of dialog(1) perform auto-sizing of the width and height of
670 # `--msgbox' and `--yesno' boxes sensibly.
672 # This function helps solve this issue by taking two sets of sequential
673 # arguments. The first set of arguments are the variable names to use when
674 # storing the calculated height and width. The second set of arguments are the
675 # title, backtitle, prompt, and [optionally] hline. The optimal height and
676 # width for the described widget (not exceeding the actual terminal height or
677 # width) is stored in $var_height and $var_width (respectively).
679 # If the first argument is `-n', the calculated sizes ($var_height and
680 # $var_width) are not constrained to minimum/maximum values.
682 # Newline character sequences (``\n'') in $prompt are expanded as-is done by
685 f_dialog_buttonbox_size()
688 [ "$1" = "-n" ] && __constrain= && shift 1 # -n
689 local __var_height="$1" __var_width="$2"
690 local __title="$3" __btitle="$4" __prompt="$5" __hline="$6"
692 # Return unless at least one size aspect has been requested
693 [ "$__var_height" -o "$__var_width" ] || return $FAILURE
695 # Calculate height/width of infobox (adjusted/constrained below)
696 # NOTE: Function name appended to prevent __var_{height,width} values
697 # from becoming local (and thus preventing setvar from working).
698 local __height_bbox_size __width_bbox_size
699 f_dialog_infobox_size -n \
700 "${__var_height:+__height_bbox_size}" \
701 "${__var_width:+__width_bbox_size}" \
702 "$__title" "$__btitle" "$__prompt" "$__hline"
704 # Adjust height if desired
705 if [ "$__var_height" ]; then
706 # Add height to accomodate the buttons
707 __height_bbox_size=$(( $__height_bbox_size + 2 ))
709 # Adjust for clipping with Xdialog(1) on Linux/GTK2
710 [ "$USE_XDIALOG" ] &&
711 __height_bbox_size=$(( $__height_bbox_size + 3 ))
713 setvar "$__var_height" $__height_bbox_size
716 # No adjustemnts to width, just pass-thru the infobox width
717 if [ "$__var_width" ]; then
718 setvar "$__var_width" $__width_bbox_size
721 # Constrain values to sensible minimums/maximums unless `-n' was passed
722 # Return success if no-constrain, else return status from constrain
723 [ ! "$__constrain" ] ||
724 f_dialog_size_constrain "$__var_height" "$__var_width"
727 # f_dialog_inputbox_size [-n] $var_height $var_width \
728 # $title $backtitle $prompt $init [$hline]
730 # Not all versions of dialog(1) perform auto-sizing of the width and height of
731 # `--inputbox' boxes sensibly.
733 # This function helps solve this issue by taking two sets of sequential
734 # arguments. The first set of arguments are the variable names to use when
735 # storing the calculated height and width. The second set of arguments are the
736 # title, backtitle, prompt, and [optionally] hline. The optimal height and
737 # width for the described widget (not exceeding the actual terminal height or
738 # width) is stored in $var_height and $var_width (respectively).
740 # If the first argument is `-n', the calculated sizes ($var_height and
741 # $var_width) are not constrained to minimum/maximum values.
743 # Newline character sequences (``\n'') in $prompt are expanded as-is done by
746 f_dialog_inputbox_size()
749 [ "$1" = "-n" ] && __constrain= && shift 1 # -n
750 local __var_height="$1" __var_width="$2"
751 local __title="$3" __btitle="$4" __prompt="$5" __init="$6" __hline="$7"
753 # Return unless at least one size aspect has been requested
754 [ "$__var_height" -o "$__var_width" ] || return $FAILURE
756 # Calculate height/width of buttonbox (adjusted/constrained below)
757 # NOTE: Function name appended to prevent __var_{height,width} values
758 # from becoming local (and thus preventing setvar from working).
759 local __height_ibox_size __width_ibox_size
760 f_dialog_buttonbox_size -n \
761 "${__var_height:+__height_ibox_size}" \
762 "${__var_width:+__width_ibox_size}" \
763 "$__title" "$__btitle" "$__prompt" "$__hline"
765 # Adjust height if desired
766 if [ "$__var_height" ]; then
767 # Add height for input box (not needed for Xdialog(1))
768 [ ! "$USE_XDIALOG" ] &&
769 __height_ibox_size=$(( $__height_ibox_size + 3 ))
771 setvar "$__var_height" $__height_ibox_size
774 # Adjust width if desired
775 if [ "$__var_width" ]; then
776 # Bump width for initial text (something neither dialog(1) nor
777 # Xdialog(1) do, but worth it!; add 16.6% if using Xdialog(1))
778 local __n=$(( ${#__init} + 7 ))
779 [ "$USE_XDIALOG" ] && __n=$(( $__n + $__n / 6 ))
780 [ $__n -gt $__width_ibox_size ] && __width_ibox_size=$__n
782 setvar "$__var_width" $__width_ibox_size
785 # Constrain values to sensible minimums/maximums unless `-n' was passed
786 # Return success if no-constrain, else return status from constrain
787 [ ! "$__constrain" ] ||
788 f_dialog_size_constrain "$__var_height" "$__var_width"
791 # f_xdialog_2inputsbox_size [-n] $var_height $var_width \
792 # $title $backtitle $prompt \
793 # $label1 $init1 $label2 $init2
795 # Xdialog(1) does not perform auto-sizing of the width and height of
796 # `--2inputsbox' boxes sensibly.
798 # This function helps solve this issue by taking two sets of sequential
799 # arguments. The first set of arguments are the variable names to use when
800 # storing the calculated height and width. The second set of arguments are the
801 # title, backtitle, prompt, label for the first field, initial text for said
802 # field, label for the second field, and initial text for said field. The
803 # optimal height and width for the described widget (not exceeding the actual
804 # terminal height or width) is stored in $var_height and $var_width
807 # If the first argument is `-n', the calculated sizes ($var_height and
808 # $var_width) are not constrained to minimum/maximum values.
810 # Newline character sequences (``\n'') in $prompt are expanded as-is done by
813 f_xdialog_2inputsbox_size()
816 [ "$1" = "-n" ] && __constrain= && shift 1 # -n
817 local __var_height="$1" __var_width="$2"
818 local __title="$3" __btitle="$4" __prompt="$5"
819 local __label1="$6" __init1="$7" __label2="$8" __init2="$9"
821 # Return unless at least one size aspect has been requested
822 [ "$__var_height" -o "$__var_width" ] || return $FAILURE
824 # Calculate height/width of inputbox (adjusted/constrained below)
825 # NOTE: Function name appended to prevent __var_{height,width} values
826 # from becoming local (and thus preventing setvar from working).
827 local __height_2ibox_size __width_2ibox_size
828 f_dialog_inputbox_size -n \
829 "${__var_height:+__height_2ibox_size}" \
830 "${__var_width:+__width_2ibox_size}" \
831 "$__title" "$__btitle" "$__prompt" "$__hline" "$__init1"
833 # Adjust height if desired
834 if [ "$__var_height" ]; then
835 # Add height for 1st label, 2nd label, and 2nd input box
836 __height_2ibox_size=$(( $__height_2ibox_size + 2 + 2 + 2 ))
837 setvar "$__var_height" $__height_2ibox_size
840 # Adjust width if desired
841 if [ "$__var_width" ]; then
844 # Bump width for first label text (+16.6% since Xdialog(1))
845 __n=$(( ${#__label1} + 7 ))
846 __n=$(( $__n + $__n / 6 ))
847 [ $__n -gt $__width_2ibox_size ] && __width_2ibox_size=$__n
849 # Bump width for second label text (+16.6% since Xdialog(1))
850 __n=$(( ${#__label2} + 7 ))
851 __n=$(( $__n + $__n / 6 ))
852 [ $__n -gt $__width_2ibox_size ] && __width_2ibox_size=$__n
854 # Bump width for 2nd initial text (something neither dialog(1)
855 # nor Xdialog(1) do, but worth it!; +16.6% since Xdialog(1))
856 __n=$(( ${#__init2} + 7 ))
857 __n=$(( $__n + $__n / 6 ))
858 [ $__n -gt $__width_2ibox_size ] && __width_2ibox_size=$__n
860 setvar "$__var_width" $__width_2ibox_size
863 # Constrain values to sensible minimums/maximums unless `-n' was passed
864 # Return success if no-constrain, else return status from constrain
865 [ ! "$__constrain" ] ||
866 f_dialog_size_constrain "$__var_height" "$__var_width"
869 # f_dialog_menu_size [-n] $var_height $var_width $var_rows \
870 # $title $backtitle $prompt $hline \
871 # $tag1 $item1 $tag2 $item2 ...
873 # Not all versions of dialog(1) perform auto-sizing of the width and height of
874 # `--menu' boxes sensibly.
876 # This function helps solve this issue by taking three sets of sequential
877 # arguments. The first set of arguments are the variable names to use when
878 # storing the calculated height, width, and rows. The second set of arguments
879 # are the title, backtitle, prompt, and hline. The [optional] third set of
880 # arguments are the menu list itself (comprised of tag/item couplets). The
881 # optimal height, width, and rows for the described widget (not exceeding the
882 # actual terminal height or width) is stored in $var_height, $var_width, and
883 # $var_rows (respectively).
885 # If the first argument is `-n', the calculated sizes ($var_height, $var_width,
886 # and $var_rows) are not constrained to minimum/maximum values.
891 [ "$1" = "-n" ] && __constrain= && shift 1 # -n
892 local __var_height="$1" __var_width="$2" __var_rows="$3"
893 local __title="$4" __btitle="$5" __prompt="$6" __hline="$7"
894 shift 7 # var_height/var_width/var_rows/title/btitle/prompt/hline
896 # Return unless at least one size aspect has been requested
897 [ "$__var_height" -o "$__var_width" -o "$__var_rows" ] ||
900 # Calculate height/width of infobox (adjusted/constrained below)
901 # NOTE: Function name appended to prevent __var_{height,width} values
902 # from becoming local (and thus preventing setvar from working).
903 local __height_menu_size __width_menu_size
904 f_dialog_infobox_size -n \
905 "${__var_height:+__height_menu_size}" \
906 "${__var_width:+__width_menu_size}" \
907 "$__title" "$__btitle" "$__prompt" "$__hline"
910 # Always process the menu-item arguments to get the longest tag-length,
911 # longest item-length (both used to bump the width), and the number of
912 # rows (used to bump the height).
914 local __longest_tag=0 __longest_item=0 __rows=0
915 while [ $# -ge 2 ]; do
916 local __tag="$1" __item="$2"
918 [ ${#__tag} -gt $__longest_tag ] && __longest_tag=${#__tag}
919 [ ${#__item} -gt $__longest_item ] && __longest_item=${#__item}
920 __rows=$(( $__rows + 1 ))
923 # Adjust rows early (for up-comning height calculation)
924 if [ "$__var_height" -o "$__var_rows" ]; then
925 # Add a row for visual aid if using Xdialog(1)
926 [ "$USE_XDIALOG" ] && __rows=$(( $__rows + 1 ))
929 # Adjust height if desired
930 if [ "$__var_height" ]; then
932 if [ "$USE_XDIALOG" ]; then
933 __height_menu_size=$((
934 $__height_menu_size + $__rows + 7 ))
936 __height_menu_size=$((
937 $__height_menu_size + $__rows + 4 ))
939 setvar "$__var_height" $__height_menu_size
942 # Adjust width if desired
943 if [ "$__var_width" ]; then
944 # The sum total between the longest tag-length and the
945 # longest item-length should be used to bump menu width
946 local __n=$(( $__longest_tag + $__longest_item + 10 ))
947 [ "$USE_XDIALOG" ] && __n=$(( $__n + $__n / 6 )) # plus 16.6%
948 [ $__n -gt $__width_menu_size ] && __width_menu_size=$__n
950 setvar "$__var_width" $__width_menu_size
953 # Store adjusted rows if desired
954 [ "$__var_rows" ] && setvar "$__var_rows" $__rows
956 # Constrain height, width, and rows to sensible minimum/maximum values
957 # Return success if no-constrain, else return status from constrain
958 [ ! "$__constrain" ] || f_dialog_menu_constrain \
959 "$__var_height" "$__var_width" "$__var_rows" "$__prompt"
962 # f_dialog_menu_with_help_size [-n] $var_height $var_width $var_rows \
963 # $title $backtitle $prompt $hline \
964 # $tag1 $item1 $help1 $tag2 $item2 $help2 ...
966 # Not all versions of dialog(1) perform auto-sizing of the width and height of
967 # `--menu' boxes sensibly.
969 # This function helps solve this issue by taking three sets of sequential
970 # arguments. The first set of arguments are the variable names to use when
971 # storing the calculated height, width, and rows. The second set of arguments
972 # are the title, backtitle, prompt, and hline. The [optional] third set of
973 # arguments are the menu list itself (comprised of tag/item/help triplets). The
974 # optimal height, width, and rows for the described widget (not exceeding the
975 # actual terminal height or width) is stored in $var_height, $var_width, and
976 # $var_rows (respectively).
978 # If the first argument is `-n', the calculated sizes ($var_height, $var_width,
979 # and $var_rows) are not constrained to minimum/maximum values.
981 f_dialog_menu_with_help_size()
984 [ "$1" = "-n" ] && __constrain= && shift 1 # -n
985 local __var_height="$1" __var_width="$2" __var_rows="$3"
986 local __title="$4" __btitle="$5" __prompt="$6" __hline="$7"
987 shift 7 # var_height/var_width/var_rows/title/btitle/prompt/hline
989 # Return unless at least one size aspect has been requested
990 [ "$__var_height" -o "$__var_width" -o "$__var_rows" ] ||
993 # Calculate height/width of infobox (adjusted/constrained below)
994 # NOTE: Function name appended to prevent __var_{height,width} values
995 # from becoming local (and thus preventing setvar from working).
996 local __height_menu_with_help_size __width_menu_with_help_size
997 f_dialog_infobox_size -n \
998 "${__var_height:+__height_menu_with_help_size}" \
999 "${__var_width:+__width_menu_with_help_size}" \
1000 "$__title" "$__btitle" "$__prompt" "$__hline"
1003 # Always process the menu-item arguments to get the longest tag-length,
1004 # longest item-length, longest help-length (help-length only considered
1005 # if using Xdialog(1), as it places the help string in the widget) --
1006 # all used to bump the width -- and the number of rows (used to bump
1009 local __longest_tag=0 __longest_item=0 __longest_help=0 __rows=0
1010 while [ $# -ge 3 ]; do
1011 local __tag="$1" __item="$2" __help="$3"
1012 shift 3 # tag/item/help
1013 [ ${#__tag} -gt $__longest_tag ] && __longest_tag=${#__tag}
1014 [ ${#__item} -gt $__longest_item ] && __longest_item=${#__item}
1015 [ ${#__help} -gt $__longest_help ] && __longest_help=${#__help}
1016 __rows=$(( $__rows + 1 ))
1019 # Adjust rows early (for up-coming height calculation)
1020 if [ "$__var_height" -o "$__var_rows" ]; then
1021 # Add a row for visual aid if using Xdialog(1)
1022 [ "$USE_XDIALOG" ] && __rows=$(( $__rows + 1 ))
1025 # Adjust height if desired
1026 if [ "$__var_height" ]; then
1027 # Add rows to height
1028 if [ "$USE_XDIALOG" ]; then
1029 __height_menu_with_help_size=$((
1030 $__height_menu_with_help_size + $__rows + 8 ))
1032 __height_menu_with_help_size=$((
1033 $__height_menu_with_help_size + $__rows + 4 ))
1035 setvar "$__var_height" $__height_menu_with_help_size
1038 # Adjust width if desired
1039 if [ "$__var_width" ]; then
1040 # The sum total between the longest tag-length and the
1041 # longest item-length should be used to bump menu width
1042 local __n=$(( $__longest_tag + $__longest_item + 10 ))
1043 [ "$USE_XDIALOG" ] && __n=$(( $__n + $__n / 6 )) # plus 16.6%
1044 [ $__n -gt $__width_menu_with_help_size ] &&
1045 __width_menu_with_help_size=$__n
1047 # Update width for help text if using Xdialog(1)
1048 if [ "$USE_XDIALOG" ]; then
1049 __n=$(( $__longest_help + 10 ))
1050 __n=$(( $__n + $__n / 6 )) # plus 16.6%
1051 [ $__n -gt $__width_menu_with_help_size ] &&
1052 __width_menu_with_help_size=$__n
1055 setvar "$__var_width" $__width_menu_with_help_size
1058 # Store adjusted rows if desired
1059 [ "$__var_rows" ] && setvar "$__var_rows" $__rows
1061 # Constrain height, width, and rows to sensible minimum/maximum values
1062 # Return success if no-constrain, else return status from constrain
1063 [ ! "$__constrain" ] || f_dialog_menu_constrain \
1064 "$__var_height" "$__var_width" "$__var_rows" "$__prompt"
1067 # f_dialog_radiolist_size [-n] $var_height $var_width $var_rows \
1068 # $title $backtitle $prompt $hline \
1069 # $tag1 $item1 $status1 $tag2 $item2 $status2 ...
1071 # Not all versions of dialog(1) perform auto-sizing of the width and height of
1072 # `--radiolist' boxes sensibly.
1074 # This function helps solve this issue by taking three sets of sequential
1075 # arguments. The first set of arguments are the variable names to use when
1076 # storing the calculated height, width, and rows. The second set of arguments
1077 # are the title, backtitle, prompt, and hline. The [optional] third set of
1078 # arguments are the radio list itself (comprised of tag/item/status triplets).
1079 # The optimal height, width, and rows for the described widget (not exceeding
1080 # the actual terminal height or width) is stored in $var_height, $var_width,
1081 # and $var_rows (respectively).
1083 # If the first argument is `-n', the calculated sizes ($var_height, $var_width,
1084 # and $var_rows) are not constrained to minimum/maximum values.
1086 f_dialog_radiolist_size()
1089 [ "$1" = "-n" ] && __constrain= && shift 1 # -n
1090 local __var_height="$1" __var_width="$2" __var_rows="$3"
1091 local __title="$4" __btitle="$5" __prompt="$6" __hline="$7"
1092 shift 7 # var_height/var_width/var_rows/title/btitle/prompt/hline
1094 # Return unless at least one size aspect has been requested
1095 [ "$__var_height" -o "$__var_width" -o "$__var_rows" ] ||
1098 # Calculate height/width of infobox (adjusted/constrained below)
1099 # NOTE: Function name appended to prevent __var_{height,width} values
1100 # from becoming local (and thus preventing setvar from working).
1101 local __height_rlist_size __width_rlist_size
1102 f_dialog_infobox_size -n \
1103 "${__var_height:+__height_rlist_size}" \
1104 "${__var_width:+__width_rlist_size}" \
1105 "$__title" "$__btitle" "$__prompt" "$__hline"
1108 # Always process the menu-item arguments to get the longest tag-length,
1109 # longest item-length (both used to bump the width), and the number of
1110 # rows (used to bump the height).
1112 local __longest_tag=0 __longest_item=0 __rows_rlist_size=0
1113 while [ $# -ge 3 ]; do
1114 local __tag="$1" __item="$2"
1115 shift 3 # tag/item/status
1116 [ ${#__tag} -gt $__longest_tag ] && __longest_tag=${#__tag}
1117 [ ${#__item} -gt $__longest_item ] && __longest_item=${#__item}
1118 __rows_rlist_size=$(( $__rows_rlist_size + 1 ))
1121 # Adjust rows early (for up-coming height calculation)
1122 if [ "$__var_height" -o "$__var_rows" ]; then
1123 # Add a row for visual aid if using Xdialog(1)
1124 [ "$USE_XDIALOG" ] &&
1125 __rows_rlist_size=$(( $__rows_rlist_size + 1 ))
1128 # Adjust height if desired
1129 if [ "$__var_height" ]; then
1130 # Add rows to height
1131 if [ "$USE_XDIALOG" ]; then
1132 __height_rlist_size=$((
1133 $__height_rlist_size + $__rows_rlist_size + 7
1136 __height_rlist_size=$((
1137 $__height_rlist_size + $__rows_rlist_size + 4
1140 setvar "$__var_height" $__height_rlist_size
1143 # Adjust width if desired
1144 if [ "$__var_width" ]; then
1145 # Sum total between longest tag-length, longest item-length,
1146 # and radio-button width should be used to bump menu width
1147 local __n=$(( $__longest_tag + $__longest_item + 13 ))
1148 [ "$USE_XDIALOG" ] && __n=$(( $__n + $__n / 6 )) # plus 16.6%
1149 [ $__n -gt $__width_rlist_size ] && __width_rlist_size=$__n
1151 setvar "$__var_width" $__width_rlist_size
1154 # Store adjusted rows if desired
1155 [ "$__var_rows" ] && setvar "$__var_rows" $__rows_rlist_size
1157 # Constrain height, width, and rows to sensible minimum/maximum values
1158 # Return success if no-constrain, else return status from constrain
1159 [ ! "$__constrain" ] || f_dialog_menu_constrain \
1160 "$__var_height" "$__var_width" "$__var_rows" "$__prompt"
1163 # f_dialog_checklist_size [-n] $var_height $var_width $var_rows \
1164 # $title $backtitle $prompt $hline \
1165 # $tag1 $item1 $status1 $tag2 $item2 $status2 ...
1167 # Not all versions of dialog(1) perform auto-sizing of the width and height of
1168 # `--checklist' boxes sensibly.
1170 # This function helps solve this issue by taking three sets of sequential
1171 # arguments. The first set of arguments are the variable names to use when
1172 # storing the calculated height, width, and rows. The second set of arguments
1173 # are the title, backtitle, prompt, and hline. The [optional] third set of
1174 # arguments are the check list itself (comprised of tag/item/status triplets).
1175 # The optimal height, width, and rows for the described widget (not exceeding
1176 # the actual terminal height or width) is stored in $var_height, $var_width,
1177 # and $var_rows (respectively).
1179 # If the first argument is `-n', the calculated sizes ($var_height, $var_width,
1180 # and $var_rows) are not constrained to minimum/maximum values.
1182 f_dialog_checklist_size()
1184 f_dialog_radiolist_size "$@"
1187 # f_dialog_radiolist_with_help_size [-n] $var_height $var_width $var_rows \
1188 # $title $backtitle $prompt $hline \
1189 # $tag1 $item1 $status1 $help1 \
1190 # $tag2 $item2 $status2 $help2 ...
1192 # Not all versions of dialog(1) perform auto-sizing of the width and height of
1193 # `--radiolist' boxes sensibly.
1195 # This function helps solve this issue by taking three sets of sequential
1196 # arguments. The first set of arguments are the variable names to use when
1197 # storing the calculated height, width, and rows. The second set of arguments
1198 # are the title, backtitle, prompt, and hline. The [optional] third set of
1199 # arguments are the radio list itself (comprised of tag/item/status/help
1200 # quadruplets). The optimal height, width, and rows for the described widget
1201 # (not exceeding the actual terminal height or width) is stored in $var_height,
1202 # $var_width, and $var_rows (respectively).
1204 # If the first argument is `-n', the calculated sizes ($var_height, $var_width,
1205 # and $var_rows) are not constrained to minimum/maximum values.
1207 f_dialog_radiolist_with_help_size()
1210 [ "$1" = "-n" ] && __constrain= && shift 1 # -n
1211 local __var_height="$1" __var_width="$2" __var_rows="$3"
1212 local __title="$4" __btitle="$5" __prompt="$6" __hline="$7"
1213 shift 7 # var_height/var_width/var_rows/title/btitle/prompt/hline
1215 # Return unless at least one size aspect has been requested
1216 [ "$__var_height" -o "$__var_width" -o "$__var_rows" ] ||
1219 # Calculate height/width of infobox (adjusted/constrained below)
1220 # NOTE: Function name appended to prevent __var_{height,width} values
1221 # from becoming local (and thus preventing setvar from working).
1222 local __height_rlist_with_help_size __width_rlist_with_help_size
1223 f_dialog_infobox_size -n \
1224 "${__var_height:+__height_rlist_with_help_size}" \
1225 "${__var_width:+__width_rlist_with_help_size}" \
1226 "$__title" "$__btitle" "$__prompt" "$__hline"
1229 # Always process the menu-item arguments to get the longest tag-length,
1230 # longest item-length, longest help-length (help-length only considered
1231 # if using Xdialog(1), as it places the help string in the widget) --
1232 # all used to bump the width -- and the number of rows (used to bump
1235 local __longest_tag=0 __longest_item=0 __longest_help=0
1236 local __rows_rlist_with_help_size=0
1237 while [ $# -ge 4 ]; do
1238 local __tag="$1" __item="$2" __status="$3" __help="$4"
1239 shift 4 # tag/item/status/help
1240 [ ${#__tag} -gt $__longest_tag ] && __longest_tag=${#__tag}
1241 [ ${#__item} -gt $__longest_item ] && __longest_item=${#__item}
1242 [ ${#__help} -gt $__longest_help ] && __longest_help=${#__help}
1243 __rows_rlist_with_help_size=$((
1244 $__rows_rlist_with_help_size + 1
1248 # Adjust rows early (for up-coming height calculation)
1249 if [ "$__var_height" -o "$__var_rows" ]; then
1250 # Add a row for visual aid if using Xdialog(1)
1251 [ "$USE_XDIALOG" ] &&
1252 __rows_rlist_with_help_size=$((
1253 $__rows_rlist_with_help_size + 1
1257 # Adjust height if desired
1258 if [ "$__var_height" ]; then
1259 # Add rows to height
1260 if [ "$USE_XDIALOG" ]; then
1261 __height_rlist_with_help_size=$((
1262 $__height_rlist_with_help_size +
1263 $__rows_rlist_with_help_size + 7
1266 __height_rlist_with_help_size=$((
1267 $__height_rlist_with_help_size +
1268 $__rows_rlist_with_help_size + 4
1271 setvar "$__var_height" $__height
1274 # Adjust width if desired
1275 if [ "$__var_width" ]; then
1276 # Sum total between longest tag-length, longest item-length,
1277 # and radio-button width should be used to bump menu width
1278 local __n=$(( $__longest_tag + $__longest_item + 13 ))
1279 [ "$USE_XDIALOG" ] && __n=$(( $__n + $__n / 6 )) # plus 16.6%
1280 [ $__n -gt $__width_rlist_with_help_size ] &&
1281 __width_rlist_with_help_size=$__n
1283 # Update width for help text if using Xdialog(1)
1284 if [ "$USE_XDIALOG" ]; then
1285 __n=$(( $__longest_help + 10 ))
1286 __n=$(( $__n + $__n / 6 )) # plus 16.6%
1287 [ $__n -gt $__width_rlist_with_help_size ] &&
1288 __width_rlist_with_help_size=$__n
1291 setvar "$__var_width" $__width_rlist_with_help_size
1294 # Store adjusted rows if desired
1295 [ "$__var_rows" ] && setvar "$__var_rows" $__rows_rlist_with_help_size
1297 # Constrain height, width, and rows to sensible minimum/maximum values
1298 # Return success if no-constrain, else return status from constrain
1299 [ ! "$__constrain" ] || f_dialog_menu_constrain \
1300 "$__var_height" "$__var_width" "$__var_rows" "$__prompt"
1303 # f_dialog_checklist_with_help_size [-n] $var_height $var_width $var_rows \
1304 # $title $backtitle $prompt $hline \
1305 # $tag1 $item1 $status1 $help1 \
1306 # $tag2 $item2 $status2 $help2 ...
1308 # Not all versions of dialog(1) perform auto-sizing of the width and height of
1309 # `--checklist' boxes sensibly.
1311 # This function helps solve this issue by taking three sets of sequential
1312 # arguments. The first set of arguments are the variable names to use when
1313 # storing the calculated height, width, and rows. The second set of arguments
1314 # are the title, backtitle, prompt, and hline. The [optional] third set of
1315 # arguments are the check list itself (comprised of tag/item/status/help
1316 # quadruplets). The optimal height, width, and rows for the described widget
1317 # (not exceeding the actual terminal height or width) is stored in $var_height,
1318 # $var_width, and $var_rows (respectively).
1320 # If the first argument is `-n', the calculated sizes ($var_height, $var_width,
1321 # and $var_rows) are not constrained to minimum/maximum values.
1323 f_dialog_checklist_with_help_size()
1325 f_dialog_radiolist_with_help_size "$@"
1328 # f_dialog_calendar_size [-n] $var_height $var_width \
1329 # $title $backtitle $prompt [$hline]
1331 # Not all versions of dialog(1) perform auto-sizing of the width and height of
1332 # `--calendar' boxes sensibly.
1334 # This function helps solve this issue by taking two sets of sequential
1335 # arguments. The first set of arguments are the variable names to use when
1336 # storing the calculated height and width. The second set of arguments are the
1337 # title, backtitle, prompt, and [optionally] hline. The optimal height and
1338 # width for the described widget (not exceeding the actual terminal height or
1339 # width) is stored in $var_height and $var_width (respectively).
1341 # If the first argument is `-n', the calculated sizes ($var_height and
1342 # $var_width) are not constrained to minimum/maximum values.
1344 # Newline character sequences (``\n'') in $prompt are expanded as-is done by
1347 f_dialog_calendar_size()
1350 [ "$1" = "-n" ] && __constrain= && shift 1 # -n
1351 local __var_height="$1" __var_width="$2"
1352 local __title="$3" __btitle="$4" __prompt="$5" __hline="$6"
1354 # Return unless at least one size aspect has been requested
1355 [ "$__var_height" -o "$__var_width" ] || return $FAILURE
1358 # Obtain/Adjust minimum and maximum thresholds
1359 # NOTE: Function name appended to prevent __var_{height,width} values
1360 # from becoming local (and thus preventing setvar from working).
1362 local __max_height_cal_size __max_width_cal_size
1363 f_dialog_max_size __max_height_cal_size __max_width_cal_size
1364 __max_width_cal_size=$(( $__max_width_cal_size - 2 ))
1365 # the calendar box will refuse to display if too wide
1367 if [ "$USE_XDIALOG" ]; then
1371 __max_height_cal_size=$((
1372 $__max_height_cal_size - $DIALOG_CALENDAR_HEIGHT ))
1373 # When using dialog(1), we can't predict whether the user has
1374 # disabled shadow's in their `$HOME/.dialogrc' file, so we'll
1375 # subtract one for the potential shadow around the widget
1376 __max_height_cal_size=$(( $__max_height_cal_size - 1 ))
1379 # Calculate height if desired
1380 if [ "$__var_height" ]; then
1382 __height=$( echo "$__prompt" | f_number_of_lines )
1384 if [ "$USE_XDIALOG" ]; then
1385 # Add height to accomodate for embedded calendar widget
1386 __height=$(( $__height + $DIALOG_CALENDAR_HEIGHT - 1 ))
1388 # Also, bump height if backtitle is enabled
1389 if [ "$__btitle" ]; then
1391 __n=$( echo "$__btitle" | f_number_of_lines )
1392 __height=$(( $__height + $__n + 2 ))
1395 [ "$__prompt" ] && __height=$(( $__height + 1 ))
1398 # Enforce maximum height, unless `-n' was passed
1399 [ "$__constrain" -a $__height -gt $__max_height_cal_size ] &&
1400 __height=$__max_height_cal_size
1402 setvar "$__var_height" $__height
1405 # Calculate width if desired
1406 if [ "$__var_width" ]; then
1407 # NOTE: Function name appended to prevent __var_{height,width}
1408 # values from becoming local (and thus preventing setvar
1410 local __width_cal_size
1411 f_dialog_infobox_size -n "" __width_cal_size \
1412 "$__title" "$__btitle" "$__prompt" "$__hline"
1414 # Enforce minimum/maximum width, unless `-n' was passed
1415 if [ "$__constrain" ]; then
1416 if [ $__width_cal_size -lt $__min_width ]; then
1417 __width_cal_size=$__min_width
1418 elif [ $__width_cal_size -gt $__max_width_cal_size ]
1420 __width_cal_size=$__max_width_size
1424 setvar "$__var_width" $__width_cal_size
1430 # f_dialog_timebox_size [-n] $var_height $var_width \
1431 # $title $backtitle $prompt [$hline]
1433 # Not all versions of dialog(1) perform auto-sizing of the width and height of
1434 # `--timebox' boxes sensibly.
1436 # This function helps solve this issue by taking two sets of sequential
1437 # arguments. The first set of arguments are the variable names to use when
1438 # storing the calculated height and width. The second set of arguments are the
1439 # title, backtitle, prompt, and [optionally] hline. The optional height and
1440 # width for the described widget (not exceeding the actual terminal height or
1441 # width) is stored in $var_height and $var_width (respectively).
1443 # If the first argument is `-n', the calculated sizes ($var_height and
1444 # $var_width) are not constrained to minimum/maximum values.
1446 # Newline character sequences (``\n'') in $prompt are expanded as-is done by
1449 f_dialog_timebox_size()
1452 [ "$1" = "-n" ] && __constrain= && shift 1 # -n
1453 local __var_height="$1" __var_width="$2"
1454 local __title="$3" __btitle="$4" __prompt="$5" __hline="$6"
1456 # Return unless at least one size aspect has been requested
1457 [ "$__var_height" -o "$__var_width" ] || return $FAILURE
1460 # Obtain/Adjust minimum and maximum thresholds
1461 # NOTE: Function name appended to prevent __var_{height,width} values
1462 # from becoming local (and thus preventing setvar from working).
1464 local __max_height_tbox_size __max_width_tbox_size
1465 f_dialog_max_size __max_height_tbox_size __max_width_tbox_size
1466 __max_width_tbox_size=$(( $__max_width_tbox_size - 2 ))
1467 # the timebox widget refuses to display if too wide
1469 if [ "$USE_XDIALOG" ]; then
1473 __max_height_tbox_size=$(( \
1474 $__max_height_tbox_size - $DIALOG_TIMEBOX_HEIGHT ))
1475 # When using dialog(1), we can't predict whether the user has
1476 # disabled shadow's in their `$HOME/.dialogrc' file, so we'll
1477 # subtract one for the potential shadow around the widget
1478 __max_height_tbox_size=$(( $__max_height_tbox_size - 1 ))
1481 # Calculate height if desired
1482 if [ "$__var_height" -a "$USE_XDIALOG" ]; then
1483 # When using Xdialog(1), the height seems to have
1484 # no effect. All values provide the same results.
1485 setvar "$__var_height" 0 # autosize
1486 elif [ "$__var_height" ]; then
1488 __height=$( echo "$__prompt" | f_number_of_lines )
1489 __height=$(( $__height ${__prompt:++1} + 1 ))
1491 # Enforce maximum height, unless `-n' was passed
1492 [ "$__constrain" -a $__height -gt $__max_height_tbox_size ] &&
1493 __height=$__max_height_tbox_size
1495 setvar "$__var_height" $__height
1498 # Calculate width if desired
1499 if [ "$__var_width" ]; then
1500 # NOTE: Function name appended to prevent __var_{height,width}
1501 # values from becoming local (and thus preventing setvar
1503 local __width_tbox_size
1504 f_dialog_infobox_size -n "" __width_tbox_size \
1505 "$__title" "$__btitle" "$__prompt" "$__hline"
1507 # Enforce the minimum width for displaying the timebox
1508 if [ "$__constrain" ]; then
1509 if [ $__width_tbox_size -lt $__min_width ]; then
1510 __width_tbox_size=$__min_width
1511 elif [ $__width_tbox_size -ge $__max_width_tbox_size ]
1513 __width_tbox_size=$__max_width_tbox_size
1517 setvar "$__var_width" $__width_tbox_size
1523 ############################################################ CLEAR FUNCTIONS
1527 # Clears any/all previous dialog(1) displays.
1534 ############################################################ INFO FUNCTIONS
1536 # f_dialog_info $info_text ...
1538 # Throw up a dialog(1) infobox. The infobox remains until another dialog is
1539 # displayed or `dialog --clear' (or f_dialog_clear) is called.
1543 local info_text="$*" height width
1544 f_dialog_infobox_size height width \
1545 "$DIALOG_TITLE" "$DIALOG_BACKTITLE" "$info_text"
1547 --title "$DIALOG_TITLE" \
1548 --backtitle "$DIALOG_BACKTITLE" \
1549 ${USE_XDIALOG:+--ignore-eof} \
1550 ${USE_XDIALOG:+--no-buttons} \
1551 --infobox "$info_text" $height $width
1554 # f_xdialog_info $info_text ...
1556 # Throw up an Xdialog(1) infobox and do not dismiss it until stdin produces
1557 # EOF. This implies that you must execute this either as an rvalue to a pipe,
1558 # lvalue to indirection or in a sub-shell that provides data on stdin.
1560 # To open an Xdialog(1) infobox that does not disappear until expeclitly dis-
1561 # missed, use the following:
1563 # f_xdialog_info "$info_text" < /dev/tty &
1565 # # Perform some lengthy actions
1568 # NB: Check $USE_XDIALOG if you need to support both dialog(1) and Xdialog(1).
1572 local info_text="$*" height width
1573 f_dialog_infobox_size height width \
1574 "$DIALOG_TITLE" "$DIALOG_BACKTITLE" "$info_text"
1576 --title "$DIALOG_TITLE" \
1577 --backtitle "$DIALOG_BACKTITLE" \
1578 --no-close --no-buttons \
1579 --infobox "$info_text" $height $width \
1580 -1 # timeout of -1 means abort when EOF on stdin
1583 ############################################################ PAUSE FUNCTIONS
1585 # f_dialog_pause $msg_text $duration [$hline]
1587 # Display a message in a widget with a progress bar that runs backward for
1588 # $duration seconds.
1592 local pause_text="$1" duration="$2" hline="$3" height width
1593 f_isinteger "$duration" || return $FAILURE
1594 f_dialog_buttonbox_size height width \
1595 "$DIALOG_TITLE" "$DIALOG_BACKTITLE" "$pause_text" "$hline"
1596 if [ "$USE_XDIALOG" ]; then
1598 --title "$DIALOG_TITLE" \
1599 --backtitle "$DIALOG_BACKTITLE" \
1600 --ok-label "$msg_skip" \
1601 --cancel-label "$msg_cancel" \
1602 ${noCancel:+--no-cancel} \
1603 --timeout "$duration" \
1604 --yesno "$pause_text" \
1607 [ $duration -gt 0 ] && duration=$(( $duration - 1 ))
1608 [ $duration -gt 1 ] && duration=$(( $duration - 1 ))
1609 height=$(( $height + 3 )) # Add height for progress bar
1611 --title "$DIALOG_TITLE" \
1612 --backtitle "$DIALOG_BACKTITLE" \
1614 --ok-label "$msg_skip" \
1615 --cancel-label "$msg_cancel" \
1616 ${noCancel:+--no-cancel} \
1617 --pause "$pause_text" \
1618 $height $width "$duration"
1622 # f_dialog_pause_no_cancel $msg_text $duration [$hline]
1624 # Display a message in a widget with a progress bar that runs backward for
1625 # $duration seconds. No cancel button is provided. Always returns success.
1627 f_dialog_pause_no_cancel()
1629 noCancel=1 f_dialog_pause "$@"
1633 ############################################################ MSGBOX FUNCTIONS
1635 # f_dialog_msgbox $msg_text [$hline]
1637 # Throw up a dialog(1) msgbox. The msgbox remains until the user presses ENTER
1638 # or ESC, acknowledging the modal dialog.
1640 # If the user presses ENTER, the exit status is zero (success), otherwise if
1641 # the user presses ESC the exit status is 255.
1645 local msg_text="$1" hline="$2" height width
1646 f_dialog_buttonbox_size height width \
1647 "$DIALOG_TITLE" "$DIALOG_BACKTITLE" "$msg_text" "$hline"
1649 --title "$DIALOG_TITLE" \
1650 --backtitle "$DIALOG_BACKTITLE" \
1652 --ok-label "$msg_ok" \
1653 --msgbox "$msg_text" $height $width
1656 ############################################################ TEXTBOX FUNCTIONS
1658 # f_dialog_textbox $file
1660 # Display the contents of $file (or an error if $file does not exist, etc.) in
1661 # a dialog(1) textbox (which has a scrollable region for the text). The textbox
1662 # remains until the user presses ENTER or ESC, acknowledging the modal dialog.
1664 # If the user presses ENTER, the exit status is zero (success), otherwise if
1665 # the user presses ESC the exit status is 255.
1670 local contents height width retval
1672 contents=$( cat "$file" 2>&1 )
1675 f_dialog_buttonbox_size height width \
1676 "$DIALOG_TITLE" "$DIALOG_BACKTITLE" "$contents"
1678 if [ $retval -eq $SUCCESS ]; then
1680 --title "$DIALOG_TITLE" \
1681 --backtitle "$DIALOG_BACKTITLE" \
1682 --exit-label "$msg_ok" \
1684 --textbox "$file" $height $width
1687 --title "$DIALOG_TITLE" \
1688 --backtitle "$DIALOG_BACKTITLE" \
1689 --ok-label "$msg_ok" \
1690 --msgbox "$contents" $height $width
1694 ############################################################ YESNO FUNCTIONS
1696 # f_dialog_yesno $msg_text [$hline]
1698 # Display a dialog(1) Yes/No prompt to allow the user to make some decision.
1699 # The yesno prompt remains until the user presses ENTER or ESC, acknowledging
1702 # If the user chooses YES the exit status is zero, or chooses NO the exit
1703 # status is one, or presses ESC the exit status is 255.
1707 local msg_text="$1" height width
1708 local hline="${2-$hline_arrows_tab_enter}"
1710 f_interactive || return 0 # If non-interactive, return YES all the time
1712 f_dialog_buttonbox_size height width \
1713 "$DIALOG_TITLE" "$DIALOG_BACKTITLE" "$msg_text" "$hline"
1715 if [ "$USE_XDIALOG" ]; then
1717 --title "$DIALOG_TITLE" \
1718 --backtitle "$DIALOG_BACKTITLE" \
1720 --ok-label "$msg_yes" \
1721 --cancel-label "$msg_no" \
1722 --yesno "$msg_text" $height $width
1725 --title "$DIALOG_TITLE" \
1726 --backtitle "$DIALOG_BACKTITLE" \
1728 --yes-label "$msg_yes" \
1729 --no-label "$msg_no" \
1730 --yesno "$msg_text" $height $width
1734 # f_dialog_noyes $msg_text [$hline]
1736 # Display a dialog(1) No/Yes prompt to allow the user to make some decision.
1737 # The noyes prompt remains until the user presses ENTER or ESC, acknowledging
1740 # If the user chooses YES the exit status is zero, or chooses NO the exit
1741 # status is one, or presses ESC the exit status is 255.
1743 # NOTE: This is just like the f_dialog_yesno function except "No" is default.
1747 local msg_text="$1" height width
1748 local hline="${2-$hline_arrows_tab_enter}"
1750 f_interactive || return 1 # If non-interactive, return NO all the time
1752 f_dialog_buttonbox_size height width \
1753 "$DIALOG_TITLE" "$DIALOG_BACKTITLE" "$msg_text" "$hline"
1755 if [ "$USE_XDIALOG" ]; then
1757 --title "$DIALOG_TITLE" \
1758 --backtitle "$DIALOG_BACKTITLE" \
1761 --ok-label "$msg_yes" \
1762 --cancel-label "$msg_no" \
1763 --yesno "$msg_text" $height $width
1766 --title "$DIALOG_TITLE" \
1767 --backtitle "$DIALOG_BACKTITLE" \
1770 --yes-label "$msg_yes" \
1771 --no-label "$msg_no" \
1772 --yesno "$msg_text" $height $width
1776 ############################################################ INPUT FUNCTIONS
1778 # f_dialog_inputstr_store [-s] $text
1780 # Store some text from a dialog(1) inputbox to be retrieved later by
1781 # f_dialog_inputstr_fetch(). If the first argument is `-s', the text is
1782 # sanitized before being stored.
1784 f_dialog_inputstr_store()
1787 [ "$1" = "-s" ] && sanitize=1 && shift 1 # -s
1790 # Sanitize the line before storing it if desired
1791 [ "$sanitize" ] && f_dialog_line_sanitize text
1793 setvar DIALOG_INPUTBOX_$$ "$text"
1796 # f_dialog_inputstr_fetch [$var_to_set]
1798 # Obtain the inputstr entered by the user from the most recently displayed
1799 # dialog(1) inputbox (previously stored with f_dialog_inputstr_store() above).
1800 # If $var_to_set is NULL or missing, output is printed to stdout (which is less
1801 # recommended due to performance degradation; in a loop for example).
1803 f_dialog_inputstr_fetch()
1805 local __var_to_set="$1" __cp
1807 debug= f_getvar DIALOG_INPUTBOX_$$ "${__var_to_set:-__cp}" # get data
1808 setvar DIALOG_INPUTBOX_$$ "" # scrub memory in case data was sensitive
1810 # Return the line on standard-out if desired
1811 [ "$__var_to_set" ] || echo "$__cp"
1816 # f_dialog_input $var_to_set $prompt [$init [$hline]]
1818 # Prompt the user with a dialog(1) inputbox to enter some value. The inputbox
1819 # remains until the the user presses ENTER or ESC, or otherwise ends the
1820 # editing session (by selecting `Cancel' for example).
1822 # If the user presses ENTER, the exit status is zero (success), otherwise if
1823 # the user presses ESC the exit status is 255, or if the user chose Cancel, the
1824 # exit status is instead 1.
1826 # NOTE: The hline should correspond to the type of data you want from the user.
1827 # NOTE: Should not be used to edit multiline values.
1831 local __var_to_set="$1" __prompt="$2" __init="$3" __hline="$4"
1833 # NOTE: Function name appended to prevent __var_{height,width} values
1834 # from becoming local (and thus preventing setvar from working).
1835 local __height_input __width_input
1836 f_dialog_inputbox_size __height_input __width_input \
1837 "$DIALOG_TITLE" "$DIALOG_BACKTITLE" \
1838 "$__prompt" "$__init" "$__hline"
1841 [ "$USE_XDIALOG" ] && __opterm=
1843 local __dialog_input
1846 --title "$DIALOG_TITLE" \
1847 --backtitle "$DIALOG_BACKTITLE" \
1848 --hline "$__hline" \
1849 --ok-label "$msg_ok" \
1850 --cancel-label "$msg_cancel" \
1851 --inputbox "$__prompt" \
1852 $__height_input $__width_input \
1853 $__opterm "$__init" \
1854 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
1858 # Remove warnings and leading/trailing whitespace from user input
1859 f_dialog_line_sanitize __dialog_input
1861 setvar "$__var_to_set" "$__dialog_input"
1865 ############################################################ MENU FUNCTIONS
1867 # f_dialog_menutag_store [-s] $text
1869 # Store some text from a dialog(1) menu to be retrieved later by
1870 # f_dialog_menutag_fetch(). If the first argument is `-s', the text is
1871 # sanitized before being stored.
1873 f_dialog_menutag_store()
1876 [ "$1" = "-s" ] && sanitize=1 && shift 1 # -s
1879 # Sanitize the menutag before storing it if desired
1880 [ "$sanitize" ] && f_dialog_data_sanitize text
1882 setvar DIALOG_MENU_$$ "$text"
1885 # f_dialog_menutag_fetch [$var_to_set]
1887 # Obtain the menutag chosen by the user from the most recently displayed
1888 # dialog(1) menu (previously stored with f_dialog_menutag_store() above). If
1889 # $var_to_set is NULL or missing, output is printed to stdout (which is less
1890 # recommended due to performance degradation; in a loop for example).
1892 f_dialog_menutag_fetch()
1894 local __var_to_set="$1" __cp
1896 debug= f_getvar DIALOG_MENU_$$ "${__var_to_set:-__cp}" # get the data
1897 setvar DIALOG_MENU_$$ "" # scrub memory in case data was sensitive
1899 # Return the data on standard-out if desired
1900 [ "$__var_to_set" ] || echo "$__cp"
1905 # f_dialog_menuitem_store [-s] $text
1907 # Store the item from a dialog(1) menu (see f_dialog_menutag2item()) to be
1908 # retrieved later by f_dialog_menuitem_fetch(). If the first argument is `-s',
1909 # the text is sanitized before being stored.
1911 f_dialog_menuitem_store()
1914 [ "$1" = "-s" ] && sanitize=1 && shift 1 # -s
1917 # Sanitize the menuitem before storing it if desired
1918 [ "$sanitize" ] && f_dialog_data_sanitize text
1920 setvar DIALOG_MENUITEM_$$ "$text"
1923 # f_dialog_menuitem_fetch [$var_to_set]
1925 # Obtain the menuitem chosen by the user from the most recently displayed
1926 # dialog(1) menu (previously stored with f_dialog_menuitem_store() above). If
1927 # $var_to_set is NULL or missing, output is printed to stdout (which is less
1928 # recommended due to performance degradation; in a loop for example).
1930 f_dialog_menuitem_fetch()
1932 local __var_to_set="$1" __cp
1934 debug= f_getvar DIALOG_MENUITEM_$$ "${__var_to_set:-__cp}" # get data
1935 setvar DIALOG_MENUITEM_$$ "" # scrub memory in case data was sensitive
1937 # Return the data on standard-out if desired
1938 [ "$__var_to_set" ] || echo "$__cp"
1943 # f_dialog_default_store [-s] $text
1945 # Store some text to be used later as the --default-item argument to dialog(1)
1946 # (or Xdialog(1)) for --menu, --checklist, and --radiolist widgets. Retrieve
1947 # the text later with f_dialog_menutag_fetch(). If the first argument is `-s',
1948 # the text is sanitized before being stored.
1950 f_dialog_default_store()
1953 [ "$1" = "-s" ] && sanitize=1 && shift 1 # -s
1956 # Sanitize the defaulitem before storing it if desired
1957 [ "$sanitize" ] && f_dialog_data_sanitize text
1959 setvar DEFAULTITEM_$$ "$text"
1962 # f_dialog_default_fetch [$var_to_set]
1964 # Obtain text to be used with the --default-item argument of dialog(1) (or
1965 # Xdialog(1)) (previously stored with f_dialog_default_store() above). If
1966 # $var_to_set is NULL or missing, output is printed to stdout (which is less
1967 # recommended due to performance degradation; in a loop for example).
1969 f_dialog_default_fetch()
1971 local __var_to_set="$1" __cp
1973 debug= f_getvar DEFAULTITEM_$$ "${__var_to_set:-__cp}" # get the data
1974 setvar DEFAULTITEM_$$ "" # scrub memory in case data was sensitive
1976 # Return the data on standard-out if desired
1977 [ "$__var_to_set" ] || echo "$__cp"
1982 # f_dialog_menutag2item $tag_chosen $tag1 $item1 $tag2 $item2 ...
1984 # To use the `--menu' option of dialog(1) you must pass an ordered list of
1985 # tag/item pairs on the command-line. When the user selects a menu option the
1986 # tag for that item is printed to stderr.
1988 # This function allows you to dereference the tag chosen by the user back into
1989 # the item associated with said tag.
1991 # Pass the tag chosen by the user as the first argument, followed by the
1992 # ordered list of tag/item pairs (HINT: use the same tag/item list as was
1993 # passed to dialog(1) for consistency).
1995 # If the tag cannot be found, NULL is returned.
1997 f_dialog_menutag2item()
1999 local tag="$1" tagn item
2002 while [ $# -gt 0 ]; do
2007 if [ "$tag" = "$tagn" ]; then
2015 # f_dialog_menutag2item_with_help $tag_chosen $tag1 $item1 $help1 \
2016 # $tag2 $item2 $help2 ...
2018 # To use the `--menu' option of dialog(1) with the `--item-help' option, you
2019 # must pass an ordered list of tag/item/help triplets on the command-line. When
2020 # the user selects a menu option the tag for that item is printed to stderr.
2022 # This function allows you to dereference the tag chosen by the user back into
2023 # the item associated with said tag (help is discarded/ignored).
2025 # Pass the tag chosen by the user as the first argument, followed by the
2026 # ordered list of tag/item/help triplets (HINT: use the same tag/item/help list
2027 # as was passed to dialog(1) for consistency).
2029 # If the tag cannot be found, NULL is returned.
2031 f_dialog_menutag2item_with_help()
2033 local tag="$1" tagn item
2036 while [ $# -gt 0 ]; do
2039 shift 3 # tagn/item/help
2041 if [ "$tag" = "$tagn" ]; then
2049 # f_dialog_menutag2index $tag_chosen $tag1 $item1 $tag2 $item2 ...
2051 # To use the `--menu' option of dialog(1) you must pass an ordered list of
2052 # tag/item pairs on the command-line. When the user selects a menu option the
2053 # tag for that item is printed to stderr.
2055 # This function allows you to dereference the tag chosen by the user back into
2056 # the index associated with said tag. The index is the one-based tag/item pair
2057 # array position within the ordered list of tag/item pairs passed to dialog(1).
2059 # Pass the tag chosen by the user as the first argument, followed by the
2060 # ordered list of tag/item pairs (HINT: use the same tag/item list as was
2061 # passed to dialog(1) for consistency).
2063 # If the tag cannot be found, NULL is returned.
2065 f_dialog_menutag2index()
2067 local tag="$1" tagn n=1
2070 while [ $# -gt 0 ]; do
2074 if [ "$tag" = "$tagn" ]; then
2083 # f_dialog_menutag2index_with_help $tag_chosen $tag1 $item1 $help1 \
2084 # $tag2 $item2 $help2 ...
2086 # To use the `--menu' option of dialog(1) with the `--item-help' option, you
2087 # must pass an ordered list of tag/item/help triplets on the command-line. When
2088 # the user selects a menu option the tag for that item is printed to stderr.
2090 # This function allows you to dereference the tag chosen by the user back into
2091 # the index associated with said tag. The index is the one-based tag/item/help
2092 # triplet array position within the ordered list of tag/item/help triplets
2093 # passed to dialog(1).
2095 # Pass the tag chosen by the user as the first argument, followed by the
2096 # ordered list of tag/item/help triplets (HINT: use the same tag/item/help list
2097 # as was passed to dialog(1) for consistency).
2099 # If the tag cannot be found, NULL is returned.
2101 f_dialog_menutag2index_with_help()
2103 local tag="$1" tagn n=1
2106 while [ $# -gt 0 ]; do
2108 shift 3 # tagn/item/help
2110 if [ "$tag" = "$tagn" ]; then
2119 # f_dialog_menutag2help $tag_chosen $tag1 $item1 $help1 $tag2 $item2 $help2 ...
2121 # To use the `--menu' option of dialog(1) with the `--item-help' option, you
2122 # must pass an ordered list of tag/item/help triplets on the command-line. When
2123 # the user selects a menu option the tag for that item is printed to stderr.
2125 # This function allows you to dereference the tag chosen by the user back into
2126 # the help associated with said tag (item is discarded/ignored).
2128 # Pass the tag chosen by the user as the first argument, followed by the
2129 # ordered list of tag/item/help triplets (HINT: use the same tag/item/help list
2130 # as was passed to dialog(1) for consistency).
2132 # If the tag cannot be found, NULL is returned.
2134 f_dialog_menutag2help()
2136 local tag="$1" tagn help
2139 while [ $# -gt 0 ]; do
2142 shift 3 # tagn/item/help
2144 if [ "$tag" = "$tagn" ]; then
2152 ############################################################ INIT FUNCTIONS
2156 # Initialize (or re-initialize) the dialog module after setting/changing any
2157 # of the following environment variables:
2159 # USE_XDIALOG Either NULL or Non-NULL. If given a value will indicate
2160 # that Xdialog(1) should be used instead of dialog(1).
2162 # SECURE Either NULL or Non-NULL. If given a value will indicate
2163 # that (while running as root) sudo(8) authentication is
2164 # required to proceed.
2166 # Also reads ~/.dialogrc for the following information:
2168 # NO_SHADOW Either NULL or Non-NULL. If use_shadow is OFF (case-
2169 # insensitive) in ~/.dialogrc this is set to "1" (otherwise
2174 local funcname=f_dialog_init
2176 DIALOG_SELF_INITIALIZE=
2180 # Clone terminal stdout so we can redirect to it from within sub-shells
2182 eval exec $DIALOG_TERMINAL_PASSTHRU_FD\>\&1
2185 # Add `-S' and `-X' to the list of standard arguments supported by all
2187 case "$GETOPTS_STDARGS" in
2188 *SX*) : good ;; # already present
2189 *) GETOPTS_STDARGS="${GETOPTS_STDARGS}SX"
2193 # Process stored command-line arguments
2195 # NB: Using backticks instead of $(...) for portability since Linux
2196 # bash(1) balks at the right parentheses encountered in the case-
2197 # statement (incorrectly interpreting it as the close of $(...)).
2199 f_dprintf "f_dialog_init: ARGV=[%s] GETOPTS_STDARGS=[%s]" \
2200 "$ARGV" "$GETOPTS_STDARGS"
2201 SECURE=`set -- $ARGV
2204 "$GETOPTS_STDARGS$GETOPTS_EXTRA$GETOPTS_ALLFLAGS" \
2205 flag > /dev/null; do
2211 USE_XDIALOG=`set -- $ARGV
2214 "$GETOPTS_STDARGS$GETOPTS_EXTRA$GETOPTS_ALLFLAGS" \
2215 flag > /dev/null; do
2221 f_dprintf "f_dialog_init: SECURE=[%s] USE_XDIALOG=[%s]" \
2222 "$SECURE" "$USE_XDIALOG"
2225 # Process `-X' command-line option
2227 [ "$USE_XDIALOG" ] && DIALOG=Xdialog USE_DIALOG=
2230 # Sanity check, or die gracefully
2232 if ! f_have $DIALOG; then
2234 local failed_dialog="$DIALOG"
2236 f_die 1 "$msg_no_such_file_or_directory" "$pgm" "$failed_dialog"
2240 # Read ~/.dialogrc (unless using Xdialog(1)) for properties
2242 if [ -f ~/.dialogrc -a ! "$USE_XDIALOG" ]; then
2244 awk -v param=use_shadow -v expect=OFF \
2245 -v set="NO_SHADOW=1" '
2246 !/^[[:space:]]*(#|$)/ && \
2247 tolower($1) ~ "^"param"(=|$)" && \
2249 sub(/^[^=]*=[[:space:]]*/, "")
2250 if ( toupper($1) == expect ) print set";"
2256 # If we're already running as root but we got there by way of sudo(8)
2257 # and we have X11, we should merge the xauth(1) credentials from our
2260 if [ "$USE_XDIALOG" ] &&
2261 [ "$( id -u )" = "0" ] &&
2262 [ "$SUDO_USER" -a "$DISPLAY" ]
2264 if ! f_have xauth; then
2265 # Die gracefully, as we [likely] can't use Xdialog(1)
2268 f_die 1 "$msg_no_such_file_or_directory" "$pgm" "xauth"
2270 HOSTNAME=$( hostname )
2271 local displaynum="${DISPLAY#*:}"
2272 eval xauth -if \~$SUDO_USER/.Xauthority extract - \
2273 \"\$HOSTNAME/unix:\$displaynum\" \
2274 \"\$HOSTNAME:\$displaynum\" | sudo sh -c 'xauth -ivf \
2275 ~root/.Xauthority merge - > /dev/null 2>&1'
2279 # Probe Xdialog(1) for maximum height/width constraints, or die
2282 if [ "$USE_XDIALOG" ]; then
2284 if ! f_eval_catch -dk maxsize $funcname "$DIALOG" \
2285 'LANG= LC_ALL= %s --print-maxsize' "$DIALOG"
2287 # Xdialog(1) failed, fall back to dialog(1)
2290 # Display the error message produced by Xdialog(1)
2292 f_dialog_buttonbox_size height width \
2293 "$DIALOG_TITLE" "$DIALOG_BACKTITLE" "$maxsize"
2295 --title "$DIALOG_TITLE" \
2296 --backtitle "$DIALOG_BACKTITLE" \
2297 --ok-label "$msg_ok" \
2298 --msgbox "$maxsize" $height $width
2303 set -- ${maxsize##*:}
2313 # If using Xdialog(1), swap DIALOG_TITLE with DIALOG_BACKTITLE.
2314 # The reason for this is because many dialog(1) applications use
2315 # --backtitle for the program name (which is better suited as
2316 # --title with Xdialog(1)).
2318 if [ "$USE_XDIALOG" ]; then
2319 local _DIALOG_TITLE="$DIALOG_TITLE"
2320 DIALOG_TITLE="$DIALOG_BACKTITLE"
2321 DIALOG_BACKTITLE="$_DIALOG_TITLE"
2324 f_dprintf "f_dialog_init: dialog(1) API initialized."
2327 ############################################################ MAIN
2330 # Self-initialize unless requested otherwise
2332 f_dprintf "%s: DIALOG_SELF_INITIALIZE=[%s]" \
2333 dialog.subr "$DIALOG_SELF_INITIALIZE"
2334 case "$DIALOG_SELF_INITIALIZE" in
2335 ""|0|[Nn][Oo]|[Oo][Ff][Ff]|[Ff][Aa][Ll][Ss][Ee]) : do nothing ;;
2339 f_dprintf "%s: Successfully loaded." dialog.subr
2341 fi # ! $_DIALOG_SUBR