3 # This file must be sourced in sh:
5 # . `which env_parallel.sh`
7 # after which 'env_parallel' works
10 # Copyright (C) 2016-2021 Ole Tange, http://ole.tange.dk and Free
11 # Software Foundation, Inc.
13 # This program is free software; you can redistribute it and/or modify
14 # it under the terms of the GNU General Public License as published by
15 # the Free Software Foundation; either version 3 of the License, or
16 # (at your option) any later version.
18 # This program is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 # General Public License for more details.
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, see <http://www.gnu.org/licenses/>
25 # or write to the Free Software Foundation, Inc., 51 Franklin St,
26 # Fifth Floor, Boston, MA 02110-1301 USA
28 # SPDX-FileCopyrightText: 2021 Ole Tange, http://ole.tange.dk and Free Software and Foundation, Inc.
29 # SPDX-License-Identifier: GPL-3.0-or-later
30 # shellcheck disable=SC2006
36 # alias fails on Unixware 5
37 for _i
in `alias 2>/dev/null | perl -ne 's/^alias //;s/^(\S+)=.*/$1/ && print' 2>/dev/null`; do
38 # Check if this name really is an alias
39 # or just part of a multiline alias definition
40 if alias "$_i" >/dev
/null
2>/dev
/null
; then
45 _bodies_of_ALIASES
() {
47 # myalias='definition' (GNU/Linux ash)
48 # alias myalias='definition' (FreeBSD ash)
49 # so remove 'alias ' from first line
51 echo 'alias '"`alias "$_i" | perl -pe '1..1 and s/^alias //'`"
54 _names_of_maybe_FUNCTIONS
() {
55 set | perl
-ne '/^([A-Z_0-9]+)\s*\(\)\s*\{?$/i and print "$1\n"'
57 _names_of_FUNCTIONS
() {
58 # myfunc is a function
59 # shellcheck disable=SC2046
60 LANG
=C
type `_names_of_maybe_FUNCTIONS` |
61 perl
-ne '/^(\S+) is a function$/ and not $seen{$1}++ and print "$1\n"'
63 _bodies_of_FUNCTIONS
() {
64 LANG
=C
type "$@" | perl
-ne '/^(\S+) is a function$/ or print'
66 _names_of_VARIABLES
() {
67 # This may screw up if variables contain \n and =
68 set | perl
-ne 's/^(\S+?)=.*/$1/ and print;'
70 _bodies_of_VARIABLES
() {
74 perl
-e 'print @ARGV' "$_i="
75 eval echo "\"\$$_i\"" | perl
-e '$/=undef; $a=<>; chop($a); print $a' |
76 perl
-pe 's/[\002-\011\013-\032\\\#\?\`\(\)\{\}\[\]\^\*\<\=\>\~\|\; \"\!\$\&\202-\377]/\\$&/go;'"s/'/\\\'/g; s/[\n]/'\\n'/go;";
81 # These names cannot be detected
85 # shellcheck disable=SC1078,SC1079,SC2026
86 readonly | perl
-e '@r = map {
88 # sh on UnixWare: readonly TIMEOUT
89 # ash: readonly var='val
'
91 s/^(readonly )?([^= ]*)(=.*|)$/$2/ or
92 # bash: declare -ar BASH_VERSINFO=([0]="4" [1]="4")
93 # zsh: typeset -r var='val
'
94 s/^\S+\s+\S+\s+(\S[^=]*)(=.*|$)/$1/;
96 $vars = join "|",map { quotemeta $_ } @r;
97 print $vars ? "($vars)" : "(,,nO,,VaRs,,)";
100 _remove_bad_NAMES
() {
101 # Do not transfer vars and funcs from env_parallel
102 _ignore_RO
="`_ignore_READONLY`"
103 _ignore_HARD
="`_ignore_HARDCODED`"
104 # Macos-grep does not like long patterns
105 # Old Solaris grep does not support -E
107 # grep -Ev '^(...)$' |
113 _bodies_of_FUNCTIONS|
114 _bodies_of_VARIABLES|
125 _list_function_BODIES|
126 _list_variable_VALUES|
131 _names_of_maybe_FUNCTIONS|
133 _prefix_PARALLEL_ENV|
134 _prefix_PARALLEL_ENV|
139 _which_PAR)$/x and next;
140 # Filter names matching --env
141 /^'"$_grep_REGEXP"'$/ or next;
142 /^'"$_ignore_UNDERSCORE"'$/ and next;
143 # Remove readonly variables
144 /^'"$_ignore_RO"'$/ and next;
145 /^'"$_ignore_HARD"'$/ and next;
148 _get_ignored_VARS
() {
151 $next_is_env and push @envvar, split/,/, $_;
152 $next_is_env=/^--env$/;
154 if(grep { /^_$/ } @envvar) {
155 if(not open(IN, "<", "$ENV{HOME}/.parallel/ignored_vars")) {
156 print STDERR "parallel: Error: ",
157 "Run \"parallel --record-env\" in a clean environment first.\n";
159 chomp(@ignored_vars = <IN>);
162 if($ENV{PARALLEL_IGNORED_NAMES}) {
163 push @ignored_vars, split/\s+/, $ENV{PARALLEL_IGNORED_NAMES};
166 $vars = join "|",map { quotemeta $_ } @ignored_vars;
167 print $vars ? "($vars)" : "(,,nO,,VaRs,,)";
171 # Get the --env variables if set
172 # --env _ should be ignored
173 # and convert a b c to (a|b|c)
174 # If --env not set: Match everything (.*)
175 _make_grep_REGEXP
() {
178 /^_$/ and $next_is_env = 0;
179 $next_is_env and push @envvar, split/,/, $_;
180 $next_is_env = /^--env$/;
182 $vars = join "|",map { quotemeta $_ } @envvar;
183 print $vars ? "($vars)" : "(.*)";
188 # ll is an alias for ls -l (in ash)
189 # bash is a tracked alias for /bin/bash
190 # true is a shell builtin (in bash)
191 # myfunc is a function (in bash)
192 # myfunc is a shell function (in zsh)
193 # which is /usr/bin/which (in sh, bash)
194 # which is hashed (/usr/bin/which)
195 # gi is aliased to `grep -i' (in bash)
196 # aliased to `alias | /usr/bin/which --tty-only --read-alias --show-dot --show-tilde'
197 # Return 0 if found, 1 otherwise
199 perl
-pe '$exit += (s/ is an alias for .*// ||
200 s/ is aliased to .*// ||
201 s/ is a function// ||
202 s/ is a shell function// ||
203 s/ is a shell builtin// ||
204 s/.* is hashed .(\S+).$/$1/ ||
205 s/.* is (a tracked alias for )?//);
206 END { exit not $exit }'
209 echo "env_parallel: Warning: $*" >&2
212 echo "env_parallel: Error: $*" >&2
215 if _which_PAR parallel
>/dev
/null
; then
216 true parallel found
in path
218 # shellcheck disable=SC2016
219 _error_PAR
'parallel must be in $PATH.'
223 # Grep regexp for vars given by --env
224 _grep_REGEXP
="`_make_grep_REGEXP \"$@\"`"
225 unset _make_grep_REGEXP
228 _ignore_UNDERSCORE
="`_get_ignored_VARS \"$@\"`"
229 unset _get_ignored_VARS
232 if perl
-e 'exit grep { /^--record-env$/ } @ARGV' -- "$@"; then
237 _names_of_VARIABLES
) |
238 cat > "$HOME"/.parallel
/ignored_vars
243 if perl
-e 'exit grep { /^--session$/ } @ARGV' -- "$@"; then
246 # Insert ::: between each level of session
247 # so you can pop off the last ::: at --end-session
248 PARALLEL_IGNORED_NAMES
="`echo \"$PARALLEL_IGNORED_NAMES\";
252 _names_of_VARIABLES) | perl -ne '
254 map { $ignored_vars{$_}++ }
255 split/\s+/, $ENV{PARALLEL_IGNORED_NAMES};
259 if(not $ignored_vars{$_}) {
264 export PARALLEL_IGNORED_NAMES
267 if perl
-e 'exit grep { /^--end.?session$/ } @ARGV' -- "$@"; then
270 # Pop off last ::: from PARALLEL_IGNORED_NAMES
271 PARALLEL_IGNORED_NAMES
="`perl -e '
272 $ENV{PARALLEL_IGNORED_NAMES} =~ s/(.*):::.*?$/$1/s;
273 print $ENV{PARALLEL_IGNORED_NAMES}
278 _alias_NAMES
="`_names_of_ALIASES | _remove_bad_NAMES | xargs echo`"
279 _list_alias_BODIES
="_bodies_of_ALIASES $_alias_NAMES"
280 if [ "$_alias_NAMES" = "" ] ; then
281 # no aliases selected
282 _list_alias_BODIES
="true"
286 # Grep function names
287 _function_NAMES
="`_names_of_FUNCTIONS | _remove_bad_NAMES | xargs echo`"
288 _list_function_BODIES
="_bodies_of_FUNCTIONS $_function_NAMES"
289 if [ "$_function_NAMES" = "" ] ; then
290 # no functions selected
291 _list_function_BODIES
="true"
293 unset _function_NAMES
295 # Grep variable names
296 _variable_NAMES
="`_names_of_VARIABLES | _remove_bad_NAMES | xargs echo`"
297 _list_variable_VALUES
="_bodies_of_VARIABLES $_variable_NAMES"
298 if [ "$_variable_NAMES" = "" ] ; then
299 # no variables selected
300 _list_variable_VALUES
="true"
302 unset _variable_NAMES
306 $_list_function_BODIES;
307 $_list_variable_VALUES;
310 unset _list_alias_BODIES _list_variable_VALUES _list_function_BODIES
311 unset _bodies_of_ALIASES _bodies_of_VARIABLES _bodies_of_FUNCTIONS
312 unset _names_of_ALIASES _names_of_VARIABLES _names_of_FUNCTIONS
313 unset _ignore_HARDCODED _ignore_READONLY _ignore_UNDERSCORE
314 unset _remove_bad_NAMES _grep_REGEXP
315 unset _prefix_PARALLEL_ENV
316 # Test if environment is too big
317 # shellcheck disable=SC2092
318 if `_which_PAR true` >/dev
/null
2>/dev
/null
; then
320 _parallel_exit_CODE
=$?
321 # Clean up variables/functions
323 unset _which_PAR _which_TRUE
324 unset _warning_PAR _error_PAR
325 # Unset _parallel_exit_CODE before return
326 eval "unset _parallel_exit_CODE; return $_parallel_exit_CODE"
329 _error_PAR
"Your environment is too big."
330 _error_PAR
"You can try 3 different approaches:"
331 _error_PAR
"1. Run 'env_parallel --session' before you set"
332 _error_PAR
" variables or define functions."
333 _error_PAR
"2. Use --env and only mention the names to copy."
334 _error_PAR
"3. Try running this in a clean environment once:"
335 _error_PAR
" env_parallel --record-env"
336 _error_PAR
" And then use '--env _'"
337 _error_PAR
"For details see: man env_parallel"
343 _parset_PARALLEL_PRG
=parallel
348 _parset_PARALLEL_PRG
=env_parallel
353 # If $1 contains ',' or space:
354 # Split on , to get the destination variable names
355 # If $1 is a single destination variable name:
356 # Treat it as the name of an array
358 # # Create array named myvar
359 # parset myvar echo ::: {1..10}
362 # # Put output into $var_a $var_b $var_c
363 # varnames=(var_a var_b var_c)
364 # parset "${varnames[*]}" echo ::: {1..3}
367 # # Put output into $var_a4 $var_b4 $var_c4
368 # parset "var_a4 var_b4 var_c4" echo ::: {1..3}
372 # mktemp does not exist on some OS
373 perl
-e 'use File::Temp qw(tempfile);
374 $ENV{"TMPDIR"} ||= "/tmp";
375 print((tempfile(DIR=>$ENV{"TMPDIR"}, TEMPLATE => "parXXXXX"))[1])'
379 if [ "$_parset_NAME" = "" ] ; then
380 echo parset
: Error
: No destination variable given.
>&2
381 echo parset
: Error
: Try
: >&2
382 echo parset
: Error
: ' ' parset myarray
echo ::: foo bar
>&2
385 if [ "$_parset_NAME" = "--help" ] ; then
386 echo parset
: Error
: Usage
: >&2
387 echo parset
: Error
: ' ' parset varname GNU Parallel options and
command >&2
392 if [ "$_parset_NAME" = "--version" ] ; then
393 echo "parset 20210922 (GNU parallel `parallel --minversion 1`)"
394 echo "Copyright (C) 2007-2021 Ole Tange, http://ole.tange.dk and Free Software"
395 echo "Foundation, Inc."
396 echo "License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>"
397 echo "This is free software: you are free to change and redistribute it."
398 echo "GNU parallel comes with no warranty."
400 echo "Web site: https://www.gnu.org/software/parallel"
402 echo "When using programs that use GNU Parallel to process data for publication"
403 echo "please cite as described in 'parallel --citation'."
408 echo "$_parset_NAME" |
409 perl
-ne 'chomp;for (split /[, ]/) {
410 # Allow: var_32 var[3]
411 if(not /^[a-zA-Z_][a-zA-Z_0-9]*(\[\d+\])?$/) {
412 print STDERR "parset: Error: $_ is an invalid variable name.\n";
413 print STDERR "parset: Error: Variable names must be letter followed by letters or digits.\n";
414 print STDERR "parset: Error: Usage:\n";
415 print STDERR "parset: Error: parset varname GNU Parallel options and command\n";
421 _exit_FILE
=`_make_TEMP`
422 if perl
-e 'exit not grep /,| /, @ARGV' "$_parset_NAME" ; then
423 # $_parset_NAME contains , or space
424 # Split on , or space to get the names
425 # shellcheck disable=SC2016,SC2046
427 # Compute results into files
428 ($_parset_PARALLEL_PRG --files -k "$@
"; echo $? > "$_exit_FILE") |
429 # var1= cat tmpfile1; rm tmpfile1
430 # var2= cat tmpfile2; rm tmpfile2
431 parallel --plain -q echo '{2}=\`cat {1}; rm {1}\`' :::: - :::+ \`
432 echo "$_parset_NAME" |
437 # $_parset_NAME does not contain , or space
438 # => $_parset_NAME is the name of the array to put data into
439 # Supported in: bash zsh ksh mksh
440 # Arrays do not work in: sh ash dash
441 eval "$_parset_NAME=( $(
442 # Compute results into files. Save exit value
443 ($_parset_PARALLEL_PRG --files -k "$@
"; echo $? > "$_exit_FILE") |
444 perl -pe 'chop;$_="\"\
`cat $_; rm $_\`\" "'
447 unset _parset_NAME _parset_PARALLEL_PRG _parallel_exit_CODE
448 # Unset _exit_FILE before return
449 eval "unset _exit_FILE; return \`cat $_exit_FILE; rm $_exit_FILE\`"