Forcing recompilation when ModelSim return warning re waiting on lock

Author: suoto

hdl_checker/builders/base_builder.py

@@ -21,7 +21,7 @@
 import os
 import os.path as p
 from threading import Lock
-from typing import Any, Dict, FrozenSet, Iterable, Optional, Set, Tuple
+from typing import Any, Dict, FrozenSet, Iterable, Mapping, Optional, Set, Tuple
 
 from hdl_checker.database import Database  # pylint: disable=unused-import
 from hdl_checker.diagnostics import CheckerDiagnostic, DiagType
@@ -202,18 +202,21 @@ def _getRebuilds(self, path, line, library):
         Gets info on what should be rebuilt to satisfy the builder
         """
         try:
-            parse_results = self._searchForRebuilds(line)
+            parse_results = self._searchForRebuilds(path, line)
         except NotImplementedError:  # pragma: no cover
             return set()
 
         rebuilds = set()  # type: Set[RebuildInfo]
         for rebuild in parse_results:
-            unit_type = rebuild.get("unit_type", None)  # type: str
-            library_name = rebuild.get("library_name", None)  # type: str
-            unit_name = rebuild.get("unit_name", None)  # type: str
-            rebuild_path = rebuild.get("rebuild_path", None)  # type: str
+            unit_type = rebuild.get("unit_type", None)  # type: Optional[str]
+            library_name = rebuild.get("library_name", None)  # type: Optional[str]
+            unit_name = rebuild.get("unit_name", None)  # type: Optional[str]
+            rebuild_path = rebuild.get("rebuild_path", None)  # type: Optional[str]
 
-            if None not in (unit_type, unit_name):
+            if library_name == "work":
+                library_name = library.name
+
+            if unit_name is not None and unit_type is not None:
                 for dependency in self._database.getDependenciesByPath(path):
                     if dependency.name.name == rebuild["unit_name"]:
                         rebuilds.add(
@@ -222,9 +225,7 @@ def _getRebuilds(self, path, line, library):
                             )
                         )
                         break
-            elif None not in (library_name, unit_name):
-                if library_name == "work":
-                    library_name = library.name
+            elif library_name is not None and unit_name is not None:
                 rebuilds.add(
                     RebuildLibraryUnit(Identifier(unit_name), Identifier(library_name))
                 )
@@ -237,8 +238,8 @@ def _getRebuilds(self, path, line, library):
 
         return rebuilds
 
-    def _searchForRebuilds(self, line):  # pragma: no cover
-        # type: (...) -> Any
+    def _searchForRebuilds(self, path, line):  # pragma: no cover
+        # type: (Path, str) -> Iterable[Mapping[str, str]]
         """
         Finds units that the builders is telling us to rebuild
         """

hdl_checker/builders/ghdl.py

@@ -20,7 +20,7 @@
 import os.path as p
 import re
 from glob import glob
-from typing import Any, Iterable, List, Optional
+from typing import Any, Iterable, List, Mapping, Optional
 
 from .base_builder import BaseBuilder
 
@@ -195,10 +195,9 @@ def _createLibrary(self, _):
         if not p.exists(workdir):
             os.makedirs(workdir)
 
-    def _searchForRebuilds(self, line):
-        rebuilds = []
-
-        for match in self._iter_rebuild_units(line):
+    def _searchForRebuilds(self, path, line):
+        # type: (Path, str) -> Iterable[Mapping[str, str]]
+        for match in GHDL._iter_rebuild_units(line):
             mdict = match.groupdict()
             # When compilers reports units out of date, they do this
             # by either
@@ -207,10 +206,6 @@ def _searchForRebuilds(self, line):
             #  2. Reporting which design unit has been affected by a
             #     given change.
             if "rebuild_path" in mdict and mdict["rebuild_path"] is not None:
-                rebuilds.append(mdict)
+                yield mdict
             else:
-                rebuilds.append(
-                    {"unit_type": mdict["unit_type"], "unit_name": mdict["unit_name"]}
-                )
-
-        return rebuilds
+                yield {"unit_type": mdict["unit_type"], "unit_name": mdict["unit_name"]}

hdl_checker/builders/msim.py

@@ -20,7 +20,7 @@
 import os.path as p
 import re
 from shutil import copyfile
-from typing import Any, Iterable, List, Optional
+from typing import Any, Iterable, List, Mapping, Optional
 
 from .base_builder import BaseBuilder
 
@@ -184,14 +184,16 @@ def _parseBuiltinLibraries(self):
             for match in self._BuilderLibraryScanner.finditer(line):
                 yield Identifier(match.groupdict()["library_name"], False)
 
-    def _searchForRebuilds(self, line):
-        rebuilds = []
-        for match in self._iter_rebuild_units(line):
+    def _searchForRebuilds(self, path, line):
+        # type: (Path, str) -> Iterable[Mapping[str, str]]
+        if line.startswith("** Warning: ") and "Waiting for lock by" in line:
+            yield {"rebuild_path": path.abspath}
+        for match in MSim._iter_rebuild_units(line):
             mdict = match.groupdict()
             library_name = mdict["lib_name_0"] or mdict["lib_name_1"]
             unit_name = mdict["unit_name_0"] or mdict["unit_name_1"]
             if None not in (library_name, unit_name):
-                rebuilds.append({"library_name": library_name, "unit_name": unit_name})
+                yield {"library_name": library_name, "unit_name": unit_name}
             else:  # pragma: no cover
                 _msg = "Something wrong while parsing '%s'. " "Match is '%s'" % (
                     line,
@@ -200,8 +202,6 @@ def _searchForRebuilds(self, line):
                 self._logger.error(_msg)
                 assert 0, _msg
 
-        return rebuilds
-
     def _buildSource(self, path, library, flags=None):
         # type: (Path, Identifier, Optional[BuildFlags]) -> Iterable[str]
         filetype = FileType.fromPath(path)

hdl_checker/builders/xvhdl.py

@@ -20,7 +20,7 @@
 import re
 import shutil
 import tempfile
-from typing import Iterable, Optional
+from typing import Iterable, Mapping, Optional
 
 from .base_builder import BaseBuilder
 
@@ -169,13 +169,11 @@ def _buildSource(self, path, library, flags=None):
         cmd += [path.name]
         return runShellCommand(cmd, cwd=self._work_folder)
 
-    def _searchForRebuilds(self, line):
-        rebuilds = []
-
+    def _searchForRebuilds(self, path, line):
+        # type: (Path, str) -> Iterable[Mapping[str, str]]
         for match in _ITER_REBUILD_UNITS(line):
             dict_ = match.groupdict()
-            rebuilds.append(
-                {"library_name": dict_["library_name"], "unit_name": dict_["unit_name"]}
-            )
-
-        return rebuilds
+            yield {
+                "library_name": dict_["library_name"],
+                "unit_name": dict_["unit_name"],
+            }

hdl_checker/tests/test_builders.py

@@ -561,7 +561,7 @@ def test_MsimRecompileMsg0(self):
 
         self.assertEqual(
             [{"library_name": "foo_lib", "unit_name": "bar_component"}],
-            self.builder._searchForRebuilds(line),
+            list(self.builder._searchForRebuilds(Path("foo.vhd"), line)),
         )
 
     def test_MsimRecompileMsg1(self):
@@ -576,7 +576,19 @@ def test_MsimRecompileMsg1(self):
 
         self.assertEqual(
             [{"library_name": "foo_lib", "unit_name": "bar_component"}],
-            self.builder._searchForRebuilds(line),
+            list(self.builder._searchForRebuilds(Path("foo.vhd"), line)),
+        )
+
+    def test_MsimRecompileMsg2(self):
+        # type: (...) -> Any
+        if not isinstance(self.builder, MSim):
+            raise unittest2.SkipTest("ModelSim only test")
+
+        line = '** Warning: (vcom-6) -- Waiting for lock by "user@host, pid = 4661". Lockfile is'
+
+        self.assertEqual(
+            [{"rebuild_path": p.abspath("foo.vhd")}],
+            list(self.builder._searchForRebuilds(Path("foo.vhd"), line)),
         )
 
     def test_GhdlRecompileMsg(self):
@@ -588,7 +600,7 @@ def test_GhdlRecompileMsg(self):
 
         self.assertEqual(
             [{"unit_type": "package", "unit_name": "leon3"}],
-            self.builder._searchForRebuilds(line),
+            list(self.builder._searchForRebuilds(Path("foo.vhd"), line)),
         )
 
     def test_XvhdlRecompileMsg0(self):
@@ -605,7 +617,7 @@ def test_XvhdlRecompileMsg0(self):
 
         self.assertEqual(
             [{"library_name": "some_library", "unit_name": "some_package"}],
-            self.builder._searchForRebuilds(line),
+            list(self.builder._searchForRebuilds(Path("foo.vhd"), line)),
         )
 
     # Rebuild formats are: