##############################################################################
# Copyright (c) 2013-2018, Lawrence Livermore National Security, LLC.
# Produced at the Lawrence Livermore National Laboratory.
#
# This file is part of Spack.
# Created by Todd Gamblin, tgamblin@llnl.gov, All rights reserved.
# LLNL-CODE-647188
#
# For details, see https://github.com/spack/spack
# Please also see the NOTICE and LICENSE files for our notice and the LGPL.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License (as
# published by the Free Software Foundation) version 2.1, February 1999.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the IMPLIED WARRANTY OF
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the terms and
# conditions of the GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##############################################################################
from spack import *
import os


class EnvironmentModules(Package):
    """The Environment Modules package provides for the dynamic
    modification of a user's environment via modulefiles."""

    homepage = "https://sourceforge.net/p/modules/wiki/Home/"
    url = "http://prdownloads.sourceforge.net/modules/modules-3.2.10.tar.gz"

    version('3.2.10', '8b097fdcb90c514d7540bb55a3cb90fb')

    variant('X', default=True, description='Build with X functionality')

    # Dependencies:
    depends_on('tcl', type=('build', 'link', 'run'))

    def install(self, spec, prefix):
        tcl_spec = spec['tcl']

        # We are looking for tclConfig.sh
        tcl_config_name = 'tclConfig.sh'
        tcl_config_dir_options = [tcl_spec.prefix.lib,
                                  tcl_spec.prefix.lib64]

        tcl_config_found = False
        for tcl_config_dir in tcl_config_dir_options:
            tcl_config_found = os.path.exists(
                join_path(tcl_config_dir, tcl_config_name))
            if tcl_config_found:
                break

        if not tcl_config_found:
            raise InstallError('Failed to locate ' + tcl_config_name)

        # See: https://sourceforge.net/p/modules/bugs/62/
        cpp_flags = ['-DUSE_INTERP_ERRORLINE']

        config_args = [
            "--without-tclx",
            "--with-tclx-ver=0.0",
            "--prefix=" + prefix,
            # It looks for tclConfig.sh
            "--with-tcl=" + tcl_config_dir,
            "--with-tcl-ver=%d.%d" % (
                tcl_spec.version.version[0], tcl_spec.version.version[1]),
            '--disable-debug',
            '--disable-dependency-tracking',
            '--disable-silent-rules',
            '--disable-versioning',
            '--datarootdir=' + prefix.share,
            'CPPFLAGS=' + ' '.join(cpp_flags)
        ]

        if '~X' in spec:
            config_args = ['--without-x'] + config_args

        configure(*config_args)
        make()
        make('install')
