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