interactive_autogen.sh

#! /bin/bash

# Crash if any sub command crashes
set -o errexit

# Crash if any unset variables are used
set -o nounset


# Get the directory that autogen.sh is in (stolen frome stackoverflow:
# http://stackoverflow.com/questions/59895/can-a-bash-script-tell-what-directory-its-stored-in
# ), this is the oomph-lib root directory. Doesn't follow symlinks to the
# script itself, should be robust for anything else. If you move autogen.sh
# this will need to change a little.
oomph_root="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"

cd "$oomph_root"

# Load helper functions
source bin/autogen_helpers.sh


# Echo autogen's usage if requested
while getopts ":h" opt; do
  case $opt in
      h)
          echo "This script is an interactive interface to autogen.sh." 
          echo "Arguments allowed for the underlying autogen.sh are:"
          echo
          EchoUsage
          exit 0
          ;; 
  esac
done


#====================================================================
# Start Q/A session
#====================================================================

echo " "
echo "============================================================= "
echo "        oomph-lib interactive installation script" 
echo "============================================================= "
echo " "


# Choose build directory (for lib,include)
build_dir="$oomph_root/build"

echo " "
echo " "
echo "I'm going to install the distribution (the lib and include directories)"
echo "in:"
echo " "
echo "    " $build_dir
echo " "
echo " "
if ! YesNoRead "Is this OK?" "y"; then
    printf "Specify build directory [e.g. /home/joe_user/build] :"
    build_dir=$(OptionRead)
fi

echo " "
echo "============================================================= "
echo " "
echo "Build directory is: " 
echo " " 
echo "     " $build_dir
echo " " 
echo "--> The include directory will be in: "
echo " " 
echo "    " $build_dir"/include" 
echo " " 
echo "--> The lib directory will be in: "
echo " " 
echo "    " $build_dir"/lib" 
echo " "
echo "etc.       " 
echo " "
echo "============================================================= "
echo " "


echo "Self tests"
echo "======"
echo "Following the installation of oomph-lib you can run a comprehensive set of"
echo "self tests with 'make check -k' or with './bin/parallel_self_test.py'. The"
echo "latter version tends to be much faster because it performs multiple"
echo "self-tests at the same time."

if YesNoRead "Would you like to automatically run self tests (serially) if the build is successful?" "n"; then
    run_self_tests="true"
else
    run_self_tests="false"
fi


# Choose configure options file
#------------------------------

configure_options_file="config/configure_options/current"

# If the current file exists then ask if it is ok
if [[ -f $configure_options_file ]]; then

    echo " "
    echo "Configure options are: "
    cat "$configure_options_file" | ProcessOptionsFile
    echo
    if YesNoRead "Is this OK?" "y"; then
        accept_configure_options="true"
    else
        accept_configure_options="false"
    fi

    # Otherwise have to choose one interactively
else
    accept_configure_options="false"
fi


# Continue asking if the options are OK until approved
while [[ $accept_configure_options != "true" ]]; do

    # Get list of options files
    configure_option_files="$(find config/configure_options -type f | sort)"

    echo " "
    echo "======================================================================"
    echo 
    echo "Choose an alternative configuration file "
    # Loop over files and display a menu
    count=0
    for file in $configure_option_files
    do
        #Increase the counter
        count=$(expr $count + 1)
        echo $count ": " $(basename $file)
    done

    echo
    echo "Enter the Desired configuration file [1-"$count"]"
    echo "Enter 0 to specify the options on the command line"

    # Read in the Desired File and validate it
    file_number=$(OptionRead)
    if (( $file_number >= $count )) || (( $file_number < 0 )); then
        # Error and go to start of loop
        echo "File number out of range, trying again." 1>&2
        continue
    fi


    # If options are to be read from the command line then store the
    # options in the file config/configure_options/current
    if [[ "$file_number" == "0" ]]; then
        echo 
        echo "Enter options"
        configure_options=$(OptionRead)
        echo $configure_options > "config/configure_options/new_options_file"
        configure_options_file="config/configure_options/new_options_file"

    # Otherwise copy the desired options file to config/configure_options/current
    else 
        # Use cut to extract the nth entry in the list
        configure_options_file="$(echo $configure_option_files | cut -d \  -f $file_number)"
    fi

    # Check that the options are in the correct order
    configure_options_are_ok="$(CheckOptions $configure_options_file)"
    if test "$configure_options_are_ok" != ""; then

        echo " " 1>&2
        echo "===============================================================" 1>&2
        echo "Error message from autogen.sh:" 1>&2
        echo " "  1>&2
        echo $configure_options_are_ok 1>&2
        echo " "  1>&2
        echo "===============================================================" 1>&2
        
        # Fail, go back to start of while loop
        continue
    fi

    # Ask if these options are OK
    echo " "
    echo "Configure options are: "
    cat "$configure_options_file" | ProcessOptionsFile
    echo 
    if YesNoRead "Is this OK?" "y"; then
        accept_configure_options="true"
    else
        accept_configure_options="false"
    fi

done

echo
echo
echo


#====================================================================
# Start actual build process
#====================================================================


# Call real autogen
build_command="./autogen.sh -b $build_dir -c ${oomph_root}/$configure_options_file $@"
echo "The interactive part of the build process is over."
echo "Running $build_command"
$build_command

# Run tests if requested
if test "$run_self_tests" == "true"; then
    self_test_command="make check -k"
    echo "Running self test command: $self_test_command"
    $self_test_command
fi


echo " "
echo "autogen.sh has finished! If you can't spot any error messages" 
echo "above this, oomph-lib should now be ready to use... " 
echo " " 
echo "If you encounter any problems, please study the installation" 
echo "instructions and the FAQ before contacting the developers. " 
echo
echo
echo "To rerun autogen.sh with the selected options use the command:"
echo "$build_command"
echo
echo "To run self tests you can use 'make check -k' or './bin/parallel_self_test.py',"
echo "to run them automatically after a succesful build use the && operator,"
echo "e.g. './autogen.sh && make check -k'."
echo
echo "To see other autogen.sh command line options run './autogen.sh -h'"