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 9002 aaronmk
isset () { test -n "${!1+isset}"; }
10
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 9027 aaronmk
# usage: cmd || { save_e; ...; rethrow; }
49
alias save_e='e=$?'
50 8976 aaronmk
alias rethrow='return "$e"'
51
alias rethrow_subshell='exit "$e"'
52
53 8978 aaronmk
fi # load new aliases
54
if self_being_included; then
55
56 9026 aaronmk
# usage: save_e_cmd cmd... || { use $e (or $?); rethrow; }
57 9027 aaronmk
function save_e_cmd () { "$@"; save_e; rethrow; } # rethrow because e= clears $?
58 9026 aaronmk
alias save_e_cmd='declare e; save_e_cmd ' # last space alias-expands next word
59 8978 aaronmk
60 8981 aaronmk
function log_e () # usage: log_e cmd... [ || use $e (or $?) ]
61
{
62 9025 aaronmk
	if "$@"; then :; else # don't use ! because that resets $?
63 9027 aaronmk
		save_e
64 8981 aaronmk
		echo "! $*" >&2
65
		echo "! command exited with error $e" >&2
66
		rethrow
67
	fi
68
}
69 8982 aaronmk
alias log_e='declare e; log_e ' # last space alias-expands next word
70 8981 aaronmk
71 8886 aaronmk
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
72
73 9026 aaronmk
function try () { "save_e_cmd" "$@" || true; }
74 8980 aaronmk
alias try='declare e; try ' # last space alias-expands next word
75 8886 aaronmk
76
catch () { test "$e" -eq "$1"; e=0; }
77
78
ignore () { catch "$@" || true; }
79
80 8977 aaronmk
alias end_try='rethrow'
81
alias end_try_subshell='rethrow_subshell'
82 8886 aaronmk
83 9020 aaronmk
fi # load new aliases
84
if self_being_included; then
85 9017 aaronmk
86 9020 aaronmk
87 9023 aaronmk
#### functions
88
89 9024 aaronmk
func_exists () { declare -f "$1" >/dev/null; }
90
91 9023 aaronmk
copy_func () # usage: from=... to=... copy_func
92
{
93
	: "${from:?}" "${to:?}"
94
	local from_def="$(declare -f "$from")"
95
	eval "$to${from_def#$from}"
96
}
97
98
99 8899 aaronmk
#### integers
100
101
let () { builtin let "$@" || true; }
102
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
103
104 9028 aaronmk
bool2int () { try test -z "$1"; echo "$e"; } # empty->0; non-empty->1
105 9004 aaronmk
106 9017 aaronmk
107 8854 aaronmk
#### arrays
108 8694 aaronmk
109 8833 aaronmk
join () { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
110 8816 aaronmk
111 8691 aaronmk
reverse () # usage: array=($(reverse args...))
112
{
113
	local i
114
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
115
}
116
117 9017 aaronmk
118 8854 aaronmk
#### verbose output
119
120 8973 aaronmk
# usage: (stdout2stderr; cmd...) || return
121
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
122 8914 aaronmk
stdout2stderr () { exec >&2; }
123
124 9006 aaronmk
# set verbosity
125 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
126 9006 aaronmk
: "${verbosity=3}" # default
127
: "${verbosity:=0}" # ensure non-empty
128 9007 aaronmk
declare -i verbosity # ensure integer
129 9000 aaronmk
export verbosity # propagate the verbosity to invoked commands
130 8710 aaronmk
131 8898 aaronmk
can_log () { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
132 8895 aaronmk
133 8920 aaronmk
: "${log_indent=  }"
134 8919 aaronmk
135 8900 aaronmk
# usage: in func:      inc_log_level; ...
136
#        outside func: inc_log_level; ...; dec_log_level
137 8919 aaronmk
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
138
let verbosity--'
139
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
140
let verbosity++'
141 8900 aaronmk
142 8995 aaronmk
fi # load new aliases
143
if self_being_included; then
144
145 8994 aaronmk
# usage: (limit_stderr; cmd...) || return
146 8973 aaronmk
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
147 8995 aaronmk
limit_stderr () { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }
148 8904 aaronmk
149 8994 aaronmk
limit_stderr_cmd () # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
150 8915 aaronmk
{
151 9010 aaronmk
	case "$1" in echo_run) shift; echo_cmd "$@";; esac
152 8994 aaronmk
	(limit_stderr
153 8915 aaronmk
		if test -n "$stdout2stderr"; then stdout2stderr; fi
154
		"$@"
155 8955 aaronmk
	) || return
156 8915 aaronmk
}
157 9008 aaronmk
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
158 8911 aaronmk
159 8897 aaronmk
echo_cmd () { if can_log; then echo "$PS4$*" >&2; fi; }
160 8272 aaronmk
161 8278 aaronmk
echo_run () { echo_cmd "$@"; "$@"; }
162
163 8984 aaronmk
# auto-echo common external commands
164
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
165
166 9011 aaronmk
# echo all external commands
167
alias extern="echo_run extern " # last space alias-expands next word
168 8907 aaronmk
169 8929 aaronmk
alias self='extern "$FUNCNAME"' # usage: wrapper () { self ...; }
170
171 8908 aaronmk
# commands that are always external
172
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
173 8872 aaronmk
174 8646 aaronmk
canon_rel_path ()
175
{
176
	local path="$1"
177 8716 aaronmk
	path="$(realpath "$path")" # canonicalize
178 8773 aaronmk
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
179 8646 aaronmk
	echo "$path"
180
}
181
182 8909 aaronmk
function echo_func ()
183 8463 aaronmk
{
184 8901 aaronmk
	inc_log_level
185 8647 aaronmk
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
186
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
187 8463 aaronmk
}
188 8885 aaronmk
189 8997 aaronmk
# usage: cmd1 | { pipe_delay; cmd2; }
190
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
191
192
fi # load new aliases
193
if self_being_included; then
194
195 8702 aaronmk
echo_stdin () # usage: input|echo_stdin|cmd
196
{
197 8901 aaronmk
	inc_log_level
198 8897 aaronmk
	if can_log; then
199 8998 aaronmk
		pipe_delay
200 8897 aaronmk
		echo ----- >&2
201
		tee -a /dev/stderr;
202
		echo ----- >&2
203
	else cat
204
	fi
205 8702 aaronmk
}
206 8275 aaronmk
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 8857 aaronmk
set_inv () { set_var no_"$1" "$(test -n "${!1}" || echo 1)"; }
240
241 8859 aaronmk
# usage: local var=...; local_inv
242 8888 aaronmk
alias local_inv='declare "no_$var=$(test -n "${!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 8854 aaronmk
#### commands
257
258 8934 aaronmk
top_script="$0" # outermost script
259
top_dir="$(dirname "$top_script")"
260 8272 aaronmk
261 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
262
function to_file () # usage: stdout=... to_file cmd...
263
{ : "${stdout?}"; log_e "$@" >"$stdout" || { rm "$stdout"; rethrow; }; }
264
alias to_file='to_file ' # last space alias-expands next word
265
266 8465 aaronmk
run_args_cmd () # runs the command line args command
267 8272 aaronmk
{
268 8971 aaronmk
	test $? -eq 0 || return
269 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
270 8971 aaronmk
	test $# -ge 1 || set -- all
271 8648 aaronmk
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
272 8272 aaronmk
}
273
274 8284 aaronmk
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
275 8272 aaronmk
{
276 8881 aaronmk
	echo_func
277 8284 aaronmk
	: "${subdirs?}"
278
279 8272 aaronmk
	for subdir in "${subdirs[@]}"; do
280 8280 aaronmk
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
281 8272 aaronmk
	done
282
}
283
284 9017 aaronmk
285 8966 aaronmk
#### URLs
286
287
localize_url () { test _"$1" = _"$(hostname -f)" || echo "$1"; }
288
289 8704 aaronmk
fi