Project

General

Profile

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

    
4
function extern () { (exec "$@") || return; }
5

    
6
isset () { test -n "${!1+isset}"; }
7

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

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

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

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

    
27
if self_not_included "${BASH_SOURCE[0]}"; then
28

    
29
shopt -s expand_aliases
30

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

    
33
#### exceptions
34

    
35
alias rethrow='return "$e"'
36
alias rethrow_subshell='exit "$e"'
37

    
38
fi # load new aliases
39
if self_being_included; then
40

    
41
# usage: save_e cmd... || use $e (or $?)
42
function save_e () { "$@"; e=$?; rethrow; } # rethrow because e= clears $?
43
alias save_e='declare e; save_e ' # last space alias-expands next word
44

    
45
function log_e () # usage: log_e cmd... [ || use $e (or $?) ]
46
{
47
	if ! "save_e" "$@"; then
48
		echo "! $*" >&2
49
		echo "! command exited with error $e" >&2
50
		rethrow
51
	fi
52
}
53
alias log_e='declare e; log_e ' # last space alias-expands next word
54

    
55
# usage: try cmd...; ignore status; if catch status; then ...; fi; end_try
56

    
57
function try () { "save_e" "$@" || true; }
58
alias try='declare e; try ' # last space alias-expands next word
59

    
60
catch () { test "$e" -eq "$1"; e=0; }
61

    
62
ignore () { catch "$@" || true; }
63

    
64
alias end_try='rethrow'
65
alias end_try_subshell='rethrow_subshell'
66

    
67
#### integers
68

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

    
72
bool2int () { save_e test -z "$1"; echo "$e"; } # empty->0; non-empty->1
73

    
74
#### arrays
75

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

    
78
reverse () # usage: array=($(reverse args...))
79
{
80
	local i
81
	for (( i=$#; i >= 1; i-- )); do printf '%q ' "${!i}"; done
82
}
83

    
84
#### verbose output
85

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

    
90
# set verbosity
91
if isset verbose; then : "${verbosity:=$(bool2int "$verbose")}"; fi
92
: "${verbosity=3}" # default
93
: "${verbosity:=0}" # ensure non-empty
94
declare -i verbosity # ensure integer
95
export verbosity # propagate the verbosity to invoked commands
96

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

    
99
: "${log_indent=  }"
100

    
101
# usage: in func:      inc_log_level; ...
102
#        outside func: inc_log_level; ...; dec_log_level
103
alias inc_log_level='declare verbosity="$verbosity" PS4="$log_indent$PS4"
104
let verbosity--'
105
alias dec_log_level='declare verbosity="$verbosity" PS4="${PS4#$log_indent}"
106
let verbosity++'
107

    
108
fi # load new aliases
109
if self_being_included; then
110

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

    
115
limit_stderr_cmd () # usage: [stdout2stderr=1] limit_stderr_cmd cmd...
116
{
117
	case "$1" in echo_run) shift; echo_cmd "$@";; esac
118
	(limit_stderr
119
		if test -n "$stdout2stderr"; then stdout2stderr; fi
120
		"$@"
121
	) || return
122
}
123
alias limit_stderr_cmd='limit_stderr_cmd ' # last space alias-expands next word
124

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

    
127
echo_run () { echo_cmd "$@"; "$@"; }
128

    
129
# auto-echo common external commands
130
for cmd in rm; do alias "$cmd=echo_run $cmd"; done; unset cmd
131

    
132
# echo all external commands
133
alias extern="echo_run extern " # last space alias-expands next word
134

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

    
137
# commands that are always external
138
for cmd in env; do alias "$cmd=extern $cmd"; done; unset cmd
139

    
140
canon_rel_path ()
141
{
142
	local path="$1"
143
	path="$(realpath "$path")" # canonicalize
144
	path="${path#$(pwd -P)/}" # remove any shared prefix with the current dir
145
	echo "$path"
146
}
147

    
148
fi # load new aliases
149
if self_being_included; then
150

    
151
function echo_func ()
152
{
153
	inc_log_level
154
	local script="$(canon_rel_path "${BASH_SOURCE[1]}")"
155
	echo_cmd "$script:${BASH_LINENO[0]}" "${FUNCNAME[1]}" "$@"
156
}
157

    
158
# usage: cmd1 | { pipe_delay; cmd2; }
159
alias pipe_delay='sleep 0.1' # s; display after leading output of cmd1
160

    
161
fi # load new aliases
162
if self_being_included; then
163

    
164
echo_stdin () # usage: input|echo_stdin|cmd
165
{
166
	inc_log_level
167
	if can_log; then
168
		pipe_delay
169
		echo ----- >&2
170
		tee -a /dev/stderr;
171
		echo ----- >&2
172
	else cat
173
	fi
174
}
175

    
176
echo_vars () # usage: echo_vars var...
177
{
178
	inc_log_level; inc_log_level
179
	if can_log; then
180
		local var
181
		for var in "${@%%=*}"; do { echo -n "$PS4"; declare -p "$var";} >&2;done
182
	fi
183
}
184

    
185
echo_export ()
186
{
187
	builtin export "$@"
188
	echo_vars "$@"
189
}
190

    
191
if test "$verbosity" -ge 2; then
192
	alias export="echo_export" # automatically echo env vars when they are set
193
fi
194

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

    
197
fi # load new aliases
198
if self_being_included; then
199

    
200
#### strings
201

    
202
sed_ere_flag="$(test "$(uname)" = Darwin && echo E || echo r)"
203

    
204
sed () { self -"$sed_ere_flag" "$@";}
205

    
206
#### vars
207

    
208
set_var () { eval "$1"'="$2"'; }
209

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

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

    
215
# usage: local prefix=..._; import_vars
216
alias import_vars="$(cat <<'EOF'
217
: "${prefix:?}"
218
local src_var dest_var
219
for src_var in $(eval echo '${!'$prefix'*}'); do
220
	dest_var="${src_var#$prefix}"
221
	local "$dest_var=${!src_var}"; echo_vars "$dest_var"
222
done
223
EOF
224
)"
225

    
226
#### commands
227

    
228
top_script="$0" # outermost script
229
top_dir="$(dirname "$top_script")"
230

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

    
236
run_args_cmd () # runs the command line args command
237
{
238
	test $? -eq 0 || return
239
	eval set -- "$(reverse "${BASH_ARGV[@]}")"
240
	test $# -ge 1 || set -- all
241
	echo_cmd "$(canon_rel_path "$0")" "$@"; "$@"
242
}
243

    
244
fwd () # usage: subdirs=(...); fwd "$FUNCNAME" "$@"
245
{
246
	echo_func
247
	: "${subdirs?}"
248
	
249
	for subdir in "${subdirs[@]}"; do
250
		"$(dirname "${BASH_SOURCE[1]}")"/"$subdir"/run "$@"
251
	done
252
}
253

    
254
#### make
255

    
256
# usage: target_filename/command () { echo_func; set_make_vars; ...; }
257
alias set_make_vars="$(cat <<'EOF'
258
local command="${FUNCNAME##*/}"; echo_vars command
259
local target_filename="${FUNCNAME%/*}"; echo_vars target_filename
260
local target="$top_dir/$target_filename"; echo_vars target
261
EOF
262
)"
263

    
264
# usage: set_make_vars; check_target_exists
265
alias check_target_exists='! test -e "$target" || return 0'
266

    
267
# usage: set_make_vars; to_target cmd...
268
alias to_target='stdout="$target" to_file ' # last space alias-expands next word
269

    
270
make () { echo_func; stdout2stderr=1 limit_stderr_cmd self "$@"; }
271

    
272
if false; then ## usage:
273
inline_make 3<<'EOF'
274
target:
275
	$(self_dir)/cmd >$@
276
EOF
277
# target will be run automatically because it's first in the makefile
278
fi ##
279
inline_make ()
280
{
281
	echo_func
282
	local self="$(readlink -f "${BASH_SOURCE[1]}")"
283
	local self_dir="$(dirname "$self")"
284
	export self self_dir
285
	
286
	make --makefile=<((
287
		cat /dev/fd/3
288
		echo -n "
289
.SUFFIXES: # turn off built-in suffix rules
290
.SECONDARY: # don't automatically delete intermediate files
291
.DELETE_ON_ERROR: # delete target if recipe fails
292
"
293
	)|echo_stdin) "$@"
294
}
295

    
296
#### compression
297

    
298
### zip
299

    
300
zip ()
301
{
302
	stdout2stderr=1 try limit_stderr_cmd self "$@"
303
	ignore 12 # "zip has nothing to do" (`man zip`)
304
	end_try
305
}
306

    
307
unzip () { stdout2stderr=1 limit_stderr_cmd self "$@"; }
308

    
309
set_inv force
310
alias zip_newer='zip ${no_force:+-u }'
311
alias unzip_newer='unzip ${no_force:+-u }-o'
312
	# -o is safe because -u only extracts newer files
313

    
314
#### URLs
315

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

    
318
fi
(3-3/3)