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
#### debugging
64

    
65
dp() { echo "$@" >&2; } # usage: pv var... # debug-prints message
66

    
67

    
68
#### logic
69

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

    
72

    
73
#### vars
74

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

    
79
set_var() { eval "$1"'="$2"'; }
80

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

    
83
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
84

    
85
# usage: local var=...; local_inv
86
alias local_inv=\
87
'declare "no_$var=$(test "${!var}" || echo 1)"; echo_vars no_$var'
88

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

    
92
alias local_export='declare -x' # combines effects of local and export
93

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

    
98
# to make export only visible locally: local var="$var"; export var
99
# within cmd: var="$var" cmd...
100

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

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

    
115

    
116
#### caching
117

    
118
## shell-variable-based caching
119

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

    
128
clear_cache() # usage: func=... clear_cache
129
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
130

    
131
fi # load new aliases
132
if self_being_included; then
133

    
134

    
135
#### aliases
136

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

    
139
# usage: alias alias_='var=value run_cmd '
140
function run_cmd() { "$@"; }
141
alias run_cmd='"run_cmd" ' # last space alias-expands next word
142

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

    
145

    
146
#### commands
147

    
148
is_callable() { type -t "$@" >/dev/null; }
149

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

    
152
require_dot_script() # usage: require_dot_script || return
153
{
154
	echo_func
155
	if ! is_dot_script; then # was run without initial "."
156
		echo "usage: . $top_script (note initial \".\")"|fold -s >&2
157
		return 2
158
	fi
159
}
160

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

    
163
# makes command in $1 a system command
164
# allows running a system command of the same name as the script
165
alias cmd2sys="$(cat <<'EOF'
166
declare _1="$1"; shift
167
_1="$(indent; clog++ sys_cmd_path "$_1")" || return
168
set -- "$_1" "$@"
169
EOF
170
)"
171

    
172
fi # load new aliases
173
if self_being_included; then
174

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

    
178

    
179
#### functions
180

    
181
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
182
# removes keyword-param-only vars from the environment
183
{ unexport "$@"; }
184

    
185
# usage: cmd=... foreach_arg
186
function foreach_arg()
187
{
188
	echo_func; kw_params cmd; : "${cmd:?}"
189
	local a; for a in "$@"; do
190
		a="$(clog++ echo_run "$cmd" "$a")" || return; args+=("$a")
191
	done
192
	echo_vars args
193
}
194
alias foreach_arg='"foreach_arg" "$@"; set -- "${args[@]}"; unset args'
195

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

    
198
alias self='command "$(self_name)"' # usage: wrapper() { self ...; }
199
alias self_sys='sys_cmd "$(self_name)"' # wrapper() { self_sys ...; }
200

    
201
pv() { declare -p "$@" >&2; } # usage: pv var... # debug-prints var(s)
202

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

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

    
208

    
209
#### exceptions
210

    
211
# usage: cmd || { save_e; ...; rethrow; }
212

    
213
alias export_e='e=$?'
214

    
215
# **WARNING**: if using this after a command that might succeed (rather than
216
# only upon error), you must `unset e` before the command
217
# idempotent: also works if save_e already called
218
alias save_e='# idempotent: use $e if the caller already called save_e
219
declare e_=$?;
220
declare e="$(if test "$e_" = 0; then echo "${e:-0}"; else echo "$e_"; fi)"'
221

    
222
alias rethrow!='return "$e"'
223
	# can't use `(exit "$e")` because a bug in bash prevents subshells from
224
	# triggering errexit (would need to append `|| return` for it to work)
225
alias rethrow_exit!='exit "$e"'
226

    
227
alias rethrow='{ if test "$e" != 0; then rethrow!; fi; }'
228
alias rethrow_exit='{ if test "$e" != 0; then rethrow_exit!; fi; }'
229
alias rethrow_subshell='rethrow_exit'
230

    
231
fi # load new aliases
232
if self_being_included; then
233

    
234
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; end_try
235

    
236
alias prep_try='declare e=0' # last space alias-expands next word
237

    
238
# usage: ...; try cmd... # *MUST* be at beginning of statement
239
#     OR prep_try; wrapper "try" cmd...
240
function try() { benign_error=1 "$@" || { export_e; true; }; }
241
alias try='prep_try; "try" ' # last space alias-expands next word
242

    
243
catch() { test "$e" = "${1:-0}" && e=0; } # also works w/ $1=''
244

    
245
ignore_e() { catch "$@" || true; } # also works w/ $1=''
246

    
247
alias end_try='rethrow'
248
alias end_try_subshell='rethrow_subshell'
249

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

    
252
### signals
253

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

    
256
ignore_sig() { ignore "$(sig_e "$1")"; }
257

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

    
262
fi # load new aliases
263
if self_being_included; then
264

    
265

    
266
#### integers
267

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

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

    
273
int2exit() { (( "$1" != 0 )); }
274

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

    
277

    
278
#### floats
279

    
280
int_part() { echo "${1%%.*}"; }
281

    
282
dec_suffix() { echo "${1#$(int_part "$1")}"; }
283

    
284
round_down() { int_part "$1"; }
285

    
286
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
287

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

    
290

    
291
#### strings
292

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

    
295
match_prefix() # usage: match_prefix pattern str
296
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
297

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

    
300
repeat() # usage: str=... n=... repeat
301
{
302
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
303
	for (( ; n > 0; n-- )); do result="$result$str"; done
304
	echo "$result"
305
}
306

    
307
# usage: outer_cmd $sed_cmd ...
308
sed_cmd="env LANG= sed -`case "$(uname)" in Darwin) echo El;; *) echo ru;;esac`"
309
	# LANG: avoid invalid UTF-8 "illegal byte sequence" errors when LANG=*.UTF-8
310
	# -l: line buffered / -u: unbuffered
311
alias sed="$sed_cmd"
312
	# can't be function because this causes segfault in redir() subshell when
313
	# used with make.sh make() filter
314

    
315
fi # load new aliases
316
if self_being_included; then
317

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

    
320

    
321
#### arrays
322

    
323
echo1() { echo "$1"; } # usage: echo1 values...
324

    
325
esc_args() # usage: array=($(log++; prep_env... (eg. cd); esc_args args...))
326
{ local arg; for arg in "$@"; do printf '%q ' "$arg"; done; }
327

    
328
# usage: split delim str; use ${parts[@]}
329
function split() { local IFS="$1"; parts=($2); echo_vars parts; }
330
	# no echo_func because used by log++
331
alias split='declare parts; "split"'
332

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

    
335
reverse() # usage: array=($(reverse args...))
336
{
337
	local i
338
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
339
}
340

    
341
contains() # usage: contains value in_array...
342
{
343
	local value="$1"; shift
344
	local elem
345
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
346
	return 1
347
}
348

    
349
is_array() # handles unset vars (=false)
350
{
351
	isset "$1" || return 1
352
	local decl; decl="$(declare -p "$1")" || return; echo_vars decl
353
	starts_with 'declare -a' "$decl" # also matches -ax
354
}
355

    
356

    
357
#### text
358

    
359
fi # load new aliases
360
if self_being_included; then
361

    
362
nl='
363
'
364

    
365
# usage: split_lines str; use ${lines[@]}
366
function split_lines() { split "$nl" "$1"; lines=("${parts[@]}"); }
367
	# no echo_func because used by log++
368
alias split_lines='declare lines; "split_lines"'
369

    
370

    
371
#### paths
372

    
373
strip/() { echo "${1%/}"; } # strips trailing /s
374

    
375
wildcard/() # usage: array=($(log++; [cd ...;] wildcard/ unquoted_pattern...))
376
{ cmd=strip/ foreach_arg; esc_args "$@"; }
377

    
378
wildcard.() # usage: array=($(log++; [cd ...;] wildcard. unquoted_pattern...))
379
# currently only removes . .. at beginning of list
380
{
381
	set -- $(wildcard/ "$@") # first strip trailing /s
382
	local to_rm=(. ..)
383
	local item
384
	if contains "$1" "${to_rm[@]}"; then
385
		shift
386
		if contains "$1" "${to_rm[@]}"; then shift; fi
387
	fi
388
	esc_args "$@"
389
}
390

    
391
#### streams
392

    
393
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
394
{ sleep 0.1; } # s; display after leading output of cmd1
395

    
396

    
397
#### verbose output
398

    
399

    
400
err_fd=2 # stderr
401

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

    
404

    
405
### log++
406

    
407
log_fd=2 # initially stderr
408

    
409
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
410

    
411
# set verbosity
412
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
413
if isset vb; then : "${verbosity:=$vb}"; fi
414
: "${verbosity=1}" # default
415
: "${verbosity:=0}" # ensure non-empty
416
export verbosity # propagate to invoked commands
417
export PS4 # follows verbosity, so also propagate this
418

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

    
421
# set log_level
422
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
423
export log_level # propagate to invoked commands
424

    
425
verbosity_int() { round_down "$verbosity"; }
426

    
427
# verbosities (and `make` equivalents):
428
# 0: just print errors. useful for cron jobs.
429
#    vs. make: equivalent to --silent, but suppresses external command output
430
# 1: also external commands run. useful for running at the command line.
431
#    vs. make: not provided (but sorely needed to avoid excessive output)
432
# 2: full graphical call tree. useful for determining where error occurred.
433
#    vs. make: equivalent to default verbosity, but with much-needed indents
434
# 3: also values of kw params and variables. useful for low-level debugging.
435
#    vs. make: not provided; need to manually use $(error $(var))
436
# 4: also variables in util.sh commands. useful for debugging util.sh.
437
#    vs. make: somewhat similar to --print-data-base
438
# 5: also variables in logging commands themselves. useful for debugging echo_*.
439
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
440
# 6+: not currently used (i.e. same as 5)
441

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

    
447
fi # load new aliases
448
if self_being_included; then
449

    
450
# usage: in func:      log++; ...         OR  log_local; "log++"; ...
451
#        outside func: log++; ...; log--
452
#        before cmd:  "log++" cmd  OR  "log+" # cmd  OR  "log++" "log++" cmd
453
# with a cmd, assignments are applied just to it, so log_local is not needed
454
# without a cmd, "$@" expands to nothing and assignments are applied to caller
455
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
456
log+()
457
{
458
	# no local vars because w/o cmd, assignments should be applied to caller
459
	PS4="$(str="${PS4:0:1}" n=$((log_level+$1-1)) repeat)${PS4: -2}"; \
460
	log_level=$((log_level+$1)) \
461
	verbosity="$(float+int "$verbosity" "-$1")" "${@:2}"
462
}
463
log-() { log+ "-$1" "${@:2}"; }
464
log++() { log+ 1 "$@"; }
465
log--() { log- 1 "$@"; }
466
log!() { log- "$log_level" "$@"; } # force-displays next log message
467
alias log_local=\
468
'declare PS4="$PS4" log_level="$log_level" verbosity="$verbosity"'
469
alias log+='log_local; "log+"' # don't expand next word because it's not a cmd
470
alias log++='log_local; "log++" ' # last space alias-expands next word
471
alias log--='log_local; "log--" ' # last space alias-expands next word
472
alias log!='log_local; "log!" ' # last space alias-expands next word
473
alias clog+='"log+"' # no last space because next word is not a cmd
474
alias clog++='"log++" ' # last space alias-expands next word
475
alias clog--='"log--" ' # last space alias-expands next word
476
alias clog!='"log!" ' # last space alias-expands next word
477

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

    
483
# usage: (verbosity_compat; cmd)
484
function verbosity_compat()
485
{ echo_func; if ((verbosity == 1)); then unset verbosity; fi; }
486
alias verbosity_compat='declare verbosity; "verbosity_compat"'
487

    
488

    
489
# indent for call tree. this is *not* the log_level (below).
490
: "${log_indent_step=| }" "${log_indent=}"
491
export log_indent_step log_indent # propagate to invoked commands
492

    
493
# see indent alias in stubs
494

    
495

    
496
fi # load new aliases
497
if self_being_included; then
498

    
499
can_log() { test "$(verbosity_int)" -gt 0; }
500
	# verbosity=0 turns off all logging
501

    
502
can_highlight_msg() { test "$log_level" -le 1; }
503

    
504
highlight_msg() # usage: [format=...] highlight_msg msg
505
# format: the # in xfree86.org/current/ctlseqs.html#Character_Attributes
506
{
507
	kw_params format; local format="${format-1}" # bold
508
	local highlight="$(test "$format" && can_highlight_msg; exit2bool)"
509
	echo "${highlight:+[${format}m}$1${highlight:+}"
510
}
511

    
512
log_line!() # highlights log_level 1 messages to stand out against other output
513
{ echo "$log_indent$PS4$(highlight_msg "$1")" >&"$log_fd"; }
514

    
515
log_msg!()
516
{ split_lines "$1"; local l; for l in "${lines[@]}"; do log_line! "$l"; done; }
517

    
518
log() { if can_log; then log_msg! "$@"; fi; }
519

    
520
log_custom() # usage: symbol=... log_custom msg
521
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
522

    
523
bg_r='101;97' # red background with white text
524

    
525
log_err() { symbol='#' format="$bg_r" log_fd="$err_fd" clog! log_custom " $1 ";}
526

    
527
log_info() { symbol=: log_custom "$@"; }
528

    
529
log_hint!() { format=7 log_info " $1 "; }
530

    
531
log_hint() # usage: cmd || [benign_error=1] log_hint msg [|| handle error]
532
# msg only displayed if not benign error
533
{ kw_params benign_error; if test ! "$benign_error"; then log_hint! "$@"; fi; }
534

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

    
538
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
539
{
540
	save_e; kw_params benign_error
541
	if test "$benign_error"; then log++; fi
542
	type="${benign_error:+info}" die "command exited with \
543
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
544
	rethrow
545
}
546

    
547
die_error_hidden() # usage: cmd || verbosity_min=# die_error_hidden [|| ...]
548
{
549
	save_e; kw_params verbosity_min; : "${verbosity_min:?}"
550
	echo_vars verbosity
551
	if test "$(verbosity_int)" -lt "$verbosity_min"; then
552
		log_hint 'to see error details, prepend `vb='"$verbosity_min"'` to the command'
553
	fi
554
	rethrow
555
}
556

    
557

    
558
#### functions
559

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

    
562
copy_func() # usage: from=... to=... copy_func
563
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
564
{
565
	: "${from:?}" "${to:?}"
566
	func_exists "$from" || die "function does not exist: $from"
567
	! func_exists "$to" || die "function already exists: $to"
568
	local from_def="$(declare -f "$from")"
569
	eval "$to${from_def#$from}"
570
}
571

    
572
func_override() # usage: func_override old_name__suffix
573
{ from="${1%__*}" to="$1" copy_func; }
574

    
575
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
576
{
577
	local nested_func="${FUNCNAME[1]}"
578
	local func="${nested_func%%__*}"
579
	contains "$func" "${FUNCNAME[@]}" || \
580
		die "$nested_func() must be used by $func()"
581
}
582

    
583

    
584
#### paths
585

    
586
# cache realpath
587
: "${realpath_cache=}" # default off because slower than without
588
if test "$realpath_cache"; then
589
func_override realpath__no_cache
590
realpath() # caches the last result for efficiency
591
{
592
	local cache_key="$*"; load_cache
593
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
594
	echo_cached_value
595
}
596
fi
597

    
598
rel_path() # usage: base_dir=... path=... rel_path
599
{
600
	kw_params base_dir path
601
	: "${base_dir:?}" "${path:?}"
602
	
603
	local path="$path/" # add *extra* / to match path when exactly = base_dir
604
	path="${path#$base_dir/}" # remove prefix shared with base_dir
605
	path="${path%/}" # remove any remaining extra trailing /
606
	
607
	if test ! "$path"; then path=.; fi # ensure non-empty
608
	
609
	echo_vars path
610
	echo "$path"
611
}
612

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

    
616
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
617
{
618
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
619
	base_dir="$(realpath "$base_dir")" || return
620
	local path; path="$(realpath "$1")" || return
621
	rel_path
622
}
623

    
624
canon_dir_rel_path() # usage: [base_dir=...] canon_dir_rel_path path
625
# if the path is a symlink, just its parent dir will be canonicalized
626
{
627
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
628
	base_dir="$(realpath "$base_dir")" || return
629
	local path; path="$(realpath "$(dirname "$1")")/$(basename "$1")" || return
630
	rel_path
631
}
632

    
633
# makes $1 a canon_rel_path if it's a filesystem path
634
alias cmd2rel_path="$(cat <<'EOF'
635
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
636
	declare _1="$1"; shift
637
	_1="$(clog++ canon_rel_path "$_1")" || return
638
	set -- "$_1" "$@"
639
fi
640
EOF
641
)"
642

    
643
# usage: path_parents path; use ${dirs[@]} # includes the path itself
644
function path_parents()
645
{
646
	echo_func; local path="$1" prev_path=; dirs=()
647
	while test "$path" != "$prev_path"; do
648
		prev_path="$path"
649
		dirs+=("$path")
650
		path="${path%/*}"
651
	done
652
}
653
alias path_parents='declare dirs; "path_parents"'
654

    
655

    
656
#### verbose output
657

    
658

    
659
### command echoing
660

    
661
alias echo_params='log "$*"'
662

    
663
fi # load new aliases
664
if self_being_included; then
665

    
666
echo_cmd() { echo_params; }
667

    
668
function echo_run() { echo_params; "$@"; }
669
# see echo_run alias after stub
670

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

    
673
echo_eval() { echo_params; builtin eval "$@"; }
674

    
675
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
676
function echo_redirs_cmd()
677
{
678
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
679
	
680
	# print <>file redirs before cmd, because they introduce it
681
	"log+" "$cmd_name_log_inc" echo_cmd "$@" $(
682
		set -- "${redirs[@]}" # operate on ${redirs[@]}
683
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
684
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
685
		echo "$@"
686
	)
687
}
688
alias echo_redirs_cmd='"echo_redirs_cmd" "$@"'
689

    
690
## vars
691

    
692
echo_vars() # usage: echo_vars var... # only prints vars that are defined
693
{
694
	log+ 2
695
	if can_log; then
696
		local var
697
		for var in "${@%%=*}"; do
698
			if isset "$var"; then log "$(declare -p "$var")"; fi
699
		done
700
	fi
701
}
702

    
703
echo_export() { builtin export "$@"; echo_vars "$@"; }
704

    
705
alias export="echo_export" # automatically echo env vars when they are set
706

    
707
func_override kw_params__lang
708
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
709

    
710
## functions
711

    
712
# usage: local func=...; set_func_loc; use $file, $line
713
alias set_func_loc="$(cat <<'EOF'
714
: "${func:?}"
715
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
716
func_info="${func_info#$func }"
717
local line="${func_info%% *}"
718
local file="${func_info#$line }"
719
EOF
720
)"
721

    
722
fi # load new aliases
723
if self_being_included; then
724

    
725
func_loc() # gets where function declared in the format file:line
726
{
727
	local func="$1"; set_func_loc
728
	file="$(canon_rel_path "$file")" || return
729
	echo "$file:$line"
730
}
731

    
732
# usage: func() { [minor=1] echo_func; ... }
733
function echo_func()
734
# usage: "echo_func" "$FUNCNAME" "$@" && indent || true
735
# exit status: whether function call was echoed
736
{
737
	log++; can_log || return
738
	local func="$1"; shift
739
	local loc; loc="$(clog++ func_loc "$func")" || return
740
	echo_cmd "$loc" "$func" "$@"
741
}
742
# see echo_func alias after stub
743

    
744
fi # load new aliases
745
if self_being_included; then
746

    
747

    
748
#### streams
749

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

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

    
755
set_fds() # usage: set_fds redirect...
756
# WARNING: does not currently support redirecting an fd to itself (due to bash
757
# bug that requires the dest fd to be closed before it can be reopened)
758
{
759
	echo_func
760
	
761
	# add #<>&- before every #<>&# reopen to fix strange bash bug
762
	local redirs=() i
763
	for i in "$@"; do
764
		# remove empty redirects resulting from using `redirs= cmd...` to clear
765
		# the redirs and then using $redirs as an array
766
		if test "$i"; then
767
			local redir_prefix="$(match_prefix '*[<>]' "$i")"
768
			local dest="$(        rm_prefix    '*[<>]' "$i")"
769
			if test "$dest" && ! starts_with '&' "$dest"; then # escape dest
770
				i="$redir_prefix$(printf %q "$dest")"
771
			fi
772
			if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
773
			redirs+=("$i")
774
		fi
775
	done
776
	set -- "${redirs[@]}"
777
	
778
	if (($# > 0)); then echo_eval exec "$@"; fi
779
}
780

    
781
fd_set_default() # usage: fd_set_default 'dest[<>]src'
782
{
783
	echo_func
784
	local dest="${1%%[<>]*}"
785
	require_fd_not_exists "$dest" || return 0
786
	set_fds "$1"
787
}
788

    
789
stdout2fd() # usage: fd=# stdout2fd cmd...
790
{
791
	echo_func; kw_params fd; : "${fd?}"
792
	if test "$fd" != 1; then local redirs=(">&$fd" "${redirs[@]}"); fi
793
	redir "$@"
794
}
795

    
796
function filter_fd() # usage: (fd=# [redirs=] filter_fd filter_cmd...; \
797
# with filter...) # be sure ${redirs[@]} is not set to an outer value
798
# useful e.g. to filter logging output or highlight errors
799
{
800
	echo_func; kw_params fd; : "${fd?}"
801
	set_fds "$fd>" >(pipe_delay; stdout2fd "$@")
802
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
803
}
804
alias filter_fd='"filter_fd" ' # last space alias-expands next word
805

    
806
stderr2stdout() # usage: { stderr2stdout cmd...|use stderr...; } 41>&1
807
# **IMPORTANT**: fd 41 must later be redirected back to fd 1
808
# unlike `2>&1`, logs stderr
809
# redirects the command stdout to fd 41 to avoid collision with stderr
810
{
811
	echo_func
812
	# command causes log_fd to be re-filtered, so that stderr is also filtered.
813
	# fd 2 is *not* redirected back to fd 2, to allow log-filtering out an
814
	# otherwise-confusing benign error.
815
	"$@" 2> >(command tee /dev/fd/"$log_fd") >&41 # redirects 2->{1,log_fd}
816
}
817

    
818
stdout_contains()
819
# usage: { stderr2stdout cmd|stdout_contains echo_run grep ...; } 41>&1
820
{ echo_func; pipe_delay; pipe_delay; pipe_delay; "$@"|echo_stdout >/dev/null; }
821

    
822
stderr_matches() # usage: pattern=... [ignore_e=#] stderr_matches cmd...
823
{
824
	echo_func; kw_params pattern ignore_e; : "${pattern?}"
825
	if test "$ignore_e"; then local benign_error=1; fi
826
	
827
	# not necessary to allow callers to handle the error themselves (which would
828
	# require *every* caller to wrap this function in prep_try/rethrow), because
829
	# they would just handle it by errexiting anyways
830
	prep_try
831
	
832
	set +o errexit # avoid errexiting since @PIPESTATUS will be used instead
833
	{ stderr2stdout "$@"|stdout_contains echo_run grep -E "$pattern"; } 41>&1
834
	local PIPESTATUS_=("${PIPESTATUS[@]}") # save b/c it's reset after each cmd
835
	set -o errexit
836
	
837
	# handle any error
838
	e="${PIPESTATUS_[0]}" # 1st command's exit status -> $e
839
	ignore_e "$ignore_e" # also works w/ ignore_e=''
840
	rethrow_exit
841
	
842
	return "${PIPESTATUS_[1]}" # 2nd command's exit status -> $?
843
}
844

    
845
fi # load new aliases
846
if self_being_included; then
847

    
848
function ignore_err_msg() # usage: pattern=... ignore_err_msg cmd...
849
# unlike `|| true`, this suppresses only errors caused by a particular error
850
# *message*, rather than all error exit statuses
851
{
852
	echo_func; kw_params pattern; : "${pattern?}"
853
	stderr_matches "$@" || true # also ignore false exit status on no match
854
}
855
alias ignore_err_msg='"ignore_err_msg" ' # last space alias-expands next word
856

    
857
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
858
# mnemonic: 4 looks like A for Alternate
859
# do NOT use 1x, which are used by eval (which is used by set_fds())
860
# do NOT use 2x, which we use as global stdin/stdout/stderr
861
# do NOT use 3x, which we use for logging
862

    
863
setup_log_fd() # view logging output at verbosity >= 5
864
{
865
	log+ 4; log-- echo_func 
866
	fd_set_default '30>&2' || true # stdlog
867
	log_fd=30 # stdlog
868
}
869
setup_log_fd
870

    
871
set_global_fds()
872
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
873
# this works even when /dev/tty isn't available
874
# view logging output at verbosity >= 3
875
{
876
	log+ 2; log-- echo_func
877
	# ignore errors if a source fd isn't open
878
	fd_set_default '20<&0' || true
879
	fd_set_default '21>&1' || true
880
	fd_set_default '22>&2' || true
881
}
882
set_global_fds
883

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

    
891

    
892
echo_vars is_outermost
893

    
894

    
895
#### paths
896

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

    
900
top_symlink_dir="$(dirname "$top_script")"; echo_vars top_symlink_dir
901
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
902
	echo_vars top_symlink_dir_abs
903

    
904
top_script_abs="$(realpath "$top_script")"; echo_vars top_script_abs
905
	# realpath this before doing any cd so this points to the right place
906
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
907

    
908
set_paths()
909
{
910
	top_script="$(clog++ canon_rel_path "$top_script_abs")" || return
911
		echo_vars top_script
912
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
913
}
914
set_paths
915

    
916
# usage: $(enter_top_dir; cmd...)
917
function enter_top_dir() { echo_func; cd "$top_dir"; }
918
alias enter_top_dir='log++; "enter_top_dir"'
919

    
920
# usage: in_top_dir cmd...
921
function in_top_dir() { echo_func; (enter_top_dir; "$@"); }
922
alias in_top_dir='"in_top_dir" ' # last space alias-expands next word
923

    
924
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
925
{
926
	echo_func; echo_vars PATH; : "${PATH?}"
927
	log+ 2
928
	split : "$PATH"
929
	local new_paths=()
930
	for path in "${parts[@]}"; do
931
		if ! contains "$path" "$@"; then new_paths+=("$path"); fi
932
	done
933
	PATH="$(delim=: join "${new_paths[@]}")" || return
934
	log- 2
935
	echo_vars PATH
936
}
937

    
938
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
939
# allows running a system command of the same name as the script
940
{
941
	echo_func
942
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
943
}
944

    
945
# makes command in $1 nonrecursive
946
# allows running a system command of the same name as the script
947
alias cmd2abs_path="$(cat <<'EOF'
948
declare _1="$1"; shift
949
_1="$(indent; no_PATH_recursion; log++; which "$_1"|echo_stdout)" || return
950
set -- "$_1" "$@"
951
EOF
952
)"
953

    
954

    
955
#### verbose output
956

    
957

    
958
## internal commands
959

    
960
.()
961
{
962
	clog++ clog++ echo_func
963
	cmd2rel_path; set -- "$FUNCNAME" "$@"
964
	if (log++; echo_params; can_log); then indent; fi
965
	builtin "$@"
966
}
967

    
968
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
969
{
970
	clog++ clog++ echo_func; local file="$1"; shift
971
	. "$(canon_rel_path "$(dirname "$(realpath "${BASH_SOURCE[1]}")")/$file")" \
972
"$@"
973
}
974

    
975
cd() # indent is permanent within subshell cd was used in
976
{
977
	log++ echo_func
978
	cmd2rel_path; echo_cmd "$FUNCNAME" "$@"
979
	if can_log; then caller_indent; fi
980
	# -P: expand symlinks so $PWD matches the output of realpath
981
	builtin "$FUNCNAME" -P "$@"
982
	
983
	func=realpath clear_cache
984
	set_paths
985
}
986

    
987
## external commands
988

    
989
disable_logging() { set_fds "$log_fd>/dev/null"; }
990

    
991
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
992
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
993
{
994
	echo_func; kw_params redirs
995
	
996
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
997
	(
998
		log++ set_fds "${redirs[@]}"
999
		unset redirs # don't redirect again in invoked command
1000
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd)
1001
		"$@"
1002
	) || return
1003
}
1004
alias redir='"redir" ' # last space alias-expands next word
1005

    
1006
alias_append save_e '; unset redirs' # don't redirect error handlers
1007

    
1008
fi # load new aliases
1009
if self_being_included; then
1010

    
1011
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] [nonrecursive=1] \
1012
# command extern_cmd...
1013
{
1014
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
1015
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
1016
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
1017
	local redirs=("${redirs[@]}")
1018
	
1019
	# determine redirections
1020
	if test "$cmd_log_fd"; then
1021
		if can_log; then
1022
			if test "$cmd_log_fd" != "$log_fd"; then
1023
				redirs+=("$cmd_log_fd>&$log_fd")
1024
			fi # else no redir needed
1025
		else redirs+=("$cmd_log_fd>/dev/null");
1026
		fi
1027
	fi
1028
	
1029
	if test "$nonrecursive"; then cmd2abs_path; else cmd2rel_path; fi
1030
	redir command__exec "$@" || die_e
1031
}
1032
command__exec()
1033
{
1034
	ensure_nested_func
1035
	if can_log; then indent; fi
1036
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
1037
	verbosity_compat
1038
	builtin command "$@"
1039
}
1040

    
1041

    
1042
### external command input/output
1043

    
1044
echo_stdin() # usage: input|echo_stdin|cmd
1045
{
1046
	if can_log; then
1047
		pipe_delay
1048
		echo ----- >&"$log_fd"
1049
		tee -a /dev/fd/"$log_fd";
1050
		echo ----- >&"$log_fd"
1051
	else cat
1052
	fi
1053
}
1054

    
1055
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
1056

    
1057

    
1058
#### commands
1059

    
1060
already_exists_msg() # usage: cond || what=... already_exists_msg || return 0
1061
{
1062
	type=info die "$what"' already exists, skipping
1063
 to force-remake, prepend `rm=1` to the command '
1064
}
1065

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

    
1069
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
1070
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
1071
{
1072
	echo_func; kw_params stdout if_not_exists del
1073
	: "${stdout?}"; local del="${del-1}"
1074
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
1075
	
1076
	local redirs=("${redirs[@]}" ">$stdout")
1077
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
1078
}
1079
alias to_file='"to_file" ' # last space alias-expands next word
1080

    
1081
log_bg() { symbol='&' log_custom "$@"; }
1082

    
1083
log_last_bg() { log_bg '$!='"$!"; }
1084

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

    
1088

    
1089
#### filesystem
1090

    
1091
alias mkdir='mkdir -p'
1092

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

    
1096
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
1097
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
1098

    
1099
fi # load new aliases
1100
if self_being_included; then
1101

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

    
1104
# usage: (mv_glob ... dir)
1105
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
1106
alias mv_glob='shopt -s nullglob; "mv_glob"'
1107

    
1108

    
1109
#### URLs
1110

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

    
1113
fi
(10-10/11)