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