#----------------------------------*-sh-*--------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     |
#   \\  /    A nd           | Copyright (C) 2018-2019 OpenCFD Ltd.
#    \\/     M anipulation  |
#------------------------------------------------------------------------------
# License
#     This file is part of OpenFOAM, licensed under GNU General Public License
#     <http://www.gnu.org/licenses/>.
#
# Script
#     have_metis
#
# Description
#     Detection/setup of metis
#
# Requires
#     config.sh/metis
#
# Functions provided
#     have_metis, no_metis, echo_metis
#
# Variables set on success
#     HAVE_METIS
#     METIS_ARCH_PATH
#     METIS_INC_DIR
#     METIS_LIB_DIR
#
#------------------------------------------------------------------------------
. $WM_PROJECT_DIR/wmake/scripts/sysFunctions # General system functions

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

# Reset variables
no_metis()
{
    unset HAVE_METIS METIS_ARCH_PATH METIS_INC_DIR METIS_LIB_DIR
    unset METIS_VERSION
    return 0
}


# Report
echo_metis()
{
    echo "metis=${HAVE_METIS:-false}"
    echo "root=$METIS_ARCH_PATH"
    echo "include=$METIS_INC_DIR"
    echo "library=$METIS_LIB_DIR"
}


# On success, return 0 and export variables
# -> HAVE_METIS, METIS_ARCH_PATH, METIS_INC_DIR, METIS_LIB_DIR
have_metis()
{
    local prefix header library static settings warn
    warn="==> skip metis"

    # Setup
    if settings=$($WM_PROJECT_DIR/bin/foamEtcFile config.sh/metis)
    then
        . "$settings"
    else
        [ -n "$warn" ] && echo "$warn (no config.sh/metis settings)"
        return 2
    fi

    # Location
    prefix="$METIS_ARCH_PATH"

    # Header/library names
    header="metis.h"
    library="libmetis$extLibso"
    static="libmetis$extLiba"

    # ----------------------------------
    if isNone "$prefix"
    then
        [ -n "$warn" ] && echo "$warn (disabled)"
        return 1
    elif hasAbsdir "$prefix"
    then
        header=$(findFirstFile "$prefix/include/$header")

        library=$(findFirstFile \
            "$(thirdExtLib $library)" \
            "$prefix/lib/$static" \
            "$prefix/lib/$library" \
            "$prefix/lib$WM_COMPILER_LIB_ARCH/$static" \
            "$prefix/lib$WM_COMPILER_LIB_ARCH/$library" \
        )
    elif isSystem "$prefix"
    then
        prefix=/usr
        header=$(findFirstFile "/usr/local/include/$header" "/usr/include/$header")
        case "$header" in (/usr/local/*) prefix=/usr/local ;; esac

        library=$(findFirstFile \
            "$prefix/lib/$library" \
            "$prefix/lib$WM_COMPILER_LIB_ARCH/$library" \
        )
    else
        unset prefix header library
    fi
    # ----------------------------------

    # Header found?
    [ -n "$header" ] || {
        [ -n "$warn" ] && echo "$warn (no header)"
        return 2
    }

    # Library found?
    [ -n "$library" ] || {
        [ -n "$warn" ] && echo "$warn (no library)"
        return 2
    }


    local good label

    # Ensure consistent sizes between OpenFOAM and metis header
    # Extract IDXTYPEWIDTH from metis.h: regex as per ThirdParty Allwmake
    label=$(sed -ne \
        's/^.*#define  *IDXTYPEWIDTH  *\([1-9][0-9]\).*/\1/p' \
        "$header")
    : "${label:=unknown}"

    if [ "$WM_LABEL_SIZE" = "$label" ]
    then
        good=true
    else
        if [ -n "$warn" ]
        then
            echo "$warn (label=$WM_LABEL_SIZE, ${header##*/} has '$label')"
        fi
        no_metis
        return 1
    fi

    # OK
    echo "metis (label=$label) - $prefix"
    export HAVE_METIS=true
    export METIS_ARCH_PATH="$prefix"
    export METIS_INC_DIR="${header%/*}"     # Basename
    export METIS_LIB_DIR="${library%/*}"    # Basename
}


# Force reset of old variables
no_metis

# Testing
if [ "$1" = "-test" ]
then
    have_metis
    echo_metis
fi

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