Added support for log location based on VHDL-2019 call paths.

Author: LarsAsplund

docs/logging/user_guide.rst

@@ -300,19 +300,31 @@ counted to get statistics on disabled log messages.
     disable(get_logger("memory_ip:timing_check"), warning);
 
 
-Log Location Preprocessing
---------------------------
+Log Location
+------------
+
+For simulators supporting VHDL-2019 VUnit adds file name
+and line number location information to all log entries. Currently
+only Riviera-PRO supports VHDL-2019 and it restricts the feature
+to **debug compiled files**. You can compile all files or just the ones
+using logging. For example,
+
+.. code-block:: python
 
-The optional VUnit location preprocessor can be used to add file name
-and line number location information to all log calls. This
-functionality is enabled from the ``run.py`` file like this:
+    testbenches = lib.get_source_files("*tb*")
+    testbenches.set_compile_option("rivierapro.vcom_flags", ["-dbg"])
+
+
+For earlier VHDL standards there is an optional location preprocessor that can
+be used to serve the same purpose. The preprocessor is enabled from
+the ``run.py`` file like this:
 
 .. code-block:: python
 
     ui = VUnit.from_argv()
     ui.enable_location_preprocessing()
 
-and will change the output to something like this.
+Regardless of method the location information is appended to the end of the log entry:
 
 .. code-block:: console
 
@@ -322,8 +334,25 @@ and will change the output to something like this.
 If you've placed your log call(s) in a convenience procedure you most
 likely want the location of the calls to that procedure to be in the
 output and not the location of the log call in the definition of the
-convenience procedure. You can do that by adding the ``line_num`` and
-``file_name`` parameters to the **end** of the parameter list for that
+convenience procedure. For VHDL-2019 you can use the ``path_offset``
+parameter to specify a number of steps earlier in the call stack. For
+example,
+
+.. code-block:: vhdl
+
+    procedure my_convenience_procedure(
+      <my parameters>) is
+    begin
+      <some code>
+      info("Some message", path_offset => 1);
+      <some code>
+    end procedure my_convenience_procedure;
+
+When ``path_offset`` is set to 1 the location of the caller to
+``my_convenience_procedure`` will be used in the log output.
+
+With earlier VHDL standard you can add the ``line_num`` and
+``file_name`` parameters to the **end** of the parameter list for the
 convenience procedure
 
 .. code-block:: vhdl

tests/unit/test_vhdl_standard.py

@@ -48,10 +48,27 @@ def test_and_later():
         VHDL.STD_2008,
         VHDL.STD_2019,
     }
+    assert VHDL.STD_2002.and_later == {
+        VHDL.STD_2002,
+        VHDL.STD_2008,
+        VHDL.STD_2019,
+    }
     assert VHDL.STD_2008.and_later == {VHDL.STD_2008, VHDL.STD_2019}
     assert VHDL.STD_2019.and_later == {VHDL.STD_2019}
 
 
+def test_and_earlier():
+    assert VHDL.STD_2019.and_earlier == {
+        VHDL.STD_1993,
+        VHDL.STD_2002,
+        VHDL.STD_2008,
+        VHDL.STD_2019,
+    }
+    assert VHDL.STD_2008.and_earlier == {VHDL.STD_1993, VHDL.STD_2002, VHDL.STD_2008}
+    assert VHDL.STD_2002.and_earlier == {VHDL.STD_1993, VHDL.STD_2002}
+    assert VHDL.STD_1993.and_earlier == {VHDL.STD_1993}
+
+
 def test_supports_context():
     assert not VHDL.STD_2002.supports_context
     assert VHDL.STD_2008.supports_context

vunit/builtins.py

@@ -60,6 +60,8 @@ def _add_files(self, pattern=None, allow_empty=True):
                 standard_name = str(standard)
                 if standard_name + "p" in base_file_name:
                     standards.update(standard.and_later)
+                elif standard_name + "m" in base_file_name:
+                    standards.update(standard.and_earlier)
                 elif standard_name in base_file_name:
                     standards.add(standard)