ui: split 'add_builtins' into 'add_vhdl_builtins' and 'add_verilog_bu…

…iltins'

docs/data_types/external_api.rst

@@ -16,11 +16,10 @@ List of types that are currently in the external VHDL API:
 * **string_ptr**, and **byte_vector_ptr** as an alias (:ref:`External string API <ext_string_pkg>`)
 * **integer_vector_ptr** (:ref:`External integer vector API <ext_integer_vector_pkg>`)
 
-.. important:: By default, bodies of the external API functions/procedures include forced failure assertions. Hence, using ``mode/=internal`` without providing a *bridge* to a foreign language will make tests fail. Bridges must be provided through `vu.add_builtins(external=<Options>)`, where `<Options>` defaults to ``{"string": False, "integer_vector": False}``. Each field should contain a list of VHDL files to replace the *dummy* default. See `VUnit/cosim <https://github.com/VUnit/cosim>`_ for reference implementations of bridges and examples.
+.. important:: By default, bodies of the external API functions/procedures include forced failure assertions. Hence, using ``mode/=internal`` without providing a *bridge* to a foreign language will make tests fail. Bridges must be provided through `vu.add_vhdl_builtins(external=<Options>)`, where `<Options>` defaults to ``{"string": False, "integer_vector": False}``. Each field should contain a list of VHDL files to replace the *dummy* default. See `VUnit/cosim <https://github.com/VUnit/cosim>`_ for reference implementations of bridges and examples.
 
 .. toctree::
    :hidden:
 
    ext_string
    ext_integer_vector
-

vunit/ui/__init__.py

@@ -159,12 +159,12 @@ def test_filter(name, attribute_names):
 
         self._builtins = Builtins(self, self._vhdl_standard, simulator_class)
         if compile_builtins:
-            self.add_builtins()
+            self.add_vhdl_builtins()
             builtins_deprecation_note = (
                 "'compile_builtins' (which defaults to 'True') is deprecated "
                 "and it will be removed in future releases; "
                 "preserve the functionality using "
-                "'compile_builtins=False' and 'VU.add_builtins'"
+                "'compile_builtins=False' and 'VU.add_vhdl_builtins'"
             )
             warn(builtins_deprecation_note, Warning)
 
@@ -934,17 +934,23 @@ def _run_test(self, test_cases, report):
         )
         runner.run(test_cases)
 
-    def add_builtins(self, external=None):
+    def add_verilog_builtins(self):
         """
-        Add vunit VHDL builtin libraries
+        Add VUnit Verilog builtin libraries
+        """
+        self._builtins.add_verilog_builtins()
+
+    def add_vhdl_builtins(self, external=None):
+        """
+        Add VUnit VHDL builtin libraries
 
         :param external: struct to provide bridges for the external VHDL API.
 
         :example:
 
         .. code-block:: python
 
-            VU.add_builtins(external={
+            VU.add_vhdl_builtins(external={
                 'string': ['path/to/custom/file'],
                 'integer': ['path/to/custom/file']}
             )

vunit/verilog.py

@@ -9,19 +9,23 @@
 """
 
 from vunit.ui import VUnit as VUnitVHDL
+from warnings import warn
 
 
 class VUnit(VUnitVHDL):
     """
     VUnit Verilog interface
     """
 
-    def add_builtins(self, external=None):  # pylint: disable=arguments-differ
+    # This is a temporary workaround to avoid breaking the scripts of current verilog users
+    def add_vhdl_builtins(self): # pylint: disable=arguments-differ
         """
         Add vunit Verilog builtin libraries
         """
         self._builtins.add_verilog_builtins()
         builtins_deprecation_note = (
-            "class 'verilog' is deprecated and it will be removed in future releases"
+            "class 'verilog' is deprecated and it will be removed in future releases; "
+            "preserve the functionality using the default vunit class, along with "
+            "'compile_builtins=False' and 'VU.add_verilog_builtins'"
         )
         warn(builtins_deprecation_note, Warning)

vunit/verilog/check/run.py

@@ -5,12 +5,14 @@
 # Copyright (c) 2014-2021, Lars Asplund lars.anders.asplund@gmail.com
 
 from pathlib import Path
-from vunit.verilog import VUnit
+from vunit import VUnit
 
 
 ROOT = Path(__file__).parent
 
 VU = VUnit.from_argv()
+VU.add_verilog_builtins()
+
 VU.add_library("lib").add_source_files(ROOT / "test" / "*.sv")
 VU.set_sim_option("modelsim.vsim_flags.gui", ["-novopt"])