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
lowercase() { tr A-Z a-z <<<"$1"; }
12

    
13
str2varname() { lowercase "${1//[^a-zA-Z0-9_]/_}"; }
14
	# lowercase: on case-insensitive filesystems, paths sometimes canonicalize
15
	# to a different capitalization than the original
16

    
17
include_guard_var() { str2varname "$(realpath "$1")"; }
18

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

    
28
# to load newly-defined aliases for use in functions in the same file:
29
## fi # load new aliases
30
## if self_being_included; then
31
# this is needed because aliases defined inside an if statement are not
32
# available inside that if statement
33

    
34
fi
35

    
36

    
37
if self_not_included "${BASH_SOURCE[0]}"; then
38

    
39

    
40
#### options
41

    
42
shopt -s expand_aliases
43
# **DON'T** do `shopt -s lastpipe` because this causes a segfault on Linux in
44
# stderr_matches(). (it also isn't supported on Mac.) use @PIPESTATUS instead.
45

    
46

    
47
#### stubs
48

    
49
die()
50
{ return "$?"; } # can't use `:` because that resets $?
51

    
52
alias log_local='declare PS4="$PS4" log_level="$log_level"'
53

    
54
function log++() { :; }
55
alias log++='"log++" ' # last space alias-expands next word
56
alias log--='"log--" ' # last space alias-expands next word
57
alias log!='"log!" ' # last space alias-expands next word
58

    
59
function log() { :; }
60

    
61
__caller_indent='log_indent="$log_indent$log_indent_step"'
62
alias caller_indent="$__caller_indent"
63
alias indent="declare $__caller_indent"
64

    
65
function canon_rel_path() { echo "$1"; }
66

    
67
function echo_func() { :; }
68
alias echo_func='"echo_func" "$FUNCNAME" "$@" && indent || true'
69

    
70
function echo_run() { :; }
71
alias echo_run='"echo_run" ' # last space alias-expands next word
72

    
73
# auto-echo common external commands
74
for cmd in env rm which; do alias "$cmd=echo_run $cmd"; done; unset cmd
75

    
76
echo_builtin() { :; }
77

    
78
function echo_vars() { :; }
79

    
80

    
81
#### logic
82

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

    
85
bool!() # usage: "$(bool! "$bool_var")"
86
{ if test ! "$1"; then echo -n 1; fi } # empty<->non-empty
87

    
88

    
89
#### vars
90

    
91
alias local_array='declare -a'
92
	# `local` does not support arrays in older versions of bash/on Mac
93

    
94
set_var() { eval "$1"'="$2"'; }
95

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

    
98
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
99

    
100
# usage: local var=...; local_inv
101
alias local_inv=\
102
'declare "no_$var=$(test "${!var}" || echo 1)"; echo_vars no_$var'
103

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

    
107
alias local_export='declare -x' # combines effects of local and export
108

    
109
alias export_array='declare -ax'
110
	# `export` does not support arrays in older versions of bash/on Mac
111

    
112
# to make export only visible locally: local var="$var"; export var
113
# within cmd: var="$var" cmd...
114

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

    
117
# usage: local prefix=..._; import_vars
118
# when used inside another alias 2+ levels deep, *must* be run inside a function
119
# idempotent: vars already set will *not* be overwritten
120
alias import_vars="$(cat <<'EOF'
121
: "${prefix:?}"
122
declare src_var dest_var
123
for src_var in $(get_prefix_vars); do
124
	dest_var="${src_var#$prefix}"
125
	# use ${...-...} to avoid overwriting an already-set var
126
	declare "$dest_var=${!dest_var-${!src_var}}"; echo_vars "$dest_var"
127
done
128
EOF
129
)"
130

    
131

    
132
#### integers
133

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

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

    
139
int2exit() { (( "$1" != 0 )); }
140

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

    
143

    
144
#### floats
145

    
146
int_part() { echo "${1%%.*}"; }
147

    
148
dec_suffix() { echo "${1#$(int_part "$1")}"; }
149

    
150
round_down() { int_part "$1"; }
151

    
152
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
153

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

    
156

    
157
#### strings
158

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

    
161
ends_with() { test "${2%$1}" != "$2"; } # usage: ends_with pattern str
162

    
163
match_prefix() # usage: match_prefix pattern str
164
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
165

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

    
168
contains_match() { starts_with "*$1" "$2"; } # usage: contains_match pattern str
169

    
170
repeat() # usage: str=... n=... repeat
171
{
172
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
173
	for (( ; n > 0; n-- )); do result="$result$str"; done
174
	echo "$result"
175
}
176

    
177
# usage: outer_cmd $sed_cmd ...
178
sed_cmd="env LANG= sed -`case "$(uname)" in Darwin) echo El;; *) echo ru;;esac`"
179
	# LANG: avoid invalid UTF-8 "illegal byte sequence" errors when LANG=*.UTF-8
180
	# -l: line buffered / -u: unbuffered
181
alias sed="$sed_cmd"
182
	# can't be function because this causes segfault in redir() subshell when
183
	# used with make.sh make() filter
184

    
185
fi # load new aliases
186
if self_being_included; then
187

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

    
190

    
191
#### arrays
192

    
193
echo1() { echo "$1"; } # usage: echo1 values...
194

    
195
esc() # usage: array=($(log++; prep_env... (eg. cd); esc args...))
196
{ local arg; for arg in "$@"; do printf '%q ' "$arg"; done; }
197

    
198
# usage: split delim str; use ${parts[@]}
199
function split() { split__with_IFS "$@"; echo_vars parts; }
200
	# no echo_func because used by log++
201
split__with_IFS() { local IFS="$1"; parts=($2); } # limit effects of IFS
202
alias split='declare parts; "split"'
203

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

    
206
reverse() # usage: array=($(reverse args...))
207
{
208
	local i
209
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
210
}
211

    
212
contains() # usage: contains value in_array...
213
{
214
	local value="$1"; shift
215
	local elem
216
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
217
	return 1
218
}
219

    
220
is_array() # handles unset vars (=false)
221
{
222
	isset "$1" || return 1
223
	local decl; decl="$(declare -p "$1")" || return; echo_vars decl
224
	starts_with 'declare -a' "$decl" # also matches -ax
225
}
226

    
227

    
228
#### terminal
229

    
230
### formatting
231

    
232
has_bg()
233
{
234
	# inverse (black background)/set background (normal colors)/set background
235
	# (bright colors) (xfree86.org/current/ctlseqs.html#Character_Attributes)
236
	starts_with 7 "$1" || starts_with 4 "$1" || starts_with 10 "$1"
237
}
238

    
239
format() # usage: format format_expr msg
240
# format_expr: the #s in xfree86.org/current/ctlseqs.html#Character_Attributes
241
{
242
	local format="$1" msg="$2"
243
	if starts_with '[' "$msg"; then format=; fi #don't add padding if formatted
244
	if has_bg "$format"; then msg=" $msg "; fi # auto-add padding if has bg
245
	echo "${format:+[0;${format}m}$msg${format:+}"
246
}
247

    
248
plain() { echo "$1"; }
249

    
250
fade() { format 90 "$@"; } # medium gray fades on white *&* black backgrounds
251

    
252

    
253
#### errors
254

    
255
err_fd=2 # stderr
256

    
257
# usage: local func=...; set_func_loc; use $file, $line
258
alias set_func_loc="$(cat <<'EOF'
259
: "${func:?}"
260
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
261
func_info="${func_info#$func }"
262
local line="${func_info%% *}"
263
local file="${func_info#$line }"
264
EOF
265
)"
266

    
267
fi # load new aliases
268
if self_being_included; then
269

    
270
func_loc() # gets where function declared in the format file:line
271
{
272
	local func="$1"; set_func_loc
273
	file="$(canon_rel_path "$file")" || return
274
	echo "$file:$line"
275
}
276

    
277
### stack traces
278

    
279
alias init_i='declare i="${i-0}"'
280
alias next_stack_frame='let! i++'
281

    
282
# makes stack_trace() skip the entry for the caller
283
alias skip_stack_frame='init_i; next_stack_frame'
284

    
285
fi # load new aliases
286
if self_being_included; then
287

    
288
# usage: [i=#] get_stack_frame # i: 0-based index from top of stack
289
# to get all stack frames:
290
# init_i; while get_stack_frame; do use $func $file $line; next_stack_frame;done
291
# better than `caller` builtin because returns info in separate vars
292
get_stack_frame()
293
{
294
	skip_stack_frame; init_i
295
	# the extra FUNCNAME/BASH_LINENO entries have dummy values (main/0)
296
	func="${FUNCNAME[$i]}" # the called function, which = the current function
297
	file="${BASH_SOURCE[$i+1]}" # not the *current* file, but the call's file
298
	line="${BASH_LINENO[$i]}" # the line the function was called at
299
	test "$file" # exit false if invalid index
300
}
301
alias get_stack_frame='declare func file line && "get_stack_frame"'
302
	# && instead of ; so it can be used as a while cond
303

    
304
format_stack_frame() #usage: "$(func=_ file=_ line=_ format_stack_frame [args])"
305
{
306
	file="$(canon_rel_path "$file")" || return
307
	local caller="$file:$line"
308
	local func_loc; func_loc="$(func_loc "$func")" || return
309
	func_loc="${func_loc#$file:}" # include just line # if file same
310
	echo "$(esc "$func" "$@")   $(plain "@$caller -> $func_loc")"
311
}
312

    
313
stack_trace() # usage: "$([i=#] stack_trace)" # or use print_stack_trace
314
{
315
	skip_stack_frame; init_i
316
	while get_stack_frame; do
317
		format_stack_frame
318
		next_stack_frame
319
	done
320
}
321

    
322
print_stack_trace() { skip_stack_frame; stack_trace >&2; }
323
# *note*: don't call from logging functions b/c will cause infinite recursion
324

    
325

    
326
#### debugging
327

    
328
debug_fd="$err_fd"
329

    
330
ps() { echo "$@" >&"$debug_fd"; } # usage: ps str...
331

    
332
pv() { declare -p "$@" >&"$debug_fd"; } # usage: pv var... # debug-prints vars
333

    
334
pf() { declare -f "$@" >&"$debug_fd"; } # usage: pf func... # prints func decls
335

    
336
pst() { print_stack_trace; } # no skip_stack_frame so know where called from
337
# *note*: don't call from logging functions b/c will cause infinite recursion
338

    
339

    
340
#### caching
341

    
342
## shell-variable-based caching
343

    
344
# usage: local cache_key=...; load_cache; \
345
# if ! cached; then save_cache value || return; fi; echo_cached_value
346
# cache_key for function inputs: "$(declare -p kw_param...) $*"
347
alias load_cache='declare cache_var="$(str2varname "${FUNCNAME}___$cache_key")"'
348
alias cached='isset "$cache_var"'
349
alias save_cache='set_var "$cache_var"'
350
alias echo_cached_value='echo "${!cache_var}"'
351

    
352
clear_cache() # usage: func=... clear_cache
353
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
354

    
355
fi # load new aliases
356
if self_being_included; then
357

    
358

    
359
#### functions
360

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

    
363
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
364
# removes keyword-param-only vars from the environment
365
{ unexport "$@"; }
366

    
367
1st_non_opt() { while starts_with - "$1"; do shift; done; echo "$1"; }
368

    
369
# usage: cmd=... foreach_arg
370
function foreach_arg()
371
{
372
	echo_func; kw_params cmd; : "${cmd:?}"
373
	local a; for a in "$@"; do
374
		a="$(log++ echo_run "$cmd" "$a")" || return; args+=("$a")
375
	done
376
	echo_vars args
377
}
378
alias foreach_arg='"foreach_arg" "$@"; set -- "${args[@]}"; unset args'
379

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

    
382
alias self='command "$(self_name)"' # usage: wrapper() { self ...; }
383
alias self_sys='sys_cmd "$(self_name)"' # wrapper() { self_sys ...; }
384
alias self_builtin='builtin "${FUNCNAME%%__*}"' #wrapper() { self_builtin ...; }
385

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

    
389
copy_func() # usage: from=... to=... copy_func
390
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
391
{
392
	log++ echo_func
393
	: "${from:?}" "${to:?}"
394
	func_exists "$from" || die "function does not exist: $from"
395
	! func_exists "$to" || die "function already exists: $to"
396
	local from_def="$(declare -f "$from")"
397
	eval "$to${from_def#$from}"
398
}
399

    
400
func_override() # usage: func_override old_name__suffix
401
{ log++ echo_func; from="${1%__*}" to="$1" copy_func; }
402

    
403
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
404
{
405
	local nested_func="${FUNCNAME[1]}"
406
	local func="${nested_func%%__*}"
407
	contains "$func" "${FUNCNAME[@]}" || \
408
		die "$nested_func() must be used by $func()"
409
}
410

    
411

    
412
#### aliases
413

    
414
fi # load new aliases
415
if self_being_included; then
416

    
417
unalias() { self_builtin "$@" 2>&- || true; } # no error if undefined
418

    
419
# usage: alias alias_='var=value run_cmd '
420
function run_cmd() { "$@"; }
421
alias run_cmd='"run_cmd" ' # last space alias-expands next word
422

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

    
425

    
426
#### commands
427

    
428
type() # handles fact that any alias would already be expanded
429
{ (unalias "$(1st_non_opt "$@")"; self_builtin "$@") || return; }
430

    
431
is_callable() { type -t -- "$1" >/dev/null; }
432

    
433
is_extern() { test "$(type -t -- "$1")" = file; }
434

    
435
is_intern() { is_callable "$1" && ! is_extern "$1"; }
436

    
437
is_dot_script()
438
{ log_local;log++; echo_func; test "${BASH_LINENO[${#BASH_LINENO[@]}-1]}" != 0;}
439

    
440
require_dot_script() # usage: require_dot_script || return
441
{
442
	echo_func
443
	if ! is_dot_script; then # was run without initial "."
444
		echo "usage: . $top_script (note initial \".\")"|fold -s >&2
445
		return 2
446
	fi
447
}
448

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

    
451
# makes command in $1 a system command
452
# allows running a system command of the same name as the script
453
alias cmd2sys="$(cat <<'EOF'
454
declare _1="$1"; shift
455
_1="$(indent; log++ sys_cmd_path "$_1")" || return
456
set -- "$_1" "$@"
457
EOF
458
)"
459

    
460
fi # load new aliases
461
if self_being_included; then
462

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

    
466
function sudo()
467
{
468
	echo_func
469
	if is_callable "$1"; then set -- env PATH="$PATH" "$@"; fi # preserve PATH
470
	self -E "$@"
471
}
472
alias sudo='"sudo" ' # last space alias-expands next word
473

    
474

    
475
#### exceptions
476

    
477
fi # load new aliases
478
if self_being_included; then
479

    
480
exit() { self_builtin "${1:-$?}"; } # exit sometimes inxeplicably ignores $?
481

    
482
errexit() # usage: cmd || errexit status # works in functions *and* subshells
483
{ return "$1"; }
484
	# can't use `(exit "$1")` because a bug in bash prevents subshells from
485
	# triggering errexit (would need to append `|| return` for it to work)
486

    
487
# usage: cmd || { save_e; ...; rethrow; }
488

    
489
alias export_e='e=$?'
490

    
491
# **WARNING**: if using this after a command that might succeed (rather than
492
# only upon error), you must `unset e` before the command
493
# idempotent: also works if save_e already called
494
alias save_e='# idempotent: use $e if the caller already called save_e
495
declare e_=$?;
496
declare e="$(if test "$e_" = 0; then echo "${e:-0}"; else echo "$e_"; fi)"'
497

    
498
rethrow() { errexit "${e:-0}"; } # only does anything if $e != 0
499
rethrow!() { rethrow && false; } # always errexit, even if $e = 0
500
rethrow_exit() { rethrow || exit; } # exit even where errexit disabled
501

    
502
is_err() { ! rethrow; } # rethrow->*false* if error
503

    
504
fi # load new aliases
505
if self_being_included; then
506

    
507
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; \
508
# finally...; end_try
509

    
510
alias prep_try='declare e=0 benign_error="$benign_error"'
511

    
512
# usage: ...; try cmd... # *MUST* be at beginning of statement
513
#     OR prep_try; var=... "try" cmd...
514
function try() { benign_error=1 "$@" || { export_e; true; }; }
515
alias try='prep_try; "try" ' # last space alias-expands next word
516

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

    
519
ignore_e() { if catch "$@"; then benign_error=1; fi; } # also works w/ $1=''
520

    
521
alias end_try='rethrow'
522

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

    
525
### signals
526

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

    
529
func_override catch__exceptions
530
catch() # supports SIG* as exception type
531
{
532
	log_local; log++; echo_func
533
	if starts_with SIG "$1"; then set -- "$(sig_e "$1")"; fi
534
	catch__exceptions "$@"
535
}
536

    
537
# usage: piped_cmd cmd1...|cmd2... # cmd2 doesn't read all its input
538
function piped_cmd() { "$@" || ignore SIGPIPE; }
539
alias piped_cmd='"piped_cmd" ' # last space alias-expands next word
540

    
541
fi # load new aliases
542
if self_being_included; then
543

    
544

    
545
#### text
546

    
547
nl='
548
'
549

    
550
# usage: by itself:                            split_lines  str; use ${lines[@]}
551
#        with wrapper: declare lines; wrapper "split_lines" str; use ${lines[@]}
552
function split_lines() { split "$nl" "$1"; lines=("${parts[@]}"); }
553
	# no echo_func because used by log++
554
alias split_lines='declare lines; "split_lines"'
555

    
556

    
557
#### paths
558

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

    
561
wildcard/() # usage: array=($(log++; [cd ...;] wildcard/ unquoted_pattern...))
562
{ cmd=strip/ foreach_arg; esc "$@"; }
563

    
564
wildcard.() # usage: array=($(log++; [cd ...;] wildcard. unquoted_pattern...))
565
# currently only removes . .. at beginning of list
566
{
567
	set -- $(wildcard/ "$@") # first strip trailing /s
568
	local to_rm=(. ..)
569
	local item
570
	if contains "$1" "${to_rm[@]}"; then
571
		shift
572
		if contains "$1" "${to_rm[@]}"; then shift; fi
573
	fi
574
	esc "$@"
575
}
576

    
577
#### streams
578

    
579
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
580
{ sleep 0.1; } # s; display after leading output of cmd1
581

    
582

    
583
#### verbose output
584

    
585

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

    
588

    
589
### log++
590

    
591
log_fd=2 # initially stderr
592

    
593
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
594

    
595
# set verbosity
596
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
597
if isset vb; then : "${verbosity:=$vb}"; fi
598
: "${verbosity=1}" # default
599
: "${verbosity:=0}" # ensure non-empty
600
export verbosity # propagate to invoked commands
601

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

    
604
# set log_level
605
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
606
export log_level # propagate to invoked commands
607
export PS4 # follows log_level, so also propagate this
608

    
609
verbosity_int() { round_down "$verbosity"; }
610

    
611
# verbosities (and `make` equivalents):
612
# 0: just print errors. useful for cron jobs.
613
#    vs. make: equivalent to --silent, but suppresses external command output
614
# 1: also external commands run. useful for running at the command line.
615
#    vs. make: not provided (but sorely needed to avoid excessive output)
616
# 2: full graphical call tree. useful for determining where error occurred.
617
#    vs. make: equivalent to default verbosity, but with much-needed indents
618
# 3: also values of kw params and variables. useful for low-level debugging.
619
#    vs. make: not provided; need to manually use $(error $(var))
620
# 4: also variables in util.sh commands. useful for debugging util.sh.
621
#    vs. make: somewhat similar to --print-data-base
622
# 5: also variables in logging commands themselves. useful for debugging echo_*.
623
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
624
# 6+: not currently used (i.e. same as 5)
625

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

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

    
634
# usage: in func:      log_local; log++; ...
635
#        outside func: log_local; log++; ...; log--
636
#        before cmd:   log++ cmd  OR  log+ num cmd  OR  log++ log++... cmd
637
# with a cmd, assignments are applied just to it, so log_local is not needed
638
# without a cmd, assignments are applied to caller ("$@" expands to nothing)
639
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
640
log:() # sets explicit log_level
641
{
642
	if test $# -gt 1; then log_local; fi # if cmd, only apply assignments to it
643
	# no local vars because w/o cmd, assignments should be applied to caller
644
	log_level="$1"
645
	PS4="$(str="${PS4:0:1}" n=$((log_level-1)) repeat)${PS4: -2}"
646
	"${@:2}"
647
}
648
log+() { log: $((log_level+$1)) "${@:2}"; }
649
log-() { log+ "-$1" "${@:2}"; }
650
# no log:/+/- alias needed because next word is not an alias-expandable cmd
651
function log++() { log+ 1 "$@"; }
652
function log--() { log- 1 "$@"; }
653
function log!() { log: 0 "$@"; } # force-displays next log message
654
# see aliases in stubs
655

    
656
verbosity_min() # usage: verbosity_min {<min>|''}
657
# WARNING: '' is a special value that causes $verbosity to be overwritten to ''
658
{ if test ! "$1" -o "$(verbosity_int)" -lt "$1"; then verbosity="$1"; fi; }
659
alias verbosity_min='declare verbosity="$verbosity"; "verbosity_min"'
660

    
661
# usage: (verbosity_compat; cmd)
662
function verbosity_compat()
663
{ log_local; log++; echo_func; if ((verbosity == 1)); then unset verbosity; fi;}
664
alias verbosity_compat='declare verbosity="$verbosity"; "verbosity_compat"'
665

    
666

    
667
# indent for call tree. this is *not* the log_level (below).
668
: "${log_indent_step=| }" "${log_indent=}"
669
export log_indent_step log_indent # propagate to invoked commands
670

    
671
# see indent alias in stubs
672

    
673

    
674
fi # load new aliases
675
if self_being_included; then
676

    
677
can_log() { test "$log_level" -le "$(verbosity_int)"; }
678
	# verbosity=0 turns off all logging
679

    
680
can_highlight_log_msg() { test "$log_level" -le 1; }
681

    
682
highlight_log_msg() # usage: [format=...] highlight_log_msg msg
683
# format: the # in xfree86.org/current/ctlseqs.html#Character_Attributes
684
{
685
	log_local; log+ 2; echo_func; kw_params format; log- 2
686
	local format="${format-1}" # bold
687
	if ! can_highlight_log_msg; then format=0; fi #remove surrounding formatting
688
	format "$format" "$1"
689
}
690

    
691
log_line!() # highlights log_level 1 messages to stand out against other output
692
{ echo "$log_indent$PS4$(highlight_log_msg "$1")" >&"$log_fd"; }
693

    
694
log_msg!()
695
{
696
	declare lines; log+ 2 "split_lines" "$1"
697
	local l; for l in "${lines[@]}"; do log_line! "$l"; done
698
}
699

    
700
log() { if can_log; then log_msg! "$@"; fi; }
701

    
702
log_custom() # usage: symbol=... log_custom msg
703
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
704

    
705
bg_r='101;97' # red background with white text
706

    
707
log_err() { symbol='#' format="$bg_r" log_fd="$err_fd" log! log_custom "$@";}
708

    
709
log_info() { symbol=: log_custom "$@"; }
710

    
711
mk_hint() { format=7 highlight_log_msg "$@";}
712

    
713
log_err_hint!() { log_err "$(mk_hint "$@")"; }
714

    
715
log_err_hint() # usage: cmd || [benign_error=1] log_err_hint msg [|| handle err]
716
# msg only displayed if not benign error
717
{
718
	log++ kw_params benign_error
719
	if test ! "$benign_error"; then log_err_hint! "$@"; fi
720
}
721

    
722
die() # usage: if msg uses $(...):    cmd || { save_e; [type=...] die msg; }
723
#              if msg uses only vars: cmd || [type=...] die msg
724
{ save_e; log++ kw_params type; "log_${type:-err}" "$1"; rethrow!; }
725

    
726
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
727
{
728
	save_e; log++ kw_params benign_error
729
	if test "$e" = "$(sig_e SIGPIPE)"; then benign_error=1; fi
730
	if test "$benign_error"; then log_local; log++; fi
731
	type="${benign_error:+info}" die "command exited with \
732
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
733
	rethrow
734
}
735

    
736
die_error_hidden() # usage: cmd || verbosity_min=# die_error_hidden [|| ...]
737
{
738
	save_e; log++ echo_func; log++ kw_params verbosity_min
739
	: "${verbosity_min:?}"; log++ echo_vars verbosity
740
	if test "$(verbosity_int)" -lt "$verbosity_min"; then
741
		log_err_hint 'to see error details, prepend `vb='"$verbosity_min"'` to the command'
742
	fi
743
	rethrow
744
}
745

    
746

    
747
#### paths
748

    
749
# cache realpath
750
: "${realpath_cache=}" # default off because slower than without
751
if test "$realpath_cache"; then
752
func_override realpath__no_cache
753
realpath() # caches the last result for efficiency
754
{
755
	local cache_key="$*"; load_cache
756
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
757
	echo_cached_value
758
}
759
fi
760

    
761
rel_path() # usage: base_dir=... path=... rel_path
762
{
763
	log_local; log++; kw_params base_dir path
764
	: "${base_dir:?}" "${path:?}"
765
	
766
	local path="$path/" # add *extra* / to match path when exactly = base_dir
767
	path="${path#$base_dir/}" # remove prefix shared with base_dir
768
	path="${path%/}" # remove any remaining extra trailing /
769
	
770
	if test ! "$path"; then path=.; fi # ensure non-empty
771
	
772
	echo_vars path
773
	echo "$path"
774
}
775

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

    
779
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
780
# falls back to original path if can't resolve
781
{
782
	kw_params base_dir; local path="$1" base_dir="${base_dir-$PWD}"
783
	canon_rel_path__try || echo "$path"
784
}
785
canon_rel_path__try()
786
{
787
	ensure_nested_func
788
	base_dir="$(realpath "$base_dir")" || return
789
	path="$(realpath "$path")" || return
790
	rel_path
791
}
792

    
793
canon_dir_rel_path() # usage: [base_dir=...] canon_dir_rel_path path
794
# if the path is a symlink, just its parent dir will be canonicalized
795
{
796
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
797
	base_dir="$(realpath "$base_dir")" || return
798
	local path; path="$(realpath "$(dirname "$1")")/$(basename "$1")" || return
799
	rel_path
800
}
801

    
802
# makes $1 a canon_rel_path if it's a filesystem path
803
alias cmd2rel_path="$(cat <<'EOF'
804
if is_extern "$1" && test -e "$1"; then # not relative to PATH
805
	declare _1="$1"; shift
806
	_1="$(log++ canon_rel_path "$_1")" || return
807
	set -- "$_1" "$@"
808
fi
809
EOF
810
)"
811

    
812
# usage: path_parents path; use ${dirs[@]} # includes the path itself
813
function path_parents()
814
{
815
	echo_func; local path="$1" prev_path=; dirs=()
816
	while test "$path" != "$prev_path"; do
817
		prev_path="$path"
818
		dirs+=("$path")
819
		path="${path%/*}"
820
	done
821
}
822
alias path_parents='declare dirs; "path_parents"'
823

    
824

    
825
#### verbose output
826

    
827

    
828
### command echoing
829

    
830
alias echo_params='log "$*"'
831

    
832
fi # load new aliases
833
if self_being_included; then
834

    
835
echo_cmd() { echo_params; }
836

    
837
function echo_run() { echo_params; "$@"; }
838
# see echo_run alias after stub
839

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

    
842
echo_eval() { echo_params; builtin eval "$@"; }
843

    
844
## vars
845

    
846
echo_vars() # usage: echo_vars var... # also prints unset vars
847
{
848
	log_local; log++ # same log_level as echo_func
849
	if can_log; then
850
		local set_exprs= shared_flags=
851
		local var; for var in "${@%%=*}"; do
852
			if ! isset "$var"; then declare "$var"='<unset>'; fi
853
			
854
			# merge repeated flags
855
			local decl="$(declare -p "$var")"; decl="${decl#declare }"
856
			local flags="${decl%% *}" def="${decl#* }"
857
			if test ! "$shared_flags"; then shared_flags="$flags"; fi
858
			if test "$flags" != "$shared_flags"; then
859
				set_exprs="$set_exprs$flags "
860
			fi
861
			set_exprs="$set_exprs$def "
862
		done
863
		# put all vars on same line so they don't clutter up the logging output
864
		log "declare $shared_flags $set_exprs"
865
	fi
866
}
867

    
868
echo_export() { builtin export "$@"; echo_vars "$@"; }
869

    
870
alias export="echo_export" # automatically echo env vars when they are set
871

    
872
func_override kw_params__lang
873
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
874

    
875
## functions
876

    
877
# usage: func() { echo_func; ... }
878
function echo_func()
879
# usage: "echo_func" "$FUNCNAME" "$@" && indent || true
880
# exit status: whether function call was echoed
881
{
882
	log_local; log++; can_log || return
883
	local func="$1"; shift
884
	local loc; loc="$(log++ func_loc "$func")" || return
885
	echo_cmd "$func" "$@" "   $(plain "@$loc")"
886
}
887
# see echo_func alias after stub
888

    
889
fi # load new aliases
890
if self_being_included; then
891

    
892

    
893
#### fds
894

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

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

    
900
set_fds() # usage: set_fds redirect...
901
# WARNING: does not currently support redirecting an fd to itself (due to bash
902
# bug that requires the dest fd to be closed before it can be reopened)
903
{
904
	echo_func
905
	
906
	# add #<>&- before every #<>&# reopen to fix strange bash bug
907
	local redirs=() i
908
	for i in "$@"; do
909
		# remove empty redirects resulting from using `redirs= cmd...` to clear
910
		# the redirs and then using $redirs as an array
911
		if test "$i"; then
912
			local redir_prefix="$(match_prefix '*[<>]' "$i")"
913
			local dest="$(        rm_prefix    '*[<>]' "$i")"
914
			if test "$dest" && ! starts_with '&' "$dest"; then # escape dest
915
				i="$redir_prefix$(printf %q "$dest")"
916
			fi
917
			if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
918
			redirs+=("$i")
919
		fi
920
	done
921
	set -- "${redirs[@]}"
922
	
923
	if (($# > 0)); then echo_eval exec "$@"; fi
924
}
925

    
926
fd_set_default() # usage: fd_set_default 'dest[<>]src'
927
{
928
	echo_func
929
	local dest="${1%%[<>]*}"
930
	require_fd_not_exists "$dest" || return 0
931
	set_fds "$1"
932
}
933

    
934
# convention: use fd 40/41/42 for command-specific alternate stdin/stdout/stderr
935
# mnemonic: 4 looks like A for Alternate
936
# do NOT use 1x, which are used by eval (which is used by set_fds())
937
# do NOT use 2x, which we use as global stdin/stdout/stderr
938

    
939
stdlog=3
940

    
941
setup_log_fd() # view logging output at verbosity >= 5
942
{
943
	log_local; log+ 4; log-- echo_func 
944
	fd_set_default "$stdlog>&2" || true # set up stdlog
945
	log_fd="$stdlog" # don't change $log_fd until stdlog is set up
946
}
947
setup_log_fd
948

    
949
set_global_fds()
950
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
951
# this works even when /dev/tty isn't available
952
# view logging output at verbosity >= 3
953
{
954
	log_local; log+ 2; log-- echo_func
955
	# ignore errors if a source fd isn't open
956
	fd_set_default '20<&0' || true
957
	fd_set_default '21>&1' || true
958
	fd_set_default '22>&2' || true
959
	debug_fd=22 # debug to global stderr in case stderr filtered
960
}
961
set_global_fds
962

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

    
970

    
971
log++ echo_vars is_outermost
972

    
973

    
974
#### paths
975

    
976
log++
977

    
978
top_script="${BASH_SOURCE[${#BASH_SOURCE[@]}-1]}"; echo_vars top_script
979
	# outermost script; unlike $0, also defined for .-scripts
980

    
981
top_symlink_dir="$(dirname "$top_script")"; echo_vars top_symlink_dir
982
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
983
	echo_vars top_symlink_dir_abs
984

    
985
top_script_abs="$(realpath "$top_script")"; echo_vars top_script_abs
986
	# realpath this before doing any cd so this points to the right place
987
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
988

    
989
log--
990

    
991
set_paths()
992
{
993
	log_local; log++
994
	top_script="$(log++ canon_rel_path "$top_script_abs")" || return
995
		echo_vars top_script
996
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
997
}
998
set_paths
999

    
1000
# usage: $(enter_top_dir; cmd...)
1001
function enter_top_dir() { echo_func; cd "$top_dir"; }
1002
alias enter_top_dir='log++; "enter_top_dir"'
1003

    
1004
# usage: in_top_dir cmd...
1005
function in_top_dir() { echo_func; (enter_top_dir; "$@"); }
1006
alias in_top_dir='"in_top_dir" ' # last space alias-expands next word
1007

    
1008
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
1009
{
1010
	echo_func; echo_vars PATH; : "${PATH?}"
1011
	log_local
1012
	log+ 2
1013
	split : "$PATH"
1014
	local new_paths=()
1015
	for path in "${parts[@]}"; do
1016
		if ! contains "$path" "$@"; then new_paths+=("$path"); fi
1017
	done
1018
	PATH="$(delim=: join "${new_paths[@]}")" || return
1019
	log- 2
1020
	echo_vars PATH
1021
}
1022

    
1023
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
1024
# allows running a system command of the same name as the script
1025
{
1026
	echo_func
1027
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
1028
}
1029

    
1030
# makes command in $1 nonrecursive
1031
# allows running a system command of the same name as the script
1032
alias cmd2abs_path="$(cat <<'EOF'
1033
declare _1="$1"; shift
1034
_1="$(indent; no_PATH_recursion; log++; which "$_1"|echo_stdout)" || return
1035
set -- "$_1" "$@"
1036
EOF
1037
)"
1038

    
1039

    
1040
#### verbose output
1041

    
1042

    
1043
## internal commands
1044

    
1045
.()
1046
{
1047
	log_local; log++; log++ echo_func
1048
	cmd2rel_path; set -- "$FUNCNAME" "$@"
1049
	if (log++; echo_params; can_log); then indent; fi
1050
	builtin "$@"
1051
}
1052

    
1053
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
1054
{
1055
	log++ log++ echo_func; local file="$1"; shift
1056
	. "$(canon_rel_path "$(dirname "$(realpath "${BASH_SOURCE[1]}")")/$file")" \
1057
"$@"
1058
}
1059

    
1060
cd() # usage: cd dir [path_var...] # path_vars will be rebased for the new dir
1061
# indent is permanent within subshell cd was used in
1062
{
1063
	log_local; log++ echo_func
1064
	local dir="$1"; shift
1065
	
1066
	# absolutize path_vars
1067
	for path_var in "$@"; do # must happen *before* cd to use correct currdir
1068
		set_var "$path_var" "$(realpath "${!path_var}")"
1069
	done
1070
	
1071
	# change dir
1072
	# -P: expand symlinks so $PWD matches the output of realpath
1073
	echo_run self_builtin -P "$dir"
1074
	if can_log; then caller_indent; fi
1075
	
1076
	func=realpath clear_cache
1077
	set_paths
1078
	
1079
	# re-relativize path_vars
1080
	for path_var in "$@"; do # must happen *after* cd to use correct currdir
1081
		set_var "$path_var" "$(canon_rel_path "${!path_var}")"
1082
	done
1083
}
1084

    
1085
## external commands
1086

    
1087
disable_logging() { set_fds "$log_fd>/dev/null"; }
1088

    
1089
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
1090
echo_redirs_cmd()
1091
{
1092
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
1093
	
1094
	log++ echo_vars PATH
1095
	log+ "$cmd_name_log_inc" echo_cmd "$@" $(
1096
		# create redirs string
1097
		set -- "${redirs[@]}" # operate on ${redirs[@]}
1098
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
1099
		# print <>file redirs before cmd, because they introduce it
1100
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
1101
		echo "$@"
1102
	)
1103
}
1104

    
1105
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
1106
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
1107
{
1108
	echo_func; kw_params redirs
1109
	
1110
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
1111
	(
1112
		log++ set_fds "${redirs[@]}"
1113
		unset redirs # don't redirect again in invoked command
1114
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd "$@")
1115
		if can_log; then indent; fi
1116
		"$@"
1117
	) || return
1118
}
1119
alias redir='"redir" ' # last space alias-expands next word
1120

    
1121
alias_append save_e '; unset redirs' # don't redirect error handlers
1122

    
1123
fi # load new aliases
1124
if self_being_included; then
1125

    
1126
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] [nonrecursive=1] \
1127
# command extern_cmd...
1128
{
1129
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
1130
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
1131
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
1132
	local redirs=("${redirs[@]}")
1133
	
1134
	# determine redirections
1135
	if test "$cmd_log_fd"; then
1136
		if can_log; then
1137
			if test "$cmd_log_fd" != "$log_fd"; then
1138
				redirs+=("$cmd_log_fd>&$log_fd")
1139
			fi # else no redir needed
1140
		else redirs+=("$cmd_log_fd>/dev/null");
1141
		fi
1142
	fi
1143
	
1144
	if test "$nonrecursive"; then cmd2abs_path; else cmd2rel_path; fi
1145
	redir command__exec "$@"
1146
}
1147
command__exec()
1148
{
1149
	ensure_nested_func
1150
	local verbosity_orig="$verbosity" # save for use in die_e
1151
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
1152
	verbosity_compat
1153
	builtin command "$@" || { verbosity="$verbosity_orig"; die_e; }
1154
}
1155

    
1156

    
1157
### external command input/output
1158

    
1159
echo_stdin() # usage: input|echo_stdin|cmd
1160
{
1161
	if can_log; then
1162
		pipe_delay
1163
		echo ----- >&"$log_fd"
1164
		tee -a /dev/fd/"$log_fd";
1165
		echo ----- >&"$log_fd"
1166
	else cat
1167
	fi
1168
}
1169

    
1170
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
1171

    
1172
stdout2fd() # usage: fd=# stdout2fd cmd...
1173
{
1174
	echo_func; kw_params fd; : "${fd?}"
1175
	if test "$fd" != 1; then local redirs=(">&$fd" "${redirs[@]}"); fi
1176
	redir "$@"
1177
}
1178

    
1179
function filter_fd() # usage: (fd=# [redirs=] filter_fd filter_cmd...; \
1180
# with filter...) # be sure ${redirs[@]} is not set to an outer value
1181
# useful e.g. to filter logging output or highlight errors
1182
{
1183
	echo_func; kw_params fd; : "${fd?}"
1184
	set_fds "$fd>" >(pipe_delay; stdout2fd "$@")
1185
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
1186
}
1187
alias filter_fd='"filter_fd" ' # last space alias-expands next word
1188

    
1189
stderr2stdout() # usage: { stderr2stdout cmd...|use stderr...; } 41>&1
1190
# **IMPORTANT**: fd 41 must later be redirected back to fd 1
1191
# unlike `2>&1`, keeps stderr going to stderr
1192
# redirects the command stdout to fd 41 to avoid collision with stderr
1193
{
1194
	echo_func
1195
	# fd 2 *must* be redirected back to fd 2, not log-filtered, in case there
1196
	# are other errors in addition to the benign error
1197
	piped_cmd "$@" 2> >(log++ echo_run tee /dev/fd/2) >&41 # redirects 2->{1,2}
1198
}
1199

    
1200
stdout_contains()
1201
# usage: { stderr2stdout cmd|stdout_contains echo_run grep ...; } 41>&1
1202
{
1203
	log_local; log++; echo_func
1204
	pipe_delay; pipe_delay; pipe_delay; "$@"|echo_stdout >/dev/null
1205
}
1206

    
1207
stderr_matches() # usage: pattern=... [ignore_e=# [benign_error=1]] \
1208
# stderr_matches cmd...
1209
{
1210
	echo_func; kw_params pattern ignore_e; : "${pattern?}"
1211
	
1212
	# not necessary to allow callers to handle the error themselves (which would
1213
	# require *every* caller to wrap this function in prep_try/rethrow), because
1214
	# they would just handle it by errexiting anyways
1215
	prep_try
1216
	
1217
	set +o errexit # avoid errexiting since @PIPESTATUS will be used instead
1218
	{ benign_error=1 stderr2stdout "$@"\
1219
|stdout_contains echo_run grep -E "$pattern"; } 41>&1
1220
		# benign_error: handle exit status logging in this func instead
1221
	local PIPESTATUS_=("${PIPESTATUS[@]}") # save b/c it's reset after each cmd
1222
	echo_vars PIPESTATUS_
1223
	set -o errexit
1224
	
1225
	# handle any command error
1226
	e="${PIPESTATUS_[0]}"
1227
	local matches="$(errexit "${PIPESTATUS_[1]}"; exit2bool)"
1228
	if test "$matches"; then ignore_e "$ignore_e" #also works w/ ignore_e=''
1229
	elif is_err && test ! "$benign_error"; then die_e # incorrectly suppressed
1230
	fi
1231
	rethrow_exit #force-exit b/c caller's test of return status disables errexit
1232
	
1233
	# handle any filter error
1234
	e="${PIPESTATUS_[1]}"
1235
	ignore_e 1 # false is not an error
1236
	# all other unsuccessful exit statuses are errors
1237
	rethrow_exit #force-exit b/c caller's test of return status disables errexit
1238
	
1239
	return "${PIPESTATUS_[1]}" # 2nd command's exit status -> $?
1240
}
1241

    
1242
fi # load new aliases
1243
if self_being_included; then
1244

    
1245
function ignore_err_msg() # usage: pattern=... [ignore_e=#] ignore_err_msg cmd
1246
# unlike `|| true`, this suppresses only errors caused by a particular error
1247
# *message*, rather than all error exit statuses
1248
{
1249
	echo_func; kw_params pattern; : "${pattern?}"
1250
	stderr_matches "$@" || true # also ignore false exit status on no match
1251
}
1252
alias ignore_err_msg='"ignore_err_msg" ' # last space alias-expands next word
1253

    
1254

    
1255
#### commands
1256

    
1257
already_exists_msg() # usage: cond || what=... already_exists_msg || return 0
1258
{
1259
	save_e # needed because $(mk_hint) resets $?
1260
	type=info die "$what already exists, skipping
1261
$(mk_hint 'to force-remake, prepend `rm=1` to the command')"
1262
}
1263

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

    
1267
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
1268
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
1269
{
1270
	echo_func; kw_params stdout if_not_exists del
1271
	: "${stdout?}"; local del="${del-1}"
1272
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
1273
	
1274
	local redirs=("${redirs[@]}" ">$stdout")
1275
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
1276
}
1277
alias to_file='"to_file" ' # last space alias-expands next word
1278

    
1279
log_bg() { symbol='&' log_custom "$@"; }
1280

    
1281
log_last_bg() { log_bg '$!='"$!"; }
1282

    
1283
function bg_cmd() # usage: bg_cmd cmd...
1284
{ echo_func; log_bg "$@"; "$@" & log_last_bg; }
1285
alias bg_cmd='"bg_cmd" ' # last space alias-expands next word
1286

    
1287

    
1288
#### filesystem
1289

    
1290
could_be_glob() { echo_func; contains_match '\*' "$1"; }
1291

    
1292
is_dir() { echo_func; test -d "$1"; }
1293

    
1294
could_be_dir() { echo_func; ends_with / "$1" || is_dir "$1"; }
1295

    
1296
is_file() { echo_func; test -f "$1"; }
1297

    
1298
could_be_file()
1299
{ echo_func; { ! could_be_dir "$1" && ! could_be_glob "$1";} || is_file "$1"; }
1300

    
1301
alias mkdir='mkdir -p'
1302
alias cp='cp -p'
1303

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

    
1307
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
1308
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
1309

    
1310
fi # load new aliases
1311
if self_being_included; then
1312

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

    
1315
# usage: (mv_glob ... dir)
1316
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
1317
alias mv_glob='shopt -s nullglob; "mv_glob"'
1318

    
1319
### permissions
1320

    
1321
has_perms() # usage: perms=... has_perms item # perms: use find's -perm format
1322
{
1323
	echo_func; kw_params perms; : "${perms:?}"
1324
	test "$(find "$1" -maxdepth 0 -perm "$perms")"
1325
}
1326

    
1327
is_world_executable() { echo_func; perms=-o=x has_perms "$1"; } # -: all bits
1328

    
1329

    
1330
#### URLs
1331

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

    
1334
fi
(10-10/11)