Source code for varats.projects.cpp_projects.fmt

"""Project file for fmt."""

import benchbuild as bb
from benchbuild.utils.cmd import cmake, make
from benchbuild.utils.settings import get_number_of_jobs
from plumbum import local

from varats.containers.containers import ImageBase, get_base_image
from varats.paper.paper_config import PaperConfigSpecificGit
from varats.project.project_domain import ProjectDomains
from varats.project.project_util import (
    BinaryType,
    ProjectBinaryWrapper,
    RevisionBinaryMap,
    get_local_project_repo,
    verify_binaries,
)
from varats.project.varats_project import VProject
from varats.utils.git_util import ShortCommitHash
from varats.utils.settings import bb_cfg




class Fmt(VProject):
    """A modern formatting library."""

    NAME = 'fmt'
    GROUP = 'cpp_projects'
    DOMAIN = ProjectDomains.CPP_LIBRARY

    SOURCE = [
        PaperConfigSpecificGit(
            project_name="fmt",
            remote="https://github.com/fmtlib/fmt.git",
            local="fmt",
            refspec="origin/HEAD",
            limit=None,
            shallow=False,
        )
    ]

    CONTAINER = get_base_image(ImageBase.DEBIAN_12).run(
        'apt', 'install', '-y', 'cmake'
    )

    @staticmethod
    def binaries_for_revision(
        revision: ShortCommitHash,
    ) -> list[ProjectBinaryWrapper]:
        """Returns a list of binaries for the given revision."""
        binary_map = RevisionBinaryMap(get_local_project_repo(Fmt.NAME))

        binary_map.specify_binary('build/libfmt.a', BinaryType.STATIC_LIBRARY)

        return binary_map[revision]

    def run_tests(self) -> None:
        """Run the tests for the project."""
        pass

    def compile(self) -> None:
        """Compile the project."""
        fmt_source = local.path(self.primary_source)

        c_compiler = bb.compiler.cc(self)
        cxx_compiler = bb.compiler.cxx(self)
        build_folder = fmt_source / "build"
        build_folder.mkdir()
        with local.cwd(build_folder):
            with local.env(CC=str(c_compiler), CXX=str(cxx_compiler)):
                bb.watch(cmake)("..")

            bb.watch(make)("-j", get_number_of_jobs(bb_cfg()))

        with local.cwd(fmt_source):
            verify_binaries(self)