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() { :; }
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
#### errors
82

    
83
err_fd=2 # stderr
84

    
85
# usage: local func=...; set_func_loc; use $file, $line
86
alias set_func_loc="$(cat <<'EOF'
87
: "${func:?}"
88
local func_info="$(shopt -s extdebug; declare -F "$func")" # 'func line file'
89
func_info="${func_info#$func }"
90
local line="${func_info%% *}"
91
local file="${func_info#$line }"
92
EOF
93
)"
94

    
95
fi # load new aliases
96
if self_being_included; then
97

    
98
func_loc() # gets where function declared in the format file:line
99
{
100
	local func="$1"; set_func_loc
101
	file="$(canon_rel_path "$file")" || return
102
	echo "$file:$line"
103
}
104

    
105

    
106
#### debugging
107

    
108
debug_fd="$err_fd"
109

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

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

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

    
116

    
117
#### logic
118

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

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

    
124

    
125
#### vars
126

    
127
alias local_array='declare -a'
128
	# `local` does not support arrays in older versions of bash/on Mac
129

    
130
set_var() { eval "$1"'="$2"'; }
131

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

    
134
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
135

    
136
# usage: local var=...; local_inv
137
alias local_inv=\
138
'declare "no_$var=$(test "${!var}" || echo 1)"; echo_vars no_$var'
139

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

    
143
alias local_export='declare -x' # combines effects of local and export
144

    
145
alias export_array='declare -ax'
146
	# `export` does not support arrays in older versions of bash/on Mac
147

    
148
# to make export only visible locally: local var="$var"; export var
149
# within cmd: var="$var" cmd...
150

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

    
153
# usage: local prefix=..._; import_vars
154
# when used inside another alias 2+ levels deep, *must* be run inside a function
155
# idempotent: vars already set will *not* be overwritten
156
alias import_vars="$(cat <<'EOF'
157
: "${prefix:?}"
158
declare src_var dest_var
159
for src_var in $(get_prefix_vars); do
160
	dest_var="${src_var#$prefix}"
161
	# use ${...-...} to avoid overwriting an already-set var
162
	declare "$dest_var=${!dest_var-${!src_var}}"; echo_vars "$dest_var"
163
done
164
EOF
165
)"
166

    
167

    
168
#### integers
169

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

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

    
175
int2exit() { (( "$1" != 0 )); }
176

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

    
179

    
180
#### floats
181

    
182
int_part() { echo "${1%%.*}"; }
183

    
184
dec_suffix() { echo "${1#$(int_part "$1")}"; }
185

    
186
round_down() { int_part "$1"; }
187

    
188
float+int() { echo "$(($(int_part "$1")+$2))$(dec_suffix "$1")"; }
189

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

    
192

    
193
#### strings
194

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

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

    
199
match_prefix() # usage: match_prefix pattern str
200
{ if starts_with "$1" "$2"; then echo "${2%${2#$1}}"; fi }
201

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

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

    
206
repeat() # usage: str=... n=... repeat
207
{
208
	: "${str?}" "${n:?}"; local result= n="$n" # n will be modified in function
209
	for (( ; n > 0; n-- )); do result="$result$str"; done
210
	echo "$result"
211
}
212

    
213
# usage: outer_cmd $sed_cmd ...
214
sed_cmd="env LANG= sed -`case "$(uname)" in Darwin) echo El;; *) echo ru;;esac`"
215
	# LANG: avoid invalid UTF-8 "illegal byte sequence" errors when LANG=*.UTF-8
216
	# -l: line buffered / -u: unbuffered
217
alias sed="$sed_cmd"
218
	# can't be function because this causes segfault in redir() subshell when
219
	# used with make.sh make() filter
220

    
221
fi # load new aliases
222
if self_being_included; then
223

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

    
226

    
227
#### arrays
228

    
229
echo1() { echo "$1"; } # usage: echo1 values...
230

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

    
234
# usage: split delim str; use ${parts[@]}
235
function split() { split__with_IFS "$@"; echo_vars parts; }
236
	# no echo_func because used by log++
237
split__with_IFS() { local IFS="$1"; parts=($2); } # limit effects of IFS
238
alias split='declare parts; "split"'
239

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

    
242
reverse() # usage: array=($(reverse args...))
243
{
244
	local i
245
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
246
}
247

    
248
contains() # usage: contains value in_array...
249
{
250
	local value="$1"; shift
251
	local elem
252
	for elem in "$@"; do if test "$elem" = "$value"; then return 0; fi; done
253
	return 1
254
}
255

    
256
is_array() # handles unset vars (=false)
257
{
258
	isset "$1" || return 1
259
	local decl; decl="$(declare -p "$1")" || return; echo_vars decl
260
	starts_with 'declare -a' "$decl" # also matches -ax
261
}
262

    
263

    
264
#### caching
265

    
266
## shell-variable-based caching
267

    
268
# usage: local cache_key=...; load_cache; \
269
# if ! cached; then save_cache value || return; fi; echo_cached_value
270
# cache_key for function inputs: "$(declare -p kw_param...) $*"
271
alias load_cache='declare cache_var="$(str2varname "${FUNCNAME}___$cache_key")"'
272
alias cached='isset "$cache_var"'
273
alias save_cache='set_var "$cache_var"'
274
alias echo_cached_value='echo "${!cache_var}"'
275

    
276
clear_cache() # usage: func=... clear_cache
277
{ : "${func:?}"; unset $(prefix="${func}___" get_prefix_vars); }
278

    
279
fi # load new aliases
280
if self_being_included; then
281

    
282

    
283
#### functions
284

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

    
287
kw_params() # usage: func() { kw_params param_var...; }; ...; param_var=... cmd
288
# removes keyword-param-only vars from the environment
289
{ unexport "$@"; }
290

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

    
293
# usage: cmd=... foreach_arg
294
function foreach_arg()
295
{
296
	echo_func; kw_params cmd; : "${cmd:?}"
297
	local a; for a in "$@"; do
298
		a="$(log++ echo_run "$cmd" "$a")" || return; args+=("$a")
299
	done
300
	echo_vars args
301
}
302
alias foreach_arg='"foreach_arg" "$@"; set -- "${args[@]}"; unset args'
303

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

    
306
alias self='command "$(self_name)"' # usage: wrapper() { self ...; }
307
alias self_sys='sys_cmd "$(self_name)"' # wrapper() { self_sys ...; }
308
alias self_builtin='builtin "${FUNCNAME%%__*}"' #wrapper() { self_builtin ...; }
309

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

    
313
copy_func() # usage: from=... to=... copy_func
314
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
315
{
316
	log++ echo_func
317
	: "${from:?}" "${to:?}"
318
	func_exists "$from" || die "function does not exist: $from"
319
	! func_exists "$to" || die "function already exists: $to"
320
	local from_def="$(declare -f "$from")"
321
	eval "$to${from_def#$from}"
322
}
323

    
324
func_override() # usage: func_override old_name__suffix
325
{ log++ echo_func; from="${1%__*}" to="$1" copy_func; }
326

    
327
ensure_nested_func() # usage: func__nested_func() { ensure_nested_func; ... }
328
{
329
	local nested_func="${FUNCNAME[1]}"
330
	local func="${nested_func%%__*}"
331
	contains "$func" "${FUNCNAME[@]}" || \
332
		die "$nested_func() must be used by $func()"
333
}
334

    
335

    
336
#### aliases
337

    
338
fi # load new aliases
339
if self_being_included; then
340

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

    
343
# usage: alias alias_='var=value run_cmd '
344
function run_cmd() { "$@"; }
345
alias run_cmd='"run_cmd" ' # last space alias-expands next word
346

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

    
349

    
350
#### commands
351

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

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

    
357
is_extern() { test "$(type -t -- "$1")" = file; }
358

    
359
is_intern() { is_callable "$1" && ! is_extern "$1"; }
360

    
361
is_dot_script()
362
{ log_local;log++; echo_func; test "${BASH_LINENO[${#BASH_LINENO[@]}-1]}" != 0;}
363

    
364
require_dot_script() # usage: require_dot_script || return
365
{
366
	echo_func
367
	if ! is_dot_script; then # was run without initial "."
368
		echo "usage: . $top_script (note initial \".\")"|fold -s >&2
369
		return 2
370
	fi
371
}
372

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

    
375
# makes command in $1 a system command
376
# allows running a system command of the same name as the script
377
alias cmd2sys="$(cat <<'EOF'
378
declare _1="$1"; shift
379
_1="$(indent; log++ sys_cmd_path "$_1")" || return
380
set -- "$_1" "$@"
381
EOF
382
)"
383

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

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

    
390
function sudo()
391
{
392
	echo_func
393
	if is_callable "$1"; then set -- env PATH="$PATH" "$@"; fi # preserve PATH
394
	self -E "$@"
395
}
396
alias sudo='"sudo" ' # last space alias-expands next word
397

    
398

    
399
#### exceptions
400

    
401
fi # load new aliases
402
if self_being_included; then
403

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

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

    
411
# usage: cmd || { save_e; ...; rethrow; }
412

    
413
alias export_e='e=$?'
414

    
415
# **WARNING**: if using this after a command that might succeed (rather than
416
# only upon error), you must `unset e` before the command
417
# idempotent: also works if save_e already called
418
alias save_e='# idempotent: use $e if the caller already called save_e
419
declare e_=$?;
420
declare e="$(if test "$e_" = 0; then echo "${e:-0}"; else echo "$e_"; fi)"'
421

    
422
rethrow() { errexit "${e:-0}"; } # only does anything if $e != 0
423
rethrow!() { rethrow && false; } # always errexit, even if $e = 0
424
rethrow_exit() { rethrow || exit; } # exit even where errexit disabled
425

    
426
is_err() { ! rethrow; } # rethrow->*false* if error
427

    
428
fi # load new aliases
429
if self_being_included; then
430

    
431
# usage: try cmd...; ignore_e status; if catch status; then ...; fi; \
432
# finally...; end_try
433

    
434
alias prep_try='declare e=0 benign_error="$benign_error"'
435

    
436
# usage: ...; try cmd... # *MUST* be at beginning of statement
437
#     OR prep_try; var=... "try" cmd...
438
function try() { benign_error=1 "$@" || { export_e; true; }; }
439
alias try='prep_try; "try" ' # last space alias-expands next word
440

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

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

    
445
alias end_try='rethrow'
446

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

    
449
### signals
450

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

    
453
func_override catch__exceptions
454
catch() # supports SIG* as exception type
455
{
456
	log_local; log++; echo_func
457
	if starts_with SIG "$1"; then set -- "$(sig_e "$1")"; fi
458
	catch__exceptions "$@"
459
}
460

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

    
465
fi # load new aliases
466
if self_being_included; then
467

    
468

    
469
#### text
470

    
471
nl='
472
'
473

    
474
# usage: by itself:                            split_lines  str; use ${lines[@]}
475
#        with wrapper: declare lines; wrapper "split_lines" str; use ${lines[@]}
476
function split_lines() { split "$nl" "$1"; lines=("${parts[@]}"); }
477
	# no echo_func because used by log++
478
alias split_lines='declare lines; "split_lines"'
479

    
480

    
481
#### terminal
482

    
483
### formatting
484

    
485
has_bg()
486
{
487
	# inverse (black background)/set background (normal colors)/set background
488
	# (bright colors) (xfree86.org/current/ctlseqs.html#Character_Attributes)
489
	starts_with 7 "$1" || starts_with 4 "$1" || starts_with 10 "$1"
490
}
491

    
492
format() # usage: format format_expr msg
493
# format_expr: the #s in xfree86.org/current/ctlseqs.html#Character_Attributes
494
{
495
	local format="$1" msg="$2"
496
	if starts_with '[' "$msg"; then format=; fi #don't add padding if formatted
497
	if has_bg "$format"; then msg=" $msg "; fi # auto-add padding if has bg
498
	echo "${format:+[0;${format}m}$msg${format:+}"
499
}
500

    
501
plain() { echo "$1"; }
502

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

    
505

    
506
#### paths
507

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

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

    
513
wildcard.() # usage: array=($(log++; [cd ...;] wildcard. unquoted_pattern...))
514
# currently only removes . .. at beginning of list
515
{
516
	set -- $(wildcard/ "$@") # first strip trailing /s
517
	local to_rm=(. ..)
518
	local item
519
	if contains "$1" "${to_rm[@]}"; then
520
		shift
521
		if contains "$1" "${to_rm[@]}"; then shift; fi
522
	fi
523
	esc "$@"
524
}
525

    
526
#### streams
527

    
528
pipe_delay() # usage: cmd1 | { pipe_delay; cmd2; }
529
{ sleep 0.1; } # s; display after leading output of cmd1
530

    
531

    
532
#### verbose output
533

    
534

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

    
537

    
538
### log++
539

    
540
log_fd=2 # initially stderr
541

    
542
if test "$explicit_errors_only"; then verbosity=0; fi # hide startup logging
543

    
544
# set verbosity
545
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
546
if isset vb; then : "${verbosity:=$vb}"; fi
547
: "${verbosity=1}" # default
548
: "${verbosity:=0}" # ensure non-empty
549
export verbosity # propagate to invoked commands
550

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

    
553
# set log_level
554
: "${log_level=$(( ${#PS4}-1 ))}" # defaults to # non-space symbols in PS4
555
export log_level # propagate to invoked commands
556
export PS4 # follows log_level, so also propagate this
557

    
558
verbosity_int() { round_down "$verbosity"; }
559

    
560
# verbosities (and `make` equivalents):
561
# 0: just print errors. useful for cron jobs.
562
#    vs. make: equivalent to --silent, but suppresses external command output
563
# 1: also external commands run. useful for running at the command line.
564
#    vs. make: not provided (but sorely needed to avoid excessive output)
565
# 2: full graphical call tree. useful for determining where error occurred.
566
#    vs. make: equivalent to default verbosity, but with much-needed indents
567
# 3: also values of kw params and variables. useful for low-level debugging.
568
#    vs. make: not provided; need to manually use $(error $(var))
569
# 4: also variables in util.sh commands. useful for debugging util.sh.
570
#    vs. make: somewhat similar to --print-data-base
571
# 5: also variables in logging commands themselves. useful for debugging echo_*.
572
#    vs. make: not provided; need to search Makefile for @ at beginning of cmd
573
# 6+: not currently used (i.e. same as 5)
574

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

    
580
fi # load new aliases
581
if self_being_included; then
582

    
583
# usage: in func:      log_local; log++; ...
584
#        outside func: log_local; log++; ...; log--
585
#        before cmd:   log++ cmd  OR  log+ num cmd  OR  log++ log++... cmd
586
# with a cmd, assignments are applied just to it, so log_local is not needed
587
# without a cmd, assignments are applied to caller ("$@" expands to nothing)
588
# "${@:2}" expands to all of $@ after *1st* arg, not 2nd ($@ indexes start at 1)
589
log:() # sets explicit log_level
590
{
591
	if test $# -gt 1; then log_local; fi # if cmd, only apply assignments to it
592
	# no local vars because w/o cmd, assignments should be applied to caller
593
	log_level="$1"
594
	PS4="$(str="${PS4:0:1}" n=$((log_level-1)) repeat)${PS4: -2}"
595
	"${@:2}"
596
}
597
log+() { log: $((log_level+$1)) "${@:2}"; }
598
log-() { log+ "-$1" "${@:2}"; }
599
# no log:/+/- alias needed because next word is not an alias-expandable cmd
600
function log++() { log+ 1 "$@"; }
601
function log--() { log- 1 "$@"; }
602
function log!() { log: 0 "$@"; } # force-displays next log message
603
# see aliases in stubs
604

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

    
610
# usage: (verbosity_compat; cmd)
611
function verbosity_compat()
612
{ log_local; log++; echo_func; if ((verbosity == 1)); then unset verbosity; fi;}
613
alias verbosity_compat='declare verbosity="$verbosity"; "verbosity_compat"'
614

    
615

    
616
# indent for call tree. this is *not* the log_level (below).
617
: "${log_indent_step=| }" "${log_indent=}"
618
export log_indent_step log_indent # propagate to invoked commands
619

    
620
# see indent alias in stubs
621

    
622

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

    
626
can_log() { test "$log_level" -le "$(verbosity_int)"; }
627
	# verbosity=0 turns off all logging
628

    
629
can_highlight_log_msg() { test "$log_level" -le 1; }
630

    
631
highlight_log_msg() # usage: [format=...] highlight_log_msg msg
632
# format: the # in xfree86.org/current/ctlseqs.html#Character_Attributes
633
{
634
	log_local; log+ 2; echo_func; kw_params format; log- 2
635
	local format="${format-1}" # bold
636
	if ! can_highlight_log_msg; then format=0; fi #remove surrounding formatting
637
	format "$format" "$1"
638
}
639

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

    
643
log_msg!()
644
{
645
	declare lines; log+ 2 "split_lines" "$1"
646
	local l; for l in "${lines[@]}"; do log_line! "$l"; done
647
}
648

    
649
log() { if can_log; then log_msg! "$@"; fi; }
650

    
651
log_custom() # usage: symbol=... log_custom msg
652
{ log_indent="${log_indent//[^ ]/$symbol}" PS4="${PS4//[^ ]/$symbol}" log "$@";}
653

    
654
bg_r='101;97' # red background with white text
655

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

    
658
log_info() { symbol=: log_custom "$@"; }
659

    
660
mk_hint() { format=7 highlight_log_msg "$@";}
661

    
662
log_err_hint!() { log_err "$(mk_hint "$@")"; }
663

    
664
log_err_hint() # usage: cmd || [benign_error=1] log_err_hint msg [|| handle err]
665
# msg only displayed if not benign error
666
{
667
	log++ kw_params benign_error
668
	if test ! "$benign_error"; then log_err_hint! "$@"; fi
669
}
670

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

    
675
die_e() # usage: cmd || [benign_error=1] die_e [|| handle error]
676
{
677
	save_e; log++ kw_params benign_error
678
	if test "$e" = "$(sig_e SIGPIPE)"; then benign_error=1; fi
679
	if test "$benign_error"; then log_local; log++; fi
680
	type="${benign_error:+info}" die "command exited with \
681
$(if test "$benign_error"; then echo status; else echo error; fi) $e"
682
	rethrow
683
}
684

    
685
die_error_hidden() # usage: cmd || verbosity_min=# die_error_hidden [|| ...]
686
{
687
	save_e; log++ echo_func; log++ kw_params verbosity_min
688
	: "${verbosity_min:?}"; log++ echo_vars verbosity
689
	if test "$(verbosity_int)" -lt "$verbosity_min"; then
690
		log_err_hint 'to see error details, prepend `vb='"$verbosity_min"'` to the command'
691
	fi
692
	rethrow
693
}
694

    
695

    
696
#### paths
697

    
698
# cache realpath
699
: "${realpath_cache=}" # default off because slower than without
700
if test "$realpath_cache"; then
701
func_override realpath__no_cache
702
realpath() # caches the last result for efficiency
703
{
704
	local cache_key="$*"; load_cache
705
	if ! cached; then save_cache "$(realpath__no_cache "$@")" || return; fi
706
	echo_cached_value
707
}
708
fi
709

    
710
rel_path() # usage: base_dir=... path=... rel_path
711
{
712
	log_local; log++; kw_params base_dir path
713
	: "${base_dir:?}" "${path:?}"
714
	
715
	local path="$path/" # add *extra* / to match path when exactly = base_dir
716
	path="${path#$base_dir/}" # remove prefix shared with base_dir
717
	path="${path%/}" # remove any remaining extra trailing /
718
	
719
	if test ! "$path"; then path=.; fi # ensure non-empty
720
	
721
	echo_vars path
722
	echo "$path"
723
}
724

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

    
728
canon_rel_path() # usage: [base_dir=...] canon_rel_path path
729
# falls back to original path if can't resolve
730
{
731
	kw_params base_dir; local path="$1" base_dir="${base_dir-$PWD}"
732
	canon_rel_path__try || echo "$path"
733
}
734
canon_rel_path__try()
735
{
736
	ensure_nested_func
737
	base_dir="$(realpath "$base_dir")" || return
738
	path="$(realpath "$path")" || return
739
	rel_path
740
}
741

    
742
canon_dir_rel_path() # usage: [base_dir=...] canon_dir_rel_path path
743
# if the path is a symlink, just its parent dir will be canonicalized
744
{
745
	kw_params base_dir; local base_dir="${base_dir-$PWD}"
746
	base_dir="$(realpath "$base_dir")" || return
747
	local path; path="$(realpath "$(dirname "$1")")/$(basename "$1")" || return
748
	rel_path
749
}
750

    
751
# makes $1 a canon_rel_path if it's a filesystem path
752
alias cmd2rel_path="$(cat <<'EOF'
753
if is_extern "$1" && test -e "$1"; then # not relative to PATH
754
	declare _1="$1"; shift
755
	_1="$(log++ canon_rel_path "$_1")" || return
756
	set -- "$_1" "$@"
757
fi
758
EOF
759
)"
760

    
761
# usage: path_parents path; use ${dirs[@]} # includes the path itself
762
function path_parents()
763
{
764
	echo_func; local path="$1" prev_path=; dirs=()
765
	while test "$path" != "$prev_path"; do
766
		prev_path="$path"
767
		dirs+=("$path")
768
		path="${path%/*}"
769
	done
770
}
771
alias path_parents='declare dirs; "path_parents"'
772

    
773

    
774
#### verbose output
775

    
776

    
777
### command echoing
778

    
779
alias echo_params='log "$*"'
780

    
781
fi # load new aliases
782
if self_being_included; then
783

    
784
echo_cmd() { echo_params; }
785

    
786
function echo_run() { echo_params; "$@"; }
787
# see echo_run alias after stub
788

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

    
791
echo_eval() { echo_params; builtin eval "$@"; }
792

    
793
## vars
794

    
795
echo_vars() # usage: echo_vars var... # also prints unset vars
796
{
797
	log_local; log++ # same log_level as echo_func
798
	if can_log; then
799
		local set_exprs= shared_flags=
800
		local var; for var in "${@%%=*}"; do
801
			if ! isset "$var"; then declare "$var"='<unset>'; fi
802
			
803
			# merge repeated flags
804
			local decl="$(declare -p "$var")"; decl="${decl#declare }"
805
			local flags="${decl%% *}" def="${decl#* }"
806
			if test ! "$shared_flags"; then shared_flags="$flags"; fi
807
			if test "$flags" != "$shared_flags"; then
808
				set_exprs="$set_exprs$flags "
809
			fi
810
			set_exprs="$set_exprs$def "
811
		done
812
		# put all vars on same line so they don't clutter up the logging output
813
		log "declare $shared_flags $set_exprs"
814
	fi
815
}
816

    
817
echo_export() { builtin export "$@"; echo_vars "$@"; }
818

    
819
alias export="echo_export" # automatically echo env vars when they are set
820

    
821
func_override kw_params__lang
822
kw_params() { kw_params__lang "$@"; echo_vars "$@"; } # echo all keyword params
823

    
824
## functions
825

    
826
# usage: func() { echo_func; ... }
827
function echo_func()
828
# usage: "echo_func" "$FUNCNAME" "$@" && indent || true
829
# exit status: whether function call was echoed
830
{
831
	log_local; log++; can_log || return
832
	local func="$1"; shift
833
	local loc; loc="$(log++ func_loc "$func")" || return
834
	echo_cmd "$func" "$@" "   $(plain "@$loc")"
835
}
836
# see echo_func alias after stub
837

    
838
fi # load new aliases
839
if self_being_included; then
840

    
841

    
842
#### fds
843

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

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

    
849
set_fds() # usage: set_fds redirect...
850
# WARNING: does not currently support redirecting an fd to itself (due to bash
851
# bug that requires the dest fd to be closed before it can be reopened)
852
{
853
	echo_func
854
	
855
	# add #<>&- before every #<>&# reopen to fix strange bash bug
856
	local redirs=() i
857
	for i in "$@"; do
858
		# remove empty redirects resulting from using `redirs= cmd...` to clear
859
		# the redirs and then using $redirs as an array
860
		if test "$i"; then
861
			local redir_prefix="$(match_prefix '*[<>]' "$i")"
862
			local dest="$(        rm_prefix    '*[<>]' "$i")"
863
			if test "$dest" && ! starts_with '&' "$dest"; then # escape dest
864
				i="$redir_prefix$(printf %q "$dest")"
865
			fi
866
			if test "$redir_prefix"; then redirs+=("$redir_prefix&-"); fi
867
			redirs+=("$i")
868
		fi
869
	done
870
	set -- "${redirs[@]}"
871
	
872
	if (($# > 0)); then echo_eval exec "$@"; fi
873
}
874

    
875
fd_set_default() # usage: fd_set_default 'dest[<>]src'
876
{
877
	echo_func
878
	local dest="${1%%[<>]*}"
879
	require_fd_not_exists "$dest" || return 0
880
	set_fds "$1"
881
}
882

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

    
888
stdlog=3
889

    
890
setup_log_fd() # view logging output at verbosity >= 5
891
{
892
	log_local; log+ 4; log-- echo_func 
893
	fd_set_default "$stdlog>&2" || true # set up stdlog
894
	log_fd="$stdlog" # don't change $log_fd until stdlog is set up
895
}
896
setup_log_fd
897

    
898
set_global_fds()
899
# allows commands to access global stdin/stdout/stderr using fd 20/21/22
900
# this works even when /dev/tty isn't available
901
# view logging output at verbosity >= 3
902
{
903
	log_local; log+ 2; log-- echo_func
904
	# ignore errors if a source fd isn't open
905
	fd_set_default '20<&0' || true
906
	fd_set_default '21>&1' || true
907
	fd_set_default '22>&2' || true
908
	debug_fd=22 # debug to global stderr in case stderr filtered
909
}
910
set_global_fds
911

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

    
919

    
920
log++ echo_vars is_outermost
921

    
922

    
923
#### paths
924

    
925
log++
926

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

    
930
top_symlink_dir="$(dirname "$top_script")"; echo_vars top_symlink_dir
931
top_symlink_dir_abs="$(realpath "$top_symlink_dir")"
932
	echo_vars top_symlink_dir_abs
933

    
934
top_script_abs="$(realpath "$top_script")"; echo_vars top_script_abs
935
	# realpath this before doing any cd so this points to the right place
936
top_dir_abs="$(dirname "$top_script_abs")"; echo_vars top_dir_abs
937

    
938
log--
939

    
940
set_paths()
941
{
942
	log_local; log++
943
	top_script="$(log++ canon_rel_path "$top_script_abs")" || return
944
		echo_vars top_script
945
	top_dir="$(dirname "$top_script")" || return; echo_vars top_dir
946
}
947
set_paths
948

    
949
# usage: $(enter_top_dir; cmd...)
950
function enter_top_dir() { echo_func; cd "$top_dir"; }
951
alias enter_top_dir='log++; "enter_top_dir"'
952

    
953
# usage: in_top_dir cmd...
954
function in_top_dir() { echo_func; (enter_top_dir; "$@"); }
955
alias in_top_dir='"in_top_dir" ' # last space alias-expands next word
956

    
957
PATH_rm() # usage: PATH_rm path... # removes components from the PATH
958
{
959
	echo_func; echo_vars PATH; : "${PATH?}"
960
	log_local
961
	log+ 2
962
	split : "$PATH"
963
	local new_paths=()
964
	for path in "${parts[@]}"; do
965
		if ! contains "$path" "$@"; then new_paths+=("$path"); fi
966
	done
967
	PATH="$(delim=: join "${new_paths[@]}")" || return
968
	log- 2
969
	echo_vars PATH
970
}
971

    
972
no_PATH_recursion() # usage: (no_PATH_recursion; cmd...)
973
# allows running a system command of the same name as the script
974
{
975
	echo_func
976
	PATH_rm "$top_dir_abs" "$top_symlink_dir" "$top_symlink_dir_abs" "$top_dir"
977
}
978

    
979
# makes command in $1 nonrecursive
980
# allows running a system command of the same name as the script
981
alias cmd2abs_path="$(cat <<'EOF'
982
declare _1="$1"; shift
983
_1="$(indent; no_PATH_recursion; log++; which "$_1"|echo_stdout)" || return
984
set -- "$_1" "$@"
985
EOF
986
)"
987

    
988

    
989
#### verbose output
990

    
991

    
992
## internal commands
993

    
994
.()
995
{
996
	log_local; log++; log++ echo_func
997
	cmd2rel_path; set -- "$FUNCNAME" "$@"
998
	if (log++; echo_params; can_log); then indent; fi
999
	builtin "$@"
1000
}
1001

    
1002
.rel() # usage: .rel file [args...] # file relative to ${BASH_SOURCE[0]} dir
1003
{
1004
	log++ log++ echo_func; local file="$1"; shift
1005
	. "$(canon_rel_path "$(dirname "$(realpath "${BASH_SOURCE[1]}")")/$file")" \
1006
"$@"
1007
}
1008

    
1009
cd() # usage: cd dir [path_var...] # path_vars will be rebased for the new dir
1010
# indent is permanent within subshell cd was used in
1011
{
1012
	log_local; log++ echo_func
1013
	local dir="$1"; shift
1014
	
1015
	# absolutize path_vars
1016
	for path_var in "$@"; do # must happen *before* cd to use correct currdir
1017
		set_var "$path_var" "$(realpath "${!path_var}")"
1018
	done
1019
	
1020
	# change dir
1021
	# -P: expand symlinks so $PWD matches the output of realpath
1022
	echo_run self_builtin -P "$dir"
1023
	if can_log; then caller_indent; fi
1024
	
1025
	func=realpath clear_cache
1026
	set_paths
1027
	
1028
	# re-relativize path_vars
1029
	for path_var in "$@"; do # must happen *after* cd to use correct currdir
1030
		set_var "$path_var" "$(canon_rel_path "${!path_var}")"
1031
	done
1032
}
1033

    
1034
## external commands
1035

    
1036
disable_logging() { set_fds "$log_fd>/dev/null"; }
1037

    
1038
# usage: redirs=(...); [cmd_name_log_inc=#] echo_redirs_cmd
1039
echo_redirs_cmd()
1040
{
1041
	local cmd_name_log_inc="${cmd_name_log_inc-0}"
1042
	
1043
	log++ echo_vars PATH
1044
	log+ "$cmd_name_log_inc" echo_cmd "$@" $(
1045
		# create redirs string
1046
		set -- "${redirs[@]}" # operate on ${redirs[@]}
1047
		while test "$#" -gt 0 && starts_with '[<>][^&]' "$1"
1048
		# print <>file redirs before cmd, because they introduce it
1049
		do log "$1 \\"; shift; done # log() will run *before* echo_cmd itself
1050
		echo "$@"
1051
	)
1052
}
1053

    
1054
function redir() # usage: local redirs=(#<>...); redir cmd...; unset redirs
1055
# to view only explicitly-displayed errors: explicit_errors_only=1 script...
1056
{
1057
	echo_func; kw_params redirs
1058
	
1059
	case "$1" in redir|command) "$@"; return;; esac # redir will be run later
1060
	(
1061
		log++ set_fds "${redirs[@]}"
1062
		unset redirs # don't redirect again in invoked command
1063
		(case "$1" in command__exec) shift;; esac; echo_redirs_cmd "$@")
1064
		if can_log; then indent; fi
1065
		"$@"
1066
	) || return
1067
}
1068
alias redir='"redir" ' # last space alias-expands next word
1069

    
1070
alias_append save_e '; unset redirs' # don't redirect error handlers
1071

    
1072
fi # load new aliases
1073
if self_being_included; then
1074

    
1075
command() # usage: [cmd_log_fd=|1|2|#] [verbosity_min=] [nonrecursive=1] \
1076
# command extern_cmd...
1077
{
1078
	echo_func; kw_params log_fd cmd_log_fd redirs verbosity_min
1079
	# if no cmd_log_fd, limit log_fd in case command uses util.sh
1080
	local cmd_log_fd="${cmd_log_fd-$log_fd}"
1081
	local redirs=("${redirs[@]}")
1082
	
1083
	# determine redirections
1084
	if test "$cmd_log_fd"; then
1085
		if can_log; then
1086
			if test "$cmd_log_fd" != "$log_fd"; then
1087
				redirs+=("$cmd_log_fd>&$log_fd")
1088
			fi # else no redir needed
1089
		else redirs+=("$cmd_log_fd>/dev/null");
1090
		fi
1091
	fi
1092
	
1093
	if test "$nonrecursive"; then cmd2abs_path; else cmd2rel_path; fi
1094
	redir command__exec "$@"
1095
}
1096
command__exec()
1097
{
1098
	ensure_nested_func
1099
	local verbosity_orig="$verbosity" # save for use in die_e
1100
	if test "$verbosity_min"; then verbosity_min "$verbosity_min"; fi
1101
	verbosity_compat
1102
	builtin command "$@" || { verbosity="$verbosity_orig"; die_e; }
1103
}
1104

    
1105

    
1106
### external command input/output
1107

    
1108
echo_stdin() # usage: input|echo_stdin|cmd
1109
{
1110
	if can_log; then
1111
		pipe_delay
1112
		echo ----- >&"$log_fd"
1113
		tee -a /dev/fd/"$log_fd";
1114
		echo ----- >&"$log_fd"
1115
	else cat
1116
	fi
1117
}
1118

    
1119
echo_stdout() { echo_stdin; } # usage: cmd|echo_stdout
1120

    
1121
stdout2fd() # usage: fd=# stdout2fd cmd...
1122
{
1123
	echo_func; kw_params fd; : "${fd?}"
1124
	if test "$fd" != 1; then local redirs=(">&$fd" "${redirs[@]}"); fi
1125
	redir "$@"
1126
}
1127

    
1128
function filter_fd() # usage: (fd=# [redirs=] filter_fd filter_cmd...; \
1129
# with filter...) # be sure ${redirs[@]} is not set to an outer value
1130
# useful e.g. to filter logging output or highlight errors
1131
{
1132
	echo_func; kw_params fd; : "${fd?}"
1133
	set_fds "$fd>" >(pipe_delay; stdout2fd "$@")
1134
	pipe_delay; pipe_delay # wait for >()'s pipe_delay and initial logging
1135
}
1136
alias filter_fd='"filter_fd" ' # last space alias-expands next word
1137

    
1138
stderr2stdout() # usage: { stderr2stdout cmd...|use stderr...; } 41>&1
1139
# **IMPORTANT**: fd 41 must later be redirected back to fd 1
1140
# unlike `2>&1`, keeps stderr going to stderr
1141
# redirects the command stdout to fd 41 to avoid collision with stderr
1142
{
1143
	echo_func
1144
	# fd 2 *must* be redirected back to fd 2, not log-filtered, in case there
1145
	# are other errors in addition to the benign error
1146
	piped_cmd "$@" 2> >(log++ echo_run tee /dev/fd/2) >&41 # redirects 2->{1,2}
1147
}
1148

    
1149
stdout_contains()
1150
# usage: { stderr2stdout cmd|stdout_contains echo_run grep ...; } 41>&1
1151
{
1152
	log_local; log++; echo_func
1153
	pipe_delay; pipe_delay; pipe_delay; "$@"|echo_stdout >/dev/null
1154
}
1155

    
1156
stderr_matches() # usage: pattern=... [ignore_e=# [benign_error=1]] \
1157
# stderr_matches cmd...
1158
{
1159
	echo_func; kw_params pattern ignore_e; : "${pattern?}"
1160
	
1161
	# not necessary to allow callers to handle the error themselves (which would
1162
	# require *every* caller to wrap this function in prep_try/rethrow), because
1163
	# they would just handle it by errexiting anyways
1164
	prep_try
1165
	
1166
	set +o errexit # avoid errexiting since @PIPESTATUS will be used instead
1167
	{ benign_error=1 stderr2stdout "$@"\
1168
|stdout_contains echo_run grep -E "$pattern"; } 41>&1
1169
		# benign_error: handle exit status logging in this func instead
1170
	local PIPESTATUS_=("${PIPESTATUS[@]}") # save b/c it's reset after each cmd
1171
	echo_vars PIPESTATUS_
1172
	set -o errexit
1173
	
1174
	# handle any command error
1175
	e="${PIPESTATUS_[0]}"
1176
	local matches="$(errexit "${PIPESTATUS_[1]}"; exit2bool)"
1177
	if test "$matches"; then ignore_e "$ignore_e" #also works w/ ignore_e=''
1178
	elif is_err && test ! "$benign_error"; then die_e # incorrectly suppressed
1179
	fi
1180
	rethrow_exit #force-exit b/c caller's test of return status disables errexit
1181
	
1182
	# handle any filter error
1183
	e="${PIPESTATUS_[1]}"
1184
	ignore_e 1 # false is not an error
1185
	# all other unsuccessful exit statuses are errors
1186
	rethrow_exit #force-exit b/c caller's test of return status disables errexit
1187
	
1188
	return "${PIPESTATUS_[1]}" # 2nd command's exit status -> $?
1189
}
1190

    
1191
fi # load new aliases
1192
if self_being_included; then
1193

    
1194
function ignore_err_msg() # usage: pattern=... [ignore_e=#] ignore_err_msg cmd
1195
# unlike `|| true`, this suppresses only errors caused by a particular error
1196
# *message*, rather than all error exit statuses
1197
{
1198
	echo_func; kw_params pattern; : "${pattern?}"
1199
	stderr_matches "$@" || true # also ignore false exit status on no match
1200
}
1201
alias ignore_err_msg='"ignore_err_msg" ' # last space alias-expands next word
1202

    
1203

    
1204
#### commands
1205

    
1206
already_exists_msg() # usage: cond || what=... already_exists_msg || return 0
1207
{
1208
	save_e # needed because $(mk_hint) resets $?
1209
	type=info die "$what already exists, skipping
1210
$(mk_hint 'to force-remake, prepend `rm=1` to the command')"
1211
}
1212

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

    
1216
function to_file() # usage: stdout=... [if_not_exists=1] [del=] to_file cmd...
1217
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
1218
{
1219
	echo_func; kw_params stdout if_not_exists del
1220
	: "${stdout?}"; local del="${del-1}"
1221
	if test "$if_not_exists"; then require_not_exists "$stdout" || return 0; fi
1222
	
1223
	local redirs=("${redirs[@]}" ">$stdout")
1224
	redir "$@" || { save_e; test ! "$del" || rm "$stdout"; rethrow; }
1225
}
1226
alias to_file='"to_file" ' # last space alias-expands next word
1227

    
1228
log_bg() { symbol='&' log_custom "$@"; }
1229

    
1230
log_last_bg() { log_bg '$!='"$!"; }
1231

    
1232
function bg_cmd() # usage: bg_cmd cmd...
1233
{ echo_func; log_bg "$@"; "$@" & log_last_bg; }
1234
alias bg_cmd='"bg_cmd" ' # last space alias-expands next word
1235

    
1236

    
1237
#### filesystem
1238

    
1239
could_be_glob() { echo_func; contains_match '\*' "$1"; }
1240

    
1241
is_dir() { echo_func; test -d "$1"; }
1242

    
1243
could_be_dir() { echo_func; ends_with / "$1" || is_dir "$1"; }
1244

    
1245
is_file() { echo_func; test -f "$1"; }
1246

    
1247
could_be_file()
1248
{ echo_func; { ! could_be_dir "$1" && ! could_be_glob "$1";} || is_file "$1"; }
1249

    
1250
alias mkdir='mkdir -p'
1251
alias cp='cp -p'
1252

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

    
1256
alias wildcard='shopt -s nullglob; echo' # usage: "$(wildcard glob...)"
1257
alias wildcard1='shopt -s nullglob; echo1' # usage: "$(wildcard1 glob...)"
1258

    
1259
fi # load new aliases
1260
if self_being_included; then
1261

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

    
1264
# usage: (mv_glob ... dir)
1265
function mv_glob() { echo_func; if (($# > 1)); then mv2dir "$@"; fi; }
1266
alias mv_glob='shopt -s nullglob; "mv_glob"'
1267

    
1268
### permissions
1269

    
1270
has_perms() # usage: perms=... has_perms item # perms: use find's -perm format
1271
{
1272
	echo_func; kw_params perms; : "${perms:?}"
1273
	test "$(find "$1" -maxdepth 0 -perm "$perms")"
1274
}
1275

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

    
1278

    
1279
#### URLs
1280

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

    
1283
fi
(10-10/11)