Merging Unstable into master (#36)

* Added handlers for retrieving dependencies
* Fixed some issues on build sequence caching
* Fixed issue where `MODELSIM` env was not taken into account when checking for existing libraries

Author: suoto

hdlcc/builders/base_builder.py

@@ -132,6 +132,14 @@ def getState(self):
         del state['_lock']
         return state
 
+    @staticmethod
+    def isAvailable():  # pragma: no cover
+        """
+        Method that should be overriden by child classes and return True
+        if the given builder is available on the current environment
+        """
+        raise NotImplementedError
+
     def checkEnvironment(self):
         """
         Sanity environment check for child classes. Any exception raised
@@ -159,6 +167,7 @@ def _makeRecords(self, message):
 
     def _getRebuilds(self, source, line):
         """
+        Gets info on what should be rebuilt to satisfy the builder
         """
         try:
             parse_results = self._searchForRebuilds(line)
@@ -267,7 +276,7 @@ def _buildAndParse(self, source, flags=None):
         # content, so we dump the buffer content to a temporary file
         # and tell the compiler to compile it instead
         if source.hasBufferContent():
-            build_path = source.dumpBufferContentToFile()
+            build_path = source.getDumpPath()
             self._logger.debug("Source has buffered content, using %s",
                                build_path)
         else:

hdlcc/builders/fallback.py

@@ -40,6 +40,10 @@ def _shouldIgnoreLine(self, line): # pragma: no cover
     def _checkEnvironment(self):
         return
 
+    @staticmethod
+    def isAvailable():
+        return True
+
     def _buildSource(self, path, library, flags=None): # pragma: no cover
         return [], []
 

hdlcc/builders/ghdl.py

@@ -96,6 +96,10 @@ def _checkEnvironment(self):
                 "Version number is '%s'", \
                 stdout[:-1], self._version)
 
+    @staticmethod
+    def isAvailable():
+        return not os.system('ghdl --version')
+
     def getBuiltinLibraries(self):
         return self._builtin_libraries
 

hdlcc/builders/msim.py

@@ -19,6 +19,7 @@
 import os
 import os.path as p
 import re
+from shutil import copyfile
 from .base_builder import BaseBuilder
 from hdlcc.utils import getFileType
 
@@ -130,6 +131,11 @@ def _checkEnvironment(self):
                 "Version number is '%s'", \
                 stdout, self._version)
 
+    @staticmethod
+    def isAvailable():
+        return ((not os.system('vcom -version')) and
+                (not os.system('vlog -version')))
+
     def _parseBuiltinLibraries(self):
         "Discovers libraries that exist regardless before we do anything"
         if not self._iniFileExists():
@@ -169,6 +175,9 @@ def _buildSource(self, path, library, flags=None):
                                filetype, path)
 
     def _getExtraFlags(self, lang):
+        """
+        Gets extra flags configured for the specific language
+        """
         libs = []
         for library in self._added_libraries + self._external_libraries[lang]:
             libs = ['-L', library]
@@ -218,6 +227,9 @@ def _createLibrary(self, library):
             raise
 
     def _iniFileExists(self):
+        """
+        Checks if the modelsim.ini file exists at the expected location
+        """
         _modelsim_ini = p.join(self._target_folder, 'modelsim.ini')
 
         return p.exists(_modelsim_ini)
@@ -226,7 +238,6 @@ def _createIniFile(self):
         """
         Adds a library to a non-existent ModelSim init file
         """
-
         _modelsim_ini = p.join(self._target_folder, 'modelsim.ini')
 
         if not p.exists(self._target_folder):  # pragma: no cover
@@ -235,24 +246,32 @@ def _createIniFile(self):
         self._logger.info("modelsim.ini not found at '%s', creating",
                           p.abspath(_modelsim_ini))
 
-        cwd = p.abspath(os.curdir)
-        self._logger.debug("Current dir is %s, changing to %s",
-                           cwd, self._target_folder)
-        os.chdir(self._target_folder)
-        if cwd == os.curdir: # pragma: no cover
-            self._logger.fatal("cwd: %s, curdir: %s, error!", cwd, os.curdir)
-            assert 0
-
-
-        self._subprocessRunner(['vmap', '-c'])
-
-        self._logger.debug("After vmap at '%s'", p.abspath(os.curdir))
-        for _dir in os.listdir(p.abspath(os.curdir)):
-            self._logger.debug("- '%s'", _dir)
-
-        self._logger.debug("Current dir is %s, changing to %s",
-                           p.abspath(os.curdir), cwd)
-        os.chdir(cwd)
+        modelsim_env = os.environ.get('MODELSIM')
+        if modelsim_env is not None:  # pragma: no cover
+            self._logger.info("MODELSIM environment variable set to %s, using "
+                              "this path as default modelsim.ini",
+                              modelsim_env)
+            # Copy the modelsim.ini as indicated by the MODELSIM environment
+            # variable
+            copyfile(modelsim_env, _modelsim_ini)
+        else:
+            cwd = p.abspath(os.curdir)
+            self._logger.debug("Current dir is %s, changing to %s",
+                               cwd, self._target_folder)
+            os.chdir(self._target_folder)
+            if cwd == os.curdir: # pragma: no cover
+                self._logger.fatal("cwd: %s, curdir: %s, error!", cwd, os.curdir)
+                assert 0
+
+            self._subprocessRunner(['vmap', '-c'])
+
+            self._logger.debug("After vmap at '%s'", p.abspath(os.curdir))
+            for _dir in os.listdir(p.abspath(os.curdir)):
+                self._logger.debug("- '%s'", _dir)
+
+            self._logger.debug("Current dir is %s, changing to %s",
+                               p.abspath(os.curdir), cwd)
+            os.chdir(cwd)
 
     def deleteLibrary(self, library):
         "Deletes a library from ModelSim init file"

hdlcc/builders/xvhdl.py

@@ -97,6 +97,10 @@ def _checkEnvironment(self):
                 "Version number is '%s'", \
                 stdout[:-1], self._version)
 
+    @staticmethod
+    def isAvailable():
+        return not os.system('xvhdl --nolog --version')
+
     def getBuiltinLibraries(self):
         # FIXME: Built-in libraries should not be statically defined
         # like this. Review this at some point

hdlcc/config_parser.py

@@ -17,7 +17,6 @@
 "Configuration file parser"
 
 import os.path as p
-import shutil
 import re
 import logging
 from threading import Lock
@@ -137,15 +136,15 @@ def _addVunitIfFound(self):
         if not foundVunit() or self._parms['builder'] == 'fallback':
             return
 
-        import vunit
+        import vunit  # pylint: disable=import-error
+        logging.getLogger('vunit').setLevel(logging.WARNING)
 
         self._logger.info("VUnit installation found")
-        #  logging.getLogger('vunit').setLevel(logging.ERROR)
 
         builder_class = getBuilderByName(self.getBuilder())
 
         if 'systemverilog' in builder_class.file_types:
-            from vunit.verilog import VUnit
+            from vunit.verilog import VUnit    # pylint: disable=import-error
             self._logger.debug("Builder supports Verilog, "
                                "using vunit.verilog.VUnit")
             builder_class.addExternalLibrary('verilog', 'vunit_lib')
@@ -154,7 +153,7 @@ def _addVunitIfFound(self):
                                   'include'))
             self._importVunitFiles(VUnit)
 
-        from vunit import VUnit
+        from vunit import VUnit  # pylint: disable=import-error
         self._importVunitFiles(VUnit)
 
     def _importVunitFiles(self, vunit_module):
@@ -307,8 +306,8 @@ def _doParseConfigFile(self):
         # to speed up parsing (important especially for libraries with
         # many files. The multiprocessing.Pool class used to hang, so
         # watch out if this behaves well enough to be used
+        self._logger.info("Adding %d sources", len(source_build_list))
         for source in getSourceFileObjects(source_build_list):
-            self._logger.debug("Adding source %s", source)
             self._sources[source.filename] = source
 
         self._cleanUpSourcesList(source_path_list)
@@ -339,23 +338,17 @@ def _discoverBuilder(self):
         If no builder was specified, try to find one that works using
         a dummy target dir
         """
-        target_dir = '.dummy'
         builder_class = None
         self._logger.debug("Searching for builder among %s",
                            AVAILABLE_BUILDERS)
         for builder_class in AVAILABLE_BUILDERS:
             if builder_class.builder_name == 'fallback':
                 continue
-            try:
-                builder_class(target_dir)
+            if builder_class.isAvailable():
                 break
-            except hdlcc.exceptions.SanityCheckError:
-                self._logger.debug("Builder '%s' failed",
-                                   builder_class.builder_name)
+            else:
+                self._logger.debug("'%s' failed", builder_class.builder_name)
                 continue
-            finally:
-                if p.exists(target_dir): # pragma: no cover
-                    shutil.rmtree(target_dir)
 
         if builder_class is not None:
             self._logger.info("Builder '%s' has worked",
@@ -471,7 +464,6 @@ def _handleParsedSource(self, library, path, flags):
 
         # If the source should be built, return the build info for it
         if self._shouldAddSource(path, library, flags_set):
-            self._logger.debug("Adding source: lib '%s', '%s'", library, path)
             return {'filename' : path, 'library' : library, 'flags' : flags_set}
 
     def _shouldAddSource(self, source_path, library, flags):

hdlcc/handlers.py

@@ -59,6 +59,8 @@ def _getServerByProjectFile(project_file):
     project file. If the object doesn't exists yet it gets created and
     then returned
     """
+    if isinstance(project_file, str) and project_file.lower() == 'none':
+        project_file = None
     try:
         return _hdlcc_objects[project_file]
     except KeyError:
@@ -165,15 +167,8 @@ def getMessagesByPath():
     _logger.debug("Getting messages for '%s', '%s', %s", project_file, path,
                   "no content" if content is None else "with content")
 
-
     server = _getServerByProjectFile(project_file)
-    response = {}
-    if content is None:
-        response['messages'] = server.getMessagesByPath(path)
-    else:
-        response['messages'] = server.getMessagesWithText(path, content)
-
-    return response
+    return {'messages': server.getMessagesByPath(path)}
 
 @app.post('/get_ui_messages')
 @_exceptionWrapper
@@ -223,6 +218,44 @@ def shutdownServer():
     _logger.info("Shutting down server")
     utils.terminateProcess(os.getpid())
 
+@app.post('/get_dependencies')
+@_exceptionWrapper
+def getDependencies():
+    """
+    Returns the direct dependencies of a given source path
+    """
+    project_file = bottle.request.forms.get('project_file')
+    path = bottle.request.forms.get('path')
+
+    _logger.debug("Getting dependencies for '%s', '%s'", project_file, path)
+
+    server = _getServerByProjectFile(project_file)
+    source, _ = server.getSourceByPath(path)
+    content = []
+    for dependency in source.getDependencies():
+        content.append("%s.%s" % (dependency['library'], dependency['unit']))
+
+    _logger.debug("Found %d dependencies", len(content))
+
+    return {'dependencies' : content}
+
+@app.post('/get_build_sequence')
+@_exceptionWrapper
+def getBuildSequence():
+    """
+    Returns the build sequence of a given source path
+    """
+    project_file = bottle.request.forms.get('project_file')
+    path = bottle.request.forms.get('path')
+
+    _logger.debug("Getting build sequence for '%s', '%s'", project_file, path)
+
+    server = _getServerByProjectFile(project_file)
+    source, _ = server.getSourceByPath(path)
+
+    return {'sequence' : [x.filename for x in
+                          server.updateBuildSequenceCache(source)]}
+
 #  We'll store a dict to store differents hdlcc objects
 _hdlcc_objects = {} # pylint: disable=invalid-name
 setupSignalHandlers()