#!/bin/bash
#
# How to use:
#
# A. SETUP
# --------
#
# 1. create a new directory, e.g.
# mkdir my_arb_compile; cd my_arb_compile
#
# 2. checkout arb, e.g. (the last argument is the name of the target directory)
# svn co svn+ssh://USERNAME@svn.arb-home.de/svn/ARB/trunk myARB
# # or
# svn co http://vc.arb-home.de/readonly/trunk myARB
#
# 3. link the included compile script, e.g.
# ln -s myARB/util/arb_compile.sh compile_myARB.sh
#
# 4. call the script
# ./compile_myARB.sh
#
# 5. review the generated config
# vi compile_myARB.config
#
# 6. call the script again (this will generate config.makefile and fail)
# ./compile_myARB.sh
#
# 7. edit the generated config.makefile (default builds a openGL/64bit/linux-ARB)
# vi myARB/config.makefile
#
# 8. call the script again (this shall succeed)
# ./compile_myARB.sh
#
#
# B. UPGRADE
# -----------
#
# 1. simply call the script to upgrade ARB to newest revision
# ./compile_myARB.sh
#
#
# C. Multiple versions (in one 'my_arb_compile' directory)
# --------------------
#
# When you use a different name for the link target in step A.3. it
# is possible to work with multiple checkouts and multiple configs
# inside the same 'my_arb_compile' directory.
# The name used as checkout directory has to be changed for subsequent
# versions. Change 'myARB' to a different name in steps A.2., A.3. and A.7
#

# -------------------------------------------
# default values for optional config entries:

REVERT=1
CLEAN=1

# -------------------------------------------

default_config() {
    echo "# config to compile ARB via $BASENAME.sh"
    echo ""
    echo "# Subdirectory in which ARB is located:"
    echo "SUBDIR=myARB"
    echo ""
    echo "# Real CPU cores"
    echo "CORES=2"
    echo ""
    echo "# SVN revision to use (empty=newest)"
    echo "REVISION="
    echo ""
    echo "# normally this script reverts all local changes (uncomment the next line to avoid that)"
    echo "#REVERT=0"
    echo ""
    echo "# normally this script always does a complete rebuild (uncomment the next line to avoid that)"
    echo "#CLEAN=0"
}

log() {
    echo "############################################################ [ $1 $2 ]"
}
log_start() {
    log $1 start
}
log_result() {
    local TAG=$1
    local STATUS=$2
    if [ $STATUS = 0 ]; then
        log $TAG succeeded
    else
        log $TAG failed
    fi
    return $STATUS
}

clean() {
    log_start clean
    if [ "$CLEAN" = "1" ]; then
        make clean
    else
        echo "No cleanup done before update"
        true
    fi
    log_result clean $?
}

revert() {
    log_start revert
    if [ "$REVERT" = "1" ]; then
        svn revert -R .
    else
        echo "Did not revert local changes"
        echo "Current local changes are:"
        echo "-----------------------------"
        svn diff
        echo "-----------------------------"
        true
    fi
    log_result revert $?
}
svnup() {
    log_start svnup
    svn up --force $UPDATE_ARGS
    log_result svnup $?
}
dumpcfg() {
    ARB_CONFIG=config.makefile

    log current "$CONFIG"
    cat ../$CONFIG

    log current "$ARB_CONFIG"
    if [ -e $ARB_CONFIG ]; then
        cat $ARB_CONFIG
    else
        echo "$ARB_CONFIG does not exist (yet)"
    fi
}
update() {
    clean && \
        revert && \
        svnup
}
build() {
    log_start build
    if [ "$CLEAN" = "1" ]; then
        make -j$CORES TARFILE
    else
        echo "No cleanup done before compilation"
        make -j$CORES TARFILE_QUICK
    fi
    log_result build $?
}

upgrade() {
    echo "Upgrading ARB checkout in '$ARBHOME'"
    echo ""
    echo "Starting build process"
    echo "(you may watch the output using"
    echo "     less +F $LOG"
    echo "in another terminal)"
    echo ""
    (dumpcfg && update && build) >& $LOG
}

arbshell() {
    echo "ARBHOME now is '$ARBHOME'"
    $ARBHOME/bin/arb_ntree --help 2>&1 | grep version
    echo "Opening a new shell ('$SHELL'). Run arb here. Press ctrl-d to close this shell."
    $SHELL
    ARBHOME=$OLDARBHOME
    echo "ARBHOME now is again '$ARBHOME'"
}

# ----------------------------------------

if [ !$?ARBHOME ]; then
    ARBHOME=''
fi
OLDARBHOME=$ARBHOME

BASEDIR=`pwd`
BASENAME=`basename $0 | perl -pne 's/.sh//'`

echo "BASENAME='$BASENAME'"

CONFIG=$BASENAME.config
LOG=$BASEDIR/$BASENAME.log

if [ -f $CONFIG ]; then
    source $CONFIG
else
    default_config > $CONFIG
    echo "$CONFIG has been generated"
    SUBDIR=
fi

if [ "$SUBDIR" = "" ]; then
    echo "Review config, then rerun this script"
else
    ARBHOME=$BASEDIR/$SUBDIR

    if [ ! -d $ARBHOME ]; then
        echo "ARBHOME='$ARBHOME' (no such directory)"
    else
        PATH=$ARBHOME/bin:$PATH
        if [ !$?LD_LIBRARY_PATH ]; then
            LD_LIBRARY_PATH=$ARBHOME/lib
        else
            LD_LIBRARY_PATH=$ARBHOME/lib:$LD_LIBRARY_PATH
        fi

        export ARBHOME PATH LD_LIBRARY_PATH

        cd $ARBHOME

        if [ "$REVISION" = "" ]; then
            UPDATE_ARGS=
        else
            UPDATE_ARGS="-r $REVISION"
        fi

        (upgrade && echo "ARB upgrade succeeded" && arbshell) || ( echo "Error: Something failed (see $LOG)" && false)
    fi
fi