#!/bin/sh
# h5_check_interface_compatibility
# Checks ABI compatibility between two installations of HDF5.

##################
# USAGE function #
##################
USAGE()
{
cat <<EOF
Usage: h5_check_interface_compatibility [OPTIONS]
          --help: show this help message.
          --old=: Specify path to old version of library. [default: /mnt/hdf/packages/hdf5/current/Linux_2.6/standard]
          --new=: Specify path to new version of library. [default: ./]
          --out=: Specify location to drop the compatibility report. [default: ./report]
EOF
}

#################################################
# Define Path to ABI Compatibility Checker Tool #
#################################################
abitool=/mnt/hdf/packages/abi-compliance-checker/1.99.9/abi-compliance-checker.pl

#################
# Parse Options #
#################
while [ $# -gt 0 ]; do
    case "$1" in
        --help)
            USAGE
            exit 0
            ;;
        --out=*)
            loc=`echo $1 | sed s/--out\=//`
            ;;
        --old=*)
            path_to_old=`echo $1 | sed s/--old\=//`
            ;;
        --new=*)
            path_to_new=`echo $1 | sed s/--new\=//`
            ;;
        *)
            echo "$0: unknown option ($1)"
            USAGE
            exit 1
            ;;
    esac
    shift
done

######################################
# Use default paths if not specified #
######################################
if test ! $path_to_old; then
    path_to_old="/mnt/hdf/packages/hdf5/current/Linux_2.6/standard"
fi
if test ! $path_to_new; then
    path_to_new="."
fi

#################################################
# Verify valid paths & retrieve version numbers #
#################################################
if test -f $path_to_old/lib/libhdf5.settings; then
    old_ver=`grep 'HDF5 Version:' $path_to_old/lib/libhdf5.settings | sed s/HDF5\ Version\:\ //`
    old_ver=`echo $old_ver`
    echo Older library version: $old_ver { $path_to_old }
else
    echo Error! {$path_to_old} does not appear to be a valid path to an HDF5 installation. Please re-check and try again.
    USAGE
    exit 1
fi

if test -f $path_to_new/lib/libhdf5.settings; then
    new_ver=`grep 'HDF5 Version:' $path_to_new/lib/libhdf5.settings | sed s/HDF5\ Version\:\ //`
    new_ver=`echo $new_ver`
    echo Newer library version: $new_ver { $path_to_new }
else
    echo Error! {$path_to_new} does not appear to be a valid path to an HDF5 installation. Please re-check and try again.
    USAGE
    exit 1
fi

##########################
# Create xml file inputs #
##########################
echo "<version>$old_ver</version>"\
"<headers>$path_to_old/include</headers>"\
"<libs>$path_to_old/lib</libs>"\
 > old.xml
echo "<version>$new_ver</version>"\
"<headers>$path_to_new/include</headers>"\
"<libs>$path_to_new/lib</libs>"\
 > new.xml

##########################
# Run compatibility tool #
##########################
echo Running ABI Compatibility Tool ...
perl $abitool -l hdf5 -d1 old.xml -d2 new.xml >& abilog
#grep result abilog

failed=`grep INCOMPATIBLE abilog`

if test ! "$failed"; then
    echo "Libraries are compatible."
else
    echo "Libraries are NOT compatible!"
fi

###################
# Publish Results #
###################
if test ! $loc; then
    loc="./report"
    mkdir report
fi

cp compat_reports/hdf5/${old_ver}_to_${new_ver}/compat_report.html ${loc}
echo Report has been posted to $loc

###########################################
# Remove other extraneous generated files #
###########################################
rm -r old.xml new.xml logs compat_reports abilog