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 8957 aaronmk
function extern () { (exec "$@") || return; }
5 8917 aaronmk
6 9002 aaronmk
isset () { test -n "${!1+isset}"; }
7
8 8716 aaronmk
realpath () { readlink -f -- "$1"; }
9 8703 aaronmk
10 8917 aaronmk
include_guard_var () { realpath "$1"|"extern" sed 's/[^a-zA-Z0-9_]/_/g'; }
11 8716 aaronmk
12 8703 aaronmk
self_not_included () # usage: if self_not_included; then ... fi
13
{
14 8971 aaronmk
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
15 8703 aaronmk
	local include_guard="$(include_guard_var "$1")"
16 8793 aaronmk
	alias self_being_included=false
17 9003 aaronmk
	! isset "$include_guard" && \
18 8793 aaronmk
	{ eval "$include_guard"=1; alias self_being_included=true; }
19 8703 aaronmk
}
20
21 8793 aaronmk
# to load newly-defined aliases for use in functions in the same file:
22
## fi # load new aliases
23
## if self_being_included; then
24
# this is needed because aliases defined inside an if statement are not
25
# available inside that if statement
26
27 9017 aaronmk
28 8704 aaronmk
if self_not_included "${BASH_SOURCE[0]}"; then
29
30 9017 aaronmk
31
#### options
32
33 8709 aaronmk
shopt -s expand_aliases
34
35 9017 aaronmk
36
#### aliases
37
38 8889 aaronmk
unalias () { builtin unalias "$@" 2>&- || true; } # no error if undefined
39
40 9017 aaronmk
41 8886 aaronmk
#### exceptions
42
43 8976 aaronmk
alias rethrow='return "$e"'
44
alias rethrow_subshell='exit "$e"'
45
46 8978 aaronmk
fi # load new aliases
47
if self_being_included; then
48
49
# usage: save_e cmd... || use $e (or $?)
50
function save_e () { "$@"; e=$?; rethrow; } # rethrow because e= clears $?
51
alias save_e='declare e; save_e ' # last space alias-expands next word
52
53 8981 aaronmk
function log_e () # usage: log_e cmd... [ || use $e (or $?) ]
54
{
55 8982 aaronmk
	if ! "save_e" "$@"; then
56 8981 aaronmk
		echo "! $*" >&2
57
		echo "! command exited with error $e" >&2
58
		rethrow
59
	fi
60
}
61 8982 aaronmk
alias log_e='declare e; log_e ' # last space alias-expands next word
62 8981 aaronmk
63 8886 aaronmk
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
64
65 8980 aaronmk
function try () { "save_e" "$@" || true; }
66
alias try='declare e; try ' # last space alias-expands next word
67 8886 aaronmk
68
catch () { test "$e" -eq "$1"; e=0; }
69
70
ignore () { catch "$@" || true; }
71
72 8977 aaronmk
alias end_try='rethrow'
73
alias end_try_subshell='rethrow_subshell'
74 8886 aaronmk
75 9017 aaronmk
76 8899 aaronmk
#### integers
77
78
let () { builtin let "$@" || true; }
79
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
80
81 9004 aaronmk
bool2int () { save_e test -z "$1"; echo "$e"; } # empty->0; non-empty->1
82
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 8854 aaronmk
#### verbose output
96
97 8973 aaronmk
# usage: (stdout2stderr; cmd...) || return
98
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
99 8914 aaronmk
stdout2stderr () { exec >&2; }
100
101 9006 aaronmk
# set verbosity
102 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
103 9006 aaronmk
: "${verbosity=3}" # default
104
: "${verbosity:=0}" # ensure non-empty
105 9007 aaronmk
declare -i verbosity # ensure integer
106 9000 aaronmk
export verbosity # propagate the verbosity to invoked commands
107 8710 aaronmk
108 8898 aaronmk
can_log () { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
109 8895 aaronmk
110 8920 aaronmk
: "${log_indent=  }"
111 8919 aaronmk
112 8900 aaronmk
# usage: in func:      inc_log_level; ...
113
#        outside func: inc_log_level; ...; dec_log_level
114 8919 aaronmk
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
115
let verbosity--'
116
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
117
let verbosity++'
118 8900 aaronmk
119 8995 aaronmk
fi # load new aliases
120
if self_being_included; then
121
122 8994 aaronmk
# usage: (limit_stderr; cmd...) || return
123 8973 aaronmk
# `|| return` needed on Mac because of bug where -e doesn't apply to ()
124 8995 aaronmk
limit_stderr () { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }
125 8904 aaronmk
126 8994 aaronmk
limit_stderr_cmd () # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
127 8915 aaronmk
{
128 9010 aaronmk
	case "$1" in echo_run) shift; echo_cmd "$@";; esac
129 8994 aaronmk
	(limit_stderr
130 8915 aaronmk
		if test -n "$stdout2stderr"; then stdout2stderr; fi
131
		"$@"
132 8955 aaronmk
	) || return
133 8915 aaronmk
}
134 9008 aaronmk
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
135 8911 aaronmk
136 8897 aaronmk
echo_cmd () { if can_log; then echo "$PS4$*" >&2; fi; }
137 8272 aaronmk
138 8278 aaronmk
echo_run () { echo_cmd "$@"; "$@"; }
139
140 8984 aaronmk
# auto-echo common external commands
141
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
142
143 9011 aaronmk
# echo all external commands
144
alias extern="echo_run extern " # last space alias-expands next word
145 8907 aaronmk
146 8929 aaronmk
alias self='extern "$FUNCNAME"' # usage: wrapper () { self ...; }
147
148 8908 aaronmk
# commands that are always external
149
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
150 8872 aaronmk
151 8646 aaronmk
canon_rel_path ()
152
{
153
	local path="$1"
154 8716 aaronmk
	path="$(realpath "$path")" # canonicalize
155 8773 aaronmk
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
156 8646 aaronmk
	echo "$path"
157
}
158
159 8909 aaronmk
fi # load new aliases
160 8884 aaronmk
if self_being_included; then
161
162 8909 aaronmk
function echo_func ()
163 8463 aaronmk
{
164 8901 aaronmk
	inc_log_level
165 8647 aaronmk
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
166
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
167 8463 aaronmk
}
168 8885 aaronmk
169 8997 aaronmk
# usage: cmd1 | { pipe_delay; cmd2; }
170
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
171
172
fi # load new aliases
173
if self_being_included; then
174
175 8702 aaronmk
echo_stdin () # usage: input|echo_stdin|cmd
176
{
177 8901 aaronmk
	inc_log_level
178 8897 aaronmk
	if can_log; then
179 8998 aaronmk
		pipe_delay
180 8897 aaronmk
		echo ----- >&2
181
		tee -a /dev/stderr;
182
		echo ----- >&2
183
	else cat
184
	fi
185 8702 aaronmk
}
186 8275 aaronmk
187 8856 aaronmk
echo_vars () # usage: echo_vars var...
188 8901 aaronmk
{
189 8922 aaronmk
	inc_log_level; inc_log_level
190 8921 aaronmk
	if can_log; then
191
		local var
192
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
193
	fi
194 8901 aaronmk
}
195 8641 aaronmk
196
echo_export ()
197
{
198 8700 aaronmk
	builtin export "$@"
199 8641 aaronmk
	echo_vars "$@"
200
}
201
202 8713 aaronmk
if test "$verbosity" -ge 2; then
203 8711 aaronmk
	alias export="echo_export" # automatically echo env vars when they are set
204
fi
205 8642 aaronmk
206 8272 aaronmk
usage () { echo "Usage: $1" >&2; (exit 2); }
207
208 8873 aaronmk
fi # load new aliases
209
if self_being_included; then
210
211 9017 aaronmk
212 8871 aaronmk
#### strings
213
214
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
215
216 8930 aaronmk
sed () { self -"$sed_ere_flag" "$@";}
217 8871 aaronmk
218 9017 aaronmk
219 8854 aaronmk
#### vars
220
221
set_var () { eval "$1"'="$2"'; }
222
223 8857 aaronmk
set_inv () { set_var no_"$1" "$(test -n "${!1}" || echo 1)"; }
224
225 8859 aaronmk
# usage: local var=...; local_inv
226 8888 aaronmk
alias local_inv='declare "no_$var=$(test -n "${!var}" || echo 1)"'
227 8859 aaronmk
228 8863 aaronmk
# usage: local prefix=..._; import_vars
229
alias import_vars="$(cat <<'EOF'
230
: "${prefix:?}"
231
local src_var dest_var
232
for src_var in $(eval echo '${!'$prefix'*}'); do
233
	dest_var="${src_var#$prefix}"
234
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
235
done
236
EOF
237
)"
238
239 9017 aaronmk
240 8854 aaronmk
#### commands
241
242 8934 aaronmk
top_script="$0" # outermost script
243
top_dir="$(dirname "$top_script")"
244 8272 aaronmk
245 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
246
function to_file () # usage: stdout=... to_file cmd...
247
{ : "${stdout?}"; log_e "$@" >"$stdout" || { rm "$stdout"; rethrow; }; }
248
alias to_file='to_file ' # last space alias-expands next word
249
250 8465 aaronmk
run_args_cmd () # runs the command line args command
251 8272 aaronmk
{
252 8971 aaronmk
	test $? -eq 0 || return
253 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
254 8971 aaronmk
	test $# -ge 1 || set -- all
255 8648 aaronmk
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
256 8272 aaronmk
}
257
258 8284 aaronmk
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
259 8272 aaronmk
{
260 8881 aaronmk
	echo_func
261 8284 aaronmk
	: "${subdirs?}"
262
263 8272 aaronmk
	for subdir in "${subdirs[@]}"; do
264 8280 aaronmk
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
265 8272 aaronmk
	done
266
}
267
268 9017 aaronmk
269 8966 aaronmk
#### URLs
270
271
localize_url () { test _"$1" = _"$(hostname -f)" || echo "$1"; }
272
273 8704 aaronmk
fi