# Copyright 2013-2024 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
import os
import re

import spack.build_systems.autotools
from spack.package import *


class Swig(AutotoolsPackage, SourceforgePackage):
    """SWIG is an interface compiler that connects programs written in
    C and C++ with scripting languages such as Perl, Python, Ruby,
    and Tcl. It works by taking the declarations found in C/C++
    header files and using them to generate the wrapper code that
    scripting languages need to access the underlying C/C++
    code. In addition, SWIG provides a variety of customization
    features that let you tailor the wrapping process to suit your
    application."""

    homepage = "http://www.swig.org"
    sourceforge_mirror_path = "swig/swig-3.0.12.tar.gz"
    maintainers("sethrj")

    tags = ["e4s", "build-tools"]

    executables = ["^swig$"]

    license("GPL-3.0-only")

    version("master", git="https://github.com/swig/swig.git")
    version(
        "4.1.1",
        sha256="2af08aced8fcd65cdb5cc62426768914bedc735b1c250325203716f78e39ac9b",
        preferred=True,
    )
    version("4.1.0", sha256="d6a9a8094e78f7cfb6f80a73cc271e1fe388c8638ed22668622c2c646df5bb3d")
    version("4.0.2", sha256="d53be9730d8d58a16bf0cbd1f8ac0c0c3e1090573168bfa151b01eb47fa906fc")
    version("4.0.1", sha256="7a00b4d0d53ad97a14316135e2d702091cd5f193bb58bcfcd8bc59d41e7887a9")
    version("4.0.0", sha256="e8a39cd6437e342cdcbd5af27a9bf11b62dc9efec9248065debcb8276fcbb925")
    version("3.0.12", sha256="7cf9f447ae7ed1c51722efc45e7f14418d15d7a1e143ac9f09a668999f4fc94d")
    version("3.0.11", sha256="d9031d531d7418829a54d0d51c4ed9007016b213657ec70be44031951810566e")
    version("3.0.10", sha256="2939aae39dec06095462f1b95ce1c958ac80d07b926e48871046d17c0094f44c")
    version("3.0.8", sha256="58a475dbbd4a4d7075e5fe86d4e54c9edde39847cdb96a3053d87cb64a23a453")
    version("3.0.2", sha256="a2669657cabcedc371f63c0457407a183e0b6b2ef4e7e303c1ec9a3964cc7813")
    version("2.0.12", sha256="65e13f22a60cecd7279c59882ff8ebe1ffe34078e85c602821a541817a4317f7")
    version("2.0.2", sha256="6e6b5e8db2bbf2761ff789a3109e4f12ca664ec178d3a164ed0dc273d346c11f")
    version("1.3.40", sha256="1945b3693bcda6777bd05fef1015a0ad1a4604cde4a4a0a368b61ccfd143ac09")
    version("fortran", branch="master", git="https://github.com/swig-fortran/swig.git")
    version(
        "4.1.1-fortran",
        sha256="417ea6adde3e6bf7825b2f670d2eac36257cc50db0e2f84c5bd4d67a16a7e88f",
        url="https://github.com/swig-fortran/swig/archive/refs/tags/v4.1.1+fortran.tar.gz",
    )
    version(
        "4.1.0-fortran",
        sha256="f15521b10e7ef3b2a41dd0d81de0b1355a94495e481d201db4247e073a6f2d9b",
        url="https://github.com/swig-fortran/swig/archive/refs/tags/v4.1.0+fortran.tar.gz",
    )
    version(
        "4.1.dev1-fortran",
        sha256="d9020319771879b41f9545e95f9d252a3ffc379832dded14c385e5cd823e526d",
        url="https://github.com/swig-fortran/swig/archive/refs/tags/v4.1.0-dev1+fortran.tar.gz",
    )
    version(
        "4.0.2-fortran",
        sha256="2d65ebe82274da294709254703f9ac2333fd39286b9375b0d89182385aac548e",
        url="https://github.com/swig-fortran/swig/archive/v4.0.2+fortran.tar.gz",
    )

    depends_on("pcre", when="@:4.0")
    depends_on("pcre2", when="@4.1:")
    depends_on("zlib-api")

    AUTOCONF_VERSIONS = "@" + ",".join(
        [
            "master",
            "fortran",
            "4.0.2-fortran",
            "4.1.dev1-fortran",
            "4.1.0-fortran",
            "4.1.1-fortran",
        ]
    )

    # Git releases do *not* include configure script
    depends_on("autoconf", type="build", when=AUTOCONF_VERSIONS)
    depends_on("automake", type="build", when=AUTOCONF_VERSIONS)
    depends_on("libtool", type="build", when=AUTOCONF_VERSIONS)
    depends_on("yacc", type="build", when=AUTOCONF_VERSIONS)

    # Need newer 'automake' to support newer platforms
    for _target in ["ppc64le", "aarch64"]:
        depends_on("automake@1.15:", type="build", when="target={0}:".format(_target))
    depends_on("pkgconfig", type="build")

    conflicts("%nvhpc", when="@:4.0.2")

    @classmethod
    def determine_version(cls, exe):
        output = Executable(exe)("-version", output=str, error=str)
        match = re.search(r"SWIG\s+Version\s+(\S+)", output)
        return match.group(1) if match else None

    @property
    def _swig(self):
        return Executable(join_path(self.prefix, "bin", "swig"))

    @property
    def _swiglib(self):
        return self._swig("-swiglib", output=str).strip()

    def test_version(self):
        """check swig version"""
        version = str(self.version)
        if version.endswith("-fortran"):
            version = version.replace("-", r"+")
        elif version in ("fortran", "master"):
            version = ""

        out = self._swig("-version", output=str.split, error=str.split)
        expected = f"SWIG Version {version}"
        assert expected in out, f"Expected '{expected}' in output"

    def test_swiglib(self):
        """check that the lib dir exists"""
        assert os.path.isdir(self._swiglib), f"SWIG library does not exist at '{swiglib}'"

    def test_swig_swg(self):
        """check that swig.swg exists"""
        swigfile = join_path(self._swiglib, "swig.swg")
        assert os.path.exists(swigfile), f"SWIG runtime does not exist at '{swigfile}'"

    def test_fortran_swg(self):
        """check that fortran.swg exists"""
        if "fortran" not in str(self.version):
            raise SkipTest(f"Test does not work with version {self.version}")

        swigfile = join_path(self._swiglib, "fortran", "fortran.swg")
        assert os.path.exists(swigfile), f"SWIG+Fortran runtime does not exist at '{swigfile}'"


class AutotoolsBuilder(spack.build_systems.autotools.AutotoolsBuilder):
    build_directory = "spack-build"

    @run_after("install")
    def create_symlink(self):
        # CMake compatibility: see https://github.com/spack/spack/pull/6240
        with working_dir(self.prefix.bin):
            os.symlink("swig", "swig{0}".format(self.spec.version.up_to(2)))

    @when(Swig.AUTOCONF_VERSIONS)
    def autoreconf(self, pkg, spec, prefix):
        which("sh")("./autogen.sh")