Added support for LSP hover and definitions

Other changes:

* Fixed some issues with testing on Windows
* Removing sources from the DB if they're not accessible when parsing
* Renamed hdl_checker_base -> base_server

Author: suoto

.ci/scripts/docker_entry_point.sh

@@ -34,7 +34,7 @@ ln -s /builders "/home/$USERNAME/builders"
 
 su -l "$USERNAME" -c "    \
   cd /hdl_checker      && \
-  tox ${TOX_ARGS[*]};     \
+  tox ${TOX_ARGS[*]}   && \
   coverage combine     && \
   coverage xml         && \
   coverage report      && \

.ci/test_support/test_project/basic_library/two_entities_one_file.vhd

@@ -0,0 +1,9 @@
+
+entity entity_a is
+end entity;
+
+entity entity_a is
+end entity;
+
+entity entity_b is
+end entity;

.ci/test_support/test_project/basic_library/use_entity_a_and_b.vhd

@@ -0,0 +1,12 @@
+
+use work.entity_a;
+
+use work.entity_b;
+
+entity entity_c is
+end entity;
+
+architecture entity_c of entity_c is
+begin
+end entity_c;
+

.ci/test_support/test_project/config.json

@@ -6,6 +6,8 @@
         "basic_library/package_with_constants.vhd",
         "basic_library/package_with_functions.vhd",
         "basic_library/very_common_pkg.vhd",
+        "basic_library/two_entities_one_file.vhd",
+        "basic_library/use_entity_a_and_b.vhd",
         "verilog/parity.sv",
         "verilog/parity.v"
     ]

.ci/test_support/test_project/ghdl.prj

@@ -7,4 +7,5 @@ vhdl   basic_library     basic_library/clock_divider.vhd
 vhdl   another_library   another_library/foo.vhd              
 vhdl   basic_library     basic_library/package_with_functions.vhd
 vhdl   basic_library     basic_library/clk_en_generator.vhd
-
+vhdl   basic_library     basic_library/two_entities_one_file.vhd
+vhdl   basic_library     basic_library/use_entity_a_and_b.vhd

.ci/test_support/test_project/msim.prj

@@ -8,3 +8,5 @@ vhdl           basic_library    basic_library/package_with_functions.vhd
 vhdl           basic_library    basic_library/clk_en_generator.vhd
 verilog        verilog          verilog/parity.v
 systemverilog  verilog          verilog/parity.sv
+vhdl   basic_library     basic_library/two_entities_one_file.vhd
+vhdl   basic_library     basic_library/use_entity_a_and_b.vhd

.ci/test_support/test_project/vimhdl.prj

@@ -6,3 +6,5 @@ vhdl           basic_library    basic_library/package_with_functions.vhd
 vhdl           basic_library    basic_library/clk_en_generator.vhd
 verilog        verilog          verilog/parity.v
 systemverilog  verilog          verilog/parity.sv
+vhdl   basic_library     basic_library/two_entities_one_file.vhd
+vhdl   basic_library     basic_library/use_entity_a_and_b.vhd

.ci/test_support/test_project/xvhdl.prj

@@ -7,3 +7,5 @@ vhdl  basic_library    basic_library/clock_divider.vhd
 vhdl  another_library  another_library/foo.vhd
 vhdl  basic_library    basic_library/package_with_functions.vhd
 vhdl  basic_library    basic_library/clk_en_generator.vhd
+vhdl   basic_library     basic_library/two_entities_one_file.vhd
+vhdl   basic_library     basic_library/use_entity_a_and_b.vhd

.gitignore

@@ -66,6 +66,5 @@ target/
 tags
 # .coverage
 # htmlcov/
-source.vhd
-.ci/test_support/grlib/
 .mypy_cache
+.hdl_checker/

hdl_checker/hdl_checker_base.py renamed to hdl_checker/base_server.py

@@ -25,9 +25,9 @@
 import traceback
 from collections import namedtuple
 from multiprocessing.pool import ThreadPool
-from threading import RLock
 from pprint import pformat
-from typing import Any, AnyStr, Dict, Iterable, Optional, Set, Union
+from threading import RLock
+from typing import Any, AnyStr, Dict, Iterable, Optional, Set, Tuple, Union
 
 import six
 
@@ -41,6 +41,7 @@
 from hdl_checker.database import Database
 from hdl_checker.diagnostics import CheckerDiagnostic, DiagType, PathNotInProjectFile
 from hdl_checker.parsers.config_parser import ConfigParser
+from hdl_checker.parsers.elements.dependency_spec import DependencySpec
 from hdl_checker.parsers.elements.identifier import Identifier
 from hdl_checker.path import Path, TemporaryPath
 from hdl_checker.serialization import StateEncoder, jsonObjectHook
@@ -54,6 +55,11 @@
 )
 from hdl_checker.utils import removeDirIfExists, removeIfExists, toBytes
 
+try:
+    from functools import lru_cache
+except ImportError:
+    from backports.functools_lru_cache import lru_cache  # type: ignore
+
 _logger = logging.getLogger(__name__)
 
 if six.PY2:
@@ -85,7 +91,7 @@ def __init__(self, root_dir):  # type: (Path) -> None
         self._lock = RLock()
         self.config_file = None  # type: Optional[WatchedFile]
 
-        self.database = Database()
+        self._database = Database()
         self._builder = Fallback(self.work_dir, self.database)
 
         if not p.exists(str(self.work_dir)):
@@ -94,6 +100,13 @@ def __init__(self, root_dir):  # type: (Path) -> None
         self._recoverCacheIfPossible()
         self._saveCache()
 
+        # Use this to know which methods should be cache
+        self._cached_methods = {
+            getattr(self, x)
+            for x in dir(self)
+            if hasattr(getattr(self, x), "cache_clear")
+        }
+
     @property
     def builder(self):
         """
@@ -103,6 +116,24 @@ def builder(self):
         self._updateConfigIfNeeded()
         return self._builder
 
+    @property
+    def database(self):
+        """
+        Parses the config file if it has been set and returns the builder in
+        use
+        """
+        self._updateConfigIfNeeded()
+        return self._database
+
+    def __hash__(self):
+        # Just to allow lru_cache
+        return hash(0)
+
+    def _clearLruCaches(self):
+        "Clear caches from lru_caches"
+        for meth in self._cached_methods:
+            meth.cache_clear()
+
     def setConfig(self, filename):
         # type: (Union[Path, str]) -> None
         """
@@ -190,11 +221,10 @@ def configure(self, config):
 
         # Add the flags from the root config file last, it should overwrite
         # values set by the included files
-        #  self.database.addSources(config.pop("sources", ()), config_root_path)
-        #  if config
-        assert not config, "Some configuration elements weren't used:\n{}".format(
-            pformat(config)
-        )
+        if config:
+            _logger.warning(
+                "Some configuration elements weren't used:\n%s", pformat(config)
+            )
 
     def _getCacheFilename(self):
         # type: () -> Path
@@ -227,7 +257,7 @@ def _setState(self, state):
         """
         Serializer load implementation
         """
-        self.database = state.pop("database")
+        self._database = state.pop("database")
         self._builder = state.pop("builder", Fallback)
         config_file = state.pop("config_file", None)
         if config_file is None:
@@ -284,10 +314,11 @@ def clean(self):
         removeDirIfExists(str(self.work_dir))
 
         del self._builder
-        del self.database
+        del self._database
 
-        self.database = Database()
-        self._builder = Fallback(self.work_dir, self.database)
+        database = Database()
+        self._database = database
+        self._builder = Fallback(self.work_dir, database)
 
     @abc.abstractmethod
     def _handleUiInfo(self, message):  # type: (AnyStr) -> None
@@ -401,7 +432,7 @@ def getMessagesByPath(self, path):
         Returns the messages for the given path, including messages
         from the configured builder (if available) and static checks
         """
-        self._updateConfigIfNeeded()
+        self._clearLruCaches()
 
         path = Path(path, self.root_dir)
 
@@ -451,9 +482,9 @@ def getMessagesWithText(self, path, content):
         Dumps content to a temprary file and replaces the temporary file name
         for path on the diagnostics received
         """
+        self._clearLruCaches()
         with self._lock:
             _logger.info("Getting messages for '%s' with content", path)
-            self._updateConfigIfNeeded()
 
             ext = path.name.split(".")[-1]
             temporary_file = tempfile.NamedTemporaryFile(suffix="." + ext, delete=False)
@@ -463,7 +494,6 @@ def getMessagesWithText(self, path, content):
             temporary_file.file.write(toBytes(content))  # type: ignore
             temporary_file.close()
 
-
             # If the reference path was added to the database, add the
             # temporary file with the same attributes
             if path in self.database.paths:
@@ -494,3 +524,21 @@ def getMessagesWithText(self, path, content):
                 diags.add(PathNotInProjectFile(path))
 
         return diags
+
+    @lru_cache()
+    def resolveDependencyToPath(self, dependency):
+        # type: (DependencySpec) -> Optional[Tuple[Path, Identifier]]
+        """
+        Retrieves the build sequence for the dependency's owner and extracts
+        the path that implements a design unit whose names match the
+        dependency.
+        """
+        for library, path in self.database.getBuildSequence(
+            dependency.owner, self.builder.builtin_libraries
+        ):
+            if dependency.name in (
+                x.name for x in self.database.getDesignUnitsByPath(path)
+            ):
+                return path, library
+
+        return None

hdl_checker/builder_utils.py

@@ -36,7 +36,7 @@
 from .builders.xvhdl import XVHDL
 
 from hdl_checker.parsers.elements.identifier import Identifier
-from hdl_checker.path import Path  # pylint: disable=unused-import
+from hdl_checker.path import Path
 from hdl_checker.types import BuildFlags, FileType
 from hdl_checker.utils import removeDirIfExists
 

hdl_checker/builders/fallback.py

@@ -16,27 +16,28 @@
 # along with HDL Checker.  If not, see <http://www.gnu.org/licenses/>.
 "Fallback builder for cases where no builder is found"
 
-from hdl_checker import types as t
 from hdl_checker.builders.base_builder import BaseBuilder
+from hdl_checker.types import FileType
+
 
 class Fallback(BaseBuilder):
     "Dummy fallback builder"
 
     # Implementation of abstract class properties
-    builder_name = 'fallback'
-    file_types = {t.FileType.vhdl, t.FileType.verilog, t.FileType.systemverilog}
+    builder_name = "fallback"
+    file_types = {FileType.vhdl, FileType.verilog, FileType.systemverilog}
 
     def __init__(self, *args, **kwargs):
         # type: (...) -> None
-        self._version = '<undefined>'
+        self._version = "<undefined>"
         super(Fallback, self).__init__(*args, **kwargs)
 
     # Since Fallback._buildSource returns nothing,
     # Fallback._makeRecords is never called
-    def _makeRecords(self, _): # pragma: no cover
+    def _makeRecords(self, _):  # pragma: no cover
         return []
 
-    def _shouldIgnoreLine(self, line): # pragma: no cover
+    def _shouldIgnoreLine(self, line):  # pragma: no cover
         return True
 
     def _checkEnvironment(self):
@@ -46,8 +47,8 @@ def _checkEnvironment(self):
     def isAvailable():
         return True
 
-    def _buildSource(self, path, library, flags=None): # pragma: no cover
+    def _buildSource(self, path, library, flags=None):  # pragma: no cover
         return [], []
 
-    def _createLibrary(self, library): # pragma: no cover
+    def _createLibrary(self, library):  # pragma: no cover
         pass

hdl_checker/config_generators/base_generator.py

@@ -22,7 +22,7 @@
 
 from hdl_checker.builder_utils import AnyValidBuilder
 from hdl_checker.path import Path
-from hdl_checker.types import BuildFlags, BuildFlagScope, FileType
+from hdl_checker.types import BuildFlags, FileType
 
 _SOURCE_EXTENSIONS = "vhdl", "sv", "v"
 _HEADER_EXTENSIONS = "vh", "svh"

hdl_checker/config_generators/simple_finder.py

@@ -22,8 +22,9 @@
 
 from .base_generator import BaseGenerator
 
+from hdl_checker.exceptions import UnknownTypeExtension
 from hdl_checker.path import Path
-from hdl_checker.types import FileType, UnknownTypeExtension
+from hdl_checker.types import FileType
 from hdl_checker.utils import isFileReadable
 
 _SOURCE_EXTENSIONS = "vhdl", "sv", "v"

hdl_checker/database.py

@@ -35,17 +35,23 @@
     Union,
 )
 
-from hdl_checker.diagnostics import (
+from hdl_checker.diagnostics import (  # pylint: disable=unused-import
     CheckerDiagnostic,
     DependencyNotUnique,
     PathNotInProjectFile,
 )
 from hdl_checker.parser_utils import flattenConfig, getSourceParserFromPath
 from hdl_checker.parsers.elements.dependency_spec import DependencySpec
-from hdl_checker.parsers.elements.design_unit import tAnyDesignUnit
+from hdl_checker.parsers.elements.design_unit import (  # pylint: disable=unused-import,
+    tAnyDesignUnit,
+)
 from hdl_checker.parsers.elements.identifier import Identifier
-from hdl_checker.path import Path, TemporaryPath
-from hdl_checker.types import BuildFlags, BuildFlagScope, FileType
+from hdl_checker.path import Path, TemporaryPath  # pylint: disable=unused-import
+from hdl_checker.types import (  # pylint: disable=unused-import
+    BuildFlags,
+    BuildFlagScope,
+    FileType,
+)
 from hdl_checker.utils import HashableByKey, getMostCommonItem, isFileReadable
 
 try:
@@ -61,7 +67,7 @@
 LibraryUnitTuple = Tuple[UnresolvedLibrary, Identifier]
 
 
-class Database(HashableByKey):
+class Database(HashableByKey):  # pylint: disable=too-many-instance-attributes
     "Stores info on and provides operations for a project file set"
 
     def __init__(self):  # type: () -> None
@@ -85,6 +91,7 @@ def __init__(self):  # type: () -> None
 
     @property
     def __hash_key__(self):
+        # Just to allow lru_cache
         return 0
 
     @property
@@ -261,8 +268,8 @@ def __jsonEncode__(self):
     def __jsonDecode__(cls, state):
         # pylint: disable=protected-access
         obj = cls()
-        obj._design_units = {x for x in state.pop("design_units")}
-        obj._inferred_libraries = {x for x in state.pop("inferred_libraries")}
+        obj._design_units = set(state.pop("design_units"))
+        obj._inferred_libraries = set(state.pop("inferred_libraries"))
         for info in state.pop("sources"):
             path = info.pop("path")
             obj._paths.add(path)
@@ -278,8 +285,8 @@ def __jsonDecode__(cls, state):
             obj._flags_map[path][BuildFlagScope.dependencies] = tuple(
                 info.pop("flags", {}).pop(BuildFlagScope.dependencies.value, ())
             )
-            obj._dependencies_map[path] = {x for x in info.pop("dependencies")}
-            obj._diags[path] = {x for x in info.pop("diags")}
+            obj._dependencies_map[path] = set(info.pop("dependencies"))
+            obj._diags[path] = set(info.pop("diags"))
         # pylint: enable=protected-access
 
         return obj
@@ -375,6 +382,7 @@ def _parseSourceIfNeeded(self, path):
         """
         if not isFileReadable(path):
             _logger.warning("Won't parse file that's not readable %s", repr(path))
+            self.removeSource(path)
             return
 
         # Sources will get parsed on demand