Project

General

Profile

1 8291 aaronmk
#!/bin/bash -e
2 8952 aaronmk
set -o errexit # in case caller did not have -e in #! line
3
4 9018 aaronmk
if test ! "$_util_sh_include_guard_utils"; then
5
_util_sh_include_guard_utils=1
6
7 8957 aaronmk
function extern () { (exec "$@") || return; }
8 8917 aaronmk
9 9050 aaronmk
isset () { test "${!1+isset}"; }
10 9002 aaronmk
11 8716 aaronmk
realpath () { readlink -f -- "$1"; }
12 8703 aaronmk
13 8917 aaronmk
include_guard_var () { realpath "$1"|"extern" sed 's/[^a-zA-Z0-9_]/_/g'; }
14 8716 aaronmk
15 8703 aaronmk
self_not_included () # usage: if self_not_included; then ... fi
16
{
17 8971 aaronmk
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
18 8703 aaronmk
	local include_guard="$(include_guard_var "$1")"
19 8793 aaronmk
	alias self_being_included=false
20 9003 aaronmk
	! isset "$include_guard" && \
21 8793 aaronmk
	{ eval "$include_guard"=1; alias self_being_included=true; }
22 8703 aaronmk
}
23
24 8793 aaronmk
# 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 9018 aaronmk
fi
31 9017 aaronmk
32 9018 aaronmk
33 8704 aaronmk
if self_not_included "${BASH_SOURCE[0]}"; then
34
35 9017 aaronmk
36
#### options
37
38 8709 aaronmk
shopt -s expand_aliases
39
40 9017 aaronmk
41
#### aliases
42
43 8889 aaronmk
unalias () { builtin unalias "$@" 2>&- || true; } # no error if undefined
44
45 9017 aaronmk
46 8886 aaronmk
#### exceptions
47
48 9032 aaronmk
# usage: cmd || { save_e; ...; rethrow; }
49 9031 aaronmk
alias export_e='e=$?'
50 9032 aaronmk
alias save_e='declare e=$?'
51 8976 aaronmk
alias rethrow='return "$e"'
52
alias rethrow_subshell='exit "$e"'
53
54 8978 aaronmk
fi # load new aliases
55
if self_being_included; then
56
57 8886 aaronmk
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
58
59 9031 aaronmk
function try () { e=0; "$@" || { export_e; true; }; }
60 8980 aaronmk
alias try='declare e; try ' # last space alias-expands next word
61 8886 aaronmk
62
catch () { test "$e" -eq "$1"; e=0; }
63
64
ignore () { catch "$@" || true; }
65
66 8977 aaronmk
alias end_try='rethrow'
67
alias end_try_subshell='rethrow_subshell'
68 8886 aaronmk
69 9020 aaronmk
fi # load new aliases
70
if self_being_included; then
71 9017 aaronmk
72 9020 aaronmk
73 8899 aaronmk
#### integers
74
75 9041 aaronmk
let! () { let "$@" || true; } # always returns true; safe to use for setting
76 8899 aaronmk
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
77
78 9050 aaronmk
bool2int () { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
79 9004 aaronmk
80 9017 aaronmk
81 8854 aaronmk
#### arrays
82 8694 aaronmk
83 8833 aaronmk
join () { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
84 8816 aaronmk
85 8691 aaronmk
reverse () # usage: array=($(reverse args...))
86
{
87
	local i
88
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
89
}
90
91 9017 aaronmk
92 9040 aaronmk
#### paths
93
94
canon_rel_path ()
95
{
96
	local path="$1"
97
	path="$(realpath "$path")" # canonicalize
98
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
99
	echo "$path"
100
}
101
102 9051 aaronmk
# makes $1 a canon_rel_path if it's a filesystem path
103
alias cmd2rel_path="$(cat <<'EOF'
104
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
105
	declare _1="$1"; shift
106
	set -- "$(canon_rel_path "$_1")" "$@"
107
fi
108
EOF
109
)"
110 9040 aaronmk
111 9051 aaronmk
112 8854 aaronmk
#### verbose output
113
114 8973 aaronmk
# usage: (stdout2stderr; cmd...) || return
115
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
116 8914 aaronmk
stdout2stderr () { exec >&2; }
117
118 9006 aaronmk
# set verbosity
119 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
120 9006 aaronmk
: "${verbosity=3}" # default
121
: "${verbosity:=0}" # ensure non-empty
122 9007 aaronmk
declare -i verbosity # ensure integer
123 9000 aaronmk
export verbosity # propagate the verbosity to invoked commands
124 8710 aaronmk
125 8898 aaronmk
can_log () { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
126 8895 aaronmk
127 9064 aaronmk
log () { if can_log; then echo "$PS4$1" >&2; fi; }
128
129 9070 aaronmk
# usage: symbol=... log_custom msg
130
log_custom () { local PS4="${PS4%[^ ] }$symbol "; log "$@"; }
131
132
log_err () { symbol=! log_custom "$@"; }
133
134
log_info () { symbol=? log_custom "$@"; }
135
136 9067 aaronmk
# usage: cmd || { save_e; log_e; ...; rethrow; }
137 9071 aaronmk
log_e () { log_err "command exited with error $e"; }
138 9067 aaronmk
139 9069 aaronmk
# usage: cmd || die msg
140
die () { save_e; echo "$1" >&2; rethrow; }
141
142 8920 aaronmk
: "${log_indent=  }"
143 8919 aaronmk
144 8900 aaronmk
# usage: in func:      inc_log_level; ...
145
#        outside func: inc_log_level; ...; dec_log_level
146 8919 aaronmk
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
147 9041 aaronmk
let! verbosity--'
148 8919 aaronmk
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
149 9041 aaronmk
let! verbosity++'
150 8900 aaronmk
151 8995 aaronmk
fi # load new aliases
152
if self_being_included; then
153
154 9056 aaronmk
echo_cmd ()
155
{
156 9065 aaronmk
	case "$1" in extern) shift;; esac # extern implied by the log_level
157
	log "$*"
158 9056 aaronmk
}
159
160
echo_run () { cmd2rel_path; echo_cmd "$@"; "$@"; }
161
162 8994 aaronmk
# usage: (limit_stderr; cmd...) || return
163 8973 aaronmk
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
164 8995 aaronmk
limit_stderr () { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }
165 8904 aaronmk
166 8994 aaronmk
limit_stderr_cmd () # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
167 8915 aaronmk
{
168 9057 aaronmk
	case "$1" in echo_run) shift; cmd2rel_path; echo_cmd "$@";; esac
169 8994 aaronmk
	(limit_stderr
170 9050 aaronmk
		if test "$stdout2stderr"; then stdout2stderr; fi
171 8915 aaronmk
		"$@"
172 8955 aaronmk
	) || return
173 8915 aaronmk
}
174 9008 aaronmk
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
175 8911 aaronmk
176 8984 aaronmk
# auto-echo common external commands
177
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
178
179 9011 aaronmk
# echo all external commands
180
alias extern="echo_run extern " # last space alias-expands next word
181 8907 aaronmk
182 8929 aaronmk
alias self='extern "$FUNCNAME"' # usage: wrapper () { self ...; }
183
184 8908 aaronmk
# commands that are always external
185
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
186 8872 aaronmk
187 8909 aaronmk
function echo_func ()
188 8463 aaronmk
{
189 8901 aaronmk
	inc_log_level
190 8647 aaronmk
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
191
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
192 8463 aaronmk
}
193 8885 aaronmk
194 8997 aaronmk
# usage: cmd1 | { pipe_delay; cmd2; }
195
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
196
197
fi # load new aliases
198
if self_being_included; then
199
200 8702 aaronmk
echo_stdin () # usage: input|echo_stdin|cmd
201
{
202 8901 aaronmk
	inc_log_level
203 8897 aaronmk
	if can_log; then
204 8998 aaronmk
		pipe_delay
205 8897 aaronmk
		echo ----- >&2
206
		tee -a /dev/stderr;
207
		echo ----- >&2
208
	else cat
209
	fi
210 8702 aaronmk
}
211 8275 aaronmk
212 9044 aaronmk
alias echo_stdout='echo_stdin' # usage: cmd|echo_stdout
213
214 8856 aaronmk
echo_vars () # usage: echo_vars var...
215 8901 aaronmk
{
216 8922 aaronmk
	inc_log_level; inc_log_level
217 8921 aaronmk
	if can_log; then
218
		local var
219
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
220
	fi
221 8901 aaronmk
}
222 8641 aaronmk
223 9019 aaronmk
echo_export () { builtin export "$@"; echo_vars "$@"; }
224 8641 aaronmk
225 8713 aaronmk
if test "$verbosity" -ge 2; then
226 8711 aaronmk
	alias export="echo_export" # automatically echo env vars when they are set
227
fi
228 8642 aaronmk
229 8272 aaronmk
usage () { echo "Usage: $1" >&2; (exit 2); }
230
231 8873 aaronmk
fi # load new aliases
232
if self_being_included; then
233
234 9017 aaronmk
235 8871 aaronmk
#### strings
236
237
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
238
239 8930 aaronmk
sed () { self -"$sed_ere_flag" "$@";}
240 8871 aaronmk
241 9017 aaronmk
242 8854 aaronmk
#### vars
243
244
set_var () { eval "$1"'="$2"'; }
245
246 9050 aaronmk
set_inv () { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
247 8857 aaronmk
248 8859 aaronmk
# usage: local var=...; local_inv
249 9050 aaronmk
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
250 8859 aaronmk
251 8863 aaronmk
# usage: local prefix=..._; import_vars
252
alias import_vars="$(cat <<'EOF'
253
: "${prefix:?}"
254
local src_var dest_var
255
for src_var in $(eval echo '${!'$prefix'*}'); do
256
	dest_var="${src_var#$prefix}"
257
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
258
done
259
EOF
260
)"
261
262 9017 aaronmk
263 9068 aaronmk
#### functions
264
265
func_exists () { declare -f "$1" >/dev/null; }
266
267
copy_func () # usage: from=... to=... copy_func
268
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
269
{
270
	: "${from:?}" "${to:?}"
271
	func_exists "$from" || die "function does not exist: $from"
272
	! func_exists "$to" || die "function already exists: $to"
273
	local from_def="$(declare -f "$from")"
274
	eval "$to${from_def#$from}"
275
}
276
277
func_override () # usage: func_override old_name__suffix
278
{ from="${1%%__*}" to="$1" copy_func; }
279
280
281 8854 aaronmk
#### commands
282
283 8934 aaronmk
top_script="$0" # outermost script
284
top_dir="$(dirname "$top_script")"
285 8272 aaronmk
286 9062 aaronmk
require_exists () # usage: require_exists file || return 0
287
{ test ! -e "$1" || die "? file "$1" already exists, skipping"; }
288
289 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
290 9058 aaronmk
function to_file () # usage: stdout=... [if_not_exists=1] to_file cmd...
291 9048 aaronmk
{
292
	echo_func
293
	: "${stdout?}"; echo_vars stdout
294 9063 aaronmk
	test ! "$if_not_exists" || require_exists "$stdout" || return 0
295 9048 aaronmk
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
296
}
297 8986 aaronmk
alias to_file='to_file ' # last space alias-expands next word
298
299 8465 aaronmk
run_args_cmd () # runs the command line args command
300 8272 aaronmk
{
301 8971 aaronmk
	test $? -eq 0 || return
302 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
303 8971 aaronmk
	test $# -ge 1 || set -- all
304 8648 aaronmk
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
305 8272 aaronmk
}
306
307 8284 aaronmk
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
308 8272 aaronmk
{
309 8881 aaronmk
	echo_func
310 8284 aaronmk
	: "${subdirs?}"
311
312 8272 aaronmk
	for subdir in "${subdirs[@]}"; do
313 8280 aaronmk
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
314 8272 aaronmk
	done
315
}
316
317 9017 aaronmk
318 8966 aaronmk
#### URLs
319
320
localize_url () { test _"$1" = _"$(hostname -f)" || echo "$1"; }
321
322 8704 aaronmk
fi