Project

General

Profile

1 8291 aaronmk
#!/bin/bash -e
2 9328 aaronmk
set -o errexit -o pipefail # errexit in case caller's #! line missing -e
3 8952 aaronmk
4 9018 aaronmk
if test ! "$_util_sh_include_guard_utils"; then
5
_util_sh_include_guard_utils=1
6
7 9798 aaronmk
isset() { declare -p "$1" &>/dev/null; }
8 9002 aaronmk
9 9074 aaronmk
realpath() { readlink -f -- "$1"; }
10 8703 aaronmk
11 9314 aaronmk
str2varname() { echo "${1//[^a-zA-Z0-9_]/_}"; }
12 8716 aaronmk
13 9312 aaronmk
include_guard_var() { str2varname "$(realpath "$1")"; }
14
15 9074 aaronmk
self_not_included() # usage: if self_not_included; then ... fi
16 8703 aaronmk
{
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 9789 aaronmk
#### stubs
42
43 9794 aaronmk
__caller_indent='log_indent="$log_indent$log_indent_step"'
44
alias caller_indent="$__caller_indent"
45
alias indent="declare $__caller_indent"
46
47 9789 aaronmk
function echo_func() { :; }
48 9790 aaronmk
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
49 9789 aaronmk
50 9796 aaronmk
function echo_run() { :; }
51
alias echo_run='"echo_run" ' # last space alias-expands next word
52 9789 aaronmk
53 9797 aaronmk
function echo_vars() { :; }
54 9796 aaronmk
55 9797 aaronmk
56 9226 aaronmk
#### vars
57
58
set_var() { eval "$1"'="$2"'; }
59
60 9420 aaronmk
set_default() { if ! isset "$1"; then set_var "$@"; fi; }
61
62 9226 aaronmk
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
63
64
# usage: local var=...; local_inv
65
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
66
67 9227 aaronmk
unexport() { export -n "$@"; }
68
	# `declare +x` won't work because it defines the var if it isn't set
69
70 9236 aaronmk
alias local_export='declare -x' # combines effects of local and export
71
72 9226 aaronmk
get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }
73
74
# usage: local prefix=..._; import_vars
75
# when used inside another alias 2+ levels deep, *must* be run inside a function
76
alias import_vars="$(cat <<'EOF'
77
: "${prefix:?}"
78
declare src_var dest_var
79
for src_var in $(get_prefix_vars); do
80
	dest_var="${src_var#$prefix}"
81
	declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
82
done
83
EOF
84
)"
85
86
87 9311 aaronmk
#### caching
88
89
## shell-variable-based caching
90
91 9330 aaronmk
# usage: local cache_key=...; load_cache; \
92 9331 aaronmk
# if ! cached; then save_cache value || return; fi; echo_cached_value
93 9561 aaronmk
# cache_key for function inputs: "$(declare -p kw_param...) $*"
94 9311 aaronmk
alias load_cache='declare cache_var="$(str2varname "${FUNCNAME}___$cache_key")"'
95
alias cached='isset "$cache_var"'
96
alias save_cache='set_var "$cache_var"'
97
alias echo_cached_value='echo "${!cache_var}"'
98
99
clear_cache() # usage: func=... clear_cache
100
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
101
102
fi # load new aliases
103
if self_being_included; then
104
105
106 9017 aaronmk
#### aliases
107
108 9074 aaronmk
unalias() { builtin unalias "$@" 2>&- || true; } # no error if undefined
109 8889 aaronmk
110 9191 aaronmk
# usage: alias alias_='var=value run_cmd '
111
function run_cmd() { "$@"; }
112
alias run_cmd='"run_cmd" ' # last space alias-expands next word
113 9017 aaronmk
114 9688 aaronmk
alias_append() { eval $(alias "$1")'"$2"'; } # usage: alias_append alias '; cmd'
115 9191 aaronmk
116 9688 aaronmk
117 9082 aaronmk
#### functions
118
119 9235 aaronmk
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
120 9229 aaronmk
# removes keyword-param-only vars from the environment
121
{ unexport "$@"; }
122 9228 aaronmk
123 9799 aaronmk
# usage: cmd=... foreach_arg
124
function foreach_arg()
125
{
126 9808 aaronmk
	echo_func; kw_params cmd; : "${cmd:?}"
127
	local a; for a in "$@"; do
128 9806 aaronmk
		a="$(clog++ echo_run "$cmd" "$a")" || return; args+=("$a")
129
	done
130 9799 aaronmk
	echo_vars args
131
}
132
alias foreach_arg='"foreach_arg" "$@"; set -- "${args[@]}"; unset args'
133
134 9082 aaronmk
alias self='command "$FUNCNAME"' # usage: wrapper() { self ...; }
135 9722 aaronmk
alias self_sys='command -p "$FUNCNAME"' # usage: wrapper() { self_sys ...; }
136 9082 aaronmk
137 9678 aaronmk
pf() { declare -f "$@"; } # usage: pf function # prints func decl for debugging
138 9082 aaronmk
139 9677 aaronmk
all_funcs() # usage: for func in $(all_funcs); do ...; done # all declared funcs
140
{ declare -F|while read -r line; do echo -n "${line#declare -f } "; done; }
141 9673 aaronmk
142 9677 aaronmk
143 8886 aaronmk
#### exceptions
144
145 9032 aaronmk
# usage: cmd || { save_e; ...; rethrow; }
146 9031 aaronmk
alias export_e='e=$?'
147 9032 aaronmk
alias save_e='declare e=$?'
148 8976 aaronmk
alias rethrow='return "$e"'
149
alias rethrow_subshell='exit "$e"'
150
151 8978 aaronmk
fi # load new aliases
152
if self_being_included; then
153
154 9535 aaronmk
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
155 8886 aaronmk
156 9448 aaronmk
function try() { e=0; benign_error=1 "$@" || { export_e; true; }; }
157 9177 aaronmk
alias try='declare e; "try" ' # last space alias-expands next word
158 8886 aaronmk
159 9534 aaronmk
catch() { test "$e" -eq "$1" && e=0; }
160 8886 aaronmk
161 9535 aaronmk
ignore_e() { catch "$@" || true; }
162 8886 aaronmk
163 8977 aaronmk
alias end_try='rethrow'
164
alias end_try_subshell='rethrow_subshell'
165 8886 aaronmk
166 9536 aaronmk
ignore() { save_e; ignore_e "$@"; rethrow; } # usage: try cmd || ignore status
167
168 9551 aaronmk
### signals
169
170
sig_e() { echo $(( 128+$(kill -l "$1") )); } # usage: sig_e SIGINT, etc.
171
172
ignore_sig() { ignore "$(sig_e "$1")"; }
173
174 9678 aaronmk
# usage: piped_cmd cmd1...|cmd2... # cmd2 doesn't read all its input
175 9551 aaronmk
function piped_cmd() { "$@" || ignore_sig SIGPIPE; }
176
alias piped_cmd='"piped_cmd" ' # last space alias-expands next word
177
178 9020 aaronmk
fi # load new aliases
179
if self_being_included; then
180 9017 aaronmk
181 9020 aaronmk
182 8899 aaronmk
#### integers
183
184 9074 aaronmk
let!() { let "$@" || true; } # always returns true; safe to use for setting
185 8899 aaronmk
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
186
187 9074 aaronmk
bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
188 9004 aaronmk
189 9696 aaronmk
int2exit() { (( "$1" != 0 )); }
190 9017 aaronmk
191 9697 aaronmk
exit2bool() { if (( $? == 0 )); then echo 1; fi } # 0->non-empty; !=0->empty
192 9538 aaronmk
193 9697 aaronmk
194 9364 aaronmk
#### floats
195
196
int_part() { echo "${1%%.*}"; }
197
198
dec_suffix() { echo "${1#$(int_part "$1")}"; }
199
200
round_down() { int_part "$1"; }
201
202
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
203
204 9544 aaronmk
float_set_min() { if (($(int_part $1) >= $2)); then echo $1; else echo $2; fi; }
205 9364 aaronmk
206 9544 aaronmk
207 9079 aaronmk
#### strings
208
209 9653 aaronmk
starts_with() { test "${2#$1}" != "$2"; } # usage: starts_with pattern str
210
211 9711 aaronmk
match_prefix() # usage: match_prefix pattern str
212
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
213
214 9081 aaronmk
repeat() # usage: str=... n=... repeat
215
{
216 9304 aaronmk
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
217
	for (( ; n > 0; n-- )); do result="$result$str"; done
218
	echo "$result"
219 9081 aaronmk
}
220
221 9550 aaronmk
sed_cmd="sed -`case "$(uname)" in Darwin) echo E;; *) echo r;; esac`"
222 9366 aaronmk
alias sed="$sed_cmd"
223 9079 aaronmk
224 9366 aaronmk
fi # load new aliases
225
if self_being_included; then
226 9079 aaronmk
227 9425 aaronmk
rtrim() { log+ 3; sed 's/[[:space:]]+$//' <<<"$1"; }
228 9079 aaronmk
229 9085 aaronmk
230 8854 aaronmk
#### arrays
231 8694 aaronmk
232 9074 aaronmk
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
233 8816 aaronmk
234 9074 aaronmk
reverse() # usage: array=($(reverse args...))
235 8691 aaronmk
{
236
	local i
237 9080 aaronmk
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
238 8691 aaronmk
}
239
240 9097 aaronmk
contains() # usage: contains value in_array...
241
{
242
	local value="$1"; shift
243
	local elem
244
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
245
	return 1
246
}
247 9017 aaronmk
248 9715 aaronmk
#### streams
249 9097 aaronmk
250 9715 aaronmk
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
251
{ sleep 0.1; } # s; display after leading output of cmd1
252
253
254 8854 aaronmk
#### verbose output
255
256 9110 aaronmk
257 9208 aaronmk
err_fd=2 # stderr
258
259 9111 aaronmk
usage() { echo "Usage: $1" >&2; return 2; }
260 9110 aaronmk
261
262 9452 aaronmk
### log++
263 9110 aaronmk
264 9361 aaronmk
log_fd=2 # initially stderr
265 9209 aaronmk
266 9142 aaronmk
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
267
268 9006 aaronmk
# set verbosity
269 9005 aaronmk
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
270 9145 aaronmk
if isset vb; then : "${verbosity:=$vb}"; fi
271 9272 aaronmk
: "${verbosity=1}" # default
272 9006 aaronmk
: "${verbosity:=0}" # ensure non-empty
273 9119 aaronmk
export verbosity # propagate to invoked commands
274 9381 aaronmk
export PS4 # follows verbosity, so also propagate this
275 8710 aaronmk
276 9731 aaronmk
is_outermost="$(! isset log_level; exit2bool)" # if util.sh env not yet set up
277
278 9542 aaronmk
# set log_level
279
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
280
export log_level # propagate to invoked commands
281
282 9396 aaronmk
verbosity_int() { round_down "$verbosity"; }
283
284 9450 aaronmk
# verbosities (and `make` equivalents):
285 9359 aaronmk
# 0: just print errors. useful for cron jobs.
286 9451 aaronmk
#    vs. make: equivalent to --silent, but suppresses external command output
287 9359 aaronmk
# 1: also external commands run. useful for running at the command line.
288 9450 aaronmk
#    vs. make: not provided (but sorely needed to avoid excessive output)
289 9359 aaronmk
# 2: full graphical call tree. useful for determining where error occurred.
290 9450 aaronmk
#    vs. make: equivalent to default verbosity, but with much-needed indents
291 9360 aaronmk
# 3: also values of kw params and variables. useful for low-level debugging.
292 9450 aaronmk
#    vs. make: not provided; need to manually use $(error $(var))
293 9359 aaronmk
# 4: also variables in util.sh commands. useful for debugging util.sh.
294 9450 aaronmk
#    vs. make: somewhat similar to --print-data-base
295 9359 aaronmk
# 5: also variables in logging commands themselves. useful for debugging echo_*.
296 9450 aaronmk
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
297 9359 aaronmk
# 6+: not currently used (i.e. same as 5)
298
299 9287 aaronmk
# definition: the log_level is the minimum verbosity needed to display a message
300
# for messages that use can_log(), the log_level starts with *1*, not 0
301
# for unfiltered messages, the log_level is 0 (i.e. still output at verbosity=0)
302 9288 aaronmk
# to view a message's log_level, count the # of + signs before it in the output
303 9284 aaronmk
304 9305 aaronmk
fi # load new aliases
305
if self_being_included; then
306
307 9299 aaronmk
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
308 9176 aaronmk
#        outside func: log++; ...; log--
309 9720 aaronmk
#        before cmd:  "log++" cmd  OR  "log+" # cmd  OR  "log++" "log++" cmd
310 9716 aaronmk
# with a cmd, assignments are applied just to it, so log_local is not needed
311 9302 aaronmk
# without a cmd, "$@" expands to nothing and assignments are applied to caller
312 9305 aaronmk
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
313 9373 aaronmk
log+()
314
{
315
	# no local vars because w/o cmd, assignments should be applied to caller
316 9545 aaronmk
	PS4="$(str="${PS4:0:1}" n=$((log_level+$1-1)) repeat)${PS4: -2}"; \
317 9543 aaronmk
	log_level=$((log_level+$1)) \
318 9377 aaronmk
	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
319 9373 aaronmk
}
320 9374 aaronmk
log++() { log+  1 "$@"; }
321
log--() { log+ -1 "$@"; }
322 9542 aaronmk
alias log_local=\
323
'declare PS4="$PS4" log_level="$log_level" verbosity="$verbosity"'
324 9395 aaronmk
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
325 9301 aaronmk
alias log++='log_local; "log++" ' # last space alias-expands next word
326
alias log--='log_local; "log--" ' # last space alias-expands next word
327 9751 aaronmk
# no clog+ alias because next word is not a cmd
328
alias clog++='"log++" ' # last space alias-expands next word
329
alias clog--='"log--" ' # last space alias-expands next word
330 9176 aaronmk
331 9846 aaronmk
verbosity_min() # usage: verbosity_min {min|} # ''->verbosity=''
332
{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
333 9397 aaronmk
alias verbosity_min='log_local; "verbosity_min"'
334 9289 aaronmk
335 9397 aaronmk
336 9289 aaronmk
# indent for call tree. this is *not* the log_level (below).
337 9382 aaronmk
: "${log_indent_step=| }" "${log_indent=}"
338
export log_indent_step log_indent # propagate to invoked commands
339 9289 aaronmk
340 9794 aaronmk
# see indent alias in stubs
341 9289 aaronmk
342
343 9190 aaronmk
fi # load new aliases
344
if self_being_included; then
345
346 9396 aaronmk
can_log() { test "$(verbosity_int)" -gt 0; }
347 9380 aaronmk
	# verbosity=0 turns off all logging
348 8895 aaronmk
349 9212 aaronmk
log() { if can_log; then echo "$log_indent$PS4$1" >&"$log_fd"; fi; }
350 9064 aaronmk
351 9270 aaronmk
log_custom() # usage: symbol=... log_custom msg
352 9242 aaronmk
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
353 9070 aaronmk
354 9251 aaronmk
log_err() { symbol='#' verbosity=1 log_fd="$err_fd" log_custom "$@"; }
355 9070 aaronmk
356 9250 aaronmk
log_info() { symbol=: log_custom "$@"; }
357 9070 aaronmk
358 9678 aaronmk
die() # usage: cmd || [type=...] die msg # msg can use $? but not $()
359 9270 aaronmk
{ save_e; kw_params type; "log_${type:-err}" "$1"; rethrow; }
360 9069 aaronmk
361 9447 aaronmk
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
362
{
363
	save_e; kw_params benign_error
364 9449 aaronmk
	if test "$benign_error"; then log++; fi
365 9447 aaronmk
	type="${benign_error:+info}" die "command exited with \
366
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
367
	rethrow
368
}
369 8919 aaronmk
370 9437 aaronmk
371 9233 aaronmk
#### functions
372
373
func_exists() { declare -f "$1" >/dev/null; }
374
375
copy_func() # usage: from=... to=... copy_func
376
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
377
{
378
	: "${from:?}" "${to:?}"
379
	func_exists "$from" || die "function does not exist: $from"
380
	! func_exists "$to" || die "function already exists: $to"
381
	local from_def="$(declare -f "$from")"
382
	eval "$to${from_def#$from}"
383
}
384
385
func_override() # usage: func_override old_name__suffix
386 9559 aaronmk
{ from="${1%__*}" to="$1" copy_func; }
387 9233 aaronmk
388
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
389
{
390
	local nested_func="${FUNCNAME[1]}"
391
	local func="${nested_func%%__*}"
392
	contains "$func" "${FUNCNAME[@]}" || \
393
		die "$nested_func() must be used by $func()"
394
}
395
396
397 9240 aaronmk
#### paths
398
399 9313 aaronmk
# cache realpath
400
: "${realpath_cache=}" # default off because slower than without
401
if test "$realpath_cache"; then
402
func_override realpath__no_cache
403
realpath() # caches the last result for efficiency
404
{
405
	local cache_key="$*"; load_cache
406 9331 aaronmk
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
407 9313 aaronmk
	echo_cached_value
408
}
409
fi
410
411 9244 aaronmk
rel_path() # usage: base_dir=... path=... rel_path
412 9240 aaronmk
{
413 9788 aaronmk
	kw_params base_dir path
414 9244 aaronmk
	: "${base_dir:?}" "${path:?}"
415
416 9246 aaronmk
	local path="$path/" # add *extra* / to match path when exactly = base_dir
417
	path="${path#$base_dir/}" # remove prefix shared with base_dir
418
	path="${path%/}" # remove any remaining extra trailing /
419 9244 aaronmk
420 9245 aaronmk
	if test ! "$path"; then path=.; fi # ensure non-empty
421
422 9244 aaronmk
	echo_vars path
423 9240 aaronmk
	echo "$path"
424
}
425
426 9309 aaronmk
cd -P . # expand symlinks in $PWD so it matches the output of realpath
427
# do before setting $top_script_abs so realpath has less symlinks to resolve
428
429 9791 aaronmk
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
430 9331 aaronmk
{
431 9791 aaronmk
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
432
	base_dir="$(realpath "$base_dir")" || return
433 9331 aaronmk
	local path; path="$(realpath "$1")" || return
434 9791 aaronmk
	rel_path
435 9331 aaronmk
}
436 9244 aaronmk
437 9240 aaronmk
# makes $1 a canon_rel_path if it's a filesystem path
438
alias cmd2rel_path="$(cat <<'EOF'
439
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
440
	declare _1="$1"; shift
441 9788 aaronmk
	_1="$(clog++ canon_rel_path "$_1")" || return
442 9331 aaronmk
	set -- "$_1" "$@"
443 9240 aaronmk
fi
444
EOF
445
)"
446
447 9810 aaronmk
# usage: path_parents path; use ${dirs[@]} # includes the path itself
448
function path_parents()
449
{
450
	echo_func; local path="$1" prev_path=; dirs=()
451
	while test "$path" != "$prev_path"; do
452
		prev_path="$path"
453
		dirs+=("$path")
454
		path="${path%/*}"
455
	done
456
}
457
alias path_parents='declare dirs; "path_parents"'
458 9240 aaronmk
459 9810 aaronmk
460 9240 aaronmk
#### verbose output
461
462
463 9165 aaronmk
### command echoing
464
465
alias echo_params='log "$*"'
466
467 8995 aaronmk
fi # load new aliases
468
if self_being_included; then
469
470 9197 aaronmk
echo_cmd() { echo_params; }
471 9056 aaronmk
472 9549 aaronmk
function echo_run() { echo_params; "$@"; }
473 9796 aaronmk
# see echo_run alias after stub
474 9539 aaronmk
475 9278 aaronmk
echo_eval() { echo_params; builtin eval "$@"; }
476
477 9730 aaronmk
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
478 9655 aaronmk
function echo_redirs_cmd()
479
{
480 9730 aaronmk
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
481
482 9657 aaronmk
	# print <>file redirs before cmd, because they introduce it
483 9730 aaronmk
	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(
484 9809 aaronmk
		set -- "${redirs[@]}" # operate on ${redirs[@]}
485 9657 aaronmk
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
486
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
487
		echo "$@"
488 9655 aaronmk
	)
489
}
490
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
491
492 9263 aaronmk
## vars
493
494
echo_vars() # usage: echo_vars var...
495
{
496 9320 aaronmk
	log+ 2
497 9263 aaronmk
	if can_log; then
498
		local var
499
		for var in "${@%%=*}"; do
500
			if isset "$var"; then log "$(declare -p "$var")"; fi
501
		done
502
	fi
503
}
504
505
echo_export() { builtin export "$@"; echo_vars "$@"; }
506
507 9379 aaronmk
alias export="echo_export" # automatically echo env vars when they are set
508 9263 aaronmk
509
func_override kw_params__lang
510
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
511
512 9273 aaronmk
## functions
513 9264 aaronmk
514 9315 aaronmk
# usage: local func=...; set_func_loc; use $file, $line
515
alias set_func_loc="$(cat <<'EOF'
516
: "${func:?}"
517
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
518
func_info="${func_info#$func }"
519
local line="${func_info%% *}"
520
local file="${func_info#$line }"
521
EOF
522
)"
523
524
fi # load new aliases
525
if self_being_included; then
526
527
func_loc() # gets where function declared in the format file:line
528 9331 aaronmk
{
529
	local func="$1"; set_func_loc
530
	file="$(canon_rel_path "$file")" || return
531
	echo "$file:$line"
532
}
533 9315 aaronmk
534 9273 aaronmk
# usage: func() { [minor=1] echo_func; ... }
535 9317 aaronmk
function echo_func()
536
# usage: [minor=1] "echo_func" "$FUNCNAME" "$@" && indent || true
537 9273 aaronmk
# exit status: whether function call was echoed
538
{
539
	kw_params minor
540 9317 aaronmk
	local func="$1"; shift
541 9273 aaronmk
542
	log++; if test "$minor"; then log++; fi
543 9788 aaronmk
	local loc; loc="$(clog++ func_loc "$func")" || return
544 9331 aaronmk
	echo_cmd "$loc" "$func" "$@"
545 9273 aaronmk
	can_log
546
}
547 9790 aaronmk
# see echo_func alias after stub
548 9273 aaronmk
549 9276 aaronmk
fi # load new aliases
550
if self_being_included; then
551 9273 aaronmk
552 9276 aaronmk
553 9279 aaronmk
#### streams
554
555
fd_exists() { (: <&"$1") 2>/dev/null; }
556
557
require_fd_not_exists() # usage: require_fd_not_exists fd || return 0
558
{ ! fd_exists "$1" || type=info die "fd $1 already exists, skipping"; }
559
560 9712 aaronmk
set_fds() # usage: set_fds redirect...
561
{
562
	echo_func
563
564
	# add #<>&- before every #<>&# reopen to fix strange bash bug
565 9804 aaronmk
	local redirs=() i
566 9712 aaronmk
	for i in "$@"; do
567 9713 aaronmk
		local redir_prefix="$(match_prefix '*[<>]' "$i")"
568 9712 aaronmk
		if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
569 9713 aaronmk
		redirs+=("$i")
570 9712 aaronmk
	done
571
	set -- "${redirs[@]}"
572
573 9795 aaronmk
	if (($# > 0)); then echo_eval exec "$@"; fi
574 9712 aaronmk
}
575 9279 aaronmk
576
fd_set_default() # usage: fd_set_default 'dest[<>]src'
577
{
578
	echo_func
579
	local dest="${1%%[<>]*}"
580
	require_fd_not_exists "$dest" || return 0
581
	set_fds "$1"
582
}
583
584 9728 aaronmk
function filter_fd() # usage: (fd=# filter_fd filter_cmd...; with filter...)
585 9717 aaronmk
# useful e.g. to filter logging output or highlight errors
586
{
587
	echo_func; kw_params fd; : "${fd?}"
588
	set_fds "$fd>" >(pipe_delay; redirs=(">&$fd" "${redirs[@]}"); redir "$@")
589
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
590
}
591 9728 aaronmk
alias filter_fd='"filter_fd" ' # last space alias-expands next word
592 9717 aaronmk
593 9651 aaronmk
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
594
# do NOT use 1x, which are used by eval (which is used by set_fds())
595
# do NOT use 2x, which are used as global stdin/stdout/stderr
596
# do NOT use 3x, which are used for logging
597 9279 aaronmk
598 9282 aaronmk
setup_log_fd() # view logging output at verbosity >= 5
599
{
600 9319 aaronmk
	log+ 4; log-- echo_func
601 9282 aaronmk
	fd_set_default '30>&2' || true # stdlog
602
	log_fd=30 # stdlog
603
}
604
setup_log_fd
605
606 9279 aaronmk
set_global_fds()
607
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
608
# this works even when /dev/tty isn't available
609 9283 aaronmk
# view logging output at verbosity >= 3
610 9279 aaronmk
{
611 9319 aaronmk
	log+ 2; log-- echo_func
612 9279 aaronmk
	# ignore errors if a source fd isn't open
613
	fd_set_default '20<&0' || true
614
	fd_set_default '21>&1' || true
615
	fd_set_default '22>&2' || true
616
}
617
set_global_fds
618
619
# usage: explicit_errors_only=1 script...
620
# show only explicitly-displayed errors (which have been redirected to fd 22)
621
# most of the time this has the same effect as `verbosity=0 script...`,
622
# which displays everything that isn't explicitly hidden
623
# this option should only be used for testing the explicit error displaying
624
if test "$explicit_errors_only"; then disable_logging; fi
625
626
627 9731 aaronmk
echo_vars is_outermost
628
629
630 9264 aaronmk
#### paths
631
632 9735 aaronmk
top_symlink_dir="$(dirname "$0")"; echo_vars top_symlink_dir
633 9736 aaronmk
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
634
	echo_vars top_symlink_dir_abs
635 9724 aaronmk
636 9269 aaronmk
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
637
	# realpath this before doing any cd so this points to the right place
638 9724 aaronmk
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
639 9269 aaronmk
640 9265 aaronmk
set_paths()
641
{
642 9788 aaronmk
	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return
643 9331 aaronmk
		echo_vars top_script
644
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
645 9265 aaronmk
}
646
set_paths
647 9264 aaronmk
648 9725 aaronmk
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
649
{
650
	echo_func; echo_vars PATH; : "${PATH?}"
651
	PATH=":$PATH:" # add *extra* : to match at beginning and end
652
	for path in "$@"; do PATH="${PATH//:$path:/:}"; done
653
	PATH="${PATH#:}" # remove any remaining extra leading :
654
	PATH="${PATH%:}" # remove any remaining extra trailing :
655
	echo_vars PATH
656
}
657 9264 aaronmk
658 9726 aaronmk
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
659
# allows running a system command of the same name as the script
660 9737 aaronmk
{
661
	echo_func
662
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
663
}
664 9725 aaronmk
665 9726 aaronmk
666 9264 aaronmk
#### verbose output
667
668
669 9123 aaronmk
## internal commands
670
671 9166 aaronmk
.()
672
{
673 9850 aaronmk
	clog++ clog++ echo_func
674
	cmd2rel_path; set -- "$FUNCNAME" "$@"
675 9435 aaronmk
	if (log++; echo_params; can_log); then indent; fi
676 9166 aaronmk
	builtin "$@"
677
}
678 9158 aaronmk
679 9853 aaronmk
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
680
{
681
	clog++ clog++ echo_func; local file="$1"; shift
682
	. "$(canon_rel_path "$(dirname "${BASH_SOURCE[1]}")/$file")" "$@"
683
}
684
685 9253 aaronmk
cd() # indent is permanent within subshell cd was used in
686
{
687 9393 aaronmk
	log++ echo_func
688 9306 aaronmk
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
689 9435 aaronmk
	if can_log; then caller_indent; fi
690 9307 aaronmk
	# -P: expand symlinks so $PWD matches the output of realpath
691 9306 aaronmk
	builtin "$FUNCNAME" -P "$@"
692 9313 aaronmk
693
	func=realpath clear_cache
694 9266 aaronmk
	set_paths
695 9253 aaronmk
}
696
697 9110 aaronmk
## external commands
698
699 9262 aaronmk
disable_logging() { set_fds "$log_fd>/dev/null"; }
700 9224 aaronmk
701 9685 aaronmk
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
702 9138 aaronmk
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
703 9134 aaronmk
{
704 9686 aaronmk
	echo_func; kw_params redirs
705 9687 aaronmk
706
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
707 9685 aaronmk
	(
708
		log++ set_fds "${redirs[@]}"
709
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
710
		"$@"
711
	) || return
712
}
713
alias redir='"redir" ' # last space alias-expands next word
714
715 9689 aaronmk
alias_append save_e '; unset redirs' # don't redirect error handlers
716
717 9685 aaronmk
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] command extern_cmd...
718
{
719 9740 aaronmk
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
720 9291 aaronmk
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
721
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
722 9473 aaronmk
	local redirs=("${redirs[@]}")
723 9231 aaronmk
724 9685 aaronmk
	# determine redirections
725 9436 aaronmk
	if test "$cmd_log_fd"; then
726
		if can_log; then
727
			if test "$cmd_log_fd" != "$log_fd"; then
728 9473 aaronmk
				redirs+=("$cmd_log_fd>&$log_fd")
729 9436 aaronmk
			fi # else no redir needed
730 9473 aaronmk
		else redirs+=("$cmd_log_fd>/dev/null");
731 9436 aaronmk
		fi
732
	fi
733 9444 aaronmk
734 9685 aaronmk
	cmd2rel_path
735
	redir command__exec "$@" || die_e
736 9134 aaronmk
}
737 9685 aaronmk
command__exec()
738
{
739
	ensure_nested_func
740
	if can_log; then indent; fi
741
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
742 9723 aaronmk
	builtin command "$@"
743 9685 aaronmk
}
744 9133 aaronmk
745 9160 aaronmk
# auto-echo common external commands
746
for cmd in env rm; do alias "$cmd=command $cmd"; done; unset cmd
747 9110 aaronmk
748
749
### external command input/output
750 8907 aaronmk
751 9074 aaronmk
echo_stdin() # usage: input|echo_stdin|cmd
752 8702 aaronmk
{
753 8897 aaronmk
	if can_log; then
754 8998 aaronmk
		pipe_delay
755 9212 aaronmk
		echo ----- >&"$log_fd"
756
		tee -a /dev/fd/"$log_fd";
757
		echo ----- >&"$log_fd"
758 8897 aaronmk
	else cat
759
	fi
760 8702 aaronmk
}
761 8275 aaronmk
762 9318 aaronmk
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
763 9044 aaronmk
764 8873 aaronmk
765 8854 aaronmk
#### commands
766
767 9622 aaronmk
already_exists_msg() # usage: cond || what=... already_exists_msg || return 0
768
{ type=info die "$what already exists, skipping"; }
769 9620 aaronmk
770 9122 aaronmk
require_not_exists() # usage: require_not_exists file || return 0
771 9622 aaronmk
{ test ! -e "$1" || what="file \"$1\"" already_exists_msg; }
772 9062 aaronmk
773 9680 aaronmk
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
774 8986 aaronmk
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
775 9048 aaronmk
{
776 9695 aaronmk
	echo_func; kw_params stdout if_not_exists del
777 9680 aaronmk
	: "${stdout?}"; local del="${del-1}"
778 9475 aaronmk
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
779 9481 aaronmk
780 9652 aaronmk
	local redirs=("${redirs[@]}" ">$stdout")
781 9690 aaronmk
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
782 9048 aaronmk
}
783 9177 aaronmk
alias to_file='"to_file" ' # last space alias-expands next word
784 8986 aaronmk
785 9747 aaronmk
log_bg() { symbol='&' log_custom "$@"; }
786
787
log_last_bg() { log_bg '$!='"$!"; }
788
789
function bg_cmd() { echo_func; "$@" & log_last_bg; } # usage: bg_cmd cmd...
790
alias bg_cmd='"bg_cmd" ' # last space alias-expands next word
791
792 9074 aaronmk
run_args_cmd() # runs the command line args command
793 8272 aaronmk
{
794 8693 aaronmk
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
795 8971 aaronmk
	test $# -ge 1 || set -- all
796 9844 aaronmk
	echo_cmd "$top_script" "$@"; time "$@"
797 8272 aaronmk
}
798
799 9074 aaronmk
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
800 8272 aaronmk
{
801 8881 aaronmk
	echo_func
802 8284 aaronmk
	: "${subdirs?}"
803
804 9297 aaronmk
	for subdir in "${subdirs[@]}"; do "$top_dir"/"$subdir"/run "$@"; done
805 8272 aaronmk
}
806
807 9017 aaronmk
808 9552 aaronmk
#### filesystem
809
810 9830 aaronmk
alias mkdir='mkdir -p'
811
812 9556 aaronmk
alias file_size=\
813 9558 aaronmk
"stat `case "$(uname)" in Darwin) echo -f %z;; *) echo --format=%s;; esac`"
814 9552 aaronmk
815 9829 aaronmk
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
816 9552 aaronmk
817 9831 aaronmk
fi # load new aliases
818
if self_being_included; then
819 9829 aaronmk
820 9831 aaronmk
mv2dir() { echo_func; mkdir "${!#}"; mv "$@"; } # usage: mv2dir ... dir
821
822
# usage: (mv_glob ... dir)
823
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
824
alias mv_glob='shopt -s nullglob; "mv_glob"'
825
826
827 8966 aaronmk
#### URLs
828
829 9074 aaronmk
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
830 8966 aaronmk
831 8704 aaronmk
fi