spack/var/spack/repos/builtin/packages/graphviz/package.py

# 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 sys

from spack.operating_systems.mac_os import macos_version
from spack.package import *

MACOS_VERSION = macos_version() if sys.platform == "darwin" else None


class Graphviz(AutotoolsPackage):
    """Graph Visualization Software"""

    homepage = "http://www.graphviz.org"
    git = "https://gitlab.com/graphviz/graphviz.git"
    url = "https://gitlab.com/graphviz/graphviz/-/archive/2.46.0/graphviz-2.46.0.tar.bz2"

    license("EPL-1.0")

    version("8.0.5", sha256="c1901fe52483fad55fbf893ccd59a3dcaedd53f0d50b5aebbbf3deaba93b674d")
    version("8.0.1", sha256="19928f09f759676578b50101420b24475eb35f712ffbe8a97254f64b20fdbd03")
    version("7.1.0", sha256="7943c3fa0c55c779f595259f3b9e41c7ea6ed92f0aca0d24df917f631322dc01")
    version("2.49.0", sha256="b129555743bb9bfb7b63c55825da51763b2f1ee7c0eaa6234a42a61a3aff6cc9")
    version("2.47.2", sha256="b5ebb00d4283c6d12cf16b2323e1820b535cc3823c8f261b783f7903b1d5b7fb")
    version("2.46.0", sha256="1b11684fd5488940b45bf4624393140da6032abafae08f33dc3e986cffd55d71")
    version("2.44.1", sha256="0f8f3fbeaddd474e0a270dc9bb0e247a1ae4284ae35125af4adceffae5c7ae9b")
    version("2.42.4", sha256="a1ca0c4273d96bbf32fbfcbb784c8da2e38da13e7d2bbf9b24fe94ae45e79c4c")
    version("2.40.1", sha256="581596aaeac5dae3f57da6ecde62ad7709a992df341e8f7c6177b41e8b1ae4f6")
    version(
        "2.38.0",
        sha256="c1b1e326b5d1f45b0ce91edd7acc68e80ff6be6b470008766e4d466aafc9801f",
        deprecated=True,
    )

    depends_on("c", type="build")  # generated
    depends_on("cxx", type="build")  # generated

    # Language bindings
    language_bindings = ["java"]

    # Additional language bindings are nominally supported by GraphViz via SWIG
    # but are untested and need the proper dependencies added:
    # language_bindings += ['sharp', 'go', 'guile', 'io', 'lua', 'ocaml',
    #                       'perl', 'php', 'python', 'r', 'ruby', 'tcl']

    for lang in language_bindings:
        variant(
            lang,
            default=False,
            description="Enable for optional {0} language " "bindings".format(lang),
        )

    # Feature variants
    variant("doc", default=False, description="Build and install graphviz documentation")
    variant(
        "expat", default=False, description="Build with Expat support (enables HTML-like labels)"
    )
    variant("gts", default=False, description="Build with GNU Triangulated Surface Library")
    variant("ghostscript", default=False, description="Build with Ghostscript support")
    variant("gtkplus", default=False, description="Build with GTK+ support")
    variant("libgd", default=False, description="Build with libgd support (more output formats)")
    variant(
        "pangocairo",
        default=False,
        description="Build with pango+cairo support (more output formats)",
    )
    variant("poppler", default=False, description="Build with poppler support (pdf formats)")
    variant("qt", default=False, description="Build with Qt support")
    variant(
        "quartz",
        default=(MACOS_VERSION is not None),
        description="Build with Quartz and PDF support",
    )
    variant("x", default=False, description="Use the X Window System")

    patch(
        "https://www.linuxfromscratch.org/patches/blfs/9.0/graphviz-2.40.1-qt5-1.patch",
        sha256="bd532df325df811713e311d17aaeac3f5d6075ea4fd0eae8d989391e6afba930",
        when="@:2.40+qt^qt@5:",
    )
    patch(
        "https://raw.githubusercontent.com/easybuilders/easybuild-easyconfigs/master/easybuild/easyconfigs/g/Graphviz/Graphviz-2.38.0_icc_sfio.patch",
        sha256="393a0a772315a89dcc970b5efd4765d22dba83493d7956303673eb89c45b949f",
        level=0,
        when="@:2.40%intel",
    )
    patch(
        "https://raw.githubusercontent.com/easybuilders/easybuild-easyconfigs/master/easybuild/easyconfigs/g/Graphviz/Graphviz-2.40.1_icc_vmalloc.patch",
        sha256="813e6529e79161a18b0f24a969b7de22f8417b2e942239e658b5402884541bc2",
        when="@:2.40%intel",
    )
    patch("ps2pdf.patch", when="@:2.45")
    patch("implicit.patch", level=0, when="@:2.44.0")

    if not MACOS_VERSION:
        conflicts("+quartz", msg="Graphviz can only be build with Quartz on macOS.")
    elif MACOS_VERSION >= Version("10.9"):
        # Doesn't detect newer mac os systems as being new
        patch("fix-quartz-darwin.patch", when="@:2.47.2")

    # Language dependencies
    for lang in language_bindings:
        depends_on("swig", when=("+" + lang))
        depends_on(lang, when=("+" + lang))

    # Feature dependencies
    depends_on("zlib-api")
    depends_on("groff", type="build", when="+doc")
    depends_on("ghostscript", type="build", when="+doc")
    depends_on("expat", when="+expat")
    depends_on("libgd", when="+libgd")
    depends_on("fontconfig", when="+libgd")
    depends_on("freetype", when="+libgd")
    depends_on("ghostscript", when="+ghostscript")
    depends_on("gtkplus", when="+gtkplus")
    depends_on("gts", when="+gts")
    depends_on("cairo+pdf+png", when="+pangocairo")
    depends_on("fontconfig", when="+pangocairo")
    depends_on("freetype", when="+pangocairo")
    depends_on("glib", when="+pangocairo")
    depends_on("libpng", when="+pangocairo")
    depends_on("pango", when="+pangocairo")
    depends_on("poppler", when="+poppler")
    depends_on("qt", when="+qt")
    depends_on("libx11", when="+x")

    # Build dependencies (graphviz binaries don't include configure file)
    depends_on("automake", type="build")
    depends_on("autoconf", type="build")
    depends_on("bison@3.0.4:", type="build")
    depends_on("flex", type="build")
    depends_on("sed", type="build")
    depends_on("libtool", type="build")
    depends_on("pkgconfig", type="build")
    # to process f-strings used in gen_version.py
    depends_on("python@3.6:", when="@2.47:", type="build")

    conflicts("~doc", when="@:2.45", msg="graphviz always builds documentation below version 2.46")
    conflicts(
        "%gcc@:5.9",
        when="@2.40.1+qt ^qt@5:",
        msg="graphviz-2.40.1 needs gcc-6 or greater to compile with QT5 " "suppport",
    )

    def autoreconf(self, spec, prefix):
        # We need to generate 'configure' when checking out sources from git
        # If configure exists nothing needs to be done
        if os.path.exists(self.configure_abs_path):
            return
        # Else bootstrap (disabling auto-configure with NOCONFIG)
        bash = which("bash")
        bash("./autogen.sh", "NOCONFIG")

    def setup_build_environment(self, env):
        # Set MACOSX_DEPLOYMENT_TARGET to 10.x due to old configure
        super().setup_build_environment(env)

        if "+quartz" in self.spec:
            env.set("OBJC", self.compiler.cc)

    @when("%clang platform=darwin")
    def patch(self):
        # When using Clang, replace GCC's libstdc++ with LLVM's libc++
        mkdirs = ["cmd/dot", "cmd/edgepaint", "cmd/mingle", "plugin/gdiplus"]
        filter_file(r"-lstdc\+\+", "-lc++", "configure.ac", *(d + "/Makefile.am" for d in mkdirs))

    @when("%apple-clang")
    def patch(self):
        # When using Clang, replace GCC's libstdc++ with LLVM's libc++
        mkdirs = ["cmd/dot", "cmd/edgepaint", "cmd/mingle", "plugin/gdiplus"]
        filter_file(r"-lstdc\+\+", "-lc++", "configure.ac", *(d + "/Makefile.am" for d in mkdirs))

    def configure_args(self):
        spec = self.spec
        args = ["--disable-silent-rules"]

        use_swig = False
        for lang in self.language_bindings:
            if "+" + lang in spec:
                use_swig = True
                args.append("--enable-" + lang)

        args.append("--{0}-swig".format("enable" if use_swig else "disable"))

        for var in [
            "expat",
            "gts",
            "ghostscript",
            "libgd",
            "pangocairo",
            "poppler",
            "qt",
            "quartz",
            "x",
        ]:
            args += self.with_or_without(var)
        for var in ("expat", "java"):
            if "+" + var in spec:
                args.append("--with-{0}includedir={1}".format(var, spec[var].prefix.include))
                args.append("--with-{0}libdir={1}".format(var, spec[var].prefix.lib))

        if "+zlib" in spec:
            args.append("--with-zlibincludedir={}".format(spec["zlib-api"].prefix.include))
            args.append("--with-zliblibdir={}".format(spec["zlib-api"].prefix.lib))

        args.append("--{0}-gtk".format("with" if "+gtkplus" in spec else "without"))

        if spec.version >= Version("2.46"):
            args.append("--{0}-man-pdfs".format("enable" if "+doc" in spec else "disable"))

        return args