# Copyright 2013-2023 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)

from spack.package import *


class Zsh(AutotoolsPackage):
    """Zsh is a shell designed for interactive use, although it is also a
    powerful scripting language. Many of the useful features of bash, ksh, and
    tcsh were incorporated into zsh; many original features were added.
    """

    homepage = "https://www.zsh.org"
    url = "http://downloads.sourceforge.net/project/zsh/zsh/5.4.2/zsh-5.4.2.tar.xz"

    license("custom")

    version("5.8", sha256="dcc4b54cc5565670a65581760261c163d720991f0d06486da61f8d839b52de27")
    version("5.7.1", sha256="7260292c2c1d483b2d50febfa5055176bd512b32a8833b116177bf5f01e77ee8")
    version("5.6.2", sha256="a50bd66c0557e8eca3b8fa24e85d0de533e775d7a22df042da90488623752e9e")
    version("5.4.2", sha256="a80b187b6b770f092ea1f53e89021d06c03d8bbe6a5e996bcca3267de14c5e52")
    version("5.3.1", sha256="fc886cb2ade032d006da8322c09a7e92b2309177811428b121192d44832920da")
    version("5.1.1", sha256="74e9453b5470b3c0970f9f93cfd603d241c3d7b1968adc0e4b3951073e8d3dec")

    # Testing for terminal related things causes failures in e.g. Jenkins.
    # See e.g. https://www.zsh.org/mla/users/2003/msg00845.html,
    # although the name of the option has evolved since then.
    variant("skip-tcsetpgrp-test", default=True, description="Skip configure's tcsetpgrp test")
    variant(
        "etcdir",
        default=False,
        description="enable etc dir local to install, for global zsh scripts",
    )
    variant("lmod", default=False, description="setup zshrc env for lmod support")

    depends_on("pcre")
    depends_on("ncurses")

    conflicts("+lmod", when="~etcdir", msg="local etc required to setup env for lmod")

    def configure_args(self):
        args = []

        if "+skip-tcsetpgrp-test" in self.spec:
            # assert that we have a functional tcsetpgrp
            args.append("--with-tcsetpgrp")

        if "+etcdir" in self.spec:
            # enable etc dir under install prefix
            mkdirp(self.prefix.etc)
            args.append("--enable-etcdir={0}".format(self.prefix.etc))

        return args

    @run_after("install")
    def setup_zshenv(self):
        if "+lmod" in self.spec:
            zsh_setup = """
if [ -d /etc/profile.d ]; then
  setopt no_nomatch
  for i in /etc/profile.d/*.sh; do
    if [ -r $i ]; then
      . $i
    fi
  done
  setopt nomatch
fi
"""

            with open("{0}/zshenv".format(self.prefix.etc), "w") as zshenv:
                zshenv.write(zsh_setup)