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 8973 aaronmk
# usage: (stdout2stderr; cmd...) || return
141 9074 aaronmk
# `|| return` needed on Mac because of bug where -e doesn't apply to()
142
stdout2stderr() { exec >&2; }
143 8914 aaronmk
144 9006 aaronmk
# set verbosity
145 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
146 9006 aaronmk
: "${verbosity=3}" # default
147
: "${verbosity:=0}" # ensure non-empty
148 9007 aaronmk
declare -i verbosity # ensure integer
149 9077 aaronmk
export PS4 verbosity # propagate indent and verbosity to invoked commands
150 8710 aaronmk
151 9074 aaronmk
can_log() { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
152 8895 aaronmk
153 9074 aaronmk
log() { if can_log; then echo "$PS4$1" >&2; fi; }
154 9064 aaronmk
155 9070 aaronmk
# usage: symbol=... log_custom msg
156 9074 aaronmk
log_custom() { local PS4="${PS4%[^ ] }$symbol "; log "$@"; }
157 9070 aaronmk
158 9074 aaronmk
log_err() { symbol=! log_custom "$@"; }
159 9070 aaronmk
160 9074 aaronmk
log_info() { symbol=? log_custom "$@"; }
161 9070 aaronmk
162 9067 aaronmk
# usage: cmd || { save_e; log_e; ...; rethrow; }
163 9074 aaronmk
log_e() { log_err "command exited with error $e"; }
164 9067 aaronmk
165 9072 aaronmk
# usage: cmd || [type=...] die msg
166 9074 aaronmk
die() { save_e; "log_${type:-err}" "$1"; rethrow; }
167 9069 aaronmk
168 8920 aaronmk
: "${log_indent=  }"
169 8919 aaronmk
170 9076 aaronmk
# usage: in func:      indent; ...
171
#        outside func: indent; ...; outdent
172
alias indent='declare PS4="$log_indent$PS4"'
173
alias outdent='declare PS4="${PS4#$log_indent}"'
174
175 8900 aaronmk
# usage: in func:      inc_log_level; ...
176
#        outside func: inc_log_level; ...; dec_log_level
177 9076 aaronmk
alias inc_log_level='indent;  declare verbosity="$verbosity"; let! verbosity--'
178
alias dec_log_level='outdent; declare verbosity="$verbosity"; let! verbosity++'
179 8900 aaronmk
180 8995 aaronmk
fi # load new aliases
181
if self_being_included; then
182
183 9074 aaronmk
echo_cmd()
184 9056 aaronmk
{
185 9096 aaronmk
	case "$1" in command) # command implied by the log_level
186
		shift
187
		case "$1" in --) shift;; esac
188
	;; esac
189 9065 aaronmk
	log "$*"
190 9056 aaronmk
}
191
192 9078 aaronmk
echo_run() { cmd2rel_path; echo_cmd "$@"; indent; "$@"; }
193 9056 aaronmk
194 8994 aaronmk
# usage: (limit_stderr; cmd...) || return
195 9103 aaronmk
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
196 9074 aaronmk
limit_stderr() { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }
197 8904 aaronmk
198 9074 aaronmk
limit_stderr_cmd() # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
199 8915 aaronmk
{
200 9057 aaronmk
	case "$1" in echo_run) shift; cmd2rel_path; echo_cmd "$@";; esac
201 8994 aaronmk
	(limit_stderr
202 9050 aaronmk
		if test "$stdout2stderr"; then stdout2stderr; fi
203 9078 aaronmk
		indent; "$@"
204 8955 aaronmk
	) || return
205 8915 aaronmk
}
206 9008 aaronmk
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
207 8911 aaronmk
208 8984 aaronmk
# auto-echo common external commands
209
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
210
211 9011 aaronmk
# echo all external commands
212 9096 aaronmk
alias command="echo_run command -- " # last space alias-expands next word
213 8907 aaronmk
214 8908 aaronmk
# commands that are always external
215 9075 aaronmk
for cmd in env; do alias "$cmd=command $cmd"; done; unset cmd
216 8872 aaronmk
217 9074 aaronmk
function echo_func()
218 8463 aaronmk
{
219 8901 aaronmk
	inc_log_level
220 8647 aaronmk
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
221
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
222 8463 aaronmk
}
223 9092 aaronmk
alias echo_func='echo_func "$@"'
224 8885 aaronmk
225 8997 aaronmk
# usage: cmd1 | { pipe_delay; cmd2; }
226
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
227
228
fi # load new aliases
229
if self_being_included; then
230
231 9074 aaronmk
echo_stdin() # usage: input|echo_stdin|cmd
232 8702 aaronmk
{
233 8901 aaronmk
	inc_log_level
234 8897 aaronmk
	if can_log; then
235 8998 aaronmk
		pipe_delay
236 8897 aaronmk
		echo ----- >&2
237
		tee -a /dev/stderr;
238
		echo ----- >&2
239
	else cat
240
	fi
241 8702 aaronmk
}
242 8275 aaronmk
243 9044 aaronmk
alias echo_stdout='echo_stdin' # usage: cmd|echo_stdout
244
245 9074 aaronmk
echo_vars() # usage: echo_vars var...
246 8901 aaronmk
{
247 8922 aaronmk
	inc_log_level; inc_log_level
248 8921 aaronmk
	if can_log; then
249
		local var
250
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
251
	fi
252 8901 aaronmk
}
253 8641 aaronmk
254 9074 aaronmk
echo_export() { builtin export "$@"; echo_vars "$@"; }
255 8641 aaronmk
256 8713 aaronmk
if test "$verbosity" -ge 2; then
257 8711 aaronmk
	alias export="echo_export" # automatically echo env vars when they are set
258
fi
259 8642 aaronmk
260 9074 aaronmk
usage() { echo "Usage: $1" >&2; (exit 2); }
261 8272 aaronmk
262 8873 aaronmk
fi # load new aliases
263
if self_being_included; then
264
265 9017 aaronmk
266 8854 aaronmk
#### vars
267
268 9074 aaronmk
set_var() { eval "$1"'="$2"'; }
269 8854 aaronmk
270 9074 aaronmk
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
271 8857 aaronmk
272 8859 aaronmk
# usage: local var=...; local_inv
273 9050 aaronmk
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
274 8859 aaronmk
275 9090 aaronmk
get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }
276
277 8863 aaronmk
# usage: local prefix=..._; import_vars
278 9093 aaronmk
# when used inside another alias 2+ levels deep, *must* be run inside a function
279 8863 aaronmk
alias import_vars="$(cat <<'EOF'
280
: "${prefix:?}"
281 9089 aaronmk
declare src_var dest_var
282 9091 aaronmk
for src_var in $(get_prefix_vars); do
283 8863 aaronmk
	dest_var="${src_var#$prefix}"
284 9089 aaronmk
	declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
285 8863 aaronmk
done
286
EOF
287
)"
288
289 9017 aaronmk
290 9068 aaronmk
#### functions
291
292 9074 aaronmk
func_exists() { declare -f "$1" >/dev/null; }
293 9068 aaronmk
294 9074 aaronmk
copy_func() # usage: from=... to=... copy_func
295 9068 aaronmk
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
296
{
297
	: "${from:?}" "${to:?}"
298
	func_exists "$from" || die "function does not exist: $from"
299
	! func_exists "$to" || die "function already exists: $to"
300
	local from_def="$(declare -f "$from")"
301
	eval "$to${from_def#$from}"
302
}
303
304 9074 aaronmk
func_override() # usage: func_override old_name__suffix
305 9068 aaronmk
{ from="${1%%__*}" to="$1" copy_func; }
306
307 9098 aaronmk
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
308
{
309
	local nested_func="${FUNCNAME[1]}"
310
	local func="${nested_func%%__*}"
311
	contains "$func" "${FUNCNAME[@]}" || \
312
		die "$nested_func() must be used by $func()"
313
}
314 9068 aaronmk
315 9098 aaronmk
316 8854 aaronmk
#### commands
317
318 8934 aaronmk
top_script="$0" # outermost script
319
top_dir="$(dirname "$top_script")"
320 8272 aaronmk
321 9074 aaronmk
require_exists() # usage: require_exists file || return 0
322 9073 aaronmk
{ test ! -e "$1" || type=info die "file "$1" already exists, skipping"; }
323 9062 aaronmk
324 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
325 9074 aaronmk
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
326 9048 aaronmk
{
327
	echo_func
328
	: "${stdout?}"; echo_vars stdout
329 9063 aaronmk
	test ! "$if_not_exists" || require_exists "$stdout" || return 0
330 9048 aaronmk
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
331
}
332 8986 aaronmk
alias to_file='to_file ' # last space alias-expands next word
333
334 9074 aaronmk
run_args_cmd() # runs the command line args command
335 8272 aaronmk
{
336 8971 aaronmk
	test $? -eq 0 || return
337 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
338 8971 aaronmk
	test $# -ge 1 || set -- all
339 8648 aaronmk
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
340 8272 aaronmk
}
341
342 9074 aaronmk
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
343 8272 aaronmk
{
344 8881 aaronmk
	echo_func
345 8284 aaronmk
	: "${subdirs?}"
346
347 8272 aaronmk
	for subdir in "${subdirs[@]}"; do
348 8280 aaronmk
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
349 8272 aaronmk
	done
350
}
351
352 9017 aaronmk
353 8966 aaronmk
#### URLs
354
355 9074 aaronmk
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
356 8966 aaronmk
357 8704 aaronmk
fi