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
# allow setting vars in the last command of a pipeline
40
shopt -s lastpipe 2>/dev/null || true # ignore errors if not supported (on Mac)
41

    
42

    
43
#### stubs
44

    
45
__caller_indent='log_indent="$log_indent$log_indent_step"'
46
alias caller_indent="$__caller_indent"
47
alias indent="declare $__caller_indent"
48

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

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

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

    
58
echo_builtin() { :; }
59

    
60
function echo_vars() { :; }
61

    
62

    
63
#### logic
64

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

    
67

    
68
#### vars
69

    
70
alias local_array='declare'
71
	# `local` does not support arrays in older versions of bash
72
	# don't need -a because that it's an array is autodetected by the ()
73

    
74
set_var() { eval "$1"'="$2"'; }
75

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

    
78
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
79

    
80
# usage: local var=...; local_inv
81
alias local_inv=\
82
'declare "no_$var=$(test "${!var}" || echo 1)"; echo_vars no_$var'
83

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

    
87
alias local_export='declare -x' # combines effects of local and export
88

    
89
alias export_array='declare -x'
90
	# `export` does not support arrays in older versions of bash
91
	# don't need -a because that it's an array is autodetected by the ()
92

    
93
# to make export only visible locally: local var="$var"; export var
94
# within cmd: var="$var" cmd...
95

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

    
98
# usage: local prefix=..._; import_vars
99
# when used inside another alias 2+ levels deep, *must* be run inside a function
100
alias import_vars="$(cat <<'EOF'
101
: "${prefix:?}"
102
declare src_var dest_var
103
for src_var in $(get_prefix_vars); do
104
	dest_var="${src_var#$prefix}"
105
	declare "$dest_var=${!dest_var-${!src_var}}"; echo_vars "$dest_var"
106
done
107
EOF
108
)"
109

    
110

    
111
#### caching
112

    
113
## shell-variable-based caching
114

    
115
# usage: local cache_key=...; load_cache; \
116
# if ! cached; then save_cache value || return; fi; echo_cached_value
117
# cache_key for function inputs: "$(declare -p kw_param...) $*"
118
alias load_cache='declare cache_var="$(str2varname "${FUNCNAME}___$cache_key")"'
119
alias cached='isset "$cache_var"'
120
alias save_cache='set_var "$cache_var"'
121
alias echo_cached_value='echo "${!cache_var}"'
122

    
123
clear_cache() # usage: func=... clear_cache
124
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
125

    
126
fi # load new aliases
127
if self_being_included; then
128

    
129

    
130
#### aliases
131

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

    
134
# usage: alias alias_='var=value run_cmd '
135
function run_cmd() { "$@"; }
136
alias run_cmd='"run_cmd" ' # last space alias-expands next word
137

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

    
140

    
141
#### commands
142

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

    
145
require_dot_script() # usage: require_dot_script || return
146
{
147
	echo_func
148
	if ! is_dot_script; then # was run without initial "."
149
		echo "usage: . $top_script (note initial \".\")"|fold -s >&2
150
		return 2
151
	fi
152
}
153

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

    
156
# makes command in $1 a system command
157
# allows running a system command of the same name as the script
158
alias cmd2sys="$(cat <<'EOF'
159
declare _1="$1"; shift
160
_1="$(indent; clog++ sys_cmd_path "$_1")" || return
161
set -- "$_1" "$@"
162
EOF
163
)"
164

    
165
fi # load new aliases
166
if self_being_included; then
167

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

    
171

    
172
#### functions
173

    
174
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
175
# removes keyword-param-only vars from the environment
176
{ unexport "$@"; }
177

    
178
# usage: cmd=... foreach_arg
179
function foreach_arg()
180
{
181
	echo_func; kw_params cmd; : "${cmd:?}"
182
	local a; for a in "$@"; do
183
		a="$(clog++ echo_run "$cmd" "$a")" || return; args+=("$a")
184
	done
185
	echo_vars args
186
}
187
alias foreach_arg='"foreach_arg" "$@"; set -- "${args[@]}"; unset args'
188

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

    
191
alias self='command "$(self_name)"' # usage: wrapper() { self ...; }
192
alias self_sys='sys_cmd "$(self_name)"' # wrapper() { self_sys ...; }
193

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

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

    
199

    
200
#### exceptions
201

    
202
# usage: cmd || { save_e; ...; rethrow; }
203
alias export_e='e=$?'
204
alias save_e='declare e=$?'
205
alias rethrow='return "$e"'
206
alias rethrow_subshell='exit "$e"'
207

    
208
fi # load new aliases
209
if self_being_included; then
210

    
211
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
212

    
213
alias prep_try='declare e' # last space alias-expands next word
214

    
215
# usage: ...; try cmd... # *MUST* be at beginning of statement
216
#     OR prep_try; wrapper "try" cmd...
217
function try() { e=0; benign_error=1 "$@" || { export_e; true; }; }
218
alias try='prep_try; "try" ' # last space alias-expands next word
219

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

    
222
ignore_e() { catch "$@" || true; }
223

    
224
alias end_try='rethrow'
225
alias end_try_subshell='rethrow_subshell'
226

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

    
229
### signals
230

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

    
233
ignore_sig() { ignore "$(sig_e "$1")"; }
234

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

    
239
fi # load new aliases
240
if self_being_included; then
241

    
242

    
243
#### integers
244

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

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

    
250
int2exit() { (( "$1" != 0 )); }
251

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

    
254

    
255
#### floats
256

    
257
int_part() { echo "${1%%.*}"; }
258

    
259
dec_suffix() { echo "${1#$(int_part "$1")}"; }
260

    
261
round_down() { int_part "$1"; }
262

    
263
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
264

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

    
267

    
268
#### strings
269

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

    
272
match_prefix() # usage: match_prefix pattern str
273
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
274

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

    
277
repeat() # usage: str=... n=... repeat
278
{
279
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
280
	for (( ; n > 0; n-- )); do result="$result$str"; done
281
	echo "$result"
282
}
283

    
284
# usage: outer_cmd $sed_cmd ...
285
sed_cmd="env LANG= sed -`case "$(uname)" in Darwin) echo El;; *) echo ru;;esac`"
286
	# LANG: avoid invalid UTF-8 "illegal byte sequence" errors when LANG=*.UTF-8
287
	# -l: line buffered / -u: unbuffered
288
alias sed="$sed_cmd"
289
	# can't be function because this causes segfault in redir() subshell when
290
	# used with make.sh make() filter
291

    
292
fi # load new aliases
293
if self_being_included; then
294

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

    
297

    
298
#### arrays
299

    
300
echo1() { echo "$1"; } # usage: echo1 values...
301

    
302
# usage: split delim str; use ${parts[@]}
303
function split() { echo_func; local IFS="$1"; parts=($2); echo_vars parts; }
304
alias split='declare parts; "split"'
305

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

    
308
reverse() # usage: array=($(reverse args...))
309
{
310
	local i
311
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
312
}
313

    
314
contains() # usage: contains value in_array...
315
{
316
	local value="$1"; shift
317
	local elem
318
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
319
	return 1
320
}
321

    
322
is_array() # handles unset vars (=false)
323
{
324
	isset "$1" || return 1
325
	local decl; decl="$(declare -p "$1")" || return; echo_vars decl
326
	starts_with 'declare -a' "$decl" # also matches -ax
327
}
328

    
329
#### streams
330

    
331
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
332
{ sleep 0.1; } # s; display after leading output of cmd1
333

    
334

    
335
#### verbose output
336

    
337

    
338
err_fd=2 # stderr
339

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

    
342

    
343
### log++
344

    
345
log_fd=2 # initially stderr
346

    
347
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
348

    
349
# set verbosity
350
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
351
if isset vb; then : "${verbosity:=$vb}"; fi
352
: "${verbosity=1}" # default
353
: "${verbosity:=0}" # ensure non-empty
354
export verbosity # propagate to invoked commands
355
export PS4 # follows verbosity, so also propagate this
356

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

    
359
# set log_level
360
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
361
export log_level # propagate to invoked commands
362

    
363
verbosity_int() { round_down "$verbosity"; }
364

    
365
# verbosities (and `make` equivalents):
366
# 0: just print errors. useful for cron jobs.
367
#    vs. make: equivalent to --silent, but suppresses external command output
368
# 1: also external commands run. useful for running at the command line.
369
#    vs. make: not provided (but sorely needed to avoid excessive output)
370
# 2: full graphical call tree. useful for determining where error occurred.
371
#    vs. make: equivalent to default verbosity, but with much-needed indents
372
# 3: also values of kw params and variables. useful for low-level debugging.
373
#    vs. make: not provided; need to manually use $(error $(var))
374
# 4: also variables in util.sh commands. useful for debugging util.sh.
375
#    vs. make: somewhat similar to --print-data-base
376
# 5: also variables in logging commands themselves. useful for debugging echo_*.
377
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
378
# 6+: not currently used (i.e. same as 5)
379

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

    
385
fi # load new aliases
386
if self_being_included; then
387

    
388
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
389
#        outside func: log++; ...; log--
390
#        before cmd:  "log++" cmd  OR  "log+" # cmd  OR  "log++" "log++" cmd
391
# with a cmd, assignments are applied just to it, so log_local is not needed
392
# without a cmd, "$@" expands to nothing and assignments are applied to caller
393
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
394
log+()
395
{
396
	# no local vars because w/o cmd, assignments should be applied to caller
397
	PS4="$(str="${PS4:0:1}" n=$((log_level+$1-1)) repeat)${PS4: -2}"; \
398
	log_level=$((log_level+$1)) \
399
	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
400
}
401
log-() { log+ "-$1" "${@:2}"; }
402
log++() { log+ 1 "$@"; }
403
log--() { log- 1 "$@"; }
404
alias log_local=\
405
'declare PS4="$PS4" log_level="$log_level" verbosity="$verbosity"'
406
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
407
alias log++='log_local; "log++" ' # last space alias-expands next word
408
alias log--='log_local; "log--" ' # last space alias-expands next word
409
# no clog+ alias because next word is not a cmd
410
alias clog++='"log++" ' # last space alias-expands next word
411
alias clog--='"log--" ' # last space alias-expands next word
412

    
413
verbosity_min() # usage: verbosity_min {<min>|''}
414
# WARNING: '' is a special value that causes $verbosity to be overwritten to ''
415
{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
416
alias verbosity_min='log_local; "verbosity_min"'
417

    
418
# usage: (verbosity_compat; cmd)
419
function verbosity_compat()
420
{ echo_func; if ((verbosity == 1)); then unset verbosity; fi; }
421
alias verbosity_compat='declare verbosity; "verbosity_compat"'
422

    
423

    
424
# indent for call tree. this is *not* the log_level (below).
425
: "${log_indent_step=| }" "${log_indent=}"
426
export log_indent_step log_indent # propagate to invoked commands
427

    
428
# see indent alias in stubs
429

    
430

    
431
fi # load new aliases
432
if self_being_included; then
433

    
434
can_log() { test "$(verbosity_int)" -gt 0; }
435
	# verbosity=0 turns off all logging
436

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

    
439
log_custom() # usage: symbol=... log_custom msg
440
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
441

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

    
444
log_info() { symbol=: log_custom "$@"; }
445

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

    
449
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
450
{
451
	save_e; kw_params benign_error
452
	if test "$benign_error"; then log++; fi
453
	type="${benign_error:+info}" die "command exited with \
454
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
455
	rethrow
456
}
457

    
458

    
459
#### functions
460

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

    
463
copy_func() # usage: from=... to=... copy_func
464
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
465
{
466
	: "${from:?}" "${to:?}"
467
	func_exists "$from" || die "function does not exist: $from"
468
	! func_exists "$to" || die "function already exists: $to"
469
	local from_def="$(declare -f "$from")"
470
	eval "$to${from_def#$from}"
471
}
472

    
473
func_override() # usage: func_override old_name__suffix
474
{ from="${1%__*}" to="$1" copy_func; }
475

    
476
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
477
{
478
	local nested_func="${FUNCNAME[1]}"
479
	local func="${nested_func%%__*}"
480
	contains "$func" "${FUNCNAME[@]}" || \
481
		die "$nested_func() must be used by $func()"
482
}
483

    
484

    
485
#### paths
486

    
487
# cache realpath
488
: "${realpath_cache=}" # default off because slower than without
489
if test "$realpath_cache"; then
490
func_override realpath__no_cache
491
realpath() # caches the last result for efficiency
492
{
493
	local cache_key="$*"; load_cache
494
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
495
	echo_cached_value
496
}
497
fi
498

    
499
rel_path() # usage: base_dir=... path=... rel_path
500
{
501
	kw_params base_dir path
502
	: "${base_dir:?}" "${path:?}"
503
	
504
	local path="$path/" # add *extra* / to match path when exactly = base_dir
505
	path="${path#$base_dir/}" # remove prefix shared with base_dir
506
	path="${path%/}" # remove any remaining extra trailing /
507
	
508
	if test ! "$path"; then path=.; fi # ensure non-empty
509
	
510
	echo_vars path
511
	echo "$path"
512
}
513

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

    
517
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
518
{
519
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
520
	base_dir="$(realpath "$base_dir")" || return
521
	local path; path="$(realpath "$1")" || return
522
	rel_path
523
}
524

    
525
canon_dir_rel_path() # usage: [base_dir=...] canon_dir_rel_path path
526
# if the path is a symlink, just its parent dir will be canonicalized
527
{
528
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
529
	base_dir="$(realpath "$base_dir")" || return
530
	local path; path="$(realpath "$(dirname "$1")")/$(basename "$1")" || return
531
	rel_path
532
}
533

    
534
# makes $1 a canon_rel_path if it's a filesystem path
535
alias cmd2rel_path="$(cat <<'EOF'
536
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
537
	declare _1="$1"; shift
538
	_1="$(clog++ canon_rel_path "$_1")" || return
539
	set -- "$_1" "$@"
540
fi
541
EOF
542
)"
543

    
544
# usage: path_parents path; use ${dirs[@]} # includes the path itself
545
function path_parents()
546
{
547
	echo_func; local path="$1" prev_path=; dirs=()
548
	while test "$path" != "$prev_path"; do
549
		prev_path="$path"
550
		dirs+=("$path")
551
		path="${path%/*}"
552
	done
553
}
554
alias path_parents='declare dirs; "path_parents"'
555

    
556

    
557
#### verbose output
558

    
559

    
560
### command echoing
561

    
562
alias echo_params='log "$*"'
563

    
564
fi # load new aliases
565
if self_being_included; then
566

    
567
echo_cmd() { echo_params; }
568

    
569
function echo_run() { echo_params; "$@"; }
570
# see echo_run alias after stub
571

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

    
574
echo_eval() { echo_params; builtin eval "$@"; }
575

    
576
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
577
function echo_redirs_cmd()
578
{
579
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
580
	
581
	# print <>file redirs before cmd, because they introduce it
582
	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(
583
		set -- "${redirs[@]}" # operate on ${redirs[@]}
584
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
585
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
586
		echo "$@"
587
	)
588
}
589
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
590

    
591
## vars
592

    
593
echo_vars() # usage: echo_vars var... # only prints vars that are defined
594
{
595
	log+ 2
596
	if can_log; then
597
		local var
598
		for var in "${@%%=*}"; do
599
			if isset "$var"; then log "$(declare -p "$var")"; fi
600
		done
601
	fi
602
}
603

    
604
echo_export() { builtin export "$@"; echo_vars "$@"; }
605

    
606
alias export="echo_export" # automatically echo env vars when they are set
607

    
608
func_override kw_params__lang
609
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
610

    
611
## functions
612

    
613
# usage: local func=...; set_func_loc; use $file, $line
614
alias set_func_loc="$(cat <<'EOF'
615
: "${func:?}"
616
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
617
func_info="${func_info#$func }"
618
local line="${func_info%% *}"
619
local file="${func_info#$line }"
620
EOF
621
)"
622

    
623
fi # load new aliases
624
if self_being_included; then
625

    
626
func_loc() # gets where function declared in the format file:line
627
{
628
	local func="$1"; set_func_loc
629
	file="$(canon_rel_path "$file")" || return
630
	echo "$file:$line"
631
}
632

    
633
# usage: func() { [minor=1] echo_func; ... }
634
function echo_func()
635
# usage: "echo_func" "$FUNCNAME" "$@" && indent || true
636
# exit status: whether function call was echoed
637
{
638
	log++; can_log || return
639
	local func="$1"; shift
640
	local loc; loc="$(clog++ func_loc "$func")" || return
641
	echo_cmd "$loc" "$func" "$@"
642
}
643
# see echo_func alias after stub
644

    
645
fi # load new aliases
646
if self_being_included; then
647

    
648

    
649
#### streams
650

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

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

    
656
set_fds() # usage: set_fds redirect...
657
# WARNING: does not currently support redirecting an fd to itself (due to bash
658
# bug that requires the dest fd to be closed before it can be reopened)
659
{
660
	echo_func
661
	
662
	# add #<>&- before every #<>&# reopen to fix strange bash bug
663
	local redirs=() i
664
	for i in "$@"; do
665
		# remove empty redirects resulting from using `redirs= cmd...` to clear
666
		# the redirs and then using $redirs as an array
667
		if test "$i"; then
668
			local redir_prefix="$(match_prefix '*[<>]' "$i")"
669
			local dest="$(        rm_prefix    '*[<>]' "$i")"
670
			if test "$dest" && ! starts_with '&' "$dest"; then # escape dest
671
				i="$redir_prefix$(printf %q "$dest")"
672
			fi
673
			if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
674
			redirs+=("$i")
675
		fi
676
	done
677
	set -- "${redirs[@]}"
678
	
679
	if (($# > 0)); then echo_eval exec "$@"; fi
680
}
681

    
682
fd_set_default() # usage: fd_set_default 'dest[<>]src'
683
{
684
	echo_func
685
	local dest="${1%%[<>]*}"
686
	require_fd_not_exists "$dest" || return 0
687
	set_fds "$1"
688
}
689

    
690
stdout2fd() # usage: fd=# stdout2fd cmd...
691
{
692
	echo_func; kw_params fd; : "${fd?}"
693
	if test "$fd" != 1; then local redirs=(">&$fd" "${redirs[@]}"); fi
694
	redir "$@"
695
}
696

    
697
function filter_fd() # usage: (fd=# [redirs=] filter_fd filter_cmd...; \
698
# with filter...) # be sure ${redirs[@]} is not set to an outer value
699
# useful e.g. to filter logging output or highlight errors
700
{
701
	echo_func; kw_params fd; : "${fd?}"
702
	set_fds "$fd>" >(pipe_delay; stdout2fd "$@")
703
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
704
}
705
alias filter_fd='"filter_fd" ' # last space alias-expands next word
706

    
707
stderr2stdout() # usage: { stderr2stdout cmd...|use stderr...; } 41>&1
708
# **IMPORTANT**: fd 41 must later be redirected back to fd 1
709
# unlike `2>&1`, logs stderr
710
# redirects the command stdout to fd 41 to avoid collision with stderr
711
{
712
	echo_func
713
	# command causes log_fd to be re-filtered, so that stderr is also filtered.
714
	# fd 2 is *not* redirected back to fd 2, to allow log-filtering out an
715
	# otherwise-confusing benign error.
716
	"$@" 2> >(command tee /dev/fd/"$log_fd") >&41 # redirects 2->{1,log_fd}
717
}
718

    
719
stdout_contains()
720
# usage: { stderr2stdout cmd|stdout_contains echo_run grep ...; } 41>&1
721
{ echo_func; pipe_delay; pipe_delay; "$@"|echo_stdout >/dev/null; }
722

    
723
function stderr_matches() # usage: if pattern=... stderr_matches cmd...; \
724
# then ...; fi; rethrow # manually rethrow any command error (if applicable)
725
# exit status of cmd is placed in $e for use with exception handling
726
{
727
	echo_func; kw_params pattern; : "${pattern?}"
728
	{ "try" stderr2stdout "$@"|"try" stdout_contains echo_run grep -E "$pattern"
729
	} 41>&1
730
	local PIPESTATUS_=("${PIPESTATUS[@]}") # save b/c it's reset after each cmd
731
	e="${PIPESTATUS_[0]}"      # 1st command's exit status -> $e
732
	return "${PIPESTATUS_[1]}" # 2nd command's exit status -> $?
733
}
734
alias stderr_matches='prep_try; "stderr_matches" '
735
	# last space alias-expands next word
736

    
737
fi # load new aliases
738
if self_being_included; then
739

    
740
function ignore_err_msg() # usage: pattern=... ignore_err_msg cmd...
741
# unlike `|| true`, this suppresses only errors caused by a particular error
742
# *message*, rather than all error exit statuses
743
{
744
	echo_func; kw_params pattern; : "${pattern?}"
745
	stderr_matches "$@" || rethrow
746
}
747
alias ignore_err_msg='"ignore_err_msg" ' # last space alias-expands next word
748

    
749
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
750
# mnemonic: 4 looks like A for Alternate
751
# do NOT use 1x, which are used by eval (which is used by set_fds())
752
# do NOT use 2x, which we use as global stdin/stdout/stderr
753
# do NOT use 3x, which we use for logging
754

    
755
setup_log_fd() # view logging output at verbosity >= 5
756
{
757
	log+ 4; log-- echo_func 
758
	fd_set_default '30>&2' || true # stdlog
759
	log_fd=30 # stdlog
760
}
761
setup_log_fd
762

    
763
set_global_fds()
764
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
765
# this works even when /dev/tty isn't available
766
# view logging output at verbosity >= 3
767
{
768
	log+ 2; log-- echo_func
769
	# ignore errors if a source fd isn't open
770
	fd_set_default '20<&0' || true
771
	fd_set_default '21>&1' || true
772
	fd_set_default '22>&2' || true
773
}
774
set_global_fds
775

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

    
783

    
784
echo_vars is_outermost
785

    
786

    
787
#### paths
788

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

    
792
top_symlink_dir="$(dirname "$top_script")"; echo_vars top_symlink_dir
793
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
794
	echo_vars top_symlink_dir_abs
795

    
796
top_script_abs="$(realpath "$top_script")"; echo_vars top_script_abs
797
	# realpath this before doing any cd so this points to the right place
798
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
799

    
800
set_paths()
801
{
802
	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return
803
		echo_vars top_script
804
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
805
}
806
set_paths
807

    
808
# usage: in_top_dir cmd...
809
function in_top_dir() { echo_func; (cd "$top_dir"; "$@"); }
810
alias in_top_dir='"in_top_dir" ' # last space alias-expands next word
811

    
812
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
813
{
814
	echo_func; echo_vars PATH; : "${PATH?}"
815
	log+ 2
816
	split : "$PATH"
817
	local new_paths=()
818
	for path in "${parts[@]}"; do
819
		if ! contains "$path" "$@"; then new_paths+=("$path"); fi
820
	done
821
	PATH="$(delim=: join "${new_paths[@]}")" || return
822
	log- 2
823
	echo_vars PATH
824
}
825

    
826
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
827
# allows running a system command of the same name as the script
828
{
829
	echo_func
830
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
831
}
832

    
833
# makes command in $1 nonrecursive
834
# allows running a system command of the same name as the script
835
alias cmd2abs_path="$(cat <<'EOF'
836
declare _1="$1"; shift
837
_1="$(indent; no_PATH_recursion; log++; which "$_1"|echo_stdout)" || return
838
set -- "$_1" "$@"
839
EOF
840
)"
841

    
842

    
843
#### verbose output
844

    
845

    
846
## internal commands
847

    
848
.()
849
{
850
	clog++ clog++ echo_func
851
	cmd2rel_path; set -- "$FUNCNAME" "$@"
852
	if (log++; echo_params; can_log); then indent; fi
853
	builtin "$@"
854
}
855

    
856
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
857
{
858
	clog++ clog++ echo_func; local file="$1"; shift
859
	. "$(canon_rel_path "$(dirname "$(realpath "${BASH_SOURCE[1]}")")/$file")" \
860
"$@"
861
}
862

    
863
cd() # indent is permanent within subshell cd was used in
864
{
865
	log++ echo_func
866
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
867
	if can_log; then caller_indent; fi
868
	# -P: expand symlinks so $PWD matches the output of realpath
869
	builtin "$FUNCNAME" -P "$@"
870
	
871
	func=realpath clear_cache
872
	set_paths
873
}
874

    
875
## external commands
876

    
877
disable_logging() { set_fds "$log_fd>/dev/null"; }
878

    
879
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
880
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
881
{
882
	echo_func; kw_params redirs
883
	
884
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
885
	(
886
		log++ set_fds "${redirs[@]}"
887
		unset redirs # don't redirect again in invoked command
888
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
889
		"$@"
890
	) || return
891
}
892
alias redir='"redir" ' # last space alias-expands next word
893

    
894
alias_append save_e '; unset redirs' # don't redirect error handlers
895

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

    
899
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] [nonrecursive=1] \
900
# command extern_cmd...
901
{
902
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
903
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
904
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
905
	local redirs=("${redirs[@]}")
906
	
907
	# determine redirections
908
	if test "$cmd_log_fd"; then
909
		if can_log; then
910
			if test "$cmd_log_fd" != "$log_fd"; then
911
				redirs+=("$cmd_log_fd>&$log_fd")
912
			fi # else no redir needed
913
		else redirs+=("$cmd_log_fd>/dev/null");
914
		fi
915
	fi
916
	
917
	if test "$nonrecursive"; then cmd2abs_path; else cmd2rel_path; fi
918
	redir command__exec "$@" || die_e
919
}
920
command__exec()
921
{
922
	ensure_nested_func
923
	if can_log; then indent; fi
924
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
925
	verbosity_compat
926
	builtin command "$@"
927
}
928

    
929

    
930
### external command input/output
931

    
932
echo_stdin() # usage: input|echo_stdin|cmd
933
{
934
	if can_log; then
935
		pipe_delay
936
		echo ----- >&"$log_fd"
937
		tee -a /dev/fd/"$log_fd";
938
		echo ----- >&"$log_fd"
939
	else cat
940
	fi
941
}
942

    
943
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
944

    
945

    
946
#### commands
947

    
948
already_exists_msg() # usage: cond || what=... already_exists_msg || return 0
949
{
950
	type=info die "$what"' already exists, skipping
951
 to force-remake, prepend `rm=1` to the command '
952
}
953

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

    
957
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
958
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
959
{
960
	echo_func; kw_params stdout if_not_exists del
961
	: "${stdout?}"; local del="${del-1}"
962
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
963
	
964
	local redirs=("${redirs[@]}" ">$stdout")
965
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
966
}
967
alias to_file='"to_file" ' # last space alias-expands next word
968

    
969
log_bg() { symbol='&' log_custom "$@"; }
970

    
971
log_last_bg() { log_bg '$!='"$!"; }
972

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

    
976

    
977
#### filesystem
978

    
979
alias mkdir='mkdir -p'
980

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

    
984
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
985
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
986

    
987
fi # load new aliases
988
if self_being_included; then
989

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

    
992
# usage: (mv_glob ... dir)
993
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
994
alias mv_glob='shopt -s nullglob; "mv_glob"'
995

    
996

    
997
#### URLs
998

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

    
1001
fi
(10-10/11)