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 || { save_e; log_e; ...; rethrow; }
58
log_e () { echo "! command exited with error $e" >&2; }
59

    
60
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
61

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

    
65
catch () { test "$e" -eq "$1"; e=0; }
66

    
67
ignore () { catch "$@" || true; }
68

    
69
alias end_try='rethrow'
70
alias end_try_subshell='rethrow_subshell'
71

    
72
fi # load new aliases
73
if self_being_included; then
74

    
75

    
76
#### functions
77

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

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

    
87

    
88
#### integers
89

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

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

    
95

    
96
#### arrays
97

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

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

    
106

    
107
#### verbose output
108

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

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

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

    
122
: "${log_indent=  }"
123

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

    
131
fi # load new aliases
132
if self_being_included; then
133

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

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

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

    
150
echo_run () { echo_cmd "$@"; "$@"; }
151

    
152
# auto-echo common external commands
153
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
154

    
155
# echo all external commands
156
alias extern="echo_run extern " # last space alias-expands next word
157

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

    
160
# commands that are always external
161
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
162

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

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

    
178
# usage: cmd1 | { pipe_delay; cmd2; }
179
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
180

    
181
fi # load new aliases
182
if self_being_included; then
183

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

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

    
205
echo_export () { builtin export "$@"; echo_vars "$@"; }
206

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

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

    
213
fi # load new aliases
214
if self_being_included; then
215

    
216

    
217
#### strings
218

    
219
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
220

    
221
sed () { self -"$sed_ere_flag" "$@";}
222

    
223

    
224
#### vars
225

    
226
set_var () { eval "$1"'="$2"'; }
227

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

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

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

    
244

    
245
#### commands
246

    
247
top_script="$0" # outermost script
248
top_dir="$(dirname "$top_script")"
249

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

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

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

    
273

    
274
#### URLs
275

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

    
278
fi
(5-5/5)