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='declare "no_$var=$(test "${!var}" || echo 1)"'
71

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

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

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

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

    
91

    
92
#### caching
93

    
94
## shell-variable-based caching
95

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

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

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

    
110

    
111
#### aliases
112

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

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

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

    
121

    
122
#### commands
123

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

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

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

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

    
141

    
142
#### functions
143

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

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

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

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

    
164
pf() { declare -f "$@"; } # usage: pf function # prints func decl for debugging
165

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

    
169

    
170
#### exceptions
171

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

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

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

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

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

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

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

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

    
195
### signals
196

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

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

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

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

    
208

    
209
#### integers
210

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

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

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

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

    
220

    
221
#### floats
222

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

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

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

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

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

    
233

    
234
#### strings
235

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

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

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

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

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

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

    
261

    
262
#### arrays
263

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

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

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

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

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

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

    
292
#### streams
293

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

    
297

    
298
#### verbose output
299

    
300

    
301
err_fd=2 # stderr
302

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

    
305

    
306
### log++
307

    
308
log_fd=2 # initially stderr
309

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

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

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

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

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

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

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

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

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

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

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

    
385

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

    
390
# see indent alias in stubs
391

    
392

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

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

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

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

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

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

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

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

    
420

    
421
#### functions
422

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

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

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

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

    
446

    
447
#### paths
448

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

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

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

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

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

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

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

    
518

    
519
#### verbose output
520

    
521

    
522
### command echoing
523

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

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

    
529
echo_cmd() { echo_params; }
530

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

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

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

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

    
553
## vars
554

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

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

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

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

    
573
## functions
574

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

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

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

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

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

    
610

    
611
#### streams
612

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

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

    
618
set_fds() # usage: set_fds redirect...
619
{
620
	echo_func
621
	
622
	# add #<>&- before every #<>&# reopen to fix strange bash bug
623
	local redirs=() i
624
	for i in "$@"; do
625
		local redir_prefix="$(match_prefix '*[<>]' "$i")"
626
		if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
627
		redirs+=("$i")
628
	done
629
	set -- "${redirs[@]}"
630
	
631
	if (($# > 0)); then echo_eval exec "$@"; fi
632
}
633

    
634
fd_set_default() # usage: fd_set_default 'dest[<>]src'
635
{
636
	echo_func
637
	local dest="${1%%[<>]*}"
638
	require_fd_not_exists "$dest" || return 0
639
	set_fds "$1"
640
}
641

    
642
function filter_fd() # usage: (fd=# filter_fd filter_cmd...; with filter...)
643
# useful e.g. to filter logging output or highlight errors
644
{
645
	echo_func; kw_params fd; : "${fd?}"
646
	set_fds "$fd>" >(pipe_delay; redirs=(">&$fd" "${redirs[@]}"); redir "$@")
647
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
648
}
649
alias filter_fd='"filter_fd" ' # last space alias-expands next word
650

    
651
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
652
# mnemonic: 4 looks like A for Alternate
653
# do NOT use 1x, which are used by eval (which is used by set_fds())
654
# do NOT use 2x, which are used as global stdin/stdout/stderr
655
# do NOT use 3x, which are used for logging
656

    
657
setup_log_fd() # view logging output at verbosity >= 5
658
{
659
	log+ 4; log-- echo_func 
660
	fd_set_default '30>&2' || true # stdlog
661
	log_fd=30 # stdlog
662
}
663
setup_log_fd
664

    
665
set_global_fds()
666
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
667
# this works even when /dev/tty isn't available
668
# view logging output at verbosity >= 3
669
{
670
	log+ 2; log-- echo_func
671
	# ignore errors if a source fd isn't open
672
	fd_set_default '20<&0' || true
673
	fd_set_default '21>&1' || true
674
	fd_set_default '22>&2' || true
675
}
676
set_global_fds
677

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

    
685

    
686
echo_vars is_outermost
687

    
688

    
689
#### paths
690

    
691
top_symlink_dir="$(dirname "$0")"; echo_vars top_symlink_dir
692
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
693
	echo_vars top_symlink_dir_abs
694

    
695
top_script_abs="$(realpath "$0")"; echo_vars top_script_abs # outermost script
696
	# realpath this before doing any cd so this points to the right place
697
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
698

    
699
set_paths()
700
{
701
	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return
702
		echo_vars top_script
703
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
704
}
705
set_paths
706

    
707
# usage: in_top_dir cmd...
708
function in_top_dir() { echo_func; (cd "$top_dir"; "$@"); }
709
alias in_top_dir='"in_top_dir" ' # last space alias-expands next word
710

    
711
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
712
{
713
	echo_func; echo_vars PATH; : "${PATH?}"
714
	log+ 2
715
	split : "$PATH"
716
	local new_paths=()
717
	for path in "${parts[@]}"; do
718
		if ! contains "$path" "$@"; then new_paths+=("$path"); fi
719
	done
720
	PATH="$(delim=: join "${new_paths[@]}")" || return
721
	log- 2
722
	echo_vars PATH
723
}
724

    
725
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
726
# allows running a system command of the same name as the script
727
{
728
	echo_func
729
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
730
}
731

    
732
# makes command in $1 nonrecursive
733
# allows running a system command of the same name as the script
734
alias cmd2abs_path="$(cat <<'EOF'
735
declare _1="$1"; shift
736
_1="$(indent; no_PATH_recursion; log++; which "$_1"|echo_stdout)" || return
737
set -- "$_1" "$@"
738
EOF
739
)"
740

    
741

    
742
#### verbose output
743

    
744

    
745
## internal commands
746

    
747
.()
748
{
749
	clog++ clog++ echo_func
750
	cmd2rel_path; set -- "$FUNCNAME" "$@"
751
	if (log++; echo_params; can_log); then indent; fi
752
	builtin "$@"
753
}
754

    
755
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
756
{
757
	clog++ clog++ echo_func; local file="$1"; shift
758
	. "$(canon_rel_path "$(dirname "$(realpath "${BASH_SOURCE[1]}")")/$file")" \
759
"$@"
760
}
761

    
762
cd() # indent is permanent within subshell cd was used in
763
{
764
	log++ echo_func
765
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
766
	if can_log; then caller_indent; fi
767
	# -P: expand symlinks so $PWD matches the output of realpath
768
	builtin "$FUNCNAME" -P "$@"
769
	
770
	func=realpath clear_cache
771
	set_paths
772
}
773

    
774
## external commands
775

    
776
disable_logging() { set_fds "$log_fd>/dev/null"; }
777

    
778
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
779
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
780
{
781
	echo_func; kw_params redirs
782
	
783
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
784
	(
785
		log++ set_fds "${redirs[@]}"
786
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
787
		"$@"
788
	) || return
789
}
790
alias redir='"redir" ' # last space alias-expands next word
791

    
792
alias_append save_e '; unset redirs' # don't redirect error handlers
793

    
794
fi # load new aliases
795
if self_being_included; then
796

    
797
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] [nonrecursive=1] \
798
# command extern_cmd...
799
{
800
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
801
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
802
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
803
	local redirs=("${redirs[@]}")
804
	
805
	# determine redirections
806
	if test "$cmd_log_fd"; then
807
		if can_log; then
808
			if test "$cmd_log_fd" != "$log_fd"; then
809
				redirs+=("$cmd_log_fd>&$log_fd")
810
			fi # else no redir needed
811
		else redirs+=("$cmd_log_fd>/dev/null");
812
		fi
813
	fi
814
	
815
	if test "$nonrecursive"; then cmd2abs_path; else cmd2rel_path; fi
816
	redir command__exec "$@" || die_e
817
}
818
command__exec()
819
{
820
	ensure_nested_func
821
	if can_log; then indent; fi
822
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
823
	verbosity_compat
824
	builtin command "$@"
825
}
826

    
827

    
828
### external command input/output
829

    
830
echo_stdin() # usage: input|echo_stdin|cmd
831
{
832
	if can_log; then
833
		pipe_delay
834
		echo ----- >&"$log_fd"
835
		tee -a /dev/fd/"$log_fd";
836
		echo ----- >&"$log_fd"
837
	else cat
838
	fi
839
}
840

    
841
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
842

    
843

    
844
#### commands
845

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

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

    
852
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
853
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
854
{
855
	echo_func; kw_params stdout if_not_exists del
856
	: "${stdout?}"; local del="${del-1}"
857
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
858
	
859
	local redirs=("${redirs[@]}" ">$stdout")
860
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
861
}
862
alias to_file='"to_file" ' # last space alias-expands next word
863

    
864
log_bg() { symbol='&' log_custom "$@"; }
865

    
866
log_last_bg() { log_bg '$!='"$!"; }
867

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

    
871

    
872
#### filesystem
873

    
874
alias mkdir='mkdir -p'
875

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

    
879
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
880
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
881

    
882
fi # load new aliases
883
if self_being_included; then
884

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

    
887
# usage: (mv_glob ... dir)
888
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
889
alias mv_glob='shopt -s nullglob; "mv_glob"'
890

    
891

    
892
#### URLs
893

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

    
896
fi
(10-10/11)