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