from typing import List
import subprocess
import os
import shutil

from .base import Simulator

class XilinxXSIM(Simulator):
    """
    Avoid using the Xilinx simulator... Its buggy and extraordinarily slow.
    As observed in v2023.2:
        - Clocking block assignments to struct members do not simulate correctly.
          assignment statements get lost.
            https://support.xilinx.com/s/question/0D54U00007ZIGfXSAX/xsim-bug-xsim-does-not-simulate-struct-assignments-in-clocking-blocks-correctly?language=en_US
        - Streaming bit-swap within a conditional returns a corrupted value
            https://support.xilinx.com/s/question/0D54U00007ZIIBPSA5/xsim-bug-xsim-corrupts-value-of-signal-that-is-bitswapped-within-a-conditional-operator?language=en_US
    """
    name = "xsim"

    @classmethod
    def is_installed(cls) -> bool:
        return (
            shutil.which("xvlog") is not None
            and shutil.which("xelab") is not None
            and shutil.which("xsim") is not None
        )

    def compile(self) -> None:
        cmd = [
            "xvlog", "--sv",
            "--log", "compile.log",
            "--include", os.path.join(os.path.dirname(__file__), ".."),
            "--define", "XILINX_XSIM",
        ]
        cmd.extend(self.tb_files)
        subprocess.run(cmd, check=True)

        cmd = [
            "xelab",
            "--log", "elaborate.log",
            "--timescale", "1ps/1ps",
            "--debug", "all",
            "tb",
        ]
        subprocess.run(cmd, check=True)


    def run(self, plusargs:List[str] = None) -> None:
        plusargs = plusargs or []

        test_name = self.testcase.request.node.name

        # call xsim
        cmd = ["xsim"]
        if self.gui_mode:
            cmd.append("--gui")
        else:
            cmd.append("-R")

        cmd.extend([
            "--log", "%s.log" % test_name,
            "tb",
        ])

        for plusarg in plusargs:
            cmd.append("--testplusarg")
            cmd.append(plusarg)
        subprocess.run(cmd, check=True)

        self.assertSimLogPass("%s.log" % test_name)


    def assertSimLogPass(self, path: str):
        self.testcase.assertTrue(os.path.isfile(path))

        with open(path, encoding="utf-8") as f:
            for line in f:
                if line.startswith("Error:"):
                    self.testcase.fail(line)
                elif line.startswith("Fatal:"):
                    self.testcase.fail(line)
                elif line.startswith("FATAL_ERROR:"):
                    self.testcase.fail(line)