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 9074 aaronmk
isset() { test "${!1+isset}"; }
8 9002 aaronmk
9 9074 aaronmk
realpath() { readlink -f -- "$1"; }
10 8703 aaronmk
11 9075 aaronmk
include_guard_var() { realpath "$1"|"command" sed 's/[^a-zA-Z0-9_]/_/g'; }
12 8716 aaronmk
13 9074 aaronmk
self_not_included() # usage: if self_not_included; then ... fi
14 8703 aaronmk
{
15 8971 aaronmk
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
16 8703 aaronmk
	local include_guard="$(include_guard_var "$1")"
17 8793 aaronmk
	alias self_being_included=false
18 9003 aaronmk
	! isset "$include_guard" && \
19 8793 aaronmk
	{ eval "$include_guard"=1; alias self_being_included=true; }
20 8703 aaronmk
}
21
22 8793 aaronmk
# to load newly-defined aliases for use in functions in the same file:
23
## fi # load new aliases
24
## if self_being_included; then
25
# this is needed because aliases defined inside an if statement are not
26
# available inside that if statement
27
28 9018 aaronmk
fi
29 9017 aaronmk
30 9018 aaronmk
31 8704 aaronmk
if self_not_included "${BASH_SOURCE[0]}"; then
32
33 9017 aaronmk
34
#### options
35
36 8709 aaronmk
shopt -s expand_aliases
37
38 9017 aaronmk
39
#### aliases
40
41 9074 aaronmk
unalias() { builtin unalias "$@" 2>&- || true; } # no error if undefined
42 8889 aaronmk
43 9017 aaronmk
44 9082 aaronmk
#### functions
45
46
alias self='command "$FUNCNAME"' # usage: wrapper() { self ...; }
47
48
49 8886 aaronmk
#### exceptions
50
51 9032 aaronmk
# usage: cmd || { save_e; ...; rethrow; }
52 9031 aaronmk
alias export_e='e=$?'
53 9032 aaronmk
alias save_e='declare e=$?'
54 8976 aaronmk
alias rethrow='return "$e"'
55
alias rethrow_subshell='exit "$e"'
56
57 8978 aaronmk
fi # load new aliases
58
if self_being_included; then
59
60 8886 aaronmk
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
61
62 9074 aaronmk
function try() { e=0; "$@" || { export_e; true; }; }
63 8980 aaronmk
alias try='declare e; try ' # last space alias-expands next word
64 8886 aaronmk
65 9074 aaronmk
catch() { test "$e" -eq "$1"; e=0; }
66 8886 aaronmk
67 9074 aaronmk
ignore() { catch "$@" || true; }
68 8886 aaronmk
69 8977 aaronmk
alias end_try='rethrow'
70
alias end_try_subshell='rethrow_subshell'
71 8886 aaronmk
72 9020 aaronmk
fi # load new aliases
73
if self_being_included; then
74 9017 aaronmk
75 9020 aaronmk
76 8899 aaronmk
#### integers
77
78 9074 aaronmk
let!() { let "$@" || true; } # always returns true; safe to use for setting
79 8899 aaronmk
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
80
81 9074 aaronmk
bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
82 9004 aaronmk
83 9017 aaronmk
84 9079 aaronmk
#### strings
85
86 9081 aaronmk
repeat() # usage: str=... n=... repeat
87
{
88
	: "${str?}" "${n:?}"; local n="$n" # will be modified in function
89
	for (( ; n > 0; n-- )); do printf '%q' "$str"; done
90
}
91
92 9079 aaronmk
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
93
94
sed() { self -"$sed_ere_flag" "$@";}
95
96 9085 aaronmk
rtrim() { sed 's/[[:space:]]+$//' <<<"$1"; }
97 9079 aaronmk
98 9085 aaronmk
99 8854 aaronmk
#### arrays
100 8694 aaronmk
101 9074 aaronmk
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
102 8816 aaronmk
103 9074 aaronmk
reverse() # usage: array=($(reverse args...))
104 8691 aaronmk
{
105
	local i
106 9080 aaronmk
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
107 8691 aaronmk
}
108
109 9097 aaronmk
contains() # usage: contains value in_array...
110
{
111
	local value="$1"; shift
112
	local elem
113
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
114
	return 1
115
}
116 9017 aaronmk
117 9097 aaronmk
118 9040 aaronmk
#### paths
119
120 9074 aaronmk
canon_rel_path()
121 9040 aaronmk
{
122
	local path="$1"
123
	path="$(realpath "$path")" # canonicalize
124
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
125
	echo "$path"
126
}
127
128 9051 aaronmk
# makes $1 a canon_rel_path if it's a filesystem path
129
alias cmd2rel_path="$(cat <<'EOF'
130
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
131
	declare _1="$1"; shift
132
	set -- "$(canon_rel_path "$_1")" "$@"
133
fi
134
EOF
135
)"
136 9040 aaronmk
137 9051 aaronmk
138 8854 aaronmk
#### verbose output
139
140 9110 aaronmk
141 8973 aaronmk
# usage: (stdout2stderr; cmd...) || return
142 9112 aaronmk
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
143 9074 aaronmk
stdout2stderr() { exec >&2; }
144 8914 aaronmk
145 9111 aaronmk
usage() { echo "Usage: $1" >&2; return 2; }
146 9110 aaronmk
147
148
### logging
149
150 9006 aaronmk
# set verbosity
151 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
152 9006 aaronmk
: "${verbosity=3}" # default
153
: "${verbosity:=0}" # ensure non-empty
154 9007 aaronmk
declare -i verbosity # ensure integer
155 9119 aaronmk
export verbosity # propagate to invoked commands
156 8710 aaronmk
157 9074 aaronmk
can_log() { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
158 8895 aaronmk
159 9119 aaronmk
log() { if can_log; then echo "$log_indent$PS4$1" >&2; fi; }
160 9064 aaronmk
161 9070 aaronmk
# usage: symbol=... log_custom msg
162 9074 aaronmk
log_custom() { local PS4="${PS4%[^ ] }$symbol "; log "$@"; }
163 9070 aaronmk
164 9074 aaronmk
log_err() { symbol=! log_custom "$@"; }
165 9070 aaronmk
166 9074 aaronmk
log_info() { symbol=? log_custom "$@"; }
167 9070 aaronmk
168 9067 aaronmk
# usage: cmd || { save_e; log_e; ...; rethrow; }
169 9074 aaronmk
log_e() { log_err "command exited with error $e"; }
170 9067 aaronmk
171 9072 aaronmk
# usage: cmd || [type=...] die msg
172 9074 aaronmk
die() { save_e; "log_${type:-err}" "$1"; rethrow; }
173 9069 aaronmk
174 9119 aaronmk
: "${log_level_indent=  }" "${log_indent=}"
175
export log_level_indent log_indent # propagate to invoked commands
176
alias cmd_indent='declare log_indent="$log_indent$log_level_indent"'
177 8919 aaronmk
178 9076 aaronmk
# usage: in func:      indent; ...
179
#        outside func: indent; ...; outdent
180 9120 aaronmk
alias indent='declare PS4="${PS4:0:1}$PS4"'
181
alias outdent='declare PS4="${PS4#${PS4:0:1}}"'
182 9076 aaronmk
183 8900 aaronmk
# usage: in func:      inc_log_level; ...
184
#        outside func: inc_log_level; ...; dec_log_level
185 9076 aaronmk
alias inc_log_level='indent;  declare verbosity="$verbosity"; let! verbosity--'
186
alias dec_log_level='outdent; declare verbosity="$verbosity"; let! verbosity++'
187 8900 aaronmk
188 8995 aaronmk
fi # load new aliases
189
if self_being_included; then
190
191 9110 aaronmk
192
### command echoing
193
194 9074 aaronmk
echo_cmd()
195 9056 aaronmk
{
196 9096 aaronmk
	case "$1" in command) # command implied by the log_level
197
		shift
198
		case "$1" in --) shift;; esac
199
	;; esac
200 9065 aaronmk
	log "$*"
201 9056 aaronmk
}
202
203 9123 aaronmk
## internal commands
204
205
echo_eval() { log "$*"; builtin eval "$@"; }
206
207 9110 aaronmk
## external commands
208
209 9134 aaronmk
function command() # usage: [stderr_is_errors=1] command extern_cmd...
210
{
211
	set -- -- "$@" # prepend -- so command name not treated as `command` option
212
	set -- builtin command "$@"
213
	if test "$stderr_is_errors"; then "$@" 2>&22 # ensure errors are visible
214
	else "$@"; fi
215
}
216 9133 aaronmk
217 9119 aaronmk
alias echo_run_prep='cmd2rel_path; echo_cmd "$@"; cmd_indent'
218 9056 aaronmk
219 9109 aaronmk
fi # load new aliases
220
if self_being_included; then
221
222
echo_run() { echo_run_prep; "$@"; }
223
224 9110 aaronmk
# auto-echo common external commands
225
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
226
227
# echo all external commands
228 9133 aaronmk
alias command='echo_run command ' # last space alias-expands next word
229 9110 aaronmk
230
# commands that are always external
231
for cmd in env; do alias "$cmd=command $cmd"; done; unset cmd
232
233
## functions
234
235
function echo_func()
236
{
237
	inc_log_level
238
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
239
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
240
}
241
alias echo_func='echo_func "$@"'
242 9124 aaronmk
alias echo_minor_func='(inc_log_level; echo_func)'
243 9110 aaronmk
244
## vars
245
246
echo_vars() # usage: echo_vars var...
247
{
248
	inc_log_level; inc_log_level
249
	if can_log; then
250
		local var
251 9121 aaronmk
		for var in "${@%%=*}"; do log "$(declare -p "$var")"; done
252 9110 aaronmk
	fi
253
}
254
255
echo_export() { builtin export "$@"; echo_vars "$@"; }
256
257
if test "$verbosity" -ge 2; then
258
	alias export="echo_export" # automatically echo env vars when they are set
259
fi
260
261
262
### external command verbose output
263
264 9104 aaronmk
# usage: ([stdout2stderr=1] limit_stderr; cmd...) || return
265 9103 aaronmk
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
266 9107 aaronmk
function limit_stderr()
267 9104 aaronmk
{
268 9116 aaronmk
	inc_log_level # should only apply during this function for use by can_log
269 9115 aaronmk
	if test "$stdout2stderr"; then
270
		if ! can_log; then exec 1>/dev/null; else stdout2stderr; fi
271
	else
272
		if ! can_log; then exec 2>/dev/null; fi
273
	fi
274 9104 aaronmk
}
275 8904 aaronmk
276 9074 aaronmk
limit_stderr_cmd() # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
277 8915 aaronmk
{
278 9109 aaronmk
	case "$1" in echo_run) shift; echo_run_prep;; esac
279 9108 aaronmk
	(limit_stderr; "$@") || return
280 8915 aaronmk
}
281 9008 aaronmk
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
282 8911 aaronmk
283 8984 aaronmk
284 9110 aaronmk
### external command input/output
285 8907 aaronmk
286 8997 aaronmk
# usage: cmd1 | { pipe_delay; cmd2; }
287
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
288
289
fi # load new aliases
290
if self_being_included; then
291
292 9074 aaronmk
echo_stdin() # usage: input|echo_stdin|cmd
293 8702 aaronmk
{
294 8901 aaronmk
	inc_log_level
295 8897 aaronmk
	if can_log; then
296 8998 aaronmk
		pipe_delay
297 8897 aaronmk
		echo ----- >&2
298
		tee -a /dev/stderr;
299
		echo ----- >&2
300
	else cat
301
	fi
302 8702 aaronmk
}
303 8275 aaronmk
304 9044 aaronmk
alias echo_stdout='echo_stdin' # usage: cmd|echo_stdout
305
306 8873 aaronmk
fi # load new aliases
307
if self_being_included; then
308
309 9017 aaronmk
310 9125 aaronmk
#### streams
311
312 9129 aaronmk
fd_exists() { (: <&"$1") 2>/dev/null; }
313 9125 aaronmk
314
require_fd_not_exists() # usage: require_fd_not_exists fd || return 0
315
{ ! fd_exists "$1" || type=info die "fd $1 already exists, skipping"; }
316
317 9129 aaronmk
set_fd() # usage: dest=fd dir='[<>]' src=fd [noclobber=1] set_fd
318 9125 aaronmk
{
319
	inc_log_level; echo_func
320
	: "${dest:?}" "${dir:?}" "${src:?}"
321
	test ! "$noclobber" || require_fd_not_exists "$dest" || return 0
322
	echo_eval exec "$dest$dir&$src"
323
}
324
325 9129 aaronmk
shadow_fd() # usage: prefix=# src=fd dir='[<>]' shadow_fd
326 9125 aaronmk
{
327
	echo_minor_func
328
	: "${prefix:?}" "${src:?}" "${dir:?}"
329
	dest="$prefix$src" noclobber=1 set_fd
330
}
331
332 9126 aaronmk
# convention: use fd 10/11/12 for command-specific alternate stdin/stdout/stderr
333 9125 aaronmk
334 9129 aaronmk
set_global_fds()
335 9128 aaronmk
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
336 9127 aaronmk
# this works even when /dev/tty isn't available
337 9128 aaronmk
{
338 9132 aaronmk
	inc_log_level; echo_func
339 9128 aaronmk
	local prefix=2
340
	# ignore errors if a source fd isn't open
341
	src=0 dir='<' shadow_fd || true
342
	src=1 dir='>' shadow_fd || true
343
	src=2 dir='>' shadow_fd || true
344
}
345
set_global_fds
346 9126 aaronmk
347 9127 aaronmk
348 8854 aaronmk
#### vars
349
350 9074 aaronmk
set_var() { eval "$1"'="$2"'; }
351 8854 aaronmk
352 9074 aaronmk
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
353 8857 aaronmk
354 8859 aaronmk
# usage: local var=...; local_inv
355 9050 aaronmk
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
356 8859 aaronmk
357 9090 aaronmk
get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }
358
359 8863 aaronmk
# usage: local prefix=..._; import_vars
360 9093 aaronmk
# when used inside another alias 2+ levels deep, *must* be run inside a function
361 8863 aaronmk
alias import_vars="$(cat <<'EOF'
362
: "${prefix:?}"
363 9089 aaronmk
declare src_var dest_var
364 9091 aaronmk
for src_var in $(get_prefix_vars); do
365 8863 aaronmk
	dest_var="${src_var#$prefix}"
366 9089 aaronmk
	declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
367 8863 aaronmk
done
368
EOF
369
)"
370
371 9017 aaronmk
372 9068 aaronmk
#### functions
373
374 9074 aaronmk
func_exists() { declare -f "$1" >/dev/null; }
375 9068 aaronmk
376 9074 aaronmk
copy_func() # usage: from=... to=... copy_func
377 9068 aaronmk
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
378
{
379
	: "${from:?}" "${to:?}"
380
	func_exists "$from" || die "function does not exist: $from"
381
	! func_exists "$to" || die "function already exists: $to"
382
	local from_def="$(declare -f "$from")"
383
	eval "$to${from_def#$from}"
384
}
385
386 9074 aaronmk
func_override() # usage: func_override old_name__suffix
387 9068 aaronmk
{ from="${1%%__*}" to="$1" copy_func; }
388
389 9098 aaronmk
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
390
{
391
	local nested_func="${FUNCNAME[1]}"
392
	local func="${nested_func%%__*}"
393
	contains "$func" "${FUNCNAME[@]}" || \
394
		die "$nested_func() must be used by $func()"
395
}
396 9068 aaronmk
397 9098 aaronmk
398 8854 aaronmk
#### commands
399
400 8934 aaronmk
top_script="$0" # outermost script
401
top_dir="$(dirname "$top_script")"
402 8272 aaronmk
403 9122 aaronmk
require_not_exists() # usage: require_not_exists file || return 0
404 9073 aaronmk
{ test ! -e "$1" || type=info die "file "$1" already exists, skipping"; }
405 9062 aaronmk
406 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
407 9074 aaronmk
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
408 9048 aaronmk
{
409
	echo_func
410
	: "${stdout?}"; echo_vars stdout
411 9122 aaronmk
	test ! "$if_not_exists" || require_not_exists "$stdout" || return 0
412 9048 aaronmk
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
413
}
414 8986 aaronmk
alias to_file='to_file ' # last space alias-expands next word
415
416 9074 aaronmk
run_args_cmd() # runs the command line args command
417 8272 aaronmk
{
418 8971 aaronmk
	test $? -eq 0 || return
419 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
420 8971 aaronmk
	test $# -ge 1 || set -- all
421 8648 aaronmk
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
422 8272 aaronmk
}
423
424 9074 aaronmk
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
425 8272 aaronmk
{
426 8881 aaronmk
	echo_func
427 8284 aaronmk
	: "${subdirs?}"
428
429 8272 aaronmk
	for subdir in "${subdirs[@]}"; do
430 8280 aaronmk
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
431 8272 aaronmk
	done
432
}
433
434 9017 aaronmk
435 8966 aaronmk
#### URLs
436
437 9074 aaronmk
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
438 8966 aaronmk
439 8704 aaronmk
fi