README: Mention that the gui example script must be named "lsi".
[gsu.git] / gui
1 #!/bin/bash
2 # Copyright (C) 2006 Andre Noll
3 # Licensed under the LGPL, version 3. See COPYING and COPYING.LESSER.
4
5 if [[ "$(type -t _gsu_setup)" != "function" ]]; then
6         gsu_dir=${gsu_dir:-${BASH_SOURCE[0]%/*}}
7         . "$gsu_dir/common" || exit 1
8         _gsu_setup
9 fi
10
11 _gsu_node_name_pattern='[a-zA-Z_]'
12
13 _get_geometry()
14 {
15         local x y
16         result="$(stty size)"
17         if (($? != 0)); then
18                 gsu_msg "fatal: could not get terminal geometry"
19                 exit 1
20         fi
21         x="${result#* }"
22         y="${result%% *}"
23         ((x > 190)) && x=190
24         result="$y $x"
25 }
26
27 _set_dialog_ret()
28 {
29         local ec="$1"
30
31         case "$ec" in
32         0) ret=$GSU_SUCCESS;;
33         1|255) ret=1;; # cancelled
34         *)
35                 result="dialog exit code $ec"
36                 ret=-$E_GSU_DIALOG
37         esac
38 }
39
40 # Open a dialog box which asks the user to input a text
41 #
42 # Usage: gsu_input_box <text> <init>
43 #
44 # <text> is displayed above of the input field, which is is preset to <init>.
45 # The entered text is returned in $result. On success (user pressed OK)
46 # the function returns zero. If the user selected Cancel, the return value is
47 # one. On dialog errors, a negative error code is returned.
48 gsu_inputbox()
49 {
50         local g text="$1" init="$2"
51
52         _get_geometry
53         g="$result"
54         result="$(dialog --inputbox "$text" $g "$init" 3>&1 1>&2 2>&3 3>&-)"
55         _set_dialog_ret $?
56 }
57
58 # Show the given file in a text box
59 #
60 # Usage: gsu_textbox <path>
61 #
62 # The box has an OK button which closes the box when activated.
63 gsu_textbox()
64 {
65         local g file="$1"
66
67         _get_geometry
68         g="$result"
69
70         ret=-$E_GSU_DIALOG
71         result='textbox'
72         dialog --textbox "$file" $g
73         _set_dialog_ret $?
74 }
75
76 # Show a message in a text box
77 #
78 # Usage: gsu_msgbox <text>
79 #
80 # This is like gsu_textbox() but the text is passed as a string.
81 gsu_msgbox()
82 {
83         local tmp
84
85         # Some versions of dialog segfault if the text is too long. Hence we
86         # always use a temporary file.
87         gsu_make_tempfile 'gsu_msgbox.XXXXXXXXXX'
88         ((ret < 0)) && return
89         tmp="$result"
90         trap "rm -f $tmp" EXIT
91         echo "$1" > "$tmp"
92         gsu_textbox "$tmp"
93         rm -f "$tmp" # ignore errors
94 }
95
96 _gsu_menu()
97 {
98         local header="${1:-root}"
99         local items="$2"
100         local geom
101
102         _get_geometry
103         geom=$result
104         result="$(dialog --no-lines --no-items --menu \
105                 "$gsu_banner_txt ($header)"  \
106                 $geom 16 $items 3>&1 1>&2 2>&3 3>&-)"
107         _set_dialog_ret $?
108 }
109
110 _get_level()
111 {
112         local tmp="${1%%$_gsu_node_name_pattern*}"
113         result="${#tmp}"
114 }
115
116 _get_subtree()
117 {
118         local tree="$1" root="${2%/}"
119         local first TAB='       '
120
121         ret=-$E_GSU_MENU_TREE
122         result="subtree grep failed"
123         first="$(grep -n "$TAB\{1,\}$root/" <<< "$tree")" || return
124         [[ -z "$first" ]] && return
125
126         line_num="${first%%:*}"
127         _get_level "${first#*:}"
128         level="$result"
129
130         #echo "line: $line_num, root: $root, indent level: $level"
131         result="$(sed -e "1,${line_num}d;" <<< "$tree" \
132                 | sed -e "/^$TAB\{1,$level\}$_gsu_node_name_pattern/,\$d" \
133                 | sed -e "/^$TAB\{$((level + 2))\}/d")"
134         if (($? != 0)); then
135                 ret=-$E_GSU_MENU_TREE
136                 result="sed command for subtree $root failed"
137                 return
138         fi
139         ret=$GSU_SUCCESS
140 }
141
142 _get_root_nodes()
143 {
144         local tree="$1" TAB='   '
145
146         result="$(grep "^${TAB}${_gsu_node_name_pattern}" <<< "$tree")"
147         if (($? != 0)); then
148                 ret=-$E_GSU_MENU_TREE
149                 result="root node grep failed"
150                 return
151         fi
152         ret=$GSU_SUCCESS
153 }
154
155 _browse()
156 {
157         local header="$1" old_header
158         local tree="$2" subtree="$3"
159
160         while :; do
161                 _gsu_menu "$header" "$subtree"
162                 ((ret < 0)) && return
163                 [[ -z "$result" ]] && return # menu was cancelled
164                 if [[ "${result%/}" != "$result" ]]; then
165                         old_header="$header"
166                         header="$result"
167                         _get_subtree "$tree" "$header"
168                         ((ret < 0)) && return
169                         _browse "$header" "$tree" "$result"
170                         ((ret < 0)) && return
171                         header="$old_header"
172                         continue
173                 fi
174                 eval ${gsu_name}_$result
175         done
176 }
177
178 gsu_gui()
179 {
180         local tree="$1" subtree
181
182         type -t dialog &> /dev/null
183         if (($? != 0)); then
184                 gsu_msg "dialog executable not found"
185                 exit 1
186         fi
187         _get_root_nodes "$tree"
188         subtree="$result"
189         _browse "main menu" "$tree" "$subtree"
190 }