Add a bash completion script for orterun/mpirun.

Features of v 1.0:

 - Completion of all switches.
 - Completion of mca variable names.
 - Completion of mca variable values for enumerated variables and component
   selection variables.
 - Completion of --bind-to and --map-by.

This commit was SVN r29513.

contrib/completion/mpirun.sh

@@ -0,0 +1,158 @@
+#!/bin/bash
+# (c) 2008-2013 Nathan Hjelm <hjelmn@cs.unm.edu>
+# mpirun completion v1.0
+#
+# Bash completion script for Open MPI's mpirun
+# Put this file in ~/.bash_completion.d if using standard
+#
+# bash completion.
+
+# Check for orterun
+type mpirun &>/dev/null || type orterun &>/dev/null && {
+
+# find available MCA variables
+_get_mca_variable_names() {
+    ompi_info -a -l 9 --parsable | perl -e '
+my %values;
+
+while (<>) {
+  if (/^mca:/) {
+    @tmp = split(":");
+    $values{$tmp[4]} = 1;
+  }
+}
+
+@uniq = keys %values;
+print join(" ", sort(@uniq));'
+}
+
+# given a framework (type) name print a list of components
+_get_mca_component_names() {
+    # components are printed by default (-a is not needed)
+    ompi_info -l 9 --parsable | grep "mca:$1:" | perl -e '
+my %values;
+
+while (<>) {
+  if (/^mca:/) {
+    @tmp = split(":");
+    $values{$tmp[2]} = 1;
+  }
+}
+
+@uniq = keys %values;
+print join(" ", sort(@uniq));'
+}
+
+_get_mpirun_switches() {
+    mpirun --help 2>&1 | sed 's/^\s*//g' | egrep '^-' | cut -d' ' -f1 | tr '|' ' ' | tr '\n' ' '
+}
+
+# get enumerator values for a variable
+_get_enum_values() {
+    ompi_info -a -l 9 --parsable | grep ":$1:" | perl -e '
+my @values;
+
+while (<>) {
+  chop;
+  @tmp = split(":");
+
+  if ($tmp[5] eq "enumerator") {
+    $values[++$#values] = $tmp[7];
+    $values[++$#values] = $tmp[8];
+  }
+}
+print join(" ", @values);'
+}
+
+# remove items from $1 that are also in $2. lists must be sorted
+_set_remove () {    
+    comm -23 <(echo $1 | tr " " "\n") <(echo $2 | tr " " "\n")
+}
+
+# find mca parameters specified on the command line (prevent duplicates)
+_find_mca_parameters() {
+    for ((i = 1; i < COMP_CWORD; i++)) ; do
+	# the subcommand is the first item on the command line that isn't module or a switch
+	if test ${COMP_WORDS[$i]##*-} == "mca" -a $i -lt $((COMP_CWORD-1)) ; then
+	    echo ${COMP_WORDS[$i+1]}
+	fi
+    done
+}
+
+# check for matches that have the search term somewhere in the name
+_fuzzy_search() {
+    for match in $2 ; do
+	if [[ $match =~ .*"$1".* ]] ; then
+	    echo $match
+	fi
+    done
+}
+
+# mpirun/orterun completion
+_mpirun() {
+    local cur prv tb switches already_specified all_variables avail_variables enumerations
+
+    COMPREPLY=()
+    if test $COMP_CWORD -gt 1 ; then
+	tb=${COMP_WORDS[COMP_CWORD-2]}
+    else
+	tb=""
+    fi
+
+    if test $COMP_CWORD -gt 0 ; then
+	prv=${COMP_WORDS[COMP_CWORD-1]}
+    else
+	prv=""
+    fi
+
+    cur=${COMP_WORDS[COMP_CWORD]}
+
+    if test "${prv}" = "--bind-to" ; then
+	COMPREPLY=($(compgen -W "none hwthread core socket numa board" -- "$cur"))
+    elif test "${prv}" = "--map-by" -o "${prv}" = "-map-by" ; then
+	COMPREPLY=($(compgen -W "slot hwthread core socket numa board node" -- "$cur"))
+    elif test "${prv##*-}" = "hostfile" ; then
+	COMPREPLY=($(compgen -f -- "$cur"))
+    elif test "${cur:0:1}" = "-" ; then
+	switches=$(_get_mpirun_switches)
+	COMPREPLY=($(compgen -W "$switches" -- "$cur"))
+    fi
+
+    cmd=${COMP_WORDS[$cmd_index]}
+
+    if test "${prv##*-}" = "mca" ; then
+	# Complete variable name
+
+	# Remove mca parameters already on the command line
+	already_specified=($(_find_mca_parameters | sort))
+	all_variables=($(_get_mca_variable_names | sort))
+	avail_variables=($(_set_remove "${all_variables[*]}" "${already_specified[*]}"))
+
+	# Return a fuzzy-search of the mca parameter names
+	COMPREPLY=($(_fuzzy_search "$cur" "${avail_variables[*]}"))
+    elif test "${tb##*-}" = "mca" ; then
+	# Complete variable value
+
+	# Check if the variable is a selection variable (no _ in the name)
+        if test "${prv#_}" = "${prv}" ; then
+	    # component selection variable, find available components (removing ones already selected)
+	    enumerations=($(_set_remove "$(_get_mca_component_names $prv)" "$(echo $cur | tr ',' '\n')"))
+
+	    # Prepend the current selection if there is one
+	    if test "${cur%,*}" = "${cur}" ; then
+		COMPREPLY=($(_fuzzy_search "${cur##*,}" "${enumerations[*]}"))
+	    else
+		COMPREPLY=($(_fuzzy_search "${cur##*,}" "${enumerations[*]}" | sed "s/^/${cur%,*},/g"))
+	    fi
+	else
+	    enumerations=($(_get_enum_values "$prv"))
+	    COMPREPLY=($(_fuzzy_search "$cur" "${enumerations[*]}"))
+	fi
+    fi
+
+    return 0
+}
+
+complete -o nospace -F _mpirun mpirun
+complete -o nospace -F _mpirun orterun
+}