vunit-hdl 5.0.0.dev2__tar.gz → 5.0.0.dev4__tar.gz

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vunit_hdl
-Version: 5.0.0.dev2
+Version: 5.0.0.dev4
 Summary: VUnit is an open source unit testing framework for VHDL/SystemVerilog.
 Home-page: https://github.com/VUnit/vunit
 Author: Lars Asplund
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Operating System :: POSIX :: Linux

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/pyproject.toml

@@ -54,7 +54,7 @@ underlines = ["-", "~"]
 [tool.tox]
 legacy_tox_ini = """
 [tox]
-envlist = py{36,37,38,39,310,311,312}-{fmt,unit,lint,docs}, py{36,37,38,39,310,311,312}-{acceptance,vcomponents}-{activehdl,ghdl,modelsim,nvc,rivierapro}, py{36,37,38,39,310,311,312}-coverage
+envlist = py{36,37,38,39,310,311,312,313}-{fmt,unit,lint,docs}, py{36,37,38,39,310,311,312,313}-{acceptance,vcomponents}-{activehdl,ghdl,modelsim,nvc,rivierapro}, py{36,37,38,39,310,311,312,313}-coverage
 isolated_build = True
 
 [testenv]

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/setup.py

@@ -71,6 +71,7 @@ setup(
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
         "Operating System :: Microsoft :: Windows",
         "Operating System :: MacOS :: MacOS X",
         "Operating System :: POSIX :: Linux",

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/tests/acceptance/test_artificial.py

@@ -129,6 +129,7 @@ class TestVunitArtificial(unittest.TestCase):
                 ("passed", "lib.tb_magic_paths.Test magic paths are correct"),
                 ("passed", "lib.tb_with_define.test 1"),
                 ("failed", "lib.tb_fail_on_warning.fail"),
+                ("failed", "lib.tb_fail_on_warning_from_python.fail"),
                 ("failed", "lib.tb_fail_on_fatal_and_early_finish.fatal0"),
                 ("failed", "lib.tb_fail_on_fatal_and_early_finish.fatal1"),
                 ("failed", "lib.tb_fail_on_fatal_and_early_finish.finish0"),
@@ -144,6 +145,12 @@ class TestVunitArtificial(unittest.TestCase):
                 ("passed", "lib.tb_same_sim_some_fail.Test 1"),
                 ("failed", "lib.tb_same_sim_some_fail.Test 2"),
                 ("skipped", "lib.tb_same_sim_some_fail.Test 3"),
+                ("passed", "lib.tb_same_sim_from_python_all_pass.cfg.Test 1"),
+                ("passed", "lib.tb_same_sim_from_python_all_pass.cfg.Test 2"),
+                ("passed", "lib.tb_same_sim_from_python_all_pass.cfg.Test 3"),
+                ("passed", "lib.tb_same_sim_from_python_some_fail.Test 1"),
+                ("failed", "lib.tb_same_sim_from_python_some_fail.Test 2"),
+                ("skipped", "lib.tb_same_sim_from_python_some_fail.Test 3"),
                 ("passed", "lib.tb_with_runner.pass"),
                 ("failed", "lib.tb_with_runner.fail"),
             ],
@@ -183,7 +190,9 @@ EXPECTED_REPORT = (
     ("failed", "lib.tb_fail.all"),
     ("passed", "lib.tb_infinite_events.all"),
     ("failed", "lib.tb_fail_on_warning.all"),
-    ("passed", "lib.tb_no_fail_on_warning.all"),
+    ("failed", "lib.tb_fail_on_warning_from_python.all"),
+    ("passed", "lib.tb_no_fail_on_warning.cfg1"),
+    ("passed", "lib.tb_no_fail_on_warning.cfg2"),
     ("passed", "lib.tb_with_vhdl_runner.pass"),
     ("passed", "lib.tb_with_vhdl_runner.Test with spaces"),
     ("failed", "lib.tb_with_vhdl_runner.fail"),
@@ -197,6 +206,12 @@ EXPECTED_REPORT = (
     ("passed", "lib.tb_same_sim_some_fail.Test 1"),
     ("failed", "lib.tb_same_sim_some_fail.Test 2"),
     ("skipped", "lib.tb_same_sim_some_fail.Test 3"),
+    ("passed", "lib.tb_same_sim_from_python_all_pass.cfg.Test 1"),
+    ("passed", "lib.tb_same_sim_from_python_all_pass.cfg.Test 2"),
+    ("passed", "lib.tb_same_sim_from_python_all_pass.cfg.Test 3"),
+    ("passed", "lib.tb_same_sim_from_python_some_fail.Test 1"),
+    ("failed", "lib.tb_same_sim_from_python_some_fail.Test 2"),
+    ("skipped", "lib.tb_same_sim_from_python_some_fail.Test 3"),
     ("passed", "lib.tb_with_checks.Test passing check"),
     ("failed", "lib.tb_with_checks.Test failing check"),
     ("failed", "lib.tb_with_checks.Test non-stopping failing check"),

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/tests/unit/test_ghdl_interface.py

@@ -27,22 +27,6 @@ class TestGHDLInterface(unittest.TestCase):
     Test the GHDL interface
     """
 
-    @mock.patch("vunit.sim_if.ghdl.GHDLInterface.find_executable")
-    def test_runtime_error_on_missing_gtkwave(self, find_executable):
-        executables = {}
-
-        def find_executable_side_effect(name):
-            return executables[name]
-
-        find_executable.side_effect = find_executable_side_effect
-
-        executables["gtkwave"] = ["path"]
-        GHDLInterface(prefix="prefix", output_path="")
-
-        executables["gtkwave"] = []
-        GHDLInterface(prefix="prefix", output_path="")
-        self.assertRaises(RuntimeError, GHDLInterface, prefix="prefix", output_path="", gui=True)
-
     @mock.patch("subprocess.check_output", autospec=True)
     def test_parses_llvm_backend(self, check_output):
         version = b"""\

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/tests/unit/test_modelsim_interface.py

@@ -18,6 +18,7 @@ from tests.common import set_env
 from vunit.sim_if.modelsim import ModelSimInterface
 from vunit.project import Project
 from vunit.ostools import renew_path, write_file
+from vunit.test.bench import Configuration
 from vunit.vhdl_standard import VHDL
 
 
@@ -316,14 +317,61 @@ class TestModelSimInterface(unittest.TestCase):
         with open(modelsim_ini, "r") as fptr:
             self.assertEqual(fptr.read(), "user")
 
+    @mock.patch("vunit.sim_if.modelsim.LOGGER", autospec=True)
+    @mock.patch("vunit.sim_if.check_output", autospec=True, return_value="")
+    @mock.patch("vunit.sim_if.modelsim.Process", autospec=True)
+    @mock.patch("vunit.sim_if.vsim_simulator_mixin.Process", autospec=True)
+    def test_optimize(self, vsim_simulator_mixin_process, modelsim_process, check_output, LOGGER):
+        simif = ModelSimInterface(prefix=self.prefix_path, output_path=self.output_path, persistent=False)
+        project = Project()
+        project.add_library("lib", str(Path(self.libraries_path) / "lib"))
+        write_file("file.vhd", "")
+        project.add_source_file("file.vhd", "lib", file_type="vhdl", vhdl_standard=VHDL.standard("2008"))
+        simif.compile_project(project)
+        config = make_config(sim_options={"modelsim.three_step_flow": True})
+
+        # First call should optimize design
+        simif.simulate(self.simulation_output_path, "test_suite_name", config, False)
+        design_to_optimize = "lib.tb(test)"
+        expected_calls = [
+            mock.call("%s scheduled for optimization.", design_to_optimize),
+            mock.call("Acquired library lock for %s to optimize %s.", "lib", design_to_optimize),
+            mock.call("Optimizing %s.", design_to_optimize),
+            mock.call("%s optimization completed.", design_to_optimize),
+        ]
+        self.assertEqual(LOGGER.debug.call_count, len(expected_calls))
+        LOGGER.debug.assert_has_calls(expected_calls)
+
+        # Second call should reuse the already optimized design
+        LOGGER.reset_mock()
+        simif.simulate(self.simulation_output_path, "test_suite_name", config, False)
+        LOGGER.debug.assert_called_once_with("Reusing optimized %s.", "lib.tb(test)")
+
+        # Fake that design is being optimized and that it is being waited for
+        LOGGER.reset_mock()
+        simif._optimized_designs[design_to_optimize]["optimized_design"] = None
+        simif.simulate(self.simulation_output_path, "test_suite_name", config, False)
+        expected_debug_calls = [mock.call("Waiting for %s to be optimized.", design_to_optimize)]
+        self.assertEqual(LOGGER.debug.call_count, len(expected_debug_calls))
+        LOGGER.debug.assert_has_calls(expected_debug_calls)
+        expected_error_calls = [
+            mock.call("Failed waiting for %s to be optimized (optimization failed).", design_to_optimize)
+        ]
+        self.assertEqual(LOGGER.error.call_count, len(expected_error_calls))
+        LOGGER.error.assert_has_calls(expected_error_calls)
+
     def setUp(self):
         self.test_path = str(Path(__file__).parent / "test_modelsim_out")
 
         self.output_path = str(Path(self.test_path) / "modelsim")
         self.prefix_path = str(Path(self.test_path) / "prefix" / "bin")
+        self.libraries_path = str(Path(self.output_path) / "libraries")
+        self.simulation_output_path = str(Path(self.test_path) / "test_output" / "lib.tb")
         renew_path(self.test_path)
         renew_path(self.output_path)
         renew_path(self.prefix_path)
+        renew_path(self.libraries_path)
+        renew_path(self.simulation_output_path)
         installed_modelsim_ini = str(Path(self.prefix_path) / ".." / "modelsim.ini")
         write_file(installed_modelsim_ini, "[Library]")
         self.project = Project()
@@ -334,3 +382,24 @@ class TestModelSimInterface(unittest.TestCase):
         os.chdir(self.cwd)
         if Path(self.test_path).exists():
             rmtree(self.test_path)
+
+
+def make_config(sim_options=None, generics=None, verilog=False):
+    """
+    Utility to reduce boiler plate in tests
+    """
+    cfg = mock.Mock(spec=Configuration)
+    cfg.library_name = "lib"
+
+    if verilog:
+        cfg.entity_name = "tb"
+        cfg.architecture_name = None
+    else:
+        cfg.entity_name = "tb"
+        cfg.architecture_name = "test"
+
+    cfg.sim_options = {} if sim_options is None else sim_options
+    cfg.generics = {} if generics is None else generics
+    cfg.vhdl_configuration_name = None
+    cfg.vhdl_assert_stop_level = "error"
+    return cfg

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/tests/unit/test_test_bench.py

@@ -273,6 +273,24 @@ if run("Test_2")
         tests = self.create_tests(test_bench)
         self.assert_has_tests(tests, [("lib.tb_entity", ("lib.tb_entity.Test_1", "lib.tb_entity.Test_2"))])
 
+    @with_tempdir
+    def test_that_run_in_same_simulation_attribute_from_python_works(self, tempdir):
+        for value in [None, True]:
+            design_unit = Entity(
+                "tb_entity",
+                file_name=str(Path(tempdir) / "file.vhd"),
+                contents="""\
+if run("Test_1")
+if run("Test_2")
+--if run("Test_3")
+""",
+            )
+            design_unit.generic_names = ["runner_cfg"]
+            test_bench = TestBench(design_unit)
+            test_bench.set_attribute("run_all_in_same_sim", value)
+            tests = self.create_tests(test_bench)
+            self.assert_has_tests(tests, [("lib.tb_entity", ("lib.tb_entity.Test_1", "lib.tb_entity.Test_2"))])
+
     @with_tempdir
     def test_add_config(self, tempdir):
         design_unit = Entity("tb_entity", file_name=str(Path(tempdir) / "file.vhd"))
@@ -451,6 +469,22 @@ if run("Test 2")
         else:
             assert False, "RuntimeError not raised"
 
+    @with_tempdir
+    def test_error_on_global_attributes_from_python_on_tests(self, tempdir):
+        design_unit = Entity(
+            "tb_entity",
+            file_name=str(Path(tempdir) / "file.vhd"),
+            contents="""\
+if run("Test 1")
+if run("Test 2")
+""",
+        )
+        design_unit.generic_names = ["runner_cfg"]
+
+        test_bench = TestBench(design_unit)
+        test = test_bench.get_test_case("Test 1")
+        self.assertRaises(AttributeException, test.set_attribute, "run_all_in_same_sim", True)    
+
     @with_tempdir
     def test_test_information(self, tempdir):
         file_name = str(Path(tempdir) / "file.vhd")

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/vunit/about.py

@@ -69,4 +69,4 @@ def version():
     return VERSION
 
 
-VERSION = "5.0.0.dev2"
+VERSION = "5.0.0.dev4"

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/vunit/cached.py

@@ -13,7 +13,7 @@ from vunit.hashing import hash_string
 from vunit.ostools import read_file
 
 
-def cached(key, function, file_name, encoding, database=None, newline=None):
+def cached(key, function, file_name, encoding, *, database=None, newline=None):
     """
     Call function with file content if an update is needed
     """

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/vunit/configuration.py

@@ -34,6 +34,7 @@ class Configuration(object):  # pylint: disable=too-many-instance-attributes
         self,
         name,
         design_unit,
+        *,
         generics=None,
         sim_options=None,
         pre_config=None,
@@ -282,6 +283,7 @@ class ConfigurationVisitor(object):
     def add_config(  # pylint: disable=too-many-arguments
         self,
         name,
+        *,
         generics=None,
         pre_config=None,
         post_check=None,

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/vunit/design_unit.py

@@ -52,6 +52,7 @@ class VHDLDesignUnit(DesignUnit):
         name,
         source_file,
         unit_type,
+        *,
         is_primary=True,
         primary_design_unit=None,
     ):
@@ -66,7 +67,7 @@ class Entity(VHDLDesignUnit):
     """
 
     def __init__(self, name, source_file, generic_names=None):
-        VHDLDesignUnit.__init__(self, name, source_file, "entity", True)
+        VHDLDesignUnit.__init__(self, name, source_file, "entity", is_primary=True)
         self.generic_names = [] if generic_names is None else generic_names
         self._add_architecture_callback = None
         self._architecture_names = {}

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/vunit/parsing/verilog/parser.py

@@ -164,6 +164,7 @@ class VerilogDesignFile(object):
 
     def __init__(  # pylint: disable=too-many-arguments
         self,
+        *,
         modules=None,
         packages=None,
         imports=None,

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/vunit/parsing/verilog/preprocess.py

@@ -81,7 +81,7 @@ class VerilogPreprocessor(object):
 
         return result
 
-    def preprocessor(  # pylint: disable=too-many-arguments,too-many-branches
+    def preprocessor(  # pylint: disable=too-many-arguments,too-many-branches,too-many-positional-arguments
         self, token, stream, defines, include_paths, included_files
     ):
         """
@@ -162,7 +162,7 @@ class VerilogPreprocessor(object):
                     if token.value == "end_protected":
                         return
 
-    def expand_macro(  # pylint: disable=too-many-arguments
+    def expand_macro(  # pylint: disable=too-many-arguments,too-many-positional-arguments
         self, macro_token, stream, defines, include_paths, included_files
     ):
         """
@@ -254,7 +254,9 @@ class VerilogPreprocessor(object):
         stream.skip_while(NEWLINE)
         return result
 
-    def include(self, token, stream, include_paths, included_files, defines):  # pylint: disable=too-many-arguments
+    def include(
+        self, token, stream, include_paths, included_files, defines
+    ):  # pylint: disable=too-many-arguments,too-many-positional-arguments
         """
         Handle `include directive
         """

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/vunit/persistent_tcl_shell.py

@@ -73,7 +73,7 @@ class PersistentTclShell(object):
         return consumer.var
 
     def read_bool(self, varname):
-        result = self.read_var(varname)
+        result = self.read_var(varname).lower()
         assert result in ("true", "false")
         return result == "true"
 

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/vunit/project.py

@@ -113,6 +113,7 @@ class Project(object):  # pylint: disable=too-many-instance-attributes
         self,
         file_name,
         library_name,
+        *,
         file_type="vhdl",
         include_dirs=None,
         defines=None,

vunit_hdl-5.0.0.dev4/vunit/sim_if/_viewermixin.py

@@ -0,0 +1,60 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# Copyright (c) 2014-2024, Lars Asplund lars.anders.asplund@gmail.com
+"""
+Viewer handling for GHDL and NVC.
+"""
+
+
+class ViewerMixin:
+    """
+    Mixin class for handling common viewer functionality for the GHDL and NVC simulators.
+    """
+
+    __slots__ = (
+        "_gui",
+        "_viewer",
+        "_viewer_fmt",
+        "_viewer_args",
+        "_gtkwave_available",
+        "_surfer_available",
+    )
+
+    def __init__(self, gui, viewer, viewer_fmt, viewer_args):
+        self._gui = gui
+        self._viewer_fmt = viewer_fmt
+        self._viewer_args = viewer_args
+        self._viewer = viewer
+        if gui:
+            self._gtkwave_available = self.find_executable("gtkwave")
+            self._surfer_available = self.find_executable("surfer")
+
+    def _get_viewer(self, config):
+        """
+        Determine the waveform viewer to use.
+
+        Falls back to gtkwave or surfer, in that order, if none is provided.
+        """
+        viewer = self._viewer or config.sim_options.get(self.name + ".viewer.gui", None)
+
+        if viewer is None:
+            if self._gtkwave_available:
+                viewer = "gtkwave"
+            elif self._surfer_available:
+                viewer = "surfer"
+            else:
+                raise RuntimeError("No viewer found. GUI not possible. Install GTKWave or Surfer.")
+
+        elif not self.find_executable(viewer):
+            viewers = []
+            if self._gtkwave_available:
+                viewers += ["gtkwave"]
+            if self._surfer_available:
+                viewers += ["surfer"]
+            addendum = f" The following viewer(s) are found in the path: {', '.join(viewers)}" if viewers else ""
+            raise RuntimeError(
+                f"Cannot find the {viewer} executable in the PATH environment variable. GUI not possible.{addendum}"
+            )
+        return viewer

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/vunit/sim_if/ghdl.py

@@ -21,11 +21,12 @@ from ..exceptions import CompileError
 from ..ostools import Process
 from . import SimulatorInterface, ListOfStringOption, StringOption, BooleanOption
 from ..vhdl_standard import VHDL
+from ._viewermixin import ViewerMixin
 
 LOGGER = logging.getLogger(__name__)
 
 
-class GHDLInterface(SimulatorInterface):  # pylint: disable=too-many-instance-attributes
+class GHDLInterface(SimulatorInterface, ViewerMixin):  # pylint: disable=too-many-instance-attributes
     """
     Interface for GHDL simulator
     """
@@ -43,7 +44,9 @@ class GHDLInterface(SimulatorInterface):  # pylint: disable=too-many-instance-at
     sim_options = [
         ListOfStringOption("ghdl.sim_flags"),
         ListOfStringOption("ghdl.elab_flags"),
-        StringOption("ghdl.gtkwave_script.gui"),
+        StringOption("ghdl.gtkwave_script.gui"),  # Deprecated in v5.1.0
+        StringOption("ghdl.viewer_script.gui"),
+        StringOption("ghdl.viewer.gui"),
         BooleanOption("ghdl.elab_e"),
     ]
 
@@ -52,14 +55,16 @@ class GHDLInterface(SimulatorInterface):  # pylint: disable=too-many-instance-at
         """
         Add command line arguments
         """
-        group = parser.add_argument_group("ghdl", description="GHDL specific flags")
+        group = parser.add_argument_group("ghdl/nvc", description="GHDL/NVC specific flags")
         group.add_argument(
+            "--viewer-fmt",
             "--gtkwave-fmt",
             choices=["vcd", "fst", "ghw"],
             default=None,
-            help="Save .vcd, .fst, or .ghw to open in gtkwave",
+            help="Save .vcd, .fst, or .ghw to open in waveform viewer. NVC does not support ghw.",
         )
-        group.add_argument("--gtkwave-args", default="", help="Arguments to pass to gtkwave")
+        group.add_argument("--viewer-args", "--gtkwave-args", default="", help="Arguments to pass to waveform viewer")
+        group.add_argument("--viewer", default=None, help="Waveform viewer to use")
 
     @classmethod
     def from_args(cls, args, output_path, **kwargs):
@@ -71,8 +76,9 @@ class GHDLInterface(SimulatorInterface):  # pylint: disable=too-many-instance-at
             output_path=output_path,
             prefix=prefix,
             gui=args.gui,
-            gtkwave_fmt=args.gtkwave_fmt,
-            gtkwave_args=args.gtkwave_args,
+            viewer_fmt=args.viewer_fmt,
+            viewer_args=args.viewer_args,
+            viewer=args.viewer,
             backend=cls.determine_backend(prefix),
         )
 
@@ -87,21 +93,25 @@ class GHDLInterface(SimulatorInterface):  # pylint: disable=too-many-instance-at
         self,
         output_path,
         prefix,
+        *,
         gui=False,
-        gtkwave_fmt=None,
-        gtkwave_args="",
+        viewer_fmt=None,
+        viewer_args="",
+        viewer=None,
         backend="llvm",
     ):
         SimulatorInterface.__init__(self, output_path, gui)
+        ViewerMixin.__init__(
+            self,
+            gui=gui,
+            viewer=viewer,
+            viewer_fmt="ghw" if gui and viewer_fmt is None else viewer_fmt,
+            viewer_args=viewer_args,
+        )
+
         self._prefix = prefix
         self._project = None
 
-        if gui and (not self.find_executable("gtkwave")):
-            raise RuntimeError("Cannot find the gtkwave executable in the PATH environment variable. GUI not possible")
-
-        self._gui = gui
-        self._gtkwave_fmt = "ghw" if gui and gtkwave_fmt is None else gtkwave_fmt
-        self._gtkwave_args = gtkwave_args
         self._backend = backend
         self._vhdl_standard = None
         self._coverage_test_dirs = set()  # For gcov
@@ -123,7 +133,7 @@ class GHDLInterface(SimulatorInterface):  # pylint: disable=too-many-instance-at
     @classmethod
     def _get_help_output(cls, prefix):
         """
-        Get the output of 'ghdl --version'
+        Get the output of 'ghdl --help'
         """
         return subprocess.check_output([str(Path(prefix) / cls.executable), "--help"]).decode()
 
@@ -277,7 +287,7 @@ class GHDLInterface(SimulatorInterface):  # pylint: disable=too-many-instance-at
 
     def _get_command(
         self, config, output_path, elaborate_only, ghdl_e, test_suite_name, wave_file
-    ):  # pylint: disable=too-many-branches,too-many-arguments
+    ):  # pylint: disable=too-many-branches,too-many-arguments,too-many-positional-arguments
         """
         Return GHDL simulation command
         """
@@ -315,11 +325,11 @@ class GHDLInterface(SimulatorInterface):  # pylint: disable=too-many-instance-at
             sim += ["--ieee-asserts=disable"]
 
         if wave_file:
-            if self._gtkwave_fmt == "ghw":
+            if self._viewer_fmt == "ghw":
                 sim += [f"--wave={wave_file!s}"]
-            elif self._gtkwave_fmt == "vcd":
+            elif self._viewer_fmt == "vcd":
                 sim += [f"--vcd={wave_file!s}"]
-            elif self._gtkwave_fmt == "fst":
+            elif self._viewer_fmt == "fst":
                 sim += [f"--fst={wave_file!s}"]
 
         if not ghdl_e:
@@ -355,8 +365,8 @@ class GHDLInterface(SimulatorInterface):  # pylint: disable=too-many-instance-at
 
         ghdl_e = elaborate_only and config.sim_options.get("ghdl.elab_e", False)
 
-        if self._gtkwave_fmt is not None:
-            data_file_name = str(Path(script_path) / f"wave.{self._gtkwave_fmt!s}")
+        if self._viewer_fmt is not None:
+            data_file_name = str(Path(script_path) / f"wave.{self._viewer_fmt!s}")
             if Path(data_file_name).exists():
                 remove(data_file_name)
         else:
@@ -382,10 +392,20 @@ class GHDLInterface(SimulatorInterface):  # pylint: disable=too-many-instance-at
         except Process.NonZeroExitCode:
             status = False
 
+        if config.sim_options.get(self.name + ".gtkwave_script.gui", None):
+            LOGGER.warning(
+                "%s.gtkwave_script.gui is deprecated and will be removed "
+                "in a future version, use %s.viewer_script.gui instead",
+                self.name,
+                self.name,
+            )
+
         if self._gui and not elaborate_only:
-            cmd = ["gtkwave"] + shlex.split(self._gtkwave_args) + [data_file_name]
+            cmd = [self._get_viewer(config)] + shlex.split(self._viewer_args) + [data_file_name]
 
-            init_file = config.sim_options.get(self.name + ".gtkwave_script.gui", None)
+            init_file = config.sim_options.get(
+                self.name + ".viewer_script.gui", config.sim_options.get(self.name + ".gtkwave_script.gui", None)
+            )
             if init_file is not None:
                 cmd += ["--script", str(Path(init_file).resolve())]
 

{vunit_hdl-5.0.0.dev2 → vunit_hdl-5.0.0.dev4}/vunit/sim_if/incisive.py

@@ -84,7 +84,7 @@ class IncisiveInterface(SimulatorInterface):  # pylint: disable=too-many-instanc
         return False
 
     def __init__(  # pylint: disable=too-many-arguments
-        self, prefix, output_path, gui=False, log_level=None, cdslib=None, hdlvar=None
+        self, prefix, output_path, *, gui=False, log_level=None, cdslib=None, hdlvar=None
     ):
         SimulatorInterface.__init__(self, output_path, gui)
         self._prefix = prefix