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
function extern () { (exec "$@") || return; }
8

    
9
isset () { test -n "${!1+isset}"; }
10

    
11
realpath () { readlink -f -- "$1"; }
12

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

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

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

    
30
fi
31

    
32

    
33
if self_not_included "${BASH_SOURCE[0]}"; then
34

    
35

    
36
#### options
37

    
38
shopt -s expand_aliases
39

    
40

    
41
#### aliases
42

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

    
45

    
46
#### exceptions
47

    
48
# usage: cmd || { export_e; ...; rethrow; }
49
alias export_e='e=$?'
50
alias rethrow='return "$e"'
51
alias rethrow_subshell='exit "$e"'
52

    
53
fi # load new aliases
54
if self_being_included; then
55

    
56
function log_e () # usage: log_e cmd... [ || use $e (or $?) ]
57
{
58
	if "$@"; then :; else # don't use ! because that resets $?
59
		export_e
60
		echo "! $*" >&2
61
		echo "! command exited with error $e" >&2
62
		rethrow
63
	fi
64
}
65
alias log_e='declare e; log_e ' # last space alias-expands next word
66

    
67
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
68

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

    
72
catch () { test "$e" -eq "$1"; e=0; }
73

    
74
ignore () { catch "$@" || true; }
75

    
76
alias end_try='rethrow'
77
alias end_try_subshell='rethrow_subshell'
78

    
79
fi # load new aliases
80
if self_being_included; then
81

    
82

    
83
#### functions
84

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

    
87
copy_func () # usage: from=... to=... copy_func
88
{
89
	: "${from:?}" "${to:?}"
90
	local from_def="$(declare -f "$from")"
91
	eval "$to${from_def#$from}"
92
}
93

    
94

    
95
#### integers
96

    
97
let () { builtin let "$@" || true; }
98
	# "If the last ARG evaluates to 0, let returns 1" (`help let`)
99

    
100
bool2int () { try test -z "$1"; echo "$e"; } # empty->0; non-empty->1
101

    
102

    
103
#### arrays
104

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

    
107
reverse () # usage: array=($(reverse args...))
108
{
109
	local i
110
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
111
}
112

    
113

    
114
#### verbose output
115

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

    
120
# set verbosity
121
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
122
: "${verbosity=3}" # default
123
: "${verbosity:=0}" # ensure non-empty
124
declare -i verbosity # ensure integer
125
export verbosity # propagate the verbosity to invoked commands
126

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

    
129
: "${log_indent=  }"
130

    
131
# usage: in func:      inc_log_level; ...
132
#        outside func: inc_log_level; ...; dec_log_level
133
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
134
let verbosity--'
135
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
136
let verbosity++'
137

    
138
fi # load new aliases
139
if self_being_included; then
140

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

    
145
limit_stderr_cmd () # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
146
{
147
	case "$1" in echo_run) shift; echo_cmd "$@";; esac
148
	(limit_stderr
149
		if test -n "$stdout2stderr"; then stdout2stderr; fi
150
		"$@"
151
	) || return
152
}
153
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
154

    
155
echo_cmd () { if can_log; then echo "$PS4$*" >&2; fi; }
156

    
157
echo_run () { echo_cmd "$@"; "$@"; }
158

    
159
# auto-echo common external commands
160
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
161

    
162
# echo all external commands
163
alias extern="echo_run extern " # last space alias-expands next word
164

    
165
alias self='extern "$FUNCNAME"' # usage: wrapper () { self ...; }
166

    
167
# commands that are always external
168
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
169

    
170
canon_rel_path ()
171
{
172
	local path="$1"
173
	path="$(realpath "$path")" # canonicalize
174
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
175
	echo "$path"
176
}
177

    
178
function echo_func ()
179
{
180
	inc_log_level
181
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
182
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
183
}
184

    
185
# usage: cmd1 | { pipe_delay; cmd2; }
186
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
187

    
188
fi # load new aliases
189
if self_being_included; then
190

    
191
echo_stdin () # usage: input|echo_stdin|cmd
192
{
193
	inc_log_level
194
	if can_log; then
195
		pipe_delay
196
		echo ----- >&2
197
		tee -a /dev/stderr;
198
		echo ----- >&2
199
	else cat
200
	fi
201
}
202

    
203
echo_vars () # usage: echo_vars var...
204
{
205
	inc_log_level; inc_log_level
206
	if can_log; then
207
		local var
208
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
209
	fi
210
}
211

    
212
echo_export () { builtin export "$@"; echo_vars "$@"; }
213

    
214
if test "$verbosity" -ge 2; then
215
	alias export="echo_export" # automatically echo env vars when they are set
216
fi
217

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

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

    
223

    
224
#### strings
225

    
226
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
227

    
228
sed () { self -"$sed_ere_flag" "$@";}
229

    
230

    
231
#### vars
232

    
233
set_var () { eval "$1"'="$2"'; }
234

    
235
set_inv () { set_var no_"$1" "$(test -n "${!1}" || echo 1)"; }
236

    
237
# usage: local var=...; local_inv
238
alias local_inv='declare "no_$var=$(test -n "${!var}" || echo 1)"'
239

    
240
# usage: local prefix=..._; import_vars
241
alias import_vars="$(cat <<'EOF'
242
: "${prefix:?}"
243
local src_var dest_var
244
for src_var in $(eval echo '${!'$prefix'*}'); do
245
	dest_var="${src_var#$prefix}"
246
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
247
done
248
EOF
249
)"
250

    
251

    
252
#### commands
253

    
254
top_script="$0" # outermost script
255
top_dir="$(dirname "$top_script")"
256

    
257
# auto-removes a command's output file on error (like make's .DELETE_ON_ERROR)
258
function to_file () # usage: stdout=... to_file cmd...
259
{ : "${stdout?}"; log_e "$@" >"$stdout" || { rm "$stdout"; rethrow; }; }
260
alias to_file='to_file ' # last space alias-expands next word
261

    
262
run_args_cmd () # runs the command line args command
263
{
264
	test $? -eq 0 || return
265
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
266
	test $# -ge 1 || set -- all
267
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
268
}
269

    
270
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
271
{
272
	echo_func
273
	: "${subdirs?}"
274
	
275
	for subdir in "${subdirs[@]}"; do
276
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
277
	done
278
}
279

    
280

    
281
#### URLs
282

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

    
285
fi
(5-5/5)