Project

General

Profile

1
#!/bin/bash -e
2
set -o errexit -o pipefail # errexit in case caller's #! line missing -e
3

    
4
if test ! "$_util_sh_include_guard_utils"; then
5
_util_sh_include_guard_utils=1
6

    
7
isset() { declare -p "$1" &>/dev/null; }
8

    
9
realpath() { readlink -f -- "$1"; }
10

    
11
str2varname() { echo "${1//[^a-zA-Z0-9_]/_}"; }
12

    
13
include_guard_var() { str2varname "$(realpath "$1")"; }
14

    
15
self_not_included() # usage: if self_not_included; then ... fi
16
{
17
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
18
	local include_guard="$(include_guard_var "$1")"
19
	alias self_being_included=false
20
	! isset "$include_guard" && \
21
	{ eval "$include_guard"=1; alias self_being_included=true; }
22
}
23

    
24
# 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
fi
31

    
32

    
33
if self_not_included "${BASH_SOURCE[0]}"; then
34

    
35

    
36
#### options
37

    
38
shopt -s expand_aliases
39

    
40

    
41
#### stubs
42

    
43
__caller_indent='log_indent="$log_indent$log_indent_step"'
44
alias caller_indent="$__caller_indent"
45
alias indent="declare $__caller_indent"
46

    
47
function echo_func() { :; }
48
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
49

    
50
function echo_run() { :; }
51
alias echo_run='"echo_run" ' # last space alias-expands next word
52

    
53
# auto-echo common external commands
54
for cmd in env rm which; do alias "$cmd=echo_run $cmd"; done; unset cmd
55

    
56
echo_builtin() { :; }
57

    
58
function echo_vars() { :; }
59

    
60

    
61
#### logic
62

    
63
not() { ! "$@"; } # usage: wrapper_cmd not wrapped_cmd... # inverts exit status
64

    
65

    
66
#### vars
67

    
68
set_var() { eval "$1"'="$2"'; }
69

    
70
set_default() { if ! isset "$1"; then set_var "$@"; fi; }
71

    
72
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
73

    
74
# usage: local var=...; local_inv
75
alias local_inv=\
76
'declare "no_$var=$(test "${!var}" || echo 1)"; echo_vars no_$var'
77

    
78
unexport() { export -n "$@"; }
79
	# `declare +x` won't work because it defines the var if it isn't set
80

    
81
alias local_export='declare -x' # combines effects of local and export
82

    
83
# to make export only visible locally: local var="$var"; export var
84
# within cmd: var="$var" cmd...
85

    
86
get_prefix_vars() { : "${prefix:?}"; eval echo '${!'$prefix'*}'; }
87

    
88
# usage: local prefix=..._; import_vars
89
# when used inside another alias 2+ levels deep, *must* be run inside a function
90
alias import_vars="$(cat <<'EOF'
91
: "${prefix:?}"
92
declare src_var dest_var
93
for src_var in $(get_prefix_vars); do
94
	dest_var="${src_var#$prefix}"
95
	declare "$dest_var=${!dest_var-${!src_var}}"; echo_vars "$dest_var"
96
done
97
EOF
98
)"
99

    
100

    
101
#### caching
102

    
103
## shell-variable-based caching
104

    
105
# usage: local cache_key=...; load_cache; \
106
# if ! cached; then save_cache value || return; fi; echo_cached_value
107
# cache_key for function inputs: "$(declare -p kw_param...) $*"
108
alias load_cache='declare cache_var="$(str2varname "${FUNCNAME}___$cache_key")"'
109
alias cached='isset "$cache_var"'
110
alias save_cache='set_var "$cache_var"'
111
alias echo_cached_value='echo "${!cache_var}"'
112

    
113
clear_cache() # usage: func=... clear_cache
114
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
115

    
116
fi # load new aliases
117
if self_being_included; then
118

    
119

    
120
#### aliases
121

    
122
unalias() { builtin unalias "$@" 2>&- || true; } # no error if undefined
123

    
124
# usage: alias alias_='var=value run_cmd '
125
function run_cmd() { "$@"; }
126
alias run_cmd='"run_cmd" ' # last space alias-expands next word
127

    
128
alias_append() { eval "$(alias "$1")"'"$2"';} #usage: alias_append alias '; cmd'
129

    
130

    
131
#### commands
132

    
133
is_dot_script() { echo_func; test "${BASH_LINENO[${#BASH_LINENO[@]}-1]}" != 0; }
134

    
135
require_dot_script() # usage: require_dot_script || return
136
{
137
	echo_func
138
	if ! is_dot_script; then # was run without initial "."
139
		echo "usage: . $top_script (note initial \".\")"|fold -s >&2
140
		return 2
141
	fi
142
}
143

    
144
sys_cmd_path() { echo_func; echo_builtin command -p which "$1"|echo_stdout; }
145

    
146
# makes command in $1 a system command
147
# allows running a system command of the same name as the script
148
alias cmd2sys="$(cat <<'EOF'
149
declare _1="$1"; shift
150
_1="$(indent; clog++ sys_cmd_path "$_1")" || return
151
set -- "$_1" "$@"
152
EOF
153
)"
154

    
155
fi # load new aliases
156
if self_being_included; then
157

    
158
sys_cmd() { cmd2sys; command "$@"; } # usage: sys_cmd cmd... # runs system cmd
159
	# allows running a system command of the same name as the script
160

    
161

    
162
#### functions
163

    
164
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
165
# removes keyword-param-only vars from the environment
166
{ unexport "$@"; }
167

    
168
# usage: cmd=... foreach_arg
169
function foreach_arg()
170
{
171
	echo_func; kw_params cmd; : "${cmd:?}"
172
	local a; for a in "$@"; do
173
		a="$(clog++ echo_run "$cmd" "$a")" || return; args+=("$a")
174
	done
175
	echo_vars args
176
}
177
alias foreach_arg='"foreach_arg" "$@"; set -- "${args[@]}"; unset args'
178

    
179
alias self_name='echo "${FUNCNAME%%__*}"' # usage: "$(self_name)"
180

    
181
alias self='command "$(self_name)"' # usage: wrapper() { self ...; }
182
alias self_sys='sys_cmd "$(self_name)"' # wrapper() { self_sys ...; }
183

    
184
pf() { declare -f "$@" >&2; } # usage: pf function # debug-prints func decl
185

    
186
all_funcs() # usage: for func in $(all_funcs); do ...; done # all declared funcs
187
{ declare -F|while read -r line; do echo -n "${line#declare -f } "; done; }
188

    
189

    
190
#### exceptions
191

    
192
# usage: cmd || { save_e; ...; rethrow; }
193
alias export_e='e=$?'
194
alias save_e='declare e=$?'
195
alias rethrow='return "$e"'
196
alias rethrow_subshell='exit "$e"'
197

    
198
fi # load new aliases
199
if self_being_included; then
200

    
201
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
202

    
203
function try() { e=0; benign_error=1 "$@" || { export_e; true; }; }
204
alias try='declare e; "try" ' # last space alias-expands next word
205

    
206
catch() { test "$e" -eq "$1" && e=0; }
207

    
208
ignore_e() { catch "$@" || true; }
209

    
210
alias end_try='rethrow'
211
alias end_try_subshell='rethrow_subshell'
212

    
213
ignore() { save_e; ignore_e "$@"; rethrow; } # usage: try cmd || ignore status
214

    
215
### signals
216

    
217
sig_e() { echo $(( 128+$(kill -l "$1") )); } # usage: sig_e SIGINT, etc.
218

    
219
ignore_sig() { ignore "$(sig_e "$1")"; }
220

    
221
# usage: piped_cmd cmd1...|cmd2... # cmd2 doesn't read all its input
222
function piped_cmd() { "$@" || ignore_sig SIGPIPE; }
223
alias piped_cmd='"piped_cmd" ' # last space alias-expands next word
224

    
225
fi # load new aliases
226
if self_being_included; then
227

    
228

    
229
#### integers
230

    
231
let!() { let "$@" || true; } # always returns true; safe to use for setting
232
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
233

    
234
bool2int() { try test ! "$1"; echo "$e"; } # empty->0; non-empty->1
235

    
236
int2exit() { (( "$1" != 0 )); }
237

    
238
exit2bool() { if (( $? == 0 )); then echo 1; fi } # 0->non-empty; !=0->empty
239

    
240

    
241
#### floats
242

    
243
int_part() { echo "${1%%.*}"; }
244

    
245
dec_suffix() { echo "${1#$(int_part "$1")}"; }
246

    
247
round_down() { int_part "$1"; }
248

    
249
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
250

    
251
float_set_min() { if (($(int_part $1) >= $2)); then echo $1; else echo $2; fi; }
252

    
253

    
254
#### strings
255

    
256
starts_with() { test "${2#$1}" != "$2"; } # usage: starts_with pattern str
257

    
258
match_prefix() # usage: match_prefix pattern str
259
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
260

    
261
rm_prefix() { echo "${2#$1}"; } # usage: rm_prefix pattern str
262

    
263
repeat() # usage: str=... n=... repeat
264
{
265
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
266
	for (( ; n > 0; n-- )); do result="$result$str"; done
267
	echo "$result"
268
}
269

    
270
# usage: outer_cmd $sed_cmd ...
271
sed_cmd="env LANG= sed -`case "$(uname)" in Darwin) echo El;; *) echo ru;;esac`"
272
	# LANG: avoid invalid UTF-8 "illegal byte sequence" errors when LANG=*.UTF-8
273
	# -l: line buffered / -u: unbuffered
274
alias sed="$sed_cmd"
275
	# can't be function because this causes segfault in redir() subshell when
276
	# used with make.sh make() filter
277

    
278
fi # load new aliases
279
if self_being_included; then
280

    
281
rtrim() { log+ 3; sed 's/[[:space:]]+$//' <<<"$1"; }
282

    
283

    
284
#### arrays
285

    
286
echo1() { echo "$1"; } # usage: echo1 values...
287

    
288
# usage: split delim str; use ${parts[@]}
289
function split() { echo_func; local IFS="$1"; parts=($2); echo_vars parts; }
290
alias split='declare parts; "split"'
291

    
292
join() { local IFS="$delim"; echo "$*"; } # usage: delim=char join elems...
293

    
294
reverse() # usage: array=($(reverse args...))
295
{
296
	local i
297
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
298
}
299

    
300
contains() # usage: contains value in_array...
301
{
302
	local value="$1"; shift
303
	local elem
304
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
305
	return 1
306
}
307

    
308
is_array() # handles unset vars (=false)
309
{
310
	isset "$1" || return 1
311
	local decl; decl="$(declare -p "$1")" || return; echo_vars decl
312
	starts_with 'declare -a' "$decl" # also matches -ax
313
}
314

    
315
#### streams
316

    
317
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
318
{ sleep 0.1; } # s; display after leading output of cmd1
319

    
320

    
321
#### verbose output
322

    
323

    
324
err_fd=2 # stderr
325

    
326
usage() { echo "Usage: $1" >&2; return 2; }
327

    
328

    
329
### log++
330

    
331
log_fd=2 # initially stderr
332

    
333
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
334

    
335
# set verbosity
336
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
337
if isset vb; then : "${verbosity:=$vb}"; fi
338
: "${verbosity=1}" # default
339
: "${verbosity:=0}" # ensure non-empty
340
export verbosity # propagate to invoked commands
341
export PS4 # follows verbosity, so also propagate this
342

    
343
is_outermost="$(! isset log_level; exit2bool)" # if util.sh env not yet set up
344

    
345
# set log_level
346
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
347
export log_level # propagate to invoked commands
348

    
349
verbosity_int() { round_down "$verbosity"; }
350

    
351
# verbosities (and `make` equivalents):
352
# 0: just print errors. useful for cron jobs.
353
#    vs. make: equivalent to --silent, but suppresses external command output
354
# 1: also external commands run. useful for running at the command line.
355
#    vs. make: not provided (but sorely needed to avoid excessive output)
356
# 2: full graphical call tree. useful for determining where error occurred.
357
#    vs. make: equivalent to default verbosity, but with much-needed indents
358
# 3: also values of kw params and variables. useful for low-level debugging.
359
#    vs. make: not provided; need to manually use $(error $(var))
360
# 4: also variables in util.sh commands. useful for debugging util.sh.
361
#    vs. make: somewhat similar to --print-data-base
362
# 5: also variables in logging commands themselves. useful for debugging echo_*.
363
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
364
# 6+: not currently used (i.e. same as 5)
365

    
366
# definition: the log_level is the minimum verbosity needed to display a message
367
# for messages that use can_log(), the log_level starts with *1*, not 0
368
# for unfiltered messages, the log_level is 0 (i.e. still output at verbosity=0)
369
# to view a message's log_level, count the # of + signs before it in the output
370

    
371
fi # load new aliases
372
if self_being_included; then
373

    
374
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
375
#        outside func: log++; ...; log--
376
#        before cmd:  "log++" cmd  OR  "log+" # cmd  OR  "log++" "log++" cmd
377
# with a cmd, assignments are applied just to it, so log_local is not needed
378
# without a cmd, "$@" expands to nothing and assignments are applied to caller
379
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
380
log+()
381
{
382
	# no local vars because w/o cmd, assignments should be applied to caller
383
	PS4="$(str="${PS4:0:1}" n=$((log_level+$1-1)) repeat)${PS4: -2}"; \
384
	log_level=$((log_level+$1)) \
385
	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
386
}
387
log-() { log+ "-$1" "${@:2}"; }
388
log++() { log+ 1 "$@"; }
389
log--() { log- 1 "$@"; }
390
alias log_local=\
391
'declare PS4="$PS4" log_level="$log_level" verbosity="$verbosity"'
392
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
393
alias log++='log_local; "log++" ' # last space alias-expands next word
394
alias log--='log_local; "log--" ' # last space alias-expands next word
395
# no clog+ alias because next word is not a cmd
396
alias clog++='"log++" ' # last space alias-expands next word
397
alias clog--='"log--" ' # last space alias-expands next word
398

    
399
verbosity_min() # usage: verbosity_min {min|} # ''->verbosity=''
400
{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
401
alias verbosity_min='log_local; "verbosity_min"'
402

    
403
# usage: (verbosity_compat; cmd)
404
function verbosity_compat()
405
{ echo_func; if ((verbosity == 1)); then unset verbosity; fi; }
406
alias verbosity_compat='declare verbosity; "verbosity_compat"'
407

    
408

    
409
# indent for call tree. this is *not* the log_level (below).
410
: "${log_indent_step=| }" "${log_indent=}"
411
export log_indent_step log_indent # propagate to invoked commands
412

    
413
# see indent alias in stubs
414

    
415

    
416
fi # load new aliases
417
if self_being_included; then
418

    
419
can_log() { test "$(verbosity_int)" -gt 0; }
420
	# verbosity=0 turns off all logging
421

    
422
log() { if can_log; then echo "$log_indent$PS4$1" >&"$log_fd"; fi; }
423

    
424
log_custom() # usage: symbol=... log_custom msg
425
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
426

    
427
log_err() { symbol='#' verbosity=1 log_fd="$err_fd" log_custom "$@"; }
428

    
429
log_info() { symbol=: log_custom "$@"; }
430

    
431
die() # usage: cmd || [type=...] die msg # msg can use $? but not $()
432
{ save_e; kw_params type; "log_${type:-err}" "$1"; rethrow; }
433

    
434
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
435
{
436
	save_e; kw_params benign_error
437
	if test "$benign_error"; then log++; fi
438
	type="${benign_error:+info}" die "command exited with \
439
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
440
	rethrow
441
}
442

    
443

    
444
#### functions
445

    
446
func_exists() { declare -f "$1" >/dev/null; }
447

    
448
copy_func() # usage: from=... to=... copy_func
449
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
450
{
451
	: "${from:?}" "${to:?}"
452
	func_exists "$from" || die "function does not exist: $from"
453
	! func_exists "$to" || die "function already exists: $to"
454
	local from_def="$(declare -f "$from")"
455
	eval "$to${from_def#$from}"
456
}
457

    
458
func_override() # usage: func_override old_name__suffix
459
{ from="${1%__*}" to="$1" copy_func; }
460

    
461
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
462
{
463
	local nested_func="${FUNCNAME[1]}"
464
	local func="${nested_func%%__*}"
465
	contains "$func" "${FUNCNAME[@]}" || \
466
		die "$nested_func() must be used by $func()"
467
}
468

    
469

    
470
#### paths
471

    
472
# cache realpath
473
: "${realpath_cache=}" # default off because slower than without
474
if test "$realpath_cache"; then
475
func_override realpath__no_cache
476
realpath() # caches the last result for efficiency
477
{
478
	local cache_key="$*"; load_cache
479
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
480
	echo_cached_value
481
}
482
fi
483

    
484
rel_path() # usage: base_dir=... path=... rel_path
485
{
486
	kw_params base_dir path
487
	: "${base_dir:?}" "${path:?}"
488
	
489
	local path="$path/" # add *extra* / to match path when exactly = base_dir
490
	path="${path#$base_dir/}" # remove prefix shared with base_dir
491
	path="${path%/}" # remove any remaining extra trailing /
492
	
493
	if test ! "$path"; then path=.; fi # ensure non-empty
494
	
495
	echo_vars path
496
	echo "$path"
497
}
498

    
499
cd -P . # expand symlinks in $PWD so it matches the output of realpath
500
# do before setting $top_script_abs so realpath has less symlinks to resolve
501

    
502
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
503
{
504
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
505
	base_dir="$(realpath "$base_dir")" || return
506
	local path; path="$(realpath "$1")" || return
507
	rel_path
508
}
509

    
510
canon_dir_rel_path() # usage: [base_dir=...] canon_dir_rel_path path
511
# if the path is a symlink, just its parent dir will be canonicalized
512
{
513
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
514
	base_dir="$(realpath "$base_dir")" || return
515
	local path; path="$(realpath "$(dirname "$1")")/$(basename "$1")" || return
516
	rel_path
517
}
518

    
519
# makes $1 a canon_rel_path if it's a filesystem path
520
alias cmd2rel_path="$(cat <<'EOF'
521
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
522
	declare _1="$1"; shift
523
	_1="$(clog++ canon_rel_path "$_1")" || return
524
	set -- "$_1" "$@"
525
fi
526
EOF
527
)"
528

    
529
# usage: path_parents path; use ${dirs[@]} # includes the path itself
530
function path_parents()
531
{
532
	echo_func; local path="$1" prev_path=; dirs=()
533
	while test "$path" != "$prev_path"; do
534
		prev_path="$path"
535
		dirs+=("$path")
536
		path="${path%/*}"
537
	done
538
}
539
alias path_parents='declare dirs; "path_parents"'
540

    
541

    
542
#### verbose output
543

    
544

    
545
### command echoing
546

    
547
alias echo_params='log "$*"'
548

    
549
fi # load new aliases
550
if self_being_included; then
551

    
552
echo_cmd() { echo_params; }
553

    
554
function echo_run() { echo_params; "$@"; }
555
# see echo_run alias after stub
556

    
557
echo_builtin() { echo_run builtin "$@"; } # usage: echo_builtin builtin_cmd...
558

    
559
echo_eval() { echo_params; builtin eval "$@"; }
560

    
561
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
562
function echo_redirs_cmd()
563
{
564
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
565
	
566
	# print <>file redirs before cmd, because they introduce it
567
	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(
568
		set -- "${redirs[@]}" # operate on ${redirs[@]}
569
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
570
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
571
		echo "$@"
572
	)
573
}
574
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
575

    
576
## vars
577

    
578
echo_vars() # usage: echo_vars var... # only prints vars that are defined
579
{
580
	log+ 2
581
	if can_log; then
582
		local var
583
		for var in "${@%%=*}"; do
584
			if isset "$var"; then log "$(declare -p "$var")"; fi
585
		done
586
	fi
587
}
588

    
589
echo_export() { builtin export "$@"; echo_vars "$@"; }
590

    
591
alias export="echo_export" # automatically echo env vars when they are set
592

    
593
func_override kw_params__lang
594
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
595

    
596
## functions
597

    
598
# usage: local func=...; set_func_loc; use $file, $line
599
alias set_func_loc="$(cat <<'EOF'
600
: "${func:?}"
601
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
602
func_info="${func_info#$func }"
603
local line="${func_info%% *}"
604
local file="${func_info#$line }"
605
EOF
606
)"
607

    
608
fi # load new aliases
609
if self_being_included; then
610

    
611
func_loc() # gets where function declared in the format file:line
612
{
613
	local func="$1"; set_func_loc
614
	file="$(canon_rel_path "$file")" || return
615
	echo "$file:$line"
616
}
617

    
618
# usage: func() { [minor=1] echo_func; ... }
619
function echo_func()
620
# usage: "echo_func" "$FUNCNAME" "$@" && indent || true
621
# exit status: whether function call was echoed
622
{
623
	log++; can_log || return
624
	local func="$1"; shift
625
	local loc; loc="$(clog++ func_loc "$func")" || return
626
	echo_cmd "$loc" "$func" "$@"
627
}
628
# see echo_func alias after stub
629

    
630
fi # load new aliases
631
if self_being_included; then
632

    
633

    
634
#### streams
635

    
636
fd_exists() { (: <&"$1") 2>/dev/null; }
637

    
638
require_fd_not_exists() # usage: require_fd_not_exists fd || return 0
639
{ ! fd_exists "$1" || type=info die "fd $1 already exists, skipping"; }
640

    
641
set_fds() # usage: set_fds redirect...
642
# WARNING: does not currently support redirecting an fd to itself (due to bash
643
# bug that requires the dest fd to be closed before it can be reopened)
644
{
645
	echo_func
646
	
647
	# add #<>&- before every #<>&# reopen to fix strange bash bug
648
	local redirs=() i
649
	for i in "$@"; do
650
		# remove empty redirects resulting from using `redirs= cmd...` to clear
651
		# the redirs and then using $redirs as an array
652
		if test "$i"; then
653
			local redir_prefix="$(match_prefix '*[<>]' "$i")"
654
			local dest="$(        rm_prefix    '*[<>]' "$i")"
655
			if test "$dest" && ! starts_with '&' "$dest"; then # escape dest
656
				i="$redir_prefix$(printf %q "$dest")"
657
			fi
658
			if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
659
			redirs+=("$i")
660
		fi
661
	done
662
	set -- "${redirs[@]}"
663
	
664
	if (($# > 0)); then echo_eval exec "$@"; fi
665
}
666

    
667
fd_set_default() # usage: fd_set_default 'dest[<>]src'
668
{
669
	echo_func
670
	local dest="${1%%[<>]*}"
671
	require_fd_not_exists "$dest" || return 0
672
	set_fds "$1"
673
}
674

    
675
stdout2fd() # usage: fd=# stdout2fd cmd...
676
{
677
	echo_func; kw_params fd; : "${fd?}"
678
	if test "$fd" != 1; then local redirs=(">&$fd" "${redirs[@]}"); fi
679
	redir "$@"
680
}
681

    
682
function filter_fd() # usage: (fd=# [redirs=] filter_fd filter_cmd...; \
683
# with filter...) # be sure ${redirs[@]} is not set to an outer value
684
# useful e.g. to filter logging output or highlight errors
685
{
686
	echo_func; kw_params fd; : "${fd?}"
687
	set_fds "$fd>" >(pipe_delay; stdout2fd "$@")
688
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
689
}
690
alias filter_fd='"filter_fd" ' # last space alias-expands next word
691

    
692
stderr2stdout() # usage: stderr2stdout cmd... # unlike `2>&1`, logs stderr
693
{
694
	echo_func
695
	# command causes log_fd to be re-filtered, so that stderr is also filtered.
696
	# this allows log-filtering out an otherwise-confusing benign error.
697
	"$@" 2> >(command tee /dev/fd/"$log_fd") # redirects 2->1,log_fd (*not* ->2)
698
}
699

    
700
stdout_contains() # usage: stderr2stdout cmd|stdout_contains echo_run grep ...
701
{ echo_func; pipe_delay; pipe_delay; "$@"|echo_stdout >/dev/null; }
702

    
703
stderr_matches() # usage: pattern=... stderr_matches cmd...
704
{
705
	echo_func; kw_params pattern; : "${pattern?}"
706
	stderr2stdout "$@"|stdout_contains echo_run grep -E "$pattern"
707
}
708

    
709
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
710
# mnemonic: 4 looks like A for Alternate
711
# do NOT use 1x, which are used by eval (which is used by set_fds())
712
# do NOT use 2x, which we use as global stdin/stdout/stderr
713
# do NOT use 3x, which we use for logging
714

    
715
setup_log_fd() # view logging output at verbosity >= 5
716
{
717
	log+ 4; log-- echo_func 
718
	fd_set_default '30>&2' || true # stdlog
719
	log_fd=30 # stdlog
720
}
721
setup_log_fd
722

    
723
set_global_fds()
724
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
725
# this works even when /dev/tty isn't available
726
# view logging output at verbosity >= 3
727
{
728
	log+ 2; log-- echo_func
729
	# ignore errors if a source fd isn't open
730
	fd_set_default '20<&0' || true
731
	fd_set_default '21>&1' || true
732
	fd_set_default '22>&2' || true
733
}
734
set_global_fds
735

    
736
# usage: explicit_errors_only=1 script...
737
# show only explicitly-displayed errors (which have been redirected to fd 22)
738
# most of the time this has the same effect as `verbosity=0 script...`,
739
# which displays everything that isn't explicitly hidden
740
# this option should only be used for testing the explicit error displaying
741
if test "$explicit_errors_only"; then disable_logging; fi
742

    
743

    
744
echo_vars is_outermost
745

    
746

    
747
#### paths
748

    
749
top_script="${BASH_SOURCE[${#BASH_SOURCE[@]}-1]}"
750
	# outermost script; unlike $0, also defined for .-scripts
751

    
752
top_symlink_dir="$(dirname "$top_script")"; echo_vars top_symlink_dir
753
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
754
	echo_vars top_symlink_dir_abs
755

    
756
top_script_abs="$(realpath "$top_script")"; echo_vars top_script_abs
757
	# realpath this before doing any cd so this points to the right place
758
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
759

    
760
set_paths()
761
{
762
	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return
763
		echo_vars top_script
764
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
765
}
766
set_paths
767

    
768
# usage: in_top_dir cmd...
769
function in_top_dir() { echo_func; (cd "$top_dir"; "$@"); }
770
alias in_top_dir='"in_top_dir" ' # last space alias-expands next word
771

    
772
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
773
{
774
	echo_func; echo_vars PATH; : "${PATH?}"
775
	log+ 2
776
	split : "$PATH"
777
	local new_paths=()
778
	for path in "${parts[@]}"; do
779
		if ! contains "$path" "$@"; then new_paths+=("$path"); fi
780
	done
781
	PATH="$(delim=: join "${new_paths[@]}")" || return
782
	log- 2
783
	echo_vars PATH
784
}
785

    
786
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
787
# allows running a system command of the same name as the script
788
{
789
	echo_func
790
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
791
}
792

    
793
# makes command in $1 nonrecursive
794
# allows running a system command of the same name as the script
795
alias cmd2abs_path="$(cat <<'EOF'
796
declare _1="$1"; shift
797
_1="$(indent; no_PATH_recursion; log++; which "$_1"|echo_stdout)" || return
798
set -- "$_1" "$@"
799
EOF
800
)"
801

    
802

    
803
#### verbose output
804

    
805

    
806
## internal commands
807

    
808
.()
809
{
810
	clog++ clog++ echo_func
811
	cmd2rel_path; set -- "$FUNCNAME" "$@"
812
	if (log++; echo_params; can_log); then indent; fi
813
	builtin "$@"
814
}
815

    
816
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
817
{
818
	clog++ clog++ echo_func; local file="$1"; shift
819
	. "$(canon_rel_path "$(dirname "$(realpath "${BASH_SOURCE[1]}")")/$file")" \
820
"$@"
821
}
822

    
823
cd() # indent is permanent within subshell cd was used in
824
{
825
	log++ echo_func
826
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
827
	if can_log; then caller_indent; fi
828
	# -P: expand symlinks so $PWD matches the output of realpath
829
	builtin "$FUNCNAME" -P "$@"
830
	
831
	func=realpath clear_cache
832
	set_paths
833
}
834

    
835
## external commands
836

    
837
disable_logging() { set_fds "$log_fd>/dev/null"; }
838

    
839
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
840
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
841
{
842
	echo_func; kw_params redirs
843
	
844
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
845
	(
846
		log++ set_fds "${redirs[@]}"
847
		unset redirs # don't redirect again in invoked command
848
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
849
		"$@"
850
	) || return
851
}
852
alias redir='"redir" ' # last space alias-expands next word
853

    
854
alias_append save_e '; unset redirs' # don't redirect error handlers
855

    
856
fi # load new aliases
857
if self_being_included; then
858

    
859
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] [nonrecursive=1] \
860
# command extern_cmd...
861
{
862
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
863
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
864
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
865
	local redirs=("${redirs[@]}")
866
	
867
	# determine redirections
868
	if test "$cmd_log_fd"; then
869
		if can_log; then
870
			if test "$cmd_log_fd" != "$log_fd"; then
871
				redirs+=("$cmd_log_fd>&$log_fd")
872
			fi # else no redir needed
873
		else redirs+=("$cmd_log_fd>/dev/null");
874
		fi
875
	fi
876
	
877
	if test "$nonrecursive"; then cmd2abs_path; else cmd2rel_path; fi
878
	redir command__exec "$@" || die_e
879
}
880
command__exec()
881
{
882
	ensure_nested_func
883
	if can_log; then indent; fi
884
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
885
	verbosity_compat
886
	builtin command "$@"
887
}
888

    
889

    
890
### external command input/output
891

    
892
echo_stdin() # usage: input|echo_stdin|cmd
893
{
894
	if can_log; then
895
		pipe_delay
896
		echo ----- >&"$log_fd"
897
		tee -a /dev/fd/"$log_fd";
898
		echo ----- >&"$log_fd"
899
	else cat
900
	fi
901
}
902

    
903
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
904

    
905

    
906
#### commands
907

    
908
already_exists_msg() # usage: cond || what=... already_exists_msg || return 0
909
{
910
	type=info die "$what"' already exists, skipping
911
 to force-remake, prepend `rm=1` to the command '
912
}
913

    
914
require_not_exists() # usage: require_not_exists file || return 0
915
{ test ! -e "$1" || what="file \"$1\"" already_exists_msg; }
916

    
917
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
918
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
919
{
920
	echo_func; kw_params stdout if_not_exists del
921
	: "${stdout?}"; local del="${del-1}"
922
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
923
	
924
	local redirs=("${redirs[@]}" ">$stdout")
925
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
926
}
927
alias to_file='"to_file" ' # last space alias-expands next word
928

    
929
log_bg() { symbol='&' log_custom "$@"; }
930

    
931
log_last_bg() { log_bg '$!='"$!"; }
932

    
933
function bg_cmd() { echo_func; "$@" & log_last_bg; } # usage: bg_cmd cmd...
934
alias bg_cmd='"bg_cmd" ' # last space alias-expands next word
935

    
936

    
937
#### filesystem
938

    
939
alias mkdir='mkdir -p'
940

    
941
alias file_size=\
942
"stat `case "$(uname)" in Darwin) echo -f %z;; *) echo --format=%s;; esac`"
943

    
944
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
945
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
946

    
947
fi # load new aliases
948
if self_being_included; then
949

    
950
mv2dir() { echo_func; mkdir "${!#}"; mv "$@"; } # usage: mv2dir ... dir
951

    
952
# usage: (mv_glob ... dir)
953
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
954
alias mv_glob='shopt -s nullglob; "mv_glob"'
955

    
956

    
957
#### URLs
958

    
959
localize_url() { test _"$1" = _"$(hostname -f)" || echo "$1"; }
960

    
961
fi
(10-10/11)