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)"
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 "$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

    
337
#### caching
338

    
339
## shell-variable-based caching
340

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

    
349
clear_cache() # usage: func=... clear_cache
350
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
351

    
352
fi # load new aliases
353
if self_being_included; then
354

    
355

    
356
#### functions
357

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

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

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

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

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

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

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

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

    
397
func_override() # usage: func_override old_name__suffix
398
{ log++ echo_func; from="${1%__*}" to="$1" copy_func; }
399

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

    
408

    
409
#### aliases
410

    
411
fi # load new aliases
412
if self_being_included; then
413

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

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

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

    
422

    
423
#### commands
424

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

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

    
430
is_extern() { test "$(type -t -- "$1")" = file; }
431

    
432
is_intern() { is_callable "$1" && ! is_extern "$1"; }
433

    
434
is_dot_script()
435
{ log_local;log++; echo_func; test "${BASH_LINENO[${#BASH_LINENO[@]}-1]}" != 0;}
436

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

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

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

    
457
fi # load new aliases
458
if self_being_included; then
459

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

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

    
471

    
472
#### exceptions
473

    
474
fi # load new aliases
475
if self_being_included; then
476

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

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

    
484
# usage: cmd || { save_e; ...; rethrow; }
485

    
486
alias export_e='e=$?'
487

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

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

    
499
is_err() { ! rethrow; } # rethrow->*false* if error
500

    
501
fi # load new aliases
502
if self_being_included; then
503

    
504
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; \
505
# finally...; end_try
506

    
507
alias prep_try='declare e=0 benign_error="$benign_error"'
508

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

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

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

    
518
alias end_try='rethrow'
519

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

    
522
### signals
523

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

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

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

    
538
fi # load new aliases
539
if self_being_included; then
540

    
541

    
542
#### text
543

    
544
nl='
545
'
546

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

    
553

    
554
#### paths
555

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

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

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

    
574
#### streams
575

    
576
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
577
{ sleep 0.1; } # s; display after leading output of cmd1
578

    
579

    
580
#### verbose output
581

    
582

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

    
585

    
586
### log++
587

    
588
log_fd=2 # initially stderr
589

    
590
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
591

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

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

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

    
606
verbosity_int() { round_down "$verbosity"; }
607

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

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

    
628
fi # load new aliases
629
if self_being_included; then
630

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

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

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

    
663

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

    
668
# see indent alias in stubs
669

    
670

    
671
fi # load new aliases
672
if self_being_included; then
673

    
674
can_log() { test "$log_level" -le "$(verbosity_int)"; }
675
	# verbosity=0 turns off all logging
676

    
677
can_highlight_log_msg() { test "$log_level" -le 1; }
678

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

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

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

    
697
log() { if can_log; then log_msg! "$@"; fi; }
698

    
699
log_custom() # usage: symbol=... log_custom msg
700
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
701

    
702
bg_r='101;97' # red background with white text
703

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

    
706
log_info() { symbol=: log_custom "$@"; }
707

    
708
mk_hint() { format=7 highlight_log_msg "$@";}
709

    
710
log_err_hint!() { log_err "$(mk_hint "$@")"; }
711

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

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

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

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

    
743

    
744
#### paths
745

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

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

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

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

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

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

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

    
821

    
822
#### verbose output
823

    
824

    
825
### command echoing
826

    
827
alias echo_params='log "$*"'
828

    
829
fi # load new aliases
830
if self_being_included; then
831

    
832
echo_cmd() { echo_params; }
833

    
834
function echo_run() { echo_params; "$@"; }
835
# see echo_run alias after stub
836

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

    
839
echo_eval() { echo_params; builtin eval "$@"; }
840

    
841
## vars
842

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

    
865
echo_export() { builtin export "$@"; echo_vars "$@"; }
866

    
867
alias export="echo_export" # automatically echo env vars when they are set
868

    
869
func_override kw_params__lang
870
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
871

    
872
## functions
873

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

    
886
fi # load new aliases
887
if self_being_included; then
888

    
889

    
890
#### fds
891

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

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

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

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

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

    
936
stdlog=3
937

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

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

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

    
967

    
968
log++ echo_vars is_outermost
969

    
970

    
971
#### paths
972

    
973
log++
974

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

    
978
top_symlink_dir="$(dirname "$top_script")"; echo_vars top_symlink_dir
979
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
980
	echo_vars top_symlink_dir_abs
981

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

    
986
log--
987

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

    
997
# usage: $(enter_top_dir; cmd...)
998
function enter_top_dir() { echo_func; cd "$top_dir"; }
999
alias enter_top_dir='log++; "enter_top_dir"'
1000

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

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

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

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

    
1036

    
1037
#### verbose output
1038

    
1039

    
1040
## internal commands
1041

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

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

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

    
1082
## external commands
1083

    
1084
disable_logging() { set_fds "$log_fd>/dev/null"; }
1085

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

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

    
1118
alias_append save_e '; unset redirs' # don't redirect error handlers
1119

    
1120
fi # load new aliases
1121
if self_being_included; then
1122

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

    
1153

    
1154
### external command input/output
1155

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

    
1167
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
1168

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

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

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

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

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

    
1239
fi # load new aliases
1240
if self_being_included; then
1241

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

    
1251

    
1252
#### commands
1253

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

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

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

    
1276
log_bg() { symbol='&' log_custom "$@"; }
1277

    
1278
log_last_bg() { log_bg '$!='"$!"; }
1279

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

    
1284

    
1285
#### filesystem
1286

    
1287
could_be_glob() { echo_func; contains_match '\*' "$1"; }
1288

    
1289
is_dir() { echo_func; test -d "$1"; }
1290

    
1291
could_be_dir() { echo_func; ends_with / "$1" || is_dir "$1"; }
1292

    
1293
is_file() { echo_func; test -f "$1"; }
1294

    
1295
could_be_file()
1296
{ echo_func; { ! could_be_dir "$1" && ! could_be_glob "$1";} || is_file "$1"; }
1297

    
1298
alias mkdir='mkdir -p'
1299
alias cp='cp -p'
1300

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

    
1304
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
1305
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
1306

    
1307
fi # load new aliases
1308
if self_being_included; then
1309

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

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

    
1316
### permissions
1317

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

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

    
1326

    
1327
#### URLs
1328

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

    
1331
fi
(10-10/11)