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