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
#### vars
62

    
63
set_var() { eval "$1"'="$2"'; }
64

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

    
67
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
68

    
69
# usage: local var=...; local_inv
70
alias local_inv=\
71
'declare "no_$var=$(test "${!var}" || echo 1)"; echo_vars no_$var'
72

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

    
76
alias local_export='declare -x' # combines effects of local and export
77

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

    
80
# usage: local prefix=..._; import_vars
81
# when used inside another alias 2+ levels deep, *must* be run inside a function
82
alias import_vars="$(cat <<'EOF'
83
: "${prefix:?}"
84
declare src_var dest_var
85
for src_var in $(get_prefix_vars); do
86
	dest_var="${src_var#$prefix}"
87
	declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
88
done
89
EOF
90
)"
91

    
92

    
93
#### caching
94

    
95
## shell-variable-based caching
96

    
97
# usage: local cache_key=...; load_cache; \
98
# if ! cached; then save_cache value || return; fi; echo_cached_value
99
# cache_key for function inputs: "$(declare -p kw_param...) $*"
100
alias load_cache='declare cache_var="$(str2varname "${FUNCNAME}___$cache_key")"'
101
alias cached='isset "$cache_var"'
102
alias save_cache='set_var "$cache_var"'
103
alias echo_cached_value='echo "${!cache_var}"'
104

    
105
clear_cache() # usage: func=... clear_cache
106
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
107

    
108
fi # load new aliases
109
if self_being_included; then
110

    
111

    
112
#### aliases
113

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

    
116
# usage: alias alias_='var=value run_cmd '
117
function run_cmd() { "$@"; }
118
alias run_cmd='"run_cmd" ' # last space alias-expands next word
119

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

    
122

    
123
#### commands
124

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

    
127
# makes command in $1 a system command
128
# allows running a system command of the same name as the script
129
alias cmd2sys="$(cat <<'EOF'
130
declare _1="$1"; shift
131
_1="$(indent; clog++ sys_cmd_path "$_1")" || return
132
set -- "$_1" "$@"
133
EOF
134
)"
135

    
136
fi # load new aliases
137
if self_being_included; then
138

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

    
142

    
143
#### functions
144

    
145
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
146
# removes keyword-param-only vars from the environment
147
{ unexport "$@"; }
148

    
149
# usage: cmd=... foreach_arg
150
function foreach_arg()
151
{
152
	echo_func; kw_params cmd; : "${cmd:?}"
153
	local a; for a in "$@"; do
154
		a="$(clog++ echo_run "$cmd" "$a")" || return; args+=("$a")
155
	done
156
	echo_vars args
157
}
158
alias foreach_arg='"foreach_arg" "$@"; set -- "${args[@]}"; unset args'
159

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

    
162
alias self='command "$(self_name)"' # usage: wrapper() { self ...; }
163
alias self_sys='sys_cmd "$(self_name)"' # wrapper() { self_sys ...; }
164

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

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

    
170

    
171
#### exceptions
172

    
173
# usage: cmd || { save_e; ...; rethrow; }
174
alias export_e='e=$?'
175
alias save_e='declare e=$?'
176
alias rethrow='return "$e"'
177
alias rethrow_subshell='exit "$e"'
178

    
179
fi # load new aliases
180
if self_being_included; then
181

    
182
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
183

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

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

    
189
ignore_e() { catch "$@" || true; }
190

    
191
alias end_try='rethrow'
192
alias end_try_subshell='rethrow_subshell'
193

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

    
196
### signals
197

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

    
200
ignore_sig() { ignore "$(sig_e "$1")"; }
201

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

    
206
fi # load new aliases
207
if self_being_included; then
208

    
209

    
210
#### integers
211

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

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

    
217
int2exit() { (( "$1" != 0 )); }
218

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

    
221

    
222
#### floats
223

    
224
int_part() { echo "${1%%.*}"; }
225

    
226
dec_suffix() { echo "${1#$(int_part "$1")}"; }
227

    
228
round_down() { int_part "$1"; }
229

    
230
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
231

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

    
234

    
235
#### strings
236

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

    
239
match_prefix() # usage: match_prefix pattern str
240
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
241

    
242
repeat() # usage: str=... n=... repeat
243
{
244
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
245
	for (( ; n > 0; n-- )); do result="$result$str"; done
246
	echo "$result"
247
}
248

    
249
# usage: outer_cmd $sed_cmd ...
250
sed_cmd="env LANG= sed -`case "$(uname)" in Darwin) echo El;; *) echo ru;;esac`"
251
	# LANG: avoid invalid UTF-8 "illegal byte sequence" errors when LANG=*.UTF-8
252
	# -l: line buffered / -u: unbuffered
253
alias sed="$sed_cmd"
254
	# can't be function because this causes segfault in redir() subshell when
255
	# used with make.sh make() filter
256

    
257
fi # load new aliases
258
if self_being_included; then
259

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

    
262

    
263
#### arrays
264

    
265
echo1() { echo "$1"; } # usage: echo1 values...
266

    
267
# usage: split delim str; use ${parts[@]}
268
function split() { echo_func; local IFS="$1"; parts=($2); echo_vars parts; }
269
alias split='declare parts; "split"'
270

    
271
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
272

    
273
reverse() # usage: array=($(reverse args...))
274
{
275
	local i
276
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
277
}
278

    
279
contains() # usage: contains value in_array...
280
{
281
	local value="$1"; shift
282
	local elem
283
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
284
	return 1
285
}
286

    
287
is_array()
288
{
289
	local decl; decl="$(declare -p "$1")" || return; echo_vars decl
290
	starts_with 'declare -a' "$decl" # also matches -ax
291
}
292

    
293
#### streams
294

    
295
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
296
{ sleep 0.1; } # s; display after leading output of cmd1
297

    
298

    
299
#### verbose output
300

    
301

    
302
err_fd=2 # stderr
303

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

    
306

    
307
### log++
308

    
309
log_fd=2 # initially stderr
310

    
311
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
312

    
313
# set verbosity
314
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
315
if isset vb; then : "${verbosity:=$vb}"; fi
316
: "${verbosity=1}" # default
317
: "${verbosity:=0}" # ensure non-empty
318
export verbosity # propagate to invoked commands
319
export PS4 # follows verbosity, so also propagate this
320

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

    
323
# set log_level
324
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
325
export log_level # propagate to invoked commands
326

    
327
verbosity_int() { round_down "$verbosity"; }
328

    
329
# verbosities (and `make` equivalents):
330
# 0: just print errors. useful for cron jobs.
331
#    vs. make: equivalent to --silent, but suppresses external command output
332
# 1: also external commands run. useful for running at the command line.
333
#    vs. make: not provided (but sorely needed to avoid excessive output)
334
# 2: full graphical call tree. useful for determining where error occurred.
335
#    vs. make: equivalent to default verbosity, but with much-needed indents
336
# 3: also values of kw params and variables. useful for low-level debugging.
337
#    vs. make: not provided; need to manually use $(error $(var))
338
# 4: also variables in util.sh commands. useful for debugging util.sh.
339
#    vs. make: somewhat similar to --print-data-base
340
# 5: also variables in logging commands themselves. useful for debugging echo_*.
341
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
342
# 6+: not currently used (i.e. same as 5)
343

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

    
349
fi # load new aliases
350
if self_being_included; then
351

    
352
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
353
#        outside func: log++; ...; log--
354
#        before cmd:  "log++" cmd  OR  "log+" # cmd  OR  "log++" "log++" cmd
355
# with a cmd, assignments are applied just to it, so log_local is not needed
356
# without a cmd, "$@" expands to nothing and assignments are applied to caller
357
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
358
log+()
359
{
360
	# no local vars because w/o cmd, assignments should be applied to caller
361
	PS4="$(str="${PS4:0:1}" n=$((log_level+$1-1)) repeat)${PS4: -2}"; \
362
	log_level=$((log_level+$1)) \
363
	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
364
}
365
log-() { log+ "-$1" "${@:2}"; }
366
log++() { log+ 1 "$@"; }
367
log--() { log- 1 "$@"; }
368
alias log_local=\
369
'declare PS4="$PS4" log_level="$log_level" verbosity="$verbosity"'
370
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
371
alias log++='log_local; "log++" ' # last space alias-expands next word
372
alias log--='log_local; "log--" ' # last space alias-expands next word
373
# no clog+ alias because next word is not a cmd
374
alias clog++='"log++" ' # last space alias-expands next word
375
alias clog--='"log--" ' # last space alias-expands next word
376

    
377
verbosity_min() # usage: verbosity_min {min|} # ''->verbosity=''
378
{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
379
alias verbosity_min='log_local; "verbosity_min"'
380

    
381
# usage: (verbosity_compat; cmd)
382
function verbosity_compat()
383
{ echo_func; if ((verbosity == 1)); then unset verbosity; fi; }
384
alias verbosity_compat='declare verbosity; "verbosity_compat"'
385

    
386

    
387
# indent for call tree. this is *not* the log_level (below).
388
: "${log_indent_step=| }" "${log_indent=}"
389
export log_indent_step log_indent # propagate to invoked commands
390

    
391
# see indent alias in stubs
392

    
393

    
394
fi # load new aliases
395
if self_being_included; then
396

    
397
can_log() { test "$(verbosity_int)" -gt 0; }
398
	# verbosity=0 turns off all logging
399

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

    
402
log_custom() # usage: symbol=... log_custom msg
403
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
404

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

    
407
log_info() { symbol=: log_custom "$@"; }
408

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

    
412
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
413
{
414
	save_e; kw_params benign_error
415
	if test "$benign_error"; then log++; fi
416
	type="${benign_error:+info}" die "command exited with \
417
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
418
	rethrow
419
}
420

    
421

    
422
#### functions
423

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

    
426
copy_func() # usage: from=... to=... copy_func
427
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
428
{
429
	: "${from:?}" "${to:?}"
430
	func_exists "$from" || die "function does not exist: $from"
431
	! func_exists "$to" || die "function already exists: $to"
432
	local from_def="$(declare -f "$from")"
433
	eval "$to${from_def#$from}"
434
}
435

    
436
func_override() # usage: func_override old_name__suffix
437
{ from="${1%__*}" to="$1" copy_func; }
438

    
439
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
440
{
441
	local nested_func="${FUNCNAME[1]}"
442
	local func="${nested_func%%__*}"
443
	contains "$func" "${FUNCNAME[@]}" || \
444
		die "$nested_func() must be used by $func()"
445
}
446

    
447

    
448
#### paths
449

    
450
# cache realpath
451
: "${realpath_cache=}" # default off because slower than without
452
if test "$realpath_cache"; then
453
func_override realpath__no_cache
454
realpath() # caches the last result for efficiency
455
{
456
	local cache_key="$*"; load_cache
457
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
458
	echo_cached_value
459
}
460
fi
461

    
462
rel_path() # usage: base_dir=... path=... rel_path
463
{
464
	kw_params base_dir path
465
	: "${base_dir:?}" "${path:?}"
466
	
467
	local path="$path/" # add *extra* / to match path when exactly = base_dir
468
	path="${path#$base_dir/}" # remove prefix shared with base_dir
469
	path="${path%/}" # remove any remaining extra trailing /
470
	
471
	if test ! "$path"; then path=.; fi # ensure non-empty
472
	
473
	echo_vars path
474
	echo "$path"
475
}
476

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

    
480
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
481
{
482
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
483
	base_dir="$(realpath "$base_dir")" || return
484
	local path; path="$(realpath "$1")" || return
485
	rel_path
486
}
487

    
488
canon_dir_rel_path() # usage: [base_dir=...] canon_dir_rel_path path
489
# if the path is a symlink, just its parent dir will be canonicalized
490
{
491
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
492
	base_dir="$(realpath "$base_dir")" || return
493
	local path; path="$(realpath "$(dirname "$1")")/$(basename "$1")" || return
494
	rel_path
495
}
496

    
497
# makes $1 a canon_rel_path if it's a filesystem path
498
alias cmd2rel_path="$(cat <<'EOF'
499
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
500
	declare _1="$1"; shift
501
	_1="$(clog++ canon_rel_path "$_1")" || return
502
	set -- "$_1" "$@"
503
fi
504
EOF
505
)"
506

    
507
# usage: path_parents path; use ${dirs[@]} # includes the path itself
508
function path_parents()
509
{
510
	echo_func; local path="$1" prev_path=; dirs=()
511
	while test "$path" != "$prev_path"; do
512
		prev_path="$path"
513
		dirs+=("$path")
514
		path="${path%/*}"
515
	done
516
}
517
alias path_parents='declare dirs; "path_parents"'
518

    
519

    
520
#### verbose output
521

    
522

    
523
### command echoing
524

    
525
alias echo_params='log "$*"'
526

    
527
fi # load new aliases
528
if self_being_included; then
529

    
530
echo_cmd() { echo_params; }
531

    
532
function echo_run() { echo_params; "$@"; }
533
# see echo_run alias after stub
534

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

    
537
echo_eval() { echo_params; builtin eval "$@"; }
538

    
539
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
540
function echo_redirs_cmd()
541
{
542
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
543
	
544
	# print <>file redirs before cmd, because they introduce it
545
	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(
546
		set -- "${redirs[@]}" # operate on ${redirs[@]}
547
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
548
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
549
		echo "$@"
550
	)
551
}
552
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
553

    
554
## vars
555

    
556
echo_vars() # usage: echo_vars var... # only prints vars that are defined
557
{
558
	log+ 2
559
	if can_log; then
560
		local var
561
		for var in "${@%%=*}"; do
562
			if isset "$var"; then log "$(declare -p "$var")"; fi
563
		done
564
	fi
565
}
566

    
567
echo_export() { builtin export "$@"; echo_vars "$@"; }
568

    
569
alias export="echo_export" # automatically echo env vars when they are set
570

    
571
func_override kw_params__lang
572
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
573

    
574
## functions
575

    
576
# usage: local func=...; set_func_loc; use $file, $line
577
alias set_func_loc="$(cat <<'EOF'
578
: "${func:?}"
579
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
580
func_info="${func_info#$func }"
581
local line="${func_info%% *}"
582
local file="${func_info#$line }"
583
EOF
584
)"
585

    
586
fi # load new aliases
587
if self_being_included; then
588

    
589
func_loc() # gets where function declared in the format file:line
590
{
591
	local func="$1"; set_func_loc
592
	file="$(canon_rel_path "$file")" || return
593
	echo "$file:$line"
594
}
595

    
596
# usage: func() { [minor=1] echo_func; ... }
597
function echo_func()
598
# usage: "echo_func" "$FUNCNAME" "$@" && indent || true
599
# exit status: whether function call was echoed
600
{
601
	log++; can_log || return
602
	local func="$1"; shift
603
	local loc; loc="$(clog++ func_loc "$func")" || return
604
	echo_cmd "$loc" "$func" "$@"
605
}
606
# see echo_func alias after stub
607

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

    
611

    
612
#### streams
613

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

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

    
619
set_fds() # usage: set_fds redirect...
620
# WARNING: does not currently support redirecting an fd to itself (due to bash
621
# bug that requires the dest fd to be closed before it can be reopened)
622
{
623
	echo_func
624
	
625
	# add #<>&- before every #<>&# reopen to fix strange bash bug
626
	local redirs=() i
627
	for i in "$@"; do
628
		local redir_prefix="$(match_prefix '*[<>]' "$i")"
629
		if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
630
		# remove empty redirects resulting from using `redirs= cmd...` to clear
631
		# the redirs and then using $redirs as an array
632
		if test "$i"; then redirs+=("$i"); fi
633
	done
634
	set -- "${redirs[@]}"
635
	
636
	if (($# > 0)); then echo_eval exec "$@"; fi
637
}
638

    
639
fd_set_default() # usage: fd_set_default 'dest[<>]src'
640
{
641
	echo_func
642
	local dest="${1%%[<>]*}"
643
	require_fd_not_exists "$dest" || return 0
644
	set_fds "$1"
645
}
646

    
647
stdout2fd() # usage: fd=# stdout2fd cmd...
648
{
649
	echo_func; kw_params fd; : "${fd?}"
650
	if test "$fd" != 1; then local redirs=(">&$fd" "${redirs[@]}"); fi
651
	redir "$@"
652
}
653

    
654
function filter_fd() # usage: (fd=# [redirs=] filter_fd filter_cmd...; \
655
# with filter...) # be sure ${redirs[@]} is not set to an outer value
656
# useful e.g. to filter logging output or highlight errors
657
{
658
	echo_func; kw_params fd; : "${fd?}"
659
	set_fds "$fd>" >(pipe_delay; stdout2fd "$@")
660
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
661
}
662
alias filter_fd='"filter_fd" ' # last space alias-expands next word
663

    
664
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
665
# mnemonic: 4 looks like A for Alternate
666
# do NOT use 1x, which are used by eval (which is used by set_fds())
667
# do NOT use 2x, which are used as global stdin/stdout/stderr
668
# do NOT use 3x, which are used for logging
669

    
670
setup_log_fd() # view logging output at verbosity >= 5
671
{
672
	log+ 4; log-- echo_func 
673
	fd_set_default '30>&2' || true # stdlog
674
	log_fd=30 # stdlog
675
}
676
setup_log_fd
677

    
678
set_global_fds()
679
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
680
# this works even when /dev/tty isn't available
681
# view logging output at verbosity >= 3
682
{
683
	log+ 2; log-- echo_func
684
	# ignore errors if a source fd isn't open
685
	fd_set_default '20<&0' || true
686
	fd_set_default '21>&1' || true
687
	fd_set_default '22>&2' || true
688
}
689
set_global_fds
690

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

    
698

    
699
echo_vars is_outermost
700

    
701

    
702
#### paths
703

    
704
top_symlink_dir="$(dirname "$0")"; echo_vars top_symlink_dir
705
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
706
	echo_vars top_symlink_dir_abs
707

    
708
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
709
	# realpath this before doing any cd so this points to the right place
710
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
711

    
712
set_paths()
713
{
714
	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return
715
		echo_vars top_script
716
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
717
}
718
set_paths
719

    
720
# usage: in_top_dir cmd...
721
function in_top_dir() { echo_func; (cd "$top_dir"; "$@"); }
722
alias in_top_dir='"in_top_dir" ' # last space alias-expands next word
723

    
724
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
725
{
726
	echo_func; echo_vars PATH; : "${PATH?}"
727
	log+ 2
728
	split : "$PATH"
729
	local new_paths=()
730
	for path in "${parts[@]}"; do
731
		if ! contains "$path" "$@"; then new_paths+=("$path"); fi
732
	done
733
	PATH="$(delim=: join "${new_paths[@]}")" || return
734
	log- 2
735
	echo_vars PATH
736
}
737

    
738
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
739
# allows running a system command of the same name as the script
740
{
741
	echo_func
742
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
743
}
744

    
745
# makes command in $1 nonrecursive
746
# allows running a system command of the same name as the script
747
alias cmd2abs_path="$(cat <<'EOF'
748
declare _1="$1"; shift
749
_1="$(indent; no_PATH_recursion; log++; which "$_1"|echo_stdout)" || return
750
set -- "$_1" "$@"
751
EOF
752
)"
753

    
754

    
755
#### verbose output
756

    
757

    
758
## internal commands
759

    
760
.()
761
{
762
	clog++ clog++ echo_func
763
	cmd2rel_path; set -- "$FUNCNAME" "$@"
764
	if (log++; echo_params; can_log); then indent; fi
765
	builtin "$@"
766
}
767

    
768
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
769
{
770
	clog++ clog++ echo_func; local file="$1"; shift
771
	. "$(canon_rel_path "$(dirname "$(realpath "${BASH_SOURCE[1]}")")/$file")" \
772
"$@"
773
}
774

    
775
cd() # indent is permanent within subshell cd was used in
776
{
777
	log++ echo_func
778
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
779
	if can_log; then caller_indent; fi
780
	# -P: expand symlinks so $PWD matches the output of realpath
781
	builtin "$FUNCNAME" -P "$@"
782
	
783
	func=realpath clear_cache
784
	set_paths
785
}
786

    
787
## external commands
788

    
789
disable_logging() { set_fds "$log_fd>/dev/null"; }
790

    
791
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
792
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
793
{
794
	echo_func; kw_params redirs
795
	
796
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
797
	(
798
		log++ set_fds "${redirs[@]}"
799
		unset redirs # don't redirect again in invoked command
800
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
801
		"$@"
802
	) || return
803
}
804
alias redir='"redir" ' # last space alias-expands next word
805

    
806
alias_append save_e '; unset redirs' # don't redirect error handlers
807

    
808
fi # load new aliases
809
if self_being_included; then
810

    
811
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] [nonrecursive=1] \
812
# command extern_cmd...
813
{
814
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
815
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
816
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
817
	local redirs=("${redirs[@]}")
818
	
819
	# determine redirections
820
	if test "$cmd_log_fd"; then
821
		if can_log; then
822
			if test "$cmd_log_fd" != "$log_fd"; then
823
				redirs+=("$cmd_log_fd>&$log_fd")
824
			fi # else no redir needed
825
		else redirs+=("$cmd_log_fd>/dev/null");
826
		fi
827
	fi
828
	
829
	if test "$nonrecursive"; then cmd2abs_path; else cmd2rel_path; fi
830
	redir command__exec "$@" || die_e
831
}
832
command__exec()
833
{
834
	ensure_nested_func
835
	if can_log; then indent; fi
836
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
837
	verbosity_compat
838
	builtin command "$@"
839
}
840

    
841

    
842
### external command input/output
843

    
844
echo_stdin() # usage: input|echo_stdin|cmd
845
{
846
	if can_log; then
847
		pipe_delay
848
		echo ----- >&"$log_fd"
849
		tee -a /dev/fd/"$log_fd";
850
		echo ----- >&"$log_fd"
851
	else cat
852
	fi
853
}
854

    
855
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
856

    
857

    
858
#### commands
859

    
860
already_exists_msg() # usage: cond || what=... already_exists_msg || return 0
861
{ type=info die "$what already exists, skipping"; }
862

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

    
866
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
867
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
868
{
869
	echo_func; kw_params stdout if_not_exists del
870
	: "${stdout?}"; local del="${del-1}"
871
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
872
	
873
	local redirs=("${redirs[@]}" ">$stdout")
874
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
875
}
876
alias to_file='"to_file" ' # last space alias-expands next word
877

    
878
log_bg() { symbol='&' log_custom "$@"; }
879

    
880
log_last_bg() { log_bg '$!='"$!"; }
881

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

    
885

    
886
#### filesystem
887

    
888
alias mkdir='mkdir -p'
889

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

    
893
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
894
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
895

    
896
fi # load new aliases
897
if self_being_included; then
898

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

    
901
# usage: (mv_glob ... dir)
902
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
903
alias mv_glob='shopt -s nullglob; "mv_glob"'
904

    
905

    
906
#### URLs
907

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

    
910
fi
(10-10/11)