Project

General

Profile

1
#!/bin/bash -e
2
set -o errexit # in case caller did not have -e in #! line
3

    
4
if test ! "$_util_sh_include_guard_utils"; then
5
_util_sh_include_guard_utils=1
6

    
7
isset() { test "${!1+isset}"; }
8

    
9
realpath() { readlink -f -- "$1"; }
10

    
11
include_guard_var() { realpath "$1"|"command" sed 's/[^a-zA-Z0-9_]/_/g'; }
12

    
13
self_not_included() # usage: if self_not_included; then ... fi
14
{
15
	test $# -ge 1 || set -- "${BASH_SOURCE[1]}"
16
	local include_guard="$(include_guard_var "$1")"
17
	alias self_being_included=false
18
	! isset "$include_guard" && \
19
	{ eval "$include_guard"=1; alias self_being_included=true; }
20
}
21

    
22
# to load newly-defined aliases for use in functions in the same file:
23
## fi # load new aliases
24
## if self_being_included; then
25
# this is needed because aliases defined inside an if statement are not
26
# available inside that if statement
27

    
28
fi
29

    
30

    
31
if self_not_included "${BASH_SOURCE[0]}"; then
32

    
33

    
34
#### options
35

    
36
shopt -s expand_aliases
37

    
38

    
39
#### aliases
40

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

    
43

    
44
#### functions
45

    
46
alias self='command "$FUNCNAME"' # usage: wrapper() { self ...; }
47

    
48

    
49
#### exceptions
50

    
51
# usage: cmd || { save_e; ...; rethrow; }
52
alias export_e='e=$?'
53
alias save_e='declare e=$?'
54
alias rethrow='return "$e"'
55
alias rethrow_subshell='exit "$e"'
56

    
57
fi # load new aliases
58
if self_being_included; then
59

    
60
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
61

    
62
function try() { e=0; "$@" || { export_e; true; }; }
63
alias try='declare e; try ' # last space alias-expands next word
64

    
65
catch() { test "$e" -eq "$1"; e=0; }
66

    
67
ignore() { catch "$@" || true; }
68

    
69
alias end_try='rethrow'
70
alias end_try_subshell='rethrow_subshell'
71

    
72
fi # load new aliases
73
if self_being_included; then
74

    
75

    
76
#### integers
77

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

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

    
83

    
84
#### strings
85

    
86
repeat() # usage: str=... n=... repeat
87
{
88
	: "${str?}" "${n:?}"; local n="$n" # will be modified in function
89
	for (( ; n > 0; n-- )); do printf '%q' "$str"; done
90
}
91

    
92
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
93

    
94
sed() { self -"$sed_ere_flag" "$@";}
95

    
96
rtrim() { sed 's/[[:space:]]+$//' <<<"$1"; }
97

    
98

    
99
#### arrays
100

    
101
join() { local IFS="$delim"; echo "$*"; } # usage: delim=... join elems...
102

    
103
reverse() # usage: array=($(reverse args...))
104
{
105
	local i
106
	for (( i=$#; i > 0; i-- )); do printf '%q ' "${!i}"; done
107
}
108

    
109

    
110
#### paths
111

    
112
canon_rel_path()
113
{
114
	local path="$1"
115
	path="$(realpath "$path")" # canonicalize
116
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
117
	echo "$path"
118
}
119

    
120
# makes $1 a canon_rel_path if it's a filesystem path
121
alias cmd2rel_path="$(cat <<'EOF'
122
if test "$(type -t "$1")" = file && test -e "$1"; then # not relative to PATH
123
	declare _1="$1"; shift
124
	set -- "$(canon_rel_path "$_1")" "$@"
125
fi
126
EOF
127
)"
128

    
129

    
130
#### verbose output
131

    
132
# usage: (stdout2stderr; cmd...) || return
133
# `|| return` needed on Mac because of bug where -e doesn't apply to()
134
stdout2stderr() { exec >&2; }
135

    
136
# set verbosity
137
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
138
: "${verbosity=3}" # default
139
: "${verbosity:=0}" # ensure non-empty
140
declare -i verbosity # ensure integer
141
export PS4 verbosity # propagate indent and verbosity to invoked commands
142

    
143
can_log() { test "$verbosity" -gt 0; } # verbosity=0 turns off all logging
144

    
145
log() { if can_log; then echo "$PS4$1" >&2; fi; }
146

    
147
# usage: symbol=... log_custom msg
148
log_custom() { local PS4="${PS4%[^ ] }$symbol "; log "$@"; }
149

    
150
log_err() { symbol=! log_custom "$@"; }
151

    
152
log_info() { symbol=? log_custom "$@"; }
153

    
154
# usage: cmd || { save_e; log_e; ...; rethrow; }
155
log_e() { log_err "command exited with error $e"; }
156

    
157
# usage: cmd || [type=...] die msg
158
die() { save_e; "log_${type:-err}" "$1"; rethrow; }
159

    
160
: "${log_indent=  }"
161

    
162
# usage: in func:      indent; ...
163
#        outside func: indent; ...; outdent
164
alias indent='declare PS4="$log_indent$PS4"'
165
alias outdent='declare PS4="${PS4#$log_indent}"'
166

    
167
# usage: in func:      inc_log_level; ...
168
#        outside func: inc_log_level; ...; dec_log_level
169
alias inc_log_level='indent;  declare verbosity="$verbosity"; let! verbosity--'
170
alias dec_log_level='outdent; declare verbosity="$verbosity"; let! verbosity++'
171

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

    
175
echo_cmd()
176
{
177
	case "$1" in command) shift;; esac # command implied by the log_level
178
	log "$*"
179
}
180

    
181
echo_run() { cmd2rel_path; echo_cmd "$@"; indent; "$@"; }
182

    
183
# usage: (limit_stderr; cmd...) || return
184
# `|| return` needed on Mac because of bug where -e doesn't apply to()
185
limit_stderr() { inc_log_level; if ! can_log; then exec 2>/dev/null; fi; }
186

    
187
limit_stderr_cmd() # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
188
{
189
	case "$1" in echo_run) shift; cmd2rel_path; echo_cmd "$@";; esac
190
	(limit_stderr
191
		if test "$stdout2stderr"; then stdout2stderr; fi
192
		indent; "$@"
193
	) || return
194
}
195
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
196

    
197
# auto-echo common external commands
198
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
199

    
200
# echo all external commands
201
alias command="echo_run command " # last space alias-expands next word
202

    
203
# commands that are always external
204
for cmd in env; do alias "$cmd=command $cmd"; done; unset cmd
205

    
206
function echo_func()
207
{
208
	inc_log_level
209
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
210
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
211
}
212
alias echo_func='echo_func "$@"'
213

    
214
# usage: cmd1 | { pipe_delay; cmd2; }
215
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
216

    
217
fi # load new aliases
218
if self_being_included; then
219

    
220
echo_stdin() # usage: input|echo_stdin|cmd
221
{
222
	inc_log_level
223
	if can_log; then
224
		pipe_delay
225
		echo ----- >&2
226
		tee -a /dev/stderr;
227
		echo ----- >&2
228
	else cat
229
	fi
230
}
231

    
232
alias echo_stdout='echo_stdin' # usage: cmd|echo_stdout
233

    
234
echo_vars() # usage: echo_vars var...
235
{
236
	inc_log_level; inc_log_level
237
	if can_log; then
238
		local var
239
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
240
	fi
241
}
242

    
243
echo_export() { builtin export "$@"; echo_vars "$@"; }
244

    
245
if test "$verbosity" -ge 2; then
246
	alias export="echo_export" # automatically echo env vars when they are set
247
fi
248

    
249
usage() { echo "Usage: $1" >&2; (exit 2); }
250

    
251
fi # load new aliases
252
if self_being_included; then
253

    
254

    
255
#### vars
256

    
257
set_var() { eval "$1"'="$2"'; }
258

    
259
set_inv() { set_var no_"$1" "$(test "${!1}" || echo 1)"; }
260

    
261
# usage: local var=...; local_inv
262
alias local_inv='declare "no_$var=$(test "${!var}" || echo 1)"'
263

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

    
266
# usage: local prefix=..._; import_vars
267
alias import_vars="$(cat <<'EOF'
268
: "${prefix:?}"
269
declare src_var dest_var
270
for src_var in $(get_prefix_vars); do
271
	dest_var="${src_var#$prefix}"
272
	declare "$dest_var=${!src_var}"; echo_vars "$dest_var"
273
done
274
EOF
275
)"
276

    
277

    
278
#### functions
279

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

    
282
copy_func() # usage: from=... to=... copy_func
283
# $to must not exist. to get around the no-clobber restriction, use `unset -f`.
284
{
285
	: "${from:?}" "${to:?}"
286
	func_exists "$from" || die "function does not exist: $from"
287
	! func_exists "$to" || die "function already exists: $to"
288
	local from_def="$(declare -f "$from")"
289
	eval "$to${from_def#$from}"
290
}
291

    
292
func_override() # usage: func_override old_name__suffix
293
{ from="${1%%__*}" to="$1" copy_func; }
294

    
295

    
296
#### commands
297

    
298
top_script="$0" # outermost script
299
top_dir="$(dirname "$top_script")"
300

    
301
require_exists() # usage: require_exists file || return 0
302
{ test ! -e "$1" || type=info die "file "$1" already exists, skipping"; }
303

    
304
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
305
function to_file() # usage: stdout=... [if_not_exists=1] to_file cmd...
306
{
307
	echo_func
308
	: "${stdout?}"; echo_vars stdout
309
	test ! "$if_not_exists" || require_exists "$stdout" || return 0
310
	"$@" >"$stdout" || { save_e; log_e; rm "$stdout"; rethrow; }
311
}
312
alias to_file='to_file ' # last space alias-expands next word
313

    
314
run_args_cmd() # runs the command line args command
315
{
316
	test $? -eq 0 || return
317
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
318
	test $# -ge 1 || set -- all
319
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
320
}
321

    
322
fwd() # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
323
{
324
	echo_func
325
	: "${subdirs?}"
326
	
327
	for subdir in "${subdirs[@]}"; do
328
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
329
	done
330
}
331

    
332

    
333
#### URLs
334

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

    
337
fi
(5-5/5)