Project

General

Profile

1
#!/bin/bash -e
2
set -o errexit # in case caller did not have -e in #! line
3

    
4
if test ! "$_util_sh_include_guard_utils"; then
5
_util_sh_include_guard_utils=1
6

    
7
function extern () { (exec "$@") || return; }
8

    
9
isset () { test -n "${!1+isset}"; }
10

    
11
realpath () { readlink -f -- "$1"; }
12

    
13
include_guard_var () { realpath "$1"|"extern" sed 's/[^a-zA-Z0-9_]/_/g'; }
14

    
15
self_not_included () # usage: if self_not_included; then ... fi
16
{
17
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
18
	local include_guard="$(include_guard_var "$1")"
19
	alias self_being_included=false
20
	! isset "$include_guard" && \
21
	{ eval "$include_guard"=1; alias self_being_included=true; }
22
}
23

    
24
# to load newly-defined aliases for use in functions in the same file:
25
## fi # load new aliases
26
## if self_being_included; then
27
# this is needed because aliases defined inside an if statement are not
28
# available inside that if statement
29

    
30
fi
31

    
32

    
33
if self_not_included "${BASH_SOURCE[0]}"; then
34

    
35

    
36
#### options
37

    
38
shopt -s expand_aliases
39

    
40

    
41
#### aliases
42

    
43
unalias () { builtin unalias "$@" 2>&- || true; } # no error if undefined
44

    
45

    
46
#### exceptions
47

    
48
# usage: cmd || { save_e; ...; rethrow; }
49
alias export_e='e=$?'
50
alias save_e='declare e=$?'
51
alias rethrow='return "$e"'
52
alias rethrow_subshell='exit "$e"'
53

    
54
fi # load new aliases
55
if self_being_included; then
56

    
57
# usage: cmd || die msg
58
die () { save_e; echo "$1" >&2; rethrow; }
59

    
60
# usage: cmd || { save_e; log_e; ...; rethrow; }
61
log_e () { echo "! command exited with error $e" >&2; }
62

    
63
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
64

    
65
function try () { e=0; "$@" || { export_e; true; }; }
66
alias try='declare e; try ' # last space alias-expands next word
67

    
68
catch () { test "$e" -eq "$1"; e=0; }
69

    
70
ignore () { catch "$@" || true; }
71

    
72
alias end_try='rethrow'
73
alias end_try_subshell='rethrow_subshell'
74

    
75
fi # load new aliases
76
if self_being_included; then
77

    
78

    
79
#### functions
80

    
81
func_exists () { declare -f "$1" >/dev/null; }
82

    
83
copy_func () # usage: from=... to=... copy_func
84
{
85
	: "${from:?}" "${to:?}"
86
	local from_def="$(declare -f "$from")"
87
	eval "$to${from_def#$from}"
88
}
89

    
90

    
91
#### integers
92

    
93
let () { builtin let "$@" || true; }
94
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
95

    
96
bool2int () { try test -z "$1"; echo "$e"; } # empty->0; non-empty->1
97

    
98

    
99
#### arrays
100

    
101
join () { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
102

    
103
reverse () # usage: array=($(reverse args...))
104
{
105
	local i
106
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
107
}
108

    
109

    
110
#### verbose output
111

    
112
# usage: (stdout2stderr; cmd...) || return
113
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
114
stdout2stderr () { exec >&2; }
115

    
116
# set verbosity
117
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
118
: "${verbosity=3}" # default
119
: "${verbosity:=0}" # ensure non-empty
120
declare -i verbosity # ensure integer
121
export verbosity # propagate the verbosity to invoked commands
122

    
123
can_log () { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
124

    
125
: "${log_indent=  }"
126

    
127
# usage: in func:      inc_log_level; ...
128
#        outside func: inc_log_level; ...; dec_log_level
129
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
130
let verbosity--'
131
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
132
let verbosity++'
133

    
134
fi # load new aliases
135
if self_being_included; then
136

    
137
# usage: (limit_stderr; cmd...) || return
138
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
139
limit_stderr () { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }
140

    
141
limit_stderr_cmd () # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
142
{
143
	case "$1" in echo_run) shift; echo_cmd "$@";; esac
144
	(limit_stderr
145
		if test -n "$stdout2stderr"; then stdout2stderr; fi
146
		"$@"
147
	) || return
148
}
149
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
150

    
151
echo_cmd () { if can_log; then echo "$PS4$*" >&2; fi; }
152

    
153
echo_run () { echo_cmd "$@"; "$@"; }
154

    
155
# auto-echo common external commands
156
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
157

    
158
# echo all external commands
159
alias extern="echo_run extern " # last space alias-expands next word
160

    
161
alias self='extern "$FUNCNAME"' # usage: wrapper () { self ...; }
162

    
163
# commands that are always external
164
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
165

    
166
canon_rel_path ()
167
{
168
	local path="$1"
169
	path="$(realpath "$path")" # canonicalize
170
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
171
	echo "$path"
172
}
173

    
174
function echo_func ()
175
{
176
	inc_log_level
177
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
178
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
179
}
180

    
181
# usage: cmd1 | { pipe_delay; cmd2; }
182
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
183

    
184
fi # load new aliases
185
if self_being_included; then
186

    
187
echo_stdin () # usage: input|echo_stdin|cmd
188
{
189
	inc_log_level
190
	if can_log; then
191
		pipe_delay
192
		echo ----- >&2
193
		tee -a /dev/stderr;
194
		echo ----- >&2
195
	else cat
196
	fi
197
}
198

    
199
echo_vars () # usage: echo_vars var...
200
{
201
	inc_log_level; inc_log_level
202
	if can_log; then
203
		local var
204
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
205
	fi
206
}
207

    
208
echo_export () { builtin export "$@"; echo_vars "$@"; }
209

    
210
if test "$verbosity" -ge 2; then
211
	alias export="echo_export" # automatically echo env vars when they are set
212
fi
213

    
214
usage () { echo "Usage: $1" >&2; (exit 2); }
215

    
216
fi # load new aliases
217
if self_being_included; then
218

    
219

    
220
#### strings
221

    
222
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
223

    
224
sed () { self -"$sed_ere_flag" "$@";}
225

    
226

    
227
#### vars
228

    
229
set_var () { eval "$1"'="$2"'; }
230

    
231
set_inv () { set_var no_"$1" "$(test -n "${!1}" || echo 1)"; }
232

    
233
# usage: local var=...; local_inv
234
alias local_inv='declare "no_$var=$(test -n "${!var}" || echo 1)"'
235

    
236
# usage: local prefix=..._; import_vars
237
alias import_vars="$(cat <<'EOF'
238
: "${prefix:?}"
239
local src_var dest_var
240
for src_var in $(eval echo '${!'$prefix'*}'); do
241
	dest_var="${src_var#$prefix}"
242
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
243
done
244
EOF
245
)"
246

    
247

    
248
#### commands
249

    
250
top_script="$0" # outermost script
251
top_dir="$(dirname "$top_script")"
252

    
253
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
254
function to_file () # usage: stdout=... to_file cmd...
255
{ : "${stdout?}"; "$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow;}; }
256
alias to_file='to_file ' # last space alias-expands next word
257

    
258
run_args_cmd () # runs the command line args command
259
{
260
	test $? -eq 0 || return
261
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
262
	test $# -ge 1 || set -- all
263
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
264
}
265

    
266
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
267
{
268
	echo_func
269
	: "${subdirs?}"
270
	
271
	for subdir in "${subdirs[@]}"; do
272
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
273
	done
274
}
275

    
276

    
277
#### URLs
278

    
279
localize_url () { test _"$1" = _"$(hostname -f)" || echo "$1"; }
280

    
281
fi
(5-5/5)