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 9074 aaronmk
isset() { test "${!1+isset}"; }
8 9002 aaronmk
9 9074 aaronmk
realpath() { readlink -f -- "$1"; }
10 8703 aaronmk
11 9075 aaronmk
include_guard_var() { realpath "$1"|"command" sed 's/[^a-zA-Z0-9_]/_/g'; }
12 8716 aaronmk
13 9074 aaronmk
self_not_included() # usage: if self_not_included; then ... fi
14 8703 aaronmk
{
15 8971 aaronmk
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
16 8703 aaronmk
	local include_guard="$(include_guard_var "$1")"
17 8793 aaronmk
	alias self_being_included=false
18 9003 aaronmk
	! isset "$include_guard" && \
19 8793 aaronmk
	{ eval "$include_guard"=1; alias self_being_included=true; }
20 8703 aaronmk
}
21
22 8793 aaronmk
# to load newly-defined aliases for use in functions in the same file:
23
## fi # load new aliases
24
## if self_being_included; then
25
# this is needed because aliases defined inside an if statement are not
26
# available inside that if statement
27
28 9018 aaronmk
fi
29 9017 aaronmk
30 9018 aaronmk
31 8704 aaronmk
if self_not_included "${BASH_SOURCE[0]}"; then
32
33 9017 aaronmk
34
#### options
35
36 8709 aaronmk
shopt -s expand_aliases
37
38 9017 aaronmk
39
#### aliases
40
41 9074 aaronmk
unalias() { builtin unalias "$@" 2>&- || true; } # no error if undefined
42 8889 aaronmk
43 9017 aaronmk
44 8886 aaronmk
#### exceptions
45
46 9032 aaronmk
# usage: cmd || { save_e; ...; rethrow; }
47 9031 aaronmk
alias export_e='e=$?'
48 9032 aaronmk
alias save_e='declare e=$?'
49 8976 aaronmk
alias rethrow='return "$e"'
50
alias rethrow_subshell='exit "$e"'
51
52 8978 aaronmk
fi # load new aliases
53
if self_being_included; then
54
55 8886 aaronmk
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
56
57 9074 aaronmk
function try() { e=0; "$@" || { export_e; true; }; }
58 8980 aaronmk
alias try='declare e; try ' # last space alias-expands next word
59 8886 aaronmk
60 9074 aaronmk
catch() { test "$e" -eq "$1"; e=0; }
61 8886 aaronmk
62 9074 aaronmk
ignore() { catch "$@" || true; }
63 8886 aaronmk
64 8977 aaronmk
alias end_try='rethrow'
65
alias end_try_subshell='rethrow_subshell'
66 8886 aaronmk
67 9020 aaronmk
fi # load new aliases
68
if self_being_included; then
69 9017 aaronmk
70 9020 aaronmk
71 8899 aaronmk
#### integers
72
73 9074 aaronmk
let!() { let "$@" || true; } # always returns true; safe to use for setting
74 8899 aaronmk
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
75
76 9074 aaronmk
bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
77 9004 aaronmk
78 9017 aaronmk
79 8854 aaronmk
#### arrays
80 8694 aaronmk
81 9074 aaronmk
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
82 8816 aaronmk
83 9074 aaronmk
reverse() # usage: array=($(reverse args...))
84 8691 aaronmk
{
85
	local i
86
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
87
}
88
89 9017 aaronmk
90 9040 aaronmk
#### paths
91
92 9074 aaronmk
canon_rel_path()
93 9040 aaronmk
{
94
	local path="$1"
95
	path="$(realpath "$path")" # canonicalize
96
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
97
	echo "$path"
98
}
99
100 9051 aaronmk
# makes $1 a canon_rel_path if it's a filesystem path
101
alias cmd2rel_path="$(cat <<'EOF'
102
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
103
	declare _1="$1"; shift
104
	set -- "$(canon_rel_path "$_1")" "$@"
105
fi
106
EOF
107
)"
108 9040 aaronmk
109 9051 aaronmk
110 8854 aaronmk
#### verbose output
111
112 8973 aaronmk
# usage: (stdout2stderr; cmd...) || return
113 9074 aaronmk
# `|| return` needed on Mac because of bug where -e doesn't apply to()
114
stdout2stderr() { exec >&2; }
115 8914 aaronmk
116 9006 aaronmk
# set verbosity
117 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
118 9006 aaronmk
: "${verbosity=3}" # default
119
: "${verbosity:=0}" # ensure non-empty
120 9007 aaronmk
declare -i verbosity # ensure integer
121 9077 aaronmk
export PS4 verbosity # propagate indent and verbosity to invoked commands
122 8710 aaronmk
123 9074 aaronmk
can_log() { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
124 8895 aaronmk
125 9074 aaronmk
log() { if can_log; then echo "$PS4$1" >&2; fi; }
126 9064 aaronmk
127 9070 aaronmk
# usage: symbol=... log_custom msg
128 9074 aaronmk
log_custom() { local PS4="${PS4%[^ ] }$symbol "; log "$@"; }
129 9070 aaronmk
130 9074 aaronmk
log_err() { symbol=! log_custom "$@"; }
131 9070 aaronmk
132 9074 aaronmk
log_info() { symbol=? log_custom "$@"; }
133 9070 aaronmk
134 9067 aaronmk
# usage: cmd || { save_e; log_e; ...; rethrow; }
135 9074 aaronmk
log_e() { log_err "command exited with error $e"; }
136 9067 aaronmk
137 9072 aaronmk
# usage: cmd || [type=...] die msg
138 9074 aaronmk
die() { save_e; "log_${type:-err}" "$1"; rethrow; }
139 9069 aaronmk
140 8920 aaronmk
: "${log_indent=  }"
141 8919 aaronmk
142 9076 aaronmk
# usage: in func:      indent; ...
143
#        outside func: indent; ...; outdent
144
alias indent='declare PS4="$log_indent$PS4"'
145
alias outdent='declare PS4="${PS4#$log_indent}"'
146
147 8900 aaronmk
# usage: in func:      inc_log_level; ...
148
#        outside func: inc_log_level; ...; dec_log_level
149 9076 aaronmk
alias inc_log_level='indent;  declare verbosity="$verbosity"; let! verbosity--'
150
alias dec_log_level='outdent; declare verbosity="$verbosity"; let! verbosity++'
151 8900 aaronmk
152 8995 aaronmk
fi # load new aliases
153
if self_being_included; then
154
155 9074 aaronmk
echo_cmd()
156 9056 aaronmk
{
157 9075 aaronmk
	case "$1" in command) shift;; esac # command implied by the log_level
158 9065 aaronmk
	log "$*"
159 9056 aaronmk
}
160
161 9074 aaronmk
echo_run() { cmd2rel_path; echo_cmd "$@"; "$@"; }
162 9056 aaronmk
163 8994 aaronmk
# usage: (limit_stderr; cmd...) || return
164 9074 aaronmk
# `|| return` needed on Mac because of bug where -e doesn't apply to()
165
limit_stderr() { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }
166 8904 aaronmk
167 9074 aaronmk
limit_stderr_cmd() # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
168 8915 aaronmk
{
169 9057 aaronmk
	case "$1" in echo_run) shift; cmd2rel_path; echo_cmd "$@";; esac
170 8994 aaronmk
	(limit_stderr
171 9050 aaronmk
		if test "$stdout2stderr"; then stdout2stderr; fi
172 8915 aaronmk
		"$@"
173 8955 aaronmk
	) || return
174 8915 aaronmk
}
175 9008 aaronmk
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
176 8911 aaronmk
177 8984 aaronmk
# auto-echo common external commands
178
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
179
180 9011 aaronmk
# echo all external commands
181 9075 aaronmk
alias command="echo_run command " # last space alias-expands next word
182 8907 aaronmk
183 9075 aaronmk
alias self='command "$FUNCNAME"' # usage: wrapper() { self ...; }
184 8929 aaronmk
185 8908 aaronmk
# commands that are always external
186 9075 aaronmk
for cmd in env; do alias "$cmd=command $cmd"; done; unset cmd
187 8872 aaronmk
188 9074 aaronmk
function echo_func()
189 8463 aaronmk
{
190 8901 aaronmk
	inc_log_level
191 8647 aaronmk
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
192
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
193 8463 aaronmk
}
194 8885 aaronmk
195 8997 aaronmk
# usage: cmd1 | { pipe_delay; cmd2; }
196
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
197
198
fi # load new aliases
199
if self_being_included; then
200
201 9074 aaronmk
echo_stdin() # usage: input|echo_stdin|cmd
202 8702 aaronmk
{
203 8901 aaronmk
	inc_log_level
204 8897 aaronmk
	if can_log; then
205 8998 aaronmk
		pipe_delay
206 8897 aaronmk
		echo ----- >&2
207
		tee -a /dev/stderr;
208
		echo ----- >&2
209
	else cat
210
	fi
211 8702 aaronmk
}
212 8275 aaronmk
213 9044 aaronmk
alias echo_stdout='echo_stdin' # usage: cmd|echo_stdout
214
215 9074 aaronmk
echo_vars() # usage: echo_vars var...
216 8901 aaronmk
{
217 8922 aaronmk
	inc_log_level; inc_log_level
218 8921 aaronmk
	if can_log; then
219
		local var
220
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
221
	fi
222 8901 aaronmk
}
223 8641 aaronmk
224 9074 aaronmk
echo_export() { builtin export "$@"; echo_vars "$@"; }
225 8641 aaronmk
226 8713 aaronmk
if test "$verbosity" -ge 2; then
227 8711 aaronmk
	alias export="echo_export" # automatically echo env vars when they are set
228
fi
229 8642 aaronmk
230 9074 aaronmk
usage() { echo "Usage: $1" >&2; (exit 2); }
231 8272 aaronmk
232 8873 aaronmk
fi # load new aliases
233
if self_being_included; then
234
235 9017 aaronmk
236 8871 aaronmk
#### strings
237
238
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
239
240 9074 aaronmk
sed() { self -"$sed_ere_flag" "$@";}
241 8871 aaronmk
242 9017 aaronmk
243 8854 aaronmk
#### vars
244
245 9074 aaronmk
set_var() { eval "$1"'="$2"'; }
246 8854 aaronmk
247 9074 aaronmk
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
248 8857 aaronmk
249 8859 aaronmk
# usage: local var=...; local_inv
250 9050 aaronmk
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
251 8859 aaronmk
252 8863 aaronmk
# usage: local prefix=..._; import_vars
253
alias import_vars="$(cat <<'EOF'
254
: "${prefix:?}"
255
local src_var dest_var
256
for src_var in $(eval echo '${!'$prefix'*}'); do
257
	dest_var="${src_var#$prefix}"
258
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
259
done
260
EOF
261
)"
262
263 9017 aaronmk
264 9068 aaronmk
#### functions
265
266 9074 aaronmk
func_exists() { declare -f "$1" >/dev/null; }
267 9068 aaronmk
268 9074 aaronmk
copy_func() # usage: from=... to=... copy_func
269 9068 aaronmk
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
270
{
271
	: "${from:?}" "${to:?}"
272
	func_exists "$from" || die "function does not exist: $from"
273
	! func_exists "$to" || die "function already exists: $to"
274
	local from_def="$(declare -f "$from")"
275
	eval "$to${from_def#$from}"
276
}
277
278 9074 aaronmk
func_override() # usage: func_override old_name__suffix
279 9068 aaronmk
{ from="${1%%__*}" to="$1" copy_func; }
280
281
282 8854 aaronmk
#### commands
283
284 8934 aaronmk
top_script="$0" # outermost script
285
top_dir="$(dirname "$top_script")"
286 8272 aaronmk
287 9074 aaronmk
require_exists() # usage: require_exists file || return 0
288 9073 aaronmk
{ test ! -e "$1" || type=info die "file "$1" already exists, skipping"; }
289 9062 aaronmk
290 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
291 9074 aaronmk
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
292 9048 aaronmk
{
293
	echo_func
294
	: "${stdout?}"; echo_vars stdout
295 9063 aaronmk
	test ! "$if_not_exists" || require_exists "$stdout" || return 0
296 9048 aaronmk
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
297
}
298 8986 aaronmk
alias to_file='to_file ' # last space alias-expands next word
299
300 9074 aaronmk
run_args_cmd() # runs the command line args command
301 8272 aaronmk
{
302 8971 aaronmk
	test $? -eq 0 || return
303 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
304 8971 aaronmk
	test $# -ge 1 || set -- all
305 8648 aaronmk
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
306 8272 aaronmk
}
307
308 9074 aaronmk
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
309 8272 aaronmk
{
310 8881 aaronmk
	echo_func
311 8284 aaronmk
	: "${subdirs?}"
312
313 8272 aaronmk
	for subdir in "${subdirs[@]}"; do
314 8280 aaronmk
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
315 8272 aaronmk
	done
316
}
317
318 9017 aaronmk
319 8966 aaronmk
#### URLs
320
321 9074 aaronmk
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
322 8966 aaronmk
323 8704 aaronmk
fi