ParaViewFunctions

#---------------------------------*- sh -*-------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     |
#   \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
#    \\/     M anipulation  | Copyright (C) 2016-2018 OpenCFD Ltd.
#------------------------------------------------------------------------------
# License
#     This file is part of OpenFOAM, licensed under GNU General Public License
#     <http://www.gnu.org/licenses/>.
#
# File
#     etc/tools/ParaViewFunctions
#
# Description
#     ParaView make/install helper functions
#
# Note
#     Obtaining paths via 'python-config' is possible, but may not always
#     resolve properly:
#
#         python-config --includes
#         >>
#             -I/usr/include/python2.7 -I/usr/include/python2.7
#
#         python-config --libs
#         >>
#             -lpython2.7 -lpthread -ldl -lutil -lm
#
#------------------------------------------------------------------------------

# Variables referenced by the functions. Initialization at the end of the file.
unset CMAKE_VARIABLES
unset withVERBOSE
unset withMPI     MPI_MAX_PROCS
unset withQT      QT_VERSION      QMAKE_PATH
unset withMESA    MESA_INCLUDE    MESA_LIBRARY    withOSMESA
unset withPYTHON  PYTHON_INCLUDE  PYTHON_LIBRARY
unset withGL2
BUILD_TYPE=Release  # The cmake build type

# sourceBASE, buildBASE, installBASE and BUILD_SUFFIX
#   are defined in tools/ThirdPartyFunctions
#------------------------------------------------------------------------------

#
# Where things are or should be put
#   ParaView_VERSION and ParaView_MAJOR should already have been set
#
#   ParaView_SOURCE_DIR : location of the original sources
#   ParaView_BUILD_DIR  : location of the build
#   ParaView_DIR        : location of the installed program
#
setParaViewDirs()
{
    set -- "ParaView-$ParaView_VERSION" "ParaView-v$ParaView_VERSION"

    unset ParaView_SOURCE_DIR
    for i
    do
        ParaView_SOURCE_DIR="$sourceBASE/$i"
        [ -d "$ParaView_SOURCE_DIR" ] && break
    done

    [ -d "$ParaView_SOURCE_DIR" ] || {
        echo "Did not locate ParaView version:"
        while [ "$#" -ge 1 ]; do echo "    $1"; shift; done
        echo
        echo "In the directory:"
        echo "    $sourceBASE"
        echo
        echo "abort build"
        exit 1
    }

    ParaView_BUILD_DIR=$buildBASE/ParaView-$ParaView_VERSION$BUILD_SUFFIX
    ParaView_DIR=$installBASE/ParaView-$ParaView_VERSION$BUILD_SUFFIX

    export ParaView_SOURCE_DIR ParaView_BUILD_DIR ParaView_DIR

    echo
    echo "ParaView_SOURCE_DIR=$ParaView_SOURCE_DIR"
    echo "ParaView_BUILD_DIR=$ParaView_BUILD_DIR"
    echo "ParaView_DIR=$ParaView_DIR"

    export GIT_DIR=$ParaView_SOURCE_DIR/.git # Mask seeing our own git-repo
}


#
# Set ParaView_VERSION and adjust ParaView_MAJOR accordingly
#
# $1 can contain something something like 4.4.0, paraview-4.4.0, ParaView-4.0.0
#
setParaViewVersion()
{
    [ $# -gt 0 ] || {
        echo "Error: function setParaViewVersion() called without an argument"
        exit 1
    }

    ParaView_VERSION="${1##*-}"

    # The major version is "<digits>.<digits>"
    ParaView_MAJOR=$(echo $ParaView_VERSION | \
        sed -e 's/^\([0-9][0-9]*\.[0-9][0-9]*\).*$/\1/')

    export ParaView_VERSION ParaView_MAJOR
}


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

#
# Set CMake cache variables
#
addCMakeVariable()
{
    local i
    for i
    do
        [ -n "$i" ] && CMAKE_VARIABLES="$CMAKE_VARIABLES -D$i"
    done
}


#
# Verbose makefiles
#
addVerbosity()
{
    if [ "${withVERBOSE:=false}" = true ]
    then
        addCMakeVariable "CMAKE_VERBOSE_MAKEFILE=TRUE"
    fi
}


#
# Define options for mpi support
#
addMpiSupport()
{
    if [ "${withMPI:=false}" != true ]
    then
        return
    fi

    addCMakeVariable "PARAVIEW_USE_MPI=ON" "VTK_USE_MPI=ON"
    if [ "${MPI_MAX_PROCS:=0}" -gt 1 ]
    then
        addCMakeVariable "VTK_MPI_MAX_NUMPROCS=$MPI_MAX_PROCS"
    fi
}


#
# Define options for python support
#
addPythonSupport()
{
    if [ "${withPYTHON:-false}" != true ]
    then
        return
    fi

    local pythonBin pythonConfig pythonMajor

    pythonBin=$(which python 2>/dev/null) || {
        echo "*** Error: python not found"
        echo "***        Deactivate python support by not using the -python "
        echo "***        option"
        exit 1
    }

    if [ -n "$PYTHON_LIBRARY" ]
    then

        # PYTHON_LIBRARY set:
        [ -e "$PYTHON_LIBRARY" ] || \
            echo "*** Error: libpython not found at location specified " \
                 "by -python-lib : PYTHON_LIBRARY=$PYTHON_LIBRARY"

    else

        # Fallback: get PYTHON_LIBRARY from dynamically linked binary

        PYTHON_LIBRARY=$(ldd $pythonBin | \
            sed -ne '/libpython/s/^.* => \(.*\) (.*/\1/p')

        [ -e "$PYTHON_LIBRARY" ] || {
            echo "*** Error: Unable to determine path to python library."
        }

    fi

    [ -e "$PYTHON_LIBRARY" ] || {
        echo "    Please set the full path to the python library "
        echo "    (including libpython) using the -python-lib option, "
        echo "    or deactivate python support by not using the -python "
        echo "    option"
        exit 1
    }

    # Guess major from library
    pythonMajor=$(echo $PYTHON_LIBRARY | sed 's/.*libpython\(.*\)\.so.*/\1/')

    if [ -n "$PYTHON_INCLUDE" ]
    then

        # PYTHON_INCLUDE set:
        [ -d "$PYTHON_INCLUDE" -a -f "$PYTHON_INCLUDE/Python.h" ] || \
            echo "*** Error: Python.h not found at location specified " \
                 "by -python-include : PYTHON_INCLUDE=$PYTHON_INCLUDE"

    elif pythonConfig=$(which python-config 2>/dev/null)
    then
        # Guess from python-config
        # parse '-I/usr/include/python2.7 -I/usr/include/python2.7'
        # -> '/usr/include/python2.7'
        PYTHON_INCLUDE=$(python-config --includes | sed -ne 's/^-I\([^ ][^ ]*\).*$/\1/p')

    else

        # Fallback to system headers
        PYTHON_INCLUDE=/usr/include/python$pythonMajor

    fi

    [ -d "$PYTHON_INCLUDE" -a -f "$PYTHON_INCLUDE/Python.h" ] || {
        echo "    No python headers found in $PYTHON_INCLUDE/"
        echo "    Please install python headers or deactivate "
        echo "    python support by not using the -python option"
        exit 1
    }

    addCMakeVariable "PARAVIEW_ENABLE_PYTHON=ON"
    addCMakeVariable "PYTHON_INCLUDE_DIRS=$PYTHON_INCLUDE"
    addCMakeVariable "PYTHON_LIBRARY=$PYTHON_LIBRARY"

    echo "----"
    echo "Python information:"
    echo "    executable     : $pythonBin"
    echo "    version        : $pythonMajor"
    echo "    include path   : $PYTHON_INCLUDE"
    echo "    library        : $PYTHON_LIBRARY"
}


#
# Define options for mesa support
#
addMesaSupport()
{
    if [ "${withMESA:=false}" != true ]
    then
        return
    fi

    if [ -d "$MESA_INCLUDE" -a -f "$MESA_LIBRARY" ]
    then
        addCMakeVariable "VTK_OPENGL_HAS_OSMESA=ON"
        addCMakeVariable "OSMESA_INCLUDE_DIR=$MESA_INCLUDE"
        addCMakeVariable "OSMESA_LIBRARY=$MESA_LIBRARY"

    else
        echo "*** Error: no MESA information found"
        echo "***   Deactivate MESA support by not using the -mesa option, "
        echo "***   or set the correct paths for:"
        echo "***       -mesa-include ($MESA_INCLUDE)"
        echo "***       -mesa-lib ($MESA_LIBRARY)"
        exit 1
    fi
}


#
# new rendering backend
#
addGL2Support()
{
    if [ "${withGL2:=false}" = true ]
    then
        addCMakeVariable "VTK_RENDERING_BACKEND=OpenGL2"
    fi
}


#
# Qt 4/5 support
#
addQtSupport()
{
    QT_VERSION=none
    : ${withQT:=true}  # default is on

    if [ "$withQT" = false ]
    then
        # Explicitly disabled
        addCMakeVariable "PARAVIEW_BUILD_QT_GUI=OFF"
        return
    fi

    local qmake qtLib

    # Check qmake can be found and handle version differences
    qmake=$(findQMake)
    if QT_VERSION=$($qmake -query QT_VERSION 2>/dev/null)
    then
        addCMakeVariable "PARAVIEW_BUILD_QT_GUI=ON"

        case "$QT_VERSION" in
        (3.* | 4.[0-4]*)
            # QT is too old
            cat <<ERROR
----
Error: ${0##*/}

QT version ($QT_VERSION) provided < 4.5
Please use the -qmake option to specify the location of a newer QT version
For example,
    ... -qmake /usr/local/qt-4.6.2/bin/qmake
    ... -qmake $installBASE/qt-4.6.2/bin/qmake
----
ERROR
            exit 1
            ;;

        (4.*)
            # Default changed to Qt5 with paraview 5.2.1, so specify explicitly
            addCMakeVariable "PARAVIEW_QT_VERSION=4"

            # Non-system installation - specify location of qmake
            if [ "$qmake" != /usr/bin/qmake ]
            then
                addCMakeVariable "QT_QMAKE_EXECUTABLE=$qmake"
            fi
            ;;

        (5.*)
            # Default changed to Qt5 with paraview 5.2.1, so specify explicitly
            addCMakeVariable "PARAVIEW_QT_VERSION=5"

            # Non-system installation - find CMake config files
            if [ "$qmake" != /usr/bin/qmake ] \
               && qtLib="$($qmake -query QT_INSTALL_LIBS)/cmake/Qt5" \
               && [ -d "$qtLib" ]
            then
                addCMakeVariable "Qt5_DIR=$qtLib"
            fi
            ;;
        esac
    else
        QT_VERSION=none
        echo "Error: cannot find qmake either at \$QMAKE_PATH or in current \$PATH"
        echo
        exit 1
    fi
}


#
# Apply source-code patch if possible
#
patchParaView()
{
    applyPatch "paraview-$ParaView_VERSION" "$ParaView_SOURCE_DIR"
}


#
# Configure via cmake, but don't actually build anything
#
configParaView()
{
    local cmake=$(findCMake)

    # Remove any existing build folder and recreate
    if [ -d $ParaView_BUILD_DIR ]
    then
        echo "removing old build directory"
        echo "    $ParaView_BUILD_DIR"
        rm -rf $ParaView_BUILD_DIR
    fi
    mkdir -p $ParaView_BUILD_DIR

    addCMakeVariable "CMAKE_BUILD_TYPE=$BUILD_TYPE"

    cd $ParaView_BUILD_DIR || exit 1  # Change to build folder

    echo "----"
    echo "Configuring paraview-$ParaView_VERSION (major version: $ParaView_MAJOR)"
    echo "    MPI    support : ${withMPI:-false}"
    echo "    Python support : ${withPYTHON:-false}"
    echo "    MESA   support : ${withMESA:-false}"
    echo "    GL2  rendering : ${withGL2:-false}"
    echo "    QT dev support : ${withQT:-true}"
    echo "    Source         : $ParaView_SOURCE_DIR"
    echo "    Build          : $ParaView_BUILD_DIR"
    echo "    Target         : $ParaView_DIR"
    echo "    cmake          : $cmake"
    echo "    Build suffix   : ${BUILD_SUFFIX:-none}"
    echo "----"
    echo
    echo "$cmake" \
        -DCMAKE_INSTALL_PREFIX=$ParaView_DIR \
        $CMAKE_VARIABLES \
        $ParaView_SOURCE_DIR
    echo
    echo "----"
    echo

    # Run cmake to create Makefiles
    $cmake \
        -DCMAKE_INSTALL_PREFIX=$ParaView_DIR \
        $CMAKE_VARIABLES \
        $ParaView_SOURCE_DIR
}


#
# Invoke make
# also link bin/ to lib/paraview-* for development without installation
#
makeParaView()
{
    cd $ParaView_BUILD_DIR || exit 1  # Change to build folder
    echo "    Starting make"
    time make -j $WM_NCOMPPROCS
    echo "    Done make"

    # Remove lib if it is a link
    # (how this was previously handled before 'make install' worked)
    if [ -L lib ]
    then
        rm lib 2>/dev/null
    fi
}


#
# Install the program
#
installParaView()
{
    cd $ParaView_BUILD_DIR || exit 1  # Change to build folder
    echo "    Installing ParaView to $ParaView_DIR"

    make install

    # System or non-system installation of QT?
    local qmake qtLib QT_VERSION
    if qmake=$(findQMake 2>/dev/null)
    then
        qtLib=$($qmake -query QT_INSTALL_LIBS)
        QT_VERSION=$($qmake -query QT_VERSION 2>/dev/null)
    fi

    /bin/cat<<INFO

====
Installation complete for paraview-$ParaView_VERSION with qt-${QT_VERSION:-none}
    ParaView_DIR=$ParaView_DIR

You may need to update the OpenFOAM environment by running:
    wmRefresh
INFO

    # Non-system installation of QT?
    case "$qtLib" in (/usr/lib | /usr/lib64) unset qtLib ;; esac

    if [ "$qmake" != /usr/bin/qmake -a -d "$qtLib" ]
    then
        /bin/cat<<INFO

And adjust your LD_LIBRARY_PATH to include the following:
    $qtLib
INFO
    fi

    echo "===="
}


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

# Start with these general settings
addCMakeVariable "BUILD_SHARED_LIBS=ON" "BUILD_TESTING=OFF"

# Include development files in "make install"
addCMakeVariable "PARAVIEW_INSTALL_DEVELOPMENT_FILES=ON"

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